Skip to content

Commit 24980ca

Browse files
committed
docs(changelog): document additional breaking changes for DEXTests and IPProfiles
1 parent 90d6f2f commit 24980ca

2 files changed

Lines changed: 78 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ See the [v7.7.0 Migration Guide](./docs/migration-guides/v7.7.0-migration-guide.
1717

1818
These fields were unreadable in the previous type (marshaling panicked with `reflect: call of reflect.Value.SetString on struct Value`). The new `interface{}` type matches the codegen pattern used by sibling merged fields on the same structs (e.g. `Values`, `Fields`, `AllowedMicrosoftOrganizations`); callers should switch on the parent union via `AsUnion()` for a strongly-typed variant.
1919

20+
* **zero_trust:** `Devices.DEXTests.{New,Update,List,Get}` response type renamed from `DeviceDEXTest{New,Update,List,Get}Response` to the shared `SchemaHTTP`; field structure unchanged. Nested types renamed accordingly (e.g. `DeviceDEXTestNewResponseData` → `SchemaData`, `DeviceDEXTestNewResponseTargetPolicy` → `SchemaHTTPTargetPolicy`). Callers using `:=` inference and field access continue to compile; callers referencing the removed type names must update to `SchemaHTTP`.
21+
* **zero_trust:** `Devices.IPProfiles.List` pagination changed from `pagination.SinglePage[IPProfile]` to `pagination.V4PagePaginationArray[IPProfile]`. `.Result` field access and `ListAutoPaging()` iteration continue to work; callers referencing the pagination type by name must update.
22+
2023
### Features
2124

2225
* **NEW SERVICE: `email_auth`** — DMARC reports edit/get and SPF inspect
@@ -41,7 +44,6 @@ See the [v7.7.0 Migration Guide](./docs/migration-guides/v7.7.0-migration-guide.
4144
* `Investigate.Bulk.Messages.List`
4245
* **accounts:** add `Logs.Audit.History` and `Logs.Audit.ProductCategories` methods
4346
* **organizations:** add `Logs.Audit.History` method
44-
* **zero_trust:** add `Devices.DEXTests.{New,Update,List,Get}` and `Devices.IPProfiles.List` methods
4547

4648
### Bug Fixes
4749

docs/migration-guides/v7.7.0-migration-guide.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,83 @@ if s, ok := meta.Mode.(ai_gateway.AIGatewayNewResponseSpendLimitsRulesMetadataMo
158158

159159
---
160160

161+
### `zero_trust`
162+
163+
#### 4. Devices.DEXTests response type renamed to SchemaHTTP
164+
165+
**What changed:**
166+
The response types for the four `zero_trust.Devices.DEXTests` methods have been renamed from per-method types to a single shared type, `SchemaHTTP`. The **field structure is unchanged** — only the exported type names differ.
167+
168+
**Removed Types:**
169+
- `DeviceDEXTestNewResponse`
170+
- `DeviceDEXTestUpdateResponse`
171+
- `DeviceDEXTestListResponse`
172+
- `DeviceDEXTestGetResponse`
173+
- Nested types: `DeviceDEXTestNewResponseData`, `DeviceDEXTestNewResponseTargetPolicy`, and their `Update`/`List`/`Get` counterparts (renamed to `SchemaData`, `SchemaHTTPTargetPolicy`).
174+
175+
**Impact:**
176+
- Code using `:=` type inference and field access (`res.Enabled`, `res.Name`, etc.) continues to compile unchanged.
177+
- Code that references the removed type names directly — e.g., declaring a typed variable, passing to a helper function with a typed parameter, or type-switching — will no longer compile.
178+
179+
**Affected methods:**
180+
- `client.ZeroTrust.Devices.DEXTests.New`
181+
- `client.ZeroTrust.Devices.DEXTests.Update`
182+
- `client.ZeroTrust.Devices.DEXTests.List`
183+
- `client.ZeroTrust.Devices.DEXTests.Get`
184+
185+
**Before (v7.6.0):**
186+
```go
187+
var test *zero_trust.DeviceDEXTestNewResponse
188+
test, err = client.ZeroTrust.Devices.DEXTests.New(ctx, params)
189+
190+
func printTest(t *zero_trust.DeviceDEXTestListResponse) { /* ... */ }
191+
```
192+
193+
**After (v7.7.0):**
194+
```go
195+
var test *zero_trust.SchemaHTTP
196+
test, err = client.ZeroTrust.Devices.DEXTests.New(ctx, params)
197+
198+
func printTest(t *zero_trust.SchemaHTTP) { /* ... */ }
199+
```
200+
201+
**Actions Needed:**
202+
1. Search for `DeviceDEXTest{New,Update,List,Get}Response` and replace with `SchemaHTTP`.
203+
2. Search for `DeviceDEXTest{New,Update,List,Get}ResponseData` / `...TargetPolicy` and replace with `SchemaData` / `SchemaHTTPTargetPolicy`.
204+
205+
---
206+
207+
#### 5. Devices.IPProfiles.List pagination type changed
208+
209+
**What changed:**
210+
`client.ZeroTrust.Devices.IPProfiles.List` now returns `*pagination.V4PagePaginationArray[IPProfile]` instead of `*pagination.SinglePage[IPProfile]`.
211+
212+
**Impact:**
213+
- Code that iterates with `.ListAutoPaging(...)` continues to work — the auto-pager has the same `.Next()` / `.Current()` API.
214+
- Code that reads `.Result` (a `[]IPProfile` on both types) continues to compile.
215+
- Code that references `pagination.SinglePage[IPProfile]` explicitly in a variable declaration or function signature will no longer compile.
216+
217+
**Before (v7.6.0):**
218+
```go
219+
var page *pagination.SinglePage[zero_trust.IPProfile]
220+
page, err = client.ZeroTrust.Devices.IPProfiles.List(ctx, params)
221+
```
222+
223+
**After (v7.7.0):**
224+
```go
225+
var page *pagination.V4PagePaginationArray[zero_trust.IPProfile]
226+
page, err = client.ZeroTrust.Devices.IPProfiles.List(ctx, params)
227+
```
228+
229+
**Actions Needed:**
230+
1. Search for `pagination.SinglePage[zero_trust.IPProfile]` (and `SinglePageAutoPager[zero_trust.IPProfile]`) and replace with `V4PagePaginationArray[...]` / `V4PagePaginationArrayAutoPager[...]`.
231+
232+
---
233+
161234
## Summary of Breaking Changes
162235

163236
1. `email_routing.Rules.List` method removed (and `RuleListParams`).
164237
2. `ssl.Recommendations.Get` method removed along with `RecommendationGetResponse`, `RecommendationGetParams`, and `RecommendationService`.
165238
3. Eight union-merged parent-struct fields changed from a variant-struct type to `interface{}` across `ai_gateway`, `workflows`, and `zero_trust`.
239+
4. `zero_trust.Devices.DEXTests.{New,Update,List,Get}` response types renamed to shared `SchemaHTTP` (field structure unchanged).
240+
5. `zero_trust.Devices.IPProfiles.List` pagination changed from `SinglePage[IPProfile]` to `V4PagePaginationArray[IPProfile]`.

0 commit comments

Comments
 (0)