fix(AIP-149): differentiate field presence and behavior #1143
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jskeet
approved these changes
Jun 20, 2023
address feedback Co-authored-by: Jon Skeet <skeet@pobox.com> link AIP-203
noahdietz
force-pushed
the
optional-and-field-behavior
branch
from
4b98c5b
to
ff4ce17
Compare
|
Needed to force push to get around a commit co-author addition that tripped the CLA checker. No content changes. |
noahdietz
requested review from
toumorokoshi and
alin04
and removed request for
shwoodard and
toumorokoshi
alin04
reviewed
Jun 22, 2023
|
|
||
| **Important:** Tracking field presence is *not* the same as documenting API | ||
| field behavior as defined in [AIP-203][]. For example, a field labeled with | ||
| `optional` for presence tracking **may** also be annotated as |
There was a problem hiding this comment.
Should there be a cross-reference to http://cloud/apis/design/design_patterns.md#optional_primitive_fields ?
There was a problem hiding this comment.
bah! Shouldn't that link to this AIP? Anyways, discussion of primitives, etc. is part of the guidance above, I don't think we need to discuss it further in this note. Is that fair?
There was a problem hiding this comment.
Yeah, I'd rather move more to the AIPs. it's more actively maintained.
The bifurcation cloud APIs and AIPs is a known issue though - when we have more breathing room we should probably tackle that.
alin04
approved these changes
Jun 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An internal discussion determined that
google.api.field_behaviorandproto3_optionalare separate features and can be used simultaneously. See Rationale in this PR for more detailed reasoning.Updates: googleapis/api-linter#1169