API Documentation

The Federated Catalogue exposes an OpenAPI 3 specification.

Live API (running service)

When the service is running, interactive documentation is served at:

• Swagger UI: <service-base-url>/swagger-ui/index.html
• OpenAPI JSON: <service-base-url>/v3/api-docs

Versioned specification (source)

The committed specification file in this repository:

https://github.com/eclipse-xfsc/federated-catalogue/blob/main/openapi/fc_openapi.yaml

Architecture and protocol context

For the architectural and conceptual description of the API (endpoints, resources, lifecycle, trust-framework integration), see the Architecture Document:

https://github.com/eclipse-xfsc/docs/tree/main/federated-catalogue