dyff-schema 0.27.4__tar.gz → 0.28.0__tar.gz

{dyff_schema-0.27.4/dyff_schema.egg-info → dyff_schema-0.28.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dyff-schema
-Version: 0.27.4
+Version: 0.28.0
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0

{dyff_schema-0.27.4 → dyff_schema-0.28.0}/dyff/schema/v0/r1/commands.py

@@ -59,6 +59,7 @@ class Command(SchemaVersion, DyffSchemaBaseModel):
         "EditEntityLabels",
         "EditFamilyMembers",
         "ForgetEntity",
+        "RestoreEntity",
         "UpdateEntityStatus",
     ]
 
@@ -218,6 +219,43 @@ class ForgetEntity(Command):
 # ----------------------------------------------------------------------------
 
 
+class RestoreEntityAttributes(DyffSchemaBaseModel):
+    entity: DyffEntityType = pydantic.Field(
+        description="The full spec of the entity to restore."
+    )
+
+    ifRevisionMatch: Optional[str] = pydantic.Field(
+        default=None,
+        description="Do not change the entity if its revision does not match"
+        " the given revision.",
+    )
+
+    ifRevisionUndefined: Optional[bool] = pydantic.Field(
+        default=None,
+        description="Allow changing entities that have no revision."
+        " By default, entities with no revision will be changed if and only if"
+        " no other matching criteria are specified."
+        " This should be the case only for legacy data.",
+    )
+
+
+class RestoreEntityData(EntityIdentifier):
+    attributes: RestoreEntityAttributes = pydantic.Field(
+        description="The command attributes"
+    )
+
+
+class RestoreEntity(Command):
+    """Restore an entity to a given state."""
+
+    command: Literal["RestoreEntity"] = "RestoreEntity"
+
+    data: RestoreEntityData = pydantic.Field(description="The command data.")
+
+
+# ----------------------------------------------------------------------------
+
+
 class UpdateEntityStatusAttributes(JsonMergePatchSemantics):
     """Attributes for the UpdateEntityStatus command."""
 
@@ -255,6 +293,7 @@ DyffCommandType = Union[
     EditEntityLabels,
     EditFamilyMembers,
     ForgetEntity,
+    RestoreEntity,
     UpdateEntityStatus,
 ]
 
@@ -276,6 +315,9 @@ __all__ = [
     "EntityIdentifier",
     "FamilyIdentifier",
     "ForgetEntity",
+    "RestoreEntity",
+    "RestoreEntityAttributes",
+    "RestoreEntityData",
     "UpdateEntityStatus",
     "UpdateEntityStatusAttributes",
     "UpdateEntityStatusData",

{dyff_schema-0.27.4 → dyff_schema-0.28.0/dyff_schema.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dyff-schema
-Version: 0.27.4
+Version: 0.28.0
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0