Add schemas for Darwin Reference data

2026-03-21 21:00:27 +00:00
parent 817baa7d66
commit 1a9b68ce41
6 changed files with 356 additions and 0 deletions
--- a/schemas/data-ingress/darwin-reference-data/reason-code.json
+++ b/schemas/data-ingress/darwin-reference-data/reason-code.json
@@ -0,0 +1,54 @@
+{
+    "$id": "https://schema.owlboard.info/data-ingress/darwin/ref/reasons.schema.json",
+    "$schema": "https://json-schema.org/draft-07/schema#",
+    "title": "DarwinReasonCodeData",
+    "type": "object",
+    "properties": {
+        "service_name": {
+            "type": "string",
+            "description": "Name of the service submitting the update"
+        },
+        "service_id": {
+            "type": "string",
+            "description": "ID of the service sending the message - usually a hostname"
+        },
+        "data_type": {
+            "type": "string",
+            "const": "raw",
+            "description": "The type of data contained in this message object"
+        },
+        "sent_timestamp": {
+            "type": "integer",
+            "description": "Unix timestamp representing the time the message was sent"
+        },
+        "data_kind": {
+            "type": "string",
+            "const": "ref-darwin-reason-code",
+            "description": "The data type contained in the message.  Currently supported PIS: PIS Data, Timetable: CIF or VSTP Data, Knowledgebase: Station Data"
+        },
+        "payload": {
+            "type": "array",
+            "additionalItems": false,
+            "items": {
+                "type": "object",
+                "required": ["c", "lR", "cR"],
+                "properties": {
+                    "c": {
+                        "type": "integer",
+                        "description": "The 'code' that the late/cancel reason maps to"
+                    },
+                    "lR": {
+                        "type": "string",
+                        "description": "The lateReason string for the item"
+                    },
+                    "cR": {
+                        "type": "string",
+                        "description": "The cancelReason string for the item"
+                    }
+                }
+            }
+        }
+    },
+    "required": ["service_name", "service_id", "data_type", "data_kind", "sent_timestamp"],
+    "additionalProperties": false
+}