CityScope/CS_cityscopeJS

RFC - Simple/Coherent module-endpoints names

Closed this issue · 0 comments

RELNO commented
  • Start Date: Oct 6 2022
  • RFC PR: WIP

Summary

We should aim to simply/generalize the modules endpoints

Basic example

access -> HEATMAPS_MODULE
abm2 -> TRIPS_MODULE
geojson -> GEOJSON_MODLUE
....
RULES:

  • all should be caps
  • all should end with _MODULE

Motivation

The current naming is to narrow, inconsistent, and confusing

Detailed design

both FE and BE should redesign in accordance.

Drawbacks

This will affect past tables. We can share this update as a note in the doc/ CSjs landing page

Alternatives

keep it as is

Adoption strategy

Do it ahead of coming deployments