Newer
Older
"info": {
"title": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management",
"version": "2.1.1",
"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",
"email": "cti_support@etsi.org",
"url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api"
}
},
"externalDocs": {
"description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf"
},
"servers": [
{
"url": "https://localhost/app_pkgm/v1"
}
],
"openapi": "3.0.0",
"tags": [
{
"name": "app-pkgm",
"description": "App Package management"
{
"name": "app-pkgm-notifications",
"description": "App Package management notifications"
}
],
"paths": {
"/app_packages": {
"post": {
"tags": [
"app-pkgm"
],
"summary": "Create a resource for on-boarding an application package to a MEO",
"description": "Create a resource for on-boarding an application package to a MEO",
"operationId": "app_packagesPOST",
"requestBody": {
"description": "Resource to be created",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAppPkg"
"responses": {
"201": {
"description": "Successful response for resource creation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppPkgInfo"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
"get": {
"tags": [
"app-pkgm"
],
"summary": "Queries information relating to on-boarded application packages in the MEO",
"description": "queries information relating to on-boarded application packages in the MEO",
"operationId": "app_packagesGET",
"in": "query",
"name": "filter",
"schema": {
"type": "string"
},
"required": false,
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009"
},
{
"in": "query",
"name": "all_fields",
"schema": {
"type": "string"
"required": false,
"description": "Include all complex attributes in the response."
},
{
"in": "query",
"name": "fields",
"schema": {
"type": "string"
"required": false,
"description": "Complex attributes of AppPkgInfo to be included into the response"
},
{
"in": "query",
"name": "exclude_fields",
"schema": {
"type": "string"
"required": false,
"description": "Complex attributes of AppPkgInfo to be excluded from the response."
},
{
"in": "query",
"name": "exclude_default",
"schema": {
"type": "string"
"required": false,
"description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response."
],
"responses": {
"200": {
"description": "Contains a representation of the application package resource",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppPkgInfo"
}
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/app_packages/{appPkgId}": {
"parameters": [
{
"in": "path",
"name": "appPkgId",
"schema": {
"type": "string"
},
"required": true,
"description": "Identifier of an individual application package resource"
}
],
"get": {
"tags": [
"app-pkgm"
],
"summary": "Queries the information related to individual application package resources",
"description": "Queries the information related to individual application package resources",
"operationId": "app_packageGET",
"responses": {
"200": {
"description": "Contains a representation of the application package resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgInfo"
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"delete": {
"tags": [
"app-pkgm"
],
"summary": "Deletes an individual application package resources",
"description": "Deletes an individual application package resources",
"operationId": "app_packageDELETE",
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
"patch": {
"tags": [
"app-pkgm"
],
"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",
"requestBody": {
"description": "Operational state to be set",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgInfoModifications"
}
}
}
},
"responses": {
"200": {
"description": "Shows that the operation has been completed successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgInfoModifications"
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"409": {
"$ref": "#/components/responses/409"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/subscriptions": {
"post": {
"tags": [
"app-pkgm"
],
"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",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgSubscription"
"responses": {
"201": {
"description": "Successful response for created subscription",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgSubscriptionInfo"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
"get": {
"tags": [
"app-pkgm"
"summary": "used to retrieve the information of subscriptions to individual application package resource in MEO",
"description": "used to retrieve the information of subscriptions to individual application package resource in MEO package",
"operationId": "subscriptionsGET",
"responses": {
"200": {
"description": "List of zero or more subscriptions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgSubscriptionLinkList"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"/subscriptions/{subscriptionId}": {
"parameters": [
{
"in": "path",
"name": "subscriptionId",
"schema": {
"type": "string"
},
"description": "Identifier of an individual subscription to notifications about application package changes",
"required": true
}
],
"get": {
"tags": [
"app-pkgm"
],
"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",
"responses": {
"200": {
"description": "Representation of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgSubscriptionInfo"
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
"delete": {
"tags": [
"app-pkgm"
],
"summary": "Deletes the individual subscription to notifications about application package changes in MEO.",
"description": "Deletes the individual subscription to notifications about application package changes in MEO.",
"operationId": "individualSubscriptionDELETE",
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/user_defined_notification": {
"post": {
"tags": [
"app-pkgm-notifications"
],
"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",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgNotification"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/app_packages/{appPkgId}/appd": {
"parameters": [
{
"in": "path",
"name": "appPkgId",
"schema": {
"type": "string"
},
"description": "Identifier of an on-boarded individual application package",
"required": true
}
],
"get": {
"tags": [
"app-pkgm"
],
"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",
"in": "query",
"name": "filter",
"schema": {
"type": "string"
},
"required": false,
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009"
},
"in": "query",
"name": "all_fields",
"schema": {
"type": "string"
},
"required": false,
"description": "Include all complex attributes in the response."
},
{
"in": "query",
"name": "fields",
"schema": {
"type": "string"
"required": false,
"description": "Complex attributes of AppPkgInfo to be included into the response"
},
{
"in": "query",
"name": "exclude_fields",
"schema": {
"type": "string"
"required": false,
"description": "Complex attributes of AppPkgInfo to be excluded from the response."
},
"in": "query",
"name": "exclude_default",
"schema": {
"type": "string"
},
"required": false,
"description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response."
"responses": {
"200": {
"description": "Content of the AppD is returned.",
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AppD"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/AppD"
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"/onboarded_app_packages/{appDId}/appd": {
"parameters": [
{
"in": "path",
"name": "appDId",
"schema": {
"type": "string"
},
"description": "Identifier of an application descriptor",
"required": true
}
],
"get": {
"tags": [
"app-pkgm"
],
"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",
"in": "query",
"name": "filter",
"required": false,
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009"
},
{
"in": "query",
"name": "all_fields",
"schema": {
"type": "string"
"required": false,
"description": "Include all complex attributes in the response."
},
{
"in": "query",
"name": "fields",
"schema": {
"type": "string"
"required": false,
"description": "Complex attributes of AppPkgInfo to be included into the response"
},
{
"in": "query",
"name": "exclude_fields",
"schema": {
"type": "string"
"required": false,
"description": "Complex attributes of AppPkgInfo to be excluded from the response."
},
{
"in": "query",
"name": "exclude_default",
"schema": {
"type": "string"
"required": false,
"description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response."
],
"responses": {
"200": {
"description": "Content of the AppD is returned.",
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AppD"
}
},
"$ref": "#/components/schemas/AppD"
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
"/app_packages/{appPkgId}/package_content": {
"parameters": [
{
"in": "path",
"name": "appPkgId",
"schema": {
"type": "string"
"description": "Identifier of an on-boarded individual application package",
"required": true
}
],
"get": {
"tags": [
"app-pkgm"
],
"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",
"responses": {
"200": {
"$ref": "#/components/responses/AppPkgContent.200"
"206": {
"$ref": "#/components/responses/206"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"416": {
"$ref": "#/components/responses/416"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"put": {
"tags": [
"app-pkgm"
],
"summary": "Uploads the content of application package.",
"description": "Uploads the content of application package.",
"operationId": "appPkgPUT",
"requestBody": {
"content": {
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
"responses": {
"202": {
"description": "The application package has been accepted for uploading, but the processing has not been completed."
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"409": {
"$ref": "#/components/responses/409"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/onboarded_app_packages/{appDId}/package_content": {
"parameters": [
{
"in": "path",
"name": "appDId",
"description": "Identifier of an application descriptor",
"schema": {
"type": "string"
},
"required": true
}
],
"get": {
"tags": [
"app-pkgm"
],
"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",
"responses": {
"200": {
"$ref": "#/components/responses/AppPkgContent.200"
},
"206": {
"$ref": "#/components/responses/206"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"416": {
"$ref": "#/components/responses/416"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"put": {
"tags": [
"app-pkgm"
],
"summary": "Uploads the content of application package.",
"description": "Uploads the content of application package.",
"operationId": "appDIdPUT",
"requestBody": {
"content": {
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
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
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
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
"responses": {
"202": {
"description": "The application package has been accepted for uploading, but the processing has not been completed."
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"409": {
"$ref": "#/components/responses/409"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
}
},
"components": {
"schemas": {
"Algorithm": {
"description": " Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.",
"type": "string"
},
"AppD": {
"properties": {
"appDId": {
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"appDNSRule": {
"description": "Describes DNS rules the MEC application requires.",
"items": {
"$ref": "#/components/schemas/DNSRuleDescriptor"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "DNSRuleDescriptor"
},
"appDVersion": {
"description": "Identifies the version of the application descriptor.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"appDescription": {
"description": "Human readable description of the MEC application.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"appExtCpd": {
"description": "Describes external interface(s) exposed by this MEC application.",
"items": {
"$ref": "#/components/schemas/AppExternalCpd"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "AppExternalCpd"
},
"appFeatureOptional": {
"description": "Describes features a MEC application may use if available.",
"items": {
"$ref": "#/components/schemas/FeatureDependency"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "FeatureDependency"
},
"appFeatureRequired": {
"description": "Describes features a MEC application requires to run.",
"items": {
"$ref": "#/components/schemas/FeatureDependency"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "FeatureDependency"
},
"appInfoName": {
"description": "Human readable name for the MEC application.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"appLatency": {
"$ref": "#/components/schemas/LatencyDescriptor"
},
"appName": {
"description": "Name to identify the MEC application.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"appProvider": {
"description": "Provider of the application and of the AppD.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"appServiceOptional": {
"description": "Describes services a MEC application may use if available.",
"items": {
"$ref": "#/components/schemas/ServiceDependency"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "ServiceDependency"
},
"appServiceProduced": {
"description": "Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps.",
"items": {
"$ref": "#/components/schemas/ServiceDescriptor"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "ServiceDescriptor"
},
"appServiceRequired": {
"description": "Describes services a MEC application requires to run.",
"items": {
"$ref": "#/components/schemas/ServiceDependency"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "ServiceDependency"
},
"appSoftVersion": {
"description": "Identifies the version of software of the MEC application.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"appTrafficRule": {
"description": "Describes traffic rules the MEC application requires.",
"items": {
"$ref": "#/components/schemas/TrafficRuleDescriptor"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "TrafficRuleDescriptor"
},
"changeAppInstanceStateOpConfig": {
"$ref": "#/components/schemas/ChangeAppInstanceStateOpConfig"
},
"mecVersion": {
"description": "Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD.",
"items": {
"type": "string"
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
},
"swImageDescriptor": {
"$ref": "#/components/schemas/SwImageDescriptor"
},
"terminateAppInstanceOpConfig": {
"$ref": "#/components/schemas/TerminateAppInstanceOpConfig"
},
"transportDependencies": {
"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.",
"items": {
"$ref": "#/components/schemas/TransportDependency"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "TransportDependency"
},
"virtualComputeDescriptor": {
"$ref": "#/components/schemas/VirtualComputeDescription"
},
"virtualStorageDescriptor": {
"description": "Defines descriptors of virtual storage resources to be used by the MEC application.",
"items": {
"$ref": "#/components/schemas/VirtualStorageDescriptor"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "VirtualStorageDescriptor"
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
"required": [
"appDId",
"appName",
"appProvider",
"appSoftVersion",
"appDVersion",
"mecVersion",
"appDescription",
"virtualComputeDescriptor",
"swImageDescriptor"
],
"type": "object",
"x-etsi-notes": "NOTE 1:\tThe appDId shall be used as the unique identifier of the application package that contains this AppD.\nNOTE 2:\tThis attribute indicates groups of transport bindings which a service-producing MEC application requires to be supported by the platform in order to be able to produce its services. At least one of the indicated groups needs to be supported to fulfil the requirements.",
"x-etsi-ref": "6.2.1.2"
},
"AppExternalCpd": {
"properties": {
"inherited_attributes": {
"description": "All attributes inherited from Cpd.",
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "inherited_attributes"
},
"virtualNetworkInterfaceRequirements": {
"description": "Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD.",
"items": {
"$ref": "#/components/schemas/VirtualNetworkInterfaceRequirements"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N"
}
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
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
"required": [
"inherited_attributes"
],
"type": "object",
"x-etsi-ref": "6.2.1.6"
},
"CallbackUri": {
"description": "The URI of the endpoint for the notification to be sent to.",
"type": "string",
"format": "uri"
},
"AppDId": {
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique.",
"type": "string"
},
"AppProvider": {
"description": "Provider of the application and of the AppD.",
"type": "string"
},
"AppName": {
"description": "Name to identify the MEC application.",
"type": "string"
},
"AppDVersion": {
"description": "Identifies the version of the application descriptor.",
"type": "string"
},
"AppPkgId": {
"description": "Identifier of the onboarded application package.",
"type": "string"
},
"SubscriptionId": {
"description": "Identifier of the subscription related to this notification.",
"type": "string"
},
"AppPkgArtifactInfo": {
"description": "Additional information of application package artifacts that are not application software images. Type is TBD"
},
"AppPkgInfo": {
"description": "'The data type AppPkgInfo represents the parameters for an application package resource'",
"type": "object",
"required": [
"id",
"appDId",
"appName",
"appSoftwareVersion",
"appDVersion",
"checksum",
"softwareImages",
"onboardingState",
"operationalState",
"usageState",
"_links"
],
"properties": {
"id": {
"$ref": "#/components/schemas/AppPkgId"
},
"appDId": {
"$ref": "#/components/schemas/AppDId"
},
"appProvider": {
"$ref": "#/components/schemas/AppProvider"
},
"appName": {
"$ref": "#/components/schemas/AppName"
},
"appSoftwareVersion": {
"$ref": "#/components/schemas/AppSoftwareVersion"
},
"appDVersion": {
"$ref": "#/components/schemas/AppDVersion"
},
"checksum": {
"$ref": "#/components/schemas/Checksum"
},
"softwareImages": {
"$ref": "#/components/schemas/AppPkgSWImageInfo"
},
"additionalArtifacts": {
"$ref": "#/components/schemas/AppPkgArtifactInfo"
},
"onboardingState": {
"$ref": "#/components/schemas/OnboardingState"
},
"operationalState": {
"$ref": "#/components/schemas/AppPkg.OperationalState"
},
"usageState": {
"$ref": "#/components/schemas/UsageState"
},
"userDefinedData": {
"$ref": "#/components/schemas/KeyValuePairs"
},
"_links": {
"$ref": "#/components/schemas/AppPkgInfo.links"
}
}
},
"AppPkgInfoModifications": {
"description": "'The data type represents the operational state for an application package resource'",
"type": "object",
"required": [
"operationState"
],
"properties": {
"operationState": {
"type": "string",
"enum": [
"DISABLED",
"ENABLED"
]
}
}
},
"AppSoftwareVersion": {
"description": "Software version of the application. This is updated when there is any change to the software in the onboarded application package.",
"type": "string"
},
"AppPkg.OperationalState": {
"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.",
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"OnboardingState": {
"description": "Onboarding state of application package",
"type": "string",
"format": "enum",
"enum": [
"CREATED",
"UPLOADING",
"PROCESSING",
"ONBOARDED"
]
},
"UsageState": {
"description": "Usage state of the onboarded instance of the application package",
"type": "string",
"format": "enum",
"enum": [
"IN_USE",
"NOT_IN_USE"
]
},
"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'",
"type": "object",
"additionalProperties": true
},
"AppPkgInfo.links": {
"description": "Links to resources related to this resource.",
"type": "object",
"required": [
"self",
"appD",
"appPkgContent"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"appD": {
"$ref": "#/components/schemas/LinkType"
},
"appPkgContent": {
"$ref": "#/components/schemas/LinkType"
}
}
},
"AppPkgNotification": {
"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'",
"type": "object",
"required": [
"id",
"notificationType",
"subscriptionId",
"timeStamp",
"appPkgId",
"appDId",
"operationalState",
"_links"
],
"properties": {
"id": {
"$ref": "#/components/schemas/AppPkgNotification.Id"
},
"notificationType": {
"$ref": "#/components/schemas/AppPkg.NotificationType"
},
"subscriptionId": {
"$ref": "#/components/schemas/SubscriptionId"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"appPkgId": {
"$ref": "#/components/schemas/AppPkgId"
},
"appDId": {
"$ref": "#/components/schemas/AppDId"
},
"operationalState": {
"type": "string",
"enum": [
"DISABLED",
"ENABLED"
]
},
"_links": {
"$ref": "#/components/schemas/AppPkgNotification.links"
}
}
},
"AppPkgNotification.Id": {
"description": "''",
"type": "string"
},
"AppPkg.NotificationType": {
"description": "Discriminator for the different notification types",
"type": "string",
"enum": [
"AppPackageOnBoarded",
"AppPacakgeEnabled",
"AppPacakgeDisabled",
"AppPackageDeleted"
]
},
"AppPkgNotification.links": {
"description": "Links to resources related to this resource.",
"type": "object",
"required": [
"subscription"
],
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
}
},
"AppPkgSWImageInfo": {
"description": "Information of application software image in application package. Type is TBD"
},
"AppPkgSubscriptionInfo": {
"description": "'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package'",
"type": "object",
"required": [
"id",
"subscriptionType",
"callbackUri",
"_links"
],
"properties": {
"id": {
"$ref": "#/components/schemas/AppPkgSubscriptionInfo.Id"
},
"subscriptionType": {
"$ref": "#/components/schemas/AppPkg.SubscriptionType"
},
"callbackUri": {
"$ref": "#/components/schemas/CallbackUri"
},
"_links": {
"$ref": "#/components/schemas/AppPkgSubscriptionInfo.links"
}
}
},
"AppPkgSubscriptionInfo.Id": {
"description": "''",
"type": "string"
},
"AppPkg.SubscriptionType": {
"description": "Subscribed notification type.",
"type": "string",
"enum": [
"AppPackageOnBoarding",
"AppPacakgeOperationChange",
"AppPackageDeletion"
]
},
"AppPkgSubscriptionInfo.links": {
"description": "Links to resources related to this resource.",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
}
},
"AppPkgSubscriptionLinkList": {
"description": "'The data type represents a subscription link list of notification on application package management'",
"type": "object",
"required": [
"_links"
],
"properties": {
"_links": {
"$ref": "#/components/schemas/AppPkgSubscriptionLinkList.links"
}
}
},
"AppPkgSubscriptionLinkList.links": {
"description": "Links to resources related to this resource.",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscriptions.AppPkgSubscription"
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
}
},
"Subscriptions.AppPkgSubscription": {
"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.'",
"type": "object",
"required": [
"href",
"subsctiptionType"
],
"properties": {
"href": {
"$ref": "#/components/schemas/Href"
},
"subsctiptionType": {
"$ref": "#/components/schemas/SubsctiptionType.AppPkg"
}
}
},
"Href": {
"description": "The URI referring to the subscription.",
"type": "string",
"format": "uri"
},
"AppPkgSubscription": {
"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.'",
"type": "object",
"required": [
"callbackUri",
"subsctiptionType"
],
"properties": {
"callbackUri": {
"$ref": "#/components/schemas/CallbackUri"
},
"subsctiptionType": {
"$ref": "#/components/schemas/SubsctiptionType.AppPkg"
},
"appPkgFilter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppPkgFilter"
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
}
},
"SubsctiptionType.AppPkg": {
"description": "'Subscribed notification type'",
"type": "string",
"enum": [
"AppPackageOnBoarding",
"AppPacakgeOperationChange",
"AppPackageDeletion"
]
},
"AppPkgFilter": {
"type": "string",
"description": "The attribute-based filter is to filter application packages on which the query applies."
},
"ChangeAppInstanceStateOpConfig": {
"description": "NFV",
"type": "string"
},
"Checksum": {
"description": "",
"properties": {
"algorithm": {
"$ref": "#/components/schemas/Algorithm"
},
"hash": {
"$ref": "#/components/schemas/Hash"
}
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
"required": [
"algorithm",
"hash"
],
"type": "object"
},
"CreateAppPkg": {
"properties": {
"appPkgName": {
"description": "Name of the application package to be onboarded.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"appPkgPath": {
"$ref": "#/components/schemas/URI"
},
"appPkgVersion": {
"description": "Version of the application package to be onboarded.\nThe appPkgName with appPkgVersion can be used to uniquely identify the application package.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"appProvider": {
"description": "The provider's name of the application package to be onboarded.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"checksum": {
"$ref": "#/components/schemas/Checksum"
},
"userDefinedData": {
"$ref": "#/components/schemas/KeyValuePairs"
}
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
"required": [
"appPkgName",
"appPkgVersion",
"checksum",
"appPkgPath"
],
"type": "object",
"x-etsi-notes": "NOTE:\tIt is for further study how to convey appPkgPath, and align with ETSI GS NFV-SOL 005 [i.7].",
"x-etsi-ref": "6.2.3.2"
},
"DNSRuleDescriptor": {
"properties": {
"dnsRuleId": {
"description": "Identifies the DNS Rule",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"domainName": {
"description": "FQDN of the DNS rule",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"ipAddress": {
"description": "IP address given by the DNS rule",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"ipAddressType": {
"$ref": "#/components/schemas/IpAddressType"
},
"ttl": {
"description": "Time-to-live value",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Int"
}
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
1615
1616
1617
1618
1619
"required": [
"dnsRuleId",
"domainName",
"ipAddressType",
"ipAddress"
],
"type": "object",
"x-etsi-ref": "6.2.1.13"
},
"IpAddressType": {
"description": "Specifies the IP address type",
"type": "string",
"enum": [
"IP_V6",
"IP_V4"
]
},
"FeatureDependency": {
"properties": {
"featureName": {
"description": "The name of the feature, for example, UserApps, UEIdentity, etc.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"version": {
"description": "The version of the feature.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
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
"required": [
"featureName",
"version"
],
"type": "object",
"x-etsi-ref": "6.2.1.8"
},
"Hash": {
"description": "'String 1 The hexadecimal value of the checksum'",
"type": "string"
},
"InterfaceDescriptor": {
"properties": {
"dstIPAddress": {
"description": "If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"dstMACAddress": {
"description": "If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"interfaceType": {
"$ref": "#/components/schemas/InterfaceType"
},
"srcMACAddress": {
"description": "If the interface type is MAC, the source address identifies the MAC address of the interface.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"tunnelInfo": {
"$ref": "#/components/schemas/TunnelInfo"
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
"required": [
"interfaceType"
],
"type": "object",
"x-etsi-ref": "6.2.1.11"
},
"InterfaceType": {
"description": "Type of interface.",
"type": "string",
"enum": [
"TUNNEL",
"MAC",
"IP"
]
},
"LatencyDescriptor": {
"properties": {
"maxLatency": {
"description": "The value of the maximum latency in nano seconds tolerated by the MEC application. See note.",
"format": "Uint32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
"required": [
"maxLatency"
],
"type": "object",
"x-etsi-notes": "NOTE:\tThe latency is considered to be the one way end-to-end latency between the client application (e.g. in a device) and the service (i.e. the MEC Application instance).",
"x-etsi-ref": "6.2.1.14"
},
"LinkType": {
"properties": {
"href": {
"description": "URI referring to a resource",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
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
"required": [
"href"
],
"type": "object",
"x-etsi-ref": "6.5.2"
},
"ProblemDetails": {
"properties": {
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"title": {
"description": "A short, human-readable summary of the problem type",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"type": {
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
}
"type": "object"
},
"SerializerTypes": {
"type": "string"
},
"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].\nThe format of this attribute is left for the data model design stage.",
"items": {
"$ref": "#/components/schemas/Not_specified"
1756
1757
1758
1759
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
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Not_specified"
},
"serCategory": {
"$ref": "#/components/schemas/CategoryRef"
},
"serName": {
"description": "The name of the service, for example, RNIS, LocationService, etc.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-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",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "TransportDependency"
},
"version": {
"description": "The version of the service.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-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.",
"x-etsi-ref": "6.2.1.17"
},
"ServiceDescriptor": {
"description": "'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.'",
"type": "object",
"required": [
"serName",
"version"
],
"properties": {
"serName": {
"$ref": "#/components/schemas/SerName"
},
"serCategory": {
"$ref": "#/components/schemas/CategoryRef"
},
"version": {
"$ref": "#/components/schemas/SerVersion"
},
"transportsSupported": {
"$ref": "#/components/schemas/TransportsSupported"
}
}
},
"SerName": {
"description": "The name of the service, for example, RNIS, LocationService, etc.",
"type": "string"
},
"SerVersion": {
"description": "The version of the service.",
"type": "string"
},
"TransportsSupported": {
"description": "'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.'",
"type": "object",
"required": [
"featureName",
"version"
],
"properties": {
"transport": {
"$ref": "#/components/schemas/TransportDescriptor"
},
"serializers": {
"$ref": "#/components/schemas/Serializers"
}
}
},
"Serializers": {
"description": "'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 '",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/SerializerTypes"
}
},
"SwImageDescriptor": {
"description": "Ref NFV",
"type": "string"
},
"TerminateAppInstanceOpConfig": {
"description": "NFV",
"type": "string",
"x-etsi-ref": "6.2.2.9"
},
"TimeStamp": {
"properties": {
"nanoSeconds": {
"description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"format": "Uint32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
},
"seconds": {
"description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"format": "Uint32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
"required": [
"seconds",
"nanoSeconds"
],
"type": "object",
"x-etsi-ref": "6.2.5.4"
},
"TrafficFilter": {
"properties": {
"dSCP": {
"description": "Used to match all IPv4 packets that have the same DSCP.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Int"
"dstAddress": {
"description": "A IP address or a range of IP addresses.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.",
"items": {
"type": "string"
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
"dstPort": {
"description": "A port or a range of ports.",
"items": {
"type": "string"
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
"dstTunnelPort": {
"description": "Used for GTP tunnel based traffic rule.",
"items": {
"type": "string"
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
"protocol": {
"description": "Specify the protocol of the traffic filter.",
"items": {
"type": "string"
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
"qCI": {
"description": "Used to match all packets that have the same QCI.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Int"
"srcAddress": {
"description": "An IP address or a range of IP addresses.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.",
"items": {
"type": "string"
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
"srcPort": {
"description": "A port or a range of ports.",
"items": {
"type": "string"
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
},
"srcTunnelAddress": {
"description": "Used for GTP tunnel based traffic rule.",
"items": {
"type": "string"
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
"srcTunnelPort": {
"description": "Used for GTP tunnel based traffic rule.",
"items": {
"type": "string"
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
},
"tC": {
"description": "Used to match all IPv6 packets that have the same TC.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Int"
},
"tag": {
"description": "Used for tag based traffic rule.",
"items": {
"type": "string"
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
},
"tgtTunnelAddress": {
"description": "Used for GTP tunnel based traffic rule.",
"items": {
"type": "string"
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
"type": "object",
"x-etsi-ref": "6.2.1.10"
},
"TrafficRuleDescriptor": {
"properties": {
"action": {
"$ref": "#/components/schemas/Action"
},
"dstInterface": {
"type": "array",
"minItems": 0,
"maxItems": 2,
"items": {
"$ref": "#/components/schemas/InterfaceDescriptor"
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
},
"filterType": {
"$ref": "#/components/schemas/FilterType"
},
"priority": {
"description": "Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Int"
},
"trafficFilter": {
"description": "The filter used to identify specific flow/packets that need to be handled by the MEC host.",
"items": {
"$ref": "#/components/schemas/TrafficFilter"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "TrafficFilter"
},
"trafficRuleId": {
"description": "Identifies the traffic rule.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
2045
2046
2047
2048
2049
2050
2051
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
"required": [
"trafficRuleId",
"filterType",
"priority",
"trafficFilter",
"action"
],
"type": "object",
"x-etsi-ref": "6.2.1.9"
},
"Action": {
"description": "'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.'",
"type": "string",
"enum": [
"DROP",
"FORWARD_DECAPSULATED",
"FORWARD_AS_IS",
"PASSTHROUGH",
"DUPLICATED_DECAPSULATED",
"DUPLICATE_AS_IS"
]
},
"FilterType": {
"description": "Definition of filter type: per FLOW or PACKET",
"type": "string",
"enum": [
"FLOW",
"PACKET"
]
},
"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",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
"serializers": {
"description": "Information about the serializers in this transport binding, as defined in the SerializerTypes 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/SerializerTypes"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "SerializerTypes"
"transport": {
"$ref": "#/components/schemas/TransportDescriptor"
}
"required": [
"transport",
"serializers",
"labels"
],
"type": "object",
"x-etsi-ref": "6.2.1.18"
},
"TransportDescriptor": {
"properties": {
"protocol": {
"description": "The name of the protocol used. Shall be set to HTTP for a REST API.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"security": {
"$ref": "#/components/schemas/SecurityInfo"
"type": {
"$ref": "#/components/schemas/TransportTypes"
"version": {
"description": "The version of the protocol used.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
"required": [
"type",
"protocol",
"version",
"security"
],
"type": "object",
"x-etsi-ref": "6.2.1.19"
},
"TransportTypes": {
"type": "string"
},
"TunnelInfo": {
"properties": {
"tunnelDstAddress": {
"description": "Destination address of the tunnel.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"tunnelSpecificData": {
"$ref": "#/components/schemas/Not_specified"
},
"tunnelSrcAddress": {
"description": "Source address of the tunnel.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"tunnelType": {
"$ref": "#/components/schemas/TunnelType"
}
"required": [
"tunnelType",
"tunnelDstAddress",
"tunnelSrcAddress"
],
"type": "object",
"x-etsi-ref": "6.2.1.12"
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
"TunnelType": {
"description": "Type of tunnel.",
"type": "string",
"enum": [
"GTP-U",
"GRE"
]
},
"VirtualComputeDescription": {
"description": "Ref NFV",
"type": "string"
},
"VirtualNetworkInterfaceRequirements": {
"type": "string"
},
"VirtualStorageDescriptor": {
"description": "Ref NFV",
"type": "string"
},
"SecurityInfo": {
"description": "See MEC011"
},
"CategoryRef": {
"description": "See MEC011"
},
"URI": {
"type": "string"
},
"Not_specified": {
"type": "string"
}
},
"responses": {
"204": {
"description": "No Content"
},
"206": {
"description": "Partial content"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/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/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/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"412": {
"description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"414": {
"description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"415": {
"description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"416": {
"description": "Range Not Satisfiable ."
},
"422": {
"description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"application/problem+json": {
"problemDetails": {
"type": "https://meAppServer.example.com/rni/v2/probs/too-many targets",
"title": "Too many targets",
"status": "422",
"detail": "The target area for the request is considered too large",
"instance": "/meAppClient.example.com/77777/msgs/abc"
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"AppPkgContent.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."