openapi

package

Go to main page

Versions in this module

v0

v0.3.0

Mar 22, 2026

Changes in this version

+ type ExternalDocs struct

+ Description string

+ URL string

type Info

+ TermsOfService string

type Spec

+ ExternalDocs *ExternalDocs

+ Tags []Tag

+ type Tag struct

+ Description string

+ ExternalDocs *ExternalDocs

+ Name string

v0.2.0

Mar 14, 2026

Changes in this version

type Schema

+ Example any

+ Nullable bool

type Version

+ const Version32

v0.1.0

Feb 7, 2026

Changes in this version

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

+ func ToString(spec *Spec, format Format) (string, error)

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

+ func WriteFile(path string, spec *Spec) error

+ func WriteJSON(w io.Writer, spec *Spec) error

+ func WriteYAML(w io.Writer, spec *Spec) error

+ type Components struct

+ Examples map[string]*Example

+ Headers map[string]*Header

+ Parameters map[string]*Parameter

+ RequestBodies map[string]*RequestBody

+ Responses map[string]*Response

+ Schemas map[string]*Schema

+ SecuritySchemes map[string]*SecurityScheme

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ type Example struct

+ Description string

+ ExternalValue string

+ Summary string

+ Value any

+ type Format string

+ const FormatJSON

+ const FormatYAML

+ type Generator struct

+ func NewGenerator(options GeneratorOptions) *Generator

+ func (g *Generator) Generate(result *inference.InferenceResult) *Spec

+ type GeneratorOptions struct

+ APIVersion string

+ Description string

+ Servers []string

+ Title string

+ Version Version

+ func DefaultGeneratorOptions() GeneratorOptions

+ type Header struct

+ Description string

+ Required bool

+ Schema *Schema

+ type Info struct

+ Contact *Contact

+ Description string

+ License *License

+ Title string

+ Version string

+ type License struct

+ Name string

+ URL string

+ type MediaType struct

+ Example any

+ Examples map[string]Example

+ Schema *Schema

+ type OAuthFlow struct

+ AuthorizationUrl string

+ RefreshUrl string

+ Scopes map[string]string

+ TokenUrl string

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Implicit *OAuthFlow

+ Password *OAuthFlow

+ type Operation struct

+ Deprecated bool

+ Description string

+ OperationID string

+ Parameters []Parameter

+ RequestBody *RequestBody

+ Responses map[string]Response

+ Security []SecurityRequirement

+ Summary string

+ Tags []string

+ type Parameter struct

+ AllowEmptyValue bool

+ Deprecated bool

+ Description string

+ Example any

+ In string

+ Name string

+ Required bool

+ Schema *Schema

+ type PathItem struct

+ Delete *Operation

+ Description string

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []Parameter

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Summary string

+ Trace *Operation

+ type RequestBody struct

+ Content map[string]MediaType

+ Description string

+ Required bool

+ type Response struct

+ Content map[string]MediaType

+ Description string

+ Headers map[string]Header

+ type Schema struct

+ AdditionalProperties any

+ AllOf []*Schema

+ AnyOf []*Schema

+ Const any

+ Default any

+ Deprecated bool

+ Description string

+ Enum []any

+ Examples []any

+ ExclusiveMaximum *float64

+ ExclusiveMinimum *float64

+ Format string

+ Items *Schema

+ MaxItems *int

+ MaxLength *int

+ MaxProperties *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ MinProperties *int

+ Minimum *float64

+ MultipleOf *float64

+ Not *Schema

+ OneOf []*Schema

+ Pattern string

+ Properties map[string]*Schema

+ ReadOnly bool

+ Ref string

+ Required []string

+ Title string

+ Type any

+ UniqueItems bool

+ WriteOnly bool

+ type SecurityRequirement map[string][]string

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ Flows *OAuthFlows

+ In string

+ Name string

+ OpenIdConnectUrl string

+ Scheme string

+ Type string

+ type Server struct

+ Description string

+ URL string

+ type Spec struct

+ Components *Components

+ Info Info

+ OpenAPI string

+ Paths map[string]*PathItem

+ Servers []Server

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

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

+ func GenerateFromInference(result *inference.InferenceResult, options GeneratorOptions) *Spec

+ func ReadFile(path string) (*Spec, error)

+ type Version string

+ const Version30

+ const Version31

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