OpenAPI Specification

Rierino automatically produces OpenAPI specification from runner & saga configurations.

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.

OpenAPI Documentation

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

If JSON schema for a state is not configured, it is not displayed for the mapping CRUD runner.

Last updated