Deprecate key ID querying

This commit is contained in:
Travis Ralston 2018-07-26 16:42:21 -06:00
parent 8e97b0ca81
commit 2f71703427
2 changed files with 8 additions and 8 deletions

View file

@ -41,8 +41,9 @@ paths:
name: keyId name: keyId
type: string type: string
description: |- description: |-
The key ID to look up. If omitted or empty, all the server's keys **Deprecated**. Servers should not use this parameter and instead
are to be queried for. opt to return all keys, not just the requested one. The key ID to
look up.
required: false required: false
x-example: "ed25519:abc123" x-example: "ed25519:abc123"
- in: query - in: query

View file

@ -29,10 +29,7 @@ paths:
description: |- description: |-
Gets the homeserver's published TLS fingerprints and signing keys. Gets the homeserver's published TLS fingerprints and signing keys.
The homeserver may have any number of active keys and may have a The homeserver may have any number of active keys and may have a
number of old keys. Homeservers SHOULD return a single JSON object number of old keys.
listing all of its keys, regardless of the ``keyId`` path argument.
This is to reduce the number of round trips needed to discover the
relevant keys for a homeserver.
Intermediate notary servers should cache a response for half of its Intermediate notary servers should cache a response for half of its
lifetime to avoid serving a stale response. Originating servers should lifetime to avoid serving a stale response. Originating servers should
@ -51,10 +48,12 @@ paths:
name: keyId name: keyId
type: string type: string
description: |- description: |-
The key ID to look up. If omitted or empty, all server keys are **Deprecated**. Servers should not use this parameter and instead
to be returned. opt to return all keys, not just the requested one. The key ID to
look up.
required: false required: false
x-example: "ed25519:abc123" x-example: "ed25519:abc123"
deprecated: true
responses: responses:
200: 200:
description: The homeserver's keys description: The homeserver's keys