schema

Documentation

Index

• Constants
• Variables
• func Dump(sch Schema, w io.Writer) error
• func Examples(sch Schema) []interface{}
• type ArraySchema
  • func (s ArraySchema) Items() Schema
  • func (s ArraySchema) SeenMaxLength() *int
  • func (s ArraySchema) SeenMinLength() *int
• type BooleanSchema
• type Field
• type IntegerSchema
  • func (s IntegerSchema) Enum() []int
  • func (s IntegerSchema) Maximum() *int
  • func (s IntegerSchema) Minimum() *int
  • func (s IntegerSchema) SeenMaximum() *int
  • func (s IntegerSchema) SeenMinimum() *int
• type NumberSchema
  • func (s NumberSchema) Maximum() *float64
  • func (s NumberSchema) Minimum() *float64
  • func (s NumberSchema) SeenMaximum() *float64
  • func (s NumberSchema) SeenMinimum() *float64
• type ObjectSchema
  • func (s ObjectSchema) Properties() map[string]Schema
• type Schema
  • func Coerce(i interface{}) Schema
  • func CoerceSlice(i interface{}) []Schema
  • func Derive(key string, o interface{}) Schema
  • func FromMap(m map[string]interface{}) Schema
  • func Load(ctx context.Context, uri, arg string) (Schema, error)
  • func Parse(s string) (sch Schema, err error)
  • func Read(r io.Reader) (Schema, error)
  • func (s Schema) DeepClone() Schema
  • func (s Schema) Format() jsonformat.JsonFormat
  • func (s Schema) IncrSamples()
  • func (s Schema) IncrSamplesDeep()
  • func (s Schema) MustObject() ObjectSchema
  • func (s Schema) NullOnly() bool
  • func (s Schema) Nullable() bool
  • func (s Schema) Samples() int
  • func (s Schema) ToArray() (ArraySchema, bool)
  • func (s Schema) ToBoolean() (BooleanSchema, bool)
  • func (s Schema) ToInteger() (IntegerSchema, bool)
  • func (s Schema) ToNumber() (NumberSchema, bool)
  • func (s Schema) ToObject() (ObjectSchema, bool)
  • func (s Schema) ToString() (StringSchema, bool)
  • func (s Schema) Type() jsontype.JsonType
• type StringSchema
  • func (s StringSchema) Enum() []string
  • func (s StringSchema) MaxLength() *int
  • func (s StringSchema) MinLength() *int
  • func (s StringSchema) SeenMaxLength() *int
  • func (s StringSchema) SeenMaximum() *string
  • func (s StringSchema) SeenMinLength() *int
  • func (s StringSchema) SeenMinimum() *string
  • func (s StringSchema) SeenStrings() []string
  • func (s StringSchema) SeenUriLocations() []string
  • func (s StringSchema) Sensitive() bool
• type UntypedSchema

Constants

const (
	TF_DATE          = "2006-01-02"
	TF_DATETIME      = time.RFC3339
	TF_DATETIME_NOTZ = "2006-01-02T15:04:05"
	TF_TIME          = "15:04:05Z07:00"
)

Variables

var SensitiveSalt string

Functions

func Dump

func Dump(sch Schema, w io.Writer) error

func Examples

func Examples(sch Schema) []interface{}

Types

type ArraySchema

type ArraySchema Schema

func (ArraySchema) Items

func (s ArraySchema) Items() Schema

func (ArraySchema) SeenMaxLength

func (s ArraySchema) SeenMaxLength() *int

func (ArraySchema) SeenMinLength

func (s ArraySchema) SeenMinLength() *int

type BooleanSchema

type BooleanSchema Schema

type Field

type Field string

const (
	P_ENUM       Field = "enum"
	P_EXAMPLES   Field = "examples"
	P_FORMAT     Field = "format"
	P_ITEMS      Field = "items"
	P_MINIMUM    Field = "minimum"
	P_MIN_LENGTH Field = "minLength"
	P_MAXIMUM    Field = "maximum"
	P_MAX_LENGTH Field = "maxLength"
	P_ONE_OF     Field = "oneOf"
	P_PROPERTIES Field = "properties"
	P_TYPE       Field = "type"

	PX_IDENTIFIER      Field = "x-identifier"
	PX_NULLABLE        Field = "x-nullable"
	PX_LAST_VALUE      Field = "x-lastValue"
	PX_SAMPLES         Field = "x-samples"
	PX_SEEN_MINIMUM    Field = "x-seenMinimum"
	PX_SEEN_MAXIMUM    Field = "x-seenMaximum"
	PX_SEEN_MIN_LENGTH Field = "x-seenMinLength"
	PX_SEEN_MAX_LENGTH Field = "x-seenMaxLength"
	PX_SEEN_STRINGS    Field = "x-seenStrings"
	PX_SENSITIVE       Field = "x-sensitive"
	PX_URI_LOCATIONS   Field = "x-uriLocations"
)

