lowerCamelCase for path and query parameters

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

lowerCamelCase for path and query parameters #148

Closed pvdbosch closed 7 months ago

pvdbosch commented 10 months ago

lowerCamelCase is the guideline for URI notation, [uri-notat] and JSON properties, but an explicit guideline for query and path parameters is missing.

pvdbosch commented 10 months ago

for query parameters, we may allow the period character, bc so it can used to refer to a property in the payload e.g. in search criteria GET /persons?address.country=BE

pvdbosch commented 10 months ago

Also for query parameters: maybe allow underscores for cases like "startDate_gt", that we were discussing in #18.

pvdbosch commented 9 months ago

I'll work out a proposition in a PR

pvdbosch commented 9 months ago

PR ready:

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"

I haven't included special query param cases that include separators, like GET /persons?address.country=BE bc they're not standardized yet. But the rule's wording (with SHOULD) gives some leeway for APIs to use them.

pvdbosch commented 7 months ago

PR was merged, will be part of next release