MEC010-2_AppLcm.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"
  },
  "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"
  },
  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
  "tags": [
    {
      "name": "app-lcm",
      "description": "App lifecycle management"
    },
    {
      "name": "app-lcm-notifications",
      "description": "App lifecycle management notifications"
    }
  ],
  "servers": [
    {
      "url": "https://localhost/app_lcm/v1",
      "variables": {}
    }
  ],
  "paths": {
    "/app_instances": {
      "post": {
        "tags": ["app-lcm"],
        "summary": "Create an application instance resource",
        "description": "Create an application instance resource",
        "operationId": "appInstancePOST",
        "parameters": [],
        "requestBody": {
          "description": "The POST method is used to create an application instance resource.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAppInstanceRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "An application instance identifier and the related resource has been created successfully.",
            "headers": {},
            "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"
          }
        },
        "deprecated": false
      },
      "get": {
        "tags": ["app-lcm"],
        "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": [
          {
            "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": "Array the representations of zero or more application instances",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AppInstanceInfo"
                  },
                  "description": ""
                }
              }
            }
          },
          "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_instances/{appInstanceId}": {
      "get": {
        "tags": ["app-lcm"],
        "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",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Identifier of an individual application instance",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a representation of the read resource.",
            "headers": {},
            "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"
          }
        },
        "deprecated": false
      },
      "delete": {
        "tags": ["app-lcm"],
        "summary": "Deletes an  individual application instance resource.",
        "description": "Deletes an  individual application instance resource.",
        "operationId": "appInstanceIdDELETE",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Identifier of an individual application instance",
            "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": []
    },
    "/subscriptions": {
      "post": {
        "tags": ["app-lcm-notifications"],
        "summary": "subscribe to the notification of application instance related change",
        "description": "subscribe to the notification of application instance related change",
        "operationId": "appLcmSubscriptionsPOST",
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/AppInstSubscriptionRequest"
                  },
                  {
                    "$ref": "#/components/schemas/AppLcmOpOccSubscriptionRequest"
                  },
                  {
                    "$ref": "#/components/schemas/AppInstIdCreationSubscriptionRequest"
                  },
                  {
                    "$ref": "#/components/schemas/AppInstIdDeletionSubscriptionRequest"
                  }
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "a representation of the created SubscriptionInfo.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/AppInstSubscriptionInfo"
                    },
                    {
                      "$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo"
                    },
                    {
                      "$ref": "#/components/schemas/AppInstIdCreationSubscriptionInfo"
                    },
                    {
                      "$ref": "#/components/schemas/AppInstIdDeletionSubscriptionInfo"
                    }
                  ]
                }
              }
            }
          },
          "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#/callbackUri}": {
              "post": {
                "summary": "Callback POST used to send a notification",
                "description": "Notification for informing the subscribers about operational state of application instance resources or state changes of an application LCM operation occurrence. It depends on subscription type.",
                "operationId": "notificationPOST",
                "requestBody": {
                  "description": "Subscription notification",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
                        "oneOf": [
                          {
                            "$ref": "#/components/schemas/AppInstNotification"
                          },
                          {
                            "$ref": "#/components/schemas/AppLcmOpOccNotification"
                          }
                        ]
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "description": "No content"
                  },
                  "404": {
                    "description": "Not found"
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "get": {
        "tags": ["app-lcm-notifications"],
        "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": [
          {
            "name": "subscriptionType",
            "in": "query",
            "description": "Query parameter to filter on a specific subscription type.",
            "style": "form",
            "explode": true,
            "schema": {
              "$ref": "#/components/schemas/AppInstanceSubscriptionType"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of all subscriptions is returned.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppInstanceSubscriptionLinkList"
                }
              }
            }
          },
          "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-lcm-notifications"],
        "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": "Represents an individual subscription to notification related to an application instance",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Representation of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/AppInstSubscriptionInfo"
                    },
                    {
                      "$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo"
                    },
                    {
                      "$ref": "#/components/schemas/AppInstIdCreationSubscriptionInfo"
                    },
                    {
                      "$ref": "#/components/schemas/AppInstIdDeletionSubscriptionInfo"
                    }
                  ]
                }
              }
            }
          },
          "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-lcm-notifications"],
        "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",
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Represents an individual subscription to notification related to an application instance",
            "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": []
    },
    "/user_defined_notification": {
      "post": {
        "tags": ["app-lcm-notifications"],
        "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",
        "parameters": [],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/AppInstNotification"
                  },
                  {
                    "$ref": "#/components/schemas/AppLcmOpOccNotification"
                  },
                  {
                    "$ref": "#/components/schemas/AppInstanceIdentifierCreationNotification"
                  },
                  {
                    "$ref": "#/components/schemas/AppInstanceIdentifierDeletionNotification"
                  }
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {},
            "content": {}
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/app_instances/{appInstanceId}/instantiate": {
      "post": {
        "tags": ["app-lcm"],
        "summary": "Deletes the individual subscription to notifications about application package changes in MEO.",
        "description": "task of instantiating an application instance.",
        "operationId": "appLcmInstanciatePOST",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Identifier of an individual application instance",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InstantiateAppRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "accepted for processing, but the processing has not yet been completed.",
            "headers": {},
            "content": {}
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/app_instances/{appInstanceId}/terminate": {
      "post": {
        "tags": ["app-lcm"],
        "summary": "terminate an application instance.",
        "description": "terminate an application instance.",
        "operationId": "appLcmTerminatePOST",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Identifier of an individual application instance",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TerminateAppRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "accepted for processing, but the processing has not yet been completed.",
            "headers": {},
            "content": {}
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/app_instances/{appInstanceId}/operate": {
      "post": {
        "tags": ["app-lcm"],
        "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",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Identifier of an individual application instance",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OperateAppRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "accepted for processing, but the processing has not yet been completed.",
            "headers": {},
            "content": {}
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/app_lcm_op_occs": {
      "get": {
        "tags": ["app-lcm"],
        "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": [
          {
            "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 AppLcmOpOcc to be excluded from the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exclude_fields",
            "in": "query",
            "description": "Complex attributes of AppLcmOpOcc 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 AppLcmOpOcc from the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Status information for zero or more application instance lifecycle management operation occurrences was queried successfully",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AppLcmOpOcc"
                  },
                  "description": ""
                }
              }
            }
          },
          "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_lcm_op_occs/{appLcmOpOccId}": {
      "get": {
        "tags": ["app-lcm"],
        "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",
        "parameters": [
          {
            "name": "appLcmOpOccId",
            "in": "path",
            "description": "Identifies an individual application LCM operation occurrence",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Information about an application LCM operation occurrence was read successfully",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppLcmOpOcc"
                }
              }
            }
          },
          "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_lcm_op_occs/{appLcmOpOccId}/cancel": {
      "post": {
        "tags": ["app-lcm"],
        "summary": "cancel an ongoing application lifecycle operation whose related \"Individual application LCM operation occurrence\" resource is in \"PROCESSING\" state.",
        "description": "cancel an ongoing application lifecycle operation whose related \"Individual application LCM operation occurrence\" resource is in \"PROCESSING\" state.",
        "operationId": "appLcmCancelPOST",
        "parameters": [
          {
            "name": "appLcmOpOccId",
            "in": "path",
            "description": "Identifies an individual application LCM operation occurrence",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CancelMode"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "The request was accepted for processing, but it is possible that the processing is not yet completed.",
            "headers": {},
            "content": {}
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/app_lcm_op_occs/{appLcmOpOccId}/fail": {