Define a 400 response from {PUT,GET,DELETE} `/directory/rooms/{roomAl…

…ias}` (matrix-org#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>
clokep · May 3, 2023 · 06f81b6 · 06f81b6
1 parent 0879d1e
commit 06f81b6
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 3 deletions.
diff --git a/changelogs/client_server/newsfragments/1286.clarification b/changelogs/client_server/newsfragments/1286.clarification
@@ -0,0 +1 @@
+Define a 400 response from `/_matrix/client/v3/directory/rooms/{roomAlias}`.
diff --git a/data/api/client-server/directory.yaml b/data/api/client-server/directory.yaml
@@ -37,7 +37,9 @@ paths:
         - in: path
           type: string
           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
           x-example: "#monkeys:matrix.org"
         - in: body
@@ -61,6 +63,15 @@ paths:
             application/json: {}
           schema:
             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:
           description: A room alias with that name already exists.
           examples:
@@ -86,7 +97,9 @@ paths:
         - in: path
           type: string
           name: roomAlias
-          description: The room alias.
+          description: |
+            The room alias. Its format is defined
+            [in the appendices](/appendices/#room-aliases).
           required: true
           x-example: "#monkeys:matrix.org"
       responses:
@@ -113,6 +126,15 @@ paths:
                   "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:
           description: There is no mapped room ID for this room alias.
           examples:
@@ -146,7 +168,9 @@ paths:
         - in: path
           type: string
           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
           x-example: "#monkeys:matrix.org"
       responses:
@@ -220,6 +244,15 @@ paths:
                 items:
                   type: string
             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:
           description: The user is not permitted to retrieve the list of local aliases for the room.
           examples: