Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/api/mark-all-as-read.md

107 lines
2.2 KiB
Markdown
Raw Normal View History

apidocs: Replace hardcoded titles with generated ones. This commit replaces the hardcoded titles of /api pages with the auto-generated ones from the openapi data using the markdown processor.
2021-05-22 13:21:18 +02:00
{generate_api_title(/mark_all_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
openapi: Use description markdown for rendering endpoint descriptions. Firstly, change endpoint descriptions in zulip.yaml so that they match their counterpart in the api docs. Then edit the api docs so that they use api description markdown extension for displaying endpoint description.
2020-04-28 20:00:46 +02:00
{generate_api_description(/mark_all_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
## Usage examples
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{start_tabs}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{generate_code_example(python)|/mark_all_as_read:post|example}
apidocs: Automatically add javascript example tabs. The javascript tab in .md templates can be generated along with the line that adds js example. Further, as a part of the effort of moving towards a single template, the markdown extension for javascrit examples is modified to return empty string if javascript example doesn't exist for that endpoint. This would make it possible to cover more endpoints with a single template. The js example tabs are now automatically generated during generation of javascript code, and so need to be removed. Also, the markdown function to render js examples can be added in all templates, since it is parses and returns an empty string if the examples don't exist, and allows us to move towards a common template. The pages have been verified to be correct by using diff between old and new pages' raw HTML.
2021-06-02 18:36:25 +02:00
{generate_code_example(javascript)|/mark_all_as_read:post|example}
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{tab|curl}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
docs: Make mark-as-read-bulk use curl example system.
2019-10-09 12:32:42 +02:00
{generate_code_example(curl)|/mark_all_as_read:post|example}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{end_tabs}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
openapi_docs: Replace `argument` with `parameter`. The term `parameter` is a better word than `argument` for data passed to an API endpoint; this is why OpenAPI uses in their terminology. Replace `argument` with `parameter` in the API docs to improve their readability. Fixes #15435.
2020-06-18 15:35:25 +02:00
## Parameters
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
{generate_api_arguments_table|zulip.yaml|/mark_all_as_read:post}
openapi: Auto render parameter descriptions. This commit modifies the templates to auto-generate general descriptions of parameters directly from the newly added field of x-parameter-description as a part of the goal of a common template.
2021-06-21 21:20:51 +02:00
{generate_parameter_description(/mark_all_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
## Response
openapi: Auto render response descriptions. This commit modifies the templates to auto-generate general descriptions of responses directly from the newly added field of x-response-description as a part of the goal of a common template.
2021-06-21 21:39:57 +02:00
{generate_response_description(/mark_all_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
#### Example response
{generate_code_example|/mark_all_as_read:post|fixture(200)}
apidocs: Fix response in API templates. Now, the descriptions and all subschemas are directly returned just by `generate_code_example`, and so, these individual subschemas and descriptions can be removed from the templates. All API endpoints docs are exactly the same after the change, except few where missing 400 responses got added due to the modification
2021-06-07 22:53:29 +02:00
{generate_code_example|/mark_all_as_read:post|fixture(400)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
apidocs: Add summary field to endpoints. As a part of effort of removing .md files for /api pages, the title of each page can be added into the summary OpenAPI parameter. This also adds a nice summary visible in Swagger and enhances the documentation. Added the parameter for all endpoints.
2021-05-20 21:53:10 +02:00
{generate_api_title(/mark_stream_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
apidocs: Add summary field to endpoints. As a part of effort of removing .md files for /api pages, the title of each page can be added into the summary OpenAPI parameter. This also adds a nice summary visible in Swagger and enhances the documentation. Added the parameter for all endpoints.
2021-05-20 21:53:10 +02:00
{generate_api_description(/mark_stream_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
`POST {{ api_url }}/v1/mark_stream_as_read`
## Usage examples
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{start_tabs}
{generate_code_example(python)|/mark_stream_as_read:post|example}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
apidocs: Automatically add javascript example tabs. The javascript tab in .md templates can be generated along with the line that adds js example. Further, as a part of the effort of moving towards a single template, the markdown extension for javascrit examples is modified to return empty string if javascript example doesn't exist for that endpoint. This would make it possible to cover more endpoints with a single template. The js example tabs are now automatically generated during generation of javascript code, and so need to be removed. Also, the markdown function to render js examples can be added in all templates, since it is parses and returns an empty string if the examples don't exist, and allows us to move towards a common template. The pages have been verified to be correct by using diff between old and new pages' raw HTML.
2021-06-02 18:36:25 +02:00
{generate_code_example(javascript)|/mark_all_as_read:post|example}
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{tab|curl}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
docs: Make mark-as-read-bulk use curl example system.
2019-10-09 12:32:42 +02:00
{generate_code_example(curl)|/mark_stream_as_read:post|example}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{end_tabs}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
openapi_docs: Replace `argument` with `parameter`. The term `parameter` is a better word than `argument` for data passed to an API endpoint; this is why OpenAPI uses in their terminology. Replace `argument` with `parameter` in the API docs to improve their readability. Fixes #15435.
2020-06-18 15:35:25 +02:00
## Parameters
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
{generate_api_arguments_table|zulip.yaml|/mark_stream_as_read:post}
openapi: Auto render parameter descriptions. This commit modifies the templates to auto-generate general descriptions of parameters directly from the newly added field of x-parameter-description as a part of the goal of a common template.
2021-06-21 21:20:51 +02:00
{generate_parameter_description(/mark_all_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
## Response
openapi: Auto render response descriptions. This commit modifies the templates to auto-generate general descriptions of responses directly from the newly added field of x-response-description as a part of the goal of a common template.
2021-06-21 21:39:57 +02:00
{generate_response_description(/mark_all_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
#### Example response
{generate_code_example|/mark_stream_as_read:post|fixture(200)}
apidocs: Fix response in API templates. Now, the descriptions and all subschemas are directly returned just by `generate_code_example`, and so, these individual subschemas and descriptions can be removed from the templates. All API endpoints docs are exactly the same after the change, except few where missing 400 responses got added due to the modification
2021-06-07 22:53:29 +02:00
{generate_code_example|/mark_stream_as_read:post|fixture(400)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
# Mark messages in a topic as read
apidocs: Add summary field to endpoints. As a part of effort of removing .md files for /api pages, the title of each page can be added into the summary OpenAPI parameter. This also adds a nice summary visible in Swagger and enhances the documentation. Added the parameter for all endpoints.
2021-05-20 21:53:10 +02:00
{generate_api_title(/mark_topic_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
apidocs: Add summary field to endpoints. As a part of effort of removing .md files for /api pages, the title of each page can be added into the summary OpenAPI parameter. This also adds a nice summary visible in Swagger and enhances the documentation. Added the parameter for all endpoints.
2021-05-20 21:53:10 +02:00
{generate_api_description(/mark_all_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
`POST {{ api_url }}/v1/mark_topic_as_read`
## Usage examples
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{start_tabs}
{generate_code_example(python)|/mark_topic_as_read:post|example}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
apidocs: Automatically add javascript example tabs. The javascript tab in .md templates can be generated along with the line that adds js example. Further, as a part of the effort of moving towards a single template, the markdown extension for javascrit examples is modified to return empty string if javascript example doesn't exist for that endpoint. This would make it possible to cover more endpoints with a single template. The js example tabs are now automatically generated during generation of javascript code, and so need to be removed. Also, the markdown function to render js examples can be added in all templates, since it is parses and returns an empty string if the examples don't exist, and allows us to move towards a common template. The pages have been verified to be correct by using diff between old and new pages' raw HTML.
2021-06-02 18:36:25 +02:00
{generate_code_example(javascript)|/mark_all_as_read:post|example}
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{tab|curl}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
docs: Make mark-as-read-bulk use curl example system.
2019-10-09 12:32:42 +02:00
{generate_code_example(curl)|/mark_topic_as_read:post|example}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{end_tabs}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
openapi_docs: Replace `argument` with `parameter`. The term `parameter` is a better word than `argument` for data passed to an API endpoint; this is why OpenAPI uses in their terminology. Replace `argument` with `parameter` in the API docs to improve their readability. Fixes #15435.
2020-06-18 15:35:25 +02:00
## Parameters
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
{generate_api_arguments_table|zulip.yaml|/mark_topic_as_read:post}
openapi: Auto render parameter descriptions. This commit modifies the templates to auto-generate general descriptions of parameters directly from the newly added field of x-parameter-description as a part of the goal of a common template.
2021-06-21 21:20:51 +02:00
{generate_parameter_description(/mark_all_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
## Response
openapi: Auto render response descriptions. This commit modifies the templates to auto-generate general descriptions of responses directly from the newly added field of x-response-description as a part of the goal of a common template.
2021-06-21 21:39:57 +02:00
{generate_response_description(/mark_all_as_read:post)}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
#### Example response
{generate_code_example|/mark_topic_as_read:post|fixture(200)}
apidocs: Fix response in API templates. Now, the descriptions and all subschemas are directly returned just by `generate_code_example`, and so, these individual subschemas and descriptions can be removed from the templates. All API endpoints docs are exactly the same after the change, except few where missing 400 responses got added due to the modification
2021-06-07 22:53:29 +02:00
{generate_code_example|/mark_topic_as_read:post|fixture(400)}