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

Yet another booking flows merge trial #33

Open
wants to merge 16 commits into
base: WIP-operator-complete-api-initial-version
Choose a base branch
from

Conversation

osarrat
Copy link
Collaborator

@osarrat osarrat commented May 31, 2022

Yes, let's dare !

Its is opened for discussion tomorrow...

@pierrecamilleri
Copy link
Collaborator

As a result of the discussions of our last meeting, we agreed that some work on the names should be useful to make sense of the different Booking objects. I write down the suggestions that we had during this meeting :

  • GenericBooking instead of CarpoolBooking (everybody seems to agree)
  • TransactionalBooking or BookingTransaction or BookingRequest

Some opinions that have been expressed :

  • BookingTransaction sounds better than TransactionalBooking BUT the first breaks the expectation given by the endpoint name /bookings while the second does not.
  • BookingRequest sounds confusing, as it is not only used during the first request, but also at all stages until the trip is completed.

Base automatically changed from booking-by-api-rebased to WIP-operator-complete-api-initial-version June 8, 2022 13:22
@pierrecamilleri
Copy link
Collaborator

As disussed today, this PR needs further discussions.

  • Underlying data structure changes (e.g. GenericBooking) can be done in the future without breaking the API calls.
  • Changing the object names can also be done with few changes in the implementation and can be considered as long as the standard is informative.

So these changes are not yet merged for a v1 informative version.

Copy link

@ccyrille ccyrille left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR introduces some unidentified breaking changes regarding the booking events flow (#5). I think this shows quite well that trying to merge the objects for the booking by API / booking events flow is far from an easy job and should be done "a posteriori" (when standard will be stabilized <> modules will be staged for the "normative" part).

properties:
passenger:
$ref: '#/components/schemas/User'
passengerId:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is not compatible with the booking events flow (#5) as the passenger / driver will not be known on MaaS's side.

properties:
driver:
$ref: '#/components/schemas/User'
driverId:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is not compatible with the bookings events flow (#5) as the passenger / driver will not be known on MaaS's side.

@@ -584,11 +770,9 @@ components:
- passengerDropLat
- passengerDropLng
- status
- webUrl

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If marked as optional here, it must be clear that it is mandatory for the booking events flow (#5).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants