From b2e4318fd2fef88bb0020a30f683d61f74429ce5 Mon Sep 17 00:00:00 2001
From: Eric Eastwood <contact@ericeastwood.com>
Date: Fri, 12 May 2023 17:24:09 -0500
Subject: [PATCH] Document why /state_ids can respond with a 404

---
 data/api/server-server/events.yaml | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/data/api/server-server/events.yaml b/data/api/server-server/events.yaml
index 427978fb..0398ee98 100644
--- 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: |-
+            No event was 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