Add user stories by bigludo7 · Pull Request #118 · camaraproject/NumberVerification

bigludo7 · 2024-07-05T13:17:44Z

What type of PR is this?

documentation

What this PR does / why we need it:

Document user stories as it is a mandatory piece to target stable maturity level.

Which issue(s) this PR fixes:

Fixes #117

Special notes for reviewers:

Changelog input

 release-note
- Add user stories

Additional documentation

This section can be blank.

docs

Add user stories

documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md

…_number_User_Story.md Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

jgarciahospital · 2024-07-15T09:04:24Z

documentation/API_documentation/NumberVerification_verify_User_Story.md

+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the line from which the call was made, so that I can ensure that I avoid identity theft fraud. |


To align with SMS OTP definition:
As an enterprise application developer, I want to verify the phone number associated with the line from which the call was made, so I can get a proof of possession of the phone number.

jgarciahospital · 2024-07-15T10:04:33Z

documentation/API_documentation/NumberVerification_verify_User_Story.md

+| ---- | ------- |
+| ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the line from which the call was made, so that I can ensure that I avoid identity theft fraud. |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator<br> **Actors:** Application service providers, hyperscalers, application developers, end users. <br> **Scope:**  <br> - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. |
+| ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.</li><li>The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.</li><li>The Customer:Administrator has onboarded the Customer:User to the platform.</li><li>The Customer:user performs an authorization request to CSP</li><li>The means to get the access token are known to the Customer:User to ensure secure access of the API.|


The means to get the access token are known to the Customer:User to ensure secure access of the API.
--> Access token generation initiated by Customer:User is based on network authentication to ensure secure access of the API

I have reworked the sentence and add one step.

jgarciahospital · 2024-07-15T10:06:03Z

documentation/API_documentation/NumberVerification_verify_User_Story.md

+| ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the line from which the call was made, so that I can ensure that I avoid identity theft fraud. |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator<br> **Actors:** Application service providers, hyperscalers, application developers, end users. <br> **Scope:**  <br> - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. |
+| ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.</li><li>The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.</li><li>The Customer:Administrator has onboarded the Customer:User to the platform.</li><li>The Customer:user performs an authorization request to CSP</li><li>The means to get the access token are known to the Customer:User to ensure secure access of the API.|
+| ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number keyed by the user on the application. This input could be hashed or plain.<br>**Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the line from which the request was triggered. |


the phone number keyed by the user on the application
--> the phone number provided by the end user in the application

jgarciahospital · 2024-07-15T10:06:49Z

documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md

+| ---- | ------- |
+| ***Summary*** | As an enterprise application developer, I want to retrieve the phone number associated with the line from which the call was made, so that I can ensure that I obtain the correct phone number and avoid identity theft fraud. |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator<br> **Actors:** Application service providers, hyperscalers, application developers, end users. <br> **Scope:**  <br>-Returns the phone number associated with the access token so API clients can get the number and verify it themselves. |
+| ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.</li><li>The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.</li><li>The Customer:Administrator has onboarded the Customer:User to the platform.</li><li>The Customer:user performs an authorization request to CSP</li><li>The means to get the access token are known to the Customer:User to ensure secure access of the API.|


The means to get the access token are known to the Customer:User to ensure secure access of the API.
--> Access token generation initiated by Customer:User is based on network authentication to ensure secure access of the API

Update NumberVerification_verify_User_Story following Jorge comments

…ge comment

bigludo7 · 2024-07-15T13:50:32Z

Thanks @jgarciahospital - I've took into consideration your comment.

fernandopradocabrillo

LGTM

AxelNennker

Please explain CSP once introducing that term.

Must this text mention network authentication? The customer does not care about the technical means, I think.

documentation/API_documentation/NumberVerification_verify_User_Story.md

AxelNennker

I would not use the word "line" if we can avoid it.

documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md

…_Story.md Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

…_number_User_Story.md Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

bigludo7 · 2024-07-22T11:53:51Z

I would not use the word "line" if we can avoid it.

Fixed !

