Rule suggestie: Operation id's must be in PascalCase (upper camel case)

[erwinkramer]

Suggestie:

 casing-operation-id-requires-pascal-case:
    description: Operation id's must be in PascalCase (upper camel case).
    message: Operation id is not in PascalCase.
    severity: warn
    given: "$..operationId"
    then:
      function: pattern #or casing func https://docs.stoplight.io/docs/spectral/cb95cf0d26b83-core-functions#casing
      functionOptions:
        match: "^[A-Z](([a-z0-9]+[A-Z]?)*)$"

[TimvdLippe]

Quarkus kan automatisch de operation ID genereren, maar dat is op basis van de methode naam. Omdat in Java die meestal camelCase zijn (

API-Design-Rules/linter/testcases/cor-api/openapi.json

Line 47 in fa7ea4a

"operationId": "getHeartbeat",

) zouden die niet voldoen. Ik denk dat het lastig is om hier een eenduidige casing voor te vinden als deze gegenereerd worden, omdat elke programmeertaal zijn casing voorkeuren heeft.

[erwinkramer]

Dat is inderdaad lastig kiezen, misschien zou de regel moeten zijn: kies 1 type casing voor operation id en hou dat consistent over je document, maar ik begrijp dat dat niet zo simpel is via Spectral.

[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.