api-quality-spectral-ruleset 1.3.0-beta.2 → 1.3.0-beta.3

package/apq-spectral.yaml

@@ -67,7 +67,7 @@ rules:
     then:
       function: "pattern"
       functionOptions:
-        match: "^[A-Za-z0-9_]+$"
+        match: "^[a-zA-Z0-9_\\-., ]+$"
   apiq:OAR005:
     description: "A wrong scope may cause problems to import the API definition into WSO2 or allow all users to call the endpoint."
     message: "OAR005: Scope in the operation must be defined correctly and match an existing scope."
@@ -106,9 +106,9 @@ rules:
     message: "OAR008: Only the REST standard verbs are allowed (POST, GET, PUT, PATCH and DELETE)."
     documentationUrl: "https://github.com/apiaddicts/apquality-spectral/blob/main/docs/resources/OAR008.md"
     severity: error
-    given: "$.paths[*][?(@property == 'get' || @property == 'post' || @property == 'put' || @property == 'delete' || @property == 'patch')]"
+    given: "$.paths[*][head,options,trace]"
     then:
-      function: truthy
+      function: falsy
   apiq:OAR009:
     description: "Default request media type should be defined for operations."
     message: "OAR009: Default request media type is mandatory."

package/functions/apq-validate-structure.js

@@ -6,8 +6,14 @@
 module.exports = (given, options, context) => {
   if (given === null || given === undefined) return [];
 
-  const VALID_IN_VALUES = ['query', 'header', 'path', 'cookie', 'body', 'formData'];
-  const VALID_SCHEMA_TYPES = ['string', 'number', 'integer', 'boolean', 'array', 'object', 'null'];
+  const doc = context.document?.data ?? {};
+  const isOAP2 = typeof doc.swagger === 'string';
+
+  const VALID_IN_VALUES_OAP2 = ['query', 'header', 'path', 'formData', 'body'];
+  const VALID_IN_VALUES_OAP3 = ['path', 'query', 'header', 'cookie'];
+  const VALID_IN_VALUES = isOAP2 ? VALID_IN_VALUES_OAP2 : VALID_IN_VALUES_OAP3;
+
+  const VALID_SCHEMA_TYPES = ['object', 'string', 'number', 'integer', 'boolean', 'array', 'null'];
 
   const nodePath = context.path || [];
   const fieldName = nodePath[nodePath.length - 1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-quality-spectral-ruleset",
-  "version": "1.3.0-beta.2",
+  "version": "1.3.0-beta.3",
   "description": "Spectral ruleset by API Quality",
   "main": "apq-spectral.yaml",
   "files": [