Skip to content

API and event reference

Indexes of known OpenAPI specifications and event-contract locations in firefly-oss. Links point at repository files on GitHub. This hub does not invent endpoints or publish a synthetic API catalogue.

Page Contents
OpenAPI index Spec paths by OpenPlatform module
Event contracts Published schemas where they exist; stubs where they do not

How to use these indexes

  1. Start from the module

    Open the business module that owns your journey.

  2. Follow the OpenAPI link

    Read the linked openapi.yml (or module README) for paths, schemas, and local /v3/api-docs behaviour.

  3. Trust the repository

    Specs can move between openapi.yml and api-spec/openapi.yml as modules evolve. The repo wins over this hub if they disagree.

Runtime Swagger UI / SpringDoc URLs (often /v3/api-docs and /swagger-ui.html) are documented in individual service READMEs when the service is running locally. This hub does not assume a public hosted API gateway.