chore: changes after review

Author: DmitryAnansky

docs/changelog.md

@@ -1321,7 +1321,7 @@ rules:
 
 ### Features
 
-- Added five new built-in rules:
+- Added four new built-in rules:
   - [path-excludes-patterns](./rules/oas/path-excludes-patterns.md)
   - [no-http-verbs-in-paths](./rules/oas/no-http-verbs-in-paths.md)
   - [request-mime-type](./rules/oas/request-mime-type.md)

docs/rules/built-in-rules.md

@@ -22,7 +22,7 @@ Details of all the rules available "out of the box" with Redocly CLI are listed
 - [no-unresolved-refs](./oas/no-unresolved-refs.md): Every `$ref` must exist
 - [no-unused-components](./oas/no-unused-components.md): All components must be used
 - [security-defined](./oas/security-defined.md): Security rules must be defined, either globally or per-operation
-- [spec](./spec.md): Conform to the declared OpenAPI specification version
+- [struct](./oas/struct.md): Conform to the declared OpenAPI specification version
 - [spec-components-invalid-map-name](./oas/spec-components-invalid-map-name.md): Use only alphanumeric and basic punctuation as key names in the components section
 - [spec-strict-refs](./oas/spec-strict-refs.md) Restricts the usage of the `$ref` keyword.
 

docs/rules/minimal.md

@@ -11,7 +11,7 @@ Errors:
 - [no-server-trailing-slash](./oas/no-server-trailing-slash.md)
 - [no-server-variables-empty-enum](./oas/no-server-variables-empty-enum.md)
 - [no-unresolved-refs](./oas/no-unresolved-refs.md)
-- [spec](./spec.md)
+- [struct](./oas/struct.md)
 
 Warnings:
 

docs/rules/oas/struct.md

