docs and ver bump

digicatapult · Feb 2, 2024 · 87fed74 · 87fed74
1 parent d112e7e
commit 87fed74
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 3 deletions.
diff --git a/docs/backend-frontend-functionality.md b/docs/backend-frontend-functionality.md
@@ -0,0 +1,30 @@
+# VER-194 - determine backend functionality needed
+
+## As a User I'd like to sign up to NICE network
+
+| Screen                  | Frontend action     |                          Backend Effect                           |                                Payload |    Note |
+| :---------------------- | :------------------ | :---------------------------------------------------------------: | -------------------------------------: | ------: |
+| Homescreen_Click_Signup | Click Signup Button |                                 -                                 |                                      - |         |
+| Signup_Onboarding1      | Fill out fields     |                                 -                                 |                                      - |         |
+| Signup_Onboarding2      | Click Submit Button | POST -> /save-signup-information & trigger sending invitation out | {companyName, companiesHouseNo, email} | MISSING |
+| Signup_Onboarding3      | Back to homepage    |                                 -                                 |                                      - |         |
+
+---
+
+## As a User I'd like to complete my sign up
+
+| Screen                         | Frontend action               |       Backend Effect       |                  Payload |
+| :----------------------------- | :---------------------------- | :------------------------: | -----------------------: |
+| Homescreen_Click_Onboarding    | Click Complete Onboarding Btn |             -              |                        - |
+| CompleteOnboarding_scanQRCode1 | Scan QR code & Submit Btn     | POST -> /accept-invitation | {cryptographic material} |
+| CompleteOnboarding_Complete    | Back to homepage              |             -              |                        - |
+
+---
+
+## As a user I'd like to see my Verifiable Claims
+
+| Screen                      | Frontend action          |   Backend Effect    |                          Payload |                 Note |
+| :-------------------------- | :----------------------- | :-----------------: | -------------------------------: | -------------------: |
+| Homescreen_Click_SSIProfile | Click SSI Profile Button |          -          |                                - |                      |
+| TBC/view profile            | Upon load                | GET -> /credentials | {verifiable claims registered[]} | gets all credentials |
+|                             |                          |   GET -> /profile   |           {Profile information } |              MISSING |
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@digicatapult/veritable-cloudagent",
-  "version": "0.4.16",
+  "version": "0.4.17",
   "main": "build/index",
   "types": "build/index",
   "files": [