diff --git a/API_CHANGELOG.md b/API_CHANGELOG.md index 68bbc2f629..87384193b6 100644 --- a/API_CHANGELOG.md +++ b/API_CHANGELOG.md @@ -2,7 +2,7 @@ This changelog notes changes to API endpoints that are documented and listed through Swagger. Changes to undocumented, internal CATMAID APIs are not included in this changelog. -## Under development +## 2018.07.19 ### Additions diff --git a/CHANGELOG.md b/CHANGELOG.md index b70f448ce7..7a097ee2e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,6 @@ -## Under development +## 2018.07.19 +Contributors: Albert Cardona, Andrew Champion, Pat Gunn, Tom Kazimiers, Will Patton, Eric Trautmans ### Notes diff --git a/package.json b/package.json index fa5128faa7..e7373c14b5 100644 --- a/package.json +++ b/package.json @@ -9,5 +9,9 @@ "jshint": "2.9.5", "karma": "2.0.2", "jsdoc": "3.5.5" + }, + "dependencies": { + "bootprint": "^1.0.2", + "bootprint-openapi": "^1.1.0" } } diff --git a/sphinx-doc/source/_static/api/index.html b/sphinx-doc/source/_static/api/index.html index 4c9a9d445a..94a09c52c3 100644 --- a/sphinx-doc/source/_static/api/index.html +++ b/sphinx-doc/source/_static/api/index.html @@ -243,6 +243,25 @@
Create a new domain for a sampler.
++
+Operation | +Description | +||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
POST /{project_id}/skeleton/connectivity_matrix | +Return a sparse connectivity matrix representation for the given skeleton |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /{project_id}/skeletons/in-bounding-box | Get a list of all skeletons that intersect with the passed in bounding + |
+ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST /{project_id}/skeletons/in-bounding-box | +Get a list of all skeletons that intersect with the passed in bounding |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /{project_id}/volumes/{volume_id}/intersect | -Test if a point intersects with a given volume. + | Test if a point intersects with the bounding box of a given volume. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /{project_id}/connectors/links/ | Get connectors linked to a set of skeletons. + |
+ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST /{project_id}/connectors/links/ | +Get connectors linked to a set of skeletons. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | + | + | + | + |
---|---|---|---|---|
+ project_id + | ++ | path | ++ string + + + | ++ + | +
+ skeleton_ids + | +Skeletons to list connectors for + |
+ formData | ++ string[] + + + | ++ + | +
+ relation_type + | +Relation of listed connector links + |
+ formData | ++ string + + + | ++ + | +
+ with_tags + | +If connector tags should be fetched + |
+ formData | ++ boolean + + + | ++ | +
Either 'connector', 'treenode' or 'location'
+Project containing node of interest
Project containing node of interest
+ID of node to list labels for
ID of node to list labels for
+Either 'connector', 'treenode' or 'location'
Project of landmark group
+The link to delete
The link to delete
+Project of landmark group
The ID of the landmark group.
+The project the landmark group is part of.
The project the landmark group is part of.
+The ID of the landmark group.
The project the landmark group is part of.
+The project the landmark group is part of.
-The landmark group to link
+Project of landmark group
Project of landmark group
+The landmark group to link
The landmark group to link
+Project of landmark group
Project of landmark group
+The landmark group to link
The starting landmark group
+Project of landmark groups
Project of landmark groups
+The starting landmark group
Project of landmark group
+The group to unlink from
The landmark to unlink from
+Project of landmark group
The group to unlink from
+The landmark to unlink from
The location to unlink
+Project of landmark group
Project of landmark group
+The landmark to unlink
The landmark to unlink
+The location to unlink
ID of neuron to rename
-ID of neuron to rename
+Maximum number of the largest skeletons in view
+Project point is part of
+ID of point
ID of point
+Project point is part of
Project point is part of
+ID of point
ID of point
+Project point is part of
Project point is part of
+ID of point
ID of point
+Project point is part of
How leaf segments should be handled, can be 'ignore', 'merge' or 'short-interval'.
+Connector to set state of
+Interval the connector is part of
Interval the connector is part of
+Connector to set state of
Interval to update state of
+Interval to update state of
-Domain to list intervals for
+Domain to list intervals for
-Return a sparse connectivity matrix representation for the given skeleton + IDs. The returned dictionary has a key for each row skeleton having + outgoing connections to one or more column skeletons. Each entry stores a + dictionary that maps the connection partners to the individual outgoing + synapse counts.
+ +application/x-www-form-urlencoded +
++ | + | + | + | + |
---|---|---|---|---|
+ project_id + | +Project of skeletons + |
+ path | ++ integer + + + | ++ + | +
+ rows + | +IDs of row skeletons + |
+ formData | ++ string[] + + + | ++ + | +
+ columns + | +IDs of column skeletons + |
+ formData | ++ string[] + + + | ++ + | +
+ with_locations + | +Whether or not to return locations of connectors + |
+ formData | ++ boolean + + + | ++ | +
Get a list of all skeletons that intersect with the passed in bounding - box.
+ box. Optionally, only a subsed of passed in skeletons can be tested against.A minimum number of nodes per result skeleton
+A minimum number of cable length per result skeleton
+Alternative to manual bounding box definition. The bounding box of the + volume is used.
+An optional list of skeleton IDs that should only be tested againt. If + used, the result will only contain skeletons of this set.
+Get a list of all skeletons that intersect with the passed in bounding + box. Optionally, only a subsed of passed in skeletons can be tested against.
+ +application/x-www-form-urlencoded +
++ | + | + | + | + |
---|---|---|---|---|
+ project_id + | ++ | path | ++ string + + + | ++ + | +
+ limit + | +Limit the number of returned nodes. + |
+ formData | ++ integer + + + | ++ | +
+ minx + | +Minimum world space X coordinate + |
+ formData | ++ float + + + | ++ + | +
+ miny + | +Minimum world space Y coordinate + |
+ formData | ++ float + + + | ++ + | +
+ minz + | +Minimum world space Z coordinate + |
+ formData | ++ float + + + | ++ + | +
+ maxx + | +Maximum world space X coordinate + |
+ formData | ++ float + + + | ++ + | +
+ maxy + | +Maximum world space Y coordinate + |
+ formData | ++ float + + + | ++ + | +
+ maxz + | +Maximum world space Z coordinate + |
+ formData | ++ float + + + | ++ + | +
+ min_nodes + | +A minimum number of nodes per result skeleton + |
+ formData | ++ float + + + | ++ | +
+ min_cable + | +A minimum number of cable length per result skeleton + |
+ formData | ++ float + + + | ++ | +
+ volume_id + | +Alternative to manual bounding box definition. The bounding box of the + volume is used. + |
+ formData | ++ integer + + + | ++ | +
+ skeleton_ids + | +An optional list of skeleton IDs that should only be tested againt. If + used, the result will only contain skeletons of this set. + |
+ formData | ++ string[] + + + | ++ | +
Return relationship between label IDs and skeleton IDs
Project of landmark
+IDs of the skeleton to get the cable length for
IDs of the skeleton to get the cable length for
+Project of landmark
Retrieve node information in a compact form. A list of elements of the - following form is returned: [ID, parent ID, x, y, z, confidence, user_id, - radius, skeleton_id, user_id].
+ following form is returned: +[ID, parent ID, x, y, z, confidence, radius, skeleton_id, edition_time, user_id]
+The returned edition time is an epoch number.
application/x-www-form-urlencoded +
+project_id | -- | path | +Project to work in + |
+ formData |
string
@@ -11506,6 +12139,68 @@ POST /{proje |
+
+ treenode_ids + | +A list of treeonde IDs to return information on + |
+ formData | ++ string + + + | ++ | +
+ label_ids + | +A list of label IDs that must be linked to result treenodes. Alternative + to explicit treenode IDs and label names. + |
+ formData | ++ string + + + | ++ | +
+ label_names + | +A list of label names that must be linked to result treenodes. + Alternative to explicit treenode IDs and label IDs + |
+ formData | ++ string + + + | ++ | +
+ skeleton_ids + | +A list of skeleton IDs that result skeletons have to be part of. + |
+ formData | ++ string + + + | ++ | +
Retrieve node information in a compact form. A list of the following form - is returned: [ID, parent ID, x, y, z, confidence, user_id, radius, - skeleton_id, user_id].
+ is returned: +[ID, parent ID, x, y, z, confidence, radius, skeleton_id, edition_time, user_id]
+The returned edition time is an epoch number.
Test if a point intersects with a given volume.
+Test if a point intersects with the bounding box of a given volume.