Define a 400 response from {PUT,GET,DELETE} /directory/rooms/{roomAlias}
(#1286)
* Define a 400 response from {PUT,GET,DELETE} `/directory/rooms/{roomAlias}` * Changelog * Adjust changelog Co-authored-by: Travis Ralston <travpc@gmail.com> * Refer to appendices Co-authored-by: Travis Ralston <travpc@gmail.com>
This commit is contained in:
parent
11cef5417a
commit
ad99be4ad7
2 changed files with 37 additions and 3 deletions
|
@ -0,0 +1 @@
|
||||||
|
Define a 400 response from `/_matrix/client/v3/directory/rooms/{roomAlias}`.
|
|
@ -37,7 +37,9 @@ paths:
|
||||||
- in: path
|
- in: path
|
||||||
type: string
|
type: string
|
||||||
name: roomAlias
|
name: roomAlias
|
||||||
description: The room alias to set.
|
description: |
|
||||||
|
The room alias to set. Its format is defined
|
||||||
|
[in the appendices](/appendices/#room-aliases).
|
||||||
required: true
|
required: true
|
||||||
x-example: "#monkeys:matrix.org"
|
x-example: "#monkeys:matrix.org"
|
||||||
- in: body
|
- in: body
|
||||||
|
@ -61,6 +63,15 @@ paths:
|
||||||
application/json: {}
|
application/json: {}
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
|
400:
|
||||||
|
description: The given `roomAlias` is not a valid room alias.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "Room alias invalid"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
"$ref": "definitions/errors/error.yaml"
|
||||||
409:
|
409:
|
||||||
description: A room alias with that name already exists.
|
description: A room alias with that name already exists.
|
||||||
examples:
|
examples:
|
||||||
|
@ -86,7 +97,9 @@ paths:
|
||||||
- in: path
|
- in: path
|
||||||
type: string
|
type: string
|
||||||
name: roomAlias
|
name: roomAlias
|
||||||
description: The room alias.
|
description: |
|
||||||
|
The room alias. Its format is defined
|
||||||
|
[in the appendices](/appendices/#room-aliases).
|
||||||
required: true
|
required: true
|
||||||
x-example: "#monkeys:matrix.org"
|
x-example: "#monkeys:matrix.org"
|
||||||
responses:
|
responses:
|
||||||
|
@ -113,6 +126,15 @@ paths:
|
||||||
"another.com"
|
"another.com"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
400:
|
||||||
|
description: The given `roomAlias` is not a valid room alias.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "Room alias invalid"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
"$ref": "definitions/errors/error.yaml"
|
||||||
404:
|
404:
|
||||||
description: There is no mapped room ID for this room alias.
|
description: There is no mapped room ID for this room alias.
|
||||||
examples:
|
examples:
|
||||||
|
@ -146,7 +168,9 @@ paths:
|
||||||
- in: path
|
- in: path
|
||||||
type: string
|
type: string
|
||||||
name: roomAlias
|
name: roomAlias
|
||||||
description: The room alias to remove.
|
description: |
|
||||||
|
The room alias to remove. Its format is defined
|
||||||
|
[in the appendices](/appendices/#room-aliases).
|
||||||
required: true
|
required: true
|
||||||
x-example: "#monkeys:matrix.org"
|
x-example: "#monkeys:matrix.org"
|
||||||
responses:
|
responses:
|
||||||
|
@ -220,6 +244,15 @@ paths:
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
required: ['aliases']
|
required: ['aliases']
|
||||||
|
400:
|
||||||
|
description: The given `roomAlias` is not a valid room alias.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "Room alias invalid"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
"$ref": "definitions/errors/error.yaml"
|
||||||
403:
|
403:
|
||||||
description: The user is not permitted to retrieve the list of local aliases for the room.
|
description: The user is not permitted to retrieve the list of local aliases for the room.
|
||||||
examples:
|
examples:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue