Define resolution function with data types and property values #297
Conversation
|
|
||
| <p><code> | ||
| resolve ( did, did-resolution-input-metadata ) <br> | ||
| -> ( did-resolution-metadata, did-document-stream, did-document-metadata ) |
There was a problem hiding this comment.
Is this syntax for these functions described somewhere? Hard to tell looking at this if this can be an async function (in languages that do that). A JavasScript implementation would probably return a Promise here. Is the output a tuple or map with named properties? Seems kind of a fuzzy description for a "MUST". In the JSON-LD API spec we used WebIDL for these API descriptions. Has some rough edges but seemed to work good enough and has some respec support. The LoadDocumentCallback API has a similar pattern to this.
There was a problem hiding this comment.
Those details depend on your language. It's pretty clear in any implementation what "call a function" and "return a value" mean, and it's different for each one.
Here, we're not specifying if it's synchronous or not, so a promise-based resolution would be fine. We're also not specifying how multiple outputs are returned, so a tuple, or an encapsulating object, or a bunch of pointers will all be fine.
There was a problem hiding this comment.
I think it's confusing to use language like "all conformant implementations MUST implement a function in the following form". In a spec I read this as something strict. But here it involves guessing what the ad-hoc function call description means, and understanding it can be sync/async, use tuples, objects, or pointers (for parameters and results maybe?), and I'm guessing the actual names are not required either since many languages can't handle - in identifiers. What form is it that must be followed?
There was a problem hiding this comment.
Additional information looks good. Have question in #296 which would be resolved in that PR and then brought in here, so not concerned with starting the discussion twice.
This adapts the DID Resolution functional definition defined by #253 into a single typed function with requirements for the function signature and implementation conformance. Property values for input and output metadata structures are defined here, with pointers to the DID registry for management of properties. Requirements for when and how to return each value are also added.
This builds on #295 and #296.
Preview | Diff