MEC021_AppMobilityService.json

            "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"
                }
              }
            }
          },
          "415": {
            "description": "Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
            "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": []
    },
    "/subscriptions/{subscriptionId}": {
      "get": {
        "tags": [
          "subscriptions"
        ],
        "summary": "Retrieve information about this subscription.",
        "description": "Retrieve information about this subscription.",
        "operationId": "sub_byIdGET",
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Refers to created subscription, where the AMS API allocates a unique resource name for this subscription",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A response body containing data type describing the specific RNI event subscription",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/MobilityProcedureSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/AdjacentAppInfoSubscription"
                    }
                  ],
                  "contentMediaType": "application/json"
                }
              }
            }
          },
          "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"
                }
              }
            }
          },
          "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": [
          "subscriptions"
        ],
        "summary": "update the existing individual subscription.",
        "description": "update the existing individual subscription.",
        "operationId": "sub_byIdPUT",
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Refers to created subscription, where the AMS API allocates a unique resource name for this subscription",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/MobilityProcedureSubscription"
                  },
                  {
                    "$ref": "#/components/schemas/AdjacentAppInfoSubscription"
                  }
                ],
                "contentMediaType": "application/json"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "a response body containing data type describing the updated subscription",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/MobilityProcedureSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/AdjacentAppInfoSubscription"
                    }
                  ],
                  "contentMediaType": "application/json"
                }
              }
            }
          },
          "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"
                }
              }
            }
          },
          "412": {
            "description": "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
            "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
      },
      "delete": {
        "tags": [
          "subscriptions"
        ],
        "summary": "cancel the existing individual subscription",
        "description": "cancel the existing individual subscription",
        "operationId": "sub_byIdDELETE",
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Refers to created subscription, where the AMS API allocates a unique resource name for this subscription",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "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": {
      "AdjacentAppInfoSubscription.links": {
        "title": "AdjacentAppInfoSubscription.links",
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          }
        },
        "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests."
      },
      "AdjacentAppInfoSubscription.filterCriteria": {
        "title": "AdjacentAppInfoSubscription.filterCriteria",
        "type": "object",
        "properties": {
          "appInstanceId": {
            "type": "string"
          }
        },
        "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response."
      },
      "AdjacentAppInfoSubscription": {
        "title": "AdjacentAppInfoSubscription",
        "required": [
          "callbackReference",
          "filterCriteria",
          "subscriptionType"
        ],
        "type": "object",
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/AdjacentAppInfoSubscription.links"
          },
          "callbackReference": {
            "type": "string",
            "description": "URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. This shall be included both in the request and in response."
          },
          "expiryDeadline": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "filterCriteria": {
            "$ref": "#/components/schemas/AdjacentAppInfoSubscription.filterCriteria"
          },
          "subscriptionType": {
            "const": "AdjacentAppInfoSubscription",
            "type": "string",
            "description": "Shall be set to \"AdjacentAppInfoSubscription\".",
            "examples": [
              "AdjacentAppInfoSubscription"
            ]
          }
        }
      },
      "AdjacentAppInstanceInfo": {
        "title": "AdjacentAppInstanceInfo",
        "required": [
          "appDId",
          "appInstanceCommLink",
          "appInstanceId"
        ],
        "type": "object",
        "properties": {
          "appDId": {
            "type": "string",
            "description": "Identifier of the application descriptor."
          },
          "appInstanceCommLink": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommunicationInterface"
            },
            "description": "It specifies the communication interface of application instance."
          },
          "appInstanceId": {
            "type": "string",
            "description": "Identifier of the application instance."
          },
          "mecHostInformation": {
            "$ref": "#/components/schemas/MECHostInformation"
          }
        }
      },
      "AppMobilityServiceLevel": {
        "title": "AppMobilityServiceLevel",
        "enum": [
          "APP_MOBILITY_NOT_ALLOWED",
          "APP_MOBILITY_WITH_CONFIRMATION",
          "APP_MOBILITY_WITHOUT_CONFIRMATION"
        ],
        "type": "string",
        "description": "This attribute provides an option for the application instance (server) to communicate with the application client before relocating this application instance to another MEC host.",
        "examples": [
          "APP_MOBILITY_NOT_ALLOWED"
        ]
      },
      "CommunicationInterface.IpAddresses": {
        "title": "CommunicationInterface.IpAddresses",
        "required": [
          "host",
          "port"
        ],
        "type": "object",
        "properties": {
          "host": {
            "type": "string"
          },
          "port": {
            "type": "integer",
            "contentEncoding": "int32"
          }
        }
      },
      "CommunicationInterface": {
        "title": "CommunicationInterface",
        "type": "object",
        "properties": {
          "ipAddresses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommunicationInterface.IpAddresses"
            },
            "description": ""
          }
        }
      },
      "MobilityProcedureSubscription.links": {
        "title": "MobilityProcedureSubscription.links",
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          }
        }
      },
      "MobilityProcedureSubscription.filterCriteria": {
        "title": "MobilityProcedureSubscription.filterCriteria",
        "type": "object",
        "properties": {
          "appInstanceId": {
            "type": "string",
            "description": "Identifier of the application instance that registers the application mobility service."
          },
          "associateId": {
            "minItems": 0,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssociateId"
            },
            "description": "0 to N identifiers to associate the information for specific UE(s) and flow(s)."
          },
          "mobilityStatus": {
            "minItems": 0,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MobilityStatus"
            },
            "description": "In case mobilityStatus is not included in the subscription request, the default value 1 = INTER_HOST_MOBILITY_TRIGGERED shall be used and included in the response."
          }
        },
        "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response."
      },
      "MobilityProcedureSubscription": {
        "title": "MobilityProcedureSubscription",
        "required": [
          "callbackReference",
          "filterCriteria",
          "subscriptionType"
        ],
        "type": "object",
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/MobilityProcedureSubscription.links"
          },
          "callbackReference": {
            "type": "string",
            "description": "URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. This shall be included both in the request and in response."
          },
          "expiryDeadline": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "filterCriteria": {
            "$ref": "#/components/schemas/MobilityProcedureSubscription.filterCriteria"
          },
          "subscriptionType": {
            "const": "MobilityProcedureSubscription",
            "type": "string",
            "description": "Shall be set to \"MobilityProcedureSubscription\".",
            "examples": [
              "MobilityProcedureSubscription"
            ]
          }
        }
      },
      "MobilityStatus": {
        "title": "MobilityStatus",
        "enum": [
          "INTERHOST_MOVEOUT_TRIGGERED",
          "INTERHOST_MOVEOUT_COMPLETED",
          "INTERHOST_MOVEOUT_FAILED"
        ],
        "type": "string",
        "description": "Indicate the status of the UE mobility",
        "examples": [
          "INTERHOST_MOVEOUT_TRIGGERED"
        ]
      },
      "RegistrationInfo.deviceInformation": {
        "title": "RegistrationInfo.deviceInformation",
        "required": [
          "associateId"
        ],
        "type": "object",
        "properties": {
          "associateId": {
            "$ref": "#/components/schemas/AssociateId"
          },
          "appMobilityServiceLevel": {
            "$ref": "#/components/schemas/AppMobilityServiceLevel"
          },
          "contextTransferState": {
            "$ref": "#/components/schemas/contextTransferState"
          }
        }
      },
      "RegistrationInfo.serviceConsumerId": {
        "title": "RegistrationInfo.serviceConsumerId",
        "type": "object",
        "properties": {
          "appInstanceId": {
            "type": "string",
            "description": "If present, it represents the identifier of the application instance registering the application mobility service."
          },
          "mepId": {
            "type": "string",
            "description": "If present, it represents the identifier of the MEC platform registering the application mobility service."
          }
        },
        "description": "The identifier of service consumer requesting the application mobility service, i.e. either the application instance ID or the MEC platform ID."
      },
      "RegistrationInfo": {
        "title": "RegistrationInfo",
        "required": [
          "serviceConsumerId"
        ],
        "type": "object",
        "properties": {
          "appMobilityServiceId": {
            "type": "string",
            "description": "The identifier of registered application mobility service. Shall be absent in POST requests, and present otherwise."
          },
          "deviceInformation": {
            "minItems": 0,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RegistrationInfo.deviceInformation"
            },
            "description": "If present, it specifies the device served by the application instance which is registering the application mobility service."
          },
          "expiryTime": {
            "type": "integer",
            "description": "If present, it indicates the time of application mobility service expiration from the time of registration accepted.The value \"0\" means infinite time, i.e. no expiration.The unit of expiry time is one second.",
            "contentEncoding": "int32"
          },
          "serviceConsumerId": {
            "$ref": "#/components/schemas/RegistrationInfo.serviceConsumerId"
          }
        }
      },
      "SubscriptionLinkList.links": {
        "title": "SubscriptionLinkList.links",
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          }
        },
        "description": "List of hyperlinks related to the resource."
      },
      "SubscriptionLinkList.subscription": {
        "title": "SubscriptionLinkList.subscription",
        "required": [
          "href",
          "subscriptionType"
        ],
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URI referring to the subscription."
          },
          "subscriptionType": {
            "$ref": "#/components/schemas/subscriptionType"
          }
        }
      },
      "SubscriptionLinkList": {
        "title": "SubscriptionLinkList",
        "required": [
          "_links"
        ],
        "type": "object",
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/SubscriptionLinkList.links"
          },
          "subscription": {
            "minItems": 0,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubscriptionLinkList.subscription"
            },
            "description": "A link to a subscription."
          }
        }
      },
      "contextTransferState": {
        "title": "contextTransferState",
        "enum": [
          "NOT_TRANSFERRED",
          "USER_CONTEXT_TRANSFER_COMPLETED"
        ],
        "type": "string",
        "description": "If present, it represents the state of transferring the user context to another application instance.",
        "examples": [
          "NOT_TRANSFERRED"
        ]
      },
      "subscriptionType": {
        "title": "subscriptionType",
        "enum": [
          0,
          1,
          2
        ],
        "type": "integer",
        "description": "Numeric value (0 - 255) corresponding to specified type of subscription as following: 0 = RESERVED. 1 = MOBILITY_PROCEDURE. 2 = ADJACENT_APPINFO.",
        "examples": [
          0
        ]
      },
      "AssociateId": {
        "title": "AssociateId",
        "required": [
          "type",
          "value"
        ],
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/Type"
          },
          "value": {
            "type": "string",
            "description": "Value for the identifier."
          }
        }
      },
      "LinkType": {
        "title": "LinkType",
        "required": [
          "href"
        ],
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URI referring to the subscription."
          }
        },
        "description": "'This data type represents a type of link'"
      },
      "TimeStamp": {
        "title": "TimeStamp",
        "required": [
          "seconds",
          "nanoSeconds"
        ],
        "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"
          },
          "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"
          }
        },
        "description": "'This data type represents the time stamp as Unix-time since January 1, 1970, 00:00:00 UTC'"
      },
      "MECHostInformation": {
        "title": "MECHostInformation",
        "required": [
          "hostId"
        ],
        "type": "object",
        "properties": {
          "hostName": {
            "type": "string",
            "description": "Human-readable name of MEC host."
          },
          "hostId": {
            "type": "object",
            "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'"
          }
        },
        "description": "'The data type represents the parameters of MEC host information.'"
      },
      "ProblemDetails": {
        "title": "ProblemDetails",
        "type": "object",
        "properties": {
          "detail": {
            "type": "string",
            "description": "A human-readable explanation specific to this occurrence of the problem"
          },
          "instance": {
            "type": "string",
            "description": "A URI reference that identifies the specific occurrence of the problem"
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status code for this occurrence of the problem",
            "contentEncoding": "int32"
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem type"
          },
          "type": {
            "type": "string",
            "description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
          }
        }
      },
      "Type": {
        "title": "Type",
        "enum": [
          "UE_IPv4_ADDRESS",
          "UE_IPV6_ADDRESS",
          "NATED_IP_ADDRESS",
          "GTP_TEID"
        ],
        "type": "string",
        "description": "Numeric value (0-255) corresponding to specified type of identifier",
        "examples": [
          "UE_IPv4_ADDRESS"
        ]
      }
    }
  },
  "security": [
    {}
  ]
}