Skip to content

Commit 3497a8d

Browse files
committed
OpenAPI: add missing tags
peekEvents remains untagged, because it is explicitly excluded. Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
1 parent a03ea34 commit 3497a8d

File tree

7 files changed

+48
-0
lines changed

7 files changed

+48
-0
lines changed

data/api/client-server/administrative_contact.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -470,6 +470,8 @@ paths:
470470
"errcode": "M_THREEPID_IN_USE",
471471
"error": "Third party identifier already in use"
472472
}
473+
tags:
474+
- User data
473475
"/account/3pid/msisdn/requestToken":
474476
post:
475477
summary: Begins the validation process for a phone number for association with the user's account.
@@ -518,3 +520,5 @@ paths:
518520
"errcode": "M_THREEPID_IN_USE",
519521
"error": "Third party identifier already in use"
520522
}
523+
tags:
524+
- User data

data/api/client-server/cross_signing.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,8 @@ paths:
129129
"errcode": "M_FORBIDDEN",
130130
"error": "Key ID in use"
131131
}
132+
tags:
133+
- End-to-end encryption
132134
"/keys/signatures/upload":
133135
post:
134136
summary: Upload cross-signing signatures.
@@ -222,3 +224,5 @@ paths:
222224
}
223225
}
224226
}
227+
tags:
228+
- End-to-end encryption

data/api/client-server/key_backup.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,8 @@ paths:
487487
description: This request was rate-limited.
488488
schema:
489489
"$ref": "definitions/errors/rate_limited.yaml"
490+
tags:
491+
- End-to-end encryption
490492
delete:
491493
summary: Delete a key from the backup
492494
description: |-
@@ -547,6 +549,8 @@ paths:
547549
description: This request was rate-limited.
548550
schema:
549551
"$ref": "definitions/errors/rate_limited.yaml"
552+
tags:
553+
- End-to-end encryption
550554
"/room_keys/keys/{roomId}":
551555
put:
552556
summary: Store several keys in the backup for a given room.
@@ -666,6 +670,8 @@ paths:
666670
description: This request was rate-limited.
667671
schema:
668672
"$ref": "definitions/errors/rate_limited.yaml"
673+
tags:
674+
- End-to-end encryption
669675
delete:
670676
summary: Delete a key from the backup
671677
description: |-
@@ -720,6 +726,8 @@ paths:
720726
description: This request was rate-limited.
721727
schema:
722728
"$ref": "definitions/errors/rate_limited.yaml"
729+
tags:
730+
- End-to-end encryption
723731
"/room_keys/keys":
724732
put:
725733
summary: Store several keys in the backup.
@@ -875,6 +883,8 @@ paths:
875883
description: This request was rate-limited.
876884
schema:
877885
"$ref": "definitions/errors/rate_limited.yaml"
886+
tags:
887+
- End-to-end encryption
878888
delete:
879889
summary: Delete a key from the backup
880890
description: |-
@@ -923,3 +933,5 @@ paths:
923933
description: This request was rate-limited.
924934
schema:
925935
"$ref": "definitions/errors/rate_limited.yaml"
936+
tags:
937+
- End-to-end encryption

data/api/client-server/list_public_rooms.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ paths:
6161
}
6262
schema:
6363
"$ref": "definitions/errors/error.yaml"
64+
tags:
65+
- Room discovery
6466
put:
6567
summary: Sets the visibility of a room in the room directory
6668
description: |-
@@ -111,6 +113,8 @@ paths:
111113
}
112114
schema:
113115
"$ref": "definitions/errors/error.yaml"
116+
tags:
117+
- Room discovery
114118
"/publicRooms":
115119
get:
116120
summary: Lists the public rooms on the server.

data/api/client-server/registration.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,8 @@ paths:
265265
}
266266
schema:
267267
"$ref": "definitions/errors/error.yaml"
268+
tags:
269+
- User data
268270
"/register/msisdn/requestToken":
269271
post:
270272
summary: Requests a validation token be sent to the given phone number for the purpose of registering an account
@@ -315,6 +317,8 @@ paths:
315317
}
316318
schema:
317319
"$ref": "definitions/errors/error.yaml"
320+
tags:
321+
- User data
318322
"/account/password":
319323
post:
320324
summary: "Changes a user's password."
@@ -434,6 +438,8 @@ paths:
434438
"errcode": "M_THREEPID_NOT_FOUND",
435439
"error": "Email not found"
436440
}
441+
tags:
442+
- User data
437443
"/account/password/msisdn/requestToken":
438444
post:
439445
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:
489495
"errcode": "M_THREEPID_NOT_FOUND",
490496
"error": "Phone number not found"
491497
}
498+
tags:
499+
- User data
492500
"/account/deactivate":
493501
post:
494502
summary: "Deactivate a user's account."

data/api/client-server/sso_login_redirect.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ paths:
4646
headers:
4747
Location:
4848
type: "string"
49+
tags:
50+
- Session management
4951
"/login/sso/redirect/{idpId}":
5052
get:
5153
summary: Redirect the user's browser to the SSO interface for an IdP.
@@ -83,3 +85,5 @@ paths:
8385
The IdP ID was not recognized by the server. The server is encouraged
8486
to provide a user-friendly page explaining the error given the user
8587
will be navigated to it.
88+
tags:
89+
- Session management

data/api/client-server/third_party_lookup.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ paths:
4242
description: The protocols supported by the homeserver.
4343
schema:
4444
$ref: ../application-service/definitions/protocol_metadata.yaml
45+
tags:
46+
- Third Party Lookup
4547
"/thirdparty/protocol/{protocol}":
4648
get:
4749
summary: Retrieve metadata about a specific protocol that the homeserver supports.
@@ -71,6 +73,8 @@ paths:
7173
}
7274
schema:
7375
$ref: definitions/errors/error.yaml
76+
tags:
77+
- Third Party Lookup
7478
"/thirdparty/location/{protocol}":
7579
get:
7680
summary: Retrieve Matrix-side portals rooms leading to a third party location.
@@ -112,6 +116,8 @@ paths:
112116
}
113117
schema:
114118
$ref: definitions/errors/error.yaml
119+
tags:
120+
- Third Party Lookup
115121
"/thirdparty/user/{protocol}":
116122
get:
117123
summary: Retrieve the Matrix User ID of a corresponding third party user.
@@ -147,6 +153,8 @@ paths:
147153
}
148154
schema:
149155
$ref: definitions/errors/error.yaml
156+
tags:
157+
- Third Party Lookup
150158
"/thirdparty/location":
151159
get:
152160
summary: Reverse-lookup third party locations given a Matrix room alias.
@@ -177,6 +185,8 @@ paths:
177185
}
178186
schema:
179187
$ref: definitions/errors/error.yaml
188+
tags:
189+
- Third Party Lookup
180190
"/thirdparty/user":
181191
get:
182192
summary: Reverse-lookup third party users given a Matrix User ID.
@@ -206,3 +216,5 @@ paths:
206216
}
207217
schema:
208218
$ref: definitions/errors/error.yaml
219+
tags:
220+
- Third Party Lookup

0 commit comments

Comments
 (0)