Add API documentation#78
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new docs/api.md file documenting bosh.io's read-only JSON API and download redirect endpoints for stemcells and releases, and links the new doc from the top-level README.md. This is a documentation-only change; no code or runtime behavior is modified.
Changes:
- New
docs/api.mdcovering four endpoints with path/query parameters, response schemas, error codes, andcurlexamples. README.mdgains a bullet linking to the new API doc.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
docs/api.md |
New reference documentation for /api/v1/stemcells/{name}, /d/stemcells/{name}, /api/v1/releases/{source}, and /d/{source}. |
README.md |
Adds a link to the new API doc. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
rkoster
previously approved these changes
May 28, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
rkoster
approved these changes
May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/api.mddocumenting all bosh.io JSON API and download endpointscurlexamplesREADME.mdEndpoints documented
GET /api/v1/stemcells/{name}— list stemcell versionsGET /d/stemcells/{name}— redirect to stemcell tarball downloadGET /api/v1/releases/{source}— list release versionsGET /d/{source}— redirect to release tarball download