From 96adf78fbdb7c76da0c11896a3ab7c7706426c77 Mon Sep 17 00:00:00 2001
From: nikolar <reyna.nikolayev@autodesk.com>
Date: Mon, 22 Jan 2024 22:29:36 -0800
Subject: [PATCH] add documentation, changeset, and api-report

Signed-off-by: nikolar <reyna.nikolayev@autodesk.com>
---
 .changeset/perfect-shoes-arrive.md    | 28 +++++++++++++++++++++++++++
 plugins/entity-feedback/README.md     | 18 +++++++++++++++++
 plugins/entity-feedback/api-report.md |  2 ++
 3 files changed, 48 insertions(+)
 create mode 100644 .changeset/perfect-shoes-arrive.md

diff --git a/.changeset/perfect-shoes-arrive.md b/.changeset/perfect-shoes-arrive.md
new file mode 100644
index 0000000000..adc642db47
--- /dev/null
+++ b/.changeset/perfect-shoes-arrive.md
@@ -0,0 +1,28 @@
+---
+'@backstage/plugin-entity-feedback': minor
+'@backstage/plugin-entity-feedback-backend': patch
+---
+
+<!-- @backstage/plugin-entity-feedback -->
+
+Add in logic to require comments for specific feedback responses
+const overviewContent = (
+<Grid container spacing={3} alignItems="stretch">
+...
+
+- <Grid item md={2}>
+-     <InfoCard title="Rate this entity">
+-       <LikeDislikeButtons
+-         feedbackDialogResponses = {[
+-          { id: 'incorrect', label: 'Incorrect info' },
+-          { id: 'missing', label: 'Missing info', mustComment: true },
+-          { id: 'other', label: 'Other (please specify below)', mustComment: true },
+-         ]}
+-       />
+-     </InfoCard>
+- </Grid>
+        ...
+      </Grid>
+    );
+  <!-- @backstage/plugin-entity-feedback-backend -->
+  Add in description for 400 response when rating and not authenticated
diff --git a/plugins/entity-feedback/README.md b/plugins/entity-feedback/README.md
index c405bd4083..4878b2e01e 100644
--- a/plugins/entity-feedback/README.md
+++ b/plugins/entity-feedback/README.md
@@ -90,6 +90,24 @@ const overviewContent = (
   </Grid>
 );
 
+// Require comments for specific feedback responses
+const overviewContent = (
+  <Grid container spacing={3} alignItems="stretch">
+    ...
++   <Grid item md={2}>
++     <InfoCard title="Rate this entity">
++       <LikeDislikeButtons
++         feedbackDialogResponses = {[
++          { id: 'incorrect', label: 'Incorrect info' },
++          { id: 'missing', label: 'Missing info', mustComment: true },
++          { id: 'other', label: 'Other (please specify below)', mustComment: true },
++         ]}
++       />
++     </InfoCard>
++   </Grid>
+    ...
+  </Grid>
+);
 ...
 
 // Add to each applicable kind/type of entity as desired
diff --git a/plugins/entity-feedback/api-report.md b/plugins/entity-feedback/api-report.md
index 27e56e5282..d5c03685cd 100644
--- a/plugins/entity-feedback/api-report.md
+++ b/plugins/entity-feedback/api-report.md
@@ -79,6 +79,8 @@ export interface EntityFeedbackResponse {
   id: string;
   // (undocumented)
   label: string;
+  // (undocumented)
+  mustComment?: boolean;
 }
 
 // @public (undocumented)