diff --git a/.jenkins.sh b/.jenkins.sh new file mode 100755 index 0000000000000000000000000000000000000000..74d0370875e23476bf3a058ebcb825f7494b3de7 --- /dev/null +++ b/.jenkins.sh @@ -0,0 +1,18 @@ +#!/bin/bash + +specfiles=$(ls | egrep "^[^.]*.(json|yaml)") + +fres=0 +for i in $specfiles ; do + echo "-- Validating and linting OpenAPI file $i..." + swagger-cli validate $i + res=$? + speccy lint "$i" + res2=$? + fres=$(($fres||$res||$res2)) + echo "--- Validator returned $res, linter returned $res2." +done + +echo "-- Final validator returns $fres." +exit $fres + diff --git a/MEC010-2_AppGrant.json b/MEC010-2_AppGrant.json new file mode 100644 index 0000000000000000000000000000000000000000..e8e3ad8042098393d72e5159f4dcfe94f85c5fa9 --- /dev/null +++ b/MEC010-2_AppGrant.json @@ -0,0 +1,1019 @@ +{ + "info": { + "title": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management", + "version": "2.1.1", + "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", + "email": "cti_support@etsi.org", + "url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api" + } + }, + "externalDocs": { + "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1", + "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf" + }, + "servers": [ + { + "url": "https://localhost/granting/v1" + } + ], + "openapi": "3.0.0", + "tags": [ + { + "name": "granting", + "description": "Grant operations" + } + ], + "paths": { + "/grants": { + "post": { + "tags": [ + "granting" + ], + "summary": "requests a grant for a particular application lifecycle operation", + "description": "requests a grant for a particular application lifecycle operation", + "operationId": "grantPOST", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GrantRequest" + } + } + } + }, + "responses": { + "201": { + "description": "grant was created successfully (synchronous mode)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Grant" + } + } + } + }, + "202": { + "description": "the request was accepted for processing" + }, + "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" + } + } + } + }, + "/grants/{grantId}": { + "parameters": [ + { + "in": "path", + "name": "grantId", + "description": "Identifier of the individual grant.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "get": { + "tags": [ + "granting" + ], + "summary": "read the grant", + "description": "read the grant", + "operationId": "GrantGET", + "responses": { + "200": { + "description": "IA representation of the \"individual grant\" resource ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Grant" + } + } + } + }, + "202": { + "description": "returned when the process of creating the grant is ongoing, no grant is available yet" + }, + "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" + } + } + } + } + }, + "components": { + "schemas": { + "AppExtCpConfig": { + "properties": { + "cpInstanceId": { + "description": "Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. \n\nShall be present if this instance has already been created. ", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "cpProtocolData": { + "description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note.", + "items": { + "$ref": "#/components/schemas/CpProtocolData" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "CpProtocolData" + }, + "linkPortId": { + "description": "Identifier of a pre-configured link port to which the external CP will be associated. See note.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + } + }, + "type": "object", + "x-etsi-notes": "NOTE:\tThe following conditions apply to the attributes \"linkPortId\" and \" cpProtocolData\": \nThe \"linkPortId\" and \"cpProtocolData\" attributes shall both be absent for the deletion of an existing external CP instance addressed by cpInstanceId. \nAt least one of these attributes shall be present for a to-be-created external CP instance or an existing external CP instance.\nIf the \"linkPortId\" attribute is absent, the MEPM shall create a link port.\nIf the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port, and the MEPM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port.\nIf both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the pre-created link port referenced by \"linkPortId\".", + "x-etsi-ref": "6.2.4.13" + }, + "AppExtCpData": { + "properties": { + "cpConfig": { + "description": "List of instance data that need to be configured on the CP instances created from the respective CPD.", + "items": { + "$ref": "#/components/schemas/AppExtCpConfig" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "AppExtCpConfig" + }, + "cpdId": { + "description": "The identifier of the CPD in the AppD.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "cpdId", + "cpConfig" + ], + "type": "object", + "x-etsi-ref": "6.2.4.12" + }, + "AppInstanceId": { + "description": "Identifier of application instance.", + "type": "string" + }, + "AppDId": { + "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique.", + "type": "string" + }, + "AppLcmOpOccId": { + "description": "Identifier of application lifecycle management operation occurrence.", + "type": "string" + }, + "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'", + "type": "object", + "additionalProperties": true + }, + "ResourceDefinition.Type": { + "description": "Type of the resource definition referenced.", + "type": "string", + "format": "enum", + "enum": [ + "COMPUTE", + "VL", + "STORAGE", + "LINKPORT" + ] + }, + "CpProtocolData": { + "properties": { + "ipOverEthernet": { + "$ref": "#/components/schemas/IpOverEthernetAddressData" + }, + "layerProtocol": { + "$ref": "#/components/schemas/IpOverEthernetAddressData" + } + }, + "required": [ + "layerProtocol" + ], + "type": "object", + "x-etsi-notes": "NOTE:\tThis attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.", + "x-etsi-ref": "6.2.4.14" + }, + "ExtLinkPortData": { + "properties": { + "id": { + "description": "Identifier of this link port as provided by the entity that has created the link port.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "resourceHandle": { + "$ref": "#/components/schemas/ResourceHandle" + } + }, + "required": [ + "id", + "resourceHandle" + ], + "type": "object", + "x-etsi-ref": "6.2.4.9" + }, + "ExtVirtualLinkData": { + "properties": { + "extCps": { + "description": "External CPs of the application instance to be connected to this external VL.", + "items": { + "$ref": "#/components/schemas/AppExtCpData" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "AppExtCpData" + }, + "extLinkPorts": { + "description": "Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the MEPM shall create the link ports on the external VL.", + "items": { + "$ref": "#/components/schemas/ExtLinkPortData" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "ExtLinkPortData" + }, + "id": { + "description": "The identifier of the external VL instance. The identifier is assigned by the MEC entity that manages this VL instance.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "resourceId": { + "description": "The identifier of the resource in the scope of the VIM.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "vimConnectionId": { + "description": "Identifier of the VIM connection to manage this resource. ", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "id", + "resourceId", + "extCps" + ], + "type": "object", + "x-etsi-ref": "6.2.4.8" + }, + "Grant": { + "description": "'This type represents a grant. Refer to clause 9.5.2.3 of ETSI GS NFV-SOL 003 '", + "type": "object", + "required": [ + "id", + "appInstanceId", + "appLcmOpOccId", + "_links" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/Grant.Id" + }, + "appInstanceId": { + "$ref": "#/components/schemas/AppInstanceId" + }, + "appLcmOpOccId": { + "$ref": "#/components/schemas/AppLcmOpOccId" + }, + "vimConnections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VimConnectionInfo" + } + }, + "zones": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ZoneInfo" + } + }, + "zoneGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ZoneGroupInfo" + } + }, + "addResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GrantInfo" + } + }, + "tempResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GrantInfo" + } + }, + "removeResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GrantInfo" + } + }, + "updateResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GrantInfo" + } + }, + "vimAssets": { + "$ref": "#/components/schemas/VimAssets" + }, + "extVirtualLinks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExtVirtualLinkData" + } + }, + "additionalParams": { + "$ref": "#/components/schemas/KeyValuePairs" + }, + "_links": { + "$ref": "#/components/schemas/Grant.links" + } + } + }, + "Grant.Id": { + "type": "string" + }, + "VimAssets": { + "description": "Information about assets for the application that are managed by the MEO in the VIM, such as software images.", + "type": "object", + "properties": { + "softwareImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftwareImages" + } + } + } + }, + "SoftwareImages": { + "$ref": "#/components/schemas/VimSoftwareImage" + }, + "Grant.links": { + "description": "Links to resources related to this resource.", + "type": "object", + "required": [ + "appLcmOpOcc", + "appInstance" + ], + "properties": { + "appLcmOpOcc": { + "$ref": "#/components/schemas/LinkType" + }, + "appInstance": { + "$ref": "#/components/schemas/LinkType" + } + } + }, + "GrantInfo": { + "properties": { + "resourceDefinitionId": { + "description": "Identifier of the related \"ResourceDefinition\" structure from the related \"GrantRequest\" structure.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "resourceGroupId": { + "description": "Identifier of the \"infrastructure resource group\", logical grouping of virtual resources assigned to a tenant within an Infrastructure Domain, to be provided when allocating the resource.If the VIM connection referenced by \"vimConnectionId\" applies to multiple infrastructure resource groups, this attribute shall be present for new resources.If the VIM connection referenced by \"vimConnectionId\" applies to a single infrastructure resource group, this attribute may be present for new resources. This attribute shall be absent for resources that have already been allocated.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "vimConnectionId": { + "description": "Identifier of the VIM connection to be used to manage this resource. Shall be present for new resources, and shall be absent for resources that have already been allocated.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "zoneId": { + "description": "Reference to the identifier of the \"ZoneInfo\" structure in the \"Grant\" structure defining the resource zone into which this resource is to be placed. Shall be present for new resources if the zones concept is applicable to them (typically, Compute resources), and shall be absent for resources that have already been allocated.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "resourceDefinitionId" + ], + "type": "object", + "x-etsi-ref": "6.2.4.5" + }, + "GrantRequest": { + "description": "'This type represents a grant request. Refer to clause 9.5.2.2 of ETSI GS NFV-SOL 003'", + "type": "object", + "required": [ + "appInstanceId", + "appLcmOpOccId", + "appDId", + "operation", + "_links" + ], + "properties": { + "appInstanceId": { + "$ref": "#/components/schemas/AppInstanceId" + }, + "appLcmOpOccId": { + "$ref": "#/components/schemas/AppLcmOpOccId" + }, + "appDId": { + "$ref": "#/components/schemas/AppDId" + }, + "operation": { + "$ref": "#/components/schemas/GrantRequest.Operation" + }, + "addResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceDefinition" + } + }, + "tempResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceDefinition" + } + }, + "removeResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceDefinition" + } + }, + "updateResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceDefinition" + } + }, + "additionalParams": { + "$ref": "#/components/schemas/KeyValuePairs" + }, + "_links": { + "$ref": "#/components/schemas/GrantRequest.links" + } + } + }, + "GrantRequest.Operation": { + "description": "'The lifecycle management operation for which granting is requested'", + "type": "string", + "enum": [ + "INSTANTIATE", + "OPERATE", + "TERMINATE" + ] + }, + "GrantRequest.links": { + "description": "Links to resources related to this resource.", + "type": "object", + "required": [ + "appLcmOpOcc", + "appInstance" + ], + "properties": { + "appLcmOpOcc": { + "$ref": "#/components/schemas/LinkType" + }, + "appInstance": { + "$ref": "#/components/schemas/LinkType" + } + } + }, + "IpOverEthernetAddressData": { + "description": "'This type represents network address data for IP over Ethernet. Refer to clause 4.4.1.10c of ETSI GS NFV SOL 003'", + "type": "object", + "properties": { + "macAddress": { + "$ref": "#/components/schemas/MacAddress" + }, + "ipAddresses": { + "$ref": "#/components/schemas/IpAddresses" + } + } + }, + "MacAddress": { + "description": "'MAC address. If this attribute is not present, it shall be chosen by the VIM'", + "type": "string" + }, + "IpAddresses": { + "description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.", + "type": "array", + "items": { + "$ref": "#/components/schemas/IpAddress" + } + }, + "IpAddress": { + "description": "'IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.'", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/IpAddress.Type" + }, + "fixedAddresses": { + "$ref": "#/components/schemas/FixedAddresses" + }, + "numDynamicAddresses": { + "$ref": "#/components/schemas/NumDynamicAddresses" + }, + "addressRange": { + "$ref": "#/components/schemas/AddressRange" + }, + "subnetId": { + "$ref": "#/components/schemas/SubnetId" + } + } + }, + "IpAddress.Type": { + "description": "The type of the IP addresses.", + "type": "string", + "enum": [ + "IPV4", + "IPV6" + ] + }, + "FixedAddresses": { + "description": "Fixed addresses to assign (from the subnet defined by subnetId if provided).", + "type": "array", + "items": { + "$ref": "#/components/schemas/FixedAddress" + } + }, + "NumDynamicAddresses": { + "description": "Number of dynamic addresses to assign (from the subnet defined by subnetId if provided)", + "type": "integer" + }, + "AddressRange": { + "description": "An IP address range to be used, e.g. in case of egress connections.", + "type": "object", + "required": [ + "minAddress", + "maxAddress" + ], + "properties": { + "minAddress": { + "$ref": "#/components/schemas/MinAddress" + }, + "maxAddress": { + "$ref": "#/components/schemas/MaxAddress" + } + } + }, + "MinAddress": { + "description": "Lowest IP address belonging to the range.", + "type": "string" + }, + "MaxAddress": { + "description": "Highest IP address belonging to the range.", + "type": "string" + }, + "FixedAddress": { + "description": "Fixed addresses to assign (from the subnet defined by subnetId if provided)", + "type": "string" + }, + "SubnetId": { + "description": "Subnet defined by the identifier of the subnet resource in the VIM.", + "type": "string" + }, + "LinkType": { + "properties": { + "href": { + "description": "URI referring to a resource", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "URI" + } + }, + "required": [ + "href" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "ProblemDetails": { + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "instance": { + "description": "A URI reference that identifies the specific occurrence of the problem", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + }, + "status": { + "description": "The HTTP status code for this occurrence of the problem", + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "title": { + "description": "A short, human-readable summary of the problem type", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "type": { + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + } + }, + "type": "object" + }, + "ResourceDefinition": { + "description": "'This type provides information of an existing or proposed resource used by the application. Refer to clause 9.5.3.2 of ETSI GS NFV-SOL 003 '", + "type": "object", + "required": [ + "id", + "type", + "resourceTemplateId", + "resource" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/ResourceDefinitionId" + }, + "type": { + "$ref": "#/components/schemas/ResourceDefinition.Type" + }, + "vduId": { + "$ref": "#/components/schemas/VduId" + }, + "resourceTemplateId": { + "$ref": "#/components/schemas/ResourceTemplateId" + }, + "resource": { + "$ref": "#/components/schemas/Resource" + } + } + }, + "ResourceDefinitionId": { + "description": "Identifier of the related ResourceDefinition structure from the related GrantRequest structure.", + "type": "string" + }, + "VduId": { + "description": "Reference to the related VDU in the AppD applicable to this resource.", + "type": "string" + }, + "ResourceTemplateId": { + "description": "Reference to a resource template, i.e. VirtualLinkDesc, VirtualComputeDesc, AppExtCpd, VirtualStorageDesc in the AppD.", + "type": "string" + }, + "Resource": { + "description": "Resource information for an existing resource", + "type": "object", + "required": [ + "vimConnectionInfo", + "resourceId" + ], + "properties": { + "vimConnectionInfo": { + "$ref": "#/components/schemas/VimConnectionInfo" + }, + "resourceId": { + "$ref": "#/components/schemas/ResourceId" + } + } + }, + "ResourceId": { + "description": "Identifier of the resource in the scope of the VIM.", + "type": "string" + }, + "ResourceHandle": { + "properties": { + "resourceId": { + "description": "Identifier of the resource in the scope of the VIM.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "vimConnectionId": { + "description": "Identifier of the VIM connection to manage the resource.The applicable \"VimConnectionInfo\" structure, which is referenced by vimConnectionId, can be obtained from the \"vimConnectionInfo\" attribute of the \"AppInstance\" structure.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "vimLevelResourceType": { + "description": "Type of the resource in the scope of the VIM. See note.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "resourceId" + ], + "type": "object", + "x-etsi-notes": "NOTE:\tThe value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition.", + "x-etsi-ref": "6.2.4.10" + }, + "VimConnectionInfo": { + "properties": { + "accessInfo": { + "$ref": "#/components/schemas/KeyValuePairs" + }, + "extra": { + "$ref": "#/components/schemas/KeyValuePairs" + }, + "id": { + "description": "The identifier of the VIM Connection. This identifier is managed by the MEO.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "interfaceInfo": { + "$ref": "#/components/schemas/KeyValuePairs" + }, + "vimId": { + "description": "The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "vimType": { + "description": "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. ", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "id", + "vimType" + ], + "type": "object", + "x-etsi-ref": "6.2.2.18" + }, + "VimSoftwareImage": { + "properties": { + "appDSoftwareImageId": { + "description": "Identifier which references the software image descriptor in the AppD.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "vimConnectionId": { + "description": "Identifier of the VIM connection to access the software image referenced in this structure. ", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "vimSoftwareImageId": { + "description": "Identifier of the software image in the resource management layer (i.e. VIM).", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "appDSoftwareImageId", + "vimSoftwareImageId" + ], + "type": "object", + "x-etsi-ref": "6.2.4.11" + }, + "ZoneGroupInfo": { + "properties": { + "zoneId": { + "description": "References of identifiers of \"ZoneInfo\" structures, each of which provides information about a resource zone that belongs to this group.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "zoneId" + ], + "type": "object", + "x-etsi-ref": "6.2.4.7" + }, + "ZoneInfo": { + "properties": { + "id": { + "description": "The identifier of this ZoneInfo instance, for the purpose of referencing it from other structures in the \"Grant\" structure.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "vimConnectionId": { + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "zoneId": { + "description": "The identifier of the resource zone, as managed by the resource management layer (typically, the VIM).", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "id", + "zoneId" + ], + "type": "object", + "x-etsi-ref": "6.2.4.6f" + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "206": { + "description": "Partial content" + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "412": { + "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "414": { + "description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "415": { + "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "416": { + "description": "Range Not Satisfiable ." + }, + "422": { + "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "example": { + "application/problem+json": { + "problemDetails": { + "type": "https://meAppServer.example.com/rni/v2/probs/too-many targets", + "title": "Too many targets", + "status": "422", + "detail": "The target area for the request is considered too large", + "instance": "/meAppClient.example.com/77777/msgs/abc" + } + } + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/MEC010-2_AppGrant.yaml b/MEC010-2_AppGrant.yaml new file mode 100644 index 0000000000000000000000000000000000000000..11021b432ac0964f0e544c2453fd76ea2606011d --- /dev/null +++ b/MEC010-2_AppGrant.yaml @@ -0,0 +1,764 @@ +info: + title: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management" + version: 2.1.1 + 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 + email: cti_support@etsi.org + url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api +externalDocs: + description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1" + url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf' +servers: + - url: 'https://localhost/granting/v1' +openapi: 3.0.0 +tags: + - name: granting + description: Grant operations +paths: + /grants: + post: + tags: + - 'granting' + summary: 'requests a grant for a particular application lifecycle operation' + description: 'requests a grant for a particular application lifecycle operation' + operationId: grantPOST + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/GrantRequest' + responses: + '201': + description: grant was created successfully (synchronous mode) + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + '202': + description: the request was accepted for processing + '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' + /grants/{grantId}: + parameters: + - in: path + name: grantId + description: 'Identifier of the individual grant.' + schema: + type: string + required: true + get: + tags: + - 'granting' + summary: 'read the grant' + description: 'read the grant' + operationId: GrantGET + responses: + '200': + description: 'IA representation of the "individual grant" resource ' + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + '202': + description: 'returned when the process of creating the grant is ongoing, no grant is available yet' + '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' + +components: + schemas: + AppExtCpConfig: + properties: + cpInstanceId: + description: "Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. \n\nShall be present if this instance has already been created. " + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + cpProtocolData: + description: Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note. + items: + $ref: '#/components/schemas/CpProtocolData' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: CpProtocolData + linkPortId: + description: Identifier of a pre-configured link port to which the external CP will be associated. See note. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: object + x-etsi-notes: "NOTE:\tThe following conditions apply to the attributes \"linkPortId\" and \" cpProtocolData\": \nThe \"linkPortId\" and \"cpProtocolData\" attributes shall both be absent for the deletion of an existing external CP instance addressed by cpInstanceId. \nAt least one of these attributes shall be present for a to-be-created external CP instance or an existing external CP instance.\nIf the \"linkPortId\" attribute is absent, the MEPM shall create a link port.\nIf the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port, and the MEPM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port.\nIf both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the pre-created link port referenced by \"linkPortId\"." + x-etsi-ref: 6.2.4.13 + AppExtCpData: + properties: + cpConfig: + description: List of instance data that need to be configured on the CP instances created from the respective CPD. + items: + $ref: '#/components/schemas/AppExtCpConfig' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: AppExtCpConfig + cpdId: + description: The identifier of the CPD in the AppD. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - cpdId + - cpConfig + type: object + x-etsi-ref: 6.2.4.12 + AppInstanceId: + description: >- + Identifier of application instance. + type: string + AppDId: + description: 'Identifier of this MEC application descriptor. This attribute shall be globally unique.' + type: string + AppLcmOpOccId: + description: >- + Identifier of application lifecycle management operation occurrence. + type: string + 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' + type: object + additionalProperties: true + ResourceDefinition.Type: + description: >- + Type of the resource definition referenced. + type: string + format: enum + enum: + - COMPUTE + - VL + - STORAGE + - LINKPORT + CpProtocolData: + properties: + ipOverEthernet: + # description': Network address data for IP over Ethernet to assign to the extCP instance. Shall be present if layerProtocol is equal to "IP_OVER_ETHERNET", and shall be absent otherwise. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': IpOverEthernetAddressData + $ref: '#/components/schemas/IpOverEthernetAddressData' + layerProtocol: + #description: "Identifier of layer(s) and protocol(s). \n\nPermitted values: IP_OVER_ETHERNET.\n\nSee note." + #type: string + #x-etsi-mec-cardinality: '1' + $ref: '#/components/schemas/IpOverEthernetAddressData' + required: + - layerProtocol + type: object + x-etsi-notes: "NOTE:\tThis attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported." + x-etsi-ref: 6.2.4.14 + ExtLinkPortData: + properties: + id: + description: Identifier of this link port as provided by the entity that has created the link port. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + resourceHandle: + # description': Reference to the virtualised resource realizing this link port. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': ResourceHandle + $ref: '#/components/schemas/ResourceHandle' + required: + - id + - resourceHandle + type: object + x-etsi-ref: 6.2.4.9 + ExtVirtualLinkData: + properties: + extCps: + description: External CPs of the application instance to be connected to this external VL. + items: + $ref: '#/components/schemas/AppExtCpData' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: AppExtCpData + extLinkPorts: + description: Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the MEPM shall create the link ports on the external VL. + items: + $ref: '#/components/schemas/ExtLinkPortData' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: ExtLinkPortData + id: + description: The identifier of the external VL instance. The identifier is assigned by the MEC entity that manages this VL instance. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + resourceId: + description: The identifier of the resource in the scope of the VIM. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + vimConnectionId: + description: 'Identifier of the VIM connection to manage this resource. ' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + required: + - id + - resourceId + - extCps + type: object + x-etsi-ref: 6.2.4.8 + Grant: + description: >- + 'This type represents a grant. Refer to clause 9.5.2.3 of ETSI GS NFV-SOL 003 ' + type: object + required: + - id + - appInstanceId + - appLcmOpOccId + - _links + properties: + id: + $ref: '#/components/schemas/Grant.Id' + appInstanceId: + $ref: '#/components/schemas/AppInstanceId' + appLcmOpOccId: + $ref: '#/components/schemas/AppLcmOpOccId' + vimConnections: + type: array + items: + $ref: '#/components/schemas/VimConnectionInfo' + zones: + type: array + items: + $ref: '#/components/schemas/ZoneInfo' + zoneGroups: + type: array + items: + $ref: '#/components/schemas/ZoneGroupInfo' + addResources: + type: array + items: + $ref: '#/components/schemas/GrantInfo' + tempResources: + type: array + items: + $ref: '#/components/schemas/GrantInfo' + removeResources: + type: array + items: + $ref: '#/components/schemas/GrantInfo' + updateResources: + type: array + items: + $ref: '#/components/schemas/GrantInfo' + vimAssets: + $ref: '#/components/schemas/VimAssets' + extVirtualLinks: + type: array + items: + $ref: '#/components/schemas/ExtVirtualLinkData' + additionalParams: + $ref: '#/components/schemas/KeyValuePairs' + _links: + $ref: '#/components/schemas/Grant.links' + Grant.Id: + type: string + VimAssets: + description: >- + Information about assets for the application that are managed by the MEO in the VIM, such as software images. + type: object + properties: + softwareImages: + type: array + items: + $ref: '#/components/schemas/SoftwareImages' + SoftwareImages: + $ref: '#/components/schemas/VimSoftwareImage' + Grant.links: + description: >- + Links to resources related to this resource. + type: object + required: + - appLcmOpOcc + - appInstance + properties: + appLcmOpOcc: + $ref: '#/components/schemas/LinkType' + appInstance: + $ref: '#/components/schemas/LinkType' + GrantInfo: + properties: + resourceDefinitionId: + description: Identifier of the related "ResourceDefinition" structure from the related "GrantRequest" structure. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + resourceGroupId: + description: 'Identifier of the "infrastructure resource group", logical grouping of virtual resources assigned to a tenant within an Infrastructure Domain, to be provided when allocating the resource.If the VIM connection referenced by "vimConnectionId" applies to multiple infrastructure resource groups, this attribute shall be present for new resources.If the VIM connection referenced by "vimConnectionId" applies to a single infrastructure resource group, this attribute may be present for new resources. This attribute shall be absent for resources that have already been allocated.' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + vimConnectionId: + description: Identifier of the VIM connection to be used to manage this resource. Shall be present for new resources, and shall be absent for resources that have already been allocated. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + zoneId: + description: Reference to the identifier of the "ZoneInfo" structure in the "Grant" structure defining the resource zone into which this resource is to be placed. Shall be present for new resources if the zones concept is applicable to them (typically, Compute resources), and shall be absent for resources that have already been allocated. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + required: + - resourceDefinitionId + type: object + x-etsi-ref: 6.2.4.5 + GrantRequest: + description: >- + 'This type represents a grant request. Refer to clause 9.5.2.2 of ETSI GS NFV-SOL 003' + type: object + required: + - appInstanceId + - appLcmOpOccId + - appDId + - operation + - _links + properties: + appInstanceId: + $ref: '#/components/schemas/AppInstanceId' + appLcmOpOccId: + $ref: '#/components/schemas/AppLcmOpOccId' + appDId: + $ref: '#/components/schemas/AppDId' + operation: + $ref: '#/components/schemas/GrantRequest.Operation' + addResources: + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + tempResources: + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + removeResources: + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + updateResources: + type: array + items: + $ref: '#/components/schemas/ResourceDefinition' + additionalParams: + $ref: '#/components/schemas/KeyValuePairs' + _links: + $ref: '#/components/schemas/GrantRequest.links' + GrantRequest.Operation: + description: >- + 'The lifecycle management operation for which granting is requested' + type: string + enum: + - INSTANTIATE + - OPERATE + - TERMINATE + GrantRequest.links: + description: >- + Links to resources related to this resource. + type: object + required: + - appLcmOpOcc + - appInstance + properties: + appLcmOpOcc: + $ref: '#/components/schemas/LinkType' + appInstance: + $ref: '#/components/schemas/LinkType' + IpOverEthernetAddressData: + description: >- + 'This type represents network address data for IP over Ethernet. Refer to clause 4.4.1.10c of ETSI GS NFV SOL 003' + type: object + properties: + macAddress: + $ref: '#/components/schemas/MacAddress' + ipAddresses: + $ref: '#/components/schemas/IpAddresses' + MacAddress: + description: >- + 'MAC address. If this attribute is not present, it shall be chosen by the VIM' + type: string + IpAddresses: + description: >- + List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. + type: array + items: + $ref: '#/components/schemas/IpAddress' + IpAddress: + description: >- + 'IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.' + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/IpAddress.Type' + fixedAddresses: + $ref: '#/components/schemas/FixedAddresses' + numDynamicAddresses: + $ref: '#/components/schemas/NumDynamicAddresses' + addressRange: + $ref: '#/components/schemas/AddressRange' + subnetId: + $ref: '#/components/schemas/SubnetId' + IpAddress.Type: + description: The type of the IP addresses. + type: string + enum: + - IPV4 + - IPV6 + FixedAddresses: + description: 'Fixed addresses to assign (from the subnet defined by subnetId if provided).' + type: array + items: + $ref: '#/components/schemas/FixedAddress' + NumDynamicAddresses: + description: 'Number of dynamic addresses to assign (from the subnet defined by subnetId if provided)' + type: integer + AddressRange: + description: >- + An IP address range to be used, e.g. in case of egress connections. + type: object + required: + - minAddress + - maxAddress + properties: + minAddress: + $ref: '#/components/schemas/MinAddress' + maxAddress: + $ref: '#/components/schemas/MaxAddress' + MinAddress: + description: Lowest IP address belonging to the range. + type: string + MaxAddress: + description: Highest IP address belonging to the range. + type: string + FixedAddress: + description: >- + Fixed addresses to assign (from the subnet defined by subnetId if provided) + type: string + SubnetId: + description: Subnet defined by the identifier of the subnet resource in the VIM. + type: string + LinkType: + properties: + href: + description: URI referring to a resource + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + required: + - href + type: object + x-etsi-ref: 6.5.2 + ProblemDetails: + properties: + detail: + description: A human-readable explanation specific to this occurrence of the problem + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + instance: + description: A URI reference that identifies the specific occurrence of the problem + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + status: + description: The HTTP status code for this occurrence of the problem + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + title: + description: A short, human-readable summary of the problem type + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: + description: A URI reference according to IETF RFC 3986 that identifies the problem type + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + type: object + ResourceDefinition: + description: >- + 'This type provides information of an existing or proposed resource used by the application. Refer to clause 9.5.3.2 of ETSI GS NFV-SOL 003 ' + type: object + required: + - id + - type + - resourceTemplateId + - resource + properties: + id: + $ref: '#/components/schemas/ResourceDefinitionId' + type: + $ref: '#/components/schemas/ResourceDefinition.Type' + vduId: + $ref: '#/components/schemas/VduId' + resourceTemplateId: + $ref: '#/components/schemas/ResourceTemplateId' + resource: + $ref: '#/components/schemas/Resource' + ResourceDefinitionId: + description: >- + Identifier of the related ResourceDefinition structure from the related GrantRequest structure. + type: string + VduId: + description: >- + Reference to the related VDU in the AppD applicable to this resource. + type: string + ResourceTemplateId: + description: >- + Reference to a resource template, i.e. VirtualLinkDesc, VirtualComputeDesc, AppExtCpd, VirtualStorageDesc in the AppD. + type: string + Resource: + description: >- + Resource information for an existing resource + type: object + required: + - vimConnectionInfo + - resourceId + properties: + vimConnectionInfo: + $ref: '#/components/schemas/VimConnectionInfo' + resourceId: + $ref: '#/components/schemas/ResourceId' + ResourceId: + description: >- + Identifier of the resource in the scope of the VIM. + type: string + ResourceHandle: + properties: + resourceId: + description: Identifier of the resource in the scope of the VIM. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + vimConnectionId: + description: 'Identifier of the VIM connection to manage the resource.The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the "vimConnectionInfo" attribute of the "AppInstance" structure.' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + vimLevelResourceType: + description: Type of the resource in the scope of the VIM. See note. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + required: + - resourceId + type: object + x-etsi-notes: "NOTE:\tThe value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition." + x-etsi-ref: 6.2.4.10 + VimConnectionInfo: + properties: + accessInfo: + #description: 'Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups (see note). The applicable keys are dependent on the content of vimType.If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included.If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band.' + $ref: '#/components/schemas/KeyValuePairs' + #x-etsi-mec-cardinality: 0..1 + #x-etsi-mec-origin-type: KeyValuePairs + extra: + #description: VIM type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType. + $ref: '#/components/schemas/KeyValuePairs' + #x-etsi-mec-cardinality: 0..1 + #x-etsi-mec-origin-type: KeyValuePairs + id: + description: The identifier of the VIM Connection. This identifier is managed by the MEO. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + interfaceInfo: + #description: 'Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of vimType.Alternatively, such information may have been configured into the VNFM and bound to the vimId.' + $ref: '#/components/schemas/KeyValuePairs' + #x-etsi-mec-cardinality: 0..1 + #x-etsi-mec-origin-type: KeyValuePairs + vimId: + description: 'The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + vimType: + description: 'Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. ' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - id + - vimType + type: object + x-etsi-ref: 6.2.2.18 + VimSoftwareImage: + properties: + appDSoftwareImageId: + description: Identifier which references the software image descriptor in the AppD. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + vimConnectionId: + description: 'Identifier of the VIM connection to access the software image referenced in this structure. ' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + vimSoftwareImageId: + description: Identifier of the software image in the resource management layer (i.e. VIM). + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - appDSoftwareImageId + - vimSoftwareImageId + type: object + x-etsi-ref: 6.2.4.11 + ZoneGroupInfo: + properties: + zoneId: + description: References of identifiers of "ZoneInfo" structures, each of which provides information about a resource zone that belongs to this group. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + required: + - zoneId + type: object + x-etsi-ref: 6.2.4.7 + ZoneInfo: + properties: + id: + description: The identifier of this ZoneInfo instance, for the purpose of referencing it from other structures in the "Grant" structure. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + vimConnectionId: + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + zoneId: + description: The identifier of the resource zone, as managed by the resource management layer (typically, the VIM). + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - id + - zoneId + type: object + x-etsi-ref: 6.2.4.6f + + responses: + 204: + description: No Content + 206: + description: Partial content + 400: + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 401: + description: 'Unauthorized : used when the client did not submit credentials.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 403: + description: 'Forbidden : operation is not allowed given the current status of the resource.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 404: + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 406: + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 409: + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 412: + description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 414: + description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 415: + description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + + 416: + description: 'Range Not Satisfiable .' + 422: + description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + example: + application/problem+json: + problemDetails: + type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets' + title: Too many targets + status: '422' + detail: The target area for the request is considered too large + instance: /meAppClient.example.com/77777/msgs/abc + 429: + description: 'Too Many Requests : used when a rate limiter has triggered.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' diff --git a/MEC010-2_AppLcm.json b/MEC010-2_AppLcm.json new file mode 100644 index 0000000000000000000000000000000000000000..f6cafeef29bb1d13284b4be5c050658373ec1010 --- /dev/null +++ b/MEC010-2_AppLcm.json @@ -0,0 +1,2034 @@ +{ + "info": { + "title": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management", + "version": "2.1.1", + "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", + "email": "cti_support@etsi.org", + "url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api" + } + }, + "externalDocs": { + "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1", + "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf" + }, + "servers": [ + { + "url": "https://localhost/app_lcm/v1" + } + ], + "openapi": "3.0.0", + "tags": [ + { + "name": "app-lcm", + "description": "App lifecycle management" + }, + { + "name": "app-lcm-notifications", + "description": "App lifecycle management notifications" + } + ], + "paths": { + "/app_instances": { + "post": { + "tags": [ + "" + ], + "summary": "Create an application instance resource", + "description": "Create an application instance resource", + "operationId": "appInstancePOST", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateAppInstanceRequest" + } + } + } + }, + "responses": { + "201": { + "description": "An application instance identifier and the related resource has been created successfully.", + "content": { + "application/zip": { + "schema": { + "$ref": "#/components/schemas/AppInstanceInfo" + } + } + } + }, + "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" + } + } + }, + "get": { + "tags": [ + "" + ], + "summary": "Queries information relating to on-boarded application packages in the MEO", + "description": "queries information relating to on-boarded application packages in the MEO", + "operationId": "appInstanceGET", + "parameters": [ + { + "in": "query", + "name": "filter", + "schema": { + "type": "string" + }, + "required": false, + "description": "Attribute-based filtering parameters according to ETSI GS MEC 009" + }, + { + "in": "query", + "name": "all_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Include all complex attributes in the response." + }, + { + "in": "query", + "name": "fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes of AppPkgInfo to be included into the response" + }, + { + "in": "query", + "name": "exclude_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes of AppPkgInfo to be excluded from the response." + }, + { + "in": "query", + "name": "exclude_default", + "schema": { + "type": "string" + }, + "required": false, + "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response." + } + ], + "responses": { + "200": { + "description": "Array the representations of zero or more application instances", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppInstanceInfo" + } + } + } + } + }, + "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" + } + } + } + }, + "/app_instances/{appInstanceId}": { + "parameters": [ + { + "in": "path", + "name": "appInstanceId", + "description": "Identifier of an individual application instance", + "schema": { + "type": "string" + }, + "required": true + } + ], + "get": { + "tags": [ + "" + ], + "summary": "Retrieves the information of an individual application instance via reading an individual application instance.", + "description": "Retrieves the information of an individual application instance via reading an individual application instance.", + "operationId": "appInstanceIdGET", + "responses": { + "200": { + "description": "Contains a representation of the read resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppInstanceInfo" + } + } + } + }, + "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" + } + } + }, + "delete": { + "tags": [ + "" + ], + "summary": "Deletes an individual application instance resource.", + "description": "Deletes an individual application instance resource.", + "operationId": "appInstanceIdDELETE", + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "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" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/subscriptions": { + "post": { + "tags": [ + "" + ], + "summary": "subscribe to the notification of application instance operational state change", + "description": "subscribe to the notification of application instance operational state change", + "operationId": "appLcmSubscriptionsPOST", + "parameters": [ + { + "in": "query", + "name": "subscriptionType", + "description": "\"Query parameter to filter on a specific subscription type. Permitted values:\n • \"AppInstanceStateChange\"\n • \"AppLcmOpOccStateChange\"\n\"", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppInst.SubscriptionType" + }, + { + "$ref": "#/components/schemas/AppLcmOpOcc.SubscriptionType" + } + ] + }, + "required": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppInstSubscriptionRequest" + }, + { + "$ref": "#/components/schemas/AppLcmOpOccSubscriptionRequest" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "a representation of the created SubscriptionInfo.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppInstSubscriptionInfo" + }, + { + "$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo" + } + ] + } + } + } + }, + "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" + } + } + }, + "get": { + "tags": [ + "" + ], + "summary": "Retrieves the information of multiple subscriptions to notifications related to an application instance.", + "description": "Retrieves the information of multiple subscriptions to notifications related to an application instance.", + "operationId": "appLcmSubscriptionsGET", + "parameters": [ + { + "in": "query", + "name": "subscriptionType", + "description": "Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange", + "schema": { + "type": "string" + }, + "required": false + } + ], + "responses": { + "200": { + "description": " List of all subscriptions is returned.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionLinkList" + } + } + } + }, + "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" + } + } + } + }, + "/subscriptions/{subscriptionId}": { + "parameters": [ + { + "in": "path", + "name": "subscriptionId", + "description": "Represents an individual subscription to notification related to an application instance", + "schema": { + "type": "string" + }, + "required": true + } + ], + "get": { + "tags": [ + "" + ], + "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": [ + { + "in": "query", + "name": "subscriptionType", + "description": "Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Representation of the resource.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppInstSubscriptionInfo" + }, + { + "$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo" + } + ] + } + } + } + }, + "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" + } + } + }, + "delete": { + "tags": [ + "" + ], + "summary": "Deletes the individual subscription to notifications about application package changes in MEO.", + "description": "Deletes the individual subscription to notifications about application package changes in MEO.", + "operationId": "individualSubscriptionDELETE", + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/user_defined_notification": { + "post": { + "tags": [ + "" + ], + "summary": "Delivers a notification from the application lifecycle management resource to the subscriber.", + "description": "Delivers a notification from the application lifecycle management resource to the subscriber.", + "operationId": "appInstNotificationPOST", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppInstNotification" + }, + { + "$ref": "#/components/schemas/AppLcmOpOccNotification" + } + ] + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "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" + } + } + } + }, + "/app_instances/{appInstanceId}/instantiate": { + "parameters": [ + { + "in": "path", + "name": "appInstanceId", + "description": "Identifier of an individual application instance", + "schema": { + "type": "string" + }, + "required": true + } + ], + "post": { + "tags": [ + "" + ], + "summary": "task of instantiating an application instance.", + "description": "task of instantiating an application instance.", + "operationId": "appLcmInstanciatePOST", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InstantiateAppRequest" + } + } + } + }, + "responses": { + "202": { + "description": "accepted for processing, but the processing has not yet been completed." + }, + "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" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/app_instances/{appInstanceId}/terminate": { + "parameters": [ + { + "in": "path", + "name": "appInstanceId", + "description": "Identifier of an individual application instance", + "schema": { + "type": "string" + }, + "required": true + } + ], + "post": { + "tags": [ + "" + ], + "summary": "terminate an application instance.", + "description": "terminate an application instance.", + "operationId": "appLcmTerminatePOST", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TerminateAppRequest" + } + } + } + }, + "responses": { + "202": { + "description": "accepted for processing, but the processing has not yet been completed." + }, + "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" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/app_instances/{appInstanceId}/operate": { + "parameters": [ + { + "in": "path", + "name": "appInstanceId", + "description": "Identifier of an individual application instance", + "schema": { + "type": "string" + }, + "required": true + } + ], + "post": { + "tags": [ + "" + ], + "summary": "change the operational state, i.e. start or stop, of the application instance", + "description": "change the operational state, i.e. start or stop, of the application instance", + "operationId": "appLcmOperatePOST", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OperateAppRequest" + } + } + } + }, + "responses": { + "202": { + "description": "accepted for processing, but the processing has not yet been completed." + }, + "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" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/app_lcm_op_occs": { + "get": { + "tags": [ + "" + ], + "summary": "retrieves information of operation status about multiple application instance lifecycle management operation occurrences", + "description": "retrieves information of operation status about multiple application instance lifecycle management operation occurrences", + "operationId": "appLcmOpOccsGET", + "parameters": [ + { + "in": "query", + "name": "filter", + "schema": { + "type": "string" + }, + "required": false, + "description": "Attribute-based filtering parameters according to ETSI GS MEC 009" + }, + { + "in": "query", + "name": "all_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Include all complex attributes in the response." + }, + { + "in": "query", + "name": "fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes of AppPkgInfo to be included into the response" + }, + { + "in": "query", + "name": "exclude_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes of AppPkgInfo to be excluded from the response." + }, + { + "in": "query", + "name": "exclude_default", + "schema": { + "type": "string" + }, + "required": false, + "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response." + } + ], + "responses": { + "200": { + "description": "Status information for zero or more application instance lifecycle management operation occurrences was queried successfully", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppInstanceLcmOpOcc" + } + } + } + } + }, + "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" + } + } + } + }, + "/app_lcm_op_occs/{appLcmOpOccId}": { + "parameters": [ + { + "in": "path", + "name": "appLcmOpOccId", + "description": "Identifies an individual application LCM operation occurrence", + "schema": { + "type": "string" + }, + "required": true + } + ], + "get": { + "tags": [ + "" + ], + "summary": "reads the status information of an individual application LCM operation occurrence", + "description": "reads the status information of an individual application LCM operation occurrence", + "operationId": "appLcmOpOccsbyIdGET", + "responses": { + "200": { + "description": "Information about an application LCM operation occurrence was read successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppInstanceLcmOpOcc" + } + } + } + }, + "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" + } + } + } + } + }, + "components": { + "schemas": { + "AppInstanceLcmOpOcc": { + "description": "'This data type represents an application lifecycle management operation occurrence'", + "type": "object", + "required": [ + "id", + "operationState", + "stateEnteredTime", + "startTime", + "lcmOperation", + "_links" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/AppInstanceLcmOpOcc.Id" + }, + "operationState": { + "$ref": "#/components/schemas/OperationState" + }, + "stateEnteredTime": { + "$ref": "#/components/schemas/TimeStamp" + }, + "startTime": { + "$ref": "#/components/schemas/TimeStamp" + }, + "lcmOperation": { + "$ref": "#/components/schemas/LcmOperation" + }, + "operationParams": { + "$ref": "#/components/schemas/OperationParams" + }, + "_links": { + "$ref": "#/components/schemas/AppInstanceLcmOpOcc.links" + } + } + }, + "AppInstanceLcmOpOcc.Id": { + "description": "'Identifier of the subscription to application LCM operation occurrence notification'", + "type": "string" + }, + "OperationParams": { + "description": "'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation.'", + "type": "string", + "enum": [ + "INSTANTIATE", + "OPERATE", + "TERMINATE" + ] + }, + "AppInstanceLcmOpOcc.links": { + "description": "Links to resources related to this resource.", + "type": "object", + "required": [ + "self", + "appInstance" + ], + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + }, + "appInstance": { + "$ref": "#/components/schemas/LinkType" + } + } + }, + "SubscriptionLinkList": { + "description": "'The data type represents a subscription link list of notification on application lifecycle management. '", + "type": "object", + "required": [ + "_links" + ], + "properties": { + "_links": { + "$ref": "#/components/schemas/SubscriptionLinkList.links" + } + } + }, + "SubscriptionLinkList.links": { + "description": "Links to resources related to this resource.", + "type": "object", + "required": [ + "self" + ], + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + }, + "subscriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionLinkList.links.subscriptions" + } + } + } + }, + "SubscriptionLinkList.links.subscriptions": { + "description": "A link list to the subscriptions", + "type": "object", + "required": [ + "href", + "subscriptionType" + ], + "properties": { + "href": { + "type": "string", + "format": "uri" + }, + "subscriptionType": { + "type": "string", + "format": "enum", + "enum": [ + "AppInstanceStateChange", + "AppLcmOpOccStateChange" + ] + } + } + }, + "AppLcmOpOccSubscriptionInfo": { + "description": "'This data type represents a subscription to notifications of application life cycle management operation occurrence'", + "type": "object", + "required": [ + "id", + "subscriptionType", + "callbackUri", + "_links" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo.Id" + }, + "subscriptionType": { + "$ref": "#/components/schemas/AppLcmOpOcc.SubscriptionType" + }, + "callbackUri": { + "$ref": "#/components/schemas/CallbackUri" + }, + "_links": { + "$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo.links" + } + } + }, + "AppLcmOpOccSubscriptionInfo.Id": { + "description": "''", + "type": "string" + }, + "AppLcmOpOcc.SubscriptionType": { + "description": "Shall be set to AppLcmOpOccStateChange.", + "type": "string", + "enum": [ + "AppLcmOpOccStateChange" + ] + }, + "AppLcmOpOccSubscriptionInfo.links": { + "description": "Links to resources related to this resource.", + "type": "object", + "required": [ + "self" + ], + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + } + }, + "AppInstSubscriptionInfo": { + "description": "'The data type represents a subscription to notification of application instance operational state change.'", + "type": "object", + "required": [ + "id", + "subscriptionType", + "notificationType", + "callbackUri", + "_links" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/AppInstSubscriptionInfo.Id" + }, + "subscriptionType": { + "$ref": "#/components/schemas/AppInst.SubscriptionType" + }, + "notificationType": { + "$ref": "#/components/schemas/AppInst.NotificationType" + }, + "callbackUri": { + "$ref": "#/components/schemas/CallbackUri" + }, + "_links": { + "$ref": "#/components/schemas/AppInstSubscriptionInfo.links" + } + } + }, + "AppInstSubscriptionInfo.Id": { + "description": "'Identifier of the subscription to application instance operational state change notification.'", + "type": "string" + }, + "AppInst.SubscriptionType": { + "description": "Shall be set to AppInstanceStateChange.", + "type": "string", + "enum": [ + "AppInstanceStateChange" + ] + }, + "AppInst.NotificationType": { + "description": "Subscribed notification", + "type": "string", + "enum": [ + "NOT_INSTANTIATED", + "STARTED", + "STOPPED" + ] + }, + "CallbackUri": { + "description": "The URI of the endpoint for the notification to be sent to.", + "type": "string", + "format": "uri" + }, + "AppInstSubscriptionInfo.links": { + "description": "Links to resources related to this resource.", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": [ + "self" + ], + "type": "object" + }, + "AppLcmOpOccSubscriptionRequest": { + "properties": { + "appLcmOpOccSubscriptionFilter": { + "$ref": "#/components/schemas/AppLcmOpOccSubscriptionFilter" + }, + "callbackUri": { + "$ref": "#/components/schemas/URI" + }, + "subscriptionType": { + "description": "Shall be set to \"AppLcmOpOccStateChange\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "subscriptionType", + "callbackUri" + ], + "type": "object", + "x-etsi-ref": "6.2.2.14" + }, + "URI": { + "type": "string" + }, + "AppLcmOpOccSubscriptionFilter": { + "properties": { + "appInstanceSubscriptionFilter": { + "$ref": "#/components/schemas/AppInstanceSubscriptionFilter" + }, + "notificationTypes": { + "$ref": "#/components/schemas/NotificationTypes" + }, + "operationStates": { + "$ref": "#/components/schemas/OperationStates" + }, + "operationTypes": { + "$ref": "#/components/schemas/OperationTypes" + } + } + }, + "NotificationTypes": { + "description": "Match particular notification types.", + "type": "string", + "enum": [ + "AppLcmOperationOccurrenceNotification" + ] + }, + "OperationStates": { + "description": "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'", + "type": "string", + "enum": [ + "STARTING", + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "OperationTypes": { + "description": "'Type of the LCM operation represented by this application instance LCM operation occurrence.'", + "type": "string", + "enum": [ + "INSTANTIATE", + "OPERATE", + "TERMINATE" + ] + }, + "CreateAppInstanceRequest": { + "properties": { + "appDId": { + "description": "The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appInstanceDescription": { + "description": "Human-readable description of the application instance to be created.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "appInstanceName": { + "description": "Human-readable name of the application instance to be created.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "appDId" + ], + "type": "object", + "x-etsi-ref": "6.2.2.3" + }, + "AppInstSubscriptionRequest": { + "type": "object", + "required": [ + "subscriptionType", + "callbackUri" + ], + "properties": { + "subscriptionType": { + "$ref": "#/components/schemas/AppInst.SubscriptionType" + }, + "callbackUri": { + "$ref": "#/components/schemas/CallbackUri" + }, + "appInstanceState": { + "$ref": "#/components/schemas/AppInstanceState" + }, + "appInstanceSubscriptionFilter": { + "$ref": "#/components/schemas/AppInstanceSubscriptionFilter" + } + } + }, + "AppInstanceSubscriptionFilter": { + "description": "'This data type represents subscription filter criteria to match application instances. '", + "type": "object", + "required": [ + "appInstSelectorType" + ], + "properties": { + "appInstSelectorType": { + "$ref": "#/components/schemas/AppInstSelectorType" + }, + "appInstances": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppInstances" + } + }, + "appsFromProviders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppsFromProviders" + } + } + } + }, + "AppsFromProviders": { + "description": "'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.'", + "type": "object", + "required": [ + "appProvider" + ], + "properties": { + "appProvider": { + "$ref": "#/components/schemas/AppProvider" + }, + "appProducts": { + "$ref": "#/components/schemas/AppProducts" + } + } + }, + "AppProducts": { + "description": "'If present, match application instances that belong to application products with certain product names, from one particular provider.'", + "type": "object", + "required": [ + "appName" + ], + "properties": { + "appName": { + "$ref": "#/components/schemas/AppName" + }, + "versions": { + "$ref": "#/components/schemas/AppProducts.Versions" + } + } + }, + "AppProducts.Versions": { + "description": "'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'", + "type": "object", + "required": [ + "appSoftVersion" + ], + "properties": { + "appSoftVersion": { + "$ref": "#/components/schemas/AppSoftVersion" + }, + "appDVersion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppDVersion" + } + } + } + }, + "AppInstances": { + "description": "If appInstIdSelector = APP_IDENTITY match existing application instances with an application instance identifier listed in this attribute.", + "type": "string" + }, + "AppInstSelectorType": { + "description": "0 = void", + "type": "string", + "enum": [ + "VOID", + "APP_IDENTITY", + "APP_NAME", + "APP_D_ID", + "APP_FROM_PROVIDER" + ] + }, + "AppInstanceState": { + "description": "Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states.", + "type": "string", + "format": "enum", + "enum": [ + "NOT_INSTANTIATED", + "STARTED", + "STOPPED" + ] + }, + "AppInstNotification": { + "properties": { + "_links": { + "description": "Links to resources related to this notification.", + "properties": { + "subscription": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": [ + "subscription" + ], + "type": "object", + "x-etsi-mec-cardinality": "1" + }, + "appDId": { + "description": "The application descriptor identifier identifies the application package and the application descriptor in a globally unique way.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appInstanceId": { + "description": "Identifier of application instance.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appPkgId": { + "description": "Identifier of the onboarded application package. ", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "id": { + "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.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "notificationType": { + "$ref": "#/components/schemas/AppInst.NotificationType" + }, + "subscriptionId": { + "description": "Identifier of the subscription related to this notification.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "required": [ + "id", + "notificationType", + "subscriptionId", + "timeStamp", + "appInstanceId", + "appPkgId", + "appDId", + "_links" + ], + "type": "object", + "x-etsi-ref": "6.2.2.11" + }, + "AppInstanceInfo": { + "description": "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'", + "type": "object", + "required": [ + "id", + "appDId", + "appProvider", + "appName", + "appSoftVersion", + "appDVersion", + "appPkgId", + "instantiationState", + "_links" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/AppInstanceId" + }, + "appInstanceName": { + "$ref": "#/components/schemas/AppInstanceName" + }, + "appInstanceDescription": { + "$ref": "#/components/schemas/AppInstanceDescription" + }, + "appDId": { + "$ref": "#/components/schemas/AppDId" + }, + "appProvider": { + "$ref": "#/components/schemas/AppProvider" + }, + "appName": { + "$ref": "#/components/schemas/AppName" + }, + "appSoftVersion": { + "$ref": "#/components/schemas/AppSoftVersion" + }, + "appDVersion": { + "$ref": "#/components/schemas/AppDVersion" + }, + "appPkgId": { + "$ref": "#/components/schemas/AppPkgId" + }, + "vimConnectionInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VimConnectionInfo" + } + }, + "instantiationState": { + "$ref": "#/components/schemas/InstantiationState" + }, + "instantiatedAppState": { + "$ref": "#/components/schemas/InstantiatedAppState" + }, + "_links": { + "$ref": "#/components/schemas/AppInstanceInfo.links" + } + } + }, + "AppInstanceId": { + "description": "Identifier of application instance.", + "type": "string" + }, + "OperationState": { + "description": "Operation state", + "type": "string", + "format": "enum", + "enum": [ + "STARTING", + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "AppInstanceName": { + "description": "Name of the application instance.", + "type": "string" + }, + "AppInstanceDescription": { + "description": "Human-readable description of the application instance to be created.", + "type": "string" + }, + "AppDId": { + "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique.", + "type": "string" + }, + "AppProvider": { + "description": "Provider of the application and of the AppD.", + "type": "string" + }, + "AppName": { + "description": "Name to identify the MEC application.", + "type": "string" + }, + "AppSoftVersion": { + "description": "Identifies the version of software of the MEC application.", + "type": "string" + }, + "AppDVersion": { + "description": "Identifies the version of the application descriptor.", + "type": "string" + }, + "AppPkgId": { + "description": "Identifier of the onboarded application package.", + "type": "string" + }, + "InstantiationState": { + "description": "Instantiation state of the application instance", + "type": "string", + "enum": [ + "NOT_INSTANTIATED", + "INSTANTIATED" + ] + }, + "InstantiatedAppState": { + "description": "'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'", + "type": "object", + "required": [ + "operationalState" + ], + "properties": { + "operationalState": { + "$ref": "#/components/schemas/OperationalState" + } + } + }, + "OperationalState": { + "description": "Operational state is applicable in the instantiation state INSTANTIATED", + "type": "string", + "enum": [ + "STARTED", + "STOPPED" + ] + }, + "AppInstanceInfo.links": { + "description": "Links to resources related to this resource.", + "type": "object", + "required": [ + "self" + ], + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + }, + "instantiate": { + "$ref": "#/components/schemas/LinkType" + }, + "terminate": { + "$ref": "#/components/schemas/LinkType" + }, + "operate": { + "$ref": "#/components/schemas/LinkType" + } + } + }, + "LcmOperation": { + "description": "Type of the actual LCM operation represented by this application instance LCM operation occurrence", + "type": "string", + "format": "enum", + "enum": [ + "INSTATIATE", + "OPERATE", + "TERMINATE" + ] + }, + "AppLcmOpOccNotification": { + "description": "'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'", + "type": "object", + "required": [ + "id", + "notificationType", + "subscriptionId", + "timeStamp", + "appLcmOpOccId", + "appInstanceId", + "_links" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/AppLcmOpOccNotification.Id" + }, + "notificationType": { + "$ref": "#/components/schemas/AppLcmOpOcc.NotificationType" + }, + "subscriptionId": { + "$ref": "#/components/schemas/SubscriptionId" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "appLcmOpOccId": { + "$ref": "#/components/schemas/AppLcmOpOccId" + }, + "appInstanceId": { + "$ref": "#/components/schemas/AppInstanceId" + }, + "_links": { + "$ref": "#/components/schemas/AppLcmOpOccNotification.links" + } + } + }, + "AppLcmOpOccNotification.Id": { + "description": "''", + "type": "string" + }, + "AppLcmOpOcc.NotificationType": { + "description": "Discriminator for the different notification types", + "type": "string", + "enum": [ + "STARTING", + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "SubscriptionId": { + "description": "Identifier of the subscription related to this notification.", + "type": "string" + }, + "AppLcmOpOccId": { + "description": "Identifier of application lifecycle management operation occurrence.", + "type": "string" + }, + "AppLcmOpOccNotification.links": { + "description": "Links to resources related to this resource.", + "type": "object", + "required": [ + "appInstance", + "subscription", + "appLcmOpOcc" + ], + "properties": { + "appInstance": { + "$ref": "#/components/schemas/LinkType" + }, + "subscription": { + "$ref": "#/components/schemas/LinkType" + }, + "appLcmOpOcc": { + "$ref": "#/components/schemas/LinkType" + } + } + }, + "InstantiateAppRequest": { + "properties": { + "locationConstraints": { + "$ref": "#/components/schemas/LocationConstraints" + }, + "selectedMECHostInfo": { + "description": "Describes the information of selected host for the application instance. See note 2.", + "items": { + "$ref": "#/components/schemas/MECHostInformation" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "MECHostInformation" + }, + "vimConnectionInfo": { + "description": "Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links.\nThis attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2.", + "items": { + "$ref": "#/components/schemas/VimConnectionInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "VimConnectionInfo" + }, + "virtualComputeDescriptor": { + "$ref": "#/components/schemas/VirtualComputeDescription" + }, + "virtualStorageDescriptor": { + "description": "Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1.", + "items": { + "$ref": "#/components/schemas/VirtualStorageDescriptor" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "VirtualStorageDescriptor" + } + }, + "required": [ + "selectedMECHostInfo" + ], + "type": "object", + "x-etsi-notes": "NOTE 1:\tThis attribute may be provided in the InstantiateAppRequest structure to override the same attribute in the AppD. \nNOTE 2:\tThis field applies to Mm3 reference point only.\nNOTE 3:\tThis field applies to Mm1 reference point only.", + "x-etsi-ref": "6.2.2.7" + }, + "LinkType": { + "properties": { + "href": { + "description": "URI referring to a resource", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "URI" + } + }, + "required": [ + "href" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "LocationConstraints": { + "description": "'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'", + "type": "object", + "required": [ + "countryCode" + ], + "properties": { + "countryCode": { + "$ref": "#/components/schemas/CountryCode" + }, + "civicAddressElement": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CivicAddressElement" + } + } + } + }, + "CountryCode": { + "description": "The two-letter ISO 3166 country code in capital letters.", + "type": "string" + }, + "CivicAddressElement": { + "description": "'The civic address.'", + "type": "object", + "required": [ + "caType", + "caValue" + ], + "properties": { + "caType": { + "$ref": "#/components/schemas/CaType" + }, + "caValue": { + "$ref": "#/components/schemas/CaValue" + } + } + }, + "CaType": { + "description": "'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'", + "type": "integer" + }, + "CaValue": { + "description": "'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'", + "type": "string" + }, + "MECHostInformation": { + "properties": { + "hostId": { + "$ref": "#/components/schemas/KeyValuePairs" + }, + "hostName": { + "description": "Human-readable name of MEC host.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "hostId" + ], + "type": "object", + "x-etsi-ref": "6.2.2.17" + }, + "OperateAppRequest": { + "properties": { + "changeStateTo": { + "$ref": "#/components/schemas/ChangeStateTo" + }, + "gracefulStopTimeout": { + "description": "The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Integer" + }, + "stopType": { + "$ref": "#/components/schemas/StopType" + } + }, + "required": [ + "changeStateTo" + ], + "type": "object", + "x-etsi-notes": "NOTE 1:\tThe \"stopType\" and \"gracefulStopTimeout\" attributes shall be absent, when the \"changeStateTo\" attribute is equal to \"STARTED\". \nNOTE 2:\tThe \"gracefulStopTimeout\" attribute shall be present, when the \"changeStateTo\" is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"GRACEFUL\". The \"gracefulStopTimeout\" attribute shall be absent, when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"FORCEFUL\". \nNOTE 3:\tThe request shall be treated as if the \"stopType\" attribute was set to \"FORCEFUL\", when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is absent.", + "x-etsi-ref": "6.2.2.8" + }, + "StopType": { + "description": "Signals forceful or graceful stop", + "type": "string", + "enum": [ + "FORCEFUL", + "GRACEFUL" + ] + }, + "ChangeStateTo": { + "description": "The desired operational state", + "type": "string", + "format": "enum", + "enum": [ + "STARTED", + "STOPPED" + ] + }, + "ProblemDetails": { + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "instance": { + "description": "A URI reference that identifies the specific occurrence of the problem", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + }, + "status": { + "description": "The HTTP status code for this occurrence of the problem", + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "title": { + "description": "A short, human-readable summary of the problem type", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "type": { + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + } + }, + "type": "object" + }, + "TerminateAppRequest": { + "properties": { + "gracefulTerminationTimeout": { + "description": "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Integer" + }, + "terminationType": { + "$ref": "#/components/schemas/TerminationType" + } + }, + "required": [ + "terminationType" + ], + "type": "object", + "x-etsi-notes": "NOTE:\tIf the application instance is still in service, requesting forceful termination can adversely impact service.", + "x-etsi-ref": "6.2.2.9" + }, + "TimeStamp": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.2.5.4" + }, + "TerminationType": { + "description": "'Indicates whether forceful or graceful termination is requested.'", + "type": "string", + "format": "enum", + "enum": [ + "FORCEFUL", + "GRACEFUL" + ] + }, + "VimConnectionInfo": { + "properties": { + "accessInfo": { + "$ref": "#/components/schemas/KeyValuePairs" + }, + "extra": { + "$ref": "#/components/schemas/KeyValuePairs" + }, + "id": { + "description": "The identifier of the VIM Connection. This identifier is managed by the MEO.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "interfaceInfo": { + "$ref": "#/components/schemas/KeyValuePairs" + }, + "vimId": { + "description": "The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "vimType": { + "description": "Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. ", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "id", + "vimType" + ], + "type": "object", + "x-etsi-ref": "6.2.2.18" + }, + "VirtualComputeDescription": { + "description": "Ref NFV", + "type": "string" + }, + "VirtualStorageDescriptor": { + "description": "Ref NFV", + "type": "string" + }, + "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'", + "type": "object", + "additionalProperties": true + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "206": { + "description": "Partial content" + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "412": { + "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "414": { + "description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "415": { + "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "416": { + "description": "Range Not Satisfiable ." + }, + "422": { + "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "example": { + "application/problem+json": { + "problemDetails": { + "type": "https://meAppServer.example.com/rni/v2/probs/too-many targets", + "title": "Too many targets", + "status": "422", + "detail": "The target area for the request is considered too large", + "instance": "/meAppClient.example.com/77777/msgs/abc" + } + } + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/MEC010-2_AppLcm.yaml b/MEC010-2_AppLcm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..5fabe92fd13f9e611d05337f5ec3da7cd4991870 --- /dev/null +++ b/MEC010-2_AppLcm.yaml @@ -0,0 +1,1492 @@ +info: + title: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management" + version: 2.1.1 + 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 + email: cti_support@etsi.org + url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api +externalDocs: + description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1" + url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf' +servers: + - url: 'https://localhost/app_lcm/v1' +openapi: 3.0.0 +tags: + - name: app-lcm + description: App lifecycle management + - name: app-lcm-notifications + description: App lifecycle management notifications +paths: + /app_instances: + post: + tags: + - '' + summary: 'Create an application instance resource' + description: 'Create an application instance resource' + operationId: appInstancePOST + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAppInstanceRequest' + responses: + '201': + description: 'An application instance identifier and the related resource has been created successfully.' + content: + application/zip: + schema: + $ref: '#/components/schemas/AppInstanceInfo' + '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' + get: + tags: + - '' + summary: 'Queries information relating to on-boarded application packages in the MEO' + description: 'queries information relating to on-boarded application packages in the MEO' + operationId: appInstanceGET + parameters: + - in: query + name: filter + schema: + type: string + required: false + description: 'Attribute-based filtering parameters according to ETSI GS MEC 009' + - in: query + name: all_fields + schema: + type: string + required: false + description: 'Include all complex attributes in the response.' + - in: query + name: fields + schema: + type: string + required: false + description: 'Complex attributes of AppPkgInfo to be included into the response' + - in: query + name: exclude_fields + schema: + type: string + required: false + description: 'Complex attributes of AppPkgInfo to be excluded from the response.' + - in: query + name: exclude_default + schema: + type: string + required: false + description: 'Indicates to exclude the following complex attributes of AppPkgInfo from the response.' + responses: + '200': + description: 'Array the representations of zero or more application instances' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AppInstanceInfo' + '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' + /app_instances/{appInstanceId}: + parameters: + - in: path + name: appInstanceId + description: 'Identifier of an individual application instance' + schema: + type: string + required: true + get: + tags: + - '' + summary: 'Retrieves the information of an individual application instance via reading an individual application instance.' + description: 'Retrieves the information of an individual application instance via reading an individual application instance.' + operationId: appInstanceIdGET + + responses: + '200': + description: 'Contains a representation of the read resource.' + content: + application/json: + schema: + $ref: '#/components/schemas/AppInstanceInfo' + '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' + delete: + tags: + - '' + summary: 'Deletes an individual application instance resource.' + description: 'Deletes an individual application instance resource.' + operationId: appInstanceIdDELETE + responses: + '204': + $ref: '#/components/responses/204' + '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' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + /subscriptions: + post: + tags: + - '' + summary: 'subscribe to the notification of application instance operational state change' + description: 'subscribe to the notification of application instance operational state change' + operationId: appLcmSubscriptionsPOST + parameters: + - in: query + name: subscriptionType + description: >- + "Query parameter to filter on a specific subscription type. + Permitted values: + • "AppInstanceStateChange" + • "AppLcmOpOccStateChange" + " + schema: + oneOf: + - $ref: '#/components/schemas/AppInst.SubscriptionType' + - $ref: '#/components/schemas/AppLcmOpOcc.SubscriptionType' + required: true + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AppInstSubscriptionRequest' + - $ref: '#/components/schemas/AppLcmOpOccSubscriptionRequest' + responses: + '201': + description: 'a representation of the created SubscriptionInfo.' + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AppInstSubscriptionInfo' + - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' + '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' + get: + tags: + - '' + summary: 'Retrieves the information of multiple subscriptions to notifications related to an application instance.' + description: 'Retrieves the information of multiple subscriptions to notifications related to an application instance.' + operationId: appLcmSubscriptionsGET + parameters: + - in: query + name: subscriptionType + description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange' + schema: + type: string + required: false + responses: + '200': + description: ' List of all subscriptions is returned.' + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionLinkList' + '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' + /subscriptions/{subscriptionId}: + parameters: + - in: path + name: subscriptionId + description: 'Represents an individual subscription to notification related to an application instance' + schema: + type: string + required: true + get: + tags: + - '' + 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: + - in: query + name: subscriptionType + description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange' + schema: + type: string + required: true + responses: + '200': + description: Representation of the resource. + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AppInstSubscriptionInfo' + - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' + '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' + delete: + tags: + - '' + summary: 'Deletes the individual subscription to notifications about application package changes in MEO.' + description: 'Deletes the individual subscription to notifications about application package changes in MEO.' + operationId: individualSubscriptionDELETE + responses: + '204': + $ref: '#/components/responses/204' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' +############################################################################### +# Notification endpoint oneOf: AppInstNotification, AppLcmOpOccNotification # +############################################################################### + /user_defined_notification: + post: + tags: + - '' + summary: 'Delivers a notification from the application lifecycle management resource to the subscriber.' + description: 'Delivers a notification from the application lifecycle management resource to the subscriber.' + operationId: appInstNotificationPOST + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AppInstNotification' + - $ref: '#/components/schemas/AppLcmOpOccNotification' + responses: + '204': + $ref: '#/components/responses/204' + '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' + /app_instances/{appInstanceId}/instantiate: + parameters: + - in: path + name: appInstanceId + description: 'Identifier of an individual application instance' + schema: + type: string + required: true + post: + tags: + - '' + summary: 'task of instantiating an application instance.' + description: 'task of instantiating an application instance.' + operationId: appLcmInstanciatePOST + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/InstantiateAppRequest' + responses: + '202': + description: 'accepted for processing, but the processing has not yet been completed.' + '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' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + /app_instances/{appInstanceId}/terminate: + parameters: + - in: path + name: appInstanceId + description: 'Identifier of an individual application instance' + schema: + type: string + required: true + post: + tags: + - '' + summary: 'terminate an application instance.' + description: 'terminate an application instance.' + operationId: appLcmTerminatePOST + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TerminateAppRequest' + responses: + '202': + description: 'accepted for processing, but the processing has not yet been completed.' + '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' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + /app_instances/{appInstanceId}/operate: + parameters: + - in: path + name: appInstanceId + description: 'Identifier of an individual application instance' + schema: + type: string + required: true + post: + tags: + - '' + summary: 'change the operational state, i.e. start or stop, of the application instance' + description: 'change the operational state, i.e. start or stop, of the application instance' + operationId: appLcmOperatePOST + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OperateAppRequest' + responses: + '202': + description: 'accepted for processing, but the processing has not yet been completed.' + '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' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + /app_lcm_op_occs: + get: + tags: + - '' + summary: 'retrieves information of operation status about multiple application instance lifecycle management operation occurrences' + description: 'retrieves information of operation status about multiple application instance lifecycle management operation occurrences' + operationId: appLcmOpOccsGET + parameters: + - in: query + name: filter + schema: + type: string + required: false + description: 'Attribute-based filtering parameters according to ETSI GS MEC 009' + - in: query + name: all_fields + schema: + type: string + required: false + description: 'Include all complex attributes in the response.' + - in: query + name: fields + schema: + type: string + required: false + description: 'Complex attributes of AppPkgInfo to be included into the response' + - in: query + name: exclude_fields + schema: + type: string + required: false + description: 'Complex attributes of AppPkgInfo to be excluded from the response.' + - in: query + name: exclude_default + schema: + type: string + required: false + description: 'Indicates to exclude the following complex attributes of AppPkgInfo from the response.' + responses: + '200': + description: 'Status information for zero or more application instance lifecycle management operation occurrences was queried successfully' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AppInstanceLcmOpOcc' + '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' + /app_lcm_op_occs/{appLcmOpOccId}: + parameters: + - in: path + name: appLcmOpOccId + description: 'Identifies an individual application LCM operation occurrence' + schema: + type: string + required: true + get: + tags: + - '' + summary: 'reads the status information of an individual application LCM operation occurrence' + description: 'reads the status information of an individual application LCM operation occurrence' + operationId: appLcmOpOccsbyIdGET + + responses: + '200': + description: 'Information about an application LCM operation occurrence was read successfully' + content: + application/json: + schema: + $ref: '#/components/schemas/AppInstanceLcmOpOcc' + '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' + +components: + schemas: + AppInstanceLcmOpOcc: + description: >- + 'This data type represents an application lifecycle management operation occurrence' + type: object + required: + - id + - operationState + - stateEnteredTime + - startTime + - lcmOperation + - _links + properties: + id: + $ref: '#/components/schemas/AppInstanceLcmOpOcc.Id' + operationState: + $ref: '#/components/schemas/OperationState' + stateEnteredTime: + $ref: '#/components/schemas/TimeStamp' + startTime: + $ref: '#/components/schemas/TimeStamp' + lcmOperation: + $ref: '#/components/schemas/LcmOperation' + operationParams: + $ref: '#/components/schemas/OperationParams' + _links: + $ref: '#/components/schemas/AppInstanceLcmOpOcc.links' + AppInstanceLcmOpOcc.Id: + description: >- + 'Identifier of the subscription to application LCM operation occurrence notification' + type: string + OperationParams: + description: >- + 'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation.' + type: string + enum: + - INSTANTIATE + - OPERATE + - TERMINATE + AppInstanceLcmOpOcc.links: + description: >- + Links to resources related to this resource. + type: object + required: + - self + - appInstance + properties: + self: + $ref: '#/components/schemas/LinkType' + appInstance: + $ref: '#/components/schemas/LinkType' + SubscriptionLinkList: + description: >- + 'The data type represents a subscription link list of notification on application lifecycle management. ' + type: object + required: + - _links + properties: + _links: + $ref: '#/components/schemas/SubscriptionLinkList.links' + SubscriptionLinkList.links: + description: >- + Links to resources related to this resource. + type: object + required: + - self + properties: + self: + $ref: '#/components/schemas/LinkType' + subscriptions: + type: array + items: + $ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions' + SubscriptionLinkList.links.subscriptions: + description: >- + A link list to the subscriptions + type: object + required: + - href + - subscriptionType + properties: + href: + type: string + format: uri + subscriptionType: + type: string + format: enum + enum: + - AppInstanceStateChange + - AppLcmOpOccStateChange + AppLcmOpOccSubscriptionInfo: + description: >- + 'This data type represents a subscription to notifications of application life cycle management operation occurrence' + type: object + required: + - id + - subscriptionType + - callbackUri + - _links + properties: + id: + $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.Id' + subscriptionType: + $ref: '#/components/schemas/AppLcmOpOcc.SubscriptionType' + callbackUri: + $ref: '#/components/schemas/CallbackUri' + _links: + $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.links' + AppLcmOpOccSubscriptionInfo.Id: + description: >- + '' + type: string + AppLcmOpOcc.SubscriptionType: + description: >- + Shall be set to AppLcmOpOccStateChange. + type: string + enum: + - AppLcmOpOccStateChange + AppLcmOpOccSubscriptionInfo.links: + description: >- + Links to resources related to this resource. + type: object + required: + - self + properties: + self: + $ref: '#/components/schemas/LinkType' + AppInstSubscriptionInfo: + description: >- + 'The data type represents a subscription to notification of application instance operational state change.' + type: object + required: + - id + - subscriptionType + - notificationType + - callbackUri + - _links + properties: + id: + $ref: '#/components/schemas/AppInstSubscriptionInfo.Id' + subscriptionType: + $ref: '#/components/schemas/AppInst.SubscriptionType' + notificationType: + $ref: '#/components/schemas/AppInst.NotificationType' + callbackUri: + $ref: '#/components/schemas/CallbackUri' + _links: + $ref: '#/components/schemas/AppInstSubscriptionInfo.links' + AppInstSubscriptionInfo.Id: + description: >- + 'Identifier of the subscription to application instance operational state change notification.' + type: string + AppInst.SubscriptionType: + description: >- + Shall be set to AppInstanceStateChange. + type: string + enum: + - AppInstanceStateChange + AppInst.NotificationType: + description: >- + Subscribed notification + type: string + enum: + - NOT_INSTANTIATED + - STARTED + - STOPPED + CallbackUri: + description: >- + The URI of the endpoint for the notification to be sent to. + type: string + format: uri + AppInstSubscriptionInfo.links: + description: Links to resources related to this resource. + properties: + self: + $ref: '#/components/schemas/LinkType' + required: + - self + type: object + + AppLcmOpOccSubscriptionRequest: + properties: + appLcmOpOccSubscriptionFilter: + # description': Subscription filter criteria to match specific application LCM operation occurrences. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': AppLcmOpOccSubscriptionFilter + $ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter' + callbackUri: + # description': The URI of the endpoint for the notification to be sent to. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': Uri + $ref: '#/components/schemas/URI' + subscriptionType: + description: Shall be set to "AppLcmOpOccStateChange". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackUri + type: object + x-etsi-ref: 6.2.2.14 + URI: + type: string + AppLcmOpOccSubscriptionFilter: + properties: + appInstanceSubscriptionFilter: + # description': If present, this attribute contains filter criteria that selects one or more application instances on which to receive "LCM operation occurrence" notifications. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': AppInstanceSubscriptionFilter + $ref: '#/components/schemas/AppInstanceSubscriptionFilter' + notificationTypes: + $ref: '#/components/schemas/NotificationTypes' + operationStates: + $ref: '#/components/schemas/OperationStates' + operationTypes: + $ref: '#/components/schemas/OperationTypes' + NotificationTypes: + description: Match particular notification types. + type: string + enum: + - AppLcmOperationOccurrenceNotification + OperationStates: + description: >- + 'Type of the LCM operation state represented by this application instance LCM operation occurrence.' + type: string + enum: + - STARTING + - PROCESSING + - COMPLETED + - FAILED + OperationTypes: + description: >- + 'Type of the LCM operation represented by this application instance LCM operation occurrence.' + type: string + enum: + - INSTANTIATE + - OPERATE + - TERMINATE + CreateAppInstanceRequest: + properties: + appDId: + description: The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appInstanceDescription: + description: Human-readable description of the application instance to be created. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + appInstanceName: + description: Human-readable name of the application instance to be created. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + required: + - appDId + type: object + x-etsi-ref: 6.2.2.3 + AppInstSubscriptionRequest: + type: object + required: + - subscriptionType + - callbackUri + properties: + subscriptionType: + $ref: '#/components/schemas/AppInst.SubscriptionType' + callbackUri: + $ref: '#/components/schemas/CallbackUri' + appInstanceState: + $ref: '#/components/schemas/AppInstanceState' + appInstanceSubscriptionFilter: + $ref: '#/components/schemas/AppInstanceSubscriptionFilter' + AppInstanceSubscriptionFilter: + description: >- + 'This data type represents subscription filter criteria to match application instances. ' + type: object + required: + - appInstSelectorType + properties: + appInstSelectorType: + $ref: '#/components/schemas/AppInstSelectorType' + appInstances: + type: array + items: + $ref: '#/components/schemas/AppInstances' + appsFromProviders: + type: array + items: + $ref: '#/components/schemas/AppsFromProviders' + AppsFromProviders: + description: >- + 'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.' + type: object + required: + - appProvider + properties: + appProvider: + $ref: '#/components/schemas/AppProvider' + appProducts: + $ref: '#/components/schemas/AppProducts' + AppProducts: + description: >- + 'If present, match application instances that belong to application products with certain product names, from one particular provider.' + type: object + required: + - appName + properties: + appName: + $ref: '#/components/schemas/AppName' + versions: + $ref: '#/components/schemas/AppProducts.Versions' + AppProducts.Versions: + description: >- + 'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.' + type: object + required: + - appSoftVersion + properties: + appSoftVersion: + $ref: '#/components/schemas/AppSoftVersion' + appDVersion: + type: array + items: + $ref: '#/components/schemas/AppDVersion' + AppInstances: + description: >- + If appInstIdSelector = APP_IDENTITY match existing application instances with an application instance identifier listed in this attribute. + type: string + AppInstSelectorType: + description: '0 = void' + type: string + enum: + - VOID + - APP_IDENTITY + - APP_NAME + - APP_D_ID + - APP_FROM_PROVIDER + AppInstanceState: + description: >- + Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states. + type: string + format: enum + enum: + - NOT_INSTANTIATED + - STARTED + - STOPPED + AppInstNotification: + properties: + _links: + description: Links to resources related to this notification. + properties: + subscription: + # description': A link to the related subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - subscription + type: object + x-etsi-mec-cardinality: '1' + appDId: + description: The application descriptor identifier identifies the application package and the application descriptor in a globally unique way. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appInstanceId: + description: Identifier of application instance. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appPkgId: + description: 'Identifier of the onboarded application package. ' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + id: + 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. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + notificationType: + # description: "Discriminator for the different notification types:\nNOT_INSTANTIATED: the application instance is not instantiated. \nSTARTED: the application instance is up and running. \nSTOPPED: the application instance stops operation." + # type: string + # x-etsi-mec-cardinality: '1' + $ref: '#/components/schemas/AppInst.NotificationType' + subscriptionId: + description: Identifier of the subscription related to this notification. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + timeStamp: + # description': Date and time of the notification generation. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - id + - notificationType + - subscriptionId + - timeStamp + - appInstanceId + - appPkgId + - appDId + - _links + type: object + x-etsi-ref: 6.2.2.11 + AppInstanceInfo: + description: >- + 'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.' + type: object + required: + - id + - appDId + - appProvider + - appName + - appSoftVersion + - appDVersion + - appPkgId + - instantiationState + - _links + properties: + id: + $ref: '#/components/schemas/AppInstanceId' + appInstanceName: + $ref: '#/components/schemas/AppInstanceName' + appInstanceDescription: + $ref: '#/components/schemas/AppInstanceDescription' + appDId: + $ref: '#/components/schemas/AppDId' + appProvider: + $ref: '#/components/schemas/AppProvider' + appName: + $ref: '#/components/schemas/AppName' + appSoftVersion: + $ref: '#/components/schemas/AppSoftVersion' + appDVersion: + $ref: '#/components/schemas/AppDVersion' + appPkgId: + $ref: '#/components/schemas/AppPkgId' + vimConnectionInfo: + type: array + items: + $ref: '#/components/schemas/VimConnectionInfo' + instantiationState: + $ref: '#/components/schemas/InstantiationState' + instantiatedAppState: + $ref: '#/components/schemas/InstantiatedAppState' + _links: + $ref: '#/components/schemas/AppInstanceInfo.links' + AppInstanceId: + description: >- + Identifier of application instance. + type: string + OperationState: + description: >- + Operation state + type: string + format: enum + enum: + - STARTING + - PROCESSING + - COMPLETED + - FAILED + AppInstanceName: + description: Name of the application instance. + type: string + AppInstanceDescription: + description: Human-readable description of the application instance to be created. + type: string + AppDId: + description: 'Identifier of this MEC application descriptor. This attribute shall be globally unique.' + type: string + AppProvider: + description: 'Provider of the application and of the AppD.' + type: string + AppName: + description: 'Name to identify the MEC application.' + type: string + AppSoftVersion: + description: 'Identifies the version of software of the MEC application.' + type: string + AppDVersion: + description: 'Identifies the version of the application descriptor.' + type: string + AppPkgId: + description: Identifier of the onboarded application package. + type: string + InstantiationState: + description: Instantiation state of the application instance + type: string + enum: + - NOT_INSTANTIATED + - INSTANTIATED + InstantiatedAppState: + description: >- + 'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.' + type: object + required: + - operationalState + properties: + operationalState: + $ref: '#/components/schemas/OperationalState' + OperationalState: + description: Operational state is applicable in the instantiation state INSTANTIATED + type: string + enum: + - STARTED + - STOPPED + AppInstanceInfo.links: + description: >- + Links to resources related to this resource. + type: object + required: + - self + properties: + self: + $ref: '#/components/schemas/LinkType' + instantiate: + $ref: '#/components/schemas/LinkType' + terminate: + $ref: '#/components/schemas/LinkType' + operate: + $ref: '#/components/schemas/LinkType' + LcmOperation: + description: >- + Type of the actual LCM operation represented by this application instance LCM operation occurrence + type: string + format: enum + enum: + - INSTATIATE + - OPERATE + - TERMINATE + AppLcmOpOccNotification: + description: >- + 'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers' + type: object + required: + - id + - notificationType + - subscriptionId + - timeStamp + - appLcmOpOccId + - appInstanceId + - _links + properties: + id: + $ref: '#/components/schemas/AppLcmOpOccNotification.Id' + notificationType: + $ref: '#/components/schemas/AppLcmOpOcc.NotificationType' + subscriptionId: + $ref: '#/components/schemas/SubscriptionId' + timeStamp: + $ref: '#/components/schemas/TimeStamp' + appLcmOpOccId: + $ref: '#/components/schemas/AppLcmOpOccId' + appInstanceId: + $ref: '#/components/schemas/AppInstanceId' + _links: + $ref: '#/components/schemas/AppLcmOpOccNotification.links' + AppLcmOpOccNotification.Id: + description: >- + '' + type: string + AppLcmOpOcc.NotificationType: + description: >- + Discriminator for the different notification types + type: string + enum: + - STARTING + - PROCESSING + - COMPLETED + - FAILED + SubscriptionId: + description: >- + Identifier of the subscription related to this notification. + type: string + AppLcmOpOccId: + description: >- + Identifier of application lifecycle management operation occurrence. + type: string + AppLcmOpOccNotification.links: + description: >- + Links to resources related to this resource. + type: object + required: + - appInstance + - subscription + - appLcmOpOcc + properties: + appInstance: + $ref: '#/components/schemas/LinkType' + subscription: + $ref: '#/components/schemas/LinkType' + appLcmOpOcc: + $ref: '#/components/schemas/LinkType' + InstantiateAppRequest: + properties: + locationConstraints: + # description': Defines the location constraints for the application instance to be created. See note 3. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': LocationConstraints + $ref: '#/components/schemas/LocationConstraints' + selectedMECHostInfo: + description: Describes the information of selected host for the application instance. See note 2. + items: + $ref: '#/components/schemas/MECHostInformation' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: MECHostInformation + vimConnectionInfo: + description: 'Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links. + + This attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2.' + items: + $ref: '#/components/schemas/VimConnectionInfo' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: VimConnectionInfo + virtualComputeDescriptor: + # description': Describes CPU, Memory and acceleration requirements of the virtual machine for the application instance to be created. See note 1. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': VirtualComputeDescription + $ref: '#/components/schemas/VirtualComputeDescription' + virtualStorageDescriptor: + description: Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1. + items: + $ref: '#/components/schemas/VirtualStorageDescriptor' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: VirtualStorageDescriptor + required: + - selectedMECHostInfo + type: object + x-etsi-notes: "NOTE 1:\tThis attribute may be provided in the InstantiateAppRequest structure to override the same attribute in the AppD. \nNOTE 2:\tThis field applies to Mm3 reference point only.\nNOTE 3:\tThis field applies to Mm1 reference point only." + x-etsi-ref: 6.2.2.7 + LinkType: + properties: + href: + description: URI referring to a resource + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + required: + - href + type: object + x-etsi-ref: 6.5.2 + LocationConstraints: + description: >- + 'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776' + type: object + required: + - countryCode + properties: + countryCode: + $ref: '#/components/schemas/CountryCode' + civicAddressElement: + type: array + items: + $ref: '#/components/schemas/CivicAddressElement' + CountryCode: + description: 'The two-letter ISO 3166 country code in capital letters.' + type: string + CivicAddressElement: + description: >- + 'The civic address.' + type: object + required: + - caType + - caValue + properties: + caType: + $ref: '#/components/schemas/CaType' + caValue: + $ref: '#/components/schemas/CaValue' + CaType: + description: >- + 'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.' + type: integer + CaValue: + description: >- + 'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.' + type: string + MECHostInformation: + properties: + hostId: + #description: 'User defined MEC host ID. ' + $ref: '#/components/schemas/KeyValuePairs' + #x-etsi-mec-cardinality: '1' + #x-etsi-mec-origin-type: KeyValuePairs + hostName: + description: Human-readable name of MEC host. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + required: + - hostId + type: object + x-etsi-ref: 6.2.2.17 + OperateAppRequest: + properties: + changeStateTo: + #description: "The desired operational state: \nSTARTED: the application instance is up and running.\nSTOPPED: the application instance stops operation." + # x-etsi-mec-cardinality: '1' + $ref: '#/components/schemas/ChangeStateTo' + gracefulStopTimeout: + description: The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Integer + stopType: + #description: 'The stop type' + #x-etsi-mec-cardinality: 0..1 + $ref: '#/components/schemas/StopType' + required: + - changeStateTo + type: object + x-etsi-notes: "NOTE 1:\tThe \"stopType\" and \"gracefulStopTimeout\" attributes shall be absent, when the \"changeStateTo\" attribute is equal to \"STARTED\". \nNOTE 2:\tThe \"gracefulStopTimeout\" attribute shall be present, when the \"changeStateTo\" is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"GRACEFUL\". The \"gracefulStopTimeout\" attribute shall be absent, when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"FORCEFUL\". \nNOTE 3:\tThe request shall be treated as if the \"stopType\" attribute was set to \"FORCEFUL\", when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is absent." + x-etsi-ref: 6.2.2.8 + StopType: + description: >- + Signals forceful or graceful stop + type: string + enum: + - FORCEFUL + - GRACEFUL + ChangeStateTo: + description: 'The desired operational state' + type: string + format: enum + enum: + - STARTED + - STOPPED + ProblemDetails: + properties: + detail: + description: A human-readable explanation specific to this occurrence of the problem + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + instance: + description: A URI reference that identifies the specific occurrence of the problem + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + status: + description: The HTTP status code for this occurrence of the problem + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + title: + description: A short, human-readable summary of the problem type + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: + description: A URI reference according to IETF RFC 3986 that identifies the problem type + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + type: object + TerminateAppRequest: + properties: + gracefulTerminationTimeout: + description: "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources." + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Integer + terminationType: + # description: 'Indicates whether forceful or graceful termination is requested.' + # x-etsi-mec-cardinality: '1' + $ref: '#/components/schemas/TerminationType' + required: + - terminationType + type: object + x-etsi-notes: "NOTE:\tIf the application instance is still in service, requesting forceful termination can adversely impact service." + x-etsi-ref: 6.2.2.9 + TimeStamp: + properties: + nanoSeconds: + description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + format: Uint32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + seconds: + description: "The seconds part of the Time. Time is defined as Unix-time since January\_1, 1970, 00:00:00 UTC." + format: Uint32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + required: + - seconds + - nanoSeconds + type: object + x-etsi-ref: 6.2.5.4 + TerminationType: + description: >- + 'Indicates whether forceful or graceful termination is requested.' + type: string + format: enum + enum: + - FORCEFUL + - GRACEFUL + VimConnectionInfo: + properties: + accessInfo: + #description: 'Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups (see note). The applicable keys are dependent on the content of vimType.If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included.If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band.' + $ref: '#/components/schemas/KeyValuePairs' + #x-etsi-mec-cardinality: 0..1 + #x-etsi-mec-origin-type: KeyValuePairs + extra: + #description: VIM type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType. + $ref: '#/components/schemas/KeyValuePairs' + #x-etsi-mec-cardinality: 0..1 + #x-etsi-mec-origin-type: KeyValuePairs + id: + description: The identifier of the VIM Connection. This identifier is managed by the MEO. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + interfaceInfo: + #description: 'Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of vimType.Alternatively, such information may have been configured into the VNFM and bound to the vimId.' + $ref: '#/components/schemas/KeyValuePairs' + #x-etsi-mec-cardinality: 0..1 + #x-etsi-mec-origin-type: KeyValuePairs + vimId: + description: 'The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + vimType: + description: 'Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. ' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - id + - vimType + type: object + x-etsi-ref: 6.2.2.18 + VirtualComputeDescription: + description: Ref NFV + type: string + VirtualStorageDescriptor: + description: Ref NFV + type: string + 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' + type: object + additionalProperties: true + + responses: + 204: + description: No Content + 206: + description: Partial content + 400: + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 401: + description: 'Unauthorized : used when the client did not submit credentials.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 403: + description: 'Forbidden : operation is not allowed given the current status of the resource.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 404: + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 406: + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 409: + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 412: + description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when + using ETags to avoid write conflicts when using PUT' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 414: + description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 415: + description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + + 416: + description: 'Range Not Satisfiable .' + 422: + description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + example: + application/problem+json: + problemDetails: + type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets' + title: Too many targets + status: '422' + detail: The target area for the request is considered too large + instance: /meAppClient.example.com/77777/msgs/abc + 429: + description: 'Too Many Requests : used when a rate limiter has triggered.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' diff --git a/MEC010-2_AppPkgMgmt.json b/MEC010-2_AppPkgMgmt.json new file mode 100644 index 0000000000000000000000000000000000000000..cafe616d0a81047c232dd12df3696554fe084714 --- /dev/null +++ b/MEC010-2_AppPkgMgmt.json @@ -0,0 +1,2339 @@ +{ + "info": { + "title": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management", + "version": "2.1.1", + "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", + "email": "cti_support@etsi.org", + "url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api" + } + }, + "externalDocs": { + "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1", + "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf" + }, + "servers": [ + { + "url": "https://localhost/app_pkgm/v1" + } + ], + "openapi": "3.0.0", + "tags": [ + { + "name": "app-pkgm", + "description": "App Package management" + }, + { + "name": "app-pkgm-notifications", + "description": "App Package management notifications" + } + ], + "paths": { + "/app_packages": { + "post": { + "tags": [ + "app-pkgm" + ], + "summary": "Create a resource for on-boarding an application package to a MEO", + "description": "Create a resource for on-boarding an application package to a MEO", + "operationId": "app_packagesPOST", + "requestBody": { + "description": "Resource to be created", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateAppPkg" + } + } + } + }, + "responses": { + "201": { + "description": "Successful response for resource creation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$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" + } + } + }, + "get": { + "tags": [ + "app-pkgm" + ], + "summary": "Queries information relating to on-boarded application packages in the MEO", + "description": "queries information relating to on-boarded application packages in the MEO", + "operationId": "app_packagesGET", + "parameters": [ + { + "in": "query", + "name": "filter", + "schema": { + "type": "string" + }, + "required": false, + "description": "Attribute-based filtering parameters according to ETSI GS MEC 009" + }, + { + "in": "query", + "name": "all_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Include all complex attributes in the response." + }, + { + "in": "query", + "name": "fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes of AppPkgInfo to be included into the response" + }, + { + "in": "query", + "name": "exclude_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes of AppPkgInfo to be excluded from the response." + }, + { + "in": "query", + "name": "exclude_default", + "schema": { + "type": "string" + }, + "required": false, + "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response." + } + ], + "responses": { + "200": { + "description": "Contains a representation of the application package resource", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$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" + } + } + } + }, + "/app_packages/{appPkgId}": { + "parameters": [ + { + "in": "path", + "name": "appPkgId", + "schema": { + "type": "string" + }, + "required": true, + "description": "Identifier of an individual application package resource" + } + ], + "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", + "responses": { + "200": { + "description": "Contains a representation of the application package resource", + "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" + } + } + }, + "delete": { + "tags": [ + "app-pkgm" + ], + "summary": "Deletes an individual application package resources", + "description": "Deletes an individual application package resources", + "operationId": "app_packageDELETE", + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "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" + } + } + }, + "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", + "requestBody": { + "description": "Operational state to be set", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPkgInfoModifications" + } + } + } + }, + "responses": { + "200": { + "description": "Shows that the operation has been completed successfully", + "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" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/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", + "requestBody": { + "description": "The input parameters of subscribe operation to notifications", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPkgSubscription" + } + } + } + }, + "responses": { + "201": { + "description": "Successful response for created subscription", + "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" + } + } + }, + "get": { + "tags": [ + "app-pkgm" + ], + "summary": "used to retrieve the information of subscriptions to individual application package resource in MEO", + "description": "used to retrieve the information of subscriptions to individual application package resource in MEO package", + "operationId": "subscriptionsGET", + "responses": { + "200": { + "description": "List of zero or more subscriptions", + "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" + } + } + } + }, + "/subscriptions/{subscriptionId}": { + "parameters": [ + { + "in": "path", + "name": "subscriptionId", + "schema": { + "type": "string" + }, + "description": "Identifier of an individual subscription to notifications about application package changes", + "required": true + } + ], + "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", + "responses": { + "200": { + "description": "Representation of the resource.", + "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" + } + } + }, + "delete": { + "tags": [ + "app-pkgm" + ], + "summary": "Deletes the individual subscription to notifications about application package changes in MEO.", + "description": "Deletes the individual subscription to notifications about application package changes in MEO.", + "operationId": "individualSubscriptionDELETE", + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/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", + "requestBody": { + "description": "Notification endpoint to be created", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPkgNotification" + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/app_packages/{appPkgId}/appd": { + "parameters": [ + { + "in": "path", + "name": "appPkgId", + "schema": { + "type": "string" + }, + "description": "Identifier of an on-boarded individual application package", + "required": true + } + ], + "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": [ + { + "in": "query", + "name": "filter", + "schema": { + "type": "string" + }, + "required": false, + "description": "Attribute-based filtering parameters according to ETSI GS MEC 009" + }, + { + "in": "query", + "name": "all_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Include all complex attributes in the response." + }, + { + "in": "query", + "name": "fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes of AppPkgInfo to be included into the response" + }, + { + "in": "query", + "name": "exclude_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes of AppPkgInfo to be excluded from the response." + }, + { + "in": "query", + "name": "exclude_default", + "schema": { + "type": "string" + }, + "required": false, + "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response." + } + ], + "responses": { + "200": { + "description": "Content of the AppD is returned.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/AppD" + } + }, + "application/zip": { + "schema": { + "$ref": "#/components/schemas/AppD" + } + } + } + }, + "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" + } + } + } + }, + "/onboarded_app_packages/{appDId}/appd": { + "parameters": [ + { + "in": "path", + "name": "appDId", + "schema": { + "type": "string" + }, + "description": "Identifier of an application descriptor", + "required": true + } + ], + "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": [ + { + "in": "query", + "name": "filter", + "schema": { + "type": "string" + }, + "required": false, + "description": "Attribute-based filtering parameters according to ETSI GS MEC 009" + }, + { + "in": "query", + "name": "all_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Include all complex attributes in the response." + }, + { + "in": "query", + "name": "fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes of AppPkgInfo to be included into the response" + }, + { + "in": "query", + "name": "exclude_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes of AppPkgInfo to be excluded from the response." + }, + { + "in": "query", + "name": "exclude_default", + "schema": { + "type": "string" + }, + "required": false, + "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response." + } + ], + "responses": { + "200": { + "description": "Content of the AppD is returned.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/AppD" + } + }, + "application/zip": { + "schema": { + "$ref": "#/components/schemas/AppD" + } + } + } + }, + "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" + } + } + } + }, + "/app_packages/{appPkgId}/package_content": { + "parameters": [ + { + "in": "path", + "name": "appPkgId", + "schema": { + "type": "string" + }, + "description": "Identifier of an on-boarded individual application package", + "required": true + } + ], + "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", + "responses": { + "200": { + "$ref": "#/components/responses/AppPkgContent.200" + }, + "206": { + "$ref": "#/components/responses/206" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "416": { + "$ref": "#/components/responses/416" + }, + "406": { + "$ref": "#/components/responses/406" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + }, + "put": { + "tags": [ + "app-pkgm" + ], + "summary": "Uploads the content of application package.", + "description": "Uploads the content of application package.", + "operationId": "appPkgPUT", + "requestBody": { + "content": { + "application/zip": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "responses": { + "202": { + "description": "The application package has been accepted for uploading, but the processing has not been completed." + }, + "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" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/onboarded_app_packages/{appDId}/package_content": { + "parameters": [ + { + "in": "path", + "name": "appDId", + "description": "Identifier of an application descriptor", + "schema": { + "type": "string" + }, + "required": true + } + ], + "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", + "responses": { + "200": { + "$ref": "#/components/responses/AppPkgContent.200" + }, + "206": { + "$ref": "#/components/responses/206" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "416": { + "$ref": "#/components/responses/416" + }, + "406": { + "$ref": "#/components/responses/406" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + }, + "put": { + "tags": [ + "app-pkgm" + ], + "summary": "Uploads the content of application package.", + "description": "Uploads the content of application package.", + "operationId": "appDIdPUT", + "requestBody": { + "content": { + "application/zip": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "responses": { + "202": { + "description": "The application package has been accepted for uploading, but the processing has not been completed." + }, + "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" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + } + }, + "components": { + "schemas": { + "Algorithm": { + "description": " Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.", + "type": "string" + }, + "AppD": { + "properties": { + "appDId": { + "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appDNSRule": { + "description": "Describes DNS rules the MEC application requires.", + "items": { + "$ref": "#/components/schemas/DNSRuleDescriptor" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "DNSRuleDescriptor" + }, + "appDVersion": { + "description": "Identifies the version of the application descriptor.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appDescription": { + "description": "Human readable description of the MEC application.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appExtCpd": { + "description": "Describes external interface(s) exposed by this MEC application.", + "items": { + "$ref": "#/components/schemas/AppExternalCpd" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "AppExternalCpd" + }, + "appFeatureOptional": { + "description": "Describes features a MEC application may use if available.", + "items": { + "$ref": "#/components/schemas/FeatureDependency" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "FeatureDependency" + }, + "appFeatureRequired": { + "description": "Describes features a MEC application requires to run.", + "items": { + "$ref": "#/components/schemas/FeatureDependency" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "FeatureDependency" + }, + "appInfoName": { + "description": "Human readable name for the MEC application.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "appLatency": { + "$ref": "#/components/schemas/LatencyDescriptor" + }, + "appName": { + "description": "Name to identify the MEC application.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appProvider": { + "description": "Provider of the application and of the AppD.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appServiceOptional": { + "description": "Describes services a MEC application may use if available.", + "items": { + "$ref": "#/components/schemas/ServiceDependency" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "ServiceDependency" + }, + "appServiceProduced": { + "description": "Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps.", + "items": { + "$ref": "#/components/schemas/ServiceDescriptor" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "ServiceDescriptor" + }, + "appServiceRequired": { + "description": "Describes services a MEC application requires to run.", + "items": { + "$ref": "#/components/schemas/ServiceDependency" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "ServiceDependency" + }, + "appSoftVersion": { + "description": "Identifies the version of software of the MEC application.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appTrafficRule": { + "description": "Describes traffic rules the MEC application requires.", + "items": { + "$ref": "#/components/schemas/TrafficRuleDescriptor" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "TrafficRuleDescriptor" + }, + "changeAppInstanceStateOpConfig": { + "$ref": "#/components/schemas/ChangeAppInstanceStateOpConfig" + }, + "mecVersion": { + "description": "Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "swImageDescriptor": { + "$ref": "#/components/schemas/SwImageDescriptor" + }, + "terminateAppInstanceOpConfig": { + "$ref": "#/components/schemas/TerminateAppInstanceOpConfig" + }, + "transportDependencies": { + "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.", + "items": { + "$ref": "#/components/schemas/TransportDependency" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "TransportDependency" + }, + "virtualComputeDescriptor": { + "$ref": "#/components/schemas/VirtualComputeDescription" + }, + "virtualStorageDescriptor": { + "description": "Defines descriptors of virtual storage resources to be used by the MEC application.", + "items": { + "$ref": "#/components/schemas/VirtualStorageDescriptor" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "VirtualStorageDescriptor" + } + }, + "required": [ + "appDId", + "appName", + "appProvider", + "appSoftVersion", + "appDVersion", + "mecVersion", + "appDescription", + "virtualComputeDescriptor", + "swImageDescriptor" + ], + "type": "object", + "x-etsi-notes": "NOTE 1:\tThe appDId shall be used as the unique identifier of the application package that contains this AppD.\nNOTE 2:\tThis 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.", + "x-etsi-ref": "6.2.1.2" + }, + "AppExternalCpd": { + "properties": { + "inherited_attributes": { + "description": "All attributes inherited from Cpd.", + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "inherited_attributes" + }, + "virtualNetworkInterfaceRequirements": { + "description": "Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD.", + "items": { + "$ref": "#/components/schemas/VirtualNetworkInterfaceRequirements" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N" + } + }, + "required": [ + "inherited_attributes" + ], + "type": "object", + "x-etsi-ref": "6.2.1.6" + }, + "CallbackUri": { + "description": "The URI of the endpoint for the notification to be sent to.", + "type": "string", + "format": "uri" + }, + "AppDId": { + "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique.", + "type": "string" + }, + "AppProvider": { + "description": "Provider of the application and of the AppD.", + "type": "string" + }, + "AppName": { + "description": "Name to identify the MEC application.", + "type": "string" + }, + "AppDVersion": { + "description": "Identifies the version of the application descriptor.", + "type": "string" + }, + "AppPkgId": { + "description": "Identifier of the onboarded application package.", + "type": "string" + }, + "SubscriptionId": { + "description": "Identifier of the subscription related to this notification.", + "type": "string" + }, + "AppPkgArtifactInfo": { + "description": "Additional information of application package artifacts that are not application software images. Type is TBD" + }, + "AppPkgInfo": { + "description": "'The data type AppPkgInfo represents the parameters for an application package resource'", + "type": "object", + "required": [ + "id", + "appDId", + "appName", + "appSoftwareVersion", + "appDVersion", + "checksum", + "softwareImages", + "onboardingState", + "operationalState", + "usageState", + "_links" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/AppPkgId" + }, + "appDId": { + "$ref": "#/components/schemas/AppDId" + }, + "appProvider": { + "$ref": "#/components/schemas/AppProvider" + }, + "appName": { + "$ref": "#/components/schemas/AppName" + }, + "appSoftwareVersion": { + "$ref": "#/components/schemas/AppSoftwareVersion" + }, + "appDVersion": { + "$ref": "#/components/schemas/AppDVersion" + }, + "checksum": { + "$ref": "#/components/schemas/Checksum" + }, + "softwareImages": { + "$ref": "#/components/schemas/AppPkgSWImageInfo" + }, + "additionalArtifacts": { + "$ref": "#/components/schemas/AppPkgArtifactInfo" + }, + "onboardingState": { + "$ref": "#/components/schemas/OnboardingState" + }, + "operationalState": { + "$ref": "#/components/schemas/AppPkg.OperationalState" + }, + "usageState": { + "$ref": "#/components/schemas/UsageState" + }, + "userDefinedData": { + "$ref": "#/components/schemas/KeyValuePairs" + }, + "_links": { + "$ref": "#/components/schemas/AppPkgInfo.links" + } + } + }, + "AppPkgInfoModifications": { + "description": "'The data type represents the operational state for an application package resource'", + "type": "object", + "required": [ + "operationState" + ], + "properties": { + "operationState": { + "type": "string", + "enum": [ + "DISABLED", + "ENABLED" + ] + } + } + }, + "AppSoftwareVersion": { + "description": "Software version of the application. This is updated when there is any change to the software in the onboarded application package.", + "type": "string" + }, + "AppPkg.OperationalState": { + "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.", + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "OnboardingState": { + "description": "Onboarding state of application package", + "type": "string", + "format": "enum", + "enum": [ + "CREATED", + "UPLOADING", + "PROCESSING", + "ONBOARDED" + ] + }, + "UsageState": { + "description": "Usage state of the onboarded instance of the application package", + "type": "string", + "format": "enum", + "enum": [ + "IN_USE", + "NOT_IN_USE" + ] + }, + "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'", + "type": "object", + "additionalProperties": true + }, + "AppPkgInfo.links": { + "description": "Links to resources related to this resource.", + "type": "object", + "required": [ + "self", + "appD", + "appPkgContent" + ], + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + }, + "appD": { + "$ref": "#/components/schemas/LinkType" + }, + "appPkgContent": { + "$ref": "#/components/schemas/LinkType" + } + } + }, + "AppPkgNotification": { + "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'", + "type": "object", + "required": [ + "id", + "notificationType", + "subscriptionId", + "timeStamp", + "appPkgId", + "appDId", + "operationalState", + "_links" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/AppPkgNotification.Id" + }, + "notificationType": { + "$ref": "#/components/schemas/AppPkg.NotificationType" + }, + "subscriptionId": { + "$ref": "#/components/schemas/SubscriptionId" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "appPkgId": { + "$ref": "#/components/schemas/AppPkgId" + }, + "appDId": { + "$ref": "#/components/schemas/AppDId" + }, + "operationalState": { + "type": "string", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "_links": { + "$ref": "#/components/schemas/AppPkgNotification.links" + } + } + }, + "AppPkgNotification.Id": { + "description": "''", + "type": "string" + }, + "AppPkg.NotificationType": { + "description": "Discriminator for the different notification types", + "type": "string", + "enum": [ + "AppPackageOnBoarded", + "AppPacakgeEnabled", + "AppPacakgeDisabled", + "AppPackageDeleted" + ] + }, + "AppPkgNotification.links": { + "description": "Links to resources related to this resource.", + "type": "object", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "$ref": "#/components/schemas/LinkType" + } + } + }, + "AppPkgSWImageInfo": { + "description": "Information of application software image in application package. Type is TBD" + }, + "AppPkgSubscriptionInfo": { + "description": "'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package'", + "type": "object", + "required": [ + "id", + "subscriptionType", + "callbackUri", + "_links" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/AppPkgSubscriptionInfo.Id" + }, + "subscriptionType": { + "$ref": "#/components/schemas/AppPkg.SubscriptionType" + }, + "callbackUri": { + "$ref": "#/components/schemas/CallbackUri" + }, + "_links": { + "$ref": "#/components/schemas/AppPkgSubscriptionInfo.links" + } + } + }, + "AppPkgSubscriptionInfo.Id": { + "description": "''", + "type": "string" + }, + "AppPkg.SubscriptionType": { + "description": "Subscribed notification type.", + "type": "string", + "enum": [ + "AppPackageOnBoarding", + "AppPacakgeOperationChange", + "AppPackageDeletion" + ] + }, + "AppPkgSubscriptionInfo.links": { + "description": "Links to resources related to this resource.", + "type": "object", + "required": [ + "self" + ], + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + } + }, + "AppPkgSubscriptionLinkList": { + "description": "'The data type represents a subscription link list of notification on application package management'", + "type": "object", + "required": [ + "_links" + ], + "properties": { + "_links": { + "$ref": "#/components/schemas/AppPkgSubscriptionLinkList.links" + } + } + }, + "AppPkgSubscriptionLinkList.links": { + "description": "Links to resources related to this resource.", + "type": "object", + "required": [ + "self" + ], + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + }, + "subscriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscriptions.AppPkgSubscription" + } + } + } + }, + "Subscriptions.AppPkgSubscription": { + "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": "object", + "required": [ + "href", + "subsctiptionType" + ], + "properties": { + "href": { + "$ref": "#/components/schemas/Href" + }, + "subsctiptionType": { + "$ref": "#/components/schemas/SubsctiptionType.AppPkg" + } + } + }, + "Href": { + "description": "The URI referring to the subscription.", + "type": "string", + "format": "uri" + }, + "AppPkgSubscription": { + "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": "object", + "required": [ + "callbackUri", + "subsctiptionType" + ], + "properties": { + "callbackUri": { + "$ref": "#/components/schemas/CallbackUri" + }, + "subsctiptionType": { + "$ref": "#/components/schemas/SubsctiptionType.AppPkg" + }, + "appPkgFilter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPkgFilter" + } + } + } + }, + "SubsctiptionType.AppPkg": { + "description": "'Subscribed notification type'", + "type": "string", + "enum": [ + "AppPackageOnBoarding", + "AppPacakgeOperationChange", + "AppPackageDeletion" + ] + }, + "AppPkgFilter": { + "type": "string", + "description": "The attribute-based filter is to filter application packages on which the query applies." + }, + "ChangeAppInstanceStateOpConfig": { + "description": "NFV", + "type": "string" + }, + "Checksum": { + "description": "", + "properties": { + "algorithm": { + "$ref": "#/components/schemas/Algorithm" + }, + "hash": { + "$ref": "#/components/schemas/Hash" + } + }, + "required": [ + "algorithm", + "hash" + ], + "type": "object" + }, + "CreateAppPkg": { + "properties": { + "appPkgName": { + "description": "Name of the application package to be onboarded.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appPkgPath": { + "$ref": "#/components/schemas/URI" + }, + "appPkgVersion": { + "description": "Version of the application package to be onboarded.\nThe appPkgName with appPkgVersion can be used to uniquely identify the application package.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appProvider": { + "description": "The provider's name of the application package to be onboarded.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "checksum": { + "$ref": "#/components/schemas/Checksum" + }, + "userDefinedData": { + "$ref": "#/components/schemas/KeyValuePairs" + } + }, + "required": [ + "appPkgName", + "appPkgVersion", + "checksum", + "appPkgPath" + ], + "type": "object", + "x-etsi-notes": "NOTE:\tIt is for further study how to convey appPkgPath, and align with ETSI GS NFV-SOL 005 [i.7].", + "x-etsi-ref": "6.2.3.2" + }, + "DNSRuleDescriptor": { + "properties": { + "dnsRuleId": { + "description": "Identifies the DNS Rule", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "domainName": { + "description": "FQDN of the DNS rule", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "ipAddress": { + "description": "IP address given by the DNS rule", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "ipAddressType": { + "$ref": "#/components/schemas/IpAddressType" + }, + "ttl": { + "description": "Time-to-live value", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Int" + } + }, + "required": [ + "dnsRuleId", + "domainName", + "ipAddressType", + "ipAddress" + ], + "type": "object", + "x-etsi-ref": "6.2.1.13" + }, + "IpAddressType": { + "description": "Specifies the IP address type", + "type": "string", + "enum": [ + "IP_V6", + "IP_V4" + ] + }, + "FeatureDependency": { + "properties": { + "featureName": { + "description": "The name of the feature, for example, UserApps, UEIdentity, etc.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "version": { + "description": "The version of the feature.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "featureName", + "version" + ], + "type": "object", + "x-etsi-ref": "6.2.1.8" + }, + "Hash": { + "description": "'String 1 The hexadecimal value of the checksum'", + "type": "string" + }, + "InterfaceDescriptor": { + "properties": { + "dstIPAddress": { + "description": "If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "dstMACAddress": { + "description": "If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "interfaceType": { + "$ref": "#/components/schemas/InterfaceType" + }, + "srcMACAddress": { + "description": "If the interface type is MAC, the source address identifies the MAC address of the interface.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "tunnelInfo": { + "$ref": "#/components/schemas/TunnelInfo" + } + }, + "required": [ + "interfaceType" + ], + "type": "object", + "x-etsi-ref": "6.2.1.11" + }, + "InterfaceType": { + "description": "Type of interface.", + "type": "string", + "enum": [ + "TUNNEL", + "MAC", + "IP" + ] + }, + "LatencyDescriptor": { + "properties": { + "maxLatency": { + "description": "The value of the maximum latency in nano seconds tolerated by the MEC application. See note.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "maxLatency" + ], + "type": "object", + "x-etsi-notes": "NOTE:\tThe latency is considered to be the one way end-to-end latency between the client application (e.g. in a device) and the service (i.e. the MEC Application instance).", + "x-etsi-ref": "6.2.1.14" + }, + "LinkType": { + "properties": { + "href": { + "description": "URI referring to a resource", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "URI" + } + }, + "required": [ + "href" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "ProblemDetails": { + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "instance": { + "description": "A URI reference that identifies the specific occurrence of the problem", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + }, + "status": { + "description": "The HTTP status code for this occurrence of the problem", + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "title": { + "description": "A short, human-readable summary of the problem type", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "type": { + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + } + }, + "type": "object" + }, + "SerializerTypes": { + "type": "string" + }, + "ServiceDependency": { + "properties": { + "requestedPermissions": { + "description": "Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4].\nThe format of this attribute is left for the data model design stage.", + "items": { + "$ref": "#/components/schemas/Not_specified" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Not_specified" + }, + "serCategory": { + "$ref": "#/components/schemas/CategoryRef" + }, + "serName": { + "description": "The name of the service, for example, RNIS, LocationService, etc.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "serTransportDependencies": { + "description": "Indicates transport and serialization format dependencies of consuming the service. Defaults to REST + JSON if absent. See note.", + "items": { + "$ref": "#/components/schemas/TransportDependency" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "TransportDependency" + }, + "version": { + "description": "The version of the service.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "serName", + "version" + ], + "type": "object", + "x-etsi-notes": "NOTE:\tThis attribute indicates groups of transport bindings that a service-consuming MEC application supports for the consumption of the MEC service defined by this ServiceDependency structure. If at least one of the indicated groups is supported by the service it may be consumed by the application.", + "x-etsi-ref": "6.2.1.17" + }, + "ServiceDescriptor": { + "description": "'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.'", + "type": "object", + "required": [ + "serName", + "version" + ], + "properties": { + "serName": { + "$ref": "#/components/schemas/SerName" + }, + "serCategory": { + "$ref": "#/components/schemas/CategoryRef" + }, + "version": { + "$ref": "#/components/schemas/SerVersion" + }, + "transportsSupported": { + "$ref": "#/components/schemas/TransportsSupported" + } + } + }, + "SerName": { + "description": "The name of the service, for example, RNIS, LocationService, etc.", + "type": "string" + }, + "SerVersion": { + "description": "The version of the service.", + "type": "string" + }, + "TransportsSupported": { + "description": "'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.'", + "type": "object", + "required": [ + "featureName", + "version" + ], + "properties": { + "transport": { + "$ref": "#/components/schemas/TransportDescriptor" + }, + "serializers": { + "$ref": "#/components/schemas/Serializers" + } + } + }, + "Serializers": { + "description": "'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 '", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/SerializerTypes" + } + }, + "SwImageDescriptor": { + "description": "Ref NFV", + "type": "string" + }, + "TerminateAppInstanceOpConfig": { + "description": "NFV", + "type": "string", + "x-etsi-ref": "6.2.2.9" + }, + "TimeStamp": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.2.5.4" + }, + "TrafficFilter": { + "properties": { + "dSCP": { + "description": "Used to match all IPv4 packets that have the same DSCP.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Int" + }, + "dstAddress": { + "description": "A IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "dstPort": { + "description": "A port or a range of ports.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "dstTunnelPort": { + "description": "Used for GTP tunnel based traffic rule.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "protocol": { + "description": "Specify the protocol of the traffic filter.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "qCI": { + "description": "Used to match all packets that have the same QCI.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Int" + }, + "srcAddress": { + "description": "An IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "srcPort": { + "description": "A port or a range of ports.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "srcTunnelAddress": { + "description": "Used for GTP tunnel based traffic rule.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "srcTunnelPort": { + "description": "Used for GTP tunnel based traffic rule.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "tC": { + "description": "Used to match all IPv6 packets that have the same TC.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Int" + }, + "tag": { + "description": "Used for tag based traffic rule.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "tgtTunnelAddress": { + "description": "Used for GTP tunnel based traffic rule.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + } + }, + "type": "object", + "x-etsi-ref": "6.2.1.10" + }, + "TrafficRuleDescriptor": { + "properties": { + "action": { + "$ref": "#/components/schemas/Action" + }, + "dstInterface": { + "type": "array", + "minItems": 0, + "maxItems": 2, + "items": { + "$ref": "#/components/schemas/InterfaceDescriptor" + } + }, + "filterType": { + "$ref": "#/components/schemas/FilterType" + }, + "priority": { + "description": "Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Int" + }, + "trafficFilter": { + "description": "The filter used to identify specific flow/packets that need to be handled by the MEC host.", + "items": { + "$ref": "#/components/schemas/TrafficFilter" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "TrafficFilter" + }, + "trafficRuleId": { + "description": "Identifies the traffic rule.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "trafficRuleId", + "filterType", + "priority", + "trafficFilter", + "action" + ], + "type": "object", + "x-etsi-ref": "6.2.1.9" + }, + "Action": { + "description": "'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.'", + "type": "string", + "enum": [ + "DROP", + "FORWARD_DECAPSULATED", + "FORWARD_AS_IS", + "PASSTHROUGH", + "DUPLICATED_DECAPSULATED", + "DUPLICATE_AS_IS" + ] + }, + "FilterType": { + "description": "Definition of filter type: per FLOW or PACKET", + "type": "string", + "enum": [ + "FLOW", + "PACKET" + ] + }, + "TransportDependency": { + "properties": { + "labels": { + "description": "Set of labels that allow to define groups of transport bindings. The mechanism of the grouping is defined below this table.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "serializers": { + "description": "Information about the serializers in this transport binding, as defined in the SerializerTypes type in ETSI GS MEC 011 [i.4]. Support for at least one of the entries is required in conjunction with the transport.", + "items": { + "$ref": "#/components/schemas/SerializerTypes" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "SerializerTypes" + }, + "transport": { + "$ref": "#/components/schemas/TransportDescriptor" + } + }, + "required": [ + "transport", + "serializers", + "labels" + ], + "type": "object", + "x-etsi-ref": "6.2.1.18" + }, + "TransportDescriptor": { + "properties": { + "protocol": { + "description": "The name of the protocol used. Shall be set to HTTP for a REST API.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "security": { + "$ref": "#/components/schemas/SecurityInfo" + }, + "type": { + "$ref": "#/components/schemas/TransportTypes" + }, + "version": { + "description": "The version of the protocol used.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "type", + "protocol", + "version", + "security" + ], + "type": "object", + "x-etsi-ref": "6.2.1.19" + }, + "TransportTypes": { + "type": "string" + }, + "TunnelInfo": { + "properties": { + "tunnelDstAddress": { + "description": "Destination address of the tunnel.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "tunnelSpecificData": { + "$ref": "#/components/schemas/Not_specified" + }, + "tunnelSrcAddress": { + "description": "Source address of the tunnel.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "tunnelType": { + "$ref": "#/components/schemas/TunnelType" + } + }, + "required": [ + "tunnelType", + "tunnelDstAddress", + "tunnelSrcAddress" + ], + "type": "object", + "x-etsi-ref": "6.2.1.12" + }, + "TunnelType": { + "description": "Type of tunnel.", + "type": "string", + "enum": [ + "GTP-U", + "GRE" + ] + }, + "VirtualComputeDescription": { + "description": "Ref NFV", + "type": "string" + }, + "VirtualNetworkInterfaceRequirements": { + "type": "string" + }, + "VirtualStorageDescriptor": { + "description": "Ref NFV", + "type": "string" + }, + "SecurityInfo": { + "description": "See MEC011" + }, + "CategoryRef": { + "description": "See MEC011" + }, + "URI": { + "type": "string" + }, + "Not_specified": { + "type": "string" + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "206": { + "description": "Partial content" + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "412": { + "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "414": { + "description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "415": { + "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "416": { + "description": "Range Not Satisfiable ." + }, + "422": { + "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "example": { + "application/problem+json": { + "problemDetails": { + "type": "https://meAppServer.example.com/rni/v2/probs/too-many targets", + "title": "Too many targets", + "status": "422", + "detail": "The target area for the request is considered too large", + "instance": "/meAppClient.example.com/77777/msgs/abc" + } + } + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "AppPkgContent.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." + } + } + } +} \ No newline at end of file diff --git a/MEC010-2_AppPkgMgmt.yaml b/MEC010-2_AppPkgMgmt.yaml new file mode 100644 index 0000000000000000000000000000000000000000..353ba455ca45c64536629517f9d1b3fed1e07521 --- /dev/null +++ b/MEC010-2_AppPkgMgmt.yaml @@ -0,0 +1,1759 @@ +info: + title: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management" + version: 2.1.1 + 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 + email: cti_support@etsi.org + url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api +externalDocs: + description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1" + url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf' +servers: + - url: 'https://localhost/app_pkgm/v1' +openapi: 3.0.0 +tags: + - name: app-pkgm + description: App Package management + - name: app-pkgm-notifications + description: App Package management notifications +paths: + /app_packages: + post: + tags: + - 'app-pkgm' + summary: 'Create a resource for on-boarding an application package to a MEO' + description: 'Create a resource for on-boarding an application package to a MEO' + operationId: app_packagesPOST + requestBody: + description: Resource to be created + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAppPkg' + responses: + '201': + description: Successful response for resource creation + content: + application/json: + schema: + type: array + items: + $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' + get: + tags: + - 'app-pkgm' + summary: 'Queries information relating to on-boarded application packages in the MEO' + description: 'queries information relating to on-boarded application packages in the MEO' + operationId: app_packagesGET + parameters: + - in: query + name: filter + schema: + type: string + required: false + description: 'Attribute-based filtering parameters according to ETSI GS MEC 009' + - in: query + name: all_fields + schema: + type: string + required: false + description: 'Include all complex attributes in the response.' + - in: query + name: fields + schema: + type: string + required: false + description: 'Complex attributes of AppPkgInfo to be included into the response' + - in: query + name: exclude_fields + schema: + type: string + required: false + description: 'Complex attributes of AppPkgInfo to be excluded from the response.' + - in: query + name: exclude_default + schema: + type: string + required: false + description: 'Indicates to exclude the following complex attributes of AppPkgInfo from the response.' + responses: + '200': + description: 'Contains a representation of the application package resource' + content: + application/json: + schema: + type: array + items: + $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' + /app_packages/{appPkgId}: + parameters: + - in: path + name: appPkgId + schema: + type: string + required: true + description: 'Identifier of an individual application package resource' + 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 + responses: + '200': + description: 'Contains a representation of the application package resource' + 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' + delete: + tags: + - 'app-pkgm' + summary: 'Deletes an individual application package resources' + description: 'Deletes an individual application package resources' + operationId: app_packageDELETE + responses: + '204': + $ref: '#/components/responses/204' + '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' + 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 + requestBody: + description: Operational state to be set + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgInfoModifications' + responses: + '200': + description: 'Shows that the operation has been completed successfully' + 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' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + /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 + requestBody: + description: The input parameters of subscribe operation to notifications + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgSubscription' + + responses: + '201': + description: Successful response for created subscription + 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' + + get: + tags: + - 'app-pkgm' + summary: 'used to retrieve the information of subscriptions to individual application package resource in MEO' + description: 'used to retrieve the information of subscriptions to individual application package resource in MEO package' + operationId: subscriptionsGET + responses: + '200': + description: List of zero or more subscriptions + 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' + /subscriptions/{subscriptionId}: + parameters: + - in: path + name: subscriptionId + schema: + type: string + description: 'Identifier of an individual subscription to notifications about application package changes' + required: true + 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 + responses: + '200': + description: Representation of the resource. + 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' + delete: + tags: + - 'app-pkgm' + summary: 'Deletes the individual subscription to notifications about application package changes in MEO.' + description: 'Deletes the individual subscription to notifications about application package changes in MEO.' + operationId: individualSubscriptionDELETE + responses: + '204': + $ref: '#/components/responses/204' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' +############################################################################### +# 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 + requestBody: + description: Notification endpoint to be created + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AppPkgNotification' + responses: + '204': + $ref: '#/components/responses/204' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + /app_packages/{appPkgId}/appd: + parameters: + - in: path + name: appPkgId + schema: + type: string + description: 'Identifier of an on-boarded individual application package' + required: true + 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: + - in: query + name: filter + schema: + type: string + required: false + description: 'Attribute-based filtering parameters according to ETSI GS MEC 009' + - in: query + name: all_fields + schema: + type: string + required: false + description: 'Include all complex attributes in the response.' + - in: query + name: fields + schema: + type: string + required: false + description: 'Complex attributes of AppPkgInfo to be included into the response' + - in: query + name: exclude_fields + schema: + type: string + required: false + description: 'Complex attributes of AppPkgInfo to be excluded from the response.' + - in: query + name: exclude_default + schema: + type: string + required: false + description: 'Indicates to exclude the following complex attributes of AppPkgInfo from the response.' + responses: + '200': + description: Content of the AppD is returned. + content: + text/plain: + schema: + $ref: '#/components/schemas/AppD' + application/zip: + schema: + $ref: '#/components/schemas/AppD' + '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' + /onboarded_app_packages/{appDId}/appd: + parameters: + - in: path + name: appDId + schema: + type: string + description: 'Identifier of an application descriptor' + required: true + 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: + - in: query + name: filter + schema: + type: string + required: false + description: 'Attribute-based filtering parameters according to ETSI GS MEC 009' + - in: query + name: all_fields + schema: + type: string + required: false + description: 'Include all complex attributes in the response.' + - in: query + name: fields + schema: + type: string + required: false + description: 'Complex attributes of AppPkgInfo to be included into the response' + - in: query + name: exclude_fields + schema: + type: string + required: false + description: 'Complex attributes of AppPkgInfo to be excluded from the response.' + - in: query + name: exclude_default + schema: + type: string + required: false + description: 'Indicates to exclude the following complex attributes of AppPkgInfo from the response.' + responses: + '200': + description: Content of the AppD is returned. + content: + text/plain: + schema: + $ref: '#/components/schemas/AppD' + application/zip: + schema: + $ref: '#/components/schemas/AppD' + '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' + /app_packages/{appPkgId}/package_content: + parameters: + - in: path + name: appPkgId + schema: + type: string + description: 'Identifier of an on-boarded individual application package' + required: true + 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 + responses: + '200': + $ref: '#/components/responses/AppPkgContent.200' + '206': + $ref: '#/components/responses/206' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '416': + $ref: '#/components/responses/416' + '406': + $ref: '#/components/responses/406' + '429': + $ref: '#/components/responses/429' + put: + tags: + - 'app-pkgm' + summary: 'Uploads the content of application package.' + description: 'Uploads the content of application package.' + operationId: appPkgPUT + requestBody: + content: + application/zip: + schema: + type: string + format: binary + responses: + '202': + description: 'The application package has been accepted for uploading, but the processing has not been completed.' + '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' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + /onboarded_app_packages/{appDId}/package_content: + parameters: + - in: path + name: appDId + description: 'Identifier of an application descriptor' + schema: + type: string + required: true + 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 + responses: + '200': + $ref: '#/components/responses/AppPkgContent.200' + '206': + $ref: '#/components/responses/206' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '416': + $ref: '#/components/responses/416' + '406': + $ref: '#/components/responses/406' + '429': + $ref: '#/components/responses/429' + put: + tags: + - 'app-pkgm' + summary: 'Uploads the content of application package.' + description: 'Uploads the content of application package.' + operationId: appDIdPUT + requestBody: + content: + application/zip: + schema: + type: string + format: binary + responses: + '202': + description: 'The application package has been accepted for uploading, but the processing has not been completed.' + '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' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' +components: + schemas: + Algorithm: + description: " Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512." + type: string + AppD: + properties: + appDId: + description: "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note\_1." + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appDNSRule: + description: Describes DNS rules the MEC application requires. + items: + $ref: '#/components/schemas/DNSRuleDescriptor' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: DNSRuleDescriptor + appDVersion: + description: Identifies the version of the application descriptor. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appDescription: + description: Human readable description of the MEC application. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appExtCpd: + description: Describes external interface(s) exposed by this MEC application. + items: + $ref: '#/components/schemas/AppExternalCpd' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: AppExternalCpd + appFeatureOptional: + description: Describes features a MEC application may use if available. + items: + $ref: '#/components/schemas/FeatureDependency' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: FeatureDependency + appFeatureRequired: + description: Describes features a MEC application requires to run. + items: + $ref: '#/components/schemas/FeatureDependency' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: FeatureDependency + appInfoName: + description: Human readable name for the MEC application. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + appLatency: + # description': Describes the maximum latency tolerated by the MEC application. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': LatencyDescriptor + $ref: '#/components/schemas/LatencyDescriptor' + appName: + description: Name to identify the MEC application. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appProvider: + description: Provider of the application and of the AppD. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appServiceOptional: + description: Describes services a MEC application may use if available. + items: + $ref: '#/components/schemas/ServiceDependency' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: ServiceDependency + appServiceProduced: + description: Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps. + items: + $ref: '#/components/schemas/ServiceDescriptor' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: ServiceDescriptor + appServiceRequired: + description: Describes services a MEC application requires to run. + items: + $ref: '#/components/schemas/ServiceDependency' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: ServiceDependency + appSoftVersion: + description: Identifies the version of software of the MEC application. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appTrafficRule: + description: Describes traffic rules the MEC application requires. + items: + $ref: '#/components/schemas/TrafficRuleDescriptor' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: TrafficRuleDescriptor + changeAppInstanceStateOpConfig: + # description': Configuration parameters for the change application instance state operation. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': ChangeAppInstanceStateOpConfig + $ref: '#/components/schemas/ChangeAppInstanceStateOpConfig' + mecVersion: + description: Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + swImageDescriptor: + # description': Describes the software image which is directly loaded on the virtualisation machine instantiating this Application. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': SwImageDescriptor + $ref: '#/components/schemas/SwImageDescriptor' + terminateAppInstanceOpConfig: + # description': Configuration parameters for the Terminate application instance operation. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TerminateAppInstanceOpConfig + $ref: '#/components/schemas/TerminateAppInstanceOpConfig' + transportDependencies: + 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. + items: + $ref: '#/components/schemas/TransportDependency' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: TransportDependency + virtualComputeDescriptor: + # description': Describes CPU, Memory and acceleration requirements of the virtual machine. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': VirtualComputeDescription + $ref: '#/components/schemas/VirtualComputeDescription' + virtualStorageDescriptor: + description: Defines descriptors of virtual storage resources to be used by the MEC application. + items: + $ref: '#/components/schemas/VirtualStorageDescriptor' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: VirtualStorageDescriptor + required: + - appDId + - appName + - appProvider + - appSoftVersion + - appDVersion + - mecVersion + - appDescription + - virtualComputeDescriptor + - swImageDescriptor + type: object + x-etsi-notes: "NOTE 1:\tThe appDId shall be used as the unique identifier of the application package that contains this AppD.\nNOTE 2:\tThis 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." + x-etsi-ref: 6.2.1.2 + AppExternalCpd: + properties: + inherited_attributes: + description: All attributes inherited from Cpd. + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: inherited_attributes + virtualNetworkInterfaceRequirements: + description: Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD. + items: + $ref: '#/components/schemas/VirtualNetworkInterfaceRequirements' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + #x-etsi-mec-origin-type: VirtualNetworkInterfaceRequirements + required: + - inherited_attributes + type: object + x-etsi-ref: 6.2.1.6 + CallbackUri: + description: >- + The URI of the endpoint for the notification to be sent to. + type: string + format: uri + AppDId: + description: 'Identifier of this MEC application descriptor. This attribute shall be globally unique.' + type: string + AppProvider: + description: 'Provider of the application and of the AppD.' + type: string + AppName: + description: 'Name to identify the MEC application.' + type: string + AppDVersion: + description: 'Identifies the version of the application descriptor.' + type: string + AppPkgId: + description: Identifier of the onboarded application package. + type: string + SubscriptionId: + description: >- + Identifier of the subscription related to this notification. + type: string + AppPkgArtifactInfo: + description: Additional information of application package artifacts that are not application software images. Type is TBD + AppPkgInfo: + description: >- + 'The data type AppPkgInfo represents the parameters for an application package resource' + type: object + required: + - id + - appDId + - appName + - appSoftwareVersion + - appDVersion + - checksum + - softwareImages + - onboardingState + - operationalState + - usageState + - _links + properties: + id: + $ref: '#/components/schemas/AppPkgId' + appDId: + $ref: '#/components/schemas/AppDId' + appProvider: + $ref: '#/components/schemas/AppProvider' + appName: + $ref: '#/components/schemas/AppName' + appSoftwareVersion: + $ref: '#/components/schemas/AppSoftwareVersion' + appDVersion: + $ref: '#/components/schemas/AppDVersion' + checksum: + $ref: '#/components/schemas/Checksum' + softwareImages: + $ref: '#/components/schemas/AppPkgSWImageInfo' + additionalArtifacts: + $ref: '#/components/schemas/AppPkgArtifactInfo' + onboardingState: + $ref: '#/components/schemas/OnboardingState' + operationalState: + $ref: '#/components/schemas/AppPkg.OperationalState' + usageState: + $ref: '#/components/schemas/UsageState' + userDefinedData: + $ref: '#/components/schemas/KeyValuePairs' + _links: + $ref: '#/components/schemas/AppPkgInfo.links' + AppPkgInfoModifications: + description: >- + 'The data type represents the operational state for an application package resource' + type: object + required: + - operationState + properties: + operationState: + type: string + enum: + - DISABLED + - ENABLED + AppSoftwareVersion: + description: >- + Software version of the application. This is updated when there is any change to the software in the onboarded application package. + type: string + AppPkg.OperationalState: + 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. + type: string + enum: + - ENABLED + - DISABLED + OnboardingState: + description: >- + Onboarding state of application package + type: string + format: enum + enum: + - CREATED + - UPLOADING + - PROCESSING + - ONBOARDED + UsageState: + description: >- + Usage state of the onboarded instance of the application package + type: string + format: enum + enum: + - IN_USE + - NOT_IN_USE + 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' + type: object + additionalProperties: true + AppPkgInfo.links: + description: >- + Links to resources related to this resource. + type: object + required: + - self + - appD + - appPkgContent + properties: + self: + $ref: '#/components/schemas/LinkType' + appD: + $ref: '#/components/schemas/LinkType' + appPkgContent: + $ref: '#/components/schemas/LinkType' + AppPkgNotification: + 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' + type: object + required: + - id + - notificationType + - subscriptionId + - timeStamp + - appPkgId + - appDId + - operationalState + - _links + properties: + id: + $ref: '#/components/schemas/AppPkgNotification.Id' + notificationType: + $ref: '#/components/schemas/AppPkg.NotificationType' + subscriptionId: + $ref: '#/components/schemas/SubscriptionId' + timeStamp: + $ref: '#/components/schemas/TimeStamp' + appPkgId: + $ref: '#/components/schemas/AppPkgId' + appDId: + $ref: '#/components/schemas/AppDId' + operationalState: + type: string + enum: + - DISABLED + - ENABLED + _links: + $ref: '#/components/schemas/AppPkgNotification.links' + AppPkgNotification.Id: + description: >- + '' + type: string + AppPkg.NotificationType: + description: >- + Discriminator for the different notification types + type: string + enum: + - AppPackageOnBoarded + - AppPacakgeEnabled + - AppPacakgeDisabled + - AppPackageDeleted + AppPkgNotification.links: + description: >- + Links to resources related to this resource. + type: object + required: + - subscription + properties: + subscription: + $ref: '#/components/schemas/LinkType' + AppPkgSWImageInfo: + description: Information of application software image in application package. Type is TBD + AppPkgSubscriptionInfo: + description: >- + 'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package' + type: object + required: + - id + - subscriptionType + - callbackUri + - _links + properties: + id: + $ref: '#/components/schemas/AppPkgSubscriptionInfo.Id' + subscriptionType: + $ref: '#/components/schemas/AppPkg.SubscriptionType' + callbackUri: + $ref: '#/components/schemas/CallbackUri' + _links: + $ref: '#/components/schemas/AppPkgSubscriptionInfo.links' + AppPkgSubscriptionInfo.Id: + description: >- + '' + type: string + AppPkg.SubscriptionType: + description: >- + Subscribed notification type. + type: string + enum: + - AppPackageOnBoarding + - AppPacakgeOperationChange + - AppPackageDeletion + AppPkgSubscriptionInfo.links: + description: >- + Links to resources related to this resource. + type: object + required: + - self + properties: + self: + $ref: '#/components/schemas/LinkType' + AppPkgSubscriptionLinkList: + description: >- + 'The data type represents a subscription link list of notification on application package management' + type: object + required: + - _links + properties: + _links: + $ref: '#/components/schemas/AppPkgSubscriptionLinkList.links' + AppPkgSubscriptionLinkList.links: + description: >- + Links to resources related to this resource. + type: object + required: + - self + properties: + self: + $ref: '#/components/schemas/LinkType' + subscriptions: + type: array + items: + $ref: '#/components/schemas/Subscriptions.AppPkgSubscription' + Subscriptions.AppPkgSubscription: + 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: object + required: + - href + - subsctiptionType + properties: + href: + $ref: '#/components/schemas/Href' + subsctiptionType: + $ref: '#/components/schemas/SubsctiptionType.AppPkg' + Href: + description: >- + The URI referring to the subscription. + type: string + format: uri + AppPkgSubscription: + 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: object + required: + - callbackUri + - subsctiptionType + properties: + callbackUri: + $ref: '#/components/schemas/CallbackUri' + subsctiptionType: + $ref: '#/components/schemas/SubsctiptionType.AppPkg' + appPkgFilter: + type: array + items: + $ref: '#/components/schemas/AppPkgFilter' + SubsctiptionType.AppPkg: + description: >- + 'Subscribed notification type' + type: string + enum: + - AppPackageOnBoarding + - AppPacakgeOperationChange + - AppPackageDeletion + AppPkgFilter: + type: string + description: >- + The attribute-based filter is to filter application packages on which the query applies. + ChangeAppInstanceStateOpConfig: + description: NFV + type: string + Checksum: + description: '' + properties: + algorithm: + $ref: '#/components/schemas/Algorithm' + hash: + $ref: '#/components/schemas/Hash' + required: + - algorithm + - hash + type: object + CreateAppPkg: + properties: + appPkgName: + description: Name of the application package to be onboarded. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appPkgPath: + # description': Address information of the application package. See note. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': Uri + $ref: '#/components/schemas/URI' + appPkgVersion: + description: 'Version of the application package to be onboarded. + + The appPkgName with appPkgVersion can be used to uniquely identify the application package.' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appProvider: + description: The provider's name of the application package to be onboarded. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + checksum: + # description': Checksum of the onboarded application package. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': Checksum + $ref: '#/components/schemas/Checksum' + userDefinedData: + #description: User defined data for the application package. + #type: object + #x-etsi-mec-cardinality: 0..1 + #x-etsi-mec-origin-type: KeyValuePair + $ref: '#/components/schemas/KeyValuePairs' + required: + - appPkgName + - appPkgVersion + - checksum + - appPkgPath + type: object + x-etsi-notes: "NOTE:\tIt is for further study how to convey appPkgPath, and align with ETSI GS NFV-SOL 005 [i.7]." + x-etsi-ref: 6.2.3.2 + DNSRuleDescriptor: + properties: + dnsRuleId: + description: Identifies the DNS Rule + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + domainName: + description: FQDN of the DNS rule + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + ipAddress: + description: IP address given by the DNS rule + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + ipAddressType: + #description: 'Specifies the IP address type, value: IP_V6, IP_V4' + #type: string + #x-etsi-mec-cardinality: '1' + $ref: '#/components/schemas/IpAddressType' + ttl: + description: Time-to-live value + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Int + required: + - dnsRuleId + - domainName + - ipAddressType + - ipAddress + type: object + x-etsi-ref: 6.2.1.13 + IpAddressType: + description: 'Specifies the IP address type' + type: string + enum: + - IP_V6 + - IP_V4 + FeatureDependency: + properties: + featureName: + description: The name of the feature, for example, UserApps, UEIdentity, etc. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + version: + description: The version of the feature. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - featureName + - version + type: object + x-etsi-ref: 6.2.1.8 + Hash: + description: '''String 1 The hexadecimal value of the checksum''' + type: string + InterfaceDescriptor: + properties: + dstIPAddress: + description: If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + dstMACAddress: + description: If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + interfaceType: + #description: 'Type of interface: TUNNEL, MAC, IP, etc.' + $ref: '#/components/schemas/InterfaceType' + #x-etsi-mec-cardinality: '1' + srcMACAddress: + description: If the interface type is MAC, the source address identifies the MAC address of the interface. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + tunnelInfo: + # description': Included only if the destination address type is tunnel. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TunnelInfo + $ref: '#/components/schemas/TunnelInfo' + required: + - interfaceType + type: object + x-etsi-ref: 6.2.1.11 + InterfaceType: + description: 'Type of interface.' + type: string + enum: + - TUNNEL + - MAC + - IP + LatencyDescriptor: + properties: + maxLatency: + description: The value of the maximum latency in nano seconds tolerated by the MEC application. See note. + format: Uint32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + required: + - maxLatency + type: object + x-etsi-notes: "NOTE:\tThe latency is considered to be the one way end-to-end latency between the client application (e.g. in a device) and the service (i.e. the MEC Application instance)." + x-etsi-ref: 6.2.1.14 + LinkType: + properties: + href: + description: URI referring to a resource + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + required: + - href + type: object + x-etsi-ref: 6.5.2 + ProblemDetails: + properties: + detail: + description: A human-readable explanation specific to this occurrence of the problem + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + instance: + description: A URI reference that identifies the specific occurrence of the problem + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + status: + description: The HTTP status code for this occurrence of the problem + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + title: + description: A short, human-readable summary of the problem type + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: + description: A URI reference according to IETF RFC 3986 that identifies the problem type + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + type: object + SerializerTypes: + type: string + ServiceDependency: + properties: + requestedPermissions: + description: 'Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4]. + + The format of this attribute is left for the data model design stage.' + items: + $ref: '#/components/schemas/Not_specified' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: Not_specified + serCategory: + # description': A Category reference of the service. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': CategoryRef + $ref: '#/components/schemas/CategoryRef' + serName: + description: The name of the service, for example, RNIS, LocationService, etc. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + serTransportDependencies: + description: Indicates transport and serialization format dependencies of consuming the service. Defaults to REST + JSON if absent. See note. + items: + $ref: '#/components/schemas/TransportDependency' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: TransportDependency + version: + description: The version of the service. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - serName + - version + type: object + x-etsi-notes: "NOTE:\tThis attribute indicates groups of transport bindings that a service-consuming MEC application supports for the consumption of the MEC service defined by this ServiceDependency structure. If at least one of the indicated groups is supported by the service it may be consumed by the application." + x-etsi-ref: 6.2.1.17 + ServiceDescriptor: + description: >- + 'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.' + type: object + required: + - serName + - version + properties: + serName: + $ref: '#/components/schemas/SerName' + serCategory: + $ref: '#/components/schemas/CategoryRef' + version: + $ref: '#/components/schemas/SerVersion' + transportsSupported: + $ref: '#/components/schemas/TransportsSupported' + SerName: + description: 'The name of the service, for example, RNIS, LocationService, etc.' + type: string + SerVersion: + description: The version of the service. + type: string + TransportsSupported: + description: >- + 'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.' + type: object + required: + - featureName + - version + properties: + transport: + $ref: '#/components/schemas/TransportDescriptor' + serializers: + $ref: '#/components/schemas/Serializers' + Serializers: + description: >- + 'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 ' + type: array + minItems: 1 + items: + $ref: '#/components/schemas/SerializerTypes' + SwImageDescriptor: + description: Ref NFV + type: string + TerminateAppInstanceOpConfig: + description: NFV + type: string + x-etsi-ref: 6.2.2.9 + TimeStamp: + properties: + nanoSeconds: + description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + format: Uint32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + seconds: + description: "The seconds part of the Time. Time is defined as Unix-time since January\_1, 1970, 00:00:00 UTC." + format: Uint32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + required: + - seconds + - nanoSeconds + type: object + x-etsi-ref: 6.2.5.4 + TrafficFilter: + properties: + dSCP: + description: Used to match all IPv4 packets that have the same DSCP. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Int + dstAddress: + description: 'A IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.' + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + dstPort: + description: A port or a range of ports. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + dstTunnelPort: + description: Used for GTP tunnel based traffic rule. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + protocol: + description: Specify the protocol of the traffic filter. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + qCI: + description: Used to match all packets that have the same QCI. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Int + srcAddress: + description: 'An IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.' + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + srcPort: + description: A port or a range of ports. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + srcTunnelAddress: + description: Used for GTP tunnel based traffic rule. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + srcTunnelPort: + description: Used for GTP tunnel based traffic rule. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + tC: + description: Used to match all IPv6 packets that have the same TC. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Int + tag: + description: Used for tag based traffic rule. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + tgtTunnelAddress: + description: Used for GTP tunnel based traffic rule. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + type: object + x-etsi-ref: 6.2.1.10 + TrafficRuleDescriptor: + properties: + action: + #description: 'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter, the example actions includes: DROP, FORWARD_DECAPSULATED, FORWARD_AS_IS, PASSTHROUGH, DUPLICATED_DECAPSULATED, DUPLICATE_AS_IS.' + # type: string + #x-etsi-mec-cardinality: '1' + $ref: '#/components/schemas/Action' + dstInterface: + # description': Describes the destination interface information, if the action is FORWARD. Some applications (e.g. inline/tap) require two interfaces, where the first is on the UE side and the second is on the EPC side. + # x-etsi-mec-cardinality': 0..2 + # x-etsi-mec-origin-type': InterfaceDescriptor + type: array + minItems: 0 + maxItems: 2 + items: + $ref: '#/components/schemas/InterfaceDescriptor' + filterType: + #description: 'Definition of filter type: per FLOW or PACKET If it is per FLOW, the filter matches UE->EPC packets and the reverse packets are handled by the same context.' + #x-etsi-mec-cardinality: '1' + $ref: '#/components/schemas/FilterType' + priority: + description: Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Int + trafficFilter: + description: The filter used to identify specific flow/packets that need to be handled by the MEC host. + items: + $ref: '#/components/schemas/TrafficFilter' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: TrafficFilter + trafficRuleId: + description: Identifies the traffic rule. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - trafficRuleId + - filterType + - priority + - trafficFilter + - action + type: object + x-etsi-ref: 6.2.1.9 + Action: + description: >- + 'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.' + type: string + enum: + - DROP + - FORWARD_DECAPSULATED + - FORWARD_AS_IS + - PASSTHROUGH + - DUPLICATED_DECAPSULATED + - DUPLICATE_AS_IS + FilterType: + description: 'Definition of filter type: per FLOW or PACKET' + type: string + enum: + - FLOW + - PACKET + TransportDependency: + properties: + labels: + description: Set of labels that allow to define groups of transport bindings. The mechanism of the grouping is defined below this table. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + serializers: + description: Information about the serializers in this transport binding, as defined in the SerializerTypes type in ETSI GS MEC 011 [i.4]. Support for at least one of the entries is required in conjunction with the transport. + items: + $ref: '#/components/schemas/SerializerTypes' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: SerializerTypes + transport: + # description': Information about the transport in this transport binding. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': TransportDescriptor + $ref: '#/components/schemas/TransportDescriptor' + required: + - transport + - serializers + - labels + type: object + x-etsi-ref: 6.2.1.18 + TransportDescriptor: + properties: + protocol: + description: The name of the protocol used. Shall be set to HTTP for a REST API. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + security: + # description': Information about the security used by the transport in ETSI GS MEC 011 [i.4]. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': SecurityInfo + $ref: '#/components/schemas/SecurityInfo' + type: + # description': Type of the transport, as defined in the TransportTypes type in ETSI GS MEC 011 [i.4]. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': TransportTypes + $ref: '#/components/schemas/TransportTypes' + version: + description: The version of the protocol used. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - type + - protocol + - version + - security + type: object + x-etsi-ref: 6.2.1.19 + TransportTypes: + type: string + TunnelInfo: + properties: + tunnelDstAddress: + description: Destination address of the tunnel. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + tunnelSpecificData: + #description: Parameters specific to the tunnel. + #type: object + #x-etsi-mec-cardinality: 0..1 + #x-etsi-mec-origin-type: Not_specified + $ref: '#/components/schemas/Not_specified' + tunnelSrcAddress: + description: Source address of the tunnel. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + tunnelType: + #description: 'Type of tunnel: GTP-U, GRE, etc.' + $ref: '#/components/schemas/TunnelType' + #x-etsi-mec-cardinality: '1' + required: + - tunnelType + - tunnelDstAddress + - tunnelSrcAddress + type: object + x-etsi-ref: 6.2.1.12 + TunnelType: + description: 'Type of tunnel.' + type: string + enum: + - GTP-U + - GRE + VirtualComputeDescription: + description: Ref NFV + type: string + VirtualNetworkInterfaceRequirements: + type: string + VirtualStorageDescriptor: + description: Ref NFV + type: string + SecurityInfo: + description: 'See MEC011' + CategoryRef: + description: 'See MEC011' + URI: + type: string + Not_specified: + type: string + + responses: + 204: + description: No Content + 206: + description: Partial content + 400: + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 401: + description: 'Unauthorized : used when the client did not submit credentials.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 403: + description: 'Forbidden : operation is not allowed given the current status of the resource.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 404: + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 406: + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 409: + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 412: + description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 414: + description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 415: + description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + + 416: + description: 'Range Not Satisfiable .' + 422: + description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + example: + application/problem+json: + problemDetails: + type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets' + title: Too many targets + status: '422' + detail: The target area for the request is considered too large + instance: /meAppClient.example.com/77777/msgs/abc + 429: + description: 'Too Many Requests : used when a rate limiter has triggered.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + AppPkgContent.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. diff --git a/README.md b/README.md index c53d492b7949a8c1365a9ceb5908a57f66f4fa5b..4e3d85ae485028c71fe5601eff346338d4d59325 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,18 @@ This repository contains OpenAPIs descriptions for the interfaces specified in ETSI GS MEC 010-2. +## Online resources + +* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf) +* [Navigate the App Package management API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api/raw/stf593/MEC010-2_AppPkgMgmt.yaml). +* [Navigate the App Lifecycle management API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api/raw/stf593/MEC010-2_AppLcm.yaml). +* [Navigate the App Operation Granting API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api/raw/stf593/MEC010-2_AppGrant.yaml). +* [Edit the App Package management API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api/raw/stf593/MEC010-2_AppPkgMgmt.yaml). +* [Edit the App Lifecycle management API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api/raw/stf593/MEC010-2_AppLcm.yaml). +* [Edit the App Operation Granting API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api/raw/stf593/MEC010-2_AppGrant.yaml). + ## License Unless specified otherwise, the content of this repository and the files contained are released under the BSD-3-Clause license. See the attached LICENSE file or visit https://forge.etsi.org/legal-matters. +