Add operationId to all endpoints of all APIs
To facilitate generation of API stubs from the spec. Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
This commit is contained in:
parent
bf3b49f13c
commit
24afe7987c
47 changed files with 95 additions and 1 deletions
|
@ -31,6 +31,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
This API is called by the HS when the HS wants to push an event (or
|
This API is called by the HS when the HS wants to push an event (or
|
||||||
batch of events) to the AS.
|
batch of events) to the AS.
|
||||||
|
operationId: sendTransaction
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: txnId
|
name: txnId
|
||||||
|
|
|
@ -34,6 +34,7 @@ paths:
|
||||||
Set some account_data for the client. This config is only visible to the user
|
Set some account_data for the client. This config is only visible to the user
|
||||||
that set the account_data. The config will be synced to clients in the
|
that set the account_data. The config will be synced to clients in the
|
||||||
top-level ``account_data``.
|
top-level ``account_data``.
|
||||||
|
operationId: setAccountData
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -75,6 +76,7 @@ paths:
|
||||||
Set some account_data for the client on a given room. This config is only
|
Set some account_data for the client on a given room. This config is only
|
||||||
visible to the user that set the account_data. The config will be synced to
|
visible to the user that set the account_data. The config will be synced to
|
||||||
clients in the per-room ``account_data``.
|
clients in the per-room ``account_data``.
|
||||||
|
operationId: setAccountDataPerRoom
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -36,6 +36,7 @@ paths:
|
||||||
This API may be restricted to only be called by the user being looked
|
This API may be restricted to only be called by the user being looked
|
||||||
up, or by a server admin. Server-local administrator privileges are not
|
up, or by a server admin. Server-local administrator privileges are not
|
||||||
specified in this document.
|
specified in this document.
|
||||||
|
operationId: getWhoIs
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -39,6 +39,7 @@ paths:
|
||||||
|
|
||||||
Identifiers in this list may be used by the homeserver as, for example,
|
Identifiers in this list may be used by the homeserver as, for example,
|
||||||
identifiers that it will accept to reset the user's account password.
|
identifiers that it will accept to reset the user's account password.
|
||||||
|
operationId: getAccount3PIDs
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
responses:
|
responses:
|
||||||
|
@ -74,6 +75,7 @@ paths:
|
||||||
post:
|
post:
|
||||||
summary: Adds contact information to the user's account.
|
summary: Adds contact information to the user's account.
|
||||||
description: Adds contact information to the user's account.
|
description: Adds contact information to the user's account.
|
||||||
|
operationId: post3PIDs
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -139,6 +141,7 @@ paths:
|
||||||
validation tokens when adding an email address to an account. This API's
|
validation tokens when adding an email address to an account. This API's
|
||||||
parameters and response is identical to that of the HS API
|
parameters and response is identical to that of the HS API
|
||||||
|/register/email/requestToken|_ endpoint.
|
|/register/email/requestToken|_ endpoint.
|
||||||
|
operationId: requestTokenTo3PID
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: An email was sent to the given address
|
description: An email was sent to the given address
|
||||||
|
|
|
@ -36,6 +36,7 @@ paths:
|
||||||
When a user is banned from a room, they may not join it or be invited to it until they are unbanned.
|
When a user is banned from a room, they may not join it or be invited to it until they are unbanned.
|
||||||
|
|
||||||
The caller must have the required power level in order to perform this operation.
|
The caller must have the required power level in order to perform this operation.
|
||||||
|
operationId: ban
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -91,6 +92,7 @@ paths:
|
||||||
and join if they would otherwise be allowed to join according to its join rules.
|
and join if they would otherwise be allowed to join according to its join rules.
|
||||||
|
|
||||||
The caller must have the required power level in order to perform this operation.
|
The caller must have the required power level in order to perform this operation.
|
||||||
|
operationId: unban
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -37,6 +37,7 @@ paths:
|
||||||
``redirectUrl=https://client.example.com/?q=p``, it might redirect to
|
``redirectUrl=https://client.example.com/?q=p``, it might redirect to
|
||||||
``https://cas.example.com/?service=https%3A%2F%2Fserver.example.com%2F_matrix%2Fclient%2F%CLIENT_MAJOR_VERSION%%2Flogin%2Fcas%2Fticket%3FredirectUrl%3Dhttps%253A%252F%252Fclient.example.com%252F%253Fq%253Dp``.
|
``https://cas.example.com/?service=https%3A%2F%2Fserver.example.com%2F_matrix%2Fclient%2F%CLIENT_MAJOR_VERSION%%2Flogin%2Fcas%2Fticket%3FredirectUrl%3Dhttps%253A%252F%252Fclient.example.com%252F%253Fq%253Dp``.
|
||||||
|
|
||||||
|
operationId: redirectToCAS
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -39,6 +39,7 @@ paths:
|
||||||
|
|
||||||
If validation is unsuccessful, the server should respond with a ``401
|
If validation is unsuccessful, the server should respond with a ``401
|
||||||
Unauthorized`` error, the body of which will be displayed to the user.
|
Unauthorized`` error, the body of which will be displayed to the user.
|
||||||
|
operationid: loginByCASTicket
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -26,6 +26,7 @@ paths:
|
||||||
"/upload":
|
"/upload":
|
||||||
post:
|
post:
|
||||||
summary: Upload some content to the content repository.
|
summary: Upload some content to the content repository.
|
||||||
|
operationid: uploadContent
|
||||||
produces: ["application/json"]
|
produces: ["application/json"]
|
||||||
parameters:
|
parameters:
|
||||||
- in: header
|
- in: header
|
||||||
|
@ -65,6 +66,7 @@ paths:
|
||||||
"/download/{serverName}/{mediaId}":
|
"/download/{serverName}/{mediaId}":
|
||||||
get:
|
get:
|
||||||
summary: "Download content from the content repository."
|
summary: "Download content from the content repository."
|
||||||
|
operationId: getContent
|
||||||
produces: ["*/*"]
|
produces: ["*/*"]
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
@ -98,6 +100,7 @@ paths:
|
||||||
"/download/{serverName}/{mediaId}/{fileName}":
|
"/download/{serverName}/{mediaId}/{fileName}":
|
||||||
get:
|
get:
|
||||||
summary: "Download content from the content repository as a given filename."
|
summary: "Download content from the content repository as a given filename."
|
||||||
|
operationId: getContentOverrideName
|
||||||
produces: ["*/*"]
|
produces: ["*/*"]
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
@ -138,6 +141,7 @@ paths:
|
||||||
"/thumbnail/{serverName}/{mediaId}":
|
"/thumbnail/{serverName}/{mediaId}":
|
||||||
get:
|
get:
|
||||||
summary: "Download a thumbnail of the content from the content repository."
|
summary: "Download a thumbnail of the content from the content repository."
|
||||||
|
operationId: getContentThumbnail
|
||||||
produces: ["image/jpeg", "image/png"]
|
produces: ["image/jpeg", "image/png"]
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
|
|
@ -46,6 +46,7 @@ paths:
|
||||||
|
|
||||||
4. Invite events implied by ``invite`` and ``invite_3pid``.
|
4. Invite events implied by ``invite`` and ``invite_3pid``.
|
||||||
|
|
||||||
|
operationId: createRoom
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -33,6 +33,7 @@ paths:
|
||||||
summary: List registered devices for the current user
|
summary: List registered devices for the current user
|
||||||
description: |-
|
description: |-
|
||||||
Gets information about all devices for the current user.
|
Gets information about all devices for the current user.
|
||||||
|
operationId: getDevices
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
responses:
|
responses:
|
||||||
|
@ -66,6 +67,7 @@ paths:
|
||||||
summary: Get a single device
|
summary: Get a single device
|
||||||
description: |-
|
description: |-
|
||||||
Gets information on a single device, by device id.
|
Gets information on a single device, by device id.
|
||||||
|
operationId: getDevice
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -97,6 +99,7 @@ paths:
|
||||||
summary: Update a device
|
summary: Update a device
|
||||||
description: |-
|
description: |-
|
||||||
Updates the metadata on the given device.
|
Updates the metadata on the given device.
|
||||||
|
operationId: updateDevice
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -137,6 +140,7 @@ paths:
|
||||||
This API endpoint uses the `User-Interactive Authentication API`_.
|
This API endpoint uses the `User-Interactive Authentication API`_.
|
||||||
|
|
||||||
Deletes the given device, and invalidates any access token assoicated with it.
|
Deletes the given device, and invalidates any access token assoicated with it.
|
||||||
|
operationId: deleteDevice
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -30,6 +30,7 @@ paths:
|
||||||
"/room/{roomAlias}":
|
"/room/{roomAlias}":
|
||||||
put:
|
put:
|
||||||
summary: Create a new mapping from room alias to room ID.
|
summary: Create a new mapping from room alias to room ID.
|
||||||
|
operationId: setRoomAlias
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -78,6 +79,7 @@ paths:
|
||||||
domain part of the alias does not correspond to the server's own
|
domain part of the alias does not correspond to the server's own
|
||||||
domain.
|
domain.
|
||||||
|
|
||||||
|
operationId: getRoomIdByAlias
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
type: string
|
type: string
|
||||||
|
@ -124,6 +126,7 @@ paths:
|
||||||
Remove a mapping of room alias to room ID.
|
Remove a mapping of room alias to room ID.
|
||||||
|
|
||||||
Servers may choose to implement additional access control checks here, for instance that room aliases can only be deleted by their creator or a server administrator.
|
Servers may choose to implement additional access control checks here, for instance that room aliases can only be deleted by their creator or a server administrator.
|
||||||
|
operationId: deleteRoomAlias
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -34,6 +34,7 @@ paths:
|
||||||
This API returns a number of events that happened just before and
|
This API returns a number of events that happened just before and
|
||||||
after the specified event. This allows clients to get the context
|
after the specified event. This allows clients to get the context
|
||||||
surrounding an event.
|
surrounding an event.
|
||||||
|
operationId: getEventContext
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -33,6 +33,7 @@ paths:
|
||||||
Uploads a new filter definition to the homeserver.
|
Uploads a new filter definition to the homeserver.
|
||||||
Returns a filter ID that may be used in future requests to
|
Returns a filter ID that may be used in future requests to
|
||||||
restrict which events are returned to the client.
|
restrict which events are returned to the client.
|
||||||
|
operationId: defineFilter
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -96,6 +97,7 @@ paths:
|
||||||
"/user/{userId}/filter/{filterId}":
|
"/user/{userId}/filter/{filterId}":
|
||||||
get:
|
get:
|
||||||
summary: Download a filter
|
summary: Download a filter
|
||||||
|
operationId: getFilter
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -51,6 +51,7 @@ paths:
|
||||||
``m.room.member`` event to the room.
|
``m.room.member`` event to the room.
|
||||||
|
|
||||||
.. _third party invites section: `invite-by-third-party-id-endpoint`_
|
.. _third party invites section: `invite-by-third-party-id-endpoint`_
|
||||||
|
operationId: inviteUser
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -44,6 +44,7 @@ paths:
|
||||||
If a ``third_party_signed`` was supplied, the homeserver must verify
|
If a ``third_party_signed`` was supplied, the homeserver must verify
|
||||||
that it matches a pending ``m.room.third_party_invite`` event in the
|
that it matches a pending ``m.room.third_party_invite`` event in the
|
||||||
room, and perform key validity checking if required by the event.
|
room, and perform key validity checking if required by the event.
|
||||||
|
operationId: joinRoomById
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -132,6 +133,7 @@ paths:
|
||||||
If a ``third_party_signed`` was supplied, the homeserver must verify
|
If a ``third_party_signed`` was supplied, the homeserver must verify
|
||||||
that it matches a pending ``m.room.third_party_invite`` event in the
|
that it matches a pending ``m.room.third_party_invite`` event in the
|
||||||
room, and perform key validity checking if required by the event.
|
room, and perform key validity checking if required by the event.
|
||||||
|
operationId: joinRoom
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -32,6 +32,7 @@ paths:
|
||||||
summary: Upload end-to-end encryption keys.
|
summary: Upload end-to-end encryption keys.
|
||||||
description: |-
|
description: |-
|
||||||
Publishes end-to-end encryption keys for the device.
|
Publishes end-to-end encryption keys for the device.
|
||||||
|
operationId: uploadKeys
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -100,6 +101,7 @@ paths:
|
||||||
summary: Download device identity keys.
|
summary: Download device identity keys.
|
||||||
description: |-
|
description: |-
|
||||||
Returns the current devices and identity keys for the given users.
|
Returns the current devices and identity keys for the given users.
|
||||||
|
operationId: queryKeys
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -208,6 +210,7 @@ paths:
|
||||||
summary: Claim one-time encryption keys.
|
summary: Claim one-time encryption keys.
|
||||||
description: |-
|
description: |-
|
||||||
Claims one-time keys for use in pre-key messages.
|
Claims one-time keys for use in pre-key messages.
|
||||||
|
operationId: claimKeys
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -293,6 +296,7 @@ paths:
|
||||||
membership state ``join``); *and*
|
membership state ``join``); *and*
|
||||||
* added new device identity keys or removed an existing device with
|
* added new device identity keys or removed an existing device with
|
||||||
identity keys, between ``from`` and ``to``.
|
identity keys, between ``from`` and ``to``.
|
||||||
|
operationId: getKeysChanges
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -34,6 +34,7 @@ paths:
|
||||||
Kick a user from the room.
|
Kick a user from the room.
|
||||||
|
|
||||||
The caller must have the required power level in order to perform this operation.
|
The caller must have the required power level in order to perform this operation.
|
||||||
|
operationId: kick
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -42,6 +42,7 @@ paths:
|
||||||
|
|
||||||
The user will still be allowed to retrieve history from the room which
|
The user will still be allowed to retrieve history from the room which
|
||||||
they were previously allowed to see.
|
they were previously allowed to see.
|
||||||
|
operationId: leaveRoom
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -79,6 +80,7 @@ paths:
|
||||||
|
|
||||||
If the user is currently joined to the room, they will implicitly leave
|
If the user is currently joined to the room, they will implicitly leave
|
||||||
the room as part of this API call.
|
the room as part of this API call.
|
||||||
|
operationId: forgetRoom
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -33,6 +33,7 @@ paths:
|
||||||
|
|
||||||
This API returns paginated responses. The rooms are ordered by the number
|
This API returns paginated responses. The rooms are ordered by the number
|
||||||
of joined members, with the largest rooms first.
|
of joined members, with the largest rooms first.
|
||||||
|
operationId: getPublicRooms
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
name: limit
|
name: limit
|
||||||
|
@ -158,6 +159,7 @@ paths:
|
||||||
|
|
||||||
This API returns paginated responses. The rooms are ordered by the number
|
This API returns paginated responses. The rooms are ordered by the number
|
||||||
of joined members, with the largest rooms first.
|
of joined members, with the largest rooms first.
|
||||||
|
operationId: queryPublicRooms
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -41,6 +41,7 @@ paths:
|
||||||
supplied by the client or generated by the server. The server may
|
supplied by the client or generated by the server. The server may
|
||||||
invalidate any access token previously associated with that device. See
|
invalidate any access token previously associated with that device. See
|
||||||
`Relationship between access tokens and devices`_.
|
`Relationship between access tokens and devices`_.
|
||||||
|
operationId: login
|
||||||
parameters:
|
parameters:
|
||||||
- in: body
|
- in: body
|
||||||
name: body
|
name: body
|
||||||
|
|
|
@ -33,6 +33,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
Invalidates an existing access token, so that it can no longer be used for
|
Invalidates an existing access token, so that it can no longer be used for
|
||||||
authorization.
|
authorization.
|
||||||
|
operationId: logout
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
responses:
|
responses:
|
||||||
|
|
|
@ -33,6 +33,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
This API returns a list of message and state events for a room. It uses
|
This API returns a list of message and state events for a room. It uses
|
||||||
pagination query parameters to paginate history in the room.
|
pagination query parameters to paginate history in the room.
|
||||||
|
operationId: getRoomEvents
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -34,6 +34,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
This API is used to paginate through the list of events that the
|
This API is used to paginate through the list of events that the
|
||||||
user has been, or would have been notified about.
|
user has been, or would have been notified about.
|
||||||
|
operationId: getNotifications
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -38,6 +38,7 @@ paths:
|
||||||
should instead call the |/sync|_ API with a ``since`` parameter. See
|
should instead call the |/sync|_ API with a ``since`` parameter. See
|
||||||
the `migration guide
|
the `migration guide
|
||||||
<https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>`_.
|
<https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>`_.
|
||||||
|
operationId: getEvents
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -114,6 +115,7 @@ paths:
|
||||||
should instead call the |/sync|_ API with no ``since`` parameter. See
|
should instead call the |/sync|_ API with no ``since`` parameter. See
|
||||||
the `migration guide
|
the `migration guide
|
||||||
<https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>`_.
|
<https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>`_.
|
||||||
|
operationId: initialSync
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -406,6 +408,7 @@ paths:
|
||||||
|
|
||||||
This endpoint was deprecated in r0 of this specification. Clients
|
This endpoint was deprecated in r0 of this specification. Clients
|
||||||
should instead call the |/rooms/{roomId}/context/{eventId}|_ API.
|
should instead call the |/rooms/{roomId}/context/{eventId}|_ API.
|
||||||
|
operationId: getOneEvent
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -41,6 +41,7 @@ paths:
|
||||||
Note that the normal ``/events`` endpoint has been deprecated. This
|
Note that the normal ``/events`` endpoint has been deprecated. This
|
||||||
API will also be deprecated at some point, but its replacement is not
|
API will also be deprecated at some point, but its replacement is not
|
||||||
yet known.
|
yet known.
|
||||||
|
operationId: peekEvents
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -35,6 +35,7 @@ paths:
|
||||||
the activity time is updated to reflect that activity; the client does
|
the activity time is updated to reflect that activity; the client does
|
||||||
not need to specify the ``last_active_ago`` field. You cannot set the
|
not need to specify the ``last_active_ago`` field. You cannot set the
|
||||||
presence state of another user.
|
presence state of another user.
|
||||||
|
operationId: setPresence
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -81,6 +82,7 @@ paths:
|
||||||
summary: Get this user's presence state.
|
summary: Get this user's presence state.
|
||||||
description: |-
|
description: |-
|
||||||
Get the given user's presence state.
|
Get the given user's presence state.
|
||||||
|
operationId: getPresence
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
type: string
|
type: string
|
||||||
|
@ -126,6 +128,7 @@ paths:
|
||||||
summary: Add or remove users from this presence list.
|
summary: Add or remove users from this presence list.
|
||||||
description: |-
|
description: |-
|
||||||
Adds or removes users from this presence list.
|
Adds or removes users from this presence list.
|
||||||
|
operationId: modifyPresenceList
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -180,6 +183,7 @@ paths:
|
||||||
summary: Get presence events for this presence list.
|
summary: Get presence events for this presence list.
|
||||||
description: |-
|
description: |-
|
||||||
Retrieve a list of presence events for every user on this list.
|
Retrieve a list of presence events for every user on this list.
|
||||||
|
operationId: getPresenceForList
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -33,6 +33,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
This API sets the given user's display name. You must have permission to
|
This API sets the given user's display name. You must have permission to
|
||||||
set this user's display name, e.g. you need to have their ``access_token``.
|
set this user's display name, e.g. you need to have their ``access_token``.
|
||||||
|
operationId: setDisplayName
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -75,6 +76,7 @@ paths:
|
||||||
Get the user's display name. This API may be used to fetch the user's
|
Get the user's display name. This API may be used to fetch the user's
|
||||||
own displayname or to query the name of other users; either locally or
|
own displayname or to query the name of other users; either locally or
|
||||||
on remote homeservers.
|
on remote homeservers.
|
||||||
|
operationId: getDisplayName
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
type: string
|
type: string
|
||||||
|
@ -105,6 +107,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
This API sets the given user's avatar URL. You must have permission to
|
This API sets the given user's avatar URL. You must have permission to
|
||||||
set this user's avatar URL, e.g. you need to have their ``access_token``.
|
set this user's avatar URL, e.g. you need to have their ``access_token``.
|
||||||
|
operationId: setAvatarUrl
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -147,6 +150,7 @@ paths:
|
||||||
Get the user's avatar URL. This API may be used to fetch the user's
|
Get the user's avatar URL. This API may be used to fetch the user's
|
||||||
own avatar URL or to query the URL of other users; either locally or
|
own avatar URL or to query the URL of other users; either locally or
|
||||||
on remote homeservers.
|
on remote homeservers.
|
||||||
|
operationId: getAvatarUrl
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
type: string
|
type: string
|
||||||
|
@ -179,6 +183,7 @@ paths:
|
||||||
to fetch the user's own profile information or other users; either
|
to fetch the user's own profile information or other users; either
|
||||||
locally or on remote homeservers. This API may return keys which are not
|
locally or on remote homeservers. This API may return keys which are not
|
||||||
limited to ``displayname`` or ``avatar_url``.
|
limited to ``displayname`` or ``avatar_url``.
|
||||||
|
operationId: getUserProfile
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -32,6 +32,7 @@ paths:
|
||||||
summary: Gets the current pushers for the authenticated user
|
summary: Gets the current pushers for the authenticated user
|
||||||
description: |-
|
description: |-
|
||||||
Gets all currently active pushers for the authenticated user
|
Gets all currently active pushers for the authenticated user
|
||||||
|
operationId: getPushers
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
responses:
|
responses:
|
||||||
|
@ -123,6 +124,7 @@ paths:
|
||||||
This endpoint allows the creation, modification and deletion of `pushers`_
|
This endpoint allows the creation, modification and deletion of `pushers`_
|
||||||
for this user ID. The behaviour of this endpoint varies depending on the
|
for this user ID. The behaviour of this endpoint varies depending on the
|
||||||
values in the JSON body.
|
values in the JSON body.
|
||||||
|
operationId: postPusher
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -35,6 +35,7 @@ paths:
|
||||||
the rulesets by suffixing a ``scope`` to this path e.g.
|
the rulesets by suffixing a ``scope`` to this path e.g.
|
||||||
``/pushrules/global/``. This will return a subset of this data under the
|
``/pushrules/global/``. This will return a subset of this data under the
|
||||||
specified key e.g. the ``global`` key.
|
specified key e.g. the ``global`` key.
|
||||||
|
operationId: getPushRules
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
responses:
|
responses:
|
||||||
|
@ -247,6 +248,7 @@ paths:
|
||||||
summary: Retrieve a push rule.
|
summary: Retrieve a push rule.
|
||||||
description: |-
|
description: |-
|
||||||
Retrieve a single specified push rule.
|
Retrieve a single specified push rule.
|
||||||
|
operationId: getPushRule
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -299,6 +301,7 @@ paths:
|
||||||
summary: Delete a push rule.
|
summary: Delete a push rule.
|
||||||
description: |-
|
description: |-
|
||||||
This endpoint removes the push rule defined in the path.
|
This endpoint removes the push rule defined in the path.
|
||||||
|
operationId: deletePushRule
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -340,6 +343,7 @@ paths:
|
||||||
This endpoint allows the creation, modification and deletion of pushers
|
This endpoint allows the creation, modification and deletion of pushers
|
||||||
for this user ID. The behaviour of this endpoint varies depending on the
|
for this user ID. The behaviour of this endpoint varies depending on the
|
||||||
values in the JSON body.
|
values in the JSON body.
|
||||||
|
operationId: setPushRule
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -446,6 +450,7 @@ paths:
|
||||||
summary: "Get whether a push rule is enabled"
|
summary: "Get whether a push rule is enabled"
|
||||||
description:
|
description:
|
||||||
This endpoint gets whether the specified push rule is enabled.
|
This endpoint gets whether the specified push rule is enabled.
|
||||||
|
operationId: isPushRuleEnabled
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -490,6 +495,7 @@ paths:
|
||||||
summary: "Enable or disable a push rule."
|
summary: "Enable or disable a push rule."
|
||||||
description: |-
|
description: |-
|
||||||
This endpoint allows clients to enable or disable the specified push rule.
|
This endpoint allows clients to enable or disable the specified push rule.
|
||||||
|
operationId: setPushRuleEnabled
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -545,6 +551,7 @@ paths:
|
||||||
summary: "The actions for a push rule"
|
summary: "The actions for a push rule"
|
||||||
description:
|
description:
|
||||||
This endpoint get the actions for the specified push rule.
|
This endpoint get the actions for the specified push rule.
|
||||||
|
operationId: getPushRuleActions
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -592,6 +599,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
This endpoint allows clients to change the actions of a push rule.
|
This endpoint allows clients to change the actions of a push rule.
|
||||||
This can be used to change the actions of builtin rules.
|
This can be used to change the actions of builtin rules.
|
||||||
|
operationId: setPushRuleActions
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -33,6 +33,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
This API updates the marker for the given receipt type to the event ID
|
This API updates the marker for the given receipt type to the event ID
|
||||||
specified.
|
specified.
|
||||||
|
operationId: postReceipt
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -39,6 +39,7 @@ paths:
|
||||||
Users may redact their own events, and any user with a power level
|
Users may redact their own events, and any user with a power level
|
||||||
greater than or equal to the `redact` power level of the room may
|
greater than or equal to the `redact` power level of the room may
|
||||||
redact events there.
|
redact events there.
|
||||||
|
operationId: redactEvent
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -49,6 +49,7 @@ paths:
|
||||||
supplied by the client or generated by the server. The server may
|
supplied by the client or generated by the server. The server may
|
||||||
invalidate any access token previously associated with that device. See
|
invalidate any access token previously associated with that device. See
|
||||||
`Relationship between access tokens and devices`_.
|
`Relationship between access tokens and devices`_.
|
||||||
|
operationId: register
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
name: kind
|
name: kind
|
||||||
|
@ -178,6 +179,7 @@ paths:
|
||||||
this API takes JSON objects, though the Identity Server API takes
|
this API takes JSON objects, though the Identity Server API takes
|
||||||
``x-www-form-urlencoded`` parameters. See the Identity Server API for
|
``x-www-form-urlencoded`` parameters. See the Identity Server API for
|
||||||
further information.
|
further information.
|
||||||
|
operationId: requestTokenToRegister
|
||||||
parameters:
|
parameters:
|
||||||
- in: body
|
- in: body
|
||||||
name: body
|
name: body
|
||||||
|
@ -244,6 +246,7 @@ paths:
|
||||||
valid access token is provided.
|
valid access token is provided.
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
|
operationId: changePassword
|
||||||
parameters:
|
parameters:
|
||||||
- in: body
|
- in: body
|
||||||
name: body
|
name: body
|
||||||
|
@ -295,6 +298,7 @@ paths:
|
||||||
.. |/register/email/requestToken| replace:: ``/register/email/requestToken``
|
.. |/register/email/requestToken| replace:: ``/register/email/requestToken``
|
||||||
|
|
||||||
.. _/register/email/requestToken: #post-matrix-client-%CLIENT_MAJOR_VERSION%-register-email-requesttoken
|
.. _/register/email/requestToken: #post-matrix-client-%CLIENT_MAJOR_VERSION%-register-email-requesttoken
|
||||||
|
operationId: requestTokenToResetPassword
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: An email was sent to the given address
|
description: An email was sent to the given address
|
||||||
|
@ -314,6 +318,7 @@ paths:
|
||||||
valid access token is provided.
|
valid access token is provided.
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
|
operationId: deactivateAccount
|
||||||
parameters:
|
parameters:
|
||||||
- in: body
|
- in: body
|
||||||
name: body
|
name: body
|
||||||
|
|
|
@ -24,6 +24,7 @@ paths:
|
||||||
direct replacement; the relevant information is returned by the
|
direct replacement; the relevant information is returned by the
|
||||||
|/sync|_ API. See the `migration guide
|
|/sync|_ API. See the `migration guide
|
||||||
<https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>`_.
|
<https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>`_.
|
||||||
|
operationId: roomInitialSync
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -38,6 +38,7 @@ paths:
|
||||||
The body of the request should be the content object of the event; the
|
The body of the request should be the content object of the event; the
|
||||||
fields in this object will vary depending on the type of event. See
|
fields in this object will vary depending on the type of event. See
|
||||||
`Room Events`_ for the m. event specification.
|
`Room Events`_ for the m. event specification.
|
||||||
|
operationId: sendMessage
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -42,6 +42,7 @@ paths:
|
||||||
The body of the request should be the content object of the event; the
|
The body of the request should be the content object of the event; the
|
||||||
fields in this object will vary depending on the type of event. See
|
fields in this object will vary depending on the type of event. See
|
||||||
`Room Events`_ for the ``m.`` event specification.
|
`Room Events`_ for the ``m.`` event specification.
|
||||||
|
operationId: setRoomStateWithKey
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -104,6 +105,7 @@ paths:
|
||||||
The body of the request should be the content object of the event; the
|
The body of the request should be the content object of the event; the
|
||||||
fields in this object will vary depending on the type of event. See
|
fields in this object will vary depending on the type of event. See
|
||||||
`Room Events`_ for the ``m.`` event specification.
|
`Room Events`_ for the ``m.`` event specification.
|
||||||
|
operationId: setRoomState
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -35,6 +35,7 @@ paths:
|
||||||
joined to the room then the state is taken from the current
|
joined to the room then the state is taken from the current
|
||||||
state of the room. If the user has left the room then the state is
|
state of the room. If the user has left the room then the state is
|
||||||
taken from the state of the room when they left.
|
taken from the state of the room when they left.
|
||||||
|
operationId: getRoomStateWithKey
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -82,6 +83,7 @@ paths:
|
||||||
taken from the state of the room when they left.
|
taken from the state of the room when they left.
|
||||||
|
|
||||||
This looks up the state event with the empty state key.
|
This looks up the state event with the empty state key.
|
||||||
|
operationId: getRoomStateByType
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -118,6 +120,7 @@ paths:
|
||||||
summary: Get all state events in the current state of a room.
|
summary: Get all state events in the current state of a room.
|
||||||
description: |-
|
description: |-
|
||||||
Get the state events for the current state of a room.
|
Get the state events for the current state of a room.
|
||||||
|
operationId: getRoomState
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -234,6 +237,7 @@ paths:
|
||||||
summary: Get the m.room.member events for the room.
|
summary: Get the m.room.member events for the room.
|
||||||
description:
|
description:
|
||||||
Get the list of members for this room.
|
Get the list of members for this room.
|
||||||
|
operationId: getRoomMembers
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -32,6 +32,7 @@ paths:
|
||||||
summary: Perform a server-side search.
|
summary: Perform a server-side search.
|
||||||
description: |-
|
description: |-
|
||||||
Performs a full text search across different categories.
|
Performs a full text search across different categories.
|
||||||
|
operationId: search
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -34,6 +34,7 @@ paths:
|
||||||
Clients use this API when they first log in to get an initial snapshot
|
Clients use this API when they first log in to get an initial snapshot
|
||||||
of the state on the server, and then continue to call this API to get
|
of the state on the server, and then continue to call this API to get
|
||||||
incremental deltas to the state, and to receive new messages.
|
incremental deltas to the state, and to receive new messages.
|
||||||
|
operationId: sync
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -32,6 +32,7 @@ paths:
|
||||||
summary: List the tags for a room.
|
summary: List the tags for a room.
|
||||||
description: |-
|
description: |-
|
||||||
List the tags set by a user on a room.
|
List the tags set by a user on a room.
|
||||||
|
operationId: getRoomTags
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -74,6 +75,7 @@ paths:
|
||||||
summary: Add a tag to a room.
|
summary: Add a tag to a room.
|
||||||
description: |-
|
description: |-
|
||||||
Add a tag to the room.
|
Add a tag to the room.
|
||||||
|
operationId: setRoomTag
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
@ -123,6 +125,7 @@ paths:
|
||||||
summary: Remove a tag from the room.
|
summary: Remove a tag from the room.
|
||||||
description: |-
|
description: |-
|
||||||
Remove a tag from the room.
|
Remove a tag from the room.
|
||||||
|
operationId: deleteRoomTag
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -75,6 +75,7 @@ paths:
|
||||||
append a ``m.room.third_party_invite`` event to the room.
|
append a ``m.room.third_party_invite`` event to the room.
|
||||||
|
|
||||||
.. _joining rooms section: `invite-by-user-id-endpoint`_
|
.. _joining rooms section: `invite-by-user-id-endpoint`_
|
||||||
|
operationId: inviteBy3PID
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -34,6 +34,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
This endpoint is used to send send-to-device events to a set of
|
This endpoint is used to send send-to-device events to a set of
|
||||||
client devices.
|
client devices.
|
||||||
|
operationId: sendToDevice
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -35,6 +35,7 @@ paths:
|
||||||
milliseconds where N is the value specified in the ``timeout`` key.
|
milliseconds where N is the value specified in the ``timeout`` key.
|
||||||
Alternatively, if ``typing`` is ``false``, it tells the server that the
|
Alternatively, if ``typing`` is ``false``, it tells the server that the
|
||||||
user has stopped typing.
|
user has stopped typing.
|
||||||
|
operationId: setTyping
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -33,6 +33,7 @@ paths:
|
||||||
|
|
||||||
Only the latest ``Z`` value will be reported for each supported ``X.Y`` value.
|
Only the latest ``Z`` value will be reported for each supported ``X.Y`` value.
|
||||||
i.e. if the server implements ``r0.0.0``, ``r0.0.1``, and ``r1.2.0``, it will report ``r0.0.1`` and ``r1.2.0``.
|
i.e. if the server implements ``r0.0.0``, ``r0.0.1``, and ``r1.2.0``, it will report ``r0.0.1`` and ``r1.2.0``.
|
||||||
|
operationId: getVersions
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: The versions supported by the server.
|
description: The versions supported by the server.
|
||||||
|
|
|
@ -33,6 +33,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
This API provides credentials for the client to use when initiating
|
This API provides credentials for the client to use when initiating
|
||||||
calls.
|
calls.
|
||||||
|
operationId: getTurnServer
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
responses:
|
responses:
|
||||||
|
|
|
@ -27,6 +27,7 @@ paths:
|
||||||
get:
|
get:
|
||||||
summary: Look up the Matrix user ID for a 3pid.
|
summary: Look up the Matrix user ID for a 3pid.
|
||||||
description: Look up the Matrix user ID for a 3pid.
|
description: Look up the Matrix user ID for a 3pid.
|
||||||
|
operationId: lookupUser
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -28,6 +28,7 @@ paths:
|
||||||
summary: Get a public key.
|
summary: Get a public key.
|
||||||
description: |-
|
description: |-
|
||||||
Get the public key for the passed key ID.
|
Get the public key for the passed key ID.
|
||||||
|
operationId: getPubKey
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
type: string
|
type: string
|
||||||
|
@ -56,6 +57,7 @@ paths:
|
||||||
summary: Check whether a long-term public key is valid.
|
summary: Check whether a long-term public key is valid.
|
||||||
description: |-
|
description: |-
|
||||||
Check whether a long-term public key is valid.
|
Check whether a long-term public key is valid.
|
||||||
|
operationId: isPubKeyValid
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
type: string
|
type: string
|
||||||
|
@ -83,6 +85,7 @@ paths:
|
||||||
summary: Check whether a short-term public key is valid.
|
summary: Check whether a short-term public key is valid.
|
||||||
description: |-
|
description: |-
|
||||||
Check whether a short-term public key is valid.
|
Check whether a short-term public key is valid.
|
||||||
|
operationId: isEphemeralPubKeyValid
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -46,7 +46,7 @@ paths:
|
||||||
Notifications are sent to the URL configured when the pusher is
|
Notifications are sent to the URL configured when the pusher is
|
||||||
created. This means that the HTTP path may be different depending on the
|
created. This means that the HTTP path may be different depending on the
|
||||||
push gateway.
|
push gateway.
|
||||||
|
operationId: notify
|
||||||
parameters:
|
parameters:
|
||||||
- in: body
|
- in: body
|
||||||
name: notification
|
name: notification
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue