https://github.com/kubernetes/kube-openapi
Kubernetes OpenAPI spec generation & serving
https://github.com/kubernetes/kube-openapi
Last synced: about 1 year ago
JSON representation
Kubernetes OpenAPI spec generation & serving
- Host: GitHub
- URL: https://github.com/kubernetes/kube-openapi
- Owner: kubernetes
- License: apache-2.0
- Created: 2017-07-12T23:43:39.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-18T19:09:50.000Z (over 1 year ago)
- Last Synced: 2025-05-13T00:14:24.998Z (about 1 year ago)
- Language: Go
- Size: 7.04 MB
- Stars: 342
- Watchers: 18
- Forks: 219
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Kube OpenAPI
This repo is the home for Kubernetes OpenAPI discovery spec generation. The goal
is to support a subset of OpenAPI features to satisfy kubernetes use-cases but
implement that subset with little to no assumption about the structure of the
code or routes. Thus, there should be no kubernetes specific code in this repo.
There are two main parts:
- A model generator that goes through .go files, find and generate model
definitions.
- The spec generator that is responsible for dynamically generating
the final OpenAPI spec using web service routes or combining other
OpenAPI/Json specs.
## Contributing
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute.