This is the landing page for the Cloud Agent technical documentation set.
- The OpenAPI specification for a service building block is written in YAML format.
- Each building block is responsible for making its YAML spec available to other parties via HTTP GET on one of its service endpoints.
Swagger UI is used and allows development teams and service consumers to visualize and interact with the API’s resources without having any of the implementation logic in place. It is automatically generated from the OpenAPI specification.
Swagger UI is available as a Docker image.
The following docker-compose.yml file can be used to run both services in one shot by executing the following command from the repo's root folder:
docker-compose -f docs/docker-compose.yml up
- OpenAPI specifications doc is available localhost:8081