util

Documentation

Index

• func AppendComponents(spec *v3.Document, components *v3.Components)
• func AppendStringDedupe(strs []string, str string) []string
• func BoolPtr(b bool) *bool
• func ConvertNodeV3toV4(n *yamlv3.Node) *yaml.Node
• func FormatComments(loc protoreflect.SourceLocation) string
• func FormatOperationComments(loc protoreflect.SourceLocation) (summary string, description string)
• func FormatTypeRef(t string) string
• func IsEmpty(msg protoreflect.MessageDescriptor) bool
• func IsFieldDeprecated(fd protoreflect.FieldDescriptor) *bool
• func IsMethodDeprecated(md protoreflect.MethodDescriptor) *bool
• func IsWellKnown(msg protoreflect.MessageDescriptor) bool
• func MakeFieldName(opts options.Options, fd protoreflect.FieldDescriptor) string
• func MakeMediaTypes(opts options.Options, s *base.SchemaProxy, isRequest, isStreaming bool) *orderedmap.Map[string, *v3.MediaType]
• func MakePath(opts options.Options, main string) string
• func MergeOrAppendParameter(existingParams []*v3.Parameter, newParam *v3.Parameter) []*v3.Parameter
• func MergeParameters(existingParams []*v3.Parameter, newParams []*v3.Parameter) []*v3.Parameter
• func MethodToRequestBody(opts options.Options, method protoreflect.MethodDescriptor, ...) *v3.RequestBody
• func ResolveSchemaRef(ref string) string
• func Singular(plural string) string
• func TypeFieldDescription(opts options.Options, tt protoreflect.FieldDescriptor) string
• type IDSchema
  • func NewGoogleAny() *IDSchema
  • func WellKnownToSchema(msg protoreflect.MessageDescriptor) *IDSchema

Functions

func AppendComponents

func AppendComponents(spec *v3.Document, components *v3.Components)

func AppendStringDedupe

func AppendStringDedupe(strs []string, str string) []string

func BoolPtr

func BoolPtr(b bool) *bool

func ConvertNodeV3toV4

func ConvertNodeV3toV4(n *yamlv3.Node) *yaml.Node

func FormatComments

func FormatComments(loc protoreflect.SourceLocation) string

func FormatOperationComments

func FormatOperationComments(loc protoreflect.SourceLocation) (summary string, description string)

func FormatTypeRef

func FormatTypeRef(t string) string

func IsEmpty

func IsEmpty(msg protoreflect.MessageDescriptor) bool

func IsFieldDeprecated

func IsFieldDeprecated(fd protoreflect.FieldDescriptor) *bool

func IsMethodDeprecated

func IsMethodDeprecated(md protoreflect.MethodDescriptor) *bool

func IsWellKnown

func IsWellKnown(msg protoreflect.MessageDescriptor) bool

func MakeFieldName

func MakeFieldName(opts options.Options, fd protoreflect.FieldDescriptor) string

func MakeMediaTypes

func MakeMediaTypes(opts options.Options, s *base.SchemaProxy, isRequest, isStreaming bool) *orderedmap.Map[string, *v3.MediaType]

MakeMediaTypes generates media types with references to the bodies

func MakePath

func MakePath(opts options.Options, main string) string

func MergeOrAppendParameter

func MergeOrAppendParameter(existingParams []*v3.Parameter, newParam *v3.Parameter) []*v3.Parameter

MergeOrAppendParameter merges or appends a parameter to a list of parameters.

func MergeParameters

func MergeParameters(existingParams []*v3.Parameter, newParams []*v3.Parameter) []*v3.Parameter

MergeParameters merges new parameters into existing parameters. It uses a map to efficiently check for duplicates and merge properties.

func MethodToRequestBody

func MethodToRequestBody(opts options.Options, method protoreflect.MethodDescriptor, s *base.SchemaProxy, isStreaming bool) *v3.RequestBody

func ResolveSchemaRef

func ResolveSchemaRef(ref string) string

ResolveSchemaRef takes a reference string and determines if it is a fully qualified protobuf message name. If so, it converts it to a valid OpenAPI schema reference. Otherwise, it returns the original string.

func Singular

func Singular(plural string) string

Singular returns the singular form of a given plural noun. .

func TypeFieldDescription

func TypeFieldDescription(opts options.Options, tt protoreflect.FieldDescriptor) string

Types

type IDSchema

type IDSchema struct {
	ID     string
	Schema *base.Schema
}

func NewGoogleAny

func NewGoogleAny() *IDSchema

func WellKnownToSchema

func WellKnownToSchema(msg protoreflect.MessageDescriptor) *IDSchema