builder3

Documentation

Index

• Constants
• func BuildOpenAPIDefinitionsForResources(config *common.OpenAPIV3Config, names ...string) (map[string]*spec.Schema, error)
• func BuildOpenAPISpec(webServices []*restful.WebService, config *common.OpenAPIV3Config) (*spec3.OpenAPI, error)
• func BuildOpenAPISpecFromRoutes(webServices []common.RouteContainer, config *common.OpenAPIV3Config) (*spec3.OpenAPI, error)

Constants

const (
	OpenAPIVersion = "3.0"
)

Functions

func BuildOpenAPIDefinitionsForResources

func BuildOpenAPIDefinitionsForResources(config *common.OpenAPIV3Config, names ...string) (map[string]*spec.Schema, error)

BuildOpenAPIDefinitionsForResource builds a partial OpenAPI spec given a sample object and common.Config to customize it. BuildOpenAPIDefinitionsForResources returns the OpenAPI spec which includes the definitions for the passed type names.

func BuildOpenAPISpec

func BuildOpenAPISpec(webServices []*restful.WebService, config *common.OpenAPIV3Config) (*spec3.OpenAPI, error)

BuildOpenAPISpec builds OpenAPI v3 spec given a list of route containers and common.Config to customize it.

Deprecated: BuildOpenAPISpecFromRoutes should be used instead.

func BuildOpenAPISpecFromRoutes

func BuildOpenAPISpecFromRoutes(webServices []common.RouteContainer, config *common.OpenAPIV3Config) (*spec3.OpenAPI, error)

BuildOpenAPISpecFromRoutes builds OpenAPI v3 spec given a list of route containers and common.Config to customize it.