misc cleanup

Signed-off-by: Dennis Toepker <[email protected]>

src/main/kotlin/org/opensearch/commons/alerting/action/DeleteCommentRequest.kt

@@ -19,6 +19,9 @@ class DeleteCommentRequest : ActionRequest {
     )
 
     override fun validate(): ActionRequestValidationException? {
+        if (commentId.isBlank()) {
+            return ActionRequestValidationException()
+        }
         return null
     }
 

src/main/kotlin/org/opensearch/commons/alerting/action/DeleteCommentResponse.kt

@@ -8,25 +8,25 @@ import org.opensearch.core.xcontent.ToXContent
 import org.opensearch.core.xcontent.XContentBuilder
 
 class DeleteCommentResponse : BaseResponse {
-    var id: String
+    var commentId: String
 
     constructor(
         id: String
     ) : super() {
-        this.id = id
+        this.commentId = id
     }
 
     constructor(sin: StreamInput) : this(
-        sin.readString() // id
+        sin.readString() // commentId
     )
 
     override fun writeTo(out: StreamOutput) {
-        out.writeString(id)
+        out.writeString(commentId)
     }
 
     override fun toXContent(builder: XContentBuilder, params: ToXContent.Params): XContentBuilder {
         return builder.startObject()
-            .field(IndexUtils._ID, id)
+            .field(IndexUtils._ID, commentId)
             .endObject()
     }
 }

src/main/kotlin/org/opensearch/commons/alerting/action/IndexCommentRequest.kt

@@ -7,6 +7,15 @@ import org.opensearch.core.common.io.stream.StreamOutput
 import org.opensearch.rest.RestRequest
 import java.io.IOException
 
+/**
+ * Request to index/create a Comment
+ *
+ * entityId: the entity that the Comment is attached to and therefore associated with (e.g. in Alerting,
+ * the entity is an Alert). This field is expected to be non-blank if the request is to create a new Comment.
+ *
+ * commentId: the ID of an existing Comment. This field is expected to be non-blank if the request is to
+ * update an existing Comment.
+ */
 class IndexCommentRequest : ActionRequest {
     val entityId: String
     val commentId: String
@@ -42,6 +51,11 @@ class IndexCommentRequest : ActionRequest {
     )
 
     override fun validate(): ActionRequestValidationException? {
+        if (method == RestRequest.Method.POST && entityId.isBlank() ||
+            method == RestRequest.Method.PUT && commentId.isBlank()
+        ) {
+            return ActionRequestValidationException()
+        }
         return null
     }
 

src/main/kotlin/org/opensearch/commons/alerting/action/IndexCommentResponse.kt

@@ -12,7 +12,6 @@ import org.opensearch.core.xcontent.XContentBuilder
 import java.io.IOException
 
 class IndexCommentResponse : BaseResponse {
-    // TODO: do we really need sequence num and primary term? probs delete em
     var id: String
     var seqNo: Long
     var primaryTerm: Long

src/test/kotlin/org/opensearch/commons/alerting/action/DeleteCommentRequestTests.kt

@@ -8,7 +8,7 @@ import org.opensearch.core.common.io.stream.StreamInput
 
 class DeleteCommentRequestTests {
     @Test
-    fun `test delete comment request`() {
+    fun `test delete comment request writing and parsing`() {
         val req = DeleteCommentRequest("1234")
         assertNotNull(req)
         assertEquals("1234", req.commentId)

src/test/kotlin/org/opensearch/commons/alerting/action/DeleteCommentResponseTests.kt

@@ -8,15 +8,15 @@ import org.opensearch.core.common.io.stream.StreamInput
 
 class DeleteCommentResponseTests {
     @Test
-    fun `test delete comment response`() {
+    fun `test delete comment response writing and parsing`() {
         val res = DeleteCommentResponse(id = "123")
         assertNotNull(res)
-        assertEquals("123", res.id)
+        assertEquals("123", res.commentId)
 
         val out = BytesStreamOutput()
         res.writeTo(out)
         val sin = StreamInput.wrap(out.bytes().toBytesRef().bytes)
         val newRes = DeleteCommentResponse(sin)
-        assertEquals("123", newRes.id)
+        assertEquals("123", newRes.commentId)
     }
 }