[Agency] API is REST-like, not RESTful #116
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@toddapetersen do we want to rework agnecy to be true restful or rest-like as is? |
|
Yes.
… On Oct 8, 2018, at 12:07 PM, Hunter Owens ***@***.***> wrote:
@toddapetersen <https://github.com/toddapetersen> do we want to rework agnecy to be true restful or rest-like as is?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub <#116 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/Ag9Otlkb4XhfwAXUWOLYs5pay5kDFYnGks5ui6JxgaJpZM4XFLsn>.
|
|
@toddapetersen "yes" meaning "rework to be true restful" ? |
|
Hi @toddapetersen , any news on that one ? |
|
Hi @toddapetersen, @hunterowens. I submitted a PR for a more RESTful API and can provide adjustments on it if needed. |
toddapetersen
added a commit
that referenced
this pull request
Dec 12, 2018
This is a baseline restructure of the Agency api to address a number of endpoint changes and incorporate feedback received in previous issue and PRs (#161, #116 and #63). Major changes: * `provider_id` is passed as part of an authorization bearer token. * Looking up and registering vehicles use standard `GET` and `POST` operations on `/vehicles` endpoint. * The `/vehicles/{vehicle_id}/event` allows Providers to `POST` events to affect vehicle status. The vehicle status is modeled around a state flow that is modeled in Vehicle Events table. * Deregister vehicle, trip start and end are now events. * Events for `trip_enter` and `trip_leave` were added to address trips that do not start or end in the Agency jurisdiction.
hunterowens
pushed a commit
that referenced
this pull request
Dec 20, 2018
* Restructure api and add event-status model This is a baseline restructure of the Agency api to address a number of endpoint changes and incorporate feedback received in previous issue and PRs (#161, #116 and #63). Major changes: * `provider_id` is passed as part of an authorization bearer token. * Looking up and registering vehicles use standard `GET` and `POST` operations on `/vehicles` endpoint. * The `/vehicles/{vehicle_id}/event` allows Providers to `POST` events to affect vehicle status. The vehicle status is modeled around a state flow that is modeled in Vehicle Events table. * Deregister vehicle, trip start and end are now events. * Events for `trip_enter` and `trip_leave` were added to address trips that do not start or end in the Agency jurisdiction. * Fix field names for provider api consistency * Linking to provider.csv
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I don't want to go into any bike-shedding, and it does not matter if an API is RESTful or REST-like. That said, it is nice to use the correct term to define the API, and this one is clearly REST-like (otherwise we would have a "/vehicles" resource that we could PUT and DELETE, not "register_vehicle" and "deregister_vehicle")