mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-04 15:18:17 +00:00

* updated metadata-ingestion and apis documents * minor changes in * addressing maven ci findings Co-authored-by: Parth Panchal <parthpanchal@Parths-MacBook-Air.local>
2.2 KiB
2.2 KiB
Dashboard Service
This schema defines the Dashboard Service entity, such as Looker and Superset.
$id: https://open-metadata.org/schema/entity/services/dashboardService.json
Type: object
Properties
- id
required
- Unique identifier of this dashboard service instance.
- $ref: ../../type/basic.json#/definitions/uuid
- name
required
- Name that identifies this dashboard service.
- Type:
string
- Length: between 1 and 64
- displayName
- Display Name that identifies this dashboard service.
- Type:
string
- serviceType
required
- Type of dashboard service such as Looker or Superset...
- $ref: #/definitions/dashboardServiceType
- description
- Description of a dashboard service instance.
- Type:
string
- version
- Metadata version of the entity.
- $ref: ../../type/basic.json#/definitions/entityVersion
- updatedAt
- Last update time corresponding to the new version of the entity.
- $ref: ../../type/basic.json#/definitions/dateTime
- updatedBy
- User who made the update.
- Type:
string
- dashboardUrl
required
- Dashboard Service URL. This will be used to make REST API calls to Dashboard Service.
- Type:
string
- String format must be a "uri"
- username
- Username to log-into Dashboard Service.
- Type:
string
- password
- Password to log-into Dashboard Service.
- Type:
string
- ingestionSchedule
- Schedule for running metadata ingestion jobs.
- $ref: ../../type/schedule.json
- href
- Link to the resource corresponding to this dashboard service.
- $ref: ../../type/basic.json#/definitions/href
Type definitions in this schema
dashboardServiceType
- Type of Dashboard service - Superset, Looker, Redash or Tableau.
- Type:
string
- The value is restricted to the following:
- "Superset"
- "Looker"
- "Tableau"
- "Redash"
This document was updated on: Monday, October 18, 2021