feat: add support for Overlay v1 documents

* linting * preprocessors * decorators * type extensions
Redocly · Feb 10, 2025 · 303d41b · 303d41b
1 parent f4cdd75
commit 303d41b
Show file tree

Hide file tree

Showing 24 changed files with 200 additions and 25 deletions.
diff --git a/.changeset/funny-lobsters-thank.md b/.changeset/funny-lobsters-thank.md
@@ -0,0 +1,6 @@
+---
+"@redocly/openapi-core": minor
+"@redocly/cli": minor
+---
+
+Added support for linting, preprocessors, decorators, and type extensions for Overlay v1 documents.
diff --git a/.changeset/stale-starfishes-rule.md b/.changeset/stale-starfishes-rule.md
diff --git a/__tests__/check-config/wrong-config-type-extensions-in-assertions/snapshot.js b/__tests__/check-config/wrong-config-type-extensions-in-assertions/snapshot.js
diff --git a/__tests__/lint-config/invalid-config-assertation-config-type/snapshot.js b/__tests__/lint-config/invalid-config-assertation-config-type/snapshot.js
diff --git a/packages/cli/src/__tests__/utils.test.ts b/packages/cli/src/__tests__/utils.test.ts
@@ -502,6 +502,7 @@ describe('checkIfRulesetExist', () => {
       async2: {},
       async3: {},
       arazzo1: {},
+      overlay1: {},
     };
     expect(() => checkIfRulesetExist(rules)).toThrowError(
       '⚠️ No rules were configured. Learn how to configure rules: https://redocly.com/docs/cli/rules/'

diff --git a/packages/cli/src/wrapper.ts b/packages/cli/src/wrapper.ts
@@ -38,6 +38,8 @@ export function commandWrapper<T extends CommandOptions>(
         ? 'asyncapi'
         : document?.arazzo
         ? 'arazzo'
+        : document?.overlay
+        ? 'overlay'
         : undefined;
       if (specKeyword) {
         specFullVersion = document[specKeyword] as string;

diff --git a/packages/core/src/bundle.ts b/packages/core/src/bundle.ts
@@ -311,6 +311,11 @@ export function mapTypeToComponent(typeName: string, version: SpecMajorVersion)
         default:
           return null;
       }
+    case SpecMajorVersion.Overlay1:
+      switch (typeName) {
+        default:
+          return null;
+      }
   }
 }
 

diff --git a/packages/core/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap b/packages/core/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap
@@ -211,6 +211,9 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
+  "overlay1Decorators": {},
+  "overlay1Preprocessors": {},
+  "overlay1Rules": {},
   "preprocessors": {},
   "recommendedFallback": false,
   "rules": {
@@ -437,6 +440,9 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
+  "overlay1Decorators": {},
+  "overlay1Preprocessors": {},
+  "overlay1Rules": {},
   "preprocessors": {},
   "recommendedFallback": undefined,
   "rules": {

diff --git a/packages/core/src/config/__tests__/__snapshots__/config.test.ts.snap b/packages/core/src/config/__tests__/__snapshots__/config.test.ts.snap
@@ -32,6 +32,11 @@ StyleguideConfig {
       "oas3_0": {},
       "oas3_1": {},
     },
+    "overlay1": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
   },
   "doNotResolveExamples": false,
   "extendPaths": [],
@@ -76,6 +81,11 @@ StyleguideConfig {
       "oas3_0": {},
       "oas3_1": {},
     },
+    "overlay1": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
   },
   "rawConfig": {
     "_usedRules": Set {},
@@ -203,6 +213,20 @@ StyleguideConfig {
         "operation-summary": "error",
       },
     },
+    "overlay1": {
+      "oas2": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_0": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_1": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+    },
   },
 }
 `;
diff --git a/packages/core/src/config/__tests__/config.test.ts b/packages/core/src/config/__tests__/config.test.ts
@@ -123,6 +123,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "doNotResolveExamples": false,
           "extendPaths": [],
@@ -136,6 +137,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "rawConfig": {
             "extendPaths": [],
@@ -164,6 +166,9 @@ describe('getMergedConfig', () => {
             "oas3_1": {
               "operation-summary": "warn",
             },
+            "overlay1": {
+              "operation-summary": "warn",
+            },
           },
         },
         "telemetry": "on",
@@ -238,6 +243,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "doNotResolveExamples": false,
           "extendPaths": [],
@@ -251,6 +257,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "rawConfig": {
             "extendPaths": [],
@@ -287,6 +294,10 @@ describe('getMergedConfig', () => {
               "no-empty-servers": "error",
               "operation-summary": "error",
             },
+            "overlay1": {
+              "no-empty-servers": "error",
+              "operation-summary": "error",
+            },
           },
         },
         "telemetry": "on",