Skip to content

Commit fddaf42

Browse files
feat(sdk): v4.8.0 - Auto-generated from unified API spec
Generated from unified API spec v4.8.0 Changes: - Auto-generated SDK updates This PR was automatically created by the API generation pipeline.
1 parent e2be0cc commit fddaf42

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

docs/CrawlersApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ Name | Type | Description | Notes
505505
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
506506

507507
# **crawlers_run**
508-
> CrawlersRun200Response crawlers_run(organization, project, crawler, crawlers_run_request)
508+
> CrawlersRun200Response crawlers_run(organization, project, crawler, crawlers_run_request=crawlers_run_request)
509509
510510
Run a crawler
511511

@@ -543,11 +543,11 @@ with quantcdn.ApiClient(configuration) as api_client:
543543
organization = 'test-org' # str | Organization identifier
544544
project = 'test-project' # str | Project identifier
545545
crawler = '00000000-0000-0000-0000-000000000000' # str | Crawler identifier
546-
crawlers_run_request = quantcdn.CrawlersRunRequest() # CrawlersRunRequest |
546+
crawlers_run_request = quantcdn.CrawlersRunRequest() # CrawlersRunRequest | (optional)
547547

548548
try:
549549
# Run a crawler
550-
api_response = api_instance.crawlers_run(organization, project, crawler, crawlers_run_request)
550+
api_response = api_instance.crawlers_run(organization, project, crawler, crawlers_run_request=crawlers_run_request)
551551
print("The response of CrawlersApi->crawlers_run:\n")
552552
pprint(api_response)
553553
except Exception as e:
@@ -564,7 +564,7 @@ Name | Type | Description | Notes
564564
**organization** | **str**| Organization identifier |
565565
**project** | **str**| Project identifier |
566566
**crawler** | **str**| Crawler identifier |
567-
**crawlers_run_request** | [**CrawlersRunRequest**](CrawlersRunRequest.md)| |
567+
**crawlers_run_request** | [**CrawlersRunRequest**](CrawlersRunRequest.md)| | [optional]
568568

569569
### Return type
570570

docs/CrawlersRunRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**urls** | **List[str]** | URLs to crawl | [optional]
8+
**urls** | **List[str]** | Optional URLs to crawl (overrides crawler's default URL configuration). If not provided, the crawler will use its configured URLs or perform a full crawl. | [optional]
99

1010
## Example
1111

quantcdn/api/crawlers_api.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
from typing_extensions import Annotated
1818

1919
from pydantic import Field, StrictInt, StrictStr
20-
from typing import List
20+
from typing import List, Optional
2121
from typing_extensions import Annotated
2222
from quantcdn.models.crawlers_run200_response import CrawlersRun200Response
2323
from quantcdn.models.crawlers_run_request import CrawlersRunRequest
@@ -1835,7 +1835,7 @@ def crawlers_run(
18351835
organization: Annotated[StrictStr, Field(description="Organization identifier")],
18361836
project: Annotated[StrictStr, Field(description="Project identifier")],
18371837
crawler: Annotated[StrictStr, Field(description="Crawler identifier")],
1838-
crawlers_run_request: CrawlersRunRequest,
1838+
crawlers_run_request: Optional[CrawlersRunRequest] = None,
18391839
_request_timeout: Union[
18401840
None,
18411841
Annotated[StrictFloat, Field(gt=0)],
@@ -1858,7 +1858,7 @@ def crawlers_run(
18581858
:type project: str
18591859
:param crawler: Crawler identifier (required)
18601860
:type crawler: str
1861-
:param crawlers_run_request: (required)
1861+
:param crawlers_run_request:
18621862
:type crawlers_run_request: CrawlersRunRequest
18631863
:param _request_timeout: timeout setting for this request. If one
18641864
number provided, it will be total request
@@ -1917,7 +1917,7 @@ def crawlers_run_with_http_info(
19171917
organization: Annotated[StrictStr, Field(description="Organization identifier")],
19181918
project: Annotated[StrictStr, Field(description="Project identifier")],
19191919
crawler: Annotated[StrictStr, Field(description="Crawler identifier")],
1920-
crawlers_run_request: CrawlersRunRequest,
1920+
crawlers_run_request: Optional[CrawlersRunRequest] = None,
19211921
_request_timeout: Union[
19221922
None,
19231923
Annotated[StrictFloat, Field(gt=0)],
@@ -1940,7 +1940,7 @@ def crawlers_run_with_http_info(
19401940
:type project: str
19411941
:param crawler: Crawler identifier (required)
19421942
:type crawler: str
1943-
:param crawlers_run_request: (required)
1943+
:param crawlers_run_request:
19441944
:type crawlers_run_request: CrawlersRunRequest
19451945
:param _request_timeout: timeout setting for this request. If one
19461946
number provided, it will be total request
@@ -1999,7 +1999,7 @@ def crawlers_run_without_preload_content(
19991999
organization: Annotated[StrictStr, Field(description="Organization identifier")],
20002000
project: Annotated[StrictStr, Field(description="Project identifier")],
20012001
crawler: Annotated[StrictStr, Field(description="Crawler identifier")],
2002-
crawlers_run_request: CrawlersRunRequest,
2002+
crawlers_run_request: Optional[CrawlersRunRequest] = None,
20032003
_request_timeout: Union[
20042004
None,
20052005
Annotated[StrictFloat, Field(gt=0)],
@@ -2022,7 +2022,7 @@ def crawlers_run_without_preload_content(
20222022
:type project: str
20232023
:param crawler: Crawler identifier (required)
20242024
:type crawler: str
2025-
:param crawlers_run_request: (required)
2025+
:param crawlers_run_request:
20262026
:type crawlers_run_request: CrawlersRunRequest
20272027
:param _request_timeout: timeout setting for this request. If one
20282028
number provided, it will be total request

quantcdn/models/crawlers_run_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class CrawlersRunRequest(BaseModel):
2626
"""
2727
CrawlersRunRequest
2828
""" # noqa: E501
29-
urls: Optional[List[StrictStr]] = Field(default=None, description="URLs to crawl")
29+
urls: Optional[List[StrictStr]] = Field(default=None, description="Optional URLs to crawl (overrides crawler's default URL configuration). If not provided, the crawler will use its configured URLs or perform a full crawl.")
3030
__properties: ClassVar[List[str]] = ["urls"]
3131

3232
model_config = ConfigDict(

0 commit comments

Comments
 (0)