Skip to content

Simplify api docs on pattern search - #70202

Merged
pierrejeambrun merged 1 commit into
apache:mainfrom
astronomer:dev/api-docs-sql-descriptions-153c6e
Jul 27, 2026
Merged

Simplify api docs on pattern search#70202
pierrejeambrun merged 1 commit into
apache:mainfrom
astronomer:dev/api-docs-sql-descriptions-153c6e

Conversation

@bbovenzi

Copy link
Copy Markdown
Contributor

The verbosity and repetition of pattern search params in the API docs was annoying me. Instead, let's have a general description at the top and shorter descriptions on each parameter:

Before:
Screenshot 2026-07-21 at 3 38 40 PM

After:
Screenshot 2026-07-21 at 3 37 39 PM


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

Claude Opus 4.8


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

@boring-cyborg boring-cyborg Bot added area:API Airflow's REST/HTTP API area:UI Related to UI/UX. For Frontend Developers. labels Jul 21, 2026
@bbovenzi
bbovenzi force-pushed the dev/api-docs-sql-descriptions-153c6e branch 2 times, most recently from 6029b1d to 4ead6ed Compare July 23, 2026 15:22
@bbovenzi
bbovenzi force-pushed the dev/api-docs-sql-descriptions-153c6e branch from 4ead6ed to 439a29b Compare July 23, 2026 16:00

@pierrejeambrun pierrejeambrun left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks, LGTM

@pierrejeambrun pierrejeambrun added this to the Airflow 3.3.1 milestone Jul 27, 2026
@pierrejeambrun pierrejeambrun added the backport-to-v3-3-test Backport to v3-3-test label Jul 27, 2026
@pierrejeambrun
pierrejeambrun merged commit 6f09cd3 into apache:main Jul 27, 2026
450 of 452 checks passed
@pierrejeambrun
pierrejeambrun deleted the dev/api-docs-sql-descriptions-153c6e branch July 27, 2026 09:02
@github-actions

Copy link
Copy Markdown
Contributor

Backport failed to create: v3-3-test. View the failure log Run details

Note: As of Merging PRs targeted for Airflow 3.X
the committer who merges the PR is responsible for backporting the PRs that are bug fixes (generally speaking) to the maintenance branches.

In matter of doubt please ask in #release-management Slack channel.

Status Branch Result
v3-3-test Commit Link

You can attempt to backport this manually by running:

cherry_picker 6f09cd3 v3-3-test

This should apply the commit to the v3-3-test branch and leave the commit in conflict state marking
the files that need manual conflict resolution.

After you have resolved the conflicts, you can continue the backport process by running:

cherry_picker --continue

If you don't have cherry-picker installed, see the installation guide.

pierrejeambrun added a commit that referenced this pull request Jul 27, 2026
(cherry picked from commit 6f09cd3)

Co-authored-by: Brent Bovenzi <brent@astronomer.io>
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 area:UI Related to UI/UX. For Frontend Developers. backport-to-v3-3-test Backport to v3-3-test

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants