FINERACT-1608: Add introduction to Asciidoc

fineract-provider/build.gradle

@@ -70,9 +70,9 @@ resolve {
     prettyPrint = false
     classpath = sourceSets.main.runtimeClasspath
     outputDir = file("${buildDir}/classes/java/main/static")
-    // openApiFile = file("${buildDir}/tmp/swagger/fineract-input.yaml")
+    openApiFile = file("${buildDir}/tmp/swagger/fineract-input.yaml")
     sortOutput = true
-    // dependsOn(prepareInputYaml)
+    dependsOn(prepareInputYaml)
 }
 
 configurations {

fineract-provider/config/swagger/fineract-input.yaml.template

@@ -1,13 +1,13 @@
 openapi: 3.0.3
 info:
   version: @VERSION@
-  title: Apache Fineract
+  title: Apache Fineract REST API
   description: |-
     Apache Fineract is a secure, multi-tenanted microfinance platform.
     The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform.
-    The <a href="https://cui.fineract.dev" target="_blank">reference app</a> (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation.
-    Until we complete the new REST API documentation you still have the legacy documentation available <a href="../legacy-docs/apiLive.htm" target="_blank">here</a>.
-    Please check <a href="https://fineract.apache.org/docs/current" target="_blank">the Fineract documentation</a> for more information.
+    The https://cui.fineract.dev[reference app] (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation.
+    Until we complete the new REST API documentation you still have the legacy documentation available https://fineract.apache.org/legacy-docs/apiLive.htm[here].
+    Please check https://fineract.apache.org/docs/current[the Fineract documentation] for more information.
   contact:
     email: dev@fineract.apache.org
   license:

fineract-provider/src/main/java/org/apache/fineract/infrastructure/survey/api/SurveyApiResource.java

@@ -119,8 +119,7 @@ public class SurveyApiResource {
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Create an entry in the survey table", description = "Insert and entry in a survey table (full fill the survey)."
-            + "\n" + "\n"
-            + "Refer Link for sample Body:  [ https://demo.fineract.dev/fineract-provider/legacy-docs/apiLive.htm#survey_create ] ")
+            + "\n" + "\n" + "Refer Link for sample Body:  [ https://fineract.apache.org/legacy-docs/apiLive.htm#survey_create ] ")
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = SurveyApiResourceSwagger.PostSurveySurveyNameApptableIdRequest.class)))
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = SurveyApiResourceSwagger.PostSurveySurveyNameApptableIdResponse.class))) })

fineract-provider/src/main/java/org/apache/fineract/portfolio/accounts/api/AccountsApiResource.java

@@ -200,7 +200,7 @@ public class AccountsApiResource {
             + "requestedDate is requsted date of shares redeem\n" + "\n" + "requestedShares is number of shares to be redeemed\n\n"
             + "Mandatory Fields: dateFormat,locale,requestedDate,requestedShares\n\n"
             + "Showing request/response for 'Reject additional shares request on a share account'\n\n"
-            + "For more info visit this link - https://demo.fineract.dev/fineract-provider/legacy-docs/apiLive.htm#shareaccounts")
+            + "For more info visit this link - https://fineract.apache.org/legacy-docs/apiLive.htm#shareaccounts")
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = AccountsApiResourceSwagger.PostAccountsTypeAccountIdRequest.class)))
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = AccountsApiResourceSwagger.PostAccountsTypeAccountIdResponse.class))) })

fineract-provider/src/main/java/org/apache/fineract/portfolio/self/security/api/SelfAuthenticationApiResource.java

@@ -53,7 +53,7 @@ public class SelfAuthenticationApiResource {
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Verify authentication", description = "Authenticates the credentials provided and returns the set roles and permissions allowed.\n\n"
-            + "Please visit this link for more info - https://demo.fineract.dev/fineract-provider/legacy-docs/apiLive.htm#selfbasicauth")
+            + "Please visit this link for more info - https://fineract.apache.org/legacy-docs/apiLive.htm#selfbasicauth")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = SelfAuthenticationApiResourceSwagger.PostSelfAuthenticationResponse.class))) })
     public String authenticate(final String apiRequestBodyAsJson) {

fineract-provider/src/main/java/org/apache/fineract/portfolio/self/security/api/SelfUserDetailsApiResource.java

@@ -52,7 +52,7 @@ public class SelfUserDetailsApiResource {
     @GET
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Fetch authenticated user details", description = "Checks the Authentication and returns the set roles and permissions allowed\n\n"
-            + "For more info visit this link - https://demo.fineract.dev/fineract-provider/legacy-docs/apiLive.htm#selfoauth")
+            + "For more info visit this link - https://fineract.apache.org/legacy-docs/apiLive.htm#selfoauth")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = SelfUserDetailsApiResourceSwagger.GetSelfUserDetailsResponse.class))) })
     public String fetchAuthenticatedUserData() {

fineract-provider/src/test/java/org/apache/fineract/infrastructure/classpath/ClasspathDuplicatesStepDefinitions.java

@@ -35,10 +35,13 @@ public class ClasspathDuplicatesStepDefinitions implements En {
     private ClassGraph classGraph;
 
     public ClasspathDuplicatesStepDefinitions() {
+        // tag::given[]
         Given("A class graph", () -> {
             this.classGraph = new ClassGraph();
         });
+        // end::given[]
 
+        // tag::when[]
         When("The user scans the class graph", () -> {
             // nothing to do here
             try (ScanResult scanResult = this.classGraph.scan()) {
@@ -61,12 +64,15 @@ public class ClasspathDuplicatesStepDefinitions implements En {
                 }
             }
         });
+        // end::when[]
 
+        // tag::then[]
         Then("There should be no duplicates", () -> {
             if (!duplicates.isEmpty()) {
                 throw new AssertionFailedError(duplicates.size() + " Classpath duplicates detected:\n" + duplicates);
             }
         });
+        // end::then[]
     }
 
     private boolean skipJAR(String jarPath) {