api-quality-spectral-ruleset 1.6.0-beta.1 → 1.6.0

package/apq-spectral.yaml

@@ -53,9 +53,7 @@ functions:
   - apq-wso2-auth-type-required
   - apq-response-content-required
   - apq-tags-consistency
-extends:
-  - spectral:asyncapi
-  - spectral:oas
+  - apq-forbidden-title-pattern
 rules:
   apiq:OAR001:
     description: "For security reasons and as a REST best practice, the HTTPS protocol is mandatory."
@@ -625,8 +623,6 @@ rules:
     message: "OAR048: An operation can have at most one body parameter"
     documentationUrl: "https://github.com/apiaddicts/apquality-spectral/blob/main/docs/resources/OAR048.md"
     severity: error
-    formats:
-      - oas2
     given: "$.paths[*][*]"
     then:
       field: parameters
@@ -854,6 +850,10 @@ rules:
     given:
       - "$.paths[*][*].parameters[*]"
       - "$.paths[*].parameters[*]"
+      - "$.paths[*].additionalOperations[*].parameters[*]"
+      - "$.webhooks[*][*].parameters[*]"
+      - "$.webhooks[*].parameters[*]"
+      - "$.webhooks[*].additionalOperations[*].parameters[*]"
       - "$.components.parameters[*]"
       - "$.parameters[*]"
     then:
@@ -991,6 +991,7 @@ rules:
     description: "The $ref of a request body must end with the suffix Body."
     message: "OAR089: The $ref of a request body must end with the suffix Body."
     severity: "warn"
+    resolved: false
     given: "$..requestBody.$ref"
     then:
       function: pattern
@@ -1214,4 +1215,14 @@ rules:
     then:
       function: apq-path-pattern
       functionOptions:
-        pattern: "^/"
+        pattern: "^/"
+  apiq:OAR117:
+    description: "The API title must not match the configured forbidden regular expression."
+    message: "{{error}}"
+    documentationUrl: "https://github.com/apiaddicts/apquality-spectral/blob/main/docs/resources/OAR117.md"
+    severity: error
+    given: "$.info.title"
+    then:
+      function: apq-forbidden-title-pattern
+      functionOptions:
+        forbidden-pattern: "(?!)"

package/functions/apq-forbidden-title-pattern.js

@@ -0,0 +1,61 @@
+const INLINE_FLAGS_REGEX = /^\(\?([a-zA-Z]+)\)/;
+const SUPPORTED_INLINE_FLAGS = 'imsu';
+
+/**
+ * @param {string} pattern configured regular expression
+ * @returns {RegExp|null} the matcher, or null when the pattern is empty or not valid
+ */
+function buildRegex(pattern) {
+  let source = pattern;
+  let flags = '';
+
+  const inline = INLINE_FLAGS_REGEX.exec(source);
+  if (inline) {
+    const requested = inline[1].toLowerCase();
+    if ([...requested].every((flag) => SUPPORTED_INLINE_FLAGS.includes(flag))) {
+      flags = [...new Set(requested)].join('');
+      source = source.slice(inline[0].length);
+    }
+  }
+
+  if (source === '') {
+    return null;
+  }
+
+  try {
+    return new RegExp(source, flags);
+  } catch (e) {
+    return null;
+  }
+}
+
+/**
+ * @param {unknown} targetVal value of `info.title`
+ * @param {object} options
+ * @param {string} options['forbidden-pattern'] regular expression that raises an issue when it
+ *   matches the title
+ * @param {import('@stoplight/spectral-core').RulesetFunctionContext} context
+ * @returns {Array<{message: string, path: Array}>}
+ */
+module.exports = (targetVal, options, context) => {
+  if (typeof targetVal !== 'string') {
+    return [];
+  }
+
+  const patternStr = options && options['forbidden-pattern'];
+  if (typeof patternStr !== 'string' || patternStr === '') {
+    return [];
+  }
+
+  const regex = buildRegex(patternStr);
+  if (regex === null || !regex.test(targetVal)) {
+    return [];
+  }
+
+  return [
+    {
+      message: `OAR117: Title '${targetVal}' matches the forbidden pattern: ${patternStr}`,
+      path: (context && context.path) || []
+    }
+  ];
+};

package/functions/apq-string-parameter-integrity.js

@@ -1,9 +1,17 @@
 const DEFAULT_INTEGRITY = 'minLength,maxLength,pattern,enum';
 
+const SELF_CONSTRAINED_FORMATS = new Set([
+  'date', 'date-time', 'uuid', 'ipv4', 'ipv6',
+]);
+
 function isStringType(type) {
   return type === 'string' || (Array.isArray(type) && type.indexOf('string') > -1);
 }
 
+function hasSelfConstrainedFormat(format) {
+  return typeof format === 'string' && SELF_CONSTRAINED_FORMATS.has(format.trim().toLowerCase());
+}
+
 /**
  * @param {object} targetVal a Parameter Object
  * @param {object} options
@@ -20,6 +28,8 @@ module.exports = (targetVal, options, context) => {
 
   if (!isStringType(container.type)) return [];
 
+  if (hasSelfConstrainedFormat(container.format)) return [];
+
   const raw = options && options.parameter_integrity !== undefined && options.parameter_integrity !== null
     ? String(options.parameter_integrity)
     : DEFAULT_INTEGRITY;

package/package.json

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