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

Update README.md #2

Merged
merged 1 commit into from
Apr 5, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Approach
The approach for coming to this standard is to take input from different sources,
merge these into a standard and propose that to the working group.

In the DataLinker directory, the work done previously by Rezare et al. can be
In the DataLinker directory, the work done previously by Rezare and other organisations can be
found. In the JoinData directory, the messages as used and/or proposed in the
JoinData/CRV/Lely project can be found. Both are largely based on the existing
ICAR ADE XML standard and as such overlap largely.
Expand All @@ -22,17 +22,20 @@ The principles used are as follows:
* Primarily focus on the body (message)
* URL with filter/query parameters are outside of the standard
* But we could propose a ‘default’ or ‘recommendation’ to allow better discoverability
* Create preferred names for url’s, filter parameters, pagination etc
* Endpoints per message
* Create preferred names for url’s
* Specification for filter parameters and pagination is within scope
* Endpoints per message (resource or resource list)
* Allows specific access to only the data required for the use case
* Allows a per-URI mandate
* Allows a per-vendor decision which URI’s to support
* Start simple, grow into complexity
* Optimise for 80% of the use cases
* Combine messages into complex messages or batches only when a use case proofs it is required
* Allow vendor-specific properties such as pagination and HATEOAS; create an optional recommendation for that
* No embedded messages (deviation from proposed standard)
* No embedded messages
* Single endpoint should mean single message
* Embedding should be used for genuinely nested structures (for instance, common metadata, ID formats)
* Linking process needs to be explicit (JSON-LD or HATEOAS to be confirmed)

* Avoid output-parameters that steer what the end-point should produce
* Standard should not dictate the URL pattern
Expand Down