Skip to content

Commit 671cf6e

Browse files
committed
change format
1 parent 20c5dce commit 671cf6e

File tree

1 file changed

+6
-66
lines changed

1 file changed

+6
-66
lines changed

aep/general/0202/aep.md.j2

Lines changed: 6 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,13 @@
11
# Fields
22

3-
The [`google.api.FieldInfo`][field info proto] type, through its accompanying
4-
extension `google.api.field_info`, enriches a field's schema beyond the basic
3+
The [`buf.validate.field`][protovalidate] type, through its accompanying
4+
extension `buf.validate.field`, enriches a field's schema beyond the basic
55
name and type information.
66

77
## Guidance
88

9-
Decorating a field with `google.api.field_info` is only necessary when
10-
explicitly stated in this AEP or another that leverages `google.api.FieldInfo`
11-
information. As such, the guidance herein applies to those scenarios as well.
12-
13-
### Format
14-
15-
Fields with a primitive type can still have a specific format. To convey that
16-
type format, the `FieldInfo.Format` enumeration is used via the
17-
`(google.api.field_info).format` extension field. The following guidance conveys
18-
the meaning of and requirements for use of each `FieldInfo.Format` value.
19-
20-
#### UUID4
21-
22-
The `UUID4` format represents a UUID version 4 value as governed by
23-
[RFC 4122][]. It **must** only be used on a field of type `string`.
24-
25-
Such a value **may** be normalized by the service to entirely lowercase letters.
26-
For example, the value `F47AC10B-58CC-0372-8567-0E02B2C3D479` would be
27-
normalized to `f47ac10b-58cc-0372-8567-0e02b2c3d479`.
28-
29-
As such, equivalence comparison **must not** be done via primitive text
30-
comparison. Instead, an [RFC 4122][] compliant implementation **must** be used.
31-
32-
#### IPv4
33-
34-
The `IPV4` format represents an IP v4 address as governed by [RFC 791][]. It
35-
**must** only be used on a field of type `string`.
36-
37-
Such a value **may** be condensed by the service, with leading zeros in each
38-
octet stripped. For example, `001.022.233.040` would be condensed to
39-
`1.22.233.40`.
40-
41-
As such, equivalence comparison **must not** be done via primitive text
42-
comparison. Instead, an [RFC 791][] compliant implementation **must** be used.
43-
44-
#### IPv6
45-
46-
The `IPV6` format represents an IP v6 address as governed by [RFC 4291][]. It
47-
**must** only be used on a field of type `string`.
48-
49-
Such a value **may** be normalized by the service to entirely lowercase letters
50-
with zeros compressed, following [RFC 5952][]. For example, the value
51-
`2001:0DB8:0::0` would be normalized to `2001:db8::`.
52-
53-
As such, equivalence comparison **must not** be done via primitive text
54-
comparison. Instead, an [RFC 4291][] compliant implementation **must** be used.
55-
56-
#### IPv4 or IPv6
57-
58-
The `IPV4_OR_IPV6` value indicates that the field can be either an IP v4 or v6
59-
address, as described in the [IPv4](#ipv4) and [IPv6](#ipv6) sections.
9+
Decorating a field with `buf.validate.field` is only necessary when a field
10+
consistently follows a set pattern.
6011

6112
#### Format Compatibility
6213

@@ -67,11 +18,6 @@ being specified.
6718
Changing an existing format specifier to a different one in all cases **is not**
6819
backwards compatible.
6920

70-
#### Extending Format
71-
72-
Any new `FieldInfo.Format` value **must** be governed by an
73-
[IETF-approved RFC][ietf rfc] or a [Google-approved AEP](./0001.md).
74-
7521
## Rationale
7622

7723
#### Why add a format specifier?
@@ -100,13 +46,7 @@ create a user-friendly surface.
10046
Those formats which are sufficiently standardized to merit an RFC or AEP are
10147
stable enough and widely enough known to be incorporated as a supported value
10248
and see usage in Google APIs. Requiring such extra guidance means that governing
103-
the format specification is not the responsibility of the `FieldInfo.Format`
49+
the format specification is not the responsibility of the `buf.validate.field`
10450
enumeration itself.
10551

106-
[field info proto]: https://github.com/googleapis/googleapis/blob/master/google/api/field_info.proto
107-
[rfc 4122]: https://datatracker.ietf.org/doc/html/rfc4122
108-
[rfc 791]: https://datatracker.ietf.org/doc/html/rfc791
109-
[rfc 4291]: https://datatracker.ietf.org/doc/html/rfc4291#section-2.2
110-
[rfc 5952]: https://datatracker.ietf.org/doc/html/rfc5952
111-
[ietf rfc]: https://www.ietf.org/standards/rfcs
112-
[java uuid]: https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html
52+
[protovalidate]: https://github.com/bufbuild/protovalidate/tree/main/proto/protovalidate

0 commit comments

Comments
 (0)