Skip to content

Commit

Permalink
Deployed fa2a8ea to main with MkDocs 1.5.3 and mike 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Mar 6, 2024
1 parent 4891695 commit d76448a
Show file tree
Hide file tree
Showing 11 changed files with 81 additions and 58 deletions.
109 changes: 62 additions & 47 deletions main/CHANGELOG/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion main/demo/AliceWantsAJsonCredential/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2276,7 +2276,7 @@

<h1 id="how-to-issue-json-ld-credentials-using-aca-py">How to Issue JSON-LD Credentials using ACA-Py<a class="headerlink" href="#how-to-issue-json-ld-credentials-using-aca-py" title="Permanent link">&para;</a></h1>
<p>ACA-Py has the capability to issue and verify both Indy and JSON-LD (W3C compliant) credentials.</p>
<p>The JSON-LD support is documented <a href="../JsonLdCredentials.md">here</a> - this document will provide some additional detail in how to use the demo and admin api to issue and prove JSON-LD credentials.</p>
<p>The JSON-LD support is documented <a href="../../features/JsonLdCredentials/">here</a> - this document will provide some additional detail in how to use the demo and admin api to issue and prove JSON-LD credentials.</p>
<h2 id="setup-agents-to-issue-json-ld-credentials">Setup Agents to Issue JSON-LD Credentials<a class="headerlink" href="#setup-agents-to-issue-json-ld-credentials" title="Permanent link">&para;</a></h2>
<p>Clone this repository to a directory on your local:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/hyperledger/aries-cloudagent-python.git
Expand Down
4 changes: 2 additions & 2 deletions main/demo/AriesOpenAPIDemo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2538,7 +2538,7 @@ <h3 id="issue-credential-notes">Issue Credential Notes<a class="headerlink" href
</ul>
<h3 id="bonus-points">Bonus Points<a class="headerlink" href="#bonus-points" title="Permanent link">&para;</a></h3>
<p>If you would like to perform all of the issuance steps manually on the Faber agent side, use a sequence of the other <code>/issue-credential-2.0/</code> messages. Use the <strong><code>GET /issue-credential-2.0/records</code></strong> 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.</p>
<p>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 <a href="../features/AdminAPI">detailed API docs</a>.</p>
<p>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 <a href="../../features/AdminAPI/">detailed API docs</a>.</p>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -2692,7 +2692,7 @@ <h3 id="present-proof-notes">Present Proof Notes<a class="headerlink" href="#pre
<p>As with the issue credential process, the agents handled some of the presentation steps without bothering the controller. In this case, Alice's agent processed the presentation request automatically through its handler for the <code>present_proof_v2_0</code> event, and her wallet contained exactly one credential that satisfied the presentation-request from the Faber agent. Similarly, the Faber agent's handler for the event responds automatically and so on receipt of the presentation, it verified the presentation and updated the status accordingly.</p>
<h3 id="bonus-points_1">Bonus Points<a class="headerlink" href="#bonus-points_1" title="Permanent link">&para;</a></h3>
<p>If you would like to perform all of the proof request/response steps manually, you can call all of the individual <code>/present-proof-2.0</code> messages.</p>
<p>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 <a href="../features/AdminAPI">detailed API docs</a>.</p>
<p>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 <a href="../../features/AdminAPI/">detailed API docs</a>.</p>
<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion main/features/DIDResolution/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2430,7 +2430,7 @@ <h3 id="using-resolver-plugins">Using Resolver Plugins<a class="headerlink" href
</code></pre></div>
<p>The following is a fully functional Dockerfile encapsulating this setup:</p>
<p>```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+<a href="https://github.com/dbluhm/acapy-resolver-github">https://github.com/dbluhm/acapy-resolver-github</a></p>
<p>CMD ["aca-py", "start", "-it", "http", "0.0.0.0", "3000", "-ot", "http", "-e", "<a href="http://localhost:3000">http://localhost:3000</a>", "--admin", "0.0.0.0", "3001", "--admin-insecure-mode", "--no-ledger", "--plugin", "acapy_resolver_github"]
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>To use the above dockerfile:
Expand Down
4 changes: 2 additions & 2 deletions main/features/DevReadMe/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2545,7 +2545,7 @@


<h1 id="developers-read-me-for-hyperledger-aries-cloud-agent-python">Developer's Read Me for Hyperledger Aries Cloud Agent - Python <!-- omit in toc --><a class="headerlink" href="#developers-read-me-for-hyperledger-aries-cloud-agent-python" title="Permanent link">&para;</a></h1>
<p>See the <a href="../../README.md">README</a> for details about this repository and information about how the Aries Cloud Agent - Python fits into the Aries project and relates to Indy.</p>
<p>See the <a href="../../">README</a> for details about this repository and information about how the Aries Cloud Agent - Python fits into the Aries project and relates to Indy.</p>
<h2 id="table-of-contents">Table of Contents <!-- omit in toc --><a class="headerlink" href="#table-of-contents" title="Permanent link">&para;</a></h2>
<ul>
<li><a href="#introduction">Introduction</a></li>
Expand Down Expand Up @@ -2684,7 +2684,7 @@ <h2 id="development-workflow">Development Workflow<a class="headerlink" href="#d
<p>Tests should reside in a directory named <code>tests</code> alongside the code under test. Generally, there is one test file for each file module under test. Test files <em>must</em> have a name starting with <code>test_</code> to be automatically picked up the test runner.</p>
<p>There are some good examples of various test scenarios for you to work from including mocking external imports and working with async code so take a look around!</p>
<p>The test suite also displays the current code coverage after each run so you can see how much of your work is covered by tests. Use your best judgement for how much coverage is sufficient.</p>
<p>Please also refer to the <a href="../../CONTRIBUTING.md">contributing guidelines</a> and <a href="../../CODE_OF_CONDUCT.md">code of conduct</a>.</p>
<p>Please also refer to the <a href="../../CONTRIBUTING/">contributing guidelines</a> and <a href="../../CODE_OF_CONDUCT.md">code of conduct</a>.</p>
<h2 id="publishing-releases">Publishing Releases<a class="headerlink" href="#publishing-releases" title="Permanent link">&para;</a></h2>
<p>The <a href="https://github.com/hyperledger/aries-cloudagent-python/blob/main/PUBLISHING.md">publishing</a> document provides information on tagging a release and publishing the release artifacts to PyPi.</p>
<h2 id="dynamic-injection-of-services">Dynamic Injection of Services<a class="headerlink" href="#dynamic-injection-of-services" title="Permanent link">&para;</a></h2>
Expand Down
4 changes: 2 additions & 2 deletions main/features/Multitenancy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2648,7 +2648,7 @@ <h3 id="base-and-sub-wallets">Base and Sub Wallets<a class="headerlink" href="#b
<p>Multi-tenancy in ACA-Py makes a distinction between a base wallet and sub wallets.</p>
<p>The wallets used by the different tenants are called <strong>sub wallets</strong>. A sub wallet is almost identical to a wallet when multi-tenancy is disabled. This means that you can do everything with it that a single-tenant ACA-Py instance can also do.</p>
<p>The <strong>base wallet</strong> 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 <a href="#multi-tenant-admin-api">Multi-tenant Admin API</a>. It stores all settings and information about the different sub wallets and will route incoming messages to the corresponding sub wallets. See <a href="#message-routing">Message Routing</a> 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 <em>not</em> be provisioned using the <code>--wallet-seed</code> 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.</p>
<p><img alt="Multi-tenancy Architecture" src="/docs/assets/multitenancyDiagram.png" /></p>
<p><img alt="Multi-tenancy Architecture" src="../../assets/multitenancyDiagram.png" /></p>
<h3 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h3>
<p>Multi-tenancy is disabled by default. You can enable support for multiple wallets using the <code>--multitenant</code> startup parameter. To also be able to manage wallets for the tenants, the multi-tenant admin API can be enabled using the <code>--multitenant-admin</code> startup parameter. See <a href="#multi-tenant-admin-api">Multi-tenant Admin API</a> below for more info on the admin API.</p>
<p>The <code>--jwt-secret</code> startup parameter is required when multi-tenancy is enabled. This is used for JWT creation and verification. See <a href="#authentication">Authentication</a> below for more info.</p>
Expand Down Expand Up @@ -2826,7 +2826,7 @@ <h3 id="jwt-secret">JWT Secret<a class="headerlink" href="#jwt-secret" title="Pe
<p>For deterministic JWT creation and verification between restarts and multiple instances, the same JWT secret would need to be used. Therefore a <code>--jwt-secret</code> param is added to the ACA-Py agent that will be used for JWT creation and verification.</p>
<h3 id="swaggerui">SwaggerUI<a class="headerlink" href="#swaggerui" title="Permanent link">&para;</a></h3>
<p>When using the SwaggerUI you can click the <img alt="🔒" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f512.svg" title=":lock:" /> icon next to each of the endpoints or the <code>Authorize</code> button at the top to set the correct authentication headers. Make sure to also include the <code>Bearer</code> part in the input field. This won't be automatically added.</p>
<p><img alt="API Authentication" src="/docs/assets/adminApiAuthentication.png" /></p>
<p><img alt="API Authentication" src="../../assets/adminApiAuthentication.png" /></p>
<h2 id="tenant-management">Tenant Management<a class="headerlink" href="#tenant-management" title="Permanent link">&para;</a></h2>
<p>After registering a tenant which effectively creates a subwallet, you may need to update the tenant information or delete it. The following describes how to accomplish both goals.</p>
<h3 id="update-a-tenant">Update a tenant<a class="headerlink" href="#update-a-tenant" title="Permanent link">&para;</a></h3>
Expand Down
2 changes: 1 addition & 1 deletion main/features/SupportedRFCs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2342,7 +2342,7 @@ <h1 id="aries-aip-and-rfcs-supported-in-aries-cloud-agent-python">Aries AIP and
ACA-Py or the repository <code>main</code> branch. Reminders (and PRs!) to update this page are
welcome! If you have any questions, please contact us on the #aries channel on
<a href="https://discord.gg/hyperledger">Hyperledger Discord</a> or through an issue in this repo.</p>
<p><strong>Last Update</strong>: 2024-02-17, Release 0.12.0rc1</p>
<p><strong>Last Update</strong>: 2024-03-05, Release 0.12.0rc2</p>
<blockquote>
<p>The checklist version of this document was created as a joint effort
between <a href="https://northernblock.io/">Northern Block</a>, <a href="https://animo.id/">Animo Solutions</a> and the Ontario government, on behalf of the Ontario government.</p>
Expand Down
2 changes: 1 addition & 1 deletion main/features/devcontainer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2452,7 +2452,7 @@ <h1 id="aca-py-development-with-dev-container">ACA-Py Development with Dev Conta
<p>The following guide will get you up and running and developing/debugging ACA-Py as quickly as possible.
We provide a <a href="https://containers.dev"><code>devcontainer</code></a> and will use <a href="https://code.visualstudio.com"><code>VS Code</code></a> to illustrate.</p>
<p>By no means is ACA-Py limited to these tools; they are merely examples. </p>
<p><strong>For information on running demos and tests using provided shell scripts, see <a href="./DevReadMe">DevReadMe</a> readme.</strong></p>
<p><strong>For information on running demos and tests using provided shell scripts, see <a href="../DevReadMe/">DevReadMe</a> readme.</strong></p>
<h2 id="caveats">Caveats<a class="headerlink" href="#caveats" title="Permanent link">&para;</a></h2>
<p>The primary use case for this <code>devcontainer</code> is for developing, debugging and unit testing (pytest) the <a href="https://github.com/hyperledger/aries-cloudagent-python/tree/main/aries_cloudagent">aries_cloudagent</a> source code.</p>
<p>There are limitations running this devcontainer, such as all networking is within this container. This container has <a href="https://github.com/microsoft/vscode-dev-containers/blob/main/script-library/docs/docker-in-docker.md">docker-in-docker</a> which allows running demos, building docker images, running <code>docker compose</code> all within this container.</p>
Expand Down
8 changes: 8 additions & 0 deletions main/generated/aries_cloudagent.utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------------------------

Expand Down
2 changes: 1 addition & 1 deletion main/search/search_index.json

Large diffs are not rendered by default.

Binary file modified main/sitemap.xml.gz
Binary file not shown.

0 comments on commit d76448a

Please sign in to comment.