sketch service formats

engine-rest/src/main/java/io/nosqlbench/engine/rest/transfertypes/ResultInfo.java

@@ -2,6 +2,26 @@ package io.nosqlbench.engine.rest.transfertypes;
 
 import io.nosqlbench.engine.core.ScenarioResult;
 
+/**
+ * TODO: Combine scenario status and pending state to one view
+ * <pre>{@code
+ *  {
+ *      "scenarioName": "myscenarioname",
+ *      "isComplete": (true|false),
+ *      "isErrored": (true|false),
+ *      "ioLog": "IOLOGLine1\n...\n"
+ *
+ *      [same progress data as for the pending scenario view]
+ *
+ *      " whole scenario "
+ *      [constructed link to grafana dashboard for current duration, with selected update interval]
+ *
+ *      [create snapshot in grafana from the time range of the scenario once complete]
+ *      [link to grafana snapshot]
+ *
+ *  }
+ * }</pre>
+ */
 public class ResultInfo {
     private final String scenarioName;
     private final ScenarioResult result;

engine-rest/src/main/java/io/nosqlbench/engine/rest/transfertypes/RunScenarioRequest.java

@@ -12,10 +12,11 @@ import java.util.Map;
  *    "name" : "auto",
  *    "basedir" : "/tmp/nosqlbench",
  *    "filemap" : {
- *        "file1.yaml": "contents of file1"
+ *        "file1.yaml": "bindings:\n i: Identity()\n",
+ *        "myscb:base64" : "base64encodeddata.."
  *    },
  *    "commands": [
- *      "run", "workload=file1.yaml", "driver=stdout", "cycles=10M", "cyclerate=100"
+ *      "run", "workload=file1.yaml", "driver=stdout", "cycles=10M", "cyclerate=100", "scb=myscb"
  *    ]
  *  }
  * }</pre>