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

Consistency on implementation JSON's properties needed for report generation #132

Open
shigeya opened this issue May 25, 2021 · 6 comments

Comments

@shigeya
Copy link
Contributor

shigeya commented May 25, 2021

For report generating purposes, we need to have at least:

  • didMethod
  • implementation
  • implementer

Some of the JSON lacks didMethod.

A few thoughts.

  1. I can update them by myself (I mean, not asking implementers to update), but we need to document this somewhere to avoid editing by ourselves.
  2. We probably need both descriptive texts for implementer and the submitter's contact, maybe GitHub user id. I think it is not wise to bury GitHub user id into descriptive texts.
  3. Implementation is a descriptive text. Some of them using the GitHub path; some of them include descriptive texts. Since this will appear as part of the test report, we may need to adjust texts to make the generated tables consistent.
@OR13
Copy link
Contributor

OR13 commented May 25, 2021

I suggest we solve this by injecting defaults when they are not present.

and use the following defaults:

"didMethod": "UNKNOWN",
"implementation": "UNKNOWN",
"implementer": "UNKNOWN",

and then we can incrementally replace UNKNOWNs with reasonable values.

@peacekeeper
Copy link
Contributor

For the Universal Resolver reports, we always just use the string "Universal Resolver" as the "implementation" field (e.g. see here).

@BernhardFuchs maybe we should update our Universal Resolver reports to also include the DID method name in the "implementation" field, e.g. to say something like "Universal Resolver - did:example"

@shigeya
Copy link
Contributor Author

shigeya commented May 25, 2021

@peacekeeper I will probably make didMethod appear in the report, so adding that text in the implementation property causes duplicates (while it's fine..)

@BernhardFuchs
Copy link
Contributor

@shigeya We could easily add the property didMethod to the reports. My approach would be to parse it from the identifier.

Question is in which format the value should be:

  • did:btcr or
  • btcr

or any other idea?

@shigeya
Copy link
Contributor Author

shigeya commented May 26, 2021

@shigeya We could easily add the property didMethod to the reports. My approach would be to parse it from the identifier.

Thank you.

Question is in which format the value should be:

  • did:btcr or
  • btcr

or any other idea?

I think did:btcr seems good. we can eliminate did: but then, the text is buried among the texts, hard to recognize.

@BernhardFuchs
Copy link
Contributor

@shigeya didMethod parameter is added #134

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

No branches or pull requests

4 participants