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

package/apq-spectral.yaml

@@ -16,6 +16,7 @@ functions:
   - apq-custom-field
   - apq-check-examples-coverage
   - apq-path-depth
+  - apq-forbidden-characters
   - apq-path-param-query-conflict
   - apq-security-required-response
   - apq-check-ambiguous-path
@@ -65,9 +66,7 @@ rules:
     severity: "error"
     given: "$.x-wso2-security.apim.x-wso2-scopes[*].roles"
     then:
-      function: "pattern"
-      functionOptions:
-        match: "^[A-Za-z0-9_]+$"
+      function: apq-forbidden-characters
   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 +105,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."
@@ -177,9 +176,11 @@ rules:
     severity: error
     given: "$.paths.*~"
     then:
-      function: pattern
+      function: apq-path-depth
       functionOptions:
-        match: "^\/[^\/]*((\/{[^}]*})*\/[^\/]*(\/{[^}]*})*){0,4}\/?$"
+        maxDepth: 5
+        ignoreSegments:
+          - me
   apiq:OAR016:
     description: "Numeric types requires a valid format."
     message: "OAR016: Numeric types must use a valid format for their type."

package/functions/apq-forbidden-characters.js

@@ -0,0 +1,23 @@
+/**
+ * @param {string|string[]} targetVal
+ * @param {object} options
+ * @param {import('@stoplight/spectral-core').RulesetFunctionContext} context
+ */
+module.exports = (targetVal, _options, context) => {
+  const pattern = /^[a-zA-Z0-9_\-., ]+$/;
+  const errors = [];
+
+  if (typeof targetVal === 'string') {
+    if (!pattern.test(targetVal)) {
+      errors.push({ message: context.rule.message });
+    }
+  } else if (Array.isArray(targetVal)) {
+    targetVal.forEach((role, index) => {
+      if (typeof role === 'string' && !pattern.test(role)) {
+        errors.push({ message: context.rule.message, path: [index] });
+      }
+    });
+  }
+
+  return errors;
+};

package/functions/apq-path-depth.js

@@ -6,14 +6,15 @@
 module.exports = (targetVal, options, context) => {
   const maxDepth = options.maxDepth ?? 3
   const ignore = options.ignoreSegments ?? []
-
   const segments = targetVal
     .split('/')
     .filter(Boolean)
     .filter(segment => !segment.startsWith('{') && !segment.endsWith('}'))
     .filter(segment => !ignore.includes(segment))
 
-  if (segments.length > maxDepth) {
+  const depth = segments.length;
+
+  if (depth > maxDepth) {
     return [
       { message: context.rule.message }
     ]

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.4",
   "description": "Spectral ruleset by API Quality",
   "main": "apq-spectral.yaml",
   "files": [