Path and query lowerCamelCase

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

Path and query lowerCamelCase #159

Closed pvdbosch closed 7 months ago

pvdbosch commented 9 months ago

Replaced "URI notation MUST use lowerCamelCase" by "Path segments and query parameters SHOULD use lowerCamelCase" and updated examples
Added a rule "Naming of path parameters"
used "SHOULD" keyword for apiName lowerCamelCase
Clarify that URI fragments are client-local and not part of the API specification

Related to #148

pvdbosch commented 7 months ago

feedback WG: in URI examples, remove /REST prefix. Otherwise OK to merge.

pvdbosch commented 7 months ago

Using https://api.socialsecurity.be as host now for all examples without /REST path prefix. Only in the example demonstrating the URI structure with a path prefix, I've kept the "/REST" prefix.