Skip to content

Comments

Generate openapi.json for the Execution API sub-app#43796

Merged
kaxil merged 1 commit intoapache:mainfrom
astronomer:remove-include-in-schema
Nov 7, 2024
Merged

Generate openapi.json for the Execution API sub-app#43796
kaxil merged 1 commit intoapache:mainfrom
astronomer:remove-include-in-schema

Conversation

@kaxil
Copy link
Member

@kaxil kaxil commented Nov 7, 2024

include_in_schema=False this flag meant none of the path operations were included in /execution/openapi.json. This was initially done to ensure this paths aren't included in the top-level client but since it is a separate App, it doesn't include the path operations on /openapi.json (used by UI and generated OpenAPI client) but only for App on /execution .


^ 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.

`include_in_schema=False` this flag meant none of the path operations were included in `/execution/openapi.json`. This was initially done to ensure this paths aren't included in the top-level client but since it is a separate App, it doesn't include the path operations on `/openapi.json` (used by UI and generated OpenAPI client) but only for App on `/execution` .
@ashb ashb changed the title Allow including Execution API routes in Schema for Execution App Generate openapi.json for the Execution API sub-app Nov 7, 2024
Copy link
Member

@ashb ashb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested that the operations don't shoe up in /openapi.json or in the rendered /docs, but only in /execution/openapi.json with this change.

@kaxil kaxil merged commit 24b2369 into apache:main Nov 7, 2024
@kaxil kaxil deleted the remove-include-in-schema branch November 7, 2024 17:41
@potiuk
Copy link
Member

potiuk commented Nov 11, 2024

Nice!

ellisms pushed a commit to ellisms/airflow that referenced this pull request Nov 13, 2024
`include_in_schema=False` this flag meant none of the path operations were included in `/execution/openapi.json`. This was initially done to ensure this paths aren't included in the top-level client but since it is a separate App, it doesn't include the path operations on `/openapi.json` (used by UI and generated OpenAPI client) but only for App on `/execution` .
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants