Clarify that number of issued credentials is related to number of keys #533
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
paulbastian
reviewed
Jun 3, 2025
| @@ -1096,7 +1096,7 @@ If the Credential Response is not encrypted, the media type of the response MUST | |||
|
|
|||
| The following parameters are used in the JSON-encoded Credential Response body: | |||
|
|
|||
| * `credentials`: OPTIONAL. Contains an array of one or more issued Credentials. It MUST NOT be used if the `transaction_id` parameter is present. The elements of the array MUST be objects. This specification defines the following parameters to be used inside this object: | |||
| * `credentials`: OPTIONAL. Contains an array of one or more issued Credentials. It MUST NOT be used if the `transaction_id` parameter is present. The elements of the array MUST be objects. The number of elements in the array is the number of keys for Credentials to be bound to that the Wallet has provided via the `proofs` parameter in the Credential Request, unless the Issuer decides to issue fewer Credentials. This specification defines the following parameters to be used inside this object: | |||
There was a problem hiding this comment.
It reads a little weird to me. How about:
Suggested change
| * `credentials`: OPTIONAL. Contains an array of one or more issued Credentials. It MUST NOT be used if the `transaction_id` parameter is present. The elements of the array MUST be objects. The number of elements in the array is the number of keys for Credentials to be bound to that the Wallet has provided via the `proofs` parameter in the Credential Request, unless the Issuer decides to issue fewer Credentials. This specification defines the following parameters to be used inside this object: | |
| * `credentials`: OPTIONAL. Contains an array of one or more issued Credentials. It MUST NOT be used if the `transaction_id` parameter is present. The elements of the array MUST be objects. The number of elements in the `credentials` array matches the number of keys that the Wallet has provided in the `proofs` parameter of the Credential Request, unless the Issuer decides to issue fewer Credentials. This specification defines the following parameters to be used inside this object: |
There was a problem hiding this comment.
Thanks Paul! I think that is better, though I think "via" is better than "in". "proofs" is an extension point so people could define mechanisms where keys are provided but the keys technically aren't "in" the proofs parameter (a set of keys being derived from an initial key being one case):
Suggested change
| * `credentials`: OPTIONAL. Contains an array of one or more issued Credentials. It MUST NOT be used if the `transaction_id` parameter is present. The elements of the array MUST be objects. The number of elements in the array is the number of keys for Credentials to be bound to that the Wallet has provided via the `proofs` parameter in the Credential Request, unless the Issuer decides to issue fewer Credentials. This specification defines the following parameters to be used inside this object: | |
| * `credentials`: OPTIONAL. Contains an array of one or more issued Credentials. It MUST NOT be used if the `transaction_id` parameter is present. The elements of the array MUST be objects. The number of elements in the `credentials` array matches the number of keys that the Wallet has provided via the `proofs` parameter of the Credential Request, unless the Issuer decides to issue fewer Credentials. This specification defines the following parameters to be used inside this object: |
tplooker
reviewed
Jun 4, 2025
| @@ -1096,7 +1096,7 @@ If the Credential Response is not encrypted, the media type of the response MUST | |||
|
|
|||
| The following parameters are used in the JSON-encoded Credential Response body: | |||
|
|
|||
| * `credentials`: OPTIONAL. Contains an array of one or more issued Credentials. It MUST NOT be used if the `transaction_id` parameter is present. The elements of the array MUST be objects. This specification defines the following parameters to be used inside this object: | |||
| * `credentials`: OPTIONAL. Contains an array of one or more issued Credentials. It MUST NOT be used if the `transaction_id` parameter is present. The elements of the array MUST be objects. The number of elements in the array is the number of keys for Credentials to be bound to that the Wallet has provided via the `proofs` parameter in the Credential Request, unless the Issuer decides to issue fewer Credentials. This specification defines the following parameters to be used inside this object: | |||
There was a problem hiding this comment.
Suggested change
| * `credentials`: OPTIONAL. Contains an array of one or more issued Credentials. It MUST NOT be used if the `transaction_id` parameter is present. The elements of the array MUST be objects. The number of elements in the array is the number of keys for Credentials to be bound to that the Wallet has provided via the `proofs` parameter in the Credential Request, unless the Issuer decides to issue fewer Credentials. This specification defines the following parameters to be used inside this object: | |
| * `credentials`: OPTIONAL. Contains an array of one or more issued Credentials. It MUST NOT be used if the `transaction_id` parameter is present. The elements of the array MUST be objects. The number of elements in this array corresponds to the number of keys the Wallet has provided via the `proofs` parameter in the Credential Request, unless the Issuer decides to issue fewer Credentials. Where each credential returned is bound to a unique key that has been provided by the wallet in the credential request. This specification defines the following parameters to be used inside this object: |
Another possible suggestion for the first part and for the last sentence I added I was trying to weave in explicitly that its not just the number of credentials returned will match the number of proofs provided but also that each credential returned is bound to a unique key. Otherwise plausibly an issuer implementation could for example if it receives 10 proofs in a request return 10 credentials bound to the first key. I'm not sure my language is sufficient yet, but I think we need to clarify that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #510