Skip to content

Expand OpenAPI response schemas in reference docs - #5

Merged
muxx merged 1 commit into
mainfrom
docs-reference-openapi-schemas
Aug 31, 2026
Merged

Expand OpenAPI response schemas in reference docs#5
muxx merged 1 commit into
mainfrom
docs-reference-openapi-schemas

Conversation

@muxx

@muxx muxx commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Summary

  • expand object fields from array item schemas in generated OpenAPI Markdown
  • replace narrow Markdown tables with a responsive field and parameter list format
  • add required, stable operation summaries to the reference route contract
  • validate every published array response against its generated field documentation

Verification

  • deterministic make generate
  • Black and repository formatting checks
  • lint, type checks, and unit tests
  • release artifact build, validation, and installation checks
  • downstream docs refs:sync, reference tests, and full VitePress build

@muxx
muxx merged commit 4ae0744 into main Aug 31, 2026
3 checks passed
@muxx
muxx deleted the docs-reference-openapi-schemas branch August 31, 2026 16:33
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.

1 participant