Documentation ¶
Index ¶
- Variables
- type Contact
- func (*Contact) Descriptor() ([]byte, []int)deprecated
- func (x *Contact) GetEmail() string
- func (x *Contact) GetName() string
- func (x *Contact) GetUrl() string
- func (*Contact) ProtoMessage()
- func (x *Contact) ProtoReflect() protoreflect.Message
- func (x *Contact) Reset()
- func (x *Contact) String() string
- type ExternalDocumentation
- func (*ExternalDocumentation) Descriptor() ([]byte, []int)deprecated
- func (x *ExternalDocumentation) GetDescription() string
- func (x *ExternalDocumentation) GetUrl() string
- func (*ExternalDocumentation) ProtoMessage()
- func (x *ExternalDocumentation) ProtoReflect() protoreflect.Message
- func (x *ExternalDocumentation) Reset()
- func (x *ExternalDocumentation) String() string
- type Info
- func (*Info) Descriptor() ([]byte, []int)deprecated
- func (x *Info) GetContact() *Contact
- func (x *Info) GetDescription() string
- func (x *Info) GetLicense() *License
- func (x *Info) GetTermsOfService() string
- func (x *Info) GetTitle() string
- func (x *Info) GetVersion() string
- func (*Info) ProtoMessage()
- func (x *Info) ProtoReflect() protoreflect.Message
- func (x *Info) Reset()
- func (x *Info) String() string
- type JSONSchema
- func (*JSONSchema) Descriptor() ([]byte, []int)deprecated
- 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) GetRef() string
- func (x *JSONSchema) GetRequired() []string
- func (x *JSONSchema) GetTitle() string
- func (x *JSONSchema) GetType() []JSONSchema_JSONSchemaSimpleTypes
- func (x *JSONSchema) GetUniqueItems() bool
- func (*JSONSchema) ProtoMessage()
- func (x *JSONSchema) ProtoReflect() protoreflect.Message
- func (x *JSONSchema) Reset()
- func (x *JSONSchema) String() string
- type JSONSchema_JSONSchemaSimpleTypes
- func (JSONSchema_JSONSchemaSimpleTypes) Descriptor() protoreflect.EnumDescriptor
- func (x JSONSchema_JSONSchemaSimpleTypes) Enum() *JSONSchema_JSONSchemaSimpleTypes
- func (JSONSchema_JSONSchemaSimpleTypes) EnumDescriptor() ([]byte, []int)deprecated
- func (x JSONSchema_JSONSchemaSimpleTypes) Number() protoreflect.EnumNumber
- func (x JSONSchema_JSONSchemaSimpleTypes) String() string
- func (JSONSchema_JSONSchemaSimpleTypes) Type() protoreflect.EnumType
- type License
- type Operation
- func (*Operation) Descriptor() ([]byte, []int)deprecated
- func (x *Operation) GetConsumes() []string
- func (x *Operation) GetDeprecated() bool
- func (x *Operation) GetDescription() string
- 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() []string
- func (x *Operation) GetSecurity() []*SecurityRequirement
- func (x *Operation) GetSummary() string
- func (x *Operation) GetTags() []string
- func (*Operation) ProtoMessage()
- func (x *Operation) ProtoReflect() protoreflect.Message
- func (x *Operation) Reset()
- func (x *Operation) String() string
- type Response
- type Schema
- func (*Schema) Descriptor() ([]byte, []int)deprecated
- func (x *Schema) GetDiscriminator() string
- func (x *Schema) GetExample() *anypb.Any
- func (x *Schema) GetExternalDocs() *ExternalDocumentation
- func (x *Schema) GetJsonSchema() *JSONSchema
- func (x *Schema) GetReadOnly() bool
- func (*Schema) ProtoMessage()
- func (x *Schema) ProtoReflect() protoreflect.Message
- func (x *Schema) Reset()
- func (x *Schema) String() string
- type Scopes
- type SecurityDefinitions
- func (*SecurityDefinitions) Descriptor() ([]byte, []int)deprecated
- func (x *SecurityDefinitions) GetSecurity() map[string]*SecurityScheme
- func (*SecurityDefinitions) ProtoMessage()
- func (x *SecurityDefinitions) ProtoReflect() protoreflect.Message
- func (x *SecurityDefinitions) Reset()
- func (x *SecurityDefinitions) String() string
- type SecurityRequirement
- func (*SecurityRequirement) Descriptor() ([]byte, []int)deprecated
- func (x *SecurityRequirement) GetSecurityRequirement() map[string]*SecurityRequirement_SecurityRequirementValue
- func (*SecurityRequirement) ProtoMessage()
- func (x *SecurityRequirement) ProtoReflect() protoreflect.Message
- func (x *SecurityRequirement) Reset()
- func (x *SecurityRequirement) String() string
- type SecurityRequirement_SecurityRequirementValue
- func (*SecurityRequirement_SecurityRequirementValue) Descriptor() ([]byte, []int)deprecated
- func (x *SecurityRequirement_SecurityRequirementValue) GetScope() []string
- func (*SecurityRequirement_SecurityRequirementValue) ProtoMessage()
- func (x *SecurityRequirement_SecurityRequirementValue) ProtoReflect() protoreflect.Message
- func (x *SecurityRequirement_SecurityRequirementValue) Reset()
- func (x *SecurityRequirement_SecurityRequirementValue) String() string
- type SecurityScheme
- func (*SecurityScheme) Descriptor() ([]byte, []int)deprecated
- func (x *SecurityScheme) GetAuthorizationUrl() string
- func (x *SecurityScheme) GetDescription() string
- 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 (*SecurityScheme) ProtoMessage()
- func (x *SecurityScheme) ProtoReflect() protoreflect.Message
- func (x *SecurityScheme) Reset()
- func (x *SecurityScheme) String() string
- type SecurityScheme_Flow
- func (SecurityScheme_Flow) Descriptor() protoreflect.EnumDescriptor
- func (x SecurityScheme_Flow) Enum() *SecurityScheme_Flow
- func (SecurityScheme_Flow) EnumDescriptor() ([]byte, []int)deprecated
- func (x SecurityScheme_Flow) Number() protoreflect.EnumNumber
- func (x SecurityScheme_Flow) String() string
- func (SecurityScheme_Flow) Type() protoreflect.EnumType
- type SecurityScheme_In
- func (SecurityScheme_In) Descriptor() protoreflect.EnumDescriptor
- func (x SecurityScheme_In) Enum() *SecurityScheme_In
- func (SecurityScheme_In) EnumDescriptor() ([]byte, []int)deprecated
- func (x SecurityScheme_In) Number() protoreflect.EnumNumber
- func (x SecurityScheme_In) String() string
- func (SecurityScheme_In) Type() protoreflect.EnumType
- type SecurityScheme_Type
- func (SecurityScheme_Type) Descriptor() protoreflect.EnumDescriptor
- func (x SecurityScheme_Type) Enum() *SecurityScheme_Type
- func (SecurityScheme_Type) EnumDescriptor() ([]byte, []int)deprecated
- func (x SecurityScheme_Type) Number() protoreflect.EnumNumber
- func (x SecurityScheme_Type) String() string
- func (SecurityScheme_Type) Type() protoreflect.EnumType
- type Swagger
- func (*Swagger) Descriptor() ([]byte, []int)deprecated
- func (x *Swagger) GetBasePath() string
- func (x *Swagger) GetConsumes() []string
- 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() []Swagger_SwaggerScheme
- func (x *Swagger) GetSecurity() []*SecurityRequirement
- func (x *Swagger) GetSecurityDefinitions() *SecurityDefinitions
- func (x *Swagger) GetSwagger() string
- func (*Swagger) ProtoMessage()
- func (x *Swagger) ProtoReflect() protoreflect.Message
- func (x *Swagger) Reset()
- func (x *Swagger) String() string
- type Swagger_SwaggerScheme
- func (Swagger_SwaggerScheme) Descriptor() protoreflect.EnumDescriptor
- func (x Swagger_SwaggerScheme) Enum() *Swagger_SwaggerScheme
- func (Swagger_SwaggerScheme) EnumDescriptor() ([]byte, []int)deprecated
- func (x Swagger_SwaggerScheme) Number() protoreflect.EnumNumber
- func (x Swagger_SwaggerScheme) String() string
- func (Swagger_SwaggerScheme) Type() protoreflect.EnumType
- type Tag
Constants ¶
This section is empty.
Variables ¶
var ( Swagger_SwaggerScheme_name = map[int32]string{ 0: "UNKNOWN", 1: "HTTP", 2: "HTTPS", 3: "WS", 4: "WSS", } Swagger_SwaggerScheme_value = map[string]int32{ "UNKNOWN": 0, "HTTP": 1, "HTTPS": 2, "WS": 3, "WSS": 4, } )
Enum value maps for Swagger_SwaggerScheme.
var ( JSONSchema_JSONSchemaSimpleTypes_name = map[int32]string{ 0: "UNKNOWN", 1: "ARRAY", 2: "BOOLEAN", 3: "INTEGER", 4: "NULL", 5: "NUMBER", 6: "OBJECT", 7: "STRING", } JSONSchema_JSONSchemaSimpleTypes_value = map[string]int32{ "UNKNOWN": 0, "ARRAY": 1, "BOOLEAN": 2, "INTEGER": 3, "NULL": 4, "NUMBER": 5, "OBJECT": 6, "STRING": 7, } )
Enum value maps for JSONSchema_JSONSchemaSimpleTypes.
var ( SecurityScheme_Type_name = map[int32]string{ 0: "TYPE_INVALID", 1: "TYPE_BASIC", 2: "TYPE_API_KEY", 3: "TYPE_OAUTH2", } SecurityScheme_Type_value = map[string]int32{ "TYPE_INVALID": 0, "TYPE_BASIC": 1, "TYPE_API_KEY": 2, "TYPE_OAUTH2": 3, } )
Enum value maps for SecurityScheme_Type.
var ( SecurityScheme_In_name = map[int32]string{ 0: "IN_INVALID", 1: "IN_QUERY", 2: "IN_HEADER", } SecurityScheme_In_value = map[string]int32{ "IN_INVALID": 0, "IN_QUERY": 1, "IN_HEADER": 2, } )
Enum value maps for SecurityScheme_In.
var ( SecurityScheme_Flow_name = map[int32]string{ 0: "FLOW_INVALID", 1: "FLOW_IMPLICIT", 2: "FLOW_PASSWORD", 3: "FLOW_APPLICATION", 4: "FLOW_ACCESS_CODE", } SecurityScheme_Flow_value = map[string]int32{ "FLOW_INVALID": 0, "FLOW_IMPLICIT": 1, "FLOW_PASSWORD": 2, "FLOW_APPLICATION": 3, "FLOW_ACCESS_CODE": 4, } )
Enum value maps for SecurityScheme_Flow.
var ( // ID assigned by protobuf-global-extension-registry@google.com for grpc-gateway project. // // All IDs are the same, as assigned. It is okay that they are the same, as they extend // different descriptor messages. // // optional grpc.gateway.protoc_gen_swagger.options.JSONSchema openapiv2_field = 1042; E_Openapiv2Field = &file_pkg_protoc_gen_swagger_options_annotations_proto_extTypes[4] )
Extension fields to descriptorpb.FieldOptions.
var ( // ID assigned by protobuf-global-extension-registry@google.com for grpc-gateway project. // // All IDs are the same, as assigned. It is okay that they are the same, as they extend // different descriptor messages. // // optional grpc.gateway.protoc_gen_swagger.options.Operation openapiv2_operation = 1042; E_Openapiv2Operation = &file_pkg_protoc_gen_swagger_options_annotations_proto_extTypes[1] )
Extension fields to descriptorpb.MethodOptions.
var ( // ID assigned by protobuf-global-extension-registry@google.com for grpc-gateway project. // // All IDs are the same, as assigned. It is okay that they are the same, as they extend // different descriptor messages. // // optional grpc.gateway.protoc_gen_swagger.options.Schema openapiv2_schema = 1042; E_Openapiv2Schema = &file_pkg_protoc_gen_swagger_options_annotations_proto_extTypes[2] )
Extension fields to descriptorpb.MessageOptions.
var ( // ID assigned by protobuf-global-extension-registry@google.com for grpc-gateway project. // // All IDs are the same, as assigned. It is okay that they are the same, as they extend // different descriptor messages. // // optional grpc.gateway.protoc_gen_swagger.options.Swagger openapiv2_swagger = 1042; E_Openapiv2Swagger = &file_pkg_protoc_gen_swagger_options_annotations_proto_extTypes[0] )
Extension fields to descriptorpb.FileOptions.
var ( // ID assigned by protobuf-global-extension-registry@google.com for grpc-gateway project. // // All IDs are the same, as assigned. It is okay that they are the same, as they extend // different descriptor messages. // // optional grpc.gateway.protoc_gen_swagger.options.Tag openapiv2_tag = 1042; E_Openapiv2Tag = &file_pkg_protoc_gen_swagger_options_annotations_proto_extTypes[3] )
Extension fields to descriptorpb.ServiceOptions.
var File_pkg_protoc_gen_swagger_options_annotations_proto protoreflect.FileDescriptor
var File_pkg_protoc_gen_swagger_options_openapiv2_proto protoreflect.FileDescriptor
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"` // contains filtered or unexported fields }
`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
deprecated
func (*Contact) ProtoMessage ¶
func (*Contact) ProtoMessage()
func (*Contact) ProtoReflect ¶
func (x *Contact) ProtoReflect() protoreflect.Message
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"` // contains filtered or unexported fields }
`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
deprecated
func (*ExternalDocumentation) Descriptor() ([]byte, []int)
Deprecated: Use ExternalDocumentation.ProtoReflect.Descriptor instead.
func (*ExternalDocumentation) GetDescription ¶
func (x *ExternalDocumentation) GetDescription() string
func (*ExternalDocumentation) GetUrl ¶
func (x *ExternalDocumentation) GetUrl() string
func (*ExternalDocumentation) ProtoMessage ¶
func (*ExternalDocumentation) ProtoMessage()
func (*ExternalDocumentation) ProtoReflect ¶
func (x *ExternalDocumentation) ProtoReflect() protoreflect.Message
func (*ExternalDocumentation) Reset ¶
func (x *ExternalDocumentation) Reset()
func (*ExternalDocumentation) String ¶
func (x *ExternalDocumentation) String() string
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"` License *License `protobuf:"bytes,5,opt,name=license,proto3" json:"license,omitempty"` Version string `protobuf:"bytes,6,opt,name=version,proto3" json:"version,omitempty"` // contains filtered or unexported fields }
`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
deprecated
func (*Info) GetContact ¶
func (*Info) GetDescription ¶
func (*Info) GetLicense ¶
func (*Info) GetTermsOfService ¶
func (*Info) GetVersion ¶
func (*Info) ProtoMessage ¶
func (*Info) ProtoMessage()
func (*Info) ProtoReflect ¶
func (x *Info) ProtoReflect() protoreflect.Message
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 */ // contains filtered or unexported fields }
`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
deprecated
func (*JSONSchema) Descriptor() ([]byte, []int)
Deprecated: Use JSONSchema.ProtoReflect.Descriptor instead.
func (*JSONSchema) GetArray ¶
func (x *JSONSchema) GetArray() []string
func (*JSONSchema) GetDefault ¶
func (x *JSONSchema) GetDefault() string
func (*JSONSchema) GetDescription ¶
func (x *JSONSchema) GetDescription() string
func (*JSONSchema) GetExclusiveMaximum ¶
func (x *JSONSchema) GetExclusiveMaximum() bool
func (*JSONSchema) GetExclusiveMinimum ¶
func (x *JSONSchema) GetExclusiveMinimum() bool
func (*JSONSchema) GetMaxItems ¶
func (x *JSONSchema) GetMaxItems() uint64
func (*JSONSchema) GetMaxLength ¶
func (x *JSONSchema) GetMaxLength() uint64
func (*JSONSchema) GetMaxProperties ¶
func (x *JSONSchema) GetMaxProperties() uint64
func (*JSONSchema) GetMaximum ¶
func (x *JSONSchema) GetMaximum() float64
func (*JSONSchema) GetMinItems ¶
func (x *JSONSchema) GetMinItems() uint64
func (*JSONSchema) GetMinLength ¶
func (x *JSONSchema) GetMinLength() uint64
func (*JSONSchema) GetMinProperties ¶
func (x *JSONSchema) GetMinProperties() uint64
func (*JSONSchema) GetMinimum ¶
func (x *JSONSchema) GetMinimum() float64
func (*JSONSchema) GetMultipleOf ¶
func (x *JSONSchema) GetMultipleOf() float64
func (*JSONSchema) GetPattern ¶
func (x *JSONSchema) GetPattern() string
func (*JSONSchema) GetRef ¶
func (x *JSONSchema) GetRef() string
func (*JSONSchema) GetRequired ¶
func (x *JSONSchema) GetRequired() []string
func (*JSONSchema) GetTitle ¶
func (x *JSONSchema) GetTitle() string
func (*JSONSchema) GetType ¶
func (x *JSONSchema) GetType() []JSONSchema_JSONSchemaSimpleTypes
func (*JSONSchema) GetUniqueItems ¶
func (x *JSONSchema) GetUniqueItems() bool
func (*JSONSchema) ProtoMessage ¶
func (*JSONSchema) ProtoMessage()
func (*JSONSchema) ProtoReflect ¶
func (x *JSONSchema) ProtoReflect() protoreflect.Message
func (*JSONSchema) Reset ¶
func (x *JSONSchema) Reset()
func (*JSONSchema) String ¶
func (x *JSONSchema) String() string
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) Descriptor ¶
func (JSONSchema_JSONSchemaSimpleTypes) Descriptor() protoreflect.EnumDescriptor
func (JSONSchema_JSONSchemaSimpleTypes) Enum ¶
func (x JSONSchema_JSONSchemaSimpleTypes) Enum() *JSONSchema_JSONSchemaSimpleTypes
func (JSONSchema_JSONSchemaSimpleTypes) EnumDescriptor
deprecated
func (JSONSchema_JSONSchemaSimpleTypes) EnumDescriptor() ([]byte, []int)
Deprecated: Use JSONSchema_JSONSchemaSimpleTypes.Descriptor instead.
func (JSONSchema_JSONSchemaSimpleTypes) Number ¶
func (x JSONSchema_JSONSchemaSimpleTypes) Number() protoreflect.EnumNumber
func (JSONSchema_JSONSchemaSimpleTypes) String ¶
func (x JSONSchema_JSONSchemaSimpleTypes) String() string
func (JSONSchema_JSONSchemaSimpleTypes) Type ¶
func (JSONSchema_JSONSchemaSimpleTypes) Type() protoreflect.EnumType
type License ¶
type License struct { // Required. The license name used for the API. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // A URL to the license used for the API. Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"` // contains filtered or unexported fields }
`License` is a representation of OpenAPI v2 specification's License object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#licenseObject
func (*License) Descriptor
deprecated
func (*License) ProtoMessage ¶
func (*License) ProtoMessage()
func (*License) ProtoReflect ¶
func (x *License) ProtoReflect() protoreflect.Message
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"` // contains filtered or unexported fields }
`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
deprecated
func (*Operation) GetConsumes ¶
func (*Operation) GetDeprecated ¶
func (*Operation) GetDescription ¶
func (*Operation) GetExternalDocs ¶
func (x *Operation) GetExternalDocs() *ExternalDocumentation
func (*Operation) GetOperationId ¶
func (*Operation) GetProduces ¶
func (*Operation) GetResponses ¶
func (*Operation) GetSchemes ¶
func (*Operation) GetSecurity ¶
func (x *Operation) GetSecurity() []*SecurityRequirement
func (*Operation) GetSummary ¶
func (*Operation) ProtoMessage ¶
func (*Operation) ProtoMessage()
func (*Operation) ProtoReflect ¶
func (x *Operation) ProtoReflect() protoreflect.Message
type Response ¶
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"` // contains filtered or unexported fields }
`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
deprecated
func (*Response) GetDescription ¶
func (*Response) ProtoMessage ¶
func (*Response) ProtoMessage()
func (*Response) ProtoReflect ¶
func (x *Response) ProtoReflect() protoreflect.Message
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 *anypb.Any `protobuf:"bytes,6,opt,name=example,proto3" json:"example,omitempty"` // contains filtered or unexported fields }
`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
deprecated
func (*Schema) GetDiscriminator ¶
func (*Schema) GetExample ¶
func (*Schema) GetExternalDocs ¶
func (x *Schema) GetExternalDocs() *ExternalDocumentation
func (*Schema) GetJsonSchema ¶
func (x *Schema) GetJsonSchema() *JSONSchema
func (*Schema) GetReadOnly ¶
func (*Schema) ProtoMessage ¶
func (*Schema) ProtoMessage()
func (*Schema) ProtoReflect ¶
func (x *Schema) ProtoReflect() protoreflect.Message
type Scopes ¶
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 */ // contains filtered or unexported fields }
`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
deprecated
func (*Scopes) ProtoMessage ¶
func (*Scopes) ProtoMessage()
func (*Scopes) ProtoReflect ¶
func (x *Scopes) ProtoReflect() protoreflect.Message
type SecurityDefinitions ¶
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 */ // contains filtered or unexported fields }
`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
deprecated
func (*SecurityDefinitions) Descriptor() ([]byte, []int)
Deprecated: Use SecurityDefinitions.ProtoReflect.Descriptor instead.
func (*SecurityDefinitions) GetSecurity ¶
func (x *SecurityDefinitions) GetSecurity() map[string]*SecurityScheme
func (*SecurityDefinitions) ProtoMessage ¶
func (*SecurityDefinitions) ProtoMessage()
func (*SecurityDefinitions) ProtoReflect ¶
func (x *SecurityDefinitions) ProtoReflect() protoreflect.Message
func (*SecurityDefinitions) Reset ¶
func (x *SecurityDefinitions) Reset()
func (*SecurityDefinitions) String ¶
func (x *SecurityDefinitions) String() string
type SecurityRequirement ¶
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 */ // contains filtered or unexported fields }
`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
deprecated
func (*SecurityRequirement) Descriptor() ([]byte, []int)
Deprecated: Use SecurityRequirement.ProtoReflect.Descriptor instead.
func (*SecurityRequirement) GetSecurityRequirement ¶
func (x *SecurityRequirement) GetSecurityRequirement() map[string]*SecurityRequirement_SecurityRequirementValue
func (*SecurityRequirement) ProtoMessage ¶
func (*SecurityRequirement) ProtoMessage()
func (*SecurityRequirement) ProtoReflect ¶
func (x *SecurityRequirement) ProtoReflect() protoreflect.Message
func (*SecurityRequirement) Reset ¶
func (x *SecurityRequirement) Reset()
func (*SecurityRequirement) String ¶
func (x *SecurityRequirement) String() string
type SecurityRequirement_SecurityRequirementValue ¶
type SecurityRequirement_SecurityRequirementValue struct { Scope []string `protobuf:"bytes,1,rep,name=scope,proto3" json:"scope,omitempty"` // contains filtered or unexported fields }
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
deprecated
func (*SecurityRequirement_SecurityRequirementValue) Descriptor() ([]byte, []int)
Deprecated: Use SecurityRequirement_SecurityRequirementValue.ProtoReflect.Descriptor instead.
func (*SecurityRequirement_SecurityRequirementValue) GetScope ¶
func (x *SecurityRequirement_SecurityRequirementValue) GetScope() []string
func (*SecurityRequirement_SecurityRequirementValue) ProtoMessage ¶
func (*SecurityRequirement_SecurityRequirementValue) ProtoMessage()
func (*SecurityRequirement_SecurityRequirementValue) ProtoReflect ¶
func (x *SecurityRequirement_SecurityRequirementValue) ProtoReflect() protoreflect.Message
func (*SecurityRequirement_SecurityRequirementValue) Reset ¶
func (x *SecurityRequirement_SecurityRequirementValue) Reset()
func (*SecurityRequirement_SecurityRequirementValue) String ¶
func (x *SecurityRequirement_SecurityRequirementValue) String() string
type SecurityScheme ¶
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"` // contains filtered or unexported fields }
`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
deprecated
func (*SecurityScheme) Descriptor() ([]byte, []int)
Deprecated: Use SecurityScheme.ProtoReflect.Descriptor instead.
func (*SecurityScheme) GetAuthorizationUrl ¶
func (x *SecurityScheme) GetAuthorizationUrl() string
func (*SecurityScheme) GetDescription ¶
func (x *SecurityScheme) GetDescription() string
func (*SecurityScheme) GetFlow ¶
func (x *SecurityScheme) GetFlow() SecurityScheme_Flow
func (*SecurityScheme) GetIn ¶
func (x *SecurityScheme) GetIn() SecurityScheme_In
func (*SecurityScheme) GetName ¶
func (x *SecurityScheme) GetName() string
func (*SecurityScheme) GetScopes ¶
func (x *SecurityScheme) GetScopes() *Scopes
func (*SecurityScheme) GetTokenUrl ¶
func (x *SecurityScheme) GetTokenUrl() string
func (*SecurityScheme) GetType ¶
func (x *SecurityScheme) GetType() SecurityScheme_Type
func (*SecurityScheme) ProtoMessage ¶
func (*SecurityScheme) ProtoMessage()
func (*SecurityScheme) ProtoReflect ¶
func (x *SecurityScheme) ProtoReflect() protoreflect.Message
func (*SecurityScheme) Reset ¶
func (x *SecurityScheme) Reset()
func (*SecurityScheme) String ¶
func (x *SecurityScheme) String() string
type SecurityScheme_Flow ¶
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) Descriptor ¶
func (SecurityScheme_Flow) Descriptor() protoreflect.EnumDescriptor
func (SecurityScheme_Flow) Enum ¶
func (x SecurityScheme_Flow) Enum() *SecurityScheme_Flow
func (SecurityScheme_Flow) EnumDescriptor
deprecated
func (SecurityScheme_Flow) EnumDescriptor() ([]byte, []int)
Deprecated: Use SecurityScheme_Flow.Descriptor instead.
func (SecurityScheme_Flow) Number ¶
func (x SecurityScheme_Flow) Number() protoreflect.EnumNumber
func (SecurityScheme_Flow) String ¶
func (x SecurityScheme_Flow) String() string
func (SecurityScheme_Flow) Type ¶
func (SecurityScheme_Flow) Type() protoreflect.EnumType
type SecurityScheme_In ¶
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) Descriptor ¶
func (SecurityScheme_In) Descriptor() protoreflect.EnumDescriptor
func (SecurityScheme_In) Enum ¶
func (x SecurityScheme_In) Enum() *SecurityScheme_In
func (SecurityScheme_In) EnumDescriptor
deprecated
func (SecurityScheme_In) EnumDescriptor() ([]byte, []int)
Deprecated: Use SecurityScheme_In.Descriptor instead.
func (SecurityScheme_In) Number ¶
func (x SecurityScheme_In) Number() protoreflect.EnumNumber
func (SecurityScheme_In) String ¶
func (x SecurityScheme_In) String() string
func (SecurityScheme_In) Type ¶
func (SecurityScheme_In) Type() protoreflect.EnumType
type SecurityScheme_Type ¶
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) Descriptor ¶
func (SecurityScheme_Type) Descriptor() protoreflect.EnumDescriptor
func (SecurityScheme_Type) Enum ¶
func (x SecurityScheme_Type) Enum() *SecurityScheme_Type
func (SecurityScheme_Type) EnumDescriptor
deprecated
func (SecurityScheme_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use SecurityScheme_Type.Descriptor instead.
func (SecurityScheme_Type) Number ¶
func (x SecurityScheme_Type) Number() protoreflect.EnumNumber
func (SecurityScheme_Type) String ¶
func (x SecurityScheme_Type) String() string
func (SecurityScheme_Type) Type ¶
func (SecurityScheme_Type) Type() protoreflect.EnumType
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"` // contains filtered or unexported fields }
`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
deprecated
func (*Swagger) GetBasePath ¶
func (*Swagger) GetConsumes ¶
func (*Swagger) GetExternalDocs ¶
func (x *Swagger) GetExternalDocs() *ExternalDocumentation
func (*Swagger) GetProduces ¶
func (*Swagger) GetResponses ¶
func (*Swagger) GetSchemes ¶
func (x *Swagger) GetSchemes() []Swagger_SwaggerScheme
func (*Swagger) GetSecurity ¶
func (x *Swagger) GetSecurity() []*SecurityRequirement
func (*Swagger) GetSecurityDefinitions ¶
func (x *Swagger) GetSecurityDefinitions() *SecurityDefinitions
func (*Swagger) GetSwagger ¶
func (*Swagger) ProtoMessage ¶
func (*Swagger) ProtoMessage()
func (*Swagger) ProtoReflect ¶
func (x *Swagger) ProtoReflect() protoreflect.Message
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) Descriptor ¶
func (Swagger_SwaggerScheme) Descriptor() protoreflect.EnumDescriptor
func (Swagger_SwaggerScheme) Enum ¶
func (x Swagger_SwaggerScheme) Enum() *Swagger_SwaggerScheme
func (Swagger_SwaggerScheme) EnumDescriptor
deprecated
func (Swagger_SwaggerScheme) EnumDescriptor() ([]byte, []int)
Deprecated: Use Swagger_SwaggerScheme.Descriptor instead.
func (Swagger_SwaggerScheme) Number ¶
func (x Swagger_SwaggerScheme) Number() protoreflect.EnumNumber
func (Swagger_SwaggerScheme) String ¶
func (x Swagger_SwaggerScheme) String() string
func (Swagger_SwaggerScheme) Type ¶
func (Swagger_SwaggerScheme) Type() protoreflect.EnumType
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"` // contains filtered or unexported fields }
`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
deprecated
func (*Tag) GetDescription ¶
func (*Tag) GetExternalDocs ¶
func (x *Tag) GetExternalDocs() *ExternalDocumentation
func (*Tag) ProtoMessage ¶
func (*Tag) ProtoMessage()
func (*Tag) ProtoReflect ¶
func (x *Tag) ProtoReflect() protoreflect.Message