[jira] [Commented] (FINERACT-1589) Missing description across multiple API endpoints in Swagger Doc

["Anas Lak (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FINERACT-1589?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18065691#comment-18065691 ] 

Anas Lak commented on FINERACT-1589:
------------------------------------

[~adamsaghy] I would like to write descriptions for some of these. But I assume some endpoints are less straightforward than others and are thus in more need of documentation. Should I indiscriminately evaluate how each works and come up with documentation for as many as I can? or are they not equally important?

> Missing description across multiple API endpoints in Swagger Doc
> ----------------------------------------------------------------
>
>                 Key: FINERACT-1589
>                 URL: https://issues.apache.org/jira/browse/FINERACT-1589
>             Project: Apache Fineract
>          Issue Type: Bug
>          Components: Docs, SDK
>    Affects Versions: 1.5.0, 1.6.0
>            Reporter: Hemant Gupta
>            Priority: Major
>              Labels: beginner-friendly
>         Attachments: Screen Shot 2022-04-18 at 9.00.20 AM.png, Screen Shot 2022-04-18 at 9.00.29 AM.png, Screen Shot 2022-04-18 at 9.00.36 AM.png
>
>
> There are multiple API endpoints (refer to Table (A) below) spread across various sections, where the description of the endpoint is missing. It will look much better and more understandable if each API endpoint has its own description.
> As we know, the API documentation hosted at readme.io ([https://mifos.readme.io/reference/overview-1]) is fetching the endpoints from Swagger only. So, in order to fill up the missing description(s) on readme.io, correction in Swagger is very necessary. This will also help in building more easily understandable & user-friendly documentation.
>  
>  
> |*Section*|*API Endpoint Title*|*Link*|
> |Loan Collateral|Update a Collateral|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Loan%20Collateral/updateCollateral]|
> |Mapping Financial Activities to Accounts|Delete a Financial Activity to Account Mapping|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Mapping%20Financial%20Activities%20to%20Accounts/deleteGLAccount]|
> |Provisioning Entries|List all Provisioning Entries|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Provisioning%20Entries/retrieveAllProvisioningEntries]|
> |Offices|Update Office|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Offices/updateOffice]|
> |default|Update a Campaign|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/default/updateCampaign_1]|
> |User Generated Documents|Update a UGD|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/User%20Generated%20Documents/saveTemplate]|
> |User Generated Documents|Delete a UGD|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/User%20Generated%20Documents/deleteTemplate]|
> |Teller Cash Management|Retrieve a cashier|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Teller%20Cash%20Management/findCashierData]|
> |Teller Cash Management|Update teller|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Teller%20Cash%20Management/updateTeller]|
> |Teller Cash Management|Retrieve tellers|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Teller%20Cash%20Management/findTeller]|
> |Teller Cash Management|Find Cashiers|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Teller%20Cash%20Management/getCashierTemplate]|
> |Teller Cash Management|List Cashiers|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Teller%20Cash%20Management/getCashierData_1]|
> |Maker Checker (or 4-eye) functionality|Delete Maker Checker Entry|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Maker%20Checker%20(or%204-eye)%20functionality/deleteMakerCheckerEntry]|
> |Roles|Update a Role|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Roles/updateRole]|
> |Roles|Update a Role’s Permissions|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Roles/updateRolePermissions]|
> |Code Values|Create a Code description|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Code%20Values/createCodeValue]|
> |Account number format|Update an Account number format|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Account%20number%20format/update_1]|
> |Permissions|Enable/Disable Permissions for Maker Checker|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Permissions/updatePermissionsDetails]|
> |Password preferences|Update password preferences|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Password%20preferences/update_23]|
> |Documents|Remove a Document|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Documents/deleteDocument]|
> |Reports|Create a Report|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Reports/createReport]|
> |Report Mailing Jobs|Update a Report Mailing Job|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Report%20Mailing%20Jobs/updateReportMailingJob]|
> |Spm-Surveys|Retrieve a Survey|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Spm-Surveys/findSurvey]|
> |Spm-Surveys|List all Surveys|[https://demo.fineract.dev/fineract-provider/swagger-ui/index.html#/Spm-Surveys/fetchAllSurveys_1]|
> !Screen Shot 2022-04-18 at 9.00.20 AM.png!
>  



--
This message was sent by Atlassian Jira
(v8.20.10#820010)