provide more metadata for events in schemas

Signed-off-by: Lance-Drane <Lance-Drane@users.noreply.github.com>

Author: Lance-Drane

src/intersect_sdk/_internal/schema.py

@@ -308,9 +308,16 @@ def _add_events(
                         'serialization',
                     )
                     _ensure_title_in_schema(event_schema, event_key)
+                    event_schemas[event_key] = {
+                        'schemaFormat': f'application/vnd.aai.asyncapi+json;version={ASYNCAPI_VERSION}',
+                        'contentType': event_definition.content_type,
+                        'payload': event_schema,
+                        'traits': {'$ref': '#/components/messageTraits/commonHeaders'},
+                    }
                     if event_definition.event_documentation:
-                        event_schema['description'] = event_definition.event_documentation
-                    event_schemas[event_key] = event_schema
+                        event_schemas[event_key]['description'] = (
+                            event_definition.event_documentation
+                        )
                     event_metadatas[event_key] = EventMetadata(
                         type=event_definition.event_type,
                         type_adapter=event_adapter,

tests/fixtures/example_schema.json

@@ -838,38 +838,73 @@
       },
       "events": {
         "union": {
-          "anyOf": [
-            {
-              "type": "integer"
-            },
-            {
-              "type": "string"
-            }
-          ],
-          "title": "union",
+          "schemaFormat": "application/vnd.aai.asyncapi+json;version=2.6.0",
+          "contentType": "application/json",
+          "payload": {
+            "anyOf": [
+              {
+                "type": "integer"
+              },
+              {
+                "type": "string"
+              }
+            ],
+            "title": "union"
+          },
+          "traits": {
+            "$ref": "#/components/messageTraits/commonHeaders"
+          },
           "description": "Generic example of how to do a union event"
         },
         "int": {
-          "type": "integer",
-          "title": "int",
-          "description": "Generic integer event"
+          "schemaFormat": "application/vnd.aai.asyncapi+json;version=2.6.0",
+          "contentType": "application/json",
+          "payload": {
+            "description": "Generic integer event",
+            "type": "integer",
+            "title": "int"
+          },
+          "traits": {
+            "$ref": "#/components/messageTraits/commonHeaders"
+          }
         },
         "str": {
-          "type": "string",
-          "title": "str",
+          "schemaFormat": "application/vnd.aai.asyncapi+json;version=2.6.0",
+          "contentType": "application/json",
+          "payload": {
+            "type": "string",
+            "title": "str"
+          },
+          "traits": {
+            "$ref": "#/components/messageTraits/commonHeaders"
+          },
           "description": "Generic string event"
         },
         "float": {
-          "type": "number",
-          "title": "float",
+          "schemaFormat": "application/vnd.aai.asyncapi+json;version=2.6.0",
+          "contentType": "application/json",
+          "payload": {
+            "type": "number",
+            "title": "float"
+          },
+          "traits": {
+            "$ref": "#/components/messageTraits/commonHeaders"
+          },
           "description": "Generic float event"
         },
         "list_float": {
-          "items": {
-            "type": "number"
+          "schemaFormat": "application/vnd.aai.asyncapi+json;version=2.6.0",
+          "contentType": "application/json",
+          "payload": {
+            "items": {
+              "type": "number"
+            },
+            "type": "array",
+            "title": "list_float"
+          },
+          "traits": {
+            "$ref": "#/components/messageTraits/commonHeaders"
           },
-          "type": "array",
-          "title": "list_float",
           "description": "generic list of floats event"
         }
       },

tests/fixtures/example_schema.py

@@ -227,7 +227,7 @@ class DummyCapabilityImplementation(IntersectBaseCapabilityImplementation):
             event_type=(int | str), event_documentation='Generic example of how to do a union event'
         ),
         'int': IntersectEventDefinition(
-            event_type=int, event_documentation='Generic integer event'
+            event_type=Annotated[int, Field(description='Generic integer event')]
         ),
         'str': IntersectEventDefinition(event_type=str, event_documentation='Generic string event'),
         'float': IntersectEventDefinition(