-
Notifications
You must be signed in to change notification settings - Fork 249
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.
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
[PKG-6905] API docs for packages create #2980
Conversation
Preview URL: https://2980--bk-docs-preview.netlify.app |
} | ||
``` | ||
|
||
Required request form-field content: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AFAIK this is the first instance of a file upload using the API here - I'm curious to know if this part looks and reads fine.
I've referenced the curl
manpage for -F
specifying a file as the content type: https://curl.se/docs/manpage.html#-F
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good!
I think you're correct, we haven't really used form field inputs for any of the other Buildkite REST API endpoints before, so we might add a cross-reference-able section to this section once we indicate there that form fields can also be accepted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved to merge once commit suggestion is acknowledged/actioned.
Co-authored-by: Giles Gas <[email protected]>
Nice work @ensvo! All these docs look great. |
Documentation for packages create API endpoint