add info about update mask to API doc introduction #10572
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
mik-laj
reviewed
Aug 26, 2020
| @@ -160,6 +160,14 @@ info: | |||
|
|
|||
| For details on configuring the authentication, see | |||
| [API Authorization](https://airflow.readthedocs.io/en/latest/security/api.html). | |||
|
|
|||
| # Update Mask | |||
There was a problem hiding this comment.
Can you move it to ### Update section or ## Conventions (first preferred)?
mik-laj
reviewed
Aug 26, 2020
| @@ -160,6 +160,14 @@ info: | |||
|
|
|||
| For details on configuring the authentication, see | |||
| [API Authorization](https://airflow.readthedocs.io/en/latest/security/api.html). | |||
|
|
|||
| # Update Mask | |||
| Update mask is available as a parameter in patch endpoints. It is used to notify the | |||
There was a problem hiding this comment.
I am afraid this has little effect on performance as these are only trivial memory operations.
The main reason for this is that you can get the full object with GET, update the selected fields, then send the full object and only indicate the fields to be updated. In other words, it's necessary to perform a partial update.
resource = request.get('/resource/my-id').json()
resource['my-field'] = 'new-value'
request.patch('/resource/my-id?update-mask=my-field', data=json.dumps(resource))
This makes it easier for the client to use the API.
|
Ok. I will update it. It was what I read from the link below that formed my explanation. https://developers.google.com/slides/how-tos/field-masks |
mik-laj
approved these changes
Aug 26, 2020
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.
This PR adds information about update_mask to the REST API reference documentation
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.