Skip to content

Latest commit

 

History

History
167 lines (79 loc) · 3.28 KB

vehicle.md

File metadata and controls

167 lines (79 loc) · 3.28 KB
title description
com.example
API Specification for the com.example package.

Top

Manufacturer

Represents a manufacturer of cars.

Field Type Description
id int32 The unique manufacturer ID.
code string A manufacturer code, e.g. "DKL4P".
details (optional) string Manufacturer details (minimum orders et.c.).
category (optional) Manufacturer.Category Manufacturer category.

Manufacturer.Category

Manufacturer category. A manufacturer may be either inhouse or external.

Name Number Description
CATEGORY_INHOUSE 0 The manufacturer is inhouse.
CATEGORY_EXTERNAL 1 The manufacturer is external.

Model

Represents a vehicle model.

Field Type Description
id string The unique model ID.
model_code string The car model code, e.g. "PZ003".
model_name string The car model name, e.g. "Z3".
daily_hire_rate_dollars sint32 Dollars per day.
daily_hire_rate_cents sint32 Cents per day.

Vehicle

Represents a vehicle that can be hired.

Field Type Description
id int32 Unique vehicle ID.
model Model Vehicle model.
reg_number string Vehicle registration number.
mileage (optional) sint32 Current vehicle mileage, if known.
category (optional) Vehicle.Category Vehicle category.
daily_hire_rate_dollars (optional) sint32 Dollars per day.
daily_hire_rate_cents (optional) sint32 Cents per day.
Extension Type Base Number Description
series Vehicle.series Vehicle 100 Vehicle model series.

Category

Represents a vehicle category. E.g. "Sedan" or "Truck".

Field Type Description
code string Category code. E.g. "S".
description string Category name. E.g. "Sedan".

Coolness

Name Number Description
COOLNESS_UNSPECIFIED 0 The coolness is unknown.
COOLNESS_MAX 1 The coolness is maximum.

Extensions

Extension Type Extension Point Number Description
country com.example.country Manufacturer 100 Manufacturer country.