Skip to content

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

@lukehesluke

Description

@lukehesluke

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    CR3Issues relating to CR3

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions