schemas

Documentation

Index

• type GenerateJSONSchema
  • func (GenerateJSONSchema) Help() *markers.DefinitionHelp
• type Generator
  • func (Generator) CheckFilter() loader.NodeFilter
  • func (g Generator) Generate(ctx *genall.GenerationContext) error
  • func (Generator) Help() *markers.DefinitionHelp
  • func (Generator) RegisterMarkers(into *markers.Registry) error

Types

type GenerateJSONSchema

type GenerateJSONSchema struct {

	// OmitCustomUnionMembers indicates that the Json schema generated from this type should omit Custom union members.
	OmitCustomUnionMembers bool `marker:",optional"`

	// OmitPluginUnionMembers indicates that the Json schema generated from this type should omit Plugin component union members.
	OmitPluginUnionMembers bool `marker:",optional"`

	ShortenEndpointNameLength bool `marker:",optional"`

	// Title indicates the content ot the Json Schema `title` attribute
	Title string `marker:",optional"`
}

GenerateJSONSchema drives whether a Json schema should be generated from this GO Struct type

func (GenerateJSONSchema) Help

func (GenerateJSONSchema) Help() *markers.DefinitionHelp

type Generator

type Generator struct{}

Generator generates JSON schemas from the GO source code of the Kubernetes API

A JSON Schema is generated for each GO structure that had the `devfile:jsonschema:generate` annotation. The semver-compatible version of JSON Schemas is defined by the `devfile:jsonschema:version` annotation on the package. Typically in the `doc.go` file.

func (Generator) CheckFilter

func (Generator) CheckFilter() loader.NodeFilter

func (Generator) Generate

func (g Generator) Generate(ctx *genall.GenerationContext) error

Generate generates the artifacts

func (Generator) Help

func (Generator) Help() *markers.DefinitionHelp

func (Generator) RegisterMarkers

func (Generator) RegisterMarkers(into *markers.Registry) error

RegisterMarkers registers the markers of the Generator