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.

Sign up for GitHub

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

Jump to bottom

docs: Prism Agent documentation suggestions #100

Merged
merged 4 commits into from
Feb 15, 2023
Merged

docs: Prism Agent documentation suggestions #100

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b25597c
Prism Agent documentation review
2byrds Nov 8, 2022
f9c4e8b
merged with latest main
2byrds Jan 25, 2023
d660cbf
Small wording updates, replacing blockchain with VDR and fixed typos
2byrds Jan 25, 2023
cc0d744
Merge branch 'main' into rootsid-documentation-review-agent-api
yshyn-iohk Feb 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 9 additions & 9 deletions prism-agent/service/api/http/prism-agent-openapi-spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ paths:
summary: Create unpublished DID and store it in PrismAgent's wallet
description: |
Create unpublished DID and store it inside PrismAgent's wallet. The private keys of the DID is
managed by PrismAgent. The DID can later be published to blockchain using publications endpoint.
managed by PrismAgent. The DID can later be published to the VDR using publications endpoint.
requestBody:
required: true
content:
Expand All @@ -171,14 +171,14 @@ paths:
post:
tags: ["DID Registrar"]
operationId: publishManagedDid
summary: Publish the DID stored in PrismAgent's wallet to the blockchain
summary: Publish the DID stored in PrismAgent's wallet to the VDR
description: |
Publish the DID stored in PrismAgent's wallet to the blockchain.
Publish the DID stored in PrismAgent's wallet to the VDR.
parameters:
- $ref: "./castor/parameters.yaml#/components/parameters/didRefInPath"
responses:
"202":
description: Publishing DID to Blockchain.
description: Publishing DID to the VDR.
content:
application/json:
schema:
Expand All @@ -194,9 +194,9 @@ paths:
post:
tags: ["DID Registrar"]
operationId: updateManagedDid
summary: Update DID in PrismAgent's wallet and post update operation to blockchain
summary: Update DID in PrismAgent's wallet and post update operation to the VDR
description: |
Update DID in PrismAgent's wallet and post update operation to blockchain.
Update DID in PrismAgent's wallet and post update operation to the VDR.
requestBody:
required: true
content:
Expand All @@ -207,7 +207,7 @@ paths:
- $ref: "./castor/parameters.yaml#/components/parameters/didRefInPath"
responses:
"202":
description: Publishing DID to Blockchain.
description: Publishing DID to the VDR.
content:
application/json:
schema:
Expand Down Expand Up @@ -663,7 +663,7 @@ paths:
schema:
$ref: ./pollux/schemas.yaml#/components/schemas/IssueCredentialRecord
"404":
description: There is no issue credential record maatching the given 'recordId'.
description: There is no issue credential record matching the given 'recordId'.
content:
application/json:
schema:
Expand All @@ -684,7 +684,7 @@ paths:
schema:
$ref: ./pollux/schemas.yaml#/components/schemas/IssueCredentialRecord
"404":
description: There is no issue credential record maatching the given 'recordId'.
description: There is no issue credential record matching the given 'recordId'.
content:
application/json:
schema:
Expand Down