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.

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

Document the format of the credentials returned by the IdentityHubCredentialsVerifier. #36

Conversation

ouphi
Copy link

@ouphi ouphi commented Jul 29, 2022

What this PR changes/adds

Document the format of the Map<String, Object> returned by the IdentityHubCredentialsVerifier.

Linked Issue(s)

Closes # <-- insert Issue number if one exists

Checklist

  • added appropriate tests?
  • performed checkstyle check locally?
  • added/updated copyright headers?
  • documented public classes/methods?
  • added/updated relevant documentation?
  • added relevant details to the changelog? (skip with label no-changelog)
  • formatted title correctly? (take a look at the CONTRIBUTING and styleguide for details)

@ouphi ouphi changed the title Feature/33/33 adr document claims format Document the format of the credentials returned by the IdentityHubCredentialsVerifier. Jul 29, 2022
@github-actions
Copy link

github-actions bot commented Jul 29, 2022

Unit Test Results

46 tests  ±0   46 ✔️ ±0   9s ⏱️ -1s
11 suites ±0     0 💤 ±0 
11 files   ±0     0 ±0 

Results for commit 8bc2da6. ± Comparison against base commit 7623480.

♻️ This comment has been updated with latest results.

@ouphi ouphi marked this pull request as ready for review July 29, 2022 13:30
The IdentityHubCredentialsVerifier returns a Map<String, Object>, it contains verifiable credentials with the following format:

```json
<verifiable-credential-id>: {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cant we have more than one VC for a given verifiable-credential-id? For example if we are dealing with multiple VC issuers.

If yes, we can have a List. Maybe an example for illustrating this case?

Copy link
Author

@ouphi ouphi Aug 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The goal of this PR is to document the format that is already used, but I agree that it could be simplified by using a List later.

@ouphi ouphi requested a review from algattik August 2, 2022 13:27
@ouphi ouphi merged commit 40cc6ee into feature/33-document-claims-format Aug 5, 2022
@ouphi ouphi deleted the feature/33/33-adr-document-claims-format branch August 5, 2022 13:51
ouphi added a commit that referenced this pull request Aug 9, 2022
…ubCredentialsVerifier. (#36) (#17)

* Documented claims format.

* improved explanations.

* Update docs/developer/decision-records/2022-07-01-get-claims/README.md

Co-authored-by: Alexandre Gattiker <algattik@users.noreply.github.com>

* Added subject in doc.

* Made the json format valid.

* Added information about the credentialSubject field.

* Added @code.

* Used pre .

Co-authored-by: Alexandre Gattiker <algattik@users.noreply.github.com>

Co-authored-by: Alexandre Gattiker <algattik@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants