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.

Sign up for GitHub

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

Jump to bottom

RFC-0031: Implement vc-api holder agent router #100

Closed
namhoang1604 opened this issue Jun 21, 2023 · 0 comments
Closed

RFC-0031: Implement vc-api holder agent router #100

namhoang1604 opened this issue Jun 21, 2023 · 0 comments
Assignees
@namhoang1604
Milestone
MVP0

Comments

@namhoang1604
Copy link
Contributor

Description

This ticket aims to enhance APIs for holders following the w3c VC-API. The relevant link for reference is provided here: https://github.com/uncefact/project-vckit/tree/main/rfcs/features/0031-vc-api

Acceptance criteria:

  • Develop interfaces for the VC-API to handle both request and response operations.
  • Establish a mapping mechanism between the VC-API interfaces and the core-types interfaces of the VC-Kit.
  • Thoroughly document the implementation process for future reference.
@namhoang1604 namhoang1604 self-assigned this Jun 21, 2023
@namhoang1604 namhoang1604 added this to the MVP0 milestone Jun 21, 2023
@namhoang1604 namhoang1604 mentioned this issue Jun 22, 2023
Merged
18 tasks
namhoang1604 added a commit that referenced this issue Jul 6, 2023
@namhoang1604
feat: vc api for the holder and the verifier (#107)
022fb56 
<!--
  For Work In Progress Pull Requests, please use the Draft PR feature,
see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for
further details.
  
  For a timely review/response, please avoid force-pushing additional
  commits if your PR already received reviews or comments.
  
Before submitting a Pull Request, please ensure you've done the
following:
- 📖 Read the [Contributing
Guide](https://github.com/uncefact/project-vckit/blob/main/CONTRIBUTING.md).
- 📖 Read the [Code of
Conduct](https://github.com/uncefact/project-vckit/blob/main/CODE_OF_CONDUCT.md).
  - 👷‍♀️ Create small PRs. In most cases, this will be possible.
  - ✅ Provide tests for your changes.
- 📝 Use descriptive commit messages following [conventional
commits](https://www.conventionalcommits.org/en/v1.0.0/).
- 📗 Update any related documentation and include any relevant
screenshots.
-->

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

- [x] 🍕 Feature
- [ ] 🐛 Bug Fix
- [x] 📝 Documentation Update
- [ ] 🎨 Style
- [ ] 🧑‍💻 Code Refactor
- [ ] 🔥 Performance Improvements
- [x] ✅ Test
- [ ] 🤖 Build
- [ ] 🔁 CI
- [ ] 📦 Chore (Release)
- [ ] ⏩ Revert

## Description

<!-- 
Please do not leave this blank 
This PR [adds/removes/fixes/replaces] the [feature/bug/etc]. 
-->
- Implement the vc-api for the holder and verifier.
- Implement the open api validator for the vc api router

```yaml
# API base path
- - $require: '@vckit/vc-api?t=function#HolderRouter'
- - $require: '@vckit/vc-api?t=function#IssuerRouter'
    $args:
      - createCredential: createVerifiableCredential
        updateCredentialStatus: updateVerifiableCredentialStatus
- - $require: '@vckit/vc-api?t=function#VerifierRouter'
    $args:
      - verifyCredential: verifyCredential
        verifyPresentation: verifyPresentation

# VC API docs path
- - /vc-api.json
  - $require: '@vckit/vc-api?t=function#VCApiSchemaRouter'
    $args:
      - basePath: :3332

- - /vc-api-docs
  - $require: '@vckit/vc-api?t=function#VCApiDocsRouter'
```

## Related Tickets & Documents
<!-- 
Please use this format link issue numbers: Fixes #123

https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
-->
#100
#92
#115

## Mobile & Desktop Screenshots/Recordings

<!-- Visual changes require screenshots -->

<img width="1510" alt="image"
src="https://github.com/uncefact/project-vckit/assets/13606809/5168be6a-ae27-4b6c-b4d4-7b51d8175d27">

<img width="536" alt="image"
src="https://github.com/uncefact/project-vckit/assets/13606809/1a1d08e8-fc02-48f5-aced-1ec56a2c24b5">

<img width="426" alt="image"
src="https://github.com/uncefact/project-vckit/assets/13606809/181eac6d-0998-4f31-9686-d855c2c6e626">





## Added tests?

- [x] 👍 yes
- [ ] 🙅 no, because they aren't needed
- [ ] 🙋 no, because I need help

## Added to documentation?

- [x] 📜 README.md
- [ ] 📓 [vc-kit doc site](https://uncefact.github.io/vckit/)
- [ ] 📕 storybook
- [ ] 🙅 no documentation needed

## [optional] Are there any post-deployment tasks we need to perform?


<!-- note: PRs with deleted sections will be marked invalid -->

---------

Signed-off-by: Nam Hoang <hoangxuannam160493@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@namhoang1604 namhoang1604

Labels
None yet
Projects
None yet
Milestone
MVP0
Development

No branches or pull requests
1 participant
@namhoang1604