Skip to content

Commit

Permalink
Add API documentation for ErrorDetails.url
Browse files Browse the repository at this point in the history
  • Loading branch information
Viicos committed Feb 20, 2025
1 parent a0e60bd commit c208818
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions python/pydantic_core/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,11 @@ class ErrorDetails(_TypedDict):
Values which are required to render the error message, and could hence be useful in rendering custom error messages.
Also useful for passing custom error data forward.
"""
url: _NotRequired[str]
"""
The documentation URL giving information about the error. No URL is available if
a [`PydanticCustomError`][pydantic_core.PydanticCustomError] is used.
"""


class InitErrorDetails(_TypedDict):
Expand Down

0 comments on commit c208818

Please sign in to comment.