mirror of https://github.com/zulip/zulip.git
docs: Make update-subscription-properties use curl example system.
This commit is contained in:
parent
89d82ab827
commit
4364e31d69
|
@ -15,16 +15,7 @@ per-stream notification settings.
|
||||||
|
|
||||||
{tab|curl}
|
{tab|curl}
|
||||||
|
|
||||||
``` curl
|
{generate_code_example(curl)|/users/me/subscriptions/properties:post|example}
|
||||||
curl -X POST {{ api_url }}/v1/users/me/subscriptions/properties \
|
|
||||||
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
|
|
||||||
-d 'subscription_data=[{"stream_id": 1, \
|
|
||||||
"property": "pin_to_top", \
|
|
||||||
"value": true}, \
|
|
||||||
{"stream_id": 3, \
|
|
||||||
"property": "color", \
|
|
||||||
"value": 'f00'}]'
|
|
||||||
```
|
|
||||||
|
|
||||||
{end_tabs}
|
{end_tabs}
|
||||||
|
|
||||||
|
|
|
@ -26,6 +26,7 @@ exclude_list = [
|
||||||
'get-message-history.md',
|
'get-message-history.md',
|
||||||
'update-message-flags.md',
|
'update-message-flags.md',
|
||||||
'mark-as-read-bulk.md',
|
'mark-as-read-bulk.md',
|
||||||
|
'update-subscription-properties.md',
|
||||||
]
|
]
|
||||||
|
|
||||||
def test_generated_curl_examples_for_success(client: Client) -> None:
|
def test_generated_curl_examples_for_success(client: Client) -> None:
|
||||||
|
|
|
@ -1815,7 +1815,7 @@ paths:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: object
|
type: object
|
||||||
example: [{"stream_id": 1, "property": "pin_to_top", "value": true}]
|
example: [{"stream_id": 1, "property": "pin_to_top", "value": true}, {"stream_id": 3, "property": "color", "value": '#f00f00'}]
|
||||||
required: true
|
required: true
|
||||||
security:
|
security:
|
||||||
- basicAuth: []
|
- basicAuth: []
|
||||||
|
|
Loading…
Reference in New Issue