Responses schema fixes (#3650)
Fixes #2237. Corrects the response schemas for: ``` PUT /user/{user_id}/account_data/{account_dataType} PUT /user/{user_id}/rooms/{roomId}/account_data/{type} PUT /directory/list/room/{roomId} PUT /sendToDevice/{eventType}/{txnId} POST /account/3pid POST /account/3pid/add POST /account/3pid/bind ```
This commit is contained in:
parent
2e5cc42666
commit
d3e39567f4
6 changed files with 39 additions and 26 deletions
|
@ -0,0 +1 @@
|
||||||
|
Correct the schema for the responses for various API endpoints.
|
|
@ -67,6 +67,10 @@ paths:
|
||||||
200:
|
200:
|
||||||
description:
|
description:
|
||||||
The account_data was successfully added.
|
The account_data was successfully added.
|
||||||
|
examples:
|
||||||
|
application/json: {}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- User data
|
||||||
get:
|
get:
|
||||||
|
@ -151,6 +155,10 @@ paths:
|
||||||
200:
|
200:
|
||||||
description:
|
description:
|
||||||
The account_data was successfully added.
|
The account_data was successfully added.
|
||||||
|
examples:
|
||||||
|
application/json: {}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
tags:
|
tags:
|
||||||
- User data
|
- User data
|
||||||
get:
|
get:
|
||||||
|
|
|
@ -298,9 +298,10 @@ paths:
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: The update succeeded.
|
description: The update succeeded.
|
||||||
|
examples:
|
||||||
|
application/json: {}
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties: {}
|
|
||||||
400:
|
400:
|
||||||
description: |-
|
description: |-
|
||||||
A parameter was incorrect. For example, the `algorithm` does not
|
A parameter was incorrect. For example, the `algorithm` does not
|
||||||
|
|
|
@ -104,6 +104,8 @@ paths:
|
||||||
description: The visibility was updated, or no change was needed.
|
description: The visibility was updated, or no change was needed.
|
||||||
examples:
|
examples:
|
||||||
application/json: {}
|
application/json: {}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
404:
|
404:
|
||||||
description: The room is not known to the server
|
description: The room is not known to the server
|
||||||
examples:
|
examples:
|
||||||
|
|
|
@ -85,7 +85,8 @@ paths:
|
||||||
description:
|
description:
|
||||||
The message was successfully sent.
|
The message was successfully sent.
|
||||||
examples:
|
examples:
|
||||||
application/json: {
|
application/json: {}
|
||||||
}
|
schema:
|
||||||
|
type: object
|
||||||
tags:
|
tags:
|
||||||
- Send-to-Device messaging
|
- Send-to-Device messaging
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue