# OpenAPI Specification

Devops application includes a link to auto generated API "Documentation", which can be viewed through an interactive UI or downloaded as OpenAPI specification for external tools.

<figure><img src="/files/0AUIjxRJytBRTo8nrSXo" alt=""><figcaption><p>OpenAPI Documentation</p></figcaption></figure>

This specification is automatically generated using the following configurations:

* **Gateway Channels:** Mapping runners to individual gateways to list only relevant APIs for a selected gateway
* **Gateway Tokens:** Mapping authentication tokens to API endpoints
* **Runners:** Mapping state managers to standard list of CRUD endpoints
* **Schemas:** Mapping JSON schemas to CRUD endpoints and Saga references
* **Sagas:** Mapping custom API endpoints, using "allowed on" stream information

{% hint style="info" %}
If JSON schema for a state is not configured, it is not displayed for the mapping CRUD runner.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.rierino.com/devops/api-gateway-and-security/apis/openapi-specification.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.