Merge branch 'main' into feat/w3c-implementation

Whats-Cookin · Mar 6, 2024 · 69d9c58 · 69d9c58
2 parents 3977fe5 + fa2a8ea
commit 69d9c58
Show file tree

Hide file tree

Showing 13 changed files with 73 additions and 48 deletions.
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -39,6 +39,8 @@ jobs:
           VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,' -e 's/^docs-v//')
           # Copy all of the root level md files into the docs folder for deployment, tweaking the relative paths
           for i in *.md; do sed -e "s#docs/#./#g" $i >docs/$i; done
+          # Fix references in DevReadMe.md to moved files
+          sed -e "s#\.\./\.\./#../#" docs/features/DevReadMe.md >tmp.md; mv tmp.md docs/features/DevReadMe.md
           # Populate overrides for the current version, and then remove to not apply if VERSION is main branch
           OVERRIDE=overrides/main.html
           echo -e "{% extends \"base.html\" %}\n\n{% block outdated %}\n  You are viewing the documentation for ACA-Py Release $ALIAS.\n{% endblock %}" >$OVERRIDE

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/docs/demo/AliceWantsAJsonCredential.md b/docs/demo/AliceWantsAJsonCredential.md
@@ -2,7 +2,7 @@
 
 ACA-Py has the capability to issue and verify both Indy and JSON-LD (W3C compliant) credentials.
 
-The JSON-LD support is documented [here](../JsonLdCredentials.md) - this document will provide some additional detail in how to use the demo and admin api to issue and prove JSON-LD credentials.
+The JSON-LD support is documented [here](../features/JsonLdCredentials.md) - this document will provide some additional detail in how to use the demo and admin api to issue and prove JSON-LD credentials.
 
 ## Setup Agents to Issue JSON-LD Credentials
 

diff --git a/docs/demo/AriesOpenAPIDemo.md b/docs/demo/AriesOpenAPIDemo.md
@@ -581,7 +581,7 @@ Those that know something about the Indy process for issuing a credential and th
 
 If you would like to perform all of the issuance steps manually on the Faber agent side, use a sequence of the other `/issue-credential-2.0/` messages. Use the **`GET /issue-credential-2.0/records`** to both check the credential exchange state as you progress through the protocol and to find some of the data you’ll need in executing the sequence of requests.
 
-The following table lists endpoints that you need to call ("REST service") and callbacks that your agent will receive ("callback") that your need to respond to. See the [detailed API docs](../features/AdminAPI).
+The following table lists endpoints that you need to call ("REST service") and callbacks that your agent will receive ("callback") that your need to respond to. See the [detailed API docs](../features/AdminAPI.md).
 
 | Protocol Step        | Faber (Issuer)         | Alice (Holder)     | Notes |
 | -------------------- | ---------------------- | ------------------ | ----- |
@@ -700,7 +700,7 @@ As with the issue credential process, the agents handled some of the presentatio
 
 If you would like to perform all of the proof request/response steps manually, you can call all of the individual `/present-proof-2.0` messages.
 
-The following table lists endpoints that you need to call ("REST service") and callbacks that your agent will receive ("callback") that you need to respond to. See the [detailed API docs](../features/AdminAPI).
+The following table lists endpoints that you need to call ("REST service") and callbacks that your agent will receive ("callback") that you need to respond to. See the [detailed API docs](../features/AdminAPI.md).
 
 | Protocol Step        | Faber (Verifier)       | Alice (Holder/Prover)     | Notes |
 | -------------------- | ---------------------- | ------------------------- | ----- |

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.0rc1
+FROM ghcr.io/hyperledger/aries-cloudagent-python:py3.9-0.12.0rc2
 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/Multitenancy.md b/docs/features/Multitenancy.md
