You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@fineract.apache.org by Sanyam96 <gi...@git.apache.org> on 2017/08/27 17:54:36 UTC
[GitHub] fineract pull request #409: GSOC'17:swagger and swagger UI integration on fi...
GitHub user Sanyam96 opened a pull request:
https://github.com/apache/fineract/pull/409
GSOC'17:swagger and swagger UI integration on fineract-provider
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
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/Sanyam96/incubator-fineract swagger-documentation-integration
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/fineract/pull/409.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #409
----
commit b5d9429926e97e0adc9bfa4fd006641afbca5dbb
Author: Sanyam96 <sa...@gmail.com>
Date: 2017-08-27T17:52:52Z
GSOC'17:swagger and swagger UI integration on fineract-provider
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] fineract issue #409: GSOC'17:swagger and swagger UI integration on fineract-...
Posted by markusgeiss <gi...@git.apache.org>.
Github user markusgeiss commented on the issue:
https://github.com/apache/fineract/pull/409
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 (;
---
[GitHub] fineract issue #409: GSOC'17:swagger and swagger UI integration on fineract-...
Posted by avikganguly01 <gi...@git.apache.org>.
Github user avikganguly01 commented on the issue:
https://github.com/apache/fineract/pull/409
@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?
---
[GitHub] fineract issue #409: GSOC'17:swagger and swagger UI integration on fineract-...
Posted by edcable <gi...@git.apache.org>.
Github user edcable commented on the issue:
https://github.com/apache/fineract/pull/409
@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?
---
[GitHub] fineract issue #409: GSOC'17:swagger and swagger UI integration on fineract-...
Posted by Sanyam96 <gi...@git.apache.org>.
Github user Sanyam96 commented on the issue:
https://github.com/apache/fineract/pull/409
@nikpawar89
I have solved the merge conflicts with the Develop branch.
---
[GitHub] fineract issue #409: GSOC'17:swagger and swagger UI integration on fineract-...
Posted by nikpawar89 <gi...@git.apache.org>.
Github user nikpawar89 commented on the issue:
https://github.com/apache/fineract/pull/409
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.
---
[GitHub] fineract issue #409: GSOC'17:swagger and swagger UI integration on fineract-...
Posted by Sanyam96 <gi...@git.apache.org>.
Github user Sanyam96 commented on the issue:
https://github.com/apache/fineract/pull/409
@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
---
[GitHub] fineract issue #409: GSOC'17:swagger and swagger UI integration on fineract-...
Posted by avikganguly01 <gi...@git.apache.org>.
Github user avikganguly01 commented on the issue:
https://github.com/apache/fineract/pull/409
@Sanyam96 : I am unable to pull in this code as you included following files in your source which I believe belongs to Swagger.
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/response.json
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.
---
[GitHub] fineract issue #409: GSOC'17:swagger and swagger UI integration on fineract-...
Posted by nikpawar89 <gi...@git.apache.org>.
Github user nikpawar89 commented on the issue:
https://github.com/apache/fineract/pull/409
@Sanyam96 Could you please resolve the conflicts. We can start working towards its integration.
---
[GitHub] fineract issue #409: GSOC'17:swagger and swagger UI integration on fineract-...
Posted by nikpawar89 <gi...@git.apache.org>.
Github user nikpawar89 commented on the issue:
https://github.com/apache/fineract/pull/409
@Sanyam96 thanks for that I am in process of reviewing your code..
---
[GitHub] fineract issue #409: GSOC'17:swagger and swagger UI integration on fineract-...
Posted by vidakovic <gi...@git.apache.org>.
Github user vidakovic commented on the issue:
https://github.com/apache/fineract/pull/409
Just FYI: I was @Sanyam96 's mentor last year and had a look at his changes. Looks good to me.
---