MecAppSupportApi.json

                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false,
        "callbacks": {
          "AppTerminationNotification": {
            "{$request.body#/callbackUri}": {
              "post": {
                "description": "Represents the information that the MEP notifies the subscribed application instance about the corresponding application instance termination/stop'",
                "operationId": "AppTerminationNotification_POST",
                "tags": [
                  "callbacks"
                ],
                "requestBody": {
                  "$ref": "#/components/requestBodies/AppTerminationNotification"
                },
                "responses": {
                  "200": {
                    "description": "Expected responses from callback consumer, if it accepts the callback"
                  }
                }
              }
            }
          }
        }
      },
      "parameters": []
    },
    "/applications/{appInstanceId}/subscriptions/{subscriptionId}": {
      "get": {
        "tags": [
          "appSubscriptions"
        ],
        "description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.",
        "operationId": "ApplicationsSubscription_GET",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Represents a subscription to the notifications from the MEC platform.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing the requested subscription is returned.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppTerminationNotificationSubscription"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "delete": {
        "tags": [
          "appSubscriptions"
        ],
        "description": "This method deletes a mecAppSuptApiSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
        "operationId": "ApplicationsSubscription_DELETE",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Represents a subscription to the notifications from the MEC platform.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {},
            "content": {}
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/applications/{appInstanceId}/confirm_termination": {
      "post": {
        "tags": [
          "appConfirmTermination"
        ],
        "description": "This method is used to confirm the application level termination  of an application instance.",
        "operationId": "ApplicationsConfirmTermination_POST",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppTerminationConfirmation"
              }
            }
          },
          "required": false
        },
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {},
            "content": {}
          },
          "401": {
            "description": "Unauthorized. It is used when the client did not submit the appropriate credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "409": {
            "description": "Conflict. The operation cannot be executed currently, due to a conflict with  the state of the resource. Typically, this is because the application  instance resource is in NOT_INSTANTIATED state.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests. It is used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/applications/{appInstanceId}/confirm_ready": {
      "post": {
        "tags": [
          "appConfirmReady"
        ],
        "description": "This method may be used by the MEC application instance to notify the MEC platform that it is up and running. ",
        "operationId": "ApplicationsConfirmReady_POST",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppReadyConfirmation"
              }
            }
          },
          "required": false
        },
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {},
            "content": {}
          },
          "401": {
            "description": "Unauthorized. It is used when the client did not submit the appropriate credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "409": {
            "description": "Conflict. The operation cannot be executed currently, due to a conflict with  the state of the resource. Typically, this is because the application  instance resource is in NOT_INSTANTIATED state.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests. It is used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/timing/timing_caps": {
      "get": {
        "tags": [
          "timing"
        ],
        "description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
        "operationId": "TimingCaps_GET",
        "parameters": [],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimingCaps"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/timing/current_time": {
      "get": {
        "tags": [
          "timing"
        ],
        "description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
        "operationId": "TimingCurrentTime_GET",
        "parameters": [],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurrentTime"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": []
    }
  },
  "components": {
    "schemas": {
      "AppReadyConfirmation": {
        "title": "AppReadyConfirmation",
        "required": [
          "indication"
        ],
        "type": "object",
        "properties": {
          "indication": {
            "const": "READY",
            "type": "string",
            "description": "Indication about the MEC application instance.",
            "examples": [
              "READY"
            ]
          }
        },
        "description": "This type represents the information that the MEC application instance indicates to the MEC platform that it is up and running."
      },
      "AppTerminationConfirmation": {
        "title": "AppTerminationConfirmation",
        "required": [
          "operationAction"
        ],
        "type": "object",
        "properties": {
          "operationAction": {
            "$ref": "#/components/schemas/OperationActionType"
          }
        },
        "description": "This type represents the information that the MEC application instance provides to the MEC platform when informing it that the application has completed its application level related terminate/stop actions, e.g. retention of application state in the case of stop."
      },
      "AppTerminationNotification.Links": {
        "title": "AppTerminationNotification.Links",
        "required": [
          "subscription"
        ],
        "type": "object",
        "properties": {
          "subscription": {
            "$ref": "#/components/schemas/LinkType"
          },
          "confirmTermination": {
            "$ref": "#/components/schemas/LinkType.ConfirmTermination"
          }
        },
        "description": "Object containing hyperlinks related to the resource."
      },
      "AppTerminationNotification": {
        "title": "AppTerminationNotification",
        "required": [
          "notificationType",
          "operationAction",
          "maxGracefulTimeout",
          "_links"
        ],
        "type": "object",
        "properties": {
          "notificationType": {
            "type": "string",
            "description": "Shall be set to AppTerminationNotification.",
            "examples": [
              "AppTerminationNotification"
            ]
          },
          "operationAction": {
            "$ref": "#/components/schemas/OperationActionType"
          },
          "maxGracefulTimeout": {
            "type": "integer",
            "description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
            "contentEncoding": "int32",
            "examples": [
              10
            ]
          },
          "_links": {
            "$ref": "#/components/schemas/AppTerminationNotification.Links"
          }
        },
        "description": "This type represents the information that the MEC platform notifies the subscribed application instance about  the corresponding application instance termination/stop."
      },
      "AppTerminationNotificationSubscription": {
        "title": "AppTerminationNotificationSubscription",
        "required": [
          "subscriptionType",
          "callbackReference",
          "_links",
          "appInstanceId"
        ],
        "type": "object",
        "properties": {
          "subscriptionType": {
            "type": "string",
            "description": "Shall be set to AppTerminationNotificationSubscription.",
            "examples": [
              "AppTerminationNotificationSubscription"
            ]
          },
          "callbackReference": {
            "type": "string",
            "description": "URI selected by the MEC application instance to receive notifications on the subscribed MEC application instance management information. This shall be included in both the request and the response."
          },
          "_links": {
            "$ref": "#/components/schemas/Self"
          },
          "appInstanceId": {
            "type": "string",
            "description": "It is used as the filtering criterion for the subscribed events.",
            "examples": [
              "ID1"
            ]
          }
        },
        "description": "This type represents the information that the MEC platform notifies the subscribed application instance about  the corresponding application instance termination/stop."
      },
      "CurrentTime": {
        "title": "CurrentTime",
        "required": [
          "seconds",
          "nanoSeconds",
          "timeSourceStatus"
        ],
        "type": "object",
        "properties": {
          "seconds": {
            "type": "integer",
            "description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
            "contentEncoding": "int32",
            "examples": [
              1577836800
            ]
          },
          "nanoSeconds": {
            "type": "integer",
            "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
            "contentEncoding": "int32",
            "examples": [
              0
            ]
          },
          "timeSourceStatus": {
            "$ref": "#/components/schemas/TimeSourceStatus"
          }
        },
        "description": "This type represents the information provided by the MEC platform in response to the Get Platform Time Request message."
      },
      "DestinationInterface.InterfaceType": {
        "title": "DestinationInterface.InterfaceType",
        "enum": [
          "TUNNEL",
          "MAC",
          "IP"
        ],
        "type": "string",
        "description": "Type of the interface",
        "examples": [
          "TUNNEL"
        ]
      },
      "DestinationInterface": {
        "title": "DestinationInterface",
        "required": [
          "interfaceType"
        ],
        "type": "object",
        "properties": {
          "interfaceType": {
            "$ref": "#/components/schemas/DestinationInterface.InterfaceType"
          },
          "tunnelInfo": {
            "$ref": "#/components/schemas/TunnelInfo"
          },
          "srcMacAddress": {
            "type": "string",
            "description": "Source address identifies the MAC address of the interface",
            "examples": [
              "02-00-00-00-00-00"
            ]
          },
          "dstMacAddress": {
            "type": "string",
            "description": "Source address identifies the MAC address of the interface",
            "examples": [
              "02-00-00-00-00-00"
            ]
          },
          "dstIpAddress": {
            "type": "string",
            "description": "IP address of the remote destination",
            "examples": [
              "192.0.2.0"
            ]
          }
        },
        "description": "This type represents the destination interface. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. If the action is DROP, no value shall be provided."
      },
      "DnsRule.IpAddressType": {
        "title": "DnsRule.IpAddressType",
        "enum": [
          "IP_V6",
          "IP_V4"
        ],
        "type": "string",
        "description": "IP address type",
        "examples": [
          "IP_V6"
        ]
      },
      "DnsRule.State": {
        "title": "DnsRule.State",
        "enum": [
          "ACTIVE",
          "INACTIVE"
        ],
        "type": "string",
        "description": "DNS rule state. This attribute may be updated using HTTP PUT method",
        "examples": [
          "ACTIVE"
        ]
      },
      "DnsRule": {
        "title": "DnsRule",
        "required": [
          "dnsRuleId",
          "domainName",
          "ipAddressType",
          "ipAddress",
          "state"
        ],
        "type": "object",
        "properties": {
          "dnsRuleId": {
            "type": "string",
            "description": "Identifies the DNS Rule",
            "examples": [
              "dnsRule1"
            ]
          },
          "domainName": {
            "type": "string",
            "description": "FQDN resolved by the DNS rule",
            "examples": [
              "www.example.com"
            ]
          },
          "ipAddressType": {
            "$ref": "#/components/schemas/DnsRule.IpAddressType"
          },
          "ipAddress": {
            "type": "string",
            "description": "IP address associated with the FQDN resolved by the DNS rule",
            "examples": [
              "192.0.2.0"
            ]
          },
          "ttl": {
            "type": "integer",
            "description": "Time to live value",
            "contentEncoding": "int32"
          },
          "state": {
            "$ref": "#/components/schemas/DnsRule.State"
          }
        },
        "description": "This type represents the general information of a DNS rule."
      },
      "LinkType": {
        "title": "LinkType",
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "URI referring to a resource",
            "examples": [
              "/mecAppSuptApi/example"
            ]
          }
        },
        "description": "This type represents a type of link and may be referenced from data structures"
      },
      "LinkType.ConfirmTermination": {
        "title": "LinkType.ConfirmTermination",
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "URI referring to a resource",
            "examples": [
              "/mecAppSuptApi/example"
            ]
          }
        },
        "description": "Link to the task resource where to confirm termination in case the  application is ready to be terminated before expiry of the timeout."
      },
      "MecAppSuptApiSubscriptionLinkList.Links": {
        "title": "MecAppSuptApiSubscriptionLinkList.Links",
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          },
          "subscriptions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Subscription"
            },
            "description": "The MEC application instance's subscriptions"
          }
        },
        "description": "Self-referring URI."
      },
      "MecAppSuptApiSubscriptionLinkList.Subscription": {
        "title": "MecAppSuptApiSubscriptionLinkList.Subscription",
        "required": [
          "href",
          "rel"
        ],
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "URI referring to a resource",
            "examples": [
              "/mecAppSuptApi/example"
            ]
          },
          "rel": {
            "type": "string",
            "description": "The values shall be set to AppTerminationNotificationSubscription."
          }
        },
        "description": "A link to a subscription."
      },
      "MecAppSuptApiSubscriptionLinkList": {
        "title": "MecAppSuptApiSubscriptionLinkList",
        "required": [
          "_links"
        ],
        "type": "object",
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Links"
          }
        },
        "description": "This type represents a list of links related to currently existing subscriptions for a MEC application instance. This information is returned when sending a request to receive current subscriptions."
      },
      "OperationActionType": {
        "title": "OperationActionType",
        "enum": [
          "STOPPING",
          "TERMINATING"
        ],
        "type": "string",
        "description": "Operation that is being performed on the MEC application instance.",
        "examples": [
          "TERMINATING"
        ]
      },
      "ProblemDetails": {
        "title": "ProblemDetails",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem type"
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status code for this occurrence of the problem",
            "contentEncoding": "int32"
          },
          "detail": {
            "type": "string",