Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update new key types in DID tutorials [skip ci] #1085

Merged
merged 3 commits into from
May 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/integration-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ jobs:
run-integration-tests:
name: "Run integration tests"
runs-on: ubuntu-latest
if: ${{ !contains(github.event.pull_request.title, '[skip ci]') }}
env:
REPORTS_DIR: "tests/integration-tests/target/site/serenity"
steps:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/performance-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ jobs:
run-e2e-tests:
name: "Run performance tests"
runs-on: ubuntu-latest
if: ${{ !contains(github.event.pull_request.title, '[skip ci]') }}
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/unit-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ jobs:
build-and-unit-tests:
name: "Build and unit tests"
runs-on: self-hosted
if: ${{ !contains(github.event.pull_request.title, '[skip ci]') }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
container:
Expand Down
8 changes: 5 additions & 3 deletions docs/docusaurus/dids/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,9 @@ The result should show an empty list, as no DIDs exist on this Cloud Agent insta
### 2. Create the Cloud Agent managed DID using DID registrar endpoint

The DID controller can create a new DID by sending a [DID document](/docs/concepts/glossary#did-document) template to the Agent.
Since key pairs are generated and managed by the Cloud Agent, DID controller only has to specify the key `id` and its purpose (e.g., `authentication`, `assertionMethod`, etc.).
The current PRISM DID method supports a key with a single purpose, but it is extendible to support a key with multiple purposes in the future.
Since key pairs are generated and managed by the Cloud Agent, DID controller only has to specify the key `id`,
`purpose` (`authentication`, `assertionMethod`, etc.), and optional `curve` (`secp256k1`, `Ed25519`, `X25519`).
If the `curve` is omitted, the agent uses the `secp256k1` curve by default.

```bash
curl --location --request POST 'http://localhost:8080/cloud-agent/did-registrar/dids' \
Expand All @@ -67,7 +68,8 @@ curl --location --request POST 'http://localhost:8080/cloud-agent/did-registrar/
"publicKeys": [
{
"id": "auth-1",
"purpose": "authentication"
"purpose": "authentication",
"curve": "secp256k1"
}
],
"services": []
Expand Down
3 changes: 2 additions & 1 deletion docs/docusaurus/dids/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,8 @@ curl --location --request POST 'http://localhost:8080/cloud-agent/did-registrar/
"actionType": "ADD_KEY",
"addKey": {
"id": "key-2",
"purpose": "authentication"
"purpose": "authentication",
"curve": "secp256k1"
}
}
]
Expand Down
Loading