spec

Sep 6, 2023

Changes in this version

+ func StrPtr(str string) *string

+ type ErrorResponse struct

+ Required bool

+ type ErrorResponses []ErrorResponse

+ func (responses ErrorResponses) GetByStatusCode(statusCode string) *ErrorResponse

+ func (responses ErrorResponses) GetByStatusName(httpStatus string) *ErrorResponse

+ func (responses ErrorResponses) HttpStatusCodes() []string

+ func (responses ErrorResponses) NonRequired() []*ErrorResponse

+ func (responses ErrorResponses) Required() []*ErrorResponse

+ func (value *ErrorResponses) UnmarshalYAML(node *yaml.Node) error

+ func (value ErrorResponses) MarshalYAML() (interface{}, error)

+ type FormDataParams Params

+ func (params FormDataParams) MarshalYAML() (interface{}, error)

+ func (value *FormDataParams) UnmarshalYAML(node *yaml.Node) error

+ type FormUrlEncodedParams Params

+ func (params FormUrlEncodedParams) MarshalYAML() (interface{}, error)

+ func (value *FormUrlEncodedParams) UnmarshalYAML(node *yaml.Node) error

type OperationResponse

+ ErrorResponse *ErrorResponse

type OperationResponses

+ func (responses OperationResponses) Errors() []*OperationResponse

+ func (responses OperationResponses) NonRequiredErrors() []*OperationResponse

+ func (responses OperationResponses) RequiredErrors() []*OperationResponse

+ func (responses OperationResponses) Success() []*OperationResponse

+ type RequestBody struct

+ Description *string

+ FormData FormDataParams

+ FormUrlEncoded FormUrlEncodedParams

+ Location *yaml.Node

+ Type *Type

+ func (body *RequestBody) Is(kind RequestBodyKind) bool

+ func (body *RequestBody) IsBodyFormData() bool

+ func (body *RequestBody) IsBodyFormUrlEncoded() bool

+ func (body *RequestBody) IsEmpty() bool

+ func (body *RequestBody) IsJson() bool

+ func (body *RequestBody) IsText() bool

+ func (body *RequestBody) Kind() RequestBodyKind

+ func (value *RequestBody) UnmarshalYAML(node *yaml.Node) error

+ func (value RequestBody) MarshalYAML() (interface{}, error)

+ type RequestBodyKind string

+ const RequestBodyEmpty

+ const RequestBodyFormData

+ const RequestBodyFormUrlEncoded

+ const RequestBodyJson

+ const RequestBodyString

type Response

+ Body ResponseBody

+ Description *string

+ func (response *Response) IsError() bool

+ func (response *Response) IsSuccess() bool

+ type ResponseBody struct

+ Location *yaml.Node

+ Type *Type

+ func (body *ResponseBody) Is(kind ResponseBodyKind) bool

+ func (body *ResponseBody) IsEmpty() bool

+ func (body *ResponseBody) IsJson() bool

+ func (body *ResponseBody) IsText() bool

+ func (body *ResponseBody) Kind() ResponseBodyKind

+ func (value *ResponseBody) String() string

+ func (value *ResponseBody) UnmarshalYAML(node *yaml.Node) error

+ func (value ResponseBody) MarshalYAML() (interface{}, error)

+ type ResponseBodyKind string

+ const ResponseBodyEmpty

+ const ResponseBodyJson

+ const ResponseBodyString

type SpecWalker

+ func (w *SpecWalker) Empty()

+ func (w *SpecWalker) Models(models []*NamedModel)

+ func (w *SpecWalker) OnEmpty(callback func()) *SpecWalker

+ func (w *SpecWalker) OnRequestBody(callback func(operation *RequestBody)) *SpecWalker

+ func (w *SpecWalker) OnResponseBody(callback func(body *ResponseBody)) *SpecWalker

+ func (w *SpecWalker) RequestBody(body *RequestBody)

+ func (w *SpecWalker) ResponseBody(body *ResponseBody)

type TypeDef

+ func (self *TypeDef) IsEnum() bool

+ func (self *TypeDef) IsErrorModel() bool

+ func (self *TypeDef) IsModel() bool

Sep 16, 2022

Changes in this version

+ const BadRequestError

+ const ErrorLocation

+ const HttpStatusBadRequest

