Fix: make dry run optional for patch task instance

[Calder-Ty]

Fixes #34563. This sets Dry run to be optional as the docs indicate it should be and makes the default False per the docs.

---

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an 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 a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

[Calder-Ty]

This is a reopened version of #34564 which was closed by mistake (by myself).

[Calder-Ty]

I didn't want this comment to be forgotten:

#34564 (review)

[f0restron07]

Hi @Calder-Ty,

Thank you for addressing this issue and for reopening the pull request. Making dry_run optional and setting the default to False aligns the behavior of the code with the documentation, which will certainly prevent confusion and errors for API users in the future.

It is crucial that the API's behavior is consistent with the documentation to ensure a smooth and reliable user experience, and this change is a step in the right direction.

Looking at the commits, it seems you have kept the changes concise and directly related to the issue at hand, which is appreciated. It's also good to see that the checks have mostly passed, indicating that this change doesn't introduce any apparent regressions or new issues.

I look forward to seeing this change merged after the required reviews, and I believe it will be a valuable improvement to Apache Airflow.

Thank you again for your contribution!

Best regards,
f0restron

[hussein-awala]

@pierrejeambrun in the first PR, I commented with:

IMHO it's a problem in the doc, dry_run should be True by default.

WDYT? If you agree, should we fix the doc and the bug in the same PR?

[pierrejeambrun]

Yes, all other dry_run params default to True in other routes, the only 2 that do not in the doc are:

• https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html#operation/patch_task_instance
• https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html#operation/patch_mapped_task_instance

I think defaulting to true makes more sense, and is more conservative, unless explicitly stated by the user with a dry_run=False, we should run in dry run mode.

Also just for a consistency reason, dry_run should be True. Updating the doc and the schema in one place will fix both endpoints mentioned.

Yes this is a very small located change, updating both the schema and the API spec and putting this under bug fix seems fine to me :)

[Calder-Ty]

made changes to have docs and code aligned, as well as be consistent with the rest of the API (i.e Set dry_run to be true by default,

[ephraimbuddy]

We should only update here:

airflow/airflow/api_connexion/endpoints/task_instance_endpoint.py

Line 636 in d1b7bca

if not data["dry_run"]:

to use data.get(‘dry_run’, False)

[pierrejeambrun]

LGTM, this is consistent with dry_run default value for other endpoints. (And the more conservative choice, I believe)

[o-nikolas]

Other than the static check failures (should be an easy fix to the generated ts) it lgtm.

I like the fix in the schema!

[o-nikolas]

Also, are we considering this change to the default a breaking change to the API or a bugfix?

CC @eladkal

[Calder-Ty]

Also, are we considering this change to the default a breaking change to the API or a bugfix?

CC @eladkal

Technically it is, however, I think we can be fairly sure no one was depending on the functionality since it was broken.

[hussein-awala]

Also, are we considering this change to the default a breaking change to the API or a bugfix?

CC @eladkal

Based on this issue #34563, we cannot use the endpoint without providing the dry_run value, so this PR technically adds a new default value for dry_run and not changing it from False to True.

[pierrejeambrun]

Yep, what Hussein said, not a breaking change. (Field was required before)

[boring-cyborg]

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.