API Refactor: Remove primary key fields from masks #1630
Merged
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
Signed-off-by: Andrew Harding <andrew.harding@hpe.com>
azdagron
requested review from
amartinezfayo,
APTy,
evan2645 and
mcpherrinm
as code owners
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.
The masks are used to filter input messages (e.g., piecemeal updates) and output messages (e.g. reduce bandwidth use for unused fields). Masking out the "primary key" field on input never makes sense since it is a required field for identifying the object to perform the operation on. Additionally, it's hard to imagine a practical scenario where you'd want to get back one or more objects without the primary key field.
This PR removes the "primary key" field from the mask messages to avoid confusing interactions with input masks with little to no benefit on the output mask.