MEC030_V2XInformationServices.yaml 82.3 KB
Newer Older
      minItems: 1
      properties:
        location:
          # description': Vehicular UE location.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LocationInfo
          $ref: '#/components/schemas/LocationInfo'
        time:
          # description': Estimated time at the location.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
      required:
      - location
      type: object
      x-etsi-mec-cardinality: 1..N
      x-etsi-mec-origin-type: Structure (inlined)

    _links:
      description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
      properties:
        self:
          # description': Self-referring URI. The URI shall be unique within the VIS API as it acts as an ID for the subscription.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LinkType
          $ref: '#/components/schemas/LinkType'
      required:
      - self
      type: object
      x-etsi-mec-cardinality: 0..1
      x-etsi-mec-origin-type: Structure (inlined)

    _links1:
      description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
      properties:
        self:
          # description': Self-referring URI. The URI shall be unique within the V2X API as it acts as an ID for the subscription.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LinkType
          $ref: '#/components/schemas/LinkType'
      required:
      - self
      type: object
      x-etsi-mec-cardinality: 0..1
      x-etsi-mec-origin-type: Structure (inlined)

    _links2:
      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:
          items:
            $ref: '#/components/schemas/Subscriptions'
          type: array
      required:
      - self
      type: object
      x-etsi-mec-cardinality: '1'
      x-etsi-mec-origin-type: Structure (inlined)

    _links3:
      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)

    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
      type: object
      x-etsi-mec-cardinality: 0..N
      x-etsi-mec-origin-type: Structure (inlined)

  responses:
    '204':
      description: No Content
    '206':
      description: Partial content
    '400':
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '401':
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '403':
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '404':
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '406':
      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'
    '409':
      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'
    '412':
      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:
            $ref: '#/components/schemas/ProblemDetails'
    '415':
      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:
            $ref: '#/components/schemas/ProblemDetails'
    '422':
      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:
            $ref: '#/components/schemas/ProblemDetails'
    '429':
      description: 'Too Many Requests : used when a rate limiter has triggered.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'