[
https://issues.apache.org/jira/browse/FINERACT-2749?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
elnafateh updated FINERACT-2749:
--------------------------------
Description:
Several list endpoints use a boolean {{paged}} query parameter that changes the
response shape: a plain array when false/omitted, a (totalFilteredRecords,
pageItems) wrapper when true. This makes it impossible to generate an accurate
single OpenAPI schema for these endpoints.
# {{AuditsApiResource}} ({{{}GET /v1/audits{}}})
# {{GroupsApiResource}} ({{{}GET /v1/groups{}}})
# {{CentersApiResource}} ({{{}GET /v1/centers{}}})
# {{FixedDepositAccountsApiResource}} ({{{}GET /v1/fixeddepositaccounts{}}})
# {{RecurringDepositAccountsApiResource}} ({{{}GET
/v1/recurringdepositaccounts{}}})
Introducing v2 endpoints to ensure backward compatibility and always return the
paged shape, following the precedent set by {{ClientSearchV2ApiResource}}
was:
Several list endpoints use a boolean {{paged}} query parameter that changes the
response shape: a plain array when false/omitted, a `totalFilteredRecords,
pageItems` wrapper when true. This makes it impossible to generate an accurate
single OpenAPI schema for these endpoints.
# {{AuditsApiResource}} ({{{}GET /v1/audits{}}})
# {{GroupsApiResource}} ({{{}GET /v1/groups{}}})
# {{CentersApiResource}} ({{{}GET /v1/centers{}}})
# {{FixedDepositAccountsApiResource}} ({{{}GET /v1/fixeddepositaccounts{}}})
# {{RecurringDepositAccountsApiResource}} ({{{}GET
/v1/recurringdepositaccounts{}}})
Introducing v2 endpoints to ensure backward compatibility and always return the
paged shape, following the precedent set by {{`ClientSearchV2ApiResource`}}
> Introduce v2 paginated-only endpoints for resources with ambiguous paged
> response typing
> ----------------------------------------------------------------------------------------
>
> Key: FINERACT-2749
> URL: https://issues.apache.org/jira/browse/FINERACT-2749
> Project: Apache Fineract
> Issue Type: Improvement
> Components: Data Tables, Docs
> Reporter: elnafateh
> Priority: Major
>
> Several list endpoints use a boolean {{paged}} query parameter that changes
> the response shape: a plain array when false/omitted, a
> (totalFilteredRecords, pageItems) wrapper when true. This makes it impossible
> to generate an accurate single OpenAPI schema for these endpoints.
> # {{AuditsApiResource}} ({{{}GET /v1/audits{}}})
> # {{GroupsApiResource}} ({{{}GET /v1/groups{}}})
> # {{CentersApiResource}} ({{{}GET /v1/centers{}}})
> # {{FixedDepositAccountsApiResource}} ({{{}GET /v1/fixeddepositaccounts{}}})
> # {{RecurringDepositAccountsApiResource}} ({{{}GET
> /v1/recurringdepositaccounts{}}})
> Introducing v2 endpoints to ensure backward compatibility and always return
> the paged shape, following the precedent set by {{ClientSearchV2ApiResource}}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
