Documentation
¶
Index ¶
- Variables
- type Database
- type HttpFieldLocation
- func (HttpFieldLocation) Descriptor() protoreflect.EnumDescriptor
- func (x HttpFieldLocation) Enum() *HttpFieldLocation
- func (HttpFieldLocation) EnumDescriptor() ([]byte, []int)deprecated
- func (x HttpFieldLocation) Number() protoreflect.EnumNumber
- func (x HttpFieldLocation) String() string
- func (HttpFieldLocation) Type() protoreflect.EnumType
- func (x *HttpFieldLocation) UnmarshalJSON(b []byte) errordeprecated
- type HttpFieldProperty
- func (*HttpFieldProperty) Descriptor() ([]byte, []int)deprecated
- func (x *HttpFieldProperty) GetLocation() HttpFieldLocation
- func (*HttpFieldProperty) ProtoMessage()
- func (x *HttpFieldProperty) ProtoReflect() protoreflect.Message
- func (x *HttpFieldProperty) Reset()
- func (x *HttpFieldProperty) String() string
- type HttpMethod
- func (*HttpMethod) Descriptor() ([]byte, []int)deprecated
- func (x *HttpMethod) GetHeader() []*HttpParameter
- func (x *HttpMethod) GetNoAuth() bool
- func (x *HttpMethod) GetScope() []string
- func (*HttpMethod) ProtoMessage()
- func (x *HttpMethod) ProtoReflect() protoreflect.Message
- func (x *HttpMethod) Reset()
- func (x *HttpMethod) String() string
- type HttpParameter
- func (*HttpParameter) Descriptor() ([]byte, []int)deprecated
- func (x *HttpParameter) GetMemberName() string
- func (x *HttpParameter) GetName() string
- func (x *HttpParameter) GetRequired() bool
- func (x *HttpParameter) GetType() HttpParameterType
- func (*HttpParameter) ProtoMessage()
- func (x *HttpParameter) ProtoReflect() protoreflect.Message
- func (x *HttpParameter) Reset()
- func (x *HttpParameter) String() string
- type HttpParameterType
- func (HttpParameterType) Descriptor() protoreflect.EnumDescriptor
- func (x HttpParameterType) Enum() *HttpParameterType
- func (HttpParameterType) EnumDescriptor() ([]byte, []int)deprecated
- func (x HttpParameterType) Number() protoreflect.EnumNumber
- func (x HttpParameterType) String() string
- func (HttpParameterType) Type() protoreflect.EnumType
- func (x *HttpParameterType) UnmarshalJSON(b []byte) errordeprecated
- type HttpSecurityScheme
- func (*HttpSecurityScheme) Descriptor() ([]byte, []int)deprecated
- func (x *HttpSecurityScheme) GetBearerFormat() HttpSecuritySchemeBearerFormat
- func (x *HttpSecurityScheme) GetDescription() string
- func (x *HttpSecurityScheme) GetIn() string
- func (x *HttpSecurityScheme) GetName() string
- func (x *HttpSecurityScheme) GetScheme() HttpSecuritySchemeScheme
- func (x *HttpSecurityScheme) GetType() HttpSecuritySchemeType
- func (*HttpSecurityScheme) ProtoMessage()
- func (x *HttpSecurityScheme) ProtoReflect() protoreflect.Message
- func (x *HttpSecurityScheme) Reset()
- func (x *HttpSecurityScheme) String() string
- type HttpSecuritySchemeBearerFormat
- func (HttpSecuritySchemeBearerFormat) Descriptor() protoreflect.EnumDescriptor
- func (x HttpSecuritySchemeBearerFormat) Enum() *HttpSecuritySchemeBearerFormat
- func (HttpSecuritySchemeBearerFormat) EnumDescriptor() ([]byte, []int)deprecated
- func (x HttpSecuritySchemeBearerFormat) Number() protoreflect.EnumNumber
- func (x HttpSecuritySchemeBearerFormat) String() string
- func (HttpSecuritySchemeBearerFormat) Type() protoreflect.EnumType
- func (x *HttpSecuritySchemeBearerFormat) UnmarshalJSON(b []byte) errordeprecated
- type HttpSecuritySchemeScheme
- func (HttpSecuritySchemeScheme) Descriptor() protoreflect.EnumDescriptor
- func (x HttpSecuritySchemeScheme) Enum() *HttpSecuritySchemeScheme
- func (HttpSecuritySchemeScheme) EnumDescriptor() ([]byte, []int)deprecated
- func (x HttpSecuritySchemeScheme) Number() protoreflect.EnumNumber
- func (x HttpSecuritySchemeScheme) String() string
- func (HttpSecuritySchemeScheme) Type() protoreflect.EnumType
- func (x *HttpSecuritySchemeScheme) UnmarshalJSON(b []byte) errordeprecated
- type HttpSecuritySchemeType
- func (HttpSecuritySchemeType) Descriptor() protoreflect.EnumDescriptor
- func (x HttpSecuritySchemeType) Enum() *HttpSecuritySchemeType
- func (HttpSecuritySchemeType) EnumDescriptor() ([]byte, []int)deprecated
- func (x HttpSecuritySchemeType) Number() protoreflect.EnumNumber
- func (x HttpSecuritySchemeType) String() string
- func (HttpSecuritySchemeType) Type() protoreflect.EnumType
- func (x *HttpSecuritySchemeType) UnmarshalJSON(b []byte) errordeprecated
- type HttpService
- func (*HttpService) Descriptor() ([]byte, []int)deprecated
- func (x *HttpService) GetHeader() []*HttpParameter
- func (x *HttpService) GetSecurityScheme() *HttpSecurityScheme
- func (*HttpService) ProtoMessage()
- func (x *HttpService) ProtoReflect() protoreflect.Message
- func (x *HttpService) Reset()
- func (x *HttpService) String() string
- type OpenapiMessage
- type OpenapiMethod
- func (*OpenapiMethod) Descriptor() ([]byte, []int)deprecated
- func (x *OpenapiMethod) GetDescription() string
- func (x *OpenapiMethod) GetResponse() []*Response
- func (x *OpenapiMethod) GetSummary() string
- func (x *OpenapiMethod) GetTags() []string
- func (*OpenapiMethod) ProtoMessage()
- func (x *OpenapiMethod) ProtoReflect() protoreflect.Message
- func (x *OpenapiMethod) Reset()
- func (x *OpenapiMethod) String() string
- type OpenapiServer
- func (*OpenapiServer) Descriptor() ([]byte, []int)deprecated
- func (x *OpenapiServer) GetDescription() string
- func (x *OpenapiServer) GetUrl() string
- func (*OpenapiServer) ProtoMessage()
- func (x *OpenapiServer) ProtoReflect() protoreflect.Message
- func (x *OpenapiServer) Reset()
- func (x *OpenapiServer) String() string
- type Operation
- type Property
- func (*Property) Descriptor() ([]byte, []int)deprecated
- func (x *Property) GetDescription() string
- func (x *Property) GetExample() string
- func (x *Property) GetFormat() PropertyFormat
- func (x *Property) GetHideFromSchema() bool
- func (x *Property) GetRequired() bool
- func (*Property) ProtoMessage()
- func (x *Property) ProtoReflect() protoreflect.Message
- func (x *Property) Reset()
- func (x *Property) String() string
- type PropertyFormat
- func (PropertyFormat) Descriptor() protoreflect.EnumDescriptor
- func (x PropertyFormat) Enum() *PropertyFormat
- func (PropertyFormat) EnumDescriptor() ([]byte, []int)deprecated
- func (x PropertyFormat) Number() protoreflect.EnumNumber
- func (x PropertyFormat) String() string
- func (PropertyFormat) Type() protoreflect.EnumType
- func (x *PropertyFormat) UnmarshalJSON(b []byte) errordeprecated
- type RequestBody
- type Response
- type ResponseCode
- func (ResponseCode) Descriptor() protoreflect.EnumDescriptor
- func (x ResponseCode) Enum() *ResponseCode
- func (ResponseCode) EnumDescriptor() ([]byte, []int)deprecated
- func (x ResponseCode) Number() protoreflect.EnumNumber
- func (x ResponseCode) String() string
- func (ResponseCode) Type() protoreflect.EnumType
- func (x *ResponseCode) UnmarshalJSON(b []byte) errordeprecated
Constants ¶
This section is empty.
Variables ¶
var ( HttpParameterType_name = map[int32]string{ 0: "HTTP_PARAMETER_TYPE_UNSPECIFIED", 1: "HTTP_PARAMETER_TYPE_STRING", 2: "HTTP_PARAMETER_TYPE_NUMBER", } HttpParameterType_value = map[string]int32{ "HTTP_PARAMETER_TYPE_UNSPECIFIED": 0, "HTTP_PARAMETER_TYPE_STRING": 1, "HTTP_PARAMETER_TYPE_NUMBER": 2, } )
Enum value maps for HttpParameterType.
var ( HttpSecuritySchemeType_name = map[int32]string{ 0: "HTTP_SECURITY_SCHEME_UNSPECIFIED", 1: "HTTP_SECURITY_SCHEME_API_KEY", 2: "HTTP_SECURITY_SCHEME_HTTP", 3: "HTTP_SECURITY_SCHEME_OAUTH2", 4: "HTTP_SECURITY_SCHEME_OPEN_ID_CONNECT", } HttpSecuritySchemeType_value = map[string]int32{ "HTTP_SECURITY_SCHEME_UNSPECIFIED": 0, "HTTP_SECURITY_SCHEME_API_KEY": 1, "HTTP_SECURITY_SCHEME_HTTP": 2, "HTTP_SECURITY_SCHEME_OAUTH2": 3, "HTTP_SECURITY_SCHEME_OPEN_ID_CONNECT": 4, } )
Enum value maps for HttpSecuritySchemeType.
var ( HttpSecuritySchemeScheme_name = map[int32]string{ 0: "HTTP_SECURITY_SCHEME_SCHEME_UNSPECIFIED", 1: "HTTP_SECURITY_SCHEME_SCHEME_BASIC", 3: "HTTP_SECURITY_SCHEME_SCHEME_BEARER", 4: "HTTP_SECURITY_SCHEME_SCHEME_DIGEST", 5: "HTTP_SECURITY_SCHEME_SCHEME_OAUTH", } HttpSecuritySchemeScheme_value = map[string]int32{ "HTTP_SECURITY_SCHEME_SCHEME_UNSPECIFIED": 0, "HTTP_SECURITY_SCHEME_SCHEME_BASIC": 1, "HTTP_SECURITY_SCHEME_SCHEME_BEARER": 3, "HTTP_SECURITY_SCHEME_SCHEME_DIGEST": 4, "HTTP_SECURITY_SCHEME_SCHEME_OAUTH": 5, } )
Enum value maps for HttpSecuritySchemeScheme.
var ( HttpSecuritySchemeBearerFormat_name = map[int32]string{ 0: "HTTP_SECURITY_SCHEME_BEARER_FORMAT_UNSPECIFIED", 1: "HTTP_SECURITY_SCHEME_BEARER_FORMAT_JWT", } HttpSecuritySchemeBearerFormat_value = map[string]int32{ "HTTP_SECURITY_SCHEME_BEARER_FORMAT_UNSPECIFIED": 0, "HTTP_SECURITY_SCHEME_BEARER_FORMAT_JWT": 1, } )
Enum value maps for HttpSecuritySchemeBearerFormat.
var ( HttpFieldLocation_name = map[int32]string{ 0: "HTTP_FIELD_LOCATION_BODY", 1: "HTTP_FIELD_LOCATION_HEADER", 2: "HTTP_FIELD_LOCATION_PATH", 3: "HTTP_FIELD_LOCATION_QUERY", } HttpFieldLocation_value = map[string]int32{ "HTTP_FIELD_LOCATION_BODY": 0, "HTTP_FIELD_LOCATION_HEADER": 1, "HTTP_FIELD_LOCATION_PATH": 2, "HTTP_FIELD_LOCATION_QUERY": 3, } )
Enum value maps for HttpFieldLocation.
var ( ResponseCode_name = map[int32]string{ 0: "RESPONSE_CODE_OK", 1: "RESPONSE_CODE_NOT_FOUND", 2: "RESPONSE_CODE_UNAUTHORIZED", 3: "RESPONSE_CODE_BAD_REQUEST", 4: "RESPONSE_CODE_PRECONDITION_FAILED", 5: "RESPONSE_CODE_INTERNAL_ERROR", 6: "RESPONSE_CODE_CREATED", } ResponseCode_value = map[string]int32{ "RESPONSE_CODE_OK": 0, "RESPONSE_CODE_NOT_FOUND": 1, "RESPONSE_CODE_UNAUTHORIZED": 2, "RESPONSE_CODE_BAD_REQUEST": 3, "RESPONSE_CODE_PRECONDITION_FAILED": 4, "RESPONSE_CODE_INTERNAL_ERROR": 5, "RESPONSE_CODE_CREATED": 6, } )
Enum value maps for ResponseCode.
var ( PropertyFormat_name = map[int32]string{ 0: "PROPERTY_FORMAT_UNSPECIFIED", 1: "PROPERTY_FORMAT_INT32", 2: "PROPERTY_FORMAT_INT64", 3: "PROPERTY_FORMAT_FLOAT", 4: "PROPERTY_FORMAT_DOUBLE", 5: "PROPERTY_FORMAT_BYTE", 6: "PROPERTY_FORMAT_BINARY", 7: "PROPERTY_FORMAT_DATE", 8: "PROPERTY_FORMAT_DATE_TIME", 9: "PROPERTY_FORMAT_PASSWORD", 10: "PROPERTY_FORMAT_STRING", } PropertyFormat_value = map[string]int32{ "PROPERTY_FORMAT_UNSPECIFIED": 0, "PROPERTY_FORMAT_INT32": 1, "PROPERTY_FORMAT_INT64": 2, "PROPERTY_FORMAT_FLOAT": 3, "PROPERTY_FORMAT_DOUBLE": 4, "PROPERTY_FORMAT_BYTE": 5, "PROPERTY_FORMAT_BINARY": 6, "PROPERTY_FORMAT_DATE": 7, "PROPERTY_FORMAT_DATE_TIME": 8, "PROPERTY_FORMAT_PASSWORD": 9, "PROPERTY_FORMAT_STRING": 10, } )
Enum value maps for PropertyFormat.
var ( // Sets the title of the OpenAPI document generated when parsing the protobuf // spec. // // optional string title = 66041; E_Title = &file_pocket_openapi_proto_extTypes[0] // Sets the version of the OpenAPI document generated when parsing the // protobuf spec. // // optional string version = 66042; E_Version = &file_pocket_openapi_proto_extTypes[1] // Defines one or more servers to be used inside the OpenAPI document. // // repeated pocket.openapi.OpenapiServer server = 66043; E_Server = &file_pocket_openapi_proto_extTypes[2] )
Extension fields to descriptorpb.FileOptions.
var ( // Sets the microservice name inside the pocket framework environment. // // optional string app_name = 56041; E_AppName = &file_pocket_proto_extTypes[0] )
Extension fields to descriptorpb.FileOptions.
var (
// optional pocket.service.Database database = 56041;
E_Database = &file_pocket_proto_extTypes[1]
)
Extension fields to descriptorpb.FieldOptions.
var (
// optional pocket.http.HttpFieldProperty field_definitions = 76041;
E_FieldDefinitions = &file_pocket_http_proto_extTypes[2]
)
Extension fields to descriptorpb.FieldOptions.
var (
// optional pocket.openapi.OpenapiMessage message = 66041;
E_Message = &file_pocket_openapi_proto_extTypes[4]
)
Extension fields to descriptorpb.MessageOptions.
var (
// optional pocket.http.HttpMethod method_definitions = 76041;
E_MethodDefinitions = &file_pocket_http_proto_extTypes[1]
)
Extension fields to descriptorpb.MethodOptions.
var (
// optional pocket.openapi.OpenapiMethod operation = 66041;
E_Operation = &file_pocket_openapi_proto_extTypes[3]
)
Extension fields to descriptorpb.MethodOptions.
var (
// optional pocket.openapi.Property property = 66041;
E_Property = &file_pocket_openapi_proto_extTypes[5]
)
Extension fields to descriptorpb.FieldOptions.
var (
// optional pocket.http.HttpService service_definitions = 76041;
E_ServiceDefinitions = &file_pocket_http_proto_extTypes[0]
)
Extension fields to descriptorpb.ServiceOptions.
var File_pocket_http_proto protoreflect.FileDescriptor
var File_pocket_openapi_proto protoreflect.FileDescriptor
var File_pocket_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Database ¶
type Database struct { Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // contains filtered or unexported fields }
func (*Database) Descriptor
deprecated
func (*Database) ProtoMessage ¶
func (*Database) ProtoMessage()
func (*Database) ProtoReflect ¶
func (x *Database) ProtoReflect() protoreflect.Message
type HttpFieldLocation ¶
type HttpFieldLocation int32
Supported location of a property inside a request.
const ( HttpFieldLocation_HTTP_FIELD_LOCATION_BODY HttpFieldLocation = 0 HttpFieldLocation_HTTP_FIELD_LOCATION_HEADER HttpFieldLocation = 1 HttpFieldLocation_HTTP_FIELD_LOCATION_PATH HttpFieldLocation = 2 HttpFieldLocation_HTTP_FIELD_LOCATION_QUERY HttpFieldLocation = 3 )
func (HttpFieldLocation) Descriptor ¶
func (HttpFieldLocation) Descriptor() protoreflect.EnumDescriptor
func (HttpFieldLocation) Enum ¶
func (x HttpFieldLocation) Enum() *HttpFieldLocation
func (HttpFieldLocation) EnumDescriptor
deprecated
func (HttpFieldLocation) EnumDescriptor() ([]byte, []int)
Deprecated: Use HttpFieldLocation.Descriptor instead.
func (HttpFieldLocation) Number ¶
func (x HttpFieldLocation) Number() protoreflect.EnumNumber
func (HttpFieldLocation) String ¶
func (x HttpFieldLocation) String() string
func (HttpFieldLocation) Type ¶
func (HttpFieldLocation) Type() protoreflect.EnumType
func (*HttpFieldLocation) UnmarshalJSON
deprecated
func (x *HttpFieldLocation) UnmarshalJSON(b []byte) error
Deprecated: Do not use.
type HttpFieldProperty ¶
type HttpFieldProperty struct { Location *HttpFieldLocation `protobuf:"varint,1,opt,name=location,enum=pocket.http.HttpFieldLocation" json:"location,omitempty"` // contains filtered or unexported fields }
func (*HttpFieldProperty) Descriptor
deprecated
func (*HttpFieldProperty) Descriptor() ([]byte, []int)
Deprecated: Use HttpFieldProperty.ProtoReflect.Descriptor instead.
func (*HttpFieldProperty) GetLocation ¶
func (x *HttpFieldProperty) GetLocation() HttpFieldLocation
func (*HttpFieldProperty) ProtoMessage ¶
func (*HttpFieldProperty) ProtoMessage()
func (*HttpFieldProperty) ProtoReflect ¶
func (x *HttpFieldProperty) ProtoReflect() protoreflect.Message
func (*HttpFieldProperty) Reset ¶
func (x *HttpFieldProperty) Reset()
func (*HttpFieldProperty) String ¶
func (x *HttpFieldProperty) String() string
type HttpMethod ¶
type HttpMethod struct { NoAuth *bool `protobuf:"varint,1,opt,name=no_auth,json=noAuth" json:"no_auth,omitempty"` Scope []string `protobuf:"bytes,2,rep,name=scope" json:"scope,omitempty"` Header []*HttpParameter `protobuf:"bytes,3,rep,name=header" json:"header,omitempty"` // contains filtered or unexported fields }
func (*HttpMethod) Descriptor
deprecated
func (*HttpMethod) Descriptor() ([]byte, []int)
Deprecated: Use HttpMethod.ProtoReflect.Descriptor instead.
func (*HttpMethod) GetHeader ¶
func (x *HttpMethod) GetHeader() []*HttpParameter
func (*HttpMethod) GetNoAuth ¶
func (x *HttpMethod) GetNoAuth() bool
func (*HttpMethod) GetScope ¶
func (x *HttpMethod) GetScope() []string
func (*HttpMethod) ProtoMessage ¶
func (*HttpMethod) ProtoMessage()
func (*HttpMethod) ProtoReflect ¶
func (x *HttpMethod) ProtoReflect() protoreflect.Message
func (*HttpMethod) Reset ¶
func (x *HttpMethod) Reset()
func (*HttpMethod) String ¶
func (x *HttpMethod) String() string
type HttpParameter ¶
type HttpParameter struct { Name *string `protobuf:"bytes,1,req,name=name" json:"name,omitempty"` MemberName *string `protobuf:"bytes,2,req,name=member_name,json=memberName" json:"member_name,omitempty"` Type *HttpParameterType `protobuf:"varint,3,opt,name=type,enum=pocket.http.HttpParameterType" json:"type,omitempty"` Required *bool `protobuf:"varint,4,opt,name=required" json:"required,omitempty"` // contains filtered or unexported fields }
func (*HttpParameter) Descriptor
deprecated
func (*HttpParameter) Descriptor() ([]byte, []int)
Deprecated: Use HttpParameter.ProtoReflect.Descriptor instead.
func (*HttpParameter) GetMemberName ¶
func (x *HttpParameter) GetMemberName() string
func (*HttpParameter) GetName ¶
func (x *HttpParameter) GetName() string
func (*HttpParameter) GetRequired ¶
func (x *HttpParameter) GetRequired() bool
func (*HttpParameter) GetType ¶
func (x *HttpParameter) GetType() HttpParameterType
func (*HttpParameter) ProtoMessage ¶
func (*HttpParameter) ProtoMessage()
func (*HttpParameter) ProtoReflect ¶
func (x *HttpParameter) ProtoReflect() protoreflect.Message
func (*HttpParameter) Reset ¶
func (x *HttpParameter) Reset()
func (*HttpParameter) String ¶
func (x *HttpParameter) String() string
type HttpParameterType ¶
type HttpParameterType int32
const ( HttpParameterType_HTTP_PARAMETER_TYPE_UNSPECIFIED HttpParameterType = 0 HttpParameterType_HTTP_PARAMETER_TYPE_STRING HttpParameterType = 1 HttpParameterType_HTTP_PARAMETER_TYPE_NUMBER HttpParameterType = 2 )
func (HttpParameterType) Descriptor ¶
func (HttpParameterType) Descriptor() protoreflect.EnumDescriptor
func (HttpParameterType) Enum ¶
func (x HttpParameterType) Enum() *HttpParameterType
func (HttpParameterType) EnumDescriptor
deprecated
func (HttpParameterType) EnumDescriptor() ([]byte, []int)
Deprecated: Use HttpParameterType.Descriptor instead.
func (HttpParameterType) Number ¶
func (x HttpParameterType) Number() protoreflect.EnumNumber
func (HttpParameterType) String ¶
func (x HttpParameterType) String() string
func (HttpParameterType) Type ¶
func (HttpParameterType) Type() protoreflect.EnumType
func (*HttpParameterType) UnmarshalJSON
deprecated
func (x *HttpParameterType) UnmarshalJSON(b []byte) error
Deprecated: Do not use.
type HttpSecurityScheme ¶
type HttpSecurityScheme struct { Type *HttpSecuritySchemeType `protobuf:"varint,1,req,name=type,enum=pocket.http.HttpSecuritySchemeType" json:"type,omitempty"` Description *string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"` Name *string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"` In *string `protobuf:"bytes,4,opt,name=in" json:"in,omitempty"` Scheme *HttpSecuritySchemeScheme `protobuf:"varint,5,opt,name=scheme,enum=pocket.http.HttpSecuritySchemeScheme" json:"scheme,omitempty"` BearerFormat *HttpSecuritySchemeBearerFormat `` /* 139-byte string literal not displayed */ // contains filtered or unexported fields }
func (*HttpSecurityScheme) Descriptor
deprecated
func (*HttpSecurityScheme) Descriptor() ([]byte, []int)
Deprecated: Use HttpSecurityScheme.ProtoReflect.Descriptor instead.
func (*HttpSecurityScheme) GetBearerFormat ¶
func (x *HttpSecurityScheme) GetBearerFormat() HttpSecuritySchemeBearerFormat
func (*HttpSecurityScheme) GetDescription ¶
func (x *HttpSecurityScheme) GetDescription() string
func (*HttpSecurityScheme) GetIn ¶
func (x *HttpSecurityScheme) GetIn() string
func (*HttpSecurityScheme) GetName ¶
func (x *HttpSecurityScheme) GetName() string
func (*HttpSecurityScheme) GetScheme ¶
func (x *HttpSecurityScheme) GetScheme() HttpSecuritySchemeScheme
func (*HttpSecurityScheme) GetType ¶
func (x *HttpSecurityScheme) GetType() HttpSecuritySchemeType
func (*HttpSecurityScheme) ProtoMessage ¶
func (*HttpSecurityScheme) ProtoMessage()
func (*HttpSecurityScheme) ProtoReflect ¶
func (x *HttpSecurityScheme) ProtoReflect() protoreflect.Message
func (*HttpSecurityScheme) Reset ¶
func (x *HttpSecurityScheme) Reset()
func (*HttpSecurityScheme) String ¶
func (x *HttpSecurityScheme) String() string
type HttpSecuritySchemeBearerFormat ¶
type HttpSecuritySchemeBearerFormat int32
const ( HttpSecuritySchemeBearerFormat_HTTP_SECURITY_SCHEME_BEARER_FORMAT_UNSPECIFIED HttpSecuritySchemeBearerFormat = 0 HttpSecuritySchemeBearerFormat_HTTP_SECURITY_SCHEME_BEARER_FORMAT_JWT HttpSecuritySchemeBearerFormat = 1 )
func (HttpSecuritySchemeBearerFormat) Descriptor ¶
func (HttpSecuritySchemeBearerFormat) Descriptor() protoreflect.EnumDescriptor
func (HttpSecuritySchemeBearerFormat) Enum ¶
func (x HttpSecuritySchemeBearerFormat) Enum() *HttpSecuritySchemeBearerFormat
func (HttpSecuritySchemeBearerFormat) EnumDescriptor
deprecated
func (HttpSecuritySchemeBearerFormat) EnumDescriptor() ([]byte, []int)
Deprecated: Use HttpSecuritySchemeBearerFormat.Descriptor instead.
func (HttpSecuritySchemeBearerFormat) Number ¶
func (x HttpSecuritySchemeBearerFormat) Number() protoreflect.EnumNumber
func (HttpSecuritySchemeBearerFormat) String ¶
func (x HttpSecuritySchemeBearerFormat) String() string
func (HttpSecuritySchemeBearerFormat) Type ¶
func (HttpSecuritySchemeBearerFormat) Type() protoreflect.EnumType
func (*HttpSecuritySchemeBearerFormat) UnmarshalJSON
deprecated
func (x *HttpSecuritySchemeBearerFormat) UnmarshalJSON(b []byte) error
Deprecated: Do not use.
type HttpSecuritySchemeScheme ¶
type HttpSecuritySchemeScheme int32
const ( HttpSecuritySchemeScheme_HTTP_SECURITY_SCHEME_SCHEME_UNSPECIFIED HttpSecuritySchemeScheme = 0 HttpSecuritySchemeScheme_HTTP_SECURITY_SCHEME_SCHEME_BASIC HttpSecuritySchemeScheme = 1 HttpSecuritySchemeScheme_HTTP_SECURITY_SCHEME_SCHEME_BEARER HttpSecuritySchemeScheme = 3 HttpSecuritySchemeScheme_HTTP_SECURITY_SCHEME_SCHEME_DIGEST HttpSecuritySchemeScheme = 4 HttpSecuritySchemeScheme_HTTP_SECURITY_SCHEME_SCHEME_OAUTH HttpSecuritySchemeScheme = 5 )
func (HttpSecuritySchemeScheme) Descriptor ¶
func (HttpSecuritySchemeScheme) Descriptor() protoreflect.EnumDescriptor
func (HttpSecuritySchemeScheme) Enum ¶
func (x HttpSecuritySchemeScheme) Enum() *HttpSecuritySchemeScheme
func (HttpSecuritySchemeScheme) EnumDescriptor
deprecated
func (HttpSecuritySchemeScheme) EnumDescriptor() ([]byte, []int)
Deprecated: Use HttpSecuritySchemeScheme.Descriptor instead.
func (HttpSecuritySchemeScheme) Number ¶
func (x HttpSecuritySchemeScheme) Number() protoreflect.EnumNumber
func (HttpSecuritySchemeScheme) String ¶
func (x HttpSecuritySchemeScheme) String() string
func (HttpSecuritySchemeScheme) Type ¶
func (HttpSecuritySchemeScheme) Type() protoreflect.EnumType
func (*HttpSecuritySchemeScheme) UnmarshalJSON
deprecated
func (x *HttpSecuritySchemeScheme) UnmarshalJSON(b []byte) error
Deprecated: Do not use.
type HttpSecuritySchemeType ¶
type HttpSecuritySchemeType int32
const ( HttpSecuritySchemeType_HTTP_SECURITY_SCHEME_UNSPECIFIED HttpSecuritySchemeType = 0 HttpSecuritySchemeType_HTTP_SECURITY_SCHEME_API_KEY HttpSecuritySchemeType = 1 HttpSecuritySchemeType_HTTP_SECURITY_SCHEME_HTTP HttpSecuritySchemeType = 2 HttpSecuritySchemeType_HTTP_SECURITY_SCHEME_OAUTH2 HttpSecuritySchemeType = 3 HttpSecuritySchemeType_HTTP_SECURITY_SCHEME_OPEN_ID_CONNECT HttpSecuritySchemeType = 4 )
func (HttpSecuritySchemeType) Descriptor ¶
func (HttpSecuritySchemeType) Descriptor() protoreflect.EnumDescriptor
func (HttpSecuritySchemeType) Enum ¶
func (x HttpSecuritySchemeType) Enum() *HttpSecuritySchemeType
func (HttpSecuritySchemeType) EnumDescriptor
deprecated
func (HttpSecuritySchemeType) EnumDescriptor() ([]byte, []int)
Deprecated: Use HttpSecuritySchemeType.Descriptor instead.
func (HttpSecuritySchemeType) Number ¶
func (x HttpSecuritySchemeType) Number() protoreflect.EnumNumber
func (HttpSecuritySchemeType) String ¶
func (x HttpSecuritySchemeType) String() string
func (HttpSecuritySchemeType) Type ¶
func (HttpSecuritySchemeType) Type() protoreflect.EnumType
func (*HttpSecuritySchemeType) UnmarshalJSON
deprecated
func (x *HttpSecuritySchemeType) UnmarshalJSON(b []byte) error
Deprecated: Do not use.
type HttpService ¶
type HttpService struct { Header []*HttpParameter `protobuf:"bytes,1,rep,name=header" json:"header,omitempty"` SecurityScheme *HttpSecurityScheme `protobuf:"bytes,2,opt,name=security_scheme,json=securityScheme" json:"security_scheme,omitempty"` // contains filtered or unexported fields }
func (*HttpService) Descriptor
deprecated
func (*HttpService) Descriptor() ([]byte, []int)
Deprecated: Use HttpService.ProtoReflect.Descriptor instead.
func (*HttpService) GetHeader ¶
func (x *HttpService) GetHeader() []*HttpParameter
func (*HttpService) GetSecurityScheme ¶
func (x *HttpService) GetSecurityScheme() *HttpSecurityScheme
func (*HttpService) ProtoMessage ¶
func (*HttpService) ProtoMessage()
func (*HttpService) ProtoReflect ¶
func (x *HttpService) ProtoReflect() protoreflect.Message
func (*HttpService) Reset ¶
func (x *HttpService) Reset()
func (*HttpService) String ¶
func (x *HttpService) String() string
type OpenapiMessage ¶
type OpenapiMessage struct { Operation *Operation `protobuf:"bytes,1,req,name=operation" json:"operation,omitempty"` // contains filtered or unexported fields }
func (*OpenapiMessage) Descriptor
deprecated
func (*OpenapiMessage) Descriptor() ([]byte, []int)
Deprecated: Use OpenapiMessage.ProtoReflect.Descriptor instead.
func (*OpenapiMessage) GetOperation ¶
func (x *OpenapiMessage) GetOperation() *Operation
func (*OpenapiMessage) ProtoMessage ¶
func (*OpenapiMessage) ProtoMessage()
func (*OpenapiMessage) ProtoReflect ¶
func (x *OpenapiMessage) ProtoReflect() protoreflect.Message
func (*OpenapiMessage) Reset ¶
func (x *OpenapiMessage) Reset()
func (*OpenapiMessage) String ¶
func (x *OpenapiMessage) String() string
type OpenapiMethod ¶
type OpenapiMethod struct { Summary *string `protobuf:"bytes,1,req,name=summary" json:"summary,omitempty"` Description *string `protobuf:"bytes,2,req,name=description" json:"description,omitempty"` Tags []string `protobuf:"bytes,3,rep,name=tags" json:"tags,omitempty"` Response []*Response `protobuf:"bytes,4,rep,name=response" json:"response,omitempty"` // contains filtered or unexported fields }
func (*OpenapiMethod) Descriptor
deprecated
func (*OpenapiMethod) Descriptor() ([]byte, []int)
Deprecated: Use OpenapiMethod.ProtoReflect.Descriptor instead.
func (*OpenapiMethod) GetDescription ¶
func (x *OpenapiMethod) GetDescription() string
func (*OpenapiMethod) GetResponse ¶
func (x *OpenapiMethod) GetResponse() []*Response
func (*OpenapiMethod) GetSummary ¶
func (x *OpenapiMethod) GetSummary() string
func (*OpenapiMethod) GetTags ¶
func (x *OpenapiMethod) GetTags() []string
func (*OpenapiMethod) ProtoMessage ¶
func (*OpenapiMethod) ProtoMessage()
func (*OpenapiMethod) ProtoReflect ¶
func (x *OpenapiMethod) ProtoReflect() protoreflect.Message
func (*OpenapiMethod) Reset ¶
func (x *OpenapiMethod) Reset()
func (*OpenapiMethod) String ¶
func (x *OpenapiMethod) String() string
type OpenapiServer ¶
type OpenapiServer struct { // url sets the server URL. Url *string `protobuf:"bytes,1,req,name=url" json:"url,omitempty"` // description sets a custom text to describe in a few words the server. Description *string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"` // contains filtered or unexported fields }
OpenapiServer defines information that a server to be used by the OpenAPI document must have.
func (*OpenapiServer) Descriptor
deprecated
func (*OpenapiServer) Descriptor() ([]byte, []int)
Deprecated: Use OpenapiServer.ProtoReflect.Descriptor instead.
func (*OpenapiServer) GetDescription ¶
func (x *OpenapiServer) GetDescription() string
func (*OpenapiServer) GetUrl ¶
func (x *OpenapiServer) GetUrl() string
func (*OpenapiServer) ProtoMessage ¶
func (*OpenapiServer) ProtoMessage()
func (*OpenapiServer) ProtoReflect ¶
func (x *OpenapiServer) ProtoReflect() protoreflect.Message
func (*OpenapiServer) Reset ¶
func (x *OpenapiServer) Reset()
func (*OpenapiServer) String ¶
func (x *OpenapiServer) String() string
type Operation ¶
type Operation struct { RequestBody *RequestBody `protobuf:"bytes,1,req,name=request_body,json=requestBody" json:"request_body,omitempty"` // contains filtered or unexported fields }
func (*Operation) Descriptor
deprecated
func (*Operation) GetRequestBody ¶
func (x *Operation) GetRequestBody() *RequestBody
func (*Operation) ProtoMessage ¶
func (*Operation) ProtoMessage()
func (*Operation) ProtoReflect ¶
func (x *Operation) ProtoReflect() protoreflect.Message
type Property ¶
type Property struct { Description *string `protobuf:"bytes,1,req,name=description" json:"description,omitempty"` Example *string `protobuf:"bytes,2,opt,name=example" json:"example,omitempty"` Format *PropertyFormat `protobuf:"varint,3,opt,name=format,enum=pocket.openapi.PropertyFormat" json:"format,omitempty"` Required *bool `protobuf:"varint,4,opt,name=required" json:"required,omitempty"` HideFromSchema *bool `protobuf:"varint,5,opt,name=hide_from_schema,json=hideFromSchema" json:"hide_from_schema,omitempty"` // contains filtered or unexported fields }
func (*Property) Descriptor
deprecated
func (*Property) GetDescription ¶
func (*Property) GetExample ¶
func (*Property) GetFormat ¶
func (x *Property) GetFormat() PropertyFormat
func (*Property) GetHideFromSchema ¶
func (*Property) GetRequired ¶
func (*Property) ProtoMessage ¶
func (*Property) ProtoMessage()
func (*Property) ProtoReflect ¶
func (x *Property) ProtoReflect() protoreflect.Message
type PropertyFormat ¶
type PropertyFormat int32
Supported formats of a property.
const ( PropertyFormat_PROPERTY_FORMAT_UNSPECIFIED PropertyFormat = 0 PropertyFormat_PROPERTY_FORMAT_INT32 PropertyFormat = 1 PropertyFormat_PROPERTY_FORMAT_INT64 PropertyFormat = 2 PropertyFormat_PROPERTY_FORMAT_FLOAT PropertyFormat = 3 PropertyFormat_PROPERTY_FORMAT_DOUBLE PropertyFormat = 4 PropertyFormat_PROPERTY_FORMAT_BYTE PropertyFormat = 5 PropertyFormat_PROPERTY_FORMAT_BINARY PropertyFormat = 6 PropertyFormat_PROPERTY_FORMAT_DATE PropertyFormat = 7 PropertyFormat_PROPERTY_FORMAT_DATE_TIME PropertyFormat = 8 PropertyFormat_PROPERTY_FORMAT_PASSWORD PropertyFormat = 9 PropertyFormat_PROPERTY_FORMAT_STRING PropertyFormat = 10 )
func (PropertyFormat) Descriptor ¶
func (PropertyFormat) Descriptor() protoreflect.EnumDescriptor
func (PropertyFormat) Enum ¶
func (x PropertyFormat) Enum() *PropertyFormat
func (PropertyFormat) EnumDescriptor
deprecated
func (PropertyFormat) EnumDescriptor() ([]byte, []int)
Deprecated: Use PropertyFormat.Descriptor instead.
func (PropertyFormat) Number ¶
func (x PropertyFormat) Number() protoreflect.EnumNumber
func (PropertyFormat) String ¶
func (x PropertyFormat) String() string
func (PropertyFormat) Type ¶
func (PropertyFormat) Type() protoreflect.EnumType
func (*PropertyFormat) UnmarshalJSON
deprecated
func (x *PropertyFormat) UnmarshalJSON(b []byte) error
Deprecated: Do not use.
type RequestBody ¶
type RequestBody struct { Description *string `protobuf:"bytes,1,req,name=description" json:"description,omitempty"` // contains filtered or unexported fields }
func (*RequestBody) Descriptor
deprecated
func (*RequestBody) Descriptor() ([]byte, []int)
Deprecated: Use RequestBody.ProtoReflect.Descriptor instead.
func (*RequestBody) GetDescription ¶
func (x *RequestBody) GetDescription() string
func (*RequestBody) ProtoMessage ¶
func (*RequestBody) ProtoMessage()
func (*RequestBody) ProtoReflect ¶
func (x *RequestBody) ProtoReflect() protoreflect.Message
func (*RequestBody) Reset ¶
func (x *RequestBody) Reset()
func (*RequestBody) String ¶
func (x *RequestBody) String() string
type Response ¶
type Response struct { Code *ResponseCode `protobuf:"varint,1,req,name=code,enum=pocket.openapi.ResponseCode" json:"code,omitempty"` Description *string `protobuf:"bytes,2,req,name=description" json:"description,omitempty"` // contains filtered or unexported fields }
func (*Response) Descriptor
deprecated
func (*Response) GetCode ¶
func (x *Response) GetCode() ResponseCode
func (*Response) GetDescription ¶
func (*Response) ProtoMessage ¶
func (*Response) ProtoMessage()
func (*Response) ProtoReflect ¶
func (x *Response) ProtoReflect() protoreflect.Message
type ResponseCode ¶
type ResponseCode int32
All supported HTTP response codes.
const ( ResponseCode_RESPONSE_CODE_OK ResponseCode = 0 ResponseCode_RESPONSE_CODE_NOT_FOUND ResponseCode = 1 ResponseCode_RESPONSE_CODE_UNAUTHORIZED ResponseCode = 2 ResponseCode_RESPONSE_CODE_BAD_REQUEST ResponseCode = 3 ResponseCode_RESPONSE_CODE_PRECONDITION_FAILED ResponseCode = 4 ResponseCode_RESPONSE_CODE_INTERNAL_ERROR ResponseCode = 5 ResponseCode_RESPONSE_CODE_CREATED ResponseCode = 6 )
func (ResponseCode) Descriptor ¶
func (ResponseCode) Descriptor() protoreflect.EnumDescriptor
func (ResponseCode) Enum ¶
func (x ResponseCode) Enum() *ResponseCode
func (ResponseCode) EnumDescriptor
deprecated
func (ResponseCode) EnumDescriptor() ([]byte, []int)
Deprecated: Use ResponseCode.Descriptor instead.
func (ResponseCode) Number ¶
func (x ResponseCode) Number() protoreflect.EnumNumber
func (ResponseCode) String ¶
func (x ResponseCode) String() string
func (ResponseCode) Type ¶
func (ResponseCode) Type() protoreflect.EnumType
func (*ResponseCode) UnmarshalJSON
deprecated
func (x *ResponseCode) UnmarshalJSON(b []byte) error
Deprecated: Do not use.