From af04a484a100bb70acdd4b4a497352331988e5e5 Mon Sep 17 00:00:00 2001 From: Thilo Schwarz Date: Sat, 21 Nov 2026 13:05:45 +0100 Subject: [PATCH] docs: document pagination constructor parameters Co-authored-by: Junie --- src/main/java/codes/thischwa/cf/model/PagingRequest.java | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/main/java/codes/thischwa/cf/model/PagingRequest.java b/src/main/java/codes/thischwa/cf/model/PagingRequest.java index 2295cd5..90db073 100644 --- a/src/main/java/codes/thischwa/cf/model/PagingRequest.java +++ b/src/main/java/codes/thischwa/cf/model/PagingRequest.java @@ -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);