REST doc / Mgmt Target Tag - fix missed info (#1629)

When spring restdoc was replaces with swagger & open api some info was lost This commit returns back this info for Mgmt API - Target Tag Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
eclipse · Feb 8, 2024 · c944a0d · c944a0d
1 parent c459423
commit c944a0d
Show file tree

Hide file tree

Showing 3 changed files with 90 additions and 48 deletions.
diff --git a/...mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/json/model/tag/MgmtTagRequestBodyPut.java b/...mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/json/model/tag/MgmtTagRequestBodyPut.java
@@ -27,12 +27,14 @@
 public class MgmtTagRequestBodyPut {
 
     @JsonProperty
-    @Schema(example = "rgb(0,255,0)")
-    private String colour;
-    @JsonProperty
-    @Schema(example = "Example name")
+    @Schema(description = "The name of the entity", example = "Example name")
     private String name;
+
     @JsonProperty
-    @Schema(example = "Example description")
+    @Schema(description = "The description of the entity", example = "Example description")
     private String description;
+
+    @JsonProperty
+    @Schema(description = "The colour of the entity", example = "rgb(0,255,0)")
+    private String colour;
 }
diff --git a/...i/src/main/java/org/eclipse/hawkbit/mgmt/json/model/tag/MgmtTargetTagAssigmentResult.java b/...i/src/main/java/org/eclipse/hawkbit/mgmt/json/model/tag/MgmtTargetTagAssigmentResult.java
@@ -11,6 +11,7 @@
 
 import java.util.List;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 import org.eclipse.hawkbit.mgmt.json.model.target.MgmtTarget;
 
@@ -29,7 +30,10 @@
 public class MgmtTargetTagAssigmentResult {
 
     @JsonProperty
+    @Schema(description = "Assigned targets")
     private List<MgmtTarget> assignedTargets;
+
     @JsonProperty
+    @Schema(description = "Unassigned targets")
     private List<MgmtTarget> unassignedTargets;
 }