I 20 Include links to possible actions - UnionInternationalCheminsdeFer/OSDM GitHub Wiki
I-20: Include Links to Possible Actions
Description
Adding hypermedia control for better navigability of the OSDM API.
Owner
- Nicolas Selleslaugh (BENE)
Business Value
For implementors
who do build clients connecting to OSDM
the adding of hypermedia controls in the API
is a implementation pattern
that provides better comprehensibility
unlike the current version of the API
our solution enables faster client implementations.
Business Outcomes
The measurable benefits that the business can anticipate if the epic hypothesis is proven to be correct.
Faster client implementation by better comprehensibility.
Leading Indicators
The early measures that will help predict the business outcome hypothesis.
Client implementors ask for hypermedia control in the API.
Nonfunctional Requirements
Nonfunctional requirements (NFRs) associated with the epic.
To do
Specification Effort: MEDIUM
Various standards for navigability exist (HAL, Collection+JSON, Siren). Before specification the standard to be supported needs to be defined.