Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-26 13:04:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Explicitly list errcodes in the description.

Browse source
This commit is contained in:
David Robertson 2022-07-12 18:27:58 +01:00
parent f58ea57ca9
commit e742b9948e
No known key found for this signature in database
GPG key ID: 903ECE108A39DEDD
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
data/api/client-server/account-data.yaml
View file

@ -73,7 +73,7 @@ paths:
type: object type: object
400: 400:
description: |- description: |-
The request body is not a JSON object. The request body is not a JSON object. Errcode: `M_BAD_JSON`.
examples: examples:
application/json: { application/json: {
"errcode": "M_BAD_JSON", "errcode": "M_BAD_JSON",
@ -84,7 +84,7 @@ paths:
403: 403:
description: |- description: |-
The access token provided is not authorized to modify this user's account The access token provided is not authorized to modify this user's account
data. data. Errcode: `M_FORBIDDEN`.
examples: examples:
application/json: { application/json: {
"errcode": "M_FORBIDDEN", "errcode": "M_FORBIDDEN",
@ -100,7 +100,7 @@ paths:
} }
description: |- description: |-
This `type` of account data is controlled by the server; it cannot be This `type` of account data is controlled by the server; it cannot be
modified by clients. modified by clients. Errcode: `M_BAD_JSON`.
schema: schema:
$ref: "../client-server/definitions/errors/error.yaml" $ref: "../client-server/definitions/errors/error.yaml"
tags: tags:
@ -141,7 +141,7 @@ paths:
403: 403:
description: |- description: |-
The access token provided is not authorized to retrieve this user's account The access token provided is not authorized to retrieve this user's account
data. data. Errcode: `M_FORBIDDEN`.
examples: examples:
application/json: { application/json: {
"errcode": "M_FORBIDDEN", "errcode": "M_FORBIDDEN",
@ -152,6 +152,7 @@ paths:
404: 404:
description: |- description: |-
No account data has been provided for this user with the given `type`. No account data has been provided for this user with the given `type`.
Errcode: `M_NOT_FOUND`.
examples: examples:
application/json: { application/json: {
"errcode": "M_NOT_FOUND", "errcode": "M_NOT_FOUND",
@ -214,8 +215,8 @@ paths:
type: object type: object
400: 400:
description: |- description: |-
The request body is not a JSON object, or the given `roomID` is not a valid The request body is not a JSON object (errcode `M_BAD_JSON`), or the
room ID. given `roomID` is not a valid room ID (errcode `M_INVALID_PARAM`).
examples: examples:
application/json: { application/json: {
"errcode": "M_BAD_JSON", "errcode": "M_BAD_JSON",
@ -226,7 +227,7 @@ paths:
403: 403:
description: |- description: |-
The access token provided is not authorized to modify this user's account The access token provided is not authorized to modify this user's account
data. data. Errcode: `M_FORBIDDEN`.
examples: examples:
application/json: { application/json: {
"errcode": "M_FORBIDDEN", "errcode": "M_FORBIDDEN",
@ -237,7 +238,7 @@ paths:
405: 405:
description: |- description: |-
This `type` of account data is controlled by the server; it cannot be This `type` of account data is controlled by the server; it cannot be
modified by clients. modified by clients. Errcode: `M_BAD_JSON`.
examples: examples:
application/json: { application/json: {
"errcode": "M_BAD_JSON", "errcode": "M_BAD_JSON",
@ -289,7 +290,7 @@ paths:
"custom_account_data_key": "custom_config_value"} "custom_account_data_key": "custom_config_value"}
400: 400:
description: |- description: |-
The given `roomID` is not a valid room ID. The given `roomID` is not a valid room ID. Errcode: `M_INVALID_PARAM`.
examples: examples:
application/json: { application/json: {
"errcode": "M_INVALID_PARAM", "errcode": "M_INVALID_PARAM",
@ -298,7 +299,7 @@ paths:
403: 403:
description: |- description: |-
The access token provided is not authorized to retrieve this user's account The access token provided is not authorized to retrieve this user's account
data. data. Errcode: `M_FORBIDDEN`.
examples: examples:
application/json: { application/json: {
"errcode": "M_FORBIDDEN", "errcode": "M_FORBIDDEN",
@ -309,7 +310,7 @@ paths:
404: 404:
description: |- description: |-
No account data has been provided for this user and this room with the No account data has been provided for this user and this room with the
given `type`. given `type`. Errcode: `M_NOT_FOUND`.
examples: examples:
application/json: { application/json: {
"errcode": "M_NOT_FOUND", "errcode": "M_NOT_FOUND",