kube-openapi: k8s.io/kube-openapi/pkg/builder Index | Files

package builder

import "k8s.io/kube-openapi/pkg/builder"

Package builder contains code to generate OpenAPI discovery spec (which initial version of it also known as Swagger 2.0). For more details: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md


Package Files

doc.go openapi.go util.go


const (
    OpenAPIVersion = "2.0"

func BuildOpenAPIDefinitionsForResource Uses

func BuildOpenAPIDefinitionsForResource(model interface{}, config *common.Config) (*spec.Definitions, error)

BuildOpenAPIDefinitionsForResource builds a partial OpenAPI spec given a sample object and common.Config to customize it.

func BuildOpenAPIDefinitionsForResources Uses

func BuildOpenAPIDefinitionsForResources(config *common.Config, names ...string) (*spec.Swagger, error)

BuildOpenAPIDefinitionsForResources returns the OpenAPI spec which includes the definitions for the passed type names.

func BuildOpenAPISpec Uses

func BuildOpenAPISpec(webServices []*restful.WebService, config *common.Config) (*spec.Swagger, error)

BuildOpenAPISpec builds OpenAPI spec given a list of webservices (containing routes) and common.Config to customize it.

Package builder imports 9 packages (graph) and is imported by 16 packages. Updated 2019-07-26. Refresh now. Tools for package owners.