Skip to content

Conversation

@prdai
Copy link
Contributor

@prdai prdai commented Oct 4, 2025

This PR addresses a TODO comment in chart/docs/conf.py by improving the _get_params function to correctly handle parameters defined as arrays in the Helm chart schema.

Summary

  • Adds logic to detect when a schema node is of type array.
  • Ensures that array parameter names are properly suffixed with [] when flattened for documentation.
  • Refactors the existing loop to include consistent section mapping and output generation.

Why

Previously, _get_params skipped over array-type properties, resulting in incomplete or inconsistent parameter documentation in chart docs.
This change improves schema coverage and makes the documentation generator output align with actual Helm values structure.

@github-actions
Copy link

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Nov 21, 2025
@prdai prdai requested a review from jscheffl as a code owner November 21, 2025 16:17
@github-actions github-actions bot removed the stale Stale PRs per the .github/workflows/stale.yml policy file label Nov 22, 2025
@jscheffl jscheffl merged commit a7fc9c6 into apache:main Nov 30, 2025
85 checks passed
RoyLee1224 pushed a commit to RoyLee1224/airflow that referenced this pull request Dec 3, 2025
…6389)

* feat(docs): fix array parameter flattening in _get_params

* fix: ensure null values are handled

* chore: fix ci/cd

---------

Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Co-authored-by: Jens Scheffler <95105677+jscheffl@users.noreply.github.com>
Copilot AI pushed a commit to jason810496/airflow that referenced this pull request Dec 5, 2025
…6389)

* feat(docs): fix array parameter flattening in _get_params

* fix: ensure null values are handled

* chore: fix ci/cd

---------

Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Co-authored-by: Jens Scheffler <95105677+jscheffl@users.noreply.github.com>
itayweb pushed a commit to itayweb/airflow that referenced this pull request Dec 6, 2025
…6389)

* feat(docs): fix array parameter flattening in _get_params

* fix: ensure null values are handled

* chore: fix ci/cd

---------

Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Co-authored-by: Jens Scheffler <95105677+jscheffl@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants