Skip to content

feat: Add new documentation facet to all OL events #52343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kacpermuda
Copy link
Contributor

@kacpermuda kacpermuda commented Jun 27, 2025

ContentType was added to OL documentation job facet in #3748. OL client requirement was bumped in #52075 to include that change.
Now I'm adding a documentation facet to all OL events, with this new content type field.

We're checking all the fields mentioned in this doc: doc, doc_md etc.

This also introduce hierarchy, as we can only include one doc in the facet.
The order for task is the following:

  1. doc
  2. doc_md
  3. doc_json
  4. doc_yaml
  5. doc_rst

For DAG it's:

  1. doc_md
  2. description

Also for tasks if task doc is not present, we're including DAG docs (if present).

Most of the lines is from testing it properly in system tests.


^ 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 airflow-core/newsfragments.

@kacpermuda kacpermuda requested a review from mobuchowski as a code owner June 27, 2025 14:41
@kacpermuda kacpermuda force-pushed the feat-ol-doc-facet branch 2 times, most recently from ff0b151 to ab813e2 Compare June 27, 2025 15:45
@potiuk potiuk force-pushed the feat-ol-doc-facet branch from ab813e2 to 4a05014 Compare June 28, 2025 18:53
@potiuk
Copy link
Member

potiuk commented Jun 28, 2025

Rebasing to check compatibility after fixing it in main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants