Update READMEs, docs, add how-tos section, first how-to for DIDs #607
Conversation
Codecov Report
@@ Coverage Diff @@
## main #607 +/- ##
==========================================
+ Coverage 26.97% 27.03% +0.05%
==========================================
Files 48 48
Lines 5860 5830 -30
==========================================
- Hits 1581 1576 -5
+ Misses 3995 3971 -24
+ Partials 284 283 -1
|
decentralgabe
changed the title
|
SMASH THE LIKE BUTTON SO HARD I BROKE MY KEYBOARD |
|
@decentralgabe is this a WIP? If so, can we have a flow on the REAME with curl which issues a credential for the simplest schema? (as one block example) - that would be wonderful |
| | [Issuing a Credential](https://github.com/TBD54566975/ssi-service/blob/main/doc/howto/credential.md) | Get started with credential issuance functionality | | ||
| | [Verify a Credential](https://github.com/TBD54566975/ssi-service/blob/main/doc/howto/verification.md) | Get started with credential verification functionality | | ||
| | [Revoke/Suspend a Credential](https://github.com/TBD54566975/ssi-service/blob/main/doc/howto/status.md) | Get started with credential status functionality | | ||
| | [[TODO] Requesting and Verifying Credentials with Presentation Exchange](https://github.com/TBD54566975/ssi-service/issues/606) | Get started with Presentation Exchange functionality | |
There was a problem hiding this comment.
Good doc here: https://hackmd.io/kvCAWD79SFKneGabpdmkgQ courtesy of @tomdaffurn
| @@ -0,0 +1,122 @@ | |||
| # How To: Create a DID | |||
|
|
|||
| ## Background | |||
There was a problem hiding this comment.
Would suggest a TL;DR section with a oneliner curl command. WDYT?
| DIDs are a core component of SSI (Self-Sovereign Identity) systems. DIDs are specified according to "methods" which | ||
| define how the DID is created and how it can be used. A list of existing [DID methods can be found here](https://www.w3.org/TR/did-spec-registries/#did-methods). | ||
|
|
||
| Importantly, DIDs in the SSI Service are _fully custodial_. This means the private keys associated with DID Documents are managed by the service and never leave its boundaries. For some DID methods, such as `did:web` it's possible to add multiple keys to the DID document, and it's possible for these additional keys to be added outside the service. This is a more advanced concept that the service may support in the future. |
| license: | ||
| name: Apache 2.0 | ||
| url: http://www.apache.org/licenses/LICENSE-2.0.html | ||
| title: SSI Service API | ||
| version: '{{.SVN}}' |
There was a problem hiding this comment.
I think we should PIN this in source code, and remove from the configuration file. What's the purposed of having it be configurable? We have no logic that's making decisions off of it.
There was a problem hiding this comment.
we have this issue to track #502 don't want to overload this change set
| engine.GET(SwaggerPrefix, ginswagger.WrapHandler(swaggerfiles.Handler, ginswagger.URL("/swagger.yaml"))) | ||
| } | ||
| engine.StaticFile("swagger.yaml", "./doc/swagger.yaml") | ||
| engine.GET(SwaggerPrefix, ginswagger.WrapHandler(swaggerfiles.Handler, ginswagger.URL("/swagger.yaml"))) |
There was a problem hiding this comment.
Removing this makes it difficult to specify the server urls dynamically. This is important to actually have a nice swagger config.
There was a problem hiding this comment.
yes, but doing it with a template file is not a great solution because it leaves ugly template files to render on the website
using swaggo's default override system as we had before doesn't have this issue, so I will re-add that
There was a problem hiding this comment.
As long as there is a way of handling that use case, then this lgtm.
|
@michaelneale WIP yes, will take the VC stuff in a follow up PR didn't want this to get too big! |
Address part of #606