Skip to content
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

better description for limit in api #29773

Merged
merged 1 commit into from
Feb 26, 2023
Merged

Conversation

Bowrna
Copy link
Contributor

@Bowrna Bowrna commented Feb 26, 2023

I have made changes in config.yml file with better description for maximum page limit and fallback page limit
closes: #27425


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

@potiuk
Copy link
Member

potiuk commented Feb 26, 2023

I agree it was confusing and the way it is described now is vey accurate. Thanks @Bowrna for that.

Additionally - maybe that would be an option to consider as a follow-up we could print (if not already done) warning in webserver's logs in case someone uses page limit higher than maximum? This way there would be at least an indication in the logs that someone is doing something not really expected and the admins of Airflow could potentially warn the user of the API about it.

@potiuk potiuk merged commit 228d79c into apache:main Feb 26, 2023
@Bowrna
Copy link
Contributor Author

Bowrna commented Feb 26, 2023

I agree it was confusing and the way it is described now is vey accurate. Thanks @Bowrna for that.

Additionally - maybe that would be an option to consider as a follow-up we could print (if not already done) warning in webserver's logs in case someone uses page limit higher than maximum? This way there would be at least an indication in the logs that someone is doing something not really expected and the admins of Airflow could potentially warn the user of the API about it.

yes completely agree with you on this point @potiuk There is high chance for user to miss out reading the description. Throwing this information in the logs is the best way to prevent such confusion. I will do that part.

@pierrejeambrun pierrejeambrun added this to the Airflow 2.5.2 milestone Feb 27, 2023
@pierrejeambrun pierrejeambrun added changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) type:doc-only Changelog: Doc Only and removed type:doc-only Changelog: Doc Only changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) labels Feb 27, 2023
pierrejeambrun pushed a commit that referenced this pull request Mar 7, 2023
pierrejeambrun pushed a commit that referenced this pull request Mar 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:doc-only Changelog: Doc Only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

get_dags does not fetch more than 100 dags.
3 participants