feat: Add new documentation facet to all OL events#52343
feat: Add new documentation facet to all OL events#52343mobuchowski merged 1 commit intoapache:mainfrom
Conversation
ff0b151 to
ab813e2
Compare
ab813e2 to
4a05014
Compare
|
Rebasing to check compatibility after fixing it in main. |
5d06a9b to
68a00e2
Compare
|
@kacpermuda just one question - is there any practical limit on the size of the documentation? Only thing I'm worried about here is the potential impact on event size. |
|
Yeah, good point, I don't think there is one. We can set some limit in the provider, I'll add some variable for that, wdyt should be the max size of such docs? I'm not sure if we should allow users to configure this limit, maybe instead we'll introduce some event size limits that can be configured (globally or per transport), if such need occurs. |
|
For now, maybe hardcode the length to something like 64kb and truncate the field if it gets larger? |
68a00e2 to
48a28a7
Compare
|
Added |
48a28a7 to
6a9f527
Compare
|
Thanks! |
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:
docdoc_mddoc_jsondoc_yamldoc_rstFor DAG it's:
doc_mddescriptionAlso 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.rstor{issue_number}.significant.rst, in airflow-core/newsfragments.