config

Documentation

Index

• type APIOperation
• type Computability
• type Config
  • func ParseGenConfigYAML(path string) (*Config, error)
• type Override
• type PlanModifier
• type Resource
• type SchemaOptions
• type Validator

Types

type APIOperation

type APIOperation struct {
	Path   string `yaml:"path"`
	Method string `yaml:"method"`
}

type Computability

type Computability struct {
	Optional bool `yaml:"optional"`
	Computed bool `yaml:"computed"`
	Required bool `yaml:"required"`
}

type Config

type Config struct {
	Resources map[string]Resource `yaml:"resources"`
}

func ParseGenConfigYAML

func ParseGenConfigYAML(path string) (*Config, error)

type Override

type Override struct {
	Computability *Computability `yaml:"computability,omitempty"`
	Description   string         `yaml:"description"`
	PlanModifiers []PlanModifier `yaml:"plan_modifiers"`
	Validators    []Validator    `yaml:"validators"`
}

type PlanModifier

type PlanModifier struct {
	Definition string   `yaml:"definition"`
	Imports    []string `yaml:"imports"`
}

type Resource

type Resource struct {
	Create        *APIOperation `yaml:"create"`
	Read          *APIOperation `yaml:"read"`
	Update        *APIOperation `yaml:"update"`
	Delete        *APIOperation `yaml:"delete"`
	SchemaOptions SchemaOptions `yaml:"schema"`
}

type SchemaOptions

type SchemaOptions struct {
	Ignores   []string            `yaml:"ignores"`
	Aliases   map[string]string   `yaml:"aliases"`
	Overrides map[string]Override `yaml:"overrides"`
	Timeouts  []string            `yaml:"timeouts"`
}

type Validator

type Validator struct {
	Definition string   `yaml:"definition"`
	Imports    []string `yaml:"imports"`
}