adobekan
commented
1 year ago Here is an OpenAPI example as well
openapi: 3.1.0
info:
title: Vehicle Acceleration API
version: 1.0.1
servers:
- url: https://api.accelerationservice.com/v1
paths:
/vehicle/acceleration:
post:
summary: Provide Vehicle Acceleration Data
description: Endpoint to send vehicle acceleration data.
requestBody:
required: true
content:
application/json:
schema:
$ref: schema/mydemo_vehicle.schema.json#/Vehicle/$children/Acceleration
responses:
'200':
description: Success. Acceleration data received.
'400':
description: Bad Request. Invalid payload or data format.
/vehicle/acceleration/mySpecificLocationEvent:
get:
summary: Get Current Vehicle Data
description: Get the current location and acceleration data of the vehicle.
responses:
'200':
description: Success. Current vehicle data received.
content:
application/json:
schema:
type: object
properties:
Location:
$ref: schema/mydemo_vehicle.schema.yaml#/Vehicle/$children/CurrentLocation
Acceleration:
$ref: schema/mydemo_vehicle.schema.yaml#/Vehicle/$children/Acceleration
/vehicle/acceleration/TriggerService:
get:
summary: Get Current Vehicle Data
description: Get the current location and acceleration data of the vehicle.
parameters:
- name: longitudinal_threshold
in: query
description: Threshold for longitudinal acceleration (X-axis) in m/s^2.
schema:
type: number
- name: lateral_threshold
in: query
description: Threshold for lateral acceleration (Y-axis) in m/s^2.
schema:
type: number
responses:
'200':
description: Success. Current vehicle data received.
content:
application/json:
schema:
type: object
properties:
Timestamp:
type: string
format: date-time
description: The timestamp of the vehicle data.
Location:
$ref: schema/mydemo_vehicle.schema.yaml#/Vehicle/$children/CurrentLocation
Acceleration:
$ref: schema/mydemo_vehicle.schema.yaml#/Vehicle/$children/Acceleration
SebastianSchildt
erikbosch
Work still in progress.
to try,
./vspec2jsonschema.py ../spec/VehicleSignalSpecification.vspec ../../mydemo.schema.json