cytoscape / cyREST

Core App: REST API module for Cytoscape
https://github.com/cytoscape/cyREST/wiki
MIT License
30 stars 13 forks source link

Network visual properties doesn't have expected PUT statement #45

Closed dotasek closed 6 years ago

dotasek commented 6 years ago

Via @AlexanderPico:

We have "get /v1/networks/{networkId}/views/{viewId}/network/{visualProperty}”, but I don’t see the corresponding PUT.

dotasek commented 6 years ago

Update and expansion: this endpoint is also missing delete, as well as equivalent bypass management.

So, if we were to make this consistent with the existing API, the endpoints would look like this:

get /v1/networks/{networkId}/views/{viewId}/network/{visualProperty} put /v1/networks/{networkId}/views/{viewId}/network/{visualProperty} delete /v1/networks/{networkId}/views/{viewId}/network/{visualProperty} We don't need delete here; there's always a visual property.

get /v1/networks/{networkId}/views/{viewId}/network/{visualProperty}/bypass put /v1/networks/{networkId}/views/{viewId}/network/{visualProperty}/bypass delete /v1/networks/{networkId}/views/{viewId}/network/{visualProperty}/bypass

AlexanderPico commented 6 years ago

+1

dotasek commented 6 years ago

One more detail... the regular put statement (not the bypass one) has proven problematic to similar endpoints in the past. People expect it to behave pretty much exactly as the bypass one does, but it doesn't: it changes the visual property temporarily, and then gets overridden by the Visual Style when the network refreshes.

@AlexanderPico, I believe I'll leave the put out, and implement only the bypass methods.

dotasek commented 6 years ago

Addressed in 706a930f387a2e554bdfcff8be0f5e036dadd038

New API

Network Views