rename to spec-no-invalid-encoding-combinations and improve docs consistency

tatomyr · tatomyr · commit 154674fa57d7 · 2025-10-16T12:35:04.000+03:00
diff --git a/docs/@v1/rules/oas/array-parameter-serialization.md b/docs/@v1/rules/oas/array-parameter-serialization.md
@@ -15,11 +15,11 @@ Enforces the inclusion of `style` and `explode` fields for parameters with array
 ```mermaid
 flowchart TD
 
-root ==> Paths --> PathItem --> Operation --> Parameter --enforces style and explode fields for array types--> Schema
+Root ==> Paths --> PathItem --> Operation --> Parameter --enforces style and explode fields for array types--> Schema
 PathItem --> Parameter
 NamedParameter --> Parameter
 
-root ==> components
+Root ==> components
 
 subgraph components
 NamedParameter
diff --git a/docs/@v1/rules/oas/boolean-parameter-prefixes.md b/docs/@v1/rules/oas/boolean-parameter-prefixes.md
@@ -16,11 +16,11 @@ When this rule is enabled, the `name` fields of all `boolean` parameters in your
 ```mermaid
 flowchart TD
 
-root ==> Paths --> PathItem --> Operation --> Parameter --enforces names for boolean types--> Schema
+Root ==> Paths --> PathItem --> Operation --> Parameter --enforces names for boolean types--> Schema
 PathItem --> Parameter
 NamedParameter --> Parameter
 
-root ==> components
+Root ==> components
 
 subgraph components
 NamedParameter
diff --git a/docs/@v1/rules/oas/info-license-url.md b/docs/@v1/rules/oas/info-license-url.md
@@ -15,7 +15,7 @@ Requires the license URL in your API descriptions.
 ```mermaid
 flowchart TD
 
-root ==> Info --> License --> url
+Root ==> Info --> License --> url
 
 style url fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v1/rules/oas/info-license.md b/docs/@v1/rules/oas/info-license.md
@@ -15,7 +15,7 @@ Requires the license info in your API descriptions.
 ```mermaid
 flowchart TD
 
-root ==> Info --> License
+Root ==> Info --> License
 
 style License fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v1/rules/oas/no-ambiguous-paths.md b/docs/@v1/rules/oas/no-ambiguous-paths.md
@@ -28,9 +28,9 @@ According to the OpenAPI specification:
 ```mermaid
 flowchart TD
 
-root ==> Paths
+Root ==> Paths
 
-root ==> components
+Root ==> components
 
 style Paths fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v1/rules/oas/no-empty-servers.md b/docs/@v1/rules/oas/no-empty-servers.md
@@ -15,7 +15,7 @@ Requires the `servers` list is defined in your API.
 ```mermaid
 flowchart TD
 
-root ==> ServersList
+Root ==> ServersList
 
 style ServersList fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v1/rules/oas/no-invalid-media-type-examples.md b/docs/@v1/rules/oas/no-invalid-media-type-examples.md
@@ -15,10 +15,10 @@ Disallow invalid media type examples by ensuring they comply with the correspond
 ```mermaid
 flowchart TD
 
-root ==> Paths --> PathItem --> Operation --> MediaType --> Example
+Root ==> Paths --> PathItem --> Operation --> MediaType --> Example
 MediaType --> Examples --> Example
 
-root ==> components
+Root ==> components
 
 NamedExamples --> Example
 
diff --git a/docs/@v1/rules/oas/no-server-example-com.md b/docs/@v1/rules/oas/no-server-example-com.md
@@ -16,7 +16,7 @@ The rule checks for all URL schemes (`http`, `https`...).
 ```mermaid
 flowchart TD
 
-root ==> ServersList
+Root ==> ServersList
 
 style ServersList fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v1/rules/oas/no-server-trailing-slash.md b/docs/@v1/rules/oas/no-server-trailing-slash.md
@@ -15,7 +15,7 @@ Disallow servers with a trailing slash.
 ```mermaid
 flowchart TD
 
-root ==> ServersList
+Root ==> ServersList
 
 style ServersList fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v1/rules/oas/no-server-variables-empty-enum.md b/docs/@v1/rules/oas/no-server-variables-empty-enum.md
@@ -15,7 +15,7 @@ Disallow server variables without enum list defined.
 ```mermaid
 flowchart TD
 
-root ==> ServersList --> Server --> ServerVariables
+Root ==> ServersList --> Server --> ServerVariables
 
 style ServerVariables fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v1/rules/oas/no-undefined-server-variable.md b/docs/@v1/rules/oas/no-undefined-server-variable.md
@@ -15,7 +15,7 @@ Disallow undefined server variables.
 ```mermaid
 flowchart TD
 
-root ==> ServersList --> Server --> ServerVariable
+Root ==> ServersList --> Server --> ServerVariable
 
 style ServerVariable fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v2/rules/oas/array-parameter-serialization.md b/docs/@v2/rules/oas/array-parameter-serialization.md
@@ -16,11 +16,11 @@ Enforces the inclusion of `style` and `explode` fields for parameters with array
 ```mermaid
 flowchart TD
 
-root ==> Paths --> PathItem --> Operation --> Parameter --enforces style and explode fields for array types--> Schema
+Root ==> Paths --> PathItem --> Operation --> Parameter --enforces style and explode fields for array types--> Schema
 PathItem --> Parameter
 NamedParameter --> Parameter
 
-root ==> components
+Root ==> components
 
 subgraph components
 NamedParameter
diff --git a/docs/@v2/rules/oas/boolean-parameter-prefixes.md b/docs/@v2/rules/oas/boolean-parameter-prefixes.md
@@ -17,11 +17,11 @@ When this rule is enabled, the `name` fields of all `boolean` parameters in your
 ```mermaid
 flowchart TD
 
-root ==> Paths --> PathItem --> Operation --> Parameter --enforces names for boolean types--> Schema
+Root ==> Paths --> PathItem --> Operation --> Parameter --enforces names for boolean types--> Schema
 PathItem --> Parameter
 NamedParameter --> Parameter
 
-root ==> components
+Root ==> components
 
 subgraph components
 NamedParameter
diff --git a/docs/@v2/rules/oas/info-license-strict.md b/docs/@v2/rules/oas/info-license-strict.md
@@ -16,7 +16,7 @@ Requires either the license URL or identifier in your API descriptions.
 ```mermaid
 flowchart TD
 
-root ==> Info --> License --> url
+Root ==> Info --> License --> url
                   License --> identifier
 
 style url fill:#codaf9,stroke:#0044d4,stroke-width:5px
diff --git a/docs/@v2/rules/oas/info-license.md b/docs/@v2/rules/oas/info-license.md
@@ -16,7 +16,7 @@ Requires the license info in your API descriptions.
 ```mermaid
 flowchart TD
 
-root ==> Info --> License
+Root ==> Info --> License
 
 style License fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v2/rules/oas/no-ambiguous-paths.md b/docs/@v2/rules/oas/no-ambiguous-paths.md
@@ -29,9 +29,9 @@ According to the OpenAPI specification:
 ```mermaid
 flowchart TD
 
-root ==> Paths
+Root ==> Paths
 
-root ==> components
+Root ==> components
 
 style Paths fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v2/rules/oas/no-empty-servers.md b/docs/@v2/rules/oas/no-empty-servers.md
@@ -16,7 +16,7 @@ Requires the `servers` list is defined in your API.
 ```mermaid
 flowchart TD
 
-root ==> ServersList
+Root ==> ServersList
 
 style ServersList fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v2/rules/oas/no-invalid-media-type-examples.md b/docs/@v2/rules/oas/no-invalid-media-type-examples.md
@@ -16,10 +16,10 @@ Disallow invalid media type examples by ensuring they comply with the correspond
 ```mermaid
 flowchart TD
 
-root ==> Paths --> PathItem --> Operation --> MediaType --> Example
+Root ==> Paths --> PathItem --> Operation --> MediaType --> Example
 MediaType --> Examples --> Example
 
-root ==> components
+Root ==> components
 
 NamedExamples --> Example
 
@@ -28,7 +28,6 @@ NamedExamples
 end
 
 style Example fill:#codaf9,stroke:#0044d4,stroke-width:5px
-style NamedExamples fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
 
 ## API design principles
diff --git a/docs/@v2/rules/oas/no-server-example-com.md b/docs/@v2/rules/oas/no-server-example-com.md
@@ -17,7 +17,7 @@ The rule checks for all URL schemes (`http`, `https`...).
 ```mermaid
 flowchart TD
 
-root ==> ServersList
+Root ==> ServersList
 
 style ServersList fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v2/rules/oas/no-server-trailing-slash.md b/docs/@v2/rules/oas/no-server-trailing-slash.md
@@ -16,7 +16,7 @@ Disallow servers with a trailing slash.
 ```mermaid
 flowchart TD
 
-root ==> ServersList
+Root ==> ServersList
 
 style ServersList fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v2/rules/oas/no-server-variables-empty-enum.md b/docs/@v2/rules/oas/no-server-variables-empty-enum.md
@@ -16,7 +16,7 @@ Disallow server variables without enum list defined.
 ```mermaid
 flowchart TD
 
-root ==> ServersList --> Server --> ServerVariables
+Root ==> ServersList --> Server --> ServerVariables
 
 style ServerVariables fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v2/rules/oas/no-undefined-server-variable.md b/docs/@v2/rules/oas/no-undefined-server-variable.md
@@ -16,7 +16,7 @@ Disallow undefined server variables.
 ```mermaid
 flowchart TD
 
-root ==> ServersList --> Server --> ServerVariable
+Root ==> ServersList --> Server --> ServerVariable
 
 style ServerVariable fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
diff --git a/docs/@v2/rules/oas/spec-discriminator-defaultMapping.md b/docs/@v2/rules/oas/spec-discriminator-defaultMapping.md
@@ -95,7 +95,7 @@ components:
 
 - [struct](../common/struct.md)
 - [spec-example-values](./spec-example-values.md)
-- [no-invalid-encoding-combinations](./no-invalid-encoding-combinations.md)
+- [spec-no-invalid-encoding-combinations](./spec-no-invalid-encoding-combinations.md)
 - [spec-no-invalid-tag-parents](./spec-no-invalid-tag-parents.md)
 
 ## Resources
diff --git a/docs/@v2/rules/oas/spec-example-values.md b/docs/@v2/rules/oas/spec-example-values.md
@@ -16,18 +16,13 @@ Ensures that example objects have valid field combinations according to the Open
 ```mermaid
 flowchart TD
 
-Root ==> Paths --> PathItem --> Operation --> Parameter --> MediaType
-PathItem --> Parameter
-Operation --> RequestBody --> MediaType --> Example
-Operation --> Responses --> MediaType
-MediaType --> Schema --> Example
-NamedExamples --> Example
-NamedSchemas --> Schema
+Root ==> Paths --> PathItem --> Operation --> MediaType --> Example
+MediaType --> Examples --> Example
 Root ==> components
+NamedExamples --> Example
 
 subgraph components
 NamedExamples
-NamedSchemas
 end
 
 style Example fill:#codaf9,stroke:#0044d4,stroke-width:5px
@@ -64,53 +59,41 @@ Example of **incorrect** example objects:
 
 ```yaml Bad example
 components:
-  schemas:
-    User:
-      type: object
-      properties:
-        name:
-          type: string
-      examples:
-        invalid-data-value-and-value:
-          dataValue:
-            name: "John Doe"
-          value:
-            name: "Jane Doe"
-        invalid-serialized-value-and-value:
-          serializedValue: '{"name":"John Doe"}'
-          value:
-            name: "Jane Doe"
-        invalid-external-value-and-value:
-          externalValue: "https://example.com/user-example.json"
-          value:
-            name: "Jane Doe"
+  examples:
+    InvalidDataValueAndValue:
+      dataValue:
+        name: "John Doe"
+      value:
+        name: "Jane Doe"
+    InvalidSerializedValueAndValue:
+      serializedValue: '{"name":"John Doe"}'
+      value:
+        name: "Jane Doe"
+    InvalidExternalValueAndValue:
+      externalValue: "https://example.com/user-example.json"
+      value:
+        name: "Jane Doe"
 ```
 
 Example of **correct** example objects:
 
 ```yaml Good example
 components:
