openapi

package

Go to main page

Versions in this module

v0

v0.14.0

Aug 11, 2026

Changes in this version

type Document

+ JSONSchemaDialect string

type Schema

+ Anchor string

+ Comment string

+ Const any

+ Contains *Schema

+ ContentEncoding string

+ ContentMediaType string

+ ContentSchema *Schema

+ Defs map[string]Schema

+ DependentRequired map[string][]string

+ DependentSchemas map[string]Schema

+ Deprecated bool

+ DynamicAnchor string

+ DynamicRef string

+ Else *Schema

+ Examples []any

+ ID string

+ If *Schema

+ MaxContains *uint64

+ MinContains *uint64

+ Not *Schema

+ PatternProperties map[string]Schema

+ PrefixItems []Schema

+ PropertyNames *Schema

+ ReadOnly bool

+ SchemaDialect string

+ Then *Schema

+ Title string

+ UnevaluatedItems any

+ UnevaluatedProperties any

+ WriteOnly bool

v0.13.0

Aug 11, 2026

Changes in this version

type Schema

+ Default any

+ ExclusiveMaximum *float64

+ ExclusiveMinimum *float64

+ MaxItems *uint64

+ MaxLength *uint64

+ MaxProperties *uint64

+ Maximum *float64

+ MinItems uint64

+ MinLength uint64

+ MinProperties uint64

+ Minimum *float64

+ MultipleOf *float64

+ Nullable bool

+ Pattern string

+ Types []string

+ UniqueItems bool

v0.12.0

Aug 10, 2026

Changes in this version

+ type Header struct

+ Description string

+ Required bool

+ Schema Schema

type Operation

+ Responses map[string]Response

+ type Response struct

+ Content map[string]MediaType

+ Description string

+ Headers map[string]Header

v0.11.0

Aug 10, 2026

Changes in this version

type Components

+ Schemas map[string]Schema

type Document

+ func LoadFileWithOptions(path string, options LoadOptions) (*Document, error)

+ type LoadOptions struct

+ ExternalRefRoot string

+ HTTPClient *http.Client

+ MaxReferenceBytes int64

+ RemoteRefHosts []string

type Schema

+ AllOf []Schema

+ AnyOf []Schema

+ OneOf []Schema

+ Ref string

v0.10.0

Aug 10, 2026

Changes in this version

+ type OAuth2Flow struct

+ AuthorizationURL string

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

type SecurityScheme

+ Flows map[string]OAuth2Flow

v0.9.0

Aug 10, 2026

v0.8.0

Aug 10, 2026

v0.7.0

Aug 10, 2026

Changes in this version

type Parameter

+ AllowReserved bool

+ Explode *bool

+ Style string

v0.6.0

Aug 10, 2026

Changes in this version

type Document

+ SecuritySet bool

type Operation

+ SecuritySet bool

v0.5.0

Aug 10, 2026

v0.4.0

Aug 10, 2026

Changes in this version

type Document

+ Security []SecurityRequirement

type Operation

+ Security []SecurityRequirement

+ type SecurityRequirement map[string][]string

type SecurityScheme

+ BearerFormat string

+ Scheme string

v0.3.0

Aug 10, 2026

v0.2.0

Aug 10, 2026

v0.1.1

Aug 10, 2026

Changes in this version

+ type Components struct

+ SecuritySchemes map[string]SecurityScheme

type Document

+ Components Components

type OperationView

+ Parameters []Parameter

type PathItem

+ Parameters []Parameter

+ type SecurityScheme struct

+ In string

+ Name string

+ Type string

v0.1.0

Aug 9, 2026

Changes in this version

+ type Document struct

+ Info Info

+ OpenAPI string

+ Paths map[string]PathItem

+ Servers []Server

+ func LoadFile(path string) (*Document, error)

+ func (d *Document) Operations() []OperationView

+ type Info struct

+ Title string

+ Version string

+ type MediaType struct

+ Schema Schema

+ type Operation struct

+ Description string

+ OperationID string

+ Parameters []Parameter

+ RequestBody *RequestBody

+ Summary string

+ type OperationView struct

+ Item PathItem

+ Method string

+ Op *Operation

+ Path string

+ type Parameter struct

+ In string

+ Name string

+ Required bool

+ Schema Schema

+ type PathItem struct

+ Delete *Operation

+ Description string

+ Get *Operation

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Summary string

+ type RequestBody struct

+ Content map[string]MediaType

+ Required bool

+ type Schema struct

+ AdditionalProperties any

+ Description string

+ Enum []any

+ Format string

+ Items *Schema

+ Properties map[string]Schema

+ Required []string

+ Type string

+ type Server struct

+ URL string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL