feat(dashboard): add dashboard description field in modal and apis

superset-frontend/src/dashboard/components/PropertiesModal/index.jsx

@@ -111,6 +111,7 @@ class PropertiesModal extends React.PureComponent {
       values: {
         dashboard_title: '',
         slug: '',
+        description: '',
         owners: [],
         roles: [],
         json_metadata: '',
@@ -208,6 +209,7 @@ class PropertiesModal extends React.PureComponent {
           ...state.values,
           dashboard_title: dashboard.dashboard_title || '',
           slug: dashboard.slug || '',
+          description: dashboard.description || '',
           // format json with 2-space indentation
           json_metadata: dashboard.json_metadata
             ? jsonStringify(jsonMetadataObj)
@@ -250,6 +252,7 @@ class PropertiesModal extends React.PureComponent {
       values: {
         json_metadata: jsonMetadata,
         slug,
+        description,
         dashboard_title: dashboardTitle,
         colorScheme,
         owners: ownersValue,
@@ -282,6 +285,7 @@ class PropertiesModal extends React.PureComponent {
         id: this.props.dashboardId,
         title: dashboardTitle,
         slug,
+        description,
         jsonMetadata,
         ownerIds: owners,
         colorScheme: metadataColorScheme || colorScheme,
@@ -295,6 +299,7 @@ class PropertiesModal extends React.PureComponent {
         body: JSON.stringify({
           dashboard_title: dashboardTitle,
           slug: slug || null,
+          description: description || null,
           json_metadata: jsonMetadata || null,
           owners,
           ...morePutProps,
@@ -309,6 +314,7 @@ class PropertiesModal extends React.PureComponent {
           id: this.props.dashboardId,
           title: result.dashboard_title,
           slug: result.slug,
+          description: result.description,
           jsonMetadata: result.json_metadata,
           ownerIds: result.owners,
           colorScheme: metadataColorScheme || colorScheme,
@@ -494,6 +500,22 @@ class PropertiesModal extends React.PureComponent {
               </FormItem>
             </Col>
           </Row>
+          <Row>
+            <Col xs={24} md={24}>
+              <FormItem label={t('Description')}>
+                <Input
+                  name="description"
+                  type="text"
+                  value={values.description || ''}
+                  onChange={this.onChange}
+                  disabled={!isDashboardLoaded}
+                />
+                <p className="help-block">
+                  {t('A dashboard description')}
+                </p>
+              </FormItem>
+            </Col>
+          </Row>
           {isFeatureEnabled(FeatureFlag.DASHBOARD_RBAC)
             ? this.getRowsWithRoles()
             : this.getRowsWithoutRoles()}

superset/dashboards/api.py

@@ -116,6 +116,7 @@ def ensure_thumbnails_enabled(self) -> Optional[Response]:
         "published",
         "status",
         "slug",
+        "description",
         "url",
         "css",
         "position_json",
@@ -152,6 +153,7 @@ def ensure_thumbnails_enabled(self) -> Optional[Response]:
     add_columns = [
         "dashboard_title",
         "slug",
+        "description",
         "owners",
         "roles",
         "position_json",

superset/dashboards/schemas.py

@@ -34,6 +34,7 @@
 
 dashboard_title_description = "A title for the dashboard."
 slug_description = "Unique identifying part for the web address of the dashboard."
+description_description = "A dashboard description/"
 owners_description = (
     "Owner are users ids allowed to delete or change this dashboard. "
     "If left empty you will be one of the owners of the dashboard."
@@ -144,6 +145,7 @@ class RolesSchema(Schema):
 class DashboardGetResponseSchema(Schema):
     id = fields.Int()
     slug = fields.String()
+    description = fields.String()
     url = fields.String()
     dashboard_title = fields.String(description=dashboard_title_description)
     thumbnail_url = fields.String()
@@ -230,6 +232,9 @@ class DashboardPostSchema(BaseDashboardSchema):
     slug = fields.String(
         description=slug_description, allow_none=True, validate=[Length(1, 255)]
     )
+    description = fields.String(
+        description=description_description, allow_none=True
+    )
     owners = fields.List(fields.Integer(description=owners_description))
     roles = fields.List(fields.Integer(description=roles_description))
     position_json = fields.String(
@@ -251,6 +256,9 @@ class DashboardPutSchema(BaseDashboardSchema):
     slug = fields.String(
         description=slug_description, allow_none=True, validate=Length(0, 255)
     )
+    description = fields.String(
+        description=description_description, allow_none=True
+    )
     owners = fields.List(
         fields.Integer(description=owners_description, allow_none=True)
     )

tests/integration_tests/dashboards/api_tests.py

@@ -87,6 +87,7 @@ def insert_dashboard(
         css: str = "",
         json_metadata: str = "",
         published: bool = False,
+        description: str = ""
     ) -> Dashboard:
         obj_owners = list()
         obj_roles = list()
@@ -108,6 +109,7 @@ def insert_dashboard(
             slices=slices,
             published=published,
             created_by=created_by,
+            description=description
         )
         db.session.add(dashboard)
         db.session.commit()
@@ -309,7 +311,11 @@ def test_get_dashboard(self):
         """
         admin = self.get_user("admin")
         dashboard = self.insert_dashboard(
-            "title", "slug1", [admin.id], created_by=admin
+            "title",
+            "slug1",
+            [admin.id],
+            created_by=admin,
+            description="some description"
         )
         self.login(username="admin")
         uri = f"api/v1/dashboard/{dashboard.id}"
@@ -341,6 +347,7 @@ def test_get_dashboard(self):
             "slug": "slug1",
             "table_names": "",
             "thumbnail_url": dashboard.thumbnail_url,
+            "description": dashboard.description,
         }
         data = json.loads(rv.data.decode("utf-8"))
         self.assertIn("changed_on", data["result"])