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

options

package

Go to main page

Versions in this module

v1

v1.0.4

Apr 7, 2022

Changes in this version

+ type Header struct

+ Default string

+ Description string

+ Format string

+ Pattern string

+ Type string

+ func (*Header) Descriptor() ([]byte, []int)

+ func (*Header) ProtoMessage()

+ func (x *Header) GetDefault() string

+ func (x *Header) GetDescription() string

+ func (x *Header) GetFormat() string

+ func (x *Header) GetPattern() string

+ func (x *Header) GetType() string

+ func (x *Header) ProtoReflect() protoreflect.Message

+ func (x *Header) Reset()

+ func (x *Header) String() string

type JSONSchema

+ Enum []string

+ Example string

+ Format string

+ func (x *JSONSchema) GetEnum() []string

+ func (x *JSONSchema) GetExample() string

+ func (x *JSONSchema) GetFormat() string

type Response

+ Headers map[string]*Header

+ func (x *Response) GetHeaders() map[string]*Header

v1.0.3

Nov 2, 2020

v1.0.2

Nov 2, 2020

v1.0.1

Nov 2, 2020

Changes in this version

+ var E_Openapiv2Field = &file_gateway_protoc_gen_openapiv2_options_annotations_proto_extTypes[4]

+ var E_Openapiv2Operation = &file_gateway_protoc_gen_openapiv2_options_annotations_proto_extTypes[1]

+ var E_Openapiv2Schema = &file_gateway_protoc_gen_openapiv2_options_annotations_proto_extTypes[2]

+ var E_Openapiv2Swagger = &file_gateway_protoc_gen_openapiv2_options_annotations_proto_extTypes[0]

+ var E_Openapiv2Tag = &file_gateway_protoc_gen_openapiv2_options_annotations_proto_extTypes[3]

+ var File_gateway_protoc_gen_openapiv2_options_annotations_proto protoreflect.FileDescriptor

+ var File_gateway_protoc_gen_openapiv2_options_openapiv2_proto protoreflect.FileDescriptor

+ var JSONSchema_JSONSchemaSimpleTypes_name = map[int32]string

+ var JSONSchema_JSONSchemaSimpleTypes_value = map[string]int32

+ var Scheme_name = map[int32]string

+ var Scheme_value = map[string]int32

+ var SecurityScheme_Flow_name = map[int32]string

+ var SecurityScheme_Flow_value = map[string]int32

+ var SecurityScheme_In_name = map[int32]string

+ var SecurityScheme_In_value = map[string]int32

+ var SecurityScheme_Type_name = map[int32]string

+ var SecurityScheme_Type_value = map[string]int32

+ type Contact struct

+ Email string

+ Name string

+ Url string

+ func (*Contact) Descriptor() ([]byte, []int)

+ func (*Contact) ProtoMessage()

+ func (x *Contact) GetEmail() string

+ func (x *Contact) GetName() string

+ func (x *Contact) GetUrl() string

+ func (x *Contact) ProtoReflect() protoreflect.Message

+ func (x *Contact) Reset()

+ func (x *Contact) String() string

+ type ExternalDocumentation struct

+ Description string

+ Url string

+ func (*ExternalDocumentation) Descriptor() ([]byte, []int)

+ func (*ExternalDocumentation) ProtoMessage()

+ func (x *ExternalDocumentation) GetDescription() string

+ func (x *ExternalDocumentation) GetUrl() string

+ func (x *ExternalDocumentation) ProtoReflect() protoreflect.Message

+ func (x *ExternalDocumentation) Reset()

+ func (x *ExternalDocumentation) String() string

+ type Info struct

+ Contact *Contact

+ Description string

+ Extensions map[string]*_struct.Value

+ License *License

+ TermsOfService string

+ Title string

+ Version string

+ func (*Info) Descriptor() ([]byte, []int)

+ func (*Info) ProtoMessage()

+ func (x *Info) GetContact() *Contact

+ func (x *Info) GetDescription() string

+ func (x *Info) GetExtensions() map[string]*_struct.Value

+ func (x *Info) GetLicense() *License

+ func (x *Info) GetTermsOfService() string

+ func (x *Info) GetTitle() string

+ func (x *Info) GetVersion() string

+ func (x *Info) ProtoReflect() protoreflect.Message

+ func (x *Info) Reset()

+ func (x *Info) String() string

+ type JSONSchema struct

+ Array []string

+ Default string

+ Description string

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ MaxItems uint64

+ MaxLength uint64

+ MaxProperties uint64

+ Maximum float64

+ MinItems uint64

