Design for Plan upload/download in GUI

dandelany commented 1 week ago

Checked for duplicates

Yes - I've already checked

Alternatives considered

Yes - and alternatives don't suffice

Describe the feature request

UI Design ticket for #1154 - we need to design a workflow for allowing users to download and upload Plan json files via the web UI. This is currently only possible using the API + aerie-cli tool, but we've gotten feedback from users that they'd like to use the UI for this too. @Mythicaeda described it well in the implementation ticket (#1154) so i'll copy her notes here:

Allow users to download a json representation of a plan, its activities with arguments, and tags. This download functionality should be exposed within the plan page and in the table of plans.
Allow users to upload a plan json file. This will involve adding an upload button to the plans page and allowing a user to specify a model and give the plan an alternative name if the plan name is already taken.

Sending to @lklyne to take a look - let me know if any further explanation is needed.

Sidenote: we also talked about supporting general file upload/download, but I think the UI design for that will be pretty different & therefore deserves a separate issue.

ewferg commented 1 week ago

If we provide a json format for download, what are our plans for documenting that specification/schema? Do we consider a similar download for a sim data set?

cartermak commented 1 week ago

Sharing some input: it would be nice if the logic to map between the standalone plan JSON and the Hasura-structured data were provided by a back-end service instead of the UI. This would reduce the code duplication between Aerie-CLI and Aerie-UI, and dedicated Hasura actions for upload/download would allow users who interact via the API outside of Aerie-CLI to leverage the feature, too.

cartermak commented 1 week ago

Another consideration: should the plan come with the simulation configuration? I was pondering adding sim config to the Aerie-CLI JSON plan format already. (See NASA-AMMOS/aerie-cli#128)

NASA-AMMOS / aerie-ui