feat: enable schema-related rules for AsyncAPI and Arazzo (#2183)

Author: tatomyr

.changeset/tough-keys-compare.md

@@ -0,0 +1,13 @@
+---
+"@redocly/openapi-core": minor
+"@redocly/cli": minor
+---
+
+Enabled `no-required-schema-properties-undefined`, `no-schema-type-mismatch`, and `no-enum-type-mismatch` rules for **AsyncAPI** and **Arazzo** specifications.
+Adjusted the rules' severities in the `recommended` and `minimal` rulesets. Refer to the following table:
+
+| Rule \ Ruleset                          | recommended       | minimal         |
+| --------------------------------------- | ----------------- | --------------- |
+| no-required-schema-properties-undefined | `off` -> `warn`   | `off` -> `warn` |
+| no-enum-type-mismatch                   | `error`           | `warn`          |
+| no-schema-type-mismatch                 | `warn` -> `error` | `off` -> `warn` |

docs/@v2/rules/built-in-rules.md

@@ -78,12 +78,12 @@ The rules list is split into sections.
 ### Requests, Responses, and Schemas
 
 - [component-name-unique](./oas/component-name-unique.md): Check for schema-wide unqiue naming of parameters, schemas, request bodies and responses
-- [no-enum-type-mismatch](./oas/no-enum-type-mismatch.md): Enum options must match the data type declared in the schema
+- [no-enum-type-mismatch](./common/no-enum-type-mismatch.md): Enum options must match the data type declared in the schema
 - [no-example-value-and-externalValue](./oas/no-example-value-and-externalValue.md): Either the `value` or `externalValue` may be present, but not both
 - [no-invalid-media-type-examples](./oas/no-invalid-media-type-examples.md): Example request bodies must match the declared schema
 - [no-invalid-schema-examples](./oas/no-invalid-schema-examples.md): Schema examples must match declared types
-- [no-required-schema-properties-undefined](./oas/no-required-schema-properties-undefined.md): All properties marked as required must be defined
-- [no-schema-type-mismatch](./oas/no-schema-type-mismatch.md): Detects schemas with type mismatches between object and items fields, and array and properties fields.
+- [no-required-schema-properties-undefined](./common/no-required-schema-properties-undefined.md): All properties marked as required must be defined
+- [no-schema-type-mismatch](./common/no-schema-type-mismatch.md): Detects schemas with type mismatches between object and items fields, and array and properties fields.
 - [request-mime-type](./oas/request-mime-type.md): Configure allowed mime types for requests
 - [response-mime-type](./oas/response-mime-type.md): Configure allowed mime types for responses
 - [response-contains-header](./oas/response-contains-header.md): List headers that must be included with specific response types

…s/@v2/rules/oas/no-enum-type-mismatch.md …v2/rules/common/no-enum-type-mismatch.mddocs/@v2/rules/oas/no-enum-type-mismatch.md renamed to docs/@v2/rules/common/no-enum-type-mismatch.md docs/@v2/rules/oas/no-enum-type-mismatch.md renamed to docs/@v2/rules/common/no-enum-type-mismatch.md

@@ -1,5 +1,7 @@
 ---
-slug: /docs/cli/v2/rules/oas/no-enum-type-mismatch
+slug: 
+- /docs/cli/v2/rules/common/no-enum-type-mismatch
+- /docs/cli/v2/rules/oas/no-enum-type-mismatch
 ---
 
 # no-enum-type-mismatch
@@ -31,6 +33,15 @@ end
 style Schema fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
 
+| AsyncAPI | Compatibility |
+| -------- | ------------- |
+| 2.6      | ✅            |
+| 3.0      | ✅            |
+
+| Arazzo | Compatibility |
+| ------ | ------------- |
+| 1.0    | ✅            |
+
 ## API design principles
 
 If a property is defined for a certain type, then its corresponding `enum` values should comply with that type.
@@ -86,10 +97,12 @@ properties:
 
 ## Related rules
 
+- [no-schema-type-mismatch](./no-schema-type-mismatch.md)
+- [no-required-schema-properties-undefined](./no-required-schema-properties-undefined.md)
 - [configurable rules](../configurable-rules.md)
-- [no-invalid-media-type-examples](./no-invalid-media-type-examples.md)
-- [no-invalid-parameter-examples](./no-invalid-parameter-examples.md)
-- [no-invalid-schema-examples](./no-invalid-schema-examples.md)
+- [no-invalid-media-type-examples](../oas/no-invalid-media-type-examples.md)
+- [no-invalid-parameter-examples](../oas/no-invalid-parameter-examples.md)
+- [no-invalid-schema-examples](../oas/no-invalid-schema-examples.md)
 
 ## Resources
 

…-required-schema-properties-undefined.md …-required-schema-properties-undefined.mddocs/@v2/rules/oas/no-required-schema-properties-undefined.md renamed to docs/@v2/rules/common/no-required-schema-properties-undefined.md docs/@v2/rules/oas/no-required-schema-properties-undefined.md renamed to docs/@v2/rules/common/no-required-schema-properties-undefined.md

@@ -1,5 +1,7 @@
 ---
-slug: /docs/cli/v2/rules/oas/no-required-schema-properties-undefined
+slug: 
+- /docs/cli/v2/rules/common/no-required-schema-properties-undefined
+- /docs/cli/v2/rules/oas/no-required-schema-properties-undefined
 ---
 
 # no-required-schema-properties-undefined
@@ -12,6 +14,11 @@ Ensures there are no required schema properties that are undefined.
 | 3.0 | ✅            |
 | 3.1 | ✅            |
 
+| AsyncAPI | Compatibility |
+| -------- | ------------- |
+| 2.6      | ✅            |
+| 3.0      | ✅            |
+
 ```mermaid
 flowchart TD
 
@@ -20,15 +27,19 @@ Root ==> Components ==> Schemas
 style Schemas fill:#codaf9,stroke:#0044d4,stroke-width:5px
 ```
 
+| Arazzo | Compatibility |
+| ------ | ------------- |
+| 1.0    | ✅            |
+
 ## API design principles
 
 If a required schema property is declared but not defined, this rule informs you which of the required schema properties are missing.
 
 ## Configuration
 
-| Option   | Type   | Description                                                                              |
-| -------- | ------ | ---------------------------------------------------------------------------------------- |
-| severity | string | Possible values: `off`, `warn`, `error`. Default `off` (in `recommended` configuration). |
+| Option   | Type   | Description                                                                               |
+| -------- | ------ | ----------------------------------------------------------------------------------------- |
+| severity | string | Possible values: `off`, `warn`, `error`. Default `warn` (in `recommended` configuration). |
 
 An example configuration:
 
@@ -100,7 +111,9 @@ schemas:
 
 ## Related rules
 
-- [no-invalid-schema-examples](./no-invalid-schema-examples.md)
+- [no-schema-type-mismatch](./no-schema-type-mismatch.md)
+- [no-enum-type-mismatch](./no-enum-type-mismatch.md)
+- [no-invalid-schema-examples](../oas/no-invalid-schema-examples.md)
 
 ## Resources
 

…@v2/rules/oas/no-schema-type-mismatch.md …/rules/common/no-schema-type-mismatch.mddocs/@v2/rules/oas/no-schema-type-mismatch.md renamed to docs/@v2/rules/common/no-schema-type-mismatch.md docs/@v2/rules/oas/no-schema-type-mismatch.md renamed to docs/@v2/rules/common/no-schema-type-mismatch.md

@@ -1,5 +1,7 @@
 ---
-slug: /docs/cli/v2/rules/oas/no-schema-type-mismatch
+slug: 
+- /docs/cli/v2/rules/common/no-schema-type-mismatch
+- /docs/cli/v2/rules/oas/no-schema-type-mismatch
 ---
 
 # no-schema-type-mismatch
@@ -15,6 +17,15 @@ Ensures that a schema's structural properties match its declared `type`. In part
 | 3.0 | ✅            |
 | 3.1 | ✅            |
 
+| AsyncAPI | Compatibility |
+| -------- | ------------- |
+| 2.6      | ✅            |
+| 3.0      | ✅            |
+
+| Arazzo | Compatibility |
+| ------ | ------------- |
+| 1.0    | ✅            |
+
 ```mermaid
 flowchart TD
   Schema -->|if type is object| CheckItems["'items' field exists?"]
@@ -102,10 +113,12 @@ properties:
 
 ## Related rules
 
+- [no-enum-type-mismatch](./no-enum-type-mismatch.md)
+- [no-required-schema-properties-undefined](./no-required-schema-properties-undefined.md)
 - [configurable rules](../configurable-rules.md)
-- [no-invalid-media-type-examples](./no-invalid-media-type-examples.md)
-- [no-invalid-parameter-examples](./no-invalid-parameter-examples.md)
-- [no-invalid-schema-examples](./no-invalid-schema-examples.md)
+- [no-invalid-media-type-examples](../oas/no-invalid-media-type-examples.md)
+- [no-invalid-parameter-examples](../oas/no-invalid-parameter-examples.md)
+- [no-invalid-schema-examples](../oas/no-invalid-schema-examples.md)
 
 ## Resources
 

docs/@v2/rules/minimal.md

@@ -20,7 +20,9 @@ Warnings:
 - [configurable rules](./configurable-rules.md)
 - [no-ambiguous-paths](./oas/no-ambiguous-paths.md)
 - [no-empty-servers](./oas/no-empty-servers.md)
-- [no-enum-type-mismatch](./oas/no-enum-type-mismatch.md)
+- [no-enum-type-mismatch](./common/no-enum-type-mismatch.md)
+- [no-required-schema-properties-undefined](./common/no-required-schema-properties-undefined.md)
+- [no-schema-type-mismatch](./common/no-schema-type-mismatch.md)
 - [no-example-value-and-externalValue](./oas/no-example-value-and-externalValue.md)
 - [no-identical-paths](./oas/no-identical-paths.md)
 - [no-invalid-media-type-examples](./oas/no-invalid-media-type-examples.md)

docs/@v2/rules/oas/no-invalid-media-type-examples.md

@@ -150,7 +150,7 @@ post:
 
 - [no-invalid-parameter-examples](./no-invalid-parameter-examples.md)
 - [no-invalid-schema-examples](./no-invalid-schema-examples.md)
-- [no-enum-type-mismatch](./no-enum-type-mismatch.md)
+- [no-enum-type-mismatch](../common/no-enum-type-mismatch.md)
 
 ## Resources
 

docs/@v2/rules/recommended.md

@@ -9,7 +9,8 @@ These are the rules in the `recommended` set, grouped by their severity.
 Errors:
 
 - [no-empty-servers](./oas/no-empty-servers.md)
-- [no-enum-type-mismatch](./oas/no-enum-type-mismatch.md)
+- [no-enum-type-mismatch](./common/no-enum-type-mismatch.md)
+- [no-schema-type-mismatch](./common/no-schema-type-mismatch.md)
 - [no-example-value-and-externalValue](./oas/no-example-value-and-externalValue.md)
 - [no-identical-paths](./oas/no-identical-paths.md)
 - [no-path-trailing-slash](./oas/no-path-trailing-slash.md)
@@ -42,6 +43,7 @@ Warnings:
 - [info-license-strict](./oas/info-license-strict.md)
 - [no-ambiguous-paths](./oas/no-ambiguous-paths.md)
 - [no-invalid-media-type-examples](./oas/no-invalid-media-type-examples.md)
+- [no-required-schema-properties-undefined](./common/no-required-schema-properties-undefined.md)
 - [no-server-example.com](./oas/no-server-example-com.md)
 - [no-unused-components](./oas/no-unused-components.md)
 - [operation-2xx-response](./oas/operation-2xx-response.md)