Skip to content

Commit 43e2d77

Browse files
authored
fix(AIP-202): rename type to FieldInfo (#1227)
1 parent 153cbb9 commit 43e2d77

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

aip/general/0202.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@ placement:
99

1010
# Fields
1111

12-
The [`google.api.Field`][field proto] type, through its accompanying extension
13-
`google.api.field`, enriches a field's schema beyond the basic name and type
14-
information.
12+
The [`google.api.FieldInfo`][field info proto] type, through its accompanying
13+
extension `google.api.field_info`, enriches a field's schema beyond the basic
14+
name and type information.
1515

1616
## Guidance
1717

18-
Decorating a field with `google.api.field` is only necessary when explicitly
19-
stated in this AIP or another that leverages `google.api.Field` information. As
20-
such, the guidance herein applies to those scenarios as well.
18+
Decorating a field with `google.api.field_info` is only necessary when
19+
explicitly stated in this AIP or another that leverages `google.api.FieldInfo`
20+
information. As such, the guidance herein applies to those scenarios as well.
2121

2222
### Format
2323

2424
Fields with a primitive type can still have a specific format. To convey that
25-
type format, the `Field.Format` enumeration is used via the
26-
`(google.api.field).format` extension field. The following guidance conveys the
27-
meaning of and requirements for use of each `Field.Format` value.
25+
type format, the `FieldInfo.Format` enumeration is used via the
26+
`(google.api.field_info).format` extension field. The following guidance conveys
27+
the meaning of and requirements for use of each `FieldInfo.Format` value.
2828

2929
#### UUID4
3030

@@ -78,7 +78,7 @@ backwards compatible.
7878

7979
#### Extending Format
8080

81-
Any new `Field.Format` value **must** be governed by an
81+
Any new `FieldInfo.Format` value **must** be governed by an
8282
[IETF-approved RFC][ietf rfc] or a [Google-approved AIP](./0001.md).
8383

8484
## Rationale
@@ -109,10 +109,10 @@ create a user-friendly surface.
109109
Those formats which are sufficiently standardized to merit an RFC or AIP are
110110
stable enough and widely enough known to be incorporated as a supported value
111111
and see usage in Google APIs. Requiring such extra guidance means that governing
112-
the format specification is not the responsibility of the `Field.Format`
112+
the format specification is not the responsibility of the `FieldInfo.Format`
113113
enumeration itself.
114114

115-
[field proto]: https://github.com/googleapis/googleapis/blob/master/google/api/field.proto
115+
[field info proto]: https://github.com/googleapis/googleapis/blob/master/google/api/field_info.proto
116116
[rfc 4122]: https://datatracker.ietf.org/doc/html/rfc4122
117117
[rfc 791]: https://datatracker.ietf.org/doc/html/rfc791
118118
[rfc 4291]: https://datatracker.ietf.org/doc/html/rfc4291#section-2.2

0 commit comments

Comments
 (0)