Skip to content

Commit

Permalink
Merge branch 'main' into feature/ATL-5881
Browse files Browse the repository at this point in the history
* main:
  fix: Improve the Establishing Connection section. (#58)
  chore(release): release prism documentation portal 1.59.1 ## [1.59.1](v1.59.0...v1.59.1) (2023-10-20)
  fix: Remove slash (#57)
  • Loading branch information
elribonazo committed Oct 20, 2023
2 parents d8c17f2 + 95dd96f commit 486181c
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 14 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## [1.59.1](https://github.com/input-output-hk/atala-prism-docs/compare/v1.59.0...v1.59.1) (2023-10-20)


### :sparkles: Updates

* Remove slash ([#57](https://github.com/input-output-hk/atala-prism-docs/issues/57)) ([e3756ff](https://github.com/input-output-hk/atala-prism-docs/commit/e3756ffcb1f351af92bba7718e10f43d2c1ab90c))

## [1.59.0](https://github.com/input-output-hk/atala-prism-docs/compare/v1.58.0...v1.59.0) (2023-10-15)


Expand Down
30 changes: 19 additions & 11 deletions documentation/docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ In order to complete this step you'll need to connect to the mediators Peer DID
```bash
curl --location \
--request GET '[[MEDIATOR ENDPOINT]]/invitation' \
--header 'Content-Type: application/json' \
--header 'Content-Type: application/json'
```

<Tabs>
Expand Down Expand Up @@ -422,6 +422,7 @@ To connect the Holder to both instances, you must run this in both Issuer and Ve
### Establish a connection - Agent side
A connection must be established between the Holder and PRISM Cloud Agents to correctly deliver the Issuance + Verification Messages to the Holder.

#### Establish connection on the Issuer Agent
```bash
curl --location \
--request POST 'http://localhost:8000/prism-agent/connections' \
Expand All @@ -431,7 +432,21 @@ curl --location \
}'
```

This request will return a JSON response with an invitation and its URL. The Cloud Agent (Issuer or Verifier) would share this URL as a QR code, and the holder would scan it with the wallet app.
This request will return a JSON response with an invitation and its URL. The Issuer Agent would share this URL as a QR code, and the holder would scan it with the wallet app.

Copy the `invitationUrl` and the `connectionId`.

#### Establish connection on the Verifier Agent
```bash
curl --location \
--request POST 'http://localhost:9000/prism-agent/connections' \
--header 'Content-Type: application/json' \
--data-raw '{
"label": "Prism Agent demo connection with holder"
}'
```

This request will return a JSON response with an invitation and its URL. The Verifier Agent would share this URL as a QR code, and the holder would scan it with the wallet app.

Copy the `invitationUrl` and the `connectionId`.

Expand Down Expand Up @@ -492,7 +507,7 @@ To trigger the creation of a credential-offer, we call the credential-offers-end

The `schemaId` being the following http://host.docker.internal:8000/prism-agent/schema-registry/schemas/[[schema guid]]

The `connectionId` is just the ID of the connection we previously established.
The `connectionId` is just the ID of the connection we previously established with the issuer.

The Issuing DID is the published PRISM DID in its short version which was also used to create and publish the credential schema.

Expand All @@ -510,13 +525,6 @@ curl --location --request POST 'http://localhost:8000/prism-agent/issue-credenti
}'
```


Attributes:

1. [ConnectionId](/docs/quick-start#establish-a-connection---agent-side)
2. The published [PRISM DID](/docs/quick-start#choose-one-published-prismdid)
3. [SchemaId](/docs/quick-start#create-a-credential-schema-jwt-w3c-credential)

### Create CredentialRequest from CredentialOffer **Holder**

As soon as the `CredentialOffer` message reaches the browser it will be automatically accepted and in exchange, a `credentialRequest` Message will be sent back to the `PrismAgent`.
Expand Down Expand Up @@ -694,7 +702,7 @@ In the example, we show a verification flow that assumes a connection between Ho

### Verifier Agent

To run this section, we will use the second connection we created between the Holder and the Verifier.
To run this section, we will use [the connection](/docs/quick-start#establish-connection-on-the-verifier-agent) we created between the Holder and the Verifier.

```bash
curl --location \
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "prism-documentation-portal",
"version": "1.59.0",
"version": "1.59.1",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down

0 comments on commit 486181c

Please sign in to comment.