forked from Mirrors/doipjs
WIP Add docs
This commit is contained in:
parent
3d8aa73456
commit
93cab2c126
7 changed files with 35 additions and 5 deletions
|
@ -3,15 +3,15 @@
|
||||||
- [Configuration](configuration.md)
|
- [Configuration](configuration.md)
|
||||||
|
|
||||||
- Reference
|
- Reference
|
||||||
- API
|
- [API](api.md)
|
||||||
- [Service provider data object](serviceproviderdataobject.md)
|
- [Service provider data object](serviceproviderdataobject.md)
|
||||||
|
|
||||||
- Concepts
|
- Concepts
|
||||||
- [DOIP](doip.md)
|
- [DOIP](doip.md)
|
||||||
- [Cryptographic keys](#)
|
- [Cryptographic keys](cryptographickeys.md)
|
||||||
- [Proofs](#)
|
- [Proofs](proofs.md)
|
||||||
- [Claims](#)
|
- [Claims](claims.nd)
|
||||||
- [Service providers](#)
|
- [Service providers](serviceproviders,md)
|
||||||
|
|
||||||
- Service providers
|
- Service providers
|
||||||
- [Liberapay](serviceproviders/liberapay.md)
|
- [Liberapay](serviceproviders/liberapay.md)
|
||||||
|
|
25
docs/api.md
Normal file
25
docs/api.md
Normal file
|
@ -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**
|
1
docs/claims.md
Normal file
1
docs/claims.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# Claims
|
1
docs/configuration.md
Normal file
1
docs/configuration.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# Configuration
|
1
docs/cryptographickeys.md
Normal file
1
docs/cryptographickeys.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# Cryptographic keys
|
1
docs/proofs.md
Normal file
1
docs/proofs.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# Proofs
|
1
docs/serviceproviders.md
Normal file
1
docs/serviceproviders.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# Service providers
|
Loading…
Reference in a new issue