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

33 lines
696 B
Markdown
Raw Normal View History

api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
# Update subscription settings
api docs: Document the POST /users/me/subscriptions/properties endpoint.
2018-07-12 10:09:50 +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(/users/me/subscriptions/properties:post)}
api docs: Document the POST /users/me/subscriptions/properties endpoint.
2018-07-12 10:09:50 +02:00
## Usage examples
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{start_tabs}
{tab|python}
api docs: Document the POST /users/me/subscriptions/properties endpoint.
2018-07-12 10:09:50 +02:00
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{generate_code_example(python)|/users/me/subscriptions/properties:post|example}
{tab|curl}
api docs: Document the POST /users/me/subscriptions/properties endpoint.
2018-07-12 10:09:50 +02:00
docs: Make update-subscription-properties use curl example system.
2019-10-10 11:06:47 +02:00
{generate_code_example(curl)|/users/me/subscriptions/properties:post|example}
api docs: Document the POST /users/me/subscriptions/properties endpoint.
2018-07-12 10:09:50 +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 the POST /users/me/subscriptions/properties endpoint.
2018-07-12 10:09:50 +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 the POST /users/me/subscriptions/properties endpoint.
2018-07-12 10:09:50 +02:00
{generate_api_arguments_table|zulip.yaml|/users/me/subscriptions/properties:post}
## Response
#### Return values
api docs: Fix documentation of update-subscription-settings. The responses for the API weren't being rendered from yaml, and were incorrectly formatted in yaml. The parameters also weren't completely included in yaml and needed to be moved. Made appropriate fixes in yaml and markdown file.
2021-01-27 20:53:43 +01:00
{generate_return_values_table|zulip.yaml|/users/me/subscriptions/properties:post}
api docs: Document the POST /users/me/subscriptions/properties endpoint.
2018-07-12 10:09:50 +02:00
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/users/me/subscriptions/properties:post|fixture(200)}