docs-v2/.github/instructions/api-docs.instructions.md

applyTo
api-docs/**/*.md, layouts/**/*.html

InfluxDB API documentation

To edit the API reference documentation, edit the YAML files in /api-docs.

InfluxData uses Redoc to generate the full InfluxDB API documentation when documentation is deployed. Redoc generates HTML documentation using the InfluxDB swagger.yml. For more information about generating InfluxDB API documentation, see the API Documentation README.

Generate API documentation locally

From api-docs directory:

1. Install dependencies. To generate the API documentation locally, you need to have Node.js and Yarn installed.

   yarn install
   

2. Run the script to generate the API documentation.

   generate-api-docs.sh