@@ -0,0 +1,70 @@
+---
+slug: /docs/cli/rules/oas/struct
+---
+
+# struct
+
+Ensures that your API document conforms to the [OpenAPI specification](https://spec.openapis.org/oas/v3.1.0.html).
+
+| OAS | Compatibility |
+| --- | ------------- |
+| 2.0 | ✅            |
+| 3.0 | ✅            |
+| 3.1 | ✅            |
+
+The default setting for this rule (in the `recommended` and `minimal` configuration) is `error`.
+
+This is an essential rule that should not be turned off except in rare and special cases.
+
+## API design principles
+
+It's important to conform to the specification so that tools work with your API document. Doing so makes writing and maintenance of API descriptions easier.
+
+## Configuration
+
+| Option   | Type   | Description                                                                                |
+| -------- | ------ | ------------------------------------------------------------------------------------------ |
+| severity | string | Possible values: `off`, `warn`, `error`. Default `error` (in `recommended` configuration). |
+
+An example configuration:
+
+```yaml
+rules:
+  struct: error
+```
+
+## Examples
+
+Given this configuration:
+
+```yaml
+rules:
+  struct: error
+```
+
+Example of an **incorrect** struct:
+
+```yaml
+openapi: 3.0.0
+info:
+  version: 1.0.0
+paths: {}
+```
+
+Example of a **correct** struct:
+
+```yaml
+openapi: 3.0.0
+info:
+  title: Ultra API
+  version: 1.0.0
+paths: {}
+```
+
+## Related rules
+
+- [configurable rules](./configurable-rules.md)
+
+## Resources
+
+- [OpenAPI docs](https://redocly.com/docs/openapi-visual-reference/)

docs/rules/recommended.md

@@ -26,7 +26,7 @@ Errors:
 - [path-parameters-defined](./oas/path-parameters-defined.md)
 - [security-defined](./oas/security-defined.md)
 - [spec-components-invalid-map-name](./oas/spec-components-invalid-map-name.md)
-- [spec](./spec.md)
+- [struct](./oas/struct.md)
 
 Warnings:
 

docs/rules/spec.md

@@ -2,70 +2,12 @@
 slug: /docs/cli/rules/spec
 ---
 
-# spec
+# Recommended ruleset
 
-Ensures that your API document conforms to the [OpenAPI specification](https://spec.openapis.org/oas/v3.1.0.html).
+These are the rules in the `spec` set, grouped by their severity.
 
-| OAS | Compatibility |
-| --- | ------------- |
-| 2.0 | ✅            |
-| 3.0 | ✅            |
-| 3.1 | ✅            |
+## Arazzo1Rules
 
-The default setting for this rule (in the `recommended` and `minimal` configuration) is `error`.
+Errors:
 
-This is an essential rule that should not be turned off except in rare and special cases.
-
-## API design principles
-
-It's important to conform to the specification so that tools work with your API document. Doing so makes writing and maintenance of API descriptions easier.
-
-## Configuration
-
-| Option   | Type   | Description                                                                                |
-| -------- | ------ | ------------------------------------------------------------------------------------------ |
-| severity | string | Possible values: `off`, `warn`, `error`. Default `error` (in `recommended` configuration). |
-
-An example configuration:
-
-```yaml
-rules:
-  spec: error
-```
-
-## Examples
-
-Given this configuration:
-
-```yaml
-rules:
-  spec: error
-```
-
-Example of an **incorrect** spec:
-
-```yaml
-openapi: 3.0.0
-info:
-  version: 1.0.0
-paths: {}
-```
-
-Example of a **correct** spec:
-
-```yaml
-openapi: 3.0.0
-info:
-  title: Ultra API
-  version: 1.0.0
-paths: {}
-```
-
-## Related rules
-
-- [configurable rules](./configurable-rules.md)
-
-## Resources
-
-- [Rule source](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/common/spec.ts)
-- [OpenAPI docs](https://redocly.com/docs/openapi-visual-reference/)
+- [criteria-unique](./arazzo/criteria-unique.md)

packages/core/src/config/spec.ts

@@ -4,6 +4,7 @@ const spec: PluginStyleguideConfig<'built-in'> = {
   rules: {
     struct: 'error',
   },
+  // TODO: populate with spec-related rules similar to `arazzo1Rules`
   oas2Rules: {},
   oas3_0Rules: {},
   oas3_1Rules: {},

packages/core/src/rules/arazzo/index.ts

@@ -22,21 +22,21 @@ import type { Arazzo1RuleSet } from '../../oas-types';
 export const rules: Arazzo1RuleSet<'built-in'> = {
   struct: Struct as Arazzo1Rule,
   assertions: Assertions as Arazzo1Rule,
-  'parameters-not-in-body': ParametersNotInBody as Arazzo1Rule,
-  'sourceDescription-type': SourceDescriptionType as Arazzo1Rule,
-  'version-enum': VersionEnum as Arazzo1Rule,
-  'workflowId-unique': WorkflowIdUnique as Arazzo1Rule,
-  'stepId-unique': StepIdUnique as Arazzo1Rule,
-  'sourceDescription-name-unique': SourceDescriptionsNameUnique as Arazzo1Rule,
-  'sourceDescriptions-not-empty': SourceDescriptionsNotEmpty as Arazzo1Rule,
-  'workflow-dependsOn': WorkflowDependsOn as Arazzo1Rule,
-  'parameters-unique': ParametersUnique as Arazzo1Rule,
-  'step-onSuccess-unique': StepOnSuccessUnique as Arazzo1Rule,
-  'step-onFailure-unique': StepOnFailureUnique as Arazzo1Rule,
-  'requestBody-replacements-unique': RequestBodyReplacementsUnique as Arazzo1Rule,
-  'no-criteria-xpath': NoCriteriaXpath as Arazzo1Rule,
-  'no-actions-type-end': NoActionsTypeEnd as Arazzo1Rule,
-  'criteria-unique': CriteriaUnique as Arazzo1Rule,
+  'parameters-not-in-body': ParametersNotInBody,
+  'sourceDescription-type': SourceDescriptionType,
+  'version-enum': VersionEnum,
+  'workflowId-unique': WorkflowIdUnique,
+  'stepId-unique': StepIdUnique,
+  'sourceDescription-name-unique': SourceDescriptionsNameUnique,
+  'sourceDescriptions-not-empty': SourceDescriptionsNotEmpty,
+  'workflow-dependsOn': WorkflowDependsOn,
+  'parameters-unique': ParametersUnique,
+  'step-onSuccess-unique': StepOnSuccessUnique,
+  'step-onFailure-unique': StepOnFailureUnique,
+  'requestBody-replacements-unique': RequestBodyReplacementsUnique,
+  'no-criteria-xpath': NoCriteriaXpath,
+  'no-actions-type-end': NoActionsTypeEnd,
+  'criteria-unique': CriteriaUnique,
 };
 
 export const preprocessors = {};