R Austin review: Add comments to actions

elastic · May 18, 2020 · e742cce · e742cce
1 parent c06da13
commit e742cce
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/x-pack/plugins/endpoint/public/embeddables/resolver/store/actions.ts b/x-pack/plugins/endpoint/public/embeddables/resolver/store/actions.ts
@@ -86,14 +86,23 @@ interface UserSelectedResolverNode {
   };
 }
 
+/**
+ * This action should dispatch to indicate that the user chose to
+ * focus on examining the related events of a particular ResolverEvent.
+ * Optionally, this can be bound by a category of related events (e.g. 'file' or 'dns')
+ */
 interface UserSelectedRelatedEventCategory {
   readonly type: 'userSelectedRelatedEventCategory';
   readonly payload: {
     subject: ResolverEvent;
-    category: string;
+    category?: string;
   };
 }
 
+/**
+ * This action should dispatch to indicate that the user chose to focus
+ * on examining alerts related to a particular ResolverEvent
+ */
 interface UserSelectedRelatedAlerts {
   readonly type: 'userSelectedRelatedAlerts';
   readonly payload: ResolverEvent;