Spaces:
Running
Running
File size: 3,282 Bytes
64a8670 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | """Test for optional parameter handling in FastMCP OpenAPI integration."""
import pytest
from fastmcp.utilities.openapi import HTTPRoute, ParameterInfo, _combine_schemas
async def test_optional_parameter_schema_allows_null():
"""Test that optional parameters generate schemas that allow null values."""
# Create a minimal HTTPRoute with optional parameter
optional_param = ParameterInfo(
name="optional_param",
location="query",
required=False,
schema={"type": "string"},
description="Optional parameter",
)
required_param = ParameterInfo(
name="required_param",
location="query",
required=True,
schema={"type": "string"},
description="Required parameter",
)
route = HTTPRoute(
method="GET",
path="/test",
parameters=[required_param, optional_param],
request_body=None,
responses={},
summary="Test endpoint",
description=None,
schema_definitions={},
)
# Generate combined schema
schema = _combine_schemas(route)
# Verify that optional parameter allows null values
optional_param_schema = schema["properties"]["optional_param"]
# Should have anyOf with string and null types
assert "anyOf" in optional_param_schema
assert {"type": "string"} in optional_param_schema["anyOf"]
assert {"type": "null"} in optional_param_schema["anyOf"]
# Required parameter should not allow null
required_param_schema = schema["properties"]["required_param"]
assert required_param_schema["type"] == "string"
assert "anyOf" not in required_param_schema
# Required list should only contain required param
assert "required_param" in schema["required"]
assert "optional_param" not in schema["required"]
@pytest.mark.parametrize(
"param_schema",
[
{"type": "string"},
{"type": "integer"},
{"type": "number"},
{"type": "boolean"},
{"type": "array", "items": {"type": "string"}},
{"type": "object", "properties": {"name": {"type": "string"}}},
],
)
async def test_optional_parameter_allows_null_for_type(param_schema):
"""Test that optional parameters of any type allow null values."""
optional_param = ParameterInfo(
name="optional_param",
location="query",
required=False,
schema=param_schema,
description="Optional parameter",
)
route = HTTPRoute(
method="GET",
path="/test",
parameters=[optional_param],
request_body=None,
responses={},
summary="Test endpoint",
description=None,
schema_definitions={},
)
# Generate combined schema
schema = _combine_schemas(route)
optional_param_schema = schema["properties"]["optional_param"]
# Should have anyOf with the original type and null
assert "anyOf" in optional_param_schema
assert {"type": "null"} in optional_param_schema["anyOf"]
# Check that original schema is preserved (either simple type or complex schema)
if "type" in param_schema:
assert {"type": param_schema["type"]} in optional_param_schema["anyOf"]
else:
assert param_schema in optional_param_schema["anyOf"]
|