Mild improvement to asyncapi schema

DiamondLightSource · Nov 14, 2024 · 75c446f · 75c446f
1 parent 05e03ea
commit 75c446f
Showing 1 changed file with 8 additions and 34 deletions.
diff --git a/docs/reference/asyncapi.yaml b/docs/reference/asyncapi.yaml
@@ -43,7 +43,7 @@ components:
         type: object
         properties:
           name:
-            type: string
+            const: "start"
           doc:
             $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.1/event_model/schemas/run_start.json"
     taggedStopDocument:
@@ -55,7 +55,7 @@ components:
         type: object
         properties:
           name:
-            type: string
+            const: "stop"
           doc:
             $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.1/event_model/schemas/run_stop.json"
     taggedDescriptorDocument:
@@ -67,7 +67,7 @@ components:
         type: object
         properties:
           name:
-            type: string
+            const: "descriptor"
           doc:
             $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.1/event_model/schemas/event_descriptor.json"
     taggedEventDocument:
@@ -79,22 +79,9 @@ components:
         type: object
         properties:
           name:
-            type: string
+            const: "event"
           doc:
             $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.1/event_model/schemas/event.json"
-    taggedEventPage:
-      messageId: eventPage
-      deprecated: true
-      summary: Page style collection of events
-      headers:
-        $ref: "#/components/schemas/contextHeaders"
-      payload:
-        type: object
-        properties:
-          name:
-            type: string
-          doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.1/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
@@ -104,7 +91,7 @@ components:
         type: object
         properties:
           name:
-            type: string
+            const: "resource"
           doc:
             $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.1/event_model/schemas/resource.json"
     taggedDatumDocument:
@@ -116,22 +103,9 @@ components:
         type: object
         properties:
           name:
-            type: string
+            const: "datum"
           doc:
             $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.1/event_model/schemas/datum.json"
-    taggedDatumPage:
-      messageId: datumPage
-      deprecated: true
-      summary: Page style collection of datum
-      headers:
-        $ref: "#/components/schemas/contextHeaders"
-      payload:
-        type: object
-        properties:
-          name:
-            type: string
-          doc:
-            $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.1/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
@@ -141,7 +115,7 @@ components:
         type: object
         properties:
           name:
-            type: string
+            const: "stream_resource"
           doc:
             $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.1/event_model/schemas/stream_resource.json"
     taggedDatumStream:
@@ -153,7 +127,7 @@ components:
         type: object
         properties:
           name:
-            type: string
+            const: "stream_datum"
           doc:
             $ref: "https://raw.githubusercontent.com/bluesky/event-model/refs/tags/v1.22.1/event_model/schemas/stream_datum.json"
     workerStateEvent: