New Meilisearch versions
MeiliOps targets the latest stable Meilisearch release. The API types are generated from the OpenAPI spec Meilisearch publishes with each release, so an update is mostly mechanical.
Steps
- Download the new release's
meilisearch-openapi.jsonintoapp/spec/. - Regenerate the types and the API console's operation catalog:
bash
npx openapi-typescript@7 spec/meilisearch-openapi.json -o src/api/schema.d.tsbash
npm run gen- Typecheck. Routes that were renamed or removed fail here, at every call site:
bash
npm run typecheck- Check coverage. New stable operations without a screen fail here:
bash
npm run coverage -- --strict- Add screens for the new operations, and update the version mentioned in the docs.
The API console picks up every new operation automatically, so new routes are usable immediately, even before they get a dedicated screen.
Coverage script details
app/scripts/coverage.mjs finds calls by scanning the source for the literal "METHOD", "/path" pattern, plus the settings catalog in views/index/settingsCatalog.ts. It knows that some routes are equivalent (for example the GET and POST forms of search) and that the /network routes are Enterprise-only.