From 7a142936f55791ef67ede727d450d77737f485a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= <76261501+zecakeh@users.noreply.github.com> Date: Fri, 9 Jun 2023 21:57:28 +0200 Subject: [PATCH] Fix level of examples in server keys definition (#1560) --- .../newsfragments/1560.clarification | 1 + data/api/server-server/definitions/keys.yaml | 22 +++++++++---------- 2 files changed, 12 insertions(+), 11 deletions(-) create mode 100644 changelogs/server_server/newsfragments/1560.clarification diff --git a/changelogs/server_server/newsfragments/1560.clarification b/changelogs/server_server/newsfragments/1560.clarification new file mode 100644 index 00000000..e717dda4 --- /dev/null +++ b/changelogs/server_server/newsfragments/1560.clarification @@ -0,0 +1 @@ +Fix level of examples in server keys definition. diff --git a/data/api/server-server/definitions/keys.yaml b/data/api/server-server/definitions/keys.yaml index 97ac1667..efb76f26 100644 --- a/data/api/server-server/definitions/keys.yaml +++ b/data/api/server-server/definitions/keys.yaml @@ -33,17 +33,17 @@ properties: additionalProperties: type: object title: Verify Key - example: { - "ed25519:abc123": { - "key": "VGhpcyBzaG91bGQgYmUgYSByZWFsIGVkMjU1MTkgcGF5bG9hZA" - } - } properties: key: type: string description: The [Unpadded base64](/appendices/#unpadded-base64) encoded key. example: "VGhpcyBzaG91bGQgYmUgYSByZWFsIGVkMjU1MTkgcGF5bG9hZA" required: ["key"] + example: { + "ed25519:abc123": { + "key": "VGhpcyBzaG91bGQgYmUgYSByZWFsIGVkMjU1MTkgcGF5bG9hZA" + } + } old_verify_keys: type: object description: |- @@ -56,12 +56,6 @@ properties: additionalProperties: type: object title: Old Verify Key - example: { - "ed25519:0ldK3y": { - "expired_ts": 1532645052628, - "key": "VGhpcyBzaG91bGQgYmUgeW91ciBvbGQga2V5J3MgZWQyNTUxOSBwYXlsb2FkLg" - } - } properties: expired_ts: type: integer @@ -73,6 +67,12 @@ properties: description: The [Unpadded base64](/appendices/#unpadded-base64) encoded key. example: "VGhpcyBzaG91bGQgYmUgeW91ciBvbGQga2V5J3MgZWQyNTUxOSBwYXlsb2FkLg" required: ["expired_ts", "key"] + example: { + "ed25519:0ldK3y": { + "expired_ts": 1532645052628, + "key": "VGhpcyBzaG91bGQgYmUgeW91ciBvbGQga2V5J3MgZWQyNTUxOSBwYXlsb2FkLg" + } + } signatures: type: object description: |-