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:
|
properties:
|
||||||
server_name:
|
server_name:
|
||||||
type: string
|
type: string
|
||||||
description: DNS name of the homeserver
|
description: DNS name of the homeserver.
|
||||||
required: true # TODO: Verify
|
required: true # TODO: Verify
|
||||||
example: "example.org"
|
example: "example.org"
|
||||||
verify_keys:
|
verify_keys:
|
||||||
type: object
|
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
|
required: true # TODO: Verify
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: object
|
type: object
|
||||||
|
@ -42,7 +42,7 @@ properties:
|
||||||
example: "Base+64+Encoded+Signature+Verification+Key"
|
example: "Base+64+Encoded+Signature+Verification+Key"
|
||||||
old_verify_keys:
|
old_verify_keys:
|
||||||
type: object
|
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:
|
additionalProperties:
|
||||||
type: object
|
type: object
|
||||||
title: Old Verify Key
|
title: Old Verify Key
|
||||||
|
@ -56,17 +56,17 @@ properties:
|
||||||
expired_ts:
|
expired_ts:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
description: The expiration time
|
description: The expiration time.
|
||||||
required: true
|
required: true
|
||||||
example: 922834800000
|
example: 922834800000
|
||||||
key:
|
key:
|
||||||
type: string
|
type: string
|
||||||
description: The key
|
description: The key.
|
||||||
required: true
|
required: true
|
||||||
example: "Base+64+Encoded+Signature+Verification+Key"
|
example: "Base+64+Encoded+Signature+Verification+Key"
|
||||||
signatures:
|
signatures:
|
||||||
type: object
|
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:
|
additionalProperties:
|
||||||
type: object
|
type: object
|
||||||
title: Signed Server
|
title: Signed Server
|
||||||
|
@ -80,17 +80,17 @@ properties:
|
||||||
name: Encoded Signature Verification Key
|
name: Encoded Signature Verification Key
|
||||||
tls_fingerprints:
|
tls_fingerprints:
|
||||||
type: array
|
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:
|
items:
|
||||||
type: object
|
type: object
|
||||||
title: TLS Fingerprint
|
title: TLS Fingerprint
|
||||||
properties:
|
properties:
|
||||||
sha256:
|
sha256:
|
||||||
type: string
|
type: string
|
||||||
description: The encoded fingerprint
|
description: The encoded fingerprint.
|
||||||
example: Base+64+Encoded+SHA-256-Fingerprint
|
example: Base+64+Encoded+SHA-256-Fingerprint
|
||||||
valid_until_ts:
|
valid_until_ts:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
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
|
example: 1052262000000
|
||||||
|
|
|
@ -22,6 +22,6 @@ properties:
|
||||||
server_keys:
|
server_keys:
|
||||||
type: array
|
type: array
|
||||||
title: Server Keys
|
title: Server Keys
|
||||||
description: The server keys
|
description: The server keys.
|
||||||
items:
|
items:
|
||||||
$ref: "keys.yaml"
|
$ref: "keys.yaml"
|
||||||
|
|
|
@ -25,27 +25,27 @@ produces:
|
||||||
paths:
|
paths:
|
||||||
"/query/{serverName}/{keyId}":
|
"/query/{serverName}/{keyId}":
|
||||||
get:
|
get:
|
||||||
summary: Retreive a server key
|
summary: Retrieve a server key.
|
||||||
description: Retreive a server key
|
description: Retrieve a server key.
|
||||||
operationId: getQueryKeys
|
operationId: perspectivesKeyQuery
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: serverName
|
name: serverName
|
||||||
type: string
|
type: string
|
||||||
description: Server name
|
description: Server name.
|
||||||
required: true
|
required: true
|
||||||
x-example: matrix.org
|
x-example: matrix.org
|
||||||
- in: path
|
- in: path
|
||||||
name: keyId
|
name: keyId
|
||||||
type: string
|
type: string
|
||||||
description: Key ID
|
description: Key ID.
|
||||||
required: true
|
required: true
|
||||||
x-example: TODO # No examples in spec so far
|
x-example: TODO # No examples in spec so far
|
||||||
- in: query
|
- in: query
|
||||||
name: minimum_valid_until_ts
|
name: minimum_valid_until_ts
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
description: Minimum Valid Until Milliseconds
|
description: Minimum Valid Until Milliseconds.
|
||||||
required: true # TODO: Verify
|
required: true # TODO: Verify
|
||||||
x-example: 1234567890
|
x-example: 1234567890
|
||||||
responses:
|
responses:
|
||||||
|
@ -55,9 +55,9 @@ paths:
|
||||||
$ref: "definitions/keys_query_response.yaml"
|
$ref: "definitions/keys_query_response.yaml"
|
||||||
"/query":
|
"/query":
|
||||||
post:
|
post:
|
||||||
summary: Retreive a server key
|
summary: Retrieve a server key
|
||||||
description: Retreive a server key
|
description: Retrieve a server key.
|
||||||
operationId: postQueryKeys
|
operationId: bulkPerspectivesKeyQuery
|
||||||
parameters:
|
parameters:
|
||||||
- in: body
|
- in: body
|
||||||
name: body
|
name: body
|
||||||
|
@ -76,24 +76,24 @@ paths:
|
||||||
properties:
|
properties:
|
||||||
server_keys:
|
server_keys:
|
||||||
type: object
|
type: object
|
||||||
description: The query criteria
|
description: The query criteria.
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: object
|
type: object
|
||||||
name: ServerName
|
name: ServerName
|
||||||
description: The server names to query
|
description: The server names to query.
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: object
|
type: object
|
||||||
title: Query Criteria
|
title: Query Criteria
|
||||||
description: The server keys to query
|
description: The server keys to query.
|
||||||
properties:
|
properties:
|
||||||
minimum_valid_until_ts:
|
minimum_valid_until_ts:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
description: Minimum Valid Until MS
|
description: Minimum Valid Until MS.
|
||||||
example: 1234567890
|
example: 1234567890
|
||||||
required: ['server_keys']
|
required: ['server_keys']
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: The keys for the server
|
description: The keys for the server.
|
||||||
schema:
|
schema:
|
||||||
$ref: "definitions/keys_query_response.yaml"
|
$ref: "definitions/keys_query_response.yaml"
|
||||||
|
|
|
@ -26,7 +26,7 @@ paths:
|
||||||
"/server/{keyId}":
|
"/server/{keyId}":
|
||||||
get:
|
get:
|
||||||
summary: Get the server's key
|
summary: Get the server's key
|
||||||
description: Get the server's key
|
description: Get the server's key.
|
||||||
operationId: getServerKey
|
operationId: getServerKey
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
@ -37,6 +37,6 @@ paths:
|
||||||
x-example: TODO # No examples in the spec so far
|
x-example: TODO # No examples in the spec so far
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: The server's keys
|
description: The server's keys.
|
||||||
schema:
|
schema:
|
||||||
$ref: "definitions/keys.yaml"
|
$ref: "definitions/keys.yaml"
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue