You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2022/01/25 03:37:08 UTC

[GitHub] [airflow] 11010cy opened a new pull request #21080: Fix wrong use of $ref and nullable

11010cy opened a new pull request #21080:
URL: https://github.com/apache/airflow/pull/21080


   <!--
   Thank you for contributing! Please make sure that your code changes
   are covered with tests. And in case of new features or big changes
   remember to adjust the documentation.
   
   Feel free to ping committers for the review!
   
   In case of existing issue, reference it using one of the following:
   
   closes: #ISSUE
   related: #ISSUE
   https://github.com/OpenAPITools/openapi-generator/issues/11352
   
   How to write a good git commit message:
   http://chris.beams.io/posts/git-commit/
   -->
   
   ---
   **^ Add meaningful description above**
   
   Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
   In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
   In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/main/UPDATING.md).
   
   related:
   https://github.com/OpenAPITools/openapi-generator/issues/11352
   https://github.com/apache/airflow-client-python/issues/40


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] 11010cy closed pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
11010cy closed pull request #21080:
URL: https://github.com/apache/airflow/pull/21080


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] github-actions[bot] closed pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
github-actions[bot] closed pull request #21080:
URL: https://github.com/apache/airflow/pull/21080


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] 11010cy closed pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
11010cy closed pull request #21080:
URL: https://github.com/apache/airflow/pull/21080


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] github-actions[bot] commented on pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #21080:
URL: https://github.com/apache/airflow/pull/21080#issuecomment-1065694899


   This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] boring-cyborg[bot] commented on pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #21080:
URL: https://github.com/apache/airflow/pull/21080#issuecomment-1020778510


   Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
   Here are some useful points:
   - Pay attention to the quality of your code (flake8, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
   - In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/main/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
   - Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/BREEZE.rst) for testing locally, itโ€™s a heavy docker but it ships with a working Airflow and a lot of integrations.
   - Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
   - Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
   - Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#coding-style-and-best-practices).
   Apache Airflow is a community-driven project and together we are making it better ๐Ÿš€.
   In case of doubts contact the developers at:
   Mailing List: dev@airflow.apache.org
   Slack: https://s.apache.org/airflow-slack
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] 11010cy commented on a change in pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
11010cy commented on a change in pull request #21080:
URL: https://github.com/apache/airflow/pull/21080#discussion_r791474763



##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3442,6 +3449,11 @@ components:
         - sensing
         - removed
 
+    NullableTaskState:
+      oneOf:
+        - type: null
+        - $ref: '#/components/schemas/TaskState'
+

Review comment:
       I could change it into inline composed schemas to fix the current `wrong composed schemas` bug, instead of creating a new component. But it is still not working.
   




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] ephraimbuddy commented on a change in pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
ephraimbuddy commented on a change in pull request #21080:
URL: https://github.com/apache/airflow/pull/21080#discussion_r791449341



##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3442,6 +3449,11 @@ components:
         - sensing
         - removed
 
+    NullableTaskState:
+      oneOf:
+        - type: null
+        - $ref: '#/components/schemas/TaskState'
+

Review comment:
       Should we have this immediately after TaskInstance which is where it was used?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] ephraimbuddy commented on a change in pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
ephraimbuddy commented on a change in pull request #21080:
URL: https://github.com/apache/airflow/pull/21080#discussion_r791449341



##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3442,6 +3449,11 @@ components:
         - sensing
         - removed
 
+    NullableTaskState:
+      oneOf:
+        - type: null
+        - $ref: '#/components/schemas/TaskState'
+

Review comment:
       Should we have this immediately after TaskInstance which is where it was used?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] boring-cyborg[bot] commented on pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #21080:
URL: https://github.com/apache/airflow/pull/21080#issuecomment-1020778510


   Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
   Here are some useful points:
   - Pay attention to the quality of your code (flake8, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
   - In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/main/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
   - Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/BREEZE.rst) for testing locally, itโ€™s a heavy docker but it ships with a working Airflow and a lot of integrations.
   - Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
   - Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
   - Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#coding-style-and-best-practices).
   Apache Airflow is a community-driven project and together we are making it better ๐Ÿš€.
   In case of doubts contact the developers at:
   Mailing List: dev@airflow.apache.org
   Slack: https://s.apache.org/airflow-slack
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] uranusjr commented on a change in pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
uranusjr commented on a change in pull request #21080:
URL: https://github.com/apache/airflow/pull/21080#discussion_r791452103



##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3442,6 +3449,11 @@ components:
         - sensing
         - removed
 
+    NullableTaskState:
+      oneOf:
+        - type: null
+        - $ref: '#/components/schemas/TaskState'
+

Review comment:
       I kind of feel we might be better off expanding this in-place and get rid of the new components entirely.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] uranusjr commented on a change in pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
uranusjr commented on a change in pull request #21080:
URL: https://github.com/apache/airflow/pull/21080#discussion_r791452103



##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3442,6 +3449,11 @@ components:
         - sensing
         - removed
 
+    NullableTaskState:
+      oneOf:
+        - type: null
+        - $ref: '#/components/schemas/TaskState'
+

Review comment:
       I kind of feel we might be better off expanding this in-place and get rid of the new components entirely.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] 11010cy commented on a change in pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
11010cy commented on a change in pull request #21080:
URL: https://github.com/apache/airflow/pull/21080#discussion_r791465400



##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3442,6 +3449,11 @@ components:
         - sensing
         - removed
 
+    NullableTaskState:
+      oneOf:
+        - type: null
+        - $ref: '#/components/schemas/TaskState'
+

Review comment:
       1. TaskState/TimeDelte itself can not be null, we couldn't change itself.  It is not nullable in some scenarios, like:
   ```
   # 3259~3264
   state:
             type: array
             items:
               $ref: '#/components/schemas/TaskState'
             description:
               The value can be repeated to retrieve multiple matching values (OR condition).
   ```
   
   2. As discussed in [openapi-generator](https://github.com/OpenAPITools/openapi-generator/issues/11352), the inline composed schemas has bug using tooling to generate client code. If you expect a property to be one of TaskState/TimeDelta and null, the following code also doesn't work:
   ```
   dag_run_timeout:
    oneOf:
     - type: null
     - $ref: '#/components/schemas/TimeDelta'
   ```
   
   3. Of course we could wait for the `openapi-generator` to fix the bug, but not necessarily in time. It's a trade-off.

##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3442,6 +3449,11 @@ components:
         - sensing
         - removed
 
+    NullableTaskState:
+      oneOf:
+        - type: null
+        - $ref: '#/components/schemas/TaskState'
+

Review comment:
       I could change it into inline composed schemas to fix the current `wrong composed schemas` bug, instead of creating a new component. But it is still not working.
   




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] 11010cy commented on a change in pull request #21080: Fix wrong use of $ref and nullable

Posted by GitBox <gi...@apache.org>.
11010cy commented on a change in pull request #21080:
URL: https://github.com/apache/airflow/pull/21080#discussion_r791465400



##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3442,6 +3449,11 @@ components:
         - sensing
         - removed
 
+    NullableTaskState:
+      oneOf:
+        - type: null
+        - $ref: '#/components/schemas/TaskState'
+

Review comment:
       1. TaskState/TimeDelte itself can not be null, we couldn't change itself.  It is not nullable in some scenarios, like:
   ```
   # 3259~3264
   state:
             type: array
             items:
               $ref: '#/components/schemas/TaskState'
             description:
               The value can be repeated to retrieve multiple matching values (OR condition).
   ```
   
   2. As discussed in [openapi-generator](https://github.com/OpenAPITools/openapi-generator/issues/11352), the inline composed schemas has bug using tooling to generate client code. If you expect a property to be one of TaskState/TimeDelta and null, the following code also doesn't work:
   ```
   dag_run_timeout:
    oneOf:
     - type: null
     - $ref: '#/components/schemas/TimeDelta'
   ```
   
   3. Of course we could wait for the `openapi-generator` to fix the bug, but not necessarily in time. It's a trade-off.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org