Skip to content

Commit 936d5af

Browse files
Fixed some error in the Documentation
According to: #249 (comment)
1 parent c337cd9 commit 936d5af

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

code/API_definitions/Traffic_Influence.yaml

+7-6
Original file line numberDiff line numberDiff line change
@@ -90,30 +90,30 @@ info:
9090
Before starting to use the TI API, the developer needs to know about the
9191
below specified details:\
9292
\
93-
**Base-Url**
93+
**Base-Url:**
9494
The RESTful TI API endpoint, for example
9595
[**https://tim-api.developer.tim.it/trafficinfluence**](https://tim-api.\
9696
developer.tim.it/trafficinfluence)\
9797
\
98-
**TrafficInfluence**
98+
**TrafficInfluence:**
9999
This object represents the resource that carries the requirements from the
100100
user to be implemented. The TI API is invoked for the life cycle management
101101
of this resource (CRUD). The resource contains the intents from the TI API
102102
Consumer. Managing this resource, the developer can specify in which
103103
geographical location the routing must be applied, toward which application,
104104
maybe for a specific set of users or for a limited period of time.\
105105
\
106-
**trafficInfluenceID**
106+
**trafficInfluenceID:**
107107
Identifier for the Traffic Influence resource. This parameter is returned
108108
by the TI API and must be used to update it (e.g., adding a Device or
109109
deleting it). A different Traffic Influence resource must be created for
110110
any Device or Zone or Region. All these resources are related to an
111111
Application identified by "appId".\
112112
\
113-
**apiConsumerId**
113+
**apiConsumerId:**
114114
Unique identifier for the TI API Consumer.\
115115
\
116-
**region**
116+
**region:**
117117
The developer can specify in which geographical area he requires the fastest
118118
routing toward the nearest application instance. A "region" is a wide
119119
geographical area and it contains one or more "zones". A "zone" is where the
@@ -125,7 +125,7 @@ info:
125125
"trafficInfluenceID"). All the created resources are aggregated by the
126126
Application (identified by "appId").\
127127
\
128-
**zone**
128+
**zone:**
129129
The developer can specify in which geographical area he requires the fastest
130130
routing toward the nearest Application instance. A "zone" is a smaller
131131
geographical area inside a "region". A "zone" is where the Edge Cloud Zone
@@ -281,6 +281,7 @@ info:
281281
- Updated documentation to better specify how to identify a Device
282282
- Updated the Device parameter according to CAMARA_common.yaml
283283
- change API name in YAML
284+
- introduced sourceTrafficFilters and modified trafficFilters into destinationTrafficFilters
284285
license:
285286
name: Apache 2.0
286287
url: https://www.apache.org/licenses/LICENSE-2.0.html

0 commit comments

Comments
 (0)