stub the Policy schema generator

Author: thekaveman

schema/README.md

@@ -7,10 +7,10 @@ This directory contains the templates and code that _generate_ the official JSON
 At a command prompt within this `schema` directory run:
 
 ```bash
-python generate_schemas.py [--agency] [--provider]
+python generate_schemas.py [--agency] [--policy] [--provider]
 ```
 
-The optional flags `--agency` and `--provider` can be used to specify which
+The optional flags `--agency`, `--policy`, and `--provider` can be used to specify which
 set of schemas to generate. The default is to generate all schemas.
 
 ## Updating Schemas
@@ -29,8 +29,6 @@ set of schemas to generate. The default is to generate all schemas.
 
 1. Run the command to regenerate the schema(s).
 
-[agency]: ../agency
 [common-module]: common.py
 [common-template]: templates/common.json
-[provider]: ../provider
 [templates]: templates/

schema/generate_schemas.py

@@ -2,13 +2,14 @@
 Generate the JSON Schema documents for MDS endpoints.
 
 USAGE:
-    python generate_schemas.py [--agency] [--provider]
+    python generate_schemas.py [--agency] [--policy] [--provider]
 """
 
 import sys
 
 import agency
 import common
+import policy
 import provider
 
 
@@ -17,11 +18,15 @@
 
     if len(sys.argv) == 1:
         agency.write_schema_files(common_definitions)
+        policy.write_schema_files(common_definitions)
         provider.write_schema_files(common_definitions)
     else:
         if "--agency" in sys.argv:
             agency.write_schema_files(common_definitions)
             sys.argv.remove("--agency")
+        if "--policy" in sys.argv:
+            policy.write_schema_files(common_definitions)
+            sys.argv.remove("--policy")
         if "--provider" in sys.argv:
             provider.write_schema_files(common_definitions)
             sys.argv.remove("--provider")

schema/policy.py

@@ -0,0 +1,39 @@
+"""
+Schema generators for Policy endpoints.
+"""
+
+import json
+
+import common
+
+
+def policy_schema(common_definitions):
+    print("Generating policy schema")
+
+
+def schema_generators():
+    """
+    The dict of schema generators for Policy.
+
+    The key is the name of the schema file/template file.
+    The value is the generator function, taking a dict of common definitions as an argument.
+    The generator function should return the complete, validated schema document as a dict.
+    """
+    return {
+        "policy": policy_schema
+    }
+
+
+def write_schema_files(common_definitions):
+    """
+    Create each of the Policy endpoint schema files in the appropriate directory.
+    """
+    print("\nStarting to generate Policy JSON Schemas...\n")
+
+    for name, generator in schema_generators().items():
+        schema = generator(common_definitions)
+        with open(f"../policy/{name}.json", "w") as schemafile:
+            schemafile.write(json.dumps(schema, indent=2))
+            print(f"Wrote {name}.json")
+
+    print("\nFinished generating Policy JSON Schemas")

schema/templates/policy/policy.json

@@ -0,0 +1,12 @@
+{
+  "$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/policy/policy.json",
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "The MDS Policy Schema",
+  "type": "object",
+  "definitions": {},
+  "required": [
+  ],
+  "properties": {
+  },
+  "additionalProperties": false
+}