feat: Blueapi plan pause

docs/reference/openapi.yaml

@@ -365,7 +365,7 @@ components:
           title: Errors
           type: array
         is_complete:
-          default: false
+          readOnly: true
           title: Is Complete
           type: boolean
         is_pending:
@@ -389,6 +389,7 @@ components:
       required:
       - task_id
       - task
+      - is_complete
       title: TrackableTask
       type: object
     ValidationError:
@@ -449,7 +450,7 @@ info:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
   title: BlueAPI Control
-  version: 1.5.0
+  version: 1.5.1
 openapi: 3.1.0
 paths:
   /api/v1/devices:

src/blueapi/config.py

@@ -324,7 +324,7 @@ class ApplicationConfig(BlueapiBaseModel):
     """
 
     #: API version to publish in OpenAPI schema
-    REST_API_VERSION: ClassVar[str] = "1.5.0"
+    REST_API_VERSION: ClassVar[str] = "1.5.1"
 
     LICENSE_INFO: ClassVar[dict[str, str]] = {
         "name": "Apache 2.0",

src/blueapi/worker/task.py

@@ -2,6 +2,7 @@
 from collections.abc import Mapping
 from typing import Any
 
+from bluesky.run_engine import RunEngineResult
 from pydantic import BaseModel, Field, TypeAdapter
 
 from blueapi.core import BlueskyContext
@@ -29,7 +30,7 @@ def prepare_params(self, ctx: BlueskyContext) -> Mapping[str, Any]:
         # Re-create dict manually to avoid nesting in model_dump output
         return {field: getattr(model, field) for field in model.__pydantic_fields__}
 
-    def do_task(self, ctx: BlueskyContext) -> None:
+    def do_task(self, ctx: BlueskyContext) -> Any:
         LOGGER.info(
             f"Asked to run plan {self.name} with {self.params} and "
             f"metadata {self.metadata} for all runs"
@@ -39,9 +40,12 @@ def do_task(self, ctx: BlueskyContext) -> None:
         prepared_params = self.prepare_params(ctx)
         ctx.run_engine.md.update(self.metadata)
         result = ctx.run_engine(func(**prepared_params))
-        if isinstance(result, tuple):  # pragma: no cover
-            # this is never true if the run_engine is configured correctly
-            return None
+        if not isinstance(result, RunEngineResult):
+            # this is unreachable unless something has misconfigured it.
+            raise RuntimeError(
+                "RunEngine did not return a RunEngineResult - is "
+                "call_returns_result set on this RunEngine instance?"
+            )
         return result.plan_result