Skip to content

Document assessment API max limit [SA-18726] #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Document assessment API max limit [SA-18726] #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions openapi/components/parameters/limit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

1 change: 1 addition & 0 deletions openapi/paths/assessment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down