Skip to content

Standardize response schemas for variables and xcoms in Execution API#63995

Open
rjgoyln wants to merge 2 commits intoapache:mainfrom
rjgoyln:api_response
Open

Standardize response schemas for variables and xcoms in Execution API#63995
rjgoyln wants to merge 2 commits intoapache:mainfrom
rjgoyln:api_response

Conversation

@rjgoyln
Copy link

@rjgoyln rjgoyln commented Mar 20, 2026

Description

Currently, the Execution API has inconsistent response formats for success messages. While endpoints like connections.py return well-defined Pydantic schemas (e.g., ConnectionResponse), others like variables.py and xcoms.py return raw Python dictionaries (e.g., {"message": "..."}).

Returning raw dictionaries causes the OpenAPI specification to default to Any or object, which makes it difficult to generate strongly-typed SDKs and Clients.


Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

  • Read the 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) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.
@rjgoyln rjgoyln marked this pull request as ready for review March 20, 2026 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

1 participant