From 9afd847cc1a5bd7d10062e14eff10cf2cdfa445d Mon Sep 17 00:00:00 2001 From: Avgustin Marinov Date: Thu, 8 Feb 2024 15:11:05 +0200 Subject: [PATCH] REST doc / Mgmt Software Modules Types - fix missed info (#1626) When spring restdoc was replaces with swagger & open api some info was lost This commit returns back this info for Mgmt API - SoftwareModules Types Signed-off-by: Marinov Avgustin --- .../api/MgmtDistributionSetTagRestApi.java | 43 +++++++---- .../api/MgmtDistributionSetTypeRestApi.java | 17 +++-- .../rest/api/MgmtDownloadArtifactRestApi.java | 12 +-- .../mgmt/rest/api/MgmtDownloadRestApi.java | 10 +-- .../mgmt/rest/api/MgmtRolloutRestApi.java | 74 +++++++++++++------ .../api/MgmtSoftwareModuleTypeRestApi.java | 34 ++++++--- 6 files changed, 122 insertions(+), 68 deletions(-) diff --git a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDistributionSetTagRestApi.java b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDistributionSetTagRestApi.java index 51d529177..51f7b375b 100644 --- a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDistributionSetTagRestApi.java +++ b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDistributionSetTagRestApi.java @@ -114,7 +114,8 @@ public interface MgmtDistributionSetTagRestApi { * * @return a single distribution set tag with status OK. */ - @Operation(summary = "Return single Distribution Set Tag", description = "Handles the GET request of retrieving a single distribution set tag.") + @Operation(summary = "Return single Distribution Set Tag", + description = "Handles the GET request of retrieving a single distribution set tag.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -125,7 +126,8 @@ public interface MgmtDistributionSetTagRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Distribution Set Tag not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Distribution Set Tag not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -148,7 +150,8 @@ public interface MgmtDistributionSetTagRestApi { * with status code 201 - Created. The Response Body contains the * created distribution set tags but without details. */ - @Operation(summary = "Creates new Distribution Set Tags", description = "Handles the POST request of creating new distribution set tag. The request body must always be a list of distribution set tags.") + @Operation(summary = "Creates new Distribution Set Tags", description = "Handles the POST request of creating " + + "new distribution set tag. The request body must always be a list of distribution set tags.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -189,7 +192,8 @@ public interface MgmtDistributionSetTagRestApi { * @return status OK if update is successful and the updated distribution * set tag. */ - @Operation(summary = "Update Distribution Set Tag", description = "Handles the PUT request of updating a distribution set tag.") + @Operation(summary = "Update Distribution Set Tag", + description = "Handles the PUT request of updating a distribution set tag.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -200,7 +204,8 @@ public interface MgmtDistributionSetTagRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Distribution Set Tag not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Distribution Set Tag not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -230,7 +235,8 @@ public interface MgmtDistributionSetTagRestApi { * @return status OK if delete as successfully. * */ - @Operation(summary = "Delete a single distribution set tag", description = "Handles the DELETE request of deleting a single distribution set tag.") + @Operation(summary = "Delete a single distribution set tag", + description = "Handles the DELETE request of deleting a single distribution set tag.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -241,7 +247,8 @@ public interface MgmtDistributionSetTagRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Distribution Set Tag not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Distribution Set Tag not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -280,7 +287,8 @@ public interface MgmtDistributionSetTagRestApi { * * @return the list of assigned distribution sets. */ - @Operation(summary = "Return all assigned distribution sets by given tag Id", description = "Handles the GET request of retrieving a list of assigned distributions.") + @Operation(summary = "Return all assigned distribution sets by given tag Id", + description = "Handles the GET request of retrieving a list of assigned distributions.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -291,7 +299,8 @@ public interface MgmtDistributionSetTagRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Distribution Set Tag not found", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Distribution Set Tag not found", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -340,7 +349,9 @@ public interface MgmtDistributionSetTagRestApi { * @return the list of assigned distribution sets and unassigned * distribution sets. */ - @Operation(summary = "Toggle the assignment of distribution sets by the given tag id", description = "Handles the POST request of toggle distribution assignment. The request body must always be a list of distribution set ids.") + @Operation(summary = "Toggle the assignment of distribution sets by the given tag id", + description = "Handles the POST request of toggle distribution assignment. The request body must " + + "always be a list of distribution set ids.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -381,7 +392,9 @@ public interface MgmtDistributionSetTagRestApi { * * @return the list of assigned distribution set. */ - @Operation(summary = "Assign distribution sets to the given tag id", description = "Handles the POST request of distribution assignment. Already assigned distribution will be ignored.") + @Operation(summary = "Assign distribution sets to the given tag id", + description = "Handles the POST request of distribution assignment. Already assigned distribution will " + + "be ignored.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -424,7 +437,8 @@ public interface MgmtDistributionSetTagRestApi { * the ID of the distribution set to unassign * @return http status code */ - @Operation(summary = "Unassign one distribution set from the given tag id", description = "Handles the DELETE request of unassign the given distribution.") + @Operation(summary = "Unassign one distribution set from the given tag id", + description = "Handles the DELETE request of unassign the given distribution.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -435,7 +449,8 @@ public interface MgmtDistributionSetTagRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Distribution Set Tag not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Distribution Set Tag not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -449,4 +464,4 @@ public interface MgmtDistributionSetTagRestApi { ResponseEntity unassignDistributionSet(@PathVariable("distributionsetTagId") Long distributionsetTagId, @PathVariable("distributionsetId") Long distributionsetId); -} +} \ No newline at end of file diff --git a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDistributionSetTypeRestApi.java b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDistributionSetTypeRestApi.java index 75418bfad..c8921a806 100644 --- a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDistributionSetTypeRestApi.java +++ b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDistributionSetTypeRestApi.java @@ -117,7 +117,8 @@ public interface MgmtDistributionSetTypeRestApi { * * @return a single DS type with status OK. */ - @Operation(summary = "Return single Distribution Set Type", description = "Handles the GET request of retrieving a single distribution set type. Required Permission: READ_REPOSITORY") + @Operation(summary = "Return single Distribution Set Type", description = "Handles the GET request of retrieving a " + + "single distribution set type. Required Permission: READ_REPOSITORY") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -151,7 +152,8 @@ public interface MgmtDistributionSetTypeRestApi { * @return status OK if delete is successful. * */ - @Operation(summary = "Delete Distribution Set Type by Id", description = "Handles the DELETE request for a single distribution set type. Required Permission: DELETE_REPOSITORY") + @Operation(summary = "Delete Distribution Set Type by Id", description = "Handles the DELETE request for a single" + + " distribution set type. Required Permission: DELETE_REPOSITORY") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -184,7 +186,8 @@ public interface MgmtDistributionSetTypeRestApi { * the DS type to be updated. * @return status OK if update is successful */ - @Operation(summary = "Update Distribution Set Type", description = "Handles the PUT request for a single distribution set type. Required Permission: UPDATE_REPOSITORY") + @Operation(summary = "Update Distribution Set Type", description = "Handles the PUT request for a single " + + "distribution set type. Required Permission: UPDATE_REPOSITORY") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -230,7 +233,9 @@ public interface MgmtDistributionSetTypeRestApi { * failure the JsonResponseExceptionHandler is handling the * response. */ - @Operation(summary = "Create new distribution set types", description = "Handles the POST request for creating new distribution set types. The request body must always be a list of types. Required Permission: CREATE_REPOSITORY") + @Operation(summary = "Create new distribution set types", description = "Handles the POST request for creating " + + "new distribution set types. The request body must always be a list of types. " + + "Required Permission: CREATE_REPOSITORY") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -269,7 +274,9 @@ public interface MgmtDistributionSetTypeRestApi { * of the DistributionSetType. * @return Unpaged list of module types and OK in case of success. */ - @Operation(summary = "Return mandatory Software Module Types in a Distribution Set Type", description = "Handles the GET request of retrieving the list of mandatory software module types in that distribution set type. Required Permission: READ_REPOSITORY") + @Operation(summary = "Return mandatory Software Module Types in a Distribution Set Type", + description = "Handles the GET request of retrieving the list of mandatory software module types in that " + + "distribution set type. Required Permission: READ_REPOSITORY") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", diff --git a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDownloadArtifactRestApi.java b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDownloadArtifactRestApi.java index 3a2692a43..f02f41f74 100644 --- a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDownloadArtifactRestApi.java +++ b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDownloadArtifactRestApi.java @@ -28,14 +28,8 @@ public interface MgmtDownloadArtifactRestApi { /** * Handles the GET request for downloading an artifact. * - * @param softwareModuleId - * of the parent SoftwareModule - * @param artifactId - * of the related LocalArtifact - * @param servletResponse - * of the servlet - * @param request - * of the client + * @param softwareModuleId of the parent SoftwareModule + * @param artifactId of the related LocalArtifact * * @return responseEntity with status ok if successful */ @@ -45,4 +39,4 @@ public interface MgmtDownloadArtifactRestApi { ResponseEntity downloadArtifact(@PathVariable("softwareModuleId") Long softwareModuleId, @PathVariable("artifactId") Long artifactId); -} +} \ No newline at end of file diff --git a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDownloadRestApi.java b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDownloadRestApi.java index 0709d50cd..a219ff185 100644 --- a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDownloadRestApi.java +++ b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtDownloadRestApi.java @@ -29,12 +29,8 @@ public interface MgmtDownloadRestApi { /** * Handles the GET request for downloading an artifact. * - * @param tenant - * the download belongs to - * @param downloadId - * the generated download id - * @param response - * of the servlet + * @param tenant the download belongs to + * @param downloadId the generated download id * @return {@link ResponseEntity} with status {@link HttpStatus#OK} if * successful */ @@ -44,4 +40,4 @@ public interface MgmtDownloadRestApi { ResponseEntity downloadArtifactByDownloadId(@PathVariable("tenant") String tenant, @PathVariable("downloadId") String downloadId); -} +} \ No newline at end of file diff --git a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtRolloutRestApi.java b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtRolloutRestApi.java index 9196bb6a6..7e81c192a 100644 --- a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtRolloutRestApi.java +++ b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtRolloutRestApi.java @@ -59,7 +59,8 @@ public interface MgmtRolloutRestApi { * status OK. The response is always paged. In any failure the * JsonResponseExceptionHandler is handling the response. */ - @Operation(summary = "Return all Rollouts", description = "Handles the GET request of retrieving all rollouts. Required Permission: READ_ROLLOUT") + @Operation(summary = "Return all Rollouts", description = "Handles the GET request of retrieving all rollouts. " + + "Required Permission: READ_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -103,7 +104,9 @@ public interface MgmtRolloutRestApi { Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.""") String rsqlParam, - @RequestParam(value = MgmtRestConstants.REQUEST_PARAMETER_REPRESENTATION_MODE, defaultValue = MgmtRestConstants.REQUEST_PARAMETER_REPRESENTATION_MODE_DEFAULT) String representationModeParam); + @RequestParam(value = MgmtRestConstants.REQUEST_PARAMETER_REPRESENTATION_MODE, + defaultValue = MgmtRestConstants.REQUEST_PARAMETER_REPRESENTATION_MODE_DEFAULT) + String representationModeParam); /** * Handles the GET request of retrieving a single rollout. @@ -112,7 +115,8 @@ public interface MgmtRolloutRestApi { * the ID of the rollout to retrieve * @return a single rollout with status OK. */ - @Operation(summary = "Return single Rollout", description = "Handles the GET request of retrieving a single rollout. Required Permission: READ_ROLLOUT") + @Operation(summary = "Return single Rollout", description = "Handles the GET request of retrieving a single " + + "rollout. Required Permission: READ_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -123,7 +127,8 @@ public interface MgmtRolloutRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Rollout not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Rollout not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -146,7 +151,8 @@ public interface MgmtRolloutRestApi { * failure the JsonResponseExceptionHandler is handling the * response. */ - @Operation(summary = "Create a new Rollout", description = "Handles the POST request of creating new rollout. Required Permission: CREATE_ROLLOUT") + @Operation(summary = "Create a new Rollout", + description = "Handles the POST request of creating new rollout. Required Permission: CREATE_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -186,7 +192,10 @@ public interface MgmtRolloutRestApi { * @return OK response (200) if rollout is approved now. In case of any * exception the corresponding errors occur. */ - @Operation(summary = "Approve a Rollout", description = "Handles the POST request of approving a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT") + @Operation(summary = "Approve a Rollout", + description = "Handles the POST request of approving a created rollout. Only possible if approval " + + "workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. " + + "Required Permission: APPROVE_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -220,7 +229,9 @@ public interface MgmtRolloutRestApi { * @return OK response (200) if rollout is denied now. In case of any * exception the corresponding errors occur. */ - @Operation(summary = "Deny a Rollout", description = "Handles the POST request of denying a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT") + @Operation(summary = "Deny a Rollout", description = "Handles the POST request of denying a created rollout. " + + "Only possible if approval workflow is enabled in system configuration and rollout is in state " + + "WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -252,7 +263,8 @@ public interface MgmtRolloutRestApi { * @return OK response (200) if rollout could be started. In case of any * exception the corresponding errors occur. */ - @Operation(summary = "Start a Rollout", description = "Handles the POST request of starting a created rollout. Required Permission: HANDLE_ROLLOUT") + @Operation(summary = "Start a Rollout", description = "Handles the POST request of starting a created rollout. " + + "Required Permission: HANDLE_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -283,7 +295,8 @@ public interface MgmtRolloutRestApi { * @return OK response (200) if rollout could be paused. In case of any * exception the corresponding errors occur. */ - @Operation(summary = "Pause a Rollout", description = "Handles the POST request of pausing a running rollout. Required Permission: HANDLE_ROLLOUT") + @Operation(summary = "Pause a Rollout", description = "Handles the POST request of pausing a running rollout. " + + "Required Permission: HANDLE_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -314,7 +327,8 @@ public interface MgmtRolloutRestApi { * @return OK response (200) if rollout could be deleted. In case of any * exception the corresponding errors occur. */ - @Operation(summary = "Delete a Rollout", description = "Handles the DELETE request of deleting a rollout. Required Permission: DELETE_ROLLOUT") + @Operation(summary = "Delete a Rollout", description = "Handles the DELETE request of deleting a rollout. " + + "Required Permission: DELETE_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -325,7 +339,8 @@ public interface MgmtRolloutRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Rollout not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Rollout not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -346,7 +361,8 @@ public interface MgmtRolloutRestApi { * @return OK response (200) if rollout could be resumed. In case of any * exception the corresponding errors occur. */ - @Operation(summary = "Resume a Rollout", description = "Handles the POST request of resuming a paused rollout. Required Permission: HANDLE_ROLLOUT") + @Operation(summary = "Resume a Rollout", description = "Handles the POST request of resuming a paused rollout. " + + "Required Permission: HANDLE_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -395,7 +411,8 @@ public interface MgmtRolloutRestApi { * paged. In any failure the JsonResponseExceptionHandler is * handling the response. */ - @Operation(summary = "Return all rollout groups referred to a Rollout", description = "Handles the GET request of retrieving all deploy groups of a specific rollout. Required Permission: READ_ROLLOUT") + @Operation(summary = "Return all rollout groups referred to a Rollout", description = "Handles the GET request of " + + "retrieving all deploy groups of a specific rollout. Required Permission: READ_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -406,7 +423,8 @@ public interface MgmtRolloutRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Rollout not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Rollout not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -440,7 +458,9 @@ public interface MgmtRolloutRestApi { Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.""") String rsqlParam, - @RequestParam(value = MgmtRestConstants.REQUEST_PARAMETER_REPRESENTATION_MODE, defaultValue = MgmtRestConstants.REQUEST_PARAMETER_REPRESENTATION_MODE_DEFAULT) String representationModeParam); + @RequestParam(value = MgmtRestConstants.REQUEST_PARAMETER_REPRESENTATION_MODE, + defaultValue = MgmtRestConstants.REQUEST_PARAMETER_REPRESENTATION_MODE_DEFAULT) + String representationModeParam); /** * Handles the GET request for retrieving a single rollout group. @@ -451,7 +471,8 @@ public interface MgmtRolloutRestApi { * the groupId to retrieve the rollout group * @return the OK response containing the MgmtRolloutGroupResponseBody */ - @Operation(summary = "Return single rollout group", description = "Handles the GET request of a single deploy group of a specific rollout. Required Permission: READ_ROLLOUT") + @Operation(summary = "Return single rollout group", description = "Handles the GET request of a single deploy " + + "group of a specific rollout. Required Permission: READ_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -462,7 +483,8 @@ public interface MgmtRolloutRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Rollout not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Rollout not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -500,7 +522,9 @@ public interface MgmtRolloutRestApi { * @return a paged list of targets related to a specific rollout and rollout * group. */ - @Operation(summary = "Return all targets related to a specific rollout group", description = "Handles the GET request of retrieving all targets of a single deploy group of a specific rollout. Required Permissions: READ_ROLLOUT, READ_TARGET.") + @Operation(summary = "Return all targets related to a specific rollout group", + description = "Handles the GET request of retrieving all targets of a single deploy group of a specific " + + "rollout. Required Permissions: READ_ROLLOUT, READ_TARGET.") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -511,7 +535,8 @@ public interface MgmtRolloutRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Rollout not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Rollout not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -557,7 +582,8 @@ public interface MgmtRolloutRestApi { * @return OK response (200). In case of any exception the corresponding * errors occur. */ - @Operation(summary = "Force trigger processing next group of a Rollout", description = "Handles the POST request of triggering the next group of a rollout. Required Permission: UPDATE_ROLLOUT") + @Operation(summary = "Force trigger processing next group of a Rollout", description = "Handles the POST request " + + "of triggering the next group of a rollout. Required Permission: UPDATE_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -588,7 +614,8 @@ public interface MgmtRolloutRestApi { * @return OK response (200). In case of any exception the corresponding * errors occur. */ - @Operation(summary = "Retry a rollout", description = "Handles the POST request of retrying a rollout. Required Permission: CREATE_ROLLOUT") + @Operation(summary = "Retry a rollout", description = "Handles the POST request of retrying a rollout. " + + "Required Permission: CREATE_ROLLOUT") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -599,7 +626,8 @@ public interface MgmtRolloutRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Rollout not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Rollout not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -612,4 +640,4 @@ public interface MgmtRolloutRestApi { MediaTypes.HAL_JSON_VALUE, MediaType.APPLICATION_JSON_VALUE}) ResponseEntity retryRollout(@PathVariable("rolloutId") final Long rolloutId); -} +} \ No newline at end of file diff --git a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtSoftwareModuleTypeRestApi.java b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtSoftwareModuleTypeRestApi.java index 88c2ed5c1..927ac6553 100644 --- a/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtSoftwareModuleTypeRestApi.java +++ b/hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/rest/api/MgmtSoftwareModuleTypeRestApi.java @@ -60,7 +60,9 @@ public interface MgmtSoftwareModuleTypeRestApi { * with status OK. The response is always paged. In any failure the * JsonResponseExceptionHandler is handling the response. */ - @Operation(summary = "Return all Software Module Types", description = "Handles the GET request of retrieving all software module types. Required Permission: READ_REPOSITORY") + @Operation(summary = "Return all Software Module Types", + description = "Handles the GET request of retrieving all software module types. " + + "Required Permission: READ_REPOSITORY") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -113,7 +115,9 @@ public interface MgmtSoftwareModuleTypeRestApi { * * @return a single softwareModule with status OK. */ - @Operation(summary = "Return single Software Module Type", description = "Handles the GET request of retrieving a single software module type. Required Permission: READ_REPOSITORY") + @Operation(summary = "Return single Software Module Type", + description = "Handles the GET request of retrieving a single software module type. " + + "Required Permission: READ_REPOSITORY") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -124,7 +128,8 @@ public interface MgmtSoftwareModuleTypeRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Software Module Type not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Software Module Type not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -146,7 +151,9 @@ public interface MgmtSoftwareModuleTypeRestApi { * @return status OK if delete as successfully. * */ - @Operation(summary = "Delete Software Module Type by Id", description = "Handles the DELETE request for a single software module type. Required Permission: DELETE_REPOSITORY") + @Operation(summary = "Delete Software Module Type by Id", + description = "Handles the DELETE request for a single software module type. " + + "Required Permission: DELETE_REPOSITORY") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -157,7 +164,8 @@ public interface MgmtSoftwareModuleTypeRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Software Module Type not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Software Module Type not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -178,7 +186,9 @@ public interface MgmtSoftwareModuleTypeRestApi { * the module type to be updated. * @return status OK if update is successful */ - @Operation(summary = "Update Software Module Type", description = "Handles the PUT request for a single software module type. Required Permission: UPDATE_REPOSITORY") + @Operation(summary = "Update Software Module Type", + description = "Handles the PUT request for a single software module type. " + + "Required Permission: UPDATE_REPOSITORY") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -189,7 +199,8 @@ public interface MgmtSoftwareModuleTypeRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Software Module Type not found.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Software Module Type not found.", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -223,7 +234,9 @@ public interface MgmtSoftwareModuleTypeRestApi { * failure the JsonResponseExceptionHandler is handling the * response. */ - @Operation(summary = "Creates new Software Module Types", description = "Handles the POST request of creating new software module types. The request body must always be a list of module types. Required Permission: CREATE_REPOSITORY") + @Operation(summary = "Creates new Software Module Types", + description = "Handles the POST request of creating new software module types. The request body must " + + "always be a list of module types. Required Permission: CREATE_REPOSITORY") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully retrieved"), @ApiResponse(responseCode = "400", description = "Bad Request - e.g. invalid parameters", @@ -234,7 +247,8 @@ public interface MgmtSoftwareModuleTypeRestApi { description = "Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or " + "data volume restriction applies.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), - @ApiResponse(responseCode = "404", description = "Software Module not found", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), + @ApiResponse(responseCode = "404", description = "Software Module not found", + content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "405", description = "The http request method is not allowed on the resource.", content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))), @ApiResponse(responseCode = "406", description = "In case accept header is specified and not application/json.", @@ -255,4 +269,4 @@ public interface MgmtSoftwareModuleTypeRestApi { ResponseEntity> createSoftwareModuleTypes( List softwareModuleTypes); -} +} \ No newline at end of file