UEAppInterfaceApi.json

{
  "openapi": "3.0.0",
  "info": {
    "contact": {
      "url": "https://forge.etsi.org/rep/mec/gs016-dev-app-api"
    },
    "title": "ETSI GS MEC 016 Device application interface",
    "version": "2.2.1",
    "description": "The ETSI MEC ISG Device application interface API described using OpenAPI.",
    "license": {
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
    }
  },
  "externalDocs": {
    "description": "ETSI GS MEC016 V2.2.1 Device application interface",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/02.02.01_60/gs_MEC016v020201p.pdf"
  },
  "servers": [
    {
      "url": "https://localhost/dev_app/v1"
    }
  ],
  "tags": [
    {
      "name": "dev_app"
    }
  ],
  "paths": {
    "/app_list": {
      "get": {
        "tags": [
          "dev_app"
        ],
        "summary": "Get available application information.",
        "description": "Used to query information about the available MEC applications.",
        "operationId": "meAppListGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.appName"
          },
          {
            "$ref": "#/components/parameters/Query.appProvider"
          },
          {
            "$ref": "#/components/parameters/Query.appSoftVersion"
          },
          {
            "$ref": "#/components/parameters/Query.vendorId"
          },
          {
            "$ref": "#/components/parameters/Query.serviceCont"
          }
        ],
        "responses": {
          "200": {
            "description": "The response body contains an array of the user applications available to the querying device application.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "applicationList": {
                      "$ref": "#/components/schemas/ApplicationList"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          }
        }
      }
    },
    "/app_contexts": {
      "post": {
        "tags": [
          "dev_app"
        ],
        "summary": "Creation of a new application context.",
        "description": "Used to create a new application context. Upon success, the response contains entity body describing the created application context.",
        "operationId": "devAppContextsGET",
        "requestBody": {
          "description": "Entity body in the request contains the Application Context as requested by the device application.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "appContext": {
                    "$ref": "#/components/schemas/AppContext"
                  }
                }
              }
            }
          }
        },
        "parameters": [],
        "responses": {
          "201": {
            "description": "The response body contains the Application Context as it was created by the MEC system, which includes the reference URI(s) of the associated user application instance(s). The URI of the resource created within the MEC system associated with the request, with its specific application context ID, shall be included in the 'Location' HTTP header of the response.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "appContext": {
                      "$ref": "#/components/schemas/AppContext"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          }
        },
        "callbacks": {
          "notification": {
            "{$request.body#/appContext.callbackReference}": {
              "post": {
                "summary": "Callback POST used to send a notification",
                "description": "Notification with content based on subscription type",
                "operationId": "notificationPOST",
                "requestBody": {
                  "description": "Subscription notification",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
                        "type": "object",
                        "properties": {
                          "notification": {
                            "oneOf": [
                              {
                                "$ref": "#/components/schemas/AddressChangeNotification"
                              },
                              {
                                "$ref": "#/components/schemas/ApplicationContextDeleteNotification"
                              },
                              {
                                "$ref": "#/components/schemas/ApplicationContextUpdateNotification"
                              },
                              {
                                "$ref": "#/components/schemas/ApplicationLocationAvailabilityNotification"
                              }
                            ],
                            "discriminator": {
                              "propertyName": "notificationType"
                            }
                          }
                        },
                        "example": {
                          "notification": {
                            "notificationType": "ApplicationContextDeleteNotification",
                            "contextId": "contextId123"
                          }
                        }
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/app_contexts/{contextId}": {
      "put": {
        "tags": [
          "dev_app"
        ],