From dcfadb42f8f0dc1c9cc76df91f638d75c1486161 Mon Sep 17 00:00:00 2001 From: wes-smith Date: Mon, 12 Feb 2024 12:48:13 -0500 Subject: [PATCH] Remove returned IssuanceMetadata, reword treatment of credentialId. Co-authored-by: Manu Sporny --- components/Credential.yml | 2 +- components/IssueCredentialOptions.yml | 2 +- components/IssueCredentialSuccess.yml | 11 ++--------- 3 files changed, 4 insertions(+), 11 deletions(-) diff --git a/components/Credential.yml b/components/Credential.yml index 5d3eafd..88e51cb 100644 --- a/components/Credential.yml +++ b/components/Credential.yml @@ -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. diff --git a/components/IssueCredentialOptions.yml b/components/IssueCredentialOptions.yml index fccc371..256b4f4 100644 --- a/components/IssueCredentialOptions.yml +++ b/components/IssueCredentialOptions.yml @@ -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", diff --git a/components/IssueCredentialSuccess.yml b/components/IssueCredentialSuccess.yml index 616ecbe..ae68c52 100644 --- a/components/IssueCredentialSuccess.yml +++ b/components/IssueCredentialSuccess.yml @@ -16,7 +16,7 @@ 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: @@ -24,11 +24,4 @@ components: - 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. \ No newline at end of file + $ref: "./DataIntegrityProof.yml#/components/schemas/DataIntegrityProof" \ No newline at end of file