ScheduleInterval schema in OpenAPI specs should have "nullable: true" otherwise generated OpenAPI client will throw an error in case of nullable "schedule_interval" #22358

Activity

1. omarsmak

   added

   area:core

   kind:bugThis is a clearly a bugThis is a clearly a bug

   on Mar 18, 2022
2. boring-cyborg commented on Mar 18, 2022

   

   boring-cyborgBot

   on Mar 18, 2022

   More actions

   Thanks for opening your first issue here! Be sure to follow the issue template!
3. uranusjr commented on Mar 18, 2022

   

   uranusjr

   on Mar 18, 2022

   Member

   More actions

   Good catch. Pull request would be very welcomed!

   👍React with 👍1Reacted by Omar Al-Safi
4. uranusjr

   assigned

   omarsmak

   on Mar 18, 2022
5. potiuk

   added

   good first issue

   on Mar 21, 2022
6. kianelbo commented on Apr 3, 2022

   

   kianelbo

   on Apr 3, 2022

   Contributor

   More actions

   Does adding allow_none=True argument to schedule_interval field suffice?
   If so, may I open the PR?
7. omarsmak commented on Apr 3, 2022

   

   omarsmak

   on Apr 3, 2022

   MemberAuthor

   More actions

   I think it doesn't really help, the issue will be on the generated client side.
   Feel free to open a PR as I haven't get the time yet
8. eladkal

   unassigned

   omarsmak

   on May 27, 2022
9. eladkal

   added

   contributors-workshopIssues that are good for first-time contributor's workshopIssues that are good for first-time contributor's workshop

   on May 27, 2022
10. Bowrna commented on Jun 3, 2022

    

    Bowrna

    on Jun 3, 2022

    Last edited by Bowrna

    Contributor

    More actions

    Currently when I hit the below API
    http://127.0.0.1:28080/api/v1/dags/example_trigger_target_dag/details,

    I get the response:

    {
      "catchup": false,
      "concurrency": 16,
      "dag_id": "example_trigger_target_dag",
      "dag_run_timeout": null,
      "default_view": "grid",
      "description": null,
      "doc_md": null,
      "end_date": null,
      "file_token": ".eJxT0s8vKNFPzCxKy8kvh9OpFYm5BTmp8SmJ6cVwTklRZnp6alF8SWJRemoJSE6voFIJADOyGRw.vE-k8zZfRBEacXoSycU5gDkSXDk",
      "fileloc": "/opt/airflow/airflow/example_dags/example_trigger_target_dag.py",
      "is_active": true,
      "is_paused": false,
      "is_paused_upon_creation": null,
      "is_subdag": false,
      "last_parsed": "2022-06-03T11:07:15.950865+00:00",
      "max_active_runs": 16,
      "max_active_tasks": 16,
      "orientation": "LR",
      "owners": [
        "airflow"
      ],
      "params": {
    
      },
      "pickle_id": null,
      "render_template_as_native_obj": false,
      "schedule_interval": null,
      "start_date": "2021-01-01T00:00:00+00:00",
      "tags": [
        {
          "name": "example"
        }
      ],
      "timezone": "Timezone('UTC')"
    }
    

    How does setting the ScheduleInterval param to nullable:true will be useful?
    Edit: @uranusjr @omarsmak Could you help me in this?
11. uranusjr commented on Jun 6, 2022

    

    uranusjr

    on Jun 6, 2022

    Last edited by uranusjr

    Member

    More actions

    From what I understand, the problem is not in the API response, but the generated API clients. The response you have above is currently not consumable by an API client. Adding nullable: true would allow the clients to handle "schedule_interval": null correctly. The generated API clients are not a part of the main Airflow repository, but they do rely on the openapi/v1.yml file in here, so we need to fix it for them.

    👍React with 👍1Reacted by Bowrna
12. potiuk

    closed this as completedin #24253on Jun 7, 2022