Skip to content

Commit ca86eea

Browse files
committed
OpenAPI: add titles
1 parent 5132f1e commit ca86eea

File tree

10 files changed

+17
-2
lines changed

10 files changed

+17
-2
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add titles for OpenAPI objects.

data/api/client-server/definitions/errors/error.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414
type: object
15+
title: Error
1516
description: A Matrix-level Error
1617
properties:
1718
errcode:
@@ -22,4 +23,4 @@ properties:
2223
type: string
2324
description: A human-readable error message.
2425
example: An unknown error occurred
25-
required: ["errcode"]
26+
required: ["errcode"]

data/api/client-server/definitions/errors/rate_limited.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
# limitations under the License.
1414
$ref: error.yaml
1515
type: object
16+
title: RateLimitError
1617
description: The rate limit was reached for this request
1718
properties:
1819
errcode:
@@ -29,4 +30,4 @@ properties:
2930
The amount of time in milliseconds the client should wait
3031
before trying the request again.
3132
example: 2000
32-
required: ["errcode"]
33+
required: ["errcode"]

data/api/client-server/definitions/event_batch.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@ properties:
2121
type: object
2222
type: array
2323
type: object
24+
title: EventBatch

data/api/client-server/definitions/openid_token.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
type: object
16+
title: OpenIdCredentials
1617
properties:
1718
access_token:
1819
type: string

data/api/client-server/definitions/request_token_response.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414
type: object
15+
title: RequestTokenResponse
1516
properties:
1617
sid:
1718
type: string

data/api/client-server/definitions/room_event_batch.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,4 @@ properties:
2525
- origin_server_ts
2626
type: array
2727
type: object
28+
title: RoomEventBatch

data/api/client-server/definitions/state_event_batch.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,4 @@ properties:
2626
- state_key
2727
type: array
2828
type: object
29+
title: StateEventBatch

data/api/client-server/definitions/timeline_batch.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ properties:
2424
rooms/{roomId}/messages endpoint.
2525
type: string
2626
type: object
27+
title: TimelineBatch

data/api/client-server/key_backup.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,7 @@ paths:
409409
description: The update succeeded.
410410
schema:
411411
type: object
412+
title: RoomKeysUpdateResponse
412413
properties:
413414
etag:
414415
description: |-
@@ -519,6 +520,7 @@ paths:
519520
description: The update succeeded
520521
schema:
521522
type: object
523+
title: RoomKeysUpdateResponse
522524
properties:
523525
etag:
524526
description: |-
@@ -580,6 +582,7 @@ paths:
580582
description: The update succeeded
581583
schema:
582584
type: object
585+
title: RoomKeysUpdateResponse
583586
properties:
584587
etag:
585588
description: |-
@@ -692,6 +695,7 @@ paths:
692695
description: The update succeeded
693696
schema:
694697
type: object
698+
title: RoomKeysUpdateResponse
695699
properties:
696700
etag:
697701
description: |-
@@ -773,6 +777,7 @@ paths:
773777
description: The update succeeded
774778
schema:
775779
type: object
780+
title: RoomKeysUpdateResponse
776781
properties:
777782
etag:
778783
description: |-
@@ -895,6 +900,7 @@ paths:
895900
description: The update succeeded
896901
schema:
897902
type: object
903+
title: RoomKeysUpdateResponse
898904
properties:
899905
etag:
900906
description: |-

0 commit comments

Comments
 (0)