Create location filter schema

2026-03-24 00:38:08 +00:00
parent 8ac0215247
commit 0848fe3b27
1 changed files with 31 additions and 0 deletions
--- a/schemas/api/location-filter.json
+++ b/schemas/api/location-filter.json
@@ -0,0 +1,31 @@
+{
+    "$id": "https://schema.owlboard.info/api/location-filter.schema.json",
+    "$schema": "https://json-schema.org/draft-07/schema#",
+    "title": "LocationFilterObject",
+    "description": "Location filter API Response.  Provides a location's data for filtering on the frontend",
+    "type": "object",
+    "required": ["n", "t", "s"],
+    "additionalProperties": false,
+    "properties": {
+        "n": {
+            "type": "string",
+            "name": "Name",
+            "description": "Name of the location"
+        },
+        "t": {
+            "type": "string",
+            "name": "TIPLOC",
+            "description": "TIPLOC of the location"
+        },
+        "c": {
+            "type": "string",
+            "name": "CRS",
+            "description": "CRS of the location"
+        },
+        "s": {
+            "type": "string",
+            "name": "searchString",
+            "description": "Generated string for efficient filtering"
+        }
+    }
+}