Merge pull request #3537 from meilisearch/feat/typo-tolerance-internals #92
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # On every push to main, check meilisearch-openapi-mintlify.json: | |
| # - Job 1: Ensure every route that has x-codeSamples includes a cURL sample (can fail). | |
| # - Job 2: Informational only – list routes and all missing code sample languages (never fails). | |
| # - Job 3: Ensure every OpenAPI route is mapped in docs.json (can fail). | |
| name: Check OpenAPI code samples | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| # Fails if any route with x-codeSamples has no cURL sample. | |
| require-curl-samples: | |
| name: Require cURL in x-codeSamples | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - uses: actions/setup-node@v6 | |
| with: | |
| node-version: "20" | |
| cache: "npm" | |
| - name: Install dependencies | |
| run: npm install | |
| - name: Check routes have cURL in x-codeSamples | |
| run: | | |
| npm run check-openapi-code-samples -- curl-check assets/open-api/meilisearch-openapi-mintlify.json | |
| # Informational only: list routes and missing code sample languages. | |
| # This job never fails the workflow (information check only). | |
| info-missing-code-samples: | |
| name: "[Info only - never fails] Missing code samples per route" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - uses: actions/setup-node@v6 | |
| with: | |
| node-version: "20" | |
| cache: "npm" | |
| - name: Install dependencies | |
| run: npm install | |
| - name: List routes and missing code samples (informational, never fails) | |
| run: | | |
| npm run check-openapi-code-samples -- info assets/open-api/meilisearch-openapi-mintlify.json || true | |
| # Fails if any OpenAPI route is not mapped in docs.json API Routes pages. | |
| require-routes-coverage: | |
| name: Require all OpenAPI routes in docs.json | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - uses: actions/setup-node@v6 | |
| with: | |
| node-version: "20" | |
| cache: "npm" | |
| - name: Install dependencies | |
| run: npm install | |
| - name: Check all OpenAPI routes are covered in docs.json | |
| run: | | |
| npm run check-openapi-routes-coverage |