TI API Rel 0.9.3: API Coherency with Edge Cloud terminology, CAMARA Guidelines and Consent Management #167

FabrizioMoggio · 2024-01-10T10:15:20Z

alignement of parameters with EdgeCloud_LCM: applicationId changed into appId and instanceId changed into appInstanceId.

Added openId authentication for Consent Management
Aligment with guidelines:
- added xcorrelator
- aligned returned Errors

sergiofranciscoortiz · 2024-01-10T17:15:09Z

code/API_definitions/Traffic Influence/Traffic_Influence.yaml

+        AppId:
+            $ref: '#/components/schemas/AppId'


Change in line 357 AppId for appId, avoiding starting with capital letter as in the rest of parameters.

sergiofranciscoortiz

Looks very good, just a couple of changes in yaml and md to keep using appId without a capital letter in TrafficInfluence object properties.

sergiofranciscoortiz · 2024-01-10T17:17:23Z

documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation.md

-1) activate the optimal routing for any EAS instance: the TI API must be invoked with the applicationId. The Telco Operator Platform identifies all the EAS instances and activates the optimal routing on the Mobile Network.
-2) activate the optimal routing in a specific Region or Zone: the TI API must be invoked with the applicationId and the Zones and Regions identifiers.
+1) activate the optimal routing for any EAS instance: the TI API must be invoked with the "appId". The Telco Operator Platform identifies all the EAS instances and activates the optimal routing on the Mobile Network.
+2) activate the optimal routing in a specific Region or Zone: the TI API must be invoked with the "appId" and the Zones and Regions identifiers.
 3) activate the optimal routing for a user devices: the TI API can  be invoked with a user Device identifier (“Device”). For each user Device, a TI API invocation is required.

 ## Version: 0.9.2


Propose to change to version 0.9.3 as in yaml

sergiofranciscoortiz · 2024-01-10T17:19:42Z

documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation.md

@@ -218,8 +217,8 @@ Delete an existing TrafficInfluence resource
 | ---- | ---- | ----------- | -------- |
 | trafficInfluenceID | string | Identifier for the Traffic Influence resource. This parameter is returned by the API and must be used to update it (e.g., adding new users or deleting it). | No |
 | apiConsumerId | string | Unique Identifier of the TI API Consumer. | Yes |
-| applicationId | string | Unique ID representing the Edge Application<br>_Example:_ `"Virtual_Reality_Arena"` | Yes |
-| instanceId | string | Unique identifier generated by the partner OP to identify an instance of the application on a specific zone. | No |
+| AppId | string (uuid) | A globally unique identifier associated with the application. OP generates this identifier when the application is submitted over NBI.<br>_Example:_ `"6B29FC40-CA47-1067-B31D-00DD010662DA"` | No |


Suggestion to change AppId, for appId for coherence with the rest of the table avoiding capital letters at the beginning, change proposed also for yaml.

the parameters are defined in coherency with: https://github.com/camaraproject/EdgeCloud/blob/main/code/API_definitions/EdgeCloud_LcM.yaml

the parameters are appId and appInstanceId, while the schema names are AppId and AppInstanceId.

like:
appInstanceId:
$ref: '#/components/schemas/AppInstanceId'

from line 598 of EdgeCloud-LcM

It seems ok it most parts, schema is ok like that. It is just within TrafficInfluence Model, in the parameters included both in yaml ( line 357) and in Documentation file ( line 220), it seems more appropriate to keep consistency with the rest of parameters to start with lower case.

sergiofranciscoortiz · 2024-01-11T11:44:38Z

documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation.md

-1) activate the optimal routing for any EAS instance: the TI API must be invoked with the applicationId. The Telco Operator Platform identifies all the EAS instances and activates the optimal routing on the Mobile Network.
-2) activate the optimal routing in a specific Region or Zone: the TI API must be invoked with the applicationId and the Zones and Regions identifiers.
+1) activate the optimal routing for any EAS instance: the TI API must be invoked with the "appId". The Telco Operator Platform identifies all the EAS instances and activates the optimal routing on the Mobile Network.
+2) activate the optimal routing in a specific Region or Zone: the TI API must be invoked with the "appId" and the Zones and Regions identifiers.
 3) activate the optimal routing for a user devices: the TI API can  be invoked with a user Device identifier (“Device”). For each user Device, a TI API invocation is required.

 ## Version: 0.9.2


Suggested change

## Version: 0.9.2

## Version: 0.9.3

sergiofranciscoortiz · 2024-01-11T11:45:05Z

documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation.md

@@ -218,8 +217,8 @@ Delete an existing TrafficInfluence resource
 | ---- | ---- | ----------- | -------- |
 | trafficInfluenceID | string | Identifier for the Traffic Influence resource. This parameter is returned by the API and must be used to update it (e.g., adding new users or deleting it). | No |
 | apiConsumerId | string | Unique Identifier of the TI API Consumer. | Yes |
-| applicationId | string | Unique ID representing the Edge Application<br>_Example:_ `"Virtual_Reality_Arena"` | Yes |
-| instanceId | string | Unique identifier generated by the partner OP to identify an instance of the application on a specific zone. | No |
+| AppId | string (uuid) | A globally unique identifier associated with the application. OP generates this identifier when the application is submitted over NBI.<br>_Example:_ `"6B29FC40-CA47-1067-B31D-00DD010662DA"` | No |


Suggested change

| AppId | string (uuid) | A globally unique identifier associated with the application. OP generates this identifier when the application is submitted over NBI.<br>_Example:_ `"6B29FC40-CA47-1067-B31D-00DD010662DA"` | No |

| appId | string (uuid) | A globally unique identifier associated with the application. OP generates this identifier when the application is submitted over NBI.<br>_Example:_ `"6B29FC40-CA47-1067-B31D-00DD010662DA"` | No |

sergiofranciscoortiz · 2024-01-11T11:46:17Z

code/API_definitions/Traffic Influence/Traffic_Influence.yaml

-          description:  Unique ID representing the Edge Application
-        instanceId:
-            $ref: '#/components/schemas/InstanceIdentifier'
+        AppId:


Suggested change

AppId:

appId:

sergiofranciscoortiz · 2024-01-11T11:47:41Z

documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation.md

@@ -218,8 +217,8 @@ Delete an existing TrafficInfluence resource
 | ---- | ---- | ----------- | -------- |
 | trafficInfluenceID | string | Identifier for the Traffic Influence resource. This parameter is returned by the API and must be used to update it (e.g., adding new users or deleting it). | No |
 | apiConsumerId | string | Unique Identifier of the TI API Consumer. | Yes |
-| applicationId | string | Unique ID representing the Edge Application<br>_Example:_ `"Virtual_Reality_Arena"` | Yes |
-| instanceId | string | Unique identifier generated by the partner OP to identify an instance of the application on a specific zone. | No |
+| AppId | string (uuid) | A globally unique identifier associated with the application. OP generates this identifier when the application is submitted over NBI.<br>_Example:_ `"6B29FC40-CA47-1067-B31D-00DD010662DA"` | No |


It seems ok it most parts, schema is ok like that. It is just within TrafficInfluence Model, in the parameters included both in yaml ( line 357) and in Documentation file ( line 220), it seems more appropriate to keep consistency with the rest of parameters to start with lower case.

FabrizioMoggio · 2024-01-11T14:29:47Z

@sergiofranciscoortiz you are totally right, thank you.

FabrizioMoggio · 2024-01-25T13:03:14Z

In my understanding this PR is completed, can it be merged?

Kevsy · 2024-01-26T10:41:11Z

documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation.md

@@ -120,7 +119,7 @@ Creates a new TrafficInfluence resource

 ##### Description

-Takes as input an object containing the intents from the API Consumer and creates a TrafficInfluence resource accordingly. The trafficInfluenceID parameter, that is part of the object, must not be valorized when creating a new resource. For this reason the trafficInfluenceID parameter must be avoided in the object, anyway it will be ignored by the API Producer. It is automatically generated by the system and returned in the response.
+Gets in input an object containing the intents from the API Consumer and creates a TrafficInfluence resourse accordingly. The trafficInfluenceID parameter, that is part of the object, must not be valorized when creating a new resource. For this reason the trafficInfluenceID parameter must be avoided in the object, anyway it will be ignored by the API Producer. It is automatically generated by the system and returned in the response.


s/resourse/resource

Sure I'm going to fix it. Before I have checked the yaml and there it was correct. Now I see that the md file is wrong. Thank you vey much.

Kevsy · 2024-01-26T10:43:02Z

documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation.md

@@ -120,7 +119,7 @@ Creates a new TrafficInfluence resource

 ##### Description

-Takes as input an object containing the intents from the API Consumer and creates a TrafficInfluence resource accordingly. The trafficInfluenceID parameter, that is part of the object, must not be valorized when creating a new resource. For this reason the trafficInfluenceID parameter must be avoided in the object, anyway it will be ignored by the API Producer. It is automatically generated by the system and returned in the response.
+Gets in input an object containing the intents from the API Consumer and creates a TrafficInfluence resourse accordingly. The trafficInfluenceID parameter, that is part of the object, must not be valorized when creating a new resource. For this reason the trafficInfluenceID parameter must be avoided in the object, anyway it will be ignored by the API Producer. It is automatically generated by the system and returned in the response.


"Takes as input" is correct (not "Gets in input")

Right, I will fix it

this is wrong also in the YAML file, I'm going to fix it also there

Kevsy

Couple of typos (see comments above ^) otherwise LGTM

soluiion for: camaraproject#167 (comment)

solution for: camaraproject#167 (comment) and camaraproject#167 (comment)

FabrizioMoggio · 2024-02-14T13:09:07Z

I'm going to update the YAML according to #192

sergiofranciscoortiz · 2024-02-14T14:22:29Z

I'm going to update the YAML according to #192

I reckon that you meant to #191, to take into account erros/warnings from CAMARA linter in TI API

FabrizioMoggio · 2024-02-14T14:25:30Z

sure :-) #191

javierlozallu

Adapt the YAML to the maximum line length of 80 characters to pass MegaLinter control.

FabrizioMoggio · 2024-04-11T11:10:57Z

I'm going to adapt the YAML according to the MegaLinter results. Anyway please note that the new version has more features to be carefully checked (@Kevsy , @gunjald). The important one are:

Consent Management: Client Credential is now substituted by openId to support 3Legs
xcorrelator: it was added as an input parameter and as an output header

javierlozallu · 2024-04-15T10:18:20Z

@FabrizioMoggio regarding the 3 legs auth support, could you give a brief overview of the implementation and whether we should adopt it in the other APIs? As 3 legs is for Consent Management and based on your implementation, you can use it for specific methods and specify the action allowed, so I think we should implement it in LCM where needed.

Also I see that xcorrelator is being implemented in others APIs in CAMARA, is this mandatory for all the APIs?

FabrizioMoggio · 2024-04-15T10:36:54Z

@javierlozallu 3Legs is based on OpenId and let you to specify the level of access right (read or write). I based the TI API implementation according to what done in CallForwardingSignal: https://github.com/camaraproject/CallForwardingSignal/blob/main/code/API_definitions/Call_Forwarding_Signal.yaml

Because that API is a very simple one it is maybe easier to understand than the TI API if you need an example. We can have a discussion about 3Legs in an Edge Cloud call.

The TI API needs Consent Management not because it uses MSISDN that is indeed owned by the API Consumer and not provided back by the API Producer as a new information. The TI API needs Consent Management because it informs the Operator about the Device position. This must be allowed by the End User. Maybe this also applies to LCM.

x-correlator, should be included as defined in the Guidelines: https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#9-architecture-headers

javierlozallu · 2024-04-15T10:43:08Z

Thank you very much! @FabrizioMoggio

It is now clearer to me and I can imagine some use cases where Consent would be needed in LCM and perhaps for Simple Edge API, so I will add this item to the agenda (I will share it on the meeting list later this afternoon) so that we can discuss it at tomorrow's meeting.

Kevsy · 2024-04-16T10:22:52Z

Hi @javierlozallu

I can imagine some use cases where Consent would be needed in LCM and perhaps for Simple Edge API,

Correct, Simple Edge Discovery 0.9.4-rc.1 already includes the Identity and Consent management guidelines for consent (per closed issue camaraproject/SimpleEdgeDiscovery#21 )

javierlozallu · 2024-04-16T11:22:20Z

Yes @Kevsy, I noticed that SED already has it and I have put it on the table that I am going to present at the meeting.

FabrizioMoggio · 2024-04-30T10:40:17Z

this version of the TI API YAML passes MegaLinter. Just one error was intentionally left. The error is on Carriage Returns that must be changed from windows to Linux formatting. I avoided doing it so far otherwise it changes every line and the other modification to the code are no more visible.

FabrizioMoggio · 2024-05-03T12:36:11Z

Considering you can view the modified code so far in the commit history, I'm going to upload a new version with the Carriage Return fixed.

camaraproject#167 (comment) CR fixed to Linux formatting

FabrizioMoggio · 2024-05-03T15:11:19Z

The last Commit has not produced any MegaLinter warning or error.

code/API_definitions/Traffic Influence/Traffic_Influence.yaml

FabrizioMoggio · 2024-05-08T13:24:09Z

@Kevsy I have implemented the changes you requested a long time ago. :-) I don't know why the system is not acknowledging that. Currently the system is still requesting for those comments to be addressed. Maybe you can do some action.

FabrizioMoggio · 2024-05-14T07:57:12Z

Hi, how can we move forward with this PR? Do I need to update the folder structure to the new one?

javierlozallu · 2024-05-14T08:04:43Z

Hi, how can we move forward with this PR? Do I need to update the folder structure to the new one?

@Kevsy I have implemented the changes you requested a long time ago. :-) I don't know why the system is not acknowledging that. Currently the system is still requesting for those comments to be addressed. Maybe you can do some action.

Hi @Kevsy, could you help us with this?

javierlozallu · 2024-05-14T08:07:34Z

Hi, how can we move forward with this PR? Do I need to update the folder structure to the new one?

Yes, I think that the conflict is related to that. Only the folder for the yaml has been changed, the .md file doesn't have to be changed.

FabrizioMoggio requested review from gunjald, Kevsy, crissancas and sergiofranciscoortiz as code owners January 10, 2024 10:15

FabrizioMoggio added API Coherency Traffic Influence API labels Jan 10, 2024

FabrizioMoggio mentioned this pull request Jan 10, 2024

TI and MVP API - Harmonization of common entities #164

Closed

FabrizioMoggio changed the title ~~appId and appInstanceId~~ TI API Rel 0.9.3: appId and appInstanceId update Jan 10, 2024

gainsley previously approved these changes Jan 10, 2024

View reviewed changes

sergiofranciscoortiz reviewed Jan 10, 2024

View reviewed changes

sergiofranciscoortiz suggested changes Jan 10, 2024

View reviewed changes

sergiofranciscoortiz suggested changes Jan 11, 2024

View reviewed changes

sergiofranciscoortiz previously approved these changes Jan 11, 2024

View reviewed changes

Kevsy reviewed Jan 26, 2024

View reviewed changes

Kevsy requested changes Jan 26, 2024

View reviewed changes

FabrizioMoggio added a commit to FabrizioMoggio/EdgeCloud that referenced this pull request Jan 31, 2024

Typo fixed

80eccf2

soluiion for: camaraproject#167 (comment)

FabrizioMoggio dismissed sergiofranciscoortiz’s stale review via 80eccf2 January 31, 2024 10:59

FabrizioMoggio added a commit to FabrizioMoggio/EdgeCloud that referenced this pull request Jan 31, 2024

Typo fixed

a989a44

solution for: camaraproject#167 (comment) and camaraproject#167 (comment)

sergiofranciscoortiz mentioned this pull request Feb 6, 2024

Review of reported errors from local run CAMARA linter to confirm conformance with API Design Guidelines for EdgeCloud_LcM.yaml #192

Closed

sergiofranciscoortiz mentioned this pull request Feb 16, 2024

