[GitHub] [fineract] vorburger commented on a change in pull request #1069: FINERACT-835: Upgrade Swagger and automatically generate the JSON spec

[GitBox <gi...@apache.org>]

vorburger commented on a change in pull request #1069:
URL: https://github.com/apache/fineract/pull/1069#discussion_r443121726



##########
File path: fineract-provider/src/main/resources/static/swagger-ui/index.html
##########
@@ -0,0 +1,60 @@
+<!-- HTML for static distribution bundle build -->

Review comment:
       @ptuomola just out of curiosity and for my education (and FYI @thesmallstar), does `org.webjars.npm:swagger-ui-dist` not already include an `index.html` like this? If we can avoid having to maintain this, that's better, of course. If in Swagger (which I don't know full details about) an application needs to provide this itself, then fine, of course - just thought I would ask.

##########
File path: README.md
##########
@@ -251,6 +251,8 @@ Apache Fineract Platform API
 
 The API for the Fineract-platform (project named 'Apache Fineract') is documented in the API-docs under <b><i>Full API Matrix</i></b> and can be viewed [here](https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm "API Documentation").
 
+If you have your own Fineract instance running, you can find the same documentation under '(your host:port)/fineract-provider/api-docs/apiLive.htm' under your. The Swagger documentation (work in progress) can be accessed under '(your host:port)/fineract-provider/swagger-ui/index.html'

Review comment:
       Very very minor, but "under your" is duplicated, better like this:
   
   ```suggestion
   If you have your own Fineract instance running, you can find the same documentation under '(your host:port)/fineract-provider/api-docs/apiLive.htm'. The Swagger documentation (work in progress) can be accessed under '(your host:port)/fineract-provider/swagger-ui/index.html'
   ```




----------------------------------------------------------------
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