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

Discovery: OpenAPI spec for server and client #2584

Merged
merged 7 commits into from
Dec 6, 2023
Merged

Conversation

reinkrul
Copy link
Member

@reinkrul reinkrul commented Nov 5, 2023

No description provided.

Copy link
Member

@woutslakhorst woutslakhorst left a comment

Choose a reason for hiding this comment

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

Comment from roadmap update: rename it to DiscoveryService

docs/_static/usecase/v1.yaml Outdated Show resolved Hide resolved
docs/_static/usecase/v1.yaml Outdated Show resolved Hide resolved
docs/_static/usecase/v1.yaml Outdated Show resolved Hide resolved
docs/_static/usecase/v1.yaml Outdated Show resolved Hide resolved
get:
summary: Searches a for presentations on the usecase list.
description: |
An API of the use case client that searches a for presentations on the usecase list,
Copy link
Member

Choose a reason for hiding this comment

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

it's a bit weird to have the client and server api on the same path. Before a client can use it as registry some additional work has to be done (did service resolving). I think the result of the list should feed into the same registry as the network for now. An api can be added later.

Copy link
Member Author

Choose a reason for hiding this comment

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

Then we have to build pruning into that store (it's the "VCR store") as well. Maybe we should just search in both stores. Although the current VCR search does not know about the discovery service IDs, so you don't know in which service to search.

Perhaps search in all of them, and deduplicate results?

VerifiablePresentation:
$ref: "../common/ssi_types.yaml#/components/schemas/VerifiablePresentation"
securitySchemes:
jwtBearerAuth:
Copy link
Member

Choose a reason for hiding this comment

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

security is indeed a question. But'll probably not be a bearer jwt.

the add and delete are "protected" by the VP, what additional protection should we add?

Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure we need any additional protection; the "get" is a cheap operation, and to register a VP you need a VC that matches the presentation definition of the service. Risk would be DoS attacks?

@reinkrul reinkrul changed the title UseCase: OpenAPI spec for list maintainer and client Discovery: OpenAPI spec for server and client Dec 5, 2023
@reinkrul reinkrul merged commit 2842b89 into master Dec 6, 2023
9 checks passed
@reinkrul reinkrul deleted the usecaselist-oapi branch December 6, 2023 05:05
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.

2 participants