This repository contains the OpenAPI specification for the StackState api. Code generation is not done in this repository but should be done by the clients (who will bridge the spec to the language used). The openapi specification lives in the spec directory.

This repository is managed by release-keeper for versioning, tagging and releasing. Client libraries are expected to pull directly from this git repository using possibly a specific tag version.

To create new docs for the OpenAPI push a tag that has the following format v<semver>, e.g. v5.0.0. Gitlab will automatically publish the docs. The URL to the new docs can be found at the end of the output of the publish job in the CI pipeline for the tag.