schema

Documentation

Index

• func Decode(input map[string]interface{}, obj interface{}) error
• func DecodeString(input string, obj interface{}) error
• func Encode(obj interface{}) (map[string]interface{}, error)
• func GetKey(input map[string]interface{}, key string) (interface{}, bool)
• func MapToSpec(m map[string]interface{}) *proto.Spec
• func ReadByTag(obj interface{}, target string) []string
• func ValidateRequired(input map[string]interface{}, obj interface{}) error
• type Array
  • func (a *Array) Kind() reflect.Type
  • func (a *Array) Type() string
• type Diff
• type DiffField
• type Field
• type Map
  • func (m *Map) Kind() reflect.Type
  • func (m *Map) Type() string
• type Record
  • func (r *Record) Kind() reflect.Type
  • func (s *Record) OpenAPIV3() interface{}
  • func (s *Record) OpenAPIV3JSON() ([]byte, error)
  • func (s *Record) OpenAPIV3Yaml() ([]byte, error)
  • func (r *Record) Type() string
• type ResourceData
  • func NewResourceData(sch *Schema2, data *proto.Spec) *ResourceData
  • func (r *ResourceData) Decode(obj interface{}) error
  • func (r *ResourceData) Get(k string) interface{}
  • func (r *ResourceData) GetOK(k string) (interface{}, bool)
• type ScalarType
  • func (s ScalarType) Kind() reflect.Type
  • func (i ScalarType) String() string
  • func (s ScalarType) Type() string
• type Schema
  • func GenerateSchema(s interface{}) (*Schema, error)
• type Schema2
  • func (s *Schema2) Diff(i, j *proto.Spec) Diff
  • func (s *Schema2) Get(k string) (*Field, error)
  • func (s *Schema2) Validate(spec *proto.Spec) error
• type Type

Functions

func Decode

func Decode(input map[string]interface{}, obj interface{}) error

Decode decodes a map into an object

func DecodeString

func DecodeString(input string, obj interface{}) error

DecodeString decodes a string into an object

func Encode

func Encode(obj interface{}) (map[string]interface{}, error)

func GetKey

func GetKey(input map[string]interface{}, key string) (interface{}, bool)

func MapToSpec

func MapToSpec(m map[string]interface{}) *proto.Spec

func ReadByTag

func ReadByTag(obj interface{}, target string) []string

func ValidateRequired

func ValidateRequired(input map[string]interface{}, obj interface{}) error

Types

type Array

type Array struct {
	Elem Type
}

Array is an array of objects

func (*Array) Kind

func (a *Array) Kind() reflect.Type

func (*Array) Type

func (a *Array) Type() string

Type implements the Type interface

type Diff

type Diff map[string]DiffField

type DiffField

type DiffField struct {
	Old interface{}
	New interface{}
}

type Field

type Field struct {
	Type Type

	// Computed describes whether the field is a status
	Computed bool

	// Required specifies if the field is required
	Required bool

	// ForceNew describes whether a change in the field requires delete the old one
	ForceNew bool

	// Default value for the field
	Default string
}

Field is a field in a record

type Map

type Map struct {
	Elem Type
}

Map is a map<string, interface{}> without specific types

func (*Map) Kind

func (m *Map) Kind() reflect.Type

func (*Map) Type

func (m *Map) Type() string

Type implements the Type interface

type Record

type Record struct {
	Fields map[string]*Field
}

Record is an object with several values

func (*Record) Kind

func (r *Record) Kind() reflect.Type

func (*Record) OpenAPIV3

func (s *Record) OpenAPIV3() interface{}

OpenAPIV3 returns the OpenApi v3 representation of the schema

func (*Record) OpenAPIV3JSON

func (s *Record) OpenAPIV3JSON() ([]byte, error)

OpenAPIV3JSON creates the OpenAPIv3 spec for the Schema in JSON format

func (*Record) OpenAPIV3Yaml

func (s *Record) OpenAPIV3Yaml() ([]byte, error)

OpenAPIV3Yaml creates the OpenAPIv3 spec for the Schema in YAML format

func (*Record) Type

func (r *Record) Type() string

Type implements the Type interface

type ResourceData

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

func NewResourceData

func NewResourceData(sch *Schema2, data *proto.Spec) *ResourceData

func (*ResourceData) Decode

func (r *ResourceData) Decode(obj interface{}) error

func (*ResourceData) Get

func (r *ResourceData) Get(k string) interface{}

func (*ResourceData) GetOK

func (r *ResourceData) GetOK(k string) (interface{}, bool)

type ScalarType

type ScalarType int

ScalarType is a scalar type

const (
	// TypeString is a string type
	TypeString ScalarType = iota

	// TypeInt is a int type
	TypeInt

	// TypeBool is a bool type
	TypeBool
)

func (ScalarType) Kind

func (s ScalarType) Kind() reflect.Type

func (ScalarType) String

func (i ScalarType) String() string

func (ScalarType) Type

func (s ScalarType) Type() string

Type implements the Type interface

type Schema

type Schema struct {
	Spec   *Record
	Status *Record
}

Schema is an OpenAPIv3 schema of a resource

func GenerateSchema

func GenerateSchema(s interface{}) (*Schema, error)

GenerateSchema generates an OpenAPIv3 schema

type Schema2

type Schema2 struct {
	Spec *Record
}

func (*Schema2) Diff

func (s *Schema2) Diff(i, j *proto.Spec) Diff

func (*Schema2) Get

func (s *Schema2) Get(k string) (*Field, error)

func (*Schema2) Validate

func (s *Schema2) Validate(spec *proto.Spec) error

type Type

type Type interface {
	Type() string
	Kind() reflect.Type
}

Type describes a valid type for the schema