Newer
Older
"version": "2.2.1",
"description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI",
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
},
"contact": {
"email": "cti_support@etsi.org"
"description": "ETSI GS MEC011 Application Enablement API, V2.2.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.02.01_60/gs_MEC011v020201p.pdf"
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"servers": [
{
"url": "http://127.0.0.1:8081/mec_app_support/v1",
"variables": {}
},
{
"url": "https://127.0.0.1:8081/mec_app_support/v1",
"variables": {}
}
],
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRules_GET",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrafficRule"
},
"description": "",
"examples": [
[
{
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": [
{
"dstInterface0": null,
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
{
"dstInterface1": null,
"interfaceType": "IP",
"dstIpAddress": "20.1.1.2"
}
],
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
"state": "ACTIVE"
}
]
],
"contentMediaType": "application/json"
},
"examples": {
"TrafficRules": {
"value": [
{
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": [
{
"dstInterface0": null,
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
}
],
"state": "ACTIVE"
}
]
}
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
},
"deprecated": false
},
"parameters": []
"/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_GET",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "trafficRuleId",
"in": "path",
"description": "Represents a traffic rule.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrafficRule"
},
"examples": {
"TrafficRule": {
"value": {
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": [
{
"dstInterface0": null,
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
}
],
"state": "ACTIVE"
}
}
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_PUT",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "trafficRuleId",
"in": "path",
"description": "Represents a traffic rule.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "One or more updated attributes that are allowed to be changed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrafficRule"
}
}
},
"required": true
},
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrafficRule"
},
"examples": {
"TrafficRule": {
"value": {
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": [
{
"dstInterface0": null,
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
}
],
"state": "ACTIVE"
}
}
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Precondition Failed. It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
Walter Featherstone
committed
},
"deprecated": false
},
"parameters": []
"description": "This method retrieves information about all the DNS rules associated with a MEC application instance.",
"operationId": "ApplicationsDnsRules_GET",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DnsRule"
},
"description": "",
"examples": [
[
{
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
},
{
"dnsRuleId": "DnsRule2",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.4",
"ttl": 300,
"state": "INACTIVE"
}
]
],
"contentMediaType": "application/json"
},
"examples": {
"DnsRules": {
"value": [
{
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
},
{
"dnsRuleId": "DnsRule2",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.4",
"ttl": 300,
"state": "INACTIVE"
}
]
}
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
},
"deprecated": false
},
"parameters": []
"/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
"description": "This method retrieves information about a DNS rule associated with a MEC application instance.",
"operationId": "ApplicationsDnsRule_GET",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "dnsRuleId",
"in": "path",
"description": "Represents a DNS rule.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DnsRule"
},
"examples": {
"DnsRule": {
"value": {
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
}
}
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
"description": "This method activates, de-activates or updates a traffic rule.",
"operationId": "ApplicationsDnsRule_PUT",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "dnsRuleId",
"in": "path",
"description": "Represents a DNS rule.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The updated state is included in the entity body of the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DnsRule"
}
}
},
"required": true
},
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DnsRule"
},
"examples": {
"DnsRule": {
"value": {
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
}
}
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Precondition Failed. It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"deprecated": false
},
"parameters": []
"/applications/{appInstanceId}/subscriptions": {
"description": "The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.",
"operationId": "ApplicationsSubscriptions_GET",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"description": "Upon success, a response body containing the list of links to the requested subscriptions is returned.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList"
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications. Upon success, the response contains entity body describing the created subscription.",
"operationId": "ApplicationsSubscriptions_POST",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Entity body in the request contains a subscription to the MEC application termination notifications that is to be created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTerminationNotificationSubscription"
}
}
},
"required": true
},
"description": "Entity body in the request contains a subscription to the MEC service availability notifications that is to be created.",
"headers": {
"location": {
"description": "The resource URI of the created resource",
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "The resource URI of the created resource",
"contentMediaType": "text/plain"
}
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTerminationNotificationSubscription"
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
Walter Featherstone
committed
},
"AppTerminationNotification": {
"{$request.body#/callbackUri}": {
"post": {
"description": "Represents the information that the MEP notifies the subscribed application instance about the corresponding application instance termination/stop'",
"operationId": "AppTerminationNotification_POST",
"tags": [
"callbacks"
],
"requestBody": {
"$ref": "#/components/requestBodies/AppTerminationNotification"
},
"responses": {
"200": {
"description": "Expected responses from callback consumer, if it accepts the callback"
}
}
}
}
"/applications/{appInstanceId}/subscriptions/{subscriptionId}": {
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
"description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.",
"operationId": "ApplicationsSubscription_GET",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "subscriptionId",
"in": "path",
"description": "Represents a subscription to the notifications from the MEC platform.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"description": "Upon success, a response body containing the requested subscription is returned.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTerminationNotificationSubscription"
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
"description": "This method deletes a mecAppSuptApiSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
"operationId": "ApplicationsSubscription_DELETE",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "subscriptionId",
"in": "path",
"description": "Represents a subscription to the notifications from the MEC platform.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
],
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
}
},
"deprecated": false
},
"parameters": []
"/applications/{appInstanceId}/confirm_termination": {
"post": {
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
"description": "This method is used to confirm the application level termination of an application instance.",
"operationId": "ApplicationsConfirmTermination_POST",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTerminationConfirmation"
}
}
},
"required": false
},
"description": "No Content",
"headers": {},
"content": {}
"description": "Unauthorized. It is used when the client did not submit the appropriate credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Conflict. The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is because the application instance resource is in NOT_INSTANTIATED state.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Too Many Requests. It is used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
Walter Featherstone
committed
},
"deprecated": false
},
"parameters": []
"/applications/{appInstanceId}/confirm_ready": {
"post": {
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
"description": "This method may be used by the MEC application instance to notify the MEC platform that it is up and running. ",
"operationId": "ApplicationsConfirmReady_POST",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppReadyConfirmation"
}
}
},
"required": false
},
"description": "No Content",
"headers": {},
"content": {}
"description": "Unauthorized. It is used when the client did not submit the appropriate credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Conflict. The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is because the application instance resource is in NOT_INSTANTIATED state.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Too Many Requests. It is used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"deprecated": false
},
"parameters": []
},
"/timing/timing_caps": {
"get": {
"description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
"operationId": "TimingCaps_GET",
"parameters": [],
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimingCaps"
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
},
"deprecated": false
},
"parameters": []
"description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
"operationId": "TimingCurrentTime_GET",
"parameters": [],
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrentTime"
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
},
"deprecated": false
},
"parameters": []
Walter Featherstone
committed
"components": {
"schemas": {
"const": "READY",
"type": "string",
"description": "Indication about the MEC application instance.",
"examples": [
"READY"
]
},
"description": "This type represents the information that the MEC application instance indicates to the MEC platform that it is up and running."
"properties": {
"operationAction": {
"$ref": "#/components/schemas/OperationActionType"
}
},
"description": "This type represents the information that the MEC application instance provides to the MEC platform when informing it that the application has completed its application level related terminate/stop actions, e.g. retention of application state in the case of stop."
"title": "AppTerminationNotification.Links",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
},
"confirmTermination": {
"$ref": "#/components/schemas/LinkType.ConfirmTermination"
}
},
"description": "Object containing hyperlinks related to the resource."
Walter Featherstone
committed
},
"AppTerminationNotification": {
Walter Featherstone
committed
"required": [
"notificationType",
Walter Featherstone
committed
"maxGracefulTimeout",
"_links"
],
Walter Featherstone
committed
"properties": {
"notificationType": {
"type": "string",
"description": "Shall be set to AppTerminationNotification.",
"examples": [
"AppTerminationNotification"
]
Walter Featherstone
committed
},
"operationAction": {
"$ref": "#/components/schemas/OperationActionType"
},
Walter Featherstone
committed
"maxGracefulTimeout": {
"type": "integer",
"description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
"contentEncoding": "int32",
"examples": [
10
]
Walter Featherstone
committed
},
"_links": {
"$ref": "#/components/schemas/AppTerminationNotification.Links"
Walter Featherstone
committed
}
},
"description": "This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop."
Walter Featherstone
committed
},
"AppTerminationNotificationSubscription": {
"title": "AppTerminationNotificationSubscription",
Walter Featherstone
committed
"required": [
"subscriptionType",
"callbackReference",
"_links",
"appInstanceId"
],
Walter Featherstone
committed
"properties": {
"subscriptionType": {
"type": "string",
"description": "Shall be set to AppTerminationNotificationSubscription.",
"examples": [
"AppTerminationNotificationSubscription"
]
Walter Featherstone
committed
},
"callbackReference": {
"type": "string",
"description": "URI selected by the MEC application instance to receive notifications on the subscribed MEC application instance management information. This shall be included in both the request and the response."
Walter Featherstone
committed
},
"_links": {
"$ref": "#/components/schemas/Self"
},
"appInstanceId": {
"type": "string",
"description": "It is used as the filtering criterion for the subscribed events.",
"examples": [
"ID1"
]
Walter Featherstone
committed
}
},
"description": "This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop."
Walter Featherstone
committed
},
"CurrentTime": {
Walter Featherstone
committed
"required": [
"seconds",
Walter Featherstone
committed
"timeSourceStatus"
],
Walter Featherstone
committed
"properties": {
"seconds": {
"type": "integer",
"description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
"contentEncoding": "int32",
"examples": [
1577836800
]
Walter Featherstone
committed
},
"nanoSeconds": {
"type": "integer",
"description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
"contentEncoding": "int32",
"examples": [
0
]
Walter Featherstone
committed
},
"timeSourceStatus": {
"$ref": "#/components/schemas/TimeSourceStatus"
Walter Featherstone
committed
}
},
"description": "This type represents the information provided by the MEC platform in response to the Get Platform Time Request message."
Walter Featherstone
committed
},
"DestinationInterface.InterfaceType": {
"title": "DestinationInterface.InterfaceType",
Walter Featherstone
committed
"enum": [
"TUNNEL",
"MAC",
"IP"
],
"type": "string",
"description": "Type of the interface",
"examples": [
"TUNNEL"
]
Walter Featherstone
committed
},
"DestinationInterface": {
Walter Featherstone
committed
"required": [
"interfaceType"
],
Walter Featherstone
committed
"properties": {
"interfaceType": {
"$ref": "#/components/schemas/DestinationInterface.InterfaceType"
},
"tunnelInfo": {
"$ref": "#/components/schemas/TunnelInfo"
},
"srcMacAddress": {
"type": "string",
"description": "Source address identifies the MAC address of the interface",
"examples": [
"02-00-00-00-00-00"
]
Walter Featherstone
committed
},
"dstMacAddress": {
"type": "string",
"description": "Source address identifies the MAC address of the interface",
"examples": [
"02-00-00-00-00-00"
]
Walter Featherstone
committed
},
"dstIpAddress": {
"type": "string",
"description": "IP address of the remote destination",
"examples": [
"192.0.2.0"
]
Walter Featherstone
committed
}
},
"description": "This type represents the destination interface. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. If the action is DROP, no value shall be provided."
Walter Featherstone
committed
},
"DnsRule.IpAddressType": {
Walter Featherstone
committed
"enum": [
"IP_V6",
"IP_V4"
],
"type": "string",
"description": "IP address type",
"examples": [
"IP_V6"
]
Walter Featherstone
committed
},
"DnsRule.State": {
Walter Featherstone
committed
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"description": "DNS rule state. This attribute may be updated using HTTP PUT method",
"examples": [
"ACTIVE"
]
Walter Featherstone
committed
},
"DnsRule": {
Walter Featherstone
committed
"required": [
"dnsRuleId",
"domainName",
"ipAddressType",
"ipAddress",
"state"
],
Walter Featherstone
committed
"properties": {
"dnsRuleId": {
"type": "string",
"description": "Identifies the DNS Rule",
"examples": [
"dnsRule1"
]
Walter Featherstone
committed
},
"domainName": {
"type": "string",
"description": "FQDN resolved by the DNS rule",
"examples": [
"www.example.com"
]
Walter Featherstone
committed
},
"ipAddressType": {
"$ref": "#/components/schemas/DnsRule.IpAddressType"
},
"ipAddress": {
"type": "string",
"description": "IP address associated with the FQDN resolved by the DNS rule",
"examples": [
"192.0.2.0"
]
Walter Featherstone
committed
},
"ttl": {
"type": "integer",
"description": "Time to live value",
"contentEncoding": "int32"
Walter Featherstone
committed
},
"state": {
"$ref": "#/components/schemas/DnsRule.State"
}
},
"description": "This type represents the general information of a DNS rule."
Walter Featherstone
committed
},
"type": "object",
"properties": {
"type": "string",
"description": "URI referring to a resource",
"examples": [
"/mecAppSuptApi/example"
]
},
"description": "This type represents a type of link and may be referenced from data structures"
Walter Featherstone
committed
},
Walter Featherstone
committed
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource",
"examples": [
"/mecAppSuptApi/example"
]
Walter Featherstone
committed
}
},
"description": "Link to the task resource where to confirm termination in case the application is ready to be terminated before expiry of the timeout."
Walter Featherstone
committed
},
"title": "MecAppSuptApiSubscriptionLinkList.Links",
Walter Featherstone
committed
"required": [
"self"
],
Walter Featherstone
committed
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
Walter Featherstone
committed
"type": "array",
"items": {
"$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Subscription"
},
"description": "The MEC application instance's subscriptions"
Walter Featherstone
committed
}
},
"description": "Self-referring URI."
Walter Featherstone
committed
},
"MecAppSuptApiSubscriptionLinkList.Subscription": {
"title": "MecAppSuptApiSubscriptionLinkList.Subscription",
Walter Featherstone
committed
"required": [
"href",
"rel"
],
Walter Featherstone
committed
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource",
"examples": [
"/mecAppSuptApi/example"
]
Walter Featherstone
committed
},
"rel": {
"type": "string",
"description": "The values shall be set to AppTerminationNotificationSubscription."
Walter Featherstone
committed
}
},
"description": "A link to a subscription."
Walter Featherstone
committed
},
"title": "MecAppSuptApiSubscriptionLinkList",
Walter Featherstone
committed
"required": [
"_links"
],
Walter Featherstone
committed
"properties": {
"_links": {
"$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Links"
Walter Featherstone
committed
}
},
"description": "This type represents a list of links related to currently existing subscriptions for a MEC application instance. This information is returned when sending a request to receive current subscriptions."
Walter Featherstone
committed
},
"enum": [
"STOPPING",
"TERMINATING"
],
"type": "string",
"description": "Operation that is being performed on the MEC application instance.",
"examples": [
"TERMINATING"
]
Walter Featherstone
committed
"ProblemDetails": {
Walter Featherstone
committed
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
Walter Featherstone
committed
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type"
Walter Featherstone
committed
},
"status": {
"type": "integer",
"description": "The HTTP status code for this occurrence of the problem",
"contentEncoding": "int32"
Walter Featherstone
committed
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem"
Walter Featherstone
committed
},
"instance": {
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem"
Walter Featherstone
committed
}
}
},
Walter Featherstone
committed
"required": [
Walter Featherstone
committed
],
Walter Featherstone
committed
"properties": {
Walter Featherstone
committed
"$ref": "#/components/schemas/LinkType"
}
Walter Featherstone
committed
},
"TimingCaps.NtpServers.AuthenticationOption": {
"title": "TimingCaps.NtpServers.AuthenticationOption",
Walter Featherstone
committed
"enum": [
"NONE",
"SYMMETRIC_KEY",
"AUTO_KEY"
],
"type": "string",
"description": "NTP authentication option",
"examples": [
"NONE"
]
},
Walter Featherstone
committed
"TimingCaps.NtpServers.NtpServerAddrType": {
"title": "TimingCaps.NtpServers.NtpServerAddrType",
Walter Featherstone
committed
"enum": [
"IP_ADDRESS",
"DNS_NAME"
],
"type": "string",
"description": "Address type of NTP server",
"examples": [
"IP_ADDRESS"
]
Walter Featherstone
committed
},
"TimingCaps.NtpServers": {
Walter Featherstone
committed
"required": [
"ntpServerAddrType",
"ntpServerAddr",
"minPollingInterval",
"maxPollingInterval",
"localPriority",
"authenticationOption",
"authenticationKeyNum"
],
Walter Featherstone
committed
"properties": {
"ntpServerAddrType": {
"$ref": "#/components/schemas/TimingCaps.NtpServers.NtpServerAddrType"
},
"ntpServerAddr": {
"type": "string",
"description": "NTP server address",
"examples": [
"192.0.2.0"
]
Walter Featherstone
committed
},
"minPollingInterval": {
"description": "Minimum poll interval for NTP messages, in seconds as a power of two. Range 3 to 17",
"contentEncoding": "int32",
"examples": [
3
]
Walter Featherstone
committed
},
"maxPollingInterval": {
"description": "Maximum poll interval for NTP messages, in seconds as a power of two. Range 3 to 17",
"contentEncoding": "int32",
"examples": [
17
]
Walter Featherstone
committed
},
"localPriority": {
"type": "integer",
"description": "NTP server local priority",
"contentEncoding": "int32",
"examples": [
1
]
Walter Featherstone
committed
},
"authenticationOption": {
"$ref": "#/components/schemas/TimingCaps.NtpServers.AuthenticationOption"
},
"authenticationKeyNum": {
"type": "integer",
"description": "Authentication key number",
"contentEncoding": "int32",
"examples": [
1
]
Walter Featherstone
committed
}
},
"description": "NTP server detail."
Walter Featherstone
committed
},
"TimingCaps_PtpMasters": {
Walter Featherstone
committed
"required": [
"ptpMasterIpAddress",
"ptpMasterLocalPriority",
"delayReqMaxRate"
],
Walter Featherstone
committed
"properties": {
"ptpMasterIpAddress": {
"description": "PTP Server (referred to as \"master\" in IEEE 1588-2019) IP Address",
Walter Featherstone
committed
},
"ptpMasterLocalPriority": {
"description": "PTP Server (referred to as \"master\" in IEEE 1588-2019 ) local priority",
"contentEncoding": "int32",
"examples": [
1
]
Walter Featherstone
committed
},
"delayReqMaxRate": {
"type": "integer",
"description": "Acceptable maximum rate of the Delay_Req messages in packets per second",
"contentEncoding": "int32",
"examples": [
10
]
Walter Featherstone
committed
}
},
"description": "NTP server detail."
Walter Featherstone
committed
},
"TimingCaps.TimeStamp": {
Walter Featherstone
committed
"required": [
Walter Featherstone
committed
],
Walter Featherstone
committed
"properties": {
"seconds": {
"type": "integer",
"description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
"contentEncoding": "int32",
"examples": [
1577836800
]
Walter Featherstone
committed
},
"nanoSeconds": {
"type": "integer",
"description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
"contentEncoding": "int32",
"examples": [
0
]
Walter Featherstone
committed
}
Walter Featherstone
committed
},
"TimingCaps": {
Walter Featherstone
committed
"type": "object",
"properties": {
"timeStamp": {
"$ref": "#/components/schemas/TimingCaps.TimeStamp"
},
"ntpServers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimingCaps.NtpServers"
},
"description": "Available NTP servers"
Walter Featherstone
committed
},
"ptpMasters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimingCaps_PtpMasters"
"description": "Number of available PTP Servers (referred to as \"masters\" in IEEE 1588-2019)"
Walter Featherstone
committed
}
},
"description": "This type represents the information provided by the MEC platform in response to the Timing capabilities Query message."
Walter Featherstone
committed
},
"TrafficFilter": {
Walter Featherstone
committed
"type": "object",
"properties": {
"srcAddress": {
"type": "array",
"items": {
"type": "string"
},
"description": "An IP address or a range of IP address. For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses. For IPv6, the IP address could be an IP prefix, or a range of IP prefixes."
Walter Featherstone
committed
},
"dstAddress": {
"type": "array",
"items": {
"type": "string"
},
"description": "An IP address or a range of IP address. For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses. For IPv6, the IP address could be an IP prefix, or a range of IP prefixes."
Walter Featherstone
committed
},
"srcPort": {
"type": "array",
"items": {
"type": "string"
},
"description": "A port or a range of ports"
Walter Featherstone
committed
},
"dstPort": {
"type": "array",
"items": {
"type": "string"
},
"description": "A port or a range of ports"
Walter Featherstone
committed
},
"protocol": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specify the protocol of the traffic filter"
Walter Featherstone
committed
},
"token": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used for token based traffic rule"
Walter Featherstone
committed
},
"srcTunnelAddress": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used for GTP tunnel based traffic rule"
Walter Featherstone
committed
},
"tgtTunnelAddress": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used for GTP tunnel based traffic rule"
Walter Featherstone
committed
},
"srcTunnelPort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used for GTP tunnel based traffic rule"
Walter Featherstone
committed
},
"dstTunnelPort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used for GTP tunnel based traffic rule"
Walter Featherstone
committed
},
"qCI": {
"type": "integer",
"description": "Used to match all packets that have the same Quality Class Indicator (QCI).",
"contentEncoding": "int32",
"examples": [
1
]
Walter Featherstone
committed
},
"dSCP": {
"type": "integer",
"description": "Used to match all IPv4 packets that have the same Differentiated Services Code Point (DSCP)",
"contentEncoding": "int32",
"examples": [
0
]
Walter Featherstone
committed
},
"tC": {
"type": "integer",
"description": "Used to match all IPv6 packets that have the same Traffic Class.",
"contentEncoding": "int32",
"examples": [
1
]
Walter Featherstone
committed
}
},
"description": "This type represents the traffic filter."
Walter Featherstone
committed
},
"TrafficRule.Action": {
Walter Featherstone
committed
"enum": [
"DROP",
"FORWARD_DECAPSULATED",
Walter Featherstone
committed
"PASSTHROUGH",
"DUPLICATE_DECAPSULATED",
Walter Featherstone
committed
],
"type": "string",
"description": "The action of the MEC host data plane when a packet matches the trafficFilter",
"examples": [
"DROP"
]
Walter Featherstone
committed
},
"TrafficRule.FilterType": {
Walter Featherstone
committed
"enum": [
"FLOW",
"PACKET"
],
"type": "string",
"description": "Definition of filter per FLOW or PACKET. If flow the filter match UE->EPC packet and the reverse packet is handled in the same context",
"examples": [
"FLOW"
]
Walter Featherstone
committed
},
"TrafficRule.State": {
Walter Featherstone
committed
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"description": "Contains the traffic rule state. This attribute may be updated using HTTP PUT method",
"examples": [
"ACTIVE"
]
Walter Featherstone
committed
},
"TrafficRule": {
Walter Featherstone
committed
"required": [
"trafficRuleId",
"filterType",
"priority",
"trafficFilter",
"action",
"state"
],
Walter Featherstone
committed
"properties": {
"trafficRuleId": {
"type": "string",
"description": "Identify the traffic rule.",
"examples": [
"TrafficRule1"
]
Walter Featherstone
committed
},
"filterType": {
"$ref": "#/components/schemas/TrafficRule.FilterType"
},
"priority": {
"description": "Priority of this traffic rule within the range 0 to 255. If traffic rules conflict, the one with higher priority take precedence. Value indicates the priority in descending order, i.e. with 0 as the highest priority and 255 as the lowest priority.",
"contentEncoding": "int32",
"examples": [
1
]
Walter Featherstone
committed
},
"trafficFilter": {
Walter Featherstone
committed
"type": "array",
"items": {
"$ref": "#/components/schemas/TrafficFilter"
Walter Featherstone
committed
},
"action": {
"$ref": "#/components/schemas/TrafficRule.Action"
},
"dstInterface": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DestinationInterface"
},
"maxItems": 2
Walter Featherstone
committed
},
"state": {
"$ref": "#/components/schemas/TrafficRule.State"
}
},
"description": "This type represents the general information of a traffic rule."
Walter Featherstone
committed
},
"TunnelInfo.TunnelType": {
Walter Featherstone
committed
"enum": [
"GTP_U",
"GRE"
],
"type": "string",
"description": "This type represents the tunnel information.",
"examples": [
"GTP_U"
]
Walter Featherstone
committed
},
"TunnelInfo": {
Walter Featherstone
committed
"required": [
"tunnelType"
],
Walter Featherstone
committed
"properties": {
"tunnelType": {
"$ref": "#/components/schemas/TunnelInfo.TunnelType"
},
"tunnelDstAddress": {
"type": "string",
"description": "Destination address of the tunnel",
"examples": [
"?"
]
Walter Featherstone
committed
},
"tunnelSrcAddress": {
"type": "string",
"description": "Source address of the tunnel",
"examples": [
"?"
]
Walter Featherstone
committed
}
"description": "This type represents the tunnel information."
Walter Featherstone
committed
},
"TimeSourceStatus": {
"title": "TimeSourceStatus",
"enum": [
"TRACEABLE",
"NONTRACEABLE"
],
"type": "string",
"description": "Platform Time Source status. 1 = TRACEABLE - time source is locked to the UTC time source. 2 = NONTRACEABLE - time source is not locked to the UTC time source",
"examples": [
"TRACEABLE"
]
Walter Featherstone
committed
}
},
"requestBodies": {
"AppTerminationNotification": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTerminationNotification"
}
}