Skip to content

feat(sdk): v4.8.0 - Auto-generated from unified API spec #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
quant-sdk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(sdk): v4.8.0 - Auto-generated from unified API spec #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/CrawlersApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,7 +505,7 @@ Name | Type | Description | Notes
[[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)

# **crawlers_run**
> CrawlersRun200Response crawlers_run(organization, project, crawler, crawlers_run_request)
> CrawlersRun200Response crawlers_run(organization, project, crawler, crawlers_run_request=crawlers_run_request)

Run a crawler

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

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

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/CrawlersRunRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**urls** | **List[str]** | URLs to crawl | [optional]
**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]

## Example

Expand Down
14 changes: 7 additions & 7 deletions quantcdn/api/crawlers_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
from typing_extensions import Annotated

from pydantic import Field, StrictInt, StrictStr
from typing import List
from typing import List, Optional
from typing_extensions import Annotated
from quantcdn.models.crawlers_run200_response import CrawlersRun200Response
from quantcdn.models.crawlers_run_request import CrawlersRunRequest
Expand Down Expand Up @@ -1835,7 +1835,7 @@ def crawlers_run(
organization: Annotated[StrictStr, Field(description="Organization identifier")],
project: Annotated[StrictStr, Field(description="Project identifier")],
crawler: Annotated[StrictStr, Field(description="Crawler identifier")],
crawlers_run_request: CrawlersRunRequest,
crawlers_run_request: Optional[CrawlersRunRequest] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Expand All @@ -1858,7 +1858,7 @@ def crawlers_run(
:type project: str
:param crawler: Crawler identifier (required)
:type crawler: str
:param crawlers_run_request: (required)
:param crawlers_run_request:
:type crawlers_run_request: CrawlersRunRequest
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
Expand Down Expand Up @@ -1917,7 +1917,7 @@ def crawlers_run_with_http_info(
organization: Annotated[StrictStr, Field(description="Organization identifier")],
project: Annotated[StrictStr, Field(description="Project identifier")],
crawler: Annotated[StrictStr, Field(description="Crawler identifier")],
crawlers_run_request: CrawlersRunRequest,
crawlers_run_request: Optional[CrawlersRunRequest] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Expand All @@ -1940,7 +1940,7 @@ def crawlers_run_with_http_info(
:type project: str
:param crawler: Crawler identifier (required)
:type crawler: str
:param crawlers_run_request: (required)
:param crawlers_run_request:
:type crawlers_run_request: CrawlersRunRequest
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
Expand Down Expand Up @@ -1999,7 +1999,7 @@ def crawlers_run_without_preload_content(
organization: Annotated[StrictStr, Field(description="Organization identifier")],
project: Annotated[StrictStr, Field(description="Project identifier")],
crawler: Annotated[StrictStr, Field(description="Crawler identifier")],
crawlers_run_request: CrawlersRunRequest,
crawlers_run_request: Optional[CrawlersRunRequest] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Expand All @@ -2022,7 +2022,7 @@ def crawlers_run_without_preload_content(
:type project: str
:param crawler: Crawler identifier (required)
:type crawler: str
:param crawlers_run_request: (required)
:param crawlers_run_request:
:type crawlers_run_request: CrawlersRunRequest
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
Expand Down
2 changes: 1 addition & 1 deletion quantcdn/models/crawlers_run_request.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class CrawlersRunRequest(BaseModel):
"""
CrawlersRunRequest
""" # noqa: E501
urls: Optional[List[StrictStr]] = Field(default=None, description="URLs to crawl")
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.")
__properties: ClassVar[List[str]] = ["urls"]

model_config = ConfigDict(
Expand Down