k8s.io/kube-openapi@v0.0.0-20240228011516-70dd3763d340/README.md (about)

     1  # Kube OpenAPI
     2  
     3  This repo is the home for Kubernetes OpenAPI discovery spec generation. The goal 
     4  is to support a subset of OpenAPI features to satisfy kubernetes use-cases but 
     5  implement that subset with little to no assumption about the structure of the 
     6  code or routes. Thus, there should be no kubernetes specific code in this repo. 
     7  
     8  
     9  There are two main parts: 
    10   - A model generator that goes through .go files, find and generate model 
    11  definitions. 
    12   - The spec generator that is responsible for dynamically generating 
    13  the final OpenAPI spec using web service routes or combining other 
    14  OpenAPI/Json specs.
    15  
    16  ## Contributing
    17  
    18  Please see [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute.