MEC030_V2XInformationService.yaml 63.9 KB
Newer Older
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: UuUniNeighbourCellInfo
        v2xApplicationServer:
          # description': V2X Application Server address (consisting of IP address and UDP port) for unicast.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': V2xApplicationServer
          $ref: '#/components/schemas/V2xApplicationServer'
      required:
        - locationInfo
        - v2xApplicationServer
      type: object
      x-etsi-mec-cardinality: '1'
      x-etsi-mec-origin-type: Structure (inlined)
Elian Kraja's avatar
Elian Kraja committed
    SubscriptionLinkList:
      properties:
        _links:
          $ref: '#/components/schemas/SubscriptionLinkList.links'
Elian Kraja's avatar
Elian Kraja committed
      required:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        - _links
Elian Kraja's avatar
Elian Kraja committed
      type: object
      x-etsi-ref: 6.3.6
    SystemInformationBlockType21:
      type: object
Elian Kraja's avatar
Elian Kraja committed
    TddInfo:
      properties:
        earfcn:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Earfcn
          $ref: '#/components/schemas/Earfcn'
        subframeAssignment:
          description: Uplink-downlink subframe configuration information.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        transmissionBandwidth:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TransmissionBandwidth
          $ref: '#/components/schemas/TransmissionBandwidth'
      required:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        - earfcn
        - transmissionBandwidth
        - subframeAssignment
Elian Kraja's avatar
Elian Kraja committed
      type: object
      x-etsi-ref: 6.5.7
    SubscriptionLinkList.links:
      description: List of hyperlinks related to the resource.
      properties:
        self:
          # description': URI of this resource.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LinkType
          $ref: '#/components/schemas/LinkType'
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions'
      required:
        - self
      type: object
      x-etsi-mec-cardinality: '1'
      x-etsi-mec-origin-type: Structure (inlined)
    SubscriptionLinkList.links.subscriptions:
      description: The service consumer's subscriptions.
      minItems: 0
      properties:
        href:
          description: The URI referring to the subscription.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        subscriptionType:
          description: Type of the subscription. The values are as defined in the "subscriptionType" attribute for each different V2X information event subscription data type.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
        - href
        - subscriptionType
      x-etsi-mec-cardinality: 0..N
      x-etsi-mec-origin-type: Structure (inlined)
    TestNotification:
      properties:
        _links:
          description: 'Hyperlink related to the resource. '
          properties:
            subscription:
              # description': URI identifying the subscription for the test notification.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': LinkType
              $ref: '#/components/schemas/LinkType'
          required:
            - subscription
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        notificationType:
          description: Shall be set to "TestNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
        - notificationType
        - _links
      type: object
      x-etsi-ref: 6.4.6
Elian Kraja's avatar
Elian Kraja committed
    TimeStamp:
      properties:
        nanoSeconds:
          description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
          format: uint32
Elian Kraja's avatar
Elian Kraja committed
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        seconds:
          description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
          format: uint32
Elian Kraja's avatar
Elian Kraja committed
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
      required:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        - seconds
        - nanoSeconds
Elian Kraja's avatar
Elian Kraja committed
      type: object
      x-etsi-ref: 6.5.2
    TransmissionBandwidth:
      properties:
        transmissionBandwidth:
          $ref: '#/components/schemas/TransmissionBandwidth.transmissionBandwidth'
      required:
        - transmissionBandwidth
      type: object
      x-etsi-ref: 6.6.4
    TransmissionBandwidth.transmissionBandwidth:
      description: |
        'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows:
        1 = bw6 (6 resource blocks)
        2 = bw15 (15 resource blocks)
        3 = bw25 (25 resource blocks)
        4 = bw50 (50 resource blocks)
        5 = bw75 (75 resource blocks)
        6 = bw100 (100 resource blocks)'
      enum:
      x-etsi-mec-cardinality: '1'
      x-etsi-mec-origin-type: Enum
Elian Kraja's avatar
Elian Kraja committed
    UuMbmsNeighbourCellInfo:
      properties:
        ecgi:
          # description': E-UTRAN CelI Global Identifier.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Ecgi
          $ref: '#/components/schemas/Ecgi'
        fddInfo:
          # description': Information for FDD operation.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': FddInfo
          $ref: '#/components/schemas/FddInfo'
        mbmsServiceAreaIdentity:
          description: Supported MBMS Service Area Identities in the cell.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        pci:
          description: Physical Cell Identifier.
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        plmn:
          # description': Public Land Mobile Network Identity.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Plmn
          $ref: '#/components/schemas/Plmn'
        tddInfo:
          # description': Information for TDD operation.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TddInfo
          $ref: '#/components/schemas/TddInfo'
      required:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        - plmn
        - ecgi
        - pci
        - fddInfo
        - tddInfo
        - mbmsServiceAreaIdentity
Elian Kraja's avatar
Elian Kraja committed
      type: object
      x-etsi-ref: 6.5.11
    UuMbmsProvisioningInfo:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms'
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      required:
Elian Kraja's avatar
Elian Kraja committed
        - proInfoUuMbms
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      type: object
      x-etsi-ref: 6.2.3
    UuMbmsProvisioningInfo.proInfoUuMbms:
      description: The provisioning information per location as defined below.
      properties:
        locationInfo:
          # description': Location information to identify a cell of a base station or a particular geographical area.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LocationInfo
          $ref: '#/components/schemas/LocationInfo'
        neighbourCellInfo:
          description: The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.
          items:
            $ref: '#/components/schemas/UuMbmsNeighbourCellInfo'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: UuMbmsNeighbourCellInfo
        v2xServerUsd:
          # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': V2xServerUsd
          $ref: '#/components/schemas/V2xServerUsd'
      required:
        - locationInfo
        - v2xServerUsd
      x-etsi-mec-cardinality: 1..N
      x-etsi-mec-origin-type: Structure (inlined)
Elian Kraja's avatar
Elian Kraja committed
    UuUniNeighbourCellInfo:
      properties:
        ecgi:
          # description': E-UTRAN CelI Global Identifier.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Ecgi
          $ref: '#/components/schemas/Ecgi'
        fddInfo:
          # description': Information for FDD operation.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': FddInfo
          $ref: '#/components/schemas/FddInfo'
        pci:
          description: Physical Cell Identifier.
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        plmn:
          # description': Public Land Mobile Network Identity.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Plmn
          $ref: '#/components/schemas/Plmn'
        tddInfo:
          # description': Information for TDD operation.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TddInfo
          $ref: '#/components/schemas/TddInfo'
      required:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        - plmn
        - ecgi
        - pci
        - fddInfo
        - tddInfo
Elian Kraja's avatar
Elian Kraja committed
      type: object
      x-etsi-ref: 6.5.9
    UuUnicastProvisioningInfo:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast'
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      required:
Elian Kraja's avatar
Elian Kraja committed
        - proInfoUuUnicast
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      type: object
      x-etsi-ref: 6.2.2
    UuUnicastProvisioningInfo.proInfoUuUnicast:
      description: The provisioning information per location as defined below.
      properties:
        locationInfo:
          # description': Location information to identify a cell of a base station or a particular geographical area.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LocationInfo
          $ref: '#/components/schemas/LocationInfo'
        neighbourCellInfo:
          description: The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.
          items:
            $ref: '#/components/schemas/UuUniNeighbourCellInfo'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: UuUniNeighbourCellInfo
        v2xApplicationServer:
          # description': V2X Application Server address (consisting of IP address and UDP port) for unicast.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': V2xApplicationServer
          $ref: '#/components/schemas/V2xApplicationServer'
      required:
        - locationInfo
        - v2xApplicationServer
      x-etsi-mec-cardinality: 1..N
      x-etsi-mec-origin-type: Structure (inlined)
Elian Kraja's avatar
Elian Kraja committed
    V2xApplicationServer:
      properties:
        ipAddress:
          description: ''
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        udpPort:
          description: ''
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        - ipAddress
        - udpPort
Elian Kraja's avatar
Elian Kraja committed
      type: object
      x-etsi-ref: 6.5.8
    V2xMsgNotification:
