base

Documentation

Index

• func ExtractExamples(...) map[string]*Example
• type Contact
  • func NewContact(contact *low.Contact) *Contact
  • func (c *Contact) GoLow() *low.Contact
• type Discriminator
  • func NewDiscriminator(disc *low.Discriminator) *Discriminator
  • func (d *Discriminator) GoLow() *low.Discriminator
• type Example
  • func NewExample(example *low.Example) *Example
  • func (e *Example) GoLow() *low.Example
• type ExternalDoc
  • func NewExternalDoc(extDoc *low.ExternalDoc) *ExternalDoc
  • func (e *ExternalDoc) GoLow() *low.ExternalDoc
• type Info
  • func NewInfo(info *low.Info) *Info
  • func (i *Info) GoLow() *low.Info
• type License
  • func NewLicense(license *low.License) *License
  • func (l *License) GoLow() *low.License
• type Schema
  • func NewSchema(schema *base.Schema) *Schema
  • func (s *Schema) GoLow() *base.Schema
• type SchemaProxy
  • func NewSchemaProxy(schema *low.NodeReference[*base.SchemaProxy]) *SchemaProxy
  • func (sp *SchemaProxy) GetBuildError() error
  • func (sp *SchemaProxy) Schema() *Schema
• type Tag
  • func NewTag(tag *low.Tag) *Tag
  • func (t *Tag) GoLow() *low.Tag
• type XML
  • func NewXML(xml *low.XML) *XML
  • func (x *XML) GoLow() *low.XML

Functions

func ExtractExamples

func ExtractExamples(elements map[lowmodel.KeyReference[string]]lowmodel.ValueReference[*low.Example]) map[string]*Example

Types

type Contact

type Contact struct {
	Name  string
	URL   string
	Email string
	// contains filtered or unexported fields
}

func NewContact

func NewContact(contact *low.Contact) *Contact

func (*Contact) GoLow

func (c *Contact) GoLow() *low.Contact

type Discriminator

type Discriminator struct {
	PropertyName string
	Mapping      map[string]string
	// contains filtered or unexported fields
}

func NewDiscriminator

func NewDiscriminator(disc *low.Discriminator) *Discriminator

func (*Discriminator) GoLow

func (d *Discriminator) GoLow() *low.Discriminator

type Example

type Example struct {
	Summary       string
	Description   string
	Value         any
	ExternalValue string
	Extensions    map[string]any
	// contains filtered or unexported fields
}

func NewExample

func NewExample(example *low.Example) *Example

func (*Example) GoLow

func (e *Example) GoLow() *low.Example

type ExternalDoc

type ExternalDoc struct {
	Description string
	URL         string
	Extensions  map[string]any
	// contains filtered or unexported fields
}

func NewExternalDoc

func NewExternalDoc(extDoc *low.ExternalDoc) *ExternalDoc

func (*ExternalDoc) GoLow

func (e *ExternalDoc) GoLow() *low.ExternalDoc

type Info

type Info struct {
	Title          string
	Description    string
	TermsOfService string
	Contact        *Contact
	License        *License
	Version        string
	// contains filtered or unexported fields
}

func NewInfo

func NewInfo(info *low.Info) *Info

func (*Info) GoLow

func (i *Info) GoLow() *low.Info

type License

type License struct {
	Name string
	URL  string
	// contains filtered or unexported fields
}

func NewLicense

func NewLicense(license *low.License) *License

func (*License) GoLow

func (l *License) GoLow() *low.License

type Schema

type Schema struct {
	Title                string
	MultipleOf           int
	Maximum              int
	ExclusiveMaximum     int
	Minimum              int
	ExclusiveMinimum     int
	MaxLength            int
	MinLength            int
	Pattern              string
	Format               string
	MaxItems             int
	MinItems             int
	UniqueItems          int
	MaxProperties        int
	MinProperties        int
	Required             []string
	Enum                 []string
	Type                 string
	AllOf                []*SchemaProxy
	OneOf                []*SchemaProxy
	AnyOf                []*SchemaProxy
	Not                  []*SchemaProxy
	Items                []*SchemaProxy
	Properties           map[string]*SchemaProxy
	AdditionalProperties any
	Description          string
	Default              any
	Nullable             bool
	Discriminator        *Discriminator
	ReadOnly             bool
	WriteOnly            bool
	XML                  *XML
	ExternalDocs         *ExternalDoc
	Example              any
	Deprecated           bool
	Extensions           map[string]any
	// contains filtered or unexported fields
}

func NewSchema

func NewSchema(schema *base.Schema) *Schema

func (*Schema) GoLow

func (s *Schema) GoLow() *base.Schema

type SchemaProxy

type SchemaProxy struct {
	// contains filtered or unexported fields
}

func NewSchemaProxy

func NewSchemaProxy(schema *low.NodeReference[*base.SchemaProxy]) *SchemaProxy

func (*SchemaProxy) GetBuildError

func (sp *SchemaProxy) GetBuildError() error

func (*SchemaProxy) Schema

func (sp *SchemaProxy) Schema() *Schema

type Tag

type Tag struct {
	Name         string
	Description  string
	ExternalDocs *ExternalDoc
	Extensions   map[string]any
	// contains filtered or unexported fields
}

func NewTag

func NewTag(tag *low.Tag) *Tag

func (*Tag) GoLow

func (t *Tag) GoLow() *low.Tag

type XML

type XML struct {
	Name       string
	Namespace  string
	Prefix     string
	Attribute  bool
	Wrapped    bool
	Extensions map[string]any
	// contains filtered or unexported fields
}

func NewXML

func NewXML(xml *low.XML) *XML

func (*XML) GoLow

func (x *XML) GoLow() *low.XML