Skip to content

Commit 2b0e738

Browse files
chore(api): update composite API spec
1 parent 25b2838 commit 2b0e738

4 files changed

Lines changed: 29 additions & 2 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 2404
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare/cloudflare-b0af4cb139f9df7339b8fb329dd6adddc6205c60257d25a13988e168af0ac607.yml
3-
openapi_spec_hash: 0cc3334f547b32a53fbfff7feedc3d3b
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare/cloudflare-874436f83bd9c383144c69da47c4b767bb9c6f4f2bb4945af58cf3b6015f0f62.yml
3+
openapi_spec_hash: beaf9a654991bf65d642e05c03460e4c
44
config_hash: 2f529580a17438fc62cd0b47db41b6f1

src/cloudflare/resources/intel/domains/domains.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ def get(
6262
account_id: str,
6363
domain: str | Omit = omit,
6464
skip_dns: bool | Omit = omit,
65+
skip_ranking: bool | Omit = omit,
6566
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
6667
# The extra values given here take precedence over values defined on the client or passed to this method.
6768
extra_headers: Headers | None = None,
@@ -77,6 +78,12 @@ def get(
7778
7879
skip_dns: Skip DNS resolution lookups for faster response.
7980
81+
skip_ranking: Skip the domain ranking lookup for faster responses. Defaults to `false`
82+
(ranking is included). Set to `true` to opt out — primarily used by callers like
83+
Cloudflare Radar that need to avoid a circular dependency when building the
84+
domain details page. Note: the bulk endpoint (`/intel/domain/bulk`) uses
85+
opposite defaults — see `include_ranking` there.
86+
8087
extra_headers: Send extra headers
8188
8289
extra_query: Add additional query parameters to the request
@@ -98,6 +105,7 @@ def get(
98105
{
99106
"domain": domain,
100107
"skip_dns": skip_dns,
108+
"skip_ranking": skip_ranking,
101109
},
102110
domain_get_params.DomainGetParams,
103111
),
@@ -137,6 +145,7 @@ async def get(
137145
account_id: str,
138146
domain: str | Omit = omit,
139147
skip_dns: bool | Omit = omit,
148+
skip_ranking: bool | Omit = omit,
140149
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
141150
# The extra values given here take precedence over values defined on the client or passed to this method.
142151
extra_headers: Headers | None = None,
@@ -152,6 +161,12 @@ async def get(
152161
153162
skip_dns: Skip DNS resolution lookups for faster response.
154163
164+
skip_ranking: Skip the domain ranking lookup for faster responses. Defaults to `false`
165+
(ranking is included). Set to `true` to opt out — primarily used by callers like
166+
Cloudflare Radar that need to avoid a circular dependency when building the
167+
domain details page. Note: the bulk endpoint (`/intel/domain/bulk`) uses
168+
opposite defaults — see `include_ranking` there.
169+
155170
extra_headers: Send extra headers
156171
157172
extra_query: Add additional query parameters to the request
@@ -173,6 +188,7 @@ async def get(
173188
{
174189
"domain": domain,
175190
"skip_dns": skip_dns,
191+
"skip_ranking": skip_ranking,
176192
},
177193
domain_get_params.DomainGetParams,
178194
),

src/cloudflare/types/intel/domain_get_params.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,12 @@ class DomainGetParams(TypedDict, total=False):
1515

1616
skip_dns: bool
1717
"""Skip DNS resolution lookups for faster response."""
18+
19+
skip_ranking: bool
20+
"""Skip the domain ranking lookup for faster responses.
21+
22+
Defaults to `false` (ranking is included). Set to `true` to opt out — primarily
23+
used by callers like Cloudflare Radar that need to avoid a circular dependency
24+
when building the domain details page. Note: the bulk endpoint
25+
(`/intel/domain/bulk`) uses opposite defaults — see `include_ranking` there.
26+
"""

tests/api_resources/intel/test_domains.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None:
3030
account_id="023e105f4ecef8ad9ca31a8372d0c353",
3131
domain="domain",
3232
skip_dns=True,
33+
skip_ranking=True,
3334
)
3435
assert_matches_type(Optional[Domain], domain, path=["response"])
3536

@@ -83,6 +84,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) -
8384
account_id="023e105f4ecef8ad9ca31a8372d0c353",
8485
domain="domain",
8586
skip_dns=True,
87+
skip_ranking=True,
8688
)
8789
assert_matches_type(Optional[Domain], domain, path=["response"])
8890

0 commit comments

Comments
 (0)