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

Make DidManagementApi more explicit #220

Closed
paullatzelsperger opened this issue Jan 15, 2024 · 0 comments · Fixed by #226
Closed

Make DidManagementApi more explicit #220

paullatzelsperger opened this issue Jan 15, 2024 · 0 comments · Fixed by #226
Labels
api breaking-change Will require manual intervention for version update enhancement New feature or request

Comments

@paullatzelsperger
Copy link
Member

paullatzelsperger commented Jan 15, 2024

Feature Request

The DidManagementApi will undergo the following changes:

  • remove all mutating endpoints except publish and unpublish
  • add endpoints to modify specific properties, e.g. serviceEndpoints:
    • PATCH /dids/endpoint: body contains the DID and the service endpoint to replace. Returns a 400 if the endpoint does not exist exists
    • DELETE /dids/endpoint: body contains the DID and the service endpoint ID to remove. Returns a 400 if the endpoint does not exist.
    • POST /dids/endpoint: body contains the DID and the service endpoint ro add. Returns a 409 if the same endpoint already exists.

Which Areas Would Be Affected?

DID management API

Why Is the Feature Desired?

DIDs are managed items, the are a mere representation of a participant, so modifying them directly should not be possible. The "single source of truth" must
always be the DidResource which we hold in the database.

More specific endpoints, avoid the danger of completely overwriting a DID.

Solution Proposal

If possible, provide a (brief!) solution proposal.

@paullatzelsperger paullatzelsperger added api breaking-change Will require manual intervention for version update enhancement New feature or request labels Jan 15, 2024
@paullatzelsperger paullatzelsperger changed the title Modify DidManagementApi Make DidManagementApi more specific Jan 15, 2024
@paullatzelsperger paullatzelsperger changed the title Make DidManagementApi more specific Make DidManagementApi more explicit Jan 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api breaking-change Will require manual intervention for version update enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant