testPullCli

pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>2.2.6.RELEASE</version>
+        <version>2.3.8.RELEASE</version>
         <relativePath/> <!-- lookup parent from repository -->
     </parent>
     <groupId>cc.altius.FASP.rest.webservice</groupId>
@@ -100,7 +100,12 @@
         </dependency>
         <dependency>
             <groupId>org.springdoc</groupId>
-            <artifactId>springdoc-openapi-data-rest</artifactId>
+            <artifactId>springdoc-openapi-webmvc-core</artifactId>
+            <version>1.3.1</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-security</artifactId>
             <version>1.3.1</version>
         </dependency>
         <!-- API, java.xml.bind module -->
@@ -154,6 +159,19 @@
                     <executable>true</executable>
                 </configuration>
             </plugin>
+            <!--            <plugin>
+                <groupId>org.springdoc</groupId>
+                <artifactId>springdoc-openapi-maven-plugin</artifactId>
+                <version>1.1</version>
+                <executions>
+                    <execution>
+                        <id>integration-test</id>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>-->
         </plugins>
     </build>
 

src/main/java/cc/altius/FASP/WebApplication.java

@@ -1,11 +1,24 @@
 package cc.altius.FASP;
 
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.info.Contact;
+import io.swagger.v3.oas.annotations.info.Info;
+import io.swagger.v3.oas.annotations.info.License;
+import io.swagger.v3.oas.annotations.servers.Server;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.scheduling.annotation.EnableScheduling;
 
+@OpenAPIDefinition(
+            info = @Info(
+                    title = "Quantification and Analytics Tool",
+                    description = "API's to access the QAT Server",
+                    license = @License(name = "Apache 2.0", url = "https://foo.bar"),
+                    contact = @Contact(url = "https://www.quantificationanalytics.org", name = "FASP team", email = "HSS_FASP_HQ@ghsc-psm.org")
+            ), servers = @Server(url = "https://www.quantificationanalytics.org", description = "Production server for QAT")
+    )
 @SpringBootApplication
 @EnableScheduling
 @ComponentScan(basePackages = {"cc.altius.FASP"})

src/main/java/cc/altius/FASP/jwt/JWTWebSecurityConfig.java

@@ -74,13 +74,6 @@ protected void configure(HttpSecurity httpSecurity) throws Exception {
                 .exceptionHandling().authenticationEntryPoint(jwtUnAuthorizedResponseAuthenticationEntryPoint).and()
                 .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS).and()
                 .authorizeRequests()
-//                .antMatchers("/actuator/info").permitAll()
-                //                .antMatchers("/api/healthArea/**").access("hasRole('ROLE_BF_UPDATE_REALM_MASTER')")
-                //                .antMatchers("/api/organisation/**").access("hasRole('ROLE_BF_UPDATE_REALM_MASTER')")
-                //                .antMatchers("/api/unit/**").access("hasRole('ROLE_BF_UPDATE_APPL_MASTER')")
-                //                .antMatchers(HttpMethod.POST, "/api/realm/**").access("hasAnyRole('ROLE_BF_UPDATE_APPL_MASTER')")
-                //                .antMatchers(HttpMethod.PUT, "/api/realm/**").access("hasAnyRole('ROLE_BF_UPDATE_APPL_MASTER', 'ROLE_BF_UPDATE_REALM_MASTER')")
-                //                .antMatchers("/api/realmCountry/**").access("hasRole('ROLE_BF_UPDATE_REALM_MASTER')")
                 .anyRequest().authenticated();
 
         httpSecurity
@@ -109,14 +102,14 @@ public void configure(WebSecurity webSecurity) throws Exception {
                 .and().ignoring().antMatchers("/browser**")
                 .and().ignoring().antMatchers("/file**")
                 .and().ignoring().antMatchers("/file/**")
-                //                .and().ignoring().antMatchers("/v2/api-docs", "/configuration/ui", "/swagger-resources", "/swagger-resources/configuration/security", "/swagger-ui.html**", "/swagger-resources/configuration/ui")
+                .and().ignoring().antMatchers("/v3/api-docs", "/configuration/ui", "/swagger-resources", "/swagger-resources/configuration/security", "/swagger-ui.html**", "/swagger-resources/configuration/ui")
                 .and().ignoring().antMatchers("/api/locales/*/**")
-                .and().ignoring().antMatchers("/api/forgotPassword/**")
+                .and().ignoring().antMatchers("/api/user/forgotPassword/**")
                 .and().ignoring().antMatchers("/api/getForgotPasswordToken/**")
-                .and().ignoring().antMatchers("/api/confirmForgotPasswordToken/**")
-                .and().ignoring().antMatchers("/api/updatePassword/**")
+                .and().ignoring().antMatchers("/api/user/confirmForgotPasswordToken/**")
+                .and().ignoring().antMatchers("/api/user/updatePassword/**")
                 //                .and().ignoring().antMatchers("/api/user/**")
-                .and().ignoring().antMatchers("/api/updateExpiredPassword/**")
+                .and().ignoring().antMatchers("/api/user/updateExpiredPassword/**")
                 .and().ignoring().antMatchers("/exportSupplyPlan/**")
                 .and().ignoring().antMatchers("/exportProgramData/**")
                 .and().ignoring().antMatchers("/exportOrderData/**")

src/main/java/cc/altius/FASP/rest/controller/BudgetRestController.java

@@ -10,6 +10,11 @@
 import cc.altius.FASP.model.ResponseCode;
 import cc.altius.FASP.service.BudgetService;
 import cc.altius.FASP.service.UserService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.Parameters;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -31,7 +36,7 @@
  * @author akil
  */
 @RestController
-@RequestMapping("/api")
+@RequestMapping("/api/budget")
 public class BudgetRestController {
 
     private final Logger logger = LoggerFactory.getLogger(this.getClass());
@@ -40,8 +45,42 @@ public class BudgetRestController {
     @Autowired
     private UserService userService;
 
-    @PostMapping(path = "/budget")
-    public ResponseEntity postBudget(@RequestBody Budget budget, Authentication auth) {
+    /**
+     * API used to get the complete Budget list
+     *
+     * @param auth
+     * @return returns the complete list of Budgets List<Budget>
+     */
+    @GetMapping("/")
+    @Operation(description = "Returns the complete list of Budgets List<Budget>", summary = "Get Budget list", tags = ("budget"))
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "200", description = "Returns the Budget list")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "500", description = "Internal error that prevented the retreival of Budget list")
+    public ResponseEntity getBudgetList(Authentication auth) {
+        try {
+            CustomUserDetails curUser = this.userService.getCustomUserByUserId(((CustomUserDetails) auth.getPrincipal()).getUserId());
+            return new ResponseEntity(this.budgetService.getBudgetList(curUser), HttpStatus.OK);
+        } catch (Exception e) {
+            logger.error("Error while trying to get Budget list", e);
+            return new ResponseEntity(new ResponseCode("static.message.listFailed"), HttpStatus.INTERNAL_SERVER_ERROR);
+        }
+    }
+
+    /**
+     * API used to add a Budget to the Realm
+     *
+     * @param budget Budget object that you want to add to the Realm
+     * @param auth
+     * @return returns a Success code if the operation was successful
+     */
+    @PostMapping(path = "/")
+    @Operation(description = "API used to add a Budget to the Realm", summary = "Add Budget", tags = ("budget"))
+    @Parameters(
+            @Parameter(name = "budget", description = "The Budget object that you want to add to the Realm"))
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "200", description = "Returns a Success code if the operation was successful")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "403", description = "Returns a HttpStatus.FORBIDDEN if the User does not have access to add the Budget")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "404", description = "Returns a HttpStatus.NOT_FOUND if the some of the underlying data does not match.")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "500", description = "Returns a HttpStatus.INTERNAL_SERVER_ERROR if there was some other error that did not allow the operation to complete")
+    public ResponseEntity addBudget(@RequestBody Budget budget, Authentication auth) {
         try {
             CustomUserDetails curUser = this.userService.getCustomUserByUserId(((CustomUserDetails) auth.getPrincipal()).getUserId());
             this.budgetService.addBudget(budget, curUser);
@@ -58,8 +97,21 @@ public ResponseEntity postBudget(@RequestBody Budget budget, Authentication auth
         }
     }
 
-    @PutMapping(path = "/budget")
-    public ResponseEntity putBudget(@RequestBody Budget budget, Authentication auth) {
+    /**
+     * API used to update a Budget
+     *
+     * @param budget Budget object that you want to update
+     * @param auth
+     * @return returns a Success code if the operation was successful
+     */
+    @PutMapping(path = "/")
+    @Operation(description = "API used to update a Budget", summary = "Update Budget", tags = ("budget"))
+    @Parameters(
+            @Parameter(name = "budget", description = "The Budget object that you want to update"))
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "200", description = "Returns a Success code if the operation was successful")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "403", description = "Returns a HttpStatus.FORBIDDEN if the User does not have access to add the Budget")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "500", description = "Returns a HttpStatus.INTERNAL_SERVER_ERROR if there was some other error that did not allow the operation to complete")
+    public ResponseEntity updateBudget(@RequestBody Budget budget, Authentication auth) {
         try {
             CustomUserDetails curUser = this.userService.getCustomUserByUserId(((CustomUserDetails) auth.getPrincipal()).getUserId());
             int rows = this.budgetService.updateBudget(budget, curUser);
@@ -73,8 +125,21 @@ public ResponseEntity putBudget(@RequestBody Budget budget, Authentication auth)
         }
     }
 
-    @PostMapping("/budget/programIds")
-    public ResponseEntity getBudget(@RequestBody String[] programIds, Authentication auth) {
+    /**
+     * API used to get the Budget list for a list of Program Ids
+     *
+     * @param programIds List of ProgramIds that you want to the list of Budgets
+     * for
+     * @param auth
+     * @return returns the list of Budgets based on Program Ids specified
+     */
+    @PostMapping("/programIds")
+    @Operation(description = "API used to get the Budget list for a list of Program Ids", summary = "Get Budget list for Program Ids", tags = ("budget"))
+    @Parameters(
+            @Parameter(name = "programIds", description = "List of Program Ids that you want to the Budgets for"))
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "200", description = "Returns the Budget list")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "500", description = "Internal error that prevented the retreival of Budget list")
+    public ResponseEntity getBudgetForProgramIds(@RequestBody String[] programIds, Authentication auth) {
         try {
             CustomUserDetails curUser = this.userService.getCustomUserByUserId(((CustomUserDetails) auth.getPrincipal()).getUserId());
             return new ResponseEntity(this.budgetService.getBudgetListForProgramIds(programIds, curUser), HttpStatus.OK);
@@ -84,19 +149,22 @@ public ResponseEntity getBudget(@RequestBody String[] programIds, Authentication
         }
     }
 
-    @GetMapping("/budget")
-    public ResponseEntity getBudget(Authentication auth) {
-        try {
-            CustomUserDetails curUser = this.userService.getCustomUserByUserId(((CustomUserDetails) auth.getPrincipal()).getUserId());
-            return new ResponseEntity(this.budgetService.getBudgetList(curUser), HttpStatus.OK);
-        } catch (Exception e) {
-            logger.error("Error while trying to get Budget list", e);
-            return new ResponseEntity(new ResponseCode("static.message.listFailed"), HttpStatus.INTERNAL_SERVER_ERROR);
-        }
-    }
-
-    @GetMapping("/budget/{budgetId}")
-    public ResponseEntity getBudget(@PathVariable("budgetId") int budgetId, Authentication auth) {
+    /**
+     * API used to get the Budget for a specific BudgetId
+     *
+     * @param budgetId BudgetId that you want the Budget Object for
+     * @param auth
+     * @return returns the list the Budget object based on BudgetId specified
+     */
+    @GetMapping("/{budgetId}")
+    @Operation(description = "API used to get the Budget for a specific BudgetId", summary = "Get Budget for a BudgetId", tags = ("budget"))
+    @Parameters(
+            @Parameter(name = "budgetId", description = "BudgetId that you want to the Budget for"))
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "200", description = "Returns the Budget")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "403", description = "Returns a HttpStatus.FORBIDDEN if the User does not have access to the Budget")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "404", description = "Returns a HttpStatus.NOT_FOUND if the BudgetId specified does not exist")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "500", description = "Internal error that prevented the retreival of Budget")
+    public ResponseEntity getBudgetById(@PathVariable("budgetId") int budgetId, Authentication auth) {
         try {
             CustomUserDetails curUser = this.userService.getCustomUserByUserId(((CustomUserDetails) auth.getPrincipal()).getUserId());
             return new ResponseEntity(this.budgetService.getBudgetById(budgetId, curUser), HttpStatus.OK);
@@ -112,7 +180,21 @@ public ResponseEntity getBudget(@PathVariable("budgetId") int budgetId, Authenti
         }
     }
 
-    @GetMapping("/budget/realmId/{realmId}")
+    /**
+     * API used to get all the Budgets for a specific Realm
+     *
+     * @param realmId RealmId that you want the List of Budgets for
+     * @param auth
+     * @return returns the list the Budgets based on RealmId specified
+     */
+    @GetMapping("/realmId/{realmId}")
+    @Operation(description = "API used to get the Budget for a specific BudgetId", summary = "Get Budget for a Realm", tags = ("budget"))
+    @Parameters(
+            @Parameter(name = "realmId", description = "RealmId that you want the List of Budgets for"))
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "200", description = "Returns the List of Budgets for that Realm")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "403", description = "Returns a HttpStatus.FORBIDDEN if the User does not have access to the Realm")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "404", description = "Returns a HttpStatus.NOT_FOUND if the RealmId specified does not exist")
+    @ApiResponse(content = @Content(mediaType = "text/json"), responseCode = "500", description = "Internal error that prevented the retreival of Budget")
     public ResponseEntity getBudgetForRealm(@PathVariable("realmId") int realmId, Authentication auth) {
         try {
             CustomUserDetails curUser = this.userService.getCustomUserByUserId(((CustomUserDetails) auth.getPrincipal()).getUserId());