Download API JSDoc

[JTonda]

From @dkelosky on July 13, 2018 19:31

Download.dataset returns a IZosmfFilesResponse object which references "commands". At the API usage, is commandResponse actually the data set content?

Copied from original issue: gizafoundation/brightside#153

[JTonda]

From @zFernand0 on August 29, 2018 12:12

commandResponse is basically a success message that gets forwarded to the handler, which doesn't seem very useful for API usage only.
On the other hand, apiResponse is the guy that contains the content of the downloaded data set.

Two possible solutions for this misunderstanding, let's vote (:+1: or :-1:)
(If you have a new solution please feel free to add it)

[JTonda]

From @zFernand0 on August 29, 2018 12:13

• Add more explicit JSDoc comments. (This is probably the quickest solution)

[JTonda]

From @zFernand0 on August 29, 2018 12:13

• Remove commandResponse all together from IZosmFilesResponse, and let the command handlers format their own messages (if needed) since API users wouldn't really care about the command messages.

[MikeBauerCA]

Closing in favor of #865