Skip to content

Commit d4c9626

Browse files
ff137ff137
authored
⬆️ Release 1.2.1-20250213 (#238)
* ⬆️ Upgrade ruff * ⬆️ Upgrade black * 🎨 Apply new black format * ⬆️ Upgrade isort * ⬆️ Upgrade anyio * 🎨 Update version * 🎨 Updated docstring * 🎨 Updated limit and offset fields * ✨ New `ListCredentialsResponse` object * ✨ New store_credential request body and response model * 🎨 AnonCredsSchema fields are required * ✨ Expanded did validation for extra submethod support * ✨ New key type: p256 * ✨ Model fields marked as required * 🎨 Update regex validators * 📝 Updated specs * 🎨 Updated script default version * 🎨 Add `anoncreds_wallet_upgrade` API to README * 🎨 Neaten README * 🎨 Format spec
1 parent a34ca06 commit d4c9626

File tree

410 files changed

+5523
-3034
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

410 files changed

+5523
-3034
lines changed

‎.github/workflows/python-publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ jobs:
3636
run: |
3737
python -m pip install --upgrade pip
3838
pip install \
39-
isort~=5.13.2 \
40-
black~=24.10.0
39+
isort~=6.0.0 \
40+
black~=25.1.0
4141
- name: Check import style with isort
4242
run: |
4343
isort . --check --profile black --diff

‎.github/workflows/python-test-publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ jobs:
3838
run: |
3939
python -m pip install --upgrade pip
4040
pip install \
41-
isort~=5.13.2 \
42-
black~=24.10.0
41+
isort~=6.0.0 \
42+
black~=25.1.0
4343
- name: Check import style with isort
4444
run: |
4545
isort . --check --profile black --diff

‎README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,23 +33,32 @@
3333
<a href="#license">License</a>
3434
</p>
3535

36-
The Aries CloudController is a Python-based client library for interacting with an instance of [Aries Cloud Agent](https://github.com/hyperledger/aries-cloudagent-python) (ACA-Py). It leverages the OpenAPI definition from ACA-Py to provide a fully-typed, rich API experience for cloud agent interaction.
36+
The Aries CloudController is a Python-based client library for interacting with an instance of
37+
[Aries Cloud Agent](https://github.com/hyperledger/aries-cloudagent-python) (ACA-Py). It leverages
38+
the OpenAPI definition from ACA-Py to provide a fully-typed, rich API experience for cloud agent interaction.
3739

3840
**Versioning Update:**
39-
As of version 0.8.0, the Aries CloudController has aligned its versioning with ACA-Py. This means that each new version of ACA-Py will correspond directly to the same version of the Aries CloudController. This change ensures a more straightforward and predictable upgrade path for users.
41+
As of version 0.8.0, the Aries CloudController has aligned its versioning with ACA-Py.
42+
This means that each new version of ACA-Py will correspond directly to the same version of the
43+
Aries CloudController. This change ensures a more straightforward and predictable upgrade path for users.
4044

41-
In other words, CloudController 0.8.0 is compatible with ACA-Py 0.8.0, CloudController 0.9.0 is compatible with ACA-Py 0.9.0, etc.
45+
In other words, CloudController 0.8.0 is compatible with ACA-Py 0.8.0,
46+
CloudController 0.9.0 is compatible with ACA-Py 0.9.0, etc.
4247

4348
For legacy versions, please review our release history to found the version compatible with ACA-Py pre-0.8.0.
4449

4550
## Features
4651

4752
Aries CloudController Python provides a robust client for interacting with Aries Cloud Agents (ACA-Py).
4853

49-
- **Fully Typed**: Offers a strongly-typed wrapper around the Aries Cloud Agent Python, enhancing developer experience and reducing errors.
50-
- **Up-to-Date Support**: Compatible with the latest ACA-Py version (1.1.0), ensuring access to the most recent features and improvements.
51-
- **Auto-Generated Client**: Utilizes OpenAPI definitions for automatic generation, ensuring timely updates in line with new ACA-Py releases.
52-
- **Multi-Tenancy and Authentication Support**: Facilitates working with multi-tenant APIs and integrates various authentication mechanisms.
54+
- **Fully Typed**: Offers a strongly-typed wrapper around the Aries Cloud Agent Python,
55+
enhancing developer experience and reducing errors.
56+
- **Up-to-Date Support**: Compatible with the latest ACA-Py version (1.1.0),
57+
ensuring access to the most recent features and improvements.
58+
- **Auto-Generated Client**: Utilizes OpenAPI definitions for automatic generation,
59+
ensuring timely updates in line with new ACA-Py releases.
60+
- **Multi-Tenancy and Authentication Support**: Facilitates working with multi-tenant APIs
61+
and integrates various authentication mechanisms.
5362
- **Asynchronous API**: Supports asynchronous operations, enabling efficient handling of I/O-bound tasks.
5463

5564
## Usage
@@ -93,7 +102,8 @@ client = AcaPyClient(
93102

94103
### Interacting with the Client
95104

96-
The API, being fully typed, is best explored through the ACA-Py Swagger UI, which mirrors the available client properties.
105+
The API, being fully typed, is best explored through the ACA-Py Swagger UI,
106+
which mirrors the available client properties.
97107

98108
**Example**: Creating and receiving an invitation:
99109

@@ -113,6 +123,7 @@ The client encompasses various APIs, each corresponding to ACA-Py Swagger UI top
113123
- `anoncreds_credential_definitions`
114124
- `anoncreds_revocation`
115125
- `anoncreds_schemas`
126+
- `anoncreds_wallet_upgrade`
116127
- `basicmessage`
117128
- `connection`
118129
- `credential_definition`
@@ -144,7 +155,8 @@ The client encompasses various APIs, each corresponding to ACA-Py Swagger UI top
144155

145156
## Contributing
146157

147-
Contributions are welcome! Please see our [CONTRIBUTING](/CONTRIBUTING.md) guidelines for more information on how to get involved.
158+
Contributions are welcome! Please see our [CONTRIBUTING](/CONTRIBUTING.md) guidelines
159+
for more information on how to get involved.
148160

149161
## License
150162

‎aries_cloudcontroller/__init__.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
# flake8: noqa
44

55
"""
6-
Aries Cloud Agent
6+
Aries Cloud Agent
77
8-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
8+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
99
10-
The version of the OpenAPI document: v1.2.0.post20241205
11-
Generated by OpenAPI Generator (https://openapi-generator.tech)
10+
The version of the OpenAPI document: v1.2.1.post20250213
11+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1212
13-
Do not edit the class manually.
13+
Do not edit the class manually.
1414
""" # noqa: E501
1515

1616

17-
__version__ = "1.2.0-20241205"
17+
__version__ = "1.2.1-20250213"
1818

1919
from aries_cloudcontroller.acapy_client import AcaPyClient
2020

@@ -243,6 +243,7 @@
243243
LedgerConfigInstance,
244244
LedgerConfigList,
245245
LinkedDataProof,
246+
ListCredentialsResponse,
246247
MediationDeny,
247248
MediationGrant,
248249
MediationIdMatchInfo,
@@ -326,6 +327,8 @@
326327
SignedDoc,
327328
SignRequest,
328329
SignResponse,
330+
StoreCredentialRequest,
331+
StoreCredentialResponse,
329332
SubmissionRequirements,
330333
TAAAccept,
331334
TAAAcceptance,

‎aries_cloudcontroller/api/action_menu_api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# coding: utf-8
22

33
"""
4-
Aries Cloud Agent
4+
Aries Cloud Agent
55
6-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
77
8-
The version of the OpenAPI document: v1.2.0.post20241205
9-
Generated by OpenAPI Generator (https://openapi-generator.tech)
8+
The version of the OpenAPI document: v1.2.1.post20250213
9+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1010
11-
Do not edit the class manually.
11+
Do not edit the class manually.
1212
""" # noqa: E501
1313

1414
from typing import Any, Dict, List, Optional, Tuple, Union

‎aries_cloudcontroller/api/anoncreds_credential_definitions_api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# coding: utf-8
22

33
"""
4-
Aries Cloud Agent
4+
Aries Cloud Agent
55
6-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
77
8-
The version of the OpenAPI document: v1.2.0.post20241205
9-
Generated by OpenAPI Generator (https://openapi-generator.tech)
8+
The version of the OpenAPI document: v1.2.1.post20250213
9+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1010
11-
Do not edit the class manually.
11+
Do not edit the class manually.
1212
""" # noqa: E501
1313

1414
from typing import Any, Dict, List, Optional, Tuple, Union

‎aries_cloudcontroller/api/anoncreds_revocation_api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# coding: utf-8
22

33
"""
4-
Aries Cloud Agent
4+
Aries Cloud Agent
55
6-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
77
8-
The version of the OpenAPI document: v1.2.0.post20241205
9-
Generated by OpenAPI Generator (https://openapi-generator.tech)
8+
The version of the OpenAPI document: v1.2.1.post20250213
9+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1010
11-
Do not edit the class manually.
11+
Do not edit the class manually.
1212
""" # noqa: E501
1313

1414
from typing import Any, Dict, List, Optional, Tuple, Union

‎aries_cloudcontroller/api/anoncreds_schemas_api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# coding: utf-8
22

33
"""
4-
Aries Cloud Agent
4+
Aries Cloud Agent
55
6-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
77
8-
The version of the OpenAPI document: v1.2.0.post20241205
9-
Generated by OpenAPI Generator (https://openapi-generator.tech)
8+
The version of the OpenAPI document: v1.2.1.post20250213
9+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1010
11-
Do not edit the class manually.
11+
Do not edit the class manually.
1212
""" # noqa: E501
1313

1414
from typing import Any, Dict, List, Optional, Tuple, Union

‎aries_cloudcontroller/api/anoncreds_wallet_upgrade_api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# coding: utf-8
22

33
"""
4-
Aries Cloud Agent
4+
Aries Cloud Agent
55
6-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
77
8-
The version of the OpenAPI document: v1.2.0.post20241205
9-
Generated by OpenAPI Generator (https://openapi-generator.tech)
8+
The version of the OpenAPI document: v1.2.1.post20250213
9+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1010
11-
Do not edit the class manually.
11+
Do not edit the class manually.
1212
""" # noqa: E501
1313

1414
from typing import Any, Dict, List, Optional, Tuple, Union

‎aries_cloudcontroller/api/basicmessage_api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# coding: utf-8
22

33
"""
4-
Aries Cloud Agent
4+
Aries Cloud Agent
55
6-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
77
8-
The version of the OpenAPI document: v1.2.0.post20241205
9-
Generated by OpenAPI Generator (https://openapi-generator.tech)
8+
The version of the OpenAPI document: v1.2.1.post20250213
9+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1010
11-
Do not edit the class manually.
11+
Do not edit the class manually.
1212
""" # noqa: E501
1313

1414
from typing import Any, Dict, List, Optional, Tuple, Union

‎aries_cloudcontroller/api/connection_api.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# coding: utf-8
22

33
"""
4-
Aries Cloud Agent
4+
Aries Cloud Agent
55
6-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
77
8-
The version of the OpenAPI document: v1.2.0.post20241205
9-
Generated by OpenAPI Generator (https://openapi-generator.tech)
8+
The version of the OpenAPI document: v1.2.1.post20250213
9+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1010
11-
Do not edit the class manually.
11+
Do not edit the class manually.
1212
""" # noqa: E501
1313

1414
import warnings
@@ -879,13 +879,15 @@ async def get_connections(
879879
Field(description="Identifier of the associated Invitation Message"),
880880
] = None,
881881
limit: Annotated[
882-
Optional[StrictInt], Field(description="Number of results to return")
882+
Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]],
883+
Field(description="Number of results to return"),
883884
] = None,
884885
my_did: Annotated[
885886
Optional[Annotated[str, Field(strict=True)]], Field(description="My DID")
886887
] = None,
887888
offset: Annotated[
888-
Optional[StrictInt], Field(description="Offset for pagination")
889+
Optional[Annotated[int, Field(strict=True, ge=0)]],
890+
Field(description="Offset for pagination"),
889891
] = None,
890892
order_by: Annotated[
891893
Optional[StrictStr],

‎aries_cloudcontroller/api/credential_definition_api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# coding: utf-8
22

33
"""
4-
Aries Cloud Agent
4+
Aries Cloud Agent
55
6-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
77
8-
The version of the OpenAPI document: v1.2.0.post20241205
9-
Generated by OpenAPI Generator (https://openapi-generator.tech)
8+
The version of the OpenAPI document: v1.2.1.post20250213
9+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1010
11-
Do not edit the class manually.
11+
Do not edit the class manually.
1212
""" # noqa: E501
1313

1414
from typing import Any, Dict, List, Optional, Tuple, Union

‎aries_cloudcontroller/api/credentials_api.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# coding: utf-8
22

33
"""
4-
Aries Cloud Agent
4+
Aries Cloud Agent
55
6-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
77
8-
The version of the OpenAPI document: v1.2.0.post20241205
9-
Generated by OpenAPI Generator (https://openapi-generator.tech)
8+
The version of the OpenAPI document: v1.2.1.post20250213
9+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1010
11-
Do not edit the class manually.
11+
Do not edit the class manually.
1212
""" # noqa: E501
1313

1414
from typing import Any, Dict, List, Optional, Tuple, Union
@@ -444,10 +444,12 @@ async def get_records(
444444
),
445445
] = None,
446446
limit: Annotated[
447-
Optional[StrictInt], Field(description="Number of results to return")
447+
Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]],
448+
Field(description="Number of results to return"),
448449
] = None,
449450
offset: Annotated[
450-
Optional[StrictInt], Field(description="Offset for pagination")
451+
Optional[Annotated[int, Field(strict=True, ge=0)]],
452+
Field(description="Offset for pagination"),
451453
] = None,
452454
start: Annotated[
453455
Optional[Annotated[str, Field(strict=True)]],

‎aries_cloudcontroller/api/default_api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# coding: utf-8
22

33
"""
4-
Aries Cloud Agent
4+
Aries Cloud Agent
55
6-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
77
8-
The version of the OpenAPI document: v1.2.0.post20241205
9-
Generated by OpenAPI Generator (https://openapi-generator.tech)
8+
The version of the OpenAPI document: v1.2.1.post20250213
9+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1010
11-
Do not edit the class manually.
11+
Do not edit the class manually.
1212
""" # noqa: E501
1313

1414
from typing import Any, Dict, List, Optional, Tuple, Union

‎aries_cloudcontroller/api/did_exchange_api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# coding: utf-8
22

33
"""
4-
Aries Cloud Agent
4+
Aries Cloud Agent
55
6-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
77
8-
The version of the OpenAPI document: v1.2.0.post20241205
9-
Generated by OpenAPI Generator (https://openapi-generator.tech)
8+
The version of the OpenAPI document: v1.2.1.post20250213
9+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1010
11-
Do not edit the class manually.
11+
Do not edit the class manually.
1212
""" # noqa: E501
1313

1414
import warnings

0 commit comments

Comments
 (0)