docs-v2/api-docs

Generate InfluxDB API docs

InfluxDB uses Redoc, redoc-cli, and Redocly's OpenApi CLI to generate API documentation from the InfluxDB openapi contracts.

To minimize repo size, the generated API documentation HTML is gitignored, therefore not committed directly to the docs repo. The InfluxDB docs deployment process uses swagger files in the api-docs directory to generate version-specific API documentation.

Versioned swagger files

The structure versions swagger files using the following pattern:

api-docs/
  ├── v2.0/
  │     └── ref.yml
  ├── v2.1/
  │     └── ref.yml
  ├── v2.2/
  │     └── ref.yml
  └── etc...

Configure OpenAPI CLI linting and bundling

.redoc.yaml sets linting and bundling options for openapi CLI. ./openapi/plugins contains custom OpenAPI CLI plugins composed of rules (for linting) and decorators (for bundle customization).

Custom content

./openapi/content contains custom OAS (OpenAPI Spec) content in YAML files. The content structure and Markdown must be valid OAS.

./openapi/plugins use ./openapi/plugins/decorators to apply the content to the contracts. .yml files in ./openapi/content/ set content for sections (nodes) in the contract. To update the content for those nodes, you only need to update the YAML files.

To add new YAML files for other nodes in the openapi contracts, configure the new content YAML file in ./openapi/content/content.js. Then, write a decorator module for the node and configure the decorator in the plugin, e.g. ./openapi/plugins/docs-plugin.js. See the complete list of OAS v3.0 nodes.

openapi CLI requires that modules use CommonJS require syntax for imports.

Generate API docs locally

Because the API documentation HTML is gitignored, you must manually generate it to view the API docs locally.

Verify that you have a working npx (it's included with Node.js). In your terminal, run:

npx --version

If npx returns errors, download and run a recent version of the Node.js installer for your OS.

In your terminal, from the root of the docs repo, run:

cd api-docs

# Generate the API docs
sh generate-api-docs.sh