You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fineract.apache.org by vo...@apache.org on 2020/08/01 13:22:01 UTC
[fineract] branch vorburger-swagger-README created (now 100d186)
This is an automated email from the ASF dual-hosted git repository.
vorburger pushed a change to branch vorburger-swagger-README
in repository https://gitbox.apache.org/repos/asf/fineract.git.
at 100d186 minor Swagger clean-up in README
This branch includes the following new commits:
new 100d186 minor Swagger clean-up in README
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[fineract] 01/01: minor Swagger clean-up in README
Posted by vo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vorburger pushed a commit to branch vorburger-swagger-README
in repository https://gitbox.apache.org/repos/asf/fineract.git
commit 100d1861017813882f8f05df89b77867bade48a2
Author: Michael Vorburger ⛑️ <mi...@vorburger.ch>
AuthorDate: Sat Aug 1 15:21:55 2020 +0200
minor Swagger clean-up in README
---
README.md | 14 ++++----------
1 file changed, 4 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 4ed3398..d387a8c 100644
--- a/README.md
+++ b/README.md
@@ -249,9 +249,11 @@ complies with the [Apache Software Foundation third-party license policy](https:
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").
+The API for Fineract is documented in [apiLive.htm](fineract-provider/src/main/resources/static/api-docs/apiLive.htm), and the [apiLive.htm can be viewed on Fineract.dev](https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm "API Documentation"). If you have your own Fineract instance running, you can find this documentation under [/fineract-provider/api-docs/apiLive.htm](https://localhost:8443/fineract-provider/api-docs/apiLive.htm).
-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'
+The Swagger documentation (work in progress; see [FINERACT-733](https://issues.apache.org/jira/browse/FINERACT-733)) can be accessed under [/fineract-provider/swagger-ui/index.html](https://localhost:8443/fineract-provider/swagger-ui/index.html) and [live Swagger UI here on Fineract.dev](https://demo.fineract.dev/fineract-provider/swagger-ui/index.html).
+
+Apache Fineract supports client code generation using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) based on the [OpenAPI Specification](https://swagger.io/specification/). For more instructions on how to generate the client code, check [docs/developers/swagger/client.md](docs/developers/swagger/client.md).
API clients (Web UIs, Mobile, etc.)
@@ -263,14 +265,6 @@ API clients (Web UIs, Mobile, etc.)
* https://github.com/openMF has more related proejcts
-Generate Apache Fineract API Client
-============
-
-Apache Fineract supports client code generation using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) based on the [OpenAPI Specification Version 3.0.3](https://swagger.io/specification/).
-
-For more instructions on how to generate the client code, check `docs/developers/swagger/client.md`
-
-
Online Demos
============