Open jawache opened 3 days ago
@jawache assuming this is one is for @narekhovhannisyan ?
@zanete yes, but let's make sure whatever format we come up with works for @osamajandali
@jmcook1186 please refine this with acceptance criteria so @narekhovhannisyan could work on this, and after that it will be easier for @osamajandali to adjust visualiser code
@narekhovhannisyan @zanete added detail to the ticket for the IF side of this.
The vizualizer fly out needs to be able to show inputs and outputs properly, e.g. in this example I'm hovering over a pipeline and two outputs are highlighted. One is an input and one is an output, the current underlying data in the manifest file doesn't show inputs/outputs (yes, I know I asked for it in this way, I was wrong!) so we need to add them back in.
Can we also call the field in the manifest, "key" or something other than "explain", I feel explain should do more than just describe the fields.
Details for Narek
We basically want to revert the changes in this PR https://github.com/Green-Software-Foundation/if/issues/971
So instead of returning
we should instead return:
So the parameter details are organized by plugin, then inputs/outputs. The aggregation method should still be returned. It is understood that this will lead to repetition of the parameters in the explain block if theyare used in multiple plugins. This is fine, as long as the aggregation method and unit are the same for identically named parameters.
Example
Here's a snippet of the
explain
block from a manifest I just ran:and this is what it should look like after the proposed changes have been made:
If two instances of the same parameter are seen with different units or aggregation methods then we should error out.