parthp2107 aec586a5fe
updated metadata-ingestion and apis documents (#839)
* updated metadata-ingestion and apis documents

* minor changes in

* addressing maven ci findings

Co-authored-by: Parth Panchal <parthpanchal@Parths-MacBook-Air.local>
2021-10-18 18:02:22 +05:30

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
  • 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
  • description
    • Description of a dashboard service instance.
    • Type: string
  • version
  • updatedAt
  • 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
  • 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:
    1. "Superset"
    2. "Looker"
    3. "Tableau"
    4. "Redash"

This document was updated on: Monday, October 18, 2021