Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

openapi

package

Go to main page

Versions in this module

v0

v0.5.2

May 21, 2025

v0.5.1

Nov 13, 2024

v0.4.0

May 18, 2023

v0.3.0

May 18, 2023

v0.2.0

May 18, 2023

Changes in this version

+ type Callback map[string]Path

+ type Components struct

+ Callbacks map[string]Callback

+ Examples map[string]Example

+ Headers map[string]Header

+ Links map[string]Link

+ Parameters map[string]Parameter

+ PathItems map[string]Path

+ RequestBodies map[string]RequestBody

+ Responses map[string]Response

+ Schemas map[string]SchemaObject

+ SecuritySchemes map[string]SecurityScheme

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ type Discriminator struct

+ Mapping map[string]string

+ PropertyName string

+ type Encoding struct

+ AllowReserved bool

+ ContentType string

+ Explode bool

+ Headers map[string]Header

+ Style string

+ type Example struct

+ Description string

+ ExternalValue string

+ Ref string

+ Summary string

+ Value interface{}

+ type ExternalDocs struct

+ Description string

+ URL string

+ type Header struct

+ type License struct

+ Identifier string

+ Name string

+ URL string

+ type Link struct

+ Description string

+ OperationId string

+ OperationRef string

+ Parameters map[string]interface{}

+ Ref string

+ RequestBody map[string]interface{}

+ Server *Server

+ type MediaType struct

+ Encoding map[string]Encoding

+ Example *Example

+ Examples map[string]Example

+ Schema *SchemaObject

+ 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 OpenAPIServerVariable struct

+ Default string

+ Description string

+ Enum []string

+ type Operation struct

+ Callbacks map[string]Callback

+ Deprecated bool

+ Description string

+ ExternalDocs *ExternalDocs

+ OperationId string

+ Parameters []Parameter

+ RequestBody *RequestBody

+ Responses map[string]Response

+ Security []SecurityRequirement

+ Servers []Server

+ Summary string

+ Tags []string

+ type Parameter struct

+ AllowEmptyValue bool

+ AllowReserved bool

+ Content map[string]MediaType

+ Deprecated bool

+ Description string

+ Example *Example

+ Examples map[string]Example

+ Explode bool

+ In string

+ Name string

+ Ref string

+ Required bool

+ Schema *SchemaObject

+ Style string

+ type Path struct

+ Delete *Operation

+ Description string

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []Parameter

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Ref string

+ Servers []Server

+ Summary string

+ Trace *Operation

+ type RequestBody struct

+ Content map[string]MediaType

+ Description string

+ Ref string

+ Required bool

+ type Response struct

+ Content map[string]MediaType

+ Description string

+ Headers map[string]Header

+ Links map[string]Link

+ Ref string

+ type Schema struct

+ Components *Components

+ ExternalDocs *ExternalDocs

+ Info *SchemaInfo

+ JSONSchemaDialect string

+ OpenAPI string

+ Paths map[string]Path

+ Security []SecurityRequirement

+ Servers []Server

+ Tags []Tag

+ Webhooks map[string]Path

+ func GenerateBaseSchema() *Schema

+ type SchemaInfo struct

+ Contact *Contact

+ Description string

+ License *License

+ Summary string

+ TermsOfService string

+ Title string

+ Version string

+ type SchemaObject struct

+ AllOf []*SchemaObject

+ Const interface{}

+ Default interface{}

+ Deprecated *bool

+ Description string

+ Discriminator *Discriminator

+ Enum []interface{}

+ Example *Example

+ Examples []Example

+ ExternalDocs *ExternalDocs

+ Format string

+ Items *SchemaObject

+ Maximum int

+ Minimum int

+ OneOf []*SchemaObject

+ Pattern string

+ Properties map[string]*SchemaObject

+ ReadOnly *bool

+ Ref string

+ Required []string

+ Title string

+ Type string

+ XAggregator []XModifier

+ XFilters []XModifier

+ XML *XML

+ type SecurityRequirement map[string][]string

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ Flows *OAuthFlows

+ In string

+ Name string

+ OpenIdConnectUrl string

+ Ref string

+ Scheme string

+ Type string

+ type Server struct

+ Description string

+ URL string

+ Variables map[string]OpenAPIServerVariable

+ type Tag struct

+ Description string

+ ExternalDocs *ExternalDocs

+ Name string

+ type XML struct

+ Attribute bool

+ Name string

+ Namespace string

+ Prefix string

+ Wrapped bool

+ type XModifier struct

+ In string

+ Modifier string

+ Summary string