mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-26 13:04:10 +01:00
Remove keyId from the server keys endpoints
It has been deprecated forever. Besides, the OpenAPI 3 spec doesn't allow optional path parameters. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
parent
3a84ea7cf6
commit
4e69140520
|
|
@ -188,11 +188,11 @@ draft](https://github.com/matrix-org/matrix-doc/blob/51faf8ed2e4a63d4cfd6d231836
|
||||||
{{% /boxes/note %}}
|
{{% /boxes/note %}}
|
||||||
|
|
||||||
Each homeserver publishes its public keys under
|
Each homeserver publishes its public keys under
|
||||||
`/_matrix/key/v2/server/{keyId}`. Homeservers query for keys by either
|
`/_matrix/key/v2/server`. Homeservers query for keys by either
|
||||||
getting `/_matrix/key/v2/server/{keyId}` directly or by querying an
|
getting `/_matrix/key/v2/server` directly or by querying an
|
||||||
intermediate notary server using a
|
intermediate notary server using a
|
||||||
`/_matrix/key/v2/query/{serverName}/{keyId}` API. Intermediate notary
|
`/_matrix/key/v2/query/{serverName}` API. Intermediate notary
|
||||||
servers query the `/_matrix/key/v2/server/{keyId}` API on behalf of
|
servers query the `/_matrix/key/v2/server` API on behalf of
|
||||||
another server and sign the response with their own key. A server may
|
another server and sign the response with their own key. A server may
|
||||||
query multiple notary servers to ensure that they all report the same
|
query multiple notary servers to ensure that they all report the same
|
||||||
public keys.
|
public keys.
|
||||||
|
|
@ -219,7 +219,7 @@ homeserver and for signing events. It contains a list of
|
||||||
Servers may query another server's keys through a notary server. The
|
Servers may query another server's keys through a notary server. The
|
||||||
notary server may be another homeserver. The notary server will retrieve
|
notary server may be another homeserver. The notary server will retrieve
|
||||||
keys from the queried servers through use of the
|
keys from the queried servers through use of the
|
||||||
`/_matrix/key/v2/server/{keyId}` API. The notary server will
|
`/_matrix/key/v2/server` API. The notary server will
|
||||||
additionally sign the response from the queried server before returning
|
additionally sign the response from the queried server before returning
|
||||||
the results.
|
the results.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ consumes:
|
||||||
produces:
|
produces:
|
||||||
- application/json
|
- application/json
|
||||||
paths:
|
paths:
|
||||||
"/query/{serverName}/{keyId}":
|
"/query/{serverName}":
|
||||||
get:
|
get:
|
||||||
summary: Query for another server's keys
|
summary: Query for another server's keys
|
||||||
description: |-
|
description: |-
|
||||||
|
|
@ -39,17 +39,6 @@ paths:
|
||||||
description: The server's DNS name to query
|
description: The server's DNS name to query
|
||||||
required: true
|
required: true
|
||||||
x-example: matrix.org
|
x-example: matrix.org
|
||||||
- in: path
|
|
||||||
name: keyId
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
**Deprecated**. Servers should not use this parameter and instead
|
|
||||||
opt to return all keys, not just the requested one. The key ID to
|
|
||||||
look up.
|
|
||||||
|
|
||||||
When excluded, the trailing slash on this endpoint is optional.
|
|
||||||
required: false
|
|
||||||
x-example: "ed25519:abc123"
|
|
||||||
- in: query
|
- in: query
|
||||||
name: minimum_valid_until_ts
|
name: minimum_valid_until_ts
|
||||||
type: integer
|
type: integer
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ basePath: /_matrix/key/v2
|
||||||
produces:
|
produces:
|
||||||
- application/json
|
- application/json
|
||||||
paths:
|
paths:
|
||||||
"/server/{keyId}":
|
"/server":
|
||||||
get:
|
get:
|
||||||
summary: Get the homeserver's public key(s)
|
summary: Get the homeserver's public key(s)
|
||||||
description: |-
|
description: |-
|
||||||
|
|
@ -43,19 +43,6 @@ paths:
|
||||||
from the server so that the signatures of old events can still be
|
from the server so that the signatures of old events can still be
|
||||||
checked.
|
checked.
|
||||||
operationId: getServerKey
|
operationId: getServerKey
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: keyId
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
**Deprecated**. Servers should not use this parameter and instead
|
|
||||||
opt to return all keys, not just the requested one. The key ID to
|
|
||||||
look up.
|
|
||||||
|
|
||||||
When excluded, the trailing slash on this endpoint is optional.
|
|
||||||
required: false
|
|
||||||
x-example: "ed25519:abc123"
|
|
||||||
deprecated: true
|
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: The homeserver's keys
|
description: The homeserver's keys
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue