From 7cd781bd97f38c9f32a73b57ea65213865f1ab7f Mon Sep 17 00:00:00 2001 From: tomcdonnell Date: Tue, 7 Jan 2025 11:24:12 +1100 Subject: [PATCH] Document assessment API max limit [SA-18726] --- openapi/components/parameters/limit.yaml | 3 +++ openapi/paths/assessment.yaml | 1 + 2 files changed, 4 insertions(+) diff --git a/openapi/components/parameters/limit.yaml b/openapi/components/parameters/limit.yaml index 391544ac..b49dc959 100644 --- a/openapi/components/parameters/limit.yaml +++ b/openapi/components/parameters/limit.yaml @@ -12,5 +12,8 @@ schema: Each endpoint whose data accepts a limit will limit their results to that number. + + Note a maximum limit may also apply, depending on the + specific type of request. type: integer diff --git a/openapi/paths/assessment.yaml b/openapi/paths/assessment.yaml index d498230e..1f30b0c4 100644 --- a/openapi/paths/assessment.yaml +++ b/openapi/paths/assessment.yaml @@ -5,6 +5,7 @@ get: description: | This endpoint will return assessments and their results that match the filter provided. The number of assessments returned is 5 by default, if the limit query parameter is not provided. + There is a maximum limit of 500 assessments per request. We strongly recommend the use of due date filters, to ensure you only get relevant assessments from the current period. For example a common request may be to get assessments of work type 'major' that are due in the current year.