Merge pull request #12 from Gallaecio/max-request-docs

Clarify how max requests work for error responses
zytedata · Nov 8, 2023 · ca4dfb9 · ca4dfb9
2 parents 01c236b + e6828b8
commit ca4dfb9
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/tests/test_ecommerce.py b/tests/test_ecommerce.py
@@ -385,7 +385,13 @@ def test_metadata():
                     "anyOf": [{"type": "integer"}, {"type": "null"}],
                     "default": None,
                     "title": "Max Requests",
-                    "description": "The max number of Zyte API requests allowed for the crawl.",
+                    "description": (
+                        "The maximum number of Zyte API requests allowed for the crawl.\n"
+                        "\n"
+                        "Requests with error responses that cannot be retried or exceed "
+                        "their retry limit also count here, but they incur in no costs "
+                        "and do not increase the request count in Scrapy Cloud."
+                    ),
                     "widget": "request-limit",
                 },
                 "url": {

diff --git a/zyte_spider_templates/spiders/base.py b/zyte_spider_templates/spiders/base.py
@@ -37,7 +37,13 @@ class BaseSpiderParams(BaseModel):
         },
     )
     max_requests: Optional[int] = Field(
-        description="The max number of Zyte API requests allowed for the crawl.",
+        description=(
+            "The maximum number of Zyte API requests allowed for the crawl.\n"
+            "\n"
+            "Requests with error responses that cannot be retried or exceed "
+            "their retry limit also count here, but they incur in no costs "
+            "and do not increase the request count in Scrapy Cloud."
+        ),
         default=None,
         json_schema_extra={
             "widget": "request-limit",