options

Documentation

Index

• Variables
• type APIOptions
  • func (*APIOptions) Descriptor() ([]byte, []int)
  • func (x *APIOptions) GetDescription() string
  • func (x *APIOptions) GetMethod() string
  • func (x *APIOptions) GetPath() string
  • func (x *APIOptions) GetQueryParams() []*QueryParameter
  • func (x *APIOptions) GetSummary() string
  • func (*APIOptions) ProtoMessage()
  • func (x *APIOptions) ProtoReflect() protoreflect.Message
  • func (x *APIOptions) Reset()
  • func (x *APIOptions) String() string
• type QueryParameter
  • func (*QueryParameter) Descriptor() ([]byte, []int)
  • func (x *QueryParameter) GetDescription() string
  • func (x *QueryParameter) GetName() string
  • func (x *QueryParameter) GetRequired() bool
  • func (x *QueryParameter) GetType() string
  • func (*QueryParameter) ProtoMessage()
  • func (x *QueryParameter) ProtoReflect() protoreflect.Message
  • func (x *QueryParameter) Reset()
  • func (x *QueryParameter) String() string

Variables

var (
	// optional APIOptions api_options = 511122;
	E_ApiOptions = &file_options_options_proto_extTypes[0]
)

Extension fields to descriptorpb.MethodOptions.

var (
	// optional bool required = 51236;
	E_Required = &file_options_options_proto_extTypes[1] // Custom option for field requirements
)

Extension fields to descriptorpb.FieldOptions.

var File_options_options_proto protoreflect.FileDescriptor

Types

type APIOptions

type APIOptions struct {
	Path        string            `protobuf:"bytes,51234,opt,name=path,proto3" json:"path,omitempty"`               // Unique field number for path
	Method      string            `protobuf:"bytes,51235,opt,name=method,proto3" json:"method,omitempty"`           // Unique field number for HTTP method
	Summary     string            `protobuf:"bytes,51237,opt,name=summary,proto3" json:"summary,omitempty"`         // Unique field number for Summary
	Description string            `protobuf:"bytes,51238,opt,name=description,proto3" json:"description,omitempty"` // Unique field number for Description
	QueryParams []*QueryParameter `protobuf:"bytes,51239,rep,name=query_params,json=queryParams,proto3" json:"query_params,omitempty"`
	// contains filtered or unexported fields
}

func (*APIOptions) Descriptor

func (*APIOptions) Descriptor() ([]byte, []int)

Deprecated: Use APIOptions.ProtoReflect.Descriptor instead.

func (*APIOptions) GetDescription

func (x *APIOptions) GetDescription() string

func (*APIOptions) GetMethod

func (x *APIOptions) GetMethod() string

func (*APIOptions) GetPath

func (x *APIOptions) GetPath() string

func (*APIOptions) GetQueryParams

func (x *APIOptions) GetQueryParams() []*QueryParameter

func (*APIOptions) GetSummary

func (x *APIOptions) GetSummary() string

func (*APIOptions) ProtoMessage

func (*APIOptions) ProtoMessage()

func (*APIOptions) ProtoReflect

func (x *APIOptions) ProtoReflect() protoreflect.Message

func (*APIOptions) Reset

func (x *APIOptions) Reset()

func (*APIOptions) String

func (x *APIOptions) String() string

type QueryParameter

type QueryParameter struct {
	Name        string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`               // Name of the query parameter
	Type        string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`               // Type of the parameter (e.g., string, int)
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` // Description of the parameter
	Required    bool   `protobuf:"varint,4,opt,name=required,proto3" json:"required,omitempty"`      // Whether the parameter is required
	// contains filtered or unexported fields
}

Define a message for a query parameter

func (*QueryParameter) Descriptor

func (*QueryParameter) Descriptor() ([]byte, []int)

Deprecated: Use QueryParameter.ProtoReflect.Descriptor instead.

func (*QueryParameter) GetDescription

func (x *QueryParameter) GetDescription() string

func (*QueryParameter) GetName

func (x *QueryParameter) GetName() string

func (*QueryParameter) GetRequired

func (x *QueryParameter) GetRequired() bool

func (*QueryParameter) GetType

func (x *QueryParameter) GetType() string

func (*QueryParameter) ProtoMessage

func (*QueryParameter) ProtoMessage()

func (*QueryParameter) ProtoReflect

func (x *QueryParameter) ProtoReflect() protoreflect.Message

func (*QueryParameter) Reset

func (x *QueryParameter) Reset()

func (*QueryParameter) String

func (x *QueryParameter) String() string