Update Documentation with core changes (#96)

Co-authored-by: discoursebuild <[email protected]>
discourse · Aug 25, 2023 · aa152ea · aa152ea
1 parent f0b2a4c
commit aa152ea
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/openapi.json b/openapi.json
@@ -10558,6 +10558,14 @@
                       "description": "A presigned PUT URL which must be used to upload\nthe file binary blob to.",
                       "example": "https://file-uploads.s3.us-west-2.amazonaws.com/temp/site/uploads/default/123/456.jpg?x-amz-acl=private&x-amz-meta-sha1-checksum=sha1&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AAAAus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20211221T011246Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=12345678"
                     },
+                    "signed_headers": {
+                      "type": "object",
+                      "description": "A map of headers that must be sent with the PUT request.",
+                      "example": {
+                        "x-amz-acl": "private",
+                        "x-amz-meta-sha1-checksum": "sha1"
+                      }
+                    },
                     "unique_identifier": {
                       "type": "string",
                       "description": "A unique string that identifies the external upload.\nThis must be stored and then sent in the /complete-external-upload\nendpoint to complete the direct upload.",

diff --git a/openapi.yml b/openapi.yml
@@ -7419,6 +7419,12 @@ paths:
                     description: A presigned PUT URL which must be used to upload
                       the file binary blob to.
                     example: https://file-uploads.s3.us-west-2.amazonaws.com/temp/site/uploads/default/123/456.jpg?x-amz-acl=private&x-amz-meta-sha1-checksum=sha1&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AAAAus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20211221T011246Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=12345678
+                  signed_headers:
+                    type: object
+                    description: A map of headers that must be sent with the PUT request.
+                    example:
+                      x-amz-acl: private
+                      x-amz-meta-sha1-checksum: sha1
                   unique_identifier:
                     type: string
                     description: A unique string that identifies the external upload.