From 12ceb8d40912e7652b1545285386e4881cf52a3d Mon Sep 17 00:00:00 2001
From: Harold Hotelling <harold@hotelling.net>
Date: Tue, 16 Nov 2021 10:41:55 -0800
Subject: [PATCH] Add more documentation for EntityActionRequestBuilderBase.

---
 .../restli/client/base/EntityActionRequestBuilderBase.java   | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/restli-client/src/main/java/com/linkedin/restli/client/base/EntityActionRequestBuilderBase.java b/restli-client/src/main/java/com/linkedin/restli/client/base/EntityActionRequestBuilderBase.java
index fef66e4b09..a4daac2aa9 100644
--- a/restli-client/src/main/java/com/linkedin/restli/client/base/EntityActionRequestBuilderBase.java
+++ b/restli-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>