Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make sure examples types match schema in definitions #1563

Merged
merged 3 commits into from
Jul 4, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Make sure examples types match schema in definitions.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Make sure examples types match schema in definitions.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Make sure examples types match schema in definitions.
2 changes: 1 addition & 1 deletion data/api/client-server/message_pagination.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ paths:
- in: query
name: limit
description: "The maximum number of events to return. Default: 10."
example: "3"
example: 3
schema:
type: integer
- in: query
Expand Down
6 changes: 3 additions & 3 deletions data/api/client-server/old_sync.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ paths:
name: timeout
description: The maximum time in milliseconds to wait for an event.
required: false
example: "35000"
example: 35000
schema:
type: integer
responses:
Expand Down Expand Up @@ -105,7 +105,7 @@ paths:
name: limit
description: The maximum number of messages to return for each room.
required: false
example: "2"
example: 2
schema:
type: integer
- in: query
Expand All @@ -116,7 +116,7 @@ paths:
included. If set to `true` then rooms that the user has left are
included as well. By default this is `false`.
required: false
example: "true"
example: true
schema:
type: boolean
responses:
Expand Down
5 changes: 2 additions & 3 deletions data/api/client-server/peeking_events.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,13 @@ paths:
name: timeout
description: The maximum time in milliseconds to wait for an event.
required: false
example: "35000"
example: 35000
schema:
type: integer
- in: query
name: room_id
description: The room ID for which events should be returned.
example:
- "!somewhere:over.the.rainbow"
example: "!somewhere:over.the.rainbow"
schema:
type: string
responses:
Expand Down
2 changes: 1 addition & 1 deletion data/api/client-server/pushrules.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -545,7 +545,7 @@ paths:
required: true
description: |
The kind of rule
example: cake
example: content
KitsuneRal marked this conversation as resolved.
Show resolved Hide resolved
schema:
type: string
enum:
Expand Down
2 changes: 1 addition & 1 deletion data/api/client-server/sync.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ paths:
changed since the point indicated by `since` will be returned.

By default, this is `false`.
example: "false"
example: false
schema:
type: boolean
- in: query
Expand Down
2 changes: 1 addition & 1 deletion data/api/identity/v2_associations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ paths:
name: sid
description: The Session ID generated by the `requestToken` call.
required: true
example: 1234
example: "1234"
schema:
type: string
- in: query
Expand Down
2 changes: 1 addition & 1 deletion data/api/identity/v2_email_associations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ paths:
name: sid
required: true
description: The session ID, generated by the `requestToken` call.
example: 1234
example: "1234"
schema:
type: string
- in: query
Expand Down
2 changes: 1 addition & 1 deletion data/api/identity/v2_phone_associations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ paths:
name: sid
required: true
description: The session ID, generated by the `requestToken` call.
example: 1234
example: "1234"
schema:
type: string
- in: query
Expand Down
2 changes: 1 addition & 1 deletion data/api/identity/v2_terms.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ paths:
items:
type: string
description: The URLs the user is accepting in this request.
example: https://example.org/somewhere/terms-2.0-en.html
example: [https://example.org/somewhere/terms-2.0-en.html]
zecakeh marked this conversation as resolved.
Show resolved Hide resolved
required:
- user_accepts
responses:
Expand Down
4 changes: 2 additions & 2 deletions data/api/server-server/leaving-v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -109,15 +109,15 @@ paths:
- depth
- content
example: {
"room_id": "!somewhere:example.org",
KitsuneRal marked this conversation as resolved.
Show resolved Hide resolved
"type": "m.room.member",
"state_key": "@someone:example.org",
"origin": "example.org",
"origin_server_ts": 1549041175876,
"sender": "@someone:example.org",
"content": {
"membership": "leave"
}
},
"depth": 0
}
required: true
responses:
Expand Down
Loading