Skip to content
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

add info about update mask to API doc introduction #10572

Merged
merged 2 commits into from
Aug 26, 2020
Merged

add info about update mask to API doc introduction #10572

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4db1835
add update mask to API doc introduction
ephraimbuddy Aug 25, 2020
8e55415
fixup! add update mask to API doc introduction
ephraimbuddy Aug 26, 2020
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
16 changes: 15 additions & 1 deletion airflow/api_connexion/openapi/v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,19 @@ info:
"open_slots": 0
}
```

### Update Mask
Update mask is available as a query parameter in patch endpoints. It is used to notify the
API which fields you want to update. Using `update_mask` makes it easier to update objects
by helping the server know which fields to update in an object instead of updating all fields.
The update request ignores any fields that aren't specified in the field mask, leaving them with
their current values.

Example:
```
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))
```

## Versioning and Endpoint Lifecycle

Expand Down Expand Up @@ -160,6 +172,8 @@ info:

For details on configuring the authentication, see
[API Authorization](https://airflow.readthedocs.io/en/latest/security/api.html).


version: '1.0.0'
license:
name: Apache 2.0
Expand Down