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

[Task] Implement JSON-LD output format for DID Documents #196

Open
7 tasks
JelleMillenaar opened this issue Apr 7, 2021 · 2 comments
Open
7 tasks

[Task] Implement JSON-LD output format for DID Documents #196

JelleMillenaar opened this issue Apr 7, 2021 · 2 comments
Labels
Enhancement New feature or improvement to an existing feature

Comments

@JelleMillenaar
Copy link
Collaborator

JelleMillenaar commented Apr 7, 2021

Description

Implement JSON-LD output format for DID Documents. Previous iteration of this Issue held more DID Core updates, but they have either been tackled or have their own issues right now.

Resources

To-do list

Create a task-specific to-do list . Please link PRs that match the To-do list item behind the item after it has been submitted.

  • Allow output of JSON-LD (Aka, just add the default context)

Change checklist

Add an x to the boxes that are relevant to your changes, and delete any items that are not.

  • The feature or fix is implemented in Rust and across all bindings whereas possible.
  • The feature or fix has sufficient testing coverage
  • All tests and examples build and run locally as expected
  • Every piece of code has been document according to the documentation guidelines.
  • If conceptual documentation (mdbook) and examples highlighting the feature exist, they are properly updated.
  • If the feature is not currently documented, a documentation task Issue has been opened to address this.
@JelleMillenaar JelleMillenaar added the Added A new feature that requires a minor release. Part of "Added" section in changelog label Apr 7, 2021
@m-renaud
Copy link
Contributor

Just to make sure I understand:

  1. Reading through the code it looks like the created and updated fields in did::Properties should be moved to a new DIDMetadata struct, correct?
  2. Since currently the Properties are the the first generic parameter to the "core" Document type, we would likely need to introduce a new type param to Document to be generic over a specific "metadata", correct?

And one other question: Would we want unique "input metadata" and "output metadata" types? The new spec says "Input and output metadata is often involved during the DID Resolution"

@l1h3r
Copy link
Contributor

l1h3r commented Apr 23, 2021

  1. Reading through the code it looks like the created and updated fields in did::Properties should be moved to a new DIDMetadata struct, correct?

Yes and there are already distinct types for this, just not really utilized - resolution is still awkward and easier if you use the Client directly and not the generic DID resolver (the difference is mostly just the input/output formats)

  1. Since currently the Properties are the the first generic parameter to the "core" Document type, we would likely need to introduce a new type param to Document to be generic over a specific "metadata", correct?

The data structures stored on the Tangle are going to change soon(ish); this will make Properties redundant and provide much clearer separation between the Document and metadata.

we probably won't need to use generics

@eike-hass eike-hass added Enhancement New feature or improvement to an existing feature and removed Added A new feature that requires a minor release. Part of "Added" section in changelog labels Dec 2, 2021
@cycraig cycraig mentioned this issue Dec 12, 2021
10 tasks
@JelleMillenaar JelleMillenaar changed the title [Task] Comply with DID core updates [Task] Implement JSON-LD output format for DID Documents Jan 25, 2022
@JelleMillenaar JelleMillenaar added this to the v0.6 Features milestone Jan 25, 2022
@eike-hass eike-hass modified the milestones: v0.6 Features, v0.7 Features Jun 8, 2022
@eike-hass eike-hass modified the milestones: v0.7 Features, v0.8 Features Jun 21, 2022
@eike-hass eike-hass removed this from the v0.8 Features milestone Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or improvement to an existing feature
Projects
Status: Product Backlog
Development

No branches or pull requests

4 participants