Skip to content

Document presigned PUT upload response on /attachments.create #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tommoor merged 2 commits into from
Jun 25, 2026
Merged

Document presigned PUT upload response on /attachments.create #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b7e3be
Document presigned PUT upload response on /attachments.create
claude Jun 25, 2026
4ce82df
Regenerate spec3.json
claude Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions spec3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,12 +450,31 @@
"maxUploadSize": {
"type": "number"
},
"mode": {
"type": "string",
"enum": [
"post",
"put"
],
"description": "Indicates which presigned upload method the server is configured to use. When `post`, the client should perform a multipart form POST using `uploadUrl` and `form`. When `put`, the client should perform a PUT request to `url` with the supplied `headers`."
},
"uploadUrl": {
"type": "string",
"format": "uri"
"format": "uri",
"description": "Present when `mode` is `post`. The endpoint to POST a multipart form upload to."
},
"form": {
"type": "object"
"type": "object",
"description": "Present when `mode` is `post`. The form fields to include in the multipart upload, including signed credentials."
},
"url": {
"type": "string",
"format": "uri",
"description": "Present when `mode` is `put`. The presigned URL to PUT the file contents to."
},
"headers": {
"type": "object",
"description": "Present when `mode` is `put`. The HTTP headers that must be sent with the PUT request."
},
"attachment": {
"$ref": "#/components/schemas/Attachment"
Expand Down
25 changes: 25 additions & 0 deletions spec3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,11 +511,36 @@ paths:
properties:
maxUploadSize:
type: number
mode:
type: string
enum:
- post
- put
description:
Indicates which presigned upload method the server is
configured to use. When `post`, the client should perform
a multipart form POST using `uploadUrl` and `form`. When
`put`, the client should perform a PUT request to `url`
with the supplied `headers`.
uploadUrl:
type: string
format: uri
description: Present when `mode` is `post`. The endpoint to
POST a multipart form upload to.
form:
type: object
description: Present when `mode` is `post`. The form fields
to include in the multipart upload, including signed
credentials.
url:
type: string
format: uri
description: Present when `mode` is `put`. The presigned URL
to PUT the file contents to.
headers:
type: object
description: Present when `mode` is `put`. The HTTP headers
that must be sent with the PUT request.
attachment:
"$ref": "#/components/schemas/Attachment"
"400":
Expand Down
Loading