Skip to content

Commit

Permalink
style: apply linters automatic fixes (#1004)
Browse files Browse the repository at this point in the history
Signed-off-by: Hyperledger Bot <hyperledger-bot@hyperledger.org>
Co-authored-by: Hyperledger Bot <hyperledger-bot@hyperledger.org>
  • Loading branch information
github-actions[bot] and hyperledger-bot committed May 3, 2024
1 parent 70b4b35 commit 3f749db
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
38 changes: 19 additions & 19 deletions docs/docusaurus/connections/connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ allowing them to exchange information and interact.

The connection protocol has two roles:

1. [Inviter](/docs/concepts/glossary#inviter): A subject that initiates a connection request by sending a [connection invitation](/docs/concepts/glossary#connection-invitation).
2. [Invitee](/docs/concepts/glossary#invitee): A subject that receives a connection invitation and accepts it by sending a [connection request](/docs/concepts/glossary#connection-request).
1. [Inviter](/docs/concepts/glossary#inviter): A subject that initiates a connection request by sending a [connection invitation](/docs/concepts/glossary#connection-invitation).
2. [Invitee](/docs/concepts/glossary#invitee): A subject that receives a connection invitation and accepts it by sending a [connection request](/docs/concepts/glossary#connection-request).

## Prerequisites

Expand All @@ -21,7 +21,7 @@ The connection protocol has two roles:
The protocol uses the following REST API endpoints:

1. [`/connections`](/agent-api/#tag/Connections-Management):
- [`POST`](/agent-api/#tag/Connections-Management/operation/createConnection): Creates a new connection and returns an invitation
- [`POST`](/agent-api/#tag/Connections-Management/operation/createConnection): Creates a new connection and returns an invitation
- [`GET`](/agent-api/#tag/Connections-Management/operation/getConnections): Returns a list of connections
2. [`GET /connections/{connectionId}`](/agent-api/#tag/Connections-Management/operation/getConnection): Returns an existing connection record by id
3. [`POST /connection-invitations`](/agent-api/#tag/Connections-Management/operation/acceptConnectionInvitation): Accepts an externally received invitation
Expand All @@ -32,10 +32,10 @@ Please check the full [Cloud Agent API](/agent-api) specification for more detai

## Inviter Flow

1. Generate and share a new Out-of-Band (OOB) invitation (connection gets created in `InvitationGenerated` state)
2. Receive a connection request from the Invitee (connection moves to `ConnectionRequestReceived` state)
3. Accept the connection request (connection moves to `ConnectionResponsePending` state)
4. Send the connection response via the DIDComm Agent (connection achieves `ConnectionResponseSent` state)
1. Generate and share a new Out-of-Band (OOB) invitation (connection gets created in `InvitationGenerated` state)
2. Receive a connection request from the Invitee (connection moves to `ConnectionRequestReceived` state)
3. Accept the connection request (connection moves to `ConnectionResponsePending` state)
4. Send the connection response via the DIDComm Agent (connection achieves `ConnectionResponseSent` state)

The following diagram represents the Inviter's Connection state transitions:
```mermaid
Expand All @@ -53,10 +53,10 @@ ConnectionResponseSent --> [*]

## Invitee Flow

1. Receive the OOB invitation (`InvitationReceived` state)
2. Accept the invitation (connection is created in `ConnectionRequestPending` state)
3. Send the connection request via [DIDComm](/docs/concepts/glossary#didcomm) (connection achieves `ConnectionRequestSent` state)
4. Receive the connection response (connection achieves `ConnectionResponseReceived` state)
1. Receive the OOB invitation (`InvitationReceived` state)
2. Accept the invitation (connection is created in `ConnectionRequestPending` state)
3. Send the connection request via [DIDComm](/docs/concepts/glossary#didcomm) (connection achieves `ConnectionRequestSent` state)
4. Receive the connection response (connection achieves `ConnectionResponseReceived` state)

The following diagram represents the Invitee's Connection state transitions:
```mermaid
Expand Down Expand Up @@ -85,10 +85,10 @@ The following example demonstrates how you could use two Cloud Agent APIs to set

```shell
curl -X 'POST' \
'http://localhost:8080/prism-agent/connections' \
-H 'Content-Type: application/json' \
-H "apikey: $API_KEY" \
-d '{ "label": "Connect with Alice" }' | jq
'http://localhost:8080/prism-agent/connections' \
-H 'Content-Type: application/json' \
-H "apikey: $API_KEY" \
-d '{ "label": "Connect with Alice" }' | jq
```

Example response:
Expand All @@ -114,10 +114,10 @@ Example response:
Replace `{RAW_INVITATION}` with the value of the '_oob' query string parameter from the invitation URL above
```shell
curl -X 'POST' \
'http://localhost:8090/prism-agent/connection-invitations' \
-H 'Content-Type: application/json' \
-H "apikey: $API_KEY" \
-d '{ "invitation": "{RAW_INVITATION}" }' | jq
'http://localhost:8090/prism-agent/connection-invitations' \
-H 'Content-Type: application/json' \
-H "apikey: $API_KEY" \
-d '{ "invitation": "{RAW_INVITATION}" }' | jq
```

Example response:
Expand Down
2 changes: 1 addition & 1 deletion docs/docusaurus/multitenancy/tenant-onboarding-ext-iam.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Response Example:

There are multiple ways to complete this step.
The goal is to ensure the user has registered on Keycloak.
Keycloak offers great flexibility, allowing users to self-register,
Keycloak offers great flexibility, allowing users to self-register,
For this tutorial, we will generate the user manually using Keycloak admin API for simplicity.

The first step is to get an admin token from Keycloak using the username and password.
Expand Down

0 comments on commit 3f749db

Please sign in to comment.