mirror of
https://github.com/apache/superset.git
synced 2026-09-01 04:51:23 +00:00
docs: cut 6.1.0 versions for user_docs, admin_docs, developer_docs, components (#40126)
Co-authored-by: Claude Code <noreply@anthropic.com>
This commit is contained in:
Evan Rusackas
co-authored by
Claude Code
Claude Code
parent
43231d56df
commit
6fa0b48752
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"type":{"default":"port","type":"string"},"values":{"items":{"default":"http"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"advanced_data_type_convert_schema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: advanced-data-type-convert-schema
|
||||
title: "advanced_data_type_convert_schema"
|
||||
description: ""
|
||||
sidebar_label: "advanced_data_type_convert_schema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"type":"port","values":[null]}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"advanced_data_type_convert_schema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./advanced-data-type-convert-schema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"display_value":{"description":"The string representation of the parsed values","type":"string"},"error_message":{"type":"string"},"valid_filter_operators":{"items":{"type":"string"},"type":"array"},"values":{"items":{"description":"parsed value (can be any value)","type":"string"},"type":"array"}},"type":"object","title":"AdvancedDataTypeSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: advanceddatatypeschema
|
||||
title: "AdvancedDataTypeSchema"
|
||||
description: ""
|
||||
sidebar_label: "AdvancedDataTypeSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"display_value":"string","error_message":"string","valid_filter_operators":["string"],"values":["string"]}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AdvancedDataTypeSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./advanceddatatypeschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"annotationType":{"description":"Type of annotation layer","enum":["FORMULA","INTERVAL","EVENT","TIME_SERIES"],"type":"string"},"color":{"description":"Layer color","nullable":true,"type":"string"},"descriptionColumns":{"description":"Columns to use as the description. If none are provided, all will be shown.","items":{"type":"string"},"type":"array"},"hideLine":{"description":"Should line be hidden. Only applies to line annotations","nullable":true,"type":"boolean"},"intervalEndColumn":{"description":"Column containing end of interval. Only applies to interval layers","nullable":true,"type":"string"},"name":{"description":"Name of layer","type":"string"},"opacity":{"description":"Opacity of layer","enum":["","opacityLow","opacityMedium","opacityHigh",null],"nullable":true,"type":"string"},"overrides":{"additionalProperties":{"nullable":true},"description":"which properties should be overridable","nullable":true,"type":"object"},"show":{"description":"Should the layer be shown","type":"boolean"},"showLabel":{"description":"Should the label always be shown","nullable":true,"type":"boolean"},"showMarkers":{"description":"Should markers be shown. Only applies to line annotations.","type":"boolean"},"sourceType":{"description":"Type of source for annotation data","enum":["","line","NATIVE","table"],"type":"string"},"style":{"description":"Line style. Only applies to time-series annotations","enum":["dashed","dotted","solid","longDashed"],"type":"string"},"timeColumn":{"description":"Column with event date or interval start date","nullable":true,"type":"string"},"titleColumn":{"description":"Column with title","nullable":true,"type":"string"},"value":{"description":"For formula annotations, this contains the formula. For other types, this is the primary key of the source object."},"width":{"description":"Width of annotation line","minimum":0,"type":"number"}},"required":["name","show","showMarkers","value"],"type":"object","title":"AnnotationLayer"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationlayer
|
||||
title: "AnnotationLayer"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationLayer"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"annotationType":"FORMULA","color":"string","descriptionColumns":["string"],"hideLine":true,"intervalEndColumn":"string","name":"string","opacity":"","overrides":{},"show":true,"showLabel":true,"showMarkers":true,"sourceType":"","style":"dashed","timeColumn":"string","titleColumn":"string","width":0}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationLayer"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationlayer.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"AnnotationLayerRestApi.get_list.User1"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationlayerrestapi-get-list-user-1
|
||||
title: "AnnotationLayerRestApi.get_list.User1"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationLayerRestApi.get_list.User1"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"first_name":"string","last_name":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationLayerRestApi.get_list.User1"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationlayerrestapi-get-list-user-1.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"AnnotationLayerRestApi.get_list.User"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationlayerrestapi-get-list-user
|
||||
title: "AnnotationLayerRestApi.get_list.User"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationLayerRestApi.get_list.User"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"first_name":"string","last_name":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationLayerRestApi.get_list.User"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationlayerrestapi-get-list-user.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"AnnotationLayerRestApi.get_list.User1"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"AnnotationLayerRestApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"descr":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"AnnotationLayerRestApi.get_list"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationlayerrestapi-get-list
|
||||
title: "AnnotationLayerRestApi.get_list"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationLayerRestApi.get_list"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"changed_by":{"first_name":"string","last_name":"string"},"changed_on":"2024-07-29T15:51:28.071Z","created_by":{"first_name":"string","last_name":"string"},"created_on":"2024-07-29T15:51:28.071Z","descr":"string","id":0,"name":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationLayerRestApi.get_list"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationlayerrestapi-get-list.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"descr":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"AnnotationLayerRestApi.get"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationlayerrestapi-get
|
||||
title: "AnnotationLayerRestApi.get"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationLayerRestApi.get"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"descr":"string","id":0,"name":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationLayerRestApi.get"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationlayerrestapi-get.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"descr":{"description":"Give a description for this annotation layer","nullable":true,"type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"required":["name"],"type":"object","title":"AnnotationLayerRestApi.post"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationlayerrestapi-post
|
||||
title: "AnnotationLayerRestApi.post"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationLayerRestApi.post"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"descr":"string","name":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationLayerRestApi.post"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationlayerrestapi-post.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"descr":{"description":"Give a description for this annotation layer","type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"type":"object","title":"AnnotationLayerRestApi.put"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationlayerrestapi-put
|
||||
title: "AnnotationLayerRestApi.put"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationLayerRestApi.put"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"descr":"string","name":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationLayerRestApi.put"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationlayerrestapi-put.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"AnnotationRestApi.get.AnnotationLayer"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationrestapi-get-annotationlayer
|
||||
title: "AnnotationRestApi.get.AnnotationLayer"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationRestApi.get.AnnotationLayer"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"id":0,"name":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationRestApi.get.AnnotationLayer"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationrestapi-get-annotationlayer.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object","title":"AnnotationRestApi.get_list.User1"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationrestapi-get-list-user-1
|
||||
title: "AnnotationRestApi.get_list.User1"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationRestApi.get_list.User1"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"first_name":"string","id":0}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationRestApi.get_list.User1"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationrestapi-get-list-user-1.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object","title":"AnnotationRestApi.get_list.User"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationrestapi-get-list-user
|
||||
title: "AnnotationRestApi.get_list.User"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationRestApi.get_list.User"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"first_name":"string","id":0}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationRestApi.get_list.User"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationrestapi-get-list-user.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object","title":"AnnotationRestApi.get_list.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object","title":"AnnotationRestApi.get_list.User1"},"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"long_descr":{"nullable":true,"type":"string"},"short_descr":{"maxLength":500,"nullable":true,"type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"}},"type":"object","title":"AnnotationRestApi.get_list"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationrestapi-get-list
|
||||
title: "AnnotationRestApi.get_list"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationRestApi.get_list"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"changed_by":{"first_name":"string","id":0},"created_by":{"first_name":"string","id":0},"end_dttm":"2024-07-29T15:51:28.071Z","id":0,"long_descr":"string","short_descr":"string","start_dttm":"2024-07-29T15:51:28.071Z"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationRestApi.get_list"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationrestapi-get-list.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"},"layer":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"AnnotationRestApi.get.AnnotationLayer"},"long_descr":{"nullable":true,"type":"string"},"short_descr":{"maxLength":500,"nullable":true,"type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"}},"required":["layer"],"type":"object","title":"AnnotationRestApi.get"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationrestapi-get
|
||||
title: "AnnotationRestApi.get"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationRestApi.get"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"end_dttm":"2024-07-29T15:51:28.071Z","id":0,"json_metadata":"string","layer":{"id":0,"name":"string"},"long_descr":"string","short_descr":"string","start_dttm":"2024-07-29T15:51:28.071Z"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationRestApi.get"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationrestapi-get.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"required":["end_dttm","short_descr","start_dttm"],"type":"object","title":"AnnotationRestApi.post"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationrestapi-post
|
||||
title: "AnnotationRestApi.post"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationRestApi.post"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"end_dttm":"2024-07-29T15:51:28.071Z","json_metadata":"string","long_descr":"string","short_descr":"string","start_dttm":"2024-07-29T15:51:28.071Z"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationRestApi.post"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationrestapi-post.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"type":"object","title":"AnnotationRestApi.put"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: annotationrestapi-put
|
||||
title: "AnnotationRestApi.put"
|
||||
description: ""
|
||||
sidebar_label: "AnnotationRestApi.put"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"end_dttm":"2024-07-29T15:51:28.071Z","json_metadata":"string","long_descr":"string","short_descr":"string","start_dttm":"2024-07-29T15:51:28.071Z"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AnnotationRestApi.put"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./annotationrestapi-put.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"domains":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"AvailableDomainsSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: availabledomainsschema
|
||||
title: "AvailableDomainsSchema"
|
||||
description: ""
|
||||
sidebar_label: "AvailableDomainsSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"domains":["string"]}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AvailableDomainsSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./availabledomainsschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"datasource_uids":{"description":"The uid of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_uid` ","items":{"type":"string"},"type":"array"},"datasources":{"description":"A list of the data source and database names","items":{"properties":{"catalog":{"description":"Datasource catalog","nullable":true,"type":"string"},"database_name":{"description":"Datasource name","type":"string"},"datasource_name":{"description":"The datasource name.","type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"type":"string"},"schema":{"description":"Datasource schema","type":"string"}},"required":["datasource_type"],"type":"object","title":"Datasource"},"type":"array"}},"type":"object","title":"CacheInvalidationRequestSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: cacheinvalidationrequestschema
|
||||
title: "CacheInvalidationRequestSchema"
|
||||
description: ""
|
||||
sidebar_label: "CacheInvalidationRequestSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"datasource_uids":["string"],"datasources":[{"catalog":"string","database_name":"string","datasource_name":"string","datasource_type":"table","schema":"string"}]}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"CacheInvalidationRequestSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./cacheinvalidationrequestschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"CacheRestApi.get_list"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: cacherestapi-get-list
|
||||
title: "CacheRestApi.get_list"
|
||||
description: ""
|
||||
sidebar_label: "CacheRestApi.get_list"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"id":0}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"CacheRestApi.get_list"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./cacherestapi-get-list.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"CacheRestApi.get"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: cacherestapi-get
|
||||
title: "CacheRestApi.get"
|
||||
description: ""
|
||||
sidebar_label: "CacheRestApi.get"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"id":0}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"CacheRestApi.get"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./cacherestapi-get.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"CacheRestApi.post"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: cacherestapi-post
|
||||
title: "CacheRestApi.post"
|
||||
description: ""
|
||||
sidebar_label: "CacheRestApi.post"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"id":0}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"CacheRestApi.post"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./cacherestapi-post.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"CacheRestApi.put"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: cacherestapi-put
|
||||
title: "CacheRestApi.put"
|
||||
description: ""
|
||||
sidebar_label: "CacheRestApi.put"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"id":0}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"CacheRestApi.put"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./cacherestapi-put.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"result":{"items":{"description":"A database catalog name","type":"string"},"type":"array"}},"type":"object","title":"CatalogsResponseSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: catalogsresponseschema
|
||||
title: "CatalogsResponseSchema"
|
||||
description: ""
|
||||
sidebar_label: "CatalogsResponseSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"result":["string"]}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"CatalogsResponseSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./catalogsresponseschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"cache_key":{"description":"The cache key","type":"string"},"chart_url":{"description":"The url to render the chart","type":"string"},"image_url":{"description":"The url to fetch the screenshot","type":"string"},"task_status":{"description":"The status of the async screenshot","type":"string"},"task_updated_at":{"description":"The timestamp of the last change in status","type":"string"}},"type":"object","title":"ChartCacheScreenshotResponseSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartcachescreenshotresponseschema
|
||||
title: "ChartCacheScreenshotResponseSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartCacheScreenshotResponseSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"cache_key":"string","chart_url":"string","image_url":"string","task_status":"string","task_updated_at":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartCacheScreenshotResponseSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartcachescreenshotresponseschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"chart_id":{"description":"The ID of the chart to warm up cache for","type":"integer"},"dashboard_id":{"description":"The ID of the dashboard to get filters for when warming cache","type":"integer"},"extra_filters":{"description":"Extra filters to apply when warming up cache","type":"string"}},"required":["chart_id"],"type":"object","title":"ChartCacheWarmUpRequestSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartcachewarmuprequestschema
|
||||
title: "ChartCacheWarmUpRequestSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartCacheWarmUpRequestSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"chart_id":0,"dashboard_id":0,"extra_filters":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartCacheWarmUpRequestSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartcachewarmuprequestschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"result":{"description":"A list of each chart's warmup status and errors if any","items":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object","title":"ChartCacheWarmUpResponseSingle"},"type":"array"}},"type":"object","title":"ChartCacheWarmUpResponseSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartcachewarmupresponseschema
|
||||
title: "ChartCacheWarmUpResponseSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartCacheWarmUpResponseSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"result":[{"chart_id":0,"viz_error":"string","viz_status":"string"}]}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartCacheWarmUpResponseSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartcachewarmupresponseschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object","title":"ChartCacheWarmUpResponseSingle"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartcachewarmupresponsesingle
|
||||
title: "ChartCacheWarmUpResponseSingle"
|
||||
description: ""
|
||||
sidebar_label: "ChartCacheWarmUpResponseSingle"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"chart_id":0,"viz_error":"string","viz_status":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartCacheWarmUpResponseSingle"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartcachewarmupresponsesingle.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"aggregate":{"description":"Aggregation operator.Only required for simple expression types.","enum":["AVG","COUNT","COUNT_DISTINCT","MAX","MIN","SUM"],"type":"string"},"column":{"properties":{"column_name":{"description":"The name of the target column","example":"mycol","type":"string"},"type":{"description":"Type of target column","example":"BIGINT","type":"string"}},"type":"object","title":"ChartDataColumn"},"expressionType":{"description":"Simple or SQL metric","enum":["SIMPLE","SQL"],"example":"SQL","type":"string"},"hasCustomLabel":{"description":"When false, the label will be automatically generated based on the aggregate expression. When true, a custom label has to be specified.","example":true,"type":"boolean"},"isExtra":{"description":"Indicates if the filter has been added by a filter component as opposed to being a part of the original query.","type":"boolean"},"label":{"description":"Label for the metric. Is automatically generated unlesshasCustomLabel is true, in which case label must be defined.","example":"Weighted observations","type":"string"},"optionName":{"description":"Unique identifier. Can be any string value, as long as all metrics have a unique identifier. If undefined, a random namewill be generated.","example":"metric_aec60732-fac0-4b17-b736-93f1a5c93e30","type":"string"},"sqlExpression":{"description":"The metric as defined by a SQL aggregate expression. Only required for SQL expression type.","example":"SUM(weight * observations) / SUM(weight)","type":"string"},"timeGrain":{"description":"Optional time grain for temporal filters","example":"PT1M","type":"string"}},"required":["expressionType"],"type":"object","title":"ChartDataAdhocMetricSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdataadhocmetricschema
|
||||
title: "ChartDataAdhocMetricSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataAdhocMetricSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"aggregate":"AVG","column":{"column_name":"mycol","type":"BIGINT"},"expressionType":"SQL","hasCustomLabel":true,"isExtra":true,"label":"Weighted observations","optionName":"metric_aec60732-fac0-4b17-b736-93f1a5c93e30","sqlExpression":"SUM(weight * observations) / SUM(weight)","timeGrain":"PT1M"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataAdhocMetricSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdataadhocmetricschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"aggregates":{"description":"The keys are the name of the aggregate column to be created, and the values specify the details of how to apply the aggregation. If an operator requires additional options, these can be passed here to be unpacked in the operator call. The following numpy operators are supported: average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, min, percentile, prod, product, std, sum, var. Any options required by the operator can be passed to the `options` object.\n\nIn the example, a new column `first_quantile` is created based on values in the column `my_col` using the `percentile` operator with the `q=0.25` parameter.","example":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"type":"object"}},"type":"object","title":"ChartDataAggregateOptionsSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdataaggregateoptionsschema
|
||||
title: "ChartDataAggregateOptionsSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataAggregateOptionsSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"aggregates":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}}}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataAggregateOptionsSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdataaggregateoptionsschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"channel_id":{"description":"Unique session async channel ID","type":"string"},"job_id":{"description":"Unique async job ID","type":"string"},"result_url":{"description":"Unique result URL for fetching async query data","type":"string"},"status":{"description":"Status value for async job","type":"string"},"user_id":{"description":"Requesting user ID","nullable":true,"type":"string"}},"type":"object","title":"ChartDataAsyncResponseSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdataasyncresponseschema
|
||||
title: "ChartDataAsyncResponseSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataAsyncResponseSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"channel_id":"string","job_id":"string","result_url":"string","status":"string","user_id":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataAsyncResponseSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdataasyncresponseschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"groupby":{"items":{"description":"Columns by which to group the query.","type":"string"},"nullable":true,"type":"array"},"metrics":{"description":"Aggregate expressions. Metrics can be passed as both references to datasource metrics (strings), or ad-hoc metricswhich are defined only within the query object. See `ChartDataAdhocMetricSchema` for the structure of ad-hoc metrics. When metrics is undefined or null, the query is executed without a groupby. However, when metrics is an array (length >= 0), a groupby clause is added to the query.","items":{},"nullable":true,"type":"array"},"percentiles":{"description":"Upper and lower percentiles for percentile whisker type.","example":[1,99]},"whisker_type":{"description":"Whisker type. Any numpy function will work.","enum":["tukey","min/max","percentile"],"example":"tukey","type":"string"}},"required":["whisker_type"],"type":"object","title":"ChartDataBoxplotOptionsSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdataboxplotoptionsschema
|
||||
title: "ChartDataBoxplotOptionsSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataBoxplotOptionsSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"groupby":["string"],"metrics":[null],"percentiles":[1,99],"whisker_type":"tukey"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataBoxplotOptionsSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdataboxplotoptionsschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"column_name":{"description":"The name of the target column","example":"mycol","type":"string"},"type":{"description":"Type of target column","example":"BIGINT","type":"string"}},"type":"object","title":"ChartDataColumn"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatacolumn
|
||||
title: "ChartDataColumn"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataColumn"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"column_name":"mycol","type":"BIGINT"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataColumn"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatacolumn.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"orientation":{"description":"Should cell values be calculated across the row or column.","enum":["row","column"],"example":"row","type":"string"}},"required":["orientation"],"type":"object","title":"ChartDataContributionOptionsSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatacontributionoptionsschema
|
||||
title: "ChartDataContributionOptionsSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataContributionOptionsSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"orientation":"row"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataContributionOptionsSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatacontributionoptionsschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"id":{"description":"Datasource id or uuid"},"type":{"description":"Datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"}},"required":["id"],"type":"object","title":"ChartDataDatasource"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatadatasource
|
||||
title: "ChartDataDatasource"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataDatasource"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"type":"table"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataDatasource"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatadatasource.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"column_order":{"description":"Ordered list of column names for result ordering. Used to preserve user's column reordering (including mixed dimension columns and metrics)","items":{"type":"string"},"nullable":true,"type":"array"},"having":{"description":"HAVING clause to be added to aggregate queries using AND operator.","type":"string"},"instant_time_comparison_range":{"description":"This is only set using the new time comparison controls that is made available in some plugins behind the experimental feature flag.","nullable":true,"type":"string"},"relative_end":{"description":"End time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"relative_start":{"description":"Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"time_grain_sqla":{"description":"To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z",null],"example":"P1D","nullable":true,"type":"string"},"transpile_to_dialect":{"description":"If true, WHERE/HAVING clauses will be transpiled to the target database dialect using SQLGlot.","nullable":true,"type":"boolean"},"where":{"description":"WHERE clause to be added to queries using AND operator.","type":"string"}},"type":"object","title":"ChartDataExtras"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdataextras
|
||||
title: "ChartDataExtras"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataExtras"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"column_order":["string"],"having":"string","instant_time_comparison_range":"string","relative_end":"today","relative_start":"today","time_grain_sqla":"P1D","transpile_to_dialect":true,"where":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataExtras"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdataextras.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"col":{"description":"The column to filter by. Can be either a string (physical or saved expression) or an object (adhoc column)","example":"country"},"grain":{"description":"Optional time grain for temporal filters","example":"PT1M","type":"string"},"isExtra":{"description":"Indicates if the filter has been added by a filter component as opposed to being a part of the original query.","type":"boolean"},"op":{"description":"The comparison operator.","enum":["==","!=",">","<",">=","<=","LIKE","NOT LIKE","ILIKE","NOT ILIKE","IS NULL","IS NOT NULL","IN","NOT IN","IS TRUE","IS FALSE","TEMPORAL_RANGE"],"example":"IN","type":"string"},"val":{"description":"The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.","example":["China","France","Japan"],"nullable":true}},"required":["col","op"],"type":"object","title":"ChartDataFilter"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatafilter
|
||||
title: "ChartDataFilter"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataFilter"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"col":"country","grain":"PT1M","isExtra":true,"op":"IN","val":["China","France","Japan"]}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataFilter"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatafilter.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"altitude":{"description":"Name of target column for decoded altitude. If omitted, altitude information in geodetic string is ignored.","type":"string"},"geodetic":{"description":"Name of source column containing geodetic point strings","type":"string"},"latitude":{"description":"Name of target column for decoded latitude","type":"string"},"longitude":{"description":"Name of target column for decoded longitude","type":"string"}},"required":["geodetic","latitude","longitude"],"type":"object","title":"ChartDataGeodeticParseOptionsSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatageodeticparseoptionsschema
|
||||
title: "ChartDataGeodeticParseOptionsSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataGeodeticParseOptionsSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"altitude":"string","geodetic":"string","latitude":"string","longitude":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataGeodeticParseOptionsSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatageodeticparseoptionsschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"geohash":{"description":"Name of source column containing geohash string","type":"string"},"latitude":{"description":"Name of target column for decoded latitude","type":"string"},"longitude":{"description":"Name of target column for decoded longitude","type":"string"}},"required":["geohash","latitude","longitude"],"type":"object","title":"ChartDataGeohashDecodeOptionsSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatageohashdecodeoptionsschema
|
||||
title: "ChartDataGeohashDecodeOptionsSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataGeohashDecodeOptionsSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"geohash":"string","latitude":"string","longitude":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataGeohashDecodeOptionsSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatageohashdecodeoptionsschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"geohash":{"description":"Name of target column for encoded geohash string","type":"string"},"latitude":{"description":"Name of source latitude column","type":"string"},"longitude":{"description":"Name of source longitude column","type":"string"}},"required":["geohash","latitude","longitude"],"type":"object","title":"ChartDataGeohashEncodeOptionsSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatageohashencodeoptionsschema
|
||||
title: "ChartDataGeohashEncodeOptionsSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataGeohashEncodeOptionsSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"geohash":"string","latitude":"string","longitude":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataGeohashEncodeOptionsSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatageohashencodeoptionsschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"aggregates":{"description":"The keys are the name of the aggregate column to be created, and the values specify the details of how to apply the aggregation. If an operator requires additional options, these can be passed here to be unpacked in the operator call. The following numpy operators are supported: average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, min, percentile, prod, product, std, sum, var. Any options required by the operator can be passed to the `options` object.\n\nIn the example, a new column `first_quantile` is created based on values in the column `my_col` using the `percentile` operator with the `q=0.25` parameter.","example":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"type":"object"},"column_fill_value":{"description":"Value to replace missing pivot columns names with.","type":"string"},"columns":{"description":"Columns to group by on the table columns","items":{"type":"string"},"type":"array"},"drop_missing_columns":{"description":"Do not include columns whose entries are all missing (default: `true`).","type":"boolean"},"marginal_distribution_name":{"description":"Name of marginal distribution row/column. (default: `All`)","type":"string"},"marginal_distributions":{"description":"Add totals for row/column. (default: `false`)","type":"boolean"},"metric_fill_value":{"description":"Value to replace missing values with in aggregate calculations.","type":"number"}},"type":"object","title":"ChartDataPivotOptionsSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatapivotoptionsschema
|
||||
title: "ChartDataPivotOptionsSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataPivotOptionsSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"aggregates":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"column_fill_value":"string","columns":["string"],"drop_missing_columns":true,"marginal_distribution_name":"string","marginal_distributions":true,"metric_fill_value":0}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataPivotOptionsSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatapivotoptionsschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"operation":{"description":"Post processing operation type","enum":["aggregate","boxplot","compare","contribution","cum","diff","escape_separator","flatten","geodetic_parse","geohash_decode","geohash_encode","histogram","pivot","prophet","rank","rename","resample","rolling","select","sort","unescape_separator"],"example":"aggregate","type":"string"},"options":{"description":"Options specifying how to perform the operation. Please refer to the respective post processing operation option schemas. For example, `ChartDataPostProcessingOperationOptions` specifies the required options for the pivot operation.","example":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]},"type":"object"}},"required":["operation"],"type":"object","title":"ChartDataPostProcessingOperation"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatapostprocessingoperation
|
||||
title: "ChartDataPostProcessingOperation"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataPostProcessingOperation"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"operation":"aggregate","options":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]}}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataPostProcessingOperation"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatapostprocessingoperation.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"confidence_interval":{"description":"Width of predicted confidence interval","example":0.8,"maximum":1,"minimum":0,"type":"number"},"monthly_seasonality":{"description":"Should monthly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false},"periods":{"description":"Time periods (in units of `time_grain`) to predict into the future","example":7,"type":"integer"},"time_grain":{"description":"Time grain used to specify time period increments in prediction. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z"],"example":"P1D","type":"string"},"weekly_seasonality":{"description":"Should weekly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false},"yearly_seasonality":{"description":"Should yearly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false}},"required":["confidence_interval","periods","time_grain"],"type":"object","title":"ChartDataProphetOptionsSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdataprophetoptionsschema
|
||||
title: "ChartDataProphetOptionsSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataProphetOptionsSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"confidence_interval":0.8,"monthly_seasonality":false,"periods":7,"time_grain":"P1D","weekly_seasonality":false,"yearly_seasonality":false}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataProphetOptionsSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdataprophetoptionsschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
File diff suppressed because one or more lines are too long
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdataquerycontextschema
|
||||
title: "ChartDataQueryContextSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataQueryContextSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"custom_cache_timeout":0,"datasource":{"type":"table"},"force":true,"queries":[{"annotation_layers":[{"annotationType":"FORMULA","color":"string","descriptionColumns":["string"],"hideLine":true,"intervalEndColumn":"string","name":"string","opacity":"","overrides":{},"show":true,"showLabel":true,"showMarkers":true,"sourceType":"","style":"dashed","timeColumn":"string","titleColumn":"string","width":0}],"applied_time_extras":{"__time_range":"1 year ago : now"},"apply_fetch_values_predicate":true,"columns":[null],"datasource":{"type":"table"},"extras":{"column_order":["string"],"having":"string","instant_time_comparison_range":"string","relative_end":"today","relative_start":"today","time_grain_sqla":"P1D","transpile_to_dialect":true,"where":"string"},"filters":[{"col":"country","grain":"PT1M","isExtra":true,"op":"IN","val":["China","France","Japan"]}],"granularity":"string","group_others_when_limit_reached":false,"groupby":[null],"is_rowcount":true,"is_timeseries":true,"metrics":[null],"order_desc":true,"orderby":[["my_col_1",false],["my_col_2",true]],"post_processing":[{"operation":"aggregate","options":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]}}],"row_limit":0,"row_offset":0,"series_columns":[null],"series_limit":0,"time_offsets":["string"],"time_range":"Last week","time_shift":"string","timeseries_limit":0,"url_params":{}}]}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataQueryContextSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdataquerycontextschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
File diff suppressed because one or more lines are too long
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdataqueryobject
|
||||
title: "ChartDataQueryObject"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataQueryObject"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"annotation_layers":[{"annotationType":"FORMULA","color":"string","descriptionColumns":["string"],"hideLine":true,"intervalEndColumn":"string","name":"string","opacity":"","overrides":{},"show":true,"showLabel":true,"showMarkers":true,"sourceType":"","style":"dashed","timeColumn":"string","titleColumn":"string","width":0}],"applied_time_extras":{"__time_range":"1 year ago : now"},"apply_fetch_values_predicate":true,"columns":[null],"datasource":{"type":"table"},"extras":{"column_order":["string"],"having":"string","instant_time_comparison_range":"string","relative_end":"today","relative_start":"today","time_grain_sqla":"P1D","transpile_to_dialect":true,"where":"string"},"filters":[{"col":"country","grain":"PT1M","isExtra":true,"op":"IN","val":["China","France","Japan"]}],"granularity":"string","group_others_when_limit_reached":false,"groupby":[null],"is_rowcount":true,"is_timeseries":true,"metrics":[null],"order_desc":true,"orderby":[["my_col_1",false],["my_col_2",true]],"post_processing":[{"operation":"aggregate","options":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]}}],"row_limit":0,"row_offset":0,"series_columns":[null],"series_limit":0,"time_offsets":["string"],"time_range":"Last week","time_shift":"string","timeseries_limit":0,"url_params":{}}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataQueryObject"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdataqueryobject.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"annotation_data":{"description":"All requested annotation data","items":{"additionalProperties":{"type":"string"},"type":"object"},"nullable":true,"type":"array"},"applied_filters":{"description":"A list with applied filters","items":{"type":"object"},"type":"array"},"cache_key":{"description":"Unique cache key for query object","nullable":true,"type":"string"},"cache_timeout":{"description":"Cache timeout in following order: custom timeout, datasource timeout, cache default timeout, config default cache timeout.","nullable":true,"type":"integer"},"cached_dttm":{"description":"Cache timestamp","nullable":true,"type":"string"},"colnames":{"description":"A list of column names","items":{"type":"string"},"type":"array"},"coltypes":{"description":"A list of generic data types of each column","items":{"type":"integer"},"type":"array"},"data":{"description":"A list with results","items":{"type":"object"},"type":"array"},"detected_currency":{"default":null,"description":"Detected ISO 4217 currency code when AUTO mode is used. Returns the currency code if all filtered data contains a single currency or null if multiple currencies are present.","nullable":true,"type":"string"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"queried_dttm":{"description":"UTC timestamp when the query was executed (ISO 8601 format)","nullable":true,"type":"string"},"query":{"description":"The executed query statement. May be absent when validation errors occur.","nullable":true,"type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","queried_dttm"],"type":"object","title":"ChartDataResponseResult"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdataresponseresult
|
||||
title: "ChartDataResponseResult"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataResponseResult"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"annotation_data":[{}],"applied_filters":[{}],"cache_key":"string","cache_timeout":0,"cached_dttm":"string","colnames":["string"],"coltypes":[0],"data":[{}],"detected_currency":null,"error":"string","from_dttm":0,"is_cached":true,"queried_dttm":"string","query":"string","rejected_filters":[{}],"rowcount":0,"stacktrace":"string","status":"stopped","to_dttm":0}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataResponseResult"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdataresponseresult.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"result":{"description":"A list of results for each corresponding query in the request.","items":{"properties":{"annotation_data":{"description":"All requested annotation data","items":{"additionalProperties":{"type":"string"},"type":"object"},"nullable":true,"type":"array"},"applied_filters":{"description":"A list with applied filters","items":{"type":"object"},"type":"array"},"cache_key":{"description":"Unique cache key for query object","nullable":true,"type":"string"},"cache_timeout":{"description":"Cache timeout in following order: custom timeout, datasource timeout, cache default timeout, config default cache timeout.","nullable":true,"type":"integer"},"cached_dttm":{"description":"Cache timestamp","nullable":true,"type":"string"},"colnames":{"description":"A list of column names","items":{"type":"string"},"type":"array"},"coltypes":{"description":"A list of generic data types of each column","items":{"type":"integer"},"type":"array"},"data":{"description":"A list with results","items":{"type":"object"},"type":"array"},"detected_currency":{"default":null,"description":"Detected ISO 4217 currency code when AUTO mode is used. Returns the currency code if all filtered data contains a single currency or null if multiple currencies are present.","nullable":true,"type":"string"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"queried_dttm":{"description":"UTC timestamp when the query was executed (ISO 8601 format)","nullable":true,"type":"string"},"query":{"description":"The executed query statement. May be absent when validation errors occur.","nullable":true,"type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","queried_dttm"],"type":"object","title":"ChartDataResponseResult"},"type":"array"}},"type":"object","title":"ChartDataResponseSchema"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdataresponseschema
|
||||
title: "ChartDataResponseSchema"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataResponseSchema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"result":[{"annotation_data":[{}],"applied_filters":[{}],"cache_key":"string","cache_timeout":0,"cached_dttm":"string","colnames":["string"],"coltypes":[0],"data":[{}],"detected_currency":null,"error":"string","from_dttm":0,"is_cached":true,"queried_dttm":"string","query":"string","rejected_filters":[{}],"rowcount":0,"stacktrace":"string","status":"stopped","to_dttm":0}]}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataResponseSchema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdataresponseschema.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object","title":"ChartDataRestApi.get_list.Dashboard"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatarestapi-get-list-dashboard
|
||||
title: "ChartDataRestApi.get_list.Dashboard"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataRestApi.get_list.Dashboard"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"dashboard_title":"string","id":0}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataRestApi.get_list.Dashboard"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatarestapi-get-list-dashboard.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"default_endpoint":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["table_name"],"type":"object","title":"ChartDataRestApi.get_list.SqlaTable"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatarestapi-get-list-sqlatable
|
||||
title: "ChartDataRestApi.get_list.SqlaTable"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataRestApi.get_list.SqlaTable"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"default_endpoint":"string","table_name":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataRestApi.get_list.SqlaTable"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatarestapi-get-list-sqlatable.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"ChartDataRestApi.get_list.Tag"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatarestapi-get-list-tag
|
||||
title: "ChartDataRestApi.get_list.Tag"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataRestApi.get_list.Tag"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"id":0,"name":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataRestApi.get_list.Tag"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatarestapi-get-list-tag.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartDataRestApi.get_list.User1"},"schemaType":"response"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: chartdatarestapi-get-list-user-1
|
||||
title: "ChartDataRestApi.get_list.User1"
|
||||
description: ""
|
||||
sidebar_label: "ChartDataRestApi.get_list.User1"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"first_name":"string","id":0,"last_name":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"ChartDataRestApi.get_list.User1"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
{...require("./chartdatarestapi-get-list-user-1.Schema.json")}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user