search

Geonovum / KP-APIs

26 stars 40 forks source link

OData trailing slashes #530

Open mrtn78 opened 1 year ago

mrtn78 commented 1 year ago

Kopie van bevinding op Developer.overheid.nl: https://forum.developer.overheid.nl/t/api-48-v-09-07-2020-vs-odata-4/109

Wij werken aan de bevindingen van onze CBS Cijfers Open Data.

Alleen is API-48 V-09-07-2020: Leave off trailing slashes from URIs (REST-API Design Rules (Nederlandse API Strategie IIa) 1.0 (centrumvoorstandaarden.nl)) tegenstrijdig met de OData4 specificaties waarbij de service root altijd op een “/” moet eindigen, zie OData Version 4.0. Part 2: URL Conventions Plus Errata 03 1:

3 Service Root URL
The service root URL identifies the root of an OData service. A GET request to this URL returns the format-specific service document, see [[OData-JSON]](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#ODataJSONRef) and [[OData-Atom]](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#ODataAtomRef).

The service root URL always terminates in a forward slash.

Hoe kunnen wij hier het beste mee omgaan?

mrtn78 commented 1 year ago

Ik stel voor dat we hiervoor een uitzondering opnemen in de betreffende rule of een module maken met rules voor specifieke OData API's.

mrtn78 commented 3 months ago

Voorstel is aangenomen in het TO om een uitzondering op de rule te maken waarbij trailing slashes in de root worden toegestaan. Actie @mrtn78 om dit af te stemmen met @dvh om ook aante passen in de testset.