Skip to content

Commit

Permalink
Remove returned IssuanceMetadata, reword treatment of credentialId.
Browse files Browse the repository at this point in the history
Co-authored-by: Manu Sporny <[email protected]>
  • Loading branch information
wes-smith and msporny authored Feb 12, 2024
1 parent dd0add5 commit dcfadb4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 11 deletions.
2 changes: 1 addition & 1 deletion components/Credential.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ components:
type: string
"id":
type: string
description: The ID of the credential. This property MAY be empty. The issuer SHOULD NOT auto-generate the id property, as this can lead to unrecoverable partitioning errors.
description: The ID of the credential. This property MAY be empty. The issuer SHOULD NOT auto-generate the id property since the client wanted to issue a VC without the id.
"type":
type: array
description: The JSON-LD type of the credential.
Expand Down
2 changes: 1 addition & 1 deletion components/IssueCredentialOptions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ components:
description: The type of credential status to issue the credential with
credentialId:
type: string
description: An identifier that can be used to identify the credential. credentialId SHOULD NOT be set if the id property is set. If credential.id is set, that value will be duplicated for credentialId. If neither credentialId nor id is set, there will be no way to uniquely identify a credential or deal with duplicate errors. This property should not be used as a replacement for credential.id, rather as a means of identifying a credential without the id property set.
description: A URI that can be used to identify the credential, that will be used in APIs to refer to the issued verifiable credential. If not provided, the value will be auto-populated from credential.id. If credentialId is not provided and credential.id is not provided, it is not possible to refer to this credential once issued or deal with duplicate errors. credentialId SHOULD NOT be set if the credential.id property is set. This property should not be used as a replacement for credential.id, rather as a means of identifying a credential without the id property set. The issuer SHOULD NOT auto-generate a credentialId if one is not supplied because doing so could create a partitioning error if the result is never received by the client.
example:
{
"created": "2020-04-02T18:48:36Z",
Expand Down
11 changes: 2 additions & 9 deletions components/IssueCredentialSuccess.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,12 @@ components:
type: object
description: The format returned from a successful issue request.
properties:
VerifiableCredential:
verifiableCredential:
type: object
description: A JSON-LD Verifiable Credential with a proof.
allOf:
- $ref: "./Credential.yml#/components/schemas/Credential"
- type: object
properties:
proof:
$ref: "./DataIntegrityProof.yml#/components/schemas/DataIntegrityProof"
IssuanceMetadata:
type: object
description: Metadata about the issued credential.
properties:
credentialId:
type: string
description: An identifier for the credential. If credentialId is not set by the user in the issue request, credential.id will be duplicated here.
$ref: "./DataIntegrityProof.yml#/components/schemas/DataIntegrityProof"

0 comments on commit dcfadb4

Please sign in to comment.