This is an automated email from the ASF dual-hosted git repository. ephraimanierobi pushed a commit to branch v2-5-test in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 9f8895f2d4efd7e984929fc2f18c4657ec1bc59f Author: Bowrna <[email protected]> AuthorDate: Sun Feb 26 21:49:51 2023 +0530 better description for limit in api (#29773) (cherry picked from commit 228d79c1b3e11ecfbff5a27c900f9d49a84ad365) --- airflow/config_templates/config.yml | 11 ++++++----- airflow/config_templates/default_airflow.cfg | 11 ++++++----- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/airflow/config_templates/config.yml b/airflow/config_templates/config.yml index 699142b708..dd825209b8 100644 --- a/airflow/config_templates/config.yml +++ b/airflow/config_templates/config.yml @@ -911,17 +911,18 @@ default: "airflow.api.auth.backend.session" - name: maximum_page_limit description: | - Used to set the maximum page limit for API requests + Used to set the maximum page limit for API requests. If limit passed as param + is greater than maximum page limit, it will be ignored and maximum page limit value + will be set as the limit version_added: 2.0.0 type: integer example: ~ default: "100" - name: fallback_page_limit description: | - Used to set the default page limit when limit is zero. A default limit - of 100 is set on OpenApi spec. However, this particular default limit - only work when limit is set equal to zero(0) from API requests. - If no limit is supplied, the OpenApi spec default is used. + Used to set the default page limit when limit param is zero or not provided in API + requests. Otherwise if positive integer is passed in the API requests as limit, the + smallest number of user given limit or maximum page limit is taken as limit. type: integer example: ~ version_added: 2.0.0 diff --git a/airflow/config_templates/default_airflow.cfg b/airflow/config_templates/default_airflow.cfg index 2103d6be6d..cc5e82d3f5 100644 --- a/airflow/config_templates/default_airflow.cfg +++ b/airflow/config_templates/default_airflow.cfg @@ -492,13 +492,14 @@ enable_experimental_api = False # ("airflow.api.auth.backend.default" allows all requests for historic reasons) auth_backends = airflow.api.auth.backend.session -# Used to set the maximum page limit for API requests +# Used to set the maximum page limit for API requests. If limit passed as param +# is greater than maximum page limit, it will be ignored and maximum page limit value +# will be set as the limit maximum_page_limit = 100 -# Used to set the default page limit when limit is zero. A default limit -# of 100 is set on OpenApi spec. However, this particular default limit -# only work when limit is set equal to zero(0) from API requests. -# If no limit is supplied, the OpenApi spec default is used. +# Used to set the default page limit when limit param is zero or not provided in API +# requests. Otherwise if positive integer is passed in the API requests as limit, the +# smallest number of user given limit or maximum page limit is taken as limit. fallback_page_limit = 100 # The intended audience for JWT token credentials used for authorization. This value must match on the client and server sides. If empty, audience will not be tested.
