Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make vehicle_type_ids plural in geofencing_zones #542

Merged
merged 2 commits into from
Nov 2, 2023

Conversation

richfab
Copy link
Contributor

@richfab richfab commented Sep 13, 2023

If you are new to the specification, please introduce yourself (name and organization/link to GBFS). It’s helpful to know who we're chatting with!

MobilityData created this Pull Request on behalf of @pgiki.

What problem does your proposal solve? Please begin with the relevant issue number. If there is no existing issue, please also describe alternative solutions you have considered.

Fixes #529

vehicle_type_id represents multiple vehicle type IDs but the field name is singular whereas it is plural elsewhere (eg: in station_status.json)

What is the proposal?

Change field vehicle_type_id to vehicle_type_ids (plural) in Geofencing Rule Object in geofencing_zones.json.

Is this a breaking change?

  • Yes
  • No
  • Unsure

Which files are affected by this change?

geofencing_zones.json

@josee-sabourin
Copy link
Contributor

I hereby call a vote on this proposal. Voting will be open for 10 full calendar days until 11:59PM UTC on Friday, October 27th.
Please vote for or against the proposal, and include the organization for which you are voting in your comment.
Please note if you can commit to implementing the proposal.

@cmonagle
Copy link
Contributor

Transit: +1

@AntoineAugusti
Copy link
Contributor

transport.data.gouv.fr : +1

@PierrickP
Copy link

fluctuo: +1


I reviewed the others fields.

1/ Most of the Arrays (simply typed Array) use plural, except:

  • eco_label (vehicle_types.json)
  • vehicle_equipment (vehicle_status.json)
  • per_km_pricing (system_pricing_plans.json)
  • per_min_pricing (system_pricing_plans.json)

2/ Some fields, typed as an Array and containing a vehicle_type_id are not plural

  • vehicle_type_area_capacity (station_information.json)
  • vehicle_type_dock_capacity
  • vehicle_types_available

3/ All fields, typed as an Array<Localized String> are not plural

View the list

  • name
  • make
  • model
  • short_name
  • operator
  • attribution_organization_name
  • terms_url
  • privacy_url
  • description
  • url

In my opinion, 1/ must be plural, too.
2/ may be plural.
3/ we can keep them as singular

@futuretap
Copy link
Contributor

+1 from Where To?

@richfab
Copy link
Contributor Author

richfab commented Oct 25, 2023

Thank you @PierrickP for surfacing Array fields written as singular. We all appreciate a consistent specification!

In my opinion, only eco_label should also be changed to plural. See justifications below:

1/

  • vehicle_equipment, per_km_pricing and per_min_pricing should remain singular because equipment and pricing are uncountable nouns (they don't have a plural form in English).

2/

  • vehicle_type_area_capacity and vehicle_type_dock_capacity should remain singular because "capacity" refers to the capacity (singular) of the dock or area per vehicle type.
  • vehicle_types_available should remain singular because available is an adjective (they don't have a plural form in English).

3/ can all remain singular.

Curious to get the opinion of native English speakers.

@josee-sabourin
Copy link
Contributor

Voting on this PR closes in 2 calendar days. Please vote for or against the proposal, and include the organization for which you are voting in your comment. Please note if you can commit to implementing the proposal.

@ezmckinn
Copy link
Contributor

+1 from Superpedestrian. Seems like a sensible change to support more vehicle types and a consistent spec.

@josee-sabourin
Copy link
Contributor

This vote has now closed, and it passes!

Votes in favor:
Transit (consumer)
Transport.data.gouv (consumer)
fluctuo (consumer)
Whereto.app (consumer)
Superpedestrian (producer)

There were no votes against.

This change will be added to v3.0-RC2, which will be released in the coming weeks.

gbfs.md Outdated Show resolved Hide resolved
@richfab richfab merged commit 5c07bdf into master Nov 2, 2023
1 check passed
@richfab richfab deleted the fix/vehicle_type_ids-plural-in-geofencing_zones branch November 2, 2023 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gbfs.md v3.0-RC2 Candidate change for GBFS 3.0 (Major release) - 2nd pass Vote Passed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change field vehicle_type_id to vehicle_type_ids on geofencing_zones.features - version v3.0-RC
7 participants