Merge pull request #2912 from swcurran/0.12.1rc0

0.12.1rc0
openwallet-foundation · Apr 24, 2024 · d60cb4b · d60cb4b
2 parents 670269d + 85a0308
commit d60cb4b
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 34 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,51 @@
 # Aries Cloud Agent Python Changelog
 
+## 0.12.1rc0
+
+### April 24, 2024
+
+Release 0.12.1rc0 is a small patch to cleanup some edge case issues in the handling of Out of Band invitations, and connection querying uncovered after the 0.12.0 release. Fixes and improvements were also made to the generation of ACA-Py's OpenAPI specifications.
+
+### 0.12.1rc0 Breaking Changes
+
+There are no breaking changes in this release.
+
+#### 0.12.1rc0 Categorized List of Pull Requests
+
+- Out of Band Invitations and Connection Establishment updates/fixes:
+  - 🐛 Fix ServiceDecorator parsing in oob record handling [\#2910](https://github.com/hyperledger/aries-cloudagent-python/pull/2910) [ff137](https://github.com/ff137)
+  - fix: consider all resolvable dids in invites "public" [\#2900](https://github.com/hyperledger/aries-cloudagent-python/pull/2900) [dbluhm](https://github.com/dbluhm)
+  - fix: oob record their_service should be updatable [\#2897](https://github.com/hyperledger/aries-cloudagent-python/pull/2897) [dbluhm](https://github.com/dbluhm)
+  - fix: look up conn record by invite msg id instead of key [\#2891](https://github.com/hyperledger/aries-cloudagent-python/pull/2891) [dbluhm](https://github.com/dbluhm)
+
+- OpenAPI/Swagger updates, fixes and cleanups:
+  - Fix api schema mixup in revocation routes [\#2909](https://github.com/hyperledger/aries-cloudagent-python/pull/2909) [jamshale](https://github.com/jamshale)
+  - 🎨 fix typos [\#2898](https://github.com/hyperledger/aries-cloudagent-python/pull/2898) [ff137](https://github.com/ff137)
+  - ⬆️ Upgrade codegen tools used in generate-open-api-specols [\#2899](https://github.com/hyperledger/aries-cloudagent-python/pull/2899) [ff137](https://github.com/ff137)
+  - 🐛 Fix IndyAttrValue model that was dropped from openapi spec [\#2894](https://github.com/hyperledger/aries-cloudagent-python/pull/2894) [ff137](https://github.com/ff137)
+
+- Test and Demo updates:
+  - fix Faber demo to use oob with aip10 to support connection reuse [\#2903](https://github.com/hyperledger/aries-cloudagent-python/pull/2903) [ianco](https://github.com/ianco)
+  - fix: integration tests should use didex 1.1 [\#2889](https://github.com/hyperledger/aries-cloudagent-python/pull/2889) [dbluhm](https://github.com/dbluhm)
+
+- Endorsement of Indy Transactions fixes:
+  - Prevent 500 error when re-promoting DID with endorsement [\#2885](https://github.com/hyperledger/aries-cloudagent-python/pull/2885) [jamshale](https://github.com/jamshale)
+  - Fix ack during for auto endorsement [\#2883](https://github.com/hyperledger/aries-cloudagent-python/pull/2883) [jamshale](https://github.com/jamshale)
+
+- Documentation publishing process updates:
+  - Some updates to the mkdocs publishing process [\#2888](https://github.com/hyperledger/aries-cloudagent-python/pull/2888) [swcurran](https://github.com/swcurran)
+  - Update GHA so that broken image links work on docs site - without breaking them on GitHub [\#2852](https://github.com/hyperledger/aries-cloudagent-python/pull/2852) [swcurran](https://github.com/swcurran)
+
+- Dependencies and Internal Updates:
+  - chore(deps): Bump aiohttp from 3.9.3 to 3.9.4  dependencies python [\#2902](https://github.com/hyperledger/aries-cloudagent-python/pull/2902) [dependabot bot](https://github.com/dependabot bot)
+  - chore(deps): Bump idna from 3.4 to 3.7 in /demo/playground/examples  dependencies python [\#2886](https://github.com/hyperledger/aries-cloudagent-python/pull/2886) [dependabot bot](https://github.com/dependabot bot)
+  - chore(deps): Bump psf/black from 24.3.0 to 24.4.0 in the all-actions group  dependencies github_actions [\#2893](https://github.com/hyperledger/aries-cloudagent-python/pull/2893) [dependabot bot](https://github.com/dependabot bot)
+  - chore(deps): Bump idna from 3.6 to 3.7  dependencies python [\#2887](https://github.com/hyperledger/aries-cloudagent-python/pull/2887) [dependabot bot](https://github.com/dependabot bot)
+  - refactor: logging configs setup [\#2870](https://github.com/hyperledger/aries-cloudagent-python/pull/2870) [amanji](https://github.com/amanji)
+
+- Release management pull requests:
+  - 0.12.1rc0 [\#2912](https://github.com/hyperledger/aries-cloudagent-python/pull/2912) [swcurran](https://github.com/swcurran)
+
 ## 0.12.0
 
 ### April 11, 2024

diff --git a/PUBLISHING.md b/PUBLISHING.md
@@ -94,7 +94,7 @@ Once you have the list of PRs:
 4. Check to see if there are any other PRs that should be included in the release.
 
 5. Update the ReadTheDocs in the `/docs` folder by following the instructions in
-   the `docs/README.md` file. That will likely add a number of new and modified
+   the `docs/UpdateRTD.md` file. That will likely add a number of new and modified
    files to the PR. Eliminate all of the errors in the generation process,
    either by mocking external dependencies or by fixing ACA-Py code. If
    necessary, create an issue with the errors and assign it to the appropriate
@@ -117,6 +117,8 @@ Once you have the list of PRs:
 7. Regenerate openapi.json and swagger.json by running
    `../scripts/generate-open-api-spec` from within the `aries_cloudagent` folder.
 
+   Command: `cd aries_cloudagent;../scripts/generate-open-api-spec;cd ..`
+
 8.  Double check all of these steps above, and then submit a PR from the branch.
    Add this new PR to CHANGELOG.md so that all the PRs are included.
    If there are still further changes to be merged, mark the PR as "Draft",

diff --git a/docs/features/DIDResolution.md b/docs/features/DIDResolution.md
@@ -176,7 +176,7 @@ plugin:
 The following is a fully functional Dockerfile encapsulating this setup:
 
 ```dockerfile=
-FROM ghcr.io/hyperledger/aries-cloudagent-python:py3.9-0.12.0
+FROM ghcr.io/hyperledger/aries-cloudagent-python:py3.9-0.12.1rc0
 RUN pip3 install git+https://github.com/dbluhm/acapy-resolver-github
 
 CMD ["aca-py", "start", "-it", "http", "0.0.0.0", "3000", "-ot", "http", "-e", "http://localhost:3000", "--admin", "0.0.0.0", "3001", "--admin-insecure-mode", "--no-ledger", "--plugin", "acapy_resolver_github"]

diff --git a/docs/features/QualifiedDIDs.md b/docs/features/QualifiedDIDs.md
@@ -32,7 +32,7 @@ When receiving an OOB invitation or creating a DID Exchange request to a known P
 
 With these changes, an existing ACA-Py installation using unqualified DIDs can upgrade to use qualified DIDs:
 
-- Reactively in 0.12.0, by using like DIDs from the other agent.
+- Reactively in 0.12.0 and later, by using like DIDs from the other agent.
 - Proactively, by adding the `use_did` or `use_did_method` parameter on the `POST /out-of-band/create-invitation`, `POST /didexchange/create-request`. and `POST /didexchange/{conn_id}/accept_invitation` endpoints and specifying `did:peer:2` or `did_peer:4`.
   - The other agent must be able to process the selected DID Method.
 - Proactively, by updating to use DID Exchange v1.1 and having the other side `auto-accept` the connection.

diff --git a/docs/features/SupportedRFCs.md b/docs/features/SupportedRFCs.md
@@ -8,7 +8,7 @@ ACA-Py or the repository `main` branch. Reminders (and PRs!) to update this page
 welcome! If you have any questions, please contact us on the #aries channel on
 [Hyperledger Discord](https://discord.gg/hyperledger) or through an issue in this repo.
 
-**Last Update**: 2024-04-11, Release 0.12.0
+**Last Update**: 2024-04-24, Release 0.12.1rc0
 
 > The checklist version of this document was created as a joint effort
 > between [Northern Block](https://northernblock.io/), [Animo Solutions](https://animo.id/) and the Ontario government, on behalf of the Ontario government.
@@ -77,7 +77,7 @@ A summary of the Aries Interop Profiles and Aries RFCs supported in ACA-Py can b
 | --- | :--: | -- |
 | [Aries Askar] | :white_check_mark: | Recommended - Aries Askar provides equivalent/evolved secure storage and cryptography support to the "indy-wallet" part of the Indy SDK. When using Askar (via the `--wallet-type askar` startup parameter), other functionality is handled by [CredX](https://github.com/hyperledger/indy-shared-rs) (AnonCreds) and [Indy VDR](https://github.com/hyperledger/indy-vdr) (Indy ledger interactions). |
 | [Aries Askar]-AnonCreds | :white_check_mark: | Recommended - When using Askar/AnonCreds (via the `--wallet-type askar-anoncreds` startup parameter), other functionality is handled by [AnonCreds RS](https://github.com/hyperledger/anoncreds-rs) (AnonCreds) and [Indy VDR](https://github.com/hyperledger/indy-vdr) (Indy ledger interactions).<br><br>This `wallet-type` will eventually be the same as `askar` when we have fully integrated the AnonCreds RS library into ACA-Py. |
-| [Indy SDK](https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage) | :warning: Deprecated | Full support for the features of the "indy-wallet" secure storage capabilities found in the Indy SDK. |
+| [Indy SDK](https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage) | :warning: Deprecated | **To be removed in the next Major/Minor release of ACA-Py** Full support for the features of the "indy-wallet" secure storage capabilities found in the Indy SDK. |
 
 > New installations of ACA-Py should **NOT** use the [Indy SDK]. Existing deployments using the [Indy SDK] should transition to [Aries Askar] and related components as soon as possible.
 

diff --git a/open-api/openapi.json b/open-api/openapi.json
@@ -2,7 +2,7 @@
   "openapi" : "3.0.1",
   "info" : {
     "title" : "Aries Cloud Agent",
-    "version" : "v0.12.0"
+    "version" : "v0.12.1rc0"
   },
   "servers" : [ {
     "url" : "/"
@@ -664,7 +664,7 @@
             "content" : {
               "application/json" : {
                 "schema" : {
-                  "$ref" : "#/components/schemas/CredRevRecordResult"
+                  "$ref" : "#/components/schemas/CredRevRecordResultSchemaAnoncreds"
                 }
               }
             },
@@ -681,7 +681,7 @@
           "content" : {
             "*/*" : {
               "schema" : {
-                "$ref" : "#/components/schemas/PublishRevocations"
+                "$ref" : "#/components/schemas/PublishRevocationsSchemaAnoncreds"
               }
             }
           },
@@ -692,7 +692,7 @@
             "content" : {
               "application/json" : {
                 "schema" : {
-                  "$ref" : "#/components/schemas/PublishRevocationsResult"
+                  "$ref" : "#/components/schemas/PublishRevocationsResultSchemaAnoncreds"
                 }
               }
             },
@@ -5573,7 +5573,7 @@
             "content" : {
               "application/json" : {
                 "schema" : {
-                  "$ref" : "#/components/schemas/PublishRevocationsSchemaAnoncreds"
+                  "$ref" : "#/components/schemas/PublishRevocations"
                 }
               }
             },
@@ -5646,7 +5646,7 @@
             "content" : {
               "application/json" : {
                 "schema" : {
-                  "$ref" : "#/components/schemas/CredRevRecordResultSchemaAnoncreds"
+                  "$ref" : "#/components/schemas/CredRevRecordResult"
                 }
               }
             },
@@ -5678,7 +5678,7 @@
           "content" : {
             "*/*" : {
               "schema" : {
-                "$ref" : "#/components/schemas/PublishRevocationsSchemaAnoncreds"
+                "$ref" : "#/components/schemas/PublishRevocations"
               }
             }
           },
@@ -8560,15 +8560,15 @@
       "CredRevRecordResult" : {
         "properties" : {
           "result" : {
-            "$ref" : "#/components/schemas/IssuerCredRevRecordSchemaAnoncreds"
+            "$ref" : "#/components/schemas/IssuerCredRevRecord"
           }
         },
         "type" : "object"
       },
       "CredRevRecordResultSchemaAnoncreds" : {
         "properties" : {
           "result" : {
-            "$ref" : "#/components/schemas/IssuerCredRevRecord"
+            "$ref" : "#/components/schemas/IssuerCredRevRecordSchemaAnoncreds"
           }
         },
         "type" : "object"
@@ -12143,9 +12143,6 @@
       },
       "PublishRevocations" : {
         "properties" : {
-          "options" : {
-            "$ref" : "#/components/schemas/PublishRevocationsOptions"
-          },
           "rrid2crid" : {
             "additionalProperties" : {
               "items" : {
@@ -12177,7 +12174,7 @@
         },
         "type" : "object"
       },
-      "PublishRevocationsResult" : {
+      "PublishRevocationsResultSchemaAnoncreds" : {
         "properties" : {
           "rrid2crid" : {
             "additionalProperties" : {
@@ -12197,6 +12194,9 @@
       },
       "PublishRevocationsSchemaAnoncreds" : {
         "properties" : {
+          "options" : {
+            "$ref" : "#/components/schemas/PublishRevocationsOptions"
+          },
           "rrid2crid" : {
             "additionalProperties" : {
               "items" : {
@@ -13598,7 +13598,7 @@
       "TxnOrPublishRevocationsResult" : {
         "properties" : {
           "sent" : {
-            "$ref" : "#/components/schemas/PublishRevocationsSchemaAnoncreds"
+            "$ref" : "#/components/schemas/PublishRevocations"
           },
           "txn" : {
             "allOf" : [ {

diff --git a/open-api/swagger.json b/open-api/swagger.json
@@ -1,7 +1,7 @@
 {
   "swagger" : "2.0",
   "info" : {
-    "version" : "v0.12.0",
+    "version" : "v0.12.1rc0",
     "title" : "Aries Cloud Agent"
   },
   "tags" : [ {
@@ -577,7 +577,7 @@
           "200" : {
             "description" : "",
             "schema" : {
-              "$ref" : "#/definitions/CredRevRecordResult"
+              "$ref" : "#/definitions/CredRevRecordResultSchemaAnoncreds"
             }
           }
         }
@@ -593,14 +593,14 @@
           "name" : "body",
           "required" : false,
           "schema" : {
-            "$ref" : "#/definitions/PublishRevocations"
+            "$ref" : "#/definitions/PublishRevocationsSchemaAnoncreds"
           }
         } ],
         "responses" : {
           "200" : {
             "description" : "",
             "schema" : {
-              "$ref" : "#/definitions/PublishRevocationsResult"
+              "$ref" : "#/definitions/PublishRevocationsResultSchemaAnoncreds"
             }
           }
         }
@@ -4568,7 +4568,7 @@
           "200" : {
             "description" : "",
             "schema" : {
-              "$ref" : "#/definitions/PublishRevocationsSchemaAnoncreds"
+              "$ref" : "#/definitions/PublishRevocations"
             }
           }
         }
@@ -4628,7 +4628,7 @@
           "200" : {
             "description" : "",
             "schema" : {
-              "$ref" : "#/definitions/CredRevRecordResultSchemaAnoncreds"
+              "$ref" : "#/definitions/CredRevRecordResult"
             }
           }
         }
@@ -4644,7 +4644,7 @@
           "name" : "body",
           "required" : false,
           "schema" : {
-            "$ref" : "#/definitions/PublishRevocationsSchemaAnoncreds"
+            "$ref" : "#/definitions/PublishRevocations"
           }
         }, {
           "name" : "conn_id",
@@ -7224,15 +7224,15 @@
       "type" : "object",
       "properties" : {
         "result" : {
-          "$ref" : "#/definitions/IssuerCredRevRecordSchemaAnoncreds"
+          "$ref" : "#/definitions/IssuerCredRevRecord"
         }
       }
     },
     "CredRevRecordResultSchemaAnoncreds" : {
       "type" : "object",
       "properties" : {
         "result" : {
-          "$ref" : "#/definitions/IssuerCredRevRecord"
+          "$ref" : "#/definitions/IssuerCredRevRecordSchemaAnoncreds"
         }
       }
     },
@@ -10640,9 +10640,6 @@
     "PublishRevocations" : {
       "type" : "object",
       "properties" : {
-        "options" : {
-          "$ref" : "#/definitions/PublishRevocationsOptions"
-        },
         "rrid2crid" : {
           "type" : "object",
           "description" : "Credential revocation ids by revocation registry id",
@@ -10673,7 +10670,7 @@
         }
       }
     },
-    "PublishRevocationsResult" : {
+    "PublishRevocationsResultSchemaAnoncreds" : {
       "type" : "object",
       "properties" : {
         "rrid2crid" : {
@@ -10694,6 +10691,9 @@
     "PublishRevocationsSchemaAnoncreds" : {
       "type" : "object",
       "properties" : {
+        "options" : {
+          "$ref" : "#/definitions/PublishRevocationsOptions"
+        },
         "rrid2crid" : {
           "type" : "object",
           "description" : "Credential revocation ids by revocation registry id",
@@ -12070,7 +12070,7 @@
       "type" : "object",
       "properties" : {
         "sent" : {
-          "$ref" : "#/definitions/PublishRevocationsSchemaAnoncreds"
+          "$ref" : "#/definitions/PublishRevocations"
         },
         "txn" : {
           "$ref" : "#/definitions/TxnOrPublishRevocationsResult_txn"

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aries_cloudagent"
-version = "0.12.0"
+version = "0.12.1rc0"
 description = "Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building decentralized identity applications and services running in non-mobile environments. "
 authors = ["Hyperledger Aries <aries@lists.hyperledger.org>"]
 license = "Apache-2.0"