Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

oas

package

Go to main page

Versions in this module

v0

v0.3.0

Jan 19, 2024

v0.2.1

Dec 13, 2023

v0.2.0

Oct 30, 2023

Changes in this version

type OASSchema

+ func (s *OASSchema) GetIgnoresForNested(name string) []string

+ func (s *OASSchema) IsPropertyIgnored(name string) bool

type SchemaOpts

+ Ignores []string

v0.1.0

Oct 17, 2023

Changes in this version

+ var ErrMultiTypeSchema = errors.New("unsupported multi-type, attribute cannot be created")

+ var ErrSchemaNotFound = errors.New("no compatible schema found")

+ func BuildSchema(proxy *base.SchemaProxy, schemaOpts SchemaOpts, globalOpts GlobalSchemaOpts) (*OASSchema, *SchemaError)

+ type GlobalSchemaOpts struct

+ OverrideComputability schema.ComputedOptionalRequired

+ type NodeType int

+ const AdditionalProperties

+ const AllOf

+ const AnyOf

+ const Items

+ const None

+ const OneOf

+ const Type

+ type OASSchema struct

+ Format string

+ GlobalSchemaOpts GlobalSchemaOpts

+ Schema *base.Schema

+ SchemaOpts SchemaOpts

+ Type string

+ func BuildSchemaFromRequest(op *high.Operation, schemaOpts SchemaOpts, globalOpts GlobalSchemaOpts) (*OASSchema, error)

+ func BuildSchemaFromResponse(op *high.Operation, schemaOpts SchemaOpts, globalOpts GlobalSchemaOpts) (*OASSchema, error)

+ func (s *OASSchema) BuildBoolDataSource(name string, computability schema.ComputedOptionalRequired) (attrmapper.DataSourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildBoolElementType() (schema.ElementType, *SchemaError)

+ func (s *OASSchema) BuildBoolProvider(name string, optionalOrRequired schema.OptionalRequired) (attrmapper.ProviderAttribute, *SchemaError)

+ func (s *OASSchema) BuildBoolResource(name string, computability schema.ComputedOptionalRequired) (attrmapper.ResourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildCollectionDataSource(name string, computability schema.ComputedOptionalRequired) (attrmapper.DataSourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildCollectionElementType() (schema.ElementType, *SchemaError)

+ func (s *OASSchema) BuildCollectionProvider(name string, optionalOrRequired schema.OptionalRequired) (attrmapper.ProviderAttribute, *SchemaError)

+ func (s *OASSchema) BuildCollectionResource(name string, computability schema.ComputedOptionalRequired) (attrmapper.ResourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildDataSourceAttribute(name string, computability schema.ComputedOptionalRequired) (attrmapper.DataSourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildDataSourceAttributes() (attrmapper.DataSourceAttributes, *SchemaError)

+ func (s *OASSchema) BuildElementType() (schema.ElementType, *SchemaError)

+ func (s *OASSchema) BuildIntegerDataSource(name string, computability schema.ComputedOptionalRequired) (attrmapper.DataSourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildIntegerElementType() (schema.ElementType, *SchemaError)

+ func (s *OASSchema) BuildIntegerProvider(name string, optionalOrRequired schema.OptionalRequired) (attrmapper.ProviderAttribute, *SchemaError)

+ func (s *OASSchema) BuildIntegerResource(name string, computability schema.ComputedOptionalRequired) (attrmapper.ResourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildMapDataSource(name string, computability schema.ComputedOptionalRequired) (attrmapper.DataSourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildMapElementType() (schema.ElementType, *SchemaError)

+ func (s *OASSchema) BuildMapProvider(name string, optionalOrRequired schema.OptionalRequired) (attrmapper.ProviderAttribute, *SchemaError)

+ func (s *OASSchema) BuildMapResource(name string, computability schema.ComputedOptionalRequired) (attrmapper.ResourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildNumberDataSource(name string, computability schema.ComputedOptionalRequired) (attrmapper.DataSourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildNumberElementType() (schema.ElementType, *SchemaError)

+ func (s *OASSchema) BuildNumberProvider(name string, optionalOrRequired schema.OptionalRequired) (attrmapper.ProviderAttribute, *SchemaError)

+ func (s *OASSchema) BuildNumberResource(name string, computability schema.ComputedOptionalRequired) (attrmapper.ResourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildObjectElementType() (schema.ElementType, *SchemaError)

+ func (s *OASSchema) BuildProviderAttribute(name string, optionalOrRequired schema.OptionalRequired) (attrmapper.ProviderAttribute, *SchemaError)

+ func (s *OASSchema) BuildProviderAttributes() (attrmapper.ProviderAttributes, *SchemaError)

+ func (s *OASSchema) BuildResourceAttribute(name string, computability schema.ComputedOptionalRequired) (attrmapper.ResourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildResourceAttributes() (attrmapper.ResourceAttributes, *SchemaError)

+ func (s *OASSchema) BuildSingleNestedDataSource(name string, computability schema.ComputedOptionalRequired) (attrmapper.DataSourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildSingleNestedProvider(name string, optionalOrRequired schema.OptionalRequired) (attrmapper.ProviderAttribute, *SchemaError)

+ func (s *OASSchema) BuildSingleNestedResource(name string, computability schema.ComputedOptionalRequired) (attrmapper.ResourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildStringDataSource(name string, computability schema.ComputedOptionalRequired) (attrmapper.DataSourceAttribute, *SchemaError)

+ func (s *OASSchema) BuildStringElementType() (schema.ElementType, *SchemaError)

+ func (s *OASSchema) BuildStringProvider(name string, optionalOrRequired schema.OptionalRequired) (attrmapper.ProviderAttribute, *SchemaError)

+ func (s *OASSchema) BuildStringResource(name string, computability schema.ComputedOptionalRequired) (attrmapper.ResourceAttribute, *SchemaError)

+ func (s *OASSchema) GetComputability(name string) schema.ComputedOptionalRequired

+ func (s *OASSchema) GetDeprecationMessage() *string

+ func (s *OASSchema) GetDescription() *string

+ func (s *OASSchema) GetFloatValidators() []schema.Float64Validator

+ func (s *OASSchema) GetIntegerValidators() []schema.Int64Validator

+ func (s *OASSchema) GetListValidators() []schema.ListValidator

+ func (s *OASSchema) GetMapValidators() []schema.MapValidator

+ func (s *OASSchema) GetOptionalOrRequired(name string) schema.OptionalRequired

+ func (s *OASSchema) GetSetValidators() []schema.SetValidator

+ func (s *OASSchema) GetStringValidators() []schema.StringValidator

+ func (s *OASSchema) IsMap() bool

+ func (s *OASSchema) IsSensitive() *bool

+ func (s *OASSchema) NestSchemaError(err *SchemaError, propName string) *SchemaError

+ func (s *OASSchema) SchemaErrorFromProperty(err error, propName string) *SchemaError

+ type SchemaError struct

+ func NewSchemaError(err error, lineNumber int, path ...string) *SchemaError

+ func SchemaErrorFromNode(err error, schema *base.Schema, nodeType NodeType) *SchemaError

+ func SchemaErrorFromProxy(err error, proxy *base.SchemaProxy) *SchemaError

+ func (e *SchemaError) Error() string

+ func (e *SchemaError) LineNumber() int

+ func (e *SchemaError) NestedSchemaError(parentName string, lineNumber int) *SchemaError

+ func (e *SchemaError) Path() string

+ type SchemaOpts struct

+ OverrideDeprecationMessage string

+ OverrideDescription string