Elian Kraja's avatar
Elian Kraja committed
      properties:
          $ref: '#/components/schemas/V2xMsgNotification.links'
Elian Kraja's avatar
Elian Kraja committed
        msgContent:
          description: Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization.
Elian Kraja's avatar
Elian Kraja committed
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        msgEncodeFormat:
          description: The encode format of the V2X message, for example base64.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        msgType:
          $ref: '#/components/schemas/msgType'
        notificationType:
          description: Shall be set to "V2xMsgNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
Elian Kraja's avatar
Elian Kraja committed
        stdOrganization:
          description: "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute.\nSee note 1."
Elian Kraja's avatar
Elian Kraja committed
          enum:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            - ETSI
Elian Kraja's avatar
Elian Kraja committed
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum
        timeStamp:
          # description': Date and time of the notification generation.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
Elian Kraja's avatar
Elian Kraja committed
      required:
        - notificationType
        - timeStamp
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        - stdOrganization
        - msgType
        - msgEncodeFormat
        - msgContent
        - _links
Elian Kraja's avatar
Elian Kraja committed
      type: object
      x-etsi-notes: "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114."
      x-etsi-ref: 6.4.5
    V2xMsgNotification.links:
      description: links to resources related to this notification.
      properties:
        subscription:
          # description': A link to the related subscription.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LinkType
          $ref: '#/components/schemas/LinkType'
      required:
        - subscription
      type: object
      x-etsi-mec-cardinality: '1'
      x-etsi-mec-origin-type: Structure (inlined)
    V2xMsgPublication:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      properties:
        msgContent:
          description: Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        msgEncodeFormat:
          description: The encode format of the V2X message, for example base64.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        msgType:
          $ref: '#/components/schemas/msgType'
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        stdOrganization:
          description: "Standardization organization which defines the published V2X message type:\nETSI: European Telecommunications Standards Institute. \nSee note 1."
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          enum:
            - ETSI
          type: string
Elian Kraja's avatar
Elian Kraja committed
          x-etsi-mec-cardinality: '1'
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          x-etsi-mec-origin-type: Enum
      required:
        - stdOrganization
        - msgType
        - msgEncodeFormat
        - msgContent
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      type: object
      x-etsi-notes: "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114."
      x-etsi-ref: 6.2.6
      description: |
        Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.
        − denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3,
        − cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2,
        − poi(3): Point of Interest message as specified in ETSI TS 101 556-1,
        − spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301,
        − mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301,
        − ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321,
        − ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3,
        − tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2,
        − srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301,
        − ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301.
        − evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1,
        − saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1,
        − rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301,
      enum:
      x-etsi-mec-cardinality: '1'
      x-etsi-mec-origin-type: Enum
Elian Kraja's avatar
Elian Kraja committed
    V2xMsgSubscription:
      properties:
        _links:
          $ref: '#/components/schemas/links'
Elian Kraja's avatar
Elian Kraja committed
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
Elian Kraja's avatar
Elian Kraja committed
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uri
Elian Kraja's avatar
Elian Kraja committed
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        filterCriteria:
          $ref: '#/components/schemas/V2xMsgSubscription.filterCriteria'
        requestTestNotification:
          description: "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS\_MEC 009 [i.1], clause 6.12a.\nDefault: FALSE."
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
Elian Kraja's avatar
Elian Kraja committed
        subscriptionType:
          description: Shall be set to "V2xMsgSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        websockNotifConfig:
          # description': Provides details to negotiate and signal the use of a Websocket connection between VIS and the service consumer for notifications. See note 1.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': WebsockNotifConfig
          $ref: '#/components/schemas/WebsockNotifConfig'
Elian Kraja's avatar
Elian Kraja committed
      required:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        - subscriptionType
        - filterCriteria
Elian Kraja's avatar
Elian Kraja committed
      type: object
      x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nNOTE 2:\tOther standardization organizations could be added as needed.\nNOTE 3:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114."
