Skip to content

Generated API references from OpenAPI file#3446

Merged
curquiza merged 53 commits into
mainfrom
exp-439-openapi-autogen
Feb 23, 2026
Merged

Generated API references from OpenAPI file#3446
curquiza merged 53 commits into
mainfrom
exp-439-openapi-autogen

Conversation

@curquiza

@curquiza curquiza commented Feb 5, 2026

Copy link
Copy Markdown
Member

✅ Needs meilisearch/meilisearch#6145 to be merged

Docs

  • Use openAPI file to generate API reference
  • Split API reference Overview page into sub pages, still uder API reference group
  • Github -> GitHub
  • Add missing code sample for /indexes/uid/fields route

Internal tooling and CIs

  • Improve Post deployment CI to trigger and generate OpenAPI files (+ creation of the scripts)
  • Add CI to check code samples in open API file (+ creation of the scripts)
  • Add PR template to ensure we do not miss steps related to code samples
  • Add scripts to npm commands, and so use npm run instead of directly the scripts in CIs

Summary by CodeRabbit

  • Documentation
    • Restructured API Reference navigation and redirects; added Authorization, Headers, Pagination, Requests, and OpenAPI pages.
    • Added API playground config and an "API Routes" group with example language support.
    • Updated many internal doc links, elevated error-code headings for clearer navigation, fixed branding to "GitHub", and added analytics event field "userId".
    • Added extra code-sample examples for federated multi-search fields.
  • Chores
    • New PR template and CI/workflow/tooling updates to improve OpenAPI and code-sample generation and validation.

Comment thread learn/self_hosted/getting_started_with_self_hosted_meilisearch.mdx Outdated
@curquiza curquiza force-pushed the exp-439-openapi-autogen branch from 36e3b4a to 5c68d62 Compare February 8, 2026 20:50
@curquiza curquiza force-pushed the exp-439-openapi-autogen branch from fe55bc2 to a7ecc38 Compare February 8, 2026 21:13
@curquiza curquiza force-pushed the exp-439-openapi-autogen branch 2 times, most recently from be5ec7f to 55c0986 Compare February 8, 2026 21:30
@curquiza curquiza force-pushed the exp-439-openapi-autogen branch from 55c0986 to 9d0c2d1 Compare February 8, 2026 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tooling and maintenance Maintenance (CI, tooling...)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants