fix(doc): fix OpenAPI docs for report controller

Signed-off-by: Gaurav Mishra <mishra.gaurav@siemens.com>
eclipse-sw360 · Dec 18, 2024 · 20d02c9 · 20d02c9
1 parent f59e3b0
commit 20d02c9
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/...server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/ProjectController.java b/...server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/ProjectController.java
@@ -2643,7 +2643,7 @@ public void getlicenseClearingCount(HttpServletResponse response ,
 
     @Operation(
             description = "Get license obligations data from license database.",
-            tags = {"Project"}
+            tags = {"Projects"}
     )
     @RequestMapping(value = PROJECTS_URL + "/{id}/licenseDbObligations", method = RequestMethod.GET)
 	public ResponseEntity<?> getLicObligations(Pageable pageable,
@@ -2733,7 +2733,7 @@ public ResponseEntity<?> removeOrphanObligation(
 
     @Operation(
             description = "Get license obligation data of project tab.",
-            tags = {"Project"}
+            tags = {"Projects"}
     )
     @RequestMapping(value = PROJECTS_URL + "/{id}/licenseObligations", method = RequestMethod.GET)
 	public ResponseEntity<HalResource> getLicenseObligations(Pageable pageable,
@@ -2772,7 +2772,7 @@ public ResponseEntity<HalResource> getLicenseObligations(Pageable pageable,
 
     @Operation(
             description = "Get obligation data of project tab.",
-            tags = {"Project"}
+            tags = {"Projects"}
     )
     @RequestMapping(value = PROJECTS_URL + "/{id}/obligation", method = RequestMethod.GET)
     public ResponseEntity<HalResource> getObligations(Pageable pageable,
@@ -3289,7 +3289,7 @@ public ResponseEntity<?> createClearingRequest(
 
     @Operation(
             description = "Get linked releases information in project's dependency network.",
-            tags = {"Project"}
+            tags = {"Projects"}
     )
     @RequestMapping(value = PROJECTS_URL + "/network/{id}/linkedReleases", method = RequestMethod.GET)
     public ResponseEntity<?> getLinkedReleasesInNetwork(
@@ -3305,7 +3305,7 @@ public ResponseEntity<?> getLinkedReleasesInNetwork(
 
     @Operation(
             description = "Get linked releases information of linked projects.",
-            tags = {"Project"}
+            tags = {"Projects"}
     )
     @RequestMapping(value = PROJECTS_URL + "/{id}/subProjects/releases", method = RequestMethod.GET)
     public ResponseEntity<?> getLinkedReleasesOfLinkedProjects(
@@ -3322,7 +3322,7 @@ public ResponseEntity<?> getLinkedReleasesOfLinkedProjects(
 
     @Operation(
             description = "Compare dependency network with default network (relationships between releases).",
-            tags = {"Project"}
+            tags = {"Projects"}
     )
     @RequestMapping(value = PROJECTS_URL + "/network/compareDefaultNetwork", method = RequestMethod.POST)
     public ResponseEntity<?> compareDependencyNetworkWithDefaultNetwork(

diff --git a/...ver/src/main/java/org/eclipse/sw360/rest/resourceserver/report/SW360ReportController.java b/...ver/src/main/java/org/eclipse/sw360/rest/resourceserver/report/SW360ReportController.java
@@ -83,7 +83,11 @@ public void getProjectReport(
             @RequestParam(value = "mimetype", required = false, defaultValue = "xlsx") String mimeType,
             @Parameter(description = "Project id.")
             @RequestParam(value = "projectId", required = false) String projectId,
-            @Parameter(description = "Module name.", schema = @Schema(allowableValues = {SW360Constants.PROJECTS, SW360Constants.COMPONENTS, SW360Constants.LICENSES, LICENSES_RESOURCE_BUNDLE, SW360Constants.PROJECT_RELEASE_SPREADSHEET_WITH_ECCINFO}))
+            @Parameter(description = "Module name.", schema = @Schema(allowableValues = {
+                    SW360Constants.PROJECTS, SW360Constants.COMPONENTS, SW360Constants.LICENSES,
+                    LICENSE_INFO, LICENSES_RESOURCE_BUNDLE, SW360Constants.PROJECT_RELEASE_SPREADSHEET_WITH_ECCINFO,
+                    EXPORT_CREATE_PROJ_CLEARING_REPORT
+            }))
             @RequestParam(value = "module", required = true) String module,
             @Parameter(description = "Exclude release version from the license info file")
             @RequestParam(value = "excludeReleaseVersion", required = false, defaultValue = "false") boolean excludeReleaseVersion,
@@ -337,4 +341,4 @@ private void getProjectReleaseWithEccSpreadSheet(HttpServletResponse response, U
             throw new TException(e.getMessage());
         }
     }
-}
+}