mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 14:03:30 +00:00
apidocs: Move stray events description to OpenAPI.
This commit is contained in:
committed by
Tim Abbott
parent
8da27b8a5b
commit
8d7634a572
@@ -40,13 +40,6 @@ a queue for you.
|
|||||||
|
|
||||||
{generate_api_arguments_table|zulip.yaml|/events:get}
|
{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
|
## Response
|
||||||
|
|
||||||
{generate_return_values_table|zulip.yaml|/events:get}
|
{generate_return_values_table|zulip.yaml|/events:get}
|
||||||
|
|||||||
@@ -159,6 +159,12 @@ paths:
|
|||||||
enum:
|
enum:
|
||||||
- queue_id
|
- queue_id
|
||||||
- last_event_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:
|
parameters:
|
||||||
- $ref: "#/components/parameters/QueueId"
|
- $ref: "#/components/parameters/QueueId"
|
||||||
- name: last_event_id
|
- name: last_event_id
|
||||||
|
|||||||
Reference in New Issue
Block a user