Clarify what is an update document in the MongoDB with Panache doc

Fixes quarkusio#38405
bschuhmann · Nov 16, 2024 · 3d3b635 · 3d3b635
1 parent 22eb6af
commit 3d3b635
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/...godb-panache/runtime/src/main/java/io/quarkus/mongodb/panache/PanacheMongoEntityBase.java b/...godb-panache/runtime/src/main/java/io/quarkus/mongodb/panache/PanacheMongoEntityBase.java
@@ -937,11 +937,12 @@ public static io.quarkus.mongodb.panache.common.PanacheUpdate update(String upda
     }
 
     /**
-     * Update all entities of this type by the given update BSON document.
+     * Update all entities of this type by the given update BSON document. An update document must contain an operator,
+     * see <a href="https://www.mongodb.com/docs/manual/tutorial/update-documents">update documents</a>.
      * The returned {@link io.quarkus.mongodb.panache.common.PanacheUpdate} object will allow to restrict on which document the
      * update should be applied.
      *
-     * @param update the update document, as a {@link org.bson.conversions.Bson}.
+     * @param update the update document, as a {@link Bson}.
      * @return a new {@link io.quarkus.mongodb.panache.common.PanacheUpdate} instance for the given update document
      * @see #update(String, Object...)
      * @see #update(String, Map)

diff --git a/...-panache/runtime/src/main/java/io/quarkus/mongodb/panache/PanacheMongoRepositoryBase.java b/...-panache/runtime/src/main/java/io/quarkus/mongodb/panache/PanacheMongoRepositoryBase.java
@@ -934,7 +934,8 @@ default io.quarkus.mongodb.panache.common.PanacheUpdate update(String update, Pa
     }
 
     /**
-     * Update all entities of this type by the given update BSON document.
+     * Update all entities of this type by the given update BSON document. An update document must contain an operator,
+     * see <a href="https://www.mongodb.com/docs/manual/tutorial/update-documents">update documents</a>.
      * The returned {@link io.quarkus.mongodb.panache.common.PanacheUpdate} object will allow to restrict on which document the
      * update should be applied.
      *