From f12f5d6db1f31d16049fee00d7e1719ea22bd640 Mon Sep 17 00:00:00 2001 From: Thilo Schwarz Date: Sun, 25 Jan 2026 18:59:02 +0100 Subject: [PATCH] Update `.gitlab-ci.yml`: Adjust `apidocs` path, and enhance documentation in `ResultInfo` and `CfDnsClientBuilder`. --- .gitlab-ci.yml | 2 +- .../java/codes/thischwa/cf/CfDnsClientBuilder.java | 4 ++++ .../java/codes/thischwa/cf/model/ResultInfo.java | 13 +++++-------- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index a659b9a..7b3b39c 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -32,7 +32,7 @@ build: - mkdir public - cp -rv docs/* public/ - mkdir public/apidocs - - cp -rv target/apidocs public/ + - cp -rv target/reports/apidocs public/ artifacts: paths: - target/surefire-reports/*.xml diff --git a/src/main/java/codes/thischwa/cf/CfDnsClientBuilder.java b/src/main/java/codes/thischwa/cf/CfDnsClientBuilder.java index 592f35d..bec5da4 100644 --- a/src/main/java/codes/thischwa/cf/CfDnsClientBuilder.java +++ b/src/main/java/codes/thischwa/cf/CfDnsClientBuilder.java @@ -11,7 +11,11 @@ import org.jetbrains.annotations.Nullable; */ public class CfDnsClientBuilder { + /** + * The default base URL for the Cloudflare v4 API requests made by the {@code CfDnsClient}. + */ public static final String DEFAULT_BASEURL = "https://api.cloudflare.com/client/v4"; + private boolean emptyResultThrowsException; private CfAuth auth; diff --git a/src/main/java/codes/thischwa/cf/model/ResultInfo.java b/src/main/java/codes/thischwa/cf/model/ResultInfo.java index 4d16755..6962830 100644 --- a/src/main/java/codes/thischwa/cf/model/ResultInfo.java +++ b/src/main/java/codes/thischwa/cf/model/ResultInfo.java @@ -6,15 +6,12 @@ package codes.thischwa.cf.model; *

This class contains information about the current page, page size, total pages, and result * counts, which can be utilized in managing and navigating through paginated data. * - *

+ * @param page The current page number. + * @param perPage The number of results per page. + * @param totalPages The total number of pages available. + * @param count The number of results on the current page. + * @param totalCount The total number of results across all pages. */ - public record ResultInfo(int page, int perPage, int totalPages, int count, int totalCount) { /**