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 documentation for revoking and activating a VC #223

Merged
merged 4 commits into from
Oct 28, 2024

Conversation

huynguyen-hl
Copy link
Contributor

@huynguyen-hl huynguyen-hl commented Oct 16, 2024

What type of PR is this? (check all applicable)

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation Update
  • 🎨 Style
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ”₯ Performance Improvements
  • βœ… Test
  • πŸ€– Build
  • πŸ” CI
  • πŸ“¦ Chore (Release)
  • ⏩ Revert

Description

This PR adds guidance on how to revoke and activate a VC using APIs.

Related Tickets & Documents

https://github.com/gs-gs/fa-ag-trace/issues/595

Mobile & Desktop Screenshots/Recordings

image image

Added tests?

  • πŸ‘ yes
  • πŸ™… no, because they aren't needed
  • πŸ™‹ no, because I need help

Added to documentation?

  • πŸ“œ README.md
  • πŸ““ vc-kit doc site
  • πŸ“• storybook
  • πŸ™… no documentation needed

Copy link

github-actions bot commented Oct 16, 2024

Coverage report

Caution

Coverage does not meet threshold
Statements coverage not met for global: expected <=25 not covered statements, but got 0

St.❔
Category Percentage Covered / Total
🟒 Statements 100% 0/0
🟒 Branches 100% 0/0
🟒 Functions 100% 0/0
🟒 Lines 100% 0/0

Test suite run success

0 tests passing in 0 suite.

Report generated by πŸ§ͺjest coverage report action from afdb319

@huynguyen-hl huynguyen-hl changed the title docs: add Revoke a VC and Activate a VC docs docs: add documentation for revoking and activating a VC Oct 17, 2024
@ashleythedeveloper
Copy link
Contributor

This LGTM, can someone confirm the payloads/responses?

@namhoang1604
Copy link
Contributor

Should we introduce the issuing bitstring status flow?

@huynguyen-hl
Copy link
Contributor Author

huynguyen-hl commented Oct 22, 2024

@namhoang1604, Yes, I agree with you about adding the issuing BitstringStatusList flow to the documentation site. However, since there are currently no flow charts in the entire site, I believe we need a ticket to create flow charts for all the APIs that already have documentation. If we only include the flow chart for the issuing BitstringStatusList, it might make the documentation site a bit inconsistent, don’t you think?

Copy link
Contributor

@namhoang1604 namhoang1604 left a comment

Choose a reason for hiding this comment

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

LGTM

@huynguyen-hl huynguyen-hl merged commit 468739f into next Oct 28, 2024
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