-  schemas:
-    User:
-      type: object
-      properties:
-        name:
-          type: string
-      examples:
-        valid-data-value:
-          dataValue:
-            name: "John Doe"
-        valid-serialized-value:
-          serializedValue: '{"name":"John Doe"}'
-        valid-external-value:
-          externalValue: "https://example.com/user-example.json"
+  examples:
+    ValidDataValue:
+      dataValue:
+        name: "John Doe"
+    ValidSerializedValue:
+      serializedValue: '{"name":"John Doe"}'
+    ValidExternalValue:
+      externalValue: "https://example.com/user-example.json"
 ```
 
 ## Related rules
 
 - [struct](../common/struct.md)
 - [no-example-value-and-externalValue](./no-example-value-and-externalValue.md)
-- [no-invalid-encoding-combinations](./no-invalid-encoding-combinations.md)
+- [spec-no-invalid-encoding-combinations](./spec-no-invalid-encoding-combinations.md)
 - [spec-discriminator-defaultMapping](./spec-discriminator-defaultMapping.md)
 - [spec-no-invalid-tag-parents](./spec-no-invalid-tag-parents.md)
 
diff --git a/docs/@v2/rules/oas/spec-no-invalid-encoding-combinations.md b/docs/@v2/rules/oas/spec-no-invalid-encoding-combinations.md
@@ -1,8 +1,8 @@
 ---
-slug: /docs/cli/rules/oas/no-invalid-encoding-combinations
+slug: /docs/cli/rules/oas/spec-no-invalid-encoding-combinations
 ---
 
-# no-invalid-encoding-combinations
+# spec-no-invalid-encoding-combinations
 
 Ensures that MediaType objects have valid combinations of encoding fields according to the OpenAPI 3.2.0 specification.
 
@@ -16,7 +16,9 @@ Ensures that MediaType objects have valid combinations of encoding fields accord
 ```mermaid
 flowchart TD
 
-Root --> Paths --> PathItem --> Operation --> RequestBody --> MediaType
+Root ==> Paths --> PathItem --> Operation --> Parameter --> MediaType
+PathItem --> Parameter
+Operation --> RequestBody --> MediaType
 Operation --> Responses --> MediaType
 
 style MediaType fill:#codaf9,stroke:#0044d4,stroke-width:5px
@@ -38,7 +40,7 @@ An example configuration:
 
 ```yaml
 rules:
-  no-invalid-encoding-combinations: error
+  spec-no-invalid-encoding-combinations: error
 ```
 
 ## Examples
@@ -47,7 +49,7 @@ Given this configuration:
 
 ```yaml
 rules:
-  no-invalid-encoding-combinations: error
+  spec-no-invalid-encoding-combinations: error
 ```
 
 Example of **incorrect** MediaType objects:
@@ -114,5 +116,5 @@ requestBody:
 
 ## Resources
 
-- [Rule source](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/oas3/no-invalid-encoding-combinations.ts)
+- [Rule source](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/oas3/spec-no-invalid-encoding-combinations.ts)
 - [MediaType object docs](https://redocly.com/docs/openapi-visual-reference/media-type/)
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
diff --git a/packages/core/src/config/__tests__/load.test.ts b/packages/core/src/config/__tests__/load.test.ts
diff --git a/packages/core/src/config/all.ts b/packages/core/src/config/all.ts
diff --git a/packages/core/src/config/minimal.ts b/packages/core/src/config/minimal.ts
diff --git a/packages/core/src/config/recommended-strict.ts b/packages/core/src/config/recommended-strict.ts
diff --git a/packages/core/src/config/recommended.ts b/packages/core/src/config/recommended.ts
diff --git a/packages/core/src/config/spec.ts b/packages/core/src/config/spec.ts
diff --git a/packages/core/src/config/types.ts b/packages/core/src/config/types.ts
diff --git a/packages/core/src/rules/oas3/__tests__/spec-no-invalid-encoding-combinations.test.ts b/packages/core/src/rules/oas3/__tests__/spec-no-invalid-encoding-combinations.test.ts
diff --git a/packages/core/src/rules/oas3/index.ts b/packages/core/src/rules/oas3/index.ts
diff --git a/packages/core/src/rules/oas3/spec-no-invalid-encoding-combinations.ts b/packages/core/src/rules/oas3/spec-no-invalid-encoding-combinations.ts
diff --git a/packages/core/src/types/redocly-yaml.ts b/packages/core/src/types/redocly-yaml.ts
