feat: rules refactoring / add separate arazzo rule-set (#1800)

Redocly · Dec 9, 2024 · f959e4c · f959e4c · github-actions · Dec 9, 2024
1 parent 7ba0d13
commit f959e4c
Show file tree

Hide file tree

Showing 164 changed files with 1,850 additions and 939 deletions.
diff --git a/.changeset/purple-lobsters-stare.md b/.changeset/purple-lobsters-stare.md
@@ -0,0 +1,6 @@
+---
+"@redocly/openapi-core": patch
+"@redocly/cli": patch
+---
+
+Updated `sourceDescriptions` to enforce a valid type field, ensuring compliance with the Arazzo specification.
diff --git a/.changeset/strong-ties-argue.md b/.changeset/strong-ties-argue.md
@@ -0,0 +1,7 @@
+---
+"@redocly/openapi-core": minor
+"@redocly/cli": minor
+---
+
+Introduced the `struct` rule and deprecated the `spec` rule.
+Added the `spec` ruleset, which enforces compliance with the specifications.
diff --git a/__tests__/check-config/config-type-extensions-in-assertions/snapshot.js b/__tests__/check-config/config-type-extensions-in-assertions/snapshot.js
@@ -2,6 +2,7 @@
 
 exports[`E2E check-config config type extension in assertions 1`] = `
 
+The 'spec' field is deprecated. Use struct instead. 
 ✅  Your config is valid.
 
 `;
diff --git a/__tests__/check-config/wrong-config-type-extensions-in-assertions/redocly.yaml b/__tests__/check-config/wrong-config-type-extensions-in-assertions/redocly.yaml
@@ -4,7 +4,7 @@ plugins:
   - plugins/type-extention.js
 
 rules:
-  spec: warn
+  struct: warn
   rule/metadata-lifecycle:
     subject:
       type: WrongXMetaData

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/__tests__/lint-config/invalid-definition-and-config/config-with-warn.snapshot.js b/__tests__/lint-config/invalid-definition-and-config/config-with-warn.snapshot.js
@@ -33,7 +33,7 @@ The field \`title\` must be present on this level.
 5 |   description: Example description
 6 |   version: '1.0'
 
-Error was generated by the spec rule.
+Error was generated by the struct rule.
 
 
 [2] ../__fixtures__/invalid-openapi.yaml:10:5 at #/paths/~1pet~1findByStatus/get/summary
@@ -60,7 +60,7 @@ Expected type \`Responses\` (object) but got \`null\`
    |     ^^^^^^^^^^
 12 |
 
-Error was generated by the spec rule.
+Error was generated by the struct rule.
 
 
 [4] ../__fixtures__/invalid-openapi.yaml:4:1 at #/info

diff --git a/__tests__/lint/arazzo-not-valid-test-description/snapshot.js b/__tests__/lint/arazzo-not-valid-test-description/snapshot.js
@@ -18,7 +18,7 @@ The field \`info\` must be present on this level.
    |       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 18 |
 
-Error was generated by the spec rule.
+Error was generated by the struct rule.
 
 
 [2] museum.yaml:9:5 at #/workflows/0
@@ -36,7 +36,7 @@ The field \`steps\` must be present on this level.
    |       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 18 |
 
-Error was generated by the spec rule.
+Error was generated by the struct rule.
 
 
 museum.yaml: validated in <test>ms

diff --git a/__tests__/lint/arazzo-type-extensions-with-plugin/plugins/type-extention.js b/__tests__/lint/arazzo-type-extensions-with-plugin/plugins/type-extention.js
@@ -9,7 +9,7 @@ const XMetaData = {
 module.exports = {
   id: 'type-extension',
   typeExtension: {
-    arazzo(types) {
+    arazzo1(types) {
       newTypes = {
         ...types,
         XMetaData: XMetaData,

diff --git a/__tests__/lint/arazzo-type-extensions-with-plugin/redocly.yaml b/__tests__/lint/arazzo-type-extensions-with-plugin/redocly.yaml
@@ -1,5 +1,5 @@
 plugins:
   - plugins/type-extention.js
 
-arazzoRules:
-  spec: error
+arazzo1Rules:
+  struct: error
diff --git a/__tests__/lint/arazzo-type-extensions-with-plugin/snapshot.js b/__tests__/lint/arazzo-type-extensions-with-plugin/snapshot.js
@@ -15,7 +15,7 @@ Property \`wrong-key\` is not expected here.
  9 | metadata:
 10 |   lifecycle: production
 
-Error was generated by the spec rule.
+Error was generated by the struct rule.
 
 
 museum.yaml: validated in <test>ms

diff --git a/__tests__/lint/async2/redocly.yaml b/__tests__/lint/async2/redocly.yaml
@@ -35,4 +35,4 @@ apis:
     root: ./websocket-gemini.yml
 
 rules:
-  spec: error
+  struct: error
diff --git a/__tests__/lint/async3/redocly.yaml b/__tests__/lint/async3/redocly.yaml
@@ -33,4 +33,4 @@ apis:
     root: ./websocket-gemini.yml
 
 rules:
-  spec: error
+  struct: error
diff --git a/__tests__/lint/deprecated-apiDefinitions/snapshot.js b/__tests__/lint/deprecated-apiDefinitions/snapshot.js
@@ -2,7 +2,7 @@
 
 exports[`E2E lint deprecated-apiDefinitions 1`] = `
 
-The 'apiDefinitions' field is deprecated. Use apis instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties
+The 'apiDefinitions' field is deprecated. Use apis instead. 
 The 'lint' field is deprecated. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties
 [1] redocly.yaml:1:1 at #/apiDefinitions
 

diff --git a/__tests__/lint/no-enum-type-mismatch-error-recommended-config/snapshot.js b/__tests__/lint/no-enum-type-mismatch-error-recommended-config/snapshot.js
@@ -39,7 +39,7 @@ Expected type \`array\` but got \`string\`.
    |         ^^^^^^
 46 |
 
-Error was generated by the spec rule.
+Error was generated by the struct rule.
 
 
 [4] openapi.yaml:2:1 at #/info

diff --git a/__tests__/lint/no-invalid-media-type-examples-invalid-schema/snapshot.js b/__tests__/lint/no-invalid-media-type-examples-invalid-schema/snapshot.js
@@ -14,7 +14,7 @@ The \`type\` field must be defined when the \`nullable\` field is used.
 17 | paths:
 18 |   /test:
 
-Error was generated by the spec rule.
+Error was generated by the struct rule.
 
 
 [2] openapi.yaml:28:17 at #/paths/~1test/get/responses/202/content/application~1json/schema

diff --git a/__tests__/lint/no-undefined-server-variable-error-recommended-config/snapshot.js b/__tests__/lint/no-undefined-server-variable-error-recommended-config/snapshot.js
@@ -14,7 +14,7 @@ Expected type \`string\` but got \`null\`.
 8 |     description: Dev Environment.
 9 | security: []
 
-Error was generated by the spec rule.
+Error was generated by the struct rule.
 
 
 [2] openapi.yaml:2:1 at #/info

diff --git a/__tests__/lint/null-schema-values/redocly.yaml b/__tests__/lint/null-schema-values/redocly.yaml
@@ -3,5 +3,5 @@ apis:
     root: ./openapi.yaml
 
 rules:
-  spec: error
+  struct: error
   no-unused-components: error
diff --git a/__tests__/lint/null-schema-values/snapshot.js b/__tests__/lint/null-schema-values/snapshot.js
@@ -13,7 +13,7 @@ Expected type \`Info\` (object) but got \`null\`
 3 | paths:
 4 |   /test:
 
-Error was generated by the spec rule.
+Error was generated by the struct rule.
 
 
 [2] openapi.yaml:15:5 at #/components/schemas/EmptySchema
@@ -28,7 +28,7 @@ Expected type \`Schema\` (object) but got \`null\`
 
 referenced from openapi.yaml:12:17 at #/paths/~1test/get/responses/200/content/application~1json/schema 
 
-Error was generated by the spec rule.
+Error was generated by the struct rule.
 
 
 /openapi.yaml: validated in <test>ms

diff --git a/__tests__/lint/oas3.1-error/snapshot.js b/__tests__/lint/oas3.1-error/snapshot.js
@@ -16,7 +16,7 @@ Must contain at least one of the following fields: paths, components, webhooks.
    | ^^^^^^^^^^^^
 24 |
 
-Error was generated by the spec rule.
+Error was generated by the struct rule.
 
 
 /openapi.yaml: validated in <test>ms
St.^❔	Category	Percentage	Covered / Total
🟡	Statements	78.66%	5055/6426
🟡	Branches	67.29%	2055/3054
🟡	Functions	73.23%	837/1143
🟡	Lines	78.95%	4767/6038