Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use OneTimeKeys schema #1800

Merged
merged 3 commits into from
Apr 30, 2024
Merged

Use OneTimeKeys schema #1800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eee82fd
Use OneTimeKeys schema
zecakeh Apr 24, 2024
3e81ec2
Add changelog
zecakeh Apr 24, 2024
9578479
Merge remote-tracking branch 'origin/main' into one-time-keys
richvdh Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/internal/newsfragments/1800.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Use reference to `OneTimeKeys` schema in OpenAPI definitions.
3 changes: 2 additions & 1 deletion data/api/client-server/definitions/one_time_keys.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ additionalProperties:
oneOf:
- type: string
- type: object
title: KeyObject
properties:
key:
type: string
Expand All @@ -18,7 +19,7 @@ additionalProperties:
description: |-
Signature for the device. Mapped from user ID to signature object,
containing mapping from _key signing identifier_ to the signature
(see also: https://spec.matrix.org/v1.2/appendices/#signing-json)
(see also: [Signing JSON](/appendices/#signing-json))
additionalProperties:
type: object
required: ['key', 'signatures']
20 changes: 5 additions & 15 deletions data/api/client-server/keys.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,9 @@ paths:
allOf:
- $ref: definitions/device_keys.yaml
one_time_keys:
# $ref: "definitions/one_time_keys.yaml"
# XXX: We can't define an actual object here, so we have to hope
# that people will look at the OpenAPI source or can figure it out
# from the other endpoints/example.
allOf:
- $ref: "definitions/one_time_keys.yaml"
type: object
title: OneTimeKeys
description: |-
One-time public keys for "pre-key" messages. The names of
the properties should be in the format
Expand All @@ -65,10 +62,9 @@ paths:
ed25519:JLAFKJWSCS: IQeCEPb9HFk217cU9kw9EOiusC6kMIkoIRnbnfOh5Oc63S1ghgyjShBGpu34blQomoalCyXWyhaaT3MrLZYQAA
fallback_keys:
x-addedInMatrixVersion: "1.2"
# $ref: "definitions/one_time_keys.yaml"
# XXX: We can't define an actual object here - see above.
allOf:
- $ref: "definitions/one_time_keys.yaml"
type: object
title: OneTimeKeys
description: |-
The public key which should be used if the device's one-time keys
are exhausted. The fallback key is not deleted once used, but should
Expand Down Expand Up @@ -349,13 +345,7 @@ paths:
additionalProperties:
type: object
additionalProperties:
# $ref: "definitions/one_time_keys.yaml"
# XXX: We can't define an actual object here, so we have to hope
# that people will read the link provided in the description
# and figure it out from the other endpoints/example.
# See also one_time_key parameter for /keys/upload above.
type: object
title: OneTimeKeys
$ref: "definitions/one_time_keys.yaml"
example:
"@alice:example.com":
JLAFKJWSCS:
Expand Down