Rule suggestie: HTTP headers must be in Hyphenated-Pascal-Case

[erwinkramer]

Suggestie:

 casing-header-requires-hyphenated-pascal-case:
    description: HTTP headers must be in Hyphenated-Pascal-Case.
    message: HTTP header is not in Hyphenated-Pascal-Case.
    severity: warn
    given: 
     - "$..responses..headers"
     - "$..parameters[?(@.in == 'header')].name"
     - "$.components.securitySchemes[?(@.in == 'header')].name"
    then:
      field: "@key"
      function: pattern #or casing func https://docs.stoplight.io/docs/spectral/cb95cf0d26b83-core-functions#casing
      functionOptions:
        match: "^(API-Version|WWW-Authenticate|([A-Z][a-z0-9]*)(-[A-Z][a-z0-9]*)*)$"

[TimvdLippe]

De API-Version header die we op dit moment vereisen (https://gitdocumentatie.logius.nl/publicatie/api/adr/#/core/version-header) zou hier niet aan voldoen. Voor de rest lijkt me dit wel een goeie om te bespreken.

[erwinkramer]

Volgens mijn validatie rule voldoet API-Version er aan, maar de ingebouwde spectral function is waarschijnlijk stricter

[TimvdLippe]

Hm, dan weet ik niet zo goed waarom die validation rule niet het pakt. Als ik de regex bekijk dan zou hij er niet aan moeten voldoen: https://regex101.com/r/Ramqq0/1

[erwinkramer]

Er waren en paar issues met mijn rule, de meest misleidende was stoplightio/spectral#2803

[erwinkramer]

Ik heb de rule in mijn startpost aangepast en wat bekende uitzonderingen toegevoegd, zelf ben ik daar nu tevreden mee.

[TimvdLippe]

We agenderen deze op het volgende TO van 2025-05-13 om te bespreken of we meer naming conventions willen standaardiseren. Op basis daarvan besluiten we om het verder uit te werken of niet.

[TimvdLippe]

We pakken deze op voor het TO 2026-03-03. Waar we wel rekening moeten houden is of we casing kunnen afdwingen omdat headers case-insensitive zouden zijn. Het kan zijn dat API gateways alle headers naar lowercase converteren.

Deze regel willen we wel opnemen, maar dan met de verduidelijking hoe om te gaan met afkortingen en dat nlgov- of adr- niet moeten voorkomen in de naamgeving. Ook dat het gebruik van x- niet handig is, vanwege RFC 6648