Service definition for REST callers

[bdemchak]

Collaborate with Dan to define the API that will address advanced cases that can be realized in Jupyter. This API will eventually be used to enable advanced User Stories in Cytoscape, so it should be sufficiently robust for this, too.

[ericsage]

I exposed a number of algorithm tunables and other options via url query parameters that allow for things like changing the name of the input column, overriding the input column with a vector or dictionary that can allow the heats to be decoupled from the network CX. I can also easily add or change these parameters in the future.

[bdemchak]

It appears that there are open questions regarding the form of the Heat Vector. Should this item have been closed? Also, the Service Definition document needs additional information (e.g., min/max values for time, executable examples (curl?) showing different parameters in use, and what the form of the return value is). Additionally, good to discuss how errors are returned. Remember ... we love our users and want them to be productive with minimal guesswork and frustration.

[bdemchak]

Almost done ... would you include a sample input.cx file so the user can try this out without having to first master CX?

[ericsage]

There is now a test_network.cx that can be used for examples

[bdemchak]

Document is out of date