pocket

Documentation

Index

• func PropertyFormatTrimPrefix(format pocketpb.PropertyFormat) string
• func ResponseCodeToHttpCode(code pocketpb.ResponseCode) string
• type FieldExtensions
  • func GetFieldExtensions(field *descriptor.FieldDescriptorProto) *FieldExtensions
  • func (f *FieldExtensions) PropertyLocation() pocketpb.HttpFieldLocation
• type FileExtensions
  • func GetFileExtensions(file *descriptor.FileDescriptorProto) *FileExtensions
• type HttpEndpointDetails
• type MessageExtensions
  • func GetMessageExtensions(message *descriptor.DescriptorProto) *MessageExtensions
• type MethodExtensions
  • func GetMethodExtensions(method *descriptor.MethodDescriptorProto) *MethodExtensions
  • func (e *MethodExtensions) GetHeaderMemberNames() map[string]string
  • func (e *MethodExtensions) HasKrillHttpExtension() bool
  • func (e *MethodExtensions) HttpMethod() string
  • func (e *MethodExtensions) HttpMethodAndEndpoint() (string, string)
• type ServiceExtensions
  • func GetServiceExtensions(service *descriptor.ServiceDescriptorProto) *ServiceExtensions
  • func (s *ServiceExtensions) GetHeaderMemberNames() map[string]string

Functions

func PropertyFormatTrimPrefix

func PropertyFormatTrimPrefix(format pocketpb.PropertyFormat) string

func ResponseCodeToHttpCode

func ResponseCodeToHttpCode(code pocketpb.ResponseCode) string

Types

type FieldExtensions

type FieldExtensions struct {
	Database *pocketpb.Database
	Openapi  *pocketpb.Property
	Http     *pocketpb.HttpFieldProperty
}

func GetFieldExtensions

func GetFieldExtensions(field *descriptor.FieldDescriptorProto) *FieldExtensions

func (*FieldExtensions) PropertyLocation

func (f *FieldExtensions) PropertyLocation() pocketpb.HttpFieldLocation

type FileExtensions

type FileExtensions struct {
	AppName        string
	OpenapiTitle   string
	OpenapiVersion string
	Servers        []*pocketpb.OpenapiServer
}

func GetFileExtensions

func GetFileExtensions(file *descriptor.FileDescriptorProto) *FileExtensions

type HttpEndpointDetails

type HttpEndpointDetails struct {
	Method     string
	Parameters []string
	Body       string
}

HttpEndpointDetails gathers detailed information about a HTTP endpoint of a method.

type MessageExtensions

type MessageExtensions struct {
	OpenapiMessage *pocketpb.OpenapiMessage
}

func GetMessageExtensions

func GetMessageExtensions(message *descriptor.DescriptorProto) *MessageExtensions

type MethodExtensions

type MethodExtensions struct {
	GoogleApi       *annotations.HttpRule
	Method          *pocketpb.HttpMethod
	OpenapiMethod   *pocketpb.OpenapiMethod
	EndpointDetails *HttpEndpointDetails
}

func GetMethodExtensions

func GetMethodExtensions(method *descriptor.MethodDescriptorProto) *MethodExtensions

func (*MethodExtensions) GetHeaderMemberNames

func (e *MethodExtensions) GetHeaderMemberNames() map[string]string

func (*MethodExtensions) HasKrillHttpExtension

func (e *MethodExtensions) HasKrillHttpExtension() bool

func (*MethodExtensions) HttpMethod

func (e *MethodExtensions) HttpMethod() string

func (*MethodExtensions) HttpMethodAndEndpoint

func (e *MethodExtensions) HttpMethodAndEndpoint() (string, string)

type ServiceExtensions

type ServiceExtensions struct {
	Service *pocketpb.HttpService
}

func GetServiceExtensions

func GetServiceExtensions(service *descriptor.ServiceDescriptorProto) *ServiceExtensions

func (*ServiceExtensions) GetHeaderMemberNames

func (s *ServiceExtensions) GetHeaderMemberNames() map[string]string