Build Models

models/schemas/ephys_link/AngularResponse.json

@@ -1 +1 @@
-{"$defs": {"Vector3": {"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\n:param angles: Position of the manipulator.\n:type angles: Vector3", "properties": {"Angles": {"$ref": "#/$defs/Vector3"}, "Error": {"title": "Error", "type": "string"}}, "required": ["Angles", "Error"], "title": "AngularResponse", "type": "object"}
+{"$defs": {"Vector3": {"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\n:param angles: Position of the manipulator.\n:type angles: Vector3", "properties": {"Angles": {"allOf": [{"$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\n:param state: State of the event.\n:type state: bool\n:param error: Error message if any.\n:type error: str", "properties": {"State": {"title": "State", "type": "boolean"}, "Error": {"title": "Error", "type": "string"}}, "required": ["State", "Error"], "title": "BooleanStateResponse", "type": "object"}
+{"description": "Response format for a boolean state.\n\n:param state: State of the event.\n:type state: bool\n:param error: Error message if any.\n:type error: str", "properties": {"State": {"default": false, "title": "State", "type": "boolean"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "BooleanStateResponse", "type": "object"}

models/schemas/ephys_link/CanWriteRequest.json

@@ -1 +1 @@
-{"description": "Request format for setting can write state.\n\n:param manipulator_id: ID of the manipulator to move.\n:type manipulator_id: str\n:param can_write: Whether the manipulator can write.\n:type can_write: bool\n:param hours: Number of hours the manipulator can write for.\n:type hours: float", "properties": {"ManipulatorId": {"title": "Manipulatorid", "type": "string"}, "CanWrite": {"title": "Canwrite", "type": "boolean"}, "Hours": {"title": "Hours", "type": "number"}}, "required": ["ManipulatorId", "CanWrite", "Hours"], "title": "CanWriteRequest", "type": "object"}
+{"description": "Request format for setting can write state.\n\n:param manipulator_id: ID of the manipulator to move.\n:type manipulator_id: str\n:param can_write: Whether the manipulator can write.\n:type can_write: bool\n:param hours: Number of hours the manipulator can write for (0 = indefinitely).\n:type hours: float", "properties": {"ManipulatorId": {"minLength": 1, "title": "Manipulatorid", "type": "string"}, "CanWrite": {"title": "Canwrite", "type": "boolean"}, "Hours": {"minimum": 0.0, "title": "Hours", "type": "number"}}, "required": ["ManipulatorId", "CanWrite", "Hours"], "title": "CanWriteRequest", "type": "object"}

models/schemas/ephys_link/DriveToDepthRequest.json

@@ -1 +1 @@
-{"description": "Request format for driving a manipulator to depth.\n\n:param manipulator_id: ID of the manipulator to move.\n:type manipulator_id: str\n:param depth: Depth to drive to in mm.\n:type depth: float\n:param speed: Speed to drive at in mm/s.\n:type speed: float", "properties": {"ManipulatorId": {"title": "Manipulatorid", "type": "string"}, "Depth": {"title": "Depth", "type": "number"}, "Speed": {"title": "Speed", "type": "number"}}, "required": ["ManipulatorId", "Depth", "Speed"], "title": "DriveToDepthRequest", "type": "object"}
+{"description": "Request format for driving a manipulator to depth.\n\n:param manipulator_id: ID of the manipulator to move.\n:type manipulator_id: str\n:param depth: Depth to drive to in mm.\n:type depth: float\n:param speed: Speed to drive at in mm/s.\n:type speed: float", "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": "DriveToDepthRequest", "type": "object"}

models/schemas/ephys_link/DriveToDepthResponse.json

@@ -1 +1 @@
-{"description": "Response format for driving a manipulator to depth.\n\n:param depth: Depth the manipulator is at in mm.\n:type depth: float\n:param error: Error message if any.\n:type error: str", "properties": {"Depth": {"title": "Depth", "type": "number"}, "Error": {"title": "Error", "type": "string"}}, "required": ["Depth", "Error"], "title": "DriveToDepthResponse", "type": "object"}
+{"description": "Response format for driving a manipulator to depth.\n\n:param depth: Depth the manipulator is at in mm.\n:type depth: float\n:param error: Error message if any.\n:type error: str", "properties": {"Depth": {"default": 0, "title": "Depth", "type": "number"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "DriveToDepthResponse", "type": "object"}

models/schemas/ephys_link/GetManipulatorsResponse.json

@@ -1 +1 @@
-{"$defs": {"Vector3": {"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 requesting available manipulators.\n\n:param manipulators: List of manipulators.\n:type manipulators: list[str]\n:param num_axes: Number of axes for the manipulators.\n:type num_axes: int\n:param dimensions: Dimensions of the manipulators (first 3 axes in unified manipulator space).\n:type dimensions: Vector3\n:param error: Error message if any.\n:type error: str", "properties": {"Manipulators": {"items": {"type": "string"}, "title": "Manipulators", "type": "array"}, "NumAxes": {"title": "Numaxes", "type": "integer"}, "Dimensions": {"$ref": "#/$defs/Vector3"}, "Error": {"title": "Error", "type": "string"}}, "required": ["Manipulators", "NumAxes", "Dimensions", "Error"], "title": "GetManipulatorsResponse", "type": "object"}
+{"$defs": {"Vector3": {"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 requesting available manipulators.\n\n:param manipulators: List of manipulators.\n:type manipulators: list[str]\n:param num_axes: Number of axes for the manipulators.\n:type num_axes: int\n:param dimensions: Dimensions of the manipulators (first 3 axes in unified manipulator space).\n:type dimensions: Vector3\n:param error: Error message if any.\n:type error: str", "properties": {"Manipulators": {"items": {"type": "string"}, "title": "Manipulators", "type": "array"}, "NumAxes": {"default": 0, "minimum": -1, "title": "Numaxes", "type": "integer"}, "Dimensions": {"allOf": [{"$ref": "#/$defs/Vector3"}], "default": {"x": 0.0, "y": 0.0, "z": 0.0}}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "GetManipulatorsResponse", "type": "object"}

models/schemas/ephys_link/GotoPositionRequest.json

@@ -1 +1 @@
-{"$defs": {"Vector4": {"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\n:param manipulator_id: ID of the manipulator to move.\n:type manipulator_id: str\n:param position: Position to move to in mm (X, Y, Z, W).\n:type position: Vector4\n:param speed: Speed to move at in mm/s.\n:type speed: float", "properties": {"ManipulatorId": {"title": "Manipulatorid", "type": "string"}, "Position": {"$ref": "#/$defs/Vector4"}, "Speed": {"title": "Speed", "type": "number"}}, "required": ["ManipulatorId", "Position", "Speed"], "title": "GotoPositionRequest", "type": "object"}
+{"$defs": {"Vector4": {"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\n:param manipulator_id: ID of the manipulator to move.\n:type manipulator_id: str\n:param position: Position to move to in mm (X, Y, Z, W).\n:type position: Vector4\n:param speed: Speed to move at in mm/s.\n:type speed: float", "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": "GotoPositionRequest", "type": "object"}

models/schemas/ephys_link/InsideBrainRequest.json

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

models/schemas/ephys_link/PositionalResponse.json

@@ -1 +1 @@
-{"$defs": {"Vector4": {"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\n:param position: Position of the manipulator.\n:type position: Vector4", "properties": {"Position": {"$ref": "#/$defs/Vector4"}, "Error": {"title": "Error", "type": "string"}}, "required": ["Position", "Error"], "title": "PositionalResponse", "type": "object"}
+{"$defs": {"Vector4": {"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\n:param position: Position of the manipulator.\n:type position: Vector4", "properties": {"Position": {"allOf": [{"$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/ShankCountResponse.json

@@ -1 +1 @@
-{"description": "Response format for the shank count.\n\n:param shank_count: Number of shanks.\n:type shank_count: int\n:param error: Error message if any.\n:type error: str", "properties": {"ShankCount": {"title": "Shankcount", "type": "integer"}, "Error": {"title": "Error", "type": "string"}}, "required": ["ShankCount", "Error"], "title": "ShankCountResponse", "type": "object"}
+{"description": "Response format for the shank count.\n\n:param shank_count: Number of shanks.\n:type shank_count: int\n:param error: Error message if any.\n:type error: str", "properties": {"ShankCount": {"default": 1, "minimum": 1, "title": "Shankcount", "type": "integer"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "ShankCountResponse", "type": "object"}