Skip to content

Coverage

Mounir Ghlaiel edited this page Apr 11, 2022 · 2 revisions

Coverage

Coverage represents the weekly schedule of Colibris' collection. It is a simple table of weekdays and cities grouped into zones. A zone is just a reference to a group of cities served on a given weekday. Zones do not exit in data tables nor in code.

The coverage service allows determining Location eligibility, which day should be served to schedule a pick-up request based on the value of location.city and updating colibris' weekly collection schedule.

Components:

schema
  Coverage:
    type: object
    properties:
      day:
        type: string
        enum: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
      cities:
        type: array
        nullable: true //A day may not have any cities assigned. Currently, Colibris takes Thursday off.
Clone this wiki locally