Touchups on the s2s swagger definitions

Duplicate properties, wrong types, etc.
pull/2084/head
Travis Ralston 5 years ago
parent 9ac89cc915
commit e115e3439d

@ -57,7 +57,6 @@ paths:
`room version specification`_ for precise event formats. **The response body `room version specification`_ for precise event formats. **The response body
here describes the common event fields in more detail and may be missing other here describes the common event fields in more detail and may be missing other
required fields for a PDU.** required fields for a PDU.**
schema:
schema: schema:
type: object type: object
properties: properties:

@ -81,7 +81,7 @@ paths:
servers: servers:
type: array type: array
description: |- description: |-
An array of server names that are likely to hold the given room. This An array of server names that are likely to hold the given room. This
list may or may not include the server answering the query. list may or may not include the server answering the query.
items: items:
type: string type: string
@ -128,7 +128,7 @@ paths:
x-example: "@someone:example.org" x-example: "@someone:example.org"
- in: query - in: query
name: field name: field
type: enum type: string
enum: ['displayname', 'avatar_url'] enum: ['displayname', 'avatar_url']
description: |- description: |-
The field to query. If specified, the server will only return the given field The field to query. If specified, the server will only return the given field
@ -139,7 +139,7 @@ paths:
description: |- description: |-
The profile for the user. If a ``field`` is specified in the request, only the The profile for the user. If a ``field`` is specified in the request, only the
matching field should be included in the response. If no ``field`` was specified, matching field should be included in the response. If no ``field`` was specified,
the response should include the fields of the user's profile that can be made the response should include the fields of the user's profile that can be made
public, such as the display name and avatar. public, such as the display name and avatar.
If the user does not have a particular field set on their profile, the server If the user does not have a particular field set on their profile, the server

@ -42,7 +42,6 @@ paths:
description: |- description: |-
The user ID to retrieve devices for. Must be a user local to the The user ID to retrieve devices for. Must be a user local to the
receiving homeserver. receiving homeserver.
required: true
x-example: "@alice:example.org" x-example: "@alice:example.org"
responses: responses:
200: 200:
@ -82,4 +81,4 @@ paths:
description: Optional display name for the device. description: Optional display name for the device.
example: "Alice's Mobile Phone" example: "Alice's Mobile Phone"
required: ['device_id', 'keys'] required: ['device_id', 'keys']
required: ['user_id', 'stream_id', 'devices'] required: ['user_id', 'stream_id', 'devices']

@ -27,6 +27,7 @@ paths:
get: get:
summary: Get the implementation name and version of this homeserver. summary: Get the implementation name and version of this homeserver.
description: Get the implementation name and version of this homeserver. description: Get the implementation name and version of this homeserver.
operationId: getVersion
responses: responses:
200: 200:
description: description:

@ -29,6 +29,7 @@ paths:
Gets information about the delegated server for server-server communication Gets information about the delegated server for server-server communication
between Matrix homeservers. Servers should follow 30x redirects, carefully between Matrix homeservers. Servers should follow 30x redirects, carefully
avoiding redirect loops, and use normal X.509 certificate validation. avoiding redirect loops, and use normal X.509 certificate validation.
operationId: getWellKnown
responses: responses:
200: 200:
description: description:

Loading…
Cancel
Save