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

Separate Issuer, Verifier, Holder APIs. #178

Merged
merged 2 commits into from
May 14, 2021
Merged

Conversation

peacekeeper
Copy link
Member

@peacekeeper peacekeeper commented Apr 18, 2021

This separates the VC HTTP API into three separate files for an Issuer API, Verifier API, and Holder API. It also separates out some common schemas (such as "VerifiableCredential") so that they can be re-used independently.

I don't feel too strongly about this, so I'm also fine if this doesn't get merged. But maybe this can be a contribution to the ongoing thought process on how to organize and document things better.

Copy link
Contributor

@mprorock mprorock left a comment

Choose a reason for hiding this comment

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

this is a great step in the right direction

@peacekeeper
Copy link
Member Author

peacekeeper commented Apr 23, 2021

This topic was discussed in a VC HTTP API Special Topic Call on 2021-04-22.

Copy link
Collaborator

@brianorwhatever brianorwhatever left a comment

Choose a reason for hiding this comment

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

some external ref links missing

items:
type: string
"issuer":
$ref: "#/components/schemas/Issuer"
Copy link
Collaborator

Choose a reason for hiding this comment

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

./Issuer.yml#/components/schemas/Issuer

type: object
description: A JSON-LD Verifiable Credential with a proof.
allOf:
- $ref: "#/components/schemas/Credential"
Copy link
Collaborator

Choose a reason for hiding this comment

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

./Credential.yml#/components/schemas/Credential

- type: object
properties:
proof:
$ref: "#/components/schemas/LinkedDataProof"
Copy link
Collaborator

Choose a reason for hiding this comment

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

./LinkedDataProof.yml#/components/schemas/LinkedDataProof

type: object
description: A JSON-LD Verifiable Presentation with a proof.
allOf:
- $ref: "#/components/schemas/Presentation"
Copy link
Collaborator

Choose a reason for hiding this comment

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

./Presentation.yml#/components/schemas/Presentation

- type: object
properties:
proof:
$ref: "#/components/schemas/LinkedDataProof"
Copy link
Collaborator

Choose a reason for hiding this comment

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

./LinkedDataProof.yml#/components/schemas/LinkedDataProof

@peacekeeper
Copy link
Member Author

some external ref links missing

Thanks! Just fixed those in 87dcd79.

@msporny
Copy link
Contributor

msporny commented May 11, 2021

@peacekeeper can you take this PR out of draft... We now have a resolution where we can pull it into the repo:

https://w3c-ccg.github.io/meetings/2021-05-06-vchttpapi/#resolution-1

I'd like to take this up during the call this coming week.

@peacekeeper peacekeeper marked this pull request as ready for review May 11, 2021 10:09
@peacekeeper
Copy link
Member Author

can you take this PR out of draft

done

@msporny msporny merged commit 98ceecf into main May 14, 2021
@msporny msporny deleted the peacekeeper-three-apis branch July 25, 2021 14:52
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.

None yet

5 participants