To include request body and typed request body

Author: simonredfern

src/tools/endpoint_index.py

@@ -134,7 +134,9 @@ class EndpointSchema(BaseModel):
     description_markdown: str = Field(default="", description="Description in markdown format")
     tags: List[str] = Field(default_factory=list, description="Tags for categorization")
     parameters: List[EndpointParameter] = Field(default_factory=list, description="Endpoint parameters")
-    requestBody: Optional[Dict[str, Any]] = Field(default=None, description="Request body specification")
+    requestBody: Optional[Dict[str, Any]] = Field(default=None, description="OpenAPI-style request body specification (from swagger path)")
+    example_request_body: Optional[Dict[str, Any]] = Field(default=None, description="Concrete example request body (from OBP resource-docs)")
+    typed_request_body: Optional[Dict[str, Any]] = Field(default=None, description="JSON Schema for request body (from OBP resource-docs)")
     responses: Dict[str, EndpointResponse] = Field(default_factory=dict, description="Response specifications by status code")
     success_response_body: Optional[Dict[str, Any]] = Field(default=None, description="Example success response body")
     error_response_bodies: List[str] = Field(default_factory=list, description="Possible error response messages")
@@ -189,6 +191,8 @@ def from_raw(cls, data: Dict[str, Any]) -> "EndpointSchema":
             tags=data.get("tags", []),
             parameters=parameters,
             requestBody=data.get("requestBody"),
+            example_request_body=data.get("example_request_body"),
+            typed_request_body=data.get("typed_request_body"),
             responses=responses,
             success_response_body=data.get("success_response_body"),
             error_response_bodies=data.get("error_response_bodies", []),
@@ -420,7 +424,11 @@ def build_index_from_resource_docs(self, resource_docs_data: Dict[str, Any]) ->
             # Extract roles from resource docs format
             roles = doc.get("roles", [])
 
-            # Store full schema separately (keyed by endpoint_id)
+            # Store full schema separately (keyed by endpoint_id).
+            # OBP resource-docs use `example_request_body` / `typed_request_body`
+            # (a concrete example object + a JSON Schema). The OpenAPI-style
+            # `requestBody` field stays None on this path since resource-docs
+            # don't carry that exact shape — clients should prefer the example.
             self._schemas[endpoint_id] = {
                 "path": path,
                 "method": method,
@@ -431,6 +439,8 @@ def build_index_from_resource_docs(self, resource_docs_data: Dict[str, Any]) ->
                 "tags": tags,
                 "parameters": [],  # Resource docs don't provide parameters in the same way
                 "requestBody": None,
+                "example_request_body": doc.get("example_request_body"),
+                "typed_request_body": doc.get("typed_request_body"),
                 "responses": {},
                 "success_response_body": doc.get("success_response_body"),
                 "error_response_bodies": doc.get("error_response_bodies", []),

tests/test_endpoint_index.py

@@ -232,6 +232,35 @@ def test_schema_from_raw(self):
         assert len(schema.responses) == 2
         assert schema.responses["200"].description == "Success"
 
+    def test_schema_carries_request_body_example_from_resource_docs(self):
+        """Resource-docs request-body examples should be exposed, not dropped."""
+        raw_data = {
+            "path": "/obp/v6.0.0/banks",
+            "method": "POST",
+            "operation_id": "OBPv6.0.0-createBank",
+            "summary": "Create Bank",
+            "tags": ["Bank"],
+            "example_request_body": {
+                "bank_id": "gh.29.uk",
+                "bank_code": "CGHZ",
+                "full_name": "Bank of Example",
+            },
+            "typed_request_body": {
+                "type": "object",
+                "properties": {
+                    "bank_id": {"type": "string"},
+                    "bank_code": {"type": "string"},
+                },
+            },
+        }
+        schema = EndpointSchema.from_raw(raw_data)
+        assert schema.example_request_body is not None
+        assert schema.example_request_body["bank_id"] == "gh.29.uk"
+        assert schema.typed_request_body is not None
+        assert schema.typed_request_body["properties"]["bank_id"]["type"] == "string"
+        # OpenAPI-style requestBody stays None on the resource-docs path.
+        assert schema.requestBody is None
+
     def test_schema_serialization(self):
         """Test that schema serializes to JSON correctly."""
         schema = EndpointSchema(