Skip to content

Commit ff07922

Browse files
TI API Rel 0.9.6: sourceTrafficFilters
- removed rel number in "version" field according to:#272 - sourceTrafficFilters added according to: #230 (comment) - updated link to Identity and Consent: CAMARA-Security-Interoperability: #277
1 parent 3dfb478 commit ff07922

File tree

1 file changed

+17
-33
lines changed

1 file changed

+17
-33
lines changed

code/API_definitions/Traffic_Influence.yaml

+17-33
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ openapi: 3.0.3
55
############################################################################
66
info:
77
title: Traffic Influence API
8-
version: 0.9.5-wip
8+
version: wip
99
description: |
1010
## Overview
1111
The reference scenario foresees a Service, composed by one or more Service
@@ -148,13 +148,15 @@ info:
148148
traffic toward a specific Application instance.\
149149
\
150150
**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"\
152154
\
153155
**destinationTrafficFilters:**
154156
The Application can expose different service on different interfaces,
155157
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.\
158160
\
159161
**Device:**
160162
An user Device can be provided as an input. The Device can be identified by
@@ -166,7 +168,10 @@ info:
166168
of each user Device. New "TrafficInfluence" resources are created (with
167169
different "trafficInfluenceID"). All the created resources are aggregated by
168170
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.\
170175
\
171176
**Notification URL and token:**
172177
Developers have a chance to specify call back URL on which notifications
@@ -175,9 +180,7 @@ info:
175180
## Authentication and Authorization
176181
CAMARA guidelines defines a set of authorization flows which can grant API
177182
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).
181184
Which specific authorization flows are to be used will be determined during
182185
onboarding process, happening between the API Client and the Telco Operator
183186
exposing the API, taking into account the declared purpose for accessing the
@@ -655,15 +658,15 @@ components:
655658
- 'deletion in progress'
656659
- 'deleted'
657660
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".
662665
type: object
663666
properties:
664667
sourcePort:
665668
allOf:
666-
- $ref: "#/components/schemas/PortsSpec"
669+
- $ref: "#/components/schemas/Port"
667670
destinationTrafficFilters:
668671
description: Identifies the destination IP packet filters. To be
669672
used when it is needed a traffic flow towards a specific EAS
@@ -673,7 +676,7 @@ components:
673676
properties:
674677
destinationPort:
675678
allOf:
676-
- $ref: "#/components/schemas/PortsSpec"
679+
- $ref: "#/components/schemas/Port"
677680
destinationProtocol:
678681
allOf:
679682
- $ref: "#/components/schemas/Protocol"
@@ -811,25 +814,6 @@ components:
811814
type: string
812815
format: ipv4
813816
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"
833817
Port:
834818
description: TCP or UDP port number
835819
type: integer

0 commit comments

Comments
 (0)