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

33 lines
706 B
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(/streams/{stream_id}:delete)}
api_docs: Add documentation for delete_stream.
2019-06-22 08:22:32 +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(/streams/{stream_id}:delete)}
api_docs: Add documentation for delete_stream.
2019-06-22 08:22:32 +02:00
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/streams/{stream_id}:delete|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)|/streams/{stream_id}:delete|example}
api_docs: Add documentation for delete_stream.
2019-06-22 08:22:32 +02:00
{tab|curl}
docs: Make delete-stream use curl example system.
2019-10-11 14:33:02 +02:00
{generate_code_example(curl)|/streams/{stream_id}:delete|example}
api_docs: Add documentation for delete_stream.
2019-06-22 08:22:32 +02:00
{end_tabs}
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: Add documentation for delete_stream.
2019-06-22 08:22:32 +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
**Note**: The following parameters are all URL query parameters.
api_docs: Add documentation for delete_stream.
2019-06-22 08:22:32 +02:00
{generate_api_arguments_table|zulip.yaml|/streams/{stream_id}:delete}
## Response
#### Example response
{generate_code_example|/streams/{stream_id}:delete|fixture(200)}
{generate_code_example|/streams/{stream_id}:delete|fixture(400)}