docs: update the no-required-schema-properties-undefined rule description (#1446)

2025-12-06 04:21:09 +00:00 · 2024-02-21 13:31:04 +02:00
parent 099455bda0
commit f7331f7832
1 changed files with 26 additions and 13 deletions
--- a/docs/rules/no-required-schema-properties-undefined.md
+++ b/docs/rules/no-required-schema-properties-undefined.md
@@ -53,12 +53,12 @@ schemas:
  Pet:
    type: object
    required:
-        - id
-        - name
+      - id
+      - name
    properties:
-        id:
-          type: integer
-          format: int64
+      id:
+        type: integer
+        format: int64
 ```

 Expected error message when linting incorrect schema example:
@@ -74,15 +74,28 @@ schemas:
  Pet:
    type: object
    required:
-        - id
-        - name
+      - id
+      - name
    properties:
-        id:
-          type: integer
-          format: int64
-        name:
-          type: string
-          example: doggie
+      id:
+        type: integer
+        format: int64
+      name:
+        type: string
+        example: doggie
+```
+
+The rule is case-sensitive, which means a property `name` does not match the string `Name` in the `required` list:
+
+```yaml
+schemas:
+  Pet:
+    type: object
+    properties:
+      name:
+        type: string
+    required:
+      - Name
 ```

 ## Related rules