Skip to main content

API Documentation

All teams building APIs should be automatically publishing their documentation using the OpenAPI Specification 3.0. Teams should use these instructions for publishing the swagger spec file to the central api docs repository.

It’s expected that all APIs follow our API standards.

A network map of microservice dependencies can be generated using this central repository by manually committing some additional information about the new service.

See the README for information on how to do this.

View API documentation

This page was last reviewed on 24 September 2024. It needs to be reviewed again on 24 September 2025 by the page owner platops-build-notices .
This page was set to be reviewed before 24 September 2025 by the page owner platops-build-notices. This might mean the content is out of date.