openapi

package

Go to main page

Versions in this module

v0

v0.8.1

Jul 16, 2026

v0.8.0

May 17, 2026

Changes in this version

type Components

+ PathItems orderedtypes.Map[string, PathItem]

+ func (c Components) Validate(o *OpenAPI) error

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ func (c Contact) Validate() error

+ type ExternalDocumentation struct

+ Description string

+ URL string

+ func (ed ExternalDocumentation) Validate(path string) error

type FullPath

+ PathItem PathItem

type Info

+ Contact *Contact

+ Description string

+ License *License

+ Summary string

+ TermsOfService string

+ func (i Info) Validate() error

+ type License struct

+ Identifier string

+ Name string

+ URL string

+ func (l License) Validate() error

+ type MediaType struct

+ Description string

+ Example *orderedtypes.Any

+ Examples orderedtypes.Map[string, Example]

+ Schema Schema

type MergedContent

+ MediaType *MediaType

+ MediaTypes []string

type OpenAPI

+ OpenAPI string

+ Security []orderedtypes.Map[string, []string]

+ Servers []Server

+ func (o *OpenAPI) GroupTagsByKind(tags []string) (nav, badge, audience []Tag)

+ func (o OpenAPI) Validate() error

type Operation

+ Servers []Server

+ func (operation Operation) Validate(path string) error

+ type PathItem struct

+ AdditionalOperations orderedtypes.Map[string, Operation]

+ Delete *Operation

+ Description string

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []Parameter

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Query *Operation

+ Ref string

+ Servers []Server

+ Summary string

+ Trace *Operation

+ func (pi PathItem) Methods() iter.Seq2[string, *Operation]

+ func (pi PathItem) Validate(jsonPath string, o *OpenAPI) error

type RequestBody

+ Description string

+ Required bool

+ func (rb RequestBody) Validate(path string) error

+ type Server struct

+ Description string

+ Name string

+ URL string

+ Variables orderedtypes.Map[string, ServerVariable]

+ func (s Server) Validate(path string) error

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

+ func (v ServerVariable) Validate(path string) error

type Tag

+ Description string

+ ExternalDocs *ExternalDocumentation

+ Kind string

+ Parent string

+ Summary string

+ func (t Tag) Validate(path string) error

+ type ValidationError struct

+ func (err ValidationError) Error() string

+ type ValidationErrors []ValidationError

+ func (err ValidationErrors) Error() string

+ func (err ValidationErrors) Join(err2 error) ValidationErrors

+ func (err ValidationErrors) Value() error

v0.7.0

Jan 14, 2026

Changes in this version

type FullPath

+ Path Path

type Path

+ Parameters []Parameter

v0.6.0

Jan 7, 2026

Changes in this version

+ type MergedContent struct

+ Content *Content

+ ContentTypes []string

type RequestBody

+ func (rb *RequestBody) ContentMerged() []MergedContent

v0.5.0

Nov 29, 2025

Changes in this version

type Content

+ Example *orderedtypes.Any

+ Examples orderedtypes.Map[string, Example]

+ type Example struct

+ Description string

+ Summary string

+ Value *orderedtypes.Any

v0.4.0

Nov 4, 2025

Changes in this version

type Content

+ func (c *Content) DescriptionAsHTML() string

+ type ReferenceNotFoundError struct

+ Reference string

+ func (err ReferenceNotFoundError) Error() string

type Schema

+ Const *orderedtypes.Any

+ Deprecated bool

+ Format string

+ Max *int

+ MaxLength *int

+ Min *int

+ MinLength *int

+ type UnparsableReferenceError struct

+ Reference string

+ func (err UnparsableReferenceError) Error() string

v0.3.0

Aug 27, 2025

Changes in this version

type Schema

+ func (s *Schema) GenerateExample() orderedtypes.Any

v0.2.0

Aug 2, 2025

Changes in this version

type Schema

