MEC021_AppMobilityService.yaml-OpenApi31Yaml.yaml

          $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:
- {}
tags:
- name: adj-app-inst
  description: Adjacent App instances
- name: app-mob-ser
  description: Application Mobility Services
- name: app-mob-ser-der
  description: Application Mobility Services Deregister task
- name: subscriptions
  description: Subscription for Application Mobility Service
externalDocs:
  description: ETSI GS MEC 021 Application Mobility Service API, v2.1.1
  url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/021/02.01.01_60/gs_mec021v020101p.pdf