@@ -7,17 +7,9 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E
*[Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs016-ue-app-api/raw/develop/UEAppInterfaceApi.yaml).
*[Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs016-ue-app-api/raw/develop/UEAppInterfaceApi.yaml).
## ETSI Forge Copyright statement
## License
Copyright (c) ETSI 2019.
Unless specified otherwise, the content of this repository and the files
contained are released under the BSD-3-Clause license.
See the attached LICENSE file or visit https://forge.etsi.org/legal-matters.
This software is subject to copyrights owned by ETSI. Non-exclusive permission
is hereby granted, free of charge, to copy, reproduce and amend this file
under the following conditions: It is provided "as is", without warranty of any
kind, expressed or implied.
ETSI shall never be liable for any claim, damages, or other liability arising
from its use or inability of use.This permission does not apply to any documentation
associated with this file for which ETSI keeps all rights reserved. The present
copyright notice shall be included in all copies of whole or part of this
software and shall not imply any sub-license right.
"description":"Used by the UALCMP to inform the UE application of a modification to reference URI of the user application.",
"description":"Used by the UALCMP to inform the Device application of a modification to reference URI of the user application.",
"operationId":"NotificationEvent_POST",
"tags":[
"callback"
...
...
@@ -307,7 +307,7 @@
"required":true
},
"NotificationEvent":{
"description":"Sent by the UALCMP to the UE application.",
"description":"Sent by the UALCMP to the Device application.",
"content":{
"application/json":{
"schema":{
...
...
@@ -338,7 +338,7 @@
}
},
"AppList":{
"description":"The response body contains the ApplicationList resource available for the querying UE application",
"description":"The response body contains the ApplicationList resource available for the querying Device application",
"content":{
"application/json":{
"schema":{
...
...
@@ -467,14 +467,30 @@
"description":"Information on available applications",
"type":"object",
"properties":{
"appInfo":{
"$ref":"#/components/schemas/AppInfo"
"appList":{
"$ref":"#/components/schemas/AppList"
},
"vendorSpecificExt":{
"$ref":"#/components/schemas/VendorSpecificExt"
}
}
},
"AppList":{
"description":"List of user applications available to the device application",
"type":"array",
"minItems":0,
"items":{
"type":"object",
"required":[
"appInfo"
],
"properties":{
"appInfo":{
"$ref":"#/components/schemas/AppInfo"
}
}
}
},
"AppContext":{
"description":"Information on application context created by the MEC system",
"type":"object",
...
...
@@ -495,7 +511,7 @@
"$ref":"#/components/schemas/CallbackReference"
},
"appInfo":{
"$ref":"#/components/schemas/RequiredAppInfo"
"$ref":"#/components/schemas/AppInfoAppContext"
}
}
},
...
...
@@ -511,14 +527,6 @@
}
}
},
"VendorSpecificExtList":{
"description":"Extension for vendor specific information.",
"type":"array",
"minItems":0,
"items":{
"$ref":"#/components/schemas/VendorSpecificExt"
}
},
"VendorSpecificExt":{
"description":"Extension for vendor-specific information",
"required":[
...
...
@@ -536,7 +544,7 @@
"readOnly":true
},
"AssociateUeAppId":{
"description":"Uniquely identifies the UE application. Included in the request. The length of the value shall not exceed 32 characters.",
"description":"Uniquely identifies the Device application. Included in the request. The length of the value shall not exceed 32 characters.",
"type":"string",
"writeOnly":true
},
...
...
@@ -545,20 +553,19 @@
"type":"string"
},
"AppInfo":{
"description":"User applications available for the UE application",
"type":"array",
"items":{
"$ref":"#/components/schemas/AppInfoList"
}
},
"AppInfoList":{
"type":"object",
"required":[
"appDId",
"appName",
"appProvider",
"appSoftVersion",
"appDVersion",
"appDescription"
],
"properties":{
"appDId":{
"$ref":"#/components/schemas/AppDId"
},
"appName":{
"$ref":"#/components/schemas/AppName"
},
...
...
@@ -568,6 +575,9 @@
"appSoftVersion":{
"$ref":"#/components/schemas/AppSoftVersion"
},
"appDVersion":{
"$ref":"#/components/schemas/AppDVersion"
},
"appDescription":{
"$ref":"#/components/schemas/AppDescription"
},
...
...
@@ -576,15 +586,18 @@
}
}
},
"RequiredAppInfo":{
"AppInfoAppContext":{
"description":"Included in the request",
"type":"object",
"required":[
"appName",
"appProvider",
"referenceURL"
"appDVersion"
],
"properties":{
"appDId":{
"$ref":"#/components/schemas/AppDId"
},
"appName":{
"$ref":"#/components/schemas/AppName"
},
...
...
@@ -594,6 +607,9 @@
"appSoftVersion":{
"$ref":"#/components/schemas/AppSoftVersion"
},
"appDVersion":{
"$ref":"#/components/schemas/AppDVersion"
},
"appDescription":{
"$ref":"#/components/schemas/AppDescription"
},
...
...
@@ -606,7 +622,7 @@
}
},
"AppCharcs":{
"description":"The application characteristics relate to the system resources consumed by the application. UE application can use this information e.g., for estimating the cost of use of the application or for the expected user experience",
"description":"The application characteristics relate to the system resources consumed by the application. Device application can use this information e.g., for estimating the cost of use of the application or for the expected user experience",
"type":"object",
"properties":{
"memory":{
...
...
@@ -652,7 +668,12 @@
"enum":[
"SERVICE_CONTINUITY_NOT_REQUIRED",
"SERVICE_CONTINUITY_REQUIRED"
]
],
"example":"SERVICE_CONTINUITY_NOT_REQUIRED"
},
"AppDId":{
"description":"Identifier of this MEC application descriptor. It is equivalent to the appDId defined in clause 6.2.1.2 of ETSI GS MEC 010-2. This attribute shall be globally unique. It shall be present if the application is one in the ApplicationList.",
"type":"string"
},
"AppName":{
"description":"Name of the MEC application. The length of the value shall not exceed 32 characters.",
...
...
@@ -666,12 +687,16 @@
"description":"Software version of the MEC application. The length of the value shall not exceed 32 characters.",
"type":"string"
},
"AppDVersion":{
"description":"Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 010-2.",
"type":"string"
},
"AppDescription":{
"description":"Human readable description of the MEC application. NOTE the language support may be limited. The length of the value shall not exceed 128 characters.",
"type":"string"
},
"CallbackReference":{
"description":"URI assigned by the UE application to receive application lifecycle related notifications. Included in the request. This subscription stays alive for the lifetime of the application context.",
"description":"URI assigned by the Device application to receive application lifecycle related notifications. Included in the request. This subscription stays alive for the lifetime of the application context.",
admin_forge authoredf8b3cbd4