add documentation, changeset, and api-report

Signed-off-by: nikolar <reyna.nikolayev@autodesk.com>
2024-01-22 22:29:36 -08:00
parent 510a94d89f
commit 96adf78fbd
3 changed files with 48 additions and 0 deletions
@@ -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
@@ -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
@@ -79,6 +79,8 @@ export interface EntityFeedbackResponse {
  id: string;
  // (undocumented)
  label: string;
+  // (undocumented)
+  mustComment?: boolean;
 }

 // @public (undocumented)