Full stops, spelling, and operation IDs.
This commit is contained in:
parent
7cb918407d
commit
bafdcf3640
4 changed files with 26 additions and 26 deletions
|
@ -19,12 +19,12 @@ example:
|
|||
properties:
|
||||
server_name:
|
||||
type: string
|
||||
description: DNS name of the homeserver
|
||||
description: DNS name of the homeserver.
|
||||
required: true # TODO: Verify
|
||||
example: "example.org"
|
||||
verify_keys:
|
||||
type: object
|
||||
description: Public keys of the homeserver for verifying digital signatures
|
||||
description: Public keys of the homeserver for verifying digital signatures.
|
||||
required: true # TODO: Verify
|
||||
additionalProperties:
|
||||
type: object
|
||||
|
@ -42,7 +42,7 @@ properties:
|
|||
example: "Base+64+Encoded+Signature+Verification+Key"
|
||||
old_verify_keys:
|
||||
type: object
|
||||
description: The public keys that the server used to use and when it stopped using them
|
||||
description: The public keys that the server used to use and when it stopped using them.
|
||||
additionalProperties:
|
||||
type: object
|
||||
title: Old Verify Key
|
||||
|
@ -56,17 +56,17 @@ properties:
|
|||
expired_ts:
|
||||
type: integer
|
||||
format: int64
|
||||
description: The expiration time
|
||||
description: The expiration time.
|
||||
required: true
|
||||
example: 922834800000
|
||||
key:
|
||||
type: string
|
||||
description: The key
|
||||
description: The key.
|
||||
required: true
|
||||
example: "Base+64+Encoded+Signature+Verification+Key"
|
||||
signatures:
|
||||
type: object
|
||||
description: Digital signatures for this object signed using the ``verify_keys``
|
||||
description: Digital signatures for this object signed using the ``verify_keys``.
|
||||
additionalProperties:
|
||||
type: object
|
||||
title: Signed Server
|
||||
|
@ -80,17 +80,17 @@ properties:
|
|||
name: Encoded Signature Verification Key
|
||||
tls_fingerprints:
|
||||
type: array
|
||||
description: Hashes of X.509 TLS certificates used by this server encoded as `Unpadded Base64`_
|
||||
description: Hashes of X.509 TLS certificates used by this server encoded as `Unpadded Base64`_.
|
||||
items:
|
||||
type: object
|
||||
title: TLS Fingerprint
|
||||
properties:
|
||||
sha256:
|
||||
type: string
|
||||
description: The encoded fingerprint
|
||||
description: The encoded fingerprint.
|
||||
example: Base+64+Encoded+SHA-256-Fingerprint
|
||||
valid_until_ts:
|
||||
type: integer
|
||||
format: int64
|
||||
description: POSIX timestamp when the list of valid keys should be refreshed
|
||||
description: POSIX timestamp when the list of valid keys should be refreshed.
|
||||
example: 1052262000000
|
||||
|
|
|
@ -22,6 +22,6 @@ properties:
|
|||
server_keys:
|
||||
type: array
|
||||
title: Server Keys
|
||||
description: The server keys
|
||||
description: The server keys.
|
||||
items:
|
||||
$ref: "keys.yaml"
|
||||
|
|
|
@ -25,27 +25,27 @@ produces:
|
|||
paths:
|
||||
"/query/{serverName}/{keyId}":
|
||||
get:
|
||||
summary: Retreive a server key
|
||||
description: Retreive a server key
|
||||
operationId: getQueryKeys
|
||||
summary: Retrieve a server key.
|
||||
description: Retrieve a server key.
|
||||
operationId: perspectivesKeyQuery
|
||||
parameters:
|
||||
- in: path
|
||||
name: serverName
|
||||
type: string
|
||||
description: Server name
|
||||
description: Server name.
|
||||
required: true
|
||||
x-example: matrix.org
|
||||
- in: path
|
||||
name: keyId
|
||||
type: string
|
||||
description: Key ID
|
||||
description: Key ID.
|
||||
required: true
|
||||
x-example: TODO # No examples in spec so far
|
||||
- in: query
|
||||
name: minimum_valid_until_ts
|
||||
type: integer
|
||||
format: int64
|
||||
description: Minimum Valid Until Milliseconds
|
||||
description: Minimum Valid Until Milliseconds.
|
||||
required: true # TODO: Verify
|
||||
x-example: 1234567890
|
||||
responses:
|
||||
|
@ -55,9 +55,9 @@ paths:
|
|||
$ref: "definitions/keys_query_response.yaml"
|
||||
"/query":
|
||||
post:
|
||||
summary: Retreive a server key
|
||||
description: Retreive a server key
|
||||
operationId: postQueryKeys
|
||||
summary: Retrieve a server key
|
||||
description: Retrieve a server key.
|
||||
operationId: bulkPerspectivesKeyQuery
|
||||
parameters:
|
||||
- in: body
|
||||
name: body
|
||||
|
@ -76,24 +76,24 @@ paths:
|
|||
properties:
|
||||
server_keys:
|
||||
type: object
|
||||
description: The query criteria
|
||||
description: The query criteria.
|
||||
additionalProperties:
|
||||
type: object
|
||||
name: ServerName
|
||||
description: The server names to query
|
||||
description: The server names to query.
|
||||
additionalProperties:
|
||||
type: object
|
||||
title: Query Criteria
|
||||
description: The server keys to query
|
||||
description: The server keys to query.
|
||||
properties:
|
||||
minimum_valid_until_ts:
|
||||
type: integer
|
||||
format: int64
|
||||
description: Minimum Valid Until MS
|
||||
description: Minimum Valid Until MS.
|
||||
example: 1234567890
|
||||
required: ['server_keys']
|
||||
responses:
|
||||
200:
|
||||
description: The keys for the server
|
||||
description: The keys for the server.
|
||||
schema:
|
||||
$ref: "definitions/keys_query_response.yaml"
|
||||
|
|
|
@ -26,7 +26,7 @@ paths:
|
|||
"/server/{keyId}":
|
||||
get:
|
||||
summary: Get the server's key
|
||||
description: Get the server's key
|
||||
description: Get the server's key.
|
||||
operationId: getServerKey
|
||||
parameters:
|
||||
- in: path
|
||||
|
@ -37,6 +37,6 @@ paths:
|
|||
x-example: TODO # No examples in the spec so far
|
||||
responses:
|
||||
200:
|
||||
description: The server's keys
|
||||
description: The server's keys.
|
||||
schema:
|
||||
$ref: "definitions/keys.yaml"
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue