Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-26 21:14:09 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse source 
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
This commit is contained in:
Tulir Asokan 2023-05-23 11:48:37 +03:00 committed by GitHub
parent 7e1c1a76e7
commit e02c69de83
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
data/api/application-service/ping.yaml
View file

@ -56,7 +56,7 @@ paths:
client API appservice ping call. client API appservice ping call.
responses: responses:
200: 200:
description: The hs_token is valid and the ping request was successful. description: The provided `hs_token` is valid and the ping request was successful.
examples: examples:
application/json: {} application/json: {}
schema: schema:

14
data/api/client-server/appservice_ping.yaml
View file

@ -35,12 +35,13 @@ paths:
summary: |- summary: |-
Ask the homeserver to ping the application service to ensure the connection works. Ask the homeserver to ping the application service to ensure the connection works.
description: |- description: |-
This API asks the homeserver to call the `/_matrix/app/v1/ping` endpoint This API asks the homeserver to call the
on the application service to ensure that the homeserver can communicate [`/_matrix/app/v1/ping`](#post_matrixappv1ping) endpoint on the
application service to ensure that the homeserver can communicate
with the application service. with the application service.
This API requires the use of an application service access token (`as_token`) This API requires the use of an application service access token (`as_token`)
instead of a typical client's access_token. This API cannot be invoked by instead of a typical client's access token. This API cannot be invoked by
users who are not identified as application services. Additionally, the users who are not identified as application services. Additionally, the
appservice ID in the path must be the same as the appservice whose `as_token` appservice ID in the path must be the same as the appservice whose `as_token`
is being used. is being used.
@ -71,15 +72,16 @@ paths:
- accessToken: [] - accessToken: []
responses: responses:
200: 200:
description: The ping was successful description: The ping was successful.
schema: schema:
type: object type: object
properties: properties:
duration_ms: duration_ms:
type: integer type: integer
description: |- description: |-
The duration that the `/_matrix/app/v1/ping` request took The duration in milliseconds that the
from the homeserver's point of view. [`/_matrix/app/v1/ping`](#post_matrixappv1ping)
request took from the homeserver's point of view.
examples: examples:
application/json: {"duration_ms": 123} application/json: {"duration_ms": 123}
400: 400: