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.

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

Misleading "Update a DAG" REST API example #19402

Closed
1 of 2 tasks
jakubczaplicki opened this issue Nov 4, 2021 · 4 comments
Closed
1 of 2 tasks

Misleading "Update a DAG" REST API example #19402

jakubczaplicki opened this issue Nov 4, 2021 · 4 comments
Labels
area:API Airflow's REST/HTTP API kind:bug This is a clearly a bug kind:documentation

Comments

@jakubczaplicki
Copy link
Contributor

jakubczaplicki commented Nov 4, 2021

Describe the issue with documentation

On https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html#operation/patch_dag
the payload in the example for PATCH /dags/{dag_id} suggest that it's possible to update schedule_interval which is not true :

{
"is_paused": true,
"schedule_interval": {
"__type": "string",
"days": 0,
"seconds": 0,
"microseconds": 0
}
}

How to solve the problem

Update documentation removing the schedule_interval part from payload

Anything else

No response

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

@jakubczaplicki jakubczaplicki added kind:bug This is a clearly a bug kind:documentation labels Nov 4, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Nov 4, 2021

Thanks for opening your first issue here! Be sure to follow the issue template!

@mik-laj mik-laj added the area:API Airflow's REST/HTTP API label Nov 4, 2021
@mik-laj
Copy link
Member

mik-laj commented Nov 5, 2021

This is a problem with Redoc. It is possible that updating the library will fix the problem.

redoc@^2.0.0-rc.54:

redoc_script_url = "https://cdn.jsdelivr.net/npm/[email protected]/bundles/redoc.standalone.js"

If that doesn't help, we should report the problem to this project, because there is nothing we can do on our side.

@mik-laj
Copy link
Member

mik-laj commented Nov 5, 2021

Duplicate: #15917

@jakubczaplicki
Copy link
Contributor Author

Thanks @mik-laj I've created a PR for adding an explicite example : #19465

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:API Airflow's REST/HTTP API kind:bug This is a clearly a bug kind:documentation
Projects
None yet
Development

No branches or pull requests

2 participants