Skip to content

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

Open

Description

@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]?)*)$"

Activity

  1. TimvdLippe commented on Apr 10, 2025

    @TimvdLippe
    Contributor

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

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

  2. erwinkramer commented on Apr 10, 2025

    @erwinkramer
    ContributorAuthor

    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.

  3. added
    Scope: KleinKleine wijzigingen met beperkte scope
    Type: WijzigingInhoudelijke wijziging op een standaard
    Overleg: TO-APITe agenderen voor het Technisch Overleg API
    on Apr 11, 2025
  4. TimvdLippe commented on Apr 11, 2025

    @TimvdLippe
    Contributor

    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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Scope: KleinKleine wijzigingen met beperkte scopeStatus: In onderzoekTer voorbereiding van uitwerking is onderzoek nodig.Type: WijzigingInhoudelijke wijziging op een standaard

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions