MecServiceMgmtApi.yaml

      x-etsi-notes: "NOTE 1:\tThe service category may be included in the application descriptor. It may be allocated by the operator or by the application developer.\nNOTE 2:\tEither transportId or transportInfo but not both shall be present in POST requests.\nNOTE 3:\tValues NFVI_POP, ZONE and NFVI_NODE are used when the service instance is deployed as a VNF.\nNOTE 4:\tThe isLocal is used only in service availability query response and service availability subscription/notification messages.\nNOTE 5:\tValue ZONE_GROUP can be used when the service instance is deployed as a VNF.\nNOTE 6:\tRegarding the value MEC_SYSTEM, if the service is running on the same MEC system as the MEC app, then it will be local to it."
    ServiceLivenessInfo:
      type: object
      required:
        - state
        - timeStamp
        - interval
      properties:
        state:
          $ref: '#/components/schemas/ServiceState'
        timeStamp:
          type: object
          description: >-
            The time when the last "heartbeat" message was received by MEC
            platform
          required:
            - seconds
            - nanoSeconds
          properties:
            seconds:
              type: integer
            nanoSeconds:
              type: integer
        interval:
          type: integer
          description: >-
            The interval (in seconds) between two consecutive "heartbeat"
            messages (see clause 8.2.10.3.3) that MEC platform has determined.
    ServiceLivenessUpdate:
      type: object
      required:
        - state
      properties:
        state:
          $ref: '#/components/schemas/ServiceState'
    Subscription:
      title: Subscription
      required:
        - subscription
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/LinkType'
      description: A link to the related subscription
    TransportInfo:
      title: TransportInfo
      required:
        - id
        - name
        - type
        - protocol
        - version
        - endpoint
        - security
      type: object
      properties:
        id:
          type: string
          description: The identifier of this transport
          examples:
            - TransId12345
        name:
          type: string
          description: The name of this transport
          examples:
            - REST
        description:
          type: string
          description: Human-readable description of this transport
          examples:
            - REST API
        type:
          $ref: '#/components/schemas/TransportType'
        protocol:
          type: string
          description: The name of the protocol used. Shall be set to HTTP for a REST API.
          examples:
            - HTTP
        version:
          type: string
          description: The version of the protocol used
          examples:
            - '2.0'
        endpoint:
          oneOf:
            - $ref: '#/components/schemas/EndPointInfo.Uris'
            - $ref: '#/components/schemas/EndPointInfo.Fqdn'
            - $ref: '#/components/schemas/EndPointInfo.Addresses'
            - $ref: '#/components/schemas/EndPointInfo.Alternative'
          description: This type represents information about a transport endpoint
          x-etsi-notes: "NOTE:\tExactly one of \"uris\", \"fqdn\", \"addresses\" or \"alternative\" shall be present."
        security:
          $ref: '#/components/schemas/SecurityInfo'
        implSpecificInfo:
          type: string
          description: Additional implementation specific details of the transport
      description: This type represents the general information of a MEC service.
    TransportType:
      title: TransportType
      enum:
        - REST_HTTP
        - MB_TOPIC_BASED
        - MB_ROUTING
        - MB_PUBSUB
        - RPC
        - RPC_STREAMING
        - WEBSOCKET
      type: string
      description: The enumeration TransportType represents types of transports
      examples:
        - REST_HTTP
  requestBodies:
    ServiceAvailabilityNotification:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceAvailabilityNotification'
      required: true