docs: document pagination constructor parameters
Build and Analyse / build-and-analyse (push) Successful in 1m22s
Build and Analyse / build-and-analyse (push) Successful in 1m22s
Co-authored-by: Junie <junie@jetbrains.com>
This commit is contained in:
1 parent
4b1a32b1bf
commit
af04a484a1
1 file changed
+7
-1
@@ -27,7 +27,13 @@ public record PagingRequest(int page, int perPage) {
|
||||
/** Maximum number of zones allowed per page by Cloudflare. */
|
||||
public static final int MAX_ZONES_PER_PAGE = 50;
|
||||
|
||||
/** Validates the page number and page size. */
|
||||
/**
|
||||
* Validates the page number and page size.
|
||||
*
|
||||
* @param page the 1-based page number
|
||||
* @param perPage the number of items per page, from 1 to {@value #MAX_RECORDS_PER_PAGE}
|
||||
* @throws IllegalArgumentException if either value is outside its allowed range
|
||||
*/
|
||||
public PagingRequest {
|
||||
if (page < 1) {
|
||||
throw new IllegalArgumentException("page must be at least 1, but was " + page);
|
||||
|
||||
Reference in new issue
Block a user