From 550e43bb9f0140176142cedbd5b4938e3385a787 Mon Sep 17 00:00:00 2001 From: Suyash Vardhan Mathur Date: Wed, 16 Jun 2021 18:17:43 +0530 Subject: [PATCH] apidocs: Move stray events description text to OpenAPI. --- templates/zerver/api/get-events.md | 8 -------- zerver/openapi/zulip.yaml | 12 ++++++++++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/templates/zerver/api/get-events.md b/templates/zerver/api/get-events.md index 6a285faac9..2549f8ed3b 100644 --- a/templates/zerver/api/get-events.md +++ b/templates/zerver/api/get-events.md @@ -50,12 +50,4 @@ a queue for you. {generate_code_example|/events:get|fixture(200)} -#### BAD_EVENT_QUEUE_ID errors - {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. diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 5d8ac32e9e..19ae4dba84 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -3867,8 +3867,16 @@ paths: allOf: - $ref: "#/components/schemas/BadEventQueueIdError" - description: | - If the target event queue has been garbage collected, you'll get the - following error response + #### BAD_EVENT_QUEUE_ID errors + + 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: operationId: delete_queue summary: Delete an event queue