Rename & document (Remote)ValidationError

dandi · Feb 8, 2023 · f1d752b · f1d752b
1 parent 9a36d21
commit f1d752b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git 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
@@ -46,7 +46,7 @@ Dandisets
 .. autoclass:: VersionInfo()
     :show-inheritance:
 
-.. autoclass:: ValidationError()
+.. autoclass:: RemoteValidationError()
     :inherited-members: BaseModel
 
 Assets