Add extra comments (#5158)

Co-authored-by: Simon Dumas <[email protected]>
BlueBrain · Sep 30, 2024 · a711280 · a711280
1 parent d241d12
commit a711280
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/...ain/scala/ch/epfl/bluebrain/nexus/delta/sdk/schemas/job/SchemaValidationCoordinator.scala b/...ain/scala/ch/epfl/bluebrain/nexus/delta/sdk/schemas/job/SchemaValidationCoordinator.scala
@@ -7,6 +7,10 @@ import ch.epfl.bluebrain.nexus.delta.sourcing.stream._
 
 /**
   * Allows to run a revalidation of the different data resouces in the given project
+  *   - Those projections are triggered directy by a a dedicated endpoint
+  *   - It saves its progress and errors the same way as other projections
+  *   - Unlike projections related to indexing, those tasks won't be resumed if Delta gets restarted
+  *   - Running again the validation on aa project will overwrite the previous progress and the related errors
   */
 trait SchemaValidationCoordinator {
 

diff --git a/...src/main/scala/ch/epfl/bluebrain/nexus/delta/sdk/schemas/job/SchemaValidationStream.scala b/...src/main/scala/ch/epfl/bluebrain/nexus/delta/sdk/schemas/job/SchemaValidationStream.scala
@@ -16,6 +16,7 @@ import fs2.Stream
 /**
   * Streams the latest version of resources from a project and revalidate them with the latest version of the schema
   * they are currently validated with.
+  *   - Only data resources are evaluated
   *   - Deprecated resources are skipped
   *   - Resources not validated with a schema are skipped too
   */