Skip to content

Commit

Permalink
Additional fixes and docs for the 2.4.0 release (#1262)
Browse files Browse the repository at this point in the history
* Added iREC files in folder

* Delete iREC Schema.schema

* Delete iRec Policy 2.policy

* Delete iRec Policy.policy

* rename nft api key setting

Signed-off-by: artembuslaev <[email protected]>

* Add files via upload

* Delete Inverter.schema

* Delete MRV.schema

* Fixed links, highlighting and linting;
Fixes some statements in the text;
'Refactoring of the paragraphs';
Using live link (not permalink) when referring to generic external documentation that can be updated;
Use 'Guardian' instead of 'The Guardian' (it should be done through all the docs);

Signed-off-by: Giuseppe Bertone <[email protected]>

* GitBook: [#145] Fixed minor changes as per ReadMe

* GitBook: [#146] Added IPFS_STORAGE_API_KEY

* update swagger

* fix error messages

* update import messages

* fix

* fix

* fix

* fix

* prevent change status on creation step

Signed-off-by: artembuslaev <[email protected]>

* fixed policy's pagination

Signed-off-by: artembuslaev <[email protected]>

* fix change policy status

* check policy status

* fix run multiple tests

Signed-off-by: simvalery <[email protected]>

* fix lint

Signed-off-by: simvalery <[email protected]>

* fix tests

Signed-off-by: simvalery <[email protected]>

* fix tests

Signed-off-by: simvalery <[email protected]>

* fix tests

Signed-off-by: simvalery <[email protected]>

* fix tests

* fix run multiple tests

Signed-off-by: simvalery <[email protected]>

* fix lint

Signed-off-by: simvalery <[email protected]>

* fix tests

Signed-off-by: simvalery <[email protected]>

* fix tests

Signed-off-by: simvalery <[email protected]>

* fix tests

Signed-off-by: simvalery <[email protected]>

Signed-off-by: simvalery <[email protected]>

* added find single schema endpoint

Signed-off-by: artembuslaev <[email protected]>

* enable closing of 'save as' dialog

Signed-off-by: artembuslaev <[email protected]>

* added single schema api

Signed-off-by: artembuslaev <[email protected]>

* policy delete option, fix import schemas

Signed-off-by: artembuslaev <[email protected]>

* change delete policy result

* allow users to get schema of own RA

Signed-off-by: artembuslaev <[email protected]>

* fix disabled delete icon, less delete schema info

Signed-off-by: artembuslaev <[email protected]>

* GitBook: [#147] Dry Run Demo added

* change delete policy functionality

Signed-off-by: artembuslaev <[email protected]>

* change initial balance settings

Signed-off-by: artembuslaev <[email protected]>

* add group

* update swagger

* add ivite

* GitBook: [#148] Added Dry Run, Added missing APIs, Added Note for .policy, .schema

* GitBook: [#149] Corrected External events docs, Roadmap content added

* async mq events

Signed-off-by: simvalery <[email protected]>

* fix lint

Signed-off-by: simvalery <[email protected]>

* add group manager block

* fix publish

Signed-off-by: simvalery <[email protected]>

* fix publish

Signed-off-by: simvalery <[email protected]>

* GitBook: [#150] Updated Roadmap, Added Dry Run APIs

* GitBook: [#151] Made corrections in roadmap

* GitBook: [#152] Dry Run APIs added

* prevent to delete schema and policy not in draft

Signed-off-by: artembuslaev <[email protected]>

* added close button to 'save as' dialog

Signed-off-by: artembuslaev <[email protected]>

* templates in mrv sender

Signed-off-by: artembuslaev <[email protected]>

* update css template dialog

Signed-off-by: artembuslaev <[email protected]>

* GitBook: [#153] Adding Schema API

* group

* fixed issue with defs

Signed-off-by: artembuslaev <[email protected]>

* publishing related schemas

Signed-off-by: artembuslaev <[email protected]>

* fixed with policy publishing

Signed-off-by: artembuslaev <[email protected]>

* GitBook: [#154] Added missing APIs

* workers

Signed-off-by: simvalery <[email protected]>

* workers

Signed-off-by: simvalery <[email protected]>

* fixed save as policy action

Signed-off-by: artembuslaev <[email protected]>

* update irec policies

Signed-off-by: artembuslaev <[email protected]>

* fix 1195

Signed-off-by: simvalery <[email protected]>

* fix 1195

Signed-off-by: simvalery <[email protected]>

* fix blank

Signed-off-by: simvalery <[email protected]>

* fix heartbeat

Signed-off-by: simvalery <[email protected]>

* GitBook: [#155] Updated iREC demo from iREC 3 to iREC 4

* Fixed IPFS pinning service key name in .env.example

* fixed permissions combined with owner

Signed-off-by: artembuslaev <[email protected]>

* task queue

Signed-off-by: simvalery <[email protected]>

* update documents

* update group mapping

* fixed schemas defs and comment fields

Signed-off-by: artembuslaev <[email protected]>

* fixed schemas in irec3,4

Signed-off-by: artembuslaev <[email protected]>

* Readme of Verra Redd (#1210)

* ReadMe file of iREC (#1209)

* topics memo

Signed-off-by: artembuslaev <[email protected]>

* messages memo

Signed-off-by: artembuslaev <[email protected]>

* fixed policy catch errors

Signed-off-by: artembuslaev <[email protected]>

* Removed Keys from ReadMe file

* supports arrays path in memo

Signed-off-by: artembuslaev <[email protected]>

* workers

Signed-off-by: simvalery <[email protected]>

* fix lint

Signed-off-by: simvalery <[email protected]>

* Corrected Timestamps in Verra ReadMe

* fix lint, fix docker build

Signed-off-by: simvalery <[email protected]>

* fix docker build

Signed-off-by: simvalery <[email protected]>

* fix docker build

Signed-off-by: simvalery <[email protected]>

* Updated IREC ReadMe

* add issuer ref

* set memo for global topic

Signed-off-by: artembuslaev <[email protected]>

* Demo Artifacts ReadMe changes

* Delete iREC Description

* Delete Verra Description

* fix docker build

Signed-off-by: simvalery <[email protected]>

* Changes made to Demo Artifacts ReadMe

* Changes made in IREC ReadMe

* Updated Verra ReadMe

* fix merge

* fix single worker

Signed-off-by: simvalery <[email protected]>

* error handling and get items interval

Signed-off-by: simvalery <[email protected]>

* message request timeout

Signed-off-by: simvalery <[email protected]>

* delete group

* fix

* fix

Signed-off-by: simvalery <[email protected]>

* fix group

* fix group

* fix issuer

* fix external data

* fix policy info

* Create Description

* Add files via upload

* Delete IRec Policy 3.policy

* Delete IRec Policy 4.policy

* Delete iRec Policy 2.policy

* Delete iRec Policy.policy

* Create Description

* Add files via upload

* Delete Description

* Delete Inverter.schema

* Delete MRV.schema

* Delete iREC Schema.schema

* Create Description

* Add files via upload

* Delete Verra REDD Policy 2.policy

* Delete Verra REDD.policy

* Create Description

* Rename Demo Artifacts/Verra Redd/readme.md to Demo Artifacts/Verra/Verra Redd/VM0007/readme.md

* Create Description

* Add files via upload

* Add files via upload

* Delete Demo Artifacts/Verra Redd directory

* Update readme.md

* Delete Description

* Update readme.md

* Update readme.md

* Delete Description

* Delete Description

* Update readme.md

* GitBook: [#165] Demo to Create API Key

* Update readme.md (#1229)

* GitBook: [#166] Creating Operator ID and Operator Key

* GitBook: [#167] corrected available Blocks

* fix async events

Signed-off-by: simvalery <[email protected]>

* fix memo

Signed-off-by: simvalery <[email protected]>

* ci tests

Signed-off-by: simvalery <[email protected]>

* test

Signed-off-by: simvalery <[email protected]>

* Update package-lock.json

* Update package-lock.json

* fix delete user

* tests environment

Signed-off-by: artembuslaev <[email protected]>

* fix local tests

Signed-off-by: artembuslaev <[email protected]>

* added validation for key schema field

Signed-off-by: artembuslaev <[email protected]>

* fix topic message memo

Signed-off-by: artembuslaev <[email protected]>

* fixes

Signed-off-by: simvalery <[email protected]>

* fix

Signed-off-by: simvalery <[email protected]>

* added memo for user topic creation message

Signed-off-by: artembuslaev <[email protected]>

* Create readme.md

* ws events send every 100ms

Signed-off-by: simvalery <[email protected]>

* Update readme.md

* fix user id

* fix

* Update readme.md

* fix

Signed-off-by: simvalery <[email protected]>

* fix

Signed-off-by: simvalery <[email protected]>

* fix

Signed-off-by: simvalery <[email protected]>

* fix

Signed-off-by: simvalery <[email protected]>

* update message status

* fix memo

* change payer

* fix

* fix

* Updated Readme to include authors + definitions (#1238)

Added Envision as an Author. Added a definition for Policy/Schema, please adjust if there is a more correct definition @anvabr. There has a been a request for a glossary so maybe we could link there.

Co-authored-by: anvabr <[email protected]>

* GitBook: [#168] Updated APIs to be cancelled

* GitBook: [#169] Added Memo field changes

* fix schemas in verra redd policies

Signed-off-by: artembuslaev <[email protected]>

* GitBook: [#170] Corrected Memo field changes.

* Updated Verra Timestamps

* Updated timestamps of Verra

* tests fixes

Signed-off-by: artembuslaev <[email protected]>

* fix result

* fix invite

* fix

* GitBook: [#171] Removed Keys from API flow

* update swagger

* remove deprecated endpoints

Signed-off-by: artembuslaev <[email protected]>

* fix

Signed-off-by: artembuslaev <[email protected]>

* updated postman collection

Signed-off-by: artembuslaev <[email protected]>

* fix README.md

Signed-off-by: simvalery <[email protected]>

* up version

Signed-off-by: simvalery <[email protected]>

* fix timeout error

Signed-off-by: simvalery <[email protected]>

* GitBook: [#172] Added User Group APIs

* fix vp documents

* fix merge

Signed-off-by: artembuslaev <[email protected]>
Signed-off-by: Giuseppe Bertone <[email protected]>
Signed-off-by: simvalery <[email protected]>
Co-authored-by: prernaadev01 <[email protected]>
Co-authored-by: artembuslaev <[email protected]>
Co-authored-by: artembuslaev <[email protected]>
Co-authored-by: Giuseppe Bertone <[email protected]>
Co-authored-by: prernaa.agarwal <[email protected]>
Co-authored-by: Stepan Kiryakov <[email protected]>
Co-authored-by: Giuseppe Bertone <[email protected]>
Co-authored-by: Stepan Kirjakov <[email protected]>
Co-authored-by: danielnorkin <[email protected]>
Co-authored-by: ANDRI H.U <[email protected]>
Co-authored-by: dubgeis <[email protected]>
Co-authored-by: anvabr <[email protected]>
  • Loading branch information
13 people authored Aug 31, 2022
1 parent 0d0ce9e commit fe2b09a
Show file tree
Hide file tree
Showing 21 changed files with 162 additions and 46 deletions.
Binary file added docs/.gitbook/assets/API_10 (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@
* [Import from zip file](policy-creation-using-the-guardian-apis/import-from-zip-file.md)
* [Retrieves Block Data by Tag](policy-creation-using-the-guardian-apis/retrieves-block-data-by-tag.md)
* [Sends Data to specified Block by Tag](policy-creation-using-the-guardian-apis/sends-data-to-specified-block-by-tag.md)
* [Returns list of Groups of a particular user](policy-creation-using-the-guardian-apis/returns-list-of-groups-of-a-particular-user.md)
* [Make the selected Group active](policy-creation-using-the-guardian-apis/make-the-selected-group-active.md)

## Policy related APIs for Asynchronous Execution

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This block is to validate documents, including linked documents. This block returns an error if at least one of the checks don’t pass. It can be placed as a ‘child’ document, or as a link in the sequence of the blocks.

![](<../.gitbook/assets/image (13).png>)
![](<../.gitbook/assets/image (13) (2).png>)

### Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/available-policy-workflow-blocks/tokenactionblock.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ This block is responsible in performing automatic actions on the token.



![](<../.gitbook/assets/image (1).png>)
![](<../.gitbook/assets/image (15) (2).png>)
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This block enables the owner of the private key for the account to manually perf

![JSON View of the Block](<../.gitbook/assets/image (9).png>)

![Configuring tokenConfirmationBlock](<../.gitbook/assets/image (18).png>)
![Configuring tokenConfirmationBlock](<../.gitbook/assets/image (1) (3).png>)

![Creating Event to move to next step](<../.gitbook/assets/image (8).png>)

Expand Down
6 changes: 3 additions & 3 deletions docs/demo-guide/demo-usage-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ There is also a _Custom Role_ which is called _User_. This role can be used to c

3\. You'll now be prompted to configure your Standard Registry account. Enter all the mandatory fields and then Press the **Generate** button to generate a Hedera Operator ID and an Operator Key. Press **Connect** when finished. This will now create Hedera Consensus Service Topics, fill the account with test hBar, create a DID document, create a Verifiable Credential, etc.

![](../.gitbook/assets/iREC\_4.2.png)
![](../.gitbook/assets/Verra\_2.2.png)

**NOTE**

There is a new feature as of version 1.0.2 which allows for the _Importing of Policies_ from the Standard Registry Policy Tab. When you import a policy you will be able to skip steps 4, 5, 6, and 7. The steps 4 through 7 will be applicable if you want to create a policy from scratch. As of release 1.0.5 we have implemented the functionality to import a policy that has been uploaded to IPFS. This is done via a Hedera message ID. You will need to find the Hedera message ID for the demo policy in step 6 below.

4\. Next, we move over to the **Schemas** tab. Schemas are the structure of which Verifiable Credentials will be filled out. Remember the iRec Policy we mentioned at the beginning of the section? We will be creating the first step of that Policy; which is to create the following schemas: iRec registration applicant details, Inverter, and MRV Schemas. The current version of the solution allows you to either build schemas from scratch or import schemas. Please note, that when you build schemas from scratch and publish them, they will be uploaded into IPFS and then the message containing the IPFS CID is sent into the corresponding Hedera topic. In this guide, we have already uploaded sample schemas for you to use. To import the sample schemas, please click on the **Import** button and paste the following Hedera message IDs one by one:

![](<../.gitbook/assets/iREC\_new\_1 (1).png>)
![](../.gitbook/assets/iREC\_new\_1.png)

* `1644847084.945541771` (iRec Schema)
* `1644847093.979895804` (Inverter)
Expand Down Expand Up @@ -84,7 +84,7 @@ In step 1 we discussed creating a custom role called installer. There is a defau

To demonstrate how you can edit other workflow actions, you will need to click on the **mint\_token** block and select the token we created.

![](<../.gitbook/assets/iREC\_new\_7 (1).png>)
![](../.gitbook/assets/iREC\_new\_7.png)

We will now press the **Save** button and the **Publish** button.

Expand Down
14 changes: 7 additions & 7 deletions docs/demo-guide/demo-using-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

### 1.2 In the policy config there is a root block which is the top of the structure

![](<../.gitbook/assets/API\_1 (1).png>)
![](../.gitbook/assets/API\_1.png)

### 1.3 Request the config for the root block

Expand Down Expand Up @@ -70,7 +70,7 @@
{% endswagger-response %}
{% endswagger %}

![](<../.gitbook/assets/API\_2 (1) (1).png>)
![](<../.gitbook/assets/API\_2 (1).png>)

### 1.5 At present only PolicyRolesBlock is available to the user. Select the "INSTALLER" role.

Expand Down Expand Up @@ -235,7 +235,7 @@ Years of registration
{% endswagger-parameter %}
{% endswagger %}

![](<../.gitbook/assets/API\_4 (1) (1).png>)
![](<../.gitbook/assets/API\_4 (1).png>)

### 1.8 Request the root block and all contained blocks again.

Expand Down Expand Up @@ -297,7 +297,7 @@ Years of registration
{% endswagger-response %}
{% endswagger %}

![](<../.gitbook/assets/image 1.png>)
![](../.gitbook/assets/API\_5.png)

## 2. Login as a Standard Registry

Expand Down Expand Up @@ -699,9 +699,9 @@ capacity
{% endswagger-parameter %}
{% endswagger %}

![](../.gitbook/assets/Sensor.png)
![](../.gitbook/assets/API\_9.png)

<figure><img src="../.gitbook/assets/API_10 (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/API_10.png" alt=""><figcaption></figcaption></figure>

### 3.4 Refresh the Blocks

Expand All @@ -717,7 +717,7 @@ record in the grid (data[0])
{% endswagger-parameter %}
{% endswagger %}

![](<../.gitbook/assets/image 4.png>)
![](../.gitbook/assets/API\_11.png)

### 3.6 Sample MRV Sender Data

Expand Down
8 changes: 4 additions & 4 deletions docs/demo-guide/irec-demo-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This folder contains a sample file that is referenced in the Demo Guide

3\. You will now be prompted to configure your Standard Registry account. Press the Generate button to generate a Hedera Operator ID and an Operator Key and enter the details of your Standard Registry. Press Connect when finished. This will now create Hedera Consensus Service Topics, fill the account with test hBar, create a DID document, create a Verifiable Credential, etc.

![](../.gitbook/assets/iREC\_4.2.png)
![](../.gitbook/assets/Verra\_2.2.png)

4\. This could be one of the most interesting parts of the reference implementation. Now we will be creating the Policy. We have two ways to "create policies." The first way is to import an existing policy. This is the easiest way to get started. When you import a policy, all schemas and tokens that are required in the policy are automatically populated. To do this, you can use the sample policy that we have already uploaded to IPFS by entering the Hedera Message IDs.

Expand All @@ -40,7 +40,7 @@ Once Policy is imported successfully, click on "Publish" button to publish the p

![](../.gitbook/assets/iREC3\_new\_3.png)

<figure><img src="../.gitbook/assets/image (7) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/image (7) (3).png" alt=""><figcaption></figcaption></figure>

<figure><img src="../.gitbook/assets/image (6) (2).png" alt=""><figcaption></figcaption></figure>

Expand Down Expand Up @@ -86,7 +86,7 @@ For now, we will be adding it manually, but in future, we will be automating the

After submitting the data, the Registrant is waiting for approval from Standard Registry.

<figure><img src="../.gitbook/assets/image (15).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/image (3).png" alt=""><figcaption></figcaption></figure>

13\. Now, we logout from Registrant and log back as Standard Registry, we navigate to Issue Requests tab in Policies and once we are ready to approve the document, you can click on Approve button.

Expand All @@ -102,7 +102,7 @@ After submitting the data, the Registrant is waiting for approval from Standard

16\. We can also check Token History by logging back as Standard Registry.

<figure><img src="../.gitbook/assets/image (23).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/image (23) (2).png" alt=""><figcaption></figcaption></figure>

We have the option of viewing TrustChain. You can view TrustChain by clicking on View TrustChain button.

Expand Down
4 changes: 2 additions & 2 deletions docs/demo-guide/verra-redd+-demo-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This folder contains a sample file that is referenced in the Demo Usage Guide

3\. You'll now be prompted to configure your Verra account. Enter the details and then press the Generate button to generate a Hedera Operator ID and an Operator Key and enter the name of your Standard Registry. Press Connect when finished. This will now create Hedera Consensus Service Topics, fill the account with test hBar, create a DID document, create a Verifiable Credential, etc.

![](../.gitbook/assets/Verra\_2.2.png)
![](../.gitbook/assets/iREC\_4.2.png)

4\. This could be one of the most interesting parts of the reference implementation. Now we will be creating the Policy. We have two ways to "create policies." The first way is to import an existing policy. This is the easiest way to get started. When you import a policy, all schemas and tokens that are required in the policy are automatically populated. To do this, you can use the sample policy that we have already uploaded to IPFS. Click on the import button and enter the one of the following Hedera message IDs:

Expand All @@ -36,7 +36,7 @@ Once Policy is imported successfully, click on "Publish" button to publish the p

6\. Now, we can click on the Policies tab. This is where the specific actions required by the Policy Workflow will be found. We can click Open button to the right of the Verra Policy, the Verra created.

![](../.gitbook/assets/verra\_new\_2.1.png)
![](<../.gitbook/assets/verra\_new\_2.1 (1).png>)

7\. This is where the custom user will be able to assign the role that was created by Verra during the workflow creation process. In our case, we created the custom role of VVB so the user will need to select the VVB role from the drop down.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ npm run test
Once [http://localhost:3000](http://localhost:3000) is launched, we need to initialize Standard Registry by completing the Setup.
![](<../../.gitbook/assets/image (14).png>)
![](<../../.gitbook/assets/image (23) (1).png>)
**Note:** The above fields in UI are mandatory only for this default Schema.
Expand Down
2 changes: 1 addition & 1 deletion docs/guardian-architecture/reference-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ description: >-

This repo contains a reference implementation of the Guardian to learn how to use the components for various applications. This reference implementation is designed with modularity so that different components may be swapped out based on various implementation requirements. Please see the Guardian's architecture diagram below:

![](../.gitbook/assets/Guardian\_Architecture\_Diagram.png)
![](../.gitbook/assets/reference\_architecture.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Make the selected Group active

{% swagger method="post" path="" baseUrl="/policies/{policyId}/groups" summary="Makes the selected group active." %}
{% swagger-description %}
Makes the selected group active. if UUID is not set then returns the user to the default state.
{% endswagger-description %}

{% swagger-parameter in="body" required="true" name="uuid" type="String" %}
Selected Group
{% endswagger-parameter %}

{% swagger-response status="200: OK" description="Successful Operation" %}
```javascript
{
// Response
}
```
{% endswagger-response %}

{% swagger-response status="401: Unauthorized" description="Unauthorized" %}
```javascript
{
// Response
}
```
{% endswagger-response %}

{% swagger-response status="403: Forbidden" description="Forbidden" %}
```javascript
{
// Response
}
```
{% endswagger-response %}

{% swagger-response status="500: Internal Server Error" description="Internal Sever Error" %}
```javascript
{
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
}
```
{% endswagger-response %}
{% endswagger %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Returns list of Groups of a particular user

{% swagger method="get" path="" baseUrl="/policies/{policyId}/groups" summary="Returns a list of groups the user is a member of." %}
{% swagger-description %}
Returns a list of groups the user is a member of.
{% endswagger-description %}

{% swagger-parameter in="path" name="policyId" type="String" required="true" %}
Selected policy ID.
{% endswagger-parameter %}

{% swagger-response status="200: OK" description="Successful Operation" %}
```javascript
{
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
uuid:
type: string
role:
type: string
groupLabel:
type: string
groupName:
type: string
active:
type: boolean
}
```
{% endswagger-response %}

{% swagger-response status="401: Unauthorized" description="Unauthorized" %}
```javascript
{
// Response
}
```
{% endswagger-response %}

{% swagger-response status="403: Forbidden" description="Forbidden" %}
```javascript
{
// Response
}
```
{% endswagger-response %}

{% swagger-response status="500: Internal Server Error" description="Internal Server Error" %}
```javascript
{
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
}
```
{% endswagger-response %}
{% endswagger %}
12 changes: 6 additions & 6 deletions docs/policy-flow/policy-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Once you login as a Standard Registry and finish the setup, click on Policies tab.

![](<../.gitbook/assets/image (4) (1).png>)
![](<../.gitbook/assets/image (4) (1) (1).png>)

We have two options to create Policy :

Expand All @@ -21,7 +21,7 @@ We have two options to create Policy :

1.3 Once the details are filled and clicked on OK. Initially, Policy is created in Draft status.

![](<../.gitbook/assets/image (1) (1) (2).png>)
![](<../.gitbook/assets/image (1) (1) (1) (1).png>)

1.4 You can even edit the Policy by clicking Edit button.

Expand All @@ -33,7 +33,7 @@ We have two options to create Policy :

1.6 Once the Policy is configured, you can go to Policies tab and click on Publish.

![](<../.gitbook/assets/image (6) (1).png>)
![](<../.gitbook/assets/image (6) (1) (1).png>)

### 2. Importing Policy either from File or from IPFS

Expand All @@ -43,11 +43,11 @@ Instead of creating Policy from scratch, there is an option of importing the Pol
**Note:** Files with **.policy** extension are only accepted. These files are in zip format, i.e. they are zip archives of the text file.
{% endhint %}

![](<../.gitbook/assets/image (11) (1).png>)
![](<../.gitbook/assets/image (11) (1) (1).png>)

2.1 Once the .zip file is selected, we get the Policy Import Review screen. Once everything looks good, click on Import Button.

![](<../.gitbook/assets/image (8) (1).png>)
![](<../.gitbook/assets/image (8) (1) (1).png>)

2.2 The Policy can also be imported by importing it from IPFS.

Expand All @@ -71,6 +71,6 @@ Instead of creating Policy from scratch, there is an option of importing the Pol

2.6 There is also an option to Export the Policy. To export the policy click on Export button. Once, you click on Export, you get Export dialog, where we have two exporting options: Copy message Identifier and saving the Policy as file.

![](<../.gitbook/assets/image (10) (1).png>)
![](<../.gitbook/assets/image (10) (3).png>)

When you click on Save to file, Policy is exported as a .zip file.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Once we have created the Draft of the policy – notice the status field showing

The edit screen will open and you will notice two boxes on the right side of the screen. The top Policy box is static and offers the ability to add high-level “Policy properties.” You can edit the name, Policy Tag, etc. Note that you can also create custom roles that are specific to your policy.

![](../.gitbook/assets/PW\_image\_4.png)
![](<../.gitbook/assets/image 5.png>)

The second Interface ContainerBlock is specific to the first workflow block. We will begin editing this block to build our policy!

Expand All @@ -33,7 +33,7 @@ But in the Permissions we can choose only: policy roles, any role, no role, owne

Then we select the “type” of UI we want to utilize. In our example, we choose the “Blank” template.

![](<../.gitbook/assets/image 5.png>)
![](../.gitbook/assets/PW\_image\_4.png)

**Programmatically you begin like this:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ We then select “Default Active” as true since this policy action must always

Now we have a Policy Action defined, however, without any specific actions

![](../.gitbook/assets/PW\_image\_7.png)
![](../.gitbook/assets/PW\_image\_6.png)

**Programmatically this workflow step looks like this:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ We then set the Id Type using the drop-down, and select “Owner” as the type

Next, we select the “Type” drop-down in the UI box and select “PAGE” indicating that the UI used for this request will be a full UI window. This will open up the Title and Description fields which we will fill in next.

![](../.gitbook/assets/PW\_image\_6.png)
![](../.gitbook/assets/PW\_image\_7.png)

**Programmatically this workflow step looks like this:**

Expand Down
Loading

0 comments on commit fe2b09a

Please sign in to comment.