package tinc

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: FieldConstraints, PrimitiveConstraints

• optional bytes const = 1

  Requires the input value be exactly equal to the value provided.

• optional uint64 len = 2

  Requires the input value length be exactly equal to the value provided.

• optional uint64 min_len = 3

  Requires the input value length be greater then or equal to the value provided.

• optional uint64 max_len = 4

  Requires the input value length be less then or equal to the value provided.

Used in: FieldConstraints, MapConstraints.MapKeyConstraints, MessageOptions, MethodOptions, PredefinedConstraints, PrimitiveConstraints

• string message = 2

  The message to use when the validation fails. You can template cel expressions using the `{<cel-expr>}` syntax

• string expression = 3

  The expression itself. Note: This expression's result will be converted into a bool.

• repeated string jsonschemas = 5

  Json Scheamas that should be used when this expression is applied. This is also a cel-expression which is evaluated at compile time and should return a map object in the json schema format.

Used in: FieldConstraints, PrimitiveConstraints

• oneof greater

  • double gt = 1

    Requires the input value is greater than the value provided.

  • double gte = 2

    Requires the input value is greater than or equal to the value provided.

• oneof less

  • double lt = 3

    Requires the input value is less than the value provided.

  • double lte = 4

    Requires the input value is less than or equal to the value provided.

• repeated double in = 5

  Requires the input value be one of the values in the list

• repeated double not_in = 6

  Requires the input value not be one of the values in the list.

• optional double const = 8

  Requires the input value be exactly equal to the value provided.

• optional bool disallow_nan = 9

  If true, NaN values are not allowed.

• optional bool disallow_infinity = 10

  If true, pos/neg Infinity values are not allowed.

Used in: FieldConstraints, PrimitiveConstraints

• optional int32 const = 1

  Requires the input value to be equal to the enum value where the tag is the value provided.

• optional bool defined = 2

  Requires the input to be a valid value for this enum.

• repeated int32 in = 3

  Requires the input to be one of the enum's provided.

• repeated int32 not_in = 4

  Requires the input to not be one of the enums provided.

• optional bool repr_enum = 2

  Treat this enum as a number enum instead of string

• optional RenameAll rename_all = 3

  Rename all the fields on the enum

• optional string rename = 1

  Rename this variant

• optional Visibility visibility = 2

  Change the visibility for this variant.

Used in: FieldOptions

• oneof constraint

  • FloatConstraints float = 1

    for float fields.

  • DoubleConstraints double = 2

    for double fields.

  • Int32Constraints int32 = 3

    for int32 fields.

  • Int64Constraints int64 = 4

    for int64 fields.

  • UInt32Constraints uint32 = 5

    for uint32 fields.

  • UInt64Constraints uint64 = 6

    for uint64 fields.

  • StringConstraints string = 7

    for string fields.

  • BytesConstraints bytes = 8

    for bytes fields.

  • EnumConstraints enum = 9

    for enum fields.

  • RepeatedConstraints repeated = 10

    for repeated fields.

  • MapConstraints map = 11

    for map fields.

• repeated CelExpression cel = 13

  A list of custom expressions to apply to the field.

• optional string rename = 1

  Rename this specific field to another name.

• JsonOmittable json_omittable = 200

  Deserialization: This flag dictates how we handle fields which are not provided in the json representation of the message. If this is true, then no error will be returned if the field is not provided. If this is false then not providing a value for this field will result in an error. Serialization: This flag dictates if we should skip serializing the field in the json representation of the message if the field is equal to the default value for its type. By default if the value depends on the type of field. If the field is an option then the default value is `TRUE_BUT_SERIALIZE` which means that the option does not need to be provided but a `null` value will always be serialized. If the field is not an option then it will be required so `FALSE`.

• optional bool flatten = 205

  Flatten this field into the parent message. This only works on messages.

• optional Visibility visibility = 202

  Change the visibility of the field. By Default all fields are visible.

• optional FieldConstraints constraint = 101

  Add some constraints to the field.

Used in: FieldConstraints, PrimitiveConstraints

• oneof greater

  • float gt = 1

    Requires the input value is greater than the value provided.

  • float gte = 2

    Requires the input value is greater than or equal to the value provided.

• oneof less

  • float lt = 3

    Requires the input value is less than the value provided.

  • float lte = 4

    Requires the input value is less than or equal to the value provided.

• repeated float in = 5

  Requires the input value be one of the values in the list

• repeated float not_in = 6

  Requires the input value not be one of the values in the list.

• optional float const = 8

  Requires the input value be exactly equal to the value provided.

• optional bool disallow_nan = 9

  If true, NaN values are not allowed.

• optional bool disallow_infinity = 10

  If true, pos/neg Infinity values are not allowed.

Used in: MethodOptions

• oneof method

  HTTP method - Path parameters can be specified using `{param}` syntax.

  • string get = 1

    GET method

  • string post = 2

    POST method

  • string put = 3

    PUT method

  • string delete = 4

    DELETE method

  • string patch = 5

    PATCH method

• optional HttpEndpointOptions.Request request = 8

• optional HttpEndpointOptions.Response response = 9

  Response options, by default the entire message will be sent as a response with the content type being `application/json`

The default input for `GET` and `DELETE` methods is `query` Otherwise the default is `body`.

Used in: HttpEndpointOptions

• oneof mode

  • Request.JsonBody json = 1

  • Request.TextBody text = 2

  • Request.BinaryBody binary = 3

  • Request.QueryParams query = 4

Used in: Request

• optional string field = 1

• optional string content_type_field = 2

  Specify the field to take the content-type from.

• optional string content_type_accepts = 3

  This field is purely used by the openapi spec to denote the set of valid output formats.

Used in: Request

• optional string field = 1

Used in: Request

• optional string field = 1

  The field to parse the query parameters into. By Default this is empty and therefore its parsed into the root message.

Used in: Request

• optional string field = 1

Used in: HttpEndpointOptions

• oneof mode

  • Response.Json json = 1

  • Response.Text text = 2

  • Response.Binary binary = 3

Used in: Response

• optional string field = 1

  Specify a sub field to return as the response If this field is bytes or string it will be returned as is without decoding.

• optional string content_type_field = 2

  Specify the field to take the content-type from.

• optional string content_type_accepts = 3

  This field is purely used by the openapi spec to denote the set of valid output formats.

Used in: Response

• optional string field = 1

  Specify a sub field to return as the response If this field is bytes or string it will be returned as is without decoding.

Used in: Response

• optional string field = 1

  Specify a sub field to return as the response If this field is bytes or string it will be returned as is without decoding.

Used in: FieldConstraints, MapConstraints.MapKeyConstraints, PrimitiveConstraints

• oneof greater

  • int32 gt = 1

    Requires the input value is greater than the value provided.

  • int32 gte = 2

    Requires the input value is greater than or equal to the value provided.

• oneof less

  • int32 lt = 3

    Requires the input value is less than the value provided.

  • int32 lte = 4

    Requires the input value is less than or equal to the value provided.

• repeated int32 in = 5

  Requires the input value be one of the values in the list

• repeated int32 not_in = 6

  Requires the input value not be one of the values in the list.

• optional int32 const = 8

  Requires the input value be exactly equal to the value provided.

Used in: FieldConstraints, MapConstraints.MapKeyConstraints, PrimitiveConstraints

• oneof greater

  • int64 gt = 1

    Requires the input value is greater than the value provided.

  • int64 gte = 2

    Requires the input value is greater than or equal to the value provided.

• oneof less

  • int64 lt = 3

    Requires the input value is less than the value provided.

  • int64 lte = 4

    Requires the input value is less than or equal to the value provided.

• repeated int64 in = 5

  Requires the input value be one of the values in the list

• repeated int64 not_in = 6

  Requires the input value not be one of the values in the list.

• optional int64 const = 8

  Requires the input value be exactly equal to the value provided.

JsonOmittable is the notion of leaving out fields, and how we behave when a field is missing.

Used in: FieldOptions, OneofOptions

• JSON_OMITTABLE_UNSPECIFIED = 0

• TRUE = 1

  If true the field will just be defaulted if not provided. The field will also not be serialized if its the default value.

• FALSE = 2

  If false we will raise an error when the field is not provided.

• TRUE_BUT_STILL_SERIALIZE = 3

  Same as true, except always serialize the field even if its a default value.

Used in: FieldConstraints

• optional uint64 min_len = 1

  Requires the length of the map be greater than or equal to the value provided.

