Skip to content

Commit

Permalink
fix(docs): guides
Browse files Browse the repository at this point in the history
  • Loading branch information
JGiter committed Apr 18, 2022
1 parent f7daa96 commit 627bc88
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/guides/application.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Application

[Application Interface](../api/interfaces/cacheServerClient_cacheServerClient_types.IApp.md
[Application Interface](../api/interfaces/IApp.md)

**Application** represents service provided by parent organization. The only domain type contained by application is Role.
Application domain is described by [IApplication](../docs/interfaces/IApplication.md).
Application domain is described by [IApplication](../api/interfaces/IApp.md).
Example of application

```
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/claim.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,10 @@ The IAM cache server then:
See the Cache Server request handler [here](https://github.com/energywebfoundation/iam-cache-server/blob/07a0053cd10ad16739cc331f043b18cc5dfc0dc4/src/modules/claim/claim.controller.ts#L112).

### 2. Issuing Claims
If the subject's enrolment request is valid, the Issuer can approve and issue the claim to the subject. If the claim has been requested by the signer, this is done by the [issueClaimRequest method](../api/classes/ClaimsService.md#issueclaimrequest). If a claim is being directly issued without having been requested, this is done by the [issueClaim method](../api/classes/modules_claims_claims_service.ClaimsService.md#issueclaim).
If the subject's enrolment request is valid, the Issuer can approve and issue the claim to the subject. If the claim has been requested by the signer, this is done by the [issueClaimRequest method](../api/classes/ClaimsService.md#issueclaimrequest). If a claim is being directly issued without having been requested, this is done by the [issueClaim method](../api/classes/ClaimsService.md#issueclaim).

#### Registering Claims on the Blockchain
A claim request has an array of [RegistrationTypes](../api/interfaces/Claim.md#registrationtypes). A claim can be registered:
A claim request has an array of [RegistrationTypes](../api/enums/RegistrationTypes.md). A claim can be registered:

1. On-Chain only
2. Off-Chain only
Expand Down Expand Up @@ -282,7 +282,7 @@ The UUID identifier for the claim

+ **registrationTypes**

The claim's [Registration Types]((../api/interfaces/Claim.md#registrationtypes)), which can be On-Chain or Off-Chain, or both. These are explained in greater detail [above](#off-chain-registration).
The claim's [Registration Types](../api/enums/RegistrationTypes.md), which can be On-Chain or Off-Chain, or both. These are explained in greater detail [above](#off-chain-registration).

+ **subjectAgreement**

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/organization.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Organization

[Organization Interface](../api/interfaces/cacheServerClient_cacheServerClient_types.IOrganization.md)
[Organization Interface](../api/interfaces/IOrganization.md)

**Organization** is basic type in EnergyWeb domains tree. Its main purpose is to be a root that can group other domains, such as apps and roles.
All other domains such as applications and roles should have parent organization.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/role.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Roles

[Role Interface](../api/interfaces/cacheServerClient_cacheServerClient_types.IRole.md)
[Role Interface](../api/interfaces/IRole.md)

**Role** is leaf in EnergyWeb domains tree. Its main purpose is to distribute responsibilities
and permissions in some domain. As part of its definition, role determines the permissions of its
Expand Down

0 comments on commit 627bc88

Please sign in to comment.