Skip to content

Commit

Permalink
docs: remove architecture intro section
Browse files Browse the repository at this point in the history
  • Loading branch information
Harasz committed Apr 21, 2022
1 parent a7873ff commit f8da541
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 36 deletions.
23 changes: 21 additions & 2 deletions docs/api/classes/modules_assets.AssetsService.md
Expand Up @@ -14,6 +14,7 @@
- [cancelAssetOffer](modules_assets.AssetsService.md#cancelassetoffer)
- [getAssetById](modules_assets.AssetsService.md#getassetbyid)
- [getAssetHistory](modules_assets.AssetsService.md#getassethistory)
- [getAssetOwner](modules_assets.AssetsService.md#getassetowner)
- [getOfferedAssets](modules_assets.AssetsService.md#getofferedassets)
- [getOwnedAssets](modules_assets.AssetsService.md#getownedassets)
- [getPreviouslyOwnedAssets](modules_assets.AssetsService.md#getpreviouslyownedassets)
Expand Down Expand Up @@ -86,7 +87,7 @@ ___

| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `Object` | Asset Id |
| `id` | `Object` | Asset decentralized identifier |
| `id.id` | `string` | - |

#### Returns
Expand Down Expand Up @@ -122,6 +123,24 @@ Asset[] || []

___

### getAssetOwner

**getAssetOwner**(`id`): `Promise`<`string`\>

Returns owner of the given asset

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | asset decentralized identifier |

#### Returns

`Promise`<`string`\>

___

### getOfferedAssets

**getOfferedAssets**(`__namedParameters?`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>
Expand Down Expand Up @@ -223,7 +242,7 @@ ___

`Promise`<`string`\>

Asset DID
Asset address

___

Expand Down
22 changes: 0 additions & 22 deletions docs/intro/architecture.md

This file was deleted.

14 changes: 3 additions & 11 deletions docs/intro/overview.md
Expand Up @@ -4,18 +4,16 @@ The iam-client-library provides high-level functions related to the identity and

- Creating and managing digital identities, which are the primary form of identification in EW-DOS
- Facilitating claim(credential) requests and issuance for digital identities
- Creating and managing Organizations, Assets and Applicationss

- Creating and managing Organizations, Assets and Applications

## Identity

Identity in EW_DOS is established through a [Decentralized Identity (DID)](https://www.w3.org/TR/did-core/). A DID is a digital, verifiable identity that is user-generated and not coupled to any centralized institution. It can be used to identify any subject, such as a non-tangible asset, a customer, or an organization.

Every DID resolves to a corresponding [DID document](https://www.w3.org/TR/did-use-cases/#dfn-did-documents). The DID Document contains information on the DID subject such as its public keys and authentication mechanisms, attributes and claims. Only the owner of the DID can update this information.
Every DID resolves to a corresponding [DID document](https://www.w3.org/TR/did-use-cases/#dfn-did-documents). The DID Document contains information on the DID subject such as its public keys and authentication mechanisms, attributes and claims. Only the owner of the DID can update this information.

The IAM Client Library's DID Registry Service provides high-level functions to create, fetch and update DIDs and DID Documents.


## Claims

Decentralized Identifiers can make claims to prove an attribute about themselves. A claim is also known as a [Verifiable Credential](https://www.w3.org/TR/vc-data-model/).
Expand All @@ -26,10 +24,4 @@ Once an authority verifies a claim, a VC can then be used as an official record

Verified claims are referenced in a user's DID document by a hash, and the full credential data is stored off-chain in a decentralized file system called [IPFS](https://ipfs.io/)

IAM Client Library's Claims Service handles the request and issuance of claims. See documentation on Claims Service [here](../guides/claim.md).






IAM Client Library's Claims Service handles the request and issuance of claims. See documentation on Claims Service [here](../guides/claim.md).
1 change: 0 additions & 1 deletion mkdocs.yml
Expand Up @@ -3,7 +3,6 @@ nav:
- 'Quick start': 'Quick_start.md'
- Introduction:
- Overview: intro/overview.md
- Architecture: intro/architecture.md
- 'Domain Hierarchy': intro/domainhierarchy.md
- Guides:
- Application: guides/application.md
Expand Down

0 comments on commit f8da541

Please sign in to comment.