protos

package
v0.0.99 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 11, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var E_EnumOptions = &proto.ExtensionDesc{
	ExtendedType:  (*descriptor.EnumOptions)(nil),
	ExtensionType: (*EnumOptions)(nil),
	Field:         1128,
	Name:          "protoc.gen.jsonschema.enum_options",
	Tag:           "bytes,1128,opt,name=enum_options",
	Filename:      "options.proto",
}
View Source
var E_FieldOptions = &proto.ExtensionDesc{
	ExtendedType:  (*descriptor.FieldOptions)(nil),
	ExtensionType: (*FieldOptions)(nil),
	Field:         1125,
	Name:          "protoc.gen.jsonschema.field_options",
	Tag:           "bytes,1125,opt,name=field_options",
	Filename:      "options.proto",
}
View Source
var E_FileOptions = &proto.ExtensionDesc{
	ExtendedType:  (*descriptor.FileOptions)(nil),
	ExtensionType: (*FileOptions)(nil),
	Field:         1126,
	Name:          "protoc.gen.jsonschema.file_options",
	Tag:           "bytes,1126,opt,name=file_options",
	Filename:      "options.proto",
}
View Source
var E_ManualLink = &proto.ExtensionDesc{
	ExtendedType:  (*descriptor.FieldOptions)(nil),
	ExtensionType: (*string)(nil),
	Field:         50015,
	Name:          "protoc.gen.jsonschema.manual_link",
	Tag:           "bytes,50015,opt,name=manual_link",
	Filename:      "options.proto",
}
View Source
var E_MessageManualLink = &proto.ExtensionDesc{
	ExtendedType:  (*descriptor.MessageOptions)(nil),
	ExtensionType: (*string)(nil),
	Field:         50000,
	Name:          "protoc.gen.jsonschema.message_manual_link",
	Tag:           "bytes,50000,opt,name=message_manual_link",
	Filename:      "options.proto",
}
View Source
var E_MessageOptions = &proto.ExtensionDesc{
	ExtendedType:  (*descriptor.MessageOptions)(nil),
	ExtensionType: (*MessageOptions)(nil),
	Field:         1127,
	Name:          "protoc.gen.jsonschema.message_options",
	Tag:           "bytes,1127,opt,name=message_options",
	Filename:      "options.proto",
}

Functions

This section is empty.

Types

type EnumOptions

type EnumOptions struct {
	// Enums tagged with this will have be encoded to use constants instead of simple types (supports value annotations):
	EnumsAsConstants bool `protobuf:"varint,1,opt,name=enums_as_constants,json=enumsAsConstants,proto3" json:"enums_as_constants,omitempty"`
	// Enums tagged with this will only provide string values as options (not their numerical equivalents):
	EnumsAsStringsOnly bool `protobuf:"varint,2,opt,name=enums_as_strings_only,json=enumsAsStringsOnly,proto3" json:"enums_as_strings_only,omitempty"`
	// Enums tagged with this will have enum name prefix removed from values:
	EnumsTrimPrefix bool `protobuf:"varint,3,opt,name=enums_trim_prefix,json=enumsTrimPrefix,proto3" json:"enums_trim_prefix,omitempty"`
	// Enums tagged with this will not be processed
	Ignore               bool     `protobuf:"varint,4,opt,name=ignore,proto3" json:"ignore,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Custom EnumOptions

func (*EnumOptions) Descriptor

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

func (*EnumOptions) GetEnumsAsConstants

func (m *EnumOptions) GetEnumsAsConstants() bool

func (*EnumOptions) GetEnumsAsStringsOnly

func (m *EnumOptions) GetEnumsAsStringsOnly() bool

func (*EnumOptions) GetEnumsTrimPrefix

func (m *EnumOptions) GetEnumsTrimPrefix() bool

func (*EnumOptions) GetIgnore

func (m *EnumOptions) GetIgnore() bool

func (*EnumOptions) ProtoMessage

func (*EnumOptions) ProtoMessage()

func (*EnumOptions) Reset

func (m *EnumOptions) Reset()

func (*EnumOptions) String

func (m *EnumOptions) String() string

func (*EnumOptions) XXX_DiscardUnknown

func (m *EnumOptions) XXX_DiscardUnknown()

func (*EnumOptions) XXX_Marshal

func (m *EnumOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*EnumOptions) XXX_Merge

func (m *EnumOptions) XXX_Merge(src proto.Message)

func (*EnumOptions) XXX_Size

func (m *EnumOptions) XXX_Size() int

func (*EnumOptions) XXX_Unmarshal

func (m *EnumOptions) XXX_Unmarshal(b []byte) error

type FieldOptions

type FieldOptions struct {
	// Fields tagged with this will be omitted from generated schemas
	Ignore bool `protobuf:"varint,1,opt,name=ignore,proto3" json:"ignore,omitempty"`
	// Fields tagged with this will be marked as "required" in generated schemas
	Required bool `protobuf:"varint,2,opt,name=required,proto3" json:"required,omitempty"`
	// Fields tagged with this will constrain strings using the "minLength" keyword in generated schemas
	MinLength int32 `protobuf:"varint,3,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
	// Fields tagged with this will constrain strings using the "maxLength" keyword in generated schemas
	MaxLength int32 `protobuf:"varint,4,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
	// Fields tagged with this will constrain strings using the "pattern" keyword in generated schemas
	Pattern              string   `protobuf:"bytes,5,opt,name=pattern,proto3" json:"pattern,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Custom FieldOptions

func (*FieldOptions) Descriptor

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

func (*FieldOptions) GetIgnore

func (m *FieldOptions) GetIgnore() bool

func (*FieldOptions) GetMaxLength

func (m *FieldOptions) GetMaxLength() int32

func (*FieldOptions) GetMinLength

func (m *FieldOptions) GetMinLength() int32

func (*FieldOptions) GetPattern

func (m *FieldOptions) GetPattern() string

func (*FieldOptions) GetRequired

func (m *FieldOptions) GetRequired() bool

func (*FieldOptions) ProtoMessage

func (*FieldOptions) ProtoMessage()

func (*FieldOptions) Reset

func (m *FieldOptions) Reset()

func (*FieldOptions) String

func (m *FieldOptions) String() string

func (*FieldOptions) XXX_DiscardUnknown

func (m *FieldOptions) XXX_DiscardUnknown()

func (*FieldOptions) XXX_Marshal

func (m *FieldOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*FieldOptions) XXX_Merge

func (m *FieldOptions) XXX_Merge(src proto.Message)

func (*FieldOptions) XXX_Size

func (m *FieldOptions) XXX_Size() int

func (*FieldOptions) XXX_Unmarshal

func (m *FieldOptions) XXX_Unmarshal(b []byte) error

type FileOptions

type FileOptions struct {
	// Files tagged with this will not be processed
	Ignore bool `protobuf:"varint,1,opt,name=ignore,proto3" json:"ignore,omitempty"`
	// Override the default file extension for schemas generated from this file
	Extension            string   `protobuf:"bytes,2,opt,name=extension,proto3" json:"extension,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Custom FileOptions

func (*FileOptions) Descriptor

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

func (*FileOptions) GetExtension

func (m *FileOptions) GetExtension() string

func (*FileOptions) GetIgnore

func (m *FileOptions) GetIgnore() bool

func (*FileOptions) ProtoMessage

func (*FileOptions) ProtoMessage()

func (*FileOptions) Reset

func (m *FileOptions) Reset()

func (*FileOptions) String

func (m *FileOptions) String() string

func (*FileOptions) XXX_DiscardUnknown

func (m *FileOptions) XXX_DiscardUnknown()

func (*FileOptions) XXX_Marshal

func (m *FileOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*FileOptions) XXX_Merge

func (m *FileOptions) XXX_Merge(src proto.Message)

func (*FileOptions) XXX_Size

func (m *FileOptions) XXX_Size() int

func (*FileOptions) XXX_Unmarshal

func (m *FileOptions) XXX_Unmarshal(b []byte) error

type MessageOptions

type MessageOptions struct {
	// Messages tagged with this will not be processed
	Ignore bool `protobuf:"varint,1,opt,name=ignore,proto3" json:"ignore,omitempty"`
	// Messages tagged with this will have all fields marked as "required":
	AllFieldsRequired bool `protobuf:"varint,2,opt,name=all_fields_required,json=allFieldsRequired,proto3" json:"all_fields_required,omitempty"`
	// Messages tagged with this will additionally accept null values for all properties:
	AllowNullValues bool `protobuf:"varint,3,opt,name=allow_null_values,json=allowNullValues,proto3" json:"allow_null_values,omitempty"`
	// Messages tagged with this will have all fields marked as not allowing additional properties:
	DisallowAdditionalProperties bool `` /* 148-byte string literal not displayed */
	// Messages tagged with this will have all nested enums encoded to use constants instead of simple types (supports value annotations):
	EnumsAsConstants     bool     `protobuf:"varint,5,opt,name=enums_as_constants,json=enumsAsConstants,proto3" json:"enums_as_constants,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Custom MessageOptions

func (*MessageOptions) Descriptor

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

func (*MessageOptions) GetAllFieldsRequired

func (m *MessageOptions) GetAllFieldsRequired() bool

func (*MessageOptions) GetAllowNullValues

func (m *MessageOptions) GetAllowNullValues() bool

func (*MessageOptions) GetDisallowAdditionalProperties

func (m *MessageOptions) GetDisallowAdditionalProperties() bool

func (*MessageOptions) GetEnumsAsConstants

func (m *MessageOptions) GetEnumsAsConstants() bool

func (*MessageOptions) GetIgnore

func (m *MessageOptions) GetIgnore() bool

func (*MessageOptions) ProtoMessage

func (*MessageOptions) ProtoMessage()

func (*MessageOptions) Reset

func (m *MessageOptions) Reset()

func (*MessageOptions) String

func (m *MessageOptions) String() string

func (*MessageOptions) XXX_DiscardUnknown

func (m *MessageOptions) XXX_DiscardUnknown()

func (*MessageOptions) XXX_Marshal

func (m *MessageOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MessageOptions) XXX_Merge

func (m *MessageOptions) XXX_Merge(src proto.Message)

func (*MessageOptions) XXX_Size

func (m *MessageOptions) XXX_Size() int

func (*MessageOptions) XXX_Unmarshal

func (m *MessageOptions) XXX_Unmarshal(b []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL