Apply error-response post processing to conform to NL API strategy

sergei-maertens commented 2 weeks ago

Error responses currently don't include invalidParams for validation errors, which is not consistent with all the other APIs

sergei-maertens commented 2 weeks ago

-> copy over code from other projects for this, maybe it's in OAF already too

sergei-maertens commented 2 weeks ago

Note: this doesn't seem to be mentioned (anymore?) on https://logius-standaarden.github.io/API-Design-Rules/, but probably it's a good idea to apply this still for consistency with existing APIs

sergei-maertens commented 2 weeks ago

Did some more digging, no mention at all anymore of RFC 9457 or 7807 (the one that preceded it). I could also track down the original discussion where they opted to deviate from the RFC (invalid-params -> invalidParams, https://github.com/Geonovum/KP-APIs/issues/289) so not sure what the point still would be to adhere to this.

Furthermore:

The Objects API doesn't use this error response (or custom content type header)
While working with Open Forms, we found ourselves often reconstructing the nested data structure from the invalidParams, which is absured since that's what our framework originally produces and custom code is added to beat it into the other shape only to transform it back to the original... that's a lot of wasted effort
I'm not convinced that this RFC is the right approach, as the type URLs and code values are typically undocumented and implementation details, so building "generic" clients for that is a noble but ultimately not-worth-the-effort goal

So, closing this as wontfix - let's not waste any time trying to be holier than the pope :wink:

GeneriekPublicatiePlatformWoo / registratie-component

Apply error-response post processing to conform to NL API strategy #116