Newer
Older
title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management'
description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.'
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
name: ETSI Forge
url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v3.1.1'
url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/03.01.01_60/gs_MEC01002v030101p.pdf'
tags:
- name: app-pkgm
description: App Package management
- name: app-pkgm-notifications
description: App Package management notifications
- url: https://localhost/app_pkgm/v1
variables: {}
summary: 'Create a resource for on-boarding an application package to a MEO/MEAO'
description: Create a resource for on-boarding an application package to a MEO/MEAO
requestBody:
description: Resource to be created
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAppPkg'
responses:
'201':
description: Successful response for resource creation
$ref: '#/components/schemas/AppPkgInfo'
description: The response body shall contain a representation of the application package resource
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
summary: Queries information relating to on-boarded application packages in the MEO/MEAO'
description: queries information relating to on-boarded application packages in the MEO/MEAO
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
- 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: Contains a representation of the application package resource
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppPkgInfo'
description: 'Indicate the success of request. The response message content shall contain a list of representations of the "individual application package" resources that match the attribute filter'
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
deprecated: false
parameters: []
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/onboarded_app_packages:
post:
tags:
- app-pkgm
summary: 'Create a resource for on-boarding an application package to a MEO/MEAO'
description: Create a resource for on-boarding an application package to a MEO/MEAO
operationId: onboarded_app_packagesPOST
parameters: []
requestBody:
description: Resource to be created
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAppPkg'
required: true
responses:
'201':
description: Successful response for resource creation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppPkgInfo'
description: The response body shall contain a representation of the application package resource
'400':
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
deprecated: false
get:
tags:
- app-pkgm
summary: Queries information relating to on-boarded application packages in the MEO/MEAO'
description: queries information relating to on-boarded application packages in the MEO/MEAO
operationId: onboarded_app_packagesGET
parameters:
- name: filter
in: query
description: Attribute-based filtering parameters according to ETSI GS MEC 009
style: form
explode: true
schema:
type: string
- name: all_fields
in: query
description: Include all complex attributes in the response.
style: form
explode: true
schema:
type: string
- name: fields
in: query
description: Complex attributes of AppPkgInfo to be included into the response
style: form
explode: true
schema:
type: string
- name: exclude_fields
in: query
description: Complex attributes of AppPkgInfo to be excluded from the response.
style: form
explode: true
schema:
type: string
- name: exclude_default
in: query
description: Indicates to exclude the following complex attributes of AppPkgInfo from the response.
style: form
explode: true
schema:
type: string
responses:
'200':
description: Contains a representation of the application package resource
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppPkgInfo'
description: Indicate the success of request. The response body message content shall contain a list of representations of the "individual application package" resources that match the attribute filter.
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
deprecated: false
parameters: []
summary: 'Queries the information related to individual application package resources'
description: Queries the information related to individual application package resources
parameters:
- name: appPkgId
in: path
description: Identifier of an individual application package resource
required: true
style: simple
schema:
type: string
description: Contains a representation of the application package resource
headers: {}
items:
$ref: '#/components/schemas/AppPkgInfo'
description: Indicates the success of request. The response message content shall contain a representation of the resource
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
summary: 'Deletes an individual application package resources in MEO/MEAO'
description: Deletes an individual application package resources in MEO/MEAO
parameters:
- name: appPkgId
in: path
description: Identifier of an individual application package resource
required: true
style: simple
schema:
type: string
description: No Content
headers: {}
content: {}
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
summary: 'Updates the operational state of an individual application package resource'
description: Updates the operational state of an individual application package resources
parameters:
- name: appPkgId
in: path
description: Identifier of an individual application package resource
required: true
style: simple
schema:
type: string
description: Parameters for application package information modification.
content:
application/json:
schema:
$ref: '#/components/schemas/AppPkgInfoModifications'
description: Shows that the operation has been completed successfully
headers: {}
items:
$ref: '#/components/schemas/AppPkgInfoModifications'
description: Shall be returned when the operation has been completed successfully.
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
deprecated: false
parameters: []
/onboarded_app_packages/{appPkgId}:
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: onboarded_app_packageGET
parameters:
- name: appPkgId
in: path
description: Identifier of an individual application package resource
required: true
style: simple
schema:
type: string
responses:
'200':
description: Contains a representation of the application package resource
headers: {}
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AppPkgInfo'
description: Indicates the success of request. The response message content shall contain arepresentation of the resource.
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
deprecated: false
delete:
tags:
- app-pkgm
summary: 'Deletes an individual application package resources in MEO/MEAO'
description: Deletes an individual application package resources in MEO/MEAO
operationId: onboarded_app_packageDELETE
parameters:
- name: appPkgId
in: path
description: Identifier of an individual application package resource
required: true
style: simple
schema:
type: string
responses:
'204':
description: No Content
headers: {}
content: {}
'400':
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
deprecated: false
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: onboarded_app_packagePATCH
parameters:
- name: appPkgId
in: path
description: Identifier of an individual application package resource
required: true
style: simple
schema:
type: string
requestBody:
description: Parameters for application package information modification.
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AppPkgInfoModifications'
description: Shall be returned when the operation has been completed successfully.
required: true
responses:
'200':
description: Shows that the operation has been completed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppPkgInfoModifications'
'400':
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
deprecated: false
parameters: []
summary: 'Subscribe to notifications about on-boarding an application package'
description: Subscribe to notifications about on-boarding an application package
description: The input parameters of subscribe operation to notifications
content:
application/json:
schema:
$ref: '#/components/schemas/AppPkgSubscription'
responses:
'201':
description: Successful response for created subscription
$ref: '#/components/schemas/AppPkgSubscriptionInfo'
descriprion: Upon success, a response message contentrepresenting the created subscription shall bereturned.
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
callbacks:
notification:
'{$request.body#/subscription.href}':
post:
summary: 'Callback POST used to send a notification'
description: ' The notification is triggered when a new application package is onboarded'
operationId: notificationPOST
requestBody:
description: Subscription notification
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AppPkgNotification'
responses:
'204':
description: "No content"
'404':
description: "Not found"
summary: 'used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO'
description: used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO package
description: List of zero or more subscriptions
headers: {}
$ref: '#/components/schemas/AppPkgSubscriptionLinkList'
description: Upon success, a response message content containing a list of zero or more subscriptions shallbe returned.
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
deprecated: false
parameters: []
/subscriptions/{subscriptionId}:
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.
parameters:
- name: subscriptionId
in: path
description: Identifier of an individual subscription to notifications about application package changes
required: true
style: simple
schema:
type: string
description: a response body containing a representation of the resource shall be returned.
$ref: '#/components/schemas/AppPkgSubscriptionInfo'
descriprion: Upon success, a response message content containing a representation of the resource shall be returned.
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
summary: 'Deletes the individual subscription to notifications about application package changes in MEO or MEAO.'
description: Deletes the individual subscription to notifications about application package changes in MEO or MEAO.
parameters:
- name: subscriptionId
in: path
description: Identifier of an individual subscription to notifications about application package changes
style: simple
schema:
type: string
description: No Content
headers: {}
content: {}
'400':
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
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.
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
- 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: {}
descriprion: Indicates the success of request, and the content of the AppD is returned.The response message content shall contain a copy of the file representing the AppD or a
ZIP file that contains the file or multiple files representing the AppD.The "Content-Type" HTTP header shall be set according to the format of the returned file, which is
selected according to "Accept" HTTP header options passed in the request.
application/zip: {}
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
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.
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
- 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: {}
descriprion: Indicates the success of request, and the content of the AppD is returned.The response message content shall contain a copy of the file representing the AppD or a
ZIP file that contains the file or multiple files representing the AppD.The "Content-Type" HTTP header shall be set according to the format of the returned file, which is
selected according to "Accept" HTTP header options passed in the request.
application/zip: {}
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
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: {}
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
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
description: The application package has been accepted for uploading, but the processing has not been completed.
headers: {}
content: {}
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
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.
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
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
responses:
'202':
description: The application package has been accepted for uploading, but the processing has not been completed.
headers: {}
content: {}
'400':
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
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: {}
'400':
$ref: '#/components/responses/400'
$ref: '#/components/responses/401'
$ref: '#/components/responses/403'
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
$ref: '#/components/responses/429'
deprecated: false
parameters: []
title: AppD
required:
- appDId
- appDVersion
- appDescription
- appName
- appProvider
- appSoftVersion
- mecVersion
- swImageDescriptor
description: Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1.
$ref: './definitions/MEC010p2_definitions.yaml#/definitions/DNSRuleDescriptor'
description: Describes DNS rules the MEC application requires.
logicalNode:
type: array
items:
$ref: '#/components/schemas/LogicalNodeRequirements'
description: The logical node requirements. See note 6 and note 7.
requestAdditionalCapabilities:
type: array
items:
$ref: '#/components/schemas/RequestedAdditionalCapabilityData'
description: Specifies requirements for additional capabilities. These can be for a range of purposes. One example is acceleration related capabilities. See note 6 and note 7.
type: array
items:
$ref: '#/components/schemas/McioConstraintParams'
description: The parameter names for constraints expected to be assigned to MCIOs realizing this application. For the associated semantical context of the values, refer to the description under the table 7.1.6.2.2-1 of ETSI GS NFV IFA 011 [1]. See note 7.
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. See note 4.
$ref: './definitions/MEC010p2_definitions.yaml#/definitions/FeatureDependency'
description: Describes features a MEC application may use if available.
appFeatureRequired:
$ref: './definitions/MEC010p2_definitions.yaml#/definitions/FeatureDependency'
description: Describes features a MEC application requires to run.
description: Human readable name for the MEC application.
$ref: './definitions/MEC010p2_definitions.yaml#/definitions/LatencyDescriptor'
description: Name to identify the MEC application.
description: Provider of the application and of the AppD.
$ref: './definitions/MEC010p2_definitions.yaml#/definitions/ServiceDependency'
description: Describes services a MEC application may use if available.
appServiceProduced:
$ref: './definitions/MEC010p2_definitions.yaml#/definitions/ServiceDescriptor'
description: Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps.
appServiceRequired:
$ref: './definitions/MEC010p2_definitions.yaml#/definitions/ServiceDependency'
description: Describes services a MEC application requires to run.
description: Identifies the version of software of the MEC application.
description: Identifies the MCIOP in the application package, used in containerized workload management, when the application is realized by a set of OS containers. See note 7.
mcioIdentificationData:
type: string
description: Name and type of the Managed Container Infrastructure Object (MCIO) that realizes this application. It allows the VNFM to identify the MCIO e.g. when querying the Container Infrastructure Service Management (CISM). See note 7.
items:
$ref: '#/components/schemas/McioIdentificationData'
$ref: './definitions/MEC010p2_definitions.yaml#/definitions/TrafficRuleDescriptor'
description: Describes traffic rules the MEC application requires.
$ref: '#/components/schemas/changeAppInstanceStateOpConfig'
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.
type: array
items:
$ref: '#/components/schemas/SwImageDescriptor'
description: Describes the descriptors of the software image to be used by the virtualisation container used to realize this MEC application. See note 5.
$ref: '#/components/schemas/terminateAppInstanceOpConfig'
$ref: './definitions/MEC010p2_definitions.yaml#/definitions/TransportDependency'
description: Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. See note 2.
description: Describes CPU and memory requirements, as well as optional additional requirements, such as disk and acceleration related capabilities, of the single VM used to realize this MEC application. See note 5.
items:
$ref: '#/components/schemas/VirtualComputeDescriptor'
osContainerDescriptor:
type: array
items:
$ref: '#/components/schemas/OsContainerDescriptor'
description: Describes CPU, memory requirements and limits, and software images of the OS Containers realizing this MEC application corresponding to OS Containers sharing the same host and same network namespace. See note 5 and note 7.
description: |
NOTE 1: The appDId shall be used as the unique identifier of the application package that contains this AppD.
NOTE 2: This 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.
NOTE 3: The support of application descriptor containing descriptions of multiple virtualisation containers and/or
application software images is out of scope of the present document.
NOTE 4: External interfaces are used to connect to e.g. other MEC applications, MEC services, UEs and also MEC
platform and OSS.
NOTE 5: Only one of virtualComputeDescriptor or osContainerDescriptor shall be present. If virtualComputeDescriptor
presents, only a single swImageDescriptor shall be provided.
NOTE 6: If the AppD includes virtualComputeDesc, then logicalNode and requestedAdditionalCapabilites shall not be
present.
NOTE 7: This attribute reflects the ETSI NFV interpretation of the cloud native workloads.
changeAppInstanceStateOpConfig:
type: object
description: >
This information element defines attributes that affect the invocation of the OperateVnf operation.
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
required:
- minGracefulStopTimeout
properties:
minGracefulStopTimeout:
type: number
description: Minimum timeout value for graceful stop of a VNF instance.
maxRecommendedGracefulStopTimeout:
type: number
description: >
Maximum recommended timeout value that can be needed to gracefully stop a VNF
instance of a particular type under certain conditions, such as maximum load
condition. This is provided by VNF provider as information for the operator facilitating
the selection of optimal timeout value. This value is not used as constraint.
parameter:
type: array
items:
type: string
description: >
Array of KVP requirements for VNF-specific parameters to be passed when invoking the
OperateVnf operation. See note.
terminateAppInstanceOpConfig:
type: object
description: >
This information element defines attributes that affect the invocation of the TerminateVnf operation.
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
required:
- minGracefulTerminationTimeout
properties:
minGracefulTerminationTimeout:
type: number
description: Minimum timeout value for graceful stop of a VNF instance.
maxRecommendedGracefulTerminationTimeout :
type: number
description: >
Maximum recommended timeout value that can be needed to gracefully terminate a
VNF instance of a particular type under certain conditions, such as maximum load
condition. This is provided by VNF provider as information for the operator facilitating
the selection of optimal timeout value. This value is not used as constraint.
parameter:
type: array
items:
type: string
description: >
Array of KVP requirements for VNF-specific parameters to be passed when invoking the
TerminateVnf operation. See note.
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
SwImageDescriptor:
type: object
required:
- id
- name
- version
- containerFormat
- swImage
properties:
id:
type: string
description: The identifier of this software image.
name:
type: string
description: The name of this software image.
version:
type: string
items:
$ref: "#/components/schemas/Version"
description: The version of this software image.
checksum:
$ref: "#/components/schemas/ChecksumData"
description: The checksum of the software image file. See note 3.
containerFormat:
type: string
description: The container format describes the container file format in which software image is provided.
diskFormat:
type: string
description: The disk format of a software image is the format of the underlying disk image. See note 1.
minDisk:
type: number
description: The minimal disk size requirement for this software image. See note 1.
minRam:
type: number
description: The minimal RAM requirement for this software image. See note 2.
size:
type: number
description: The size of this software image file. See note 3.
swImage:
type: object
items:
$ref: "#/components/schemas/SwImageDesc"
description: A reference to the actual software image.
operatingSystem:
type: string
description: Specifies the operating system used in the software image.
supportedVirtualisationEnvironment:
type: array
items:
type: string
description: Specifies the virtualisation environments (e.g. hypervisor) compatible with this software image.
description: |
NOTE 1: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise.
NOTE 2: The attribute may be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise.
NOTE 3: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and may be present otherwise.
Version:
type: object
required:
- srcVnfdId
- dstVnfdId
- srcFlavourId
properties:
srcVnfdId:
type: string
description: Identifier of the source VNFD and the source VNF package. See note 1.
dstVnfdId:
type: string
description: Identifier of the destination VNFD and the destination VNF package. See note 1.
srcFlavourId:
type: string
description: Identifier of the deployment flavour in the source VNF package for which this modification applies. See note 2.
description: |
NOTE 1: Either the srcVnfdId or the dstVnfdId shall be equal to the vnfdId of the VNFD containing this version selector.
NOTE 2: It is up to protocol design stage to decide whether there is further optimization potential to apply one modification for multiple srcFlavourIds.
McioConstraintParams:
title: McioConstraintParams
enum:
- localAffinityCisNode
- nodeAdditionalCapabilitySsd
- nodeAdditionalCapabilityDpdk
- nodeAdditionalCapabilitySriov
- nodeAdditionalCapabilityGpu
- nodeAdditionalCapabilityFpga
- nodeAdditionalCapabilityCpuPin
- nodeCapabilityLogicalNuma
- nodePool
type: string
description: |
The parameter names for constraints expected to be assigned to MCIOs realizing this application.The value specifies the standardized
semantical context of the MCIO constraints and the parameter names for the MCIO constraints in the MCIO declarative descriptor.The mcioConstraintParams
attribute shall have one of the following values, expressing the associated semantical context.. For the associated semantical context of the values,
refer to the description under the table 7.1.6.2.2-1 of ETSI GS NFV IFA 011 [1].
McioIdentificationData:
type: object
required:
- name
- type
properties:
name:
type: string
description: The name of the mcio. See note 1.
description: The type of the mcio. See note 2.
description: |
NOTE 1: When the container infrastructure service is a Kubernetes® instance it is the value of the 'metadata.name'
field in Kubernetes® manifest.
NOTE 2: When the container infrastructure service is a Kubernetes® instance it is the value of the 'kind' field in
Kubernetes® manifest.
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
OsContainerDescriptor:
title: OsContainerDescriptor
type: object
required:
- osContainerDescId
- name
- description
- swImageDesc
properties:
osContainerDescId:
type: string
description: Unique identifier of this OsContainerDesc in the VNFD.
name:
type: string
description: Human readable name of this OS container.
description:
type: string
description: Human readable description of this OS container.
requestedCpuResources:
type: integer
description: Number of CPU resources requested for the container (e.g. in milli-CPU-s).
requestedMemoryResources:
type: number
description: Amount of memory resources requested for the container (e.g. in MB).
requestedEphemeralStorageResources:
type: number
description: Size of ephemeral storage resources requested for the container (e.g. in GB).
extendedResourceRequests:
type: array
items:
type: object
description: An array of key-value pairs of extended resources required by the container see note.
additionalProperties:
type: string
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
description: See note.
cpuResourceLimit:
type: integer
description: Number of CPU resources the container can maximally use (e.g. in milli-CPU).
memoryResourceLimit:
type: number
description: Amount of memory resources the container can maximally use (e.g. in MB).
ephemeralStorageResourceLimit:
type: number
description: Size of ephemeral storage resources the container can maximally use (e.g. in GB).
hugePageResources:
type: object
description: Specifies HugePages resources requested for the container, which the container can maximally use.
additionalProperties:
type: string
cpuPinningRequirements:
$ref: '#/components/schemas/VirtualCpuPinningData'
description: Requirements for CPU pinning configuration for this OS container.
swImageDesc:
$ref: '#/components/schemas/SwImageDesc'
description: Describes the software image realizing this OS container.
bootData:
type: string
description: Contains a string or a URL to a file contained in the VNF package used to customize a container resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent.
monitoringParameters:
type: array
items:
$ref: '#/components/schemas/MonitoringParameter'
description: Specifies the virtualized resource related performance metrics on the OsContainerDesc level to be tracked by the VNFM.
description: |
NOTE: Extended resources are to describe any type of resource provided by the container infrastructure. One
example implementation of extended resources is "Extended Resources" in case the container infrastructure
service is a Kubernetes® instance.
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
MonitoringParameter:
type: object
required:
- monitoringParameterId
- performanceMetric
properties:
monitoringParameterId:
type: string
description: Unique identifier of the monitoring parameter.
name:
type: string
description: Human readable name of the monitoring parameter.
performanceMetric:
type: string
description: Specifies the virtualised resource performance metric.
collectionPeriod:
type: string
description: An attribute that describes the periodicity at which to collect the performance information.
VirtualComputeDescriptor:
title: VirtualComputeDescriptor
type: object
required:
- virtualComputeDescId
- virtualMemory
- virtualCpu
properties:
virtualComputeDescId:
type: string
description: Unique identifier of this VirtualComputeDesc in the VNFD.
logicalNode:
type: array
items:
$ref: '#/components/schemas/LogicalNodeRequirements'
requestAdditionalCapabilities:
type: array
items:
$ref: '#/components/schemas/RequestedAdditionalCapabilityData'
computeRequirements:
description: Specifies compute requirements.
items:
type: string
format: not-specified
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
virtualMemory:
$ref: '#/components/schemas/VirtualMemoryData'
virtualCpu:
$ref: '#/components/schemas/VirtualCpuData'
virtualDisk:
type: array
items:
$ref: '#/components/schemas/BlockStorageData'
VirtualCpuData:
type: object
required:
- numVirtualCpu
properties:
cpuArchitecture:
type: string
description: CPU architecture type. Examples are x86, ARM.
numVirtualCpu:
type: integer
description: Number of virtual CPUs.
virtualCpuClock:
type: number
description: Minimum virtual CPU clock rate (e.g. in MHz).
virtualCpuOversubscriptionPolicy:
type: string
description: The CPU core oversubscription policy, e.g. the relation of virtual CPU cores to physical CPU cores/threads.
vduCpuRequirements:
type: array
items:
type: object
description: Array of key-value pair requirements on the Compute (CPU) for the VDU.
virtualCpuPinning:
$ref: '#/components/schemas/VirtualCpuPinningData'
BlockStorageData:
type: object
required:
- sizeOfStorage
properties:
sizeOfStorage:
type: number
description: Size of virtualised storage resource in GB.
vduStorageRequirements:
type: array
items:
type: object
description: An array of key-value pairs that articulate the storage deployment requirements.
description: Array of key-value pair requirements on the storage for the VDU.
rdmaEnabled:
type: boolean
description: Indicate if the storage support RDMA.
swImageDesc:
$ref: '#/components/schemas/SwImageDesc'
description: References the software image to be loaded on the VirtualStorage resource created based on this VirtualStorageDesc. Shall be absent when used for virtual disks. See note.
description: |
NOTE: This attribute shall not be present in a VirtualStorageDesc used in a VDU realized by one or a set of OS containers
SwImageDesc:
type: object
required:
- id
- name
- version
- containerFormat
- swImage
properties:
id:
type: string
description: The identifier of this software image.
name:
type: string
description: The name of this software image.
version:
type: string
description: The version of this software image.
checksum:
$ref: '#/components/schemas/ChecksumData'
description: The checksum of the software image file. See note 3
containerFormat:
type: string
description: The container format describes the container file format in which software image is provided.
diskFormat:
type: string
description: The disk format of a software image is the format of the underlying disk image. See note 1
description: The minimal disk size requirement for this software image. The value of the "size of storage" attribute of the VirtualStorageDesc referencing this SwImageDesc shall not be smaller than the value of minDisk. See note 1
description: The minimal RAM requirement for this software image. The value of the "size" attribute of VirtualMemoryData of the Vdu referencing this SwImageDesc shall not be smaller than the value of minRam. See note 2
description: The size of this software image file. See note 3
swImage:
$ref: '#/components/schemas/SwImageDesc'
description: This is a reference to the actual software image. The reference can be relative to the root of the VNF Package or can be a URL.
operatingSystem:
type: string
description: Specifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used.
supportedVirtualisationEnvironment:
type: array
items:
type: string
description: Specifies the virtualisation environments (e.g. hypervisor) compatible with this software image.
description: |
NOTE 1: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise.
NOTE 2: The attribute may be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise.
NOTE 3: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and may be present otherwise.
ChecksumData:
type: object
required:
- algorithm
- hash
properties:
algorithm:
type: string
description: Specifies the algorithm used to obtain the checksum value see note.
hash:
type: string
description: Contains the result of applying the algorithm indicated by the algorithm attribute to the data to which this ChecksumData refers.
description: |
NOTE: The algorithm attribute value shall be one of the Hash Function Textual Names present in [2].
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
VirtualCpuPinningData:
type: object
properties:
virtualCpuPinningPolicy:
type: string
description: Indicates the policy for CPU pinning.
enum:
- STATIC
- DYNAMIC
virtualCpuPinningRule:
type: array
items:
type: string
description: List of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of "STATIC" virtualCpuPinningPolicy.
VirtualMemoryData:
type: object
required:
- virtualMemSize
properties:
virtualMemSize:
type: number
description: Amount of virtual memory in MB.
virtualMemOversubscriptionPolicy:
description: The memory core oversubscription policy in terms of virtual memory to physical memory on the platform.
vduMemRequirements:
type: array
items:
$ref: '#/components/schemas/KeyValuePair'
description: Array of key-value pair requirements on the memory for the VDU.
numaEnabled:
type: boolean
description: Specifies the memory allocation to be cognisant of the relevant process/core allocation.
hugePagesRequirements:
description: Specifies requirements on the huge pages resources for the virtual memory.
RequestedAdditionalCapabilityData:
type: object
required:
- requestedAdditionalCapabilityName
- supportMandatory
- targetPerformanceParameters
properties:
requestedAdditionalCapabilityName:
type: string
description: Specifies a requested additional capability for the VDU
supportMandatory:
type: boolean
description: Indicates whether the requested additional capability is mandatory for successful operation
minRequestedAdditionalCapabilityVersion:
type: string
description: Specifies the minimum version of the requested additional capability
preferredRequestedAdditionalCapabilityVersion:
type: string
description: Specifies the preferred version of the requested additional capability
targetPerformanceParameters:
type: array
items:
$ref: '#/components/schemas/KeyValuePair'
KeyValuePair:
type: object
properties:
key:
type: string
value:
type: string
LogicalNodeRequirements:
type: object
required:
- id
properties:
id:
type: string
format: uuid
description: Identifies this set of logical node requirements
logicalNodeRequirementDetail:
type: array
description: >
The logical node-level compute, memory and I/O requirements. An array of key-value pairs
that articulate the deployment requirements. This could include the number of CPU cores on
this logical node, a memory configuration specific to a logical node (e.g. such as available
in the Linux kernel via the libnuma library) or a requirement related to the association of
an I/O device with the logical node.
items:
type: string
format: not-specified
AppExternalCpd:
title: AppExternalCpd
type: object
properties:
inherited_attributes:
type: object
description: All attributes inherited from Cpd. See note 2.
virtualNetworkInterfaceRequirements:
type: array
$ref: '#/components/schemas/VirtualNetworkInterfaceRequirements'
description: Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD. See note 1.
additionalServiceData:
type: array
items:
$ref: '#/components/schemas/AdditionalServiceData'
description: Additional service identification data of the external CP. For the definition of AdditionalServiceData, refer to clause 7.1.18.3 of ETSI GS NFV IFA 011 [1].
description: |
NOTE 1: An AppD conformant to the present document shall not specify "virtualNetworkInterfaceRequirements" in AppExternalCpd corresponding to primary container cluster network interfaces.
NOTE 2: For CPs exposed by MEC Applications realized only by one or set of OS containers and used by the OS containers to connect to the primary container cluster external network, the ability to configure virtualised
resources based on cpRole and trunkMode attributes might not be supported by all container technologies.
AdditionalServiceData:
type: object
required:
- portData
properties:
portData:
type: array
items:
$ref: '#/components/schemas/ServicePortData'
minItems: 1
serviceData:
type: object
description: Service matching information exposed by the VirtualCp. See note.
description: |
NOTE: This attribute shall only be present if additional information is needed to identify the service termination within
the VNF, such as for example a url path information in an HTTP request required to allow a single VirtualCp IP
address to be used for several HTTP based services that use the same portnumber.
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
ServicePortData:
type: object
required:
- name
- protocol
- port
- portConfigurable
properties:
name:
type: string
description: The name of the port exposed by the VirtualCp.
protocol:
type: string
enum:
- TCP
- UDP
- SCTP
description: The L4 protocol for this port exposed by the VirtualCp.
port:
type: integer
description: The L4 port number exposed by the VirtualCp.
portConfigurable:
type: boolean
description: Specifies whether the port attribute value is allowed to be configurable.
VirtualNetworkInterfaceRequirements:
type: object
properties:
name:
type: string
description: Provides a human readable name for the requirement.
description:
type: string
description: Provides a human readable description of the requirement.
standardizedNetworkInterfaceRequirements:
type: string
description: The requirements on standardized network interface capabilities, e.g. SR-IOV or secondary container cluster network interface deployment requirements.See note
networkInterfaceRequirements:
type: string
description: The additional network interface requirements beyond those specified in the standardizedNetworkInterfaceRequirements attribute.An element from an array of key-value pairs that articulate the network interface deployment requirements.See note.
nicIoRequirements:
items:
$ref: '#/components/schemas/LogicalNodeRequirements'
description: This references (couples) the CPD with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that I/O requirements that need to be articulated at the logical node level can be associated with the network
interface requirements associated with the CPD.See note
description: |
NOTE: At least one of the attributes "standardizedNetworkInterfaceRequirements", "networkInterfaceRequirements", "nicIoRequirements" shall be present
- 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.
description: Information of application software image in application package. Type is TBD. See note 1.
type: array
items:
type: string
format: not-specified
additionalArtifacts:
description: |
Additional information of application package artifacts that are not application
software images. Type is TBD. See note 2.
type: array
items:
type: string
format: not-specified
onboardingState:
$ref: '#/components/schemas/OnboardingState'
operationalState:
$ref: '#/components/schemas/AppPkg.OperationalState'
usageState:
$ref: '#/components/schemas/UsageState'
mecInfo:
type: array
description: The MEC version that compatible with this application. This information is copied from the AppD.
items:
type: string
onBoardingFailureDetails:
description: Failure details of current onboarding procedure
$ref: '#/components/schemas/ProblemDetails'
$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
NOTE 1: The data type of application software image information data model is related to virtualisation method and
needs for further study.
NOTE 2: The data type of additional information of application package artifacts is not specified in the present
document.
NOTE 3: This attribute applies only for the MEAO
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
description: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "notificationId" attribute of all
these notifications shall have the same value.
notificationType:
$ref: '#/components/schemas/AppPkg.NotificationType'
subscriptionId:
type: string
description: Identifier of the subscription related to this notification.
timeStamp:
$ref: '#/components/schemas/TimeStamp'
appPkgId:
type: string
description: Identifier of the onboarded application package.
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. see note.
description: Match the application descriptor identifier which is allocated by the application provider. The attributes "appPkgInfoId ", and "appDId" are alternatives to reference particular application package in a filter. See note.
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
appProvider:
type: string
description: Match the provider's name of the onboarded application.
appName:
type: string
description: Match the name of the onboarded application.
appSoftwareVersion:
type: string
description: Match the software version of the application package.
appDVersion:
type: string
description: Match the version of the application descriptor.
operationalState:
type: string
description: Match particular operational state of the application package. May be present if the "subscriptionType" attribute contains the value "AppPackageChangeSubscription", and shall be absent otherwise.
enum:
- ENABLED
- DISABLED
usageState:
type: string
description: Match particular usage state of the application package. May be present if the "subscriptionType" attribute contains the value "AppPackageChangeSubscription", and shall be absent otherwise.
enum:
- N_USE
- NOT_IN_USE
description: |
NOTE: The attributes "appPkgInfoId ", and "appDId" are alternatives to reference particular application package in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.
required:
- algorithm
- hash
type: object
properties:
algorithm:
type: string
description: Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.
hash:
type: string
description: "'String 1 The hexadecimal value of the checksum'"
title: CreateAppPkg
required:
- appPkgName
- appPkgPath
- appPkgVersion
- checksum
type: object
description: Name of the application package to be onboarded.
description: Address information of the application package. See note.
description: Version of the application package to be onboarded.The appPkgName with appPkgVersion can be used to uniquely identify the application package.
description: The provider's name of the application package to be onboarded.
checksum:
$ref: '#/components/schemas/Checksum'
userDefinedData:
$ref: '#/components/schemas/KeyValuePairs'
description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
description: |
NOTE: It is for further study how to convey appPkgPath, and align with ETSI GS NFV-SOL 005 [i.7].
additionalProperties:
type: object
type: object
properties:
href:
type: string
description: URI referring to a resource
title: ProblemDetails
type: object
description: A human-readable explanation specific to this occurrence of the problem
description: A URI reference that identifies the specific occurrence of the problem
description: The HTTP status code for this occurrence of the problem
description: A short, human-readable summary of the problem type
description: A URI reference according to IETF RFC 3986 that identifies the problem type
title: TimeStamp
required:
- nanoSeconds
- seconds
type: object
description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
OperationalState:
title: OperationalState
enum:
- DISABLED
- ENABLED
examples:
- DISABLED
OperationState:
title: OperationState
enum:
- DISABLED
- ENABLED
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
responses:
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests: used when a rate limiter has triggered.'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'