search

cytoscape / cyREST

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

Means to find originating App for command #47

Closed dotasek closed 6 years ago

dotasek commented 6 years ago

An endpoint to be able to track back the App from which a command originates.

dotasek commented 6 years ago

The RESTful way of doing this might be by adding parameters to the v1/apps endpoint.

For example, v1/apps?commandName=circle&commandNamespace=layout

dotasek commented 6 years ago

From a conversation with @bdemchak offline, this splits into two issues:

  1. Apps following best practices in using Automation functions should be grouping their functions by the App:xyz tag convention anyway. Our need for that is lessened.
  2. Commands don't follow this convention at all. The closest analogy is the 'command namespace' which isn't governed by originating app, but rather by semantics. What might be worth doing is simply adding the originating app name to every Swagger operation's notes.

I still like the idea of a filter parameter on the v1/apps operation, but the above would be far easier to navigate.

dotasek commented 6 years ago

Addressed in 5ad3478b42938eeeb2f1d58a2aff80f835d04e1a