Documentation ¶
Index ¶
- Variables
- type Contact
- func (*Contact) Descriptor() ([]byte, []int)
- func (m *Contact) GetEmail() string
- func (m *Contact) GetName() string
- func (m *Contact) GetUrl() string
- func (*Contact) ProtoMessage()
- func (m *Contact) Reset()
- func (m *Contact) String() string
- func (m *Contact) XXX_DiscardUnknown()
- func (m *Contact) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Contact) XXX_Merge(src proto.Message)
- func (m *Contact) XXX_Size() int
- func (m *Contact) XXX_Unmarshal(b []byte) error
- type ExternalDocumentation
- func (*ExternalDocumentation) Descriptor() ([]byte, []int)
- func (m *ExternalDocumentation) GetDescription() string
- func (m *ExternalDocumentation) GetUrl() string
- func (*ExternalDocumentation) ProtoMessage()
- func (m *ExternalDocumentation) Reset()
- func (m *ExternalDocumentation) String() string
- func (m *ExternalDocumentation) XXX_DiscardUnknown()
- func (m *ExternalDocumentation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *ExternalDocumentation) XXX_Merge(src proto.Message)
- func (m *ExternalDocumentation) XXX_Size() int
- func (m *ExternalDocumentation) XXX_Unmarshal(b []byte) error
- type Info
- func (*Info) Descriptor() ([]byte, []int)
- func (m *Info) GetContact() *Contact
- func (m *Info) GetDescription() string
- func (m *Info) GetTermsOfService() string
- func (m *Info) GetTitle() string
- func (m *Info) GetVersion() string
- func (*Info) ProtoMessage()
- func (m *Info) Reset()
- func (m *Info) String() string
- func (m *Info) XXX_DiscardUnknown()
- func (m *Info) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Info) XXX_Merge(src proto.Message)
- func (m *Info) XXX_Size() int
- func (m *Info) XXX_Unmarshal(b []byte) error
- type JSONSchema
- func (*JSONSchema) Descriptor() ([]byte, []int)
- func (m *JSONSchema) GetArray() []string
- func (m *JSONSchema) GetDefault() string
- func (m *JSONSchema) GetDescription() string
- func (m *JSONSchema) GetExclusiveMaximum() bool
- func (m *JSONSchema) GetExclusiveMinimum() bool
- func (m *JSONSchema) GetMaxItems() uint64
- func (m *JSONSchema) GetMaxLength() uint64
- func (m *JSONSchema) GetMaxProperties() uint64
- func (m *JSONSchema) GetMaximum() float64
- func (m *JSONSchema) GetMinItems() uint64
- func (m *JSONSchema) GetMinLength() uint64
- func (m *JSONSchema) GetMinProperties() uint64
- func (m *JSONSchema) GetMinimum() float64
- func (m *JSONSchema) GetMultipleOf() float64
- func (m *JSONSchema) GetPattern() string
- func (m *JSONSchema) GetRef() string
- func (m *JSONSchema) GetRequired() []string
- func (m *JSONSchema) GetTitle() string
- func (m *JSONSchema) GetType() []JSONSchema_JSONSchemaSimpleTypes
- func (m *JSONSchema) GetUniqueItems() bool
- func (*JSONSchema) ProtoMessage()
- func (m *JSONSchema) Reset()
- func (m *JSONSchema) String() string
- func (m *JSONSchema) XXX_DiscardUnknown()
- func (m *JSONSchema) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *JSONSchema) XXX_Merge(src proto.Message)
- func (m *JSONSchema) XXX_Size() int
- func (m *JSONSchema) XXX_Unmarshal(b []byte) error
- type JSONSchema_JSONSchemaSimpleTypes
- type Operation
- func (*Operation) Descriptor() ([]byte, []int)
- func (m *Operation) GetConsumes() []string
- func (m *Operation) GetDeprecated() bool
- func (m *Operation) GetDescription() string
- func (m *Operation) GetExternalDocs() *ExternalDocumentation
- func (m *Operation) GetOperationId() string
- func (m *Operation) GetProduces() []string
- func (m *Operation) GetResponses() map[string]*Response
- func (m *Operation) GetSchemes() []string
- func (m *Operation) GetSecurity() []*SecurityRequirement
- func (m *Operation) GetSummary() string
- func (m *Operation) GetTags() []string
- func (*Operation) ProtoMessage()
- func (m *Operation) Reset()
- func (m *Operation) String() string
- func (m *Operation) XXX_DiscardUnknown()
- func (m *Operation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Operation) XXX_Merge(src proto.Message)
- func (m *Operation) XXX_Size() int
- func (m *Operation) XXX_Unmarshal(b []byte) error
- type Response
- func (*Response) Descriptor() ([]byte, []int)
- func (m *Response) GetDescription() string
- func (m *Response) GetSchema() *Schema
- func (*Response) ProtoMessage()
- func (m *Response) Reset()
- func (m *Response) String() string
- func (m *Response) XXX_DiscardUnknown()
- func (m *Response) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Response) XXX_Merge(src proto.Message)
- func (m *Response) XXX_Size() int
- func (m *Response) XXX_Unmarshal(b []byte) error
- type Schema
- func (*Schema) Descriptor() ([]byte, []int)
- func (m *Schema) GetDiscriminator() string
- func (m *Schema) GetExample() *any.Any
- func (m *Schema) GetExternalDocs() *ExternalDocumentation
- func (m *Schema) GetJsonSchema() *JSONSchema
- func (m *Schema) GetReadOnly() bool
- func (*Schema) ProtoMessage()
- func (m *Schema) Reset()
- func (m *Schema) String() string
- func (m *Schema) XXX_DiscardUnknown()
- func (m *Schema) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Schema) XXX_Merge(src proto.Message)
- func (m *Schema) XXX_Size() int
- func (m *Schema) XXX_Unmarshal(b []byte) error
- type Scopes
- func (*Scopes) Descriptor() ([]byte, []int)
- func (m *Scopes) GetScope() map[string]string
- func (*Scopes) ProtoMessage()
- func (m *Scopes) Reset()
- func (m *Scopes) String() string
- func (m *Scopes) XXX_DiscardUnknown()
- func (m *Scopes) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Scopes) XXX_Merge(src proto.Message)
- func (m *Scopes) XXX_Size() int
- func (m *Scopes) XXX_Unmarshal(b []byte) error
- type SecurityDefinitions
- func (*SecurityDefinitions) Descriptor() ([]byte, []int)
- func (m *SecurityDefinitions) GetSecurity() map[string]*SecurityScheme
- func (*SecurityDefinitions) ProtoMessage()
- func (m *SecurityDefinitions) Reset()
- func (m *SecurityDefinitions) String() string
- func (m *SecurityDefinitions) XXX_DiscardUnknown()
- func (m *SecurityDefinitions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *SecurityDefinitions) XXX_Merge(src proto.Message)
- func (m *SecurityDefinitions) XXX_Size() int
- func (m *SecurityDefinitions) XXX_Unmarshal(b []byte) error
- type SecurityRequirement
- func (*SecurityRequirement) Descriptor() ([]byte, []int)
- func (m *SecurityRequirement) GetSecurityRequirement() map[string]*SecurityRequirement_SecurityRequirementValue
- func (*SecurityRequirement) ProtoMessage()
- func (m *SecurityRequirement) Reset()
- func (m *SecurityRequirement) String() string
- func (m *SecurityRequirement) XXX_DiscardUnknown()
- func (m *SecurityRequirement) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *SecurityRequirement) XXX_Merge(src proto.Message)
- func (m *SecurityRequirement) XXX_Size() int
- func (m *SecurityRequirement) XXX_Unmarshal(b []byte) error
- type SecurityRequirement_SecurityRequirementValue
- func (*SecurityRequirement_SecurityRequirementValue) Descriptor() ([]byte, []int)
- func (m *SecurityRequirement_SecurityRequirementValue) GetScope() []string
- func (*SecurityRequirement_SecurityRequirementValue) ProtoMessage()
- func (m *SecurityRequirement_SecurityRequirementValue) Reset()
- func (m *SecurityRequirement_SecurityRequirementValue) String() string
- func (m *SecurityRequirement_SecurityRequirementValue) XXX_DiscardUnknown()
- func (m *SecurityRequirement_SecurityRequirementValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *SecurityRequirement_SecurityRequirementValue) XXX_Merge(src proto.Message)
- func (m *SecurityRequirement_SecurityRequirementValue) XXX_Size() int
- func (m *SecurityRequirement_SecurityRequirementValue) XXX_Unmarshal(b []byte) error
- type SecurityScheme
- func (*SecurityScheme) Descriptor() ([]byte, []int)
- func (m *SecurityScheme) GetAuthorizationUrl() string
- func (m *SecurityScheme) GetDescription() string
- func (m *SecurityScheme) GetFlow() SecurityScheme_Flow
- func (m *SecurityScheme) GetIn() SecurityScheme_In
- func (m *SecurityScheme) GetName() string
- func (m *SecurityScheme) GetScopes() *Scopes
- func (m *SecurityScheme) GetTokenUrl() string
- func (m *SecurityScheme) GetType() SecurityScheme_Type
- func (*SecurityScheme) ProtoMessage()
- func (m *SecurityScheme) Reset()
- func (m *SecurityScheme) String() string
- func (m *SecurityScheme) XXX_DiscardUnknown()
- func (m *SecurityScheme) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *SecurityScheme) XXX_Merge(src proto.Message)
- func (m *SecurityScheme) XXX_Size() int
- func (m *SecurityScheme) XXX_Unmarshal(b []byte) error
- type SecurityScheme_Flow
- type SecurityScheme_In
- type SecurityScheme_Type
- type Swagger
- func (*Swagger) Descriptor() ([]byte, []int)
- func (m *Swagger) GetBasePath() string
- func (m *Swagger) GetConsumes() []string
- func (m *Swagger) GetExternalDocs() *ExternalDocumentation
- func (m *Swagger) GetHost() string
- func (m *Swagger) GetInfo() *Info
- func (m *Swagger) GetProduces() []string
- func (m *Swagger) GetResponses() map[string]*Response
- func (m *Swagger) GetSchemes() []Swagger_SwaggerScheme
- func (m *Swagger) GetSecurity() []*SecurityRequirement
- func (m *Swagger) GetSecurityDefinitions() *SecurityDefinitions
- func (m *Swagger) GetSwagger() string
- func (*Swagger) ProtoMessage()
- func (m *Swagger) Reset()
- func (m *Swagger) String() string
- func (m *Swagger) XXX_DiscardUnknown()
- func (m *Swagger) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Swagger) XXX_Merge(src proto.Message)
- func (m *Swagger) XXX_Size() int
- func (m *Swagger) XXX_Unmarshal(b []byte) error
- type Swagger_SwaggerScheme
- type Tag
- func (*Tag) Descriptor() ([]byte, []int)
- func (m *Tag) GetDescription() string
- func (m *Tag) GetExternalDocs() *ExternalDocumentation
- func (*Tag) ProtoMessage()
- func (m *Tag) Reset()
- func (m *Tag) String() string
- func (m *Tag) XXX_DiscardUnknown()
- func (m *Tag) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Tag) XXX_Merge(src proto.Message)
- func (m *Tag) XXX_Size() int
- func (m *Tag) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
var E_Openapiv2Field = &proto.ExtensionDesc{ ExtendedType: (*descriptor.FieldOptions)(nil), ExtensionType: (*JSONSchema)(nil), Field: 1042, Name: "grpc.gateway.protoc_gen_swagger.options.openapiv2_field", Tag: "bytes,1042,opt,name=openapiv2_field,json=openapiv2Field", Filename: "protoc-gen-swagger/options/annotations.proto", }
var E_Openapiv2Operation = &proto.ExtensionDesc{ ExtendedType: (*descriptor.MethodOptions)(nil), ExtensionType: (*Operation)(nil), Field: 1042, Name: "grpc.gateway.protoc_gen_swagger.options.openapiv2_operation", Tag: "bytes,1042,opt,name=openapiv2_operation,json=openapiv2Operation", Filename: "protoc-gen-swagger/options/annotations.proto", }
var E_Openapiv2Schema = &proto.ExtensionDesc{ ExtendedType: (*descriptor.MessageOptions)(nil), ExtensionType: (*Schema)(nil), Field: 1042, Name: "grpc.gateway.protoc_gen_swagger.options.openapiv2_schema", Tag: "bytes,1042,opt,name=openapiv2_schema,json=openapiv2Schema", Filename: "protoc-gen-swagger/options/annotations.proto", }
var E_Openapiv2Swagger = &proto.ExtensionDesc{ ExtendedType: (*descriptor.FileOptions)(nil), ExtensionType: (*Swagger)(nil), Field: 1042, Name: "grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger", Tag: "bytes,1042,opt,name=openapiv2_swagger,json=openapiv2Swagger", Filename: "protoc-gen-swagger/options/annotations.proto", }
var E_Openapiv2Tag = &proto.ExtensionDesc{ ExtendedType: (*descriptor.ServiceOptions)(nil), ExtensionType: (*Tag)(nil), Field: 1042, Name: "grpc.gateway.protoc_gen_swagger.options.openapiv2_tag", Tag: "bytes,1042,opt,name=openapiv2_tag,json=openapiv2Tag", Filename: "protoc-gen-swagger/options/annotations.proto", }
var JSONSchema_JSONSchemaSimpleTypes_name = map[int32]string{
0: "UNKNOWN",
1: "ARRAY",
2: "BOOLEAN",
3: "INTEGER",
4: "NULL",
5: "NUMBER",
6: "OBJECT",
7: "STRING",
}
var JSONSchema_JSONSchemaSimpleTypes_value = map[string]int32{
"UNKNOWN": 0,
"ARRAY": 1,
"BOOLEAN": 2,
"INTEGER": 3,
"NULL": 4,
"NUMBER": 5,
"OBJECT": 6,
"STRING": 7,
}
var SecurityScheme_Flow_name = map[int32]string{
0: "FLOW_INVALID",
1: "FLOW_IMPLICIT",
2: "FLOW_PASSWORD",
3: "FLOW_APPLICATION",
4: "FLOW_ACCESS_CODE",
}
var SecurityScheme_Flow_value = map[string]int32{
"FLOW_INVALID": 0,
"FLOW_IMPLICIT": 1,
"FLOW_PASSWORD": 2,
"FLOW_APPLICATION": 3,
"FLOW_ACCESS_CODE": 4,
}
var SecurityScheme_In_name = map[int32]string{
0: "IN_INVALID",
1: "IN_QUERY",
2: "IN_HEADER",
}
var SecurityScheme_In_value = map[string]int32{
"IN_INVALID": 0,
"IN_QUERY": 1,
"IN_HEADER": 2,
}
var SecurityScheme_Type_name = map[int32]string{
0: "TYPE_INVALID",
1: "TYPE_BASIC",
2: "TYPE_API_KEY",
3: "TYPE_OAUTH2",
}
var SecurityScheme_Type_value = map[string]int32{
"TYPE_INVALID": 0,
"TYPE_BASIC": 1,
"TYPE_API_KEY": 2,
"TYPE_OAUTH2": 3,
}
var Swagger_SwaggerScheme_name = map[int32]string{
0: "UNKNOWN",
1: "HTTP",
2: "HTTPS",
3: "WS",
4: "WSS",
}
var Swagger_SwaggerScheme_value = map[string]int32{
"UNKNOWN": 0,
"HTTP": 1,
"HTTPS": 2,
"WS": 3,
"WSS": 4,
}
Functions ¶
This section is empty.
Types ¶
type Contact ¶
type Contact struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"` Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`Contact` is a representation of OpenAPI v2 specification's Contact object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#contactObject
TODO(ivucica): document fields
func (*Contact) Descriptor ¶
func (*Contact) ProtoMessage ¶
func (*Contact) ProtoMessage()
func (*Contact) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *Contact) XXX_DiscardUnknown()
func (*Contact) XXX_Marshal ¶ added in v1.4.0
func (*Contact) XXX_Unmarshal ¶ added in v1.4.0
type ExternalDocumentation ¶
type ExternalDocumentation struct { Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`ExternalDocumentation` is a representation of OpenAPI v2 specification's ExternalDocumentation object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject
TODO(ivucica): document fields
func (*ExternalDocumentation) Descriptor ¶
func (*ExternalDocumentation) Descriptor() ([]byte, []int)
func (*ExternalDocumentation) GetDescription ¶
func (m *ExternalDocumentation) GetDescription() string
func (*ExternalDocumentation) GetUrl ¶
func (m *ExternalDocumentation) GetUrl() string
func (*ExternalDocumentation) ProtoMessage ¶
func (*ExternalDocumentation) ProtoMessage()
func (*ExternalDocumentation) Reset ¶
func (m *ExternalDocumentation) Reset()
func (*ExternalDocumentation) String ¶
func (m *ExternalDocumentation) String() string
func (*ExternalDocumentation) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *ExternalDocumentation) XXX_DiscardUnknown()
func (*ExternalDocumentation) XXX_Marshal ¶ added in v1.4.0
func (m *ExternalDocumentation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ExternalDocumentation) XXX_Merge ¶ added in v1.4.0
func (dst *ExternalDocumentation) XXX_Merge(src proto.Message)
func (*ExternalDocumentation) XXX_Size ¶ added in v1.4.0
func (m *ExternalDocumentation) XXX_Size() int
func (*ExternalDocumentation) XXX_Unmarshal ¶ added in v1.4.0
func (m *ExternalDocumentation) XXX_Unmarshal(b []byte) error
type Info ¶
type Info struct { Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` TermsOfService string `protobuf:"bytes,3,opt,name=terms_of_service,json=termsOfService,proto3" json:"terms_of_service,omitempty"` Contact *Contact `protobuf:"bytes,4,opt,name=contact,proto3" json:"contact,omitempty"` Version string `protobuf:"bytes,6,opt,name=version,proto3" json:"version,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`Info` is a representation of OpenAPI v2 specification's Info object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#infoObject
TODO(ivucica): document fields
func (*Info) Descriptor ¶
func (*Info) GetContact ¶
func (*Info) GetDescription ¶
func (*Info) GetTermsOfService ¶
func (*Info) GetVersion ¶
func (*Info) ProtoMessage ¶
func (*Info) ProtoMessage()
func (*Info) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *Info) XXX_DiscardUnknown()
func (*Info) XXX_Marshal ¶ added in v1.4.0
func (*Info) XXX_Unmarshal ¶ added in v1.4.0
type JSONSchema ¶
type JSONSchema struct { // Ref is used to define an external reference to include in the message. // This could be a fully qualified proto message reference, and that type must be imported // into the protofile. If no message is identified, the Ref will be used verbatim in // the output. // For example: // `ref: ".google.protobuf.Timestamp"`. Ref string `protobuf:"bytes,3,opt,name=ref,proto3" json:"ref,omitempty"` Title string `protobuf:"bytes,5,opt,name=title,proto3" json:"title,omitempty"` Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"` Default string `protobuf:"bytes,7,opt,name=default,proto3" json:"default,omitempty"` MultipleOf float64 `protobuf:"fixed64,10,opt,name=multiple_of,json=multipleOf,proto3" json:"multiple_of,omitempty"` Maximum float64 `protobuf:"fixed64,11,opt,name=maximum,proto3" json:"maximum,omitempty"` ExclusiveMaximum bool `protobuf:"varint,12,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3" json:"exclusive_maximum,omitempty"` Minimum float64 `protobuf:"fixed64,13,opt,name=minimum,proto3" json:"minimum,omitempty"` ExclusiveMinimum bool `protobuf:"varint,14,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3" json:"exclusive_minimum,omitempty"` MaxLength uint64 `protobuf:"varint,15,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"` MinLength uint64 `protobuf:"varint,16,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"` Pattern string `protobuf:"bytes,17,opt,name=pattern,proto3" json:"pattern,omitempty"` MaxItems uint64 `protobuf:"varint,20,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"` MinItems uint64 `protobuf:"varint,21,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"` UniqueItems bool `protobuf:"varint,22,opt,name=unique_items,json=uniqueItems,proto3" json:"unique_items,omitempty"` MaxProperties uint64 `protobuf:"varint,24,opt,name=max_properties,json=maxProperties,proto3" json:"max_properties,omitempty"` MinProperties uint64 `protobuf:"varint,25,opt,name=min_properties,json=minProperties,proto3" json:"min_properties,omitempty"` Required []string `protobuf:"bytes,26,rep,name=required,proto3" json:"required,omitempty"` // Items in 'array' must be unique. Array []string `protobuf:"bytes,34,rep,name=array,proto3" json:"array,omitempty"` Type []JSONSchema_JSONSchemaSimpleTypes `` /* 148-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`JSONSchema` represents properties from JSON Schema taken, and as used, in the OpenAPI v2 spec.
This includes changes made by OpenAPI v2.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
See also: https://cswr.github.io/JsonSchema/spec/basic_types/, https://github.com/json-schema-org/json-schema-spec/blob/master/schema.json
TODO(ivucica): document fields
func (*JSONSchema) Descriptor ¶
func (*JSONSchema) Descriptor() ([]byte, []int)
func (*JSONSchema) GetArray ¶
func (m *JSONSchema) GetArray() []string
func (*JSONSchema) GetDefault ¶
func (m *JSONSchema) GetDefault() string
func (*JSONSchema) GetDescription ¶
func (m *JSONSchema) GetDescription() string
func (*JSONSchema) GetExclusiveMaximum ¶
func (m *JSONSchema) GetExclusiveMaximum() bool
func (*JSONSchema) GetExclusiveMinimum ¶
func (m *JSONSchema) GetExclusiveMinimum() bool
func (*JSONSchema) GetMaxItems ¶
func (m *JSONSchema) GetMaxItems() uint64
func (*JSONSchema) GetMaxLength ¶
func (m *JSONSchema) GetMaxLength() uint64
func (*JSONSchema) GetMaxProperties ¶
func (m *JSONSchema) GetMaxProperties() uint64
func (*JSONSchema) GetMaximum ¶
func (m *JSONSchema) GetMaximum() float64
func (*JSONSchema) GetMinItems ¶
func (m *JSONSchema) GetMinItems() uint64
func (*JSONSchema) GetMinLength ¶
func (m *JSONSchema) GetMinLength() uint64
func (*JSONSchema) GetMinProperties ¶
func (m *JSONSchema) GetMinProperties() uint64
func (*JSONSchema) GetMinimum ¶
func (m *JSONSchema) GetMinimum() float64
func (*JSONSchema) GetMultipleOf ¶
func (m *JSONSchema) GetMultipleOf() float64
func (*JSONSchema) GetPattern ¶
func (m *JSONSchema) GetPattern() string
func (*JSONSchema) GetRef ¶ added in v1.5.0
func (m *JSONSchema) GetRef() string
func (*JSONSchema) GetRequired ¶
func (m *JSONSchema) GetRequired() []string
func (*JSONSchema) GetTitle ¶
func (m *JSONSchema) GetTitle() string
func (*JSONSchema) GetType ¶
func (m *JSONSchema) GetType() []JSONSchema_JSONSchemaSimpleTypes
func (*JSONSchema) GetUniqueItems ¶
func (m *JSONSchema) GetUniqueItems() bool
func (*JSONSchema) ProtoMessage ¶
func (*JSONSchema) ProtoMessage()
func (*JSONSchema) Reset ¶
func (m *JSONSchema) Reset()
func (*JSONSchema) String ¶
func (m *JSONSchema) String() string
func (*JSONSchema) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *JSONSchema) XXX_DiscardUnknown()
func (*JSONSchema) XXX_Marshal ¶ added in v1.4.0
func (m *JSONSchema) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*JSONSchema) XXX_Merge ¶ added in v1.4.0
func (dst *JSONSchema) XXX_Merge(src proto.Message)
func (*JSONSchema) XXX_Size ¶ added in v1.4.0
func (m *JSONSchema) XXX_Size() int
func (*JSONSchema) XXX_Unmarshal ¶ added in v1.4.0
func (m *JSONSchema) XXX_Unmarshal(b []byte) error
type JSONSchema_JSONSchemaSimpleTypes ¶
type JSONSchema_JSONSchemaSimpleTypes int32
const ( JSONSchema_UNKNOWN JSONSchema_JSONSchemaSimpleTypes = 0 JSONSchema_ARRAY JSONSchema_JSONSchemaSimpleTypes = 1 JSONSchema_BOOLEAN JSONSchema_JSONSchemaSimpleTypes = 2 JSONSchema_INTEGER JSONSchema_JSONSchemaSimpleTypes = 3 JSONSchema_NULL JSONSchema_JSONSchemaSimpleTypes = 4 JSONSchema_NUMBER JSONSchema_JSONSchemaSimpleTypes = 5 JSONSchema_OBJECT JSONSchema_JSONSchemaSimpleTypes = 6 JSONSchema_STRING JSONSchema_JSONSchemaSimpleTypes = 7 )
func (JSONSchema_JSONSchemaSimpleTypes) EnumDescriptor ¶
func (JSONSchema_JSONSchemaSimpleTypes) EnumDescriptor() ([]byte, []int)
func (JSONSchema_JSONSchemaSimpleTypes) String ¶
func (x JSONSchema_JSONSchemaSimpleTypes) String() string
type Operation ¶
type Operation struct { Tags []string `protobuf:"bytes,1,rep,name=tags,proto3" json:"tags,omitempty"` Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"` Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` ExternalDocs *ExternalDocumentation `protobuf:"bytes,4,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"` OperationId string `protobuf:"bytes,5,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"` Consumes []string `protobuf:"bytes,6,rep,name=consumes,proto3" json:"consumes,omitempty"` Produces []string `protobuf:"bytes,7,rep,name=produces,proto3" json:"produces,omitempty"` Responses map[string]*Response `` /* 159-byte string literal not displayed */ Schemes []string `protobuf:"bytes,10,rep,name=schemes,proto3" json:"schemes,omitempty"` Deprecated bool `protobuf:"varint,11,opt,name=deprecated,proto3" json:"deprecated,omitempty"` Security []*SecurityRequirement `protobuf:"bytes,12,rep,name=security,proto3" json:"security,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`Operation` is a representation of OpenAPI v2 specification's Operation object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#operationObject
TODO(ivucica): document fields
func (*Operation) Descriptor ¶
func (*Operation) GetConsumes ¶
func (*Operation) GetDeprecated ¶
func (*Operation) GetDescription ¶
func (*Operation) GetExternalDocs ¶
func (m *Operation) GetExternalDocs() *ExternalDocumentation
func (*Operation) GetOperationId ¶
func (*Operation) GetProduces ¶
func (*Operation) GetResponses ¶ added in v1.5.0
func (*Operation) GetSchemes ¶
func (*Operation) GetSecurity ¶ added in v1.4.0
func (m *Operation) GetSecurity() []*SecurityRequirement
func (*Operation) GetSummary ¶
func (*Operation) ProtoMessage ¶
func (*Operation) ProtoMessage()
func (*Operation) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *Operation) XXX_DiscardUnknown()
func (*Operation) XXX_Marshal ¶ added in v1.4.0
func (*Operation) XXX_Unmarshal ¶ added in v1.4.0
type Response ¶ added in v1.5.0
type Response struct { // `Description` is a short description of the response. // GFM syntax can be used for rich text representation. Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` // `Schema` optionally defines the structure of the response. // If `Schema` is not provided, it means there is no content to the response. Schema *Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`Response` is a representation of OpenAPI v2 specification's Response object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject
func (*Response) Descriptor ¶ added in v1.5.0
func (*Response) GetDescription ¶ added in v1.5.0
func (*Response) ProtoMessage ¶ added in v1.5.0
func (*Response) ProtoMessage()
func (*Response) XXX_DiscardUnknown ¶ added in v1.5.0
func (m *Response) XXX_DiscardUnknown()
func (*Response) XXX_Marshal ¶ added in v1.5.0
func (*Response) XXX_Unmarshal ¶ added in v1.5.0
type Schema ¶
type Schema struct { JsonSchema *JSONSchema `protobuf:"bytes,1,opt,name=json_schema,json=jsonSchema,proto3" json:"json_schema,omitempty"` Discriminator string `protobuf:"bytes,2,opt,name=discriminator,proto3" json:"discriminator,omitempty"` ReadOnly bool `protobuf:"varint,3,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"` ExternalDocs *ExternalDocumentation `protobuf:"bytes,5,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"` Example *any.Any `protobuf:"bytes,6,opt,name=example,proto3" json:"example,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`Schema` is a representation of OpenAPI v2 specification's Schema object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
TODO(ivucica): document fields
func (*Schema) Descriptor ¶
func (*Schema) GetDiscriminator ¶
func (*Schema) GetExample ¶
func (*Schema) GetExternalDocs ¶
func (m *Schema) GetExternalDocs() *ExternalDocumentation
func (*Schema) GetJsonSchema ¶
func (m *Schema) GetJsonSchema() *JSONSchema
func (*Schema) GetReadOnly ¶
func (*Schema) ProtoMessage ¶
func (*Schema) ProtoMessage()
func (*Schema) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *Schema) XXX_DiscardUnknown()
func (*Schema) XXX_Marshal ¶ added in v1.4.0
func (*Schema) XXX_Unmarshal ¶ added in v1.4.0
type Scopes ¶ added in v1.4.0
type Scopes struct { // Maps between a name of a scope to a short description of it (as the value // of the property). Scope map[string]string `` /* 151-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`Scopes` is a representation of OpenAPI v2 specification's Scopes object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#scopesObject
Lists the available scopes for an OAuth2 security scheme.
func (*Scopes) Descriptor ¶ added in v1.4.0
func (*Scopes) ProtoMessage ¶ added in v1.4.0
func (*Scopes) ProtoMessage()
func (*Scopes) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *Scopes) XXX_DiscardUnknown()
func (*Scopes) XXX_Marshal ¶ added in v1.4.0
func (*Scopes) XXX_Unmarshal ¶ added in v1.4.0
type SecurityDefinitions ¶ added in v1.4.0
type SecurityDefinitions struct { // A single security scheme definition, mapping a "name" to the scheme it defines. Security map[string]*SecurityScheme `` /* 157-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`SecurityDefinitions` is a representation of OpenAPI v2 specification's Security Definitions object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityDefinitionsObject
A declaration of the security schemes available to be used in the specification. This does not enforce the security schemes on the operations and only serves to provide the relevant details for each scheme.
func (*SecurityDefinitions) Descriptor ¶ added in v1.4.0
func (*SecurityDefinitions) Descriptor() ([]byte, []int)
func (*SecurityDefinitions) GetSecurity ¶ added in v1.4.0
func (m *SecurityDefinitions) GetSecurity() map[string]*SecurityScheme
func (*SecurityDefinitions) ProtoMessage ¶ added in v1.4.0
func (*SecurityDefinitions) ProtoMessage()
func (*SecurityDefinitions) Reset ¶ added in v1.4.0
func (m *SecurityDefinitions) Reset()
func (*SecurityDefinitions) String ¶ added in v1.4.0
func (m *SecurityDefinitions) String() string
func (*SecurityDefinitions) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *SecurityDefinitions) XXX_DiscardUnknown()
func (*SecurityDefinitions) XXX_Marshal ¶ added in v1.4.0
func (m *SecurityDefinitions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SecurityDefinitions) XXX_Merge ¶ added in v1.4.0
func (dst *SecurityDefinitions) XXX_Merge(src proto.Message)
func (*SecurityDefinitions) XXX_Size ¶ added in v1.4.0
func (m *SecurityDefinitions) XXX_Size() int
func (*SecurityDefinitions) XXX_Unmarshal ¶ added in v1.4.0
func (m *SecurityDefinitions) XXX_Unmarshal(b []byte) error
type SecurityRequirement ¶ added in v1.4.0
type SecurityRequirement struct { // Each name must correspond to a security scheme which is declared in // the Security Definitions. If the security scheme is of type "oauth2", // then the value is a list of scope names required for the execution. // For other security scheme types, the array MUST be empty. SecurityRequirement map[string]*SecurityRequirement_SecurityRequirementValue `` /* 206-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`SecurityRequirement` is a representation of OpenAPI v2 specification's Security Requirement object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityRequirementObject
Lists the required security schemes to execute this operation. The object can have multiple security schemes declared in it which are all required (that is, there is a logical AND between the schemes).
The name used for each property MUST correspond to a security scheme declared in the Security Definitions.
func (*SecurityRequirement) Descriptor ¶ added in v1.4.0
func (*SecurityRequirement) Descriptor() ([]byte, []int)
func (*SecurityRequirement) GetSecurityRequirement ¶ added in v1.4.0
func (m *SecurityRequirement) GetSecurityRequirement() map[string]*SecurityRequirement_SecurityRequirementValue
func (*SecurityRequirement) ProtoMessage ¶ added in v1.4.0
func (*SecurityRequirement) ProtoMessage()
func (*SecurityRequirement) Reset ¶ added in v1.4.0
func (m *SecurityRequirement) Reset()
func (*SecurityRequirement) String ¶ added in v1.4.0
func (m *SecurityRequirement) String() string
func (*SecurityRequirement) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *SecurityRequirement) XXX_DiscardUnknown()
func (*SecurityRequirement) XXX_Marshal ¶ added in v1.4.0
func (m *SecurityRequirement) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SecurityRequirement) XXX_Merge ¶ added in v1.4.0
func (dst *SecurityRequirement) XXX_Merge(src proto.Message)
func (*SecurityRequirement) XXX_Size ¶ added in v1.4.0
func (m *SecurityRequirement) XXX_Size() int
func (*SecurityRequirement) XXX_Unmarshal ¶ added in v1.4.0
func (m *SecurityRequirement) XXX_Unmarshal(b []byte) error
type SecurityRequirement_SecurityRequirementValue ¶ added in v1.4.0
type SecurityRequirement_SecurityRequirementValue struct { Scope []string `protobuf:"bytes,1,rep,name=scope,proto3" json:"scope,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
If the security scheme is of type "oauth2", then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty.
func (*SecurityRequirement_SecurityRequirementValue) Descriptor ¶ added in v1.4.0
func (*SecurityRequirement_SecurityRequirementValue) Descriptor() ([]byte, []int)
func (*SecurityRequirement_SecurityRequirementValue) GetScope ¶ added in v1.4.0
func (m *SecurityRequirement_SecurityRequirementValue) GetScope() []string
func (*SecurityRequirement_SecurityRequirementValue) ProtoMessage ¶ added in v1.4.0
func (*SecurityRequirement_SecurityRequirementValue) ProtoMessage()
func (*SecurityRequirement_SecurityRequirementValue) Reset ¶ added in v1.4.0
func (m *SecurityRequirement_SecurityRequirementValue) Reset()
func (*SecurityRequirement_SecurityRequirementValue) String ¶ added in v1.4.0
func (m *SecurityRequirement_SecurityRequirementValue) String() string
func (*SecurityRequirement_SecurityRequirementValue) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *SecurityRequirement_SecurityRequirementValue) XXX_DiscardUnknown()
func (*SecurityRequirement_SecurityRequirementValue) XXX_Marshal ¶ added in v1.4.0
func (m *SecurityRequirement_SecurityRequirementValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SecurityRequirement_SecurityRequirementValue) XXX_Merge ¶ added in v1.4.0
func (dst *SecurityRequirement_SecurityRequirementValue) XXX_Merge(src proto.Message)
func (*SecurityRequirement_SecurityRequirementValue) XXX_Size ¶ added in v1.4.0
func (m *SecurityRequirement_SecurityRequirementValue) XXX_Size() int
func (*SecurityRequirement_SecurityRequirementValue) XXX_Unmarshal ¶ added in v1.4.0
func (m *SecurityRequirement_SecurityRequirementValue) XXX_Unmarshal(b []byte) error
type SecurityScheme ¶ added in v1.4.0
type SecurityScheme struct { // Required. The type of the security scheme. Valid values are "basic", // "apiKey" or "oauth2". Type SecurityScheme_Type `` /* 127-byte string literal not displayed */ // A short description for security scheme. Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` // Required. The name of the header or query parameter to be used. // // Valid for apiKey. Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` // Required. The location of the API key. Valid values are "query" or "header". // // Valid for apiKey. In SecurityScheme_In `protobuf:"varint,4,opt,name=in,proto3,enum=grpc.gateway.protoc_gen_swagger.options.SecurityScheme_In" json:"in,omitempty"` // Required. The flow used by the OAuth2 security scheme. Valid values are // "implicit", "password", "application" or "accessCode". // // Valid for oauth2. Flow SecurityScheme_Flow `` /* 127-byte string literal not displayed */ // Required. The authorization URL to be used for this flow. This SHOULD be in // the form of a URL. // // Valid for oauth2/implicit and oauth2/accessCode. AuthorizationUrl string `protobuf:"bytes,6,opt,name=authorization_url,json=authorizationUrl,proto3" json:"authorization_url,omitempty"` // Required. The token URL to be used for this flow. This SHOULD be in the // form of a URL. // // Valid for oauth2/password, oauth2/application and oauth2/accessCode. TokenUrl string `protobuf:"bytes,7,opt,name=token_url,json=tokenUrl,proto3" json:"token_url,omitempty"` // Required. The available scopes for the OAuth2 security scheme. // // Valid for oauth2. Scopes *Scopes `protobuf:"bytes,8,opt,name=scopes,proto3" json:"scopes,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`SecurityScheme` is a representation of OpenAPI v2 specification's Security Scheme object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securitySchemeObject
Allows the definition of a security scheme that can be used by the operations. Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code).
func (*SecurityScheme) Descriptor ¶ added in v1.4.0
func (*SecurityScheme) Descriptor() ([]byte, []int)
func (*SecurityScheme) GetAuthorizationUrl ¶ added in v1.4.0
func (m *SecurityScheme) GetAuthorizationUrl() string
func (*SecurityScheme) GetDescription ¶ added in v1.4.0
func (m *SecurityScheme) GetDescription() string
func (*SecurityScheme) GetFlow ¶ added in v1.4.0
func (m *SecurityScheme) GetFlow() SecurityScheme_Flow
func (*SecurityScheme) GetIn ¶ added in v1.4.0
func (m *SecurityScheme) GetIn() SecurityScheme_In
func (*SecurityScheme) GetName ¶ added in v1.4.0
func (m *SecurityScheme) GetName() string
func (*SecurityScheme) GetScopes ¶ added in v1.4.0
func (m *SecurityScheme) GetScopes() *Scopes
func (*SecurityScheme) GetTokenUrl ¶ added in v1.4.0
func (m *SecurityScheme) GetTokenUrl() string
func (*SecurityScheme) GetType ¶ added in v1.4.0
func (m *SecurityScheme) GetType() SecurityScheme_Type
func (*SecurityScheme) ProtoMessage ¶ added in v1.4.0
func (*SecurityScheme) ProtoMessage()
func (*SecurityScheme) Reset ¶ added in v1.4.0
func (m *SecurityScheme) Reset()
func (*SecurityScheme) String ¶ added in v1.4.0
func (m *SecurityScheme) String() string
func (*SecurityScheme) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *SecurityScheme) XXX_DiscardUnknown()
func (*SecurityScheme) XXX_Marshal ¶ added in v1.4.0
func (m *SecurityScheme) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SecurityScheme) XXX_Merge ¶ added in v1.4.0
func (dst *SecurityScheme) XXX_Merge(src proto.Message)
func (*SecurityScheme) XXX_Size ¶ added in v1.4.0
func (m *SecurityScheme) XXX_Size() int
func (*SecurityScheme) XXX_Unmarshal ¶ added in v1.4.0
func (m *SecurityScheme) XXX_Unmarshal(b []byte) error
type SecurityScheme_Flow ¶ added in v1.4.0
type SecurityScheme_Flow int32
Required. The flow used by the OAuth2 security scheme. Valid values are "implicit", "password", "application" or "accessCode".
const ( SecurityScheme_FLOW_INVALID SecurityScheme_Flow = 0 SecurityScheme_FLOW_IMPLICIT SecurityScheme_Flow = 1 SecurityScheme_FLOW_PASSWORD SecurityScheme_Flow = 2 SecurityScheme_FLOW_APPLICATION SecurityScheme_Flow = 3 SecurityScheme_FLOW_ACCESS_CODE SecurityScheme_Flow = 4 )
func (SecurityScheme_Flow) EnumDescriptor ¶ added in v1.4.0
func (SecurityScheme_Flow) EnumDescriptor() ([]byte, []int)
func (SecurityScheme_Flow) String ¶ added in v1.4.0
func (x SecurityScheme_Flow) String() string
type SecurityScheme_In ¶ added in v1.4.0
type SecurityScheme_In int32
Required. The location of the API key. Valid values are "query" or "header".
const ( SecurityScheme_IN_INVALID SecurityScheme_In = 0 SecurityScheme_IN_QUERY SecurityScheme_In = 1 SecurityScheme_IN_HEADER SecurityScheme_In = 2 )
func (SecurityScheme_In) EnumDescriptor ¶ added in v1.4.0
func (SecurityScheme_In) EnumDescriptor() ([]byte, []int)
func (SecurityScheme_In) String ¶ added in v1.4.0
func (x SecurityScheme_In) String() string
type SecurityScheme_Type ¶ added in v1.4.0
type SecurityScheme_Type int32
Required. The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2".
const ( SecurityScheme_TYPE_INVALID SecurityScheme_Type = 0 SecurityScheme_TYPE_BASIC SecurityScheme_Type = 1 SecurityScheme_TYPE_API_KEY SecurityScheme_Type = 2 SecurityScheme_TYPE_OAUTH2 SecurityScheme_Type = 3 )
func (SecurityScheme_Type) EnumDescriptor ¶ added in v1.4.0
func (SecurityScheme_Type) EnumDescriptor() ([]byte, []int)
func (SecurityScheme_Type) String ¶ added in v1.4.0
func (x SecurityScheme_Type) String() string
type Swagger ¶
type Swagger struct { Swagger string `protobuf:"bytes,1,opt,name=swagger,proto3" json:"swagger,omitempty"` Info *Info `protobuf:"bytes,2,opt,name=info,proto3" json:"info,omitempty"` Host string `protobuf:"bytes,3,opt,name=host,proto3" json:"host,omitempty"` BasePath string `protobuf:"bytes,4,opt,name=base_path,json=basePath,proto3" json:"base_path,omitempty"` Schemes []Swagger_SwaggerScheme `` /* 142-byte string literal not displayed */ Consumes []string `protobuf:"bytes,6,rep,name=consumes,proto3" json:"consumes,omitempty"` Produces []string `protobuf:"bytes,7,rep,name=produces,proto3" json:"produces,omitempty"` Responses map[string]*Response `` /* 160-byte string literal not displayed */ SecurityDefinitions *SecurityDefinitions `protobuf:"bytes,11,opt,name=security_definitions,json=securityDefinitions,proto3" json:"security_definitions,omitempty"` Security []*SecurityRequirement `protobuf:"bytes,12,rep,name=security,proto3" json:"security,omitempty"` ExternalDocs *ExternalDocumentation `protobuf:"bytes,14,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`Swagger` is a representation of OpenAPI v2 specification's Swagger object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject
TODO(ivucica): document fields
func (*Swagger) Descriptor ¶
func (*Swagger) GetBasePath ¶
func (*Swagger) GetConsumes ¶
func (*Swagger) GetExternalDocs ¶
func (m *Swagger) GetExternalDocs() *ExternalDocumentation
func (*Swagger) GetProduces ¶
func (*Swagger) GetResponses ¶ added in v1.5.0
func (*Swagger) GetSchemes ¶
func (m *Swagger) GetSchemes() []Swagger_SwaggerScheme
func (*Swagger) GetSecurity ¶ added in v1.4.0
func (m *Swagger) GetSecurity() []*SecurityRequirement
func (*Swagger) GetSecurityDefinitions ¶ added in v1.4.0
func (m *Swagger) GetSecurityDefinitions() *SecurityDefinitions
func (*Swagger) GetSwagger ¶
func (*Swagger) ProtoMessage ¶
func (*Swagger) ProtoMessage()
func (*Swagger) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *Swagger) XXX_DiscardUnknown()
func (*Swagger) XXX_Marshal ¶ added in v1.4.0
func (*Swagger) XXX_Unmarshal ¶ added in v1.4.0
type Swagger_SwaggerScheme ¶
type Swagger_SwaggerScheme int32
const ( Swagger_UNKNOWN Swagger_SwaggerScheme = 0 Swagger_HTTP Swagger_SwaggerScheme = 1 Swagger_HTTPS Swagger_SwaggerScheme = 2 Swagger_WS Swagger_SwaggerScheme = 3 Swagger_WSS Swagger_SwaggerScheme = 4 )
func (Swagger_SwaggerScheme) EnumDescriptor ¶
func (Swagger_SwaggerScheme) EnumDescriptor() ([]byte, []int)
func (Swagger_SwaggerScheme) String ¶
func (x Swagger_SwaggerScheme) String() string
type Tag ¶
type Tag struct { // TODO(ivucica): Description should be extracted from comments on the proto // service object. Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` ExternalDocs *ExternalDocumentation `protobuf:"bytes,3,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
`Tag` is a representation of OpenAPI v2 specification's Tag object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#tagObject
TODO(ivucica): document fields
func (*Tag) Descriptor ¶
func (*Tag) GetDescription ¶
func (*Tag) GetExternalDocs ¶
func (m *Tag) GetExternalDocs() *ExternalDocumentation
func (*Tag) ProtoMessage ¶
func (*Tag) ProtoMessage()
func (*Tag) XXX_DiscardUnknown ¶ added in v1.4.0
func (m *Tag) XXX_DiscardUnknown()