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 1 commit
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
26 changes: 13 additions & 13 deletions prism-agent/api/http/prism-agent-openapi-spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ paths:
post:
tags: [ "DID" ]
operationId: createDid
summary: Publish DID create operation to blockchain.
description: Publish DID create operation to blockchain.
summary: Publish DID create operation to the VDR.
description: Publish DID create operation to the VDR.
requestBody:
required: true
content:
Expand All @@ -48,7 +48,7 @@ paths:
$ref: "./castor/schemas.yaml#/components/schemas/CreateDIDRequest"
responses:
"202":
description: Created DID. Publishing DID or Proof to Blockchain.
description: Created DID. Publishing DID or Proof to the VDR.
content:
application/json:
schema:
Expand All @@ -69,8 +69,8 @@ paths:
get:
tags: [ "DID" ]
operationId: getDid
summary: Resolve DID.
description: Resolve DID.
summary: Retrieves the DID document of the DID.
description: Retrieves the DID document of the DID.
parameters:
- $ref: "./castor/parameters.yaml#/components/parameters/didRefInPath"
responses:
Expand All @@ -91,8 +91,8 @@ paths:
post:
tags: [ "DID" ]
operationId: updateDid
summary: Publish DID update operation to blockchain.
description: Publish DID update operation to blockchain.
summary: Publish DID update operation to VDR.
description: Publish DID update operation to VDR.
parameters:
- $ref: "./castor/parameters.yaml#/components/parameters/didRefInPath"
requestBody:
Expand All @@ -103,7 +103,7 @@ paths:
$ref: "./castor/schemas.yaml#/components/schemas/UpdateDIDRequest"
responses:
"202":
description: Updated DID. Publishing Updated DID or Update Proof to Blockchain.
description: Updated DID. Publishing Updated DID or Update Proof to the VDR.
content:
application/json:
schema:
Expand Down Expand Up @@ -181,7 +181,7 @@ paths:
$ref: "./castor/schemas.yaml#/components/schemas/RecoverDIDRequest"
responses:
"202":
description: Recovered DID. Publishing Recovered DID or Recovery Proof to Blockchain.
description: Recovered DID. Publishing Recovered DID or Recovery Proof to the VDR.
content:
application/json:
schema:
Expand Down Expand Up @@ -335,13 +335,13 @@ paths:
post:
tags: [ "DID Registrar" ]
operationId: publishManagedDid
summary: Publish DID stored in PrismAgent wallet to blockchain
description: Publish DID stored in PrismAgent wallet to blockchain
summary: Publish DID stored in PrismAgent wallet to the VDR
description: Publish DID stored in PrismAgent 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 Down Expand Up @@ -548,7 +548,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