Skip to content

Commit b0fa819

Browse files
stainless-app[bot]stainless-bot
authored andcommitted
feat(api): OpenAPI spec update via Stainless API (#312)
1 parent 6bc0063 commit b0fa819

File tree

5 files changed

+28
-28
lines changed

5 files changed

+28
-28
lines changed

api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -298,8 +298,8 @@ from cloudflare.types.zones import DNSSetting, Nameserver
298298

299299
Methods:
300300

301-
- <code title="patch /zones/{zone_id}/dns_settings">client.zones.dns_settings.<a href="./src/cloudflare/resources/zones/dns_settings.py">edit</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/dns_setting_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/dns_setting.py">DNSSetting</a></code>
302-
- <code title="get /zones/{zone_id}/dns_settings">client.zones.dns_settings.<a href="./src/cloudflare/resources/zones/dns_settings.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/zones/dns_setting.py">DNSSetting</a></code>
301+
- <code title="patch /zones/{zone_id}/dns_settings">client.zones.dns_settings.<a href="./src/cloudflare/resources/zones/dns_settings.py">edit</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/dns_setting_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/dns_setting.py">Optional</a></code>
302+
- <code title="get /zones/{zone_id}/dns_settings">client.zones.dns_settings.<a href="./src/cloudflare/resources/zones/dns_settings.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/zones/dns_setting.py">Optional</a></code>
303303

304304
## Settings
305305

src/cloudflare/resources/zones/dns_settings.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
from __future__ import annotations
44

5-
from typing import Type, cast
5+
from typing import Type, Optional, cast
66

77
import httpx
88

@@ -51,7 +51,7 @@ def edit(
5151
extra_query: Query | None = None,
5252
extra_body: Body | None = None,
5353
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
54-
) -> DNSSetting:
54+
) -> Optional[DNSSetting]:
5555
"""
5656
Update DNS settings for a zone
5757
@@ -97,7 +97,7 @@ def edit(
9797
timeout=timeout,
9898
post_parser=ResultWrapper._unwrapper,
9999
),
100-
cast_to=cast(Type[DNSSetting], ResultWrapper[DNSSetting]),
100+
cast_to=cast(Type[Optional[DNSSetting]], ResultWrapper[DNSSetting]),
101101
)
102102

103103
def get(
@@ -110,7 +110,7 @@ def get(
110110
extra_query: Query | None = None,
111111
extra_body: Body | None = None,
112112
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
113-
) -> DNSSetting:
113+
) -> Optional[DNSSetting]:
114114
"""
115115
Show DNS settings for a zone
116116
@@ -136,7 +136,7 @@ def get(
136136
timeout=timeout,
137137
post_parser=ResultWrapper._unwrapper,
138138
),
139-
cast_to=cast(Type[DNSSetting], ResultWrapper[DNSSetting]),
139+
cast_to=cast(Type[Optional[DNSSetting]], ResultWrapper[DNSSetting]),
140140
)
141141

142142

@@ -163,7 +163,7 @@ async def edit(
163163
extra_query: Query | None = None,
164164
extra_body: Body | None = None,
165165
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
166-
) -> DNSSetting:
166+
) -> Optional[DNSSetting]:
167167
"""
168168
Update DNS settings for a zone
169169
@@ -209,7 +209,7 @@ async def edit(
209209
timeout=timeout,
210210
post_parser=ResultWrapper._unwrapper,
211211
),
212-
cast_to=cast(Type[DNSSetting], ResultWrapper[DNSSetting]),
212+
cast_to=cast(Type[Optional[DNSSetting]], ResultWrapper[DNSSetting]),
213213
)
214214

215215
async def get(
@@ -222,7 +222,7 @@ async def get(
222222
extra_query: Query | None = None,
223223
extra_body: Body | None = None,
224224
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
225-
) -> DNSSetting:
225+
) -> Optional[DNSSetting]:
226226
"""
227227
Show DNS settings for a zone
228228
@@ -248,7 +248,7 @@ async def get(
248248
timeout=timeout,
249249
post_parser=ResultWrapper._unwrapper,
250250
),
251-
cast_to=cast(Type[DNSSetting], ResultWrapper[DNSSetting]),
251+
cast_to=cast(Type[Optional[DNSSetting]], ResultWrapper[DNSSetting]),
252252
)
253253

254254

src/cloudflare/types/zones/nameserver.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88

99

1010
class Nameserver(BaseModel):
11-
type: Literal["cloudflare.standard", "cloudflare.foundation_dns"]
11+
type: Literal["cloudflare.standard"]
1212
"""Nameserver type"""

src/cloudflare/types/zones/nameserver_param.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88

