From d8be631f2cdfc5cb26210df23ddcd46323f94bc9 Mon Sep 17 00:00:00 2001 From: Julian Ladisch Date: Fri, 4 Oct 2024 22:02:30 +0200 Subject: [PATCH] Link totalRecords documentation. Explain limit=0. --- schemas/resultInfo.schema | 2 +- traits/pageable.raml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/schemas/resultInfo.schema b/schemas/resultInfo.schema index d46bbe5..5e35f52 100644 --- 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 index b34dd56..c758391 100644 --- 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