Compare commits

...

4 Commits

Author SHA1 Message Date
5eb6f623be Schemata...
All checks were successful
Generate and Release Protos / release (push) Successful in 48s
2026-04-21 13:56:26 +01:00
d8acf84b44 Add schema for OW Data 2026-04-21 13:55:57 +01:00
e574358ea9 Make networkRailCorpus.json an object not an array.
All checks were successful
Generate and Release Protos / release (push) Successful in 40s
Object/Array support can be handled on the processor side to support either
2026-04-08 23:12:28 +01:00
698248487a Add networkRailCorpus schema
All checks were successful
Generate and Release Protos / release (push) Successful in 44s
2026-04-08 22:54:06 +01:00
3 changed files with 97 additions and 1 deletions

View File

@@ -1,6 +1,6 @@
# backend-data-contracts
This repository is the single source of truth for all schema definitions used across the Owlboard backend communication and storage services. Language specific types are generated here and published to the Gitea package repository linked to the repo.
This repository is the single source of truth for all schemata definitions used across the Owlboard backend communication and storage services. Language specific types are generated here and published to the Gitea package repository linked to the repo.
## Directory Structure

View File

@@ -0,0 +1,66 @@
{
"$id": "https://schema.owlboard.info/data-ingress/darwin/OW.schema.json",
"$schema": "https://json-schema.org/draft-07/schema#",
"title": "DarwinOwData",
"type": "object",
"required": [
"i",
"d"
],
"additionalProperties": false,
"properties": {
"i": {
"type": "string",
"name": "ID",
"description": "Unique ID of the incident message"
},
"c": {
"type": "string",
"name": "Category",
"description": "Category of the incident message"
},
"s": {
"type": "integer",
"name": "Severity",
"description": "The severity of the incident"
},
"l": {
"type": "array",
"name": "locations",
"description": "CRS Locations at which the message applies",
"additionalItems": false,
"items": {
"type": "string",
"name": "CRS",
"description": "CRS Location where this message applies"
}
},
"d": {
"type": "boolean",
"name": "Delete",
"description": "If true, the message is to be deleted"
},
"m": {
"type": "object",
"name": "Message",
"description": "The message properties",
"properties": {
"l": {
"type": "string",
"name": "href",
"description": "URL where further information can be found"
},
"lt": {
"type": "string",
"name": "href-text",
"description": "Text that should be displayed as part of the href"
},
"m": {
"type": "string",
"name": "Message text",
"description": "The text to be displayed"
}
}
}
}
}

View File

@@ -0,0 +1,30 @@
{
"$id": "https://schema.owlboard.info/data-ingress/network-rail/networkRailCorpus.schema.json",
"$schema": "https://json-schema.org/draft-07/schema#",
"title": "networkRailCorpus",
"type": "object",
"required": [
"t",
"n"
],
"additionalProperties": false,
"properties": {
"t": {
"type": "string",
"name": "TIPLOC",
"description": "The TIPLOC Code of the location"
},
"n": {
"type": "string",
"name": "Name",
"description": "The human readable name of the location"
},
"nc": {
"type": "integer",
"name": "NLC",
"description": "The national location code of the location",
"minimum": 0,
"maximum": 999999
}
}
}