Link totalRecords documentation. Explain limit=0.

folio-org · Oct 4, 2024 · d8be631 · d8be631
1 parent c113f10
commit d8be631
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/schemas/resultInfo.schema b/schemas/resultInfo.schema
@@ -6,7 +6,7 @@
   "properties": {
     "totalRecords": {
       "type": "integer",
-      "description": "Estimated or exact total number of records"
+      "description": "Estimated or exact total number of records. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords"
     },
     "totalRecordsEstimated": {
       "type": "boolean",

diff --git a/traits/pageable.raml b/traits/pageable.raml
@@ -16,7 +16,7 @@
           minimum: 0
           maximum: 2147483647
         limit:
-          description: Limit the number of elements returned in the response
+          description: Limit the number of elements returned in the response. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
           type: integer
           required: false
           example: 10