diff --git a/code/API_definitions/Traffic_Influence.yaml b/code/API_definitions/Traffic_Influence.yaml index 9dec615b..a4c2adf7 100644 --- a/code/API_definitions/Traffic_Influence.yaml +++ b/code/API_definitions/Traffic_Influence.yaml @@ -5,7 +5,7 @@ openapi: 3.0.3 ############################################################################ info: title: OPAG-CAMARA Traffic Influence API - version: 0.9.3 + version: 0.9.4-wip description: | ## Overview The reference scenario foresees a Service, composed by one or more Service @@ -33,7 +33,7 @@ info: geographical location and the Device moves to another geographical location, the TI API can be invoked to get the optimal routing in the new geographical location for that Device. - ## 1. Introduction + ## Introduction The TI API provides the capability to establish the best routing, in terms of latency, in a specific geographical area, between the user Device, e.g. the user’s smartphone, and the optimal EAS instance nearby. If the Device @@ -74,7 +74,7 @@ info: instance. In the case the Application detects a location change, it can invoke the TI API again to request a new routing optimization toward the new EAS instance. - ## 2. Quick Start + ## Quick Start The usage of the TI API is based on the management of a "TrafficInfluence" resource, an object containing the intent requested invoking the TI API and that is implemented by the platform configuring the Mobile Network for the @@ -164,7 +164,7 @@ info: Developers have a chance to specify call back URL on which notifications (e.g. session termination) regarding the session can be received from the service provider. This is also an optional parameter. - ## 3. Authentication and Authorization + ## Authentication and Authorization CAMARA guidelines defines a set of authorization flows which can grant API clients access to the API functionality, as outlined in the document [CAMARA-API-access-and-user-consent.md](https://github.com/camaraproject\ @@ -181,8 +181,7 @@ info: mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. - ## 4. API Documentation - ## 4.1 Details + ## API Documentation The TI API is consumed by an Application Function (AF) requesting for the optimal routing, in term of latency, for the traffic flow from a Device toward EAS instances in Edge Cloud Zones.\ @@ -210,6 +209,67 @@ info: 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. + ## Release Notes + The Traffic Influence API reduces the complexity of the 3GPP Traffic + Influence API exposed by the 3GPP Network Exposure Function (NEF) [1]. While + the 3GPP TI API offers fastest routing activation and user mobility among + different edge sites, this version of the CAMARA Traffic Influence API + covers only the fastest routing activation, also for selected users. + User mobility will be introduced in a future version.\ + \ + **Enhancements with respect to the previous release V0.8.1:** + - These release also effects existing data sessions + - These release can be also used to optimize existing data sessions when a + Device moves among geographical areas. + - The ueId parameter is renamed into Device + - The parameter Device, that identifies the User, is now simplified to + guarantee the identification of an existing data session + - InstanceId added + - TrafficFilters description updated + - CAMEL type adopted + - FlowInfo deleted + - OpenAPI version updated to 3.0.3 + - To let the Developer to just work on parameters actually editable, the PUT + method is changed into a PATCH method with a limitation on the + parameters usable and modifiable. A new resource is created, + PatchTrafficInfluence that contains only the editable parameters + The same approach is also adopted for the PUT method and a new resource + PostTrafficInfluence was created with just the editable parameters + - DELETE response code modified as 202. The Deletion request is accepted + (not yet completed, it must be carried on by the system) + - Added response code 400 (bad request) to POST + - General improvement in documentation + - applicationId changed into appId and instanceId changed into appInstanceId + - Alignement of parameters with EdgeCloud_LCM: applicationId changed into + appId and instanceId changed into appInstanceId + - Modified reference to CAMARA Authorization guidelines link + - Telco Edge Site changed in Edge Cloud Zone + - Added: info-contact + - Device: IPV4 and IPV6 changed to represent just one IP. Netmask is no more + valid + - Global tags definition + - Adopted lowerCamelCase for OperationId + - Added descriptions for Delete and Get (for specific resource) methods + - Added missing operationid + - Improvement of callback definition + - Added "description" to the TrafficInfluence resource + - Added "description" to the PatchTrafficInfluence resource + - Added "description" to TrafficInfluenceNotification + - Added "description" to NetworkAccessIdentifier + - Added "description" to ErrResponse + - Added "description" to message + - Added "description" to status + - Added "description" to ErrorInfo + - Removed unused error code SessionNotFound404 + - Alignement of parameters with EdgeCloud_LCM: applicationId changed into + appId and instanceId changed into appInstanceId + - Adoption of OpenId authentication for Consent Management. Client + Credential is removed + - Intruduced xcorrelator + - General alignment with CAMARA on returned Errors + - Modified CAMARA URL to refer to the Edge Cloud Repository + - OAS version now includes "-wip" extension + - simplified "Servers" section and included "vwip" as version license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -218,19 +278,16 @@ info: externalDocs: description: Product documentation at Camara - url: https://github.com/camaraproject/ + url: https://github.com/camaraproject/EdgeCloud ############################################################################ # Servers # ############################################################################ servers: - - url: "{apiRoot}/{basePath}" + - url: "{apiRoot}/traffic-influence/vwip" variables: apiRoot: default: http://localhost:9091 - description: API root - basePath: - default: traffic-influence/v0 - description: Base path for the Traffic Influence API + description: API root for the Traffic Influence API ############################################################################ # Tags # ############################################################################ diff --git a/documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation.md b/documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation_Obsolete.md similarity index 68% rename from documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation.md rename to documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation_Obsolete.md index 291361c9..39294cf1 100644 --- a/documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation.md +++ b/documentation/SupportingDocuments/API_Documentation/Traffic_Influence_API_Documentation_Obsolete.md @@ -2,8 +2,11 @@ # OPAG-CAMARA Traffic Influence API ## Overview -The reference scenario foresees a Service, composed by one or more Service Producers deployed in different geographical locations on Telco Edge sites (Edge datacentres of Telco Operator) or in Cloud. The Service Producer, deployed at the Edge, is referred as Edge Application Server (EAS). -The Traffic Influence API (TI API) provides the fastest routing from the user Device (e.g. a Smartphone) to the optimal EAS instance in a specific geographical location, installed in a Telco Edge site. +NOTE: this documentation file is obsolete. The API documentation is now fully included in the API YAML file. + +The reference scenario foresees a Service, composed by one or more Service Producers deployed in different geographical locations on Edge Cloud Zones (Edge datacentres of Telco Operator) or in Cloud. The Service Producer, deployed at the Edge, is referred as Edge Application Server (EAS). +An Edge Cloud Zone is a platform in the Telco Operator network, offering network, compute and storage resources to developers. A developer can deploy and run applications on an Edge Cloud Zone, meaning reduced latency to end users that are nearby, as the network path is shorter. A network operator's EdgeCloud may comprise multiple Edge Cloud Zones, each in a discrete location to bring latency benefits to end users across a country . The operator can help developers know which of the Edge Cloud Zones will bring the best performance benefit for a given end user and application +The Traffic Influence API (TI API) provides the fastest routing from the user Device (e.g. a Smartphone) to the optimal EAS instance in a specific geographical location, installed in an Edge Cloud Zone. If a Service is offered by Cloud Instances and by Edge Instances, the TI API can be used get the optimal routing of the traffic to the Edge Instances, maybe for a set of users. Getting the optimal routing can be used to improve latency maybe in combination with other CAMARA APIs such as QoD (Quality On Demand). Providing the optimal routing is indeed an important step to get the optimal latency. If the TI API is used to get the best routing at the Edge for a Device in a geographical location and the Device moves to another geographical location, the TI API can be invoked to get the optimal routing in the new geographical location for that Device. @@ -21,7 +24,7 @@ The TI API can be used to: The usage of the TI API is based on the management of a "TrafficInfluence" resource, an object containing the intent requested invoking the TI API and that is implemented by the platform configuring the Mobile Network for the optimal routing toward the EAS instance. The "TrafficInfluence" resource can be created (providing the related parameters that specify the desired intent), queried, modified and deleted. The TI API is asynchronous, a notification is available providing information about the status of the requested resource. -For an Application (identified by "applicationId") many "TrafficInfluence" resources can be created, e.g. to add multiple users, regions or zones. +For an Application (identified by "appId") many "TrafficInfluence" resources can be created, e.g. to add multiple users, regions or zones. Before starting to use the TI API, the developer needs to know about the below specified details: @@ -35,28 +38,28 @@ Configure security access keys such as OAuth 2.0 client credentials to be used b This object represents the resource that carries the requirements from the user to be implemented. The TI API is invoked for the life cycle management of this resource (CRUD). The resource contains the intents from the TI API Consumer. Managing this resource, the developer can specify in which geographical location the routing must be applied, toward which application, maybe for a specific set of users or for a limited period of time. **trafficInfluenceID** -Identifier for the Traffic Influence resource. This parameter is returned by the TI API and must be used to update it (e.g., adding a Device or deleting it). A different Traffic Influence resource must be created for any Device or Zone or Region. All these resources are related to an Application identified by the applicationId. +Identifier for the Traffic Influence resource. This parameter is returned by the TI API and must be used to update it (e.g., adding a Device or deleting it). A different Traffic Influence resource must be created for any Device or Zone or Region. All these resources are related to an Application identified by "appId". **apiConsumerId** Unique identifier for the TI API Consumer. **region** -The developer can specify in which geographical area he requires the fastest routing toward the nearest application instance. A Region is a wide geographical area and it contains one or more Zones. A Zone is where the Telco Edge sites are located. Zones and Regions identifiers are defined and provided by the Telco Operator and can also be used or retrieved with other CAMARA APIs (“MEC Exposure & Experience Management API” and “Simple Edge Discovery”). To add more regions the TI API must be invoked (POST) for each region. New "TrafficInfluence" resources are created (with different "trafficInfluenceID"). All the created resources are aggregated by the Application (identified by "applicationId"). +The developer can specify in which geographical area he requires the fastest routing toward the nearest application instance. A "region" is a wide geographical area and it contains one or more "zones". A "zone" is where the Edge Cloud Zone is located. Zones and Regions identifiers are defined and provided by the Telco Operator and can also be used or retrieved with other CAMARA APIs (“MEC Exposure & Experience Management API” and “Simple Edge Discovery”). To add more regions the TI API must be invoked (POST) for each region. New "TrafficInfluence" resources are created (with different "trafficInfluenceID"). All the created resources are aggregated by the Application (identified by "appId"). **zone** -The developer can specify in which geographical area he requires the fastest routing toward the nearest Application instance. A Zone is a smaller geographical area inside a Region. A Zone is where the Telco Edge sites are located. To add more zones the TI API must be invoked (POST) for each zone. New "TrafficInfluence" resources are created (with different "trafficInfluenceID"). All the created resources are aggregated by the Application (identified by "applicationId"). +The developer can specify in which geographical area he requires the fastest routing toward the nearest Application instance. A "zone" is a smaller geographical area inside a "region". A "zone" is where the Edge Cloud Zone is located. To add more zones the TI API must be invoked (POST) for each "zone". New "TrafficInfluence" resources are created (with different "trafficInfluenceID"). All the created resources are aggregated by the Application (identified by "appId"). -**applicationId** -Unique Application identifier inside the Telco Operator Platform. This identifier is provided during the application onboarding process. To influence the traffic toward a specific Application. It is the Operator Platform that detects the appropriate Application instance in the selected Region or Zone. +**appId** +A globally unique identifier associated with the application. This identifier is provided during the application onboarding process. To influence the traffic toward a specific Application. It is the Operator Platform that detects the appropriate Application instance in the selected "region" or "zone". -**instanceId** -Unique identifier generated by the Operator Platform to identify a specific instance of the Application on a specific zone. To influence a traffic toward a specific Application instance. +**appInstanceId** +A globally unique identifier generated by the Operator Platform to identify a specific instance of the Application on a specific zone. To influence a traffic toward a specific Application instance. **trafficFilters** The Application can expose different service on different interfaces, with this parameter it is possible to enable just some of those services maybe for different sets of users. **Device** -A user Device can be provided as an input. To add more users the TI API must be invoked (POST) of each user Device. New "TrafficInfluence" resources are created (with different "trafficInfluenceID"). All the created resources are aggregated by the Application (identified by "applicationId"). The routing toward the selected Application instance is only applied for provided user Devices. +A user Device can be provided as an input. To add more users the TI API must be invoked (POST) of each user Device. New "TrafficInfluence" resources are created (with different "trafficInfluenceID"). All the created resources are aggregated by the Application (identified by "appId"). The routing toward the selected Application instance is only applied for provided user Devices. **Notification URL and token** Developers have a chance to specify call back URL on which notifications (e.g. session termination) regarding the session can be received from the service provider. This is also an optional parameter. @@ -68,19 +71,22 @@ In this method the TI API invoker client is registered as a confidential client ## 4. API Documentation ## 4.1 Details -The TI API is consumed by an Application Function (AF) requesting for the optimal routing, in term of latency, for the traffic flow from a Device toward EAS instances in Telco Edge sites. -When the Application (the EAS) is onboarded and deployed in the Telco Edge site, the Application is identified with a unique identifier (applicationId). -Using the application identifier ("applicationId") and specifying a Zone or a Region, the Telco Operator Platform, autonomously identifies the best instance of the EAS toward which routing the traffic flow and configures the Mobile Network accordingly to get the fastest routing. +The TI API is consumed by an Application Function (AF) requesting for the optimal routing, in term of latency, for the traffic flow from a Device toward EAS instances in Edge Cloud Zones. +When the Application (the EAS) is onboarded and deployed in the Edge Cloud Zones, the Application is identified with a unique identifier ("appId"). +Using the application identifier ("appId") and specifying a Zone or a Region, the Telco Operator Platform, autonomously identifies the best instance of the EAS toward which routing the traffic flow and configures the Mobile Network accordingly to get the fastest routing. If just the application identifier is used, the Telco Operator Platform identifies all the EAS Instances and activates the optimal routing on the Mobile Network. If the optimal routing in term of latency should be available just for a set of users, the TI API must be invoked for each user creating a new TrafficInfluce resource for each one. If the Application offers different services on different interfaces a traffic filter based on IP, Port and Protocol can be used. I this way it is also possible to redirect different users to different interfaces. Here are some possible intents: -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 +## Version: 0.9.3 + +**Contact information:** +project-email@sample.com **License:** [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) @@ -100,7 +106,7 @@ Reads all of the active TrafficInfluence resources owned by the same API Consume | Name | Located in | Description | Required | Schema | | ---- | ---------- | ----------- | -------- | ---- | -| applicationId | query | Not required. Used to select traffic influence resources filtered by applicationId | No | string | +| appId | query | Used to select traffic influence resources filtered by appId | No | string (uuid) | ##### Responses @@ -120,7 +126,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. +Takes as 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. ##### Responses @@ -139,7 +145,11 @@ Takes as input an object containing the intents from the API Consumer and create #### GET ##### Summary -read a specific TrafficInfluence resource identified by the trafficInfluenceID value +Reads a specific TrafficInfluence resource identified by the trafficInfluenceID value + +##### Description + +Returns a specific TrafficInfluence resources owned by the same API Consumer authenticated via oAuth2 ##### Parameters @@ -192,6 +202,10 @@ The resource identified by the trafficInfluenceID value can be modified Delete an existing TrafficInfluence resource +##### Description + +invoked by the API Consumer to stop influencing the traffic, deleting a TrafficInfluence resource previously created + ##### Parameters | Name | Located in | Description | Required | Schema | @@ -214,12 +228,14 @@ Delete an existing TrafficInfluence resource #### TrafficInfluence +Resource conteining the informations to influence the traffic from the device to the EAS + | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | 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
_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.
_Example:_ `"6B29FC40-CA47-1067-B31D-00DD010662DA"` | Yes | +| appInstanceId | string (uuid) | A globally unique identifier associated with a running instance of an application. OP generates this identifier. | No | | region | string | Unique identifier representing a region | No | | zone | string | Unique identifier representing a zone | No | | device | object | Device identifier | No | @@ -230,11 +246,13 @@ Delete an existing TrafficInfluence resource #### PatchTrafficInfluence +inherits from TrafficInfluence and restricts the access to certain parameters. Only some paramter can be indeed modified with the PATCH operation. + | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | trafficInfluenceID | | | No | | apiConsumerId | | | No | -| applicationId | | | No | +| appId | | | No | | state | | | No | #### PostTrafficInfluence @@ -246,9 +264,11 @@ Delete an existing TrafficInfluence resource #### TrafficInfluenceNotification +Notifican channel for changes in the TrafficInfluence resource + | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | -| trafficInfluenceChanged | object | | Yes | +| trafficInfluenceChanged | object | Resource conteining the informations to influence the traffic from the device to the EAS | Yes | #### TypesZoneId @@ -273,15 +293,17 @@ Device identifier | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | phoneNumber | string | Subscriber number in E.164 format (starting with country code). Optionally prefixed with '+'.
_Example:_ `"123456789"` | No | -| networkAccessIdentifier | string | _Example:_ `"123456789@domain.com"` | No | -| ipv4Address | string (ipv4) | IPv4 address may be specified in form
as: - address - an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule. - address/mask - an IP number as above with a mask width of the form 1.2.3.4/24. In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version.
_Example:_ `"192.168.0.1/24"` | No | -| ipv6Address | | IPv6 address, following IETF 5952 format, may be specified in form
as: - address - The /128 subnet is optional for single addresses: - 2001:db8:85a3:8d3:1319:8a2e:370:7344 - 2001:db8:85a3:8d3:1319:8a2e:370:7344/128 - address/mask - an IP v6 number with a mask: - 2001:db8:85a3:8d3::0/64 - 2001:db8:85a3:8d3::/64
_Example:_ `"2001:db8:85a3:8d3:1319:8a2e:370:7344"` | No | +| networkAccessIdentifier | string | identifier for the End User formatted as string, it cab be the user's email address
_Example:_ `"123456789@domain.com"` | No | +| ipv4Address | string (ipv4) | IP of the device. A single IPv4 address may be specified in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule.
_Example:_ `"192.168.0.1"` | No | +| ipv6Address | string (ipv6) | IP of the device. A single IPv6 address, following IETF 5952 format, may be specified like 2001:db8:85a3:8d3:1319:8a2e:370:7344
_Example:_ `"2001:db8:85a3:8d3:1319:8a2e:370:7344"` | No | #### NetworkAccessIdentifier +identifier for the End User formatted as string, it cab be the user's email address + | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | -| NetworkAccessIdentifier | string | | | +| NetworkAccessIdentifier | string | identifier for the End User formatted as string, it cab be the user's email address | | **Example** 
123456789@domain.com
@@ -299,58 +321,63 @@ Subscriber number in E.164 format (starting with country code). Optionally prefi #### Ipv4Address -IPv4 address may be specified in form
as: - -- address - an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule. -- address/mask - an IP number as above with a mask width of the form 1.2.3.4/24. - In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version. +IP of the device. A single IPv4 address may be specified in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | -| Ipv4Address | string | IPv4 address may be specified in form
as: - address - an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule. - address/mask - an IP number as above with a mask width of the form 1.2.3.4/24. In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version. | | +| Ipv4Address | string | IP of the device. A single IPv4 address may be specified in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule. | | **Example** -
192.168.0.1/24
+
192.168.0.1
#### Ipv6Address -IPv6 address, following IETF 5952 format, may be specified in form
as: - -- address - The /128 subnet is optional for single addresses: - - 2001:db8:85a3:8d3:1319:8a2e:370:7344 - - 2001:db8:85a3:8d3:1319:8a2e:370:7344/128 -- address/mask - an IP v6 number with a mask: - - 2001:db8:85a3:8d3::0/64 - - 2001:db8:85a3:8d3::/64 +IP of the device. A single IPv6 address, following IETF 5952 format, may be specified like 2001:db8:85a3:8d3:1319:8a2e:370:7344 | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | -| Ipv6Address | string | IPv6 address, following IETF 5952 format, may be specified in form
as: - address - The /128 subnet is optional for single addresses: - 2001:db8:85a3:8d3:1319:8a2e:370:7344 - 2001:db8:85a3:8d3:1319:8a2e:370:7344/128 - address/mask - an IP v6 number with a mask: - 2001:db8:85a3:8d3::0/64 - 2001:db8:85a3:8d3::/64 | | +| Ipv6Address | string | IP of the device. A single IPv6 address, following IETF 5952 format, may be specified like 2001:db8:85a3:8d3:1319:8a2e:370:7344 | | **Example** 
2001:db8:85a3:8d3:1319:8a2e:370:7344
-#### InstanceIdentifier +#### AppInstanceId + +A globally unique identifier associated with a running instance of an application. OP generates this identifier. + +| Name | Type | Description | Required | +| ---- | ---- | ----------- | -------- | +| AppInstanceId | string | A globally unique identifier associated with a running instance of an application. OP generates this identifier. | | + +#### AppId -Unique identifier generated by the partner OP to identify an instance of the application on a specific zone. +A globally unique identifier associated with the application. OP generates this identifier when the application is submitted over NBI. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | -| InstanceIdentifier | string | Unique identifier generated by the partner OP to identify an instance of the application on a specific zone. | | +| AppId | string | A globally unique identifier associated with the application. OP generates this identifier when the application is submitted over NBI. | | + +**Example** +
6B29FC40-CA47-1067-B31D-00DD010662DA
#### ErrResponse +Responce feedback in case of errors + | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | -| status | string | _Example:_ `"OK"` | No | -| message | string | _Example:_ `"OK"` | No | +| status | string | status for the error
_Example:_ `"OK"` | No | +| message | string | additional message for the error
_Example:_ `"OK"` | No | #### ErrorInfo +Information in case of errors + | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | code | string | Code given to this error | Yes | | message | string | Detailed error description | Yes | + ### 4.4 Policies N/A @@ -385,8 +412,28 @@ Enhancements with respect to the previous release: - DELETE response code modified as 202. The Deletion request is accepted (not yet completed) - Added response code 400 (bad request) to POST - General improvement in documentation +- applicationId changed into appId and instanceId changed into appInstanceId +- alignement of parameters with EdgeCloud_LCM: applicationId changed into appId and instanceId changed into appInstanceId +- modified reference to CAMARA Authorization guidelines link +- Telco Edge Site changed in Edge Cloud Zone +- added: info-contact +- Device: IPV4 and IPV6 changed to represent just one IP. Net mask is no more valid. +- global tags definition +- adopted lowerCamelCase for OperationId +- added descriptions for Delte and Get (for specific resource) methods +- added missing operationid +- improvement of callback definition +- added "description" to the TrafficInfluence resource +- added "description" to the PatchTrafficInfluence resource +- added "description" to TrafficInfluenceNotification +- added "description" to NetworkAccessIdentifier +- added "description" to ErrResponse +- added "description" to message +- added "description" to status +- added "description" to ErrorInfo +- removed unused error code SessionNotFound404 ## References [1] 3GPP TS 23.501: System architecture for the 5G System (5GS); Stage 2 (Release 17), V17.4.0 (2022-03) -[2] CAMARA Commonalities : Authentication and Authorization Concept for Service APIs https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/Working/CAMARA-AuthN-AuthZ-Concept.md \ No newline at end of file +[2] CAMARA Commonalities : Authentication and Authorization Concept for Service APIs https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access-and-user-consent.md