From 6229e4b7b744f9cd7e4cd50b2a6b342b5eda4752 Mon Sep 17 00:00:00 2001 From: Amogh Desai Date: Sat, 14 Jun 2025 20:06:13 +0530 Subject: [PATCH 1/2] Add note about payload size considerations in API docs --- airflow-core/docs/security/api.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/airflow-core/docs/security/api.rst b/airflow-core/docs/security/api.rst index 115cfec443aef..108be898b3eaf 100644 --- a/airflow-core/docs/security/api.rst +++ b/airflow-core/docs/security/api.rst @@ -93,3 +93,10 @@ Page size limit To protect against requests that may lead to application instability, the stable API has a limit of items in response. The default is 100 items, but you can change it using ``maximum_page_limit`` option in ``[api]`` section in the ``airflow.cfg`` file. + +Request Payload Considerations +----------------------------- + +When using REST APIs that accept data payloads (such as the Variables API), be mindful of the payload size. +Large payloads (out of ordinary size, like a million bytes) can impact the performance of the Airflow webserver. +It's recommended to implement appropriate size limits at the proxy layer for your deployment. From 6198ddf233e0952f2d38e8580c7e0e57fb26bb1d Mon Sep 17 00:00:00 2001 From: Amogh Desai Date: Mon, 16 Jun 2025 09:55:53 +0530 Subject: [PATCH 2/2] fixing build docs --- airflow-core/docs/security/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/airflow-core/docs/security/api.rst b/airflow-core/docs/security/api.rst index 108be898b3eaf..3f86a75b863fb 100644 --- a/airflow-core/docs/security/api.rst +++ b/airflow-core/docs/security/api.rst @@ -95,7 +95,7 @@ The default is 100 items, but you can change it using ``maximum_page_limit`` op section in the ``airflow.cfg`` file. Request Payload Considerations ------------------------------ +------------------------------ When using REST APIs that accept data payloads (such as the Variables API), be mindful of the payload size. Large payloads (out of ordinary size, like a million bytes) can impact the performance of the Airflow webserver.