• optional uint64 max_len = 2

  Requires the length of the map be less than or equal to the value provided.

• optional uint64 len = 3

  Requires the length of the map be equal to the value provided.

• optional MapConstraints.MapKeyConstraints key = 4

  Apply a constraints to the keys in the list.

• optional PrimitiveConstraints value = 5

  Apply a constraints to the values in the list.

Used in: MapConstraints

• oneof constraint

  • Int32Constraints int32 = 1

    for int32 keys

  • Int64Constraints int64 = 2

    for int64 keys

  • UInt32Constraints uint32 = 3

    for uint32 keys

  • UInt64Constraints uint64 = 4

    for uint64 keys

  • StringConstraints string = 5

    for string keys

• repeated CelExpression cel = 8

  A list of custom expressions to apply to map keys.

• optional bool generate = 1

  If false, this message will not be generated even if its depended on by a method. If true, this message will always be generated. By default: this message is only generated if its depended on by a method.

• optional RenameAll rename_all = 2

  Rename all fields in the message.

• optional bool skip_validation = 101

  Disable cel-validation generation.

• repeated CelExpression cel = 100

  A list of custom cel expressions that apply to the message in its entirety You can use this to create expressions that depend on multiple field values.

• repeated HttpEndpointOptions endpoint = 1

  A list of endpoints to be built from this method.

• repeated CelExpression cel = 2

  A list of cel expressions to apply to the input of this message.

• optional string rename = 1

  Rename this oneof's name

• optional RenameAll rename_all = 4

  Rename all the fields in the oneof.

• JsonOmittable json_omittable = 200

  Deserialization: This flag dictates how we handle fields which are not provided in the json representation of the message. If this is true, then no error will be returned if the field is not provided. If this is false then not providing a value for this field will result in an error. Serialization: This flag dictates if we should skip serializing the field in the json representation of the message if the field is equal to the default value for its type. By default if the value depends on the type of field. If the field is an option then the default value is `TRUE_BUT_SERIALIZE` which means that the option does not need to be provided but a `null` value will always be serialized. If the field is not an option then it will be required so `FALSE`.

• optional Visibility visibility = 202

  This specifies the visibility for oneof fields.

• optional OneofOptions.Tagged tagged = 100

  If you want to use tagged notation this allows you to configure that.

• optional bool flatten = 101

  You can also flatten the oneof directly into the containing message.

Tagging a oneof causes the ser/de to represent it like such { "tag": "tag", "content": content }

Used in: OneofOptions

• string tag = 1

• string content = 2

Predefined constraints allow us to extend the validation system by defining our own custom message extensions with validation constraints.

• repeated CelExpression cel = 1

  The set of constraints that should be applied.

• PredefinedConstraints.Type type = 2

The type of the target of the expression

Used in: PredefinedConstraints

• TYPE_UNSPECIFIED = 0

• WRAPPER_REPEATED_ITEM = 1

  Only apply all sub items to repeated items

• WRAPPER_MAP_KEY = 2

  Only apply all sub items to map keys

• WRAPPER_MAP_VALUE = 3

  Only apply all sub items to map values

• CUSTOM_EXPRESSION = 4

  Unlike the others, this can only be applied to lists of `CelExpression`

Used in: MapConstraints, RepeatedConstraints

• oneof constraint

  • FloatConstraints float = 1

    for float values

  • DoubleConstraints double = 2

    for double values

  • Int32Constraints int32 = 3

    for int32 values

  • Int64Constraints int64 = 4

    for int64 values

  • UInt32Constraints uint32 = 5

    for uint32 values

  • UInt64Constraints uint64 = 6

    for uint64 values

  • StringConstraints string = 7

    for string values

  • BytesConstraints bytes = 8

    for bytes values

  • EnumConstraints enum = 9

    for enum values

• repeated CelExpression cel = 11

  A list of custom expressions to apply to the value

Enum to define how to rename fields or enum variants.

Used in: EnumOptions, MessageOptions, OneofOptions

• RENAME_ALL_UNSPECIFIED = 0

  protolint:disable ENUM_FIELD_NAMES_PREFIX

• LOWER_CASE = 1

  Rename to lowercase.

• UPPER_CASE = 2

  Rename to UPPERCASE.

• PASCAL_CASE = 3

  Rename to PascalCase.

