search

openMF / fineract-client

Mifos Fineract Client is a Java based library that provides a simple interface to interact with the Apache Fineract 1.x Platform APIs
Mozilla Public License 2.0
14 stars 14 forks source link

Documentation in README to clarify how this project relates to Fineract's API client #29

Open vorburger opened 4 years ago

vorburger commented 4 years ago

@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).

Grandolf49 commented 4 years ago

@vorburger Sure, I'll add more details about this repository.

For you information:

  1. This repository is more focused on the Android Applications that Mifos uses. Hence, some manual extensions were required here. Whereas the library generated in apache-fineract will be more generic and not Android Specific. Perhaps, I should consider modifying the name of this repository.

  2. Yes, this is a project generated by Swagger Codegen. I have used Swagger 2.0 API Spec File, which differs from the latest spec file OpenAPI 3.0.0 generated in Apache Fineract project.

  3. Reason for using old Spec File is because android-client and mifos-mobile and mobile-wallet android applications are using Fineract 1.0.0 (which I understand is a very old version of Fineract).

  4. If anyone of the Android Project mentioned above require some fixes to be done in this library, we can perform that directly here. It is quite possible that these fixes need human intervention which Mustache templates might not solve.

I would love to have feedback of @vorburger @droidchef @therajanmaurya @shiv07tiwari @edcable for deciding how to proceed here.

vorburger commented 2 years ago

I've added now a link to the "other" (official) fineract-client to the README of this project via https://github.com/openMF/fineract-client/commit/8061350f10644a1580316781c92f91d9c7f0e368.