openapi: 3.1.0 info: 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' contact: name: ETSI Forge url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api email: cti_support@etsi.org version: '3.0.1' jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema externalDocs: description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v3.0.1' url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/03.00.01_60/gs_MEC01002v030001p.pdf' tags: - name: app-pkgm description: App Package management - name: app-pkgm-notifications description: App Package management notifications servers: - url: https://localhost/app_pkgm/v1 variables: {} paths: /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: 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 contentMediaType: application/json '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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: 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: '' contentMediaType: application/json '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] /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 contentMediaType: application/json '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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: '' contentMediaType: application/json '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] /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: 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: $ref: '#/components/schemas/AppPkgInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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: 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' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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: 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: $ref: '#/components/schemas/AppPkgInfoModifications' 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' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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: $ref: '#/components/schemas/AppPkgInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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: $ref: '#/components/schemas/AppPkgInfoModifications' 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' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] /subscriptions: post: tags: - app-pkgm summary: 'Subscribe to notifications about on-boarding an application package' description: Subscribe to notifications about on-boarding an application package operationId: subscriptionsPOST parameters: [] requestBody: description: The input parameters of subscribe operation to notifications content: application/json: schema: $ref: '#/components/schemas/AppPkgSubscription' required: true responses: '201': description: Successful response for created subscription headers: {} content: application/json: schema: $ref: '#/components/schemas/AppPkgSubscriptionInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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" get: tags: - app-pkgm 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 operationId: subscriptionsGET parameters: [] responses: '200': description: List of zero or more subscriptions headers: {} content: application/json: schema: $ref: '#/components/schemas/AppPkgSubscriptionLinkList' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] /subscriptions/{subscriptionId}: get: tags: - app-pkgm summary: 'Used to represent an individual subscription to notifications about application package changes.' description: Used to represent an individual subscription to notifications about application package changes. operationId: individualSubscriptionGET parameters: - name: subscriptionId in: path description: Identifier of an individual subscription to notifications about application package changes required: true style: simple schema: type: string responses: '200': description: a response body containing a representation of the resource shall be returned. headers: {} content: application/json: schema: $ref: '#/components/schemas/AppPkgSubscriptionInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false delete: tags: - app-pkgm 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. operationId: individualSubscriptionDELETE parameters: - name: subscriptionId in: path description: Identifier of an individual subscription to notifications about application package changes required: true style: simple schema: type: string responses: '204': description: No Content headers: {} content: {} '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] /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 parameters: - 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 responses: '200': description: Content of the AppD is returned. headers: {} content: text/plain: schema: $ref: '#/components/schemas/AppD' application/zip: {} '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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 parameters: - 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 responses: '200': description: Content of the AppD is returned. headers: {} content: text/plain: schema: $ref: '#/components/schemas/AppD' application/zip: {} '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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: {} '206': 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. headers: {} content: application/zip: {} '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false 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': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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: 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. headers: {} content: {} '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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: {} required: false 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' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] ############################################################################### # Notification endpoint AppPkgNotification # ############################################################################### /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: {} '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] components: schemas: AppD: title: AppD required: - appDId - appDVersion - appDescription - appName - appProvider - appSoftVersion - mecVersion - swImageDescriptor - virtualComputeDescriptor - appExtCpd type: object properties: appDId: type: string description: Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1. appDNSRule: type: array items: $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. 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. 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. 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. mcioConstraintParams: $ref: '#/components/schemas/McioConstraintParams' appDVersion: type: string description: Identifies the version of the application descriptor. appDescription: type: string description: Human readable description of the MEC application. appExtCpd: type: array items: $ref: '#/components/schemas/AppExternalCpd' description: | Describes external interface(s) exposed by this MEC application. See note 4. NOTE 4: External interfaces are used to connect to e.g. other MEC applications, MEC services, UEs and also MEC platform and OSS. appFeatureOptional: type: array items: $ref: './definitions/MEC010p2_definitions.yaml#/definitions/FeatureDependency' description: Describes features a MEC application may use if available. appFeatureRequired: type: array items: $ref: './definitions/MEC010p2_definitions.yaml#/definitions/FeatureDependency' description: Describes features a MEC application requires to run. appInfoName: type: string description: Human readable name for the MEC application. appLatency: $ref: './definitions/MEC010p2_definitions.yaml#/definitions/LatencyDescriptor' appName: type: string description: Name to identify the MEC application. appProvider: type: string description: Provider of the application and of the AppD. appServiceOptional: type: array items: $ref: './definitions/MEC010p2_definitions.yaml#/definitions/ServiceDependency' description: Describes services a MEC application may use if available. appServiceProduced: type: array items: $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: type: array items: $ref: './definitions/MEC010p2_definitions.yaml#/definitions/ServiceDependency' description: Describes services a MEC application requires to run. appSoftVersion: type: string description: Identifies the version of software of the MEC application. mciopId: type: string 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. NOTE 7: This attribute reflects the ETSI NFV interpretation of the cloud native workloads. mcioIdentificationData: type: string items: $ref: '#/components/schemas/McioIdentificationData' appTrafficRule: type: array items: $ref: './definitions/MEC010p2_definitions.yaml#/definitions/TrafficRuleDescriptor' description: Describes traffic rules the MEC application requires. changeAppInstanceStateOpConfig: type: string description: NFV mecVersion: type: array items: type: string 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 .. where , and are decimal numbers representing the version of the present document. Whitespace between list entries shall be trimmed before validation. swImageDescriptor: type: string description: | Describes the descriptors of the software image to be used by the virtualisation container used to realize this MEC application. See note 5. NOTE 5: Only one of virtualComputeDescriptor or osContainerDescriptor shall be present. If virtualComputeDescriptor presents, only a single swImageDescriptor shall be provided. terminateAppInstanceOpConfig: type: string description: NFV transportDependencies: type: array items: $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. virtualComputeDescriptor: 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: $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. NOTE 5: Only one of virtualComputeDescriptor or osContainerDescriptor shall be present. If virtualComputeDescriptor presents, only a single swImageDescriptor shall be provided. NOTE 7: This attribute reflects the ETSI NFV interpretation of the cloud native workloads. 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]. See note 7. NOTE 7: This attribute reflects the ETSI NFV interpretation of the cloud native workloads. McioIdentificationData: type: object required: - name - type properties: name: type: string description: | The name of the mcio. See note 1. NOTE 1: When the container infrastructure service is a Kubernetes® instance it is the value of the 'metadata.name' field in Kubernetes® manifest. type: type: string description: | The type of the mcio. See note 2. NOTE 2: When the container infrastructure service is a Kubernetes® instance it is the value of the 'kind' field in Kubernetes® manifest. 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. 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. additionalProperties: type: string 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. 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: type: array description: Not Specified. 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. 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. 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. minDisk: type: number 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. minRam: type: number 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. size: type: number description: The size of this software image file. 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. virtualStorageDescriptor: type: array items: type: string description: Defines descriptors of virtual storage resources to be used by the MEC application. userContextTransferCapability: $ref: './definitions/MEC010p2_definitions.yaml#/definitions/UserContextTransferCapability' appNetworkPolicy: $ref: './definitions/MEC010p2_definitions.yaml#/definitions/AppNetworkPolicy' 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. NOTE: The algorithm attribute value shall be one of the Hash Function Textual Names present in [2]. 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. AppExternalCpd: title: AppExternalCpd type: object properties: inherited_attributes: type: object description: | All attributes inherited from Cpd. See note 2. 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. virtualNetworkInterfaceRequirements: type: array items: $ref: '#/components/schemas/VirtualNetworkInterfaceRequirements' description: | Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD. See note 1. NOTE 1: An AppD conformant to the present document shall not specify "virtualNetworkInterfaceRequirements" in AppExternalCpd corresponding to primary container cluster network interfaces. 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]. 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. 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. 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 NOTE: At least one of the attributes "standardizedNetworkInterfaceRequirements", "networkInterfaceRequirements", "nicIoRequirements" shall be present. 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. NOTE: At least one of the attributes "standardizedNetworkInterfaceRequirements", "networkInterfaceRequirements", "nicIoRequirements" shall be present. 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 NOTE: At least one of the attributes "standardizedNetworkInterfaceRequirements", "networkInterfaceRequirements", "nicIoRequirements" shall be present. AppPkgInfo: title: AppPkgInfo required: - id - appDId - appName - appSoftwareVersion - appDVersion - checksum - softwareImages - onboardingState - operationalState - usageState - mecInfo - _links type: object properties: id: type: string description: Identifier of the onboarded application package. appDId: type: string description: Identifier of this MEC application descriptor. This attribute shall be globally unique. appProvider: type: string description: Provider of the application and of the AppD. appName: type: string description: Name to identify the MEC application. appSoftwareVersion: type: string description: Software version of the application. This is updated when there is any change to the software in the onboarded application package. appDVersion: type: string description: Identifies the version of the application descriptor. checksum: $ref: '#/components/schemas/Checksum' signingCertificate: type: string description: The singleton signing certificate if it is included as a file in the AppD archive. softwareImages: type: object description: | Information of application software image in application package. Type is TBD. See note 1. NOTE 1: The data type of application software image information data model is related to virtualisation method and needs for further study. additionalArtifacts: type: object description: | Additional information of application package artifacts that are not application software images. Type is TBD. See note 2. NOTE 2: The data type of additional information of application package artifacts is not specified in the present document. 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' 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'" _links: $ref: '#/components/schemas/AppPkgInfo.links' description: "'The data type AppPkgInfo represents the parameters for an application package resource'" AppPkgInfoModifications: title: AppPkgInfoModifications required: - operationState type: object properties: operationState: $ref: '#/components/schemas/OperationState' description: "'The data type represents the operational state for an application package resource'" AppPkg.OperationalState: title: AppPkg.OperationalState enum: - ENABLED - DISABLED type: string 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 enum: - CREATED - UPLOADING - PROCESSING - ONBOARDED type: string description: Onboarding state of application package examples: - CREATED UsageState: title: UsageState enum: - IN_USE - NOT_IN_USE type: string description: Usage state of the onboarded instance of the application package examples: - IN_USE AppPkgInfo.links: title: AppPkgInfo.links required: - 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. AppPkgNotification: title: AppPkgNotification required: - id - notificationType - subscriptionId - timeStamp - appPkgId - appDId - operationalState - _links type: object properties: id: type: string 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. appDId: type: string 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'" AppPkg.NotificationType: title: AppPkg.NotificationType enum: - AppPackageOnBoarded - AppPacakgeEnabled - AppPacakgeDisabled - AppPackageDeleted type: string description: Discriminator for the different notification types examples: - AppPackageOnBoarded AppPkgNotification.links: title: AppPkgNotification.links required: - subscription type: object properties: subscription: $ref: '#/components/schemas/LinkType' description: Links to resources related to this resource. AppPkgSubscriptionInfo: title: AppPkgSubscriptionInfo required: - id - subscriptionType - callbackUri - _links type: object properties: id: type: string description: Identifier of the subscription to application package notification. subscriptionType: description: Type of subscription. $ref: '#/components/schemas/AppPkgSubscriptionType' callbackUri: 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 enum: - AppPackageOnBoardingSubscription - AppPackageChangeSubscription - AppPackageDeletionSubscription type: string description: type of a subscription. examples: - AppPackageOnBoardingSubscription AppPkgSubscriptionInfo.links: title: AppPkgSubscriptionInfo.links required: - self type: object properties: self: $ref: '#/components/schemas/LinkType' description: Links to resources related to this resource. AppPkgSubscriptionLinkList: title: AppPkgSubscriptionLinkList required: - _links type: object properties: _links: $ref: '#/components/schemas/AppPkgSubscriptionLinkList.links' description: "'The data type represents a subscription link list of notification on application package management'" AppPkgSubscriptionLinkList.links: title: AppPkgSubscriptionLinkList.links required: - self type: object properties: self: $ref: '#/components/schemas/LinkType' subscriptions: type: array items: $ref: '#/components/schemas/Subscriptions.AppPkgSubscription' description: '' description: Links to resources related to this resource. Subscriptions.AppPkgSubscription: title: Subscriptions.AppPkgSubscription required: - href - subscriptionType type: object properties: href: 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.'" AppPkgSubscription: title: AppPkgSubscription required: - callbackUri - subscriptionType type: object properties: callbackUri: type: string description: The URI of the endpoint for the notification to be sent to. subscriptionType: $ref: '#/components/schemas/AppPkgSubscriptionType' appPkgFilter: type: array items: $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: type: string 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. 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 Checksum: title: Checksum 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'" CreateAppPkg: title: CreateAppPkg required: - appPkgName - appPkgPath - appPkgVersion - checksum type: object properties: appPkgName: type: string description: Name of the application package to be onboarded. appPkgPath: type: string format: uri appPkgVersion: type: string description: >- Version of the application package to be onboarded.The appPkgName with appPkgVersion can be used to uniquely identify the application package. appProvider: type: string 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'" KeyValuePairs: type: object additionalProperties: type: object LinkType: title: LinkType required: - href type: object properties: href: type: string description: URI referring to a resource ProblemDetails: title: ProblemDetails type: object properties: detail: type: string description: A human-readable explanation specific to this occurrence of the problem instance: type: string description: A URI reference that identifies the specific occurrence of the problem status: type: integer description: The HTTP status code for this occurrence of the problem contentEncoding: int32 title: type: string description: A short, human-readable summary of the problem type type: type: string description: A URI reference according to IETF RFC 3986 that identifies the problem type TimeStamp: title: TimeStamp required: - nanoSeconds - seconds type: object properties: nanoSeconds: type: integer description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. contentEncoding: int32 seconds: type: integer description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. contentEncoding: int32 OperationalState: title: OperationalState enum: - DISABLED - ENABLED type: string examples: - DISABLED OperationState: title: OperationState enum: - DISABLED - ENABLED type: string examples: - DISABLED 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' security: - {}