Skip to content

Commit

Permalink
Docs and additional fixes for 2.4.0 from develop to main (#1265)
Browse files Browse the repository at this point in the history
* 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

* fix publish schemas

* Additional fixes and docs for the 2.4.0 release (#1262) (#1264)

* 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]>

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]>

* GitBook: [#173] Added User Groups and Roles Page

* GitBook: [#174] Added groupManagerBlock

* up version

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

Signed-off-by: Giuseppe Bertone <[email protected]>
Signed-off-by: artembuslaev <[email protected]>
Signed-off-by: simvalery <[email protected]>
Co-authored-by: prernaadev01 <[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: artembuslaev <[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 Sep 1, 2022
1 parent fe2b09a commit d5c3179
Show file tree
Hide file tree
Showing 43 changed files with 193 additions and 56 deletions.
2 changes: 1 addition & 1 deletion api-docs/api/swagger/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: "Guardian"
description: "The Guardian is a modular open-source solution that includes best-in-class identity management and decentralized ledger technology (DLT) libraries. At the heart of the Guardian solution is a sophisticated Policy Workflow Engine (PWE) that enables applications to offer a requirements-based tokenization implementation."
version: "2.4.0"
version: "2.4.1"
contact:
name: "API developer"
url: "https://envisionblockchain.com"
Expand Down
2 changes: 1 addition & 1 deletion api-docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "api-docs",
"version": "2.4.0",
"version": "2.4.1",
"description": "Swagger Documentation",
"main": "dist/index.js",
"scripts": {
Expand Down
6 changes: 3 additions & 3 deletions api-gateway/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
},
"author": "Envision Blockchain Solutions <[email protected]>",
"dependencies": {
"@guardian/common": "^2.4.0",
"@guardian/interfaces": "^2.4.0",
"@guardian/common": "^2.4.1",
"@guardian/interfaces": "^2.4.1",
"dotenv": "^16.0.0",
"express": "^4.17.1",
"jszip": "^3.7.1",
Expand Down Expand Up @@ -49,5 +49,5 @@
"start": "node dist/index.js",
"test": "mocha tests/**/*.test.js --reporter mocha-junit-reporter --reporter-options mochaFile=../test_results/ui-service.xml"
},
"version": "2.4.0"
"version": "2.4.1"
}
2 changes: 1 addition & 1 deletion api-tests/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "api-tests",
"version": "2.4.0",
"version": "2.4.1",
"description": "API Tests",
"main": "index.js",
"scripts": {
Expand Down
6 changes: 3 additions & 3 deletions auth-service/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
},
"author": "Envision Blockchain Solutions <[email protected]>",
"dependencies": {
"@guardian/common": "^2.4.0",
"@guardian/interfaces": "^2.4.0",
"@guardian/common": "^2.4.1",
"@guardian/interfaces": "^2.4.1",
"@mikro-orm/core": "^5.3.0",
"@mikro-orm/mongodb": "^5.3.0",
"dotenv": "^16.0.0",
Expand Down Expand Up @@ -44,5 +44,5 @@
"start": "node dist/index.js",
"test": "mocha tests/**/*.test.js --reporter mocha-junit-reporter --reporter-options mochaFile=../test_results/ui-service.xml"
},
"version": "2.4.0"
"version": "2.4.1"
}
4 changes: 2 additions & 2 deletions common/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"author": "Envision Blockchain Solutions <[email protected]>",
"dependencies": {
"@guardian/interfaces": "^2.4.0",
"@guardian/interfaces": "^2.4.1",
"@mikro-orm/core": "^5.3.0",
"@mikro-orm/migrations-mongodb": "^5.3.1",
"@mikro-orm/mongodb": "^5.3.0",
Expand Down Expand Up @@ -34,5 +34,5 @@
"prepare": "npm run build",
"test": "echo \"Error: no test specified\" && exit 1"
},
"version": "2.4.0"
"version": "2.4.1"
}
Binary file added docs/.gitbook/assets/Role1.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.
Binary file added docs/.gitbook/assets/Role1.1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/image (1) (4).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/image (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/image (13) (3).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/image (13).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/image (16) (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/image (16).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/image (17) (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/image (17).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/image (18).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/image (22).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/image (23) (3).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/image (23).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/image (32).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/image (33) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/image (33).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/image (34).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/image (35).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@
* [tokenConfirmationBlock](available-policy-workflow-blocks/tokenconfirmationblock.md)
* [mintDocumentBlock](available-policy-workflow-blocks/mintdocumentblock.md)
* [Events](available-policy-workflow-blocks/events.md)
* [groupManagerBlock](available-policy-workflow-blocks/groupmanagerblock.md)

## Policy Workflow Creation using the Guardian User Interface

Expand Down Expand Up @@ -271,3 +272,7 @@
## Task APIs

* [Returning Task Statuses](task-apis/returning-task-statuses.md)

## Multi - User Roles

* [Roles and Groups](multi-user-roles/roles-and-groups.md)
45 changes: 45 additions & 0 deletions docs/available-policy-workflow-blocks/groupmanagerblock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# groupManagerBlock

This block allows to manage group membership, add and remove users from the group.

### 1. Properties



| Block Property | Definition | Example Input | Status |
| ---------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------ |
| tag | Unique name for the logic block. | groupManagerBlock | |
| permissions | Which entity has rights to interact at this part of the workflow. | NoRole | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| On errors | Called if the system error has occurs in the Block | <p></p><ul><li>No action</li><li>Retry</li><li>Go to step</li><li>Go to tag</li></ul> | |
| Stop Propagation | End processing here, don't pass control to the next block. | Checked or unchecked. | |
| Can Invite | specifies who can create invites | <p>· Group Owner – only the creator of the group</p><p>· All – all members of the group</p> | |
| Can Delete | specifies who can remove users from the group | <p>· Group Owner – only the creator of the group</p><p>. All – all members of the group</p> | |



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

### 2. Usage

#### 2.1 **List of the groups in which the user is included:**

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

#### **2.2 List of the users included in the group**

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

#### **2.3 Inviting users to groups**

First step is to select the role to invite the user as shown below:

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

Next step is to copy and send the unique invite or the link to the invite.

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

#### 2.4 **Removing users from groups**

<figure><img src="../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
1 change: 1 addition & 0 deletions docs/available-policy-workflow-blocks/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@ Starting with the [Wikipedia definition](https://en.wikipedia.org/wiki/Workflow\
| tokenActionBlock | Block is responsible to automation actions related to tokens | [tokenactionblock.md](tokenactionblock.md "mention") |
| tokenConfirmationBlock | Block enables the owner of the private key for the account to manually perform operations with the token | [tokenconfirmationblock.md](tokenconfirmationblock.md "mention") |
| mintDocumentBlock | Block is responsible for adding configurations on calculating the amount of tokens to be minted. | [mintdocumentblock.md](mintdocumentblock.md "mention") |
| groupManagerBlock | Block allows to manage group membership, add and remove users from the group. | [groupmanagerblock.md](groupmanagerblock.md "mention") |
30 changes: 22 additions & 8 deletions docs/available-policy-workflow-blocks/roles-workflow-block.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,29 @@
# PolicyRolesBlock

This block allows the user to select a role or a group.

### Properties

| Block Property | Definition | Example Input | Status |
| -------------- | --------------------------------------------------------------------------------- | ----------------------------------------------- | ------------------------------------------ |
| type | A block which determines a role for the user. | **PolicyRoles**Block (Can't be changed). | |
| tag | Unique name for the logic block. | choose\_role. | |
| permissions | Which entity has rights to interact at this part of the workflow. | Installer. | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| dependencies | Establish workflow dependancies that need to be completed prior. | Select the appropriate block from the dropdown. | <mark style="color:red;">Deprecated</mark> |
| roles | Available roles from which the user can choose. | Select the appropriate roles from the dropdown. | |
| Block Property | Definition | Example Input | Status |
| ----------------- | --------------------------------------------------------------------------------- | ----------------------------------------------- | ------------------------------------------ |
| type | A block which determines a role for the user. | **PolicyRoles**Block (Can't be changed). | |
| tag | Unique name for the logic block. | choose\_role. | |
| permissions | Which entity has rights to interact at this part of the workflow. | Installer. | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| dependencies | Establish workflow dependancies that need to be completed prior. | Select the appropriate block from the dropdown. | <mark style="color:red;">Deprecated</mark> |
| roles | Available roles from which the user can choose. | Select the appropriate roles from the dropdown. | |
| Available Roles | list of roles for selected user | Checked or unchecked. | |
| ·Available Groups | list of groups for selected user | Checked or unchecked. | |



{% hint style="info" %}
**Note: ‘**_**Available Groups**_**** option takes priority and thus, when set, causes the system to ignore ****_**Available Roles**_****.
{% endhint %}

{% hint style="info" %}
**Note:** Setting the Permissions property to ‘**No Role’** limits the visibility of this block to those users which have not yet selected a role or a group.
{% endhint %}

{% hint style="info" %}
RefreshEvents are used to refreshing the UI, instead of "dependencies" property.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ The user need to input the private key for the account to enable Guardian to per
**Note:** Users can skip the action in UI if they prefer to perform it outside Guardian (directly with Hedera blockchain).
{% endhint %}

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

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Following are the steps to follow to generate Web3.Storage API Key:

1. We need to create an account in Web3.Storage using [https://web3.storage/login/](https://web3.storage/login/)

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

2\. Once Logged in successfully, hover over **Account** and click **Create an API Token** in the dropdown menu.

Expand Down
72 changes: 72 additions & 0 deletions docs/multi-user-roles/roles-and-groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Roles and Groups

### 1. Roles

Set of textual constants that are used to separate users into different roles.

#### 1.1 Creation of Roles

Roles can be created by adding Role Property and its Value in Policy Configurator as shown below:

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

<figure><img src="../.gitbook/assets/Role1.1.png" alt=""><figcaption></figcaption></figure>

#### 1.2 Usage

This is used for setting Permissions for a block, which limits which users can see this block or access it via the API.

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

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

{% hint style="info" %}
**Note:** Permissions do not affect the Block via Events.
{% endhint %}

### 2. Groups

Groups are separate sets of documents access , which can be limited to users who are members of the group.

{% hint style="info" %}
**Note**: A user can be included into any number of groups with a single role within each. User roles can be different in different groups.
{% endhint %}

#### 2.1 Properties

| Property Name | Definition |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | The name of the group |
| Creator Role | Role which is assigned to the creator of the group |
| Members Role | The list of roles which can be assigned to members of the group |
| Relationship Type | <p>· Single – only a single user can be included in the group. This type is maintained for backward compatibility with historic policy versions.</p><p>· Multiple – the group can include multiple users. This is the new mode of operation.</p> |
| Access Type | <p>· Global – static group is created at the start. The creator of the group is the creator of the policy.</p><p>· Private – a new instance of the group is created every time a user selects group creation action. The creator of the group is the user who executed the group creation action.</p> |



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

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

#### 2.2 Usage

**documentsSourceAddon** has multiple filters which allow us to select relevant documents

| Owned by User | Owned by Group | Document Selection |
| ------------- | -------------- | --------------------------------------------------------------- |
| False | False | Documents are not filtered by Owner. |
| True | False | Only documents created by the current user (in all groups) |
| False | True | Only documents created in the current group (by all users) |
| True | True | Only documents created by the current user in the current group |



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

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

### 3. Switching between Groups

When a policy contains multiple groups, users have an option to switch between those they are included in. The selection menu also allows to switch to the ‘no group’ default state, i.e. the state in which the user is not acting as a member of any group.

<figure><img src="../.gitbook/assets/image (32).png" alt=""><figcaption></figcaption></figure>
2 changes: 1 addition & 1 deletion frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@
"test": "ng test",
"watch": "ng build --watch --configuration development --output-path ../www-data"
},
"version": "2.4.0"
"version": "2.4.1"
}
6 changes: 3 additions & 3 deletions guardian-service/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
},
"author": "Envision Blockchain Solutions <[email protected]>",
"dependencies": {
"@guardian/common": "^2.4.0",
"@guardian/interfaces": "^2.4.0",
"@guardian/common": "^2.4.1",
"@guardian/interfaces": "^2.4.1",
"@hashgraph/sdk": "^2.15.0",
"@mikro-orm/core": "^5.3.0",
"@mikro-orm/mongodb": "^5.3.0",
Expand Down Expand Up @@ -75,5 +75,5 @@
"test:network": "mocha tests/network-tests/**/*.test.js",
"test:stability": "mocha tests/stability.test.js"
},
"version": "2.4.0"
"version": "2.4.1"
}
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@ export class PolicyEngineService {
let skipped: number = 0;
for (const schemaIRI of schemaIRIs) {
const schema = await incrementSchemaVersion(schemaIRI, owner);
if (schema.status === SchemaStatus.PUBLISHED) {
if (!schema || schema.status === SchemaStatus.PUBLISHED) {
skipped++;
continue;
}
Expand Down
2 changes: 1 addition & 1 deletion interfaces/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@
"lint": "tslint --config ../tslint.json --project .",
"test": "echo \"Error: no test specified\" && exit 1"
},
"version": "2.4.0"
"version": "2.4.1"
}
6 changes: 3 additions & 3 deletions ipfs-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
},
"author": "Envision Blockchain Solutions <[email protected]>",
"dependencies": {
"@guardian/common": "^2.4.0",
"@guardian/interfaces": "^2.4.0",
"@guardian/common": "^2.4.1",
"@guardian/interfaces": "^2.4.1",
"@mikro-orm/core": "^5.3.0",
"@mikro-orm/mongodb": "^5.3.0",
"@web-std/fetch": "3.0.0",
Expand Down Expand Up @@ -46,5 +46,5 @@
"test": "mocha tests/**/*.test.js --reporter mocha-junit-reporter --reporter-options mochaFile=../test_results/ipfs-client.xml",
"watch": "nodemon src/index.ts"
},
"version": "2.4.0"
"version": "2.4.1"
}
Loading

0 comments on commit d5c3179

Please sign in to comment.