bigludo7 · 2024-07-22T11:55:47Z

Please explain CSP once introducing that term.

Must this text mention network authentication? The customer does not care about the technical means, I think.

Thanks @AxelNennker for the review.

Added CSP in actor.
I tend to think it makes sense to keep this as we have limitation over Wifi so it provides some indication to the scope of usage to the reader.

Add user stories

50107e1

Add user stories

bigludo7 requested review from AxelNennker and fernandopradocabrillo as code owners July 5, 2024 13:17

AxelNennker requested changes Jul 8, 2024

View reviewed changes

documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md Outdated Show resolved Hide resolved

Update documentation/API_documentation/NumberVerificationdevice_phone…

1ac7c9e

…_number_User_Story.md Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

bigludo7 requested a review from AxelNennker July 10, 2024 12:58

jgarciahospital suggested changes Jul 15, 2024

View reviewed changes

bigludo7 added 3 commits July 15, 2024 15:45

Update NumberVerification_verify_User_Story following Jorge comments

0f18860

Update NumberVerification_verify_User_Story following Jorge comments

Update NumberVerificationdevice_phone_number_User_Story following Jor…

43c4446

…ge comment

Fix small typo

037cecd

jgarciahospital approved these changes Jul 18, 2024

View reviewed changes

fernandopradocabrillo previously approved these changes Jul 18, 2024

View reviewed changes

AxelNennker requested changes Jul 22, 2024

View reviewed changes

documentation/API_documentation/NumberVerification_verify_User_Story.md Outdated Show resolved Hide resolved

documentation/API_documentation/NumberVerification_verify_User_Story.md Outdated Show resolved Hide resolved

AxelNennker requested changes Jul 22, 2024

View reviewed changes

bigludo7 dismissed fernandopradocabrillo’s stale review via 260e4b9 July 22, 2024 11:42

bigludo7 and others added 10 commits July 22, 2024 13:42

Update documentation/API_documentation/NumberVerification_verify_User…

260e4b9

…_Story.md Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

Update documentation/API_documentation/NumberVerification_verify_User…

f8ff928

…_Story.md Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

Update documentation/API_documentation/NumberVerificationdevice_phone…

66eeae4

…_number_User_Story.md Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

Update documentation/API_documentation/NumberVerificationdevice_phone…

d6f7921

…_number_User_Story.md Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

Update documentation/API_documentation/NumberVerificationdevice_phone…

d2eae61

…_number_User_Story.md Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

Update documentation/API_documentation/NumberVerificationdevice_phone…

916710e

…_number_User_Story.md Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

Add Communication service Provider in Actors

a6ecc12

Communication service Provider in Actors

0ddfc05

changed line to device

105860f

Changed line to device

36db56a

bigludo7 added 2 commits July 24, 2024 14:53

Update NumberVerification_verify_User_Story.md

a12d92e

Update NumberVerificationdevice_phone_number_User_Story.md

ecade42

Update NumberVerification_verify_User_Story.md

4ddbc75

AxelNennker approved these changes Jul 25, 2024

View reviewed changes

bigludo7 merged commit f69b247 into camaraproject:main Jul 25, 2024

Conversation

bigludo7 commented Jul 5, 2024

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewers:

Changelog input

Additional documentation

Uh oh!

Uh oh!

jgarciahospital Jul 15, 2024

Choose a reason for hiding this comment

Uh oh!

jgarciahospital Jul 15, 2024

Choose a reason for hiding this comment

Uh oh!

bigludo7 Jul 15, 2024

Choose a reason for hiding this comment

Uh oh!

jgarciahospital Jul 15, 2024

Choose a reason for hiding this comment

Uh oh!

jgarciahospital Jul 15, 2024

Choose a reason for hiding this comment

Uh oh!

bigludo7 commented Jul 15, 2024

Uh oh!

fernandopradocabrillo left a comment

Choose a reason for hiding this comment

Uh oh!

AxelNennker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AxelNennker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bigludo7 commented Jul 22, 2024

Uh oh!

bigludo7 commented Jul 22, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants