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/14 03:14:18 UTC

[GitHub] [fineract] ptuomola commented on a change in pull request #1163: FINERACT-835: Complete work on automatically generating Swagger docs

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