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

docs: add prism anoncreds method support docs #1386

Merged
merged 3 commits into from
Sep 27, 2024
Merged

Conversation

shotexa
Copy link
Contributor

@shotexa shotexa commented Sep 27, 2024

Description:

This PR needs to be merged together with hyperledger/identus-docs#183

Alternatives Considered (optional):

Link to existing ADR (Architecture Decision Record), if any. If relevant, describe other approaches explored and the selected approach. Documenting why the methods were not selected will create a knowledge base for future reference, helping prevent others from revisiting less optimal ideas.

Checklist:

  • My PR follows the contribution guidelines of this project
  • My PR is free of third-party dependencies that don't comply with the Allowlist
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked the PR title to follow the conventional commit specification

Signed-off-by: Shota Jolbordi <[email protected]>
@shotexa shotexa requested a review from a team as a code owner September 27, 2024 12:54
@github-actions github-actions bot added the docs label Sep 27, 2024
@shotexa shotexa changed the title Update docs docs: add prism anoncreds method support docs Sep 27, 2024
@@ -134,7 +134,10 @@ curl -X 'POST' \
1. `claims`: The data stored in a verifiable credential. AnonCreds claims get expressed in a flat, "string -> string", key-value pair format. The claims contain the data that the issuer attests to, such as name, address, date of birth, and so on.
2. `connectionId`: The unique ID of the connection between the holder and the issuer to offer this credential over.
3. `credentialDefinitionId`: The unique ID of the [credential definition](../credentialdefinition/credential-definition.md) that has been created by the issuer as a prerequisite. Please refer to the [Create AnonCreds Credential Definition](../credentialdefinition/credential-definition.md) doc for details on how to create a credential definition.
1. 📌 Note: If the credential definition was created via HTTP URL endpoint, then this credential definition will be referenced to that credential via HTTP URL, and if this credential definition was created via DID URL endpoint, then it will be referenced via DID URL, How to create credential definition for HTTP URL or DID URL is explained in [credential definition creation guide](../credentialdefinition/create.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

::: note

📌 If the credential definition was created via HTTP URL endpoint, then this credential definition will be referenced to that credential via HTTP URL, and if this credential definition was created via DID URL endpoint, then it will be referenced via DID URL, How to create credential definition for HTTP URL or DID URL is explained in credential definition creation guide

:::

Copy link
Contributor

@petevielhaber petevielhaber left a comment

Choose a reason for hiding this comment

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

This looks like it should be a note using admonitions. It was also numbered back to 1, which I would suggest that notes shouldn't be numbered.

Copy link
Contributor

github-actions bot commented Sep 27, 2024

Integration Test Results

20 files  ±0  20 suites  ±0   2s ⏱️ ±0s
45 tests ±0  45 ✅ ±0  0 💤 ±0  0 ❌ ±0 
71 runs  ±0  71 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit f9edcae. ± Comparison against base commit fbee055.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Sep 27, 2024

Unit Test Results

102 files  ±0  102 suites  ±0   19m 50s ⏱️ -32s
872 tests ±0  864 ✅ ±0  8 💤 ±0  0 ❌ ±0 
879 runs  ±0  871 ✅ ±0  8 💤 ±0  0 ❌ ±0 

Results for commit f9edcae. ± Comparison against base commit fbee055.

♻️ This comment has been updated with latest results.

@coveralls
Copy link

coveralls commented Sep 27, 2024

Coverage Status

coverage: 48.548%. remained the same
when pulling f9edcae on ATL-7667-update-docs
into fbee055 on main.

Copy link

@mattklepp mattklepp left a comment

Choose a reason for hiding this comment

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

Everything looks fine to me.

Signed-off-by: Shota Jolbordi <[email protected]>
@shotexa shotexa changed the title docs: add prism anoncreds method support docs [Skip CI] docs: add prism anoncreds method support docs Sep 27, 2024
@shotexa shotexa changed the title [Skip CI] docs: add prism anoncreds method support docs [skip ci] docs: add prism anoncreds method support docs Sep 27, 2024
@shotexa shotexa changed the title [skip ci] docs: add prism anoncreds method support docs [skip ci]: docs: add prism anoncreds method support docs Sep 27, 2024
@shotexa shotexa changed the title [skip ci]: docs: add prism anoncreds method support docs docs: add prism anoncreds method support docs Sep 27, 2024
@shotexa shotexa merged commit 9eee914 into main Sep 27, 2024
15 of 18 checks passed
@shotexa shotexa deleted the ATL-7667-update-docs branch September 27, 2024 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants