Voeg regel toe voor problem+json responses

[BvanRaaij]

De file adr-ruleset.yaml bevat oa regels voor naming conventions en problem-schema, deze staan niet in de ADR 2.0.2 documentatie vernoemd. Gaan jullie de ADR documentatie en rulset alignen of gaan deze uit elkaar lopen

[TimvdLippe]

De naming convention regels waren al gedefinieerd in de linter en komen voort uit de conventions die OpenAPI specifications zelf meestal gebruiken. Op basis hiervan hebben we #158 aangemaakt wat voortkomt uit de naming-conventions module van het kennisplatform: https://docs.geostandaarden.nl/api/API-Strategie-mod-naming-conventions/ Als deze wijziging door het TO wordt geaccepteerd, dan laten we de linter regel staan. Anders moeten we daar alsnog naar kijken en mogelijk weghalen.

Het problem-schema stond al in de linter toen we die overnamen van developer.overheid.nl. Ik ben niet bekend met de context waarom die hier in staat en wat het doel er van was. Mijn aanname is dat dit voort komt uit het feit dat wij OpenAPI specification vereisen. @dvh Heb jij hier meer context van? Mocht niemand weten wat het doel van deze regel is/was, dan kunnen we die wat mij betreft verwijderen.

[BvanRaaij]

Ik ben zelf wel voorstander van een standaard problem response zoals RFC7807 en de opvolger 9457 voorschrijven. Zou dus zeker overwegen om één van deze in de ADR/ruleset te handhaven

[TimvdLippe]

Alexander gaat een wijzigingsvoorstel doen voor het introduceren van RFC9457 voor status responses. Bedankt voor de suggestie en wees welkom bij het Technisch Overleg om dit verder te bespreken en een besluit te kunnen nemen.

[dvh]

De problem+json response komt uit de DSO API strategie en zou m.i. in ieder geval als tip/hint/best practice in de ruleset mogen zitten. Overigens is deze er volgens mij ingefietsts vanuit een andere Spectral ruleset.

[BvanRaaij]

Alexander gaat een wijzigingsvoorstel doen voor het introduceren van RFC9457 voor status responses. Bedankt voor de suggestie en wees welkom bij het Technisch Overleg om dit verder te bespreken en een besluit te kunnen nemen.

Ik weet eerlijk gezegd niet hoe ik daar kan aansluiten als dat gewenst is. Allemaal nieuw voor mij

[TimvdLippe]

Op basis van de gesprekken van deze week gaan we dit op pakken door een profiel te schrijven op de RFC en die als regel te introduceren in het core document