Update content to call the new template for HTTP APIs
This commit is contained in:
parent
1d629bae40
commit
52f5e73a39
27 changed files with 98 additions and 98 deletions
|
@ -23,7 +23,7 @@ These events can also be received in a `/events` response or in the
|
|||
|
||||
#### Client Behaviour
|
||||
|
||||
{{account\_data\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="account-data" %}}
|
||||
|
||||
#### Server Behaviour
|
||||
|
||||
|
|
|
@ -10,4 +10,4 @@ server state and data.
|
|||
|
||||
#### Client Behaviour
|
||||
|
||||
{{admin\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="admin" %}}
|
||||
|
|
|
@ -34,7 +34,7 @@ look like:
|
|||
|
||||
Clients can upload and download content using the following HTTP APIs.
|
||||
|
||||
{{content\_repo\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="content-repo" %}}
|
||||
|
||||
##### Thumbnails
|
||||
|
||||
|
|
|
@ -13,7 +13,7 @@ Clients that implement this module should offer the user a list of
|
|||
registered devices, as well as the means to update their display names.
|
||||
Clients should also allow users to delete disused devices.
|
||||
|
||||
{{device\_management\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="device_management" %}}
|
||||
|
||||
#### Security considerations
|
||||
|
||||
|
|
|
@ -905,7 +905,7 @@ To avoid leaking of social graphs, servers will only allow users to see:
|
|||
Users will not be able to see signatures made by other users'
|
||||
user-signing keys.
|
||||
|
||||
{{cross\_signing\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="cross_signing" %}}
|
||||
|
||||
#### Sharing keys between devices
|
||||
|
||||
|
@ -1050,7 +1050,7 @@ The `session_data` field in the backups is constructed as follows:
|
|||
the resulting MAC are base64-encoded, and become the `mac` property
|
||||
of the `session_data`.
|
||||
|
||||
{{key\_backup\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="key_backup" %}}
|
||||
|
||||
##### Key exports
|
||||
|
||||
|
@ -1369,7 +1369,7 @@ messages.
|
|||
|
||||
##### Key management API
|
||||
|
||||
{{keys\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="keys" %}}
|
||||
|
||||
##### Extensions to /sync
|
||||
|
||||
|
|
|
@ -14,7 +14,7 @@ an event.
|
|||
There is a single HTTP API for retrieving event context, documented
|
||||
below.
|
||||
|
||||
{{event\_context\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="event_context" %}}
|
||||
|
||||
#### Security considerations
|
||||
|
||||
|
|
|
@ -10,4 +10,4 @@ service. The third party service does need to be matrix-aware in that it
|
|||
will need to know to resolve matrix homeservers to exchange the user's
|
||||
token for identity information.
|
||||
|
||||
{{openid\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="openid" %}}
|
||||
|
|
|
@ -37,7 +37,7 @@ enum of one of the following:
|
|||
Clients can manually set/get their presence using the HTTP APIs listed
|
||||
below.
|
||||
|
||||
{{presence\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="presence" %}}
|
||||
|
||||
##### Last active ago
|
||||
|
||||
|
|
|
@ -90,7 +90,7 @@ Clients MUST configure a Pusher before they will receive push
|
|||
notifications. There is a single API endpoint for this, as described
|
||||
below.
|
||||
|
||||
{{pusher\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="pusher" %}}
|
||||
|
||||
##### Listing Notifications
|
||||
|
||||
|
@ -98,7 +98,7 @@ A client can retrieve a list of events that it has been notified about.
|
|||
This may be useful so that users can see a summary of what important
|
||||
messages they have received.
|
||||
|
||||
{{notifications\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="notifications" %}}
|
||||
|
||||
##### Receiving notifications
|
||||
|
||||
|
@ -658,7 +658,7 @@ Definition:
|
|||
Clients can retrieve, add, modify and remove push rules globally or
|
||||
per-device using the APIs below.
|
||||
|
||||
{{pushrules\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="pushrules" %}}
|
||||
|
||||
##### Push Rules: Events
|
||||
|
||||
|
|
|
@ -39,7 +39,7 @@ commonly updated at the same time, and therefore the client might wish
|
|||
to save an extra HTTP call. Providing an `m.read` location performs the
|
||||
same task as a request to `/receipt/m.read/$event:example.org`.
|
||||
|
||||
{{read\_markers\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="read_markers" %}}
|
||||
|
||||
#### Server behaviour
|
||||
|
||||
|
|
|
@ -58,7 +58,7 @@ for events sent by their own user.
|
|||
A client can update the markers for its user by interacting with the
|
||||
following HTTP APIs.
|
||||
|
||||
{{receipts\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="receipts" %}}
|
||||
|
||||
#### Server behaviour
|
||||
|
||||
|
|
|
@ -14,7 +14,7 @@ offensive" and 0 is "inoffensive".
|
|||
|
||||
#### Client behaviour
|
||||
|
||||
{{report\_content\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="report_content" %}}
|
||||
|
||||
#### Server behaviour
|
||||
|
||||
|
|
|
@ -25,7 +25,7 @@ Clients can of course also call other endpoints such as [GET
|
|||
and [GET /search](#post_matrixclientr0search) to
|
||||
access events outside the `/events` stream.
|
||||
|
||||
{{peeking\_events\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="peeking_events" %}}
|
||||
|
||||
#### Server behaviour
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ old room. Another approach may be to virtually merge the rooms such that
|
|||
the old room's timeline seamlessly continues into the new timeline
|
||||
without the user having to jump between the rooms.
|
||||
|
||||
{{room\_upgrades\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="room_upgrades" %}}
|
||||
|
||||
#### Server behaviour
|
||||
|
||||
|
|
|
@ -15,7 +15,7 @@ it won't include events in rooms that happened after you left.
|
|||
There is a single HTTP API for performing server-side search, documented
|
||||
below.
|
||||
|
||||
{{search\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="search" %}}
|
||||
|
||||
#### Search Categories
|
||||
|
||||
|
|
|
@ -52,7 +52,7 @@ should be sent on to the remote servers via
|
|||
|
||||
#### Protocol definitions
|
||||
|
||||
{{to\_device\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="to_device" %}}
|
||||
|
||||
##### Extensions to /sync
|
||||
|
||||
|
|
|
@ -104,7 +104,7 @@ The client starts the process by instructing the browser to navigate to
|
|||
authentication is successful, the browser will be redirected to that
|
||||
`redirectUrl`.
|
||||
|
||||
{{sso\_login\_redirect\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="sso_login_redirect" %}}
|
||||
|
||||
###### Security considerations
|
||||
|
||||
|
|
|
@ -63,4 +63,4 @@ tags are defined in the `m.*` namespace:
|
|||
|
||||
#### Client Behaviour
|
||||
|
||||
{{tags\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="tags" %}}
|
||||
|
|
|
@ -37,7 +37,7 @@ invitee does indeed own that third party identifier. See the
|
|||
|
||||
A client asks a server to invite a user by their third party identifier.
|
||||
|
||||
{{third\_party\_membership\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="third_party_membership" %}}
|
||||
|
||||
#### Server behaviour
|
||||
|
||||
|
|
|
@ -19,4 +19,4 @@ A client may wish to provide a rich interface for joining third party
|
|||
locations and connecting with third party users. Information necessary
|
||||
for such an interface is provided by third party lookups.
|
||||
|
||||
{{third\_party\_lookup\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="third_party_lookup" %}}
|
||||
|
|
|
@ -33,7 +33,7 @@ recommended. When the user stops typing, the state change of the
|
|||
`boolean` to `false` should trigger another HTTP request to inform the
|
||||
server that the user has stopped typing.
|
||||
|
||||
{{typing\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="typing" %}}
|
||||
|
||||
#### Security considerations
|
||||
|
||||
|
|
|
@ -82,7 +82,7 @@ The homeserver MAY provide a TURN server which clients can use to
|
|||
contact the remote party. The following HTTP API endpoints will be used
|
||||
by clients in order to get information about the TURN server.
|
||||
|
||||
{{voip\_cs\_http\_api}}
|
||||
{{% http-api spec="client-server" api="voip" %}}
|
||||
|
||||
#### Security considerations
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue