@apisyouwonthate/style-guide/__tests__/paths-kebab-case.test.ts

Make your HTTP APIs better, faster, stronger, whether they are still being designed (API Design-First) or your organization has flopped various mismatched APIs into production and now you're thinking some consistency would be nice. Using Spectral and Open

import { DiagnosticSeverity } from "@stoplight/types";
import testRule from "./__helpers__/helper";

testRule("paths-kebab-case", [
  {
    name: "valid case",
    document: {
      openapi: "3.1.0",
      info: { version: "1.0" },
      paths: { "/this-is-kebab-case": {} },
    },
    errors: [],
  },

  {
    name: "invalid case",
    document: {
      openapi: "3.1.0",
      info: { version: "1.0" },
      paths: { "/this_is_snake_case": {} },
    },
    errors: [
      {
        message:
          "/this_is_snake_case should be kebab-case (lower case and separated with hyphens).",
        path: ["paths", "/this_is_snake_case"],
        severity: DiagnosticSeverity.Warning,
      },
    ],
  },
]);