Clarify that the async upload endpoint will return 404 in some cases

matrix-org · Oct 25, 2024 · f087767 · f087767
1 parent 285cd2b
commit f087767
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/changelogs/client_server/newsfragments/1983.clarification b/changelogs/client_server/newsfragments/1983.clarification
@@ -0,0 +1 @@
+Clarify that the async upload endpoint will return 404 in some cases.
diff --git a/data/api/client-server/content-repo.yaml b/data/api/client-server/content-repo.yaml
@@ -126,6 +126,25 @@ paths:
                     "errcode": "M_FORBIDDEN",
                     "error": "Cannot upload this content"
                   }
+        "404":
+          description: |-
+            The user has provided an invalid MXC ID. Some reasons for this error include:
+
+            - The MXC ID was not created with [POST /_matrix/media/v1/create](/client-server-api/#post_matrixmediav1create).
+            - The MXC ID has expired.
+
+            A [standard error response](/client-server-api/#standard-error-response)
+            will be returned with the `errcode` `M_NOT_FOUND`.
+          content:
+            application/json:
+              schema:
+                $ref: definitions/errors/error.yaml
+              examples:
+                response:
+                  value: {
+                    "errcode": "M_NOT_FOUND",
+                    "error": "Unknown media ID"
+                  }
         "409":
           description: |-
             The endpoint was called with a media ID that already has content. A