generators

README

Generate OpenAPI definitions

• To generate definition for a specific type or package add "+k8s:openapi-gen=true" tag to the type/package comment lines.
• To exclude a type or a member from a tagged package/type, add "+k8s:openapi-gen=false" tag to the comment lines.

OpenAPI Extensions

OpenAPI spec can have extensions on types. To define one or more extensions on a type or its member add +k8s:openapi-gen=x-kubernetes-$NAME:$VALUE to the comment lines before type/member. A type/member can have multiple extensions. The rest of the line in the comment will be used as $VALUE so there is no need to escape or quote the value string. Extensions can be used to pass more information to client generators or documentation generators. For example a type might have a friendly name to be displayed in documentation or being used in a client's fluent interface.

Custom OpenAPI type definitions

Custom types which otherwise don't map directly to OpenAPI can override their OpenAPI definition by implementing a function named "OpenAPIDefinition" with the following signature:

	import openapi "github.com/vmware-tanzu/graph-framework-for-microservices/src/kube-openapi/pkg/common"

	// ...

	type Time struct {
		time.Time
	}

	func (_ Time) OpenAPIDefinition() openapi.OpenAPIDefinition {
		return openapi.OpenAPIDefinition{
			Schema: spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type:   []string{"string"},
					Format: "date-time",
				},
			},
		}
	}

Alternatively, the type can avoid the "openapi" import by defining the following methods. The following example produces the same OpenAPI definition as the example above:

    func (_ Time) OpenAPISchemaType() []string { return []string{"string"} }
    func (_ Time) OpenAPISchemaFormat() string { return "date-time" }

Documentation

Index

• Constants
• func DefaultNameSystem() string
• func GenerateValidationProperty(vp validationParser) error
• func NameSystems() namer.NameSystems
• func Packages(context *generator.Context, arguments *args.GeneratorArgs) generator.Packages
• type APIRule

Constants

const (
	Maximum          = "Maximum"
	Minimum          = "Minimum"
	ExclusiveMaximum = "ExclusiveMaximum"
	ExclusiveMinimum = "ExclusiveMinimum"
	MaxLength        = "MaxLength"
	MinLength        = "MinLength"
	MaxProperties    = "MaxProperties"
	MinProperties    = "MinProperties"
	MaxItems         = "MaxItems"
	MinItems         = "MinItems"
	Pattern          = "Pattern"
	UniqueItems      = "UniqueItems"
)

Validation Markers.

Functions

func DefaultNameSystem

func DefaultNameSystem() string

DefaultNameSystem returns the default name system for ordering the types to be processed by the generators in this package.

func GenerateValidationProperty

func GenerateValidationProperty(vp validationParser) error

func NameSystems

func NameSystems() namer.NameSystems

NameSystems returns the name system used by the generators in this package.

func Packages

func Packages(context *generator.Context, arguments *args.GeneratorArgs) generator.Packages

Types

type APIRule

type APIRule interface {
	// Validate evaluates API rule on type t and returns a list of field names in
	// the type that violate the rule. Empty field name [""] implies the entire
	// type violates the rule.
	Validate(t *types.Type) ([]string, error)

	// Name returns the name of APIRule
	Name() string
}

APIRule is the interface for validating API rule on Go types