api-quality-spectral-ruleset 1.4.1-beta.4 → 1.4.1

package/apq-spectral.yaml

@@ -338,7 +338,7 @@ rules:
       field: "$[?(@.name == '$start' && @.in == 'query')]"
       function: truthy
   apiq:OAR025:
-    description: "$limit must be defined as a query parameter in the collection GET operations selected by the configured paths."
+    description: "$limit must be defined as an integer query parameter in the collection GET operations selected by the configured paths."
     message: "{{error}}"
     documentationUrl: "https://github.com/apiaddicts/apquality-spectral/blob/main/docs/resources/OAR025.md"
     severity: error

package/functions/apq-collection-query-param-required.js

@@ -22,12 +22,32 @@ const shouldIncludePath = (path, patterns, strategy) => {
   return strategy === STRATEGY_INCLUDE ? matchesList : !matchesList;
 };
 
-const hasQueryParameter = (parameters, parameterName) => Array.isArray(parameters)
-  && parameters.some((p) => p && !p.$ref && p.name === parameterName && p.in === 'query');
+const resolveRef = (ref, context) => {
+  const root = context && context.document && context.document.resolved;
+  if (!root || typeof ref !== 'string' || !ref.startsWith('#/')) return undefined;
+  return ref.replace(/^#\//, '').split('/')
+    .reduce((node, part) => (node == null ? undefined : node[part]), root);
+};
+
+const resolveParam = (p, context) => (p && p.$ref ? resolveRef(p.$ref, context) : p);
+
+const findQueryParameter = (parameters, parameterName, context) => (Array.isArray(parameters)
+  ? parameters
+    .map((p) => resolveParam(p, context))
+    .find((p) => p && p.name === parameterName && p.in === 'query')
+  : undefined);
+
+const getParameterType = (param) => {
+  if (!param) return undefined;
+  if (param.schema && typeof param.schema === 'object') return param.schema.type;
+  return param.type;
+};
 
 const PAGINATED_RESPONSE_CODE = '206';
 const PAGINATED_RULE_CODES = ['OAR022', 'OAR025'];
 
+const REQUIRED_PARAM_TYPES = { OAR025: 'integer' };
+
 const hasResponseCode = (operation, code) => {
   const responses = operation && operation.responses;
   return !!responses && typeof responses === 'object'
@@ -71,11 +91,21 @@ module.exports = (given, options = {}, context) => {
     if (!shouldIncludePath(path, patterns, strategy)) return;
     if (requiresPaginated && !hasResponseCode(getOperation, PAGINATED_RESPONSE_CODE)) return;
 
-    if (!hasQueryParameter(getOperation.parameters, parameterName)) {
+    const param = findQueryParameter(getOperation.parameters, parameterName, context);
+    if (!param) {
       results.push({
         message: `${ruleCode}: ${parameterName} must be defined as a query parameter in this operation.`,
         path: [...context.path, path, 'get'],
       });
+      return;
+    }
+
+    const expectedType = REQUIRED_PARAM_TYPES[ruleCode];
+    if (expectedType && getParameterType(param) !== expectedType) {
+      results.push({
+        message: `${ruleCode}: ${parameterName} must be defined as a query parameter of type ${expectedType} in this operation.`,
+        path: [...context.path, path, 'get'],
+      });
     }
   });
 

package/package.json

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