@redocly/openapi-core 1.25.14 → 1.26.0

package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap

@@ -2,9 +2,9 @@
 
 exports[`resolveConfig should ignore minimal from the root and read local file 1`] = `
 {
-  "arazzoDecorators": {},
-  "arazzoPreprocessors": {},
-  "arazzoRules": {
+  "arazzo1Decorators": {},
+  "arazzo1Preprocessors": {},
+  "arazzo1Rules": {
     "criteria-unique": "warn",
     "no-actions-type-end": "warn",
     "no-criteria-xpath": "warn",
@@ -13,7 +13,7 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "requestBody-replacements-unique": "warn",
     "sourceDescription-name-unique": "error",
     "sourceDescription-type": "error",
-    "spec": "error",
+    "sourceDescriptions-not-empty": "error",
     "step-onFailure-unique": "warn",
     "step-onSuccess-unique": "warn",
     "stepId-unique": "error",
@@ -29,7 +29,6 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "info-license-strict": "warn",
     "no-channel-trailing-slash": "off",
     "operation-operationId": "warn",
-    "spec": "error",
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
@@ -41,7 +40,6 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "info-license-strict": "warn",
     "no-channel-trailing-slash": "off",
     "operation-operationId": "warn",
-    "spec": "error",
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
@@ -51,9 +49,48 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
   "oas2Preprocessors": {},
   "oas2Rules": {
     "boolean-parameter-prefixes": "error",
+    "info-contact": "off",
+    "info-license": "warn",
+    "info-license-strict": "warn",
+    "info-license-url": "off",
+    "no-ambiguous-paths": "warn",
+    "no-enum-type-mismatch": "error",
+    "no-http-verbs-in-paths": "off",
+    "no-identical-paths": "error",
+    "no-invalid-parameter-examples": "off",
+    "no-invalid-schema-examples": "off",
+    "no-path-trailing-slash": "error",
+    "no-required-schema-properties-undefined": "off",
+    "no-unresolved-refs": "error",
+    "operation-2xx-response": "warn",
+    "operation-4xx-response": "error",
+    "operation-description": "error",
+    "operation-operationId": "warn",
+    "operation-operationId-unique": "error",
+    "operation-operationId-url-safe": "error",
+    "operation-parameters-unique": "error",
+    "operation-singular-tag": "off",
+    "operation-summary": "error",
+    "operation-tag-defined": "off",
+    "parameter-description": "off",
+    "path-declaration-must-exist": "error",
+    "path-excludes-patterns": "off",
+    "path-http-verbs-order": "error",
+    "path-not-include-query": "error",
+    "path-parameters-defined": "error",
+    "path-params-defined": "off",
+    "path-segment-plural": "off",
+    "paths-kebab-case": "off",
     "request-mime-type": "off",
+    "required-string-property-missing-min-length": "off",
+    "response-contains-header": "off",
     "response-contains-property": "off",
     "response-mime-type": "off",
+    "scalar-property-missing-example": "off",
+    "security-defined": "error",
+    "spec-strict-refs": "off",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
   },
   "oas3_0Decorators": {},
   "oas3_0Preprocessors": {},
@@ -61,22 +98,61 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "array-parameter-serialization": "off",
     "boolean-parameter-prefixes": "error",
     "component-name-unique": "off",
+    "info-contact": "off",
+    "info-license": "warn",
+    "info-license-strict": "warn",
+    "info-license-url": "off",
+    "no-ambiguous-paths": "warn",
     "no-empty-servers": "error",
+    "no-enum-type-mismatch": "error",
     "no-example-value-and-externalValue": "error",
+    "no-http-verbs-in-paths": "off",
+    "no-identical-paths": "error",
     "no-invalid-media-type-examples": {
       "allowAdditionalProperties": false,
       "severity": "error",
     },
+    "no-invalid-parameter-examples": "off",
+    "no-invalid-schema-examples": "off",
+    "no-path-trailing-slash": "error",
+    "no-required-schema-properties-undefined": "off",
     "no-server-example.com": "warn",
     "no-server-trailing-slash": "error",
     "no-server-variables-empty-enum": "error",
     "no-undefined-server-variable": "error",
+    "no-unresolved-refs": "error",
     "no-unused-components": "warn",
+    "operation-2xx-response": "warn",
     "operation-4xx-problem-details-rfc7807": "off",
+    "operation-4xx-response": "error",
+    "operation-description": "error",
+    "operation-operationId": "warn",
+    "operation-operationId-unique": "error",
+    "operation-operationId-url-safe": "error",
+    "operation-parameters-unique": "error",
+    "operation-singular-tag": "off",
+    "operation-summary": "error",
+    "operation-tag-defined": "off",
+    "parameter-description": "off",
+    "path-declaration-must-exist": "error",
+    "path-excludes-patterns": "off",
+    "path-http-verbs-order": "error",
+    "path-not-include-query": "error",
+    "path-parameters-defined": "error",
+    "path-params-defined": "off",
+    "path-segment-plural": "off",
+    "paths-kebab-case": "off",
     "request-mime-type": "off",
+    "required-string-property-missing-min-length": "off",
+    "response-contains-header": "off",
     "response-contains-property": "off",
     "response-mime-type": "off",
+    "scalar-property-missing-example": "off",
+    "security-defined": "error",
     "spec-components-invalid-map-name": "error",
+    "spec-strict-refs": "off",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
   },
   "oas3_1Decorators": {},
   "oas3_1Preprocessors": {},
@@ -84,31 +160,14 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "array-parameter-serialization": "off",
     "boolean-parameter-prefixes": "error",
     "component-name-unique": "off",
-    "no-empty-servers": "error",
-    "no-example-value-and-externalValue": "error",
-    "no-invalid-media-type-examples": "error",
-    "no-server-example.com": "warn",
-    "no-server-trailing-slash": "error",
-    "no-server-variables-empty-enum": "error",
-    "no-undefined-server-variable": "error",
-    "no-unused-components": "warn",
-    "operation-4xx-problem-details-rfc7807": "off",
-    "request-mime-type": "off",
-    "response-contains-property": "off",
-    "response-mime-type": "off",
-    "spec-components-invalid-map-name": "error",
-  },
-  "preprocessors": {},
-  "recommendedFallback": false,
-  "rules": {
-    "boolean-parameter-prefixes": "error",
     "info-contact": "off",
     "info-license": "warn",
     "info-license-strict": "warn",
     "info-license-url": "off",
-    "local/operation-id-not-test": "error",
     "no-ambiguous-paths": "warn",
+    "no-empty-servers": "error",
     "no-enum-type-mismatch": "error",
+    "no-example-value-and-externalValue": "error",
     "no-http-verbs-in-paths": "off",
     "no-identical-paths": "error",
     "no-invalid-media-type-examples": "error",
@@ -116,8 +175,14 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "no-invalid-schema-examples": "off",
     "no-path-trailing-slash": "error",
     "no-required-schema-properties-undefined": "off",
+    "no-server-example.com": "warn",
+    "no-server-trailing-slash": "error",
+    "no-server-variables-empty-enum": "error",
+    "no-undefined-server-variable": "error",
     "no-unresolved-refs": "error",
+    "no-unused-components": "warn",
     "operation-2xx-response": "warn",
+    "operation-4xx-problem-details-rfc7807": "off",
     "operation-4xx-response": "error",
     "operation-description": "error",
     "operation-operationId": "warn",
@@ -136,23 +201,38 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "path-params-defined": "off",
     "path-segment-plural": "off",
     "paths-kebab-case": "off",
+    "request-mime-type": "off",
     "required-string-property-missing-min-length": "off",
     "response-contains-header": "off",
+    "response-contains-property": "off",
+    "response-mime-type": "off",
     "scalar-property-missing-example": "off",
     "security-defined": "error",
-    "spec": "error",
+    "spec-components-invalid-map-name": "error",
     "spec-strict-refs": "off",
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
+  "preprocessors": {},
+  "recommendedFallback": false,
+  "rules": {
+    "boolean-parameter-prefixes": "error",
+    "local/operation-id-not-test": "error",
+    "no-invalid-media-type-examples": "error",
+    "operation-2xx-response": "warn",
+    "operation-4xx-response": "error",
+    "operation-description": "error",
+    "path-http-verbs-order": "error",
+    "struct": "error",
+  },
 }
 `;
 
 exports[`resolveStyleguideConfig should resolve extends with local file config which contains path to nested config 1`] = `
 {
-  "arazzoDecorators": {},
-  "arazzoPreprocessors": {},
-  "arazzoRules": {
+  "arazzo1Decorators": {},
+  "arazzo1Preprocessors": {},
+  "arazzo1Rules": {
     "criteria-unique": "warn",
     "no-actions-type-end": "warn",
     "no-criteria-xpath": "warn",
@@ -161,7 +241,7 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "requestBody-replacements-unique": "warn",
     "sourceDescription-name-unique": "error",
     "sourceDescription-type": "error",
-    "spec": "error",
+    "sourceDescriptions-not-empty": "error",
     "step-onFailure-unique": "warn",
     "step-onSuccess-unique": "warn",
     "stepId-unique": "error",
@@ -177,7 +257,6 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "info-license-strict": "warn",
     "no-channel-trailing-slash": "off",
     "operation-operationId": "warn",
-    "spec": "error",
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
@@ -189,7 +268,6 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "info-license-strict": "warn",
     "no-channel-trailing-slash": "off",
     "operation-operationId": "warn",
-    "spec": "error",
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
@@ -199,9 +277,48 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
   "oas2Preprocessors": {},
   "oas2Rules": {
     "boolean-parameter-prefixes": "error",
+    "info-contact": "off",
+    "info-license": "warn",
+    "info-license-strict": "warn",
+    "info-license-url": "off",
+    "no-ambiguous-paths": "warn",
+    "no-enum-type-mismatch": "error",
+    "no-http-verbs-in-paths": "off",
+    "no-identical-paths": "error",
+    "no-invalid-parameter-examples": "off",
+    "no-invalid-schema-examples": "off",
+    "no-path-trailing-slash": "error",
+    "no-required-schema-properties-undefined": "off",
+    "no-unresolved-refs": "error",
+    "operation-2xx-response": "error",
+    "operation-4xx-response": "off",
+    "operation-description": "off",
+    "operation-operationId": "warn",
+    "operation-operationId-unique": "error",
+    "operation-operationId-url-safe": "error",
+    "operation-parameters-unique": "error",
+    "operation-singular-tag": "off",
+    "operation-summary": "error",
+    "operation-tag-defined": "off",
+    "parameter-description": "off",
+    "path-declaration-must-exist": "error",
+    "path-excludes-patterns": "off",
+    "path-http-verbs-order": "off",
+    "path-not-include-query": "error",
+    "path-parameters-defined": "error",
+    "path-params-defined": "off",
+    "path-segment-plural": "off",
+    "paths-kebab-case": "off",
     "request-mime-type": "off",
+    "required-string-property-missing-min-length": "off",
+    "response-contains-header": "off",
     "response-contains-property": "off",
     "response-mime-type": "off",
+    "scalar-property-missing-example": "off",
+    "security-defined": "error",
+    "spec-strict-refs": "off",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
   },
   "oas3_0Decorators": {},
   "oas3_0Preprocessors": {},
@@ -209,22 +326,61 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "array-parameter-serialization": "off",
     "boolean-parameter-prefixes": "error",
     "component-name-unique": "off",
+    "info-contact": "off",
+    "info-license": "warn",
+    "info-license-strict": "warn",
+    "info-license-url": "off",
+    "no-ambiguous-paths": "warn",
     "no-empty-servers": "error",
+    "no-enum-type-mismatch": "error",
     "no-example-value-and-externalValue": "error",
+    "no-http-verbs-in-paths": "off",
+    "no-identical-paths": "error",
     "no-invalid-media-type-examples": {
       "allowAdditionalProperties": false,
       "severity": "warn",
     },
+    "no-invalid-parameter-examples": "off",
+    "no-invalid-schema-examples": "off",
+    "no-path-trailing-slash": "error",
+    "no-required-schema-properties-undefined": "off",
     "no-server-example.com": "warn",
     "no-server-trailing-slash": "error",
     "no-server-variables-empty-enum": "error",
     "no-undefined-server-variable": "error",
+    "no-unresolved-refs": "error",
     "no-unused-components": "warn",
+    "operation-2xx-response": "error",
     "operation-4xx-problem-details-rfc7807": "off",
+    "operation-4xx-response": "off",
+    "operation-description": "off",
+    "operation-operationId": "warn",
+    "operation-operationId-unique": "error",
+    "operation-operationId-url-safe": "error",
+    "operation-parameters-unique": "error",
+    "operation-singular-tag": "off",
+    "operation-summary": "error",
+    "operation-tag-defined": "off",
+    "parameter-description": "off",
+    "path-declaration-must-exist": "error",
+    "path-excludes-patterns": "off",
+    "path-http-verbs-order": "off",
+    "path-not-include-query": "error",
+    "path-parameters-defined": "error",
+    "path-params-defined": "off",
+    "path-segment-plural": "off",
+    "paths-kebab-case": "off",
     "request-mime-type": "off",
+    "required-string-property-missing-min-length": "off",
+    "response-contains-header": "off",
     "response-contains-property": "off",
     "response-mime-type": "off",
+    "scalar-property-missing-example": "off",
+    "security-defined": "error",
     "spec-components-invalid-map-name": "error",
+    "spec-strict-refs": "off",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
   },
   "oas3_1Decorators": {},
   "oas3_1Preprocessors": {},
@@ -232,49 +388,14 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "array-parameter-serialization": "off",
     "boolean-parameter-prefixes": "error",
     "component-name-unique": "off",
-    "no-empty-servers": "error",
-    "no-example-value-and-externalValue": "error",
-    "no-invalid-media-type-examples": "warn",
-    "no-server-example.com": "warn",
-    "no-server-trailing-slash": "error",
-    "no-server-variables-empty-enum": "error",
-    "no-undefined-server-variable": "error",
-    "no-unused-components": "warn",
-    "operation-4xx-problem-details-rfc7807": "off",
-    "request-mime-type": "off",
-    "response-contains-property": "off",
-    "response-mime-type": "off",
-    "spec-components-invalid-map-name": "error",
-  },
-  "preprocessors": {},
-  "recommendedFallback": undefined,
-  "rules": {
-    "assertions": [
-      {
-        "assertionId": "rule/path-item-get-defined",
-        "defined": true,
-        "message": "Every path item must have a GET operation.",
-        "property": "get",
-        "subject": "PathItem",
-      },
-      {
-        "assertionId": "rule/tag-description",
-        "message": "Tag description must be at least 13 characters and end with a full stop.",
-        "minLength": 13,
-        "pattern": "/\\.$/",
-        "property": "description",
-        "severity": "error",
-        "subject": "Tag",
-      },
-    ],
-    "boolean-parameter-prefixes": "error",
     "info-contact": "off",
     "info-license": "warn",
     "info-license-strict": "warn",
     "info-license-url": "off",
-    "local/operation-id-not-test": "error",
     "no-ambiguous-paths": "warn",
+    "no-empty-servers": "error",
     "no-enum-type-mismatch": "error",
+    "no-example-value-and-externalValue": "error",
     "no-http-verbs-in-paths": "off",
     "no-identical-paths": "error",
     "no-invalid-media-type-examples": "warn",
@@ -282,8 +403,14 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "no-invalid-schema-examples": "off",
     "no-path-trailing-slash": "error",
     "no-required-schema-properties-undefined": "off",
+    "no-server-example.com": "warn",
+    "no-server-trailing-slash": "error",
+    "no-server-variables-empty-enum": "error",
+    "no-undefined-server-variable": "error",
     "no-unresolved-refs": "error",
+    "no-unused-components": "warn",
     "operation-2xx-response": "error",
+    "operation-4xx-problem-details-rfc7807": "off",
     "operation-4xx-response": "off",
     "operation-description": "off",
     "operation-operationId": "warn",
@@ -302,14 +429,45 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "path-params-defined": "off",
     "path-segment-plural": "off",
     "paths-kebab-case": "off",
+    "request-mime-type": "off",
     "required-string-property-missing-min-length": "off",
     "response-contains-header": "off",
+    "response-contains-property": "off",
+    "response-mime-type": "off",
     "scalar-property-missing-example": "off",
     "security-defined": "error",
-    "spec": "error",
+    "spec-components-invalid-map-name": "error",
     "spec-strict-refs": "off",
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
+  "preprocessors": {},
+  "recommendedFallback": undefined,
+  "rules": {
+    "assertions": [
+      {
+        "assertionId": "rule/path-item-get-defined",
+        "defined": true,
+        "message": "Every path item must have a GET operation.",
+        "property": "get",
+        "subject": "PathItem",
+      },
+      {
+        "assertionId": "rule/tag-description",
+        "message": "Tag description must be at least 13 characters and end with a full stop.",
+        "minLength": 13,
+        "pattern": "/\\.$/",
+        "property": "description",
+        "severity": "error",
+        "subject": "Tag",
+      },
+    ],
+    "boolean-parameter-prefixes": "error",
+    "local/operation-id-not-test": "error",
+    "no-invalid-media-type-examples": "warn",
+    "operation-2xx-response": "error",
+    "operation-4xx-response": "off",
+    "struct": "error",
+  },
 }
 `;