+ const HttpStatusInternalServerError

+ const HttpStatusNotFound

+ const InternalServerError

+ const NotFoundError

+ const TypeAliasBool

+ const TypeAliasInt

+ const TypeAliasLong

+ const TypeAliasStr

+ const TypeBoolean

+ const TypeDate

+ const TypeDateTime

+ const TypeDecimal

+ const TypeDouble

+ const TypeEmpty

+ const TypeFloat

+ const TypeInt32

+ const TypeInt64

+ const TypeJson

+ const TypeString

+ const TypeUuid

+ const ValidationError

+ var Boolean = Format

+ var Date = Format

+ var DateTime = Format

+ var Float = Format

+ var HttpMethod = Format

+ var HttpParams = Format

+ var Integer = Format

+ var JsonField = Format

+ var LowerCase = Format

+ var PascalCase = Format

+ var SnakeCase = Format

+ var SpecOptionsDefault = SpecOptions

+ var SpecVersion = "2.1"

+ var Types = map[string]TypeInfo

+ var TypesAliases = map[string]string

+ var UUID = Format

+ var VersionFormat = Format

+ func HttpStatusCode(statusName Name) string

+ func HttpStatusName(statusCode string) string

+ func MergeHttpStatusCodes(left, right []string) []string

+ func ReadSpec(data []byte) (*Spec, *Messages, error)

+ func ReadSpecWithOptions(options SpecOptions, data []byte) (*Spec, *Messages, error)

+ func UrlParamStr(param *NamedParam) string

+ func WriteSpec(spec *Spec) ([]byte, error)

+ type Api struct

+ InHttp *Http

+ Name Name

+ Operations Operations

+ type BodyKind string

+ const BodyEmpty

+ const BodyJson

+ const BodyString

+ type Definition struct

+ Description *string

+ Location *yaml.Node

+ Type Type

+ func (value *Definition) UnmarshalYAML(node *yaml.Node) error

+ func (value Definition) MarshalYAML() (interface{}, error)

+ type DefinitionDefault struct

+ Default *string

+ Description *string

+ Location *yaml.Node

+ Type Type

+ func (value *DefinitionDefault) UnmarshalYAML(node *yaml.Node) error

+ func (value DefinitionDefault) MarshalYAML() (interface{}, error)

+ type Endpoint struct

+ Method string

+ Url string

+ UrlParams UrlParams

+ UrlParts []UrlPart

+ func ParseEndpoint(endpointStr string) *Endpoint

+ func (value *Endpoint) UnmarshalYAML(node *yaml.Node) error

+ func (value Endpoint) MarshalYAML() (interface{}, error)

+ type Enum struct

+ Items EnumItems

+ type EnumItem struct

+ Description *string

+ Value string

+ type EnumItems []NamedEnumItem

+ func (value *EnumItems) UnmarshalYAML(node *yaml.Node) error

+ func (value EnumItems) MarshalYAML() (interface{}, error)

+ type Format struct

+ Example string

+ Name string

+ Regex string

+ func FormatOr(f1 Format, f2 Format) Format

+ func (format *Format) Check(value string) error

+ type FormatError struct

+ Format Format

+ Value string

+ func (err *FormatError) Error() string

+ type HeaderParams Params

+ func (params HeaderParams) MarshalYAML() (interface{}, error)

+ func (value *HeaderParams) UnmarshalYAML(node *yaml.Node) error

+ type Http struct

+ Apis []Api

+ InVersion *Version

+ Url *string

+ func (apis *Http) GetUrl() string

+ func (value *Http) UnmarshalYAML(node *yaml.Node) error

+ func (value Http) MarshalYAML() (interface{}, error)

+ type HttpErrors struct

+ InSpec *Spec

+ Models Models

+ ResolvedModels []*NamedModel

+ Responses Responses

+ type Level string

+ const LevelError

+ const LevelInfo

+ const LevelWarning

+ type Location struct

+ Column int

+ Line int

+ type Message struct

+ Level Level

+ Location *Location

+ Message string

+ func Error(messageFormat string, args ...interface{}) Message

+ func Info(messageFormat string, args ...interface{}) Message

+ func Warning(messageFormat string, args ...interface{}) Message

+ func (message Message) At(location *Location) Message

