|
2070 | 2070 | "200": {
|
2071 | 2071 | "description": "Returns vehicle.",
|
2072 | 2072 | "schema": {
|
2073 |
| - "$ref": "#/definitions/VehicleResponse" |
| 2073 | + "$ref": "#/definitions/FleetVehicleResponse" |
2074 | 2074 | }
|
2075 | 2075 | },
|
2076 | 2076 | "default": {
|
|
2088 | 2088 | ],
|
2089 | 2089 | "summary": "/fleet/vehicles/{vehicle_id | external_id}",
|
2090 | 2090 | "description": "Updates a vehicle given either a vehicle ID or external ID key:value pair (ex. payroll:1)",
|
| 2091 | + "parameters": [ |
| 2092 | + { |
| 2093 | + "in": "body", |
| 2094 | + "name": "data", |
| 2095 | + "required": true, |
| 2096 | + "schema": { |
| 2097 | + "type": "object", |
| 2098 | + "properties": |
| 2099 | + { |
| 2100 | + "name": { |
| 2101 | + "description": "Name", |
| 2102 | + "type": "string" |
| 2103 | + }, |
| 2104 | + "harsh_accel_setting": { |
| 2105 | + "description": "Harsh Acceleration Setting\n* 0: Passenger\n* 1: Light Truck\n* 2: Heavy\n* 3: Off\n* 4: Auto", |
| 2106 | + "type": "integer", |
| 2107 | + "format": "int64", |
| 2108 | + "enum": [ 0, 1, 2, 3, 4 ] |
| 2109 | + } |
| 2110 | + } |
| 2111 | + } |
| 2112 | + } |
| 2113 | + ], |
2091 | 2114 | "operationId": "updateVehicle",
|
2092 | 2115 | "consumes": [
|
2093 | 2116 | "application/json"
|
|
2099 | 2122 | "200": {
|
2100 | 2123 | "description": "Returns updated vehicle.",
|
2101 | 2124 | "schema": {
|
2102 |
| - "$ref": "#/definitions/VehicleResponse" |
| 2125 | + "$ref": "#/definitions/FleetVehicleResponse" |
2103 | 2126 | }
|
2104 | 2127 | },
|
2105 | 2128 | "default": {
|
|
5622 | 5645 | }
|
5623 | 5646 | }
|
5624 | 5647 | },
|
5625 |
| - "VehicleResponse": { |
| 5648 | + "FleetVehicleResponse": { |
5626 | 5649 | "type": "object",
|
5627 |
| - "description": "Contains information about the vehicle", |
| 5650 | + "description": "A vehicle object as returned for fleet/vehicle", |
| 5651 | + "required": [ |
| 5652 | + "id", |
| 5653 | + "name" |
| 5654 | + ], |
5628 | 5655 | "properties": {
|
5629 | 5656 | "id": {
|
5630 | 5657 | "type": "integer",
|
5631 | 5658 | "description": "ID of the vehicle.",
|
5632 | 5659 | "format": "int64",
|
5633 |
| - "example": 123 |
| 5660 | + "example": 112 |
5634 | 5661 | },
|
5635 | 5662 | "name": {
|
5636 | 5663 | "type": "string",
|
5637 |
| - "description": "Name of the vehicle", |
5638 |
| - "format": "string", |
5639 |
| - "example": "Bob's Truck" |
5640 |
| - }, |
5641 |
| - "make": { |
5642 |
| - "type": "string", |
5643 |
| - "description": "Make of the vehicle", |
5644 |
| - "format": "string", |
5645 |
| - "example": "Toyota" |
| 5664 | + "description": "Name of the vehicle.", |
| 5665 | + "example": "Truck A7" |
5646 | 5666 | },
|
5647 |
| - "model": { |
5648 |
| - "type": "string", |
5649 |
| - "description": "Model of the vehicle", |
5650 |
| - "format": "string", |
5651 |
| - "example": "Corolla" |
5652 |
| - }, |
5653 |
| - "vin": { |
5654 |
| - "type": "string", |
5655 |
| - "description": "VIN of the vehicle", |
5656 |
| - "format": "string", |
5657 |
| - "example": "1HGBH41JXMN109186" |
| 5667 | + "vehicleInfo": { |
| 5668 | + "type": "object", |
| 5669 | + "description": "", |
| 5670 | + "properties": { |
| 5671 | + "vin": { |
| 5672 | + "type": "string", |
| 5673 | + "description": "Vehicle Identification Number.", |
| 5674 | + "example": "1FUJA6BD31LJ09646" |
| 5675 | + }, |
| 5676 | + "make": { |
| 5677 | + "type": "string", |
| 5678 | + "description": "Make of the vehicle.", |
| 5679 | + "example": "Honda" |
| 5680 | + }, |
| 5681 | + "model": { |
| 5682 | + "type": "string", |
| 5683 | + "description": "Model of the Vehicle.", |
| 5684 | + "example": "Odyssey" |
| 5685 | + }, |
| 5686 | + "year": { |
| 5687 | + "type": "integer", |
| 5688 | + "format": "int64", |
| 5689 | + "description": "Year of the vehicle.", |
| 5690 | + "example": 1997 |
| 5691 | + } |
| 5692 | + } |
5658 | 5693 | },
|
5659 |
| - "year": { |
5660 |
| - "type": "integer", |
5661 |
| - "description": "Year the vehicle was made.", |
5662 |
| - "format": "int64", |
5663 |
| - "example": "2017" |
5664 |
| - }, |
5665 | 5694 | "harshAccelSetting": {
|
5666 | 5695 | "type": "integer",
|
5667 |
| - "description": "A number from 1-10 indicating the harsh acceleration setting of the vehicle", |
5668 | 5696 | "format": "int64",
|
5669 |
| - "example": "2017" |
5670 |
| - }, |
5671 |
| - "externalIds" : { |
| 5697 | + "description": "Harsh acceleration setting.", |
| 5698 | + "example": 1 |
| 5699 | + }, |
| 5700 | + "externalIds": { |
5672 | 5701 | "type": "object",
|
5673 |
| - "description": "Dictionary of external IDs (string key-value pairs)", |
5674 | 5702 | "additionalProperties": {
|
5675 |
| - "type": "string" |
5676 |
| - }, |
5677 |
| - "example": {"maintenanceId": "ABFS18600"} |
5678 |
| - } |
| 5703 | + "type": "string" |
| 5704 | + }, |
| 5705 | + "example": {"maintenanceId": "ABFS18600"} |
| 5706 | + } |
5679 | 5707 | }
|
5680 | 5708 | },
|
5681 | 5709 | "MachineHistoryResponse": {
|
|
0 commit comments