Skip to content

docs: Add cloud builds API documentation#545

Open
mattshep wants to merge 6 commits intomainfrom
ms/pcc-617-new-builds-endpoints
Open

docs: Add cloud builds API documentation#545
mattshep wants to merge 6 commits intomainfrom
ms/pcc-617-new-builds-endpoints

Conversation

@mattshep
Copy link
Contributor

  • Add buildId parameter to agent create/update endpoints
  • Add error examples for buildId validation errors
  • Add build endpoints: upload-url, create, list, get
  • Update navigation with Builds section

- Add buildId parameter to agent create/update endpoints
- Add error examples for buildId validation errors
- Add build endpoints: upload-url, create, list, get
- Update navigation with Builds section
Parameter was redundant - S3 enforces the 500MB limit via its own
content-length-range condition.
Copy link

@cbrianhill cbrianhill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think my main piece of feedback here is about timing -- would we merge this before we have any CLI functionality, or wait until we have the CLI ready, and maybe some updates to the general deployment documentation explaining how a user will use this?

@mattshep
Copy link
Contributor Author

I think my main piece of feedback here is about timing -- would we merge this before we have any CLI functionality, or wait until we have the CLI ready, and maybe some updates to the general deployment documentation explaining how a user will use this?

I think a new guide would be good, but I was starting with just the basics (API endpoints) and then intended to circle back for more once I had the CLI changes ready... I'll hold off on merging this one though until we get the new endpoints live in prod

…aram

- Remove contentLength from upload-url request examples (not a valid parameter)
- Fix S3 field name casing: X-Amz-* instead of x-amz-* (S3 is case-sensitive)
- Add bucket field to upload example
- Add X-Amz-Security-Token for STS credentials
- Add warning about field name case-sensitivity to prevent auth errors

Discovered during API integration testing.
Add documentation for the new build logs endpoint that allows users to
retrieve logs from a specific build for debugging and monitoring.
Update cloud builds guide and deploy CLI reference to reflect that a
Dockerfile is now required. Point users to pipecat-quickstart for
reference Dockerfiles.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants