Skip to content

Latest commit

 

History

History
131 lines (55 loc) · 2.44 KB

booking.md

File metadata and controls

131 lines (55 loc) · 2.44 KB
title description
com.example.booking
API Specification for the com.example.booking package.

Top

BookingService

Service for handling vehicle bookings.

Method Name Request Type Response Type Description
BookVehicle Booking BookingStatus Used to book a vehicle. Pass in a Booking and a BookingStatus will be returned.
BookingUpdates BookingStatusID BookingStatus stream Used to subscribe to updates of the BookingStatus.

BookingStatusID

Represents the booking status ID.

Field Type Description
id int32 Unique booking status ID.

BookingStatus

Represents the status of a vehicle booking.

Field Type Description
id int32 Unique booking status ID.
description string Booking status description. E.g. "Active".

Booking

Represents the booking of a vehicle.

Vehicles are quite fun. But drive carefully!

Field Type Description
vehicle_id int32 ID of booked vehicle.
customer_id int32 Customer that booked the vehicle.
status BookingStatus Status of the booking.
confirmation_sent bool Has booking confirmation been sent?
payment_received bool Has payment been received?
color_preference string Color preference of the customer.

EmptyBookingMessage

An empty message for testing