mirror of https://github.com/zulip/zulip.git
apidocs: Move stray events description text to OpenAPI.
This commit is contained in:
parent
d6ed38e0c9
commit
550e43bb9f
|
@ -50,12 +50,4 @@ a queue for you.
|
||||||
|
|
||||||
{generate_code_example|/events:get|fixture(200)}
|
{generate_code_example|/events:get|fixture(200)}
|
||||||
|
|
||||||
#### BAD_EVENT_QUEUE_ID errors
|
|
||||||
|
|
||||||
{generate_code_example|/events:get|fixture(400)}
|
{generate_code_example|/events:get|fixture(400)}
|
||||||
|
|
||||||
A compliant client will handle this error by re-initializing itself
|
|
||||||
(e.g. a Zulip web app browser window will reload in this case).
|
|
||||||
|
|
||||||
See [the /register endpoint docs](/api/register-queue) for details on how to
|
|
||||||
handle these correctly.
|
|
||||||
|
|
|
@ -3867,8 +3867,16 @@ paths:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: "#/components/schemas/BadEventQueueIdError"
|
- $ref: "#/components/schemas/BadEventQueueIdError"
|
||||||
- description: |
|
- description: |
|
||||||
If the target event queue has been garbage collected, you'll get the
|
#### BAD_EVENT_QUEUE_ID errors
|
||||||
following error response
|
|
||||||
|
This error occurs if the target event queue has been garbage collected.
|
||||||
|
A compliant client will handle this error by re-initializing itself
|
||||||
|
(e.g. a Zulip web app browser window will reload in this case).
|
||||||
|
|
||||||
|
See [the /register endpoint docs](/api/register-queue) for details on how to
|
||||||
|
handle these correctly.
|
||||||
|
|
||||||
|
The following is the error response in such case
|
||||||
delete:
|
delete:
|
||||||
operationId: delete_queue
|
operationId: delete_queue
|
||||||
summary: Delete an event queue
|
summary: Delete an event queue
|
||||||
|
|
Loading…
Reference in New Issue