OpenAPI Export

The browser generates an OpenAPI 3.1 document describing the API as it exists on your installation.

Downloading#

From the admin browser, click OpenAPI (JSON) or OpenAPI (YAML) in the page actions. The URLs are:

The admin URLs require a logged-in admin session. The public URLs are available to anyone and contain only the resources selected under Configuration.

What the document contains#

• A servers entry pointing at your site's /api base URL.
• For each resource, the collection and item paths with the operations available: get for search and read, post, put, patch and delete where permitted.
• Query parameters for search operations, taken from the same catalog the browser displays.
• A component schema per resource built from its JSON-LD keys and entity fields, referenced by the responses.
• An API key security scheme using the key_identity and key_credential query parameters.

Using it#

The document works with the usual OpenAPI tooling: import it into Postman or Insomnia, feed it to a client generator, or publish it with Swagger UI or Redoc. Regenerate it after installing or removing modules so it reflects the current set of resources.