From cca0906c839d107b8e5ac06d1f5f2115bd99bd04 Mon Sep 17 00:00:00 2001 From: Vivek Nigam Date: Fri, 20 Feb 2026 09:41:23 +0530 Subject: [PATCH] docs: add JavaDoc for extractFieldsForResponseIfProvided Adds JavaDoc explaining purpose and usage of extractFieldsForResponseIfProvided method to improve code readability and contributor understanding. --- .../core/api/ApiParameterHelper.java | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/fineract-core/src/main/java/org/apache/fineract/infrastructure/core/api/ApiParameterHelper.java b/fineract-core/src/main/java/org/apache/fineract/infrastructure/core/api/ApiParameterHelper.java index db4d7f060f6..e5d0e7cce3b 100644 --- a/fineract-core/src/main/java/org/apache/fineract/infrastructure/core/api/ApiParameterHelper.java +++ b/fineract-core/src/main/java/org/apache/fineract/infrastructure/core/api/ApiParameterHelper.java @@ -45,6 +45,20 @@ public static Long commandId(final MultivaluedMap queryParams) { return id; } +/** + * Extracts the "fields" query parameter from the API request. + * + * Example: + * GET /clients?fields=id,name,status + * + * Result: + * ["id", "name", "status"] + * + * This is used to limit response payload size and improve performance. + * + * @param queryParams HTTP query parameters + * @return Set of requested response fields, or empty set if none provided + */ public static Set extractFieldsForResponseIfProvided(final MultivaluedMap queryParams) { Set fields = new HashSet<>(); String commaSeparatedParameters = "";