summaryrefslogtreecommitdiff
path: root/vendor/k8s.io/kube-openapi/README.md
blob: babadde1f191e82b00e2fb0a747c89a40211a7ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# 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 generate 
the final OpenAPI spec using web service routes or combining other 
OpenAPI/Json specs.