Skip to content

Commit

Permalink
docs: Update DashboardMetadata docs (#402)
Browse files Browse the repository at this point in the history
* Update DashboardMetadata docs

Signed-off-by: Joseph Atkins-Turkish <jatkins-turkish@brex.com>

* Update dashboard_metadata.py

Signed-off-by: Joseph Atkins-Turkish <jatkins-turkish@brex.com>
  • Loading branch information
Joseph Atkins-Turkish authored Nov 4, 2020
1 parent 6718396 commit 093b3d6
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions databuilder/models/dashboard/dashboard_metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,15 @@

class DashboardMetadata(Neo4jCsvSerializable):
"""
Dashboard metadata that contains dashboard group name, dashboardgroup description, dashboard description,
along with tags, owner userid and lastreloadtime.
(Owner ID and last reload time will be supported by separate Extractor later on with more information)
Dashboard metadata including dashboard group name, dashboardgroup description, dashboard description,
and tags.
It implements Neo4jCsvSerializable so that it can be serialized to produce
Dashboard, Tag, Description, Lastreloadtime and relation of those. Additionally, it will create
Dashboardgroup with relationships to Dashboard. If users exist in neo4j, it will create
the relation between dashboard and user (owner).
Some other metadata e.g. Owners and last-reload/modified times are provided by other models
e.g. DashboardOwner
Lastreloadtime is the time when the Dashboard was last reloaded.
It implements Neo4jCsvSerializable so that it can be serialized to produce
Dashboard, Tag, Description and relations between those. Additionally, it will create a
Dashboardgroup with relationships to the Dashboard.
"""
CLUSTER_KEY_FORMAT = '{product}_dashboard://{cluster}'
CLUSTER_DASHBOARD_GROUP_RELATION_TYPE = 'DASHBOARD_GROUP'
Expand Down

0 comments on commit 093b3d6

Please sign in to comment.