Skip to content
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

Merged
merged 6 commits into from
Sep 13, 2024
Merged

Conversation

ensvo
Copy link
Contributor

@ensvo ensvo commented Sep 12, 2024

Documentation for packages create API endpoint

image image

@buildkite-docs-bot
Copy link
Contributor

Preview URL: https://2980--bk-docs-preview.netlify.app

@ensvo ensvo changed the title api docs for package create [PKG-6905] API docs for package create Sep 12, 2024
@ensvo ensvo changed the title [PKG-6905] API docs for package create [PKG-6905] API docs for packages create Sep 12, 2024
}
```

Required request form-field content:
Copy link
Contributor Author

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

Copy link
Contributor

@gilesgas gilesgas Sep 12, 2024

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.

@github-actions github-actions bot added the agent label Sep 12, 2024
@ensvo ensvo marked this pull request as ready for review September 12, 2024 05:29
Base automatically changed from ev-packages-api-packages-destroy to main September 12, 2024 23:13
@github-actions github-actions bot removed the agent label Sep 12, 2024
Copy link
Contributor

@gilesgas gilesgas left a 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.

@gilesgas gilesgas merged commit c20e899 into main Sep 13, 2024
3 checks passed
@gilesgas gilesgas deleted the ev-packages-api-packages-create branch September 13, 2024 00:05
@sj26
Copy link
Member

sj26 commented Sep 16, 2024

Nice work @ensvo! All these docs look great.

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

Successfully merging this pull request may close these issues.

4 participants