MEC010-2_AppPkgMgmt.json 74.8 KB
Newer Older
  "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"
Elian Kraja's avatar
Elian Kraja committed
    },
    {
      "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"
Elian Kraja's avatar
Elian Kraja committed
        },
        "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",
Elian Kraja's avatar
Elian Kraja committed
        "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"
Elian Kraja's avatar
Elian Kraja committed
            },
            "required": false,
            "description": "Include all complex attributes in the response."
          },
          {
            "in": "query",
            "name": "fields",
            "schema": {
              "type": "string"
Elian Kraja's avatar
Elian Kraja committed
            },
            "required": false,
            "description": "Complex attributes of AppPkgInfo to be included into the response"
          },
          {
            "in": "query",
            "name": "exclude_fields",
            "schema": {
              "type": "string"
Elian Kraja's avatar
Elian Kraja committed
            },
            "required": false,
            "description": "Complex attributes of AppPkgInfo to be excluded from the response."
          },
          {
            "in": "query",
            "name": "exclude_default",
            "schema": {
              "type": "string"
Elian Kraja's avatar
Elian Kraja committed
            },
            "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"
        "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"
Elian Kraja's avatar
Elian Kraja committed
      },
      "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"
Elian Kraja's avatar
Elian Kraja committed
            },
            "required": false,
            "description": "Complex attributes of AppPkgInfo to be included into the response"
          },
          {
            "in": "query",
            "name": "exclude_fields",
            "schema": {
              "type": "string"
Elian Kraja's avatar
Elian Kraja committed
            },
            "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",
Elian Kraja's avatar
Elian Kraja committed
        "parameters": [
          {
            "in": "query",
            "name": "filter",
Elian Kraja's avatar
Elian Kraja committed
            "schema": {
              "type": "string"
            },
            "required": false,
            "description": "Attribute-based filtering parameters according to ETSI GS MEC 009"
          },
          {
            "in": "query",
            "name": "all_fields",
            "schema": {
              "type": "string"
Elian Kraja's avatar
Elian Kraja committed
            },
            "required": false,
            "description": "Include all complex attributes in the response."
          },
          {
            "in": "query",
            "name": "fields",
            "schema": {
              "type": "string"
Elian Kraja's avatar
Elian Kraja committed
            },
            "required": false,
            "description": "Complex attributes of AppPkgInfo to be included into the response"
          },
          {
            "in": "query",
            "name": "exclude_fields",
            "schema": {
              "type": "string"
Elian Kraja's avatar
Elian Kraja committed
            },
            "required": false,
            "description": "Complex attributes of AppPkgInfo to be excluded from the response."
          },
          {
            "in": "query",
            "name": "exclude_default",
            "schema": {
              "type": "string"
Elian Kraja's avatar
Elian Kraja committed
            },
            "required": false,
            "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response."
        ],
        "responses": {
          "200": {
            "description": "Content of the AppD is returned.",
Elian Kraja's avatar
Elian Kraja committed
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/AppD"
                }
              },
Elian Kraja's avatar
Elian Kraja committed
              "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"
Elian Kraja's avatar
Elian Kraja committed
    },
    "/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": {