Developer Overheid forum

API-48 V-09-07-2020 vs OData 4

Standaarden
#1

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:

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] and [OData-Atom].

The service root URL always terminates in a forward slash.

Hoe kunnen wij hier het beste mee omgaan?

#2

Beste CBS,

Ik heb voor dit vraagstuk een issue aangemaakt bij het Kennisplaform API’s. Zie ook OData trailing slashes · Issue #530 · Geonovum/KP-APIs · GitHub

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

#3

Een uitzondering opnemen in de betreffende rule of een module maken met rules voor specifieke OData API’s lijkt ons prima.

  1. Is er al een keuze gemaakt?
  2. Is er een indicatie te geven wanneer de gekozen oplossing wordt geïmplementeerd?
  3. Moeten wij dan nog iets aanpassen aan onze content/api/cbs-cijfers.yaml · main · Common Ground / DON / Content · GitLab?