Vehicle Endpoint

[StPfeffer]

Description

Implementation of the vehicle scope.

Endpoints

Method	Endpoint	Description
GET	/api/v1/vehicles	List all the vehicles.
GET	/api/v1/vehicles/:vehicleId	Returns the vehicle referring to the given ID.
POST	/api/v1/vehicles	Creates a vehicle.
DELETE	/api/v1/vehicles/:vehicleId	Deletes the vehicle referring to the entered ID.

Payloads

List all vehicles

Response

{
    "vehicles": [
        {
            "id": "b87d1704-c957-4ee2-b378-f7be43c10b85",
            "name": "Volkswagen Gol",
            "initialMileage": 85,
            "actualMileage": 93,
            "createdAt": "2024-05-27T20:12:09.472329",
            "updatedAt": "2024-05-27T20:12:09.472329"
        }
    ],
    "results": 1
}

Get a vehicle

Response

{
    "id": "b87d1704-c957-4ee2-b378-f7be43c10b85",
    "name": "Volkswagen Gol",
    "initialMileage": 85,
    "actualMileage": 93,
    "createdAt": "2024-05-27T20:12:09.472329",
    "updatedAt": "2024-05-27T20:12:09.472329"
}

Create a vehicle

Request

The actualMileage field is optional. If it is not included in the request body, the value of initialMileage will be used instead.

{
    "name": "Volkswagen Gol",
    "initialMileage": 85,
    "actualMileage": 93
}

Response

{
    "id": "b87d1704-c957-4ee2-b378-f7be43c10b85",
    "name": "Volkswagen Gol",
    "initialMileage": 85,
    "actualMileage": 93,
    "createdAt": "2024-05-27T20:12:09.472329",
    "updatedAt": "2024-05-27T20:12:09.472329"
}

Delete a vehicle

Response

{
    "id": "b87d1704-c957-4ee2-b378-f7be43c10b85",
    "name": "Volkswagen Gol",
    "initialMileage": 85,
    "actualMileage": 93,
    "createdAt": "2024-05-27T20:12:09.472329",
    "updatedAt": "2024-05-27T20:12:09.472329"
}

Type of change

• [x] New feature (non-breaking change which adds functionality)

Checklist

• [x] I ran cargo clippy --all -- -D warnings just before my last commit and fixed any issue that was found.
• [x] I ran cargo fmt just before my last commit.
• [x] I ran cargo test just before my last commit and all tests passed.
• [x] I added my algorithm to the corresponding mod.rs file within its own folder, and in any parent folder(s).