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

BUG OrderItem['@id'] should not be marked as REQUIRED for Broker Requests #235

Open
lukehesluke opened this issue Jul 13, 2022 · 0 comments
Labels
CR3 Issues relating to CR3

Comments

@lukehesluke
Copy link

In the most recent version of the spec, OrderItem['@id'] is marked as REQUIRED for Broker Requests (https://openactive.io/open-booking-api/EditorsDraft/1.0CR3/#schema-orderitem).

This is not correct. The Booking System generates its own OrderItem IDs at B (and also at P assuming this issue is agreed upon).

So it should look like:

Property Broker Request Booking System Response Type Notes
@id - REQUIRED https://schema.org/URL A URI providing a unique identifier ...

Additional Suggestion: Booking System Response: REQUIRED*

Property Broker Request Booking System Response Type Notes
@id - REQUIRED* https://schema.org/URL A URI providing a unique identifier ... *This property is required for B responses and ...

I have a feeling a lot of implementers skim through this table. It would be good to signpost things as much as possible. By including the asterisk, it may make it clearer to them that it is not required in all cases. This may be a bigger issue though as there are many properties which may warrant a similar treatment

@nickevansuk nickevansuk added the CR3 Issues relating to CR3 label Jun 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR3 Issues relating to CR3
Projects
None yet
Development

No branches or pull requests

2 participants