-
Notifications
You must be signed in to change notification settings - Fork 61
Expand file tree
/
Copy pathapi_docs.js
More file actions
29 lines (26 loc) · 923 Bytes
/
api_docs.js
File metadata and controls
29 lines (26 loc) · 923 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
/**
* @typedef {Object} vehicleMedia
* @property {string} name - Name of image
* @property {string} url - URL of image
*/
/**
* @typedef {Object} emissions
* @property {string} template - Template string
* @property {string} value - Occurrence value
*/
/**
* @typedef {Object} vehicleMeta
* @property {string} passengers - Quantity of passengers
* @property {Array.<string>} drivetrain - Drivetrain
* @property {Array.<string>} bodystyles - Bodystyles
* @property {Object.<emissions>} emissions - Emissions template
*/
/**
* @typedef {Object} vehicleSummaryPayload
* @property {string} id - ID of the vehicle
* @property {string} apiUrl - API URL for price, description & other details
* @property {string} description - Description
* @property {string} price - Price
* @property {Array.<vehicleMedia>} media - Array of vehicle images
* @property {Object.<vehicleMeta>} meta - Vehicle meta data
*/