mayo-qin / grunt Goto Github PK

Currently, in it's configuration file (gruntfile.yml), grunt uses @, < and > to signify parameter, input file, and output file respectively. Propose a change to use # for parameter rather than @. This change will reduce confusion with curl commands.

For instance the new scheme would have:

services:
  - endPoint: echo
    commandLine: ["echo", "#Message"]
    description: print a message
    defaults:
      Message: "Hi From Grunt"
  - endPoint: sleep
    commandLine: ["sleep", "#seconds"]
    description: Sleep for a while
    defaults:
      seconds: 300
  - endPoint: copy
    commandLine: ["cp", "<input", ">output"]
    description: copy a file

It makes a better UX to go to the job status page when submitting a job.

The commands might delete all the images in the users pc. We have to re-write them to be more specific.

Documentation on passing an email address to grunt for notification is missing. An example curl command would be:

curl -X POST --form seconds=5000 --form [email protected] 192.168.99.100:9901/rest/service/sleep

In addition to the uuid of a Job, return grunt's HOST and PORT back in the status endpoint for a given Job.

Many APIs require a directory of image files, DICOM for instance. Add options to upload zip files that will be expanded as directories, processed and downloaded.

The REST API returns individual files as requested. Add an option to zip the entire working directory and return. Should stream the zip rather than cache.

Can you add a REST endpoint for stopping the running instance of grunt. I know I can stop it via docker command, but it would be great if the instance can stop via API call. Or is it already supported I just miss it?

• Need to hid output file links while the plugin is running, then show when it completes.
• Change output on job page to be download output as zip

Have the job status page refresh, especially the log.

Slicer has a well defined XML format to describe command line modules. Allow grunt to expose any Slicer CLI module as an endpoint. The YML file ought to have a new section.

services:
  - endPoint: copy
    commandLine: ["cp", "<input", ">output"]
    description: copy a file

# Use Slicer CLI modules.  Will populate the command line by parsing the XML output from
# ./MedianImageFilter --xml
cli:
  - endPoint: median
    executable: ./MedianImageFilter