Skip to content

Commit

Permalink
Small updates to API specification.
Browse files Browse the repository at this point in the history
  • Loading branch information
peacekeeper committed Mar 28, 2024
1 parent ed2db54 commit c06a5af
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions swagger/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
"paths": {
"/identifiers/{identifier}": {
"get": {
"summary": "Resolve a DID / Dereference a DID URL.",
"description": "<p>This endpoint resolves a DID or dereferences a DID URL. As input it takes the DID or DID URL, plus DID resolution <a href=\"https://www.w3.org/TR/did-core/#did-resolution-options\">options</a>. The output is a DID document in one of the supported representations, plus metadata.</p> <p>See the <a href=\"https://w3c-ccg.github.io/did-resolution/\">DID Resolution</a> specification for additional details.</p>",
"summary": "Resolve a DID / Dereference a DID URL",
"description": "<p>This endpoint resolves a DID. As input it takes the DID, plus DID resolution <a href=\"https://www.w3.org/TR/did-core/#did-resolution-options\">options</a>. The output is a DID document in one of the supported representations, plus metadata. The same endpoint can also be used to dereference a DID URL. In this case, the output is a DID document, or part of a DID document, or some other resource identified by the DID URL.</p> <p>See the <a href=\"https://w3c-ccg.github.io/did-resolution/\">DID Resolution</a> specification for additional details.</p>",
"operationId": "resolve",
"tags": [
"Universal Resolver"
Expand Down Expand Up @@ -156,7 +156,8 @@
},
"/properties": {
"get": {
"summary": "Returns a map of properties of the resolver.",
"summary": "Return a map of configuration properties",
"description": "<p>This endpoint returns a map of the configuration properties of the DID Resolver, including of its drivers.</p>",
"operationId": "universalResolverGetProperties",
"tags": [
"Universal Resolver"
Expand All @@ -178,7 +179,8 @@
},
"/methods": {
"get": {
"summary": "Returns a list of supported DID methods.",
"summary": "Return a list of supported DID methods",
"description": "<p>This endpoint returns a list of DID methods supported by the DID Resolver.</p>",
"operationId": "universalResolverGetMethods",
"tags": [
"Universal Resolver"
Expand Down Expand Up @@ -209,7 +211,8 @@
},
"/testIdentifiers": {
"get": {
"summary": "Returns a list of test identifiers that can be resolved.",
"summary": "Return a map of test identifiers",
"description": "<p>This endpoint returns a map of test identifiers, grouped by DID method.</p>",
"operationId": "universalResolverGetTestIdentifiers",
"tags": [
"Universal Resolver"
Expand Down

0 comments on commit c06a5af

Please sign in to comment.