Document why /state_ids can respond with a 404 (#1521)

matrix-org · May 31, 2023 · dd6af5b · dd6af5b
1 parent 48459de
commit dd6af5b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/changelogs/server_server/newsfragments/1521.clarification b/changelogs/server_server/newsfragments/1521.clarification
@@ -0,0 +1 @@
+Document why `/state_ids` can respond with a 404.
diff --git a/data/api/server-server/events.yaml b/data/api/server-server/events.yaml
@@ -137,6 +137,17 @@ paths:
                   type: string
                 example: ["$an_event:example.org"]
             required: ['auth_chain_ids', 'pdu_ids']
+        404:
+          description: |-
+            The given `event_id` was not found or the server doesn't know about the state at
+            that event to return anything useful.
+          examples:
+            application/json: {
+                "errcode": "M_NOT_FOUND",
+                "error": "Could not find event $Rqnc-F-dvnEYJTyHq_iKxU2bZ1CI92-kuZq3a5lr5Zg"
+              }
+          schema:
+            "$ref": "../client-server/definitions/errors/error.yaml"
   "/event/{eventId}":
     get:
       summary: Get a single event
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Document why `/state_ids` can respond with a 404.