Merge pull request #337 from ravindrapalaskar17/Update-Spectral-rule

Update spectral rule to handle null values error in example fields

artifacts/linting_rules/.spectral.yml

@@ -3,6 +3,7 @@
 # Changelog:
 # - 31.01.2024: Initial version
 # - 19.03.2024: Corrected camara-http-methods rule
+# - 03.12.2024: Corrected camara-path-param-id and camara-discriminator-use to handle null values error in example fields
 
 
 extends: "spectral:oas"
@@ -84,12 +85,12 @@ rules:
     description: |
       This rule ensures consistent and descriptive naming for path parameters in your OpenAPI specification.
       Please use 'resource_id' instead of just 'id' for your path parameters.
-    given: "$..parameters[?(@.in == 'path')]"
+    given: "$.paths[*][*].parameters[?(@.in == 'path')].name"
     then:
       field: name
       function: pattern
       functionOptions:
-        notMatch: \b(id|Id|ID|iD)\b
+        match: "^(?!.*\\b(id|Id|ID|iD)\\b).*$"
     recommended: true  # Set to true/false to enable/disable this rule
 
   camara-security-no-secrets-in-path-or-query-parameters:
@@ -219,11 +220,17 @@ rules:
     description: |
       Ensure that API definition YAML files with oneOf or anyOf sections include a discriminator object for serialization, deserialization, and validation.
     severity: hint
-    given: "$..[?(@.oneOf || @.anyOf)]"
+    given: "$.components.schemas[*]"
     then:
-      field: discriminator
-      function: truthy
-      description: "Discriminator object is required when using oneOf or anyOf."
+      - field: oneOf
+        function: truthy
+        message: "Schemas with 'oneOf' should include a 'discriminator' for type identification."
+      - field: anyOf
+        function: truthy
+        message: "Schemas with 'anyOf' should include a 'discriminator' for type identification."
+      - field: discriminator
+        function: truthy
+        message: "A 'discriminator' object is required when using 'oneOf' or 'anyOf'."
     recommended: true  # Set to true/false to enable/disable this rule
 
   camara-operationid-casing-convention: