Rename unknown parameter to unknown issue + clarifications

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

Rename unknown parameter to unknown issue + clarifications #144

Closed pvdbosch closed 10 months ago

pvdbosch commented 10 months ago

see #140

pvdbosch commented 10 months ago

to be reviewed next WG post-merge for possible fine-tuning of wordings. Already publishing this to limit risk on impact of change of input-validation issue type.

pvdbosch commented 9 months ago

Reviewed by WG, change to more consistent naming "input":

"An API SHOULD refuse unknown input, i.e. unknown body (JSON), path properties in the payload or unknown query request parameters. A Bad Request problem response should be returned with an issue of type urn:problem-type:belgif:input-validation:unknownInput."

input/request fields -> input