spec

Jan 21, 2023

Changes in this version

type Attribute

+ Signed bool

Sep 24, 2019

Changes in this version

type Specification

+ DefaultOrder func() []string

Aug 24, 2019

Changes in this version

type Attribute

+ Encrypted bool

Jul 1, 2019

Changes in this version

type Attribute

+ ExposedName string

May 1, 2019

Changes in this version

+ func Pluralize(word string) string

+ type APIInfo struct

+ Prefix string

+ Root string

+ Version int

+ func LoadAPIInfo(path string) (*APIInfo, error)

+ func NewAPIInfo() *APIInfo

+ func (a *APIInfo) Validate() []error

+ type Attribute struct

+ AllowedChars string

+ AllowedCharsMessage string

+ AllowedChoices []string

+ Autogenerated bool

+ ConvertedName string

+ ConvertedType string

+ CreationOnly bool

+ DefaultOrder bool

+ DefaultValue interface{}

+ Deprecated bool

+ Description string

+ ExampleValue interface{}

+ Exposed bool

+ Extensions map[string]interface{}

+ Filterable bool

+ ForeignKey bool

+ Getter bool

+ Identifier bool

+ Initializer string

+ MaxLength uint16

+ MaxValue float64

+ MinLength uint16

+ MinValue float64

+ Name string

+ OmitEmpty bool

+ Orderable bool

+ PrimaryKey bool

+ ReadOnly bool

+ Required bool

+ Secret bool

+ Setter bool

+ Stored bool

+ SubType string

+ Transient bool

+ Type AttributeType

+ TypeProvider string

+ ValidationProviders map[string]*ValidationMap

+ Validations []string

+ func (a *Attribute) Validate() []error

+ type AttributeNameConverterFunc func(name string) string

+ type AttributeType string

+ const AttributeTypeBool

+ const AttributeTypeEnum

+ const AttributeTypeExt

+ const AttributeTypeFloat

+ const AttributeTypeInt

+ const AttributeTypeList

+ const AttributeTypeObject

+ const AttributeTypeRef

+ const AttributeTypeRefList

+ const AttributeTypeRefMap

+ const AttributeTypeString

+ const AttributeTypeTime

+ type AttributeTypeConverterFunc func(typ AttributeType, subtype string) (converted string, provider string)

+ type Config struct

+ Author string

+ Copyright string

+ Description string

+ Email string

+ Name string

+ ProductName string

+ URL string

+ Version string

+ func LoadConfig(path string) (*Config, error)

+ func NewConfig() *Config

+ func (c *Config) Key(section, key string) string

+ type Model struct

+ Aliases []string

+ Delete *RelationAction

+ Description string

+ Detached bool

+ Documentation string

+ EntityName string

+ EntityNamePlural string

+ Extends []string

+ Extensions map[string]interface{}

+ Get *RelationAction

+ Group string

+ IsRoot bool

+ Package string

+ Private bool

+ ResourceName string

+ RestName string

+ Update *RelationAction

+ Validations []string

+ func (m *Model) Validate() []error

+ type Parameter struct

+ AllowedChoices []string

+ DefaultValue interface{}

+ Description string

+ ExampleValue interface{}

+ Multiple bool

+ Name string

+ Type ParameterType

+ func (p *Parameter) Validate(relatedReSTName string) []error

+ type ParameterDefinition struct

+ Entries []*Parameter

+ Required [][][]string

+ func (p *ParameterDefinition) Validate(relatedReSTName string) []error

+ type ParameterMapping map[string]*ParameterDefinition

+ func LoadGlobalParameters(path string) (ParameterMapping, error)

+ func NewParameterMapping() ParameterMapping

+ func (p ParameterMapping) Read(reader io.Reader, validate bool) (err error)

+ func (p ParameterMapping) Validate() []error

+ func (p ParameterMapping) Write(writer io.Writer) error

+ type ParameterType string

+ const ParameterTypeBool

+ const ParameterTypeDuration

+ const ParameterTypeEnum

+ const ParameterTypeFloat

+ const ParameterTypeInt

+ const ParameterTypeString

+ const ParameterTypeTime

+ type Relation struct

+ Create *RelationAction

+ Delete *RelationAction

+ Get *RelationAction

+ RestName string

+ Update *RelationAction

+ func (r *Relation) Specification() Specification

+ func (r *Relation) Validate() []error

+ type RelationAction struct

+ Deprecated bool

+ Description string

+ ParameterDefinition *ParameterDefinition

+ ParameterReferences []string

+ func (ra *RelationAction) Validate(currentRestName string, remoteRestName string, k string) []error

+ type Relationship struct

+ Create map[string]*RelationAction

+ Delete map[string]*RelationAction

+ Get map[string]*RelationAction

+ GetMany map[string]*RelationAction

+ Update map[string]*RelationAction

+ func NewRelationship() *Relationship

+ func (r *Relationship) Set(action string, name string, ra *RelationAction)

+ type Specification interface

+ ApplyBaseSpecifications func(specs ...Specification) error

+ Attribute func(name string, version string) *Attribute

+ AttributeVersions func() []string

+ Attributes func(version string) []*Attribute

+ ExposedAttributes func(version string) []*Attribute

+ Identifier func() *Attribute

+ LatestAttributesVersion func() string

+ Model func() *Model

+ OrderingAttributes func(version string) []*Attribute

+ Read func(reader io.Reader, validate bool) error

+ Relation func(restName string) *Relation

+ Relations func() []*Relation

+ Validate func() []error

+ Write func(writer io.Writer) error

+ func LoadSpecification(specPath string, validate bool) (Specification, error)

+ func NewSpecification() Specification

+ type SpecificationSet interface

+ APIInfo func() *APIInfo

+ Configuration func() *Config

+ Groups func() []string

+ Len func() int

+ Relationships func() map[string]*Relationship

+ RelationshipsByResourceName func() map[string]*Relationship

+ RelationshipsByRestName func() map[string]*Relationship

+ Specification func(name string) Specification

+ SpecificationGroup func(groupName string) []Specification

+ Specifications func() (specs []Specification)

+ TypeMapping func() TypeMapping

+ ValidationMapping func() ValidationMapping

+ func LoadSpecificationSet(dirname string, nameConvertFunc AttributeNameConverterFunc, ...) (SpecificationSet, error)

+ func LoadSpecificationSetFromGithub(token string, repoURL string, refName string, internalPath string, ...) (SpecificationSet, error)

+ type TypeMap struct

+ Description string

+ Import string

+ Initializer string

+ Type string

+ type TypeMapping map[string]map[string]*TypeMap

+ func LoadTypeMapping(path string) (TypeMapping, error)

+ func NewTypeMapping() TypeMapping

+ func (t TypeMapping) All(mode string) (mapping []*TypeMap)

+ func (t TypeMapping) Mapping(mode string, externalType string) (mapping *TypeMap, err error)

+ func (t TypeMapping) Read(reader io.Reader, validate bool) (err error)

+ func (t TypeMapping) Validate() []error

+ func (t TypeMapping) Write(writer io.Writer) error

+ type ValidationMap struct

+ Import string

+ Name string

+ type ValidationMapping map[string]map[string]*ValidationMap

+ func LoadValidationMapping(path string) (ValidationMapping, error)

+ func NewValidationMapping() ValidationMapping

+ func (v ValidationMapping) Mapping(mode string, functionName string) (mapping *ValidationMap, err error)

+ func (v ValidationMapping) Read(reader io.Reader, validate bool) (err error)

+ func (v ValidationMapping) Validate() []error

+ func (v ValidationMapping) Write(writer io.Writer) error