Loading go-apps/meep-tm/api/bwm/swagger.yaml +566 −15 File changed.Preview size limit exceeded, changes collapsed. Show changes go-apps/meep-tm/api/mts/swagger.yaml +94 −24 Original line number Diff line number Diff line Loading @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: AdvantEDGE Multi-access Traffic Steering API description: "Multi-access Traffic Steering Sercice is AdvantEDGE's implementation\ \ of [ETSI MEC ISG MEC015 Traffic Management APIs](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/02.02.01_60/gs_MEC015v020201p.pdf)\ \ of [ETSI MEC ISG MEC015 Traffic Management APIs](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/03.01.01_60/gs_MEC015v030101p.pdf)\ \ <p>[Copyright (c) ETSI 2017](https://forge.etsi.org/etsi-forge-copyright-notice.txt)\ \ <p>**Micro-service**<br>[meep-tm](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-tm/server/mts)\ \ <p>**Type & Usage**<br>Edge Service used by edge applications that want to get\ Loading @@ -14,10 +14,10 @@ info: license: name: Apache 2.0 url: https://github.com/InterDigitalInc/AdvantEDGE/blob/master/LICENSE version: 2.2.1 version: 3.1.1 externalDocs: description: ETSI GS MEC015 V2.2.1 Traffic Management APIs url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/02.02.01_60/gs_MEC015v020201p.pdf description: ETSI GS MEC015 V3.1.1 Traffic Management APIs url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/03.01.01_60/gs_MEC015v030101p.pdf servers: - url: https://localhost/sandboxname/mts/v1 tags: Loading Loading @@ -62,6 +62,12 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' "429": description: "Too many requests: It is used when a rate limiter has triggered." content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /mts_sessions: get: tags: Loading Loading @@ -139,6 +145,12 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' "429": description: "Too many requests: It is used when a rate limiter has triggered." content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: tags: - mts Loading Loading @@ -184,6 +196,12 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' "405": description: "Not Allowed : used when the client reached maximum sessions limit." content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /mts_sessions/{sessionId}: get: tags: Loading Loading @@ -231,6 +249,12 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' "429": description: "Too many requests: It is used when a rate limiter has triggered." content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - mts Loading Loading @@ -450,7 +474,7 @@ components: x-etsi-mec-origin-type: Structure (inlined) mtsMode: type: integer description: "Numeric value (0 - 255) corresponding to a specific MTS mode\ description: "Numeric value (0 to 255) corresponding to a specific MTS mode\ \ of the MTS session: 0 = low cost, i.e. using the unmetered access network\ \ connection whenever it is available 1 = low latency, i.e. using the\ \ access network connection with lower latency 2 = high throughput, i.e.\ Loading @@ -462,11 +486,21 @@ components: format: uint32 x-etsi-mec-cardinality: "1" x-etsi-mec-origin-type: Uint32 trafficSplit: type: array description: Indicates the requested ratio between multiple access networks for the network aggregation\ \ required for higher throughput. Indicates the requested ratio between multiple access networks for \ \ the network aggregation required for higher throughput. This is based on the existing 3GPP ATSSS feature\ \ specified in clause 5.32.8 of ETSI TS 123 501 [i.5]. items: $ref: '#/components/schemas/TrafficSplit' trafficSwitch: $ref: '#/components/schemas/TrafficSwitch' qosD: $ref: '#/components/schemas/MtsSessionInfo_qosD' requestType: type: integer description: "Numeric value (0 - 255) corresponding to specific type of\ description: "Numeric value (0 to 255) corresponding to specific type of\ \ consumer as following: 0 = APPLICATION_SPECIFIC_MTS_SESSION 1 = FLOW_SPECIFIC_MTS_SESSION" enum: - 0 Loading Loading @@ -607,7 +641,7 @@ components: x-etsi-mec-origin-type: Uint32 accessType: type: integer description: "Numeric value (0-255) corresponding to specific type of access\ description: "Numeric value (0 to 255) corresponding to specific type of access\ \ network as following: 0 = Unknown 1 = Any IEEE802.11-based WLAN technology\ \ 2 = Any 3GPP-based Cellular technology 3 = Any Fixed Access 11 = IEEE802.11\ \ a/b/g WLAN 12 = IEEE 802.11 a/b/g/n WLAN 13 = IEEE 802.11 a/b/g/n/ac\ Loading @@ -619,7 +653,7 @@ components: x-etsi-mec-origin-type: Uint32 metered: type: integer description: "Numeric value (0-255) corresponding to the following: 0: the\ description: "Numeric value (0 to 255) corresponding to the following: 0: the\ \ connection is not metered (see note) 1: the connection is metered 2:\ \ unknown " format: uint32 Loading Loading @@ -663,21 +697,20 @@ components: format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 dstIp: dstAddress: type: string description: "Destination address identity of session. The string for a\ \ IPv4 address shall be formatted in the \"dotted decimal\" notation as\ \ defined in IETF RFC 1166 [10]. The string for a IPv6 address shall be\ \ formatted according to clause 4 of IETF RFC 5952 [11], with in CIDR\ \ notation [12] used to provide the routing prefix." \ notation IETF RFC 4632 [12] used to provide the routing prefix." x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: String dstPort: type: integer type: string description: Destination port identity of session format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 x-etsi-mec-origin-type: String flowlabel: type: integer description: "Flow Label in the IPv6 header, applicable only if the flow\ Loading @@ -686,26 +719,32 @@ components: x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 protocol: type: integer type: string description: Protocol number x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: String maxSessions: type: integer format: uint32 description: It indicates the maximum number of sessions MTS service will\ \ track for the given (sourceIp, dstIp etc.) provided by a service consumer.\ \ This attribute shall not be present in the request, but may be present in the response. x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 sourceIp: sourceAddress: type: string description: "Source address identity of session. The string for a IPv4\ \ address shall be formatted in the \"dotted decimal\" notation as defined\ \ in IETF RFC 1166 [10]. The string for a IPv6 address shall be formatted\ \ according to clause 4 of IETF RFC 5952 [11], with in CIDR notation [12]\ \ according to clause 4 of IETF RFC 5952 [11], with in CIDR notation IETF RFC 4632 [12]\ \ used to provide the routing prefix." x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: String sourcePort: type: integer type: string description: Source port identity of session format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 x-etsi-mec-origin-type: String example: flowlabel: 1 protocol: 5 Loading @@ -714,36 +753,67 @@ components: dstPort: 6 sourceIp: sourceIp dstIp: dstIp TrafficSplit: type: object required: - accessId - splittingRatio properties: accessId: type: integer format: int32 description: Unique identifier for the access network connection. x-etsi-mec-cardinality: 1 x-etsi-mec-origin-type: Uint32 splittingRatio: type: string description: Splitting ratio for the access network as per the accessId. x-etsi-mec-cardinality: 1 x-etsi-mec-origin-type: String TrafficSwitch: type: object description: Priority based access network connection switching for seamless handover as per the\ \ application preference. This is based on the existing 3GPP ATSSS feature specified in clause\ \ 5.32.8 of ETSI TS 123 501 [i.5]. required: - accessId properties: accessId: type: integer format: int32 description: Unique identifier for the access network connection. x-etsi-mec-cardinality: 1 x-etsi-mec-origin-type: Uint32 MtsSessionInfo_qosD: type: object properties: maxJitter: type: integer description: "tolerable jitter in [10 nanoseconds]" description: "Tolerable jitter in [10 nanoseconds]" format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 maxLatency: type: integer description: "tolerable (one-way) delay in [10 nanoseconds]" description: "Tolerable (one-way) delay in [10 nanoseconds]" format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 maxLoss: type: integer description: "tolerable packet loss rate in [1/10^x]" description: "Tolerable packet loss rate in [1/10^x]" format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 minTpt: type: integer description: "minimal throughput in [kbps]" description: "Minimal throughput in [kbps]" format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 priority: type: integer description: "numeric value (0 - 255) corresponding to the traffic priority\ description: "numeric value (0 to 255) corresponding to the traffic priority\ \ 0: low; 1: medium; 2: high; 3: critical" format: uint32 x-etsi-mec-cardinality: 0..1 Loading Loading
go-apps/meep-tm/api/bwm/swagger.yaml +566 −15 File changed.Preview size limit exceeded, changes collapsed. Show changes
go-apps/meep-tm/api/mts/swagger.yaml +94 −24 Original line number Diff line number Diff line Loading @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: AdvantEDGE Multi-access Traffic Steering API description: "Multi-access Traffic Steering Sercice is AdvantEDGE's implementation\ \ of [ETSI MEC ISG MEC015 Traffic Management APIs](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/02.02.01_60/gs_MEC015v020201p.pdf)\ \ of [ETSI MEC ISG MEC015 Traffic Management APIs](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/03.01.01_60/gs_MEC015v030101p.pdf)\ \ <p>[Copyright (c) ETSI 2017](https://forge.etsi.org/etsi-forge-copyright-notice.txt)\ \ <p>**Micro-service**<br>[meep-tm](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-tm/server/mts)\ \ <p>**Type & Usage**<br>Edge Service used by edge applications that want to get\ Loading @@ -14,10 +14,10 @@ info: license: name: Apache 2.0 url: https://github.com/InterDigitalInc/AdvantEDGE/blob/master/LICENSE version: 2.2.1 version: 3.1.1 externalDocs: description: ETSI GS MEC015 V2.2.1 Traffic Management APIs url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/02.02.01_60/gs_MEC015v020201p.pdf description: ETSI GS MEC015 V3.1.1 Traffic Management APIs url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/03.01.01_60/gs_MEC015v030101p.pdf servers: - url: https://localhost/sandboxname/mts/v1 tags: Loading Loading @@ -62,6 +62,12 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' "429": description: "Too many requests: It is used when a rate limiter has triggered." content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /mts_sessions: get: tags: Loading Loading @@ -139,6 +145,12 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' "429": description: "Too many requests: It is used when a rate limiter has triggered." content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: tags: - mts Loading Loading @@ -184,6 +196,12 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' "405": description: "Not Allowed : used when the client reached maximum sessions limit." content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /mts_sessions/{sessionId}: get: tags: Loading Loading @@ -231,6 +249,12 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' "429": description: "Too many requests: It is used when a rate limiter has triggered." content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - mts Loading Loading @@ -450,7 +474,7 @@ components: x-etsi-mec-origin-type: Structure (inlined) mtsMode: type: integer description: "Numeric value (0 - 255) corresponding to a specific MTS mode\ description: "Numeric value (0 to 255) corresponding to a specific MTS mode\ \ of the MTS session: 0 = low cost, i.e. using the unmetered access network\ \ connection whenever it is available 1 = low latency, i.e. using the\ \ access network connection with lower latency 2 = high throughput, i.e.\ Loading @@ -462,11 +486,21 @@ components: format: uint32 x-etsi-mec-cardinality: "1" x-etsi-mec-origin-type: Uint32 trafficSplit: type: array description: Indicates the requested ratio between multiple access networks for the network aggregation\ \ required for higher throughput. Indicates the requested ratio between multiple access networks for \ \ the network aggregation required for higher throughput. This is based on the existing 3GPP ATSSS feature\ \ specified in clause 5.32.8 of ETSI TS 123 501 [i.5]. items: $ref: '#/components/schemas/TrafficSplit' trafficSwitch: $ref: '#/components/schemas/TrafficSwitch' qosD: $ref: '#/components/schemas/MtsSessionInfo_qosD' requestType: type: integer description: "Numeric value (0 - 255) corresponding to specific type of\ description: "Numeric value (0 to 255) corresponding to specific type of\ \ consumer as following: 0 = APPLICATION_SPECIFIC_MTS_SESSION 1 = FLOW_SPECIFIC_MTS_SESSION" enum: - 0 Loading Loading @@ -607,7 +641,7 @@ components: x-etsi-mec-origin-type: Uint32 accessType: type: integer description: "Numeric value (0-255) corresponding to specific type of access\ description: "Numeric value (0 to 255) corresponding to specific type of access\ \ network as following: 0 = Unknown 1 = Any IEEE802.11-based WLAN technology\ \ 2 = Any 3GPP-based Cellular technology 3 = Any Fixed Access 11 = IEEE802.11\ \ a/b/g WLAN 12 = IEEE 802.11 a/b/g/n WLAN 13 = IEEE 802.11 a/b/g/n/ac\ Loading @@ -619,7 +653,7 @@ components: x-etsi-mec-origin-type: Uint32 metered: type: integer description: "Numeric value (0-255) corresponding to the following: 0: the\ description: "Numeric value (0 to 255) corresponding to the following: 0: the\ \ connection is not metered (see note) 1: the connection is metered 2:\ \ unknown " format: uint32 Loading Loading @@ -663,21 +697,20 @@ components: format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 dstIp: dstAddress: type: string description: "Destination address identity of session. The string for a\ \ IPv4 address shall be formatted in the \"dotted decimal\" notation as\ \ defined in IETF RFC 1166 [10]. The string for a IPv6 address shall be\ \ formatted according to clause 4 of IETF RFC 5952 [11], with in CIDR\ \ notation [12] used to provide the routing prefix." \ notation IETF RFC 4632 [12] used to provide the routing prefix." x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: String dstPort: type: integer type: string description: Destination port identity of session format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 x-etsi-mec-origin-type: String flowlabel: type: integer description: "Flow Label in the IPv6 header, applicable only if the flow\ Loading @@ -686,26 +719,32 @@ components: x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 protocol: type: integer type: string description: Protocol number x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: String maxSessions: type: integer format: uint32 description: It indicates the maximum number of sessions MTS service will\ \ track for the given (sourceIp, dstIp etc.) provided by a service consumer.\ \ This attribute shall not be present in the request, but may be present in the response. x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 sourceIp: sourceAddress: type: string description: "Source address identity of session. The string for a IPv4\ \ address shall be formatted in the \"dotted decimal\" notation as defined\ \ in IETF RFC 1166 [10]. The string for a IPv6 address shall be formatted\ \ according to clause 4 of IETF RFC 5952 [11], with in CIDR notation [12]\ \ according to clause 4 of IETF RFC 5952 [11], with in CIDR notation IETF RFC 4632 [12]\ \ used to provide the routing prefix." x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: String sourcePort: type: integer type: string description: Source port identity of session format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 x-etsi-mec-origin-type: String example: flowlabel: 1 protocol: 5 Loading @@ -714,36 +753,67 @@ components: dstPort: 6 sourceIp: sourceIp dstIp: dstIp TrafficSplit: type: object required: - accessId - splittingRatio properties: accessId: type: integer format: int32 description: Unique identifier for the access network connection. x-etsi-mec-cardinality: 1 x-etsi-mec-origin-type: Uint32 splittingRatio: type: string description: Splitting ratio for the access network as per the accessId. x-etsi-mec-cardinality: 1 x-etsi-mec-origin-type: String TrafficSwitch: type: object description: Priority based access network connection switching for seamless handover as per the\ \ application preference. This is based on the existing 3GPP ATSSS feature specified in clause\ \ 5.32.8 of ETSI TS 123 501 [i.5]. required: - accessId properties: accessId: type: integer format: int32 description: Unique identifier for the access network connection. x-etsi-mec-cardinality: 1 x-etsi-mec-origin-type: Uint32 MtsSessionInfo_qosD: type: object properties: maxJitter: type: integer description: "tolerable jitter in [10 nanoseconds]" description: "Tolerable jitter in [10 nanoseconds]" format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 maxLatency: type: integer description: "tolerable (one-way) delay in [10 nanoseconds]" description: "Tolerable (one-way) delay in [10 nanoseconds]" format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 maxLoss: type: integer description: "tolerable packet loss rate in [1/10^x]" description: "Tolerable packet loss rate in [1/10^x]" format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 minTpt: type: integer description: "minimal throughput in [kbps]" description: "Minimal throughput in [kbps]" format: uint32 x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uint32 priority: type: integer description: "numeric value (0 - 255) corresponding to the traffic priority\ description: "numeric value (0 to 255) corresponding to the traffic priority\ \ 0: low; 1: medium; 2: high; 3: critical" format: uint32 x-etsi-mec-cardinality: 0..1 Loading