add ability to include event documentation in events schema

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

Author: Lance-Drane

src/intersect_sdk/_internal/schema.py

@@ -308,6 +308,8 @@ def _add_events(
                         'serialization',
                     )
                     _ensure_title_in_schema(event_schema, event_key)
+                    if event_definition.event_documentation:
+                        event_schema['description'] = event_definition.event_documentation
                     event_schemas[event_key] = event_schema
                     event_metadatas[event_key] = EventMetadata(
                         type=event_definition.event_type,

tests/fixtures/example_schema.json

@@ -846,26 +846,31 @@
               "type": "string"
             }
           ],
-          "title": "union"
+          "title": "union",
+          "description": "Generic example of how to do a union event"
         },
         "int": {
           "type": "integer",
-          "title": "int"
+          "title": "int",
+          "description": "Generic integer event"
         },
         "str": {
           "type": "string",
-          "title": "str"
+          "title": "str",
+          "description": "Generic string event"
         },
         "float": {
           "type": "number",
-          "title": "float"
+          "title": "float",
+          "description": "Generic float event"
         },
         "list_float": {
           "items": {
             "type": "number"
           },
           "type": "array",
-          "title": "list_float"
+          "title": "list_float",
+          "description": "generic list of floats event"
         }
       },
       "status": {