api-docs.json

{"info":{"title":"X2 API","version":"0.2.0","license":{"name":"MIT"}},"swagger":"2.0","paths":{"/node_match":{"get":{"summary":"Graph Retrieval By Node Matching","tags":[{"name":"Retrieval"}],"description":"Get graphs by node matching","produces":["application/json"],"parameters":[{"name":"node_ids","description":"Filter by nodes such that those ids are included in given node ids.","in":"query","type":"array","items":{"type":"integer"}},{"name":"node_labels","description":"Filter by nodes such that those labels are included in given node labels.","in":"query","type":"array","items":{"type":"string"}},{"name":"node_props","description":"Filter by nodes such that those props are included in given node props.","type":"array","in":"query","items":{"type":"string"}},{"name":"edge_ids","description":"Filter by nodes such that those adjacent edges ids are included in given edge ids.","type":"array","items":{"type":"integer"},"in":"query"},{"name":"edge_labels","description":"Filter by nodes such that those adjacent edges labels are included in given edge labels.","type":"array","items":{"type":"string"},"in":"query"},{"name":"edge_props","description":"Filter by nodes such that those adjacent edges props are included in given edge props.","type":"array","items":{"type":"string"},"in":"query"},{"name":"limit","in":"query","description":"limit records of graph.","type":"integer"},{"name":"debug","in":"query","description":"Response includes the queries on request for debugging.","type":"boolean"}],"responses":{"200":{"description":"success"},"400":{"description":"invalid parameter"}}}},"/edge_match":{"get":{"summary":"Graph Retrieval By Edge Matching","tags":[{"name":"Retrieval"}],"description":"Get graphs by edge matching","produces":["application/json"],"parameters":[{"name":"node_ids","description":"Filter by edges that both ends of edges are included in given node ids.","in":"query","type":"array","items":{"type":"integer","example":851}},{"name":"node_labels","description":"Filter by edges that both ends of edges have any of given node labels.","in":"query","type":"array","items":{"type":"string"}},{"name":"node_props","description":"Filter by edges that both ends of edges have any of given node props.","type":"array","in":"query","items":{"type":"string"}},{"name":"edge_ids","description":"Filter by edges such that those ids are included in given edge ids.","type":"array","items":{"type":"integer"},"in":"query"},{"name":"edge_labels","description":"Filter by edges such that those ids are included in given edge labels.","type":"array","items":{"type":"string"},"in":"query"},{"name":"edge_props","description":"Filter by edges such that those ids are included in given edge props.","type":"array","items":{"type":"string"},"in":"query"},{"name":"limit","in":"query","description":"limit records of graph","type":"integer","example":100},{"name":"debug","in":"query","description":"Response includes the queries on request for debugging.","type":"boolean"}],"responses":{"200":{"description":"success"},"400":{"description":"invalid parameter"}}}},"/traversal":{"get":{"summary":"Graph Traversal","tags":[{"name":"Traversal"}],"description":"Get graphs with traversing from the specified nodes or edges","produces":["application/json"],"parameters":[{"name":"node_ids","description":"Filter by edges that either end of edges are included in given node ids.","in":"query","type":"array","items":{"type":"integer"}},{"name":"node_labels","description":"Filter by edges that either end of edges have any of given node labels.","in":"query","type":"array","items":{"type":"string"}},{"name":"node_props","description":"Filter by edges that either end of edges have any of given node props.","type":"array","in":"query","items":{"type":"string"}},{"name":"edge_ids","description":"Filter by edges such that those ids are included in given edge ids.","type":"array","items":{"type":"integer"},"in":"query"},{"name":"edge_labels","description":"Filter by edges such that those ids are included in given edge labels.","type":"array","items":{"type":"string"},"in":"query"},{"name":"edge_props","description":"Filter by edges such that those ids are included in given edge props.","type":"array","items":{"type":"string"},"in":"query"},{"name":"iteration","in":"query","description":"the number of iteration (>=0).","type":"integer","required":true,"default":2},{"name":"limit","in":"query","description":"limit records of graph.","type":"integer","default":1000},{"name":"debug","in":"query","description":"Response includes the queries on request for debugging.","type":"boolean"}],"responses":{"200":{"description":"success"},"400":{"description":"invalid parameter"}}}},"/compute/shortest":{"get":{"summary":"Graph Computation","tags":[{"name":"Computation"}],"description":"Find a shortest paths for the query.","produces":["application/json"],"parameters":[{"name":"from_node_id","description":"Specify a source node that has given node id.","in":"query","type":"integer"},{"name":"from_node_label","description":"Specify a source node that has given node label.","in":"query","type":"string"},{"name":"from_node_props","description":"Specify a source node that has given node props.","type":"array","in":"query","items":{"type":"string"}},{"name":"to_node_id","description":"Specify a target node that has given node id.","in":"query","type":"integer"},{"name":"to_node_label","description":"Specify a target node that has given node label.","in":"query","type":"string"},{"name":"to_node_props","description":"Specify a target node that has given node props.","type":"array","in":"query","items":{"type":"string"}},{"name":"edge_label","description":"Filter by edges such that those label equals the given label.","type":"string","in":"query"},{"name":"iteration","in":"query","description":"the number of iteration (>=0).","type":"integer","required":true,"default":2},{"name":"limit","in":"query","description":"limit records of graph.","type":"integer","default":1000},{"name":"debug","in":"query","description":"Response includes the queries on request for debugging.","type":"boolean"}],"responses":{"200":{"description":"success"},"400":{"description":"invalid parameter"}}}},"/profile":{"get":{"summary":"Graph Profile","tags":[{"name":"Profile"}],"description":"Get data profiling of graphs","produces":["application/json"],"parameters":[{"name":"type","description":"Request types of metadata.","in":"query","type":"string","enum":["all","node","edge"]}],"responses":{"200":{"description":"success"}}}},"/query":{"get":{"summary":"Graph Query","tags":[{"name":"Query"}],"description":"Get graphs with arbitral query.","produces":["application/json"],"parameters":[{"name":"q","description":"Query for backend dbms.","in":"query","type":"string"}],"responses":{"200":{"description":"success"},"403":{"description":"prohibited"}}}}},"definitions":{},"responses":{},"parameters":{},"securityDefinitions":{},"tags":[]}