search

belgif / rest-guide

REST Guidelines of Belgian government institutions
https://www.belgif.be/specification/rest/api-guide/
Apache License 2.0
26 stars 4 forks source link

Consistent uri notation in examples #68

Closed wsalembi closed 3 years ago

wsalembi commented 4 years ago

Some examples use absolute URIs, others are abbreviated. We added a note (For brevity most URIs in examples are shortened, but in practice URIs should be in absolute notation.) at the start of the style guide but it isn't ery explicit.

Decide approach and adapt examples. Perhaps synchronized with the publication of our demo API on internet.

pvdbosch commented 4 years ago

Syncing the URIs with the demo API was indeed the plan, as mentioned in #19 :

"Examples in the styleguide should be replaced with samples from the REST mock API; and using full URLs instead of relative ones."

pvdbosch commented 3 years ago

will be taken up in #19, closing this one