From e53c12ba74e48456890e3920dd553a53aa1dde5d Mon Sep 17 00:00:00 2001 From: Sylvain Briat Date: Thu, 28 Mar 2024 17:42:30 +0100 Subject: [PATCH] fix readme for optional schedule --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index bb9e2b6..7a0f7ba 100644 --- a/README.md +++ b/README.md @@ -157,10 +157,13 @@ The app exposes the following [gRPC](https://grpc.io/) services : - **fromDate**: start date for recurrent ad, carpool date for punctual ad - **toDate**: end date for recurrent ad, same as fromDate for punctual ad - **schedule**: an optional array of schedule items, a schedule item containing : + - the week day as a number, from 0 (sunday) to 6 (saturday) if the ad is recurrent (default to fromDate day for punctual search) - the departure time (as HH:MM) - the margin around the departure time in seconds (optional) (_default : 900_) + _If the schedule is not set, the driver departure time is guessed to be the ideal departure time to reach the passenger, and the passenger departure time is guessed to by the ideal pick up time for the driver_ + - **seatsProposed** (integer, optional): number of seats proposed as driver (_default : 3_) - **seatsRequested** (integer, optional): number of seats requested as passenger (_default : 1_) - **waypoints**: an array of addresses that represent the waypoints of the journey (only first and last waypoints are used for passenger ads). Note that positions are **required** and **must** be consecutives