MEC021_AppMobilityService.yaml 46.7 KB
Newer Older
          type: integer
          contentEncoding: int32
Elian Kraja's avatar
Elian Kraja committed
    CommunicationInterface:
      title: CommunicationInterface
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        ipAddresses:
          type: array
          items:
            $ref: '#/components/schemas/CommunicationInterface.IpAddresses'
          description: ''
Elian Kraja's avatar
Elian Kraja committed
    MobilityProcedureSubscription.links:
      title: MobilityProcedureSubscription.links
      required:
      - self
      type: object
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
Elian Kraja's avatar
Elian Kraja committed
    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.
Elian Kraja's avatar
Elian Kraja committed
    MobilityProcedureSubscription:
      title: MobilityProcedureSubscription
      required:
      - callbackReference
      - filterCriteria
      - subscriptionType
Elian Kraja's avatar
Elian Kraja committed
      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.
Elian Kraja's avatar
Elian Kraja committed
        expiryDeadline:
          $ref: '#/components/schemas/TimeStamp'
        filterCriteria:
          $ref: '#/components/schemas/MobilityProcedureSubscription.filterCriteria'
        subscriptionType:
          const: MobilityProcedureSubscription
Elian Kraja's avatar
Elian Kraja committed
          type: string
          description: Shall be set to "MobilityProcedureSubscription".
          examples:
          - MobilityProcedureSubscription
Elian Kraja's avatar
Elian Kraja committed
    MobilityStatus:
      title: MobilityStatus
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - INTERHOST_MOVEOUT_TRIGGERED
      - INTERHOST_MOVEOUT_COMPLETED
      - INTERHOST_MOVEOUT_FAILED
      type: string
      description: Indicate the status of the UE mobility
      examples:
      - INTERHOST_MOVEOUT_TRIGGERED
Elian Kraja's avatar
Elian Kraja committed
    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'
Elian Kraja's avatar
Elian Kraja committed
    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.
Elian Kraja's avatar
Elian Kraja committed
    RegistrationInfo:
      title: RegistrationInfo
      required:
      - serviceConsumerId
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        appMobilityServiceId:
          type: string
          description: The identifier of registered application mobility service. Shall be absent in POST requests, and present otherwise.
Elian Kraja's avatar
Elian Kraja committed
        deviceInformation:
          minItems: 0
Elian Kraja's avatar
Elian Kraja committed
          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.
Elian Kraja's avatar
Elian Kraja committed
        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
Elian Kraja's avatar
Elian Kraja committed
        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.
Elian Kraja's avatar
Elian Kraja committed
    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'
Elian Kraja's avatar
Elian Kraja committed
    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.
Elian Kraja's avatar
Elian Kraja committed
    contextTransferState:
      title: contextTransferState
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
    subscriptionType:
      title: subscriptionType
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
    AssociateId:
      title: AssociateId
Elian Kraja's avatar
Elian Kraja committed
      required:
      - type
      - value
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type'
        value:
          type: string
          description: Value for the identifier.
Elian Kraja's avatar
Elian Kraja committed
    LinkType:
      title: LinkType
Elian Kraja's avatar
Elian Kraja committed
      required:
      - href
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        href:
          type: string
          description: The URI referring to the subscription.
      description: "'This data type represents a type of link'"
Elian Kraja's avatar
Elian Kraja committed
    TimeStamp:
      title: TimeStamp
Elian Kraja's avatar
Elian Kraja committed
      required:
      - seconds
      - nanoSeconds
      type: object
Elian Kraja's avatar
Elian Kraja committed
      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
Elian Kraja's avatar
Elian Kraja committed
        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'"
Elian Kraja's avatar
Elian Kraja committed
    MECHostInformation:
      title: MECHostInformation
Elian Kraja's avatar
Elian Kraja committed
      required:
      - hostId
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        hostName:
          type: string
          description: Human-readable name of MEC host.
Elian Kraja's avatar
Elian Kraja committed
        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.'"
Elian Kraja's avatar
Elian Kraja committed
    ProblemDetails:
      title: ProblemDetails
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
Elian Kraja's avatar
Elian Kraja committed
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem
Elian Kraja's avatar
Elian Kraja committed
        status:
          type: integer
          description: The HTTP status code for this occurrence of the problem
          contentEncoding: int32
Elian Kraja's avatar
Elian Kraja committed
        title:
          type: string
          description: A short, human-readable summary of the problem type
Elian Kraja's avatar
Elian Kraja committed
        type:
Elian Kraja's avatar
Elian Kraja committed
          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: