paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-09 00:18:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

api docs: Minor fixes in documentation.

Browse Source 
Added some missing response names and type in additionalProperties.
This commit is contained in:
Suyash Vardhan Mathur
2021-01-28 01:27:55 +05:30
committed by Tim Abbott
parent 63c13a8f13
commit 38dc1131b9
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
zerver/openapi/zulip.yaml
View File

@@ -3795,7 +3795,7 @@ paths:
narrow is a search narrow, `<span class="highlight">` elements narrow is a search narrow, `<span class="highlight">` elements
will be included wrapping the matches for the search keywords. will be included wrapping the matches for the search keywords.
description: | description: |
The ID of the message that matches the narrow. No record will be returned `message_id`: The ID of the message that matches the narrow. No record will be returned
for queried messages that do not match the narrow. for queried messages that do not match the narrow.
example: example:
{ {
@@ -6430,6 +6430,7 @@ paths:
description: | description: |
`{user_id}`: Object containing the status details of a user `{user_id}`: Object containing the status details of a user
with the key of the object being the id of the user. with the key of the object being the id of the user.
type: object
properties: properties:
away: away:
type: boolean type: boolean
@@ -7105,6 +7106,7 @@ paths:
`{provider_name}`: Dictionary containing the details of the `{provider_name}`: Dictionary containing the details of the
video chat provider with the name of the chat provider as video chat provider with the name of the chat provider as
the key. the key.
type: object
properties: properties:
name: name:
type: string type: string
@@ -7217,6 +7219,7 @@ paths:
`{site_name}`: Dictionary containing the details of the `{site_name}`: Dictionary containing the details of the
default external account provider with the name of the default external account provider with the name of the
website as the key. website as the key.
type: object
properties: properties:
name: name:
type: string type: string
@@ -9915,7 +9918,7 @@ components:
type: object type: object
additionalProperties: false additionalProperties: false
description: | description: |
'{id}': Object with data about what value user filled in the custom `{id}`: Object with data about what value user filled in the custom
profile field with id `id`. profile field with id `id`.
properties: properties:
value: value:
@@ -10101,7 +10104,7 @@ components:
subscribed to. subscribed to.
additionalProperties: additionalProperties:
description: | description: |
{email_address}`: List of the names of the streams that the user is `{email_address}`: List of the names of the streams that the user is
already subscribed to. already subscribed to.
type: array type: array
items: items: