Skip to content

Commit 93db46a

Browse files
committed
Update README.md
1 parent ab59f4c commit 93db46a

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,21 @@ Python 3.7+
1212
pip install infisicalsdk
1313
```
1414

15+
16+
## Migrating to stable version >= 1.0.0
17+
18+
We have recently rolled out our first stable version of the SDK, version `1.0.0` and above.
19+
20+
The 1.0.0 version comes with a few key changes that may change how you're using the SDK.
21+
1. **Removal of `rest`**: The SDK no longer exposes the entire Infisical API. This was nessecary as we have moved away from using an OpenAPI generator approach. We aim to add support for more API resources in the near future. If you have any specific requests, please [open an issue](https://github.com/Infisical/python-sdk-official/issues).
22+
2. **New response types**: The 1.0.0 release uses return types that differ from the older versions. The new return types such as `BaseSecret`, are all exported from the Infisical SDK.
23+
3. **Property renaming**: Some properties on the responses have been slightly renamed. An example of this would be that the `secret_key` property on the `get_secret_by_name()` method, has been renamed to `secretKey`.
24+
25+
With this in mind, you're ready to upgrade your SDK version to `1.0.0` or above.
26+
27+
You can refer to our [legacy documentation](https://github.com/Infisical/python-sdk-official/tree/9b0403938ee5ae599d42c5f1fdf9158671a15606?tab=readme-ov-file#infisical-python-sdk) if need be
28+
29+
1530
## Getting Started
1631

1732
```python

0 commit comments

Comments
 (0)