#38 - fix JSON schema generation

Lance-Drane · Lance-Drane · commit f4e51ffae0ad · 2026-02-05T15:30:36.000-05:00
Signed-off-by: Lance-Drane &lt;Lance-Drane@users.noreply.github.com&gt;
diff --git a/examples/1_hello_world/hello_service_schema.json b/examples/1_hello_world/hello_service_schema.json
@@ -51,7 +51,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/1_hello_world_amqp/hello_service_schema.json b/examples/1_hello_world_amqp/hello_service_schema.json
@@ -51,7 +51,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/1_hello_world_events/hello_service_schema.json b/examples/1_hello_world_events/hello_service_schema.json
@@ -57,7 +57,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/1_hello_world_minio/hello_service_schema.json b/examples/1_hello_world_minio/hello_service_schema.json
@@ -51,7 +51,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/2_counting/counting_service_schema.json b/examples/2_counting/counting_service_schema.json
@@ -139,7 +139,7 @@
     },
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/2_counting_events/counting_service_schema.json b/examples/2_counting_events/counting_service_schema.json
@@ -25,7 +25,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/3_ping_pong_events/ping_service_schema.json b/examples/3_ping_pong_events/ping_service_schema.json
@@ -25,7 +25,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/3_ping_pong_events/pong_service_schema.json b/examples/3_ping_pong_events/pong_service_schema.json
@@ -25,7 +25,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/3_ping_pong_events_amqp/ping_service_schema.json b/examples/3_ping_pong_events_amqp/ping_service_schema.json
@@ -25,7 +25,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/3_ping_pong_events_amqp/pong_service_schema.json b/examples/3_ping_pong_events_amqp/pong_service_schema.json
@@ -25,7 +25,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/4_service_to_service/example_1_service_schema.json b/examples/4_service_to_service/example_1_service_schema.json
@@ -55,7 +55,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/4_service_to_service/example_2_service_schema.json b/examples/4_service_to_service/example_2_service_schema.json
@@ -51,7 +51,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/4_service_to_service_events/exposed_service_schema.json b/examples/4_service_to_service_events/exposed_service_schema.json
@@ -25,7 +25,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/examples/4_service_to_service_events/internal_service_schema.json b/examples/4_service_to_service_events/internal_service_schema.json
@@ -25,7 +25,7 @@
     "schemas": {},
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/src/intersect_sdk/_internal/schema.py b/src/intersect_sdk/_internal/schema.py
@@ -594,7 +594,7 @@ def get_schema_and_functions_from_capability_implementations(
             'messageTraits': {
                 # this is where we can define our message headers
                 'commonHeaders': {
-                    'messageHeaders': TypeAdapter(UserspaceMessageHeader).json_schema(
+                    'userspaceHeaders': TypeAdapter(UserspaceMessageHeader).json_schema(
                         ref_template='#/components/messageTraits/commonHeaders/userspaceHeaders/$defs/{model}',
                         mode='serialization',
                     ),
diff --git a/tests/fixtures/example_schema.json b/tests/fixtures/example_schema.json
@@ -943,7 +943,7 @@
     },
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",
diff --git a/tests/unit/test_schema_ref_resolution.py b/tests/unit/test_schema_ref_resolution.py
@@ -0,0 +1,55 @@
+import json
+from pathlib import Path
+from typing import Iterable, List
+
+from referencing import Registry, Resource
+from referencing.exceptions import Unresolvable
+from referencing.jsonschema import DRAFT202012
+
+from intersect_sdk.schema import get_schema_from_capability_implementations
+from tests.fixtures.example_schema import FAKE_HIERARCHY_CONFIG, DummyCapabilityImplementation
+
+
+def get_fixture_path(fixture: str) -> Path:
+    return Path(__file__).absolute().parents[1] / 'fixtures' / fixture
+
+
+def iter_ref_values(schema: object) -> Iterable[str]:
+    if isinstance(schema, dict):
+        for key, value in schema.items():
+            if key == '$ref' and isinstance(value, str):
+                yield value
+            else:
+                yield from iter_ref_values(value)
+    elif isinstance(schema, list):
+        for item in schema:
+            yield from iter_ref_values(item)
+
+
+def assert_refs_resolve(schema: dict) -> None:
+    resource = Resource.from_contents(schema, default_specification=DRAFT202012)
+    base_uri = ''
+    resolver = Registry().with_resource(base_uri, resource).resolver(base_uri)
+    unresolved: List[str] = []
+    for ref in iter_ref_values(schema):
+        try:
+            resolver.lookup(ref)
+        except Unresolvable:
+            unresolved.append(ref)
+    assert not unresolved, f'Unresolved $ref entries: {sorted(set(unresolved))}'
+
+
+def test_fixture_schema_refs_resolve() -> None:
+    """Verifies that the generated JSON schema contains valid $ref entries."""
+    with Path.open(get_fixture_path('example_schema.json'), 'rb') as f:
+        schema = json.load(f)
+    assert_refs_resolve(schema)
+
+
+def test_generated_schema_refs_resolve() -> None:
+    """Assert that the INTERSECT-SDK can generate a schema with valid $ref entries."""
+    schema = get_schema_from_capability_implementations(
+        [DummyCapabilityImplementation],
+        FAKE_HIERARCHY_CONFIG,
+    )
+    assert_refs_resolve(schema)
