New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Naming convention for API-specific issue types #164

Open

jpraet opened this issue Jan 15, 2024 · 0 comments

Contributor

jpraet commented Jan 15, 2024 •

edited by pvdbosch

Loading

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

The text was updated successfully, but these errors were encountered:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment