Use OpenAPI validation and only use updateable fields in request body for PATCH endpoints of DAG and Variable. #14645
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
…methods. Use Openapi for validation
mik-laj
reviewed
Mar 6, 2021
| @@ -425,7 +425,12 @@ paths: | |||
| content: | |||
| application/json: | |||
| schema: | |||
| $ref: '#/components/schemas/DAG' | |||
| type: object | |||
There was a problem hiding this comment.
We should named components here. Otherwise there may be problems with generating classes for API client
I personally prefer to always use named components.
|
I don't understand this change. according to the OpenAPI specification, these fields should never be sent. See: spec-first/connexion#942 we should fix clients which don't respect OpenAPI specs, not make changes to our API specs. |
|
I am still not convinced that this change is a good idea. Especially in strongly typed languages like Java, this means that we will have several kinds of objects. This does not follow the REST convention. The REST convention limits the number of different types of objects for different operations. |
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.
Closes: #14635
This two endpoints DAG
PATCHand VariablePATCHallows only a single field to be updated and were being given the DAG and Variable objects in the requestBody respectively. This causes confusion and I feel we should let users know that they don't need the DAG or Variable object for their updatesThis PR changes the behaviour and also switch to using Openapi for validation in the requestBody instead of schema validation
^ 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.