[
https://issues.apache.org/jira/browse/FINERACT-1588?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18053523#comment-18053523
]
Vladyslav Samchenko edited comment on FINERACT-1588 at 1/22/26 11:07 AM:
-------------------------------------------------------------------------
If I understand the task correctly, we are expected to change only how the
*{{{}POST /clients/{clientId{}}}}* endpoint is displayed in Swagger, without
making any changes to the API logic.
However, this is not feasible. I researched the OpenAPI specification and found
the following clarification in the documentation:
[https://swagger.io/docs/specification/v3_0/paths-and-operations/]
{quote}OpenAPI defines a unique operation as a combination of a path and an
HTTP method. This means that two GET or two POST methods for the same path are
not allowed – even if they have different parameters (parameters have no effect
on uniqueness).
{quote}
As a result, we have only two options:
* Change the API design and create a separate endpoint for each command, or
* Keep the Swagger definition as it is today.
!image-2026-01-22-13-06-04-048.png!
was (Author: JIRAUSER312207):
If I understand the task correctly, we are expected to change only how the
{{POST /clients/\{clientId}}} endpoint is displayed in Swagger, without making
any changes to the API logic.
However, this is not feasible. I researched the OpenAPI specification and found
the following clarification in the documentation:
[https://swagger.io/docs/specification/v3_0/paths-and-operations/]
{quote}OpenAPI defines a unique operation as a combination of a path and an
HTTP method. This means that two GET or two POST methods for the same path are
not allowed – even if they have different parameters (parameters have no effect
on uniqueness).
{quote}
As a result, we have only two options:
* Change the API design and create a separate endpoint for each command, or
* Keep the Swagger definition as it is today.
!image-2026-01-22-13-06-04-048.png!
> Multiple POST Request(s) in Client section [Activate a Client, Reject a
> Client, etc.] shown under single API interface
> ----------------------------------------------------------------------------------------------------------------------
>
> Key: FINERACT-1588
> URL: https://issues.apache.org/jira/browse/FINERACT-1588
> Project: Apache Fineract
> Issue Type: Bug
> Components: SDK
> Affects Versions: 1.5.0, 1.6.0
> Reporter: Ed Cable
> Priority: Major
> Labels: beginner-friendly
> Attachments: Screen Shot 2022-04-18 at 8.55.26 AM.png, Screen Shot
> 2022-04-18 at 8.55.35 AM.png, image-2026-01-22-13-06-04-048.png
>
>
> As reported by [~guptahemant65]
>
> * Link to the API interface -
> [https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Client/activate_1]
> * As you can check from the above link, there are multiple POST Requests in
> the Client Section that are meant for different functionalities but yet shown
> as a single API interface. It will look much better and more understandable
> if each API endpoint is shown as a different API interface.
> * This will also help in building more user-friendly documentation on
> readme.io (Link - https://dash.readme.com/project/mifos/v2.0/refs/activate_1)
> !Screen Shot 2022-04-18 at 8.55.26 AM.png!
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
