Author: paperwing Date: 2012-05-31 09:57:05 -0700 (Thu, 31 May 2012) New Revision: 29410
Added: core3/impl/trunk/app-impl/api-notes.txt Log: Added local HTTP server API Added: core3/impl/trunk/app-impl/api-notes.txt =================================================================== --- core3/impl/trunk/app-impl/api-notes.txt (rev 0) +++ core3/impl/trunk/app-impl/api-notes.txt 2012-05-31 16:57:05 UTC (rev 29410) @@ -0,0 +1,49 @@ +Note: All responses are in JSON. + + +Get App Status +============== + +URL +--- + +GET http://127.0.0.1:2608/status?appname=<app_name> + +Notes: App_name is the app store unique app name. For web-downloaded apps, it will be the same +as the Cytoscape-App-Name entry in the manifest. + +Response +-------- + +{ + "request_name": The app name requested by the app store + "status": installed, uninstall-on-restart, uninstalled, or not-found. Not found would +mean the app isn't found on the user's computer. + "version": The version of the app, as found in the Cytoscape-App-Version manifest entry, +or "not-found" if not available. It will also be "not-found" in the case that the app was +not found on the user's computer. +} + +Install an App +============== + +URL +--- + +GET http://127.0.0.1:2608/install?appname=<app_name>&version=<version> + +Response +-------- + +The server attempts to query the app from the app store. If no matches were found +for the version, or if the version information was absent, an error is returned in +the "install_status" field. + +Upon completion, the server sends the following: + +{ + "app_name": The name of the install app + "install_status": The result of the installation. Values could be: success, +app-not-found, version-not-found. +} + Property changes on: core3/impl/trunk/app-impl/api-notes.txt ___________________________________________________________________ Added: svn:mime-type + text/plain -- You received this message because you are subscribed to the Google Groups "cytoscape-cvs" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/cytoscape-cvs?hl=en.
