From 2f7ba21593a732577a863ec7bd7012572298e334 Mon Sep 17 00:00:00 2001
From: Ryan McKinley <ryantxu@gmail.com>
Date: Tue, 7 Apr 2020 23:18:48 -0700
Subject: [PATCH] Docs: add basic docs for QueryResultMetaNotice (#23410)

* add basic docs

* fix typo

* use link not url
---
 packages/grafana-data/src/types/data.ts       | 21 ++++++++++++++++++-
 .../dashgrid/PanelHeader/PanelHeader.tsx      |  2 +-
 2 files changed, 21 insertions(+), 2 deletions(-)

diff --git a/packages/grafana-data/src/types/data.ts b/packages/grafana-data/src/types/data.ts
index ecf355c8f43..7b13e502706 100644
--- a/packages/grafana-data/src/types/data.ts
+++ b/packages/grafana-data/src/types/data.ts
@@ -45,10 +45,29 @@ export interface QueryResultMetaStat extends FieldConfig {
   value: number;
 }
 
+/**
+ * QueryResultMetaNotice is a structure that provides user notices for query result data
+ */
 export interface QueryResultMetaNotice {
+  /**
+   * Specify the notice severity
+   */
   severity: 'info' | 'warning' | 'error';
+
+  /**
+   * Notice descriptive text
+   */
   text: string;
-  url?: string;
+
+  /**
+   * An optional link that may be displayed in the UI.
+   * This value may be an absolute URL or relative to grafana root
+   */
+  link?: string;
+
+  /**
+   * Optionally suggest an appropriate tab for the panel inspector
+   */
   inspect?: 'meta' | 'error' | 'data' | 'stats';
 }
 
diff --git a/public/app/features/dashboard/dashgrid/PanelHeader/PanelHeader.tsx b/public/app/features/dashboard/dashgrid/PanelHeader/PanelHeader.tsx
index e08ce67fbef..acbcd54edbf 100644
--- a/public/app/features/dashboard/dashgrid/PanelHeader/PanelHeader.tsx
+++ b/public/app/features/dashboard/dashgrid/PanelHeader/PanelHeader.tsx
@@ -112,7 +112,7 @@ export class PanelHeader extends Component<Props, State> {
             <span className="fa fa-info-circle" style={{ marginRight: '8px', cursor: 'pointer' }} />
           </div>
         ) : (
-          <a className="panel-info-notice" href={notice.url} target="_blank">
+          <a className="panel-info-notice" href={notice.link} target="_blank">
             <span className="fa fa-info-circle" style={{ marginRight: '8px', cursor: 'pointer' }} />
           </a>
         )}