Update API

info_node/swagger/swagger.yaml

@@ -199,12 +199,63 @@ paths:
           schema:
             $ref: "#/definitions/Status"
       x-swagger-router-controller: "info_node.controllers.arbor_controller"
-  /arbor/neuron_ids:
+  /arbor/attributes:
     get:
       tags:
       - "arbor"
-      summary: "Retrieves the list of all neuron IDs."
-      operationId: "arbor_get_neuron_ids"
+      summary: "Retrieves the list of all attributes."
+      operationId: "arbor_get_attributes"
+      produces:
+      - "application/json"
+      parameters: []
+      responses:
+        200:
+          description: "Operation successful."
+          schema:
+            type: "array"
+            items:
+              type: "string"
+            example:
+              - "Voltage"
+              - "Current"
+        400:
+          description: "Operation failed."
+          schema:
+            type: "string"
+            example: "Error message"
+      x-swagger-router-controller: "info_node.controllers.arbor_controller"
+    put:
+      tags:
+      - "arbor"
+      summary: "Registers attributes."
+      operationId: "arbor_put_attributes"
+      produces:
+      - "application/json"
+      parameters:
+      - in: "body"
+        name: "attributes"
+        description: "A list of attributes."
+        required: true
+        schema:
+          type: "array"
+          items:
+            type: "string"
+      responses:
+        200:
+          description: "Operation successful."
+          schema:
+            $ref: "#/definitions/Status"
+        400:
+          description: "Operation failed."
+          schema:
+            $ref: "#/definitions/Status"
+      x-swagger-router-controller: "info_node.controllers.arbor_controller"
+  /arbor/cell_ids:
+    get:
+      tags:
+      - "arbor"
+      summary: "Retrieves the list of all cell IDs."
+      operationId: "arbor_get_cell_ids"
       produces:
       - "application/json"
       parameters: []
@@ -224,14 +275,14 @@ paths:
     put:
       tags:
       - "arbor"
-      summary: "Registers a neuron by ID."
-      operationId: "arbor_put_neuron_ids"
+      summary: "Registers a cell by ID."
+      operationId: "arbor_put_cell_ids"
       consumes:
       - "application/json"
       produces:
       - "application/json"
       parameters:
-      - name: "gids"
+      - name: "cell_ids"
         in: "query"
         required: true
         type: "array"
@@ -253,18 +304,18 @@ paths:
           schema:
             $ref: "#/definitions/Status"
       x-swagger-router-controller: "info_node.controllers.arbor_controller"
-  /arbor/neuron_properties:
+  /arbor/cell_properties:
     get:
       tags:
       - "arbor"
       summary: "Retrieves the properties of the specified neurons."
-      operationId: "arbor_get_neuron_properties"
+      operationId: "arbor_get_cell_properties"
       produces:
       - "application/json"
       parameters:
-      - name: "gids"
+      - name: "cell_ids"
         in: "query"
-        description: "A list of neuron IDs queried for properties."
+        description: "A list of cell IDs queried for properties."
         required: false
         type: "array"
         items:
@@ -276,7 +327,7 @@ paths:
           schema:
             type: "array"
             items:
-              $ref: "#/definitions/ArborNeuronProperties"
+              $ref: "#/definitions/ArborCellProperties"
         400:
           description: "Operation failed."
           schema:
@@ -286,19 +337,19 @@ paths:
     put:
       tags:
       - "arbor"
-      summary: "Sends the properties of the specified neurons."
-      operationId: "arbor_set_neuron_properties"
+      summary: "Sends the properties of the specified cells."
+      operationId: "arbor_set_cell_properties"
       produces:
       - "application/json"
       parameters:
       - in: "body"
         name: "properties"
-        description: "A list of neuron IDs queried for properties."
+        description: "A list of cell properties."
         required: true
         schema:
           type: "array"
           items:
-            $ref: "#/definitions/ArborNeuronProperties"
+            $ref: "#/definitions/ArborCellProperties"
       responses:
         200:
           description: "Operation successful."
@@ -309,25 +360,27 @@ paths:
           schema:
             $ref: "#/definitions/Status"
       x-swagger-router-controller: "info_node.controllers.arbor_controller"
-  /arbor/attributes:
+  /arbor/probes:
     get:
       tags:
       - "arbor"
-      summary: "Retrieves a list of measurable attributes"
-      operationId: "arbor_get_attributes"
+      summary: "Retrieves the list of all probes for a given attribute (optional)."
+      operationId: "arbor_get_probes"
       produces:
       - "application/json"
-      parameters: []
+      parameters:
+      - name: "attribute"
+        in: "query"
+        description: "The attribute measured for which existing probes will be returned."
+        required: false
+        type: "string"
       responses:
         200:
           description: "Operation successful."
           schema:
             type: "array"
             items:
-              type: "string"
-            example:
-            - "Voltage"
-            - "Resistance"
+              $ref: "#/definitions/Probe"
         400:
           description: "Operation failed."
           schema:
@@ -337,18 +390,45 @@ paths:
     put:
       tags:
       - "arbor"
-      summary: "Puts the available attributes"
-      operationId: "arbor_put_attributes"
+      summary: "Registers probes."
+      operationId: "arbor_put_probe"
       consumes:
       - "application/json"
       produces:
       - "application/json"
       parameters:
-      - name: "attributes"
+      - name: "probe_ids"
         in: "query"
-        required: false
+        required: true
         type: "array"
         items:
+          type: "integer"
+          format: "uint64"
+      - name: "cell_ids"
+        in: "query"
+        required: true
+        type: "array"
+        items:
+          type: "integer"
+          format: "uint64"
+      - name: "segment_ids"
+        in: "query"
+        required: true
+        type: "array"
+        items:
+          type: "integer"
+          format: "uint64"
+      - name: "positions"
+        in: "query"
+        required: true
+        type: "array"
+        items:
+          type: "number"
+          format: "double"
+      - name: "address"
+        in: "query"
+        description: "Address of the node."
+        required: false
         type: "string"
       responses:
         200:
@@ -692,7 +772,27 @@ definitions:
     example:
       code: 0.8008281904610115
       message: "message"
-  ArborNeuronProperties:
+  Probe:
+    type: "object"
+    properties:
+      id:
+        type: "integer"
+        format: "uint64"
+      cell_id:
+        type: "integer"
+        format: "uint64"
+      segment_id:
+        type: "integer"
+        format: "uint64"
+      position:
+        type: "number"
+        format: "double"
+    example:
+      id: 1
+      cell_id: 2
+      segment_id: 1
+      position: 0.4
+  ArborCellProperties:
     type: "object"
     properties:
       gid:
@@ -702,7 +802,7 @@ definitions:
         type: "object"
         properties: {}
     example:
-      gid: 5
+      cell_id: 5
       properties:
         population: "pop1"
         position: