TOMP-WG / TOMP-API

Transport Operator to Mobility-as-a-Service Provider-API development for Mobility as a Service
Apache License 2.0
100 stars 41 forks source link

[FEATURE REQUEST] TOMP v2.0 Consistent Naming Conventions #487

Open eborremans opened 1 year ago

eborremans commented 1 year ago

There is an inconsistent use of certain model suffixes in the TOMP idiom. For instance, the booking endpoint expects a bookingRequest whereas the trip execution endpoint expects a legEvent. I think we should either always use the Request suffix when dealing with requests, or never. The notable exception would be where the term request is an explicit term used in a particular domain. Afaik this is not the case for TOMP.

The same holds for responses, enums, arrays, lists, etc.

When designing TOMP v2.0 we should take this into account.

edwinvandenbelt commented 1 year ago

We're going to investigate what the mapping with Transmodel will look like before taking action on this one.

edwinvandenbelt commented 10 months ago

MUST do. https://github.com/TOMP-WG/TOMP-API/blob/transmodel-v1/TOMP-API.yaml

edwinvandenbelt commented 9 months ago

https://github.com/TOMP-WG/TOMP-API/commit/ba9ba10dab3fa8c1cc20194adf37ab478eb44acd