+ func (self Message) String() string

+ type Messages struct

+ Items messages

+ func NewMessages() *Messages

+ func (ms *Messages) Add(message Message)

+ func (ms *Messages) AddAll(messages ...Message)

+ func (ms *Messages) Contains(f func(Message) bool) bool

+ func (ms *Messages) ContainsLevel(level Level) bool

+ type Meta struct

+ Description *string

+ Name Name

+ SpecVersion string

+ Title *string

+ Version string

+ func (value Meta) MarshalYAML() (interface{}, error)

+ type Model struct

+ Description *string

+ Enum *Enum

+ Location *yaml.Node

+ Object *Object

+ OneOf *OneOf

+ func (self *Model) IsEnum() bool

+ func (self *Model) IsObject() bool

+ func (self *Model) IsOneOf() bool

+ func (value *Model) UnmarshalYAML(node *yaml.Node) error

+ func (value Model) MarshalYAML() (interface{}, error)

+ type Models []NamedModel

+ func (value *Models) UnmarshalYAML(node *yaml.Node) error

+ func (value Models) MarshalYAML() (interface{}, error)

+ type ModelsMap map[string]*NamedModel

+ type Name struct

+ Location *yaml.Node

+ Source string

+ func (self Name) CamelCase() string

+ func (self Name) Check(format Format) error

+ func (self Name) FlatCase() string

+ func (self Name) PascalCase() string

+ func (self Name) SnakeCase() string

+ func (self Name) UpperCase() string

+ func (value *Name) UnmarshalYAML(node *yaml.Node) error

+ func (value Name) MarshalYAML() (interface{}, error)

+ type NamedDefinition struct

+ Name Name

+ type NamedDefinitions []NamedDefinition

+ func (value *NamedDefinitions) UnmarshalYAML(node *yaml.Node) error

+ func (value NamedDefinitions) MarshalYAML() (interface{}, error)

+ type NamedEnumItem struct

+ Name Name

+ type NamedModel struct

+ InHttpErrors *HttpErrors

+ InVersion *Version

+ Name Name

+ func OrderModels(models ModelsMap) []*NamedModel

+ type NamedOperation struct

+ InApi *Api

+ Name Name

+ func (op *NamedOperation) FullName() string

+ func (op *NamedOperation) FullUrl() string

+ type NamedParam struct

+ Name Name

+ type Object struct

+ Fields NamedDefinitions

+ type OneOf struct

+ Discriminator *string

+ Items NamedDefinitions

+ type Operation operation

+ func (operation *Operation) BodyIs(kind BodyKind) bool

+ func (operation *Operation) GetResponse(status string) *OperationResponse

+ func (operation *Operation) HasParams() bool

+ func (value *Operation) UnmarshalYAML(node *yaml.Node) error

+ func (value Operation) MarshalYAML() (interface{}, error)

+ type OperationResponse struct

+ Operation *NamedOperation

+ type OperationResponses []OperationResponse

+ func (responses OperationResponses) Get(httpStatus string) *OperationResponse

+ func (responses OperationResponses) GetByStatusCode(statusCode string) *OperationResponse

+ func (responses OperationResponses) HttpStatusCodes() []string

+ func (value *OperationResponses) UnmarshalYAML(node *yaml.Node) error

+ func (value OperationResponses) MarshalYAML() (interface{}, error)

+ type Operations []NamedOperation

+ func (value *Operations) UnmarshalYAML(node *yaml.Node) error

+ func (value Operations) MarshalYAML() (interface{}, error)

+ type Params []NamedParam

+ type QueryParams Params

+ func (params QueryParams) MarshalYAML() (interface{}, error)

+ func (value *QueryParams) UnmarshalYAML(node *yaml.Node) error

+ type Response struct

+ Name Name

+ func (response *Response) BodyIs(kind BodyKind) bool

+ func (response *Response) BodyKind() BodyKind

+ type Responses []Response

+ func (responses *Responses) UnmarshalYAML(node *yaml.Node) error

+ func (responses Responses) GetByStatusCode(statusCode string) *Response

+ func (responses Responses) GetByStatusName(httpStatus string) *Response

+ func (responses Responses) HttpStatusCodes() []string

+ func (responses Responses) MarshalYAML() (interface{}, error)

+ type Security []SecurityRef

+ type SecurityRef securityRef

+ func (value *SecurityRef) UnmarshalYAML(node *yaml.Node) error

+ func (value SecurityRef) MarshalYAML() (interface{}, error)

+ type Spec struct

+ HttpErrors *HttpErrors

+ Versions []Version

+ func (value *Spec) UnmarshalYAML(node *yaml.Node) error

+ func (value Spec) MarshalYAML() (interface{}, error)

+ type SpecOptions struct

+ AddErrors bool

+ type SpecParseResult struct

+ Messages Messages

+ Spec *Spec

+ type SpecWalker struct

+ func NewWalker() *SpecWalker

+ func (w *SpecWalker) Api(api *Api)

+ func (w *SpecWalker) HttpErrors(httpErrors *HttpErrors)

+ func (w *SpecWalker) Model(model *NamedModel)

+ func (w *SpecWalker) OnApi(callback func(api *Api)) *SpecWalker

+ func (w *SpecWalker) OnHttpErrors(callback func(httpErrors *HttpErrors)) *SpecWalker

+ func (w *SpecWalker) OnModel(callback func(model *NamedModel)) *SpecWalker

+ func (w *SpecWalker) OnOperation(callback func(operation *NamedOperation)) *SpecWalker

+ func (w *SpecWalker) OnOperationResponse(callback func(response *OperationResponse)) *SpecWalker

+ func (w *SpecWalker) OnParam(callback func(param *NamedParam)) *SpecWalker

+ func (w *SpecWalker) OnResponse(callback func(response *Response)) *SpecWalker

+ func (w *SpecWalker) OnSpecification(callback func(specification *Spec)) *SpecWalker

+ func (w *SpecWalker) OnType(callback func(typ *Type)) *SpecWalker

+ func (w *SpecWalker) OnTypeDef(callback func(typ *TypeDef)) *SpecWalker

+ func (w *SpecWalker) OnVersion(callback func(version *Version)) *SpecWalker

+ func (w *SpecWalker) Operation(operation *NamedOperation)

+ func (w *SpecWalker) OperationResponse(response *OperationResponse)

+ func (w *SpecWalker) Param(param *NamedParam)

+ func (w *SpecWalker) Response(response *Response)

+ func (w *SpecWalker) Specification(specification *Spec)

+ func (w *SpecWalker) Type(typ *Type)

+ func (w *SpecWalker) TypeDef(typ *TypeDef)

+ func (w *SpecWalker) Version(version *Version)

+ type Type struct

+ Definition TypeDef

+ Location *yaml.Node

+ func NewType(str string) *Type

+ func (typ Type) String() string

+ func (value *Type) UnmarshalYAML(node *yaml.Node) error

+ type TypeDef struct

+ Child *TypeDef

+ Info *TypeInfo

+ Name string

+ Node TypeNode

+ Plain string

+ func Array(typ *TypeDef) *TypeDef

+ func Map(typ *TypeDef) *TypeDef

+ func Nullable(typ *TypeDef) *TypeDef

+ func ParseType(value string) TypeDef

+ func Plain(typ string) *TypeDef

+ func (self *TypeDef) BaseType() *TypeDef

+ func (self *TypeDef) IsEmpty() bool

+ func (self *TypeDef) IsNullable() bool

+ func (typ TypeDef) String() string

+ type TypeInfo struct

+ Defaultable bool

+ Model *NamedModel

+ Structure TypeStructure

+ func ArrayTypeInfo() *TypeInfo

+ func MapTypeInfo() *TypeInfo

+ func ModelTypeInfo(model *NamedModel) *TypeInfo

+ func NullableTypeInfo(childInfo *TypeInfo) *TypeInfo

+ type TypeNode int

+ const ArrayType

+ const MapType

+ const NullableType

+ const PlainType

+ type TypeStructure int

+ const StructureArray

+ const StructureNone

+ const StructureObject

+ const StructureScalar

+ type UrlParams Params

+ type UrlPart struct

+ Param *NamedParam

+ Part string

+ type Version struct

+ InSpec *Spec

+ Name Name

+ ResolvedModels []*NamedModel

+ type VersionSpecification struct

+ Http Http

+ Models Models

+ func (value VersionSpecification) MarshalYAML() (interface{}, error)