developer.overheid.nl

Ontwikkelaarsportaal van de Nederlandse overheid

Ga naar hoofdinhoud

/core/path-segments-kebab-case

Padsegmenten in een URI mogen alleen kleine letters, cijfers en koppeltekens bevatten, oftewel kebab-case. Een koppelteken scheidt woorden; het is geen opvulling. Diacritische tekens worden genormaliseerd en speciale tekens vallen weg: /subsidie-aanvragen, niet /subsidieAanvragen of /subsidié_aanvragen.

Twee uitzonderingen​

Een padvariabele houdt de notatie uit de OAS, dus {organisatieId} mag lowerCamelCase zijn. De linter kijkt alleen naar de letterlijke segmenten.

Het laatste segment mag met een _ beginnen. Dat is de conventie uit /core/resource-operations voor een bewerking die geen resource is, zoals een zoekopdracht.

Uitdrukken in OAS​

/openapi.yaml
openapi: 3.1.0
paths:
/open-source-projecten: # goed
/openSourceProjecten: # fout, lowerCamelCase
/open_source_projecten: # fout, snake_case
/Open-Source-Projecten: # fout, Upper-Kebab-Case
/organisaties/{organisatieId}/open-source-projecten: # goed, de variabele mag lowerCamelCase
/organisaties/_zoek: # goed, bewerking met een underscore als laatste segment