TSK-1687: Added Rest Docs for WorkbasketPriorityReport

rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc

@@ -138,6 +138,7 @@ include::{snippets}/WorkbasketAccessItemControllerRestDocTest/removeWorkbasketAc
 == Monitoring Resources
 
 include::{snippets}/MonitorControllerRestDocTest/computeWorkbasketReportDocTest/auto-section.adoc[]
+include::{snippets}/MonitorControllerRestDocTest/computeWorkbasketPriorityReportDocTest/auto-section.adoc[]
 include::{snippets}/MonitorControllerRestDocTest/computeClassificationCategoryReportDocTest/auto-section.adoc[]
 include::{snippets}/MonitorControllerRestDocTest/computeClassificationReportDocTest/auto-section.adoc[]
 include::{snippets}/MonitorControllerRestDocTest/computeDetailedClassificationReportDocTest/auto-section.adoc[]

rest/taskana-rest-spring/src/main/java/pro/taskana/monitor/rest/MonitorController.java

@@ -82,28 +82,23 @@ public class MonitorController {
   }
 
   /**
-   * This endpoint generates a Workbasket Report by priority. This Report currently
+   * This endpoint generates a Workbasket Report by priority ranges.
    *
    * <p>Each Row represents a Workbasket.
    *
    * <p>Each Column Header represents a priority range. <br>
    * <br>
    *
-   * <table>
+   * <p><b>Default ranges</b>
-   *   <caption><b>Default ranges</b></caption>
-   *  <tr>
-   *    <td> high </td> <td>priority &gt; 500</td>
-   *  </tr>
-   *  <tr>
-   *    <td> medium </td> <td> 250 &ge; priority &le; 500</td>
-   *  </tr>
-   *  <tr>
-   *    <td> low </td> <td> priority &lt; 250</td>
-   *  </tr>
-   * </table>
    *
-   * @title Compute a Workbasket Report
+   * <p>High: priority &gt; 500
-   * @param workbasketTypes determine the {@linkplain WorkbasketType}s to include in the report
+   *
+   * <p>Medium: 250 &ge; priority &le; 500
+   *
+   * <p>Low: priority &lt; 250
+   *
+   * @title Compute a Workbasket Priority Report
+   * @param workbasketTypes determine the WorkbasketTypes to include in the report
    * @return the computed Report
    * @throws NotAuthorizedException if the current user is not authorized to compute the Report
    * @throws InvalidArgumentException if topicWorkbaskets or useDefaultValues are false
@@ -111,7 +106,7 @@ public class MonitorController {
   @GetMapping(path = RestEndpoints.URL_MONITOR_WORKBASKET_PRIORITY_REPORT)
   @Transactional(readOnly = true, rollbackFor = Exception.class)
   public ResponseEntity<ReportRepresentationModel> computePriorityWorkbasketReport(
-      @RequestParam(name = "workbasket-types", required = false) WorkbasketType[] workbasketTypes)
+      @RequestParam(name = "workbasket-type", required = false) WorkbasketType[] workbasketTypes)
       throws NotAuthorizedException, InvalidArgumentException {
 
     WorkbasketPriorityReport.Builder builder =
@@ -318,7 +313,7 @@ public class MonitorController {
    *
    * <p>Each Column Header represents a TimeInterval.
    *
-   * @title Get a Timestamp Report
+   * @title Compute a Timestamp Report
    * @param filterParameter the filter parameter
    * @param timestamps Filter by the Task Timestamp of the task
    * @return the computed report

rest/taskana-rest-spring/src/test/java/pro/taskana/monitor/rest/MonitorControllerIntTest.java

@@ -109,7 +109,7 @@ class MonitorControllerIntTest {
   void should_ComputeReport_When_QueryingForAWorkbasketPriorityReport() {
     String url =
         restHelper.toUrl(RestEndpoints.URL_MONITOR_WORKBASKET_PRIORITY_REPORT)
-            + "?workbasket-types=TOPIC,GROUP";
+            + "?workbasket-type=TOPIC,GROUP";
     HttpEntity<?> auth = new HttpEntity<>(RestHelper.generateHeadersForUser("monitor"));
 
     ResponseEntity<ReportRepresentationModel> response =

rest/taskana-rest-spring/src/test/java/pro/taskana/monitor/rest/MonitorControllerRestDocTest.java

@@ -20,6 +20,14 @@ class MonitorControllerRestDocTest extends BaseRestDocTest {
         .andExpect(MockMvcResultMatchers.status().isOk());
   }
 
+  @Test
+  void computeWorkbasketPriorityReportDocTest() throws Exception {
+    mockMvc
+        .perform(
+            get(RestEndpoints.URL_MONITOR_WORKBASKET_PRIORITY_REPORT + "?workbasket-type=GROUP"))
+        .andExpect(MockMvcResultMatchers.status().isOk());
+  }
+
   @Test
   void computeClassificationCategoryReportDocTest() throws Exception {
     mockMvc