add 415 response to forecast PATCH

trolie · Mar 16, 2024 · 226c2c7 · 226c2c7
1 parent 06e1910
commit 226c2c7
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 4 deletions.
diff --git a/cspell.json b/cspell.json
@@ -22,6 +22,7 @@
         ,"mrid"
         ,"MVAR"
         ,"NERC"
+        ,"nowcast"
         ,"openapi"
         ,"overvoltage"
         ,"owasp"

diff --git a/docs/_data/openapi-split.yaml b/docs/_data/openapi-split.yaml
@@ -215,7 +215,7 @@ components:
 
     '400': &malformed
       <<: *rate-limited
-      description: Malformed request.
+      description: Malformed request
     '401': &unauthorized
       <<: *rate-limited
       description: Unauthorized
@@ -227,10 +227,10 @@ components:
       description: Not Found
     '406': &not-acceptable
       <<: *rate-limited
-      description: Not Acceptable. (Content negotiation failed)
+      description: Not Acceptable (Content negotiation failed)
     '410': &gone
       <<: *rate-limited
-      description: Gone.
+      description: Gone
     '429': &rate-limit-hit
       description: Too many requests (rate limiting)
       headers:
@@ -271,8 +271,28 @@ components:
       content: *empty
     '413-empty':
       <<: *rate-limited
-      description: Payload too large!
+      description: Payload too large
       content: *empty
+    '415-problem':
+      description: Unsupported media type
+      headers:
+        <<: *rate-limited-headers
+        Accept:
+          schema:
+            type: string
+          examples:
+            "Forecast Proposal":
+              summary: Used to update the area-wide forecast
+              value: "application/vnd.trolie.rating-forecast-proposal.v1+json"
+            "Real-Time Proposal":
+              summary: Used to update the area-wide nowcast
+              value: "application/vnd.trolie.rating-realtime-proposal.v1+json"
+        Accept-Encoding:
+          schema:
+            type: string
+            description: List of content encoding formats the server accepts.
+          example: "br,gzip"
+      content: *problem
     '422-problem':
       <<: *rate-limited
       description: Unprocessable content

diff --git a/docs/_data/paths/rating-proposals_forecasts.yaml b/docs/_data/paths/rating-proposals_forecasts.yaml
@@ -128,6 +128,8 @@ patch:
         $ref: '../openapi-split.yaml#/components/responses/304/headers'
     '413':
       $ref: '../openapi-split.yaml#/components/responses/413-empty'
+    '415':
+      $ref: '../openapi-split.yaml#/components/responses/415-problem'
     '422':
       description: Unprocessable Content
       content: