Skip to content

Commit 1e72a05

Browse files
Merge pull request #14 from FabrizioMoggio/NewDocumentation
TI API Rel 0.9.4 new Documentation
2 parents 9198b72 + d80f825 commit 1e72a05

File tree

2 files changed

+69
-404
lines changed

2 files changed

+69
-404
lines changed

code/API_definitions/Traffic_Influence.yaml

+69-12
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ openapi: 3.0.3
55
############################################################################
66
info:
77
title: OPAG-CAMARA Traffic Influence API
8-
version: 0.9.3
8+
version: 0.9.4-wip
99
description: |
1010
## Overview
1111
The reference scenario foresees a Service, composed by one or more Service
@@ -33,7 +33,7 @@ info:
3333
geographical location and the Device moves to another geographical location,
3434
the TI API can be invoked to get the optimal routing in the new geographical
3535
location for that Device.
36-
## 1. Introduction
36+
## Introduction
3737
The TI API provides the capability to establish the best routing, in terms
3838
of latency, in a specific geographical area, between the user Device, e.g.
3939
the user’s smartphone, and the optimal EAS instance nearby. If the Device
@@ -74,7 +74,7 @@ info:
7474
instance. In the case the Application detects a location change, it can
7575
invoke the TI API again to request a new routing optimization toward
7676
the new EAS instance.
77-
## 2. Quick Start
77+
## Quick Start
7878
The usage of the TI API is based on the management of a "TrafficInfluence"
7979
resource, an object containing the intent requested invoking the TI API and
8080
that is implemented by the platform configuring the Mobile Network for the
@@ -164,7 +164,7 @@ info:
164164
Developers have a chance to specify call back URL on which notifications
165165
(e.g. session termination) regarding the session can be received from the
166166
service provider. This is also an optional parameter.
167-
## 3. Authentication and Authorization
167+
## Authentication and Authorization
168168
CAMARA guidelines defines a set of authorization flows which can grant API
169169
clients access to the API functionality, as outlined in the document
170170
[CAMARA-API-access-and-user-consent.md](https://github.com/camaraproject\
@@ -181,8 +181,7 @@ info:
181181
mandatory. This measure ensures that the API remains in strict compliance
182182
with user privacy preferences and regulatory obligations, upholding the
183183
principles of transparency and user-centric data control.
184-
## 4. API Documentation
185-
## 4.1 Details
184+
## API Documentation
186185
The TI API is consumed by an Application Function (AF) requesting for the
187186
optimal routing, in term of latency, for the traffic flow from a Device
188187
toward EAS instances in Edge Cloud Zones.\
@@ -210,6 +209,67 @@ info:
210209
3) activate the optimal routing for a user devices: the TI API can be
211210
invoked with a user Device identifier (“Device”). For each user Device,
212211
a TI API invocation is required.
212+
## Release Notes
213+
The Traffic Influence API reduces the complexity of the 3GPP Traffic
214+
Influence API exposed by the 3GPP Network Exposure Function (NEF) [1]. While
215+
the 3GPP TI API offers fastest routing activation and user mobility among
216+
different edge sites, this version of the CAMARA Traffic Influence API
217+
covers only the fastest routing activation, also for selected users.
218+
User mobility will be introduced in a future version.\
219+
\
220+
**Enhancements with respect to the previous release V0.8.1:**
221+
- These release also effects existing data sessions
222+
- These release can be also used to optimize existing data sessions when a
223+
Device moves among geographical areas.
224+
- The ueId parameter is renamed into Device
225+
- The parameter Device, that identifies the User, is now simplified to
226+
guarantee the identification of an existing data session
227+
- InstanceId added
228+
- TrafficFilters description updated
229+
- CAMEL type adopted
230+
- FlowInfo deleted
231+
- OpenAPI version updated to 3.0.3
232+
- To let the Developer to just work on parameters actually editable, the PUT
233+
method is changed into a PATCH method with a limitation on the
234+
parameters usable and modifiable. A new resource is created,
235+
PatchTrafficInfluence that contains only the editable parameters
236+
The same approach is also adopted for the PUT method and a new resource
237+
PostTrafficInfluence was created with just the editable parameters
238+
- DELETE response code modified as 202. The Deletion request is accepted
239+
(not yet completed, it must be carried on by the system)
240+
- Added response code 400 (bad request) to POST
241+
- General improvement in documentation
242+
- applicationId changed into appId and instanceId changed into appInstanceId
243+
- Alignement of parameters with EdgeCloud_LCM: applicationId changed into
244+
appId and instanceId changed into appInstanceId
245+
- Modified reference to CAMARA Authorization guidelines link
246+
- Telco Edge Site changed in Edge Cloud Zone
247+
- Added: info-contact
248+
- Device: IPV4 and IPV6 changed to represent just one IP. Netmask is no more
249+
valid
250+
- Global tags definition
251+
- Adopted lowerCamelCase for OperationId
252+
- Added descriptions for Delete and Get (for specific resource) methods
253+
- Added missing operationid
254+
- Improvement of callback definition
255+
- Added "description" to the TrafficInfluence resource
256+
- Added "description" to the PatchTrafficInfluence resource
257+
- Added "description" to TrafficInfluenceNotification
258+
- Added "description" to NetworkAccessIdentifier
259+
- Added "description" to ErrResponse
260+
- Added "description" to message
261+
- Added "description" to status
262+
- Added "description" to ErrorInfo
263+
- Removed unused error code SessionNotFound404
264+
- Alignement of parameters with EdgeCloud_LCM: applicationId changed into
265+
appId and instanceId changed into appInstanceId
266+
- Adoption of OpenId authentication for Consent Management. Client
267+
Credential is removed
268+
- Intruduced xcorrelator
269+
- General alignment with CAMARA on returned Errors
270+
- Modified CAMARA URL to refer to the Edge Cloud Repository
271+
- OAS version now includes "-wip" extension
272+
- simplified "Servers" section and included "vwip" as version
213273
license:
214274
name: Apache 2.0
215275
url: https://www.apache.org/licenses/LICENSE-2.0.html
@@ -218,19 +278,16 @@ info:
218278

219279
externalDocs:
220280
description: Product documentation at Camara
221-
url: https://github.com/camaraproject/
281+
url: https://github.com/camaraproject/EdgeCloud
222282
############################################################################
223283
# Servers #
224284
############################################################################
225285
servers:
226-
- url: "{apiRoot}/{basePath}"
286+
- url: "{apiRoot}/traffic-influence/vwip"
227287
variables:
228288
apiRoot:
229289
default: http://localhost:9091
230-
description: API root
231-
basePath:
232-
default: traffic-influence/v0
233-
description: Base path for the Traffic Influence API
290+
description: API root for the Traffic Influence API
234291
############################################################################
235292
# Tags #
236293
############################################################################

0 commit comments

Comments
 (0)