Review of reported errors from local run CAMARA linter to confirm conformance with API Design Guidelines for Traffic_Influence.yaml #191

Closed

FabrizioMoggio dismissed gainsley’s stale review via 32c7ca4 March 7, 2024 13:54

FabrizioMoggio requested review from nicolacdnll and javierlozallu as code owners April 10, 2024 14:31

FabrizioMoggio changed the title ~~TI API Rel 0.9.3: appId and appInstanceId update~~ TI API Rel 0.9.3: API Coherency with Edge Cloud terminology, CAMARA Guidelines and Consent Management Apr 11, 2024

FabrizioMoggio requested a review from Kevsy April 11, 2024 07:57

javierlozallu requested changes Apr 11, 2024

View reviewed changes

FabrizioMoggio added a commit to FabrizioMoggio/EdgeCloud that referenced this pull request May 3, 2024

Carriage Return fixed

5ecb214

camaraproject#167 (comment) CR fixed to Linux formatting

FabrizioMoggio requested a review from javierlozallu May 6, 2024 14:44

javierlozallu reviewed May 7, 2024

View reviewed changes

code/API_definitions/Traffic Influence/Traffic_Influence.yaml Outdated Show resolved Hide resolved

code/API_definitions/Traffic Influence/Traffic_Influence.yaml Outdated Show resolved Hide resolved

javierlozallu approved these changes May 7, 2024

View reviewed changes

FabrizioMoggio closed this May 14, 2024

FabrizioMoggio force-pushed the main branch from 7fc089a to 0ca2ed5 Compare May 14, 2024 08:29

FabrizioMoggio mentioned this pull request May 14, 2024

TI API Rel 0.9.3 new Edge Cloud folder structure #237

Merged

	\| AppId \| string (uuid) \| A globally unique identifier associated with the application. OP generates this identifier when the application is submitted over NBI.<br>_Example:_ `"6B29FC40-CA47-1067-B31D-00DD010662DA"` \| No \|
	\| appId \| string (uuid) \| A globally unique identifier associated with the application. OP generates this identifier when the application is submitted over NBI.<br>_Example:_ `"6B29FC40-CA47-1067-B31D-00DD010662DA"` \| No \|

TI API Rel 0.9.3: API Coherency with Edge Cloud terminology, CAMARA Guidelines and Consent Management #167

TI API Rel 0.9.3: API Coherency with Edge Cloud terminology, CAMARA Guidelines and Consent Management #167

Conversation

FabrizioMoggio commented Jan 10, 2024 • edited Loading

Choose a reason for hiding this comment

sergiofranciscoortiz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FabrizioMoggio Jan 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FabrizioMoggio commented Jan 11, 2024

FabrizioMoggio commented Jan 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FabrizioMoggio Jan 30, 2024 • edited Loading

Choose a reason for hiding this comment

Kevsy left a comment • edited Loading

Choose a reason for hiding this comment

FabrizioMoggio commented Feb 14, 2024

sergiofranciscoortiz commented Feb 14, 2024

FabrizioMoggio commented Feb 14, 2024

javierlozallu left a comment

Choose a reason for hiding this comment

FabrizioMoggio commented Apr 11, 2024

javierlozallu commented Apr 15, 2024

FabrizioMoggio commented Apr 15, 2024

javierlozallu commented Apr 15, 2024

Kevsy commented Apr 16, 2024

javierlozallu commented Apr 16, 2024

FabrizioMoggio commented Apr 30, 2024 • edited Loading

FabrizioMoggio commented May 3, 2024

FabrizioMoggio commented May 3, 2024

FabrizioMoggio commented May 8, 2024

FabrizioMoggio commented May 14, 2024 • edited Loading

javierlozallu commented May 14, 2024

javierlozallu commented May 14, 2024

FabrizioMoggio commented Jan 10, 2024 •

edited

Loading

FabrizioMoggio Jan 11, 2024 •

edited

Loading

FabrizioMoggio Jan 30, 2024 •

edited

Loading

Kevsy left a comment •

edited

Loading

FabrizioMoggio commented Apr 30, 2024 •

edited

Loading

FabrizioMoggio commented May 14, 2024 •

edited

Loading