Skip to content

Add API documentation#78

Merged
rkoster merged 2 commits into
mainfrom
docs/api-documentation
May 28, 2026
Merged

Add API documentation#78
rkoster merged 2 commits into
mainfrom
docs/api-documentation

Conversation

@ramonskie

Copy link
Copy Markdown
Contributor

Summary

  • Adds docs/api.md documenting all bosh.io JSON API and download endpoints
  • Covers stemcell and release endpoints with request parameters, response schemas, error codes, and curl examples
  • Links the new doc from README.md

Endpoints documented

  • GET /api/v1/stemcells/{name} — list stemcell versions
  • GET /d/stemcells/{name} — redirect to stemcell tarball download
  • GET /api/v1/releases/{source} — list release versions
  • GET /d/{source} — redirect to release tarball download

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.md covering four endpoints with path/query parameters, response schemas, error codes, and curl examples.
  • README.md gains 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.

Comment thread docs/api.md
Comment thread docs/api.md
Comment thread docs/api.md Outdated
rkoster
rkoster previously approved these changes May 28, 2026
@github-project-automation github-project-automation Bot moved this from Inbox to Pending Merge | Prioritized in Foundational Infrastructure Working Group May 28, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@rkoster rkoster merged commit 0a9e1f2 into main May 28, 2026
5 checks passed
@github-project-automation github-project-automation Bot moved this from Pending Merge | Prioritized to Done in Foundational Infrastructure Working Group May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

3 participants