OpenAPI Setup

This section will contain the generated OpenAPI documentation once the Eixam API spec is available.

Status

The docusaurus-plugin-openapi-docs package is already installed. Activation requires:

1. The API spec file at openapi.yaml (repo root of eixam-docs)
2. Uncommenting the plugin config in docusaurus.config.js

How to activate

Once the spec file exists, uncomment the following in docusaurus.config.js:

plugins: [
  [
    'docusaurus-plugin-openapi-docs',
    {
      id: 'openapi',
      docsPluginId: 'classic',
      config: {
        eixam: {
          specPath: 'openapi.yaml',
          outputDir: 'docs/openapi',
          sidebarOptions: { groupPathsBy: 'tag' },
        },
      },
    },
  ],
],
themes: ['docusaurus-theme-openapi-docs'],

Then run:

npm run docusaurus gen-api-docs eixam

The generated docs will appear in docs/openapi/ and be automatically included in the sidebar.