Skip to content

Commit ad6565c

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore(api): update composite API spec
1 parent 7b7741b commit ad6565c

9 files changed

Lines changed: 134 additions & 29 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: 2018
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-5807819d215d59200ffb9f5f7a040de93818fd7450f3a0e39ae7f7a92289bef0.yml
3-
openapi_spec_hash: 7f66c4c6998df3f3413c58189e894df4
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-d5d4d4462803aafff1863a0e621429533bc3a27662fb7261d32d9b79f9ee98fd.yml
3+
openapi_spec_hash: 202d4dd1e9e4e72678ec6290f111b5ee
44
config_hash: 7a08b6d7e050d324501d76c833118c84

‎src/cloudflare/resources/hostnames/settings/tls.py‎

Lines changed: 66 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,26 @@ def update(
6969
Args:
7070
zone_id: Identifier.
7171
72-
setting_id: The TLS Setting name.
72+
setting_id:
73+
The TLS Setting name. The value type depends on the setting:
74+
75+
- `ciphers`: value is an array of cipher suite strings (e.g.,
76+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
77+
- `min_tls_version`: value is a TLS version string (`"1.0"`, `"1.1"`, `"1.2"`,
78+
or `"1.3"`)
79+
- `http2`: value is `"on"` or `"off"`
7380
7481
hostname: The hostname for which the tls settings are set.
7582
76-
value: The tls setting value.
83+
value: The TLS setting value. The type depends on the `setting_id` used in the request
84+
path:
85+
86+
- `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g.,
87+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
88+
- `min_tls_version`: a string indicating the minimum TLS version — one of
89+
`"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`)
90+
- `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"`
91+
(e.g., `"on"`)
7792
7893
extra_headers: Send extra headers
7994
@@ -121,7 +136,14 @@ def delete(
121136
Args:
122137
zone_id: Identifier.
123138
124-
setting_id: The TLS Setting name.
139+
setting_id:
140+
The TLS Setting name. The value type depends on the setting:
141+
142+
- `ciphers`: value is an array of cipher suite strings (e.g.,
143+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
144+
- `min_tls_version`: value is a TLS version string (`"1.0"`, `"1.1"`, `"1.2"`,
145+
or `"1.3"`)
146+
- `http2`: value is `"on"` or `"off"`
125147
126148
hostname: The hostname for which the tls settings are set.
127149
@@ -169,7 +191,14 @@ def get(
169191
Args:
170192
zone_id: Identifier.
171193
172-
setting_id: The TLS Setting name.
194+
setting_id:
195+
The TLS Setting name. The value type depends on the setting:
196+
197+
- `ciphers`: value is an array of cipher suite strings (e.g.,
198+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
199+
- `min_tls_version`: value is a TLS version string (`"1.0"`, `"1.1"`, `"1.2"`,
200+
or `"1.3"`)
201+
- `http2`: value is `"on"` or `"off"`
173202
174203
extra_headers: Send extra headers
175204
@@ -233,11 +262,26 @@ async def update(
233262
Args:
234263
zone_id: Identifier.
235264
236-
setting_id: The TLS Setting name.
265+
setting_id:
266+
The TLS Setting name. The value type depends on the setting:
267+
268+
- `ciphers`: value is an array of cipher suite strings (e.g.,
269+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
270+
- `min_tls_version`: value is a TLS version string (`"1.0"`, `"1.1"`, `"1.2"`,
271+
or `"1.3"`)
272+
- `http2`: value is `"on"` or `"off"`
237273
238274
hostname: The hostname for which the tls settings are set.
239275
240-
value: The tls setting value.
276+
value: The TLS setting value. The type depends on the `setting_id` used in the request
277+
path:
278+
279+
- `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g.,
280+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
281+
- `min_tls_version`: a string indicating the minimum TLS version — one of
282+
`"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`)
283+
- `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"`
284+
(e.g., `"on"`)
241285
242286
extra_headers: Send extra headers
243287
@@ -285,7 +329,14 @@ async def delete(
285329
Args:
286330
zone_id: Identifier.
287331
288-
setting_id: The TLS Setting name.
332+
setting_id:
333+
The TLS Setting name. The value type depends on the setting:
334+
335+
- `ciphers`: value is an array of cipher suite strings (e.g.,
336+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
337+
- `min_tls_version`: value is a TLS version string (`"1.0"`, `"1.1"`, `"1.2"`,
338+
or `"1.3"`)
339+
- `http2`: value is `"on"` or `"off"`
289340
290341
hostname: The hostname for which the tls settings are set.
291342
@@ -333,7 +384,14 @@ def get(
333384
Args:
334385
zone_id: Identifier.
335386
336-
setting_id: The TLS Setting name.
387+
setting_id:
388+
The TLS Setting name. The value type depends on the setting:
389+
390+
- `ciphers`: value is an array of cipher suite strings (e.g.,
391+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
392+
- `min_tls_version`: value is a TLS version string (`"1.0"`, `"1.1"`, `"1.2"`,
393+
or `"1.3"`)
394+
- `http2`: value is `"on"` or `"off"`
337395
338396
extra_headers: Send extra headers
339397

‎src/cloudflare/types/hostnames/settings/setting.py‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,14 @@ class Setting(BaseModel):
2323
"""This is the time the tls setting was updated."""
2424

2525
value: Optional[SettingValue] = None
26-
"""The tls setting value."""
26+
"""The TLS setting value.
27+
28+
The type depends on the `setting_id` used in the request path:
29+
30+
- `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g.,
31+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
32+
- `min_tls_version`: a string indicating the minimum TLS version — one of
33+
`"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`)
34+
- `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"`
35+
(e.g., `"on"`)
36+
"""

‎src/cloudflare/types/hostnames/settings/setting_value.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
from typing import List, Union
4-
from typing_extensions import TypeAlias
4+
from typing_extensions import Literal, TypeAlias
55

66
__all__ = ["SettingValue"]
77

8-
SettingValue: TypeAlias = Union[float, str, List[str]]
8+
SettingValue: TypeAlias = Union[Literal["1.0", "1.1", "1.2", "1.3", "on", "off"], List[str]]

‎src/cloudflare/types/hostnames/settings/setting_value_param.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
from __future__ import annotations
44

55
from typing import Union
6-
from typing_extensions import TypeAlias
6+
from typing_extensions import Literal, TypeAlias
77

88
from ...._types import SequenceNotStr
99

1010
__all__ = ["SettingValueParam"]
1111

12-
SettingValueParam: TypeAlias = Union[float, str, SequenceNotStr[str]]
12+
SettingValueParam: TypeAlias = Union[Literal["1.0", "1.1", "1.2", "1.3", "on", "off"], SequenceNotStr[str]]

‎src/cloudflare/types/hostnames/settings/tls_delete_response.py‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,14 @@ class TLSDeleteResponse(BaseModel):
2323
"""This is the time the tls setting was updated."""
2424

2525
value: Optional[SettingValue] = None
26-
"""The tls setting value."""
26+
"""The TLS setting value.
27+
28+
The type depends on the `setting_id` used in the request path:
29+
30+
- `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g.,
31+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
32+
- `min_tls_version`: a string indicating the minimum TLS version — one of
33+
`"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`)
34+
- `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"`
35+
(e.g., `"on"`)
36+
"""

‎src/cloudflare/types/hostnames/settings/tls_get_response.py‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,14 @@ class TLSGetResponse(BaseModel):
2323
"""This is the time the tls setting was updated."""
2424

2525
value: Optional[SettingValue] = None
26-
"""The tls setting value."""
26+
"""The TLS setting value.
27+
28+
The type depends on the `setting_id` used in the request path:
29+
30+
- `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g.,
31+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
32+
- `min_tls_version`: a string indicating the minimum TLS version — one of
33+
`"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`)
34+
- `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"`
35+
(e.g., `"on"`)
36+
"""

‎src/cloudflare/types/hostnames/settings/tls_update_params.py‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,24 @@ class TLSUpdateParams(TypedDict, total=False):
1414
"""Identifier."""
1515

1616
setting_id: Required[Literal["ciphers", "min_tls_version", "http2"]]
17-
"""The TLS Setting name."""
17+
"""The TLS Setting name. The value type depends on the setting:
18+
19+
- `ciphers`: value is an array of cipher suite strings (e.g.,
20+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
21+
- `min_tls_version`: value is a TLS version string (`"1.0"`, `"1.1"`, `"1.2"`,
22+
or `"1.3"`)
23+
- `http2`: value is `"on"` or `"off"`
24+
"""
1825

1926
value: Required[SettingValueParam]
20-
"""The tls setting value."""
27+
"""The TLS setting value.
28+
29+
The type depends on the `setting_id` used in the request path:
30+
31+
- `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g.,
32+
`["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`)
33+
- `min_tls_version`: a string indicating the minimum TLS version — one of
34+
`"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`)
35+
- `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"`
36+
(e.g., `"on"`)
37+
"""

‎tests/api_resources/hostnames/settings/test_tls.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ def test_method_update(self, client: Cloudflare) -> None:
2828
hostname="app.example.com",
2929
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
3030
setting_id="ciphers",
31-
value=["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"],
31+
value="1.0",
3232
)
3333
assert_matches_type(Optional[Setting], tls, path=["response"])
3434

@@ -38,7 +38,7 @@ def test_raw_response_update(self, client: Cloudflare) -> None:
3838
hostname="app.example.com",
3939
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
4040
setting_id="ciphers",
41-
value=["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"],
41+
value="1.0",
4242
)
4343

4444
assert response.is_closed is True
@@ -52,7 +52,7 @@ def test_streaming_response_update(self, client: Cloudflare) -> None:
5252
hostname="app.example.com",
5353
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
5454
setting_id="ciphers",
55-
value=["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"],
55+
value="1.0",
5656
) as response:
5757
assert not response.is_closed
5858
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -69,15 +69,15 @@ def test_path_params_update(self, client: Cloudflare) -> None:
6969
hostname="app.example.com",
7070
zone_id="",
7171
setting_id="ciphers",
72-
value=["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"],
72+
value="1.0",
7373
)
7474

7575
with pytest.raises(ValueError, match=r"Expected a non-empty value for `hostname` but received ''"):
7676
client.hostnames.settings.tls.with_raw_response.update(
7777
hostname="",
7878
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
7979
setting_id="ciphers",
80-
value=["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"],
80+
value="1.0",
8181
)
8282

8383
@parametrize
@@ -187,7 +187,7 @@ async def test_method_update(self, async_client: AsyncCloudflare) -> None:
187187
hostname="app.example.com",
188188
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
189189
setting_id="ciphers",
190-
value=["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"],
190+
value="1.0",
191191
)
192192
assert_matches_type(Optional[Setting], tls, path=["response"])
193193

@@ -197,7 +197,7 @@ async def test_raw_response_update(self, async_client: AsyncCloudflare) -> None:
197197
hostname="app.example.com",
198198
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
199199
setting_id="ciphers",
200-
value=["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"],
200+
value="1.0",
201201
)
202202

203203
assert response.is_closed is True
@@ -211,7 +211,7 @@ async def test_streaming_response_update(self, async_client: AsyncCloudflare) ->
211211
hostname="app.example.com",
212212
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
213213
setting_id="ciphers",
214-
value=["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"],
214+
value="1.0",
215215
) as response:
216216
assert not response.is_closed
217217
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -228,15 +228,15 @@ async def test_path_params_update(self, async_client: AsyncCloudflare) -> None:
228228
hostname="app.example.com",
229229
zone_id="",
230230
setting_id="ciphers",
231-
value=["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"],
231+
value="1.0",
232232
)
233233

234234
with pytest.raises(ValueError, match=r"Expected a non-empty value for `hostname` but received ''"):
235235
await async_client.hostnames.settings.tls.with_raw_response.update(
236236
hostname="",
237237
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
238238
setting_id="ciphers",
239-
value=["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"],
239+
value="1.0",
240240
)
241241

242242
@parametrize

0 commit comments

Comments
 (0)