Skip to content

API reference: Human friendly docs for API endpoints that take multipart/form-data #37674

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

Jump to bottom
Open
noahtalerman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

API reference: Human friendly docs for API endpoints that take multipart/form-data #37674

noahtalerman wants to merge 1 commit into from
+20 −37

Conversation

@noahtalerman
Copy link
Member

@noahtalerman noahtalerman commented Dec 24, 2025 •
edited
Loading

  • During Product office hours on 2025-12-23, we learned that no one on the call knew what the current request body format was.
    • I later learned that this is the raw request (formatted by a browser or curl command)
    • I think the updated format is more friendly for humans who are using curl/Postman
  • Also update "form" to "body" in the "Parameters" table. We learned that the form data is actually part the body. Postman's UI shows this.

@noahtalerman
API reference: New "Request body" format for API endpoints that take …
c91773b 
…`multipart/form-data`

- During Product office hours on 2025-12-23, we learned that no one on the call knew what the current request body format was.
  - We later learned that this is the raw request (formatted by a browser or curl command)
  - I think the updated format is more friendly for humans who are using curl/Postman
- Also update "form" to "body" in the "Parameters" table. We learned that the form data is actually part the body. Postman's UI shows this.
@noahtalerman noahtalerman changed the title API reference: New "Request body" format for API endpoints that take multipart/form-data API reference: Human friendly docs for API endpoints that take multipart/form-data Dec 24, 2025
@noahtalerman
Copy link
Member Author

noahtalerman commented Dec 24, 2025

@spalmesano0 @rachaelshaw what do you think?

If this looks good I think we want to update docs for all API endpoints that take multipart/form-data.

cc @melpike @marko-lisica

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fleet-release fleet-release fleet-release approved these changes

@rachaelshaw rachaelshaw Awaiting requested review from rachaelshaw rachaelshaw is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@noahtalerman @fleet-release