Newer
Older
description: The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
contact:
email: cti_support@etsi.org
description: 'ETSI GS MEC011 Application Enablement API, V3.1.1'
url: >-
https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/03.01.01_60/gs_MEC011v030101p.pdf
- name: appTrafficRules
- name: appDnsRules
- name: appSubscriptions
- name: appConfirmTermination
- name: appConfirmReady
- name: timing
- name: callbacks
- name: appRegistrations
jsonSchemaDialect: 'https://json-schema.org/draft/2020-12/schema'
- url: 'http://127.0.0.1:8081/mec_app_support/v2'
variables: {}
- url: 'https://127.0.0.1:8081/mec_app_support/v2'
variables: {}
'/applications/{appInstanceId}/traffic_rules':
- appTrafficRules
summary: get traffic rules
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
description: >-
Upon success, a response message content containing an array of the
TrafficRules is returned.
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TrafficRule'
description: ''
examples:
- - trafficRuleId: TrafficRule123
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.127.4.100/32
- 192.127.4.101/32
dstAddress:
- 192.127.4.102/32
- 192.127.4.103/32
srcPort:
- '80'
dstPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
dstIpAddress: 20.1.1.1
state: ACTIVE
contentMediaType: application/json
examples:
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
TrafficRules:
- trafficRuleId: TrafficRule123
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.127.4.100/32
- 192.127.4.101/32
dstAddress:
- 192.127.4.102/32
- 192.127.4.103/32
srcPort:
- '80'
dstPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
- dstInterface: null
interfaceType: IP
tunnelInfo: tunnel
dstIpAddress: 20.1.1.1
state: ACTIVE
- trafficRuleId: TrafficRule456
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.127.4.104/32
- 192.127.4.105/32
dstAddress:
- 192.127.4.106/32
- 192.127.4.107/32
srcPort:
- '80'
dstPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
- dstInterface: null
interfaceType: IP
tunnelInfo: tunnel
dstIpAddress: 20.1.1.2
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}':
- appTrafficRules
summary: Get traffic rule
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
description: >-
Upon success, a response message content containing the TrafficRules
is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
examples:
trafficRuleId: TrafficRule123
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.127.4.100/32
- 192.127.4.101/32
dstAddress:
- 192.127.4.102/32
- 192.127.4.103/32
srcPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
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
- appTrafficRules
summary: Update traffic rule
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
description: >-
One or more updated attributes that are allowed to be changed are
included in the TrafficRule data structure in the message content of
the request.
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
required: true
description: >-
Upon success, a response message content containing data type
describing the updated TrafficRule is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
examples:
trafficRuleId: TrafficRule123
serName: ExampleService
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.127.4.100/32
- 192.127.4.101/32
dstAddress:
- 192.127.4.102/32
- 192.127.4.103/32
srcPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
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}/dns_rules':
- appDnsRules
summary: Get DNS rules
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
description: >-
Upon success, a response message content containing an array of the
DnsRules is returned.
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:
- 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}':
- appDnsRules
summary: Get DNS rule
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: >-
Upon success, a response message content containing the DnsRules is
returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
examples:
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
deprecated: false
- appDnsRules
summary: Update DNS rule
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
description: The updated "state" is included in the message content of the request.
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
required: true
description: >-
Upon success, a response message content containing data type
describing the updated DnsRule is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
examples:
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':
- appSubscriptions
summary: Get subscriptions
description: >-
The GET method may be used to request information about all
subscriptions for this requestor. Upon success, the response contains
message content 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 message content 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
deprecated: false
- appSubscriptions
summary: Create subscription
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 message content
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
description: >-
Message content 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
deprecated: false
callbacks:
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
summary: Create callback
$ref: '#/components/requestBodies/AppTerminationNotification'
responses:
'200':
description: >-
Expected responses from callback consumer, if it accepts the
callback
'/applications/{appInstanceId}/subscriptions/{subscriptionId}':
- appSubscriptions
summary: Get subscription
description: >-
The GET method requests information about a subscription for this
requestor. Upon success, the response contains message content 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 message content 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
deprecated: false
- appSubscriptions
summary: delete subscription
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
responses:
'204':
description: No Content
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}/confirm_termination':
- appConfirmTermination
summary: Confirm termination
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
description: >-
Message content in the request contains the operational action the
application instance is responding to.
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationConfirmation'
required: false
description: >-
No Content. The request is acknowledged. The response message
content shall be empty.
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
'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
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: []
'/applications/{appInstanceId}/confirm_ready':
- appConfirmReady
summary: Confirm ready
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
description: >-
Message content in the request contains the indication that the
application instance is up and running.
content:
application/json:
schema:
$ref: '#/components/schemas/AppReadyConfirmation'
required: false
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
'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
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: []
1180
1181
1182
1183
1184
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
1225
1226
1227
1228
1229
1230
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
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
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
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
/registrations:
post:
tags:
- appRegistrations
summary: Create Registrantion
description: >-
The POST method may be used by the MEC application instance to request
its registration to the MEC platform.
operationId: ApplicationsRegistrations_POST
parameters: []
requestBody:
description: >-
The message content in the request contains the profile of the MEC
application instance, calling the MEC platform to register the MEC
application instance.
content:
application/json:
schema:
$ref: '#/components/schemas/AppInfo'
required: false
responses:
'201':
description: >-
Indicates successful resource creation for registration of the MEC
application instance to the MEC platform.
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/AppInfo'
'400':
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
'401':
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
'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: []
'/registrations/{appInstanceId}':
get:
tags:
- appRegistrations
summary: Get Registration
description: >-
The GET method may be used by the MEC application instance to retrieve
information about the existing MEC application instance registration to
the MEC platform.
operationId: ApplicationsRegistration_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
responses:
'200':
description: >-
Upon success, a response message content containing the requested
subscription is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppInfo'
'400':
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
'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
put:
tags:
- appRegistrations
summary: Update Registration
description: >-
The PUT method may be used by the MEC application instance to update its
registration to the MEC platform.
operationId: ApplicationsRegistration_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
requestBody:
description: >-
Message content in the request contains the profile of the
application, calling the MEC platform to update the existing MEC
application instance registration.
content:
application/json:
schema:
$ref: '#/components/schemas/AppInfo'
required: true
responses:
'204':
description: No Content
headers: {}
content: {}
'400':
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
'401':
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
'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
delete:
tags:
- appRegistrations
summary: delete registration
description: >-
The DELETE method is used to cancel the existing MEC application
instance registration.
operationId: ApplicationsRegistration_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
responses:
'204':
description: No Content
headers: {}
content: {}
'400':
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
'401':
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
'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: []
- timing
summary: Retrieve timing capabilities
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 message
content contains a representation of the resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimingCaps'
'400':
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
'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: []
/timing/current_time:
- timing
summary: Retrieve current time
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 message
content contains a representation of the resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CurrentTime'
'400':
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
'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: []
Walter Featherstone
committed
components:
schemas:
const: READY
type: string
description: Indication about the MEC application instance.
examples:
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
- READY
description: >-
This type represents the information that the MEC application instance
indicates to the MEC platform that it is up and running.
AppInfo:
title: AppInfo
required:
- appName
type: object
properties:
appName:
title: appName
type: string
description: >-
Name of the application. It shall be consistent with the appName in
the AppD, if an AppD is available.
examples:
- appName
appProvider:
title: appProvider
type: string
description: >-
Provider of the application. It shall be consistent with the
appProvider in the AppD, if an AppD is available. See note 1.
examples:
- appProvider1
appCategory:
$ref: '#/components/schemas/CategoryRef'
appDId:
title: appDId
type: string
description: >-
The application descriptor identifier. It is managed by the
application provider to identify the application descriptor in a
globally unique way. Shall be present if the application instance is
instantiated by the MEC Management.
examples:
- TODO
appInstanceId:
title: appInstanceId
type: string
description: >-
Identifier of the application instance. Shall be present if the
application instance is instantiated by the MEC Management.
examples:
- ID1
endpoint:
oneOf:
- $ref: '#/components/schemas/EndPointInfo.Uris'
- $ref: '#/components/schemas/EndPointInfo.Fqdn'
- $ref: '#/components/schemas/EndPointInfo.Addresses'
- $ref: '#/components/schemas/EndPointInfo.Alternative'
description: This type represents information about a transport endpoint
x-etsi-notes: "NOTE 1:\tIf appProfile is present, appProvider shall be consistent with provId provided in EAS profile data type, i.e. the same.\nNOTE 2:\tIf appProfile is present, endpoint shall refer to the same end point as endPt provided in EAS profile data type."
appServiceRequired:
title: appServiceRequired
type: array
items:
$ref: '#/components/schemas/ServiceDependency'
description: >-
Describes services a MEC application requires to run.
ServiceDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
be provided if an AppD is available.
appServiceOptional:
title: appServiceOptional
type: array
items:
$ref: '#/components/schemas/ServiceDependency'
description: >-
Describes services a MEC application may use if available.
ServiceDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
be provided if an AppD is available.
appFeatureRequired:
title: appFeatureRequired
type: array
items:
$ref: '#/components/schemas/FeatureDependency'
description: >-
Describes features a MEC application requires to run.
FeatureDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
be provided if an AppD is available.
appFeatureOptional:
title: appFeatureOptional
type: array
items:
$ref: '#/components/schemas/FeatureDependency'
description: >-
Describes features a MEC application may use if available.
FeatureDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
be provided if an AppD is available.
isInsByMec:
type: boolean
description: >-
Indicate whether the application instance is instantiated by the MEC
Management.
Default to FALSE if absent.
examples:
- false
appProfile:
$ref: '#/components/schemas/AppProfile'
description: >-
This type represents the information provided by the MEC application
instance as part of the "application registration request" and
"application registration update" messages.
x-etsi-notes: "NOTE 1:\tIf appProfile is present, appProvider shall be consistent with provId provided in EAS profile data type, i.e. the same.\nNOTE 2:\tIf appProfile is present, endpoint shall refer to the same end point as endPt provided in EAS profile data type."
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
- operationAction
- maxGracefulTimeout
- _links
Walter Featherstone
committed
properties:
notificationType:
type: string
description: Shall be set to AppTerminationNotification.
examples:
- AppTerminationNotification
operationAction:
$ref: '#/components/schemas/OperationActionType'
Walter Featherstone
committed
maxGracefulTimeout:
description: >-
Maximum timeout value in seconds for graceful termination or
graceful stop of an application instance.
contentEncoding: int32
examples:
Walter Featherstone
committed
_links:
$ref: '#/components/schemas/AppTerminationNotification.Links'
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:
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
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
- nanoSeconds
- 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:
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:
Walter Featherstone
committed
timeSourceStatus:
$ref: '#/components/schemas/TimeSourceStatus'
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
Walter Featherstone
committed
type: string
description: Type of the interface
examples:
Walter Featherstone
committed
DestinationInterface:
Walter Featherstone
committed
required:
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:
Walter Featherstone
committed
dstMacAddress:
type: string
description: Source address identifies the MAC address of the interface
examples:
Walter Featherstone
committed
dstIpAddress:
type: string
description: IP address of the remote destination
examples:
- 192.0.2.0
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:
Walter Featherstone
committed
type: string
description: IP address type
examples:
DnsRule.State:
title: DnsRule.State
Walter Featherstone
committed
enum:
type: string
description: DNS rule state. This attribute may be updated using HTTP PUT method
examples:
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:
Walter Featherstone
committed
domainName:
type: string
description: FQDN resolved by the DNS rule
examples:
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:
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.
x-etsi-notes: "NOTE:\tIf no ttl value is provided, the DnsRule shall not expire."
href:
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
type: object
properties:
href:
type: string
description: URI referring to a resource
examples:
- /mecAppSuptApi/example
description: >-
Link to the task resource where to confirm termination in case the
application is ready to be terminated before expiry of the timeout.
title: MecAppSuptApiSubscriptionLinkList.Links
Walter Featherstone
committed
required:
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
description: Self-referring URI.
MecAppSuptApiSubscriptionLinkList.Subscription:
title: MecAppSuptApiSubscriptionLinkList.Subscription
Walter Featherstone
committed
required:
- href
- subscriptionType
Walter Featherstone
committed
properties:
href:
type: string
description: URI referring to a resource
examples:
- /mecAppSuptApi/example
subscriptionType:
Walter Featherstone
committed
type: string
description: Type of the subscription. The values are as defined in the "subscriptionType" attribute for each different Mp1 event subscription data type.
description: A link to a subscription.
title: MecAppSuptApiSubscriptionLinkList
Walter Featherstone
committed
required:
Walter Featherstone
committed
properties:
_links:
$ref: '#/components/schemas/MecAppSuptApiSubscriptionLinkList.Links'
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.
- STOPPING
- TERMINATING
type: string
description: Operation that is being performed on the MEC application instance.
examples:
Walter Featherstone
committed
ProblemDetails:
Walter Featherstone
committed
type: object
properties:
type:
description: >-
A URI reference according to IETF RFC 3986 that identifies the
problem type
Walter Featherstone
committed
title:
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:
description: >-
A human-readable explanation specific to this occurrence of the
problem
Walter Featherstone
committed
instance:
description: >-
A URI reference that identifies the specific occurrence of the
problem
Walter Featherstone
committed
Self:
Walter Featherstone
committed
required:
Walter Featherstone
committed
properties:
self:
$ref: '#/components/schemas/LinkType'
Walter Featherstone
committed
TimingCaps.NtpServers.AuthenticationOption:
title: TimingCaps.NtpServers.AuthenticationOption
Walter Featherstone
committed
enum:
- NONE
- SYMMETRIC_KEY
- AUTO_KEY
Walter Featherstone
committed
type: string
description: NTP authentication option
examples:
Walter Featherstone
committed
TimingCaps.NtpServers.NtpServerAddrType:
title: TimingCaps.NtpServers.NtpServerAddrType
Walter Featherstone
committed
enum:
- IP_ADDRESS
- DNS_NAME
Walter Featherstone
committed
type: string
description: Address type of NTP server
examples:
Walter Featherstone
committed
TimingCaps.NtpServers:
Walter Featherstone
committed
required:
- ntpServerAddrType
- ntpServerAddr
- minPollingInterval
- maxPollingInterval
- localPriority
- authenticationOption
Walter Featherstone
committed
properties:
ntpServerAddrType:
$ref: '#/components/schemas/TimingCaps.NtpServers.NtpServerAddrType'
ntpServerAddr:
type: string
description: NTP server address
examples:
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:
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:
Walter Featherstone
committed
localPriority:
type: integer
description: NTP server local priority
contentEncoding: int32
examples:
Walter Featherstone
committed
authenticationOption:
$ref: '#/components/schemas/TimingCaps.NtpServers.AuthenticationOption'
authenticationKeyNum:
description: >-
Authentication key number. This configuration is valid and shall be
present if authenticationOption is set to SYMMETRIC_KEY
contentEncoding: int32
examples:
Walter Featherstone
committed
description: NTP server detail.
TimingCaps_PtpMasters:
title: 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:
Walter Featherstone
committed
delayReqMaxRate:
description: >-
Acceptable maximum rate of the Delay_Req messages in packets per
second
contentEncoding: int32
examples:
Walter Featherstone
committed
TimingCaps.TimeStamp:
Walter Featherstone
committed
required:
- seconds
- nanoSeconds
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:
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:
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'
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)
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:
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:
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:
Walter Featherstone
committed
description: A port or a range of ports
Walter Featherstone
committed
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
type: array
items:
type: string
description: Used for token based traffic rule
Walter Featherstone
committed
srcTunnelAddress:
type: array
items:
Walter Featherstone
committed
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
type: array
items:
Walter Featherstone
committed
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
type: array
items:
Walter Featherstone
committed
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
type: array
items:
type: string
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
qCI:
description: >-
Used to match all packets that have the same Quality Class Indicator
(QCI).
contentEncoding: int32
examples:
Walter Featherstone
committed
dSCP:
description: >-
Used to match all IPv4 packets that have the same Differentiated
Services Code Point (DSCP)
contentEncoding: int32
examples:
Walter Featherstone
committed
tC:
type: integer
description: Used to match all IPv6 packets that have the same Traffic Class.
contentEncoding: int32
examples:
description: This type represents the traffic filter.
Walter Featherstone
committed
TrafficRule.Action:
Walter Featherstone
committed
enum:
- DROP
- FORWARD_DECAPSULATED
- FORWARD_ENCAPSULATED
- PASSTHROUGH
- DUPLICATE_DECAPSULATED
- DUPLICATE_ENCAPSULATED
Walter Featherstone
committed
type: string
description: >-
The action of the MEC host data plane when a packet matches the
trafficFilter
TrafficRule.FilterType:
title: TrafficRule.FilterType
Walter Featherstone
committed
enum:
Walter Featherstone
committed
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
Walter Featherstone
committed
TrafficRule.State:
Walter Featherstone
committed
enum:
description: >-
Contains the traffic rule state. This attribute may be updated using
HTTP PUT method
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:
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:
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.
x-etsi-notes: "NOTE 1:\tValue indicates the priority in descending order, i.e. with 0 as the highest priority and 255 as the lowest priority.\nNOTE 2:\tSome applications (like inline/tap) require two interfaces. The first interface in the case of inline/tap is on the client (e.g. UE) side and the second on the core network (e.g. EPC) side."
Walter Featherstone
committed
TunnelInfo.TunnelType:
Walter Featherstone
committed
enum:
Walter Featherstone
committed
description: This type represents the tunnel information.
Walter Featherstone
committed
required:
Walter Featherstone
committed
properties:
tunnelType:
$ref: '#/components/schemas/TunnelInfo.TunnelType'
tunnelDstAddress:
type: string
description: Destination address of the tunnel
Walter Featherstone
committed
examples:
tunnelSrcAddress:
type: string
description: Source address of the tunnel
Walter Featherstone
committed
examples:
description: This type represents the tunnel information.
TimeSourceStatus:
title: TimeSourceStatus
enum:
- TRACEABLE
- NONTRACEABLE
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
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
- TRACEABLE
CategoryRef:
title: CategoryRef
required:
- href
- id
- name
- version
type: object
properties:
href:
type: string
description: Reference of the catalogue
examples:
- /example/catalogue1
id:
type: string
description: Unique identifier of the category
examples:
- id12345
name:
type: string
description: >-
Name of the category, example values include RNI, Location &
Bandwidth Management
examples:
- RNI
version:
type: string
description: Category version
examples:
- version1
description: This type represents the category reference
EndPointInfo.Address:
title: EndPointInfo.Address
required:
- host
- port
type: object
properties:
host:
type: string
description: Host portion of the address
examples:
- 192.0.2.0
port:
type: integer
description: Port portion of the address
contentEncoding: int32
examples:
- 8080
description: A IP address and port pair
EndPointInfo.Addresses:
title: EndPointInfo.Addresses
required:
- addresses
type: object
properties:
addresses:
type: array
items:
$ref: '#/components/schemas/EndPointInfo.Address'
description: >-
Entry point information of the service as one or more pairs of IP
address and port. See note.
description: This type represents information about a transport endpoint.
EndPointInfo.Alternative:
title: EndPointInfo.Alternative
required:
- alternative
type: object
properties:
alternative:
type: object
description: >-
Entry point information of the service in a format defined by an
implementation, or in an external specification. See note.
description: This type represents information about a transport endpoint.
EndPointInfo.Uris:
title: EndPointInfo.Uris
required:
- uris
type: object
properties:
uris:
type: array
items:
type: string
description: >-
Entry point information of the service as string, formatted
according to URI syntax
description: This type represents information about a transport endpoint.
EndPointInfo.Fqdn:
title: EndPointInfo.Fqdn
required:
- fqdn
type: object
properties:
fqdn:
type: array
items:
type: string
description: Fully Qualified Domain Name of the service. See note.
description: 'This type represents information about a transport endpoint. '
ServiceDependency:
properties:
requestedPermissions:
description: >-
Requested permissions regarding the access of the application to the
service. See clause 8.2 of ETSI GS MEC 009 [4].
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
The format of this attribute is left for the data model design
stage.
items:
$ref: '#/components/schemas/Not_specified'
minItems: 0
type: array
serCategory:
$ref: '#/components/schemas/CategoryRef'
serName:
description: 'The name of the service, for example, RNIS, LocationService, etc.'
type: string
serTransportDependencies:
description: >-
Indicates transport and serialization format dependencies of
consuming the service. Defaults to REST + JSON if absent. See note.
items:
$ref: '#/components/schemas/TransportDependency'
minItems: 0
type: array
version:
description: The version of the service.
type: string
required:
- serName
- version
type: object
x-etsi-notes: "NOTE:\tThis attribute indicates groups of transport bindings that a service-consuming MEC application supports for the consumption of the MEC service defined by this ServiceDependency structure. If at least one of the indicated groups is supported by the service it may be consumed by the application."
TransportDependency:
properties:
labels:
description: >-
Set of labels that allow to define groups of transport bindings. The
mechanism of the grouping is defined below this table.
items:
type: string
minItems: 1
type: array
serializers:
description: >-
Information about the serializers in this transport binding, as
defined in the SerializerType type in ETSI GS MEC 011 [i.4]. Support
for at least one of the entries is required in conjunction with the
transport.
items:
$ref: '#/components/schemas/SerializerType'
minItems: 1
type: array
transport:
$ref: '#/components/schemas/TransportDescriptor'
required:
- transport
- serializers
- labels
type: object
TransportDescriptor:
properties:
protocol:
description: >-
The name of the protocol used. Shall be set to "HTTP" for a REST
API.
type: string
security:
$ref: '#/components/schemas/SecurityInfo'
type:
$ref: '#/components/schemas/TransportType'
version:
description: The version of the protocol used.
type: string
required:
- type
- protocol
- version
- security
type: object
SerializerType:
title: SerializerType
enum:
- JSON
- XML
- PROTOBUF3
type: string
description: The enumeration represents types of serializers
examples:
- JSON
SecurityInfo:
title: SecurityInfo
type: object
properties:
oAuth2Info:
$ref: '#/components/schemas/SecurityInfo.OAuth2Info'
description: This type represents security information related to a transport
SecurityInfo.OAuth2Info:
title: SecurityInfo.OAuth2Info
required:
- grantTypes
- tokenEndpoint
type: object
properties:
grantTypes:
maxItems: 4
minItems: 1
type: array
items:
$ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantType'
description: List of supported OAuth 2.0 grant types.
tokenEndpoint:
type: string
description: The token endpoint
examples:
- /mecSerMgmtApi/security/TokenEndPoint
description: Parameters related to use of OAuth 2.0
SecurityInfo.OAuth2Info.GrantType:
title: SecurityInfo.OAuth2Info.GrantType
enum:
- OAUTH2_AUTHORIZATION_CODE
- OAUTH2_IMPLICIT_GRANT
- OAUTH2_RESOURCE_OWNER
- OAUTH2_CLIENT_CREDENTIALS
type: string
description: OAuth 2.0 grant type
examples:
- OAUTH2_CLIENT_CREDENTIALS
TransportType:
title: TransportType
enum:
- REST_HTTP
- MB_TOPIC_BASED
- MB_ROUTING
- MB_PUBSUB
- RPC
- RPC_STREAMING
- WEBSOCKET
type: string
description: The enumeration TransportType represents types of transports
examples:
- REST_HTTP
FeatureDependency:
properties:
featureName:
description: 'The name of the feature, for example, UserApps, UEIdentity, etc.'
type: string
version:
description: The version of the feature.
type: string
required:
- featureName
- version
type: object
AppProfile:
type: object
required:
- easId
- endPt
- acIds
- scheds
- permLvl
- easFeats
- svcContSupp
- appLocs
properties:
easId:
description: The identifier of the EAS
type: string
examples:
- appName
endPt:
description: The version of the feature.
oneOf:
- $ref: '#/components/schemas/EndPointInfo.Uris'
- $ref: '#/components/schemas/EndPointInfo.Fqdn'
- $ref: '#/components/schemas/EndPointInfo.Addresses'
- $ref: '#/components/schemas/EndPointInfo.Alternative'
acIds:
type: array
items:
type: string
minItems: 1
description: Identities of the Application Clients that can be served by the EAS
provId:
type: string
description: Identifier of the ASP that provides the EAS.
examples:
- appProvider1
type:
description: The category or type of EAS.
type: string
scheds:
type: array
items:
type: string
minItems: 1
description: The availability schedule of the EAS.
svcArea:
type: string
description: >-
The list of geographical and topological areas that the EAS serves.
ACs in the UE that are outside the area will not be served.
svcKpi:
type: string
description: Service characteristics provided by the EAS.
permLvl:
type: array
items:
type: string
minItems: 1
description: level of service permissions supported by the EAS.
easFeats:
type: array
items:
type: string
minItems: 1
description: Service features supported by the EAS.
svcContSupp:
type: array
items:
type: string
minItems: 1
description: The ACR scenarios supported by the EAS for service continuity.
appLocs:
type: array
items:
type: string
minItems: 1
description: >-
List of DNAI(s) and the N6 traffic information associated with the
EAS.
avlRep:
type: integer
description: >-
The period indicating to the EES, how often the EES needs to check
the EAS's availability after a successful registration.
contentEncoding: int32
examples:
- 1577836800
status:
type: string
description: 'EAS status information. '
requestBodies:
AppTerminationNotification:
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotification'