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

Rename car to carshare to match top-level spec description #411

Conversation

avatarneil
Copy link
Contributor

@avatarneil avatarneil commented Nov 7, 2019

Explain pull request

In this commit f720a09 the top-level name of car was switched to carshare. However, I noticed that change did not seem to bubble down to the agency and provider spec level. This changes the vehicle_types enum to have carshare instead of car. This would be a breaking change, however I find the discontinuity between the types in the top level compared to agency and provider to be pretty strange... If this isn't intended to be a rename that goes down to the data-type level, feel free to close the PR!

Is this a breaking change

A breaking change would require consumers or implementors of the API to modify their code for it to continue to function (ex: renaming of a required field or the change in data type of an existing field). A non-breaking change would allow existing code to continue to function (ex: addition of an optional field or the creation of a new optional endpoint).

  • Yes, breaking

Impacted Spec

Which spec(s) will this pull request impact?

  • agency
  • policy
  • provider

Additional context

Add any other context or screenshots about the feature request here.

@avatarneil avatarneil requested a review from a team November 7, 2019 17:45
@avatarneil avatarneil requested a review from a team as a code owner November 7, 2019 17:45
@avatarneil avatarneil requested a review from a team November 7, 2019 17:45
@CLAassistant
Copy link

CLAassistant commented Nov 7, 2019

CLA assistant check
All committers have signed the CLA.

@thekaveman
Copy link
Collaborator

I don't know that this spec-level change is needed, especially as it would be breaking. The vehicle is a car after all, it just happens to be a car in a car-sharing fleet.

@avatarneil
Copy link
Contributor Author

Sounds good to me! I'll nuke the PR.

@avatarneil avatarneil closed this Nov 7, 2019
@avatarneil avatarneil deleted the rename-car-to-carshare branch November 7, 2019 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants