Skip to content

Commit

Permalink
feat(pollux): cleanup the OAS from Issue Credentials and other unused…
Browse files Browse the repository at this point in the history
… tags
  • Loading branch information
yshyn-iohk committed Nov 29, 2022
1 parent e5d1810 commit 79170f8
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 377 deletions.
120 changes: 0 additions & 120 deletions prism-agent/service/api/http/pollux/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -244,126 +244,6 @@ components:
count:
type: integer

#

W3CCredentialInput:
description: |-
Credential input object based on which the new instance of the verifiable credentials is created.
Object contains the minimal set of the fields required to create the credentials for the given subject.
All other required fields of the verifiable credential depend on the context of the cloud agent
required:
- subjectId
- claims
properties:
schemaId:
type: string
description: "Identity of the Verifiable Credentials Schema associated with this object"
example: "did:example:MDP8AsFhHzhwUvGNuYkX7T;id=06e126d1-fa44-4882-a243-1e326fbe21db;version=1.0"
subjectId:
type: string
description: "Subject DID of the verifiable credentials object"
example: "did:prism:subjectofverifiablecredentials"
validityPeriod:
type: number
description: "The validity period in seconds of the verifiable credential"
example: 3600
claims:
type: object
additionalProperties:
type: string
description: "Clams associated with given credentials object (for now it's just a key/value, later should be more complex"

W3CCredential:
description: "Verifiable Credential Object according to W3C specification"
required: ["id", "type", "issuer", "issuanceDate", "credentialSubject"]
properties:
id:
type: string
description: "Credential id or url that can be used to get the status of revoke the credential"
example: "http://example.edu/credentials/1872"
type:
type: string
description: "Credential type according to W3C specification. Must include VerifiableCredentials and type of concrete credentials"
example: '["VerifiableCredential", "AlumniCredential"]'
issuer:
type: string
description: "Issuer DID"
example: "did:prism:issuerdid"
issuanceDate:
type: string
description: "Datetime in ISO format that corresponds to the date of issuance"
example: "2010-01-01T19:23:24Z"
credentialSubject:
type: object
description: "Credentials subject DID and claims according to the schema object"
additionalProperties:
type: string
example:
id: "did:prism:subject12345"
alumni_of: "University"
degree: "master of openapi specification"
proof:
$ref: "#/components/schemas/W3CProof"

W3CCredentialsPaginated:
description: "Paginated response that contains an array of the credential objects"
properties:
data:
type: array
items:
$ref: "#/components/schemas/W3CCredential"
offset:
type: integer
limit:
type: integer
count:
type: integer

W3CIssuanceBatch:
description: "An issuance batch object that is associated with thelist of verifiable credentials"
properties:
id:
type: string
description: "Issuance batch id"
count:
type: integer
description: "Count of the verifiable credentials object in the batch"
actions:
type: array
items:
$ref: "#/components/schemas/W3CIssuanceBatchAction"

W3CIssuanceBatchAction:
description: "Action performed on the list of credentials associated with the issuance batch"
properties:
action:
description: "Action name"
type: string
enum: ["sign", "issue", "send"]
example: "issue"
id:
description: "Action id for tracking"
type: string
example: "uid"
status:
description: "Action status"
type: string
enum: ["scheduled", "pending", "completed", "failed"]

W3CIssuanceBatchPaginated:
description: "Paginated response that contains an array of the issuance-batch objects"
properties:
data:
type: array
items:
$ref: "#/components/schemas/W3CIssuanceBatch"
offset:
type: integer
limit:
type: integer
count:
type: integer

W3CCredentialStatus:
description: Verifiable Credential revocation status
required:
Expand Down
Loading

0 comments on commit 79170f8

Please sign in to comment.