From df57b40dc7f8d5526f0ff0d13584400f31ee7b6f Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Fri, 31 Jul 2026 10:17:13 +0100 Subject: [PATCH] docs: update consent text and mermaid diagram actors in User Story --- .../SimpleEdgeDiscovery_User_Story.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/documentation/API_documentation/SimpleEdgeDiscovery_User_Story.md b/documentation/API_documentation/SimpleEdgeDiscovery_User_Story.md index 38b1166..3451154 100644 --- a/documentation/API_documentation/SimpleEdgeDiscovery_User_Story.md +++ b/documentation/API_documentation/SimpleEdgeDiscovery_User_Story.md @@ -3,10 +3,10 @@ | **Item** | **Details** | | ---- | ------- | | ***Summary*** | As an application developer belonging to an enterprise, I want to discover (using either my application server/backend service, or an HTTPS application client on the end-user device) the closest Edge Cloud Zone to a given end-user's device. | -| ***Roles, Actors and Scope*** | **Roles:** Customer:User
**Actors:** Application service providers, network operators, application developers. The API allows a check to see if end-user consent is required. If so, it will be required to be obtained in the authorization flow prior to the CSP issuing the access token.
- **Scope:** | Get the name of the Edge Cloud Zone closest to a given end-user's device | -| ***Pre-conditions*** |The preconditions are listed below:
  1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
  2. The Customer:BusinessManager has successfully subscribed to the Simple Edge Discovery product from the product catalog.
  3. The Customer:Administrator has onboarded the Customer:User to the platform.
    4. |
  4. If applicable, the Customer:BusinessManager has agreed to any terms and conditions of the CSP related to managing consent of mobile subscription owners.
    5. 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 server/client makes a an HTTPS POST request to the Simple Edge Discovery API to query the closest Edge Cloud Zone to the target device (an end-user device). The target device is either identified in the 3-legged access token where supported, or explicitly identified in the encrypted POST request body.
    **Ends when:** The Simple Edge Discovery API retruns the request information, or an error message. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User
    **Actors:** Application service providers, network operators, application developers. The API allows a check to see if end-user consent is required. Note that the API is not intended to indicate coarse end-user location, instead it reflects the 'closest' operator Edge Cloud Zone based on the internal network route between the end-user's network access point and an operator edge . However, If end-user consent is required by the implementing network operator, it will be required to be obtained in the authorization flow as per the operator-defined process.
    + **Scope:** | Get the name of the Edge Cloud Zone with the shortest operator network path to a given end-user's device | +| ***Pre-conditions*** |The preconditions are listed below:
    1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the Operator's API platform.
    2. The Customer:BusinessManager has successfully subscribed to the Simple Edge Discovery product from the product catalog.
    3. The Customer:Administrator has onboarded the Customer:User to the platform.
      4. |
    4. If applicable, the Customer:BusinessManager has agreed to any terms and conditions of the CSP related to managing consent of mobile subscription owners.
      5. 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 server/client makes a an HTTPS POST request to the Simple Edge Discovery API to query the closest Edge Cloud Zone to the target device (an end-user device). The target device is either identified in the 3-legged access token where supported, or explicitly identified in the encrypted POST request body.
      **Ends when:** The Simple Edge Discovery API returns the request information, or an error message. | | ***Post-conditions*** | Optional - the customer may decide to act upon the information by connecting the end-user application client to the application server instance hosted at the closest Edge Cloud Zone, and/or spin up an application server instance at that closest Edge Cloud Zone if not currently hosted there. | | ***Exceptions*** | Several exceptions might occur after a request to the Simple Edge Discovery API
      - Unauthorized: Invalid credentials (e.g. use of already expired access token).
      - Invalid Input: Invalid input data to retrieve device details (e.g. MSISDN format not as expected, or MSISDN not associated with a customer of the CSP).
      - Forbidden: End user has not consented to device identifier information being provided to the Customer:User
      - Service not applicable: the device is not currently attached to an Edge-capable network.
      - The network cannot resolve the request due to an internal issue.
      - a rate limit/request quota has been exceeded. | @@ -36,13 +36,13 @@ sequenceDiagram Operator->>API Consumer: edgeCloudZoneID, edgeCloudZoneName, edgeCloudZoneProvider, device end opt Application developer has a local mapping of server endpoints to Edge Cloud Zone names - Application Developer->>Application Developer: lookup app server endpoint (EdgeCloudZone name) - Application Developer->>Application Client: app server endpoint (IP address:port) - Application Client->>Edge Cloud Zone Provider: connect to app server endpoint (IP address:port) + Application Server->>Application Server: lookup edge app server endpoint (EdgeCloudZone name) + Application Server->>Application Client: edge app server endpoint (IP address:port) + Application Client->>Edge Cloud Zone Provider: connect to edge app server endpoint (IP address:port) end opt spin up instance on closest Edge Cloud Zone - Application Developer->>Edge Cloud Zone Provider: create instance(Edge Cloud Zone) - Edge Cloud Zone Provider->>Application Developer: instance endpoint - Application Developer->>Application Client: instance endpoint + Application Server->>Edge Cloud Zone Provider: create instance(Edge Cloud Zone) + Edge Cloud Zone Provider->>Application Server: instance endpoint + Application Server->>Application Client: instance endpoint end ```