[
https://issues.apache.org/jira/browse/FINERACT-834?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17141519#comment-17141519
]
Petri Tuomola commented on FINERACT-834:
----------------------------------------
[~vorburger] My thinking was that we want to update the README once the Swagger
generation is working fully - i.e. the Swagger documentation is ready for some
actual use. My update to README was really just to point people to the right
URL so they wouldn't have to guess where to find the Swagger doc - but once
ready, we probably want to include a longer description on how to update
Swagger etc.
> Minor quick win: Please raise very small PR documenting Swagger use on README
> -----------------------------------------------------------------------------
>
> Key: FINERACT-834
> URL: https://issues.apache.org/jira/browse/FINERACT-834
> Project: Apache Fineract
> Issue Type: Sub-task
> Reporter: Michael Vorburger
> Priority: Major
>
> Based on some of the discussion in
> https://github.com/apache/fineract/pull/629 (which got superseded by
> https://github.com/apache/fineract/pull/695), I think it would be very useful
> to have a short line (or a or two paragraph, max) in
> https://github.com/apache/fineract/blob/develop/README.md#apache-fineract-platform-api
> which simply explains how one actually may currently use the Swagger UI, as
> it currently is.
> I will just be completely honest and admit that personally I do not actually
> know how! ;-) Is there a special URL one has to access? Does one need to
> locally install anything?
> [~kangbreder] would you like to do this? Please do raise 1 small PR with ONLY
> this README change.
> [~awasum] [~sanyam] ([~sanyam96] ?) FYI
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
