typed capabilities

Author: pedroslopez

airbyte_cdk/manifest_server/api_models/capabilities.py

@@ -0,0 +1,7 @@
+from pydantic import BaseModel
+
+
+class CapabilitiesResponse(BaseModel):
+    """Capabilities of the manifest server."""
+
+    custom_code_execution: bool

airbyte_cdk/manifest_server/openapi.yaml

@@ -41,8 +41,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                title: Response Getcapabilities
+                $ref: '#/components/schemas/CapabilitiesResponse'
   /v1/manifest/test_read:
     post:
       tags:
@@ -280,6 +279,16 @@ components:
       - response
       title: AuxiliaryRequest
       description: Auxiliary HTTP request made during stream processing.
+    CapabilitiesResponse:
+      properties:
+        custom_code_execution:
+          type: boolean
+          title: Custom Code Execution
+      type: object
+      required:
+      - custom_code_execution
+      title: CapabilitiesResponse
+      description: Capabilities of the manifest server.
     CheckRequest:
       properties:
         manifest:

airbyte_cdk/manifest_server/routers/capabilities.py

@@ -3,14 +3,16 @@
 
 from fastapi import APIRouter
 
+from ..api_models.capabilities import CapabilitiesResponse
+
 router = APIRouter(
     prefix="/capabilities",
     tags=["capabilities"],
 )
 
 
 @router.get("/", operation_id="getCapabilities")
-def get_capabilities() -> Dict[str, Any]:
+def get_capabilities() -> CapabilitiesResponse:
     """
     Get the capabilities available for the manifest server.
 
@@ -20,4 +22,4 @@ def get_capabilities() -> Dict[str, Any]:
     # Read the same environment variable as the connector builder server
     enable_unsafe_code = os.getenv("AIRBYTE_ENABLE_UNSAFE_CODE", "false").lower() == "true"
 
-    return {"customCodeExecution": enable_unsafe_code}
+    return CapabilitiesResponse(custom_code_execution=enable_unsafe_code)