openapi: Rectify wrong examples and schemas.

Some examples mentioned in zulip.yaml did not match their schema.
Change either the schema or the example so that all examples are
valid with respect to their schemas.
This commit is contained in:
orientor
2020-05-11 17:44:12 +05:30
committed by Tim Abbott
parent 35139ac559
commit fab2ec9e63

View File

@@ -589,8 +589,12 @@ paths:
containing string email addresses.
**Changes**: Support for using user/stream IDs was added in Zulip 2.0.0.
content:
application/json:
schema:
type: string
type: array
items:
type: integer
example: [9, 10]
required: true
- $ref: '#/components/parameters/Topic'
@@ -1282,8 +1286,6 @@ paths:
"is_active": true,
"email": "hamlet@zulip.com"
}
}
patch:
@@ -1302,9 +1304,10 @@ paths:
in: query
description: |
The user's full name.
content:
application/json:
schema:
type: string
format: json
example: NewName
required: false
- name: is_admin
@@ -2616,9 +2619,10 @@ paths:
in: query
description: |
Notification sound name.
content:
application/json:
schema:
type: string
format: json
example: ding
- name: enable_desktop_notifications
in: query
@@ -2967,19 +2971,21 @@ paths:
in: query
description: |
The new description for the stream.
content:
application/json:
schema:
type: string
format: json
example: "This stream is related to football dicsussions."
example: This stream is related to football dicsussions.
required: false
- name: new_name
in: query
description: |
The new name for the stream.
content:
application/json:
schema:
type: string
format: json
example: "Italy"
example: Italy
required: false
- name: is_private
in: query
@@ -3260,7 +3266,7 @@ paths:
parameters:
- $ref: '#/components/parameters/Narrow'
- $ref: '#/components/parameters/Event_types'
example: event_types=['message']
example: ['message']
security:
- basicAuth: []
responses: