Skip to content
MEC030_V2XInformationService.yaml 45 KiB
Newer Older
Elian Kraja's avatar
Elian Kraja committed
info:
  title: "ETSI GS MEC 030 V2X Information Service API"
  version: 2.1.1
  description: "ETSI GS MEC 030 V2X Information Service API described using OpenAPI."
Elian Kraja's avatar
Elian Kraja committed
  contact:
Elian Kraja's avatar
Elian Kraja committed
    name: ETSI Forge
    email: cti_support@etsi.org
Elian Kraja's avatar
Elian Kraja committed
    url: https://forge.etsi.org/rep/mec/gs030-vis-api
Elian Kraja's avatar
Elian Kraja committed
  license:
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'  
externalDocs:
  description: "ETSI GS MEC 030 V2X Information Service API, v2.1.1"
  url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.01.01_60/gs_mec030v020101p.pdf' 
openapi: 3.0.0
servers:
Elian Kraja's avatar
Elian Kraja committed
  - url: 'https://localhost/vis/v1'
Elian Kraja's avatar
Elian Kraja committed
tags:
  - name: queries
    description: Queries
  - name: subscription
    description: Subscription
    
paths:
 /queries/uu_unicast_provisioning_info:   
  get:
   tags:
    - 'queries'
   summary: 'Used to query provisioning information for V2X communication over Uu unicast.'
   description: 'Used to query provisioning information for V2X communication over Uu unicast.'
   operationId: prov_info_uu_unicastGET  
   parameters:
        - in: query
          name: location_info
          schema:
           type: string
          required: true
          description: 'Comma separated list of locations to identify a cell of a base station or a particular geographical area'

   responses:
        '200':
          description: 'A response body containing the Uu unicast provisioning information. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UuUnicastProvisioningInfo'        
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'       
 /queries/uu_mbms_provisioning_info: 
  get:
   tags:
    - 'queries'
   summary: 'retrieve information required for V2X communication over Uu MBMS.'
   description: 'retrieve information required for V2X communication over Uu MBMS.'
   operationId: prov_info_uu_mbmsGET  
   parameters:
        - in: query
          name: location_info
          schema:
           type: string
          required: true
          description: 'omma separated list of locations to identify a cell of a base station or a particular geographical area'

   responses:
        '200':
          description: 'A response body containing the Uu unicast provisioning information. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UuMbmsProvisioningInfo'        
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'         
  #/queries/pc5_provisioning_info:
    #get: 
  #/provide_predicted_qos:
   #post:  
  #/publish_v2x_message:
   #post:    
  #/subscriptions:
   #get: 
   #post: 
  #/subscriptions/{subscriptionId}:
   #get: 
   #put:
   #delete: 
  # /notifitication_end_point_provided_by_client
   #post: 
   
components:
  schemas:
    CellId:
      properties:
        cellId:
          description: E-UTRAN Cell Identity as a bit string (size (28)).
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - cellId
      type: object
      x-etsi-ref: 6.6.2
    Earfcn:
      properties:
        earfcn:
          description: E-UTRA Absolute Radio Frequency Channel Number, range (0... 65535)
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
      required:
      - earfcn
      type: object
      x-etsi-ref: 6.6.3
    Ecgi:
      properties:
        cellId:
          # description': The E-UTRAN Cell Identity.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': CellId
          $ref: '#/components/schemas/CellId'
        plmn:
          # description': Public Land Mobile Network Identity.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Plmn
          $ref: '#/components/schemas/Plmn'
      required:
      - plmn
      - cellId
      type: object
      x-etsi-ref: 6.5.5
    FddInfo:
      properties:
        dlEarfcn:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Earfcn
          $ref: '#/components/schemas/Earfcn'
        dlTransmissionBandwidth:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TransmissionBandwidth
          $ref: '#/components/schemas/TransmissionBandwidth'
        ulEarfcn:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Earfcn
          $ref: '#/components/schemas/Earfcn'
        ulTransmissionBandwidth:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TransmissionBandwidth
          $ref: '#/components/schemas/TransmissionBandwidth'
      required:
      - ulEarfcn
      - dlEarfcn
      - ulTransmissionBandwidth
      - dlTransmissionBandwidth
      type: object
      x-etsi-ref: 6.5.6
    LocalityTypes:
      type: string
      
    LocationInfo.geoArea:
          description: Information of a geographical area.
          properties:
            latitude:
              description: 'Latitude (DATUM = WGS84) -90 to 90 in decimal degree format DDD.ddd'
              format: Float
              type: number
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Float
            longitude:
              description: 'Longitude (DATUM = WGS84)-180 to 180 in decimal degree format DDD.ddd'
              format: Float
              type: number
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Float
          required:
          - latitude
          - longitude
          type: object
Loading full blame...