OpenAPI: add titles
This commit is contained in:
parent
3bf7e48e13
commit
13f7df1379
10 changed files with 17 additions and 2 deletions
|
@ -0,0 +1 @@
|
||||||
|
Add titles for OpenAPI objects.
|
|
@ -12,6 +12,7 @@
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
type: object
|
type: object
|
||||||
|
title: Error
|
||||||
description: A Matrix-level Error
|
description: A Matrix-level Error
|
||||||
properties:
|
properties:
|
||||||
errcode:
|
errcode:
|
||||||
|
@ -22,4 +23,4 @@ properties:
|
||||||
type: string
|
type: string
|
||||||
description: A human-readable error message.
|
description: A human-readable error message.
|
||||||
example: An unknown error occurred
|
example: An unknown error occurred
|
||||||
required: ["errcode"]
|
required: ["errcode"]
|
||||||
|
|
|
@ -13,6 +13,7 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
$ref: error.yaml
|
$ref: error.yaml
|
||||||
type: object
|
type: object
|
||||||
|
title: RateLimitError
|
||||||
description: The rate limit was reached for this request
|
description: The rate limit was reached for this request
|
||||||
properties:
|
properties:
|
||||||
errcode:
|
errcode:
|
||||||
|
@ -29,4 +30,4 @@ properties:
|
||||||
The amount of time in milliseconds the client should wait
|
The amount of time in milliseconds the client should wait
|
||||||
before trying the request again.
|
before trying the request again.
|
||||||
example: 2000
|
example: 2000
|
||||||
required: ["errcode"]
|
required: ["errcode"]
|
||||||
|
|
|
@ -21,3 +21,4 @@ properties:
|
||||||
type: object
|
type: object
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
|
title: EventBatch
|
||||||
|
|
|
@ -13,6 +13,7 @@
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
type: object
|
type: object
|
||||||
|
title: OpenIdCredentials
|
||||||
properties:
|
properties:
|
||||||
access_token:
|
access_token:
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -12,6 +12,7 @@
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
type: object
|
type: object
|
||||||
|
title: RequestTokenResponse
|
||||||
properties:
|
properties:
|
||||||
sid:
|
sid:
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -25,3 +25,4 @@ properties:
|
||||||
- origin_server_ts
|
- origin_server_ts
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
|
title: RoomEventBatch
|
||||||
|
|
|
@ -26,3 +26,4 @@ properties:
|
||||||
- state_key
|
- state_key
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
|
title: StateEventBatch
|
||||||
|
|
|
@ -24,3 +24,4 @@ properties:
|
||||||
rooms/{roomId}/messages endpoint.
|
rooms/{roomId}/messages endpoint.
|
||||||
type: string
|
type: string
|
||||||
type: object
|
type: object
|
||||||
|
title: TimelineBatch
|
||||||
|
|
|
@ -409,6 +409,7 @@ paths:
|
||||||
description: The update succeeded.
|
description: The update succeeded.
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
|
title: RoomKeysUpdateResponse
|
||||||
properties:
|
properties:
|
||||||
etag:
|
etag:
|
||||||
description: |-
|
description: |-
|
||||||
|
@ -519,6 +520,7 @@ paths:
|
||||||
description: The update succeeded
|
description: The update succeeded
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
|
title: RoomKeysUpdateResponse
|
||||||
properties:
|
properties:
|
||||||
etag:
|
etag:
|
||||||
description: |-
|
description: |-
|
||||||
|
@ -580,6 +582,7 @@ paths:
|
||||||
description: The update succeeded
|
description: The update succeeded
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
|
title: RoomKeysUpdateResponse
|
||||||
properties:
|
properties:
|
||||||
etag:
|
etag:
|
||||||
description: |-
|
description: |-
|
||||||
|
@ -692,6 +695,7 @@ paths:
|
||||||
description: The update succeeded
|
description: The update succeeded
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
|
title: RoomKeysUpdateResponse
|
||||||
properties:
|
properties:
|
||||||
etag:
|
etag:
|
||||||
description: |-
|
description: |-
|
||||||
|
@ -773,6 +777,7 @@ paths:
|
||||||
description: The update succeeded
|
description: The update succeeded
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
|
title: RoomKeysUpdateResponse
|
||||||
properties:
|
properties:
|
||||||
etag:
|
etag:
|
||||||
description: |-
|
description: |-
|
||||||
|
@ -895,6 +900,7 @@ paths:
|
||||||
description: The update succeeded
|
description: The update succeeded
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
|
title: RoomKeysUpdateResponse
|
||||||
properties:
|
properties:
|
||||||
etag:
|
etag:
|
||||||
description: |-
|
description: |-
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue