proto

Documentation

Index

• func CompileProtos(goModule, moduleName, protoDir string, protocOptions collector.ProtocOptions, ...) ([]*collector.DescriptorWithPath, error)
• type FieldOptions
• type FileOptions
• type MessageOptions
• type Options
  • func ParseOptions(fileDescriptors []*collector.DescriptorWithPath) (Options, error)
  • func (o Options) GetUnstructuredFields(protoPkg string, rootMessage string) ([][]string, error)

Functions

func CompileProtos

func CompileProtos(goModule, moduleName, protoDir string, protocOptions collector.ProtocOptions, customGoArgs []string) ([]*collector.DescriptorWithPath, error)

make sure the pkg matches the go_package option in the proto TODO: validate this

Types

type FieldOptions

type FieldOptions struct {
	Field *descriptor.FieldDescriptorProto

	OpenAPIValidationDisabled bool
}

options for a field

type FileOptions

type FileOptions struct {
	File     *collector.DescriptorWithPath
	Messages []MessageOptions
}

a representation of set of parsed options for a given File's descriptor

type MessageOptions

type MessageOptions struct {
	Message        *descriptor.DescriptorProto
	Fields         []FieldOptions
	NestedMessages []MessageOptions
}

options for a message

type Options

type Options []FileOptions

a representation of set of parsed options for a given File's descriptor

func ParseOptions

func ParseOptions(fileDescriptors []*collector.DescriptorWithPath) (Options, error)

func (Options) GetUnstructuredFields

func (o Options) GetUnstructuredFields(protoPkg string, rootMessage string) ([][]string, error)

GetUnstructuredFields gets the full list of unstructured fields contained within a given message. This function returns each field as an array of path elements, which is the fully expanded index of the field as measured from the root message. For example, given a message with the given structure:

// root level message

message MyCRDSpec {
    Options options = 1;
}

message Options {
    UnstructuredType unstructured_option = 1;
}

message RecursiveType {
    RecursiveType recursive_field = 1 [(cue.opt).disable_openapi_validation = true];
    repeated RecursiveType repeated_recursive_field = 2 [(cue.opt).disable_openapi_validation = true];
}

The unstructured fields of `MyCRDSpec` would be returned as: - ["MyCRDSpec", "options", "recursiveField"] - ["MyCRDSpec", "options", "repeatedRecursiveField"]