diff --git a/data/api/client-server/administrative_contact.yaml b/data/api/client-server/administrative_contact.yaml index f1db14db9..d3f0a63ab 100644 --- a/data/api/client-server/administrative_contact.yaml +++ b/data/api/client-server/administrative_contact.yaml @@ -87,7 +87,7 @@ paths: associated the third party identifier with the user. required: ['medium', 'address', 'validated_at', 'added_at'] tags: - - User data + - Account management post: summary: Adds contact information to the user's account. description: |- @@ -179,7 +179,7 @@ paths: schema: "$ref": "definitions/errors/error.yaml" tags: - - User data + - Account management "/account/3pid/add": post: summary: Adds contact information to the user's account. @@ -235,7 +235,7 @@ paths: schema: "$ref": "definitions/errors/rate_limited.yaml" tags: - - User data + - Account management "/account/3pid/bind": post: summary: Binds a 3PID to the user's account through an Identity Service. @@ -289,7 +289,7 @@ paths: schema: "$ref": "definitions/errors/rate_limited.yaml" tags: - - User data + - Account management "/account/3pid/delete": post: summary: Deletes a third party identifier from the user's account @@ -354,7 +354,7 @@ paths: required: - id_server_unbind_result tags: - - User data + - Account management "/account/3pid/unbind": post: summary: Removes a user's third party identifier from an identity server. @@ -418,7 +418,7 @@ paths: required: - id_server_unbind_result tags: - - User data + - Account management "/account/3pid/email/requestToken": post: summary: Begins the validation process for an email address for association with the user's account. @@ -470,6 +470,8 @@ paths: "errcode": "M_THREEPID_IN_USE", "error": "Third party identifier already in use" } + tags: + - Account management "/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: + - Account management diff --git a/data/api/client-server/cross_signing.yaml b/data/api/client-server/cross_signing.yaml index 47ab4da29..3c17cd116 100644 --- a/data/api/client-server/cross_signing.yaml +++ b/data/api/client-server/cross_signing.yaml @@ -136,6 +136,8 @@ paths: "errcode": "M_FORBIDDEN", "error": "Key ID in use" } + tags: + - End-to-end encryption "/keys/signatures/upload": post: summary: Upload cross-signing signatures. @@ -230,3 +232,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 73044c6d1..f52309f10 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 the keys from the backup for a given room. 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 the keys 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 4175b0a96..87806e04a 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 925ad00b8..526233fa4 100644 --- a/data/api/client-server/registration.yaml +++ b/data/api/client-server/registration.yaml @@ -214,7 +214,7 @@ paths: schema: "$ref": "definitions/errors/rate_limited.yaml" tags: - - User data + - Account management "/register/email/requestToken": post: summary: Begins the validation process for an email to be used during registration. @@ -265,6 +265,8 @@ paths: } schema: "$ref": "definitions/errors/error.yaml" + tags: + - Account management "/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: + - Account management "/account/password": post: summary: "Changes a user's password." @@ -378,7 +382,7 @@ paths: schema: "$ref": "definitions/errors/rate_limited.yaml" tags: - - User data + - Account management "/account/password/email/requestToken": post: summary: Requests a validation token be sent to the given email address for the purpose of resetting a user's password @@ -434,6 +438,8 @@ paths: "errcode": "M_THREEPID_NOT_FOUND", "error": "Email not found" } + tags: + - Account management "/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: + - Account management "/account/deactivate": post: summary: "Deactivate a user's account." @@ -565,7 +573,7 @@ paths: schema: "$ref": "definitions/errors/rate_limited.yaml" tags: - - User data + - Account management "/register/available": get: summary: Checks to see if a username is available on the server. @@ -627,4 +635,4 @@ paths: schema: "$ref": "definitions/errors/rate_limited.yaml" tags: - - User data + - Account management diff --git a/data/api/client-server/sso_login_redirect.yaml b/data/api/client-server/sso_login_redirect.yaml index f15f19e49..b58d88fe4 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 3d348df2f..6f8829655 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 diff --git a/data/api/client-server/users.yaml b/data/api/client-server/users.yaml index 4a264f3a1..ae015e7a5 100644 --- a/data/api/client-server/users.yaml +++ b/data/api/client-server/users.yaml @@ -107,4 +107,4 @@ paths: schema: "$ref": "definitions/errors/rate_limited.yaml" tags: - - User data + - User directory diff --git a/data/api/client-server/whoami.yaml b/data/api/client-server/whoami.yaml index 3458c4d0d..54d9cde90 100644 --- a/data/api/client-server/whoami.yaml +++ b/data/api/client-server/whoami.yaml @@ -89,4 +89,4 @@ paths: schema: "$ref": "definitions/errors/rate_limited.yaml" tags: - - User data + - Session management