Conduktor API docs

For main docs, see docs repo.

Deployment overview

• URL
• Vercel project

Automated updates

These API docs are automatically updated by the update-api-docs action in the conduktor-actions repo.

The action will perform the manual steps below, copying the openapi yaml files from each repo.

Manual updates

API docs live on host:8888 of the deployed Gateway/Console and are also published to: Gateway API and Console API docs.

To update the public docs:

1. Copy the latest open API yaml files from the conduktor-proxy or console-plus repo based on the version:
   • Gateway v2
   • Gateway v1: removed in Gateway 3.21.0. For earlier versions, take proxy/src/main/resources/gateway-API.yaml from that version's tag in conduktor-proxy.
   • Console
2. Paste the yaml files to the relevant directory within openapi and rename as required with the version number of the latest update.
3. Add the new version number to openapi/manifest.json.