Newer
Older
},
"/app_packages/{appPkgId}/appd": {
"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",
"name": "appPkgId",
"in": "path",
"description": "Identifier of an on-boarded individual application package",
"required": true,
"style": "simple",
"schema": {
"type": "string"
"in": "query",
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
"style": "form",
"explode": true,
"schema": {
"type": "string"
"in": "query",
"description": "Include all complex attributes in the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
"in": "query",
"description": "Complex attributes of AppPkgInfo to be included into the response",
"style": "form",
"explode": true,
"schema": {
"type": "string"
"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.",
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AppD"
}
},
"application/zip": {}
}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"$ref": "#/components/schemas/ProblemDetails"
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/onboarded_app_packages/{appDId}/appd": {
"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",
"name": "appDId",
"in": "path",
"description": "Identifier of an application descriptor",
"required": true,
"style": "simple",
"in": "query",
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
"style": "form",
"explode": true,
"schema": {
"type": "string"
"in": "query",
"description": "Include all complex attributes in the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
"in": "query",
"description": "Complex attributes of AppPkgInfo to be included into the response",
"style": "form",
"explode": true,
"schema": {
"type": "string"
"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.",
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AppD"
}
},
"application/zip": {}
}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"$ref": "#/components/schemas/ProblemDetails"
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"deprecated": false
},
"parameters": []
"/app_packages/{appPkgId}/package_content": {
"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",
"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.",
"headers": {},
"content": {
"application/zip": {}
}
"description": "Partial content",
"headers": {},
"content": {
"application/zip": {}
}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"416": {
"description": "Range Not Satisfiable .",
"headers": {},
"content": {}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"put": {
"tags": [
"app-pkgm"
],
"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"
],
"requestBody": {
"description": "",
"content": {
"application/zip": {}
},
"required": false
"responses": {
"202": {
"description": "The application package has been accepted for uploading, but the processing has not been completed.",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"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",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/onboarded_app_packages/{appDId}/package_content": {
"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",
"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": "Partial content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"416": {
"description": "Range Not Satisfiable .",
"headers": {},
"content": {}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"put": {
"tags": [
"app-pkgm"
],
"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"
],
"requestBody": {
"description": "",
"content": {
"application/zip": {}
},
"required": false
"responses": {
"202": {
"description": "The application package has been accepted for uploading, but the processing has not been completed.",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"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",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
1749
1750
1751
1752
1753
1754
1755
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
},
"deprecated": false
},
"parameters": []
},
"/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",
"parameters": [],
"requestBody": {
"description": "Notification endpoint to be created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgNotification"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated": false
},
"parameters": []
}
},
"components": {
"schemas": {
"AppD": {
"title": "AppD",
"required": [
"appDId",
"appDVersion",
"appDescription",
"appName",
"appProvider",
"appSoftVersion",
"mecVersion",
"swImageDescriptor",
"virtualComputeDescriptor"
],
"type": "object",
"properties": {
"appDId": {
"type": "string",
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1."
},
"appDNSRule": {
"items": {
"$ref": "#/components/schemas/DNSRuleDescriptor"
},
"description": "Describes DNS rules the MEC application requires."
},
"appDVersion": {
"type": "string",
"description": "Identifies the version of the application descriptor."
},
"appDescription": {
"type": "string",
"description": "Human readable description of the MEC application."
},
"appExtCpd": {
"items": {
"$ref": "#/components/schemas/AppExternalCpd"
},
"description": "Describes external interface(s) exposed by this MEC application."
},
"appFeatureOptional": {
"items": {
"$ref": "#/components/schemas/FeatureDependency"
},
"description": "Describes features a MEC application may use if available."
},
"appFeatureRequired": {
"items": {
"$ref": "#/components/schemas/FeatureDependency"
},
"description": "Describes features a MEC application requires to run."
},
"appInfoName": {
"type": "string",
"description": "Human readable name for the MEC application."
},
"appLatency": {
"$ref": "#/components/schemas/LatencyDescriptor"
},
"appName": {
"type": "string",
"description": "Name to identify the MEC application."
},
"appProvider": {
"type": "string",
"description": "Provider of the application and of the AppD."
},
"appServiceOptional": {
"items": {
"$ref": "#/components/schemas/ServiceDependency"
},
"description": "Describes services a MEC application may use if available."
},
"appServiceProduced": {
"items": {
"$ref": "#/components/schemas/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": {
"items": {
"$ref": "#/components/schemas/ServiceDependency"
},
"description": "Describes services a MEC application requires to run."
},
"appSoftVersion": {
"type": "string",
"description": "Identifies the version of software of the MEC application."
},
"appTrafficRule": {
"items": {
"$ref": "#/components/schemas/TrafficRuleDescriptor"
},
"description": "Describes traffic rules the MEC application requires."
},
"changeAppInstanceStateOpConfig": {
"type": "string",
"description": "NFV"
},
"mecVersion": {
"items": {
"type": "string"
"description": "Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD."
},
"swImageDescriptor": {
"type": "string",
"description": "Ref NFV"
},
"terminateAppInstanceOpConfig": {
"type": "string",
"description": "NFV"
},
"transportDependencies": {
"items": {
"$ref": "#/components/schemas/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": {
"type": "string",
"description": "Ref NFV"
},
"virtualStorageDescriptor": {
"minItems": 0,
"type": "array",
"items": {
"type": "string"
},
"description": "Defines descriptors of virtual storage resources to be used by the MEC application."
}
},
"AppExternalCpd": {
"title": "AppExternalCpd",
"required": [
],
"type": "object",
"properties": {
"inherited_attributes": {
"type": "object",
"description": "All attributes inherited from Cpd."
},
"virtualNetworkInterfaceRequirements": {
"minItems": 0,
"type": "array",