Add more documentation for EntityActionRequestBuilderBase.

linkedin · Nov 16, 2021 · 12ceb8d · 12ceb8d
1 parent 0a9eb23
commit 12ceb8d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/...-client/src/main/java/com/linkedin/restli/client/base/EntityActionRequestBuilderBase.java b/...-client/src/main/java/com/linkedin/restli/client/base/EntityActionRequestBuilderBase.java
@@ -26,6 +26,11 @@
 
 /**
  * The abstract base class for all generated request builders classes for entity-level actions.
+ *
+ * For entity-level actions the action is being performed against a specific record which means
+ * that the key/id must be present in the request to identify which record to perform the action
+ * on. This class adds validation when the request is built that the id was set to a non-null
+ * value.
  */
 public abstract class EntityActionRequestBuilderBase<K, V, RB extends ActionRequestBuilderBase<K, V, RB>>
         extends ActionRequestBuilderBase<K, V, RB>