Skip to content
MEC030_V2XInformationService.yaml 59.1 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'       
Elian Kraja's avatar
Elian Kraja committed
 /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: 
    tags:
    - 'queries'
    summary: 'Query provisioning information for V2X communication over PC5.'
    description: 'Query provisioning information for V2X communication over PC5.'
    operationId: prov_infoGET
    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 PC5 provisioning information is returned.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pc5ProvisioningInfo'        
        '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'   
          
 /provide_predicted_qos:
   post:  
    tags:
    - 'QoS'
    summary: 'Request the predicted QoS correspondent to potential routes of a vehicular UE.'
    description: 'Request the predicted QoS correspondent to potential routes of a vehicular UE.'
    operationId: predicted_qosPOST
    requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictedQos'
    responses:
        '200':
          description: 'The response body shall contain the predicted QoS corresponding to potential routes of a vehicular UE'
          content:
            application/json:
              schema:
               $ref: '#/components/schemas/PredictedQos'      
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'     
          
 /publish_v2x_message:
   post:    
    tags:
    - 'V2X_msg'
    summary: 'Used to publish a V2X message.'
    description: 'Used to publish a V2X message.'
    operationId: v2x_messagePOST
    requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2xMsgPublication'  
    responses:
        '204':
          $ref: '#/components/responses/204'      
        '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'   
          
 /subscriptions:
   get: 
     tags:
      - 'subscription'
     summary: 'Request information about the subscriptions for this requestor.'
     description: 'Request information about the subscriptions for this requestor.'
     operationId: subGET  
     parameters:
          - in: query
            name: subscription_type
            description: 'Query parameter to filter on a specific subscription type. Permitted values:  prov_chg_uu_uni: provisioning information change for V2X communication over Uuunicast prov_chg_uu_mbms: provisioning information change for V2X communication over Uu MBMS prov_chg_uu_pc5: provisioning information change for V2X communication over PC5. v2x_msg: V2X interoperability message'
            schema:
             type: string
            required: false   
Loading full blame...