mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-19 03:54:18 +02:00
100 lines
3.1 KiB
Python
100 lines
3.1 KiB
Python
"""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 fully preserved under anyOf
|
|
assert param_schema in optional_param_schema["anyOf"]
|