Merge pull request #8 from MetaCell/feature/CELE-32

Feature/cele 32
MetaCell · Jul 17, 2024 · a3f8314 · a3f8314
2 parents 26a8b30 + 13e3d32
commit a3f8314
Show file tree

Hide file tree

Showing 59 changed files with 2,362 additions and 485 deletions.
diff --git a/applications/visualizer/api/openapi.json b/applications/visualizer/api/openapi.json
@@ -8,9 +8,29 @@
   "paths": {
     "/api/datasets": {
       "get": {
-        "operationId": "get_all_datasets",
-        "summary": "Get All Datasets",
-        "parameters": [],
+        "operationId": "get_datasets",
+        "summary": "Get Datasets",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "ids",
+            "schema": {
+              "anyOf": [
+                {
+                  "items": {
+                    "type": "string"
+                  },
+                  "type": "array"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "Ids"
+            },
+            "required": false
+          }
+        ],
         "responses": {
           "200": {
             "description": "OK",
@@ -27,7 +47,7 @@
             }
           }
         },
-        "description": "Returns all the datasets from the DB",
+        "description": "Returns all datasets or a filtered list based on provided IDs",
         "tags": [
           "datasets"
         ]
@@ -158,6 +178,101 @@
         ]
       }
     },
+    "/api/connections": {
+      "get": {
+        "operationId": "get_connections",
+        "summary": "Get Connections",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "cells",
+            "schema": {
+              "title": "Cells",
+              "type": "string"
+            },
+            "required": true
+          },
+          {
+            "in": "query",
+            "name": "dataset_ids",
+            "schema": {
+              "title": "Dataset Ids",
+              "type": "string"
+            },
+            "required": true
+          },
+          {
+            "in": "query",
+            "name": "dataset_type",
+            "schema": {
+              "title": "Dataset Type",
+              "type": "string"
+            },
+            "required": true
+          },
+          {
+            "in": "query",
+            "name": "threshold_chemical",
+            "schema": {
+              "default": 3,
+              "title": "Threshold Chemical",
+              "type": "integer"
+            },
+            "required": false
+          },
+          {
+            "in": "query",
+            "name": "threshold_electrical",
+            "schema": {
+              "default": 3,
+              "title": "Threshold Electrical",
+              "type": "integer"
+            },
+            "required": false
+          },
+          {
+            "in": "query",
+            "name": "include_neighboring_cells",
+            "schema": {
+              "default": false,
+              "title": "Include Neighboring Cells",
+              "type": "boolean"
+            },
+            "required": false
+          },
+          {
+            "in": "query",
+            "name": "include_annotations",
+            "schema": {
+              "default": false,
+              "title": "Include Annotations",
+              "type": "boolean"
+            },
+            "required": false
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "items": {
+                    "$ref": "#/components/schemas/Connection"
+                  },
+                  "title": "Response",
+                  "type": "array"
+                }
+              }
+            }
+          }
+        },
+        "description": "Gets the connections of a dedicated Dataset",
+        "tags": [
+          "connectivity"
+        ]
+      }
+    },
     "/api/live": {
       "get": {
         "operationId": "live",
@@ -357,6 +472,48 @@
         ],
         "title": "PagedNeuron",
         "type": "object"
+      },
+      "Connection": {
+        "properties": {
+          "annotations": {
+            "default": [],
+            "items": {
+              "type": "string"
+            },
+            "title": "Annotations",
+            "type": "array"
+          },
+          "synapses": {
+            "additionalProperties": {
+              "type": "integer"
+            },
+            "default": {},
+            "title": "Synapses",
+            "type": "object"
+          },
+          "pre": {
+            "maxLength": 30,
+            "title": "Pre",
+            "type": "string"
+          },
+          "post": {
+            "maxLength": 30,
+            "title": "Post",
+            "type": "string"
+          },
+          "type": {
+            "maxLength": 20,
+            "title": "Type",
+            "type": "string"
+          }
+        },
+        "required": [
+          "pre",
+          "post",
+          "type"
+        ],
+        "title": "Connection",
+        "type": "object"
       }
     }
   },

diff --git a/applications/visualizer/api/openapi.yaml b/applications/visualizer/api/openapi.yaml
@@ -1,5 +1,37 @@
 components:
   schemas:
+    Connection:
+      properties:
+        annotations:
+          default: []
+          items:
+            type: string
+          title: Annotations
+          type: array
+        post:
+          maxLength: 30
+          title: Post
+          type: string
+        pre:
+          maxLength: 30
+          title: Pre
+          type: string
+        synapses:
+          additionalProperties:
+            type: integer
+          default: {}
+          title: Synapses
+          type: object
+        type:
+          maxLength: 20
+          title: Type
+          type: string
+      required:
+      - pre
+      - post
+      - type
+      title: Connection
+      type: object
     Dataset:
       properties:
         axes:
@@ -139,11 +171,85 @@ paths:
       summary: Get All Cells
       tags:
       - neurons
+  /api/connections:
+    get:
+      description: Gets the connections of a dedicated Dataset
+      operationId: get_connections
+      parameters:
+      - in: query
+        name: cells
+        required: true
+        schema:
+          title: Cells
+          type: string
+      - in: query
+        name: dataset_ids
+        required: true
+        schema:
+          title: Dataset Ids
+          type: string
+      - in: query
+        name: dataset_type
+        required: true
+        schema:
+          title: Dataset Type
+          type: string
+      - in: query
+        name: threshold_chemical
+        required: false
+        schema:
+          default: 3
+          title: Threshold Chemical
+          type: integer
+      - in: query
+        name: threshold_electrical
+        required: false
+        schema:
+          default: 3
+          title: Threshold Electrical
+          type: integer
+      - in: query
+        name: include_neighboring_cells
+        required: false
+        schema:
+          default: false
+          title: Include Neighboring Cells
+          type: boolean
+      - in: query
+        name: include_annotations
+        required: false
+        schema:
+          default: false
+          title: Include Annotations
+          type: boolean
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                items:
+                  $ref: '#/components/schemas/Connection'
+                title: Response
+                type: array
+          description: OK
+      summary: Get Connections
+      tags:
+      - connectivity
   /api/datasets:
     get:
-      description: Returns all the datasets from the DB
-      operationId: get_all_datasets
-      parameters: []
+      description: Returns all datasets or a filtered list based on provided IDs
+      operationId: get_datasets
+      parameters:
+      - in: query
+        name: ids
+        required: false
+        schema:
+          anyOf:
+          - items:
+              type: string
+            type: array
+          - type: 'null'
+          title: Ids
       responses:
         '200':
           content:
@@ -154,7 +260,7 @@ paths:
                 title: Response
                 type: array
           description: OK
-      summary: Get All Datasets
+      summary: Get Datasets
       tags:
       - datasets
   /api/datasets/{dataset}: