docs change

Author: yelizhenden-mdb

tools/spectral/ipa/__tests__/IPA110CollectionsUsePaginatedSchema.test.js

@@ -2,37 +2,37 @@ import testRule from './__helpers__/testRule';
 import { DiagnosticSeverity } from '@stoplight/types';
 
 const componentSchemas = {
-    Resource: {
-      type: 'object',
-    },
-    PaginatedResourceList: {
-      type: 'object',
-      properties: {
-        totalCount: {
-          type: 'integer',
-        },
-        results: {
-          type: 'array',
-          items: {
-            $ref: '#/components/schemas/Resource',
-          },
+  Resource: {
+    type: 'object',
+  },
+  PaginatedResourceList: {
+    type: 'object',
+    properties: {
+      totalCount: {
+        type: 'integer',
+      },
+      results: {
+        type: 'array',
+        items: {
+          $ref: '#/components/schemas/Resource',
         },
       },
     },
-    ResourceList: {
-      type: 'object',
-      properties: {
-        totalCount: {
-          type: 'integer',
-        },
-        results: {
-          type: 'array',
-          items: {
-            $ref: '#/components/schemas/Resource',
-          },
+  },
+  ResourceList: {
+    type: 'object',
+    properties: {
+      totalCount: {
+        type: 'integer',
+      },
+      results: {
+        type: 'array',
+        items: {
+          $ref: '#/components/schemas/Resource',
         },
       },
     },
+  },
   NonPaginatedList: {
     type: 'object',
     properties: {
@@ -86,7 +86,7 @@ testRule('xgen-IPA-110-collections-use-paginated-schema', [
         },
       },
       components: {
-        schemas: componentSchemas
+        schemas: componentSchemas,
       },
     },
     errors: [],
@@ -115,7 +115,7 @@ testRule('xgen-IPA-110-collections-use-paginated-schema', [
         },
       },
       components: {
-        schemas: componentSchemas
+        schemas: componentSchemas,
       },
     },
     errors: [],
@@ -144,8 +144,8 @@ testRule('xgen-IPA-110-collections-use-paginated-schema', [
         },
       },
       components: {
-        schemas : componentSchemas,
-      }
+        schemas: componentSchemas,
+      },
     },
     errors: [
       {
@@ -194,7 +194,7 @@ testRule('xgen-IPA-110-collections-use-paginated-schema', [
               },
             },
           },
-        }
+        },
       },
     },
     errors: [
@@ -288,7 +288,7 @@ testRule('xgen-IPA-110-collections-use-paginated-schema', [
         },
       },
       components: {
-        schemas: componentSchemas
+        schemas: componentSchemas,
       },
     },
     errors: [
@@ -328,7 +328,7 @@ testRule('xgen-IPA-110-collections-use-paginated-schema', [
         },
       },
       components: {
-        schemas: componentSchemas
+        schemas: componentSchemas,
       },
     },
     errors: [],

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

@@ -12,7 +12,8 @@ rules:
       ##### Implementation details
       Rule checks for the following conditions:
         - Only applies to List methods (GET operations that return collections of resources)
-        - Checks that the 200 response schema references a schema with a name starting with "Paginated"
+        - Checks that the 200 response schema references a schema with a name starting with either a name starting with "Paginated" or contain both "totalCount" (integer) and "results" (array) fields
+        - If the referenced schema name has "Paginated" prefix, the rule assumes that the schema is paginated and does not check for "totalCount" and "results" fields
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-110-list-methods-must-use-paginated-schema'
     severity: warn
     given: '$.paths[*].get.responses.200.content'

tools/spectral/ipa/rulesets/README.md

@@ -459,7 +459,8 @@ APIs that return collections of resources must use a paginated response schema.
 ##### Implementation details
 Rule checks for the following conditions:
   - Only applies to List methods (GET operations that return collections of resources)
-  - Checks that the 200 response schema references a schema with a name starting with "Paginated"
+  - Checks that the 200 response schema references a schema with a name starting with either a name starting with "Paginated" or contain both "totalCount" (integer) and "results" (array) fields
+  - If the referenced schema name has "Paginated" prefix, the rule assumes that the schema is paginated and does not check for "totalCount" and "results" fields