Skip to content

feat(AIP-203): Clarify that IDENTIFIER fields must not use other behaviors #1310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrei-scripniciuc wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat(AIP-203): Clarify that IDENTIFIER fields must not use other behaviors #1310

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d57200
feat(AIP-203): Clarify that IDENTIFIER fields are mutually exclusive …
andrei-scripniciuc Feb 16, 2024
a32a82b
chore: add changelog entry
andrei-scripniciuc Feb 16, 2024
32e990f
Merge branch 'master' into andrei-scripniciuc-patch-2
noahdietz Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion aip/general/0203.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ RecognitionAudio audio = 2 [(google.api.field_behavior) = REQUIRED];
- The annotation **must** include any [google.api.FieldBehavior][] values that
accurately describe the behavior of the field.
- `FIELD_BEHAVIOR_UNSPECIFIED` **must not** be used.
- APIs **must** at minimum use one of `REQUIRED`, `OPTIONAL`, or `OUTPUT_ONLY`.
- APIs **must** at minimum use one of `REQUIRED`, `OPTIONAL`, `OUTPUT_ONLY` or
`IDENTIFIER`.

**Warning:** Although `field_behavior` does not impact proto-level behavior,
many clients (e.g. CLIs and SDKs) rely on them to generate code. Thoroughly
Expand Down Expand Up @@ -78,6 +79,9 @@ resource as the primary input e.g. [Standard Update][aip-134].
This annotation **must not** be applied to references to other resources within
a message.

Fields annonated with `IDENTIFIER` **must not** use any other
`google.api.field_behavior` annotation.

### Immutable

The use of `IMMUTABLE` indicates that a field on a resource cannot be changed
Expand Down