sourceinfo

Documentation

Index

• func ExtractAPIOptions(meth *descriptorpb.MethodDescriptorProto) (*options.HttpRule, error)
• func ExtractOpenApiFieldOptions(field *descriptorpb.FieldDescriptorProto) (*openapi_v3.Schema, error)
• func ExtractOpenApiMessageOptions(message *descriptorpb.DescriptorProto) (*openapi_v3.Schema, error)
• type ApiOptionInfo
• type EnumInfo
• type FieldInfo
• type MessageInfo
• type MethodInfo
• type ServiceInfo
• type SourceInfo
  • func GetSourceInfo(descr *descriptorpb.FileDescriptorProto) SourceInfo
• type ValueInfo

Functions

func ExtractAPIOptions

func ExtractAPIOptions(meth *descriptorpb.MethodDescriptorProto) (*options.HttpRule, error)

Extract the google.api.http option more details here vendor/google.golang.org/genproto/googleapis/api/annotations/http.pb.go

func ExtractOpenApiFieldOptions

func ExtractOpenApiFieldOptions(field *descriptorpb.FieldDescriptorProto) (*openapi_v3.Schema, error)

func ExtractOpenApiMessageOptions

func ExtractOpenApiMessageOptions(message *descriptorpb.DescriptorProto) (*openapi_v3.Schema, error)

Types

type ApiOptionInfo

type ApiOptionInfo struct {
	Info       *descriptorpb.SourceCodeInfo_Location
	ApiOptions *options.HttpRule
}

type EnumInfo

type EnumInfo struct {
	Name       string
	Info       *descriptorpb.SourceCodeInfo_Location
	ValuesInfo []ValueInfo
	AllowAlias bool
	Message    descriptorpb.EnumDescriptorProto
	Package    string
}

type FieldInfo

type FieldInfo struct {
	Name              string
	Info              *descriptorpb.SourceCodeInfo_Location
	Field             *descriptorpb.FieldDescriptorProto
	Message           *descriptorpb.DescriptorProto
	Package           string
	OpenApiProperties *openapi_v3.Schema
}

type MessageInfo

type MessageInfo struct {
	Name           string
	Info           *descriptorpb.SourceCodeInfo_Location
	FieldInfos     []FieldInfo
	Message        descriptorpb.DescriptorProto
	Package        string
	OpenApiSchema  *openapi_v3.Schema
	NestedMessages []MessageInfo
	ParentOfNested *MessageInfo
}

type MethodInfo

type MethodInfo struct {
	Name     string
	Info     *descriptorpb.SourceCodeInfo_Location
	Method   *descriptorpb.MethodDescriptorProto
	Service  *descriptorpb.ServiceDescriptorProto // link the parent service
	HttpRule *ApiOptionInfo
}

type ServiceInfo

type ServiceInfo struct {
	Name    string
	Info    *descriptorpb.SourceCodeInfo_Location
	Service *descriptorpb.ServiceDescriptorProto
	Methods []MethodInfo
	Package string
}

type SourceInfo

type SourceInfo struct {
	Messages            []MessageInfo
	InlineMessages      []MessageInfo
	Enums               []EnumInfo
	InlineEnums         []EnumInfo
	Services            []ServiceInfo
	FileDescriptorProto *descriptorpb.FileDescriptorProto
	Package             string
	Path                string //  path without the file
}

func GetSourceInfo

func GetSourceInfo(descr *descriptorpb.FileDescriptorProto) SourceInfo

type ValueInfo

type ValueInfo struct {
	Name  string
	Value int32
	Info  *descriptorpb.SourceCodeInfo_Location
}