package/src/config/__tests__/__snapshots__/config.test.ts.snap

@@ -6,7 +6,7 @@ StyleguideConfig {
   "_usedVersions": Set {},
   "configFile": undefined,
   "decorators": {
-    "arazzo": {},
+    "arazzo1": {},
     "async2": {
       "oas2": {},
       "oas3_0": {},
@@ -50,7 +50,7 @@ StyleguideConfig {
   "pluginPaths": [],
   "plugins": [],
   "preprocessors": {
-    "arazzo": {},
+    "arazzo1": {},
     "async2": {
       "oas2": {},
       "oas3_0": {},
@@ -119,7 +119,20 @@ StyleguideConfig {
   },
   "recommendedFallback": false,
   "rules": {
-    "arazzo": {},
+    "arazzo1": {
+      "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",
+      },
+    },
     "async2": {
       "oas2": {
         "no-empty-servers": "error",

package/src/config/__tests__/config-resolvers.test.ts

@@ -389,11 +389,23 @@ describe('resolveStyleguideConfig', () => {
 
 describe('resolveApis', () => {
   it('should resolve apis styleguideConfig and merge minimal extends', async () => {
+    const baseStyleguideConfig: StyleguideRawConfig = {
+      oas3_1Rules: {
+        'operation-2xx-response': 'error',
+      },
+    };
+    const mergedStyleguidePreset = resolveStyleguideConfig({
+      styleguideConfig: { ...baseStyleguideConfig, extends: ['minimal'] },
+    });
     const rawConfig: RawConfig = {
       apis: {
         petstore: {
           root: 'some/path',
-          styleguide: {},
+          styleguide: {
+            oas3_1Rules: {
+              'operation-2xx-response': 'error',
+            },
+          },
         },
       },
       styleguide: {
@@ -401,7 +413,7 @@ describe('resolveApis', () => {
       },
     };
     const apisResult = await resolveApis({ rawConfig });
-    expect(apisResult['petstore'].styleguide).toEqual(await minimalStyleguidePreset);
+    expect(apisResult['petstore'].styleguide).toEqual(await mergedStyleguidePreset);
   });
 
   it('should not merge recommended extends by default by every level', async () => {

package/src/config/__tests__/config.test.ts

@@ -117,7 +117,7 @@ describe('getMergedConfig', () => {
           "_usedVersions": Set {},
           "configFile": "redocly.yaml",
           "decorators": {
-            "arazzo": {},
+            "arazzo1": {},
             "async2": {},
             "async3": {},
             "oas2": {},
@@ -130,7 +130,7 @@ describe('getMergedConfig', () => {
           "pluginPaths": [],
           "plugins": [],
           "preprocessors": {
-            "arazzo": {},
+            "arazzo1": {},
             "async2": {},
             "async3": {},
             "oas2": {},
@@ -146,7 +146,9 @@ describe('getMergedConfig', () => {
           },
           "recommendedFallback": false,
           "rules": {
-            "arazzo": {},
+            "arazzo1": {
+              "operation-summary": "warn",
+            },
             "async2": {
               "operation-summary": "warn",
             },
@@ -230,7 +232,7 @@ describe('getMergedConfig', () => {
           "_usedVersions": Set {},
           "configFile": "redocly.yaml",
           "decorators": {
-            "arazzo": {},
+            "arazzo1": {},
             "async2": {},
             "async3": {},
             "oas2": {},
@@ -243,7 +245,7 @@ describe('getMergedConfig', () => {
           "pluginPaths": [],
           "plugins": [],
           "preprocessors": {
-            "arazzo": {},
+            "arazzo1": {},
             "async2": {},
             "async3": {},
             "oas2": {},
@@ -261,7 +263,10 @@ describe('getMergedConfig', () => {
           },
           "recommendedFallback": false,
           "rules": {
-            "arazzo": {},
+            "arazzo1": {
+              "no-empty-servers": "error",
+              "operation-summary": "error",
+            },
             "async2": {
               "no-empty-servers": "error",
               "operation-summary": "error",