Newer
Older
- callbackReference
- filterCriteria
- subscriptionType
type: object
properties:
_links:
$ref: '#/components/schemas/AdjacentAppInfoSubscription.links'
callbackReference:
piscione
committed
type: uri
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.
piscione
committed
requestTestNotification:
type: boolean
description: Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009, as described in clause 6.12a.
websockNotifConfig:
$ref: '#/components/schemas/WebsockNotifConfig'
piscione
committed
description: Identifies a boundary after which the subscription will expire.
$ref: '#/components/schemas/TimeStamp'
filterCriteria:
$ref: '#/components/schemas/AdjacentAppInfoSubscription.filterCriteria'
subscriptionType:
const: AdjacentAppInfoSubscription
description: Shall be set to "AdjacentAppInfoSubscription".
examples:
- AdjacentAppInfoSubscription
AdjacentAppInstanceInfo:
title: AdjacentAppInstanceInfo
- appDId
- appInstanceCommLink
- appInstanceId
description: Identifier of the application descriptor.
appInstanceCommLink:
type: array
items:
$ref: '#/components/schemas/CommunicationInterface'
description: It specifies the communication interface of application instance.
description: Identifier of the application instance.
mecHostInformation:
$ref: '#/components/schemas/MECHostInformation'
piscione
committed
registeredInstanceId:
type: string
description: dentifier of the application instance that registers to the AMS, which is instantiated from the application descriptor identified by the attribute "appDId".
enum:
- APP_MOBILITY_NOT_ALLOWED
- APP_MOBILITY_WITH_CONFIRMATION
- APP_MOBILITY_WITHOUT_CONFIRMATION
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
title: CommunicationInterface.IpAddresses
required:
- host
- port
type: object
properties:
host:
type: string
port:
type: integer
contentEncoding: int32
title: CommunicationInterface
type: object
type: array
items:
$ref: '#/components/schemas/CommunicationInterface.IpAddresses'
description: ''
title: MobilityProcedureSubscription.links
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
title: MobilityProcedureSubscription.filterCriteria
type: object
properties:
appInstanceId:
type: string
piscione
committed
description: Identifier of the application instance that registers the Application Mobility Service.
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for specific UE(s) and flow(s).
mobilityStatus:
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.
piscione
committed
WebsockNotifConfig:
type: object
properties:
websocketUri:
description: Set by AMS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
type: uri
requestWebsocketUri:
type: boolean
description: Set to true by the service consumer to indicate that Websocket delivery is requested.
title: MobilityProcedureSubscription
required:
- filterCriteria
- subscriptionType
type: object
properties:
_links:
$ref: '#/components/schemas/MobilityProcedureSubscription.links'
callbackReference:
piscione
committed
type: uri
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.
piscione
committed
requestTestNotification:
type: boolean
description: Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009, as described in clause 6.12a.
websockNotifConfig:
description: Provides details to negotiate and signal the use of a Websocket connection between AMS and the service consumer for notifications.
$ref: '#/components/schemas/WebsockNotifConfig'
piscione
committed
description: Identifies a boundary after which the subscription will expire.
$ref: '#/components/schemas/TimeStamp'
filterCriteria:
$ref: '#/components/schemas/MobilityProcedureSubscription.filterCriteria'
subscriptionType:
const: MobilityProcedureSubscription
description: Shall be set to "MobilityProcedureSubscription".
examples:
- MobilityProcedureSubscription
piscione
committed
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
MobilityProcedureNotification:
title: MobilityProcedureNotification
required:
- notificationType
- associateId
- mobilityStatus
- links
properties:
notificationType:
type: string
description: Shall be set to "MobilityProcedureNotification".
timeStamp:
description: Date and time of the generation of the notification
$ref: '#/components/schemas/TimeStamp'
associateId:
type: array
description: 1 to N identifiers to associate the information for specific
items:
$ref: '#/components/schemas/AssociateId'
mobilityStatus:
description: Indicate the status of the UE mobility. Values are defined as following 1 = INTERHOST_MOVEOUT_TRIGGERED. 2 = INTERHOST_MOVEOUT_COMPLETED. 3 = INTERHOST_MOVEOUT_FAILED. Other values are reserved.
$ref: '#/components/schemas/MobilityStatus'
targetAppInfo:
type: object
required:
- appInstanceId
properties:
appInstanceId:
type: string
description: Identifiers of the target application instance.
commInterface:
description: If present, it specifies the communication interface of the application instance.
$ref: '#/components/schemas/CommunicationInterface'
_links:
$ref: '#/components/schemas/LinkType'
AdjacentAppInfoNotification:
title: AdjacentAppInfoNotification
required:
- notificationType
- _links
properties:
notificationType:
type: string
description: Shall be set to "AdjacentAppInfoNotification".
timeStamp:
description: Date and time of the generation of the notification
$ref: '#/components/schemas/TimeStamp'
associateId:
type: array
description: 1 to N identifiers to associate the information for specific
items:
$ref: '#/components/schemas/AssociateId'
adjacentAppInfo:
type: object
required:
- appInstanceId
- commInterface
properties:
appInstanceId:
type: string
description: Identifier of the adjacent application instance.
commInterface:
type: array
description: If present, it represents the communication interface(s) information of the application instance.
items:
$ref: '#/components/schemas/CommunicationInterface'
_links:
$ref: '#/components/schemas/LinkType'
ExpiryNotification:
title: ExpiryNotification
required:
- notificationType
- _links
- expiryDeadline
properties:
notificationType:
type: string
description: Shall be set to "ExpiryNotification".
timeStamp:
description: Date and time of the generation of the notification
$ref: '#/components/schemas/TimeStamp'
_links:
type: object
required:
- subscription
properties:
subscription:
$ref: '#/components/schemas/LinkType'
expiryDeadline:
description: The boundary value setting in the subscription request.
$ref: '#/components/schemas/TimeStamp'
TestNotification:
title: TestNotification
required:
- notificationType
- _links
properties:
notificationType:
type: string
description: Shall be set to "TestNotification".
_links:
type: object
description: Hyperlink related to the resource.
required:
- subscription
properties:
subscription:
description: URI identifying the subscription for the test notification.
$ref: '#/components/schemas/LinkType'
enum:
- INTERHOST_MOVEOUT_TRIGGERED
- INTERHOST_MOVEOUT_COMPLETED
- INTERHOST_MOVEOUT_FAILED
type: string
description: Indicate the status of the UE mobility
examples:
- INTERHOST_MOVEOUT_TRIGGERED
title: RegistrationInfo.deviceInformation
required:
- associateId
type: object
properties:
associateId:
$ref: '#/components/schemas/AssociateId'
appMobilityServiceLevel:
$ref: '#/components/schemas/AppMobilityServiceLevel'
contextTransferState:
$ref: '#/components/schemas/contextTransferState'
title: RegistrationInfo.serviceConsumerId
type: object
properties:
appInstanceId:
type: string
piscione
committed
description: If present, it represents the identifier of the application instance registering the Application Mobility Service.
piscione
committed
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.
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.
$ref: '#/components/schemas/RegistrationInfo.deviceInformation'
piscione
committed
description: If present, it specifies the device served by the application instance which is registering is registering the Application Mobility Service.
piscione
committed
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.
serviceConsumerId:
$ref: '#/components/schemas/RegistrationInfo.serviceConsumerId'
SubscriptionLinkList.links:
title: SubscriptionLinkList.links
piscione
committed
description: List of hyperlinks related to the resource.
required:
- self
type: object
properties:
self:
piscione
committed
$ref: '#/components/schemas/LinkType'
description: URI of this resource.
subscription:
type: array
description: The service consumer’s subscriptions.
items:
$ref: '#/components/schemas/SubscriptionLinkList.subscription'
title: SubscriptionLinkList.subscription
required:
- href
- subscriptionType
type: object
properties:
href:
type: string
description: The URI referring to the subscription.
subscriptionType:
piscione
committed
description:
$ref: '#/components/schemas/subscriptionType'
piscione
committed
title: SubscriptionLinkList
required:
- _links
type: object
properties:
_links:
$ref: '#/components/schemas/SubscriptionLinkList.links'
piscione
committed
description: Hyperlinks related to the resource.
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
description: 'Numeric value (0 - 255) corresponding to specified type of subscription as following: 0 = RESERVED. 1 = MOBILITY_PROCEDURE. 2 = ADJACENT_APPINFO.'
examples:
- 0
properties:
type:
$ref: '#/components/schemas/Type'
value:
type: string
description: Value for the identifier.
type: string
description: The URI referring to the subscription.
description: "'This data type represents a type of link'"
- seconds
- nanoSeconds
type: object
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
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'"
piscione
committed
KeyValuePairs:
type: object
additionalProperties:
type: object
type: string
description: Human-readable name of MEC host.
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'"
piscione
committed
$ref: '#/components/schemas/KeyValuePairs'
title: ProblemDetails
type: object
description: A human-readable explanation specific to this occurrence of the problem
description: A URI reference that identifies the specific occurrence of the problem
description: The HTTP status code for this occurrence of the problem
contentEncoding: int32
description: A short, human-readable summary of the problem type
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: