Skip to content

Commit 0e138b9

Browse files
committed
chore: v5.0.0 changelog and migration guide
1 parent 6b44004 commit 0e138b9

2 files changed

Lines changed: 149 additions & 41 deletions

File tree

CHANGELOG.md

Lines changed: 106 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,120 @@
22

33
## 5.0.0 (2026-04-30)
44

5-
Full Changelog: [v5.0.0-beta.2...v5.0.0](https://github.com/cloudflare/cloudflare-python/compare/v5.0.0-beta.2...v5.0.0)
6-
7-
### Features
8-
9-
* **api:** api update ([3b83baa](https://github.com/cloudflare/cloudflare-python/commit/3b83baa3be725513c98c33e678886f83f5c6b2ce))
10-
* chore: remove account_id and zone_id client options ([988df86](https://github.com/cloudflare/cloudflare-python/commit/988df8632b0b531c5b1117ecd7ed7d77925dd5ac))
11-
* feat: add organization audit logs endpoint ([6810580](https://github.com/cloudflare/cloudflare-python/commit/681058048aedeb0983d182b1168b131c332e1477))
12-
* feat(cache): Add origin cloud regions resource to docs/sdk for new API ([c7b5b51](https://github.com/cloudflare/cloudflare-python/commit/c7b5b51764e7c343140d91d4fd86cf7275eec271))
13-
* feat(iam): add user_groups and user_group_members terraform resources ([cb00d08](https://github.com/cloudflare/cloudflare-python/commit/cb00d08d86197bddbd55bd3107473c1e363c12c4))
14-
15-
16-
### Bug Fixes
17-
18-
* **_models:** add polymorphic_serialization parameter to model_dump overrides ([342b5a8](https://github.com/cloudflare/cloudflare-python/commit/342b5a84daaf5c09e3e1612809d956d916a43621))
19-
* **ci:** pin single Python version to match pre-uv test behavior ([86676bc](https://github.com/cloudflare/cloudflare-python/commit/86676bca670d38d5947041bc5677138640dd6d92))
20-
* **ci:** run tests with single Python version and pydantic v2 only ([3259115](https://github.com/cloudflare/cloudflare-python/commit/3259115d9c1c5e2f116adda878851afc86ce5239))
21-
* **pipelines:** add BaseModel base to response SchemaFieldStruct/SchemaFieldList stubs ([d33af8b](https://github.com/cloudflare/cloudflare-python/commit/d33af8b5d5c1705fde4ae73efdbe3bfe3ba321df))
22-
* **radar:** move type: ignore[call-arg] to call site for mypy ([fac9404](https://github.com/cloudflare/cloudflare-python/commit/fac9404ebfa1eb5383a3d3c54f49e4120eb8cd11))
5+
Full Changelog: [v4.3.1...v5.0.0](https://github.com/cloudflare/cloudflare-python/compare/v4.3.1...v5.0.0)
6+
7+
This is a major release of the Cloudflare Python SDK. It drops support for
8+
Python 3.8, adds 11 new API services, introduces optional aiohttp backend
9+
support for improved async concurrency, and includes hundreds of type and
10+
method updates across the entire API surface.
11+
12+
Please review the breaking changes below before upgrading. A migration guide
13+
is available at [docs/migration-guides/v5.0.0-migration-guide.md](./docs/migration-guides/v5.0.0-migration-guide.md).
14+
15+
---
16+
17+
#### Breaking Changes
18+
19+
- **Python 3.8 is no longer supported.** The minimum required version is now Python 3.9. ([pyproject.toml](https://github.com/cloudflare/cloudflare-python/compare/v4.3.1...v5.0.0))
20+
- **`typing-extensions` minimum version bumped** from `>=4.10` to `>=4.14`.
21+
22+
Additionally, the following resources have breaking changes:
23+
24+
- `abusereports`
25+
- `acm.totaltls`
26+
- `apigateway.configurations`
27+
- `cloudforceone.threatevents`
28+
- `d1.database`
29+
- `intel.indicatorfeeds`
30+
- `logpush.edge`
31+
- `origintlsclientauth.hostnames`
32+
- `queues.consumers`
33+
- `radar.bgp`
34+
- `rulesets.rules`
35+
- `schemavalidation.schemas`
36+
- `snippets`
37+
- `zerotrust.dlp`
38+
- `zerotrust.networks`
39+
40+
See the [v5.0.0 Migration Guide](./docs/migration-guides/v5.0.0-migration-guide.md) for upgrade instructions and resource-specific guidance.
41+
42+
---
43+
44+
#### Features
45+
46+
* **aiohttp backend support:** The async client now supports an optional `aiohttp` HTTP backend for improved concurrency performance. Install with `pip install cloudflare[aiohttp]` and use `DefaultAioHttpClient()` as the `http_client` parameter.
47+
* **Python 3.13 and 3.14 support** added as tested classifiers.
48+
49+
##### New Services
50+
51+
The following top-level resources are new in this release:
52+
53+
* **AISearch** (`aisearch`): AI-powered search capabilities
54+
* **Connectivity** (`connectivity`): Connectivity testing and diagnostics
55+
* **EmailSending** (`email_sending`): Email send and send_raw endpoints
56+
* **Fraud** (`fraud`): Fraud detection and prevention
57+
* **GoogleTagGateway** (`google_tag_gateway`): Google Tag Gateway management
58+
* **Organizations** (`organizations`): Organization audit logs and management
59+
* **R2DataCatalog** (`r2_data_catalog`): R2 Data Catalog operations
60+
* **RealtimeKit** (`realtime_kit`): Realtime communication (Calls/TURN)
61+
* **ResourceTagging** (`resource_tagging`): Resource tagging and labeling
62+
* **TokenValidation** (`token_validation`): Token validation configuration and rules
63+
* **VulnerabilityScanner** (`vulnerability_scanner`): Vulnerability scanning, credential sets, and target environments
64+
65+
##### New Endpoints on Existing Services
66+
67+
* **accounts:** update generated types and methods
68+
* **api_gateway:** add labels endpoints (WAM-1196)
69+
* **billing:** add billable usage PayGo endpoint
70+
* **brand_protection:** add v2 endpoints
71+
* **browser_rendering:** add devtools methods (BRAPI-1051)
72+
* **cache:** add origin cloud regions resource
73+
* **custom_origin_trust_store:** enable custom origin trust store
74+
* **dns:** add dns_records/usage endpoints (DNS-12466)
75+
* **email_security:** add phishguard reports endpoint
76+
* **iam:** add user_groups and user_group_members resources
77+
* **radar:** add Botnet Threat Feed and Post-Quantum endpoints
78+
* **workers:** add Observability Destinations resources (WO-989)
79+
* **zero_trust:** add Access Users endpoint (AUTH-7071), DEX rules, Device IP Profile, Device Subnet, WARP Connector connections and failover endpoints, WARP Subnet endpoints, Gateway PAC files (GIN-1439)
80+
* **zones:** add zone environments endpoints
81+
82+
##### Updated Services
83+
84+
Nearly every existing service received type and method updates through
85+
composite API spec refreshes. Notable updates include:
86+
87+
* **email_security:** remove deprecated type definitions
88+
* **radar:** restructured to use per-resource api.md sub-files (no client path changes)
89+
* **workers_for_platforms:** update generated types
90+
* **r2:** update generated types
91+
* **fraud:** update generated types and methods
92+
93+
94+
#### Bug Fixes
95+
96+
* **_models:** add `polymorphic_serialization` parameter to `model_dump` overrides ([342b5a8](https://github.com/cloudflare/cloudflare-python/commit/342b5a84daaf5c09e3e1612809d956d916a43621))
97+
* **pipelines:** add `BaseModel` base to response `SchemaFieldStruct`/`SchemaFieldList` stubs ([d33af8b](https://github.com/cloudflare/cloudflare-python/commit/d33af8b5d5c1705fde4ae73efdbe3bfe3ba321df))
98+
* **dlp:** add missing `model_rebuild`/`update_forward_refs` for `SharedEntryCustomEntry` classes ([25ec10c](https://github.com/cloudflare/cloudflare-python/commit/25ec10c814d138f8dea08a79f9984b70abb58477))
99+
* **workers:** make `RunQueryParametersNeedleValue` a `BaseModel` with `arbitrary_types_allowed` ([6b7efbc](https://github.com/cloudflare/cloudflare-python/commit/6b7efbc51e6189ba18225c57637015f050060683))
100+
* **stream:** remove duplicate `notification_url` field in webhook response types ([fc9fb2f](https://github.com/cloudflare/cloudflare-python/commit/fc9fb2f895c5de968f67c62bb599a6792be9fa8f))
23101
* resolve pre-existing codegen type errors ([fed88d6](https://github.com/cloudflare/cloudflare-python/commit/fed88d6c5a5e482a9de595a1431915320fa11d23))
102+
* **radar:** fix `type: ignore[call-arg]` placement for mypy compatibility ([fac9404](https://github.com/cloudflare/cloudflare-python/commit/fac9404ebfa1eb5383a3d3c54f49e4120eb8cd11))
103+
* fix broken reference for the queues `consumer` model ([3f5cf39](https://github.com/cloudflare/cloudflare-python/commit/3f5cf39405b6b38fc594ce348d93a6e7da92c276))
24104

25105

26-
### Chores
106+
#### Chores
27107

28-
* **accounts:** update generated types ([7ff4adf](https://github.com/cloudflare/cloudflare-python/commit/7ff4adf1cf53aae127ffcf059dbfd60620c661e5))
29-
* **aisearch:** update generated types and methods ([f22897e](https://github.com/cloudflare/cloudflare-python/commit/f22897e1ec7ac175278e5481c4855b44fe093a9d))
30-
* **aisearch:** update generated types, remove unused tests ([e20c138](https://github.com/cloudflare/cloudflare-python/commit/e20c1386bec9181c3dd6dae42a6dee58fc62f1fb))
31-
* **api:** update composite API spec ([511b508](https://github.com/cloudflare/cloudflare-python/commit/511b508a3dcdbce558c32bee20a2d2e2edefa689))
32-
* **api:** update composite API spec ([0ee5719](https://github.com/cloudflare/cloudflare-python/commit/0ee571927b0b9656256ed22d76a412b262241f44))
33-
* **api:** update composite API spec ([6bf05ea](https://github.com/cloudflare/cloudflare-python/commit/6bf05ea320bcbdf1d9fd30edc6d9a19a626a7d22))
34-
* **api:** update composite API spec ([fd0fca0](https://github.com/cloudflare/cloudflare-python/commit/fd0fca0667e9ca3837629d1aeb1ede7134f0253d))
35-
* **api:** update composite API spec ([67db9e9](https://github.com/cloudflare/cloudflare-python/commit/67db9e976b1f31e0a4526c76b8149390be128bd8))
36-
* **api:** update composite API spec ([0fd3baf](https://github.com/cloudflare/cloudflare-python/commit/0fd3baf76be724534d7693eb5a2c3da1b5144c57))
37-
* **api:** update composite API spec ([42c4dbf](https://github.com/cloudflare/cloudflare-python/commit/42c4dbfa49e879c59dd5e1100c9d5c0191c968d2))
38-
* **api:** upload stainless config from cloudflare-config ([0d64642](https://github.com/cloudflare/cloudflare-python/commit/0d646425898be57e654301e98c37beeb69d541c4))
39-
* apply shared infrastructure changes (rye -> uv migration) ([2f283c2](https://github.com/cloudflare/cloudflare-python/commit/2f283c29584b49e7c000f5e04aa5edc62db36ab9))
40-
* **email_security:** remove deprecated type definitions ([878e3d4](https://github.com/cloudflare/cloudflare-python/commit/878e3d461cc5704a76665cb47e73b0f153f10546))
41-
* **fraud:** update generated types and methods ([771c7e4](https://github.com/cloudflare/cloudflare-python/commit/771c7e45ce91554f4897bdc8cdea0ceedc2c48ab))
42-
* **internal:** version bump ([0a576fa](https://github.com/cloudflare/cloudflare-python/commit/0a576fa0cbe15e8ebee4ff4ca489d8362885231e))
43-
* **r2:** update generated types ([2e7856d](https://github.com/cloudflare/cloudflare-python/commit/2e7856d879a82674f6f141c6eef33576694cca0a))
44-
* **radar:** update to_markdown type ignore comments ([d721964](https://github.com/cloudflare/cloudflare-python/commit/d721964e85978708190d31ba12a15b05f840c0b7))
45-
* sync shared codegen files from staging-next ([2802feb](https://github.com/cloudflare/cloudflare-python/commit/2802feb0090eb951a2393b7677b2601ed279d85f))
46-
* **workers_for_platforms:** update generated types ([f342310](https://github.com/cloudflare/cloudflare-python/commit/f3423103c48ad1308775105be71e2243ab1865ed))
108+
* **build:** migrate from rye to uv for project management ([2f283c2](https://github.com/cloudflare/cloudflare-python/commit/2f283c29584b49e7c000f5e04aa5edc62db36ab9))
109+
* **ci:** pin single Python version and pydantic v2 for test runs ([86676bc](https://github.com/cloudflare/cloudflare-python/commit/86676bca670d38d5947041bc5677138640dd6d92))
110+
* **typing:** add mypy configuration with strict mode ([pyproject.toml](https://github.com/cloudflare/cloudflare-python/compare/v4.3.1...v5.0.0))
111+
* **api:** 80+ composite API spec updates across the release cycle
47112

48113

49-
### Documentation
114+
#### Documentation
50115

51116
* add Authentication section to README ([70d934a](https://github.com/cloudflare/cloudflare-python/commit/70d934abd91cfa8f8444e0651ac97012c1d0edcf))
117+
* add aiohttp backend usage instructions to README
118+
* add MCP server integration badges (Cursor, VS Code)
52119

53120
## 5.0.0-beta.2 (2026-04-20)
54121

docs/v5-migration-guide.md renamed to docs/migration-guides/v5.0.0-migration-guide.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,50 @@ This guide helps you migrate your code from v4.3.1 to v5 of the Cloudflare Pytho
66

77
Version 5 introduces several breaking changes across multiple resources. This guide provides detailed migration instructions for each affected resource.
88

9-
**Important**: This is a beta release. APIs and types may change before the final v5.0.0 release.
9+
## Broad Breaking Changes
1010

11-
## Quick Reference
11+
### 1. Python 3.8 is no longer supported
12+
13+
**What changed:**
14+
The minimum required Python version is now 3.9. Python 3.8 reached end-of-life
15+
in October 2024.
16+
17+
**Impact:**
18+
If you are running Python 3.8, your application will fail to install or run
19+
with cloudflare v5.0.0.
20+
21+
**Actions Needed:**
22+
1. Upgrade to Python 3.9 or later (3.12+ recommended).
23+
2. Update any CI/CD pipelines or Docker images that pin Python 3.8.
24+
3. Review your `pyproject.toml` or `setup.py` for `python_requires` constraints.
25+
26+
**Before (v4.x):**
27+
```
28+
requires-python = ">= 3.8"
29+
```
30+
31+
**After (v5.0.0):**
32+
```
33+
requires-python = ">= 3.9"
34+
```
35+
36+
### 2. typing-extensions minimum version bumped
37+
38+
**What changed:**
39+
The minimum version of `typing-extensions` was raised from `>=4.10` to `>=4.14`.
40+
41+
**Impact:**
42+
If you pin `typing-extensions` to a version below 4.14, dependency resolution
43+
will fail.
44+
45+
**Actions Needed:**
46+
1. Update any version pins on `typing-extensions` to `>=4.14`.
47+
2. Run `pip install --upgrade typing-extensions` or let your dependency
48+
resolver handle it.
49+
50+
---
51+
52+
## Quick Reference for Resource Changes
1253

1354
Resources with breaking changes:
1455

0 commit comments

Comments
 (0)