clarify use of 410 Gone

trolie · Oct 9, 2024 · 893d863 · 893d863
1 parent ef5ae5d
commit 893d863
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/docs/_data/openapi-split.yaml b/docs/_data/openapi-split.yaml
@@ -285,10 +285,14 @@ components:
       <<: *rate-limited
       description: Not Acceptable (Content negotiation failed)
       content: *problem
-    '410-empty':
+    '410-problem':
       <<: *rate-limited
-      description: Gone
-      content: *empty
+      description: |
+        Gone. The requested resource is no longer available.  TROLIE
+        implementations MAY return this status code when a resource is known to
+        have been deleted or archived, if the authenticated client would
+        otherwise have had authorized access to the resource.
+      content: *problem
     '413-empty':
       <<: *rate-limited
       description: Payload too large

diff --git a/docs/_data/paths/seasonal-overrides_{id}.yaml b/docs/_data/paths/seasonal-overrides_{id}.yaml
@@ -31,7 +31,7 @@ get:
     '406': &not-acceptable-empty
       $ref: '../openapi-split.yaml#/components/responses/406-empty'
     '410':
-      $ref: '../openapi-split.yaml#/components/responses/410-empty'
+      $ref: '../openapi-split.yaml#/components/responses/410-problem'
     '429': &rate-limit-hit
       $ref: '../openapi-split.yaml#/components/responses/429-empty'
     '500': &unexpected-error-empty

diff --git a/docs/_data/paths/temporary-aar-exceptions_{id}.yaml b/docs/_data/paths/temporary-aar-exceptions_{id}.yaml
@@ -31,7 +31,7 @@ get:
     '406': &not-acceptable-empty
       $ref: '../openapi-split.yaml#/components/responses/406-empty'
     '410':
-      $ref: '../openapi-split.yaml#/components/responses/410-empty'
+      $ref: '../openapi-split.yaml#/components/responses/410-problem'
     '429': &rate-limit-hit
       $ref: '../openapi-split.yaml#/components/responses/429-empty'
     '500': &unexpected-error-empty