Newer
Older
description: No Content
headers: {}
content: {}
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
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.
1045
1046
1047
1048
1049
1050
1051
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
1085
1086
- name: appPkgId
in: path
description: Identifier of an on-boarded individual application package
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
description: Content of the AppD is returned.
headers: {}
application/zip: {}
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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'
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:
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.
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
- 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
description: Content of the AppD is returned.
headers: {}
application/zip: {}
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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'
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:
summary: 'Fetch the onboarded application package content identified by appPkgId or appDId.'
description: Fetch the onboarded application package content identified by appPkgId or appDId.
parameters:
- name: appPkgId
in: path
description: Identifier of an on-boarded individual application package
required: true
style: simple
schema:
type: string
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: 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.
content:
application/zip: {}
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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: Range Not Satisfiable .
headers: {}
content: {}
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'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
summary: 'Uploads the content of application package.'
description: Uploads the content of application package.
parameters:
- name: appPkgId
in: path
description: Identifier of an on-boarded individual application package
required: true
style: simple
schema:
type: string
application/zip: {}
description: The application package has been accepted for uploading, but the processing has not been completed.
headers: {}
content: {}
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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'
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'
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:
summary: 'Fetch the onboarded application package content identified by appPkgId or appDId.'
description: Fetch the onboarded application package content identified by appPkgId or appDId.
parameters:
- name: appDId
in: path
description: Identifier of an application descriptor
required: true
style: simple
schema:
type: string
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: {}
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.
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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
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'
'416':
description: Range Not Satisfiable .
headers: {}
content: {}
'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
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: {}
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
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'
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'
'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'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
###############################################################################
# Notification endpoint AppPkgNotification #
###############################################################################
/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
parameters: []
description: Notification endpoint to be created
$ref: '#/components/schemas/AppPkgNotification'
required: true
'204':
description: No Content
headers: {}
content: {}
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
title: AppD
required:
- appDId
- appDVersion
- appDescription
- appName
- appProvider
- appSoftVersion
- mecVersion
- swImageDescriptor
- virtualComputeDescriptor
type: object
description: Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1.
$ref: './MEC010p2_v221_definitions.yaml#/definitions/DNSRuleDescriptor'
description: Describes DNS rules the MEC application requires.
description: Identifies the version of the application descriptor.
description: Human readable description of the MEC application.
items:
$ref: '#/components/schemas/AppExternalCpd'
description: Describes external interface(s) exposed by this MEC application.
appFeatureOptional:
$ref: './MEC010p2_v221_definitions.yaml#/definitions/FeatureDependency'
description: Describes features a MEC application may use if available.
appFeatureRequired:
$ref: './MEC010p2_v221_definitions.yaml#/definitions/FeatureDependency'
description: Describes features a MEC application requires to run.
description: Human readable name for the MEC application.
$ref: './MEC010p2_v221_definitions.yaml#/definitions/LatencyDescriptor'
description: Name to identify the MEC application.
description: Provider of the application and of the AppD.
$ref: './MEC010p2_v221_definitions.yaml#/definitions/ServiceDependency'
description: Describes services a MEC application may use if available.
appServiceProduced:
$ref: './MEC010p2_v221_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:
$ref: './MEC010p2_v221_definitions.yaml#/definitions/ServiceDependency'
description: Describes services a MEC application requires to run.
description: Identifies the version of software of the MEC application.
$ref: './MEC010p2_v221_definitions.yaml#/definitions/TrafficRuleDescriptor'
description: Describes traffic rules the MEC application requires.
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.
description: Describes the descriptors of the software image to be used by the virtualisation container used to realize this MEC application.
$ref: './MEC010p2_v221_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.
description: Describes CPU and memory requirements, as well as optional additional requirements, such as disk and acceleration related capabilities, of the virtualisation container used to realize this MEC application.
type: object
items:
type: string
description: Defines descriptors of virtual storage resources to be used by the MEC application.
userContextTransferCapability:
$ref: './MEC010p2_v221_definitions.yaml#/definitions/UserContextTransferCapability'
appNetworkPolicy:
$ref: './MEC010p2_v221_definitions.yaml#/definitions/AppNetworkPolicy'
AppExternalCpd:
title: AppExternalCpd
type: object
properties:
inherited_attributes:
type: object
description: All attributes inherited from Cpd.
virtualNetworkInterfaceRequirements:
type: array
items:
type: string
description: Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD.
- id
- appDId
- appName
- appSoftwareVersion
- appDVersion
- checksum
- softwareImages
- onboardingState
- operationalState
- usageState
type: string
description: Identifier of the onboarded application package.
type: string
description: Identifier of this MEC application descriptor. This attribute shall be globally unique.
type: string
description: Provider of the application and of the AppD.
type: string
description: Name to identify the MEC application.
type: string
description: Software version of the application. This is updated when there is any change to the software in the onboarded application package.
type: string
description: Identifies the version of the application descriptor.
signingCertificate:
type: string
description: The singleton signing certificate if it is included as a file in the AppD archive.
type: object
description: Information of application software image in application package. Type is TBD
type: object
description: Additional information of application package artifacts that are not application software images. Type is TBD
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'
$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'"
title: AppPkgInfoModifications
required:
- operationState
$ref: '#/components/schemas/OperationState'
description: "'The data type represents the operational state for an application package resource'"
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.'
examples:
- ENABLED
OnboardingState:
title: OnboardingState
- CREATED
- UPLOADING
- PROCESSING
- ONBOARDED
description: Onboarding state of application package
examples:
- CREATED
UsageState:
title: UsageState
- IN_USE
- NOT_IN_USE
type: string
description: Usage state of the onboarded instance of the application package
examples:
- IN_USE
- self
- appD
- appPkgContent
type: object
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.
- id
- notificationType
- subscriptionId
- timeStamp
- appPkgId
- appDId
- operationalState
- _links
type: object
type: string
description: "''"
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.
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'"
- AppPackageOnBoarded
- AppPacakgeEnabled
- AppPacakgeDisabled
- AppPackageDeleted
type: string
description: Discriminator for the different notification types
examples:
- AppPackageOnBoarded
properties:
subscription:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this resource.
- id
- subscriptionType
- callbackUri
- _links
type: object
description: Identifier of the subscription to application package notification.
description: Type of subscription.
$ref: '#/components/schemas/AppPkgSubscriptionType'
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.
- AppPackageOnBoardingSubscription
title: AppPkgSubscriptionInfo.links
properties:
self:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this resource.
properties:
_links:
$ref: '#/components/schemas/AppPkgSubscriptionLinkList.links'
description: "'The data type represents a subscription link list of notification on application package management'"
title: AppPkgSubscriptionLinkList.links
properties:
self:
$ref: '#/components/schemas/LinkType'
subscriptions:
type: array
items:
$ref: '#/components/schemas/Subscriptions.AppPkgSubscription'
description: ''
description: Links to resources related to this resource.
title: Subscriptions.AppPkgSubscription
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.'"
type: string
description: The URI of the endpoint for the notification to be sent to.
subscriptionType:
$ref: '#/components/schemas/AppPkgSubscriptionType'
$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.
appDId: