From af2a884ecd092d632462c30da4eb41902896c187 Mon Sep 17 00:00:00 2001 From: Alex Stephen Date: Tue, 26 Mar 2024 15:42:14 -0700 Subject: [PATCH] Add field_info.proto --- .../proto/aep/api/field_info.proto | 49 +++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 common-components/proto/aep/api/field_info.proto diff --git a/common-components/proto/aep/api/field_info.proto b/common-components/proto/aep/api/field_info.proto new file mode 100644 index 00000000..b4670071 --- /dev/null +++ b/common-components/proto/aep/api/field_info.proto @@ -0,0 +1,49 @@ +syntax = "proto3"; + +package aep.api; + +option go_package = "aep.golang.org/genproto/common-components/type/api;field_info"; +option java_multiple_files = true; +option java_outer_classname = "FieldInfoProto"; +option java_package = "dev.aep.api"; +option objc_class_prefix = "AEP"; + +// Rich semantic information of an API field beyond basic typing. +message FieldInfo { + // The standard format of a field value. The supported formats are all backed + // by either an RFC defined by the IETF or a Google-defined AIP. + enum Format { + // Default, unspecified value. + FORMAT_UNSPECIFIED = 0; + + // Universally Unique Identifier, version 4, value as defined by + // https://datatracker.ietf.org/doc/html/rfc4122. The value may be + // normalized to entirely lowercase letters. For example, the value + // `F47AC10B-58CC-0372-8567-0E02B2C3D479` would be normalized to + // `f47ac10b-58cc-0372-8567-0e02b2c3d479`. + UUID4 = 1; + + // Internet Protocol v4 value as defined by [RFC + // 791](https://datatracker.ietf.org/doc/html/rfc791). The value may be + // condensed, with leading zeros in each octet stripped. For example, + // `001.022.233.040` would be condensed to `1.22.233.40`. + IPV4 = 2; + + // Internet Protocol v6 value as defined by [RFC + // 2460](https://datatracker.ietf.org/doc/html/rfc2460). The value may be + // normalized to entirely lowercase letters with zeros compressed, following + // [RFC 5952](https://datatracker.ietf.org/doc/html/rfc5952). For example, + // the value `2001:0DB8:0::0` would be normalized to `2001:db8::`. + IPV6 = 3; + + // An IP address in either v4 or v6 format as described by the individual + // values defined herein. See the comments on the IPV4 and IPV6 types for + // allowed normalizations of each. + IPV4_OR_IPV6 = 4; + } + + // The standard format of a field value. This does not explicitly configure + // any API consumer, just documents the API's format for the field it is + // applied to. + Format format = 1; +} \ No newline at end of file