Skip to content

Commit

Permalink
OpenAPI: add titles
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaslihotzki committed Aug 14, 2021
1 parent 5132f1e commit ca86eea
Show file tree
Hide file tree
Showing 10 changed files with 17 additions and 2 deletions.
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/3330.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add titles for OpenAPI objects.
3 changes: 2 additions & 1 deletion data/api/client-server/definitions/errors/error.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -22,4 +23,4 @@ properties:
type: string
description: A human-readable error message.
example: An unknown error occurred
required: ["errcode"]
required: ["errcode"]
3 changes: 2 additions & 1 deletion data/api/client-server/definitions/errors/rate_limited.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -29,4 +30,4 @@ properties:
The amount of time in milliseconds the client should wait
before trying the request again.
example: 2000
required: ["errcode"]
required: ["errcode"]
1 change: 1 addition & 0 deletions data/api/client-server/definitions/event_batch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ properties:
type: object
type: array
type: object
title: EventBatch
1 change: 1 addition & 0 deletions data/api/client-server/definitions/openid_token.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions data/api/client-server/definitions/room_event_batch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ properties:
- origin_server_ts
type: array
type: object
title: RoomEventBatch
1 change: 1 addition & 0 deletions data/api/client-server/definitions/state_event_batch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ properties:
- state_key
type: array
type: object
title: StateEventBatch
1 change: 1 addition & 0 deletions data/api/client-server/definitions/timeline_batch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ properties:
rooms/{roomId}/messages endpoint.
type: string
type: object
title: TimelineBatch
6 changes: 6 additions & 0 deletions data/api/client-server/key_backup.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,7 @@ paths:
description: The update succeeded.
schema:
type: object
title: RoomKeysUpdateResponse
properties:
etag:
description: |-
Expand Down Expand Up @@ -519,6 +520,7 @@ paths:
description: The update succeeded
schema:
type: object
title: RoomKeysUpdateResponse
properties:
etag:
description: |-
Expand Down Expand Up @@ -580,6 +582,7 @@ paths:
description: The update succeeded
schema:
type: object
title: RoomKeysUpdateResponse
properties:
etag:
description: |-
Expand Down Expand Up @@ -692,6 +695,7 @@ paths:
description: The update succeeded
schema:
type: object
title: RoomKeysUpdateResponse
properties:
etag:
description: |-
Expand Down Expand Up @@ -773,6 +777,7 @@ paths:
description: The update succeeded
schema:
type: object
title: RoomKeysUpdateResponse
properties:
etag:
description: |-
Expand Down Expand Up @@ -895,6 +900,7 @@ paths:
description: The update succeeded
schema:
type: object
title: RoomKeysUpdateResponse
properties:
etag:
description: |-
Expand Down

0 comments on commit ca86eea

Please sign in to comment.