Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

location-verification Create Location Verification User Story #227

Merged
merged 2 commits into from
Aug 20, 2024

Conversation

jgarciahospital
Copy link
Collaborator

What type of PR is this?

  • documentation

What this PR does / why we need it:

Including user story for Location Verification API

Which issue(s) this PR fixes:

Fixes #220

Special notes for reviewers:

Changelog input

Include user story for Location Verification API

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @jgarciahospital
2 small comments for your consideration.

| ---- | ------- |
| ***Summary*** | As an enterprise application developer, I want to verify the location of a user's device, so that I can ensure the device is within a specified area for security and contextual-based services. |
| ***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 device is located within a predefined geographical area (circle with given coordinates and radius). |
| ***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 Location Verification API 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 Customer:User has the access token allowing a secure access of the API.|
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CSP: probably we need to provide full name for first use in the user story. BTW CSP should not be in the Actors part?

| ***Summary*** | As an enterprise application developer, I want to verify the location of a user's device, so that I can ensure the device is within a specified area for security and contextual-based services. |
| ***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 device is located within a predefined geographical area (circle with given coordinates and radius). |
| ***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 Location Verification API 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 Customer:User has the access token allowing a secure access of the API.|
| ***Activities/Steps*** | **Starts when:** The customer application makes a POST request to the Location Verification API providing the device identifier (e.g., phone number) and the area information (center coordinates and radius).<br>**Ends when:** The API server responds with the verification result indicating if the device is within the specified area, partially matches the area, or is unknown. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The customer also asks for a freshness of the information - worth to add it perhaps

| **Item** | **Details** |
| ---- | ------- |
| ***Summary*** | As an enterprise application developer, I want to verify the location of a user's device, so that I can ensure the device is within a specified area for security and contextual-based services. |
| ***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 device is located within a predefined geographical area (circle with given coordinates and radius). |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to specify the area is a circle? We can support other shapes in the future. Then we would need to come back and update the story for every new shape. But if you find it OK, that's OK for me too. Thank you.

@jlurien jlurien added the Fall24 Meta-release Fall24 label Jul 29, 2024
@jlurien
Copy link
Collaborator

jlurien commented Aug 1, 2024

@bigludo7 @alpaycetin74 please review if your comments and questions have been addressed. Thanks

Copy link
Collaborator

@alpaycetin74 alpaycetin74 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jlurien jlurien merged commit 31b0d8d into camaraproject:main Aug 20, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Fall24 Meta-release Fall24
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide API readiness checklist
4 participants