From f1d752b11dee180c41b4042481d893c08602ff0f Mon Sep 17 00:00:00 2001 From: "John T. Wodder II" Date: Wed, 8 Feb 2023 14:19:41 -0500 Subject: [PATCH] Rename & document (Remote)ValidationError --- dandi/dandiapi.py | 14 +++++++++++--- docs/source/modref/dandiapi.rst | 2 +- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/dandi/dandiapi.py b/dandi/dandiapi.py index 4a6279f4b..c1af68a51 100644 --- a/dandi/dandiapi.py +++ b/dandi/dandiapi.py @@ -650,7 +650,15 @@ def __str__(self) -> str: return self.identifier -class ValidationError(APIBase): +class RemoteValidationError(APIBase): + """ + .. versionadded:: 0.49.0 + + Validation error record obtained from a server. Not to be confused with + :class:`dandi.validate_types.ValidationResult`, which provides richer + representation of validation errors. + """ + field: str message: str @@ -663,8 +671,8 @@ class VersionInfo(Version): errors """ - asset_validation_errors: List[ValidationError] - version_validation_errors: List[ValidationError] + asset_validation_errors: List[RemoteValidationError] + version_validation_errors: List[RemoteValidationError] class RemoteDandisetData(APIBase): diff --git a/docs/source/modref/dandiapi.rst b/docs/source/modref/dandiapi.rst index 01f762928..90fb9fc29 100644 --- a/docs/source/modref/dandiapi.rst +++ b/docs/source/modref/dandiapi.rst @@ -46,7 +46,7 @@ Dandisets .. autoclass:: VersionInfo() :show-inheritance: -.. autoclass:: ValidationError() +.. autoclass:: RemoteValidationError() :inherited-members: BaseModel Assets