paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

apidocs: Move stray events description to OpenAPI.

Browse Source
This commit is contained in:
Suyash Vardhan Mathur
2021-06-16 17:25:06 +05:30
committed by Tim Abbott
parent 8da27b8a5b
commit 8d7634a572
2 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
templates/zerver/api/get-events.md
View File

@@ -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}

6
zerver/openapi/zulip.yaml
View File

@@ -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