23tae opened a new pull request, #67286:
URL: https://github.com/apache/airflow/pull/67286
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->
<!--
Thank you for contributing!
Please provide above a brief description of the changes made in this pull
request.
Write a good git commit message following this guide:
http://chris.beams.io/posts/git-commit/
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 (in general) for the review if you do not see reaction for
a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we
sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
* closes: #ISSUE
* related: #ISSUE
-->
This PR standardizes the Airflow Execution API error responses to follow the
RFC 9457 (Problem Details for HTTP APIs) specification.
## Description
Exceptions in the Execution API are caught at the FastAPI route boundary in
`task_instances.py` and re-raised as standard `HTTPException`s. Airflow's core
API framework then automatically formats these into RFC 9457 compliant JSON.
### Error Response Examples
This PR demonstrates two key improvements in error handling:
#### Case 1: Upgrading plain string messages to structured objects
**Before:**
```json
{
"detail": "Database error occurred"
}
```
**After:**
```json
{
"detail": {
"type": "about:blank",
"title": "Internal Server Error",
"status": 500,
"detail": "Database error occurred"
}
}
```
#### Case 2: Standardizing dictionaries while retaining custom context
**Before:**
```json
{
"detail": {
"reason": "running_elsewhere",
"message": "TI is already running elsewhere",
"current_hostname": "worker-1",
"current_pid": 12345
}
}
```
**After:**
```json
{
"detail": {
"type": "about:blank",
"title": "Conflict",
"status": 409,
"detail": "TI is already running elsewhere",
"reason": "running_elsewhere",
"current_hostname": "worker-1",
"current_pid": 12345
}
}
```
## Verification Results
I have verified the changes using `prek` and `breeze`.
* **Static Checks (Prek):** Passed
* **Unit Tests (Breeze):** Passed
---
closes: #62107
---
##### Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR,
please
change below checkbox to `[X]` followed by the name of the tool, uncomment
the "Generated-by".
-->
- [x] Yes
Generated-by: Antigravity following [the
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
---
* Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information. Note: commit author/co-author name and email in commits
become permanently public when merged.
* For fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment:
`{pr_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
You can add this file in a follow-up commit after the PR is created so you
know the PR number.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