99

1010
class NameserverParam(TypedDict, total=False):
11-
type: Required[Literal["cloudflare.standard", "cloudflare.foundation_dns"]]
11+
type: Required[Literal["cloudflare.standard"]]
1212
"""Nameserver type"""

tests/api_resources/zones/test_dns_settings.py

+15-15
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from __future__ import annotations
44

55
import os
6-
from typing import Any, cast
6+
from typing import Any, Optional, cast
77

88
import pytest
99

@@ -23,7 +23,7 @@ def test_method_edit(self, client: Cloudflare) -> None:
2323
dns_setting = client.zones.dns_settings.edit(
2424
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
2525
)
26-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
26+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
2727

2828
@pytest.mark.skip()
2929
@parametrize
@@ -35,7 +35,7 @@ def test_method_edit_with_all_params(self, client: Cloudflare) -> None:
3535
nameservers={"type": "cloudflare.standard"},
3636
secondary_overrides=False,
3737
)
38-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
38+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
3939

4040
@pytest.mark.skip()
4141
@parametrize
@@ -47,7 +47,7 @@ def test_raw_response_edit(self, client: Cloudflare) -> None:
4747
assert response.is_closed is True
4848
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
4949
dns_setting = response.parse()
50-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
50+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
5151

5252
@pytest.mark.skip()
5353
@parametrize
@@ -59,7 +59,7 @@ def test_streaming_response_edit(self, client: Cloudflare) -> None:
5959
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
6060

6161
dns_setting = response.parse()
62-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
62+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
6363

6464
assert cast(Any, response.is_closed) is True
6565

@@ -77,7 +77,7 @@ def test_method_get(self, client: Cloudflare) -> None:
7777
dns_setting = client.zones.dns_settings.get(
7878
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
7979
)
80-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
80+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
8181

8282
@pytest.mark.skip()
8383
@parametrize
@@ -89,7 +89,7 @@ def test_raw_response_get(self, client: Cloudflare) -> None:
8989
assert response.is_closed is True
9090
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
9191
dns_setting = response.parse()
92-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
92+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
9393

9494
@pytest.mark.skip()
9595
@parametrize
@@ -101,7 +101,7 @@ def test_streaming_response_get(self, client: Cloudflare) -> None:
101101
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
102102

103103
dns_setting = response.parse()
104-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
104+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
105105

106106
assert cast(Any, response.is_closed) is True
107107

@@ -123,7 +123,7 @@ async def test_method_edit(self, async_client: AsyncCloudflare) -> None:
123123
dns_setting = await async_client.zones.dns_settings.edit(
124124
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
125125
)
126-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
126+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
127127

128128
@pytest.mark.skip()
129129
@parametrize
@@ -135,7 +135,7 @@ async def test_method_edit_with_all_params(self, async_client: AsyncCloudflare)
135135
nameservers={"type": "cloudflare.standard"},
136136
secondary_overrides=False,
137137
)
138-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
138+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
139139

140140
@pytest.mark.skip()
141141
@parametrize
@@ -147,7 +147,7 @@ async def test_raw_response_edit(self, async_client: AsyncCloudflare) -> None:
147147
assert response.is_closed is True
148148
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
149149
dns_setting = await response.parse()
150-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
150+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
151151

152152
@pytest.mark.skip()
153153
@parametrize
@@ -159,7 +159,7 @@ async def test_streaming_response_edit(self, async_client: AsyncCloudflare) -> N
159159
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
160160

161161
dns_setting = await response.parse()
162-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
162+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
163163

164164
assert cast(Any, response.is_closed) is True
165165

@@ -177,7 +177,7 @@ async def test_method_get(self, async_client: AsyncCloudflare) -> None:
177177
dns_setting = await async_client.zones.dns_settings.get(
178178
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
179179
)
180-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
180+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
181181

182182
@pytest.mark.skip()
183183
@parametrize
@@ -189,7 +189,7 @@ async def test_raw_response_get(self, async_client: AsyncCloudflare) -> None:
189189
assert response.is_closed is True
190190
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
191191
dns_setting = await response.parse()
192-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
192+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
193193

194194
@pytest.mark.skip()
195195
@parametrize
@@ -201,7 +201,7 @@ async def test_streaming_response_get(self, async_client: AsyncCloudflare) -> No
201201
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
202202

203203
dns_setting = await response.parse()
204-
assert_matches_type(DNSSetting, dns_setting, path=["response"])
204+
assert_matches_type(Optional[DNSSetting], dns_setting, path=["response"])
205205

206206
assert cast(Any, response.is_closed) is True
207207

0 commit comments

Comments
 (0)