openmf / fineract-client Goto Github PK

@Grandolf49 make sure that https://github.com/openMF/fineract-client/blob/767943e88793350fd6b0e36dd8d370e541a54995/src/main/java/org/mifos/fineract/FineractApiClient.java OAuth support doesn't pass secrets in URL but in x-www-form-urlencoded Body, see https://issues.apache.org/jira/browse/FINERACT-1145 for https://issues.apache.org/jira/browse/FINERACT-629.

Summary

Currently, the API response is wrapped in Call<ApiResponse> object.

Expectation

It would be very helpful for the Android Applications to get the response in either Observable or LiveData

The Spec File used to generate the library should be added to the project in case if anyone wants to try out customizing the library

To use the SDK, we have to follow these steps:

1. Obtains an instance of FineractApiClient
2. Get the appropriate service from FineractApiClient
3. Perform API call.

User should not have to create the Service. The library should handle service creation and provide getter methods for the user.
Example: https://github.com/openMF/android-client/blob/master/mifosng-android/src/main/java/com/mifos/api/BaseApiManager.java

The major issues with the fineract swagger resources are fixed, which need to be included here also. This issue focuses on regenerating and updating the SDK after including all those fixes.

Below are the tickets

• FINERACT-1364: Missmatch datatype in groups field of client model "GetClientsClientIdResponse"
• FINERACT-1365: invalid swagger annotations in DatatablesApiResource for posting datatable
• FINERACT-1366: invalid fields in PostClientsClientIdRequest in clientsApiResourceSwagger
• FINERACT-1369: invalid body payload in basic authentication swagger resource and generated client
• FINERACT-1370: invalid response schema defined in SearchApiResource

@Grandolf49 perhaps it would be useful to add something to the top of the https://github.com/openMF/fineract-client/blob/master/README.md which clarifies how this project relates to https://github.com/apache/fineract/blob/develop/docs/developers/swagger/client.md ?

Because it's actually not clear e.g. to me (and perhaps to others, in the future). From what little I understand, this looks like it may be a Git repo containing the output of the code that one can generate by following https://github.com/apache/fineract/blob/develop/docs/developers/swagger/client.md, is that right? But you seem to also be making manual extensions here (like #11), and letting Dependabot upgrade many 3rd-parties (which, ideally, should better be made "upstream" in Swagger Codegen, which would then release new versions, which Apache Fineract would, eventually, pick up through Dependabot upgrades of Swagger Codegen).

Swagger Codegen generated blank test files to test the APIs. It is up to us to write the tests according to our needs. Currently, the APIs are not being tested although, test files are present.

Description
Json.java uses DateTimeFormatter class which is only supports android api >= 0reo(API 26), but the min sdk version is 15. Hence it is causing app crash in android making this library only available for device run-in non android API level 26+.

Screenshot

To build the project, the user is expected to have Maven installed in their system.

Ideally, the project should contain a Maven Wrapper which will allow a user to build the project by executing the command ./mvnw package

The documentation generated by Swagger Codegen is incorrect.
Eg: AccountNumberFormatApi.md
In the documentation, the Base URL contains an additional http:// string. This was because the API Spec File was incorrect. It has been fixed now.

This might be a tedious task to solve. This file was used to generate the client library.

Possible Resolution

1. Use the Spec File URL and generate library again.
2. Verify if the documentation generated is correct or not.
3. If correct, copy all the doc files and paste them in this project
4. If not, use Mustache Templates to generate correct documentation in Swagger Codegen

Currently this markdown is generated.
But instead the latest released version has more convenient and clear documentation.
Hence its better to modify README.mustache template in corder to make future sdk release easy and consistent.