Newer
Older
"info": {
"title": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management",
"description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.",
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
"contact": {
"name": "ETSI Forge",
"url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api",
"email": "cti_support@etsi.org"
},
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"externalDocs": {
"description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v3.1.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/03.01.01_60/gs_MEC01002v030101p.pdf"
},
"tags": [
{
"name": "app-pkgm",
"description": "App Package management"
{
"name": "app-pkgm-notifications",
"description": "App Package management notifications"
}
],
"servers": [
{
"url": "https://localhost/app_pkgm/v1",
"paths": {
"/app_packages": {
"post": {
"summary": "Create a resource for on-boarding an application package to a MEO/MEAO",
"description": "Create a resource for on-boarding an application package to a MEO/MEAO",
"operationId": "app_packagesPOST",
"requestBody": {
"description": "Resource to be created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAppPkg"
"responses": {
"201": {
"description": "Successful response for resource creation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgInfo",
"description": "The response body shall contain a representation of the application package resource"
"summary": "Queries information relating to on-boarded application packages in the MEO/MEAO'",
"description": "queries information relating to on-boarded application packages in the MEO/MEAO",
"operationId": "app_packagesGET",
"name": "filter",
"in": "query",
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
{
"name": "all_fields",
"in": "query",
"description": "Include all complex attributes in the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
{
"name": "fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be included into the response",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
{
"name": "exclude_fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be excluded from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
{
"name": "exclude_default",
"in": "query",
"description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
],
"responses": {
"200": {
"description": "Contains a representation of the application package resource",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppPkgInfo"
"description": "Indicate the success of request. The response message content shall contain a list of representations of the \"individual application package\" resources that match the attribute filter"
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"/onboarded_app_packages": {
"post": {
"summary": "Create a resource for on-boarding an application package to a MEO/MEAO",
"description": "Create a resource for on-boarding an application package to a MEO/MEAO",
"operationId": "onboarded_app_packagesPOST",
"requestBody": {
"description": "Resource to be created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAppPkg"
}
"responses": {
"201": {
"description": "Successful response for resource creation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgInfo",
"description": "The response body shall contain a representation of the application package resource"
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"summary": "Queries information relating to on-boarded application packages in the MEO/MEAO'",
"description": "queries information relating to on-boarded application packages in the MEO/MEAO",
"operationId": "onboarded_app_packagesGET",
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
"name": "filter",
"in": "query",
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "all_fields",
"in": "query",
"description": "Include all complex attributes in the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be included into the response",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "exclude_fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be excluded from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "exclude_default",
"in": "query",
"description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Contains a representation of the application package resource",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppPkgInfo"
},
"description": "Indicate the success of request. The response body message content shall contain a list of representations of the \"individual application package\" resources that match the attribute filter."
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
},
"/app_packages/{appPkgId}": {
"get": {
"summary": "Queries the information related to individual application package resources",
"description": "Queries the information related to individual application package resources",
"operationId": "app_packageGET",
"parameters": [
{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an individual application package resource",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Contains a representation of the application package resource",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AppPkgInfo"
},
"description": "Indicates the success of request. The response message content shall contain a representation of the resource"
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"summary": "Deletes an individual application package resources in MEO/MEAO",
"description": "Deletes an individual application package resources in MEO/MEAO",
"operationId": "app_packageDELETE",
"parameters": [
{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an individual application package resource",
"required": true,
"style": "simple",
"schema": {
"type": "string"
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
"summary": "Updates the operational state of an individual application package resource",
"description": "Updates the operational state of an individual application package resources",
"operationId": "app_packagePATCH",
"parameters": [
{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an individual application package resource",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Parameters for application package information modification.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgInfoModifications"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Shows that the operation has been completed successfully",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AppPkgInfoModifications"
},
"description": "Shall be returned when the operation has been completed successfully."
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
"/onboarded_app_packages/{appPkgId}": {
"summary": "Queries the information related to individual application package resources",
"description": "Queries the information related to individual application package resources",
"operationId": "onboarded_app_packageGET",
"description": "Identifier of an individual application package resource",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Contains a representation of the application package resource",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AppPkgInfo"
},
"description": "Indicates the success of request. The response message content shall contain arepresentation of the resource."
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"summary": "Deletes an individual application package resources in MEO/MEAO",
"description": "Deletes an individual application package resources in MEO/MEAO",
"operationId": "onboarded_app_packageDELETE",
"description": "Identifier of an individual application package resource",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"headers": {},
"content": {}
},
"403": {
},
"404": {
"summary": "Updates the operational state of an individual application package resource",
"description": "Updates the operational state of an individual application package resources",
"operationId": "onboarded_app_packagePATCH",
"description": "Identifier of an individual application package resource",
"schema": {
"type": "string"
"requestBody": {
"description": "Parameters for application package information modification.",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AppPkgInfoModifications"
},
"description": "Shall be returned when the operation has been completed successfully."
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Shows that the operation has been completed successfully",
"$ref": "#/components/schemas/AppPkgInfoModifications"
},
"403": {
},
"404": {
"summary": "Subscribe to notifications about on-boarding an application package",
"description": "Subscribe to notifications about on-boarding an application package",
"operationId": "subscriptionsPOST",
"requestBody": {
"description": "The input parameters of subscribe operation to notifications",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgSubscription"
}
"responses": {
"201": {
"description": "Successful response for created subscription",
"$ref": "#/components/schemas/AppPkgSubscriptionInfo",
"descriprion": "Upon success, a response message contentrepresenting the created subscription shall bereturned."
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"callbacks": {
"notification": {
"{$request.body#/subscription.href}": {
"post": {
"summary": "Callback POST used to send a notification",
"description": " The notification is triggered when a new application package is onboarded",
"operationId": "notificationPOST",
"requestBody": {
"description": "Subscription notification",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgNotification"
}
}
}
},
"responses": {
"204": {
"description": "No content"
},
"404": {
"description": "Not found"
"summary": "used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO",
"description": "used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO package",
"operationId": "subscriptionsGET",
"responses": {
"200": {
"description": "List of zero or more subscriptions",
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgSubscriptionLinkList",
"description": "Upon success, a response message content containing a list of zero or more subscriptions shallbe returned."
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"/subscriptions/{subscriptionId}": {
"get": {
"summary": "Used to represent an individual subscription to notifications about application package changes.",
"description": "Used to represent an individual subscription to notifications about application package changes.",
"operationId": "individualSubscriptionGET",
"description": "Identifier of an individual subscription to notifications about application package changes",
"required": true,
"style": "simple",
"schema": {
"type": "string"
"responses": {
"200": {
"description": "a response body containing a representation of the resource shall be returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgSubscriptionInfo",
"descriprion": "Upon success, a response message content containing a representation of the resource shall be returned."
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"summary": "Deletes the individual subscription to notifications about application package changes in MEO or MEAO.",
"description": "Deletes the individual subscription to notifications about application package changes in MEO or MEAO.",
"operationId": "individualSubscriptionDELETE",
"description": "Identifier of an individual subscription to notifications about application package changes",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
"400": {
"$ref": "#/components/responses/400"
},
},
"403": {
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
},
"/app_packages/{appPkgId}/appd": {
"get": {
"summary": "Reads the content of the AppD of on-boarded individual application package resources.",
"description": "Reads the content of the AppD of on-boarded individual application package resources.",
"operationId": "appPkgIdGET",
"description": "Identifier of an on-boarded individual application package",
"required": true,
"style": "simple",
"schema": {
"type": "string"
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
},
{
"name": "filter",
"in": "query",
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "all_fields",
"in": "query",
"description": "Include all complex attributes in the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be included into the response",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "exclude_fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be excluded from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "exclude_default",
"in": "query",
"description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
"responses": {
"200": {
"description": "Content of the AppD is returned.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AppD",
"descriprion": "Indicates the success of request, and the content of the AppD is returned.The response message content shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.The \"Content-Type\" HTTP header shall be set according to the format of the returned file, which is selected according to \"Accept\" HTTP header options passed in the request."
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"/onboarded_app_packages/{appDId}/appd": {
"get": {
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
"summary": "Reads the content of the AppD of on-boarded individual application package resources.",
"description": "Reads the content of the AppD of on-boarded individual application package resources.",
"operationId": "appDGET",
"parameters": [
{
"name": "appDId",
"in": "path",
"description": "Identifier of an application descriptor",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "all_fields",
"in": "query",
"description": "Include all complex attributes in the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be included into the response",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "exclude_fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be excluded from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "exclude_default",
"in": "query",
"description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Content of the AppD is returned.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AppD",
"descriprion": "Indicates the success of request, and the content of the AppD is returned.The response message content shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.The \"Content-Type\" HTTP header shall be set according to the format of the returned file, which is selected according to \"Accept\" HTTP header options passed in the request."
"application/zip": {}
}
},
"deprecated": false
},
},
"/app_packages/{appPkgId}/package_content": {
"get": {
"summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"description": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"operationId": "appPkgGET",
"parameters": [
{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an on-boarded individual application package",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.",
"application/zip": {}
}
},
"206": {
"description": "On success, if the MEO or MEAO supports range requests, a single consecutive byte range from the content of the application package file shall be returned.",
"application/zip": {}
}
},
"deprecated": false
},
"put": {
"summary": "Uploads the content of application package.",
"description": "Uploads the content of application package.",
"operationId": "appPkgPUT",
"parameters": [
{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an on-boarded individual application package",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "The application package has been accepted for uploading, but the processing has not been completed.",
"headers": {},
"content": {}
}
},
"deprecated": false
},
},
"/onboarded_app_packages/{appDId}/package_content": {
"get": {
"summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"description": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"operationId": "appDIdGET",
"parameters": [
{
"name": "appDId",
"in": "path",
"description": "Identifier of an application descriptor",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.",
"headers": {},
"content": {}
},
"206": {
"description": "On success, if the MEO or MEAO supports range requests, a single consecutive byte range from the content of the application package file shall be returned.",
"headers": {},
"content": {}
}
},
"deprecated": false
},
"put": {
"summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"description": "Uploads the content of application package.",
"operationId": "appDIdPUT",
"parameters": [
{
"name": "appDId",
"in": "path",
"description": "Identifier of an application descriptor",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "The application package has been accepted for uploading, but the processing has not been completed.",
"headers": {},
"content": {}
}
},
"deprecated": false
},
},
"/user_defined_notification": {
"post": {
"summary": "Registers a notification endpoint to notify application package operations",
"description": "Registers a notification endpoint to notify application package operations",
"operationId": "app_pkg_notificationPOST",
"requestBody": {
"description": "Notification endpoint to be created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgNotification"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
"400": {
"$ref": "#/components/responses/400"
},
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
}
},
"components": {
"schemas": {
"AppD": {
"title": "AppD",
"required": [
"appDId",
"appDVersion",
"appDescription",
"appName",
"appProvider",
"appSoftVersion",
"mecVersion",
"swImageDescriptor",
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
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
"appExtCpd"
],
"type": "object",
"properties": {
"appDId": {
"type": "string",
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1."
},
"appDNSRule": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/DNSRuleDescriptor"
},
"description": "Describes DNS rules the MEC application requires."
},
"logicalNode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogicalNodeRequirements"
},
"description": "The logical node requirements. See note 6 and note 7."
},
"requestAdditionalCapabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestedAdditionalCapabilityData"
},
"description": "Specifies requirements for additional capabilities. These can be for a range of purposes. One example is acceleration related capabilities. See note 6 and note 7."
},
"mcioConstraintParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/McioConstraintParams"
},
"description": "The parameter names for constraints expected to be assigned to MCIOs realizing this application. For the associated semantical context of the values, refer to the description under the table 7.1.6.2.2-1 of ETSI GS NFV IFA 011 [1]. See note 7."
},
"appDVersion": {
"type": "string",
"description": "Identifies the version of the application descriptor."
},
"appDescription": {
"type": "string",
"description": "Human readable description of the MEC application."
},
"appExtCpd": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppExternalCpd"
},
"description": "Describes external interface(s) exposed by this MEC application. See note 4."
},
"appFeatureOptional": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/FeatureDependency"
},
"description": "Describes features a MEC application may use if available."
},
"appFeatureRequired": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/FeatureDependency"
},
"description": "Describes features a MEC application requires to run."
},
"appInfoName": {
"type": "string",
"description": "Human readable name for the MEC application."
},
"appLatency": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/LatencyDescriptor"
},
"appName": {
"type": "string",
"description": "Name to identify the MEC application."
},
"appProvider": {
"type": "string",
"description": "Provider of the application and of the AppD."
},
"appServiceOptional": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/ServiceDependency"
},
"description": "Describes services a MEC application may use if available."
},
"appServiceProduced": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/ServiceDescriptor"
},
"description": "Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps."
},
"appServiceRequired": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/ServiceDependency"
},
"description": "Describes services a MEC application requires to run."
},
"appSoftVersion": {
"type": "string",
"description": "Identifies the version of software of the MEC application."
},
"mciopId": {
"type": "string",
"description": "Identifies the MCIOP in the application package, used in containerized workload management, when the application is realized by a set of OS containers. See note 7."
},
"mcioIdentificationData": {
"type": "string",
"description": "Name and type of the Managed Container Infrastructure Object (MCIO) that realizes this application. It allows the VNFM to identify the MCIO e.g. when querying the Container Infrastructure Service Management (CISM). See note 7.",
"items": {
"$ref": "#/components/schemas/McioIdentificationData"
}
},
"appTrafficRule": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/TrafficRuleDescriptor"
},
"description": "Describes traffic rules the MEC application requires."
},
"changeAppInstanceStateOpConfig": {
"type": "string",
"description": "NFV"
},
"mecVersion": {
"type": "array",
"items": {
"type": "string"
},
"description": "Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD. The value shall be formatted as comma-separated list of strings. Each entry shall have the format <x>.<y>.<z> where <x>, <y> and <z> are decimal numbers representing the version of the present document. Whitespace between list entries shall be trimmed before validation."
},
"swImageDescriptor": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SwImageDescriptor"
},
"description": "Describes the descriptors of the software image to be used by the virtualisation container used to realize this MEC application. See note 5."
},
"terminateAppInstanceOpConfig": {
"type": "string",
"description": "NFV"
},
"transportDependencies": {
"type": "object",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/TransportDependency"
},
"description": "Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. See note 2."
},
"virtualComputeDescriptor": {
"description": "Describes CPU and memory requirements, as well as optional additional requirements, such as disk and acceleration related capabilities, of the single VM used to realize this MEC application. See note 5.",
"type": "object",
"items": {
"$ref": "#/components/schemas/VirtualComputeDescriptor"
}
},
"osContainerDescriptor": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OsContainerDescriptor"
},
"description": "Describes CPU, memory requirements and limits, and software images of the OS Containers realizing this MEC application corresponding to OS Containers sharing the same host and same network namespace. See note 5 and note 7."
}
},
"description": "NOTE 1: The appDId shall be used as the unique identifier of the application package that contains this AppD.\nNOTE 2: This attribute indicates groups of transport bindings which a service-producing MEC application requires to \n be supported by the platform in order to be able to produce its services. At least one of the indicated groups \n needs to be supported to fulfil the requirements.\nNOTE 3: The support of application descriptor containing descriptions of multiple virtualisation containers and/or \n application software images is out of scope of the present document.\nNOTE 4: External interfaces are used to connect to e.g. other MEC applications, MEC services, UEs and also MEC \n platform and OSS.\nNOTE 5: Only one of virtualComputeDescriptor or osContainerDescriptor shall be present. If virtualComputeDescriptor \n presents, only a single swImageDescriptor shall be provided. \nNOTE 6: If the AppD includes virtualComputeDesc, then logicalNode and requestedAdditionalCapabilites shall not be \n present.\nNOTE 7: This attribute reflects the ETSI NFV interpretation of the cloud native workloads. \n"
},
"SwImageDescriptor": {
"type": "object",
"required": ["id", "name", "version", "containerFormat", "swImage"],
"properties": {
"id": {
"type": "string",
"description": "The identifier of this software image."
},
"name": {
"type": "string",
"description": "The name of this software image."
},
"version": {
"type": "string",
"items": {
"$ref": "#/components/schemas/Version"
},
"description": "The version of this software image."
},
"checksum": {
"$ref": "#/components/schemas/ChecksumData",
"description": "The checksum of the software image file. See note 3."
},
"containerFormat": {
"type": "string",
"description": "The container format describes the container file format in which software image is provided."
},
"diskFormat": {
"type": "string",
"description": "The disk format of a software image is the format of the underlying disk image. See note 1."
},
"minDisk": {
"type": "number",
"description": "The minimal disk size requirement for this software image. See note 1."
},
"minRam": {
"type": "number",
"description": "The minimal RAM requirement for this software image. See note 2."
},
"size": {
"type": "number",
"description": "The size of this software image file. See note 3."
},
"swImage": {
"type": "object",
"items": {
"$ref": "#/components/schemas/SwImageDesc"
},
"description": "A reference to the actual software image."
},
"operatingSystem": {
"type": "string",
"description": "Specifies the operating system used in the software image."
},
"supportedVirtualisationEnvironment": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the virtualisation environments (e.g. hypervisor) compatible with this software image."
}
},
"description": "NOTE 1: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise. \nNOTE 2: The attribute may be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise. \nNOTE 3: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and may be present otherwise. \n"
},
"Version": {
"type": "object",
"required": ["srcVnfdId", "dstVnfdId", "srcFlavourId"],
"properties": {
"srcVnfdId": {
"type": "string",
"description": "Identifier of the source VNFD and the source VNF package. See note 1."
},
"dstVnfdId": {
"type": "string",
"description": "Identifier of the destination VNFD and the destination VNF package. See note 1."
},
"srcFlavourId": {
"type": "string",
"description": "Identifier of the deployment flavour in the source VNF package for which this modification applies. See note 2."
}
},
"description": "NOTE 1: Either the srcVnfdId or the dstVnfdId shall be equal to the vnfdId of the VNFD containing this version selector. \nNOTE 2: It is up to protocol design stage to decide whether there is further optimization potential to apply one modification for multiple srcFlavourIds.\n"
},
"McioConstraintParams": {
"title": "McioConstraintParams",
"enum": [
"localAffinityCisNode",
"nodeAdditionalCapabilitySsd",
"nodeAdditionalCapabilityDpdk",
"nodeAdditionalCapabilitySriov",
"nodeAdditionalCapabilityGpu",
"nodeAdditionalCapabilityFpga",
"nodeAdditionalCapabilityCpuPin",
"nodeCapabilityLogicalNuma",
"nodePool"
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
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
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
"type": "string",
"description": "The parameter names for constraints expected to be assigned to MCIOs realizing this application.The value specifies the standardized \nsemantical context of the MCIO constraints and the parameter names for the MCIO constraints in the MCIO declarative descriptor.The mcioConstraintParams\nattribute shall have one of the following values, expressing the associated semantical context.. For the associated semantical context of the values,\nrefer to the description under the table 7.1.6.2.2-1 of ETSI GS NFV IFA 011 [1].\n"
},
"McioIdentificationData": {
"type": "object",
"required": ["name", "type"],
"properties": {
"name": {
"type": "string",
"description": "The name of the mcio. See note 1."
},
"type": {
"type": "string",
"description": "The type of the mcio. See note 2."
}
},
"description": "NOTE 1: When the container infrastructure service is a Kubernetes® instance it is the value of the 'metadata.name' \n field in Kubernetes® manifest. \nNOTE 2: When the container infrastructure service is a Kubernetes® instance it is the value of the 'kind' field in \n Kubernetes® manifest. \n"
},
"OsContainerDescriptor": {
"title": "OsContainerDescriptor",
"type": "object",
"required": ["osContainerDescId", "name", "description", "swImageDesc"],
"properties": {
"osContainerDescId": {
"type": "string",
"description": "Unique identifier of this OsContainerDesc in the VNFD."
},
"name": {
"type": "string",
"description": "Human readable name of this OS container."
},
"description": {
"type": "string",
"description": "Human readable description of this OS container."
},
"requestedCpuResources": {
"type": "integer",
"description": "Number of CPU resources requested for the container (e.g. in milli-CPU-s)."
},
"requestedMemoryResources": {
"type": "number",
"description": "Amount of memory resources requested for the container (e.g. in MB)."
},
"requestedEphemeralStorageResources": {
"type": "number",
"description": "Size of ephemeral storage resources requested for the container (e.g. in GB)."
},
"extendedResourceRequests": {
"type": "array",
"items": {
"type": "object",
"description": "An array of key-value pairs of extended resources required by the container see note."
}
},
"additionalProperties": {
"type": "string",
"description": "See note."
},
"cpuResourceLimit": {
"type": "integer",
"description": "Number of CPU resources the container can maximally use (e.g. in milli-CPU)."
},
"memoryResourceLimit": {
"type": "number",
"description": "Amount of memory resources the container can maximally use (e.g. in MB)."
},
"ephemeralStorageResourceLimit": {
"type": "number",
"description": "Size of ephemeral storage resources the container can maximally use (e.g. in GB)."
},
"hugePageResources": {
"type": "object",
"description": "Specifies HugePages resources requested for the container, which the container can maximally use.",
"additionalProperties": {
"type": "string"
}
},
"cpuPinningRequirements": {
"$ref": "#/components/schemas/VirtualCpuPinningData",
"description": "Requirements for CPU pinning configuration for this OS container."
},
"swImageDesc": {
"$ref": "#/components/schemas/SwImageDesc",
"description": "Describes the software image realizing this OS container."
},
"bootData": {
"type": "string",
"description": "Contains a string or a URL to a file contained in the VNF package used to customize a container resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent."
},
"monitoringParameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonitoringParameter"
},
"description": "Specifies the virtualized resource related performance metrics on the OsContainerDesc level to be tracked by the VNFM."
}
},
"description": "NOTE: Extended resources are to describe any type of resource provided by the container infrastructure. One \n example implementation of extended resources is \"Extended Resources\" in case the container infrastructure \n service is a Kubernetes® instance. \n"
},
"MonitoringParameter": {
"type": "object",
"required": ["monitoringParameterId", "performanceMetric"],
"properties": {
"monitoringParameterId": {
"type": "string",
"description": "Unique identifier of the monitoring parameter."
},
"name": {
"type": "string",
"description": "Human readable name of the monitoring parameter."
},
"performanceMetric": {
"type": "string",
"description": "Specifies the virtualised resource performance metric."
},
"collectionPeriod": {
"type": "string",
"description": "An attribute that describes the periodicity at which to collect the performance information."
}
}
},
"VirtualComputeDescriptor": {
"title": "VirtualComputeDescriptor",
"type": "object",
"required": ["virtualComputeDescId", "virtualMemory", "virtualCpu"],
"properties": {
"virtualComputeDescId": {
"type": "string",
"description": "Unique identifier of this VirtualComputeDesc in the VNFD."
},
"logicalNode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogicalNodeRequirements"
}
},
"requestAdditionalCapabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestedAdditionalCapabilityData"
}
},
"computeRequirements": {
"description": "Specifies compute requirements.",
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
"type": "array",
"items": {
"type": "string",
"format": "not-specified"
}
},
"virtualMemory": {
"$ref": "#/components/schemas/VirtualMemoryData"
},
"virtualCpu": {
"$ref": "#/components/schemas/VirtualCpuData"
},
"virtualDisk": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlockStorageData"
}
}
}
},
"VirtualCpuData": {
"type": "object",
"required": ["numVirtualCpu"],
"properties": {
"cpuArchitecture": {
"type": "string",
"description": "CPU architecture type. Examples are x86, ARM."
},
"numVirtualCpu": {
"type": "integer",
"description": "Number of virtual CPUs."
},
"virtualCpuClock": {
"type": "number",
"description": "Minimum virtual CPU clock rate (e.g. in MHz)."
},
"virtualCpuOversubscriptionPolicy": {
"type": "string",
"description": "The CPU core oversubscription policy, e.g. the relation of virtual CPU cores to physical CPU cores/threads."
},
"vduCpuRequirements": {
"type": "array",
"items": {
"type": "object",
"description": "Array of key-value pair requirements on the Compute (CPU) for the VDU."
}
},
"virtualCpuPinning": {
"$ref": "#/components/schemas/VirtualCpuPinningData"
}
}
},
"BlockStorageData": {
"properties": {
"sizeOfStorage": {
"type": "number",
"description": "Size of virtualised storage resource in GB."
"type": "object",
"description": "An array of key-value pairs that articulate the storage deployment requirements."
"description": "Array of key-value pair requirements on the storage for the VDU."
"rdmaEnabled": {
"type": "boolean",
"description": "Indicate if the storage support RDMA."
},
"swImageDesc": {
"$ref": "#/components/schemas/SwImageDesc",
"description": "References the software image to be loaded on the VirtualStorage resource created based on this VirtualStorageDesc. Shall be absent when used for virtual disks. See note."
}
},
"description": "NOTE: This attribute shall not be present in a VirtualStorageDesc used in a VDU realized by one or a set of OS containers\n"
},
"SwImageDesc": {
"type": "object",
"required": ["id", "name", "version", "containerFormat", "swImage"],
"properties": {
"id": {
"type": "string",
"description": "The identifier of this software image."
"type": "string",
"description": "The name of this software image."
"version": {
"type": "string",
"description": "The version of this software image."
"checksum": {
"$ref": "#/components/schemas/ChecksumData",
"description": "The checksum of the software image file. See note 3"
"containerFormat": {
"type": "string",
"description": "The container format describes the container file format in which software image is provided."
"type": "string",
"description": "The disk format of a software image is the format of the underlying disk image. See note 1"
"minDisk": {
"type": "number",
"description": "The minimal disk size requirement for this software image. The value of the \"size of storage\" attribute of the VirtualStorageDesc referencing this SwImageDesc shall not be smaller than the value of minDisk. See note 1"
"minRam": {
"type": "number",
"description": "The minimal RAM requirement for this software image. The value of the \"size\" attribute of VirtualMemoryData of the Vdu referencing this SwImageDesc shall not be smaller than the value of minRam. See note 2"
"size": {
"type": "number",
"description": "The size of this software image file. See note 3"
},
"swImage": {
"$ref": "#/components/schemas/SwImageDesc",
"description": "This is a reference to the actual software image. The reference can be relative to the root of the VNF Package or can be a URL."
},
"operatingSystem": {
"type": "string",
"description": "Specifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used."
"supportedVirtualisationEnvironment": {
"description": "Specifies the virtualisation environments (e.g. hypervisor) compatible with this software image."
}
},
"description": "NOTE 1: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise. \nNOTE 2: The attribute may be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise. \nNOTE 3: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and may be present otherwise. \n"
},
"ChecksumData": {
"type": "object",
"required": ["algorithm", "hash"],
"properties": {
"algorithm": {
"type": "string",
"description": "Specifies the algorithm used to obtain the checksum value see note."
"hash": {
"type": "string",
"description": "Contains the result of applying the algorithm indicated by the algorithm attribute to the data to which this ChecksumData refers."
}
},
"description": "NOTE: The algorithm attribute value shall be one of the Hash Function Textual Names present in [2]. \n"
},
"VirtualCpuPinningData": {
"type": "object",
"properties": {
"virtualCpuPinningPolicy": {
"type": "string",
"description": "Indicates the policy for CPU pinning.",
"enum": ["STATIC", "DYNAMIC"]
"description": "List of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of \"STATIC\" virtualCpuPinningPolicy."
}
}
},
"VirtualMemoryData": {
"type": "object",
"required": ["virtualMemSize"],
"properties": {
"virtualMemSize": {
"type": "number",
"description": "Amount of virtual memory in MB."
"virtualMemOversubscriptionPolicy": {
"description": "The memory core oversubscription policy in terms of virtual memory to physical memory on the platform."
"$ref": "#/components/schemas/KeyValuePair"
"description": "Array of key-value pair requirements on the memory for the VDU."
"numaEnabled": {
"type": "boolean",
"description": "Specifies the memory allocation to be cognisant of the relevant process/core allocation."
},
"hugePagesRequirements": {
"description": "Specifies requirements on the huge pages resources for the virtual memory."
}
}
},
"RequestedAdditionalCapabilityData": {
"type": "object",
"required": [
"requestedAdditionalCapabilityName",
"supportMandatory",
"targetPerformanceParameters"
],
"properties": {
"requestedAdditionalCapabilityName": {
"description": "Specifies a requested additional capability for the VDU"
"supportMandatory": {
"type": "boolean",
"description": "Indicates whether the requested additional capability is mandatory for successful operation"
"minRequestedAdditionalCapabilityVersion": {
"description": "Specifies the minimum version of the requested additional capability"
"preferredRequestedAdditionalCapabilityVersion": {
"description": "Specifies the preferred version of the requested additional capability"
"$ref": "#/components/schemas/KeyValuePair"
}
}
}
},
"KeyValuePair": {
"type": "object",
"properties": {
"key": {
"type": "string"
"value": {
"type": "string"
}
}
},
"LogicalNodeRequirements": {
"type": "object",
"required": ["id"],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Identifies this set of logical node requirements"
"type": "array",
"description": "The logical node-level compute, memory and I/O requirements. An array of key-value pairs that articulate the deployment requirements. This could include the number of CPU cores on this logical node, a memory configuration specific to a logical node (e.g. such as available in the Linux kernel via the libnuma library) or a requirement related to the association of an I/O device with the logical node. \n",
"type": "string",
"format": "not-specified"
}
}
},
"AppExternalCpd": {
"title": "AppExternalCpd",
"type": "object",
"properties": {
"inherited_attributes": {
"type": "object",
"description": "All attributes inherited from Cpd. See note 2."
},
"virtualNetworkInterfaceRequirements": {
"type": "array",
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
"$ref": "#/components/schemas/VirtualNetworkInterfaceRequirements"
},
"description": "Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD. See note 1."
},
"additionalServiceData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalServiceData"
},
"description": "Additional service identification data of the external CP. For the definition of AdditionalServiceData, refer to clause 7.1.18.3 of ETSI GS NFV IFA 011 [1]."
}
},
"description": "NOTE 1: An AppD conformant to the present document shall not specify \"virtualNetworkInterfaceRequirements\" in AppExternalCpd corresponding to primary container cluster network interfaces.\nNOTE 2: For CPs exposed by MEC Applications realized only by one or set of OS containers and used by the OS containers to connect to the primary container cluster external network, the ability to configure virtualised \n resources based on cpRole and trunkMode attributes might not be supported by all container technologies.\n"
},
"AdditionalServiceData": {
"type": "object",
"required": ["portData"],
"properties": {
"portData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServicePortData"
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
"minItems": 1
},
"serviceData": {
"type": "object",
"description": "Service matching information exposed by the VirtualCp. See note."
}
},
"description": "NOTE: This attribute shall only be present if additional information is needed to identify the service termination within \n the VNF, such as for example a url path information in an HTTP request required to allow a single VirtualCp IP \n address to be used for several HTTP based services that use the same portnumber. \n"
},
"ServicePortData": {
"type": "object",
"required": ["name", "protocol", "port", "portConfigurable"],
"properties": {
"name": {
"type": "string",
"description": "The name of the port exposed by the VirtualCp."
},
"protocol": {
"type": "string",
"enum": ["TCP", "UDP", "SCTP"],
"description": "The L4 protocol for this port exposed by the VirtualCp."
},
"port": {
"type": "integer",
"description": "The L4 port number exposed by the VirtualCp."
},
"portConfigurable": {
"type": "boolean",
"description": "Specifies whether the port attribute value is allowed to be configurable."
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
"VirtualNetworkInterfaceRequirements": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provides a human readable name for the requirement."
},
"description": {
"type": "string",
"description": "Provides a human readable description of the requirement."
},
"standardizedNetworkInterfaceRequirements": {
"type": "string",
"description": "The requirements on standardized network interface capabilities, e.g. SR-IOV or secondary container cluster network interface deployment requirements.See note"
},
"networkInterfaceRequirements": {
"type": "string",
"description": "The additional network interface requirements beyond those specified in the standardizedNetworkInterfaceRequirements attribute.An element from an array of key-value pairs that articulate the network interface deployment requirements.See note."
},
"nicIoRequirements": {
"items": {
"$ref": "#/components/schemas/LogicalNodeRequirements"
},
"description": "This references (couples) the CPD with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CPD.See note"
}
},
"description": "NOTE: At least one of the attributes \"standardizedNetworkInterfaceRequirements\", \"networkInterfaceRequirements\", \"nicIoRequirements\" shall be present\n"
},
"AppPkgInfo": {
"required": [
"id",
"appDId",
"appName",
"appSoftwareVersion",
"appDVersion",
"checksum",
"softwareImages",
"onboardingState",
"operationalState",
"usageState",
"_links"
],
"properties": {
"id": {
"type": "string",
"description": "Identifier of the onboarded application package."
},
"appDId": {
"type": "string",
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique."
},
"appProvider": {
"type": "string",
"description": "Provider of the application and of the AppD."
},
"appName": {
"type": "string",
"description": "Name to identify the MEC application."
},
"appSoftwareVersion": {
"type": "string",
"description": "Software version of the application. This is updated when there is any change to the software in the onboarded application package."
},
"appDVersion": {
"type": "string",
"description": "Identifies the version of the application descriptor."
},
"checksum": {
"$ref": "#/components/schemas/Checksum"
},
"signingCertificate": {
"type": "string",
"description": "The singleton signing certificate if it is included as a file in the AppD archive."
},
"softwareImages": {
"description": "Information of application software image in application package. Type is TBD. See note 1.",
"type": "array",
"items": {
"type": "string",
"format": "not-specified"
}
},
"additionalArtifacts": {
"description": "Additional information of application package artifacts that are not application \nsoftware images. Type is TBD. See note 2.\n",
"type": "array",
"items": {
"type": "string",
"format": "not-specified"
}
},
"onboardingState": {
"$ref": "#/components/schemas/OnboardingState"
},
"operationalState": {
"$ref": "#/components/schemas/AppPkg.OperationalState"
},
"usageState": {
"$ref": "#/components/schemas/UsageState"
},
"mecInfo": {
"type": "array",
"description": "The MEC version that compatible with this application. This information is copied from the AppD.",
"items": {
"type": "string"
}
},
"onBoardingFailureDetails": {
"description": "Failure details of current onboarding procedure",
"$ref": "#/components/schemas/ProblemDetails"
},
"userDefinedData": {
"$ref": "#/components/schemas/KeyValuePairs",
"description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
},
"_links": {
"$ref": "#/components/schemas/AppPkgInfo.links"
}
"description": "The data type AppPkgInfo represents the parameters for an application package resource\nNOTE 1: The data type of application software image information data model is related to virtualisation method and \n needs for further study.\nNOTE 2: The data type of additional information of application package artifacts is not specified in the present \n document.\nNOTE 3: This attribute applies only for the MEAO\n"
},
"AppPkgInfoModifications": {
"properties": {
"operationState": {
"$ref": "#/components/schemas/OperationState"
},
"description": "'The data type represents the operational state for an application package resource'"
},
"AppPkg.OperationalState": {
"type": "string",
"description": "Operational state of the onboarded application package: •ENABLED: the application package can be used for instantiation of new application instances. •DISABLED: the application package cannot be used for further application instantiation requests.",
},
"OnboardingState": {
"enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"],
"type": "string",
"description": "Onboarding state of application package",
},
"UsageState": {
"type": "string",
"description": "Usage state of the onboarded instance of the application package",
},
"AppPkgInfo.links": {
"required": ["self", "appD", "appPkgContent"],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"appD": {
"$ref": "#/components/schemas/LinkType"
},
"appPkgContent": {
"$ref": "#/components/schemas/LinkType"
},
"vnfPkgInfo": {
"$ref": "#/components/schemas/LinkType"
},
"description": "Links to resources related to this resource."
},
"AppPkgNotification": {
"required": [
"id",
"notificationType",
"subscriptionId",
"timeStamp",
"appPkgId",
"appDId",
"operationalState",
"_links"
],
"properties": {
"id": {
"description": "Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the \"notificationId\" attribute of all these notifications shall have the same value."
},
"notificationType": {
"$ref": "#/components/schemas/AppPkg.NotificationType"
},
"subscriptionId": {
"type": "string",
"description": "Identifier of the subscription related to this notification."
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"appPkgId": {
"type": "string",
"description": "Identifier of the onboarded application package."
},
"appDId": {
"type": "string",
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique."
},
"operationalState": {
"$ref": "#/components/schemas/OperationalState"
},
"_links": {
"$ref": "#/components/schemas/AppPkgNotification.links"
}
},
"description": "'This data type represents an application package management notification for informing the subscribers about onboarding application package resources. The notification is triggered when a new application package is onboarded'"
},
"AppPkg.NotificationType": {
"enum": [
"AppPackageOnBoarded",
"AppPacakgeEnabled",
"AppPacakgeDisabled",
"AppPackageDeleted"
],
"type": "string",
"description": "Discriminator for the different notification types",
},
"AppPkgNotification.links": {
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "Links to resources related to this resource."
},
"AppPkgSubscriptionInfo": {
"required": ["id", "subscriptionType", "callbackUri", "_links"],
"properties": {
"id": {
"description": "Identifier of the subscription to application package notification."
},
"subscriptionType": {
"description": "Type of subscription.",
"$ref": "#/components/schemas/AppPkgSubscriptionType"
},
"callbackUri": {
"type": "string",
"description": "The URI of the endpoint for the notification to be sent to."
},
"_links": {
"$ref": "#/components/schemas/AppPkgSubscriptionInfo.links"
}
},
"description": "'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package'"
"AppPkgSubscriptionType": {
"title": "AppPkgSubscriptionType",
"AppPackageOnBoardingSubscription",
"AppPackageChangeSubscription",
"AppPackageDeletionSubscription"
"description": "type of a subscription.",
"examples": ["AppPackageOnBoardingSubscription"]
},
"AppPkgSubscriptionInfo.links": {
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "Links to resources related to this resource."
},
"AppPkgSubscriptionLinkList": {
"properties": {
"_links": {
"$ref": "#/components/schemas/AppPkgSubscriptionLinkList.links"
}
},
"description": "'The data type represents a subscription link list of notification on application package management'"
},
"AppPkgSubscriptionLinkList.links": {
"title": "AppPkgSubscriptionLinkList.links",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscriptions.AppPkgSubscription"
},
"description": "Links to resources related to this resource."
},
"Subscriptions.AppPkgSubscription": {
"title": "Subscriptions.AppPkgSubscription",
"required": ["href", "subscriptionType"],
"properties": {
"href": {
"type": "string",
"description": "The URI referring to the subscription."
"subscriptionType": {
"$ref": "#/components/schemas/AppPkgSubscriptionType"
},
"description": "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'"
},
"AppPkgSubscription": {
"required": ["callbackUri", "subscriptionType"],
"properties": {
"callbackUri": {
"type": "string",
"description": "The URI of the endpoint for the notification to be sent to."
"subscriptionType": {
"$ref": "#/components/schemas/AppPkgSubscriptionType"
},
"appPkgFilter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppPkgFilter"
"description": "The attribute-based filter is to filter application packages on which the query applies"
},
"description": "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'"
"AppPkgFilter": {
"title": "AppPkgFilter",
"type": "object",
"properties": {
"appPkgInfoId": {
"type": "string",
"description": "Match the application package identifier which is allocated by the MEO. The attributes \"appPkgInfoId \", and \"appDId\" are alternatives to reference particular application package in a filter. see note."
},
"appDId": {
"type": "string",
"description": "Match the application descriptor identifier which is allocated by the application provider. The attributes \"appPkgInfoId \", and \"appDId\" are alternatives to reference particular application package in a filter. See note."
},
"appProvider": {
"type": "string",
"description": "Match the provider's name of the onboarded application."
},
"appName": {
"type": "string",
"description": "Match the name of the onboarded application."
},
"appSoftwareVersion": {
"type": "string",
"description": "Match the software version of the application package."
},
"appDVersion": {
"type": "string",
"description": "Match the version of the application descriptor."
},
"operationalState": {
"type": "string",
"description": "Match particular operational state of the application package. May be present if the \"subscriptionType\" attribute contains the value \"AppPackageChangeSubscription\", and shall be absent otherwise.",
},
"usageState": {
"type": "string",
"description": "Match particular usage state of the application package. May be present if the \"subscriptionType\" attribute contains the value \"AppPackageChangeSubscription\", and shall be absent otherwise.",
},
"description": "NOTE: The attributes \"appPkgInfoId \", and \"appDId\" are alternatives to reference particular application package in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n"
},
"Checksum": {
"properties": {
"algorithm": {
"type": "string",
"description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512."
},
"hash": {
"type": "string",
"description": "'String 1 The hexadecimal value of the checksum'"
},
"CreateAppPkg": {
"required": ["appPkgName", "appPkgPath", "appPkgVersion", "checksum"],
"properties": {
"appPkgName": {
"type": "string",
"description": "Name of the application package to be onboarded."
},
"appPkgPath": {
"format": "uri",
"description": "Address information of the application package. See note."
},
"appPkgVersion": {
"type": "string",
"description": "Version of the application package to be onboarded.The appPkgName with appPkgVersion can be used to uniquely identify the application package."
},
"appProvider": {
"type": "string",
"description": "The provider's name of the application package to be onboarded."
},
"checksum": {
"$ref": "#/components/schemas/Checksum"
},
"userDefinedData": {
"$ref": "#/components/schemas/KeyValuePairs",
"description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
},
"description": "NOTE: It is for further study how to convey appPkgPath, and align with ETSI GS NFV-SOL 005 [i.7].\n"
"additionalProperties": {
"type": "object"
}
},
"LinkType": {
"title": "LinkType",
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource"
},
"ProblemDetails": {
"title": "ProblemDetails",
"type": "object",
"properties": {
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem"
},
"instance": {
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem"
},
"status": {
"type": "integer",
"description": "The HTTP status code for this occurrence of the problem",
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type"
},
"type": {
"type": "string",
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
},
"TimeStamp": {
"required": ["nanoSeconds", "seconds"],
"properties": {
"nanoSeconds": {
"type": "integer",
"description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
},
"seconds": {
"type": "integer",
"description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"format": "int32"
"OperationalState": {
"title": "OperationalState",
"OperationState": {
"title": "OperationState",
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
"examples": ["DISABLED"]
}
},
"responses": {
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests: used when a rate limiter has triggered.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}