Skip to content

Commit

Permalink
docs: Prism Agent documentation suggestions (#100)
Browse files Browse the repository at this point in the history
* Prism Agent documentation review

* Small wording updates, replacing blockchain with VDR and fixed typos

Signed-off-by: 2byrds <2byrds@gmail.com>

---------

Signed-off-by: 2byrds <2byrds@gmail.com>
Co-authored-by: Yurii Shynbuiev - IOHK <102033808+yshyn-iohk@users.noreply.github.com>
  • Loading branch information
2byrds and yshyn-iohk committed Feb 15, 2023
1 parent 882b394 commit 174b4aa
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions prism-agent/service/api/http/prism-agent-openapi-spec.yaml
Expand Up @@ -87,7 +87,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 @@ -112,14 +112,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 @@ -135,9 +135,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.
This endpoint updates the DID document from last confirmed operation.
Submitting multiple update operations without waiting for confirmation will result in
some operation being rejected as only one operation can be appended from last confirmed operation.
Expand All @@ -151,7 +151,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 @@ -630,7 +630,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 @@ -651,7 +651,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

0 comments on commit 174b4aa

Please sign in to comment.