opentripmodel / otm5-change-requests

Tracking and reporting bugs and change requests of the OTM5 specification.
5 stars 1 forks source link

Properties and classes have identical names #71

Closed huibertalblas closed 1 year ago

huibertalblas commented 1 year ago

Type of request

Is your feature request related to a problem? With the current specification i cannot convert an OTM json file to an OTM json-ld file by just appending a @context section.

Describe the solution you'd like Currently properties and classes can have identical names within OTM. For example: 'stop' is both an actionType/entityType, aswell as a property under 'Action'. It would be convenient to differentiate between the two, by starting the class/actionTypes/entityType names with a capital letter.

Describe alternatives you've considered Alternatively an active conversion can be used to rewrite these class names, but the downside to that is:

bmeesters commented 1 year ago

Hello @huibertalblas,

Though I understand the need, it would require to change all the entity, stop and event types. This would not be backwards compatible and therefore is not possible in the OTM5.X line. It could be part of OTM6, but I doubt we want to go that route any time soon as it likely halts any momentum we currently have as a standard.

Alternatively we could create all the entity types with double and deprecate the ones with a lowercase, but that would result in a lot of noise in the specification. Also it would require all existing parties to change their implementation as, and potentially future implementing parties as they would need to adopt for the possibility that either the capital or non-capital version is used.

So, in hindsight it could have been better to make the difference more clear, the amount of work it would cost is not worth it. I will leave the change request open so we can discuss it in a larger setting, but I do not think it is viable to make these changes.

bmeesters commented 1 year ago

Closing this since we cannot make such drastic changes that would break all existing OTM5 services