openactive / developer-documentation

Developer documentation synced with GitBook and the Data Models
https://developer.openactive.io/
MIT License
0 stars 3 forks source link

Documentation of test interface for the implementer, in addition to the spec #71

Closed lukehesluke closed 8 months ago

lukehesluke commented 8 months ago

Provide very clear guidance on what each Action specifically needs to do, and which need to be implemented depending on the features implemented

Ensure that this guidance is signpostable from the following places:

Specifically consider how test data generation can be used to narrow down which criteria need to be implemented, which reduces work for the implementer

Potentially improve the test data generation tool with a flag to produce this data more clearly LW: That task has separately been defined here: https://github.com/orgs/openactive/projects/17/views/1?pane=issue&itemId=38590522. Probably, that task should be completed first, so that the documentation consists of instructing users to use that new logic

lukehesluke commented 8 months ago

Gitbook PR: https://app.gitbook.com/o/-LJTExWaXZFqcFJ_lZwF/s/-LOMz1IIOd5fl4xzfUYb/~/diff/~/changes/275/open-booking-api/key-decisions (now merged)