From 08cbb6b952ed8cd32c0bfacfbc86992361f7a834 Mon Sep 17 00:00:00 2001 From: Tom Kazimiers Date: Tue, 2 Jul 2024 21:42:47 +0200 Subject: [PATCH] Doc: add updated version of API docs --- sphinx-doc/source/_static/api/index.html | 13 +++++++------ sphinx-doc/source/_static/api/openapi.json | 2 +- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/sphinx-doc/source/_static/api/index.html b/sphinx-doc/source/_static/api/index.html index 7feb12b45b..cc2ac84309 100644 --- a/sphinx-doc/source/_static/api/index.html +++ b/sphinx-doc/source/_static/api/index.html @@ -699,7 +699,7 @@ input set of skeletons. These links are further constrained by relation type, with currently support available for: postsynaptic_to, presynaptic_to, abutting, gapjunction_with, tightjunction_with, -desmosome_with.

+desmosome_with, mitochondrion_of.

Returned is an object containing an array of links to connectors and a set of tags for all connectors found (if not disabled). The link array contains one array per connector link with the following content: [Linked skeleton ID, @@ -714,7 +714,7 @@ input set of skeletons. These links are further constrained by relation type, with currently support available for: postsynaptic_to, presynaptic_to, abutting, gapjunction_with, tightjunction_with, -desmosome_with.

+desmosome_with, mitochondrion_of.

Returned is an object containing an array of links to connectors and a set of tags for all connectors found (if not disabled). The link array contains one array per connector link with the following content: [Linked skeleton ID, @@ -1326,7 +1326,7 @@

[skeleton_id, id, parent_id, user_id, location_x, location_y, location_z, radius, confidence].

Each element in the [connectors] array has the following form, with the third element representing the connector link as 0 = presynaptic, 1 = -postsynaptic, 2 = gap junction, -1 = other:

+postsynaptic, 2 = gap junction, 3 = desmosome, 4 = mitochondria, -1 = other:

[treenode_id, connector_id, 0|1|2|-1, location_x, location_y, location_z]

If history data is requested, each row contains a validity interval. Note that for the live table entry (the currently valid version), there are @@ -1379,7 +1379,8 @@ with_nodes

string

Whether to return detailed connectivity information that includes partner sites.

link_types
string

A list of allowed link types: incoming, outgoing, abutting, -gapjunction, tightjunction, desmosome, attachment, close_object.

+gapjunction, tightjunction, desmosome, attachment, close_object, +mitochondrion

Responses

Get the number of synapses per type for r a set of skeletons.

Get the number of synapses per type for r a set of skeletons.

Returns an object with to fields. The first, connectivity, is a mapping from skeleton ID to objects that map a relation ID to connectivity count for @@ -1538,7 +1539,7 @@

[id, parent_id, user_id, location_x, location_y, location_z, radius, confidence].

Each element in the [connectors] array has the following form, with the third element representing the connector link as 0 = presynaptic, 1 = -postsynaptic, 2 = gap junction, -1 = other:

+postsynaptic, 2 = gap junction, 3 = mitochondria, -1 = other:

[treenode_id, connector_id, 0|1|2|-1, location_x, location_y, location_z]

If history data is requested, each row contains a validity interval. Note that for the live table entry (the currently valid version), there are @@ -1820,7 +1821,7 @@

STL
volume_id
required
string

The volume to update

Responses