This repo contains the OpenAPI specifications for Directus' API.

The static spec in this repo contains all the system endpoints and a definition for a generic /items/{collection} endpoint.

The spec is exported in 3 formats: .yaml, .json, and .js. The JS file is just an export of the same JSON but parsed into JS for ease of use in JS projects.

The specification is written to work with OpenAPI version 3 and up.

The spec relies on two vendor-specific fields to represent information required by the system:

Key that maps a system endpoint to its corresponding system collection.

Examples of how to use the equivalent of the documented REST endpoint in the JS SDK and/or GraphQL endpoint.

To deploy a new release to npm:

1. Bump the version in package.json via a PR and merge it into main
2. Run the release workflow