MEC010-2_AppPkgMgmt.json

              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    },
    "/app_packages/{appPkgId}/package_content": {
      "get": {
        "tags": [
          "app-pkgm"
        ],
        "summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
        "description": "Fetch the onboarded application package content identified by appPkgId or appDId.",
        "operationId": "appPkgGET",
        "parameters": [
          {
            "name": "appPkgId",
            "in": "path",
            "description": "Identifier of an on-boarded individual application package",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.",
            "headers": {
            },
            "content": {
              "application/zip": {
              }
            }
          },
          "206": {
            "description": "On success, if the MEO or MEAO supports range requests, a single consecutive byte range from the content of the application package file shall be returned.",
            "headers": {
            },
            "content": {
              "application/zip": {
              }
            }
          },
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "416": {
            "description": "Range Not Satisfiable .",
            "headers": {
            },
            "content": {
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "put": {
        "tags": [
          "app-pkgm"
        ],
        "summary": "Uploads the content of application package.",
        "description": "Uploads the content of application package.",
        "operationId": "appPkgPUT",
        "parameters": [
          {
            "name": "appPkgId",
            "in": "path",
            "description": "Identifier of an on-boarded individual application package",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/zip": {
            }
          },
          "required": false
        },
        "responses": {
          "202": {
            "description": "The application package has been accepted for uploading, but the processing has not been completed.",
            "headers": {
            },
            "content": {
            }
          },
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "409": {
            "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    },
    "/onboarded_app_packages/{appDId}/package_content": {
      "get": {
        "tags": [
          "app-pkgm"
        ],
        "summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
        "description": "Fetch the onboarded application package content identified by appPkgId or appDId.",
        "operationId": "appDIdGET",
        "parameters": [
          {
            "name": "appDId",
            "in": "path",
            "description": "Identifier of an application descriptor",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.",
            "headers": {
            },
            "content": {
            }
          },
          "206": {
            "description": "On success, if the MEO or MEAO supports range requests, a single consecutive byte range from the content of the application package file shall be returned.",
            "headers": {
            },
            "content": {
            }
          },
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "416": {
            "description": "Range Not Satisfiable .",
            "headers": {
            },
            "content": {
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "put": {
        "tags": [
          "app-pkgm"
        ],
        "summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
        "description": "Uploads the content of application package.",
        "operationId": "appDIdPUT",
        "parameters": [
          {
            "name": "appDId",
            "in": "path",
            "description": "Identifier of an application descriptor",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/zip": {
            }
          },
          "required": false
        },
        "responses": {
          "202": {
            "description": "The application package has been accepted for uploading, but the processing has not been completed.",
            "headers": {
            },
            "content": {
            }
          },
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "409": {
            "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    },
    "/user_defined_notification": {
      "post": {
        "tags": [
          "app-pkgm-notifications"
        ],
        "summary": "Registers a notification endpoint to notify application package operations",
        "description": "Registers a notification endpoint to notify application package operations",
        "operationId": "app_pkg_notificationPOST",
        "parameters": [

        ],
        "requestBody": {
          "description": "Notification endpoint to be created",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppPkgNotification"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {
            },
            "content": {
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    }
  },
  "components": {
    "schemas": {
      "AppD": {
        "title": "AppD",
        "required": [
          "appDId",
          "appDVersion",
          "appDescription",
          "appName",
          "appProvider",
          "appSoftVersion",
          "mecVersion",
          "swImageDescriptor",
          "virtualComputeDescriptor"
        ],
        "type": "object",
        "properties": {
          "appDId": {
            "type": "string",
            "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1."
          },
          "appDNSRule": {
            "type": "array",
            "items": {
              "$ref": "./MEC010p2_v221_definitions.yaml#/definitions/DNSRuleDescriptor"
            },
            "description": "Describes DNS rules the MEC application requires."
          },
          "appDVersion": {
            "type": "string",
            "description": "Identifies the version of the application descriptor."
          },
          "appDescription": {
            "type": "string",
            "description": "Human readable description of the MEC application."
          },
          "appExtCpd": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppExternalCpd"
            },
            "description": "Describes external interface(s) exposed by this MEC application."
          },
          "appFeatureOptional": {
            "type": "array",
            "items": {
              "$ref": "./MEC010p2_v221_definitions.yaml#/definitions/FeatureDependency"
            },
            "description": "Describes features a MEC application may use if available."
          },
          "appFeatureRequired": {
            "type": "array",
            "items": {
              "$ref": "./MEC010p2_v221_definitions.yaml#/definitions/FeatureDependency"
            },
            "description": "Describes features a MEC application requires to run."
          },
          "appInfoName": {
            "type": "string",
            "description": "Human readable name for the MEC application."
          },
          "appLatency": {
            "$ref": "./MEC010p2_v221_definitions.yaml#/definitions/LatencyDescriptor"
          },
          "appName": {
            "type": "string",
            "description": "Name to identify the MEC application."
          },
          "appProvider": {
            "type": "string",
            "description": "Provider of the application and of the AppD."
          },
          "appServiceOptional": {
            "type": "array",
            "items": {
              "$ref": "./MEC010p2_v221_definitions.yaml#/definitions/ServiceDependency"
            },
            "description": "Describes services a MEC application may use if available."
          },
          "appServiceProduced": {
            "type": "array",
            "items": {
              "$ref": "./MEC010p2_v221_definitions.yaml#/definitions/ServiceDescriptor"
            },
            "description": "Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps."
          },
          "appServiceRequired": {
            "type": "array",
            "items": {
              "$ref": "./MEC010p2_v221_definitions.yaml#/definitions/ServiceDependency"
            },
            "description": "Describes services a MEC application requires to run."
          },
          "appSoftVersion": {
            "type": "string",
            "description": "Identifies the version of software of the MEC application."
          },
          "appTrafficRule": {
            "type": "array",
            "items": {
              "$ref": "./MEC010p2_v221_definitions.yaml#/definitions/TrafficRuleDescriptor"
            },
            "description": "Describes traffic rules the MEC application requires."
          },
          "changeAppInstanceStateOpConfig": {
            "type": "string",
            "description": "NFV"
          },
          "mecVersion": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD. The value shall be formatted as comma-separated list of strings. Each entry shall have the format <x>.<y>.<z> where <x>, <y> and <z> are decimal numbers representing the version of the present document. Whitespace between list entries shall be trimmed before validation."
          },
          "swImageDescriptor": {
            "type": "string",
            "description": "Describes the descriptors of the software image to be used by the virtualisation container used to realize this MEC application."
          },
          "terminateAppInstanceOpConfig": {
            "type": "string",
            "description": "NFV"
          },
          "transportDependencies": {
            "type": "array",
            "items": {
              "$ref": "./MEC010p2_v221_definitions.yaml#/definitions/TransportDependency"
            },
            "description": "Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. See note 2."
          },
          "virtualComputeDescriptor": {
            "description": "Describes CPU and memory requirements, as well as optional additional requirements, such as disk and acceleration related capabilities, of the virtualisation container used to realize this MEC application.",
            "type": "object"
          },
          "virtualStorageDescriptor": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Defines descriptors of virtual storage resources to be used by the MEC application."
          },
          "userContextTransferCapability": {
            "$ref": "./MEC010p2_v221_definitions.yaml#/definitions/UserContextTransferCapability"
          },
          "appNetworkPolicy": {
            "$ref": "./MEC010p2_v221_definitions.yaml#/definitions/AppNetworkPolicy"
          }
        }
      },
      "AppExternalCpd": {
        "title": "AppExternalCpd",
        "required": [
          "inherited_attributes"
        ],
        "type": "object",
        "properties": {
          "inherited_attributes": {
            "type": "object",
            "description": "All attributes inherited from Cpd."
          },
          "virtualNetworkInterfaceRequirements": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD."
          }
        }
      },
      "AppPkgInfo": {
        "title": "AppPkgInfo",
        "required": [
          "id",
          "appDId",
          "appName",
          "appSoftwareVersion",
          "appDVersion",
          "checksum",
          "softwareImages",
          "onboardingState",
          "operationalState",
          "usageState",
          "mecInfo",
          "_links"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Identifier of the onboarded application package."
          },
          "appDId": {
            "type": "string",
            "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique."
          },
          "appProvider": {
            "type": "string",
            "description": "Provider of the application and of the AppD."
          },
          "appName": {
            "type": "string",
            "description": "Name to identify the MEC application."
          },
          "appSoftwareVersion": {
            "type": "string",
            "description": "Software version of the application. This is updated when there is any change to the software in the onboarded application package."
          },
          "appDVersion": {
            "type": "string",
            "description": "Identifies the version of the application descriptor."
          },
          "checksum": {
            "$ref": "#/components/schemas/Checksum"
          },
          "signingCertificate": {
            "type": "string",
            "description": "The singleton signing certificate if it is included as a file in the AppD archive."
          },
          "softwareImages": {
            "type": "object",
            "description": "Information of application software image in application package. Type is TBD"
          },
          "additionalArtifacts": {
            "type": "object",
            "description": "Additional information of application package artifacts that are not application software images. Type is TBD"
          },
          "onboardingState": {
            "$ref": "#/components/schemas/OnboardingState"
          },
          "operationalState": {
            "$ref": "#/components/schemas/AppPkg.OperationalState"
          },
          "usageState": {
            "$ref": "#/components/schemas/UsageState"
          },
          "mecInfo": {
            "type": "array",
            "description": "The MEC version that compatible with this application. This information is copied from the AppD.",
            "items": {
              "type": "string"
            }
          },
          "onBoardingFailureDetails": {
            "description": "Failure details of current onboarding procedure",
            "$ref": "#/components/schemas/ProblemDetails"
          },
          "userDefinedData": {
            "$ref": "#/components/schemas/KeyValuePairs",
            "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
          },
          "_links": {
            "$ref": "#/components/schemas/AppPkgInfo.links"
          }
        },
        "description": "'The data type AppPkgInfo represents the parameters for an application package resource'"
      },
      "AppPkgInfoModifications": {
        "title": "AppPkgInfoModifications",
        "required": [
          "operationState"
        ],
        "type": "object",
        "properties": {
          "operationState": {
            "$ref": "#/components/schemas/OperationState"
          }
        },
        "description": "'The data type represents the operational state for an application package resource'"
      },
      "AppPkg.OperationalState": {
        "title": "AppPkg.OperationalState",
        "enum": [
          "ENABLED",
          "DISABLED"
        ],
        "type": "string",
        "description": "Operational state of the onboarded application package: •ENABLED: the application package can be used for instantiation of new application instances. •DISABLED: the application package cannot be used for further application instantiation requests.",
        "examples": [
          "ENABLED"
        ]
      },
      "OnboardingState": {
        "title": "OnboardingState",
        "enum": [
          "CREATED",
          "UPLOADING",
          "PROCESSING",
          "ONBOARDED"
        ],
        "type": "string",
        "description": "Onboarding state of application package",
        "examples": [
          "CREATED"
        ]
      },
      "UsageState": {
        "title": "UsageState",
        "enum": [
          "IN_USE",
          "NOT_IN_USE"
        ],
        "type": "string",
        "description": "Usage state of the onboarded instance of the application package",
        "examples": [
          "IN_USE"
        ]
      },
      "AppPkgInfo.links": {
        "title": "AppPkgInfo.links",
        "required": [
          "self",
          "appD",
          "appPkgContent"
        ],
        "type": "object",
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          },
          "appD": {
            "$ref": "#/components/schemas/LinkType"
          },
          "appPkgContent": {
            "$ref": "#/components/schemas/LinkType"
          },
          "vnfPkgInfo": {
            "$ref": "#/components/schemas/LinkType"
          }
        },
        "description": "Links to resources related to this resource."
      },
      "AppPkgNotification": {
        "title": "AppPkgNotification",
        "required": [
          "id",
          "notificationType",
          "subscriptionId",
          "timeStamp",
          "appPkgId",
          "appDId",
          "operationalState",
          "_links"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "''"
          },
          "notificationType": {
            "$ref": "#/components/schemas/AppPkg.NotificationType"
          },
          "subscriptionId": {
            "type": "string",
            "description": "Identifier of the subscription related to this notification."
          },
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "appPkgId": {
            "type": "string",
            "description": "Identifier of the onboarded application package."
          },
          "appDId": {
            "type": "string",
            "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique."
          },
          "operationalState": {
            "$ref": "#/components/schemas/OperationalState"
          },
          "_links": {
            "$ref": "#/components/schemas/AppPkgNotification.links"
          }
        },
        "description": "'This data type represents an application package management notification for informing the subscribers about onboarding application package resources. The notification is triggered when a new application package is onboarded'"
      },
      "AppPkg.NotificationType": {
        "title": "AppPkg.NotificationType",
        "enum": [
          "AppPackageOnBoarded",
          "AppPacakgeEnabled",
          "AppPacakgeDisabled",
          "AppPackageDeleted"
        ],
        "type": "string",
        "description": "Discriminator for the different notification types",
        "examples": [
          "AppPackageOnBoarded"
        ]
      },
      "AppPkgNotification.links": {
        "title": "AppPkgNotification.links",
        "required": [
          "subscription"
        ],
        "type": "object",
        "properties": {
          "subscription": {
            "$ref": "#/components/schemas/LinkType"
          }
        },
        "description": "Links to resources related to this resource."