This is an automated email from the ASF dual-hosted git repository.
pierrejeambrun pushed a commit to branch v3-0-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/v3-0-test by this push:
new 9d9c4c51e49 [v3-0-test] Add note about payload size considerations in
API docs (#51732) (#51768)
9d9c4c51e49 is described below
commit 9d9c4c51e492101b5fb417acae4d59612946e968
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Mon Jun 16 12:43:41 2025 +0200
[v3-0-test] Add note about payload size considerations in API docs (#51732)
(#51768)
(cherry picked from commit 69da3f7eadd25e7d7a950daa6ad170bf6002034c)
Co-authored-by: Amogh Desai <[email protected]>
---
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 115cfec443a..3f86a75b863 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.
