api-quality-spectral-ruleset 1.4.0-beta.3 → 1.4.0-beta.5

package/apq-spectral.yaml

@@ -528,9 +528,10 @@ rules:
       functionOptions:
         notMatch: "^(Cookie|Set-Cookie)$"
   apiq:OAR037:
-    description: "If a string schema declares a format, it must be a valid format value."
-    message: "OAR037: String schemas must specify a valid format (date, date-time, password, byte, binary, email, uuid, uri, hostname, ipv4, ipv6, HEX, HEX(16), json, xml, or base64)."
+    description: "String schemas must specify a valid format, or a valid pattern when no format is defined."
+    message: "OAR037: String schemas must specify a valid format (date, date-time, password, byte, binary, email, uuid, uri, hostname, ipv4, ipv6, HEX, HEX(16), json, xml, or base64), or a valid pattern when no format is defined."
     severity: error
+    resolved: false
     given: "$..[?(@.type=='string')]"
     then:
       function: apq-schema-format
@@ -621,13 +622,17 @@ rules:
     message: "OAR044: Declared media type range should conform to RFC7231."
     severity: "error"
     given:
-      - "$.paths.*.*.responses.*.content.*~"
-      - "$.paths.*.*.requestBody.content.*~"
+      - "$.paths.*.*.responses[?(@property !== '204')].content.*~"
+      - "$.paths.*[post,put,patch].requestBody.content.*~"
+      - "$.paths.*.*.parameters[*].content.*~"
+      - "$.paths.*.parameters[*].content.*~"
+      - "$.components.responses.*.content.*~"
       - "$.components.requestBodies.*.content.*~"
+      - "$.components.parameters.*.content.*~"
     then:
       function: pattern
       functionOptions:
-        match: "^(\\*|[a-zA-Z0-9][a-zA-Z0-9!#$&\\-^_.+]*)/(\\*|[a-zA-Z0-9][a-zA-Z0-9!#$&\\-^_.+]*)(;\\s*[a-zA-Z0-9]+=[\\w\\-]+)*$"
+        match: "^(\\*|[a-zA-Z0-9.][a-zA-Z0-9.!#$&_^+\\-]+)/(\\*|[a-zA-Z0-9.][a-zA-Z0-9.!#$&_^+\\-]+(; charset=[a-zA-Z0-9_\\-]+)?)$"
   apiq:OAR045:
     description: "Response schema is required for responses with status codes 201 and others that return content."
     message: "OAR045: Response schema is required for status code '{{property}}'."

package/functions/apq-schema-format.js

@@ -4,10 +4,29 @@ const VALID_FORMATS = new Set([
   'json', 'xml', 'base64'
 ]);
 
+function isValidPattern(pattern) {
+  try {
+    new RegExp(pattern);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
 module.exports = (targetVal, _options, context) => {
+  const typePath = [...context.path, 'type'];
   const format = targetVal.format;
-  if (format !== undefined && format !== null && !VALID_FORMATS.has(String(format).toLowerCase())) {
-    return [{ message: context.rule.message }];
+  if (format !== undefined && format !== null) {
+    if (!VALID_FORMATS.has(String(format).toLowerCase())) {
+      return [{ message: context.rule.message, path: typePath }];
+    }
+    return [];
   }
-  return [];
+
+  const pattern = targetVal.pattern;
+  if (pattern !== undefined && pattern !== null && String(pattern).length > 0 && isValidPattern(String(pattern))) {
+    return [];
+  }
+
+  return [{ message: context.rule.message, path: typePath }];
 };

package/package.json

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