microsoftgraph / microsoftgraph/msgraph-sdk-python
Incorrect Serialization Format for defaultDuration in BookingService
@ramsessanchez 已经在做这个了。
开始于 2026年5月18日。
- 主要语言
- Python
- 星标
- 630
- 派生
- 96
- 平均合并
- 15 小时 20 分钟
- 30 天内合并 PR
- 3
描述
Describe the bug
The defaultDuration field in the BookingService model is being serialized incorrectly due to the behavior of the write_timedelta_value method in the json_serialization_writer.py module.
According to the Microsoft Graph API documentation for BookingService, the defaultDuration field must be serialized as an ISO 8601 duration, e.g., P11D23H59M59.999999999999S.
However, the SDK currently serializes Python timedelta objects using the default str(timedelta) representation, which does not conform to ISO 8601. This results in requests being sent with incorrectly formatted durations and leading to 400 Graph API errors.
Relevant Code:
File: msgraph/generated/models/booking_service.py
writer.write_timedelta_value("defaultDuration", self.default_duration)
File: kiota_serialization_json/json_serialization_writer.py
def write_timedelta_value(self, key: Optional[str], value: Optional[timedelta]) -> None:
if isinstance(value, timedelta):
if key:
self.writer[key] = str(value) # <-- Incorrect format
else:
self.value = str(value)
Expected behavior
write_timedelta_value should serialize timedelta objects to valid ISO 8601 duration strings (e.g., P1DT2H3M4S), not the default str(timedelta) representation (1 day, 2:03:04).
How to reproduce
Create a BookingService object with a default_duration = timedelta(days=1, hours=2, minutes=3, seconds=4).
Serialize the object.
Observe that the serialized value for defaultDuration is "1 day, 2:03:04" instead of "P1DT2H3M4S".
SDK Version
1.33.0
Latest version known to work for scenario above?
No response
Known Workarounds
Currently manually patching the serialize method to use correct serialization
from datetime import timedelta
from isodate import duration_isoformat
from kiota_abstractions.serialization.serialization_writer import SerializationWriter
from msgraph.generated.models.booking_service import BookingService
def patch_booking_service(booking_service: BookingService) -> None:
old_serializer = booking_service.serialize
def booking_service_serializer_patch(writer: SerializationWriter) -> None:
old_serializer(writer)
if isinstance(booking_service.default_duration, timedelta):
writer.writer["defaultDuration"] = duration_isoformat(booking_service.default_duration)
booking_service.serialize = booking_service_serializer_patch
Debug output
Click to expand log
MainError(additional_data={}, code='UnknownError', details=None, inner_error=InnerError(additional_data={}, client_request_id='08e4b63d-43c0-42aa-a8ed-c42fc75cbf2a', date=datetime.datetime(2025, 6, 16, 20, 47, 57), odata_type=None, request_id='3e28d869-8972-4636-a6f6-6cc0a126bee5'), message='{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.1","title":"One or more validation errors occurred.","status":400,"errors":{"":["The input was not valid."]},"traceId":"00-3e28d86989724636a6f66cc0a126bee5-3b0ff72f47b6692f-01"}', target=None)
Configuration
SDK Version: Latest (as of writing)
Python Version: 3.11+
Endpoint: /solutions/bookingBusinesses/{id}/services
Other information
Proposed Fix
Add a new utility function for ISO 8601 serialization
File: kiota_serialization_json/json_serialization_writer.py:
from isodate import duration_isoformat
def write_iso8601_duration(self, key: Optional[str], value: Optional[timedelta]) -> None:
"""
Writes a timedelta as an ISO 8601 duration string (e.g., P1DT2H3M4S).
"""
if isinstance(value, timedelta):
duration = duration_isoformat(value)
if key:
self.writer[key] = duration
else:
self.value = duration
Then update BookingService to call this new method explicitly:
File: msgraph/generated/models/booking_service.py:
@dataclass
class BookingService(Entity, Parsable):
...
def serialize(self, writer: SerializationWriter) -> None:
...
# Use the custom method for ISO 8601 durations
if hasattr(writer, "write_iso8601_duration"):
writer.write_iso8601_duration("defaultDuration", self.default_duration)
else:
writer.write_timedelta_value("defaultDuration", self.default_duration) # Fallback
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
评估
这个 Issue 还没有评估数据。