OpenAPI Specification

Monospace automatically generates an OpenAPI 3.1 compatible specification for your API, documenting all available endpoints, required parameters, and response schemas based on your exact database structure.

This guarantees that the spec is always synchronized with your latest migrations or data model changes.

Generating the OpenAPI Specification

You can fetch the JSON OpenAPI specification via standard GET requests. There are two primary URLs, one for the system schema and one for specific projects.

System Schema

The System specification details all administrative configurations, user management endpoints, roles, and structural operations internal to the server itself.

Endpoint:

GET /api/system/openapi

Required Entitlement: You must have the systemOpenApiSchema:read entitlement to fetch this definition. The Organization Admin role has this by default.

Project Schema

The Project specification dynamically models the endpoints and schemas for the tables and collections you defined in a specific project's database schema.

Endpoint:

GET /api/{project}/openapi

Required Entitlement: You must have the openApiSchema:read entitlement assigned in your project rules configuration to retrieve this specification.