Pin to event-model prior to copier template adoption

DiamondLightSource · Oct 25, 2024 · 43e3efa · 43e3efa
1 parent 2292a20
commit 43e3efa
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 46 deletions.
diff --git a/docs/reference/asyncapi.yaml b/docs/reference/asyncapi.yaml
@@ -20,18 +20,18 @@ channels:
       description: Data documents produced by running plans
       message:
         oneOf:
-        - $ref: "#/components/messages/workerStateEvent"
-        - $ref: "#/components/messages/workerProgressEvent"
-        - $ref: "#/components/messages/taggedStartDocument"
-        - $ref: "#/components/messages/taggedDescriptorDocument"
-        - $ref: "#/components/messages/taggedEventDocument"
-        - $ref: "#/components/messages/taggedStopDocument"
-        - $ref: "#/components/messages/taggedResourceDocument"
-        - $ref: "#/components/messages/taggedDatumDocument"
-        - $ref: "#/components/messages/taggedResourceStream"
-        - $ref: "#/components/messages/taggedDatumStream"
-        - $ref: "#/components/messages/taggedEventPage"
-        - $ref: "#/components/messages/taggedDatumPage"
+          - $ref: "#/components/messages/workerStateEvent"
+          - $ref: "#/components/messages/workerProgressEvent"
+          - $ref: "#/components/messages/taggedStartDocument"
+          - $ref: "#/components/messages/taggedDescriptorDocument"
+          - $ref: "#/components/messages/taggedEventDocument"
+          - $ref: "#/components/messages/taggedStopDocument"
+          - $ref: "#/components/messages/taggedResourceDocument"
+          - $ref: "#/components/messages/taggedDatumDocument"
+          - $ref: "#/components/messages/taggedResourceStream"
+          - $ref: "#/components/messages/taggedDatumStream"
+          - $ref: "#/components/messages/taggedEventPage"
+          - $ref: "#/components/messages/taggedDatumPage"
 components:
   messages: # Defined as Components to allow referencing from other APIs. # TODO: Define protocol specific correlationId bindings
     taggedStartDocument:
@@ -45,7 +45,7 @@ components:
           name:
             type: string
           doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/main/src/event_model/schemas/run_start.json"
+            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.0/event_model/schemas/run_start.json"
     taggedStopDocument:
       messageId: runStop
       summary: Indicates the completion of a Bluesky run based on a previously specified Plan; describes end conditions and metadata
@@ -57,7 +57,7 @@ components:
           name:
             type: string
           doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/main/src/event_model/schemas/run_stop.json"
+            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.0/event_model/schemas/run_stop.json"
     taggedDescriptorDocument:
       messageId: eventStreamDescriptor
       summary: Describes the devices to be within a scientifically related stream of measurements
@@ -69,7 +69,7 @@ components:
           name:
             type: string
           doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/main/src/event_model/schemas/event_descriptor.json"
+            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.0/event_model/schemas/event_descriptor.json"
     taggedEventDocument:
       messageId: dataEvent
       summary: Describes a point measurement for a number of scientifically related devices
@@ -81,7 +81,7 @@ components:
           name:
             type: string
           doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/main/src/event_model/schemas/event.json"
+            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.0/event_model/schemas/event.json"
     taggedEventPage:
       messageId: eventPage
       deprecated: true
@@ -94,7 +94,7 @@ components:
           name:
             type: string
           doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/main/src/event_model/schemas/event_page.json"
+            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.0/event_model/schemas/event_page.json"
     taggedResourceDocument:
       messageId: resource
       summary: Describes an external resource (file, database entry etc.) that is to be referenced by later datum
@@ -106,7 +106,7 @@ components:
           name:
             type: string
           doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/main/src/event_model/schemas/resource.json"
+            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.0/event_model/schemas/resource.json"
     taggedDatumDocument:
       messageId: datum
       summary: Describes how to access a point measurement within an external resource
@@ -118,7 +118,7 @@ components:
           name:
             type: string
           doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/main/src/event_model/schemas/datum.json"
+            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.0/event_model/schemas/datum.json"
     taggedDatumPage:
       messageId: datumPage
       deprecated: true
@@ -131,7 +131,7 @@ components:
           name:
             type: string
           doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/main/src/event_model/schemas/datum_page.json"
+            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.0/event_model/schemas/datum_page.json"
     taggedResourceStream:
       messageId: streamResource
       summary: Describes an external resource (file, database entry etc.) that is to be referenced by later Stream Datum
@@ -143,7 +143,7 @@ components:
           name:
             type: string
           doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/main/src/event_model/schemas/stream_resource.json"
+            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.0/event_model/schemas/stream_resource.json"
     taggedDatumStream:
       messageId: streamDatum
       summary: Describes how to access a slice of an external resource
@@ -155,17 +155,17 @@ components:
           name:
             type: string
           doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/main/src/event_model/schemas/stream_datum.json"
+            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.0/event_model/schemas/stream_datum.json"
     workerStateEvent:
       messageId: stateEvent
       headers:
         $ref: "#/components/schemas/contextHeaders"
       payload:
         type: object
         required:
-        - state
-        - errors
-        - warnings
+          - state
+          - errors
+          - warnings
         properties:
           state:
             $ref: "#/components/schemas/workerState"
@@ -188,8 +188,8 @@ components:
       payload:
         type: object
         required:
-        - taskName
-        - statuses
+          - taskName
+          - statuses
         properties:
           taskName:
             description: Unique id of the task, returned when it was originally submitted
@@ -203,7 +203,7 @@ components:
     contextHeaders:
       type: object
       required:
-      - destination
+        - destination
       properties:
         destination:
           description: Name of the channel on which the message is being sent
@@ -217,23 +217,23 @@ components:
     workerState:
       description: The state of the Worker.
       enum:
-      - IDLE
-      - RUNNING
-      - PAUSING
-      - PAUSED
-      - HALTING
-      - STOPPING
-      - ABORTING
-      - SUSPENDING
-      - PANICKED
-      - UNKNOWN
+        - IDLE
+        - RUNNING
+        - PAUSING
+        - PAUSED
+        - HALTING
+        - STOPPING
+        - ABORTING
+        - SUSPENDING
+        - PANICKED
+        - UNKNOWN
     taskStatus:
       description: Current state of a task the worker is running.
       type: object
       required:
-      - taskName
-      - taskComplete
-      - taskFailed
+        - taskName
+        - taskComplete
+        - taskFailed
       properties:
         taskName:
           description: Unique id of the task, returned when it was originally submitted
@@ -247,10 +247,10 @@ components:
     statusView:
       type: object
       required:
-      - displayName
-      - unit
-      - precision
-      - done
+        - displayName
+        - unit
+        - precision
+        - done
       properties:
         displayName:
           description: Human-readable name indicating what this status describes

diff --git a/pyproject.toml b/pyproject.toml
@@ -29,9 +29,10 @@ dependencies = [
     "requests",
     "dls-bluesky-core",     #requires ophyd-async
     "dls-dodal>=1.31.0",
-    "super-state-machine",  # See GH issue 553
+    "super-state-machine",  # https://github.com/DiamondLightSource/blueapi/issues/553
     "GitPython",
     "bluesky-stomp>=0.1.2",
+    "event-model<1.23",     # https://github.com/DiamondLightSource/blueapi/issues/684
 ]
 dynamic = ["version"]
 license.file = "LICENSE"