type IntegerSchema

type IntegerSchema Schema

func (IntegerSchema) Enum

func (s IntegerSchema) Enum() []int

func (IntegerSchema) Maximum

func (s IntegerSchema) Maximum() *int

func (IntegerSchema) Minimum

func (s IntegerSchema) Minimum() *int

func (IntegerSchema) SeenMaximum

func (s IntegerSchema) SeenMaximum() *int

func (IntegerSchema) SeenMinimum

func (s IntegerSchema) SeenMinimum() *int

type NumberSchema

type NumberSchema Schema

func (NumberSchema) Maximum

func (s NumberSchema) Maximum() *float64

func (NumberSchema) Minimum

func (s NumberSchema) Minimum() *float64

func (NumberSchema) SeenMaximum

func (s NumberSchema) SeenMaximum() *float64

func (NumberSchema) SeenMinimum

func (s NumberSchema) SeenMinimum() *float64

type ObjectSchema

type ObjectSchema Schema

func (ObjectSchema) Properties

func (s ObjectSchema) Properties() map[string]Schema

type Schema

type Schema map[Field]interface{}

func Coerce

func Coerce(i interface{}) Schema

func CoerceSlice

func CoerceSlice(i interface{}) []Schema

func Derive

func Derive(key string, o interface{}) Schema

func FromMap

func FromMap(m map[string]interface{}) Schema

func Load

func Load(ctx context.Context, uri, arg string) (Schema, error)

func Parse

func Parse(s string) (sch Schema, err error)

func Read

func Read(r io.Reader) (Schema, error)

func (Schema) DeepClone

func (s Schema) DeepClone() Schema

func (Schema) Format

func (s Schema) Format() jsonformat.JsonFormat

func (Schema) IncrSamples

func (s Schema) IncrSamples()

func (Schema) IncrSamplesDeep

func (s Schema) IncrSamplesDeep()

func (Schema) MustObject

func (s Schema) MustObject() ObjectSchema

func (Schema) NullOnly

func (s Schema) NullOnly() bool

func (Schema) Nullable

func (s Schema) Nullable() bool

func (Schema) Samples

func (s Schema) Samples() int

func (Schema) ToArray

func (s Schema) ToArray() (ArraySchema, bool)

func (Schema) ToBoolean

func (s Schema) ToBoolean() (BooleanSchema, bool)

func (Schema) ToInteger

func (s Schema) ToInteger() (IntegerSchema, bool)

func (Schema) ToNumber

func (s Schema) ToNumber() (NumberSchema, bool)

func (Schema) ToObject

func (s Schema) ToObject() (ObjectSchema, bool)

func (Schema) ToString

func (s Schema) ToString() (StringSchema, bool)

func (Schema) Type

func (s Schema) Type() jsontype.JsonType

type StringSchema

type StringSchema Schema

func (StringSchema) Enum

func (s StringSchema) Enum() []string

func (StringSchema) MaxLength

func (s StringSchema) MaxLength() *int

func (StringSchema) MinLength

func (s StringSchema) MinLength() *int

func (StringSchema) SeenMaxLength

func (s StringSchema) SeenMaxLength() *int

func (StringSchema) SeenMaximum

func (s StringSchema) SeenMaximum() *string

func (StringSchema) SeenMinLength

func (s StringSchema) SeenMinLength() *int

func (StringSchema) SeenMinimum

func (s StringSchema) SeenMinimum() *string

func (StringSchema) SeenStrings

func (s StringSchema) SeenStrings() []string

func (StringSchema) SeenUriLocations

func (s StringSchema) SeenUriLocations() []string

func (StringSchema) Sensitive

func (s StringSchema) Sensitive() bool

type UntypedSchema

type UntypedSchema Schema