API

estuary.api.v1.about()[source]

Display general information about the app.

Return type:flask.Response
estuary.api.v1.get_artifact_relationships(*args, **kwargs)[source]

Get one-to-many relationships of a particular artifact.

Parameters:
  • resource (str) – a resource name that maps to a neomodel class
  • uid (str) – the value of the UniqueIdProperty to query with
  • relationship (str) – relationship to expand
Returns:

a Flask JSON response

Return type:

flask.Response

Raises:
  • NotFound – if the item is not found
  • ValidationError – if an invalid resource/relationship was requested
estuary.api.v1.get_recent_stories(*args, **kwargs)[source]

Get stories that were most recently updated, by their artifact type.

estuary.api.v1.get_resource(*args, **kwargs)[source]

Get a resource from Neo4j.

Parameters:
  • resource (str) – a resource name that maps to a neomodel class
  • uid (str) – the value of the UniqueIdProperty to query with
Returns:

a Flask JSON response

Return type:

flask.Response

Raises:
  • NotFound – if the item is not found
  • ValidationError – if an invalid resource was requested
estuary.api.v1.get_resource_all_stories(*args, **kwargs)[source]

Get all unique stories of an artifact from Neo4j.

Parameters:
  • resource (str) – a resource name that maps to a neomodel class
  • uid (str) – the value of the UniqueIdProperty to query with
Returns:

a Flask JSON response

Return type:

flask.Response

Raises:
  • NotFound – if the item is not found
  • ValidationError – if an invalid resource was requested
estuary.api.v1.get_resource_story(*args, **kwargs)[source]

Get the story of a resource from Neo4j.

Parameters:
  • resource (str) – a resource name that maps to a neomodel class
  • uid (str) – the value of the UniqueIdProperty to query with
Returns:

a Flask JSON response

Return type:

flask.Response

Raises:
  • NotFound – if the item is not found
  • ValidationError – if an invalid resource was requested
estuary.api.v1.get_siblings(*args, **kwargs)[source]

Get siblings of next/previous node that are correlated to the node in question.

Parameters:
  • resource (str) – a resource name that maps to a neomodel class
  • uid (str) – the value of the UniqueIdProperty to query with
Returns:

a Flask JSON response

Return type:

flask.Response

Raises:
  • NotFound – if the item is not found
  • ValidationError – if an invalid resource was requested