+ MinLength uint64

+ MinProperties uint64

+ Minimum float64

+ MultipleOf float64

+ Pattern string

+ ReadOnly bool

+ Ref string

+ Required []string

+ Title string

+ Type []JSONSchema_JSONSchemaSimpleTypes

+ UniqueItems bool

+ func (*JSONSchema) Descriptor() ([]byte, []int)

+ func (*JSONSchema) ProtoMessage()

+ func (x *JSONSchema) GetArray() []string

+ func (x *JSONSchema) GetDefault() string

+ func (x *JSONSchema) GetDescription() string

+ func (x *JSONSchema) GetExclusiveMaximum() bool

+ func (x *JSONSchema) GetExclusiveMinimum() bool

+ func (x *JSONSchema) GetMaxItems() uint64

+ func (x *JSONSchema) GetMaxLength() uint64

+ func (x *JSONSchema) GetMaxProperties() uint64

+ func (x *JSONSchema) GetMaximum() float64

+ func (x *JSONSchema) GetMinItems() uint64

+ func (x *JSONSchema) GetMinLength() uint64

+ func (x *JSONSchema) GetMinProperties() uint64

+ func (x *JSONSchema) GetMinimum() float64

+ func (x *JSONSchema) GetMultipleOf() float64

+ func (x *JSONSchema) GetPattern() string

+ func (x *JSONSchema) GetReadOnly() bool

+ func (x *JSONSchema) GetRef() string

+ func (x *JSONSchema) GetRequired() []string

+ func (x *JSONSchema) GetTitle() string

+ func (x *JSONSchema) GetType() []JSONSchema_JSONSchemaSimpleTypes

+ func (x *JSONSchema) GetUniqueItems() bool

+ func (x *JSONSchema) ProtoReflect() protoreflect.Message

+ func (x *JSONSchema) Reset()

+ func (x *JSONSchema) String() string

+ type JSONSchema_JSONSchemaSimpleTypes int32

+ const JSONSchema_ARRAY

+ const JSONSchema_BOOLEAN

+ const JSONSchema_INTEGER

+ const JSONSchema_NULL

+ const JSONSchema_NUMBER

+ const JSONSchema_OBJECT

+ const JSONSchema_STRING

+ const JSONSchema_UNKNOWN

+ func (JSONSchema_JSONSchemaSimpleTypes) Descriptor() protoreflect.EnumDescriptor

+ func (JSONSchema_JSONSchemaSimpleTypes) EnumDescriptor() ([]byte, []int)

+ func (JSONSchema_JSONSchemaSimpleTypes) Type() protoreflect.EnumType

+ func (x JSONSchema_JSONSchemaSimpleTypes) Enum() *JSONSchema_JSONSchemaSimpleTypes

+ func (x JSONSchema_JSONSchemaSimpleTypes) Number() protoreflect.EnumNumber

+ func (x JSONSchema_JSONSchemaSimpleTypes) String() string

+ type License struct

+ Name string

+ Url string

+ func (*License) Descriptor() ([]byte, []int)

+ func (*License) ProtoMessage()

+ func (x *License) GetName() string

+ func (x *License) GetUrl() string

+ func (x *License) ProtoReflect() protoreflect.Message

+ func (x *License) Reset()

+ func (x *License) String() string

+ type Operation struct

+ Consumes []string

+ Deprecated bool

+ Description string

+ Extensions map[string]*_struct.Value

+ ExternalDocs *ExternalDocumentation

+ OperationId string

+ Produces []string

+ Responses map[string]*Response

+ Schemes []Scheme

+ Security []*SecurityRequirement

+ Summary string

+ Tags []string

+ func (*Operation) Descriptor() ([]byte, []int)

+ func (*Operation) ProtoMessage()

+ func (x *Operation) GetConsumes() []string

+ func (x *Operation) GetDeprecated() bool

+ func (x *Operation) GetDescription() string

+ func (x *Operation) GetExtensions() map[string]*_struct.Value

+ func (x *Operation) GetExternalDocs() *ExternalDocumentation

+ func (x *Operation) GetOperationId() string

+ func (x *Operation) GetProduces() []string

+ func (x *Operation) GetResponses() map[string]*Response

+ func (x *Operation) GetSchemes() []Scheme

+ func (x *Operation) GetSecurity() []*SecurityRequirement

+ func (x *Operation) GetSummary() string

+ func (x *Operation) GetTags() []string

+ func (x *Operation) ProtoReflect() protoreflect.Message

+ func (x *Operation) Reset()

+ func (x *Operation) String() string

+ type Response struct

