CLOUDP-304938: Clarify pagination

Author: lovisaberggren

tools/spectral/ipa/rulesets/IPA-105.yaml

@@ -41,6 +41,7 @@ rules:
         - Validation applies to List methods for resource collections only
         - Validation applies to json response content only
         - Validation ignores responses without schema and non-paginated responses
+          - A response is considered paginated if it contains an array property named `results`
         - Validation ignores resources without a Get method
         - Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
     message: '{{error}} http://go/ipa-spectral#IPA-105'

tools/spectral/ipa/rulesets/README.md

@@ -117,6 +117,7 @@ Validation checks that the List method response contains items property with ref
   - Validation applies to List methods for resource collections only
   - Validation applies to json response content only
   - Validation ignores responses without schema and non-paginated responses
+    - A response is considered paginated if it contains an array property named `results`
   - Validation ignores resources without a Get method
   - Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
 

tools/spectral/ipa/rulesets/functions/utils/schemaUtils.js

@@ -5,7 +5,11 @@
  */
 export function schemaIsPaginated(schema) {
   const fields = Object.keys(schema);
-  return fields.includes('properties') && Object.keys(schema['properties']).includes('results');
+  return (
+    fields.includes('properties') &&
+    Object.keys(schema['properties']).includes('results') &&
+    schema.properties.results.type === 'array'
+  );
 }
 
 /**