mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-20 16:38:37 +01:00
Add note where an endpoint uses capability negotiation (#2223)
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
This commit is contained in:
parent
7f4072d993
commit
fda3be5ee3
|
|
@ -0,0 +1 @@
|
||||||
|
Add note to each endpoint that uses capability negotiation.
|
||||||
|
|
@ -99,6 +99,10 @@ paths:
|
||||||
has been removed, making this endpoint behave as though it was `false`.
|
has been removed, making this endpoint behave as though it was `false`.
|
||||||
This results in this endpoint being an equivalent to `/3pid/bind` rather
|
This results in this endpoint being an equivalent to `/3pid/bind` rather
|
||||||
than dual-purpose.
|
than dual-purpose.
|
||||||
|
|
||||||
|
This endpoint uses [capabilities negotiation](/client-server-api/#capabilities-negotiation).
|
||||||
|
Clients SHOULD check the value of the [`m.3pid_changes` capability](/client-server-api/#m3pid_changes-capability)
|
||||||
|
to determine if this endpoint is available.
|
||||||
operationId: post3PIDs
|
operationId: post3PIDs
|
||||||
deprecated: true
|
deprecated: true
|
||||||
security:
|
security:
|
||||||
|
|
@ -202,6 +206,10 @@ paths:
|
||||||
Homeservers should prevent the caller from adding a 3PID to their account if it has
|
Homeservers should prevent the caller from adding a 3PID to their account if it has
|
||||||
already been added to another user's account on the homeserver.
|
already been added to another user's account on the homeserver.
|
||||||
|
|
||||||
|
This endpoint uses [capabilities negotiation](/client-server-api/#capabilities-negotiation).
|
||||||
|
Clients SHOULD check the value of the [`m.3pid_changes` capability](/client-server-api/#m3pid_changes-capability)
|
||||||
|
to determine if this endpoint is available.
|
||||||
|
|
||||||
{{% boxes/warning %}}
|
{{% boxes/warning %}}
|
||||||
Since this endpoint uses User-Interactive Authentication, it cannot be used when the access token was obtained
|
Since this endpoint uses User-Interactive Authentication, it cannot be used when the access token was obtained
|
||||||
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
||||||
|
|
@ -331,6 +339,10 @@ paths:
|
||||||
Unlike other endpoints, this endpoint does not take an `id_access_token`
|
Unlike other endpoints, this endpoint does not take an `id_access_token`
|
||||||
parameter because the homeserver is expected to sign the request to the
|
parameter because the homeserver is expected to sign the request to the
|
||||||
identity server instead.
|
identity server instead.
|
||||||
|
|
||||||
|
This endpoint uses [capabilities negotiation](/client-server-api/#capabilities-negotiation).
|
||||||
|
Clients SHOULD check the value of the [`m.3pid_changes` capability](/client-server-api/#m3pid_changes-capability)
|
||||||
|
to determine if this endpoint is available.
|
||||||
operationId: delete3pidFromAccount
|
operationId: delete3pidFromAccount
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
|
||||||
|
|
@ -34,6 +34,10 @@ paths:
|
||||||
valid access token is provided. The homeserver SHOULD NOT revoke the
|
valid access token is provided. The homeserver SHOULD NOT revoke the
|
||||||
access token provided in the request. Whether other access tokens for
|
access token provided in the request. Whether other access tokens for
|
||||||
the user are revoked depends on the request parameters.
|
the user are revoked depends on the request parameters.
|
||||||
|
|
||||||
|
This endpoint uses [capabilities negotiation](/client-server-api/#capabilities-negotiation).
|
||||||
|
Clients SHOULD check the value of the [`m.change_password` capability](/client-server-api/#mchange_password-capability)
|
||||||
|
to determine if this endpoint is available.
|
||||||
security:
|
security:
|
||||||
- {}
|
- {}
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
|
||||||
|
|
@ -29,6 +29,11 @@ paths:
|
||||||
Servers MAY reject `null` values. Servers that accept `null` values SHOULD store
|
Servers MAY reject `null` values. Servers that accept `null` values SHOULD store
|
||||||
them rather than treating `null` as a deletion request. Clients that want to delete a
|
them rather than treating `null` as a deletion request. Clients that want to delete a
|
||||||
field, including its key and value, SHOULD use the `DELETE` endpoint instead.
|
field, including its key and value, SHOULD use the `DELETE` endpoint instead.
|
||||||
|
|
||||||
|
This endpoint uses [capabilities negotiation](/client-server-api/#capabilities-negotiation)
|
||||||
|
depending on the `keyName`. Clients SHOULD check the value of the
|
||||||
|
[`m.profile_fields` capability](/client-server-api/#mprofile_fields-capability) to detect
|
||||||
|
which `keyName`s they are allowed to modify.
|
||||||
operationId: setProfileField
|
operationId: setProfileField
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue