feat(AIP-203): Disallow OUTPUT_ONLY fields with OPTIONAL/REQUIRED sub… #1276
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
…-fields Nested messages allow avoiding code duplication, where the same type can be shared by multiple messages. Given that field behavior annotations are also required for nested messages, field behavior must also implicitly be shared. Annotating a field with `OUTPUT_ONLY`, when the field is a sub-message declaring `REQUIRED` and/or `OPTIONAL` fields, forces clients to treat this sub-message differently depending on the context it is used in. Forcing services to consistently separate output fields from user-defined fields avoids this problem. Additionally, there is little value in annotating sub-fields of `OUTPUT_ONLY` fields as either `REQUIRED` or `OPTIONAL`, since the consequences of breaking this contract by services still have to be handled by clients.
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.
Nested messages allow avoiding code duplication, where the same type can be shared by multiple messages. Given that field behavior annotations are also required for nested messages, field behavior must also implicitly be shared.
Annotating a field with
OUTPUT_ONLY, when the field is a sub-message declaringREQUIREDand/orOPTIONALfields, forces clients to treat this sub-message differently depending on the context it is used in. Forcing services to consistently separate output fields from user-defined fields avoids this problem.Additionally, there is little value in annotating sub-fields of
OUTPUT_ONLYfields as eitherREQUIREDorOPTIONAL, since the consequences of breaking this contract by services still have to be handled by clients, and clients must be able to accept the current state of a resource regardless.