API

Warning: this API is under active development

REST API

URI	GET	POST	PUT	DELETE
/nodes	info for all nodes (not scalable)
/nodes/:id	user and vetted info for node :id
/nodes/:id/user_data	user info for node :id	user info to add new nodes id[1] and title fields required)
/:topic/nodes/:id/:field	:field for node :id (both user and vetted)
/search	process a search query with supplied options, return a list of JSON objects for the results

[1] perhaps deterministically auto-generating ids from the titles for nodes is a better idea (why should users manually specify an id?). e.g. Hidden Markov Models becomes hidden_markov_models

Questions to address

• How should we address user authentication? Clearly we shouldn't let arbitrary users send DELETE request...
• How should we let users query for subsets of a graph (e.g. all dependencies of a specific node)?
• If we do client-side json-to-svg generation, should we still maintain an svg format option (i.e. running graphviz on the server)?