Skip to content

feat(api-docs): version API reference - #31

Merged
imdhemy merged 1 commit into
mainfrom
dmi/versioned-api-reference
Apr 2, 2026
Merged

feat(api-docs): version API reference#31
imdhemy merged 1 commit into
mainfrom
dmi/versioned-api-reference

Conversation

@imdhemy

@imdhemy imdhemy commented Apr 2, 2026

Copy link
Copy Markdown
Member

Summary

  • introduce an explicit versioned-pages mechanism for auxiliary versioned routes
  • move the API reference to canonical /docs//api-reference routes and keep /api-docs as a compatibility redirect
  • version OpenAPI sources and generated outputs per docs release while moving OpenAPI build scripts under /openapi

Behavior Change

  • the homepage no longer shows a global API Reference link
  • versioned docs pages now expose an API Reference link in the left navbar that stays within the active docs version
  • each published docs version resolves to its own OpenAPI source file and generated API reference output

Review Focus

  • verify the separation between docs registry concerns and the new opt-in versioned-pages mechanism
  • verify the API navbar visibility and routing behavior on homepage, docs pages, and versioned API pages
  • verify the OpenAPI generation contract now uses openapi/.yaml and static/openapi// consistently

Notes

- add explicit versioned auxiliary page routing for API docs
- version OpenAPI specs and generation output per docs release
- keep API reference navigation inside versioned docs context
@imdhemy
imdhemy force-pushed the dmi/versioned-api-reference branch from ac62381 to e25d543 Compare April 2, 2026 21:15
@imdhemy
imdhemy merged commit eb084f9 into main Apr 2, 2026
2 checks passed
@imdhemy
imdhemy deleted the dmi/versioned-api-reference branch April 2, 2026 21:17
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.

feat(api-docs): align API reference with docs versions

1 participant