From 13f7df13798745ea014d6f15bfb7b1144b01d252 Mon Sep 17 00:00:00 2001 From: Lukas Lihotzki Date: Wed, 11 Aug 2021 23:20:18 +0200 Subject: [PATCH] OpenAPI: add titles --- changelogs/client_server/newsfragments/3330.clarification | 1 + data/api/client-server/definitions/errors/error.yaml | 3 ++- data/api/client-server/definitions/errors/rate_limited.yaml | 3 ++- data/api/client-server/definitions/event_batch.yaml | 1 + data/api/client-server/definitions/openid_token.yaml | 1 + .../client-server/definitions/request_token_response.yaml | 1 + data/api/client-server/definitions/room_event_batch.yaml | 1 + data/api/client-server/definitions/state_event_batch.yaml | 1 + data/api/client-server/definitions/timeline_batch.yaml | 1 + data/api/client-server/key_backup.yaml | 6 ++++++ 10 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 changelogs/client_server/newsfragments/3330.clarification diff --git a/changelogs/client_server/newsfragments/3330.clarification b/changelogs/client_server/newsfragments/3330.clarification new file mode 100644 index 00000000..5df676a1 --- /dev/null +++ b/changelogs/client_server/newsfragments/3330.clarification @@ -0,0 +1 @@ +Add titles for OpenAPI objects. diff --git a/data/api/client-server/definitions/errors/error.yaml b/data/api/client-server/definitions/errors/error.yaml index 7471da6f..89a0d44f 100644 --- a/data/api/client-server/definitions/errors/error.yaml +++ b/data/api/client-server/definitions/errors/error.yaml @@ -12,6 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. type: object +title: Error description: A Matrix-level Error properties: errcode: @@ -22,4 +23,4 @@ properties: type: string description: A human-readable error message. example: An unknown error occurred -required: ["errcode"] \ No newline at end of file +required: ["errcode"] diff --git a/data/api/client-server/definitions/errors/rate_limited.yaml b/data/api/client-server/definitions/errors/rate_limited.yaml index aca82ce7..1530458b 100644 --- a/data/api/client-server/definitions/errors/rate_limited.yaml +++ b/data/api/client-server/definitions/errors/rate_limited.yaml @@ -13,6 +13,7 @@ # limitations under the License. $ref: error.yaml type: object +title: RateLimitError description: The rate limit was reached for this request properties: errcode: @@ -29,4 +30,4 @@ properties: The amount of time in milliseconds the client should wait before trying the request again. example: 2000 -required: ["errcode"] \ No newline at end of file +required: ["errcode"] diff --git a/data/api/client-server/definitions/event_batch.yaml b/data/api/client-server/definitions/event_batch.yaml index 1694652c..e326184c 100644 --- a/data/api/client-server/definitions/event_batch.yaml +++ b/data/api/client-server/definitions/event_batch.yaml @@ -21,3 +21,4 @@ properties: type: object type: array type: object +title: EventBatch diff --git a/data/api/client-server/definitions/openid_token.yaml b/data/api/client-server/definitions/openid_token.yaml index 32929ef6..e74ddfff 100644 --- a/data/api/client-server/definitions/openid_token.yaml +++ b/data/api/client-server/definitions/openid_token.yaml @@ -13,6 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. type: object +title: OpenIdCredentials properties: access_token: type: string diff --git a/data/api/client-server/definitions/request_token_response.yaml b/data/api/client-server/definitions/request_token_response.yaml index aa9379f6..0f8c8cab 100644 --- a/data/api/client-server/definitions/request_token_response.yaml +++ b/data/api/client-server/definitions/request_token_response.yaml @@ -12,6 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. type: object +title: RequestTokenResponse properties: sid: type: string diff --git a/data/api/client-server/definitions/room_event_batch.yaml b/data/api/client-server/definitions/room_event_batch.yaml index 45bcb423..4a7dab19 100644 --- a/data/api/client-server/definitions/room_event_batch.yaml +++ b/data/api/client-server/definitions/room_event_batch.yaml @@ -25,3 +25,4 @@ properties: - origin_server_ts type: array type: object +title: RoomEventBatch diff --git a/data/api/client-server/definitions/state_event_batch.yaml b/data/api/client-server/definitions/state_event_batch.yaml index 9518300f..f3966dcd 100644 --- a/data/api/client-server/definitions/state_event_batch.yaml +++ b/data/api/client-server/definitions/state_event_batch.yaml @@ -26,3 +26,4 @@ properties: - state_key type: array type: object +title: StateEventBatch diff --git a/data/api/client-server/definitions/timeline_batch.yaml b/data/api/client-server/definitions/timeline_batch.yaml index e243b485..65a7622a 100644 --- a/data/api/client-server/definitions/timeline_batch.yaml +++ b/data/api/client-server/definitions/timeline_batch.yaml @@ -24,3 +24,4 @@ properties: rooms/{roomId}/messages endpoint. type: string type: object +title: TimelineBatch diff --git a/data/api/client-server/key_backup.yaml b/data/api/client-server/key_backup.yaml index 73044c6d..bf7900f9 100644 --- a/data/api/client-server/key_backup.yaml +++ b/data/api/client-server/key_backup.yaml @@ -409,6 +409,7 @@ paths: description: The update succeeded. schema: type: object + title: RoomKeysUpdateResponse properties: etag: description: |- @@ -519,6 +520,7 @@ paths: description: The update succeeded schema: type: object + title: RoomKeysUpdateResponse properties: etag: description: |- @@ -580,6 +582,7 @@ paths: description: The update succeeded schema: type: object + title: RoomKeysUpdateResponse properties: etag: description: |- @@ -692,6 +695,7 @@ paths: description: The update succeeded schema: type: object + title: RoomKeysUpdateResponse properties: etag: description: |- @@ -773,6 +777,7 @@ paths: description: The update succeeded schema: type: object + title: RoomKeysUpdateResponse properties: etag: description: |- @@ -895,6 +900,7 @@ paths: description: The update succeeded schema: type: object + title: RoomKeysUpdateResponse properties: etag: description: |-