This repository provides
- an OpenAPI spec for the Giant Swarm Control Plane API
- the tooling to keep this spec up-to-date
The Giant Swarm Control Plane API is the Kubernetes API living in the control plane of a Giant Swarm installation. It is used to manage clusters and other resources.
The custom resources used in the Control Plane API are defined in the giantswarm/apiextensions repository. There is reference documentation for them in our docs.
To re-generate the spec in this repository based on a specific version of the apiextensions
repo
- Set the
APIEXTENSIONS_BRANCH
in theMakefile
to eithermaster
, a tag, or a branch name. - Run
make generate
. - Find the updated spec in
pkg/spec/swagger.yaml
.