Skip to content

Commit f9bb4f3

Browse files
committed
update release notes
1 parent 1433f02 commit f9bb4f3

File tree

1 file changed

+32
-23
lines changed

1 file changed

+32
-23
lines changed

src/release/RELEASE-NOTES

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,47 +11,56 @@
1111

1212
- **Deleting Archived Items:** The SDK now supports deleting items from the archive.
1313

14-
### ⚠️ BREAKING CHANGES ⚠️
14+
## ⚠️ BREAKING CHANGES ⚠️
15+
This release contains breaking changes for two functions in the Go SDK.
1516

16-
This release contains a breaking change for the Python SDK.
17+
**Vault listing**
1718

18-
`items.list_all()` has changed to `items.list()` and the return type has also changed from SDKIterator[ItemOverview] to List[ItemOverview]. To migrate to the latest SDK version:
19-
20-
Wherever you were using:
19+
* The function name has changed from `list_all` to `list`. To use this in your code, replace:
2120
```python
22-
overviews = await client.items.list_all(vault_id)
23-
24-
async for overview in overviews:
25-
print(overview.ID)
21+
vaults = await client.vaults.list_all(vault_id)
22+
```
23+
with
24+
```python
25+
vaults = await client.vaults.list(vault_id)
2626
```
2727

28-
You must now use:
28+
* The return type of the vault listing function has changed from `*Iterator[VaultOverview]` to `[]VaultOverview`. To use this in your code, replace:
2929

30+
```python
31+
async for vault in vaults:
32+
# using vault overview
33+
```
34+
with
35+
```python
36+
for vault in vaults:
37+
# using vault overview
38+
```
39+
**Item listing**
40+
41+
* The function name has changed from `ListAll` to `List`. To use this in your code, replace:
42+
```python
43+
overviews = await client.items.list_all(vault_id)
44+
```
45+
with:
3046
```python
3147
overviews = await client.items.list(vault_id, ItemListFilter(
3248
content=ItemListFilterByStateInner(
3349
active=active,
3450
archived=archived
3551
)
3652
))
37-
38-
for overview in overviews:
39-
print(overview.ID)
4053
```
41-
`vaults.list_all()` has changed to `vaults.list()` nd the return type has also changed from SDKIterator[VaultOverview] to List[VaultOverview]. To migrate to the latest SDK version:
4254

43-
Wherever you were using:
55+
* The return type of the item listing function has changed from `*Iterator[ItemOverview]` to `[]ItemOverview`. To use this in your code, replace:
4456
```python
45-
vaults = await client.vaults.list_all()
46-
async for vault in vaults:
47-
print(vault.title)
57+
async for overview in overviews:
58+
# using item overview
4859
```
49-
50-
You must now use:
60+
with
5161
```python
52-
vaults = await client.vaults.list()
53-
for vault in vaults:
54-
print(vault.title)
62+
for overview in overviews:
63+
# using item overview
5564
```
5665

5766
This does not affect any code that's already deployed, and will not take effect in your codebase until updating to v0.3.0+ of the 1Password Python SDK.

0 commit comments

Comments
 (0)