@apisyouwonthate/style-guide/__tests__/no-global-versioning.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("no-global-versioning", [
  {
    name: "valid case",
    document: {
      openapi: "3.1.0",
      info: { version: "1.0" },
      paths: { "/": {} },
      servers: [{ url: "https://api.example.com/" }],
    },
    errors: [],
  },

  {
    name: "an API that is getting ready to give its consumers a really bad time",
    document: {
      openapi: "3.1.0",
      info: { version: "1.0" },
      paths: { "/": {} },
      servers: [{ url: "https://api.example.com/v1" }],
    },
    errors: [
      {
        message: "Server URL should not contain global versions.",
        path: ["servers", "0", "url"],
        severity: DiagnosticSeverity.Warning,
      },
    ],
  },

  {
    name: "an API that got massively out of control as usual",
    document: {
      openapi: "3.1.0",
      info: { version: "1.0" },
      paths: { "/": {} },
      servers: [{ url: "https://api.example.com/v13" }],
    },
    errors: [
      {
        message: "Server URL should not contain global versions.",
        path: ["servers", "0", "url"],
        severity: DiagnosticSeverity.Warning,
      },
    ],
  },
]);