+ PatternProperties *orderedtypes.Map[string, Schema]

v0.1.1

Aug 1, 2025

v0.1.0

Aug 1, 2025

Changes in this version

+ type Components struct

+ Parameters orderedtypes.Map[string, Parameter]

+ RequestBodies orderedtypes.Map[string, RequestBody]

+ Responses orderedtypes.Map[string, Response]

+ Schemas orderedtypes.Map[string, Schema]

+ SecuritySchemes orderedtypes.Map[string, Security]

+ type Content struct

+ Description string

+ Schema Schema

+ type FullPath struct

+ Method string

+ Operation Operation

+ URL string

+ type Info struct

+ Title string

+ Version string

+ type OpenAPI struct

+ Components Components

+ Info Info

+ Paths orderedtypes.Map[string, Path]

+ Tags []Tag

+ Version string

+ func Parse(filepath string) (*OpenAPI, error)

+ func (o *OpenAPI) GetRef(path string) any

+ func (o OpenAPI) GroupedPaths() []PathGroup

+ type Operation struct

+ Deprecated bool

+ Description string

+ Parameters []Parameter

+ RequestBody *RequestBody

+ Responses orderedtypes.Map[string, *Response]

+ Security []orderedtypes.Map[string, []string]

+ Summary *string

+ Tags []string

+ func (op *Operation) DescriptionAsHTML() string

+ func (op Operation) HasBody() bool

+ func (op Operation) HasParameters() bool

+ func (op Operation) HasResponseInfo() bool

+ func (p Operation) SortedResponses() []ResponseAndStatus

+ type Parameter struct

+ AllowEmptyValue bool

+ Deprecated bool

+ Description string

+ Example any

+ In ParameterLocation

+ Name string

+ Ref string

+ Required bool

+ ResolvedRefName string

+ Schema *Schema

+ type ParameterLocation string

+ const ParameterCookie

+ const ParameterHeader

+ const ParameterPath

+ const ParameterQuery

+ type Path struct

+ Delete *Operation

+ Get *Operation

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ func (p Path) Methods() iter.Seq2[string, *Operation]

+ type PathGroup struct

+ Paths []FullPath

+ Tag Tag

+ type RequestBody struct

+ Content orderedtypes.Map[string, *Content]

+ Ref string

+ type Response struct

+ Content orderedtypes.Map[string, Content]

+ Description string

+ Ref string

+ ResolvedRefName string

+ type ResponseAndStatus struct

+ Status string

+ type Schema struct

+ AdditionalProperties *Schema

+ AnyOf []Schema

+ Description string

+ Enum []any

+ Example any

+ Examples []orderedtypes.Any

+ Items *Schema

+ Properties *orderedtypes.Map[string, Schema]

+ Ref string

+ Required []string

+ ResolvedRefName string

+ Type any

+ func (s *Schema) DescriptionAsHTML() string

+ func (s Schema) JSON() string

+ func (s Schema) TypeName() string

+ type Security struct

+ BearerFormat string

+ Description string

+ Flows SecurityFlows

+ In string

+ Name string

+ OpenIdConnectURL string

+ Scheme string

+ Type SecurityType

+ func (s *Security) DescriptionAsHTML() string

+ type SecurityFlow struct

+ AuthorizationURL string

+ RefreshURL string

+ Scopes *orderedtypes.Map[string, string]

+ TokenURL string

+ type SecurityFlows struct

+ AuthorizationCode *SecurityFlow

+ ClientCredentials *SecurityFlow

+ Implicit *SecurityFlow

+ Password *SecurityFlow

+ func (sf *SecurityFlows) Iter() iter.Seq2[string, *SecurityFlow]

+ type SecurityType string

+ const SecurityApiKey

+ const SecurityHttp

+ const SecurityMutualTLS

+ const SecurityOAuth2

+ const SecurityOpenIdConnect

+ type Tag struct

+ Name string

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