You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fineract.apache.org by GitBox <gi...@apache.org> on 2020/07/09 07:07:49 UTC
[GitHub] [fineract] ptuomola opened a new pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
ptuomola opened a new pull request #1163:
URL: https://github.com/apache/fineract/pull/1163
## Description
This PR fixes the Swagger UI versioning issue and includes the remaining metadata from old response.json to the new autogenerated fineract.json. It also removes the old response.json and completes the work on the following JIRA issues:
- FINERACT-835
- FINERACT-837
- FINERACT-1045
## Checklist
Please make sure these boxes are checked before submitting your pull request - thanks!
- [ ] Commit message starts with the issue number from https://issues.apache.org/jira/projects/FINERACT/. Ex: FINERACT-646 Pockets API.
- [ ] Coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions have been followed.
- [ ] API documentation at fineract-provider/src/main/resources/static/api-docs/apiLive.htm has been updated with details of any API changes.
- [ ] Integration tests have been created/updated for verifying the changes made.
- [ ] All Integrations tests are passing with the new commits.
- [ ] Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the list.)
Our guidelines for code reviews is at https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [fineract] vorburger commented on a change in pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
Posted by GitBox <gi...@apache.org>.
vorburger commented on a change in pull request #1163:
URL: https://github.com/apache/fineract/pull/1163#discussion_r453987711
##########
File path: fineract-provider/config/swagger/fineract-input.json
##########
@@ -0,0 +1,16 @@
+{
+ "openapi" : "3.0.3",
+ "info": {
+ "version": "1.4.0",
+ "title": "Apache Fineract",
+ "description": "Apache Fineract is a secure, multi-tenanted microfinance platform\n\nThe goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform<br>The [reference app](https://cui.fineract.dev) (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation\n\n- The API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)\n- Find out more about Apache Fineract [here](/fineract-provider/api-docs/apiLive.htm#top)\n- You can [Try The API From Your Browser](/fineract-provider/api-docs/apiLive.htm#interact)\n- The Generic Options are available [here](/fineract-provider/api-docs/apiLive.htm#genopts)\n- Find out more about [Updating Dates and Numbers](/fineract-provider/api-docs/apiLive.htm#dates_and_numbers)\n- For the Authentication and the Basic of HTTP and HTTPS refer [here](/fineract-provider/api-docs/apiLive.htm#authentication_overview)\n- Check about ERROR codes [here](/fineract-provider/api-docs/apiLive.htm#errors)\n\nPlease refer to the [old documentation](/fineract-provider/api-docs/apiLive.htm) for any documentation queries",
+ "termsOfService": "https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm",
Review comment:
Is it possible to just leave this out entirely? Or use /fineract-provider/... without fineract.dev hostname?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [fineract] thesmallstar commented on pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
Posted by GitBox <gi...@apache.org>.
thesmallstar commented on pull request #1163:
URL: https://github.com/apache/fineract/pull/1163#issuecomment-656084538
@ptuomola this is failing due to minor spotless violations, spotlessApply should fix this :D
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [fineract] thesmallstar commented on pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
Posted by GitBox <gi...@apache.org>.
thesmallstar commented on pull request #1163:
URL: https://github.com/apache/fineract/pull/1163#issuecomment-657042829
@ptuomola is there any reason you used JSON over yaml for this config?
All the docs of swagger-ui use yaml, would you mind if I convert it to yaml in a PR following this (which will fix the needed config for try it out button).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [fineract] Sanyam96 commented on pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
Posted by GitBox <gi...@apache.org>.
Sanyam96 commented on pull request #1163:
URL: https://github.com/apache/fineract/pull/1163#issuecomment-658325646
Thanks @ptuomola @thesmallstar @vorburger for the implementation and merging this.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [fineract] vorburger commented on pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
Posted by GitBox <gi...@apache.org>.
vorburger commented on pull request #1163:
URL: https://github.com/apache/fineract/pull/1163#issuecomment-657834564
> GREAT! this works as expected!!
@thesmallstar can I double check, have you actually pulled this PR locally manually tested it yourself? Once you confirm, I'll just merge this, without further testing it myself first... PS: I love seeing the collaboration between you and @ptuomola here!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [fineract] ptuomola commented on pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
Posted by GitBox <gi...@apache.org>.
ptuomola commented on pull request #1163:
URL: https://github.com/apache/fineract/pull/1163#issuecomment-657065229
@thesmallstar No reason - just that the first examples I found for the config file format were in JSON, so I followed them. Feel free to change to YAML once this PR has been merged...
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [fineract] thesmallstar commented on pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
Posted by GitBox <gi...@apache.org>.
thesmallstar commented on pull request #1163:
URL: https://github.com/apache/fineract/pull/1163#issuecomment-657076666
Sounds good :D
@awasum @xurror @Sanyam96 can you review/merge this, please?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [fineract] ptuomola commented on a change in pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
Posted by GitBox <gi...@apache.org>.
ptuomola commented on a change in pull request #1163:
URL: https://github.com/apache/fineract/pull/1163#discussion_r454073131
##########
File path: fineract-provider/config/swagger/fineract-input.json
##########
@@ -0,0 +1,16 @@
+{
+ "openapi" : "3.0.3",
+ "info": {
+ "version": "1.4.0",
+ "title": "Apache Fineract",
+ "description": "Apache Fineract is a secure, multi-tenanted microfinance platform\n\nThe goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform<br>The [reference app](https://cui.fineract.dev) (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation\n\n- The API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)\n- Find out more about Apache Fineract [here](/fineract-provider/api-docs/apiLive.htm#top)\n- You can [Try The API From Your Browser](/fineract-provider/api-docs/apiLive.htm#interact)\n- The Generic Options are available [here](/fineract-provider/api-docs/apiLive.htm#genopts)\n- Find out more about [Updating Dates and Numbers](/fineract-provider/api-docs/apiLive.htm#dates_and_numbers)\n- For the Authentication and the Basic of HTTP and HTTPS refer [here](/fineract-provider/api-docs/apiLive.htm#authentication_overview)\n- Check about ERROR codes [here](/fineract-provider/api-docs/apiLive.htm#errors)\n\nPlease refer to the [old documentation](/fineract-provider/api-docs/apiLive.htm) for any documentation queries",
+ "termsOfService": "https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm",
Review comment:
For the terms of service-attribute specifically? I think it's optional and also a relative path should work. @thesmallstar was going to convert this file to YAML in a separate PR, so maybe good idea to leave it out from that version - I don't think the API docs really qualify as a "terms of service" anyway?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [fineract] thesmallstar edited a comment on pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
Posted by GitBox <gi...@apache.org>.
thesmallstar edited a comment on pull request #1163:
URL: https://github.com/apache/fineract/pull/1163#issuecomment-657836629
@vorburger yes I have pulled this and tested it.
Also, I could make PR #1169 work locally only on this change :)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [fineract] thesmallstar commented on pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
Posted by GitBox <gi...@apache.org>.
thesmallstar commented on pull request #1163:
URL: https://github.com/apache/fineract/pull/1163#issuecomment-657836629
@vorburger yes I have pulled this and tested it.
Also, I could make PR #1169 work only on this change :)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [fineract] vorburger merged pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs
Posted by GitBox <gi...@apache.org>.
vorburger merged pull request #1163:
URL: https://github.com/apache/fineract/pull/1163
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org