+ Description string

+ Examples map[string]string

+ Extensions map[string]*_struct.Value

+ Schema *Schema

+ func (*Response) Descriptor() ([]byte, []int)

+ func (*Response) ProtoMessage()

+ func (x *Response) GetDescription() string

+ func (x *Response) GetExamples() map[string]string

+ func (x *Response) GetExtensions() map[string]*_struct.Value

+ func (x *Response) GetSchema() *Schema

+ func (x *Response) ProtoReflect() protoreflect.Message

+ func (x *Response) Reset()

+ func (x *Response) String() string

+ type Schema struct

+ Discriminator string

+ Example string

+ ExternalDocs *ExternalDocumentation

+ JsonSchema *JSONSchema

+ ReadOnly bool

+ func (*Schema) Descriptor() ([]byte, []int)

+ func (*Schema) ProtoMessage()

+ func (x *Schema) GetDiscriminator() string

+ func (x *Schema) GetExample() string

+ func (x *Schema) GetExternalDocs() *ExternalDocumentation

+ func (x *Schema) GetJsonSchema() *JSONSchema

+ func (x *Schema) GetReadOnly() bool

+ func (x *Schema) ProtoReflect() protoreflect.Message

+ func (x *Schema) Reset()

+ func (x *Schema) String() string

+ type Scheme int32

+ const Scheme_HTTP

+ const Scheme_HTTPS

+ const Scheme_UNKNOWN

+ const Scheme_WS

+ const Scheme_WSS

+ func (Scheme) Descriptor() protoreflect.EnumDescriptor

+ func (Scheme) EnumDescriptor() ([]byte, []int)

+ func (Scheme) Type() protoreflect.EnumType

+ func (x Scheme) Enum() *Scheme

+ func (x Scheme) Number() protoreflect.EnumNumber

+ func (x Scheme) String() string

+ type Scopes struct

+ Scope map[string]string

+ func (*Scopes) Descriptor() ([]byte, []int)

+ func (*Scopes) ProtoMessage()

+ func (x *Scopes) GetScope() map[string]string

+ func (x *Scopes) ProtoReflect() protoreflect.Message

+ func (x *Scopes) Reset()

+ func (x *Scopes) String() string

+ type SecurityDefinitions struct

+ Security map[string]*SecurityScheme

+ func (*SecurityDefinitions) Descriptor() ([]byte, []int)

+ func (*SecurityDefinitions) ProtoMessage()

+ func (x *SecurityDefinitions) GetSecurity() map[string]*SecurityScheme

+ func (x *SecurityDefinitions) ProtoReflect() protoreflect.Message

+ func (x *SecurityDefinitions) Reset()

+ func (x *SecurityDefinitions) String() string

+ type SecurityRequirement struct

+ SecurityRequirement map[string]*SecurityRequirement_SecurityRequirementValue

+ func (*SecurityRequirement) Descriptor() ([]byte, []int)

+ func (*SecurityRequirement) ProtoMessage()

+ func (x *SecurityRequirement) GetSecurityRequirement() map[string]*SecurityRequirement_SecurityRequirementValue

+ func (x *SecurityRequirement) ProtoReflect() protoreflect.Message

+ func (x *SecurityRequirement) Reset()

+ func (x *SecurityRequirement) String() string

+ type SecurityRequirement_SecurityRequirementValue struct

+ Scope []string

+ func (*SecurityRequirement_SecurityRequirementValue) Descriptor() ([]byte, []int)

+ func (*SecurityRequirement_SecurityRequirementValue) ProtoMessage()

+ func (x *SecurityRequirement_SecurityRequirementValue) GetScope() []string

+ func (x *SecurityRequirement_SecurityRequirementValue) ProtoReflect() protoreflect.Message

+ func (x *SecurityRequirement_SecurityRequirementValue) Reset()

+ func (x *SecurityRequirement_SecurityRequirementValue) String() string

+ type SecurityScheme struct

+ AuthorizationUrl string

+ Description string

+ Extensions map[string]*_struct.Value

+ Flow SecurityScheme_Flow

+ In SecurityScheme_In

+ Name string

+ Scopes *Scopes

+ TokenUrl string

+ Type SecurityScheme_Type

+ func (*SecurityScheme) Descriptor() ([]byte, []int)

+ func (*SecurityScheme) ProtoMessage()

+ func (x *SecurityScheme) GetAuthorizationUrl() string

+ func (x *SecurityScheme) GetDescription() string

+ func (x *SecurityScheme) GetExtensions() map[string]*_struct.Value

