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

90 lines
1.7 KiB
Markdown
Raw Normal View History

openapi: Fuse generate_api_title with generate_api_description. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-07-21 00:01:06 +02:00
{generate_api_header(/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: Update example response header for potential plural. The documentation for various API endpoints gives multiple response examples. Update the headers to reflect this fact.
2022-11-07 20:35:08 +01:00
#### Example response(s)
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
openapi: Render all responses of an operation. Previously, one needed to specifying all the HTTP status codes that we want to render along with the operation, but the primary use case just needs the responses of all the status codes, and not just one. This commit modifies the Markdown extension to render all the responses of all status codes of a specified operation in a loop.
2021-07-13 17:33:43 +02:00
{generate_code_example|/mark_all_as_read:post|fixture}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
openapi: Fuse generate_api_title with generate_api_description. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-07-21 00:01:06 +02:00
{generate_api_header(/mark_stream_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}
{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: Update example response header for potential plural. The documentation for various API endpoints gives multiple response examples. Update the headers to reflect this fact.
2022-11-07 20:35:08 +01:00
#### Example response(s)
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
openapi: Render all responses of an operation. Previously, one needed to specifying all the HTTP status codes that we want to render along with the operation, but the primary use case just needs the responses of all the status codes, and not just one. This commit modifies the Markdown extension to render all the responses of all status codes of a specified operation in a loop.
2021-07-13 17:33:43 +02:00
{generate_code_example|/mark_stream_as_read:post|fixture}
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
openapi: Fuse generate_api_title with generate_api_description. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-07-21 00:01:06 +02:00
{generate_api_header(/mark_topic_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}
{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: Update example response header for potential plural. The documentation for various API endpoints gives multiple response examples. Update the headers to reflect this fact.
2022-11-07 20:35:08 +01:00
#### Example response(s)
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-08-11 13:38:55 +02:00
openapi: Render all responses of an operation. Previously, one needed to specifying all the HTTP status codes that we want to render along with the operation, but the primary use case just needs the responses of all the status codes, and not just one. This commit modifies the Markdown extension to render all the responses of all status codes of a specified operation in a loop.
2021-07-13 17:33:43 +02:00
{generate_code_example|/mark_topic_as_read:post|fixture}