chore: remove leftover OpenAPI example files; rename schema-fix func to ensure_upload_file_schema_references; tidy openapi package

Author: yizzy

aws_lambda_powertools/event_handler/api_gateway.py

@@ -2160,14 +2160,14 @@ def _apply_schema_fixes(self, output: dict[str, Any]) -> OpenAPI:
             The final OpenAPI model with all fixes applied
         """
         from aws_lambda_powertools.event_handler.openapi.models import OpenAPI
-        from aws_lambda_powertools.event_handler.openapi.params import fix_upload_file_schema_references
+        from aws_lambda_powertools.event_handler.openapi.params import ensure_upload_file_schema_references
 
         # First create the OpenAPI model
         result = OpenAPI(**output)
 
         # Convert the model to a dict and apply the upload file schema fix
         result_dict = result.model_dump(by_alias=True)
-        fixed_dict = fix_upload_file_schema_references(result_dict)
+        fixed_dict = ensure_upload_file_schema_references(result_dict)
 
         # Reconstruct the model with the fixed dict
         return OpenAPI(**fixed_dict)

aws_lambda_powertools/event_handler/openapi/__init__.py

@@ -1367,7 +1367,7 @@ def _create_model_field(
     )
 
 
-def fix_upload_file_schema_references(schema_dict: dict[str, Any]) -> dict[str, Any]:
+def ensure_upload_file_schema_references(schema_dict: dict[str, Any]) -> dict[str, Any]:
     """
     Fix missing component references for UploadFile in OpenAPI schemas.
 
@@ -1391,7 +1391,7 @@ def fix_upload_file_schema_references(schema_dict: dict[str, Any]) -> dict[str,
     Example
     -------
     >>> schema = {"paths": {...}, "components": {...}}
-    >>> fixed_schema = fix_upload_file_schema_references(schema)
+    >>> fixed_schema = ensure_upload_file_schema_references(schema)
     >>> # Now all $ref references in multipart/form-data schemas have matching components
     """
     # Handle pydantic models that might be passed in

aws_lambda_powertools/event_handler/openapi/params.py

@@ -18,7 +18,7 @@
     _extract_endpoint_info_from_component_name,
     _find_missing_upload_file_components,
     _generate_component_title,
-    fix_upload_file_schema_references,
+    ensure_upload_file_schema_references,
 )
 
 
@@ -52,7 +52,7 @@ def upload_file(file: Annotated[UploadFile, File()]):
         schema = app.get_openapi_schema()
         # Convert to dict for processing by fix function
         schema_dict = schema.model_dump()
-        fix_upload_file_schema_references(schema_dict)
+        ensure_upload_file_schema_references(schema_dict)
 
         # Verify components exist and are processed
         assert "components" in schema_dict
@@ -113,12 +113,12 @@ def test_schema_fix_edge_cases(self):
         """Test schema fix function edge cases."""
         # Test with empty schema
         empty_schema = {}
-        fix_upload_file_schema_references(empty_schema)
+        ensure_upload_file_schema_references(empty_schema)
         assert empty_schema == {}
 
         # Test with schema missing components
         schema_no_components = {"paths": {}}
-        fix_upload_file_schema_references(schema_no_components)
+        ensure_upload_file_schema_references(schema_no_components)
         # Should not crash and may or may not add components
 
     def test_upload_file_multipart_handling(self):
@@ -131,7 +131,7 @@ def upload_multiple(primary: Annotated[UploadFile, File()], secondary: Annotated
 
         schema = app.get_openapi_schema()
         schema_dict = schema.model_dump()
-        fix_upload_file_schema_references(schema_dict)
+        ensure_upload_file_schema_references(schema_dict)
 
         # Verify multipart handling works without errors
         assert schema_dict is not None
@@ -226,7 +226,7 @@ def test_file_parameter_json_schema_extra(self):
         assert file_param.description == "Test file"
         assert hasattr(file_param, "json_schema_extra")
 
-    def test_fix_upload_file_schema_references_complex(self):
+    def test_ensure_upload_file_schema_references_complex(self):
         """Test schema fix with complex schema structures."""
         # Test with pydantic model that has model_dump method
         mock_schema = Mock()
@@ -246,7 +246,7 @@ def test_fix_upload_file_schema_references_complex(self):
         }
 
         # Test fix function with model that has model_dump
-        fix_upload_file_schema_references(mock_schema)
+        ensure_upload_file_schema_references(mock_schema)
         mock_schema.model_dump.assert_called_once_with(by_alias=True)
 
     def test_extract_endpoint_info_from_component_name(self):
@@ -341,7 +341,7 @@ def test_schema_dict_model_dump_handling(self):
         mock_schema.model_dump.return_value = {"paths": {}, "components": {"schemas": {}}}
 
         # This should call model_dump and process the result
-        fix_upload_file_schema_references(mock_schema)
+        ensure_upload_file_schema_references(mock_schema)
         mock_schema.model_dump.assert_called_once_with(by_alias=True)
 
     def test_openapi_validation_webkit_boundary_extraction(self):