belgif / rest-guide

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

singleton document resource #106

Closed pvdbosch closed 7 months ago

pvdbosch commented 1 year ago

All examples in the guide of document resources are part of a collection, e.g. /persons/{ssin} We could also add examples of singleton resources, e.g. /persons/{ssin}/profilePicture

A document resource is either an instance part of a collection: /persons/{ssin} or a singleton document, of which only a single instance exists within the context of a parent document, if any:

    /endUserLicenceAgreement
   /persons/{ssin}/profilePicture

Name: singular noun

explain use case: when only single entity exists

edit: change singleton example, similar to existing examples

pvdbosch commented 9 months ago

I'll create a PR for review in next WG

pvdbosch commented 9 months ago

PR ready for review

pvdbosch commented 7 months ago

PR was merged, will be part of next release