From 20d02c9542181be851dae33d9029d5d119540043 Mon Sep 17 00:00:00 2001 From: Gaurav Mishra Date: Fri, 13 Dec 2024 21:24:14 +0530 Subject: [PATCH] fix(doc): fix OpenAPI docs for report controller Signed-off-by: Gaurav Mishra --- .../resourceserver/project/ProjectController.java | 12 ++++++------ .../resourceserver/report/SW360ReportController.java | 8 ++++++-- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/ProjectController.java b/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/ProjectController.java index 5fdfb40654..d39ae9c5e8 100644 --- a/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/ProjectController.java +++ b/rest/resource-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 getLicenseObligations(Pageable pageable, @@ -2772,7 +2772,7 @@ public ResponseEntity 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 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/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/report/SW360ReportController.java b/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/report/SW360ReportController.java index 438eaf4a37..4dcdf2fac3 100644 --- a/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/report/SW360ReportController.java +++ b/rest/resource-server/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()); } } -} \ No newline at end of file +}