chore: Better ephys link docs (#69)

* Get manipulator

* Positional response

* Improved docs

Author: kjy5

models/schemas/ephys_link/AngularResponse.json

@@ -1 +1 @@
-{"$defs": {"Vector3": {"description": "3D vector.\n\nAttributes:\n    x: X component.\n    y: Y component.\n    z: Z component.", "properties": {"x": {"default": 0.0, "title": "X", "type": "number"}, "y": {"default": 0.0, "title": "Y", "type": "number"}, "z": {"default": 0.0, "title": "Z", "type": "number"}}, "title": "Vector3", "type": "object"}}, "description": "Response format for the manipulator angles.\n\nAttributes:\n    angles: Position of the manipulator.\n    error: Error message if any.", "properties": {"Angles": {"$ref": "#/$defs/Vector3", "default": {"x": 0.0, "y": 0.0, "z": 0.0}}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "AngularResponse", "type": "object"}
+{"$defs": {"Vector3": {"description": "3D vector.\n\nAttributes:\n    x: X component.\n    y: Y component.\n    z: Z component.", "properties": {"x": {"default": 0.0, "title": "X", "type": "number"}, "y": {"default": 0.0, "title": "Y", "type": "number"}, "z": {"default": 0.0, "title": "Z", "type": "number"}}, "title": "Vector3", "type": "object"}}, "description": "Manipulator axis angles.\n\nThis is not very standardized and its usage is platform-specific.\n\nAttributes:\n    angles: Position of the manipulator.\n    error: Error message if any.", "properties": {"Angles": {"$ref": "#/$defs/Vector3", "default": {"x": 0.0, "y": 0.0, "z": 0.0}}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "AngularResponse", "type": "object"}

models/schemas/ephys_link/BooleanStateResponse.json

@@ -1 +1 @@
-{"description": "Response format for a boolean state.\n\nAttributes:\n    state: State of the event.\n    error: Error message if any.", "properties": {"State": {"default": false, "title": "State", "type": "boolean"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "BooleanStateResponse", "type": "object"}
+{"description": "Boolean state from an event.\n\nAttributes:\n    state: State of the event.\n    error: Error message if any.", "properties": {"State": {"default": false, "title": "State", "type": "boolean"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "BooleanStateResponse", "type": "object"}

models/schemas/ephys_link/GetManipulatorsResponse.json

@@ -1 +1 @@
-{"description": "Response format for requesting available manipulators.\n\nAttributes:\n    manipulators: List of manipulators by ID.\n    error: Error message if any.", "properties": {"Manipulators": {"items": {"type": "string"}, "title": "Manipulators", "type": "array"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "GetManipulatorsResponse", "type": "object"}
+{"description": "List the IDs of available manipulators from the active platform.\n\nAttributes:\n    manipulators: List of manipulators by ID.\n    error: Error message if any.", "properties": {"Manipulators": {"items": {"type": "string"}, "title": "Manipulators", "type": "array"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "GetManipulatorsResponse", "type": "object"}

models/schemas/ephys_link/PlatformInfo.json

@@ -1 +1 @@
-{"$defs": {"Vector4": {"description": "4D vector.\n\nAttributes:\n    x: X component.\n    y: Y component.\n    z: Z component.\n    w: W component.", "properties": {"x": {"default": 0.0, "title": "X", "type": "number"}, "y": {"default": 0.0, "title": "Y", "type": "number"}, "z": {"default": 0.0, "title": "Z", "type": "number"}, "w": {"default": 0.0, "title": "W", "type": "number"}}, "title": "Vector4", "type": "object"}}, "description": "Information about the manipulator platform.\n\nAttributes:\n    name: Name of the manipulator platform.\n    cli_name: CLI identifier for the manipulator platform (for the `-t` flag).\n    axes_count: Number of axes on a manipulator.\n    dimensions: Dimensions of the manipulators (3-axis manipulators should set w to 0).", "properties": {"Name": {"minLength": 1, "title": "Name", "type": "string"}, "CliName": {"minLength": 1, "title": "Cliname", "type": "string"}, "AxesCount": {"default": 0, "minimum": -1, "title": "Axescount", "type": "integer"}, "Dimensions": {"$ref": "#/$defs/Vector4", "default": {"x": 0.0, "y": 0.0, "z": 0.0, "w": 0.0}}}, "required": ["Name", "CliName"], "title": "PlatformInfo", "type": "object"}
+{"$defs": {"Vector4": {"description": "4D vector.\n\nAttributes:\n    x: X component.\n    y: Y component.\n    z: Z component.\n    w: W component.", "properties": {"x": {"default": 0.0, "title": "X", "type": "number"}, "y": {"default": 0.0, "title": "Y", "type": "number"}, "z": {"default": 0.0, "title": "Z", "type": "number"}, "w": {"default": 0.0, "title": "W", "type": "number"}}, "title": "Vector4", "type": "object"}}, "description": "General metadata information about the manipulator platform\n\nAttributes:\n    name: Name of the manipulator platform.\n    cli_name: CLI identifier for the manipulator platform (for the `-t` flag).\n    axes_count: Number of axes on a manipulator.\n    dimensions: Dimensions of the manipulators (3-axis manipulators should set w to 0).", "properties": {"Name": {"minLength": 1, "title": "Name", "type": "string"}, "CliName": {"minLength": 1, "title": "Cliname", "type": "string"}, "AxesCount": {"default": 0, "minimum": -1, "title": "Axescount", "type": "integer"}, "Dimensions": {"$ref": "#/$defs/Vector4", "default": {"x": 0.0, "y": 0.0, "z": 0.0, "w": 0.0}}}, "required": ["Name", "CliName"], "title": "PlatformInfo", "type": "object"}

models/schemas/ephys_link/PositionalResponse.json

@@ -1 +1 @@
-{"$defs": {"Vector4": {"description": "4D vector.\n\nAttributes:\n    x: X component.\n    y: Y component.\n    z: Z component.\n    w: W component.", "properties": {"x": {"default": 0.0, "title": "X", "type": "number"}, "y": {"default": 0.0, "title": "Y", "type": "number"}, "z": {"default": 0.0, "title": "Z", "type": "number"}, "w": {"default": 0.0, "title": "W", "type": "number"}}, "title": "Vector4", "type": "object"}}, "description": "Response format for the manipulator position.\n\nAttributes:\n    position: Position of the manipulator.\n    error: Error message if any.", "properties": {"Position": {"$ref": "#/$defs/Vector4", "default": {"x": 0.0, "y": 0.0, "z": 0.0, "w": 0.0}}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "PositionalResponse", "type": "object"}
+{"$defs": {"Vector4": {"description": "4D vector.\n\nAttributes:\n    x: X component.\n    y: Y component.\n    z: Z component.\n    w: W component.", "properties": {"x": {"default": 0.0, "title": "X", "type": "number"}, "y": {"default": 0.0, "title": "Y", "type": "number"}, "z": {"default": 0.0, "title": "Z", "type": "number"}, "w": {"default": 0.0, "title": "W", "type": "number"}}, "title": "Vector4", "type": "object"}}, "description": "Position of a manipulator.\n\nAttributes:\n    position: Position of the manipulator.\n    error: Error message if any.", "properties": {"Position": {"$ref": "#/$defs/Vector4", "default": {"x": 0.0, "y": 0.0, "z": 0.0, "w": 0.0}}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "PositionalResponse", "type": "object"}

models/schemas/ephys_link/SetDepthRequest.json

@@ -1 +1 @@
-{"description": "Request format for driving a manipulator to depth.\n\nAttributes:\n    manipulator_id: ID of the manipulator to move.\n    depth: Depth to drive to in mm.\n    speed: Speed to drive at in mm/s.", "properties": {"ManipulatorId": {"minLength": 1, "title": "Manipulatorid", "type": "string"}, "Depth": {"title": "Depth", "type": "number"}, "Speed": {"exclusiveMinimum": 0.0, "title": "Speed", "type": "number"}}, "required": ["ManipulatorId", "Depth", "Speed"], "title": "SetDepthRequest", "type": "object"}
+{"description": "Depth to drive a manipulator to.\n\nThese are the absolute positions of the manipulator stages.\n\nAttributes:\n    manipulator_id: ID of the manipulator to move.\n    depth: Depth to drive to in mm.\n    speed: Speed to drive at in mm/s.", "properties": {"ManipulatorId": {"minLength": 1, "title": "Manipulatorid", "type": "string"}, "Depth": {"title": "Depth", "type": "number"}, "Speed": {"exclusiveMinimum": 0.0, "title": "Speed", "type": "number"}}, "required": ["ManipulatorId", "Depth", "Speed"], "title": "SetDepthRequest", "type": "object"}

models/schemas/ephys_link/SetDepthResponse.json

@@ -1 +1 @@
-{"description": "Response format for driving a manipulator to depth.\n\nAttributes:\n    depth: Depth the manipulator is at in mm.\n    error: Error message if any.", "properties": {"Depth": {"default": 0, "title": "Depth", "type": "number"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "SetDepthResponse", "type": "object"}
+{"description": "Final depth a manipulator is at after a drive.\n\nAttributes:\n    depth: Depth the manipulator is at in mm.\n    error: Error message if any.", "properties": {"Depth": {"default": 0, "title": "Depth", "type": "number"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "SetDepthResponse", "type": "object"}

models/schemas/ephys_link/SetInsideBrainRequest.json

@@ -1 +1 @@
-{"description": "Request format for setting inside brain state.\n\nAttributes:\n    manipulator_id: ID of the manipulator to move.\n    inside: Whether the manipulator is inside the brain.", "properties": {"ManipulatorId": {"minLength": 1, "title": "Manipulatorid", "type": "string"}, "Inside": {"title": "Inside", "type": "boolean"}}, "required": ["ManipulatorId", "Inside"], "title": "SetInsideBrainRequest", "type": "object"}
+{"description": "Set the \"inside brain\" state of a manipulator.\n\nAttributes:\n    manipulator_id: ID of the manipulator to move.\n    inside: Whether the manipulator is inside the brain.", "properties": {"ManipulatorId": {"minLength": 1, "title": "Manipulatorid", "type": "string"}, "Inside": {"title": "Inside", "type": "boolean"}}, "required": ["ManipulatorId", "Inside"], "title": "SetInsideBrainRequest", "type": "object"}

models/schemas/ephys_link/SetPositionRequest.json

@@ -1 +1 @@
-{"$defs": {"Vector4": {"description": "4D vector.\n\nAttributes:\n    x: X component.\n    y: Y component.\n    z: Z component.\n    w: W component.", "properties": {"x": {"default": 0.0, "title": "X", "type": "number"}, "y": {"default": 0.0, "title": "Y", "type": "number"}, "z": {"default": 0.0, "title": "Z", "type": "number"}, "w": {"default": 0.0, "title": "W", "type": "number"}}, "title": "Vector4", "type": "object"}}, "description": "Request format for moving a manipulator to a position.\n\nAttributes:\n    manipulator_id: ID of the manipulator to move.\n    position: Position to move to in mm (X, Y, Z, W).\n    speed: Speed to move at in mm/s.", "properties": {"ManipulatorId": {"minLength": 1, "title": "Manipulatorid", "type": "string"}, "Position": {"$ref": "#/$defs/Vector4"}, "Speed": {"exclusiveMinimum": 0.0, "title": "Speed", "type": "number"}}, "required": ["ManipulatorId", "Position", "Speed"], "title": "SetPositionRequest", "type": "object"}
+{"$defs": {"Vector4": {"description": "4D vector.\n\nAttributes:\n    x: X component.\n    y: Y component.\n    z: Z component.\n    w: W component.", "properties": {"x": {"default": 0.0, "title": "X", "type": "number"}, "y": {"default": 0.0, "title": "Y", "type": "number"}, "z": {"default": 0.0, "title": "Z", "type": "number"}, "w": {"default": 0.0, "title": "W", "type": "number"}}, "title": "Vector4", "type": "object"}}, "description": "Position to set a manipulator to.\n\nThese are the absolute positions of the manipulator stages.\n\nAttributes:\n    manipulator_id: ID of the manipulator to move.\n    position: Position to move to in mm (X, Y, Z, W).\n    speed: Speed to move at in mm/s.", "properties": {"ManipulatorId": {"minLength": 1, "title": "Manipulatorid", "type": "string"}, "Position": {"$ref": "#/$defs/Vector4"}, "Speed": {"exclusiveMinimum": 0.0, "title": "Speed", "type": "number"}}, "required": ["ManipulatorId", "Position", "Speed"], "title": "SetPositionRequest", "type": "object"}

models/schemas/ephys_link/ShankCountResponse.json

@@ -1 +1 @@
-{"description": "Response format for the shank count.\n\nAttributes:\n    shank_count: Number of shanks.\n    error: Error message if any.", "properties": {"ShankCount": {"default": 1, "minimum": 1, "title": "Shankcount", "type": "integer"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "ShankCountResponse", "type": "object"}
+{"description": "Number of electrode shanks on a manipulator.\n\nAttributes:\n    shank_count: Number of shanks.\n    error: Error message if any.", "properties": {"ShankCount": {"default": 1, "minimum": 1, "title": "Shankcount", "type": "integer"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "ShankCountResponse", "type": "object"}