Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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

openapiv3

package

Go to main page

Versions in this module

v0

v0.0.3

Oct 20, 2023

v0.0.2

Oct 20, 2023

v0.0.1

Oct 20, 2023

Changes in this version

+ const OpenAPIVersion

+ func Files(root *expr.RootExpr) ([]*codegen.File, error)

+ type CallbackRef struct

+ Ref string

+ Value map[string]*PathItem

+ func (r *CallbackRef) MarshalJSON() ([]byte, error)

+ func (r *CallbackRef) MarshalYAML() (interface{}, error)

+ func (r *CallbackRef) UnmarshalJSON(d []byte) error

+ func (r *CallbackRef) UnmarshalYAML(u func(interface{}) error) error

+ type Components struct

+ Callbacks map[string]*CallbackRef

+ Examples map[string]*ExampleRef

+ Extensions map[string]interface{}

+ Headers map[string]*HeaderRef

+ Links map[string]*LinkRef

+ Parameters map[string]*ParameterRef

+ RequestBodies map[string]*RequestBodyRef

+ Responses map[string]*ResponseRef

+ Schemas map[string]*openapi.Schema

+ SecuritySchemes map[string]*SecuritySchemeRef

+ type Contact struct

+ Email string

+ Extensions map[string]interface{}

+ Name string

+ URL string

+ type Encoding struct

+ AllowReserved bool

+ ContentType string

+ Explode *bool

+ Extensions map[string]interface{}

+ Headers map[string]*HeaderRef

+ Style string

+ type EndpointBodies struct

+ RequestBody *openapi.Schema

+ ResponseBodies map[int][]*openapi.Schema

+ type Example struct

+ Description string

+ Extensions map[string]interface{}

+ ExternalValue string

+ Summary string

+ Value interface{}

+ type ExampleRef struct

+ Ref string

+ Value *Example

+ func (r *ExampleRef) MarshalJSON() ([]byte, error)

+ func (r *ExampleRef) MarshalYAML() (interface{}, error)

+ func (r *ExampleRef) UnmarshalJSON(d []byte) error

+ func (r *ExampleRef) UnmarshalYAML(u func(interface{}) error) error

+ type Header struct

+ AllowEmptyValue bool

+ AllowReserved bool

+ Content map[string]*MediaType

+ Deprecated bool

+ Description string

+ Example interface{}

+ Examples map[string]*ExampleRef

+ Explode *bool

+ Extensions map[string]interface{}

+ Required bool

+ Schema *openapi.Schema

+ Style string

+ type HeaderRef struct

+ Ref string

+ Value *Header

+ func (r *HeaderRef) MarshalJSON() ([]byte, error)

+ func (r *HeaderRef) MarshalYAML() (interface{}, error)

+ func (r *HeaderRef) UnmarshalJSON(d []byte) error

+ func (r *HeaderRef) UnmarshalYAML(u func(interface{}) error) error

+ type Info struct

+ Contact *Contact

+ Description string

+ Extensions map[string]interface{}

+ License *License

+ TermsOfService string

+ Title string

+ Version string

+ func (i Info) MarshalJSON() ([]byte, error)

+ func (i Info) MarshalYAML() (interface{}, error)

+ type License struct

+ Extensions map[string]interface{}

+ Name string

+ URL string

+ type Link struct

+ Description string

+ Extensions map[string]interface{}

+ OperationID string

+ OperationRef string

+ Parameters map[string]interface{}

+ RequestBody interface{}

+ Server *Server

+ type LinkRef struct

+ Ref string

+ Value *Link

+ func (r *LinkRef) MarshalJSON() ([]byte, error)

+ func (r *LinkRef) MarshalYAML() (interface{}, error)

+ func (r *LinkRef) UnmarshalJSON(d []byte) error

+ func (r *LinkRef) UnmarshalYAML(u func(interface{}) error) error

+ type MediaType struct

+ Encoding map[string]*Encoding

+ Example interface{}

+ Examples map[string]*ExampleRef

+ Extensions map[string]interface{}

+ Schema *openapi.Schema

+ type OAuthFlow struct

+ AuthorizationURL string

+ Extensions map[string]interface{}

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Extensions map[string]interface{}

+ Implicit *OAuthFlow

+ Password *OAuthFlow

+ type OpenAPI struct

+ Components *Components

+ Extensions map[string]interface{}

+ ExternalDocs *openapi.ExternalDocs

+ Info *Info

+ OpenAPI string

+ Paths map[string]*PathItem

+ Security []map[string][]string

+ Servers []*Server

+ Tags []*openapi.Tag

+ func New(root *expr.RootExpr) *OpenAPI

+ type Operation struct

+ Callbacks map[string]*CallbackRef

+ Deprecated bool

+ Description string

+ Extensions map[string]interface{}

+ ExternalDocs *openapi.ExternalDocs

+ OperationID string

+ Parameters []*ParameterRef

+ RequestBody *RequestBodyRef

+ Responses map[string]*ResponseRef

+ Security []map[string][]string

+ Servers []*Server

+ Summary string

+ Tags []string

+ func (o Operation) MarshalJSON() ([]byte, error)

+ func (o Operation) MarshalYAML() (interface{}, error)

+ type Parameter struct

+ AllowEmptyValue bool

+ AllowReserved bool

+ Content map[string]*MediaType

+ Deprecated bool

+ Description string

+ Example interface{}

+ Examples map[string]*ExampleRef

+ Explode *bool

+ Extensions map[string]interface{}

+ In string

+ Name string

+ Required bool

+ Schema *openapi.Schema

+ Style string

+ func (p Parameter) MarshalJSON() ([]byte, error)

+ func (p Parameter) MarshalYAML() (interface{}, error)

+ type ParameterRef struct

+ Ref string

+ Value *Parameter

+ func (r *ParameterRef) MarshalJSON() ([]byte, error)

+ func (r *ParameterRef) MarshalYAML() (interface{}, error)

+ func (r *ParameterRef) UnmarshalJSON(d []byte) error

+ func (r *ParameterRef) UnmarshalYAML(u func(interface{}) error) error

+ type PathItem struct

+ Connect *Operation

+ Delete *Operation

+ Description string

+ Extensions map[string]interface{}

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []*ParameterRef

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Ref string

+ Servers []*Server

+ Summary string

+ Trace *Operation

+ func (p PathItem) MarshalJSON() ([]byte, error)

+ func (p PathItem) MarshalYAML() (interface{}, error)

+ type RequestBody struct

+ Content map[string]*MediaType

+ Description string

+ Extensions map[string]interface{}

+ Required bool

+ type RequestBodyRef struct

+ Ref string

+ Value *RequestBody

+ func (r *RequestBodyRef) MarshalJSON() ([]byte, error)

+ func (r *RequestBodyRef) MarshalYAML() (interface{}, error)

+ func (r *RequestBodyRef) UnmarshalJSON(d []byte) error

+ func (r *RequestBodyRef) UnmarshalYAML(u func(interface{}) error) error

+ type Response struct

+ Content map[string]*MediaType

+ Description *string

+ Extensions map[string]interface{}

+ Headers map[string]*HeaderRef

+ Links map[string]*LinkRef

+ func (r Response) MarshalJSON() ([]byte, error)

+ func (r Response) MarshalYAML() (interface{}, error)

+ type ResponseRef struct

+ Ref string

+ Value *Response

+ func (r *ResponseRef) MarshalJSON() ([]byte, error)

+ func (r *ResponseRef) MarshalYAML() (interface{}, error)

+ func (r *ResponseRef) UnmarshalJSON(d []byte) error

+ func (r *ResponseRef) UnmarshalYAML(u func(interface{}) error) error

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ Extensions map[string]interface{}

+ Flows *OAuthFlows

+ In string

+ Name string

+ Scheme string

+ Type string

+ func (s SecurityScheme) MarshalJSON() ([]byte, error)

+ func (s SecurityScheme) MarshalYAML() (interface{}, error)

+ type SecuritySchemeRef struct

+ Ref string

+ Value *SecurityScheme

+ func (r *SecuritySchemeRef) MarshalJSON() ([]byte, error)

+ func (r *SecuritySchemeRef) MarshalYAML() (interface{}, error)

+ func (r *SecuritySchemeRef) UnmarshalJSON(d []byte) error

+ func (r *SecuritySchemeRef) UnmarshalYAML(u func(interface{}) error) error

+ type Server struct

+ Description string

+ URL string

+ Variables map[string]*ServerVariable

+ type ServerVariable struct

+ Default interface{}

+ Description string

+ Enum []interface{}

Incompatible versions in this module

v2.2.5+incompatible

Nov 1, 2020

v2.2.4+incompatible

Sep 20, 2020

v2.2.3+incompatible

Aug 16, 2020

v2.2.2+incompatible

Aug 11, 2020

v2.2.1+incompatible

Aug 9, 2020

v2.2.0+incompatible

Jul 11, 2020

Other modules containing this package

github.com/mtal3t/goa/v3