new download endpoint (#899)

walletnode/api/design/cascade.go

@@ -145,6 +145,44 @@ var _ = Service("cascade", func() {
 		})
 	})
 
+	Method("downloadV2", func() {
+		Description("Starts downloading cascade Artifact.")
+		Meta("swagger:summary", "Downloads cascade artifact")
+
+		Security(APIKeyAuth)
+
+		Payload(DownloadPayload)
+		Result(FileDownloadV2Result)
+
+		HTTP(func() {
+			GET("/v2/download")
+			Param("txid")
+			Param("pid")
+
+			Response("UnAuthorized", StatusUnauthorized)
+			Response("NotFound", StatusNotFound)
+			Response("InternalServerError", StatusInternalServerError)
+			Response(StatusOK)
+		})
+	})
+
+	Method("getDownloadTaskState", func() {
+		Description("Gets the state of download task")
+		Meta("swagger:summary", "Get history of states as a json string with a list of state objects.")
+
+		Payload(func() {
+			Extend(DownloadTaskStatePayload)
+		})
+		Result(ArrayOf(TaskHistory))
+
+		HTTP(func() {
+			GET("/downloads/{file_id}/status")
+			Response("NotFound", StatusNotFound)
+			Response("InternalServerError", StatusInternalServerError)
+			Response(StatusOK)
+		})
+	})
+
 	Method("registrationDetails", func() {
 		Description("Get the file registration details")
 		Meta("swagger:summary", "Get the file registration details")

walletnode/api/design/common.go

@@ -68,6 +68,17 @@ var RegisterTaskPayload = Type("RegisterTaskPayload", func() {
 	Required("taskId")
 })
 
+// DownloadTaskStatePayload represents a payload for returning task.
+var DownloadTaskStatePayload = Type("DownloadTaskStatePayload", func() {
+	Attribute("file_id", String, "File ID returned by Download V2 API", func() {
+		TypeName("file_id")
+		MinLength(8)
+		MaxLength(8)
+		Example("n6Qn6TFM")
+	})
+	Required("file_id")
+})
+
 // RegisterTaskState is task streaming of the NFT registration.
 var RegisterTaskState = Type("TaskState", func() {
 	Attribute("date", String, func() {
@@ -224,6 +235,15 @@ var FileDownloadResult = Type("FileDownloadResult", func() {
 	Required("file_id")
 })
 
+// FileDownloadV2Result is Asset download result.
+var FileDownloadV2Result = Type("FileDownloadV2Result", func() {
+	Description("Asset download response V2 - returns task_id for the download task")
+	Attribute("file_id", String, func() {
+		Description("Task ID for the download task - caller can check the status of the download task using this task_id")
+	})
+	Required("file_id")
+})
+
 // DownloadResult is Asset download result.
 var DownloadResult = Type("DownloadResult", func() {
 	Description("Asset download response")