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

Naming convention for API-specific issue types #164

Open jpraet opened 10 months ago

jpraet commented 10 months ago

The guide has a naming rule for problem types: https://www.belgif.be/specification/rest/api-guide/#rule-prb-type

And https://www.belgif.be/specification/rest/api-guide/#bad-request mentions the following about issue types:

They follow the same URN structure as problem types. It is RECOMMENDED to use input-validation as infix to distinguish them.

But it's not clear how API-specific issue types should be named:

urn:problem-type:<org>:input-validation:<api>:<type> or urn:problem-type:<org>:<api>:input-validation:<type>?

Response from @pvdbosch in teams chat:

[12/7/23 1:43 PM] Peter Van Den Bosch (Smals) nergens officieel, maar zou urn:problem-type:cbss:input-validation:socialStatus:issueName nemen [12/7/23 1:44 PM] Peter Van Den Bosch (Smals) wss had het logischer geweest urn:problem-type:input-validation:<org> te nemen, maar dat is weer een breaking change