+ func (x *SecurityScheme) GetFlow() SecurityScheme_Flow

+ func (x *SecurityScheme) GetIn() SecurityScheme_In

+ func (x *SecurityScheme) GetName() string

+ func (x *SecurityScheme) GetScopes() *Scopes

+ func (x *SecurityScheme) GetTokenUrl() string

+ func (x *SecurityScheme) GetType() SecurityScheme_Type

+ func (x *SecurityScheme) ProtoReflect() protoreflect.Message

+ func (x *SecurityScheme) Reset()

+ func (x *SecurityScheme) String() string

+ type SecurityScheme_Flow int32

+ const SecurityScheme_FLOW_ACCESS_CODE

+ const SecurityScheme_FLOW_APPLICATION

+ const SecurityScheme_FLOW_IMPLICIT

+ const SecurityScheme_FLOW_INVALID

+ const SecurityScheme_FLOW_PASSWORD

+ func (SecurityScheme_Flow) Descriptor() protoreflect.EnumDescriptor

+ func (SecurityScheme_Flow) EnumDescriptor() ([]byte, []int)

+ func (SecurityScheme_Flow) Type() protoreflect.EnumType

+ func (x SecurityScheme_Flow) Enum() *SecurityScheme_Flow

+ func (x SecurityScheme_Flow) Number() protoreflect.EnumNumber

+ func (x SecurityScheme_Flow) String() string

+ type SecurityScheme_In int32

+ const SecurityScheme_IN_HEADER

+ const SecurityScheme_IN_INVALID

+ const SecurityScheme_IN_QUERY

+ func (SecurityScheme_In) Descriptor() protoreflect.EnumDescriptor

+ func (SecurityScheme_In) EnumDescriptor() ([]byte, []int)

+ func (SecurityScheme_In) Type() protoreflect.EnumType

+ func (x SecurityScheme_In) Enum() *SecurityScheme_In

+ func (x SecurityScheme_In) Number() protoreflect.EnumNumber

+ func (x SecurityScheme_In) String() string

+ type SecurityScheme_Type int32

+ const SecurityScheme_TYPE_API_KEY

+ const SecurityScheme_TYPE_BASIC

+ const SecurityScheme_TYPE_INVALID

+ const SecurityScheme_TYPE_OAUTH2

+ func (SecurityScheme_Type) Descriptor() protoreflect.EnumDescriptor

+ func (SecurityScheme_Type) EnumDescriptor() ([]byte, []int)

+ func (SecurityScheme_Type) Type() protoreflect.EnumType

+ func (x SecurityScheme_Type) Enum() *SecurityScheme_Type

+ func (x SecurityScheme_Type) Number() protoreflect.EnumNumber

+ func (x SecurityScheme_Type) String() string

+ type Swagger struct

+ BasePath string

+ Consumes []string

+ Extensions map[string]*_struct.Value

+ ExternalDocs *ExternalDocumentation

+ Host string

+ Info *Info

+ Produces []string

+ Responses map[string]*Response

+ Schemes []Scheme

+ Security []*SecurityRequirement

+ SecurityDefinitions *SecurityDefinitions

+ Swagger string

+ func (*Swagger) Descriptor() ([]byte, []int)

+ func (*Swagger) ProtoMessage()

+ func (x *Swagger) GetBasePath() string

+ func (x *Swagger) GetConsumes() []string

+ func (x *Swagger) GetExtensions() map[string]*_struct.Value

+ func (x *Swagger) GetExternalDocs() *ExternalDocumentation

+ func (x *Swagger) GetHost() string

+ func (x *Swagger) GetInfo() *Info

+ func (x *Swagger) GetProduces() []string

+ func (x *Swagger) GetResponses() map[string]*Response

+ func (x *Swagger) GetSchemes() []Scheme

+ func (x *Swagger) GetSecurity() []*SecurityRequirement

+ func (x *Swagger) GetSecurityDefinitions() *SecurityDefinitions

+ func (x *Swagger) GetSwagger() string

+ func (x *Swagger) ProtoReflect() protoreflect.Message

+ func (x *Swagger) Reset()

+ func (x *Swagger) String() string

+ type Tag struct

+ Description string

+ ExternalDocs *ExternalDocumentation

+ func (*Tag) Descriptor() ([]byte, []int)

+ func (*Tag) ProtoMessage()

+ func (x *Tag) GetDescription() string

+ func (x *Tag) GetExternalDocs() *ExternalDocumentation

+ func (x *Tag) ProtoReflect() protoreflect.Message

+ func (x *Tag) Reset()

+ func (x *Tag) String() string