OpenAPI documents

ReportPlane generates OpenAPI from saved resources. This keeps examples and schemas tied to the control-plane definitions rather than a separate handwritten file.

Model OpenAPI#

Open a model in the console and use its OpenAPI action to describe the field object schema.

Field types map to OpenAPI scalar, array, or object types. Required ingest fields appear in the generated required list.

Ingest-client OpenAPI#

Open an ingest client in the console to generate a contract for POST /ingest and the client's allowed models.

The document includes Bearer, API-key, and mTLS security schemes. When one model is allowed, each data item references that model. With several allowed models, the envelope remains accurate while consumers use the selected schema key.

Analytics OpenAPI#

Open an Analytics API in the console to generate a contract for its POST /query operation.

The document contains:

• the Analytics API key example;
• runtime filter schema and allowed operators;
• output columns and row fields from aliases;
• result_metadata;
• x-reportplane-chart-type;
• optional x-reportplane-visualization.

Servers#

Ingest documents use the public ingest origin. Analytics documents use the public query origin. The model document provides schema context through the management surface.

Swagger and export#

Use the console's OpenAPI/Swagger surface to inspect and export the JSON document. Treat exported files as snapshots: regenerate them after model, client scope, filter, alias, or visualization changes.