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/02/07 02:26:58 UTC
[fineract] branch develop updated: FINERACT-840
This is an automated email from the ASF dual-hosted git repository.
vorburger pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/fineract.git
The following commit(s) were added to refs/heads/develop by this push:
new 78eb402 FINERACT-840
78eb402 is described below
commit 78eb4022066136c3469f515b9c31f606b550fbf6
Author: xurror <ka...@outlook.com>
AuthorDate: Tue Feb 4 17:06:54 2020 +0200
FINERACT-840
Update API docs and demo app URL
---
docs/system-architecture/index.html | 6 +++---
.../infrastructure/survey/api/SurveyApiResource.java | 2 +-
.../portfolio/accounts/api/AccountsApiResource.java | 2 +-
.../security/api/SelfAuthenticationApiResource.java | 2 +-
.../security/api/SelfUserDetailsApiResource.java | 2 +-
.../src/main/resources/META-INF/spring/swagger.xml | 20 ++++++++++----------
6 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/docs/system-architecture/index.html b/docs/system-architecture/index.html
index fdf12d4..e4159ca 100644
--- a/docs/system-architecture/index.html
+++ b/docs/system-architecture/index.html
@@ -233,7 +233,7 @@ pre .tex .formula {
<ul>
<li>2006: Project intiated by <a href="http://www.grameenfoundation.org/" target="_blank">Grameen Foundation</a></li>
<li>Late 2011: Grameen Foundation handed over full responsibility to open source community.</li>
- <li>2012: Mifos X platform started. Previous members of project come together under the name of Community for Open Source Microfinance (COSM / <a href="http://www.openmf.org" target="_blank">OpenMF</a>)</li>
+ <li>2012: Mifos X platform started. Previous members of project come together under the name of Community for Open Source Microfinance (COSM / <a href="http://www.mifos.org" target="_blank">OpenMF</a>)</li>
<li>2013: COSM / OpenMF officially rebranded to <strong>Mifos Initiative</strong> and receive US 501c3 status.</li>
</ul>
</p>
@@ -276,7 +276,7 @@ pre .tex .formula {
<section>
<h2>Functional Overview</h2>
- <p>As ALL capabilities of the platform are exposed through an API, The API docs are the best place to view a detailed breakdown of what the platform does. See <a href="https://demo.openmf.org/api-docs/apiLive.htm" target="_blank">online API Documentation</a>.
+ <p>As ALL capabilities of the platform are exposed through an API, The API docs are the best place to view a detailed breakdown of what the platform does. See <a href="https://demo.mifos.io/api-docs/apiLive.htm" target="_blank">online API Documentation</a>.
</p>
<img src="diagrams/platform-categories.png"
alt="platform functionality view" />
@@ -378,7 +378,7 @@ pre .tex .formula {
</li>
</ul>
- See <a href="https://demo.openmf.org/api-docs/apiLive.htm" target="_blank">online API Documentation</a> for more detail.
+ See <a href="https://demo.mifos.io/api-docs/apiLive.htm" target="_blank">online API Documentation</a> for more detail.
</p>
<h3>Multi-tenanted</h3>
<p>
diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/survey/api/SurveyApiResource.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/survey/api/SurveyApiResource.java
index 95ee83c..02196db 100644
--- a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/survey/api/SurveyApiResource.java
+++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/survey/api/SurveyApiResource.java
@@ -114,7 +114,7 @@ public class SurveyApiResource {
@Path("{surveyName}/{apptableId}")
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
- @ApiOperation(value = "Create an entry in the survey table", notes = "Insert and entry in a survey table (full fill the survey)." + "\n" + "\n" + "Refer Link for sample Body: [ https://demo.openmf.org/api-docs/apiLive.htm#survey_create ] ")
+ @ApiOperation(value = "Create an entry in the survey table", notes = "Insert and entry in a survey table (full fill the survey)." + "\n" + "\n" + "Refer Link for sample Body: [ https://demo.mifos.io/api-docs/apiLive.htm#survey_create ] ")
@ApiImplicitParams({@ApiImplicitParam(value = "body", required = true, paramType = "body", dataType = "body", format = "body", dataTypeClass = SurveyApiResourceSwagger.PostSurveySurveyNameApptableIdRequest.class)})
@ApiResponses({@ApiResponse(code = 200, message = "", response = SurveyApiResourceSwagger.PostSurveySurveyNameApptableIdResponse.class)})
public String createDatatableEntry(@PathParam("surveyName") @ApiParam(value = "surveyName") final String datatable, @PathParam("apptableId") @ApiParam(value = "apptableId") final Long apptableId,
diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/accounts/api/AccountsApiResource.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/accounts/api/AccountsApiResource.java
index 1be8407..8bbce31 100644
--- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/accounts/api/AccountsApiResource.java
+++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/accounts/api/AccountsApiResource.java
@@ -174,7 +174,7 @@ public class AccountsApiResource {
@Path("{accountId}")
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
- @ApiOperation(value = "Approve share application | Undo approval share application | Reject share application | Activate a share account | Close a share account | Apply additional shares on a share account | Approve additional shares request on a share account | Reject additional shares request on a share account | Redeem shares on a share account", httpMethod = "POST", notes = "Approve share application:\n\n" + "Approves share application so long as its in 'Submitted and pending app [...]
+ @ApiOperation(value = "Approve share application | Undo approval share application | Reject share application | Activate a share account | Close a share account | Apply additional shares on a share account | Approve additional shares request on a share account | Reject additional shares request on a share account | Redeem shares on a share account", httpMethod = "POST", notes = "Approve share application:\n\n" + "Approves share application so long as its in 'Submitted and pending app [...]
@ApiImplicitParams({@ApiImplicitParam(value = "body", required = true, paramType = "body", dataType = "body", format = "body", dataTypeClass = AccountsApiResourceSwagger.PostAccountsTypeAccountIdRequest.class)})
@ApiResponses({@ApiResponse(code = 200, message = "OK", response = AccountsApiResourceSwagger.PostAccountsTypeAccountIdResponse.class)})
public String handleCommands(@PathParam("type") @ApiParam(value = "type") final String accountType, @PathParam("accountId") @ApiParam(value = "accountId") final Long accountId, @QueryParam("command") @ApiParam(value = "command") final String commandParam,
diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/self/security/api/SelfAuthenticationApiResource.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/self/security/api/SelfAuthenticationApiResource.java
index 0e22fdf..7d72fa6 100644
--- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/self/security/api/SelfAuthenticationApiResource.java
+++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/self/security/api/SelfAuthenticationApiResource.java
@@ -54,7 +54,7 @@ public class SelfAuthenticationApiResource {
@POST
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
- @ApiOperation(value = "Verify authentication", httpMethod = "POST", notes = "Authenticates the credentials provided and returns the set roles and permissions allowed.\n\n" + "Please visit this link for more info - https://demo.openmf.org/api-docs/apiLive.htm#selfbasicauth")
+ @ApiOperation(value = "Verify authentication", httpMethod = "POST", notes = "Authenticates the credentials provided and returns the set roles and permissions allowed.\n\n" + "Please visit this link for more info - https://demo.mifos.io/api-docs/apiLive.htm#selfbasicauth")
@ApiResponses({@ApiResponse(code = 200, message = "OK", response = SelfAuthenticationApiResourceSwagger.PostSelfAuthenticationResponse.class)})
public String authenticate(final String apiRequestBodyAsJson) {
return this.authenticationApiResource.authenticate(apiRequestBodyAsJson);
diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/self/security/api/SelfUserDetailsApiResource.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/self/security/api/SelfUserDetailsApiResource.java
index 3137f57..f76512e 100644
--- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/self/security/api/SelfUserDetailsApiResource.java
+++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/self/security/api/SelfUserDetailsApiResource.java
@@ -56,7 +56,7 @@ public class SelfUserDetailsApiResource {
@GET
@Produces({ MediaType.APPLICATION_JSON })
- @ApiOperation(value = "Fetch authenticated user details", httpMethod = "GET", notes = "Checks the Authentication and returns the set roles and permissions allowed\n\n" + "For more info visit this link - https://demo.openmf.org/api-docs/apiLive.htm#selfoauth")
+ @ApiOperation(value = "Fetch authenticated user details", httpMethod = "GET", notes = "Checks the Authentication and returns the set roles and permissions allowed\n\n" + "For more info visit this link - https://demo.mifos.io/api-docs/apiLive.htm#selfoauth")
@ApiResponses({@ApiResponse(code = 200, message = "OK", response = SelfUserDetailsApiResourceSwagger.GetSelfUserDetailsResponse.class)})
public String fetchAuthenticatedUserData(
@QueryParam("access_token") @ApiParam(value = "äccess_token") final String accessToken) {
diff --git a/fineract-provider/src/main/resources/META-INF/spring/swagger.xml b/fineract-provider/src/main/resources/META-INF/spring/swagger.xml
index aea5b22..9552198 100644
--- a/fineract-provider/src/main/resources/META-INF/spring/swagger.xml
+++ b/fineract-provider/src/main/resources/META-INF/spring/swagger.xml
@@ -35,25 +35,25 @@
<property name="version" value="1.0.0" />
<property name="description" value="Apache Fineract is a secure, multi-tenanted microfinance platform. <br />
- The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform. The reference app [ https://demo.openmf.org ] (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation.
+ The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform. The reference app [ https://demo.mifos.io ] (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation.
<br/>The API
is organized around REST [ https://en.wikipedia.org/wiki/Representational_state_transfer ]
- <br/> Find out more about Apache Fineract on [ https://demo.openmf.org/api-docs/apiLive.htm#top ]
+ <br/> Find out more about Apache Fineract on [ https://demo.mifos.io/api-docs/apiLive.htm#top ]
- <br/> You can Try The API From Your Browser itself at [ https://demo.openmf.org/api-docs/apiLive.htm#interact ]
+ <br/> You can Try The API From Your Browser itself at [ https://demo.mifos.io/api-docs/apiLive.htm#interact ]
- <br/> The Generic Options are available at [ https://demo.openmf.org/api-docs/apiLive.htm#genopts ]
+ <br/> The Generic Options are available at [ https://demo.mifos.io/api-docs/apiLive.htm#genopts ]
- <br/> Find out more about Updating Dates and Numbers at [ https://demo.openmf.org/api-docs/apiLive.htm#dates_and_numbers ]
+ <br/> Find out more about Updating Dates and Numbers at [ https://demo.mifos.io/api-docs/apiLive.htm#dates_and_numbers ]
- <br/> For the Authentication and the Basic of HTTP and HTTPS refer [ https://demo.openmf.org/api-docs/apiLive.htm#authentication_overview ]
+ <br/> For the Authentication and the Basic of HTTP and HTTPS refer [ https://demo.mifos.io/api-docs/apiLive.htm#authentication_overview ]
- <br/> Check about ERROR codes at [ https://demo.openmf.org/api-docs/apiLive.htm#errors ]
+ <br/> Check about ERROR codes at [ https://demo.mifos.io/api-docs/apiLive.htm#errors ]
- <br/> <br/> Please refer to the old documentation for any documentation queries [ https://demo.openmf.org/api-docs/apiLive.htm ]
+ <br/> <br/> Please refer to the old documentation for any documentation queries [ https://demo.mifos.io/api-docs/apiLive.htm ]
<br/>
______________________________________________________________________________________________________________________________
@@ -62,9 +62,9 @@
<property name="license" value="Apache 2.0" />
<property name="schemes" value="https" />
- <property name="host" value="https://demo.openmf.org" />
+ <property name="host" value="https://demo.mifos.io" />
<property name="basePath" value="fineract-provider/api/v1"/>
- <property name="termsOfServiceUrl" value="https://demo.openmf.org/api-docs/apiLive.htm"/>
+ <property name="termsOfServiceUrl" value="https://demo.mifos.io/api-docs/apiLive.htm"/>
<property name="contact" value="https://gitter.im/openMF/mifos"/>
<!--<property name="resourcePackage" value="io.swagger.resources"/>-->
<property name="resourcePackage" value="org.apache.fineract"/>