Transport
HTTP RPC
The procedures are, by topic:
- Deployments: list, get, submit, preview, cancel, delete, action, set update policy.
- Builds: list, logs.
- Schema: the default schema and renames, the schema and renames of a given source, the application paths and the sections of a configuration.
- Catalog: the component listing and the artwork of one component.
A procedure that needs authorization declares an HTTP bearer security scheme, so that an interactive client can send a token of the front-end. api does not check the token: it sends it to the authorization callback (see Authorization). Each set-up of a hosting provider serves an interactive page of the OpenAPI document for its own api, with that api as its only server and in its CORS allowlist.
Centrifugo pub/sub
A front-end connects to Centrifugo over WebSocket. api publishes a build event on the channel of each build, and a deployment state event on the channel of each deployment. Each set-up serves the rendered AsyncAPI documentation of its own api.
The two documents are validated on each change, so that a malformed document does not reach the clients that are generated from it (006-service-deployment).