schema

Documentation

Index

• Constants
• func ComputeFlagName(name string) string
• func SortResourcesForApply(catalog KindCatalog, resources []resource.Resource, debug bool)
• func SortResourcesForDelete(catalog KindCatalog, resources []resource.Resource, debug bool)
• type ConsoleKindVersion
  • func (c *ConsoleKindVersion) GetListPath() string
  • func (c *ConsoleKindVersion) GetListQueryParamter() map[string]QueryParameterOption
  • func (c *ConsoleKindVersion) GetName() string
  • func (c *ConsoleKindVersion) GetOrder() int
  • func (c *ConsoleKindVersion) GetParentPathParam() []string
• type GatewayKindVersion
  • func (g *GatewayKindVersion) GetListPath() string
  • func (g *GatewayKindVersion) GetListQueryParamter() map[string]QueryParameterOption
  • func (g *GatewayKindVersion) GetName() string
  • func (g *GatewayKindVersion) GetOrder() int
  • func (g *GatewayKindVersion) GetParentPathParam() []string
• type GetParameter
• type Kind
  • func NewKind(version int, kindVersion KindVersion) Kind
  • func (kind *Kind) AddVersion(version int, kindVersion KindVersion) error
  • func (kind *Kind) ApplyPath(resource *resource.Resource) (string, error)
  • func (kind *Kind) DeletePath(resource *resource.Resource) (string, error)
  • func (kind *Kind) DescribePath(parentPathValues []string, name string) string
  • func (kind *Kind) GetLatestKindVersion() KindVersion
  • func (kind *Kind) GetListFlag() map[string]QueryParameterOption
  • func (Kind *Kind) GetName() string
  • func (kind *Kind) GetParentFlag() []string
  • func (kind *Kind) ListPath(parentPathValues []string) string
  • func (kind *Kind) MaxVersion() int
• type KindCatalog
  • func ConsoleDefaultKind() KindCatalog
  • func GatewayDefaultKind() KindCatalog
• type KindGeneric
• type KindVersion
• type QueryParameterOption
• type Schema
  • func New(schema []byte) (*Schema, error)
  • func (s *Schema) GetConsoleKinds(strict bool) (map[string]Kind, error)
  • func (s *Schema) GetGatewayKinds(strict bool) (map[string]Kind, error)

Constants

const DefaultPriority = 1000 //update  json annotation for Order when changing this value

Functions

func ComputeFlagName

func ComputeFlagName(name string) string

two logics: uniformize flag name and kebab case

func SortResourcesForApply

func SortResourcesForApply(catalog KindCatalog, resources []resource.Resource, debug bool)

func SortResourcesForDelete

func SortResourcesForDelete(catalog KindCatalog, resources []resource.Resource, debug bool)

Types

type ConsoleKindVersion

type ConsoleKindVersion struct {
	ListPath          string
	Name              string
	ParentPathParam   []string
	ListQueryParamter map[string]QueryParameterOption
	Order             int `json:1000` //same value DefaultPriority
}

func (*ConsoleKindVersion) GetListPath

func (c *ConsoleKindVersion) GetListPath() string

func (*ConsoleKindVersion) GetListQueryParamter

func (c *ConsoleKindVersion) GetListQueryParamter() map[string]QueryParameterOption

func (*ConsoleKindVersion) GetName

func (c *ConsoleKindVersion) GetName() string

func (*ConsoleKindVersion) GetOrder

func (c *ConsoleKindVersion) GetOrder() int

func (*ConsoleKindVersion) GetParentPathParam

func (c *ConsoleKindVersion) GetParentPathParam() []string

type GatewayKindVersion

type GatewayKindVersion struct {
	ListPath           string
	Name               string
	ParentPathParam    []string
	ListQueryParameter map[string]QueryParameterOption
	GetAvailable       bool
	Order              int `json:1000` //same value DefaultPriority
}

func (*GatewayKindVersion) GetListPath

func (g *GatewayKindVersion) GetListPath() string

func (*GatewayKindVersion) GetListQueryParamter

func (g *GatewayKindVersion) GetListQueryParamter() map[string]QueryParameterOption

func (*GatewayKindVersion) GetName

func (g *GatewayKindVersion) GetName() string

func (*GatewayKindVersion) GetOrder

func (g *GatewayKindVersion) GetOrder() int

func (*GatewayKindVersion) GetParentPathParam

func (g *GatewayKindVersion) GetParentPathParam() []string

type GetParameter

type GetParameter struct {
	Name      string
	Mandatory bool
}

type Kind

type Kind struct {
	Versions map[int]KindVersion
}

func NewKind

func NewKind(version int, kindVersion KindVersion) Kind

func (*Kind) AddVersion

func (kind *Kind) AddVersion(version int, kindVersion KindVersion) error

func (*Kind) ApplyPath

func (kind *Kind) ApplyPath(resource *resource.Resource) (string, error)

func (*Kind) DeletePath

func (kind *Kind) DeletePath(resource *resource.Resource) (string, error)

func (*Kind) DescribePath

func (kind *Kind) DescribePath(parentPathValues []string, name string) string

func (*Kind) GetLatestKindVersion

func (kind *Kind) GetLatestKindVersion() KindVersion

func (*Kind) GetListFlag

func (kind *Kind) GetListFlag() map[string]QueryParameterOption

func (*Kind) GetName

func (Kind *Kind) GetName() string

func (*Kind) GetParentFlag

func (kind *Kind) GetParentFlag() []string

func (*Kind) ListPath

func (kind *Kind) ListPath(parentPathValues []string) string

func (*Kind) MaxVersion

func (kind *Kind) MaxVersion() int

type KindCatalog

type KindCatalog = map[string]Kind

func ConsoleDefaultKind

func ConsoleDefaultKind() KindCatalog

func GatewayDefaultKind

func GatewayDefaultKind() KindCatalog

type KindGeneric

type KindGeneric[T KindVersion] struct {
	Versions map[int]T
}

type KindVersion

type KindVersion interface {
	GetListPath() string
	GetName() string
	GetParentPathParam() []string
	GetOrder() int
	GetListQueryParamter() map[string]QueryParameterOption
}

type QueryParameterOption

type QueryParameterOption struct {
	FlagName string
	Required bool
	Type     string
}

type Schema

type Schema struct {
	// contains filtered or unexported fields
}

func New

func New(schema []byte) (*Schema, error)

func (*Schema) GetConsoleKinds

func (s *Schema) GetConsoleKinds(strict bool) (map[string]Kind, error)

func (*Schema) GetGatewayKinds

func (s *Schema) GetGatewayKinds(strict bool) (map[string]Kind, error)