Georepublic / pg_scheduleserv

RESTful API Server for scheduling VRP tasks using vrpRouting and VROOM, written in Go. Demo Application
GNU Affero General Public License v3.0
8 stars 0 forks source link

Extend the schedule output to provide a summary and details #21

Closed dkastl closed 2 years ago

dkastl commented 2 years ago

There are good reasons to return additional information (i.e. metadata) together with the schedule request. In fact there could be the following cases:

  1. Return metadata + schedule data
  2. Return metadata only (since a full schedule can be very big)
  3. Return schedule data only (because this eventually makes it easier to handle the response for clients that can easier deal with an iCal document alone, for example the iCal document of a single job, see #19 )

How the schedule request response would look like can be set through parameters with the default set to 1.?

What information could be "metadata":

Vroom Express for example does this: https://github.com/VROOM-Project/vroom/blob/master/docs/API.md#output