From 8d7634a5723c57ea8b48e527fa1e9956066e97fb Mon Sep 17 00:00:00 2001 From: Suyash Vardhan Mathur Date: Wed, 16 Jun 2021 17:25:06 +0530 Subject: [PATCH] apidocs: Move stray events description to OpenAPI. --- templates/zerver/api/get-events.md | 7 ------- zerver/openapi/zulip.yaml | 6 ++++++ 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/templates/zerver/api/get-events.md b/templates/zerver/api/get-events.md index 39320b373e..6a285faac9 100644 --- a/templates/zerver/api/get-events.md +++ b/templates/zerver/api/get-events.md @@ -40,13 +40,6 @@ a queue for you. {generate_api_arguments_table|zulip.yaml|/events:get} -**Note**: The parameters documented above are optional in the sense that -even if you haven't registered a queue by explicitly requesting the -`{{ api_url}}/v1/register` endpoint, you could pass the parameters for -[the `{{ api_url}}/v1/register` endpoint](/api/register-queue) to this -endpoint and a queue would be registered in the absence of a `queue_id`. -{generate_parameter_description(/events:get)} - ## Response {generate_return_values_table|zulip.yaml|/events:get} diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index e234cd24d0..67714e0b73 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -159,6 +159,12 @@ paths: enum: - queue_id - last_event_id + x-parameter-description: | + **Note**: The parameters documented above are optional in the sense that + even if you haven't registered a queue by explicitly requesting the + `{{ api_url}}/v1/register` endpoint, you could pass the parameters for + [the `{{ api_url}}/v1/register` endpoint](/api/register-queue) to this + endpoint and a queue would be registered in the absence of a `queue_id`. parameters: - $ref: "#/components/parameters/QueueId" - name: last_event_id