annotation

package
v1.4.0 Latest Latest
Warning

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

Go to latest
Published: Feb 18, 2022 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// Public marks that a field should be included in the generated Huma model.
	//
	// optional bool public = 84841;
	E_Public = &file_huma_proto_extTypes[1]
	// Read-only marks that a field is set by the server. The client can only
	// read its value, e.g. resource creation date.
	//
	// optional bool read_only = 84842;
	E_ReadOnly = &file_huma_proto_extTypes[2]
	// Name specifies the Huma Go field name. For example, a field might be cased
	// as `Mp2T` but should be `MP2T` because it is a non-common initialism.
	// Setting this field also updates the JSON name unless it has also been
	// overridden.
	//
	// optional string name = 84843;
	E_Name = &file_huma_proto_extTypes[3]
	// JSON specifies the Huma field's JSON name. Usually this is derived from
	// the field's name, but this option allows you to override it. For example,
	// a field named `MP2T` might become `mp2_t` but should be `mp2t`.
	//
	// optional string json = 84844;
	E_Json = &file_huma_proto_extTypes[4]
	// Multiple-of specifies that the number must be a multiple of this value
	// or validation will fail.
	//
	// optional int32 multiple_of = 84845;
	E_MultipleOf = &file_huma_proto_extTypes[5]
	// Example provides a sample value for documentation purposes. This string
	// value will get put directly into the Huma field example and will get
	// written out in JSON Schema with the appropriate type.
	//
	// optional string example = 84846;
	E_Example = &file_huma_proto_extTypes[6]
)

Extension fields to descriptorpb.FieldOptions.

View Source
var (
	// Excludes this enum value from the available options.
	//
	// optional bool exclude = 84841;
	E_Exclude = &file_huma_proto_extTypes[0]
)

Extension fields to descriptorpb.EnumValueOptions.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

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