@@ -43,7 +43,7 @@ The wallets used by the different tenants are called **sub wallets**. A sub wall
 
 The **base wallet** however, takes on a different role and has limited functionality. Its main function is to manage the sub wallets, which can be done using the [Multi-tenant Admin API](#multi-tenant-admin-api). It stores all settings and information about the different sub wallets and will route incoming messages to the corresponding sub wallets. See [Message Routing](#message-routing) for more details. All other features are disabled for the base wallet. This means it cannot issue credentials, present proof, or do any of the other actions sub wallets can do. This is to keep a clear hierarchical difference between base and sub wallets. For this reason, the base wallet should generally _not_ be provisioned using the `--wallet-seed` argument as not only it is not necessary for sub wallet management operations, but it will also require this DID to be correctly registered on the ledger for the service to start-up correctly.
 
-![Multi-tenancy Architecture](/docs/assets/multitenancyDiagram.png)
+![Multi-tenancy Architecture](../assets/multitenancyDiagram.png)
 
 ### Usage
 
@@ -301,7 +301,7 @@ For deterministic JWT creation and verification between restarts and multiple in
 
 When using the SwaggerUI you can click the :lock: icon next to each of the endpoints or the `Authorize` button at the top to set the correct authentication headers. Make sure to also include the `Bearer` part in the input field. This won't be automatically added.
 
-![API Authentication](/docs/assets/adminApiAuthentication.png)
+![API Authentication](../assets/adminApiAuthentication.png)
 
 ## Tenant Management
 

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-02-17, Release 0.12.0rc1
+**Last Update**: 2024-03-05, Release 0.12.0rc2
 
 > 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.

diff --git a/docs/features/devcontainer.md b/docs/features/devcontainer.md
@@ -5,7 +5,7 @@ We provide a [`devcontainer`](https://containers.dev) and will use [`VS Code`](h
 
 By no means is ACA-Py limited to these tools; they are merely examples.  
 
-**For information on running demos and tests using provided shell scripts, see [DevReadMe](./DevReadMe) readme.**
+**For information on running demos and tests using provided shell scripts, see [DevReadMe](./DevReadMe.md) readme.**
 
 ## Caveats
 

diff --git a/docs/generated/aries_cloudagent.utils.rst b/docs/generated/aries_cloudagent.utils.rst
@@ -33,6 +33,14 @@ aries\_cloudagent.utils.dependencies module
    :undoc-members:
    :show-inheritance:
 
+aries\_cloudagent.utils.endorsement\_setup module
+-------------------------------------------------
+
+.. automodule:: aries_cloudagent.utils.endorsement_setup
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 aries\_cloudagent.utils.env module
 ----------------------------------
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -49,8 +49,8 @@ markdown_extensions:
   - pymdownx.caret
   - pymdownx.details
   - pymdownx.emoji:
-      emoji_generator: !!python/name:materialx.emoji.to_svg
-      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
   - pymdownx.highlight:
       anchor_linenums: true
   - pymdownx.inlinehilite

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.0rc1"
+    "version" : "v0.12.0rc2"
   },
   "servers" : [ {
     "url" : "/"
@@ -376,7 +376,7 @@
           "in" : "query",
           "name" : "state",
           "schema" : {
-            "enum" : [ "abandoned", "invitation", "active", "response", "request", "start", "error", "completed", "init" ],
+            "enum" : [ "abandoned", "invitation", "response", "active", "start", "request", "error", "init", "completed" ],
             "type" : "string"
           }
         }, {

diff --git a/open-api/swagger.json b/open-api/swagger.json
@@ -1,7 +1,7 @@
 {
   "swagger" : "2.0",
   "info" : {
-    "version" : "v0.12.0rc1",
+    "version" : "v0.12.0rc2",
     "title" : "Aries Cloud Agent"
   },
   "tags" : [ {
@@ -339,7 +339,7 @@
           "description" : "Connection state",
           "required" : false,
           "type" : "string",
-          "enum" : [ "abandoned", "invitation", "active", "response", "request", "start", "error", "completed", "init" ]
+          "enum" : [ "abandoned", "invitation", "response", "active", "start", "request", "error", "init", "completed" ]
         }, {
           "name" : "their_did",
           "in" : "query",

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aries_cloudagent"
-version = "0.12.0rc1"
+version = "0.12.0rc2"
 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 <[email protected]>"]
 license = "Apache-2.0"