New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GSOC'17:swagger and swagger UI integration on fineract-provider #409

Open
wants to merge 4 commits into
base: develop
from

Conversation

Projects
None yet
5 participants
@Sanyam96
Contributor

Sanyam96 commented Aug 27, 2017

This Pull Request contains the Integration of Swagger on fineract-provider for dynamic documentation of REST API which can easily replace apiLive.htm (which is the current documentation of Apache/Fineract Rest API) and now the documentation can easily be in sync with the Rest API.

Developers can follow the "Instructions For Accessing Swagger Files" and "Developers Instruction for Contribution" in the Documentation Link ( https://goo.gl/S1jJuS ) on the integration of Swagger and Swagger UI on Fineract Rest API.

All the details related to Swagger Integration on Fineract can easily be found at:
PDF Link of Documentation: https://goo.gl/8RMMhN
Google Doc Link of Documentation: https://goo.gl/S1jJuS

@nazeer1100126
@dhirenpratap
@vidakovic
@edcable

@nikpawar89

This comment has been minimized.

Show comment
Hide comment
@nikpawar89

nikpawar89 Oct 7, 2017

Member

@Sanyam96 Could you please resolve the conflicts. We can start working towards its integration.

Member

nikpawar89 commented Oct 7, 2017

@Sanyam96 Could you please resolve the conflicts. We can start working towards its integration.

@Sanyam96

This comment has been minimized.

Show comment
Hide comment
@Sanyam96

Sanyam96 Oct 11, 2017

Contributor

@nikpawar89
I have solved the merge conflicts with the Develop branch.

Contributor

Sanyam96 commented Oct 11, 2017

@nikpawar89
I have solved the merge conflicts with the Develop branch.

@nikpawar89

This comment has been minimized.

Show comment
Hide comment
@nikpawar89

nikpawar89 Oct 15, 2017

Member

@Sanyam96 thanks for that I am in process of reviewing your code..

Member

nikpawar89 commented Oct 15, 2017

@Sanyam96 thanks for that I am in process of reviewing your code..

@nikpawar89

This comment has been minimized.

Show comment
Hide comment
@nikpawar89

nikpawar89 Oct 20, 2017

Member

As the annotations for portfolio branch are to be inserted, merging this PR will not be feasible.
The remaining work can be converted into GCI tasks and once the PR is completed we can merge it.
@nazeer1100126 @avikganguly01 let me know your views.
I was also having concern over manually inserting /swagger.json or /swagger.yml after we have build the application. I am not 100% sure if this will work, but I have seen people generating the files during compile time,
https://tech.homeaway.com/development/2016/06/02/generating-swagger-spec.html
Although this has been done in maven. @Sanyam96 please refer this link

For bit level task, I can take the lead for mentoring GCI students to get this PR completed.

Member

nikpawar89 commented Oct 20, 2017

As the annotations for portfolio branch are to be inserted, merging this PR will not be feasible.
The remaining work can be converted into GCI tasks and once the PR is completed we can merge it.
@nazeer1100126 @avikganguly01 let me know your views.
I was also having concern over manually inserting /swagger.json or /swagger.yml after we have build the application. I am not 100% sure if this will work, but I have seen people generating the files during compile time,
https://tech.homeaway.com/development/2016/06/02/generating-swagger-spec.html
Although this has been done in maven. @Sanyam96 please refer this link

For bit level task, I can take the lead for mentoring GCI students to get this PR completed.

@edcable

This comment has been minimized.

Show comment
Hide comment
@edcable

edcable Nov 13, 2017

@avikganguly01 @nazeer1100126 are you in concurrence with @nikpawar89 that we should wait on committing these changes until the annotations for portfolio are complete as well? I would like to at least get this committed and then after GCI do the remaining commits once portfolio is done. Or am I missing something and this can not be done in separate chunks?

edcable commented Nov 13, 2017

@avikganguly01 @nazeer1100126 are you in concurrence with @nikpawar89 that we should wait on committing these changes until the annotations for portfolio are complete as well? I would like to at least get this committed and then after GCI do the remaining commits once portfolio is done. Or am I missing something and this can not be done in separate chunks?

@avikganguly01

This comment has been minimized.

Show comment
Hide comment
@avikganguly01

avikganguly01 Dec 13, 2017

Contributor

@Sanyam96 : I am unable to pull in this code as you included following files in your source which I believe belongs to Swagger and we cannot release them under our license.

src/main/resources/swagger-ui/swagger-ui-bundle.js.map
src/main/resources/swagger-ui/swagger-ui-standalone-preset.js.map
src/main/resources/swagger-ui/swagger-ui.css
src/main/resources/swagger-ui/swagger-ui.css.map
src/main/resources/swagger-ui/swagger-ui-standalone-preset.js
src/main/resources/swagger-ui/swagger-ui.js.map
src/main/resources/swagger-ui/swagger-ui-bundle.js
src/main/resources/swagger-ui/swagger-ui.js

You should add a bower.json file to pull in this file, then add bower_components to .gitignore folder and change path references for this file to point to bower_components folder.

Contributor

avikganguly01 commented Dec 13, 2017

@Sanyam96 : I am unable to pull in this code as you included following files in your source which I believe belongs to Swagger and we cannot release them under our license.

src/main/resources/swagger-ui/swagger-ui-bundle.js.map
src/main/resources/swagger-ui/swagger-ui-standalone-preset.js.map
src/main/resources/swagger-ui/swagger-ui.css
src/main/resources/swagger-ui/swagger-ui.css.map
src/main/resources/swagger-ui/swagger-ui-standalone-preset.js
src/main/resources/swagger-ui/swagger-ui.js.map
src/main/resources/swagger-ui/swagger-ui-bundle.js
src/main/resources/swagger-ui/swagger-ui.js

You should add a bower.json file to pull in this file, then add bower_components to .gitignore folder and change path references for this file to point to bower_components folder.

@Sanyam96

This comment has been minimized.

Show comment
Hide comment
@Sanyam96

Sanyam96 Dec 18, 2017

Contributor

@avikganguly01
Hi Avik, Swagger is an open source project in which we have used their Swagger-UI project with some modification to enable Swagger-UI with Swagger-Json.
I have followed their instruction to enable Swagger-UI Please see the link: https://swagger.io/docs/swagger-tools/#download-33

Contributor

Sanyam96 commented Dec 18, 2017

@avikganguly01
Hi Avik, Swagger is an open source project in which we have used their Swagger-UI project with some modification to enable Swagger-UI with Swagger-Json.
I have followed their instruction to enable Swagger-UI Please see the link: https://swagger.io/docs/swagger-tools/#download-33

@avikganguly01

This comment has been minimized.

Show comment
Hide comment
@avikganguly01

avikganguly01 Dec 26, 2017

Contributor

@mgeiss : Swagger UI (https://swagger.io/docs/swagger-tools/#download-33) is advocating customizing their css and js files directly. Can we put our license on such modified files like swagger-ui.css and swagger-ui.js?

Contributor

avikganguly01 commented Dec 26, 2017

@mgeiss : Swagger UI (https://swagger.io/docs/swagger-tools/#download-33) is advocating customizing their css and js files directly. Can we put our license on such modified files like swagger-ui.css and swagger-ui.js?

@ghost

This comment has been minimized.

Show comment
Hide comment
@ghost

ghost Dec 29, 2017

we should not change the underlying license of swagger ... if needed we should exclude them from the license check ... even if we change the code ... it is not ours (;

ghost commented Dec 29, 2017

we should not change the underlying license of swagger ... if needed we should exclude them from the license check ... even if we change the code ... it is not ours (;

Gci swagger integration (#33)
* Swagger Documentation of StandingInstructionApiResource.java

* Swagger Documentation of StandingInstructionHistoryApiResource.java

* Swagger Documentation for ChargesApiResource.java

* Swagger Documentation of EntityFieldConfigurationApiResources.java and LoanChargesApiResource.java

* Swagger Documentation for CollateralsApiResource.java and InterestRateChartsApiResource.java (#5)

* Swagger Documentation for InterestRateChartSlabsApiResource.java (#8)

* Swagger Documentation for FundsApiResource.java (#9)

* Swagger Documentation for LoansApiResource.java (#10)

* Swagger Documentation for TaxGroupApiResource.java (#12)

* Swagger Documentation for FixedDepositAccountsApiResource.java (#13)

* Swagger Documentation for FixedDepositAccountsApiResource.java

* Added Example Request in GET Endpoint {accountId}

Added Example Request in GET Endpoint in "fixeddepositaccounts/{accountId}"

* Swagger Documentation for AccountTransfersApiResource.java (#14)

* Swagger Documentation for CollectionSheetApiResource.java and FloatingRatesApiResource.java (#15)

* Swagger Documentation for CentersApiResource.java (#16)

* Swagger documentation for GroupsApiResource.java (#11)

* Swagger Documentation for SelfBeneficiariesTPTApiResource.java and SelfAuthenticationApiResource.java (#21)

* Swagger Documentation for SelfClientsApiResource.java (#20)

* Swagger Documentation for AccountsApiResource.java (#19)

* Swagger Documentation for SelfUserApiResource.java, TaxComponentApiResource.java & SelfUserDetailsApiResource.java (#18)

* Swagger Documentation for FixedDepositProductsApiResource.java (#22)

* Swagger Documentation for SelfSavingsApiResource.java (#23)

* Swagger Documentation for RecurringDepositAccountsApiResource.java (#24)

* Swagger Documentation for SelfLoansApiResource.java (#17)

* Swagger Documentation for SelfLoansApiResource.java
* Added documentation for POST endpoint

* Swagger Documentation for SavingsAccountsApiResource.java (#26)

* Swagger Documentation for RecurringDepositAccountTransactionsApiResource.java (#29)

* Swagger Documentation for LoanProductsApiResource.java and NotesApiResource,java (#25)

* Swagger Documentation for RecurringDepositProductsApiResource.java & SavingAccountChargesApiResource.java (#27)

* Swagger Documenatation for LoanScheduleApiResource.java & LoanTransactionsApiResource.java (#28)

* Swagger Documentation for PaymentTypeApiResource.java and ProductsApiResource.java (#31)

* Swagger Documentation for SavingsProductsApiResource.java (#30)

* Swagger Documentation for Clients API (#32)

* Swagger Documentation for Clients API

* Changed the file name

* Fixed minor bugs/errors

* Requested Changes

* Some more changes
@vidakovic

This comment has been minimized.

Show comment
Hide comment
@vidakovic

vidakovic Apr 10, 2018

Just FYI: I was @Sanyam96 's mentor last year and had a look at his changes. Looks good to me.

vidakovic commented Apr 10, 2018

Just FYI: I was @Sanyam96 's mentor last year and had a look at his changes. Looks good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment