Skip to content

api: docs: new graph API (path/ and explore/ endpoints)

Thibault Allançon requested to merge generated-differential-D1625-source into generated-differential-D1625-target

This API is both more general and flexible than previous one.

The visit/ endpoint was re-worked into the explore/ endpoint:

  • Removing traversal option since we care about all paths (cf path/ endpoint, here a BFS does not carry out additional informations)
  • Add a 'nodes' field in the JSON output, we do not necessarily always want full paths.
  • Add a 'destination' in the URL that can either be a specific node id, or a node type.

A new path/ endpoint was added to account for single path information. The traversal option with the BFS is used here because it has real meanings:

  • The BFS can be used to get the shortest path between nodes.
  • DFS/BFS can be chosen depending on the subgraph topology to explore it more effectively.

Migrated from D1625 (view on Phabricator)

Merge request reports