Field Name | Unique? | Validation |
---|---|---|
slug | ✔ | ^[a-z0-9_-]+$ |
name | ^[a-zA-Z0-9_. ]+$ |
Resource | 1-to-1 | 1-to-many | many-to-1 | many-to-many |
---|---|---|---|---|
model | ✔ | |||
vehicle | ✔ |
Operation: GET /vehicle/makes
Itent: fetch a list of vehicle makes
Status: 200 OK
Response body:
[{ VEHICLE MAKE HASH }, { VEHICLE MAKE HASH }, ... ]
Operation: GET /vehicle/make/1
Intent: retrieve vehicle make 1
Status: 200 OK
Response body:
{
"id": "1",
"location": "/vehicle/make/1",
"name": "Bayerische Motoren Werke AG",
"slug": "bmw"
}
Operation: POST /vehicle/make
Request body:
{
"name": "Volkswagen",
"slug": "vw"
}
Intent: create a vehicle make
Status: 201 Created
Response body: { VEHICLE MAKE HASH }
Operation: PUT /vehicle/make/1
Request body:
{
"slug": "volkswagen"
}
Intent: update vehicle make 1 to have a slug of "volkswagen"
Status: 200 OK
Response body: { VEHICLE MAKE HASH }
Operation: DELETE /vehicle/make/1
Intent: delete vehice make 1
Status: 200 OK