Elian Kraja's avatar
Elian Kraja committed
      x-etsi-ref: 6.3.5
    V2xMsgSubscription.filterCriteria:
      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.
      properties:
        msgType:
          description: Subscribed V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 3.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Enum
        stdOrganization:
          description: "Standardization organization which defines the subscribed V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 2."
          enum:
            - ETSI
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum
      required:
        - stdOrganization
      type: object
      x-etsi-mec-cardinality: '1'
      x-etsi-mec-origin-type: Structure (inlined)
Elian Kraja's avatar
Elian Kraja committed
    V2xServerUsd:
      properties:
        sdpInfo:
          $ref: '#/components/schemas/V2xServerUsd.sdpInfo'
Elian Kraja's avatar
Elian Kraja committed
        serviceAreaIdentifier:
          description: A list of service area identifier for the applicable MBMS broadcast area.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        tmgi:
          $ref: '#/components/schemas/V2xServerUsd.tmgi'
Elian Kraja's avatar
Elian Kraja committed
      required:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        - tmgi
        - serviceAreaIdentifier
        - sdpInfo
Elian Kraja's avatar
Elian Kraja committed
      type: object
      x-etsi-ref: 6.5.10
    V2xServerUsd.sdpInfo:
      description: SDP with IP multicast address and port number used for V2X communication via MBMS.
      properties:
        ipMulticastAddress:
          description: ''
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        portNumber:
          description: ''
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
        - ipMulticastAddress
        - portNumber
      type: object
      x-etsi-mec-cardinality: '1'
      x-etsi-mec-origin-type: Structure (inlined)
    V2xServerUsd.tmgi:
      description: Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services.
      properties:
        mbmsServiceId:
          description: MBMS Service ID consisting of three octets.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        mcc:
          description: The Mobile Country Code part of PLMN Identity.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        mnc:
          description: The Mobile Network Code part of PLMN Identity.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
        - mbmsServiceId
        - mcc
        - mnc
      type: object
      x-etsi-mec-cardinality: ''
      x-etsi-mec-origin-type: Structure (inlined)
    WebsockNotifConfig:
Elian Kraja's avatar
Elian Kraja committed
      properties:
        requestWebsocketUri:
          description: Set to TRUE by the service consumer to indicate that Websocket delivery is requested.
          type: boolean
Elian Kraja's avatar
Elian Kraja committed
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        websocketUri:
          description: Set by VIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
Elian Kraja's avatar
Elian Kraja committed
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uri
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      type: object
      x-etsi-ref: 6.5.14

Elian Kraja's avatar
Elian Kraja committed
  responses:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
    '204':
Elian Kraja's avatar
Elian Kraja committed
      description: No Content
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
    '206':
      description: Partial content
    '400':
Elian Kraja's avatar
Elian Kraja committed
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/json:
          schema:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            $ref: '#/components/schemas/ProblemDetails'
    '401':
Elian Kraja's avatar
Elian Kraja committed
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/json:
          schema:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            $ref: '#/components/schemas/ProblemDetails'
    '403':
Elian Kraja's avatar
Elian Kraja committed
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
    '404':
Elian Kraja's avatar
Elian Kraja committed
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/json:
          schema:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            $ref: '#/components/schemas/ProblemDetails'
    '406':
Elian Kraja's avatar
Elian Kraja committed
      description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
    '409':
Elian Kraja's avatar
Elian Kraja committed
      description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
    '412':
Elian Kraja's avatar
Elian Kraja committed
      description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
      content:
        application/json:
          schema:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            $ref: '#/components/schemas/ProblemDetails'
    '415':
Elian Kraja's avatar
Elian Kraja committed
      description: 'Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.'
      content:
        application/json:
          schema:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            $ref: '#/components/schemas/ProblemDetails'
    '422':
Elian Kraja's avatar
Elian Kraja committed
      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.'
      content:
        application/json:
          schema:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            $ref: '#/components/schemas/ProblemDetails'
    '429':
Elian Kraja's avatar
Elian Kraja committed
      description: 'Too Many Requests : used when a rate limiter has triggered.'
      content:
        application/json:
          schema:
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            $ref: '#/components/schemas/ProblemDetails'