From 97ebe5aec2d8cf2c8fd3e084c1ea065ca193f912 Mon Sep 17 00:00:00 2001 From: Lukas Lihotzki Date: Tue, 10 Aug 2021 19:24:37 +0200 Subject: [PATCH] OpenAPI: add missing tags peekEvents remains untagged, because it is explicitly excluded. Signed-off-by: Lukas Lihotzki --- data/api/client-server/administrative_contact.yaml | 4 ++++ data/api/client-server/cross_signing.yaml | 4 ++++ data/api/client-server/key_backup.yaml | 12 ++++++++++++ data/api/client-server/list_public_rooms.yaml | 4 ++++ data/api/client-server/registration.yaml | 8 ++++++++ data/api/client-server/sso_login_redirect.yaml | 4 ++++ data/api/client-server/third_party_lookup.yaml | 12 ++++++++++++ 7 files changed, 48 insertions(+) diff --git a/data/api/client-server/administrative_contact.yaml b/data/api/client-server/administrative_contact.yaml index f1db14db..313ce17d 100644 --- a/data/api/client-server/administrative_contact.yaml +++ b/data/api/client-server/administrative_contact.yaml @@ -470,6 +470,8 @@ paths: "errcode": "M_THREEPID_IN_USE", "error": "Third party identifier already in use" } + tags: + - User data "/account/3pid/msisdn/requestToken": post: summary: Begins the validation process for a phone number for association with the user's account. @@ -518,3 +520,5 @@ paths: "errcode": "M_THREEPID_IN_USE", "error": "Third party identifier already in use" } + tags: + - User data diff --git a/data/api/client-server/cross_signing.yaml b/data/api/client-server/cross_signing.yaml index a0516ef2..6f83606b 100644 --- a/data/api/client-server/cross_signing.yaml +++ b/data/api/client-server/cross_signing.yaml @@ -129,6 +129,8 @@ paths: "errcode": "M_FORBIDDEN", "error": "Key ID in use" } + tags: + - End-to-end encryption "/keys/signatures/upload": post: summary: Upload cross-signing signatures. @@ -222,3 +224,5 @@ paths: } } } + tags: + - End-to-end encryption diff --git a/data/api/client-server/key_backup.yaml b/data/api/client-server/key_backup.yaml index 7c42f6b5..08f3b20b 100644 --- a/data/api/client-server/key_backup.yaml +++ b/data/api/client-server/key_backup.yaml @@ -487,6 +487,8 @@ paths: description: This request was rate-limited. schema: "$ref": "definitions/errors/rate_limited.yaml" + tags: + - End-to-end encryption delete: summary: Delete a key from the backup description: |- @@ -547,6 +549,8 @@ paths: description: This request was rate-limited. schema: "$ref": "definitions/errors/rate_limited.yaml" + tags: + - End-to-end encryption "/room_keys/keys/{roomId}": put: summary: Store several keys in the backup for a given room. @@ -666,6 +670,8 @@ paths: description: This request was rate-limited. schema: "$ref": "definitions/errors/rate_limited.yaml" + tags: + - End-to-end encryption delete: summary: Delete a key from the backup description: |- @@ -720,6 +726,8 @@ paths: description: This request was rate-limited. schema: "$ref": "definitions/errors/rate_limited.yaml" + tags: + - End-to-end encryption "/room_keys/keys": put: summary: Store several keys in the backup. @@ -875,6 +883,8 @@ paths: description: This request was rate-limited. schema: "$ref": "definitions/errors/rate_limited.yaml" + tags: + - End-to-end encryption delete: summary: Delete a key from the backup description: |- @@ -923,3 +933,5 @@ paths: description: This request was rate-limited. schema: "$ref": "definitions/errors/rate_limited.yaml" + tags: + - End-to-end encryption diff --git a/data/api/client-server/list_public_rooms.yaml b/data/api/client-server/list_public_rooms.yaml index 4175b0a9..87806e04 100644 --- a/data/api/client-server/list_public_rooms.yaml +++ b/data/api/client-server/list_public_rooms.yaml @@ -61,6 +61,8 @@ paths: } schema: "$ref": "definitions/errors/error.yaml" + tags: + - Room discovery put: summary: Sets the visibility of a room in the room directory description: |- @@ -111,6 +113,8 @@ paths: } schema: "$ref": "definitions/errors/error.yaml" + tags: + - Room discovery "/publicRooms": get: summary: Lists the public rooms on the server. diff --git a/data/api/client-server/registration.yaml b/data/api/client-server/registration.yaml index 925ad00b..be416e70 100644 --- a/data/api/client-server/registration.yaml +++ b/data/api/client-server/registration.yaml @@ -265,6 +265,8 @@ paths: } schema: "$ref": "definitions/errors/error.yaml" + tags: + - User data "/register/msisdn/requestToken": post: summary: Requests a validation token be sent to the given phone number for the purpose of registering an account @@ -315,6 +317,8 @@ paths: } schema: "$ref": "definitions/errors/error.yaml" + tags: + - User data "/account/password": post: summary: "Changes a user's password." @@ -434,6 +438,8 @@ paths: "errcode": "M_THREEPID_NOT_FOUND", "error": "Email not found" } + tags: + - User data "/account/password/msisdn/requestToken": post: summary: Requests a validation token be sent to the given phone number for the purpose of resetting a user's password. @@ -489,6 +495,8 @@ paths: "errcode": "M_THREEPID_NOT_FOUND", "error": "Phone number not found" } + tags: + - User data "/account/deactivate": post: summary: "Deactivate a user's account." diff --git a/data/api/client-server/sso_login_redirect.yaml b/data/api/client-server/sso_login_redirect.yaml index f15f19e4..b58d88fe 100644 --- a/data/api/client-server/sso_login_redirect.yaml +++ b/data/api/client-server/sso_login_redirect.yaml @@ -46,6 +46,8 @@ paths: headers: Location: type: "string" + tags: + - Session management "/login/sso/redirect/{idpId}": get: summary: Redirect the user's browser to the SSO interface for an IdP. @@ -83,3 +85,5 @@ paths: The IdP ID was not recognized by the server. The server is encouraged to provide a user-friendly page explaining the error given the user will be navigated to it. + tags: + - Session management diff --git a/data/api/client-server/third_party_lookup.yaml b/data/api/client-server/third_party_lookup.yaml index 3d348df2..6f882965 100644 --- a/data/api/client-server/third_party_lookup.yaml +++ b/data/api/client-server/third_party_lookup.yaml @@ -42,6 +42,8 @@ paths: description: The protocols supported by the homeserver. schema: $ref: ../application-service/definitions/protocol_metadata.yaml + tags: + - Third Party Lookup "/thirdparty/protocol/{protocol}": get: summary: Retrieve metadata about a specific protocol that the homeserver supports. @@ -71,6 +73,8 @@ paths: } schema: $ref: definitions/errors/error.yaml + tags: + - Third Party Lookup "/thirdparty/location/{protocol}": get: summary: Retrieve Matrix-side portals rooms leading to a third party location. @@ -112,6 +116,8 @@ paths: } schema: $ref: definitions/errors/error.yaml + tags: + - Third Party Lookup "/thirdparty/user/{protocol}": get: summary: Retrieve the Matrix User ID of a corresponding third party user. @@ -147,6 +153,8 @@ paths: } schema: $ref: definitions/errors/error.yaml + tags: + - Third Party Lookup "/thirdparty/location": get: summary: Reverse-lookup third party locations given a Matrix room alias. @@ -177,6 +185,8 @@ paths: } schema: $ref: definitions/errors/error.yaml + tags: + - Third Party Lookup "/thirdparty/user": get: summary: Reverse-lookup third party users given a Matrix User ID. @@ -206,3 +216,5 @@ paths: } schema: $ref: definitions/errors/error.yaml + tags: + - Third Party Lookup