MEC010-2_AppPkgMgmt.json

{
  "openapi": "3.1.0",
  "info": {
    "title": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management",
    "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.",
    "license": {
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
    },
    "contact": {
      "name": "ETSI Forge",
      "url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api",
      "email": "cti_support@etsi.org"
    },
    "version": "3.1.1"
  },
  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
  "externalDocs": {
    "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v3.1.1",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/03.01.01_60/gs_MEC01002v030101p.pdf"
  },
  "tags": [
    {
      "name": "app-pkgm",
      "description": "App Package management"
    },
    {
      "name": "app-pkgm-notifications",
      "description": "App Package management notifications"
    }
  ],
  "servers": [
    {
      "url": "https://localhost/app_pkgm/v1",
      "variables": {}
    }
  ],
  "paths": {
    "/app_packages": {
      "post": {
        "tags": ["app-pkgm"],
        "summary": "Create a resource for on-boarding an application package to a MEO/MEAO",
        "description": "Create a resource for on-boarding an application package to a MEO/MEAO",
        "operationId": "app_packagesPOST",
        "parameters": [],
        "requestBody": {
          "description": "Resource to be created",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAppPkg"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Successful response for resource creation",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppPkgInfo",
                  "description": "The response body shall contain a representation of the application package resource"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "get": {
        "tags": ["app-pkgm"],
        "summary": "Queries information relating to on-boarded application packages in the MEO/MEAO'",
        "description": "queries information relating to on-boarded application packages in the MEO/MEAO",
        "operationId": "app_packagesGET",
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "all_fields",
            "in": "query",
            "description": "Include all complex attributes in the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "Complex attributes of AppPkgInfo to be included into the response",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exclude_fields",
            "in": "query",
            "description": "Complex attributes of AppPkgInfo to be excluded from the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exclude_default",
            "in": "query",
            "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a representation of the application package resource",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AppPkgInfo"
                  },
                  "description": "Indicate the success of request. The response  message content shall contain a list of representations of the \"individual application package\" resources that match the attribute filter"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/onboarded_app_packages": {
      "post": {
        "tags": ["app-pkgm"],
        "summary": "Create a resource for on-boarding an application package to a MEO/MEAO",
        "description": "Create a resource for on-boarding an application package to a MEO/MEAO",
        "operationId": "onboarded_app_packagesPOST",
        "parameters": [],
        "requestBody": {
          "description": "Resource to be created",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAppPkg"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Successful response for resource creation",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppPkgInfo",
                  "description": "The response body shall contain a representation of the application package resource"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "get": {
        "tags": ["app-pkgm"],
        "summary": "Queries information relating to on-boarded application packages in the MEO/MEAO'",
        "description": "queries information relating to on-boarded application packages in the MEO/MEAO",
        "operationId": "onboarded_app_packagesGET",
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "all_fields",
            "in": "query",
            "description": "Include all complex attributes in the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "Complex attributes of AppPkgInfo to be included into the response",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exclude_fields",
            "in": "query",
            "description": "Complex attributes of AppPkgInfo to be excluded from the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exclude_default",
            "in": "query",
            "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a representation of the application package resource",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AppPkgInfo"
                  },
                  "description": "Indicate the success of request. The response body message content shall contain a list of representations of the \"individual application package\" resources that match the attribute filter."
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/app_packages/{appPkgId}": {
      "get": {
        "tags": ["app-pkgm"],
        "summary": "Queries the information related to individual application package resources",
        "description": "Queries the information related to individual application package resources",
        "operationId": "app_packageGET",
        "parameters": [
          {
            "name": "appPkgId",
            "in": "path",
            "description": "Identifier of an individual application package resource",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a representation of the application package resource",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/AppPkgInfo"
                  },
                  "description": "Indicates the success of request. The response message content shall contain a representation of the resource"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "delete": {
        "tags": ["app-pkgm"],
        "summary": "Deletes an individual application package resources in MEO/MEAO",
        "description": "Deletes an individual application package resources in MEO/MEAO",
        "operationId": "app_packageDELETE",
        "parameters": [
          {
            "name": "appPkgId",
            "in": "path",
            "description": "Identifier of an individual application package resource",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {},
            "content": {}
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "patch": {
        "tags": ["app-pkgm"],
        "summary": "Updates the operational state of an individual application package resource",
        "description": "Updates the operational state of an individual application package resources",
        "operationId": "app_packagePATCH",
        "parameters": [
          {
            "name": "appPkgId",
            "in": "path",
            "description": "Identifier of an individual application package resource",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Parameters for application package information modification.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppPkgInfoModifications"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Shows that the operation has been completed successfully",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/AppPkgInfoModifications"
                  },
                  "description": "Shall be returned when the operation has been completed successfully."
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/onboarded_app_packages/{appPkgId}": {
      "get": {
        "tags": ["app-pkgm"],
        "summary": "Queries the information related to individual application package resources",
        "description": "Queries the information related to individual application package resources",
        "operationId": "onboarded_app_packageGET",
        "parameters": [
          {
            "name": "appPkgId",
            "in": "path",
            "description": "Identifier of an individual application package resource",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a representation of the application package resource",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/AppPkgInfo"
                  },
                  "description": "Indicates the success of request. The response message content shall contain arepresentation of the resource."
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "delete": {
        "tags": ["app-pkgm"],
        "summary": "Deletes an individual application package resources in MEO/MEAO",
        "description": "Deletes an individual application package resources in MEO/MEAO",
        "operationId": "onboarded_app_packageDELETE",
        "parameters": [
          {
            "name": "appPkgId",
            "in": "path",
            "description": "Identifier of an individual application package resource",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {},
            "content": {}
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "patch": {
        "tags": ["app-pkgm"],
        "summary": "Updates the operational state of an individual application package resource",
        "description": "Updates the operational state of an individual application package resources",
        "operationId": "onboarded_app_packagePATCH",
        "parameters": [
          {
            "name": "appPkgId",
            "in": "path",
            "description": "Identifier of an individual application package resource",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Parameters for application package information modification.",
          "content": {
            "application/json": {
              "schema": {
                "items": {
                  "$ref": "#/components/schemas/AppPkgInfoModifications"
                },
                "description": "Shall be returned when the operation has been completed successfully."
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Shows that the operation has been completed successfully",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppPkgInfoModifications"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/subscriptions": {
      "post": {
        "tags": ["app-pkgm"],
        "summary": "Subscribe to notifications about on-boarding an application package",
        "description": "Subscribe to notifications about on-boarding an application package",
        "operationId": "subscriptionsPOST",
        "parameters": [],
        "requestBody": {
          "description": "The input parameters of subscribe operation to notifications",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppPkgSubscription"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Successful response for created subscription",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppPkgSubscriptionInfo",
                  "descriprion": "Upon success, a response message contentrepresenting the created subscription shall bereturned."
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "callbacks": {
          "notification": {
            "{$request.body#/subscription.href}": {
              "post": {
                "summary": "Callback POST used to send a notification",
                "description": " The notification is triggered when a new application package is onboarded",
                "operationId": "notificationPOST",
                "requestBody": {
                  "description": "Subscription notification",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
                        "$ref": "#/components/schemas/AppPkgNotification"
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "description": "No content"
                  },
                  "404": {
                    "description": "Not found"
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "tags": ["app-pkgm"],
        "summary": "used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO",
        "description": "used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO package",
        "operationId": "subscriptionsGET",
        "parameters": [],
        "responses": {
          "200": {
            "description": "List of zero or more subscriptions",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppPkgSubscriptionLinkList",
                  "description": "Upon success, a response message content containing a list of zero or more subscriptions shallbe returned."
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/subscriptions/{subscriptionId}": {
      "get": {
        "tags": ["app-pkgm"],
        "summary": "Used to represent an individual subscription to notifications about application package changes.",
        "description": "Used to represent an individual subscription to notifications about application package changes.",
        "operationId": "individualSubscriptionGET",
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Identifier of an individual subscription to notifications about application package changes",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "a response body containing a representation of the resource shall be returned.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppPkgSubscriptionInfo",
                  "descriprion": "Upon success, a response message content containing a representation of the resource shall be returned."
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "delete": {
        "tags": ["app-pkgm"],
        "summary": "Deletes the individual subscription to notifications about application package changes in MEO or MEAO.",
        "description": "Deletes the individual subscription to notifications about application package changes in MEO or MEAO.",
        "operationId": "individualSubscriptionDELETE",
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Identifier of an individual subscription to notifications about application package changes",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {},
            "content": {}
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/app_packages/{appPkgId}/appd": {
      "get": {
        "tags": ["app-pkgm"],
        "summary": "Reads the content of the AppD of on-boarded individual application package resources.",
        "description": "Reads the content of the AppD of on-boarded individual application package resources.",
        "operationId": "appPkgIdGET",
        "parameters": [
          {
            "name": "appPkgId",
            "in": "path",
            "description": "Identifier of an on-boarded individual application package",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "filter",
            "in": "query",
            "description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "all_fields",
            "in": "query",
            "description": "Include all complex attributes in the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "Complex attributes of AppPkgInfo to be included into the response",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exclude_fields",
            "in": "query",
            "description": "Complex attributes of AppPkgInfo to be excluded from the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exclude_default",
            "in": "query",
            "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Content of the AppD is returned.",
            "headers": {},
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/AppD",
                  "descriprion": "Indicates the success of request, and the content of the AppD is returned.The response message content shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.The \"Content-Type\" HTTP header shall be set according to the format of the returned file, which is selected according to \"Accept\" HTTP header options passed in the request."
                }
              },
              "application/zip": {}
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/onboarded_app_packages/{appDId}/appd": {
      "get": {
        "tags": ["app-pkgm"],
        "summary": "Reads the content of the AppD of on-boarded individual application package resources.",
        "description": "Reads the content of the AppD of on-boarded individual application package resources.",
        "operationId": "appDGET",
        "parameters": [
          {
            "name": "appDId",
            "in": "path",
            "description": "Identifier of an application descriptor",
            "required": true,