@@ -5,7 +5,7 @@ openapi: 3.0.3
5
5
# ###########################################################################
6
6
info :
7
7
title : Traffic Influence API
8
- version : 0.9.5- wip
8
+ version : wip
9
9
description : |
10
10
## Overview
11
11
The reference scenario foresees a Service, composed by one or more Service
@@ -148,13 +148,15 @@ info:
148
148
traffic toward a specific Application instance.\
149
149
\
150
150
**sourceTrafficFilters:**
151
- The traffic can be from a specific application port in the Device.\
151
+ The traffic can be from a specific port in the device. If this parameter is
152
+ used, the influenced flow is from the port defined in "sourceTrafficFilters"
153
+ rathar than the port specified in "Device"\
152
154
\
153
155
**destinationTrafficFilters:**
154
156
The Application can expose different service on different interfaces,
155
157
identified by port and protocol, with this parameter it is possible to
156
- route the traffic just toward some of those services maybe for different
157
- sets of users .\
158
+ route the traffic toward a specific port and protocol exposed by the
159
+ Application .\
158
160
\
159
161
**Device:**
160
162
An user Device can be provided as an input. The Device can be identified by
@@ -166,7 +168,10 @@ info:
166
168
of each user Device. New "TrafficInfluence" resources are created (with
167
169
different "trafficInfluenceID"). All the created resources are aggregated by
168
170
the Application (identified by "appId"). The routing toward the selected
169
- Application instance is only applied for provided user Devices.\
171
+ Application instance is only applied for provided user Devices. "publicPort"
172
+ can be used to identify the device. "publicPort" can be also used to
173
+ identify the flow to be influenced. If the flow to be influenced is from a
174
+ different port, "sourceTrafficFilters" can be used.\
170
175
\
171
176
**Notification URL and token:**
172
177
Developers have a chance to specify call back URL on which notifications
@@ -175,9 +180,7 @@ info:
175
180
## Authentication and Authorization
176
181
CAMARA guidelines defines a set of authorization flows which can grant API
177
182
clients access to the API functionality, as outlined in the document
178
- [CAMARA-API-access-and-user-consent.md](https://github.com/camaraproject\
179
- /IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access\
180
- -and-user-consent.md).
183
+ [CAMARA-Security-Interoperability.md](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md).
181
184
Which specific authorization flows are to be used will be determined during
182
185
onboarding process, happening between the API Client and the Telco Operator
183
186
exposing the API, taking into account the declared purpose for accessing the
@@ -655,15 +658,15 @@ components:
655
658
- ' deletion in progress'
656
659
- ' deleted'
657
660
sourceTrafficFilters :
658
- description : Ports used locally by the device for flows to which
659
- the requested traffic influence should apply. If omitted, then the
660
- traffic influence will apply to all flows between the device and the
661
- specified application server address and ports .
661
+ description : Port used locally by the device for flows to which
662
+ the requested traffic influence should apply. Traffic influence will
663
+ be applied to the flow between "sourcePort" and the Application
664
+ Server address and port specified in "destinationTrafficFilters" .
662
665
type : object
663
666
properties :
664
667
sourcePort :
665
668
allOf :
666
- - $ref : " #/components/schemas/PortsSpec "
669
+ - $ref : " #/components/schemas/Port "
667
670
destinationTrafficFilters :
668
671
description : Identifies the destination IP packet filters. To be
669
672
used when it is needed a traffic flow towards a specific EAS
@@ -673,7 +676,7 @@ components:
673
676
properties :
674
677
destinationPort :
675
678
allOf :
676
- - $ref : " #/components/schemas/PortsSpec "
679
+ - $ref : " #/components/schemas/Port "
677
680
destinationProtocol :
678
681
allOf :
679
682
- $ref : " #/components/schemas/Protocol"
@@ -811,25 +814,6 @@ components:
811
814
type : string
812
815
format : ipv4
813
816
example : " 84.125.93.10"
814
- PortsSpec :
815
- description : Specification of several TCP or UDP ports
816
- type : object
817
- minProperties : 1
818
- properties :
819
- ranges :
820
- description : Range of TCP or UDP ports
821
- type : array
822
- minItems : 1
823
- items :
824
- type : object
825
- required :
826
- - from
827
- - to
828
- properties :
829
- from :
830
- $ref : " #/components/schemas/Port"
831
- to :
832
- $ref : " #/components/schemas/Port"
833
817
Port :
834
818
description : TCP or UDP port number
835
819
type : integer
0 commit comments