oas31

Documentation

Index

• type Discriminator
• type ExternalDocumentation
• type OASMixin
  • func (s OASMixin) AppliesTo(t jsonschema.Type) bool
  • func (s OASMixin) Kind() jsonschema.Kind
  • func (s OASMixin) Validate(v interface{}) error
• type Schema
  • func (m *Schema) AppliesTo(t jsonschema.Type) bool
  • func (m *Schema) Keywords() iter.Seq[jsonschema.Keyword]
  • func (m *Schema) Kind() jsonschema.Kind
  • func (m *Schema) Validate(v interface{}) error
• type SpecificationExtension
• type XML

Types

type Discriminator

type Discriminator struct {
	PropertyName string            `json:"propertyName,omitempty" validate:"required"`
	Mapping      map[string]string `json:"mapping,omitempty" validate:"dive,uri-reference"`
}

type ExternalDocumentation

type ExternalDocumentation struct {
	Description string                 `json:"description,omitempty"`
	Url         string                 `json:"url,omitempty" validate:"required,url"`
	Extensions  SpecificationExtension `json:"-"`
}

type OASMixin

type OASMixin struct {
	Example       interface{}            `json:"examples,omitempty"`
	ExternalDocs  *ExternalDocumentation `json:"externalDocs,omitempty"`
	Discriminator *Discriminator         `json:"discriminator,omitempty"`
	Xml           *XML                   `json:"xml,omitempty"`
	Extensions    SpecificationExtension `json:"-"`
}

func (OASMixin) AppliesTo

func (s OASMixin) AppliesTo(t jsonschema.Type) bool

func (OASMixin) Kind

func (s OASMixin) Kind() jsonschema.Kind

func (OASMixin) Validate

func (s OASMixin) Validate(v interface{}) error

type Schema

type Schema struct {
	draft2020.MetaSchemaMixin[*Schema]
	draft2020.ReferenceMixin[Schema]
	draft2020.MetaDataMixin
	draft2020.ValidationMixin
	draft2020.StringMixin
	draft2020.NumericMixin
	draft2020.ObjectMixin[*Schema]
	draft2020.ArrayMixin[*Schema]
	draft2020.UnevaluatedMixin[*Schema]
	draft2020.ApplicatorMixin[*Schema]
	OASMixin
}

func (*Schema) AppliesTo

func (m *Schema) AppliesTo(t jsonschema.Type) bool

func (*Schema) Keywords

func (m *Schema) Keywords() iter.Seq[jsonschema.Keyword]

func (*Schema) Kind

func (m *Schema) Kind() jsonschema.Kind

func (*Schema) Validate

func (m *Schema) Validate(v interface{}) error

type SpecificationExtension

type SpecificationExtension map[string]interface{}

type XML

type XML struct {
	Name       string                 `json:"name,omitempty"`
	Namespace  string                 `json:"namespace,omitempty" validate:"omitempty,uri"`
	Prefix     string                 `json:"prefix,omitempty"`
	Attribute  bool                   `json:"attribute,omitempty"`
	Wrapped    bool                   `json:"wrapped,omitempty"`
	Extensions SpecificationExtension `json:"-"`
}