Fix swagger definition for blueprint processor

Change-Id: I69ba541b4b301735a988cf01673827a79daf1f8c
Issue-ID: CCSDK-1431
Signed-off-by: Alexis de Talhouët <adetalhouet89@gmail.com>

1 files changed, 35 insertions, 24 deletions

diff --git a/ms/blueprintsprocessor/modules/commons/processor-core/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/core/api/data/BlueprintProcessorData.kt b/ms/blueprintsprocessor/modules/commons/processor-core/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/core/api/data/BlueprintProcessorData.kt
index c2698c026..c45ebc127 100644
--- a/ms/blueprintsprocessor/modules/commons/processor-core/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/core/api/data/BlueprintProcessorData.kt
+++ b/ms/blueprintsprocessor/modules/commons/processor-core/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/core/api/data/BlueprintProcessorData.kt
@@ -30,24 +30,32 @@ import java.util.*
  */
 
 open class ExecutionServiceInput {
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "Headers providing request context.")
     lateinit var commonHeader: CommonHeader
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "Provide information about the action to execute.")
     lateinit var actionIdentifiers: ActionIdentifiers
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true,
+        value = "Contain the information to be passed as input to the action." +
+                "The payload is constituted of two section: the workflow input which is the higher level block (xxx-request)" +
+                " and the input for resource resolution located within the xxx-request block, contained within xxx-properties")
     lateinit var payload: ObjectNode
+    @get:ApiModelProperty(hidden = true)
     var stepData: StepData? = null
 }
 
 open class ExecutionServiceOutput {
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "Headers providing request context.")
     lateinit var commonHeader: CommonHeader
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "Provide information about the action to execute.")
     lateinit var actionIdentifiers: ActionIdentifiers
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "Status of the request.")
     lateinit var status: Status
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true,
+        value = "Contain the information to be passed as input to the action." +
+                "The payload is constituted of two section: the workflow input which is the higher level block (xxx-request)" +
+                " and the input for resource resolution located within the xxx-request block, contained within xxx-properties")
     lateinit var payload: ObjectNode
+    @get:ApiModelProperty(hidden = true)
     var stepData: StepData? = null
 }
 
@@ -55,53 +63,56 @@ const val ACTION_MODE_ASYNC = "async"
 const val ACTION_MODE_SYNC = "sync"
 
 open class ActionIdentifiers {
-    @get:ApiModelProperty(required = false)
+    @get:ApiModelProperty(required = false, value = "Name of the CBA.")
     lateinit var blueprintName: String
-    @get:ApiModelProperty(required = false)
+    @get:ApiModelProperty(required = false, value = "Version of the CBA.")
     lateinit var blueprintVersion: String
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "Name of the workflow to execute.")
     lateinit var actionName: String
-    @get:ApiModelProperty(required = true, allowableValues = "sync, async")
+    @get:ApiModelProperty(required = true,
+        value = "Async processing is only supported for gRPC client.",
+        allowableValues = "sync, async")
     lateinit var mode: String
 }
 
 open class CommonHeader {
-    @get:ApiModelProperty(required = true, example = "2012-04-23T18:25:43.511Z")
+    @get:ApiModelProperty(required = true, value = "Date of the execution", example = "2012-04-23T18:25:43.511Z")
     @get:JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     var timestamp: Date = Date()
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "Identify the system/person triggering the request.")
     lateinit var originatorId: String
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "Uniquely identify a request.")
     lateinit var requestId: String
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "Allow for fine-grain request identifier")
     lateinit var subRequestId: String
-    @get:ApiModelProperty(required = false)
+    @get:ApiModelProperty(required = false, hidden = true)
     var flags: Flags? = null
 }
 
 open class Flags {
+    @get:ApiModelProperty(value = "Whether or not to force the action.")
     var isForce: Boolean = false
     @get:ApiModelProperty(value = "3600")
     var ttl: Int = 3600
 }
 
 open class Status {
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "HTTP status code equivalent.")
     var code: Int = 200
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "Type of the event being emitted by CDS.")
     var eventType: String = ""
-    @get:ApiModelProperty(required = true, example = "2012-04-23T18:25:43.511Z")
+    @get:ApiModelProperty(required = true,
+        value = "Time when the execution ended.",
+        example = "2012-04-23T18:25:43.511Z")
     @get:JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
     var timestamp: Date = Date()
-    @get:ApiModelProperty(required = false)
+    @get:ApiModelProperty(required = false, value = "Error message when system failed")
     var errorMessage: String? = null
-    @get:ApiModelProperty(required = true)
+    @get:ApiModelProperty(required = true, value = "Message providing request status")
     var message: String = "success"
 }
 
 open class StepData {
     lateinit var name: String
     var properties: MutableMap<String, JsonNode> = mutableMapOf()
-}
-
-
+}
\ No newline at end of file