json.schema.dataInsight.dataInsightChartResult.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
  "$id": "https://open-metadata.org/schema/dataInsight/dataInsightChartResult.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DataInsightChartResult",
  "description": "DataInsightChartResult represents data that will be consumed by a specific chart",
  "type": "object",
  "javaType": "org.openmetadata.schema.dataInsight.DataInsightChartResult",
  "definitions": {
    "dataInsightChartType": {
      "description": "chart type. Must match `name` of a `dataInsightChartDefinition`.",
      "type": "string",
      "enum": [
        "DailyActiveUsers",
        "MostActiveUsers",
        "MostViewedEntities",
        "PageViewsByEntities",
        "UnusedAssets",
        "AggregatedUnusedAssetsSize",
        "AggregatedUnusedAssetsCount",
        "AggregatedUsedVsUnusedAssetsSize",
        "AggregatedUsedVsUnusedAssetsCount"
      ]
    }
  },
  "properties": {
    "chartType": {
      "description": "Chart Type that will consume the data. Must match name of dataInsightChart.",
      "$ref": "#/definitions/dataInsightChartType"
    },
    "total": {
      "description": "Total number of hits returned by the aggregation.",
      "type": "integer"
    },
    "data": {
      "description": "Array of consumable data.",
      "type": "array",
      "items": {
        "anyOf": [
          {"$ref": "./type/dailyActiveUsers.json"},
          {"$ref": "./type/pageViewsByEntities.json"},
          {"$ref": "type/mostActiveUsers.json"},
          {"$ref": "type/mostViewedEntities.json"},
          {"$ref": "type/unusedAssets.json"},
          {"$ref": "type/aggregatedUnusedAssetsSize.json"},
          {"$ref": "type/aggregatedUnusedAssetsCount.json"},
          {"$ref": "type/aggregatedUsedVsUnusedAssetsSize.json"},
          {"$ref": "type/aggregatedUsedVsUnusedAssetsCount.json"}
        ]
      }
    }
  },
  "required": ["chartType"],
  "additionalProperties": false
}