From 93cab2c1260a5dbb2dbf3802f59b9e0b6d7342df Mon Sep 17 00:00:00 2001 From: Yarmo Mackenbach Date: Thu, 5 Nov 2020 23:28:56 +0100 Subject: [PATCH] WIP Add docs --- docs/_sidebar.md | 10 +++++----- docs/api.md | 25 +++++++++++++++++++++++++ docs/claims.md | 1 + docs/configuration.md | 1 + docs/cryptographickeys.md | 1 + docs/proofs.md | 1 + docs/serviceproviders.md | 1 + 7 files changed, 35 insertions(+), 5 deletions(-) create mode 100644 docs/api.md create mode 100644 docs/claims.md create mode 100644 docs/configuration.md create mode 100644 docs/cryptographickeys.md create mode 100644 docs/proofs.md create mode 100644 docs/serviceproviders.md diff --git a/docs/_sidebar.md b/docs/_sidebar.md index b95b70e..e02080e 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -3,15 +3,15 @@ - [Configuration](configuration.md) - Reference - - API + - [API](api.md) - [Service provider data object](serviceproviderdataobject.md) - Concepts - [DOIP](doip.md) - - [Cryptographic keys](#) - - [Proofs](#) - - [Claims](#) - - [Service providers](#) + - [Cryptographic keys](cryptographickeys.md) + - [Proofs](proofs.md) + - [Claims](claims.nd) + - [Service providers](serviceproviders,md) - Service providers - [Liberapay](serviceproviders/liberapay.md) diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..fc7d158 --- /dev/null +++ b/docs/api.md @@ -0,0 +1,25 @@ +# API + +## verify + +*(async)* doip.verify(uri, [fingerprint], [opts]) + +Verifies the identity behind the provided **uri** using the **fingerprint**. + +**Parameters** + +| Name | Mandatory | Type | Description | +|-------------|-----------|--------|----------------------------------| +| uri | true | string | the URI to an identity to verify | +| fingerprint | false | string | the fingerprint of the claim | +| opts | false | object | options (see below) | + +**Options** + +| Name | Default | Type | Description | +|-------------|-----------|--------|----------------------------------| +| uri | true | string | the URI to an identity to verify | +| fingerprint | false | string | the fingerprint of the claim | +| opts | false | object | options | + +**Returns** diff --git a/docs/claims.md b/docs/claims.md new file mode 100644 index 0000000..34f417c --- /dev/null +++ b/docs/claims.md @@ -0,0 +1 @@ +# Claims diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..a025a48 --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1 @@ +# Configuration diff --git a/docs/cryptographickeys.md b/docs/cryptographickeys.md new file mode 100644 index 0000000..dfa4eaf --- /dev/null +++ b/docs/cryptographickeys.md @@ -0,0 +1 @@ +# Cryptographic keys diff --git a/docs/proofs.md b/docs/proofs.md new file mode 100644 index 0000000..5c4267d --- /dev/null +++ b/docs/proofs.md @@ -0,0 +1 @@ +# Proofs diff --git a/docs/serviceproviders.md b/docs/serviceproviders.md new file mode 100644 index 0000000..a66ad50 --- /dev/null +++ b/docs/serviceproviders.md @@ -0,0 +1 @@ +# Service providers