registry icon indicating copy to clipboard operation
registry copied to clipboard

docs: update API endpoint documentation from /v0/ to /v0.1/

Open tadasant opened this issue 1 month ago • 2 comments

Update all documentation to reference the stable /v0.1/ API version instead of the development /v0/ version.

Didn't update internal references (e.g. in admin-only docs) as that probably make sense to keep pointed at v0 as the "dev" option.

Authored by Claude Code, reviewed by me.

tadasant avatar Nov 27 '25 18:11 tadasant

@claude review this PR

tadasant avatar Nov 27 '25 18:11 tadasant

Claude finished @tadasant's task —— View job


Code Review ✅

I've reviewed this PR which updates API endpoint documentation from /v0/ to /v0.1/. The changes look excellent!

Summary

The PR correctly updates all public-facing documentation to reference the stable /v0.1/ API version instead of the development /v0/ version. This aligns with the API freeze announcement mentioned in the README.

What I Reviewed

Changed files (all look good ✅):

  • docs/design/tech-architecture.md - Updated admin auth examples to use /v0.1/
  • docs/modelcontextprotocol-io/registry-aggregators.mdx - Updated pagination examples
  • docs/reference/api/generic-registry-api.md - Updated all endpoint references and examples
  • docs/reference/api/official-registry-api.md - Updated endpoint descriptions and examples
  • docs/reference/api/openapi.yaml - Updated all path definitions
  • scripts/mirror_data/README.md - Updated data fetching documentation

Files intentionally left unchanged (correct decision ✅):

  • docs/administration/admin-operations.md - Admin docs correctly kept at /v0/ for internal use
  • deploy/README.md - Deployment/testing docs correctly use /v0/ping endpoint
  • tests/integration/README.md - Test documentation correctly references /v0/ endpoints
  • docs/reference/api/CHANGELOG.md - Historical references appropriately preserved

Review Findings

✅ Strengths:

  1. Comprehensive coverage - All public-facing documentation updated consistently
  2. Appropriate scope - Admin and internal docs correctly left pointing to /v0/ as the "dev" option
  3. Consistency - All 50 line changes (25 additions, 25 deletions) are simple replacements from /v0/ to /v0.1/
  4. OpenAPI spec updated - The formal API spec is updated alongside documentation
  5. No breaking changes - Pure documentation update with no code changes

No issues found - The changes are straightforward, consistent, and complete. The decision to keep internal/admin documentation pointing at /v0/ makes sense as those are for maintainers who may want to test against the development API.

Recommendation

Approve and merge. This PR correctly implements the documentation update to reflect the v0.1 API freeze. All changes are accurate and well-scoped.


claude[bot] avatar Nov 27 '25 18:11 claude[bot]