• CAMEL_CASE = 4

  Rename to camelCase.

• SNAKE_CASE = 5

  Rename to snake_case.

• SCREAMING_SNAKE_CASE = 6

  Rename to SCREAMING_SNAKE_CASE.

• KEBAB_CASE = 7

  Rename to kebab-case.

• SCREAMING_KEBAB_CASE = 8

  Rename to SCREAMING-KEBAB-CASE.

Used in: FieldConstraints

• optional uint64 min_len = 1

  Requires the length of the list be greater than or equal to the value provided.

• optional uint64 max_len = 2

  Requires the length of the list be less than or equal to the value provided.

• optional uint64 len = 3

  Requires the length of the list be equal to the value provided.

• optional PrimitiveConstraints item = 5

  Apply a constraints to the items in the list.

• optional string prefix = 1

  By default service routes are defined in the method, however if you want all routes in this service to be prefixed this is how you would apply such a prefix.

Used in: FieldConstraints, MapConstraints.MapKeyConstraints, PrimitiveConstraints

• optional string const = 1

  Requires the input value be exactly equal to the value provided.

• optional uint64 len = 2

  Requires the input value length be exactly equal to the value provided.

• optional uint64 min_len = 3

  Requires the input value length be greater then or equal to the value provided.

• optional uint64 max_len = 4

  Requires the input value length be less then or equal to the value provided.

• optional string match = 5

  Requires the input value to match against regex provided.

• optional string not_match = 6

  Requires the input value not match against the regex provided.

• optional string prefix = 7

  Requires the input value to start with the value provided.

• optional string suffix = 8

  Requires the input value to end with the value provided.

• optional string contains = 9

  Requires the input value to contain this sub string.

• optional string not_contains = 10

  Requires the input value to not contain this sub string.

• repeated string in = 11

  Requires the input value to be one of the values in the list.

• repeated string not_in = 12

  Requires the input value to not be in the list.

• oneof well_known

  • bool email = 13

    Ensure the value is a valid email address format

  • bool ip = 14

    Requires the input value to be a valid ipv4 or ipv6 address.

  • bool ipv4 = 15

    Requires the input value to be a valid ipv4 address.

  • bool ipv6 = 16

    Requires the input value to be a valid ipv6 address.

  • bool uuid = 17

    Requires the input value to be a valid uuid.

  • bool hostname = 18

    Requires the input value to be a valid hostname.

  • bool uri = 19

    Requires the input value to be a valid uri.

  • bool ulid = 20

Used in: FieldConstraints, MapConstraints.MapKeyConstraints, PrimitiveConstraints

• oneof greater

  • uint32 gt = 1

    Requires the input value is greater than the value provided.

  • uint32 gte = 2

    Requires the input value is greater than or equal to the value provided.

• oneof less

  • uint32 lt = 3

    Requires the input value is less than the value provided.

  • uint32 lte = 4

    Requires the input value is less than or equal to the value provided.

• repeated uint32 in = 5

  Requires the input value be one of the values in the list

• repeated uint32 not_in = 6

  Requires the input value not be one of the values in the list.

• optional uint32 const = 8

  Requires the input value be exactly equal to the value provided.

Used in: FieldConstraints, MapConstraints.MapKeyConstraints, PrimitiveConstraints

• oneof greater

  • int64 gt = 1

    Requires the input value is greater than the value provided.

  • uint64 gte = 2

    Requires the input value is greater than or equal to the value provided.

• oneof less

  • uint64 lt = 3

    Requires the input value is less than the value provided.

  • uint64 lte = 4

    Requires the input value is less than or equal to the value provided.

• repeated uint64 in = 5

  Requires the input value be one of the values in the list

• repeated uint64 not_in = 6

  Requires the input value not be one of the values in the list.

• optional uint64 const = 8

  Requires the input value be exactly equal to the value provided.

Change the visibility of a field or enum variant

Used in: EnumVariantOptions, FieldOptions, OneofOptions

• VISIBILITY_UNSPECIFIED = 0

• SKIP = 1

  Skipped fields will not be deserialized or serialized.

• INPUT_ONLY = 2

  Fields marked as input only will only be deserialized and will not be serialized.

• OUTPUT_ONLY = 3

  Fields marked as output only will not be deserialized and only will be serialized.