You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by as...@apache.org on 2024/12/13 01:58:42 UTC
(superset-site) branch asf-site updated: deploying docs: fix(tags): clean up bulk create api and schema (#31427) (apache/superset@bf56a327f4f3720f1b3f24fea3e7ee47bfb4da31)
This is an automated email from the ASF dual-hosted git repository.
asf-ci-deploy pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/superset-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new f830aee98 deploying docs: fix(tags): clean up bulk create api and schema (#31427) (apache/superset@bf56a327f4f3720f1b3f24fea3e7ee47bfb4da31)
f830aee98 is described below
commit f830aee98387d796a720d6c4381ffc7bbdc07671
Author: apache <de...@superset.apache.org>
AuthorDate: Fri Dec 13 01:58:35 2024 +0000
deploying docs: fix(tags): clean up bulk create api and schema (#31427) (apache/superset@bf56a327f4f3720f1b3f24fea3e7ee47bfb4da31)
---
404.html | 2 +-
assets/js/079e4a65.7a80d0ac.js | 1 -
assets/js/079e4a65.93153fb4.js | 1 +
assets/js/2461ffa2.1d5b65eb.js | 1 +
assets/js/2461ffa2.28778caf.js | 1 -
...e~main.57e2b707.js => runtime~main.9c3ddd34.js} | 2 +-
community/index.html | 2 +-
docs/api/index.html | 2 +-
docs/configuration/alerts-reports/index.html | 2 +-
docs/configuration/async-queries-celery/index.html | 2 +-
docs/configuration/cache/index.html | 2 +-
docs/configuration/configuring-superset/index.html | 2 +-
docs/configuration/country-map-tools/index.html | 2 +-
docs/configuration/databases/index.html | 2 +-
docs/configuration/event-logging/index.html | 2 +-
.../importing-exporting-datasources/index.html | 2 +-
docs/configuration/networking-settings/index.html | 2 +-
docs/configuration/setup-ssh-tunneling/index.html | 2 +-
docs/configuration/sql-templating/index.html | 2 +-
docs/configuration/timezones/index.html | 2 +-
docs/contributing/development/index.html | 2 +-
docs/contributing/guidelines/index.html | 2 +-
docs/contributing/howtos/index.html | 2 +-
docs/contributing/index.html | 2 +-
docs/contributing/misc/index.html | 2 +-
docs/contributing/resources/index.html | 4 +-
docs/faq/index.html | 2 +-
docs/installation/architecture/index.html | 2 +-
docs/installation/docker-builds/index.html | 2 +-
docs/installation/docker-compose/index.html | 2 +-
docs/installation/kubernetes/index.html | 2 +-
docs/installation/pypi/index.html | 2 +-
docs/installation/upgrading-superset/index.html | 2 +-
docs/intro/index.html | 2 +-
docs/quickstart/index.html | 2 +-
docs/security/cves/index.html | 2 +-
docs/security/index.html | 2 +-
.../creating-your-first-dashboard/index.html | 2 +-
docs/using-superset/exploring-data/index.html | 2 +-
docs/using-superset/issue-codes/index.html | 2 +-
img/erd.svg | 2 +-
index.html | 2 +-
markdown-page/index.html | 2 +-
resources/openapi.json | 15638 ++++++++++++-------
search/index.html | 2 +-
45 files changed, 9952 insertions(+), 5772 deletions(-)
diff --git a/404.html b/404.html
index 57ca27447..1ffbee5c2 100644
--- a/404.html
+++ b/404.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/assets/js/079e4a65.7a80d0ac.js b/assets/js/079e4a65.7a80d0ac.js
deleted file mode 100644
index d948e52ac..000000000
--- a/assets/js/079e4a65.7a80d0ac.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[6840],{37509:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>vd,contentTitle:()=>Sd,default:()=>Rd,frontMatter:()=>zd,metadata:()=>Fd,toc:()=>_d});var l,a,r,i,o,d,h,f,D,x,y,m,E,c,s,g,M,k,V,L,z,S,F,v,_,T,R,p,A,W,I,N,u,b,G,H,C,w,O,X,B,j,q,Y,U,P,K,Q,J,Z,$,ee,te,ne,le,ae,re,ie,oe,de,he,fe,De,xe,ye,me,Ee,ce,se,ge,Me,ke,Ve,Le,ze,Se,Fe,ve,_e,Te,Re,pe,Ae,We,Ie,Ne,ue,be,Ge,He,Ce,we,Oe,Xe,Be,je,qe,Ye,Ue,Pe,Ke,Qe,Je,Ze,$e,et,tt,nt,lt, [...]
\ No newline at end of file
diff --git a/assets/js/079e4a65.93153fb4.js b/assets/js/079e4a65.93153fb4.js
new file mode 100644
index 000000000..a98645842
--- /dev/null
+++ b/assets/js/079e4a65.93153fb4.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[6840],{37509:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>vd,contentTitle:()=>Sd,default:()=>Rd,frontMatter:()=>zd,metadata:()=>Fd,toc:()=>_d});var l,a,r,i,o,d,h,f,D,x,y,m,E,c,s,g,M,k,V,L,z,S,F,v,_,T,R,p,A,W,I,N,u,b,G,H,C,w,O,X,B,j,q,Y,U,P,K,Q,J,Z,$,ee,te,ne,le,ae,re,ie,oe,de,he,fe,De,xe,ye,me,Ee,ce,se,ge,Me,ke,Ve,Le,ze,Se,Fe,ve,_e,Te,Re,pe,Ae,We,Ie,Ne,ue,be,Ge,He,Ce,we,Oe,Xe,Be,je,qe,Ye,Ue,Pe,Ke,Qe,Je,Ze,$e,et,tt,nt,lt, [...]
\ No newline at end of file
diff --git a/assets/js/2461ffa2.1d5b65eb.js b/assets/js/2461ffa2.1d5b65eb.js
new file mode 100644
index 000000000..82161b8eb
--- /dev/null
+++ b/assets/js/2461ffa2.1d5b65eb.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[3503],{9210:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>m,contentTitle:()=>c,default:()=>h,frontMatter:()=>p,metadata:()=>l,toc:()=>d});var a=s(74848),r=s(28453),n=(s(48287),s(49960));const o=JSON.parse('{"components":{"responses":{"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"pro [...]
\ No newline at end of file
diff --git a/assets/js/2461ffa2.28778caf.js b/assets/js/2461ffa2.28778caf.js
deleted file mode 100644
index 24bca8a27..000000000
--- a/assets/js/2461ffa2.28778caf.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[3503],{9210:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>m,contentTitle:()=>c,default:()=>h,frontMatter:()=>p,metadata:()=>l,toc:()=>d});var r=s(74848),a=s(28453),n=(s(48287),s(49960));const o=JSON.parse('{"components":{"responses":{"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"pro [...]
\ No newline at end of file
diff --git a/assets/js/runtime~main.57e2b707.js b/assets/js/runtime~main.9c3ddd34.js
similarity index 95%
rename from assets/js/runtime~main.57e2b707.js
rename to assets/js/runtime~main.9c3ddd34.js
index 543a894e9..a5c32f6f1 100644
--- a/assets/js/runtime~main.57e2b707.js
+++ b/assets/js/runtime~main.9c3ddd34.js
@@ -1 +1 @@
-(()=>{"use strict";var e,a,f,t,r,d={},c={};function o(e){var a=c[e];if(void 0!==a)return a.exports;var f=c[e]={id:e,loaded:!1,exports:{}};return d[e].call(f.exports,f,f.exports,o),f.loaded=!0,f.exports}o.m=d,o.c=c,e=[],o.O=(a,f,t,r)=>{if(!f){var d=1/0;for(i=0;i<e.length;i++){f=e[i][0],t=e[i][1],r=e[i][2];for(var c=!0,n=0;n<f.length;n++)(!1&r||d>=r)&&Object.keys(o.O).every((e=>o.O[e](f[n])))?f.splice(n--,1):(c=!1,r<d&&(d=r));if(c){e.splice(i--,1);var b=t();void 0!==b&&(a=b)}}return a}r=r| [...]
\ No newline at end of file
+(()=>{"use strict";var e,a,f,t,r,d={},c={};function o(e){var a=c[e];if(void 0!==a)return a.exports;var f=c[e]={id:e,loaded:!1,exports:{}};return d[e].call(f.exports,f,f.exports,o),f.loaded=!0,f.exports}o.m=d,o.c=c,e=[],o.O=(a,f,t,r)=>{if(!f){var d=1/0;for(i=0;i<e.length;i++){f=e[i][0],t=e[i][1],r=e[i][2];for(var c=!0,n=0;n<f.length;n++)(!1&r||d>=r)&&Object.keys(o.O).every((e=>o.O[e](f[n])))?f.splice(n--,1):(c=!1,r<d&&(d=r));if(c){e.splice(i--,1);var b=t();void 0!==b&&(a=b)}}return a}r=r| [...]
\ No newline at end of file
diff --git a/community/index.html b/community/index.html
index 5c1f1e121..b7e23c325 100644
--- a/community/index.html
+++ b/community/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/api/index.html b/docs/api/index.html
index b2cf48d4b..f16e977e5 100644
--- a/docs/api/index.html
+++ b/docs/api/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/alerts-reports/index.html b/docs/configuration/alerts-reports/index.html
index 14d489593..f3e3c529a 100644
--- a/docs/configuration/alerts-reports/index.html
+++ b/docs/configuration/alerts-reports/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/async-queries-celery/index.html b/docs/configuration/async-queries-celery/index.html
index f4c86e891..632a8310d 100644
--- a/docs/configuration/async-queries-celery/index.html
+++ b/docs/configuration/async-queries-celery/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/cache/index.html b/docs/configuration/cache/index.html
index 9505e9730..aa6e5deab 100644
--- a/docs/configuration/cache/index.html
+++ b/docs/configuration/cache/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/configuring-superset/index.html b/docs/configuration/configuring-superset/index.html
index a64a1a6c6..13bec4938 100644
--- a/docs/configuration/configuring-superset/index.html
+++ b/docs/configuration/configuring-superset/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/country-map-tools/index.html b/docs/configuration/country-map-tools/index.html
index 11546518e..24366c25c 100644
--- a/docs/configuration/country-map-tools/index.html
+++ b/docs/configuration/country-map-tools/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/databases/index.html b/docs/configuration/databases/index.html
index 274a478fb..d2649e0a0 100644
--- a/docs/configuration/databases/index.html
+++ b/docs/configuration/databases/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/event-logging/index.html b/docs/configuration/event-logging/index.html
index fbf182fbe..97bb1138b 100644
--- a/docs/configuration/event-logging/index.html
+++ b/docs/configuration/event-logging/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/importing-exporting-datasources/index.html b/docs/configuration/importing-exporting-datasources/index.html
index 80eb0be12..fc6f30790 100644
--- a/docs/configuration/importing-exporting-datasources/index.html
+++ b/docs/configuration/importing-exporting-datasources/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/networking-settings/index.html b/docs/configuration/networking-settings/index.html
index 1944b733b..5e380eab3 100644
--- a/docs/configuration/networking-settings/index.html
+++ b/docs/configuration/networking-settings/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/setup-ssh-tunneling/index.html b/docs/configuration/setup-ssh-tunneling/index.html
index 489a6580a..6e33f15a5 100644
--- a/docs/configuration/setup-ssh-tunneling/index.html
+++ b/docs/configuration/setup-ssh-tunneling/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/sql-templating/index.html b/docs/configuration/sql-templating/index.html
index 60f6ee7cd..922f1d35d 100644
--- a/docs/configuration/sql-templating/index.html
+++ b/docs/configuration/sql-templating/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/configuration/timezones/index.html b/docs/configuration/timezones/index.html
index 04d211f2b..1b5dd6a00 100644
--- a/docs/configuration/timezones/index.html
+++ b/docs/configuration/timezones/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/contributing/development/index.html b/docs/contributing/development/index.html
index d73a38454..941fa5924 100644
--- a/docs/contributing/development/index.html
+++ b/docs/contributing/development/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/contributing/guidelines/index.html b/docs/contributing/guidelines/index.html
index 16defcd05..09ded2041 100644
--- a/docs/contributing/guidelines/index.html
+++ b/docs/contributing/guidelines/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/contributing/howtos/index.html b/docs/contributing/howtos/index.html
index 7d6cfe849..4e2cc79f4 100644
--- a/docs/contributing/howtos/index.html
+++ b/docs/contributing/howtos/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/contributing/index.html b/docs/contributing/index.html
index 8d33b0f1a..f03a50d51 100644
--- a/docs/contributing/index.html
+++ b/docs/contributing/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/contributing/misc/index.html b/docs/contributing/misc/index.html
index 42eb72096..d6aaf667a 100644
--- a/docs/contributing/misc/index.html
+++ b/docs/contributing/misc/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/contributing/resources/index.html b/docs/contributing/resources/index.html
index 0e034b63b..18cda0102 100644
--- a/docs/contributing/resources/index.html
+++ b/docs/contributing/resources/index.html
@@ -8,14 +8,14 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentEle [...]
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="entity-relationship-diagram">Entity-Relationship Diagram<a href="#entity-relationship-diagram" class="hash-link" aria-label="Direct link to Entity-Relationship Diagram" title="Direct link to Entity-Relationship Diagram"></a></h2>
<p>Here is our interactive ERD:</p>
-<div style="position:relative;width:100%;height:800"><svg width="100%" height="800" style="display:block;touch-action:none"><rect fill="#003153" x="0" y="0" width="100%" height="800" style="pointer-events:none"></rect><g transform="matrix(1,0,0,1,0,0)"><rect fill="#fff" x="0" y="0"></rect><g><svg xmlns="http://www.w3.org/2000/svg" width="6730" height="2766" preserveAspectRatio="none" style="width:6730px;height:2766px;background:#003153" viewBox="0 0 6730 2766"><path fill="#003153" d="M0 [...]
+<div style="position:relative;width:100%;height:800"><svg width="100%" height="800" style="display:block;touch-action:none"><rect fill="#003153" x="0" y="0" width="100%" height="800" style="pointer-events:none"></rect><g transform="matrix(1,0,0,1,0,0)"><rect fill="#fff" x="0" y="0"></rect><g><svg xmlns="http://www.w3.org/2000/svg" width="5230" height="2559" preserveAspectRatio="none" style="width:5230px;height:2559px;background:#003153" viewBox="0 0 5230 2559"><path fill="#003153" d="M0 [...]
<br>
<p><a href="https://github.com/apache/superset/tree/master/docs/static/img/erd.svg" target="_blank" rel="noopener noreferrer">Download the .svg</a></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/apache/superset/edit/master/docs/docs/contributing/resources.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" wid [...]
<div class="footer__applitools">
diff --git a/docs/faq/index.html b/docs/faq/index.html
index fd0fde316..52b8d88e8 100644
--- a/docs/faq/index.html
+++ b/docs/faq/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/installation/architecture/index.html b/docs/installation/architecture/index.html
index 4dbc07091..4ae12142d 100644
--- a/docs/installation/architecture/index.html
+++ b/docs/installation/architecture/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/installation/docker-builds/index.html b/docs/installation/docker-builds/index.html
index 4e3ac748d..ba800b382 100644
--- a/docs/installation/docker-builds/index.html
+++ b/docs/installation/docker-builds/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/installation/docker-compose/index.html b/docs/installation/docker-compose/index.html
index 6a6c9d152..d8f3e3256 100644
--- a/docs/installation/docker-compose/index.html
+++ b/docs/installation/docker-compose/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/installation/kubernetes/index.html b/docs/installation/kubernetes/index.html
index 0c459866b..55d5ab0c5 100644
--- a/docs/installation/kubernetes/index.html
+++ b/docs/installation/kubernetes/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/installation/pypi/index.html b/docs/installation/pypi/index.html
index e1203771e..393853783 100644
--- a/docs/installation/pypi/index.html
+++ b/docs/installation/pypi/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/installation/upgrading-superset/index.html b/docs/installation/upgrading-superset/index.html
index e3a2b9fa9..f2541a044 100644
--- a/docs/installation/upgrading-superset/index.html
+++ b/docs/installation/upgrading-superset/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/intro/index.html b/docs/intro/index.html
index 640c39deb..36e2001a0 100644
--- a/docs/intro/index.html
+++ b/docs/intro/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/quickstart/index.html b/docs/quickstart/index.html
index 58059f4b1..806f5a0c8 100644
--- a/docs/quickstart/index.html
+++ b/docs/quickstart/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/security/cves/index.html b/docs/security/cves/index.html
index 83980a9d4..583dbb8b4 100644
--- a/docs/security/cves/index.html
+++ b/docs/security/cves/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/security/index.html b/docs/security/index.html
index 13362f6ab..e1ced8cc2 100644
--- a/docs/security/index.html
+++ b/docs/security/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/using-superset/creating-your-first-dashboard/index.html b/docs/using-superset/creating-your-first-dashboard/index.html
index 61cc435fc..21cbb550e 100644
--- a/docs/using-superset/creating-your-first-dashboard/index.html
+++ b/docs/using-superset/creating-your-first-dashboard/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/using-superset/exploring-data/index.html b/docs/using-superset/exploring-data/index.html
index f6433011f..247c1d253 100644
--- a/docs/using-superset/exploring-data/index.html
+++ b/docs/using-superset/exploring-data/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/docs/using-superset/issue-codes/index.html b/docs/using-superset/issue-codes/index.html
index 0a96e170d..1cd2e37c1 100644
--- a/docs/using-superset/issue-codes/index.html
+++ b/docs/using-superset/issue-codes/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/img/erd.svg b/img/erd.svg
index c8bc1ce3e..5a9d0d270 100644
--- a/img/erd.svg
+++ b/img/erd.svg
@@ -1 +1 @@
-<?xml version="1.0" encoding="us-ascii" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentStyleType="text/css" height="2766px" preserveAspectRatio="none" style="width:6730px;height:2766px;background:#003153;" version="1.1" viewBox="0 0 6730 2766" width="6730px" zoomAndPan="magnify"><defs/><g><rect fill="#003153" height="2766" style="stroke:none;stroke-width:1.0;" width="6730" x="0" y="0"/><text fill="#D9D3D0" font-family="Verdana" [...]
\ No newline at end of file
+<?xml version="1.0" encoding="us-ascii" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentStyleType="text/css" height="2559px" preserveAspectRatio="none" style="width:5230px;height:2559px;background:#003153;" version="1.1" viewBox="0 0 5230 2559" width="5230px" zoomAndPan="magnify"><defs/><g><rect fill="#003153" height="2559" style="stroke:none;stroke-width:1.0;" width="5230" x="0" y="0"/><text fill="#D9D3D0" font-family="Verdana" [...]
\ No newline at end of file
diff --git a/index.html b/index.html
index 54e4a6ebb..c830a429f 100644
--- a/index.html
+++ b/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/markdown-page/index.html b/markdown-page/index.html
index d1c52053b..a860b8670 100644
--- a/markdown-page/index.html
+++ b/markdown-page/index.html
@@ -8,7 +8,7 @@
<script src="/script/matomo.js"></script><link rel="stylesheet" href="/assets/css/styles.c2c83f8d.css">
-<script src="/assets/js/runtime~main.57e2b707.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.9c3ddd34.js" defer="defer"></script>
<script src="/assets/js/main.795dc5e2.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
diff --git a/resources/openapi.json b/resources/openapi.json
index 39ce30517..60c25fc51 100644
--- a/resources/openapi.json
+++ b/resources/openapi.json
@@ -100,8 +100,13 @@
"QUERY_SECURITY_ACCESS_ERROR",
"MISSING_OWNERSHIP_ERROR",
"USER_ACTIVITY_SECURITY_ACCESS_ERROR",
+ "DASHBOARD_SECURITY_ACCESS_ERROR",
+ "CHART_SECURITY_ACCESS_ERROR",
+ "OAUTH2_REDIRECT",
+ "OAUTH2_REDIRECT_ERROR",
"BACKEND_TIMEOUT_ERROR",
"DATABASE_NOT_FOUND_ERROR",
+ "TABLE_NOT_FOUND_ERROR",
"MISSING_TEMPLATE_PARAMS_ERROR",
"INVALID_TEMPLATE_PARAMS_ERROR",
"RESULTS_BACKEND_NOT_CONFIGURED_ERROR",
@@ -112,12 +117,14 @@
"RESULTS_BACKEND_ERROR",
"ASYNC_WORKERS_ERROR",
"ADHOC_SUBQUERY_NOT_ALLOWED_ERROR",
+ "INVALID_SQL_ERROR",
+ "RESULT_TOO_LARGE_ERROR",
"GENERIC_COMMAND_ERROR",
"GENERIC_BACKEND_ERROR",
"INVALID_PAYLOAD_FORMAT_ERROR",
"INVALID_PAYLOAD_SCHEMA_ERROR",
- "REPORT_NOTIFICATION_ERROR",
- "RESULT_TOO_LARGE_ERROR"
+ "MARSHMALLOW_ERROR",
+ "REPORT_NOTIFICATION_ERROR"
],
"type": "string"
},
@@ -125,7 +132,11 @@
"type": "object"
},
"level": {
- "enum": ["info", "warning", "error"],
+ "enum": [
+ "info",
+ "warning",
+ "error"
+ ],
"type": "string"
},
"message": {
@@ -207,7 +218,12 @@
"properties": {
"annotationType": {
"description": "Type of annotation layer",
- "enum": ["FORMULA", "INTERVAL", "EVENT", "TIME_SERIES"],
+ "enum": [
+ "FORMULA",
+ "INTERVAL",
+ "EVENT",
+ "TIME_SERIES"
+ ],
"type": "string"
},
"color": {
@@ -238,7 +254,12 @@
},
"opacity": {
"description": "Opacity of layer",
- "enum": ["", "opacityLow", "opacityMedium", "opacityHigh"],
+ "enum": [
+ "",
+ "opacityLow",
+ "opacityMedium",
+ "opacityHigh"
+ ],
"nullable": true,
"type": "string"
},
@@ -265,12 +286,22 @@
},
"sourceType": {
"description": "Type of source for annotation data",
- "enum": ["", "line", "NATIVE", "table"],
+ "enum": [
+ "",
+ "line",
+ "NATIVE",
+ "table"
+ ],
"type": "string"
},
"style": {
"description": "Line style. Only applies to time-series annotations",
- "enum": ["dashed", "dotted", "solid", "longDashed"],
+ "enum": [
+ "dashed",
+ "dotted",
+ "solid",
+ "longDashed"
+ ],
"type": "string"
},
"timeColumn": {
@@ -292,7 +323,12 @@
"type": "number"
}
},
- "required": ["name", "show", "showMarkers", "value"],
+ "required": [
+ "name",
+ "show",
+ "showMarkers",
+ "value"
+ ],
"type": "object"
},
"AnnotationLayerRestApi.get": {
@@ -359,7 +395,10 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"AnnotationLayerRestApi.get_list.User1": {
@@ -373,7 +412,10 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"AnnotationLayerRestApi.post": {
@@ -390,7 +432,9 @@
"type": "string"
}
},
- "required": ["name"],
+ "required": [
+ "name"
+ ],
"type": "object"
},
"AnnotationLayerRestApi.put": {
@@ -440,7 +484,9 @@
"type": "string"
}
},
- "required": ["layer"],
+ "required": [
+ "layer"
+ ],
"type": "object"
},
"AnnotationRestApi.get.AnnotationLayer": {
@@ -459,13 +505,13 @@
"AnnotationRestApi.get_list": {
"properties": {
"changed_by": {
- "$ref": "#/components/schemas/AnnotationRestApi.get_list.User1"
+ "$ref": "#/components/schemas/AnnotationRestApi.get_list.User"
},
"changed_on_delta_humanized": {
"readOnly": true
},
"created_by": {
- "$ref": "#/components/schemas/AnnotationRestApi.get_list.User"
+ "$ref": "#/components/schemas/AnnotationRestApi.get_list.User1"
},
"end_dttm": {
"format": "date-time",
@@ -502,7 +548,9 @@
"type": "integer"
}
},
- "required": ["first_name"],
+ "required": [
+ "first_name"
+ ],
"type": "object"
},
"AnnotationRestApi.get_list.User1": {
@@ -515,7 +563,9 @@
"type": "integer"
}
},
- "required": ["first_name"],
+ "required": [
+ "first_name"
+ ],
"type": "object"
},
"AnnotationRestApi.post": {
@@ -547,7 +597,11 @@
"type": "string"
}
},
- "required": ["end_dttm", "short_descr", "start_dttm"],
+ "required": [
+ "end_dttm",
+ "short_descr",
+ "start_dttm"
+ ],
"type": "object"
},
"AnnotationRestApi.put": {
@@ -581,6 +635,37 @@
},
"type": "object"
},
+ "AppleHealthResponseSchema": {
+ "properties": {
+ "cache_message": {
+ "description": "Human readable status message for the cache connection",
+ "type": "string"
+ },
+ "cache_status": {
+ "description": "The status of the cache",
+ "enum": [
+ "NA",
+ "HEALTHY",
+ "ERROR"
+ ],
+ "type": "string"
+ },
+ "metastore_message": {
+ "description": "Human readable status message for the metastore connection",
+ "type": "string"
+ },
+ "metastore_status": {
+ "description": "The status of the metastore",
+ "enum": [
+ "NA",
+ "HEALTHY",
+ "ERROR"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"AvailableDomainsSchema": {
"properties": {
"domains": {
@@ -592,10 +677,136 @@
},
"type": "object"
},
+ "CSVMetadataUploadFilePostSchema": {
+ "properties": {
+ "delimiter": {
+ "description": "The delimiter of the CSV file",
+ "type": "string"
+ },
+ "file": {
+ "description": "The file to upload",
+ "format": "binary",
+ "type": "string"
+ },
+ "header_row": {
+ "description": "Row containing the headers to use as column names(0 is first line of data). Leave empty if there is no header row.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "file"
+ ],
+ "type": "object"
+ },
+ "CSVUploadPostSchema": {
+ "properties": {
+ "already_exists": {
+ "default": "fail",
+ "description": "What to do if the table already exists accepts: fail, replace, append",
+ "enum": [
+ "fail",
+ "replace",
+ "append"
+ ],
+ "type": "string"
+ },
+ "column_data_types": {
+ "description": "A dictionary with column names and their data types if you need to change the defaults. Example: {'user_id':'int'}. Check Python Pandas library for supported data types",
+ "type": "string"
+ },
+ "column_dates": {
+ "description": "A list of column names that should be parsed as dates. Example: date,timestamp",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "columns_read": {
+ "description": "A List of the column names that should be read",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dataframe_index": {
+ "description": "Write dataframe index as a column.",
+ "type": "boolean"
+ },
+ "day_first": {
+ "description": "DD/MM format dates, international and European format",
+ "type": "boolean"
+ },
+ "decimal_character": {
+ "description": "Character to recognize as decimal point. Default is '.'",
+ "type": "string"
+ },
+ "delimiter": {
+ "description": "The delimiter of the CSV file",
+ "type": "string"
+ },
+ "file": {
+ "description": "The CSV file to upload",
+ "format": "text/csv",
+ "type": "string"
+ },
+ "header_row": {
+ "description": "Row containing the headers to use as column names(0 is first line of data). Leave empty if there is no header row.",
+ "type": "integer"
+ },
+ "index_column": {
+ "description": "Column to use as the row labels of the dataframe. Leave empty if no index column",
+ "type": "string"
+ },
+ "index_label": {
+ "description": "Index label for index column.",
+ "type": "string"
+ },
+ "null_values": {
+ "description": "A list of strings that should be treated as null. Examples: '' for empty strings, 'None', 'N/A',Warning: Hive database supports only a single value",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "rows_to_read": {
+ "description": "Number of rows to read from the file. If None, reads all rows.",
+ "minimum": 1,
+ "nullable": true,
+ "type": "integer"
+ },
+ "schema": {
+ "description": "The schema to upload the data file to.",
+ "type": "string"
+ },
+ "skip_blank_lines": {
+ "description": "Skip blank lines in the CSV file.",
+ "type": "boolean"
+ },
+ "skip_initial_space": {
+ "description": "Skip spaces after delimiter.",
+ "type": "boolean"
+ },
+ "skip_rows": {
+ "description": "Number of rows to skip at start of file.",
+ "type": "integer"
+ },
+ "table_name": {
+ "description": "The name of the table to be created/appended",
+ "maxLength": 10000,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "file",
+ "table_name"
+ ],
+ "type": "object"
+ },
"CacheInvalidationRequestSchema": {
"properties": {
"datasource_uids": {
- "description": "The uid of the dataset/datasource this new chart will use. A complete datasource identification needs `datasouce_uid` ",
+ "description": "The uid of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_uid` ",
"items": {
"type": "string"
},
@@ -643,6 +854,18 @@
},
"type": "object"
},
+ "CatalogsResponseSchema": {
+ "properties": {
+ "result": {
+ "items": {
+ "description": "A database catalog name",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
"ChartCacheScreenshotResponseSchema": {
"properties": {
"cache_key": {
@@ -675,7 +898,9 @@
"type": "string"
}
},
- "required": ["chart_id"],
+ "required": [
+ "chart_id"
+ ],
"type": "object"
},
"ChartCacheWarmUpResponseSchema": {
@@ -711,7 +936,14 @@
"properties": {
"aggregate": {
"description": "Aggregation operator.Only required for simple expression types.",
- "enum": ["AVG", "COUNT", "COUNT_DISTINCT", "MAX", "MIN", "SUM"],
+ "enum": [
+ "AVG",
+ "COUNT",
+ "COUNT_DISTINCT",
+ "MAX",
+ "MIN",
+ "SUM"
+ ],
"type": "string"
},
"column": {
@@ -719,7 +951,10 @@
},
"expressionType": {
"description": "Simple or SQL metric",
- "enum": ["SIMPLE", "SQL"],
+ "enum": [
+ "SIMPLE",
+ "SQL"
+ ],
"example": "SQL",
"type": "string"
},
@@ -753,7 +988,9 @@
"type": "string"
}
},
- "required": ["expressionType"],
+ "required": [
+ "expressionType"
+ ],
"type": "object"
},
"ChartDataAggregateOptionsSchema": {
@@ -818,16 +1055,25 @@
},
"percentiles": {
"description": "Upper and lower percentiles for percentile whisker type.",
- "example": [1, 99]
+ "example": [
+ 1,
+ 99
+ ]
},
"whisker_type": {
"description": "Whisker type. Any numpy function will work.",
- "enum": ["tukey", "min/max", "percentile"],
+ "enum": [
+ "tukey",
+ "min/max",
+ "percentile"
+ ],
"example": "tukey",
"type": "string"
}
},
- "required": ["whisker_type"],
+ "required": [
+ "whisker_type"
+ ],
"type": "object"
},
"ChartDataColumn": {
@@ -849,12 +1095,17 @@
"properties": {
"orientation": {
"description": "Should cell values be calculated across the row or column.",
- "enum": ["row", "column"],
+ "enum": [
+ "row",
+ "column"
+ ],
"example": "row",
"type": "string"
}
},
- "required": ["orientation"],
+ "required": [
+ "orientation"
+ ],
"type": "object"
},
"ChartDataDatasource": {
@@ -866,7 +1117,6 @@
"type": {
"description": "Datasource type",
"enum": [
- "sl_table",
"table",
"dataset",
"query",
@@ -876,7 +1126,9 @@
"type": "string"
}
},
- "required": ["id"],
+ "required": [
+ "id"
+ ],
"type": "object"
},
"ChartDataExtras": {
@@ -885,14 +1137,25 @@
"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"],
+ "enum": [
+ "today",
+ "now"
+ ],
"type": "string"
},
"relative_start": {
"description": "Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`",
- "enum": ["today", "now"],
+ "enum": [
+ "today",
+ "now"
+ ],
"type": "string"
},
"time_grain_sqla": {
@@ -916,12 +1179,7 @@
"1969-12-28T00:00:00Z/P1W",
"1969-12-29T00:00:00Z/P1W",
"P1W/1970-01-03T00:00:00Z",
- "P1W/1970-01-04T00:00:00Z",
- "PT2H",
- "PT4H",
- "PT8H",
- "PT10H",
- "PT12H"
+ "P1W/1970-01-04T00:00:00Z"
],
"example": "P1D",
"nullable": true,
@@ -959,6 +1217,7 @@
">=",
"<=",
"LIKE",
+ "NOT LIKE",
"ILIKE",
"IS NULL",
"IS NOT NULL",
@@ -973,11 +1232,18 @@
},
"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"],
+ "example": [
+ "China",
+ "France",
+ "Japan"
+ ],
"nullable": true
}
},
- "required": ["col", "op"],
+ "required": [
+ "col",
+ "op"
+ ],
"type": "object"
},
"ChartDataGeodeticParseOptionsSchema": {
@@ -999,7 +1265,11 @@
"type": "string"
}
},
- "required": ["geodetic", "latitude", "longitude"],
+ "required": [
+ "geodetic",
+ "latitude",
+ "longitude"
+ ],
"type": "object"
},
"ChartDataGeohashDecodeOptionsSchema": {
@@ -1017,7 +1287,11 @@
"type": "string"
}
},
- "required": ["geohash", "latitude", "longitude"],
+ "required": [
+ "geohash",
+ "latitude",
+ "longitude"
+ ],
"type": "object"
},
"ChartDataGeohashEncodeOptionsSchema": {
@@ -1035,7 +1309,11 @@
"type": "string"
}
},
- "required": ["geohash", "latitude", "longitude"],
+ "required": [
+ "geohash",
+ "latitude",
+ "longitude"
+ ],
"type": "object"
},
"ChartDataPivotOptionsSchema": {
@@ -1099,8 +1377,10 @@
"geodetic_parse",
"geohash_decode",
"geohash_encode",
+ "histogram",
"pivot",
"prophet",
+ "rank",
"rename",
"resample",
"rolling",
@@ -1127,12 +1407,17 @@
}
}
},
- "groupby": ["country", "gender"]
+ "groupby": [
+ "country",
+ "gender"
+ ]
},
"type": "object"
}
},
- "required": ["operation"],
+ "required": [
+ "operation"
+ ],
"type": "object"
},
"ChartDataProphetOptionsSchema": {
@@ -1174,12 +1459,7 @@
"1969-12-28T00:00:00Z/P1W",
"1969-12-29T00:00:00Z/P1W",
"P1W/1970-01-03T00:00:00Z",
- "P1W/1970-01-04T00:00:00Z",
- "PT2H",
- "PT4H",
- "PT8H",
- "PT10H",
- "PT12H"
+ "P1W/1970-01-04T00:00:00Z"
],
"example": "P1D",
"type": "string"
@@ -1193,7 +1473,11 @@
"example": false
}
},
- "required": ["confidence_interval", "periods", "time_grain"],
+ "required": [
+ "confidence_interval",
+ "periods",
+ "time_grain"
+ ],
"type": "object"
},
"ChartDataQueryContextSchema": {
@@ -1221,7 +1505,11 @@
"type": "array"
},
"result_format": {
- "enum": ["csv", "json", "xlsx"]
+ "enum": [
+ "csv",
+ "json",
+ "xlsx"
+ ]
},
"result_type": {
"enum": [
@@ -1338,8 +1626,14 @@
"orderby": {
"description": "Expects a list of lists where the first element is the column name which to sort by, and the second element is a boolean.",
"example": [
- ["my_col_1", false],
- ["my_col_2", true]
+ [
+ "my_col_1",
+ false
+ ],
+ [
+ "my_col_2",
+ true
+ ]
],
"items": {},
"nullable": true,
@@ -1604,7 +1898,7 @@
"type": "boolean"
},
"owners": {
- "$ref": "#/components/schemas/ChartDataRestApi.get.User"
+ "$ref": "#/components/schemas/ChartDataRestApi.get.AppleUser"
},
"params": {
"nullable": true,
@@ -1636,6 +1930,26 @@
},
"type": "object"
},
+ "ChartDataRestApi.get.AppleUser": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
"ChartDataRestApi.get.Dashboard": {
"properties": {
"dashboard_title": {
@@ -1664,26 +1978,14 @@
"type": "string"
},
"type": {
- "enum": [1, 2, 3, 4]
- }
- },
- "type": "object"
- },
- "ChartDataRestApi.get.User": {
- "properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "last_name": {
- "maxLength": 64,
- "type": "string"
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4
+ ]
}
},
- "required": ["first_name", "last_name"],
"type": "object"
},
"ChartDataRestApi.get_list": {
@@ -1701,7 +2003,7 @@
"type": "string"
},
"changed_by": {
- "$ref": "#/components/schemas/ChartDataRestApi.get_list.User3"
+ "$ref": "#/components/schemas/ChartDataRestApi.get_list.User"
},
"changed_by_name": {
"readOnly": true
@@ -1716,7 +2018,7 @@
"readOnly": true
},
"created_by": {
- "$ref": "#/components/schemas/ChartDataRestApi.get_list.User"
+ "$ref": "#/components/schemas/ChartDataRestApi.get_list.User1"
},
"created_by_name": {
"readOnly": true
@@ -1767,10 +2069,10 @@
"type": "string"
},
"last_saved_by": {
- "$ref": "#/components/schemas/ChartDataRestApi.get_list.User2"
+ "$ref": "#/components/schemas/ChartDataRestApi.get_list.AppleUser"
},
"owners": {
- "$ref": "#/components/schemas/ChartDataRestApi.get_list.User1"
+ "$ref": "#/components/schemas/ChartDataRestApi.get_list.AppleUser1"
},
"params": {
"nullable": true,
@@ -1804,6 +2106,46 @@
},
"type": "object"
},
+ "ChartDataRestApi.get_list.AppleUser": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "ChartDataRestApi.get_list.AppleUser1": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
"ChartDataRestApi.get_list.Dashboard": {
"properties": {
"dashboard_title": {
@@ -1828,7 +2170,9 @@
"type": "string"
}
},
- "required": ["table_name"],
+ "required": [
+ "table_name"
+ ],
"type": "object"
},
"ChartDataRestApi.get_list.Tag": {
@@ -1842,7 +2186,12 @@
"type": "string"
},
"type": {
- "enum": [1, 2, 3, 4]
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4
+ ]
}
},
"type": "object"
@@ -1861,7 +2210,10 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"ChartDataRestApi.get_list.User1": {
@@ -1878,41 +2230,13 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
- "ChartDataRestApi.get_list.User2": {
- "properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "last_name": {
- "maxLength": 64,
- "type": "string"
- }
- },
- "required": ["first_name", "last_name"],
- "type": "object"
- },
- "ChartDataRestApi.get_list.User3": {
- "properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
- },
- "last_name": {
- "maxLength": 64,
- "type": "string"
- }
- },
- "required": ["first_name", "last_name"],
- "type": "object"
- },
- "ChartDataRestApi.post": {
+ "ChartDataRestApi.post": {
"properties": {
"cache_timeout": {
"description": "Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.",
@@ -1948,7 +2272,6 @@
"datasource_type": {
"description": "The type of dataset/datasource identified on `datasource_id`.",
"enum": [
- "sl_table",
"table",
"dataset",
"query",
@@ -1988,7 +2311,7 @@
"type": "string"
},
"query_context_generation": {
- "description": "The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.",
+ "description": "The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.",
"nullable": true,
"type": "boolean"
},
@@ -2000,13 +2323,21 @@
},
"viz_type": {
"description": "The type of chart visualization used.",
- "example": ["bar", "area", "table"],
+ "example": [
+ "bar",
+ "area",
+ "table"
+ ],
"maxLength": 250,
"minLength": 0,
"type": "string"
}
},
- "required": ["datasource_id", "datasource_type", "slice_name"],
+ "required": [
+ "datasource_id",
+ "datasource_type",
+ "slice_name"
+ ],
"type": "object"
},
"ChartDataRestApi.put": {
@@ -2041,7 +2372,6 @@
"datasource_type": {
"description": "The type of dataset/datasource identified on `datasource_id`.",
"enum": [
- "sl_table",
"table",
"dataset",
"query",
@@ -2082,7 +2412,7 @@
"type": "string"
},
"query_context_generation": {
- "description": "The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.",
+ "description": "The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.",
"nullable": true,
"type": "boolean"
},
@@ -2095,13 +2425,18 @@
},
"tags": {
"items": {
- "$ref": "#/components/schemas/Tag"
+ "description": "Tags to be associated with the chart",
+ "type": "integer"
},
"type": "array"
},
"viz_type": {
"description": "The type of chart visualization used.",
- "example": ["bar", "area", "table"],
+ "example": [
+ "bar",
+ "area",
+ "table"
+ ],
"maxLength": 250,
"minLength": 0,
"nullable": true,
@@ -2182,14 +2517,21 @@
"type": "integer"
}
},
- "required": ["rolling_type", "window"],
+ "required": [
+ "rolling_type",
+ "window"
+ ],
"type": "object"
},
"ChartDataSelectOptionsSchema": {
"properties": {
"columns": {
"description": "Columns which to select from the input data, in the desired order. If columns are renamed, the original column name should be referenced here.",
- "example": ["country", "gender", "age"],
+ "example": [
+ "country",
+ "gender",
+ "age"
+ ],
"items": {
"type": "string"
},
@@ -2197,7 +2539,9 @@
},
"exclude": {
"description": "Columns to exclude from selection.",
- "example": ["my_temp_column"],
+ "example": [
+ "my_temp_column"
+ ],
"items": {
"type": "string"
},
@@ -2242,7 +2586,9 @@
"type": "object"
}
},
- "required": ["columns"],
+ "required": [
+ "columns"
+ ],
"type": "object"
},
"ChartEntityResponseSchema": {
@@ -2372,7 +2718,7 @@
"type": "boolean"
},
"owners": {
- "$ref": "#/components/schemas/ChartRestApi.get.User"
+ "$ref": "#/components/schemas/ChartRestApi.get.AppleUser"
},
"params": {
"nullable": true,
@@ -2404,6 +2750,26 @@
},
"type": "object"
},
+ "ChartRestApi.get.AppleUser": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
"ChartRestApi.get.Dashboard": {
"properties": {
"dashboard_title": {
@@ -2432,26 +2798,14 @@
"type": "string"
},
"type": {
- "enum": [1, 2, 3, 4]
- }
- },
- "type": "object"
- },
- "ChartRestApi.get.User": {
- "properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "last_name": {
- "maxLength": 64,
- "type": "string"
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4
+ ]
}
},
- "required": ["first_name", "last_name"],
"type": "object"
},
"ChartRestApi.get_list": {
@@ -2469,7 +2823,7 @@
"type": "string"
},
"changed_by": {
- "$ref": "#/components/schemas/ChartRestApi.get_list.User3"
+ "$ref": "#/components/schemas/ChartRestApi.get_list.User"
},
"changed_by_name": {
"readOnly": true
@@ -2484,7 +2838,7 @@
"readOnly": true
},
"created_by": {
- "$ref": "#/components/schemas/ChartRestApi.get_list.User"
+ "$ref": "#/components/schemas/ChartRestApi.get_list.User1"
},
"created_by_name": {
"readOnly": true
@@ -2535,10 +2889,10 @@
"type": "string"
},
"last_saved_by": {
- "$ref": "#/components/schemas/ChartRestApi.get_list.User2"
+ "$ref": "#/components/schemas/ChartRestApi.get_list.AppleUser"
},
"owners": {
- "$ref": "#/components/schemas/ChartRestApi.get_list.User1"
+ "$ref": "#/components/schemas/ChartRestApi.get_list.AppleUser1"
},
"params": {
"nullable": true,
@@ -2572,6 +2926,46 @@
},
"type": "object"
},
+ "ChartRestApi.get_list.AppleUser": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "ChartRestApi.get_list.AppleUser1": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
"ChartRestApi.get_list.Dashboard": {
"properties": {
"dashboard_title": {
@@ -2596,7 +2990,9 @@
"type": "string"
}
},
- "required": ["table_name"],
+ "required": [
+ "table_name"
+ ],
"type": "object"
},
"ChartRestApi.get_list.Tag": {
@@ -2610,7 +3006,12 @@
"type": "string"
},
"type": {
- "enum": [1, 2, 3, 4]
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4
+ ]
}
},
"type": "object"
@@ -2629,7 +3030,10 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"ChartRestApi.get_list.User1": {
@@ -2646,38 +3050,10 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
- "type": "object"
- },
- "ChartRestApi.get_list.User2": {
- "properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "last_name": {
- "maxLength": 64,
- "type": "string"
- }
- },
- "required": ["first_name", "last_name"],
- "type": "object"
- },
- "ChartRestApi.get_list.User3": {
- "properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
- },
- "last_name": {
- "maxLength": 64,
- "type": "string"
- }
- },
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"ChartRestApi.post": {
@@ -2716,7 +3092,6 @@
"datasource_type": {
"description": "The type of dataset/datasource identified on `datasource_id`.",
"enum": [
- "sl_table",
"table",
"dataset",
"query",
@@ -2756,7 +3131,7 @@
"type": "string"
},
"query_context_generation": {
- "description": "The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.",
+ "description": "The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.",
"nullable": true,
"type": "boolean"
},
@@ -2768,13 +3143,21 @@
},
"viz_type": {
"description": "The type of chart visualization used.",
- "example": ["bar", "area", "table"],
+ "example": [
+ "bar",
+ "area",
+ "table"
+ ],
"maxLength": 250,
"minLength": 0,
"type": "string"
}
},
- "required": ["datasource_id", "datasource_type", "slice_name"],
+ "required": [
+ "datasource_id",
+ "datasource_type",
+ "slice_name"
+ ],
"type": "object"
},
"ChartRestApi.put": {
@@ -2809,7 +3192,6 @@
"datasource_type": {
"description": "The type of dataset/datasource identified on `datasource_id`.",
"enum": [
- "sl_table",
"table",
"dataset",
"query",
@@ -2850,7 +3232,7 @@
"type": "string"
},
"query_context_generation": {
- "description": "The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.",
+ "description": "The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.",
"nullable": true,
"type": "boolean"
},
@@ -2863,13 +3245,18 @@
},
"tags": {
"items": {
- "$ref": "#/components/schemas/Tag"
+ "description": "Tags to be associated with the chart",
+ "type": "integer"
},
"type": "array"
},
"viz_type": {
"description": "The type of chart visualization used.",
- "example": ["bar", "area", "table"],
+ "example": [
+ "bar",
+ "area",
+ "table"
+ ],
"maxLength": 250,
"minLength": 0,
"nullable": true,
@@ -2878,11 +3265,79 @@
},
"type": "object"
},
+ "ColumnarMetadataUploadFilePostSchema": {
+ "properties": {
+ "file": {
+ "description": "The file to upload",
+ "format": "binary",
+ "type": "string"
+ }
+ },
+ "required": [
+ "file"
+ ],
+ "type": "object"
+ },
+ "ColumnarUploadPostSchema": {
+ "properties": {
+ "already_exists": {
+ "default": "fail",
+ "description": "What to do if the table already exists accepts: fail, replace, append",
+ "enum": [
+ "fail",
+ "replace",
+ "append"
+ ],
+ "type": "string"
+ },
+ "columns_read": {
+ "description": "A List of the column names that should be read",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dataframe_index": {
+ "description": "Write dataframe index as a column.",
+ "type": "boolean"
+ },
+ "file": {
+ "description": "The Columnar file to upload",
+ "format": "binary",
+ "type": "string"
+ },
+ "index_label": {
+ "description": "Index label for index column.",
+ "type": "string"
+ },
+ "schema": {
+ "description": "The schema to upload the data file to.",
+ "type": "string"
+ },
+ "table_name": {
+ "description": "The name of the table to be created/appended",
+ "maxLength": 10000,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "file",
+ "table_name"
+ ],
+ "type": "object"
+ },
"CssTemplateRestApi.get": {
"properties": {
- "created_by": {
+ "changed_by": {
"$ref": "#/components/schemas/CssTemplateRestApi.get.User"
},
+ "changed_on_delta_humanized": {
+ "readOnly": true
+ },
+ "created_by": {
+ "$ref": "#/components/schemas/CssTemplateRestApi.get.User1"
+ },
"css": {
"nullable": true,
"type": "string"
@@ -2912,19 +3367,42 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "CssTemplateRestApi.get.User1": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"CssTemplateRestApi.get_list": {
"properties": {
"changed_by": {
- "$ref": "#/components/schemas/CssTemplateRestApi.get_list.User1"
+ "$ref": "#/components/schemas/CssTemplateRestApi.get_list.User"
},
"changed_on_delta_humanized": {
"readOnly": true
},
"created_by": {
- "$ref": "#/components/schemas/CssTemplateRestApi.get_list.User"
+ "$ref": "#/components/schemas/CssTemplateRestApi.get_list.User1"
},
"created_on": {
"format": "date-time",
@@ -2960,7 +3438,10 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"CssTemplateRestApi.get_list.User1": {
@@ -2977,7 +3458,10 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"CssTemplateRestApi.post": {
@@ -3008,31 +3492,21 @@
},
"type": "object"
},
- "DashboardNativeFiltersConfigUpdateSchema": {
+ "DashboardCacheScreenshotResponseSchema": {
"properties": {
- "deleted": {
- "description": "List of filter ids to delete",
- "items": {
- "type": "integer"
- },
- "type": "array"
+ "cache_key": {
+ "description": "The cache key",
+ "type": "string"
},
- "modified": {
- "description": "List of filter objects to update",
- "items": {
- "type": "object"
- },
- "type": "array"
+ "dashboard_url": {
+ "description": "The url to render the dashboard",
+ "type": "string"
},
- "reordered": {
- "description": "List of filter ids in the new order",
- "items": {
- "type": "integer"
- },
- "type": "array"
+ "image_url": {
+ "description": "The url to fetch the screenshot",
+ "type": "string"
}
},
- "required": ["deleted", "modified", "reordered"],
"type": "object"
},
"DashboardCopySchema": {
@@ -3057,17 +3531,28 @@
"type": "string"
}
},
- "required": ["json_metadata"],
+ "required": [
+ "json_metadata"
+ ],
"type": "object"
},
"DashboardDatasetSchema": {
"properties": {
+ "always_filter_main_dttm": {
+ "type": "boolean"
+ },
"cache_timeout": {
"type": "integer"
},
"column_formats": {
"type": "object"
},
+ "column_names": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"column_types": {
"items": {
"type": "integer"
@@ -3080,12 +3565,6 @@
},
"type": "array"
},
- "column_names": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"currency_formats": {
"type": "object"
},
@@ -3140,6 +3619,9 @@
"name": {
"type": "string"
},
+ "normalize_columns": {
+ "type": "boolean"
+ },
"offset": {
"type": "integer"
},
@@ -3233,6 +3715,12 @@
},
"type": "array"
},
+ "created_by": {
+ "$ref": "#/components/schemas/User"
+ },
+ "created_on_delta_humanized": {
+ "type": "string"
+ },
"css": {
"description": "Override CSS for the dashboard.",
"type": "string"
@@ -3276,7 +3764,7 @@
},
"tags": {
"items": {
- "$ref": "#/components/schemas/Tag1"
+ "$ref": "#/components/schemas/Tag"
},
"type": "array"
},
@@ -3340,7 +3828,7 @@
"type": "string"
},
"changed_by": {
- "$ref": "#/components/schemas/DashboardRestApi.get_list.User2"
+ "$ref": "#/components/schemas/DashboardRestApi.get_list.User"
},
"changed_by_name": {
"readOnly": true
@@ -3352,7 +3840,7 @@
"readOnly": true
},
"created_by": {
- "$ref": "#/components/schemas/DashboardRestApi.get_list.User"
+ "$ref": "#/components/schemas/DashboardRestApi.get_list.User1"
},
"created_on_delta_humanized": {
"readOnly": true
@@ -3377,7 +3865,7 @@
"type": "string"
},
"owners": {
- "$ref": "#/components/schemas/DashboardRestApi.get_list.User1"
+ "$ref": "#/components/schemas/DashboardRestApi.get_list.AppleUser"
},
"position_json": {
"nullable": true,
@@ -3410,53 +3898,63 @@
},
"type": "object"
},
- "DashboardRestApi.get_list.Role": {
+ "DashboardRestApi.get_list.AppleUser": {
"properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
"id": {
"type": "integer"
},
- "name": {
+ "last_name": {
"maxLength": 64,
"type": "string"
}
},
- "required": ["name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
- "DashboardRestApi.get_list.Tag": {
+ "DashboardRestApi.get_list.Role": {
"properties": {
"id": {
"type": "integer"
},
"name": {
- "maxLength": 250,
- "nullable": true,
+ "maxLength": 64,
"type": "string"
- },
- "type": {
- "enum": [1, 2, 3, 4]
}
},
+ "required": [
+ "name"
+ ],
"type": "object"
},
- "DashboardRestApi.get_list.User": {
+ "DashboardRestApi.get_list.Tag": {
"properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
- },
"id": {
"type": "integer"
},
- "last_name": {
- "maxLength": 64,
+ "name": {
+ "maxLength": 250,
+ "nullable": true,
"type": "string"
+ },
+ "type": {
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4
+ ]
}
},
- "required": ["first_name", "last_name"],
"type": "object"
},
- "DashboardRestApi.get_list.User1": {
+ "DashboardRestApi.get_list.User": {
"properties": {
"first_name": {
"maxLength": 64,
@@ -3470,10 +3968,13 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
- "DashboardRestApi.get_list.User2": {
+ "DashboardRestApi.get_list.User1": {
"properties": {
"first_name": {
"maxLength": 64,
@@ -3487,7 +3988,10 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"DashboardRestApi.post": {
@@ -3626,12 +4130,23 @@
"minLength": 0,
"nullable": true,
"type": "string"
+ },
+ "tags": {
+ "items": {
+ "description": "Tags to be associated with the dashboard",
+ "nullable": true,
+ "type": "integer"
+ },
+ "type": "array"
}
},
"type": "object"
},
"Database": {
"properties": {
+ "allow_multi_catalog": {
+ "type": "boolean"
+ },
"allows_cost_estimate": {
"type": "boolean"
},
@@ -3719,15 +4234,14 @@
"type": "string"
},
"engine_information": {
- "additionalProperties": {},
- "type": "object"
+ "$ref": "#/components/schemas/EngineInformation"
},
"expose_in_sqllab": {
"description": "Expose this database to SQLLab",
"type": "boolean"
},
"extra": {
- "description": "<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\" rel=\"noopener noreferrer\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\" rel=\"noopener noreferrer\ [...]
+ "description": "<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\" rel=\"noopener noreferrer\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\" rel=\"noopener noreferrer\ [...]
"type": "string"
},
"force_ctas_schema": {
@@ -3943,7 +4457,9 @@
"type": "string"
}
},
- "required": ["database_name"],
+ "required": [
+ "database_name"
+ ],
"type": "object"
},
"DatabaseRestApi.get_list": {
@@ -3964,6 +4480,9 @@
"nullable": true,
"type": "boolean"
},
+ "allow_multi_catalog": {
+ "readOnly": true
+ },
"allow_run_async": {
"nullable": true,
"type": "boolean"
@@ -3980,6 +4499,9 @@
"backend": {
"readOnly": true
},
+ "changed_by": {
+ "$ref": "#/components/schemas/DatabaseRestApi.get_list.User"
+ },
"changed_on": {
"format": "date-time",
"nullable": true,
@@ -3989,7 +4511,7 @@
"readOnly": true
},
"created_by": {
- "$ref": "#/components/schemas/DatabaseRestApi.get_list.User"
+ "$ref": "#/components/schemas/DatabaseRestApi.get_list.User1"
},
"database_name": {
"maxLength": 250,
@@ -3998,6 +4520,9 @@
"disable_data_preview": {
"readOnly": true
},
+ "disable_drill_to_detail": {
+ "readOnly": true
+ },
"engine_information": {
"readOnly": true
},
@@ -4026,7 +4551,9 @@
"type": "string"
}
},
- "required": ["database_name"],
+ "required": [
+ "database_name"
+ ],
"type": "object"
},
"DatabaseRestApi.get_list.User": {
@@ -4040,7 +4567,27 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "DatabaseRestApi.get_list.User1": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"DatabaseRestApi.post": {
@@ -4073,7 +4620,10 @@
"configuration_method": {
"default": "sqlalchemy_form",
"description": "Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.",
- "enum": ["sqlalchemy_form", "dynamic_form"]
+ "enum": [
+ "sqlalchemy_form",
+ "dynamic_form"
+ ]
},
"database_name": {
"description": "A database name to identify this connection.",
@@ -4100,7 +4650,7 @@
"type": "string"
},
"extra": {
- "description": "<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\" rel=\"noopener noreferrer\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\" rel=\"noopener noreferrer\ [...]
+ "description": "<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\" rel=\"noopener noreferrer\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\" rel=\"noopener noreferrer\ [...]
"type": "string"
},
"force_ctas_schema": {
@@ -4151,7 +4701,9 @@
"type": "string"
}
},
- "required": ["database_name"],
+ "required": [
+ "database_name"
+ ],
"type": "object"
},
"DatabaseRestApi.put": {
@@ -4184,7 +4736,10 @@
"configuration_method": {
"default": "sqlalchemy_form",
"description": "Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.",
- "enum": ["sqlalchemy_form", "dynamic_form"]
+ "enum": [
+ "sqlalchemy_form",
+ "dynamic_form"
+ ]
},
"database_name": {
"description": "A database name to identify this connection.",
@@ -4212,7 +4767,7 @@
"type": "string"
},
"extra": {
- "description": "<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\" rel=\"noopener noreferrer\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\" rel=\"noopener noreferrer\ [...]
+ "description": "<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\" rel=\"noopener noreferrer\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\" rel=\"noopener noreferrer\ [...]
"type": "string"
},
"force_ctas_schema": {
@@ -4327,7 +4882,10 @@
"configuration_method": {
"default": "sqlalchemy_form",
"description": "Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.",
- "enum": ["sqlalchemy_form", "dynamic_form"]
+ "enum": [
+ "sqlalchemy_form",
+ "dynamic_form"
+ ]
},
"database_name": {
"description": "A database name to identify this connection.",
@@ -4347,7 +4905,7 @@
"type": "string"
},
"extra": {
- "description": "<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\" rel=\"noopener noreferrer\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\" rel=\"noopener noreferrer\ [...]
+ "description": "<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\" rel=\"noopener noreferrer\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\" rel=\"noopener noreferrer\ [...]
"type": "string"
},
"impersonate_user": {
@@ -4397,7 +4955,10 @@
},
"configuration_method": {
"description": "Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.",
- "enum": ["sqlalchemy_form", "dynamic_form"]
+ "enum": [
+ "sqlalchemy_form",
+ "dynamic_form"
+ ]
},
"database_name": {
"description": "A database name to identify this connection.",
@@ -4416,7 +4977,7 @@
"type": "string"
},
"extra": {
- "description": "<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\" rel=\"noopener noreferrer\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\" rel=\"noopener noreferrer\ [...]
+ "description": "<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\" rel=\"noopener noreferrer\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\" rel=\"noopener noreferrer\ [...]
"type": "string"
},
"id": {
@@ -4446,7 +5007,10 @@
"type": "string"
}
},
- "required": ["configuration_method", "engine"],
+ "required": [
+ "configuration_method",
+ "engine"
+ ],
"type": "object"
},
"Dataset": {
@@ -4636,7 +5200,10 @@
"type": "string"
}
},
- "required": ["db_name", "table_name"],
+ "required": [
+ "db_name",
+ "table_name"
+ ],
"type": "object"
},
"DatasetCacheWarmUpResponseSchema": {
@@ -4730,7 +5297,9 @@
"type": "string"
}
},
- "required": ["column_name"],
+ "required": [
+ "column_name"
+ ],
"type": "object"
},
"DatasetColumnsRestApi.get": {
@@ -4776,7 +5345,10 @@
"type": "string"
}
},
- "required": ["base_model_id", "table_name"],
+ "required": [
+ "base_model_id",
+ "table_name"
+ ],
"type": "object"
},
"DatasetMetricRestApi.get": {
@@ -4864,7 +5436,10 @@
"type": "string"
}
},
- "required": ["expression", "metric_name"],
+ "required": [
+ "expression",
+ "metric_name"
+ ],
"type": "object"
},
"DatasetRelatedChart": {
@@ -4943,12 +5518,21 @@
},
"DatasetRestApi.get": {
"properties": {
+ "always_filter_main_dttm": {
+ "nullable": true,
+ "type": "boolean"
+ },
"cache_timeout": {
"nullable": true,
"type": "integer"
},
+ "catalog": {
+ "maxLength": 256,
+ "nullable": true,
+ "type": "string"
+ },
"changed_by": {
- "$ref": "#/components/schemas/DatasetRestApi.get.User2"
+ "$ref": "#/components/schemas/DatasetRestApi.get.User1"
},
"changed_on": {
"format": "date-time",
@@ -5034,6 +5618,10 @@
"name": {
"readOnly": true
},
+ "normalize_columns": {
+ "nullable": true,
+ "type": "boolean"
+ },
"offset": {
"nullable": true,
"type": "integer"
@@ -5042,7 +5630,7 @@
"readOnly": true
},
"owners": {
- "$ref": "#/components/schemas/DatasetRestApi.get.User1"
+ "$ref": "#/components/schemas/DatasetRestApi.get.AppleUser"
},
"schema": {
"maxLength": 255,
@@ -5077,11 +5665,39 @@
"readOnly": true
}
},
- "required": ["columns", "database", "metrics", "table_name"],
+ "required": [
+ "columns",
+ "database",
+ "metrics",
+ "table_name"
+ ],
+ "type": "object"
+ },
+ "DatasetRestApi.get.AppleUser": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"DatasetRestApi.get.Database": {
"properties": {
+ "allow_multi_catalog": {
+ "readOnly": true
+ },
"backend": {
"readOnly": true
},
@@ -5093,7 +5709,9 @@
"type": "integer"
}
},
- "required": ["database_name"],
+ "required": [
+ "database_name"
+ ],
"type": "object"
},
"DatasetRestApi.get.SqlMetric": {
@@ -5151,7 +5769,10 @@
"type": "string"
}
},
- "required": ["expression", "metric_name"],
+ "required": [
+ "expression",
+ "metric_name"
+ ],
"type": "object"
},
"DatasetRestApi.get.TableColumn": {
@@ -5229,7 +5850,9 @@
"type": "string"
}
},
- "required": ["column_name"],
+ "required": [
+ "column_name"
+ ],
"type": "object"
},
"DatasetRestApi.get.User": {
@@ -5243,7 +5866,10 @@
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"DatasetRestApi.get.User1": {
@@ -5252,35 +5878,26 @@
"maxLength": 64,
"type": "string"
},
- "id": {
- "type": "integer"
- },
"last_name": {
"maxLength": 64,
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
- "DatasetRestApi.get.User2": {
+ "DatasetRestApi.get_list": {
"properties": {
- "first_name": {
- "maxLength": 64,
+ "catalog": {
+ "maxLength": 256,
+ "nullable": true,
"type": "string"
},
- "last_name": {
- "maxLength": 64,
- "type": "string"
- }
- },
- "required": ["first_name", "last_name"],
- "type": "object"
- },
- "DatasetRestApi.get_list": {
- "properties": {
"changed_by": {
- "$ref": "#/components/schemas/DatasetRestApi.get_list.User1"
+ "$ref": "#/components/schemas/DatasetRestApi.get_list.User"
},
"changed_by_name": {
"readOnly": true
@@ -5319,7 +5936,7 @@
"readOnly": true
},
"owners": {
- "$ref": "#/components/schemas/DatasetRestApi.get_list.User"
+ "$ref": "#/components/schemas/DatasetRestApi.get_list.AppleUser"
},
"schema": {
"maxLength": 255,
@@ -5335,55 +5952,79 @@
"type": "string"
}
},
- "required": ["database", "table_name"],
+ "required": [
+ "database",
+ "table_name"
+ ],
"type": "object"
},
- "DatasetRestApi.get_list.Database": {
+ "DatasetRestApi.get_list.AppleUser": {
"properties": {
- "database_name": {
- "maxLength": 250,
+ "first_name": {
+ "maxLength": 64,
"type": "string"
},
"id": {
"type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
}
},
- "required": ["database_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
- "DatasetRestApi.get_list.User": {
+ "DatasetRestApi.get_list.Database": {
"properties": {
- "first_name": {
- "maxLength": 64,
+ "database_name": {
+ "maxLength": 250,
"type": "string"
},
"id": {
"type": "integer"
- },
- "last_name": {
- "maxLength": 64,
- "type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "database_name"
+ ],
"type": "object"
},
- "DatasetRestApi.get_list.User1": {
+ "DatasetRestApi.get_list.User": {
"properties": {
"first_name": {
"maxLength": 64,
"type": "string"
},
+ "id": {
+ "type": "integer"
+ },
"last_name": {
"maxLength": 64,
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "first_name",
+ "last_name"
+ ],
"type": "object"
},
"DatasetRestApi.post": {
"properties": {
+ "always_filter_main_dttm": {
+ "default": false,
+ "type": "boolean"
+ },
+ "catalog": {
+ "maxLength": 250,
+ "minLength": 0,
+ "nullable": true,
+ "type": "string"
+ },
"database": {
"type": "integer"
},
@@ -5395,6 +6036,10 @@
"nullable": true,
"type": "boolean"
},
+ "normalize_columns": {
+ "default": false,
+ "type": "boolean"
+ },
"owners": {
"items": {
"type": "integer"
@@ -5417,15 +6062,28 @@
"type": "string"
}
},
- "required": ["database", "table_name"],
+ "required": [
+ "database",
+ "table_name"
+ ],
"type": "object"
},
"DatasetRestApi.put": {
"properties": {
+ "always_filter_main_dttm": {
+ "default": false,
+ "type": "boolean"
+ },
"cache_timeout": {
"nullable": true,
"type": "integer"
},
+ "catalog": {
+ "maxLength": 250,
+ "minLength": 0,
+ "nullable": true,
+ "type": "string"
+ },
"columns": {
"items": {
"$ref": "#/components/schemas/DatasetColumnsPut"
@@ -5479,6 +6137,10 @@
},
"type": "array"
},
+ "normalize_columns": {
+ "nullable": true,
+ "type": "boolean"
+ },
"offset": {
"nullable": true,
"type": "integer"
@@ -5514,6 +6176,11 @@
},
"Datasource": {
"properties": {
+ "catalog": {
+ "description": "Datasource catalog",
+ "nullable": true,
+ "type": "string"
+ },
"database_name": {
"description": "Datasource name",
"type": "string"
@@ -5525,7 +6192,6 @@
"datasource_type": {
"description": "The type of dataset/datasource identified on `datasource_id`.",
"enum": [
- "sl_table",
"table",
"dataset",
"query",
@@ -5539,7 +6205,9 @@
"type": "string"
}
},
- "required": ["datasource_type"],
+ "required": [
+ "datasource_type"
+ ],
"type": "object"
},
"DistincResponseSchema": {
@@ -5575,7 +6243,9 @@
"type": "array"
}
},
- "required": ["allowed_domains"],
+ "required": [
+ "allowed_domains"
+ ],
"type": "object"
},
"EmbeddedDashboardResponseSchema": {
@@ -5638,18 +6308,44 @@
},
"type": "object"
},
- "EstimateQueryCostSchema": {
+ "EngineInformation": {
"properties": {
- "database_id": {
- "description": "The database id",
- "type": "integer"
+ "disable_ssh_tunneling": {
+ "description": "SSH tunnel is not available to the database",
+ "type": "boolean"
},
- "schema": {
- "description": "The database schema",
- "nullable": true,
- "type": "string"
+ "supports_dynamic_catalog": {
+ "description": "The database supports multiple catalogs in a single connection",
+ "type": "boolean"
},
- "sql": {
+ "supports_file_upload": {
+ "description": "Users can upload files to the database",
+ "type": "boolean"
+ },
+ "supports_oauth2": {
+ "description": "The database supports OAuth2",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "EstimateQueryCostSchema": {
+ "properties": {
+ "catalog": {
+ "description": "The database catalog",
+ "nullable": true,
+ "type": "string"
+ },
+ "database_id": {
+ "description": "The database id",
+ "type": "integer"
+ },
+ "schema": {
+ "description": "The database schema",
+ "nullable": true,
+ "type": "string"
+ },
+ "sql": {
"description": "The SQL query to estimate",
"type": "string"
},
@@ -5658,11 +6354,124 @@
"type": "object"
}
},
- "required": ["database_id", "sql"],
+ "required": [
+ "database_id",
+ "sql"
+ ],
+ "type": "object"
+ },
+ "ExcelMetadataUploadFilePostSchema": {
+ "properties": {
+ "file": {
+ "description": "The file to upload",
+ "format": "binary",
+ "type": "string"
+ },
+ "header_row": {
+ "description": "Row containing the headers to use as column names(0 is first line of data). Leave empty if there is no header row.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "file"
+ ],
+ "type": "object"
+ },
+ "ExcelUploadPostSchema": {
+ "properties": {
+ "already_exists": {
+ "default": "fail",
+ "description": "What to do if the table already exists accepts: fail, replace, append",
+ "enum": [
+ "fail",
+ "replace",
+ "append"
+ ],
+ "type": "string"
+ },
+ "column_dates": {
+ "description": "A list of column names that should be parsed as dates. Example: date,timestamp",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "columns_read": {
+ "description": "A List of the column names that should be read",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dataframe_index": {
+ "description": "Write dataframe index as a column.",
+ "type": "boolean"
+ },
+ "decimal_character": {
+ "description": "Character to recognize as decimal point. Default is '.'",
+ "type": "string"
+ },
+ "file": {
+ "description": "The Excel file to upload",
+ "format": "binary",
+ "type": "string"
+ },
+ "header_row": {
+ "description": "Row containing the headers to use as column names(0 is first line of data). Leave empty if there is no header row.",
+ "type": "integer"
+ },
+ "index_column": {
+ "description": "Column to use as the row labels of the dataframe. Leave empty if no index column",
+ "type": "string"
+ },
+ "index_label": {
+ "description": "Index label for index column.",
+ "type": "string"
+ },
+ "null_values": {
+ "description": "A list of strings that should be treated as null. Examples: '' for empty strings, 'None', 'N/A',Warning: Hive database supports only a single value",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "rows_to_read": {
+ "description": "Number of rows to read from the file. If None, reads all rows.",
+ "minimum": 1,
+ "nullable": true,
+ "type": "integer"
+ },
+ "schema": {
+ "description": "The schema to upload the data file to.",
+ "type": "string"
+ },
+ "sheet_name": {
+ "description": "Strings used for sheet names (default is the first sheet).",
+ "type": "string"
+ },
+ "skip_rows": {
+ "description": "Number of rows to skip at start of file.",
+ "type": "integer"
+ },
+ "table_name": {
+ "description": "The name of the table to be created/appended",
+ "maxLength": 10000,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "file",
+ "table_name"
+ ],
"type": "object"
},
"ExecutePayloadSchema": {
"properties": {
+ "catalog": {
+ "nullable": true,
+ "type": "string"
+ },
"client_id": {
"nullable": true,
"type": "string"
@@ -5718,7 +6527,10 @@
"type": "string"
}
},
- "required": ["database_id", "sql"],
+ "required": [
+ "database_id",
+ "sql"
+ ],
"type": "object"
},
"ExploreContextSchema": {
@@ -5756,7 +6568,9 @@
"type": "array"
}
},
- "required": ["formData"],
+ "required": [
+ "formData"
+ ],
"type": "object"
},
"FormDataPostSchema": {
@@ -5772,7 +6586,6 @@
"datasource_type": {
"description": "The datasource type",
"enum": [
- "sl_table",
"table",
"dataset",
"query",
@@ -5786,7 +6599,11 @@
"type": "string"
}
},
- "required": ["datasource_id", "datasource_type", "form_data"],
+ "required": [
+ "datasource_id",
+ "datasource_type",
+ "form_data"
+ ],
"type": "object"
},
"FormDataPutSchema": {
@@ -5802,7 +6619,6 @@
"datasource_type": {
"description": "The datasource type",
"enum": [
- "sl_table",
"table",
"dataset",
"query",
@@ -5816,7 +6632,11 @@
"type": "string"
}
},
- "required": ["datasource_id", "datasource_type", "form_data"],
+ "required": [
+ "datasource_id",
+ "datasource_type",
+ "form_data"
+ ],
"type": "object"
},
"GetFavStarIdsSchema": {
@@ -5833,10 +6653,25 @@
},
"GetOrCreateDatasetSchema": {
"properties": {
+ "always_filter_main_dttm": {
+ "default": false,
+ "type": "boolean"
+ },
+ "catalog": {
+ "description": "The catalog the table belongs to",
+ "maxLength": 250,
+ "minLength": 0,
+ "nullable": true,
+ "type": "string"
+ },
"database_id": {
"description": "ID of database table belongs to",
"type": "integer"
},
+ "normalize_columns": {
+ "default": false,
+ "type": "boolean"
+ },
"schema": {
"description": "The schema the table belongs to",
"maxLength": 250,
@@ -5853,7 +6688,10 @@
"type": "string"
}
},
- "required": ["database_id", "table_name"],
+ "required": [
+ "database_id",
+ "table_name"
+ ],
"type": "object"
},
"GuestTokenCreate": {
@@ -5874,1435 +6712,2080 @@
"$ref": "#/components/schemas/User2"
}
},
- "required": ["resources", "rls"],
+ "required": [
+ "resources",
+ "rls"
+ ],
"type": "object"
},
- "LogRestApi.get": {
+ "IASLoginTokenRequestSchema": {
"properties": {
- "action": {
- "maxLength": 512,
+ "access_token": {
+ "description": "IAS Access token. Can be requested by adding `token` to the `responseTypes`.",
"nullable": true,
"type": "string"
},
- "dashboard_id": {
- "nullable": true,
- "type": "integer"
- },
- "dttm": {
- "format": "date-time",
+ "client_id": {
+ "description": "IAS client id. Only needed if `refresh_token` is provided.",
"nullable": true,
"type": "string"
},
- "duration_ms": {
- "nullable": true,
- "type": "integer"
- },
- "json": {
+ "client_secret": {
+ "description": "IAS client secret. Only needed if `refresh_token` and `client_id` is provided.",
"nullable": true,
"type": "string"
},
- "referrer": {
- "maxLength": 1024,
- "nullable": true,
+ "id_token": {
+ "description": "IAS ID token. Can be requested by adding `id_token` to the `responseTypes`. The following scopes should be added:`iam:ds:groups`, `corpds:ds:username`, `corpds:ds:firstName`, `corpds:ds:lastName`, `corpds:ds:email`, `corpds:ds:uidNumber`, `iam:ds:explicitgroups`.",
"type": "string"
},
- "slice_id": {
- "nullable": true,
- "type": "integer"
- },
- "user": {
- "$ref": "#/components/schemas/LogRestApi.get.User"
- },
- "user_id": {
+ "refresh_token": {
+ "description": "IAS refresh token. This can be requested by adding `offline` to `scopes`. To be able to refresh the token, the IAS `client_id` and `client_secret` need to be added, as the same client needs to be used for refreshing as logging in.",
"nullable": true,
- "type": "integer"
+ "type": "string"
}
},
+ "required": [
+ "id_token"
+ ],
"type": "object"
},
- "LogRestApi.get.User": {
+ "IASLoginTokenResponseSchema": {
"properties": {
- "username": {
- "maxLength": 64,
+ "access_token": {
+ "description": "Access that can be used access the Superset API",
+ "type": "string"
+ },
+ "refresh_token": {
+ "description": "Refresh token that can be used to refresh the `access_token`",
"type": "string"
}
},
- "required": ["username"],
+ "required": [
+ "access_token"
+ ],
"type": "object"
},
- "LogRestApi.get_list": {
+ "IASProfileResponse": {
"properties": {
- "action": {
- "maxLength": 512,
- "nullable": true,
- "type": "string"
- },
- "dashboard_id": {
- "nullable": true,
- "type": "integer"
- },
- "dttm": {
- "format": "date-time",
- "nullable": true,
- "type": "string"
- },
- "duration_ms": {
- "nullable": true,
- "type": "integer"
- },
- "json": {
- "nullable": true,
+ "client_id": {
+ "description": "The client id",
"type": "string"
},
- "referrer": {
- "maxLength": 1024,
- "nullable": true,
+ "profile": {
+ "description": "The IAS profile",
"type": "string"
},
- "slice_id": {
- "nullable": true,
- "type": "integer"
- },
- "user": {
- "$ref": "#/components/schemas/LogRestApi.get_list.User"
- },
- "user_id": {
- "nullable": true,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "LogRestApi.get_list.User": {
- "properties": {
- "username": {
- "maxLength": 64,
+ "scope": {
+ "description": "The scope of the client",
"type": "string"
}
},
- "required": ["username"],
+ "required": [
+ "client_id",
+ "profile"
+ ],
"type": "object"
},
- "LogRestApi.post": {
+ "IASProfilesResponseSchema": {
"properties": {
- "id": {
- "type": "integer"
+ "result": {
+ "description": "A list of all available IAS profiles",
+ "items": {
+ "$ref": "#/components/schemas/IASProfileResponse"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "LogRestApi.put": {
+ "IASTokenResponse": {
"properties": {
- "action": {
- "maxLength": 512,
- "nullable": true,
+ "access_token": {
+ "description": "The access token",
"type": "string"
},
- "dttm": {
- "format": "date-time",
- "nullable": true,
- "type": "string"
+ "has_client_credentials": {
+ "description": "Are the original client credentials available or not",
+ "type": "boolean"
},
- "json": {
- "nullable": true,
+ "has_refresh_token": {
+ "description": "Is there a refresh token available or not",
+ "type": "boolean"
+ },
+ "ias_profile": {
+ "description": "The IAS profile",
"type": "string"
},
- "user": {
- "nullable": true
+ "id_token": {
+ "description": "The id token",
+ "type": "string"
}
},
+ "required": [
+ "has_client_credentials",
+ "has_refresh_token",
+ "ias_profile",
+ "id_token"
+ ],
"type": "object"
},
- "QueryExecutionResponseSchema": {
+ "IASTokensResponseSchema": {
"properties": {
- "columns": {
- "items": {
- "type": "object"
- },
- "type": "array"
- },
- "data": {
- "items": {
- "type": "object"
- },
- "type": "array"
- },
- "expanded_columns": {
- "items": {
- "type": "object"
- },
- "type": "array"
- },
- "query": {
- "$ref": "#/components/schemas/QueryResult"
- },
- "query_id": {
- "type": "integer"
- },
- "selected_columns": {
+ "result": {
+ "description": "A list of all requested tokens",
"items": {
- "type": "object"
+ "$ref": "#/components/schemas/IASTokenResponse"
},
"type": "array"
- },
- "status": {
- "type": "string"
}
},
"type": "object"
},
- "QueryRestApi.get": {
+ "ImportV1Database": {
"properties": {
- "changed_on": {
- "format": "date-time",
- "nullable": true,
- "type": "string"
+ "allow_csv_upload": {
+ "type": "boolean"
},
- "client_id": {
- "maxLength": 11,
- "type": "string"
+ "allow_ctas": {
+ "type": "boolean"
},
- "database": {
- "$ref": "#/components/schemas/QueryRestApi.get.Database"
+ "allow_cvas": {
+ "type": "boolean"
},
- "end_result_backend_time": {
- "nullable": true,
- "type": "number"
+ "allow_dml": {
+ "type": "boolean"
},
- "end_time": {
- "nullable": true,
- "type": "number"
+ "allow_run_async": {
+ "type": "boolean"
},
- "error_message": {
+ "cache_timeout": {
"nullable": true,
+ "type": "integer"
+ },
+ "database_name": {
"type": "string"
},
- "executed_sql": {
+ "expose_in_sqllab": {
+ "type": "boolean"
+ },
+ "external_url": {
"nullable": true,
"type": "string"
},
- "id": {
- "type": "integer"
+ "extra": {
+ "$ref": "#/components/schemas/ImportV1DatabaseExtra"
},
- "limit": {
- "nullable": true,
- "type": "integer"
+ "impersonate_user": {
+ "type": "boolean"
},
- "progress": {
+ "is_managed_externally": {
"nullable": true,
- "type": "integer"
+ "type": "boolean"
},
- "results_key": {
- "maxLength": 64,
+ "password": {
"nullable": true,
"type": "string"
},
- "rows": {
- "nullable": true,
- "type": "integer"
+ "sqlalchemy_uri": {
+ "type": "string"
},
- "schema": {
- "maxLength": 256,
- "nullable": true,
+ "ssh_tunnel": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/DatabaseSSHTunnel"
+ }
+ ],
+ "nullable": true
+ },
+ "uuid": {
+ "format": "uuid",
"type": "string"
},
- "select_as_cta": {
- "nullable": true,
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "database_name",
+ "sqlalchemy_uri",
+ "uuid",
+ "version"
+ ],
+ "type": "object"
+ },
+ "ImportV1DatabaseExtra": {
+ "properties": {
+ "allow_multi_catalog": {
"type": "boolean"
},
- "select_as_cta_used": {
- "nullable": true,
+ "allows_virtual_table_explore": {
"type": "boolean"
},
- "select_sql": {
- "nullable": true,
- "type": "string"
+ "cancel_query_on_windows_unload": {
+ "type": "boolean"
},
- "sql": {
- "nullable": true,
- "type": "string"
+ "cost_estimate_enabled": {
+ "type": "boolean"
},
- "sql_editor_id": {
- "maxLength": 256,
- "nullable": true,
- "type": "string"
+ "disable_data_preview": {
+ "type": "boolean"
},
- "start_running_time": {
- "nullable": true,
- "type": "number"
+ "disable_drill_to_detail": {
+ "type": "boolean"
},
- "start_time": {
- "nullable": true,
- "type": "number"
+ "engine_params": {
+ "additionalProperties": {},
+ "type": "object"
},
- "status": {
- "maxLength": 16,
- "nullable": true,
- "type": "string"
+ "metadata_cache_timeout": {
+ "additionalProperties": {
+ "type": "integer"
+ },
+ "type": "object"
},
- "tab_name": {
- "maxLength": 256,
- "nullable": true,
- "type": "string"
+ "metadata_params": {
+ "additionalProperties": {},
+ "type": "object"
},
- "tmp_schema_name": {
- "maxLength": 256,
- "nullable": true,
- "type": "string"
+ "schemas_allowed_for_csv_upload": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "tmp_table_name": {
- "maxLength": 256,
+ "version": {
"nullable": true,
"type": "string"
- },
- "tracking_url": {
- "readOnly": true
}
},
- "required": ["client_id", "database"],
"type": "object"
},
- "QueryRestApi.get.Database": {
+ "LakehouseCatalog": {
"properties": {
- "id": {
+ "database_id": {
+ "description": "The numerical id of the database",
"type": "integer"
- }
- },
- "type": "object"
- },
- "QueryRestApi.get_list": {
- "properties": {
- "changed_on": {
- "format": "date-time",
- "type": "string"
- },
- "database": {
- "$ref": "#/components/schemas/Database1"
- },
- "end_time": {
- "type": "number"
},
- "executed_sql": {
+ "database_name": {
+ "description": "The name of the database",
"type": "string"
},
"id": {
+ "description": "The numerical id of the catalog",
"type": "integer"
},
- "rows": {
- "type": "integer"
- },
- "schema": {
+ "name": {
+ "description": "The name of the catalog",
"type": "string"
},
- "sql": {
+ "sqlalchemy_uri": {
+ "description": "The SQLAlchemy URI",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LakehouseConnectRequestSchema": {
+ "properties": {
+ "catalogs": {
+ "description": "A list of catalogs to connect to. If empty or undefined, connect all available catalogs.",
+ "example": [
+ "my_catalog"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "nullable": true,
+ "type": "array"
},
- "sql_tables": {
- "readOnly": true
+ "database_names": {
+ "description": "Custom catalog-database name mappings. If undefined, the default naming convention will be used",
+ "example": {
+ "my_catalog": "my_database"
+ },
+ "nullable": true,
+ "type": "object"
},
- "start_time": {
- "type": "number"
+ "dry_run": {
+ "description": "Should the task be executed in dry run mode. Useful for testing.",
+ "example": false,
+ "type": "boolean"
},
- "status": {
+ "engine_type": {
+ "description": "The type of the engine (only trino is currently supported)",
+ "enum": [
+ "trino"
+ ],
+ "example": "trino",
"type": "string"
},
- "tab_name": {
+ "engine_url": {
+ "description": "The URL to the engine",
+ "example": "https://myengine.corp.apple.com",
"type": "string"
},
- "tmp_table_name": {
+ "environment": {
+ "description": "Prod or Int",
+ "enum": [
+ "int",
+ "prod"
+ ],
+ "example": "int",
"type": "string"
},
- "tracking_url": {
+ "name": {
+ "description": "The name of the Lakehouse (subject to change over time). If left undefined, use lakehouse id",
+ "example": "My Lakehouse",
+ "nullable": true,
"type": "string"
},
- "user": {
- "$ref": "#/components/schemas/User"
+ "superset_url": {
+ "description": "The URL of the Superset instance connecting to",
+ "example": "http://localhost:8088",
+ "type": "string"
}
},
+ "required": [
+ "engine_type",
+ "engine_url",
+ "environment",
+ "superset_url"
+ ],
"type": "object"
},
- "QueryRestApi.post": {
+ "LakehouseConnectResponseSchema": {
"properties": {
- "id": {
- "type": "integer"
+ "task_id": {
+ "description": "The id of the connection task",
+ "type": "string"
}
},
"type": "object"
},
- "QueryRestApi.put": {
+ "LakehouseConnectResultResponseSchema": {
"properties": {
- "id": {
- "type": "integer"
+ "existing_catalogs": {
+ "description": "A list of connected catalogs before the connect operation",
+ "items": {
+ "description": "Catalogs",
+ "items": {
+ "$ref": "#/components/schemas/LakehouseCatalog"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "lakehouse": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/LakehouseGetResponseSchema"
+ }
+ ],
+ "description": "The connected Lakehouse",
+ "nullable": true
+ },
+ "message": {
+ "description": "A message to provide additional context on what has happened",
+ "type": "string"
+ },
+ "new_catalogs": {
+ "description": "A list of newly connected catalogs after the connect operation",
+ "items": {
+ "description": "Catalogs",
+ "items": {
+ "$ref": "#/components/schemas/LakehouseCatalog"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "The status of the task",
+ "enum": [
+ "scheduled",
+ "running",
+ "completed",
+ "failed",
+ "reconnect_failed",
+ "cancelled"
+ ],
+ "type": "string"
}
},
+ "required": [
+ "lakehouse"
+ ],
"type": "object"
},
- "QueryResult": {
+ "LakehouseConnectStatusResponseSchema": {
"properties": {
- "changed_on": {
- "format": "date-time",
+ "message": {
+ "description": "A message to provide additional context on what has happened",
"type": "string"
},
- "ctas": {
- "type": "boolean"
- },
- "db": {
+ "status": {
+ "description": "The status of the task",
+ "enum": [
+ "scheduled",
+ "running",
+ "completed",
+ "failed",
+ "reconnect_failed",
+ "cancelled"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LakehouseDatasetListResponseSchema": {
+ "properties": {
+ "name": {
+ "description": "The name of the dataset",
"type": "string"
},
- "dbId": {
- "type": "integer"
- },
- "endDttm": {
- "type": "number"
- },
- "errorMessage": {
+ "schema": {
+ "description": "The schema",
"nullable": true,
"type": "string"
},
- "executedSql": {
+ "sql": {
+ "description": "The virtual dataset query",
"type": "string"
- },
- "extra": {
- "type": "object"
- },
- "id": {
+ }
+ },
+ "required": [
+ "name",
+ "sql"
+ ],
+ "type": "object"
+ },
+ "LakehouseDatasetRequestSchema": {
+ "properties": {
+ "catalog": {
+ "description": "The catalog. If left empty, uses an arbitrary connected catalog.",
+ "nullable": true,
"type": "string"
},
- "limit": {
- "type": "integer"
- },
- "limitingFactor": {
+ "lakehouse_id": {
+ "description": "Deprecated, not used for anything",
"type": "string"
},
- "progress": {
- "type": "integer"
- },
- "queryId": {
- "type": "integer"
- },
- "resultsKey": {
+ "name": {
+ "description": "The name of the dataset to be created",
"type": "string"
},
- "rows": {
- "type": "integer"
+ "overwrite": {
+ "default": false,
+ "description": "Should the virtual dataset be overwritten if it already exists",
+ "type": "boolean"
},
"schema": {
+ "description": "The schema",
+ "nullable": true,
"type": "string"
},
- "serverId": {
- "type": "integer"
- },
"sql": {
+ "description": "The virtual dataset query",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "sql"
+ ],
+ "type": "object"
+ },
+ "LakehouseDatasetResponseSchema": {
+ "properties": {
+ "url": {
+ "description": "The url for exploring the virtual dataset",
"type": "string"
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "type": "object"
+ },
+ "LakehouseDisconnectResponseSchema": {
+ "properties": {
+ "lakehouse": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/LakehouseGetResponseSchema"
+ }
+ ],
+ "description": "A list of disconnected lakehouses"
+ }
+ },
+ "type": "object"
+ },
+ "LakehouseGetListResponseSchema": {
+ "properties": {
+ "lakehouses": {
+ "description": "A list of connected lakehouses",
+ "items": {
+ "$ref": "#/components/schemas/LakehouseGetResponseSchema"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LakehouseGetResponseSchema": {
+ "properties": {
+ "catalogs": {
+ "description": "A list of connected catalogs",
+ "items": {
+ "description": "Catalogs",
+ "items": {
+ "$ref": "#/components/schemas/LakehouseCatalog"
+ },
+ "type": "array"
+ },
+ "type": "array"
},
- "sqlEditorId": {
+ "engine_url": {
+ "description": "The URL uf the engine",
"type": "string"
},
- "startDttm": {
- "type": "number"
+ "id": {
+ "description": "The unique id of the Lakehouse",
+ "type": "string"
},
- "state": {
+ "name": {
"type": "string"
},
- "tab": {
+ "superset_url": {
+ "description": "The URL uf the Superset instance",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LogRestApi.get": {
+ "properties": {
+ "action": {
+ "maxLength": 512,
+ "nullable": true,
"type": "string"
},
- "tempSchema": {
+ "dashboard_id": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "dttm": {
+ "format": "date-time",
"nullable": true,
"type": "string"
},
- "tempTable": {
+ "duration_ms": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "json": {
"nullable": true,
"type": "string"
},
- "trackingUrl": {
+ "referrer": {
+ "maxLength": 1024,
"nullable": true,
"type": "string"
},
+ "slice_id": {
+ "nullable": true,
+ "type": "integer"
+ },
"user": {
- "type": "string"
+ "$ref": "#/components/schemas/LogRestApi.get.AppleUser"
},
- "userId": {
+ "user_id": {
+ "nullable": true,
"type": "integer"
}
},
"type": "object"
},
- "RLSRestApi.get": {
+ "LogRestApi.get.AppleUser": {
"properties": {
- "clause": {
- "description": "clause_description",
+ "username": {
+ "maxLength": 64,
"type": "string"
- },
- "description": {
- "description": "description_description",
+ }
+ },
+ "required": [
+ "username"
+ ],
+ "type": "object"
+ },
+ "LogRestApi.get_list": {
+ "properties": {
+ "action": {
+ "maxLength": 512,
+ "nullable": true,
"type": "string"
},
- "filter_type": {
- "description": "filter_type_description",
- "enum": ["Regular", "Base"],
- "type": "string"
+ "dashboard_id": {
+ "nullable": true,
+ "type": "integer"
},
- "group_key": {
- "description": "group_key_description",
+ "dttm": {
+ "format": "date-time",
+ "nullable": true,
"type": "string"
},
- "id": {
- "description": "id_description",
+ "duration_ms": {
+ "nullable": true,
"type": "integer"
},
- "name": {
- "description": "name_description",
+ "json": {
+ "nullable": true,
"type": "string"
},
- "roles": {
- "items": {
- "$ref": "#/components/schemas/Roles1"
- },
- "type": "array"
+ "referrer": {
+ "maxLength": 1024,
+ "nullable": true,
+ "type": "string"
},
- "tables": {
- "items": {
- "$ref": "#/components/schemas/Tables"
- },
- "type": "array"
+ "slice_id": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "user": {
+ "$ref": "#/components/schemas/LogRestApi.get_list.AppleUser"
+ },
+ "user_id": {
+ "nullable": true,
+ "type": "integer"
}
},
"type": "object"
},
- "RLSRestApi.get_list": {
+ "LogRestApi.get_list.AppleUser": {
"properties": {
- "changed_on_delta_humanized": {
- "readOnly": true
- },
- "clause": {
- "description": "clause_description",
+ "username": {
+ "maxLength": 64,
"type": "string"
- },
- "description": {
- "description": "description_description",
+ }
+ },
+ "required": [
+ "username"
+ ],
+ "type": "object"
+ },
+ "LogRestApi.post": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "LogRestApi.put": {
+ "properties": {
+ "action": {
+ "maxLength": 512,
+ "nullable": true,
"type": "string"
},
- "filter_type": {
- "description": "filter_type_description",
- "enum": ["Regular", "Base"],
+ "dttm": {
+ "format": "date-time",
+ "nullable": true,
"type": "string"
},
- "group_key": {
- "description": "group_key_description",
+ "json": {
+ "nullable": true,
"type": "string"
},
- "id": {
- "description": "id_description",
- "type": "integer"
+ "user": {
+ "nullable": true
+ }
+ },
+ "type": "object"
+ },
+ "QueryExecutionResponseSchema": {
+ "properties": {
+ "columns": {
+ "items": {
+ "type": "object"
+ },
+ "type": "array"
},
- "name": {
- "description": "name_description",
- "type": "string"
+ "data": {
+ "items": {
+ "type": "object"
+ },
+ "type": "array"
},
- "roles": {
+ "expanded_columns": {
"items": {
- "$ref": "#/components/schemas/Roles1"
+ "type": "object"
},
"type": "array"
},
- "tables": {
+ "query": {
+ "$ref": "#/components/schemas/QueryResult"
+ },
+ "query_id": {
+ "type": "integer"
+ },
+ "selected_columns": {
"items": {
- "$ref": "#/components/schemas/Tables"
+ "type": "object"
},
"type": "array"
+ },
+ "status": {
+ "type": "string"
}
},
"type": "object"
},
- "RLSRestApi.post": {
+ "QueryRestApi.get": {
"properties": {
- "clause": {
- "description": "clause_description",
- "type": "string"
- },
- "description": {
- "description": "description_description",
+ "changed_on": {
+ "format": "date-time",
"nullable": true,
"type": "string"
},
- "filter_type": {
- "description": "filter_type_description",
- "enum": ["Regular", "Base"],
+ "client_id": {
+ "maxLength": 11,
"type": "string"
},
- "group_key": {
- "description": "group_key_description",
+ "database": {
+ "$ref": "#/components/schemas/QueryRestApi.get.Database"
+ },
+ "end_result_backend_time": {
+ "nullable": true,
+ "type": "number"
+ },
+ "end_time": {
+ "nullable": true,
+ "type": "number"
+ },
+ "error_message": {
"nullable": true,
"type": "string"
},
- "name": {
- "description": "name_description",
- "maxLength": 255,
- "minLength": 1,
+ "executed_sql": {
+ "nullable": true,
"type": "string"
},
- "roles": {
- "description": "roles_description",
- "items": {
- "type": "integer"
- },
- "type": "array"
+ "id": {
+ "type": "integer"
},
- "tables": {
- "description": "tables_description",
- "items": {
- "type": "integer"
- },
- "minItems": 1,
- "type": "array"
- }
- },
- "required": ["clause", "filter_type", "name", "roles", "tables"],
- "type": "object"
- },
- "RLSRestApi.put": {
- "properties": {
- "clause": {
- "description": "clause_description",
+ "limit": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "progress": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "results_key": {
+ "maxLength": 64,
+ "nullable": true,
"type": "string"
},
- "description": {
- "description": "description_description",
+ "rows": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "schema": {
+ "maxLength": 256,
"nullable": true,
"type": "string"
},
- "filter_type": {
- "description": "filter_type_description",
- "enum": ["Regular", "Base"],
+ "select_as_cta": {
+ "nullable": true,
+ "type": "boolean"
+ },
+ "select_as_cta_used": {
+ "nullable": true,
+ "type": "boolean"
+ },
+ "select_sql": {
+ "nullable": true,
"type": "string"
},
- "group_key": {
- "description": "group_key_description",
+ "sql": {
"nullable": true,
"type": "string"
},
- "name": {
- "description": "name_description",
- "maxLength": 255,
- "minLength": 1,
+ "sql_editor_id": {
+ "maxLength": 256,
+ "nullable": true,
"type": "string"
},
- "roles": {
- "description": "roles_description",
- "items": {
- "type": "integer"
- },
- "type": "array"
+ "start_running_time": {
+ "nullable": true,
+ "type": "number"
},
- "tables": {
- "description": "tables_description",
- "items": {
- "type": "integer"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RecentActivity": {
- "properties": {
- "action": {
- "description": "Action taken describing type of activity",
- "type": "string"
+ "start_time": {
+ "nullable": true,
+ "type": "number"
},
- "item_title": {
- "description": "Title of item",
+ "status": {
+ "maxLength": 16,
+ "nullable": true,
"type": "string"
},
- "item_type": {
- "description": "Type of item, e.g. slice or dashboard",
+ "tab_name": {
+ "maxLength": 256,
+ "nullable": true,
"type": "string"
},
- "item_url": {
- "description": "URL to item",
+ "tmp_schema_name": {
+ "maxLength": 256,
+ "nullable": true,
"type": "string"
},
- "time": {
- "description": "Time of activity, in epoch milliseconds",
- "type": "number"
- },
- "time_delta_humanized": {
- "description": "Human-readable description of how long ago activity took place.",
+ "tmp_table_name": {
+ "maxLength": 256,
+ "nullable": true,
"type": "string"
+ },
+ "tracking_url": {
+ "readOnly": true
}
},
+ "required": [
+ "client_id",
+ "database"
+ ],
"type": "object"
},
- "RecentActivityResponseSchema": {
+ "QueryRestApi.get.Database": {
"properties": {
- "result": {
- "description": "A list of recent activity objects",
- "items": {
- "$ref": "#/components/schemas/RecentActivity"
- },
- "type": "array"
+ "id": {
+ "type": "integer"
}
},
"type": "object"
},
- "RecentActivitySchema": {
+ "QueryRestApi.get_list": {
"properties": {
- "action": {
- "description": "Action taken describing type of activity",
+ "changed_on": {
+ "format": "date-time",
"type": "string"
},
- "item_title": {
- "description": "Title of item",
+ "database": {
+ "$ref": "#/components/schemas/Database1"
+ },
+ "end_time": {
+ "type": "number"
+ },
+ "executed_sql": {
"type": "string"
},
- "item_type": {
- "description": "Type of item, e.g. slice or dashboard",
+ "id": {
+ "type": "integer"
+ },
+ "rows": {
+ "type": "integer"
+ },
+ "schema": {
"type": "string"
},
- "item_url": {
- "description": "URL to item",
+ "sql": {
"type": "string"
},
- "time": {
- "description": "Time of activity, in epoch milliseconds",
+ "sql_tables": {
+ "readOnly": true
+ },
+ "start_time": {
"type": "number"
},
- "time_delta_humanized": {
- "description": "Human-readable description of how long ago activity took place.",
+ "status": {
+ "type": "string"
+ },
+ "tab_name": {
+ "type": "string"
+ },
+ "tmp_table_name": {
+ "type": "string"
+ },
+ "tracking_url": {
"type": "string"
+ },
+ "user": {
+ "$ref": "#/components/schemas/User"
}
},
"type": "object"
},
- "RelatedResponseSchema": {
+ "QueryRestApi.post": {
"properties": {
- "count": {
- "description": "The total number of related values",
+ "id": {
"type": "integer"
- },
- "result": {
- "items": {
- "$ref": "#/components/schemas/RelatedResultResponse"
- },
- "type": "array"
}
},
"type": "object"
},
- "RelatedResultResponse": {
+ "QueryRestApi.put": {
"properties": {
- "extra": {
- "description": "The extra metadata for related item",
- "type": "object"
- },
- "text": {
- "description": "The related item string representation",
- "type": "string"
- },
- "value": {
- "description": "The related item identifier",
+ "id": {
"type": "integer"
}
},
"type": "object"
},
- "ReportExecutionLogRestApi.get": {
+ "QueryResult": {
"properties": {
- "end_dttm": {
+ "changed_on": {
"format": "date-time",
- "nullable": true,
"type": "string"
},
- "error_message": {
- "nullable": true,
+ "ctas": {
+ "type": "boolean"
+ },
+ "db": {
"type": "string"
},
- "id": {
+ "dbId": {
"type": "integer"
},
- "scheduled_dttm": {
- "format": "date-time",
+ "endDttm": {
+ "type": "number"
+ },
+ "errorMessage": {
+ "nullable": true,
"type": "string"
},
- "start_dttm": {
- "format": "date-time",
- "nullable": true,
+ "executedSql": {
"type": "string"
},
- "state": {
- "maxLength": 50,
- "type": "string"
+ "extra": {
+ "type": "object"
},
- "uuid": {
- "format": "uuid",
- "nullable": true,
+ "id": {
"type": "string"
},
- "value": {
- "nullable": true,
- "type": "number"
+ "limit": {
+ "type": "integer"
},
- "value_row_json": {
- "nullable": true,
+ "limitingFactor": {
"type": "string"
- }
- },
- "required": ["scheduled_dttm", "state"],
- "type": "object"
- },
- "ReportExecutionLogRestApi.get_list": {
- "properties": {
- "end_dttm": {
- "format": "date-time",
- "nullable": true,
+ },
+ "progress": {
+ "type": "integer"
+ },
+ "queryId": {
+ "type": "integer"
+ },
+ "resultsKey": {
"type": "string"
},
- "error_message": {
- "nullable": true,
+ "rows": {
+ "type": "integer"
+ },
+ "schema": {
"type": "string"
},
- "id": {
+ "serverId": {
"type": "integer"
},
- "scheduled_dttm": {
- "format": "date-time",
+ "sql": {
"type": "string"
},
- "start_dttm": {
- "format": "date-time",
- "nullable": true,
+ "sqlEditorId": {
"type": "string"
},
+ "startDttm": {
+ "type": "number"
+ },
"state": {
- "maxLength": 50,
"type": "string"
},
- "uuid": {
- "format": "uuid",
+ "tab": {
+ "type": "string"
+ },
+ "tempSchema": {
"nullable": true,
"type": "string"
},
- "value": {
+ "tempTable": {
"nullable": true,
- "type": "number"
+ "type": "string"
},
- "value_row_json": {
+ "trackingUrl": {
"nullable": true,
"type": "string"
- }
- },
- "required": ["scheduled_dttm", "state"],
- "type": "object"
- },
- "ReportExecutionLogRestApi.post": {
- "properties": {
- "id": {
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ReportExecutionLogRestApi.put": {
- "properties": {
- "id": {
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ReportRecipient": {
- "properties": {
- "recipient_config_json": {
- "$ref": "#/components/schemas/ReportRecipientConfigJSON"
},
- "type": {
- "description": "The recipient type, check spec for valid options",
- "enum": ["Email", "Slack"],
+ "user": {
"type": "string"
+ },
+ "userId": {
+ "type": "integer"
}
},
- "required": ["type"],
"type": "object"
},
- "ReportRecipientConfigJSON": {
+ "RLSRestApi.get": {
"properties": {
- "target": {
+ "clause": {
+ "description": "clause_description",
"type": "string"
- }
- },
- "type": "object"
- },
- "ReportScheduleRestApi.get": {
- "properties": {
- "active": {
- "nullable": true,
- "type": "boolean"
- },
- "chart": {
- "$ref": "#/components/schemas/ReportScheduleRestApi.get.Slice"
},
- "context_markdown": {
- "nullable": true,
+ "description": {
+ "description": "description_description",
"type": "string"
},
- "creation_method": {
- "maxLength": 255,
- "nullable": true,
+ "filter_type": {
+ "description": "filter_type_description",
+ "enum": [
+ "Regular",
+ "Base"
+ ],
"type": "string"
},
- "crontab": {
- "maxLength": 1000,
+ "group_key": {
+ "description": "group_key_description",
"type": "string"
},
- "custom_width": {
- "nullable": true,
+ "id": {
+ "description": "id_description",
"type": "integer"
},
- "dashboard": {
- "$ref": "#/components/schemas/ReportScheduleRestApi.get.Dashboard"
- },
- "database": {
- "$ref": "#/components/schemas/ReportScheduleRestApi.get.Database"
- },
- "description": {
- "nullable": true,
+ "name": {
+ "description": "name_description",
"type": "string"
},
- "extra": {
- "readOnly": true
- },
- "force_screenshot": {
- "nullable": true,
- "type": "boolean"
+ "roles": {
+ "items": {
+ "$ref": "#/components/schemas/Roles1"
+ },
+ "type": "array"
},
- "grace_period": {
- "nullable": true,
- "type": "integer"
+ "tables": {
+ "items": {
+ "$ref": "#/components/schemas/Tables"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RLSRestApi.get_list": {
+ "properties": {
+ "changed_by": {
+ "$ref": "#/components/schemas/User"
},
- "id": {
- "type": "integer"
+ "changed_on_delta_humanized": {
+ "readOnly": true
},
- "last_eval_dttm": {
- "format": "date-time",
- "nullable": true,
+ "clause": {
+ "description": "clause_description",
"type": "string"
},
- "last_state": {
- "maxLength": 50,
- "nullable": true,
+ "description": {
+ "description": "description_description",
"type": "string"
},
- "last_value": {
- "nullable": true,
- "type": "number"
+ "filter_type": {
+ "description": "filter_type_description",
+ "enum": [
+ "Regular",
+ "Base"
+ ],
+ "type": "string"
},
- "last_value_row_json": {
- "nullable": true,
+ "group_key": {
+ "description": "group_key_description",
"type": "string"
},
- "log_retention": {
- "nullable": true,
+ "id": {
+ "description": "id_description",
"type": "integer"
},
"name": {
- "maxLength": 150,
+ "description": "name_description",
"type": "string"
},
- "owners": {
- "$ref": "#/components/schemas/ReportScheduleRestApi.get.User"
- },
- "recipients": {
- "$ref": "#/components/schemas/ReportScheduleRestApi.get.ReportRecipients"
+ "roles": {
+ "items": {
+ "$ref": "#/components/schemas/Roles1"
+ },
+ "type": "array"
},
- "report_format": {
- "maxLength": 50,
- "nullable": true,
+ "tables": {
+ "items": {
+ "$ref": "#/components/schemas/Tables"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RLSRestApi.post": {
+ "properties": {
+ "clause": {
+ "description": "clause_description",
"type": "string"
},
- "sql": {
+ "description": {
+ "description": "description_description",
"nullable": true,
"type": "string"
},
- "timezone": {
- "maxLength": 100,
- "type": "string"
- },
- "type": {
- "maxLength": 50,
+ "filter_type": {
+ "description": "filter_type_description",
+ "enum": [
+ "Regular",
+ "Base"
+ ],
"type": "string"
},
- "validator_config_json": {
+ "group_key": {
+ "description": "group_key_description",
"nullable": true,
"type": "string"
},
- "validator_type": {
- "maxLength": 100,
- "nullable": true,
+ "name": {
+ "description": "name_description",
+ "maxLength": 255,
+ "minLength": 1,
"type": "string"
},
- "working_timeout": {
- "nullable": true,
- "type": "integer"
- }
+ "roles": {
+ "description": "roles_description",
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "tables": {
+ "description": "tables_description",
+ "items": {
+ "type": "integer"
+ },
+ "minItems": 1,
+ "type": "array"
+ }
},
- "required": ["crontab", "name", "recipients", "type"],
+ "required": [
+ "clause",
+ "filter_type",
+ "name",
+ "roles",
+ "tables"
+ ],
"type": "object"
},
- "ReportScheduleRestApi.get.Dashboard": {
+ "RLSRestApi.put": {
"properties": {
- "dashboard_title": {
- "maxLength": 500,
+ "clause": {
+ "description": "clause_description",
+ "type": "string"
+ },
+ "description": {
+ "description": "description_description",
"nullable": true,
"type": "string"
},
- "id": {
- "type": "integer"
+ "filter_type": {
+ "description": "filter_type_description",
+ "enum": [
+ "Regular",
+ "Base"
+ ],
+ "type": "string"
+ },
+ "group_key": {
+ "description": "group_key_description",
+ "nullable": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "name_description",
+ "maxLength": 255,
+ "minLength": 1,
+ "type": "string"
+ },
+ "roles": {
+ "description": "roles_description",
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "tables": {
+ "description": "tables_description",
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "ReportScheduleRestApi.get.Database": {
+ "RecentActivity": {
"properties": {
- "database_name": {
- "maxLength": 250,
+ "action": {
+ "description": "Action taken describing type of activity",
"type": "string"
},
- "id": {
- "type": "integer"
+ "item_title": {
+ "description": "Title of item",
+ "type": "string"
+ },
+ "item_type": {
+ "description": "Type of item, e.g. slice or dashboard",
+ "type": "string"
+ },
+ "item_url": {
+ "description": "URL to item",
+ "type": "string"
+ },
+ "time": {
+ "description": "Time of activity, in epoch milliseconds",
+ "type": "number"
+ },
+ "time_delta_humanized": {
+ "description": "Human-readable description of how long ago activity took place.",
+ "type": "string"
}
},
- "required": ["database_name"],
"type": "object"
},
- "ReportScheduleRestApi.get.ReportRecipients": {
+ "RecentActivityResponseSchema": {
"properties": {
- "id": {
- "type": "integer"
+ "result": {
+ "description": "A list of recent activity objects",
+ "items": {
+ "$ref": "#/components/schemas/RecentActivity"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RecentActivitySchema": {
+ "properties": {
+ "action": {
+ "description": "Action taken describing type of activity",
+ "type": "string"
},
- "recipient_config_json": {
- "nullable": true,
+ "item_title": {
+ "description": "Title of item",
"type": "string"
},
- "type": {
- "maxLength": 50,
+ "item_type": {
+ "description": "Type of item, e.g. slice or dashboard",
+ "type": "string"
+ },
+ "item_url": {
+ "description": "URL to item",
+ "type": "string"
+ },
+ "time": {
+ "description": "Time of activity, in epoch milliseconds",
+ "type": "number"
+ },
+ "time_delta_humanized": {
+ "description": "Human-readable description of how long ago activity took place.",
"type": "string"
}
},
- "required": ["type"],
"type": "object"
},
- "ReportScheduleRestApi.get.Slice": {
+ "RelatedResponseSchema": {
"properties": {
- "id": {
+ "count": {
+ "description": "The total number of related values",
"type": "integer"
},
- "slice_name": {
- "maxLength": 250,
- "nullable": true,
- "type": "string"
- },
- "viz_type": {
- "maxLength": 250,
- "nullable": true,
- "type": "string"
+ "result": {
+ "items": {
+ "$ref": "#/components/schemas/RelatedResultResponse"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "ReportScheduleRestApi.get.User": {
+ "RelatedResultResponse": {
"properties": {
- "first_name": {
- "maxLength": 64,
+ "extra": {
+ "description": "The extra metadata for related item",
+ "type": "object"
+ },
+ "text": {
+ "description": "The related item string representation",
"type": "string"
},
- "id": {
+ "value": {
+ "description": "The related item identifier",
"type": "integer"
- },
- "last_name": {
- "maxLength": 64,
- "type": "string"
}
},
- "required": ["first_name", "last_name"],
"type": "object"
},
- "ReportScheduleRestApi.get_list": {
+ "ReportExecutionLogRestApi.get": {
"properties": {
- "active": {
- "nullable": true,
- "type": "boolean"
- },
- "changed_by": {
- "$ref": "#/components/schemas/ReportScheduleRestApi.get_list.User2"
- },
- "changed_on": {
+ "end_dttm": {
"format": "date-time",
"nullable": true,
"type": "string"
},
- "changed_on_delta_humanized": {
- "readOnly": true
- },
- "chart_id": {
+ "error_message": {
"nullable": true,
- "type": "integer"
+ "type": "string"
},
- "created_by": {
- "$ref": "#/components/schemas/ReportScheduleRestApi.get_list.User"
+ "id": {
+ "type": "integer"
},
- "created_on": {
+ "scheduled_dttm": {
"format": "date-time",
- "nullable": true,
"type": "string"
},
- "creation_method": {
- "maxLength": 255,
+ "start_dttm": {
+ "format": "date-time",
"nullable": true,
"type": "string"
},
- "crontab": {
- "maxLength": 1000,
+ "state": {
+ "maxLength": 50,
"type": "string"
},
- "crontab_humanized": {
- "readOnly": true
+ "uuid": {
+ "format": "uuid",
+ "nullable": true,
+ "type": "string"
},
- "dashboard_id": {
+ "value": {
"nullable": true,
- "type": "integer"
+ "type": "number"
},
- "description": {
+ "value_row_json": {
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "scheduled_dttm",
+ "state"
+ ],
+ "type": "object"
+ },
+ "ReportExecutionLogRestApi.get_list": {
+ "properties": {
+ "end_dttm": {
+ "format": "date-time",
"nullable": true,
"type": "string"
},
- "extra": {
- "readOnly": true
+ "error_message": {
+ "nullable": true,
+ "type": "string"
},
"id": {
"type": "integer"
},
- "last_eval_dttm": {
+ "scheduled_dttm": {
"format": "date-time",
- "nullable": true,
"type": "string"
},
- "last_state": {
- "maxLength": 50,
+ "start_dttm": {
+ "format": "date-time",
"nullable": true,
"type": "string"
},
- "name": {
- "maxLength": 150,
+ "state": {
+ "maxLength": 50,
"type": "string"
},
- "owners": {
- "$ref": "#/components/schemas/ReportScheduleRestApi.get_list.User1"
- },
- "recipients": {
- "$ref": "#/components/schemas/ReportScheduleRestApi.get_list.ReportRecipients"
- },
- "timezone": {
- "maxLength": 100,
+ "uuid": {
+ "format": "uuid",
+ "nullable": true,
"type": "string"
},
- "type": {
- "maxLength": 50,
+ "value": {
+ "nullable": true,
+ "type": "number"
+ },
+ "value_row_json": {
+ "nullable": true,
"type": "string"
}
},
- "required": ["crontab", "name", "recipients", "type"],
+ "required": [
+ "scheduled_dttm",
+ "state"
+ ],
"type": "object"
},
- "ReportScheduleRestApi.get_list.ReportRecipients": {
+ "ReportExecutionLogRestApi.post": {
"properties": {
"id": {
"type": "integer"
- },
- "type": {
- "maxLength": 50,
- "type": "string"
}
},
- "required": ["type"],
"type": "object"
},
- "ReportScheduleRestApi.get_list.User": {
+ "ReportExecutionLogRestApi.put": {
"properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
- },
- "last_name": {
- "maxLength": 64,
- "type": "string"
+ "id": {
+ "type": "integer"
}
},
- "required": ["first_name", "last_name"],
"type": "object"
},
- "ReportScheduleRestApi.get_list.User1": {
+ "ReportRecipient": {
"properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
- },
- "id": {
- "type": "integer"
+ "recipient_config_json": {
+ "$ref": "#/components/schemas/ReportRecipientConfigJSON"
},
- "last_name": {
- "maxLength": 64,
+ "type": {
+ "description": "The recipient type, check spec for valid options",
+ "enum": [
+ "Email",
+ "Slack",
+ "SlackV2"
+ ],
"type": "string"
}
},
- "required": ["first_name", "last_name"],
+ "required": [
+ "type"
+ ],
"type": "object"
},
- "ReportScheduleRestApi.get_list.User2": {
+ "ReportRecipientConfigJSON": {
"properties": {
- "first_name": {
- "maxLength": 64,
+ "bccTarget": {
"type": "string"
},
- "last_name": {
- "maxLength": 64,
+ "ccTarget": {
+ "type": "string"
+ },
+ "target": {
"type": "string"
}
},
- "required": ["first_name", "last_name"],
"type": "object"
},
- "ReportScheduleRestApi.post": {
+ "ReportScheduleRestApi.get": {
"properties": {
"active": {
+ "nullable": true,
"type": "boolean"
},
"chart": {
- "nullable": true,
- "type": "integer"
+ "$ref": "#/components/schemas/ReportScheduleRestApi.get.Slice"
},
"context_markdown": {
- "description": "Markdown description",
"nullable": true,
"type": "string"
},
"creation_method": {
- "description": "Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.",
- "enum": ["charts", "dashboards", "alerts_reports"]
+ "maxLength": 255,
+ "nullable": true,
+ "type": "string"
},
"crontab": {
- "description": "A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.",
- "example": "*/5 * * * *",
"maxLength": 1000,
- "minLength": 1,
"type": "string"
},
"custom_width": {
- "description": "Custom width of the screenshot in pixels",
- "example": 1000,
"nullable": true,
"type": "integer"
},
"dashboard": {
- "nullable": true,
- "type": "integer"
+ "$ref": "#/components/schemas/ReportScheduleRestApi.get.Dashboard"
},
"database": {
- "type": "integer"
+ "$ref": "#/components/schemas/ReportScheduleRestApi.get.Database"
},
"description": {
- "description": "Use a nice description to give context to this Alert/Report",
- "example": "Daily sales dashboard to marketing",
+ "nullable": true,
+ "type": "string"
+ },
+ "email_subject": {
+ "maxLength": 255,
"nullable": true,
"type": "string"
},
"extra": {
- "type": "object"
+ "readOnly": true
},
"force_screenshot": {
+ "nullable": true,
"type": "boolean"
},
"grace_period": {
- "description": "Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)",
- "example": 14400,
- "minimum": 1,
+ "nullable": true,
+ "type": "integer"
+ },
+ "id": {
"type": "integer"
},
+ "last_eval_dttm": {
+ "format": "date-time",
+ "nullable": true,
+ "type": "string"
+ },
+ "last_state": {
+ "maxLength": 50,
+ "nullable": true,
+ "type": "string"
+ },
+ "last_value": {
+ "nullable": true,
+ "type": "number"
+ },
+ "last_value_row_json": {
+ "nullable": true,
+ "type": "string"
+ },
"log_retention": {
- "description": "How long to keep the logs around for this report (in days)",
- "example": 90,
- "minimum": 1,
+ "nullable": true,
"type": "integer"
},
"name": {
- "description": "The report schedule name.",
- "example": "Daily dashboard email",
"maxLength": 150,
- "minLength": 1,
"type": "string"
},
"owners": {
- "items": {
- "description": "Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.",
- "type": "integer"
- },
- "type": "array"
+ "$ref": "#/components/schemas/ReportScheduleRestApi.get.AppleUser"
},
"recipients": {
- "items": {
- "$ref": "#/components/schemas/ReportRecipient"
- },
- "type": "array"
+ "$ref": "#/components/schemas/ReportScheduleRestApi.get.ReportRecipients"
},
"report_format": {
- "enum": ["PNG", "CSV", "TEXT"],
- "type": "string"
- },
- "selected_tabs": {
- "items": {
- "type": "integer"
- },
+ "maxLength": 50,
"nullable": true,
- "type": "array"
+ "type": "string"
},
"sql": {
- "description": "A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.",
- "example": "SELECT value FROM time_series_table",
+ "nullable": true,
"type": "string"
},
"timezone": {
- "description": "A timezone string that represents the location of the timezone.",
- "enum": [
- "Africa/Abidjan",
- "Africa/Accra",
- "Africa/Addis_Ababa",
- "Africa/Algiers",
- "Africa/Asmara",
- "Africa/Asmera",
- "Africa/Bamako",
- "Africa/Bangui",
- "Africa/Banjul",
- "Africa/Bissau",
- "Africa/Blantyre",
- "Africa/Brazzaville",
- "Africa/Bujumbura",
- "Africa/Cairo",
- "Africa/Casablanca",
- "Africa/Ceuta",
- "Africa/Conakry",
- "Africa/Dakar",
- "Africa/Dar_es_Salaam",
- "Africa/Djibouti",
- "Africa/Douala",
- "Africa/El_Aaiun",
- "Africa/Freetown",
- "Africa/Gaborone",
- "Africa/Harare",
- "Africa/Johannesburg",
- "Africa/Juba",
- "Africa/Kampala",
- "Africa/Khartoum",
- "Africa/Kigali",
- "Africa/Kinshasa",
- "Africa/Lagos",
- "Africa/Libreville",
- "Africa/Lome",
- "Africa/Luanda",
- "Africa/Lubumbashi",
- "Africa/Lusaka",
- "Africa/Malabo",
- "Africa/Maputo",
- "Africa/Maseru",
- "Africa/Mbabane",
- "Africa/Mogadishu",
- "Africa/Monrovia",
- "Africa/Nairobi",
- "Africa/Ndjamena",
- "Africa/Niamey",
- "Africa/Nouakchott",
- "Africa/Ouagadougou",
- "Africa/Porto-Novo",
- "Africa/Sao_Tome",
- "Africa/Timbuktu",
- "Africa/Tripoli",
- "Africa/Tunis",
- "Africa/Windhoek",
- "America/Adak",
- "America/Anchorage",
- "America/Anguilla",
- "America/Antigua",
- "America/Araguaina",
- "America/Argentina/Buenos_Aires",
- "America/Argentina/Catamarca",
- "America/Argentina/ComodRivadavia",
- "America/Argentina/Cordoba",
- "America/Argentina/Jujuy",
- "America/Argentina/La_Rioja",
- "America/Argentina/Mendoza",
- "America/Argentina/Rio_Gallegos",
- "America/Argentina/Salta",
- "America/Argentina/San_Juan",
- "America/Argentina/San_Luis",
- "America/Argentina/Tucuman",
- "America/Argentina/Ushuaia",
- "America/Aruba",
- "America/Asuncion",
- "America/Atikokan",
- "America/Atka",
- "America/Bahia",
- "America/Bahia_Banderas",
- "America/Barbados",
- "America/Belem",
- "America/Belize",
- "America/Blanc-Sablon",
- "America/Boa_Vista",
- "America/Bogota",
- "America/Boise",
- "America/Buenos_Aires",
- "America/Cambridge_Bay",
- "America/Campo_Grande",
- "America/Cancun",
- "America/Caracas",
- "America/Catamarca",
- "America/Cayenne",
- "America/Cayman",
- "America/Chicago",
- "America/Chihuahua",
- "America/Coral_Harbour",
- "America/Cordoba",
- "America/Costa_Rica",
- "America/Creston",
- "America/Cuiaba",
- "America/Curacao",
- "America/Danmarkshavn",
- "America/Dawson",
- "America/Dawson_Creek",
- "America/Denver",
- "America/Detroit",
- "America/Dominica",
- "America/Edmonton",
- "America/Eirunepe",
- "America/El_Salvador",
- "America/Ensenada",
- "America/Fort_Nelson",
- "America/Fort_Wayne",
- "America/Fortaleza",
- "America/Glace_Bay",
- "America/Godthab",
- "America/Goose_Bay",
- "America/Grand_Turk",
- "America/Grenada",
- "America/Guadeloupe",
- "America/Guatemala",
- "America/Guayaquil",
- "America/Guyana",
- "America/Halifax",
- "America/Havana",
- "America/Hermosillo",
- "America/Indiana/Indianapolis",
- "America/Indiana/Knox",
- "America/Indiana/Marengo",
- "America/Indiana/Petersburg",
+ "maxLength": 100,
+ "type": "string"
+ },
+ "type": {
+ "maxLength": 50,
+ "type": "string"
+ },
+ "validator_config_json": {
+ "nullable": true,
+ "type": "string"
+ },
+ "validator_type": {
+ "maxLength": 100,
+ "nullable": true,
+ "type": "string"
+ },
+ "working_timeout": {
+ "nullable": true,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "crontab",
+ "name",
+ "recipients",
+ "type"
+ ],
+ "type": "object"
+ },
+ "ReportScheduleRestApi.get.AppleUser": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "ReportScheduleRestApi.get.Dashboard": {
+ "properties": {
+ "dashboard_title": {
+ "maxLength": 500,
+ "nullable": true,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ReportScheduleRestApi.get.Database": {
+ "properties": {
+ "database_name": {
+ "maxLength": 250,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "database_name"
+ ],
+ "type": "object"
+ },
+ "ReportScheduleRestApi.get.ReportRecipients": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "recipient_config_json": {
+ "nullable": true,
+ "type": "string"
+ },
+ "type": {
+ "maxLength": 50,
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ "ReportScheduleRestApi.get.Slice": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "slice_name": {
+ "maxLength": 250,
+ "nullable": true,
+ "type": "string"
+ },
+ "viz_type": {
+ "maxLength": 250,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportScheduleRestApi.get_list": {
+ "properties": {
+ "active": {
+ "nullable": true,
+ "type": "boolean"
+ },
+ "changed_by": {
+ "$ref": "#/components/schemas/ReportScheduleRestApi.get_list.User"
+ },
+ "changed_on": {
+ "format": "date-time",
+ "nullable": true,
+ "type": "string"
+ },
+ "changed_on_delta_humanized": {
+ "readOnly": true
+ },
+ "chart_id": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "created_by": {
+ "$ref": "#/components/schemas/ReportScheduleRestApi.get_list.User1"
+ },
+ "created_on": {
+ "format": "date-time",
+ "nullable": true,
+ "type": "string"
+ },
+ "creation_method": {
+ "maxLength": 255,
+ "nullable": true,
+ "type": "string"
+ },
+ "crontab": {
+ "maxLength": 1000,
+ "type": "string"
+ },
+ "crontab_humanized": {
+ "readOnly": true
+ },
+ "dashboard_id": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "description": {
+ "nullable": true,
+ "type": "string"
+ },
+ "extra": {
+ "readOnly": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_eval_dttm": {
+ "format": "date-time",
+ "nullable": true,
+ "type": "string"
+ },
+ "last_state": {
+ "maxLength": 50,
+ "nullable": true,
+ "type": "string"
+ },
+ "name": {
+ "maxLength": 150,
+ "type": "string"
+ },
+ "owners": {
+ "$ref": "#/components/schemas/ReportScheduleRestApi.get_list.AppleUser"
+ },
+ "recipients": {
+ "$ref": "#/components/schemas/ReportScheduleRestApi.get_list.ReportRecipients"
+ },
+ "timezone": {
+ "maxLength": 100,
+ "type": "string"
+ },
+ "type": {
+ "maxLength": 50,
+ "type": "string"
+ }
+ },
+ "required": [
+ "crontab",
+ "name",
+ "recipients",
+ "type"
+ ],
+ "type": "object"
+ },
+ "ReportScheduleRestApi.get_list.AppleUser": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "ReportScheduleRestApi.get_list.ReportRecipients": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "type": {
+ "maxLength": 50,
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ "ReportScheduleRestApi.get_list.User": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "ReportScheduleRestApi.get_list.User1": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "ReportScheduleRestApi.post": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "chart": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "context_markdown": {
+ "description": "Markdown description",
+ "nullable": true,
+ "type": "string"
+ },
+ "creation_method": {
+ "description": "Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.",
+ "enum": [
+ "charts",
+ "dashboards",
+ "alerts_reports"
+ ]
+ },
+ "crontab": {
+ "description": "A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.",
+ "example": "*/5 * * * *",
+ "maxLength": 1000,
+ "minLength": 1,
+ "type": "string"
+ },
+ "custom_width": {
+ "description": "Custom width of the screenshot in pixels",
+ "example": 1000,
+ "nullable": true,
+ "type": "integer"
+ },
+ "dashboard": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "database": {
+ "type": "integer"
+ },
+ "description": {
+ "description": "Use a nice description to give context to this Alert/Report",
+ "example": "Daily sales dashboard to marketing",
+ "nullable": true,
+ "type": "string"
+ },
+ "email_subject": {
+ "description": "The report schedule subject line",
+ "example": "[Report] Report name: Dashboard or chart name",
+ "nullable": true,
+ "type": "string"
+ },
+ "extra": {
+ "type": "object"
+ },
+ "force_screenshot": {
+ "type": "boolean"
+ },
+ "grace_period": {
+ "description": "Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)",
+ "example": 14400,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "log_retention": {
+ "description": "How long to keep the logs around for this report (in days)",
+ "example": 90,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "name": {
+ "description": "The report schedule name.",
+ "example": "Daily dashboard email",
+ "maxLength": 150,
+ "minLength": 1,
+ "type": "string"
+ },
+ "owners": {
+ "items": {
+ "description": "Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "recipients": {
+ "items": {
+ "$ref": "#/components/schemas/ReportRecipient"
+ },
+ "type": "array"
+ },
+ "report_format": {
+ "enum": [
+ "PDF",
+ "PNG",
+ "CSV",
+ "TEXT"
+ ],
+ "type": "string"
+ },
+ "selected_tabs": {
+ "items": {
+ "type": "integer"
+ },
+ "nullable": true,
+ "type": "array"
+ },
+ "sql": {
+ "description": "A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.",
+ "example": "SELECT value FROM time_series_table",
+ "type": "string"
+ },
+ "timezone": {
+ "description": "A timezone string that represents the location of the timezone.",
+ "enum": [
+ "Africa/Abidjan",
+ "Africa/Accra",
+ "Africa/Addis_Ababa",
+ "Africa/Algiers",
+ "Africa/Asmara",
+ "Africa/Asmera",
+ "Africa/Bamako",
+ "Africa/Bangui",
+ "Africa/Banjul",
+ "Africa/Bissau",
+ "Africa/Blantyre",
+ "Africa/Brazzaville",
+ "Africa/Bujumbura",
+ "Africa/Cairo",
+ "Africa/Casablanca",
+ "Africa/Ceuta",
+ "Africa/Conakry",
+ "Africa/Dakar",
+ "Africa/Dar_es_Salaam",
+ "Africa/Djibouti",
+ "Africa/Douala",
+ "Africa/El_Aaiun",
+ "Africa/Freetown",
+ "Africa/Gaborone",
+ "Africa/Harare",
+ "Africa/Johannesburg",
+ "Africa/Juba",
+ "Africa/Kampala",
+ "Africa/Khartoum",
+ "Africa/Kigali",
+ "Africa/Kinshasa",
+ "Africa/Lagos",
+ "Africa/Libreville",
+ "Africa/Lome",
+ "Africa/Luanda",
+ "Africa/Lubumbashi",
+ "Africa/Lusaka",
+ "Africa/Malabo",
+ "Africa/Maputo",
+ "Africa/Maseru",
+ "Africa/Mbabane",
+ "Africa/Mogadishu",
+ "Africa/Monrovia",
+ "Africa/Nairobi",
+ "Africa/Ndjamena",
+ "Africa/Niamey",
+ "Africa/Nouakchott",
+ "Africa/Ouagadougou",
+ "Africa/Porto-Novo",
+ "Africa/Sao_Tome",
+ "Africa/Timbuktu",
+ "Africa/Tripoli",
+ "Africa/Tunis",
+ "Africa/Windhoek",
+ "America/Adak",
+ "America/Anchorage",
+ "America/Anguilla",
+ "America/Antigua",
+ "America/Araguaina",
+ "America/Argentina/Buenos_Aires",
+ "America/Argentina/Catamarca",
+ "America/Argentina/ComodRivadavia",
+ "America/Argentina/Cordoba",
+ "America/Argentina/Jujuy",
+ "America/Argentina/La_Rioja",
+ "America/Argentina/Mendoza",
+ "America/Argentina/Rio_Gallegos",
+ "America/Argentina/Salta",
+ "America/Argentina/San_Juan",
+ "America/Argentina/San_Luis",
+ "America/Argentina/Tucuman",
+ "America/Argentina/Ushuaia",
+ "America/Aruba",
+ "America/Asuncion",
+ "America/Atikokan",
+ "America/Atka",
+ "America/Bahia",
+ "America/Bahia_Banderas",
+ "America/Barbados",
+ "America/Belem",
+ "America/Belize",
+ "America/Blanc-Sablon",
+ "America/Boa_Vista",
+ "America/Bogota",
+ "America/Boise",
+ "America/Buenos_Aires",
+ "America/Cambridge_Bay",
+ "America/Campo_Grande",
+ "America/Cancun",
+ "America/Caracas",
+ "America/Catamarca",
+ "America/Cayenne",
+ "America/Cayman",
+ "America/Chicago",
+ "America/Chihuahua",
+ "America/Ciudad_Juarez",
+ "America/Coral_Harbour",
+ "America/Cordoba",
+ "America/Costa_Rica",
+ "America/Creston",
+ "America/Cuiaba",
+ "America/Curacao",
+ "America/Danmarkshavn",
+ "America/Dawson",
+ "America/Dawson_Creek",
+ "America/Denver",
+ "America/Detroit",
+ "America/Dominica",
+ "America/Edmonton",
+ "America/Eirunepe",
+ "America/El_Salvador",
+ "America/Ensenada",
+ "America/Fort_Nelson",
+ "America/Fort_Wayne",
+ "America/Fortaleza",
+ "America/Glace_Bay",
+ "America/Godthab",
+ "America/Goose_Bay",
+ "America/Grand_Turk",
+ "America/Grenada",
+ "America/Guadeloupe",
+ "America/Guatemala",
+ "America/Guayaquil",
+ "America/Guyana",
+ "America/Halifax",
+ "America/Havana",
+ "America/Hermosillo",
+ "America/Indiana/Indianapolis",
+ "America/Indiana/Knox",
+ "America/Indiana/Marengo",
+ "America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
@@ -7620,8 +9103,9 @@
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
- "Europe/Kyiv",
+ "Europe/Kiev",
"Europe/Kirov",
+ "Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
@@ -7772,7 +9256,10 @@
},
"type": {
"description": "The report schedule type",
- "enum": ["Alert", "Report"],
+ "enum": [
+ "Alert",
+ "Report"
+ ],
"type": "string"
},
"validator_config_json": {
@@ -7780,17 +9267,24 @@
},
"validator_type": {
"description": "Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\n- Not Null - When the return value is Not NULL, Empty, or 0\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`<br>Supports the comparison operators <, <=, >, >=, ==, and !=",
- "enum": ["not null", "operator"],
+ "enum": [
+ "not null",
+ "operator"
+ ],
"type": "string"
},
"working_timeout": {
- "description": "If an alert is staled at a working state, how long until it's state is reseted to error",
+ "description": "If an alert is staled at a working state, how long until it's state is reset to error",
"example": 3600,
"minimum": 1,
"type": "integer"
}
},
- "required": ["crontab", "name", "type"],
+ "required": [
+ "crontab",
+ "name",
+ "type"
+ ],
"type": "object"
},
"ReportScheduleRestApi.put": {
@@ -7809,7 +9303,11 @@
},
"creation_method": {
"description": "Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.",
- "enum": ["charts", "dashboards", "alerts_reports"],
+ "enum": [
+ "charts",
+ "dashboards",
+ "alerts_reports"
+ ],
"nullable": true
},
"crontab": {
@@ -7837,6 +9335,12 @@
"nullable": true,
"type": "string"
},
+ "email_subject": {
+ "description": "The report schedule subject line",
+ "example": "[Report] Report name: Dashboard or chart name",
+ "nullable": true,
+ "type": "string"
+ },
"extra": {
"type": "object"
},
@@ -7852,7 +9356,7 @@
"log_retention": {
"description": "How long to keep the logs around for this report (in days)",
"example": 90,
- "minimum": 1,
+ "minimum": 0,
"type": "integer"
},
"name": {
@@ -7875,7 +9379,12 @@
"type": "array"
},
"report_format": {
- "enum": ["PNG", "CSV", "TEXT"],
+ "enum": [
+ "PDF",
+ "PNG",
+ "CSV",
+ "TEXT"
+ ],
"type": "string"
},
"sql": {
@@ -7982,6 +9491,7 @@
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
+ "America/Ciudad_Juarez",
"America/Coral_Harbour",
"America/Cordoba",
"America/Costa_Rica",
@@ -8334,8 +9844,9 @@
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
- "Europe/Kyiv",
+ "Europe/Kiev",
"Europe/Kirov",
+ "Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
@@ -8484,1285 +9995,3341 @@
],
"type": "string"
},
- "type": {
- "description": "The report schedule type",
- "enum": ["Alert", "Report"],
+ "type": {
+ "description": "The report schedule type",
+ "enum": [
+ "Alert",
+ "Report"
+ ],
+ "type": "string"
+ },
+ "validator_config_json": {
+ "$ref": "#/components/schemas/ValidatorConfigJSON"
+ },
+ "validator_type": {
+ "description": "Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\n- Not Null - When the return value is Not NULL, Empty, or 0\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`<br>Supports the comparison operators <, <=, >, >=, ==, and !=",
+ "enum": [
+ "not null",
+ "operator"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "working_timeout": {
+ "description": "If an alert is staled at a working state, how long until it's state is reset to error",
+ "example": 3600,
+ "minimum": 1,
+ "nullable": true,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Resource": {
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "dashboard"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "type"
+ ],
+ "type": "object"
+ },
+ "RlsRule": {
+ "properties": {
+ "clause": {
+ "type": "string"
+ },
+ "dataset": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "clause"
+ ],
+ "type": "object"
+ },
+ "Roles": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Roles1": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SQLLabBootstrapSchema": {
+ "properties": {
+ "active_tab": {
+ "$ref": "#/components/schemas/TabState"
+ },
+ "databases": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/ImportV1Database"
+ },
+ "type": "object"
+ },
+ "queries": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/QueryResult"
+ },
+ "type": "object"
+ },
+ "tab_state_ids": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SavedQueryRestApi.get": {
+ "properties": {
+ "catalog": {
+ "maxLength": 256,
+ "nullable": true,
+ "type": "string"
+ },
+ "changed_by": {
+ "$ref": "#/components/schemas/SavedQueryRestApi.get.User"
+ },
+ "changed_on": {
+ "format": "date-time",
+ "nullable": true,
+ "type": "string"
+ },
+ "changed_on_delta_humanized": {
+ "readOnly": true
+ },
+ "created_by": {
+ "$ref": "#/components/schemas/SavedQueryRestApi.get.User1"
+ },
+ "database": {
+ "$ref": "#/components/schemas/SavedQueryRestApi.get.Database"
+ },
+ "description": {
+ "nullable": true,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "label": {
+ "maxLength": 256,
+ "nullable": true,
+ "type": "string"
+ },
+ "schema": {
+ "maxLength": 128,
+ "nullable": true,
+ "type": "string"
+ },
+ "sql": {
+ "nullable": true,
+ "type": "string"
+ },
+ "sql_tables": {
+ "readOnly": true
+ },
+ "template_parameters": {
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SavedQueryRestApi.get.Database": {
+ "properties": {
+ "database_name": {
+ "maxLength": 250,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "database_name"
+ ],
+ "type": "object"
+ },
+ "SavedQueryRestApi.get.User": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "SavedQueryRestApi.get.User1": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "SavedQueryRestApi.get_list": {
+ "properties": {
+ "catalog": {
+ "maxLength": 256,
+ "nullable": true,
+ "type": "string"
+ },
+ "changed_by": {
+ "$ref": "#/components/schemas/SavedQueryRestApi.get_list.User"
+ },
+ "changed_on": {
+ "format": "date-time",
+ "nullable": true,
+ "type": "string"
+ },
+ "changed_on_delta_humanized": {
+ "readOnly": true
+ },
+ "created_by": {
+ "$ref": "#/components/schemas/SavedQueryRestApi.get_list.User1"
+ },
+ "created_on": {
+ "format": "date-time",
+ "nullable": true,
+ "type": "string"
+ },
+ "database": {
+ "$ref": "#/components/schemas/SavedQueryRestApi.get_list.Database"
+ },
+ "db_id": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "description": {
+ "nullable": true,
+ "type": "string"
+ },
+ "extra": {
+ "readOnly": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "label": {
+ "maxLength": 256,
+ "nullable": true,
+ "type": "string"
+ },
+ "last_run_delta_humanized": {
+ "readOnly": true
+ },
+ "rows": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "schema": {
+ "maxLength": 128,
+ "nullable": true,
+ "type": "string"
+ },
+ "sql": {
+ "nullable": true,
+ "type": "string"
+ },
+ "sql_tables": {
+ "readOnly": true
+ },
+ "tags": {
+ "$ref": "#/components/schemas/SavedQueryRestApi.get_list.Tag"
+ }
+ },
+ "type": "object"
+ },
+ "SavedQueryRestApi.get_list.Database": {
+ "properties": {
+ "database_name": {
+ "maxLength": 250,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "database_name"
+ ],
+ "type": "object"
+ },
+ "SavedQueryRestApi.get_list.Tag": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "maxLength": 250,
+ "nullable": true,
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "SavedQueryRestApi.get_list.User": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "SavedQueryRestApi.get_list.User1": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "SavedQueryRestApi.post": {
+ "properties": {
+ "catalog": {
+ "maxLength": 256,
+ "nullable": true,
+ "type": "string"
+ },
+ "db_id": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "description": {
+ "nullable": true,
+ "type": "string"
+ },
+ "extra_json": {
+ "nullable": true,
+ "type": "string"
+ },
+ "label": {
+ "maxLength": 256,
+ "nullable": true,
+ "type": "string"
+ },
+ "schema": {
+ "maxLength": 128,
+ "nullable": true,
+ "type": "string"
+ },
+ "sql": {
+ "nullable": true,
+ "type": "string"
+ },
+ "template_parameters": {
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SavedQueryRestApi.put": {
+ "properties": {
+ "catalog": {
+ "maxLength": 256,
+ "nullable": true,
+ "type": "string"
+ },
+ "db_id": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "description": {
+ "nullable": true,
+ "type": "string"
+ },
+ "extra_json": {
+ "nullable": true,
+ "type": "string"
+ },
+ "label": {
+ "maxLength": 256,
+ "nullable": true,
+ "type": "string"
+ },
+ "schema": {
+ "maxLength": 128,
+ "nullable": true,
+ "type": "string"
+ },
+ "sql": {
+ "nullable": true,
+ "type": "string"
+ },
+ "template_parameters": {
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SchemasResponseSchema": {
+ "properties": {
+ "result": {
+ "items": {
+ "description": "A database schema name",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SelectStarResponseSchema": {
+ "properties": {
+ "result": {
+ "description": "SQL select star",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Slice": {
+ "properties": {
+ "cache_timeout": {
+ "description": "Duration (in seconds) of the caching timeout for this chart.",
+ "type": "integer"
+ },
+ "certification_details": {
+ "description": "Details of the certification.",
+ "type": "string"
+ },
+ "certified_by": {
+ "description": "Person or group that has certified this dashboard.",
+ "type": "string"
+ },
+ "changed_on": {
+ "description": "Timestamp of the last modification.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "changed_on_humanized": {
+ "description": "Timestamp of the last modification in human readable form.",
+ "type": "string"
+ },
+ "datasource": {
+ "description": "Datasource identifier.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Slice description.",
+ "type": "string"
+ },
+ "description_markeddown": {
+ "description": "Sanitized HTML version of the chart description.",
+ "type": "string"
+ },
+ "edit_url": {
+ "description": "The URL for editing the slice.",
+ "type": "string"
+ },
+ "form_data": {
+ "description": "Form data associated with the slice.",
+ "type": "object"
+ },
+ "is_managed_externally": {
+ "description": "If the chart is managed outside externally.",
+ "type": "boolean"
+ },
+ "modified": {
+ "description": "Last modification in human readable form.",
+ "type": "string"
+ },
+ "owners": {
+ "description": "Owners identifiers.",
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "query_context": {
+ "description": "The context associated with the query.",
+ "type": "object"
+ },
+ "slice_id": {
+ "description": "The slice ID.",
+ "type": "integer"
+ },
+ "slice_name": {
+ "description": "The slice name.",
+ "type": "string"
+ },
+ "slice_url": {
+ "description": "The slice URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "StopQuerySchema": {
+ "properties": {
+ "client_id": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Tab": {
+ "properties": {
+ "children": {
+ "items": {
+ "$ref": "#/components/schemas/Tab"
+ },
+ "type": "array"
+ },
+ "parents": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "title": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TabState": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "autorun": {
+ "type": "boolean"
+ },
+ "database_id": {
+ "type": "integer"
+ },
+ "extra_json": {
+ "type": "object"
+ },
+ "hide_left_bar": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "string"
+ },
+ "label": {
+ "type": "string"
+ },
+ "latest_query": {
+ "$ref": "#/components/schemas/QueryResult"
+ },
+ "query_limit": {
+ "type": "integer"
+ },
+ "saved_query": {
+ "nullable": true,
+ "type": "object"
+ },
+ "schema": {
+ "type": "string"
+ },
+ "sql": {
+ "type": "string"
+ },
+ "table_schemas": {
+ "items": {
+ "$ref": "#/components/schemas/Table"
+ },
+ "type": "array"
+ },
+ "user_id": {
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Table": {
+ "properties": {
+ "database_id": {
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "expanded": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "schema": {
+ "type": "string"
+ },
+ "tab_state_id": {
+ "type": "integer"
+ },
+ "table": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TableExtraMetadataResponseSchema": {
+ "properties": {
+ "clustering": {
+ "type": "object"
+ },
+ "metadata": {
+ "type": "object"
+ },
+ "partitions": {
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "TableMetadataColumnsResponse": {
+ "properties": {
+ "duplicates_constraint": {
+ "type": "string"
+ },
+ "keys": {
+ "description": "",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "longType": {
+ "description": "The actual backend long type for the column",
+ "type": "string"
+ },
+ "name": {
+ "description": "The column name",
+ "type": "string"
+ },
+ "type": {
+ "description": "The column type",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TableMetadataForeignKeysIndexesResponse": {
+ "properties": {
+ "column_names": {
+ "items": {
+ "description": "A list of column names that compose the foreign key or index",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of the foreign key or index",
+ "type": "string"
+ },
+ "options": {
+ "$ref": "#/components/schemas/TableMetadataOptionsResponse"
+ },
+ "referred_columns": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "referred_schema": {
+ "type": "string"
+ },
+ "referred_table": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TableMetadataOptionsResponse": {
+ "properties": {
+ "deferrable": {
+ "type": "boolean"
+ },
+ "initially": {
+ "type": "boolean"
+ },
+ "match": {
+ "type": "boolean"
+ },
+ "ondelete": {
+ "type": "boolean"
+ },
+ "onupdate": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "TableMetadataPrimaryKeyResponse": {
+ "properties": {
+ "column_names": {
+ "items": {
+ "description": "A list of column names that compose the primary key",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The primary key index name",
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TableMetadataResponseSchema": {
+ "properties": {
+ "columns": {
+ "description": "A list of columns and their metadata",
+ "items": {
+ "$ref": "#/components/schemas/TableMetadataColumnsResponse"
+ },
+ "type": "array"
+ },
+ "foreignKeys": {
+ "description": "A list of foreign keys and their metadata",
+ "items": {
+ "$ref": "#/components/schemas/TableMetadataForeignKeysIndexesResponse"
+ },
+ "type": "array"
+ },
+ "indexes": {
+ "description": "A list of indexes and their metadata",
+ "items": {
+ "$ref": "#/components/schemas/TableMetadataForeignKeysIndexesResponse"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of the table",
+ "type": "string"
+ },
+ "primaryKey": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/TableMetadataPrimaryKeyResponse"
+ }
+ ],
+ "description": "Primary keys metadata"
+ },
+ "selectStar": {
+ "description": "SQL select star",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Tables": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "schema": {
+ "type": "string"
+ },
+ "table_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TabsPayloadSchema": {
+ "properties": {
+ "all_tabs": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "tab_tree": {
+ "items": {
+ "$ref": "#/components/schemas/Tab"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Tag": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "TagGetResponseSchema": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TagObject": {
+ "properties": {
+ "description": {
+ "nullable": true,
+ "type": "string"
+ },
+ "name": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "objects_to_tag": {
+ "description": "Objects to tag",
+ "items": {},
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TagPostBulkResponseObject": {
+ "properties": {
+ "objects_skipped": {
+ "description": "Objects to tag",
+ "items": {},
+ "type": "array"
+ },
+ "objects_tagged": {
+ "description": "Objects to tag",
+ "items": {},
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TagPostBulkResponseSchema": {
+ "properties": {
+ "result": {
+ "$ref": "#/components/schemas/TagPostBulkResponseObject"
+ }
+ },
+ "type": "object"
+ },
+ "TagPostBulkSchema": {
+ "properties": {
+ "tags": {
+ "items": {
+ "$ref": "#/components/schemas/TagObject"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TagRestApi.get": {
+ "properties": {
+ "changed_by": {
+ "$ref": "#/components/schemas/TagRestApi.get.User"
+ },
+ "changed_on_delta_humanized": {
+ "readOnly": true
+ },
+ "created_by": {
+ "$ref": "#/components/schemas/TagRestApi.get.User1"
+ },
+ "created_on_delta_humanized": {
+ "readOnly": true
+ },
+ "description": {
+ "nullable": true,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "maxLength": 250,
+ "nullable": true,
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "TagRestApi.get.User": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "TagRestApi.get.User1": {
+ "properties": {
+ "active": {
+ "nullable": true,
+ "type": "boolean"
+ },
+ "changed_on": {
+ "format": "date-time",
+ "nullable": true,
+ "type": "string"
+ },
+ "created_on": {
+ "format": "date-time",
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "maxLength": 320,
+ "type": "string"
+ },
+ "fail_login_count": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_login": {
+ "format": "date-time",
+ "nullable": true,
+ "type": "string"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "login_count": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "password": {
+ "maxLength": 256,
+ "nullable": true,
+ "type": "string"
+ },
+ "username": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "first_name",
+ "last_name",
+ "username"
+ ],
+ "type": "object"
+ },
+ "TagRestApi.get_list": {
+ "properties": {
+ "changed_by": {
+ "$ref": "#/components/schemas/TagRestApi.get_list.User"
+ },
+ "changed_on_delta_humanized": {
+ "readOnly": true
+ },
+ "created_by": {
+ "$ref": "#/components/schemas/TagRestApi.get_list.User1"
+ },
+ "created_on_delta_humanized": {
+ "readOnly": true
+ },
+ "description": {
+ "nullable": true,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "maxLength": 250,
+ "nullable": true,
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "TagRestApi.get_list.User": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "TagRestApi.get_list.User1": {
+ "properties": {
+ "first_name": {
+ "maxLength": 64,
+ "type": "string"
+ },
+ "last_name": {
+ "maxLength": 64,
+ "type": "string"
+ }
+ },
+ "required": [
+ "first_name",
+ "last_name"
+ ],
+ "type": "object"
+ },
+ "TagRestApi.post": {
+ "properties": {
+ "description": {
+ "nullable": true,
+ "type": "string"
+ },
+ "name": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "objects_to_tag": {
+ "description": "Objects to tag",
+ "items": {},
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TagRestApi.put": {
+ "properties": {
+ "description": {
+ "nullable": true,
+ "type": "string"
+ },
+ "name": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "objects_to_tag": {
+ "description": "Objects to tag",
+ "items": {},
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TaggedObjectEntityResponseSchema": {
+ "properties": {
+ "changed_on": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "created_by": {
+ "$ref": "#/components/schemas/User"
+ },
+ "creator": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "owners": {
+ "items": {
+ "$ref": "#/components/schemas/User1"
+ },
+ "type": "array"
+ },
+ "tags": {
+ "items": {
+ "$ref": "#/components/schemas/TagGetResponseSchema"
+ },
+ "type": "array"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TemporaryCachePostSchema": {
+ "properties": {
+ "value": {
+ "description": "Any type of JSON supported text.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "type": "object"
+ },
+ "TemporaryCachePutSchema": {
+ "properties": {
+ "value": {
+ "description": "Any type of JSON supported text.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "type": "object"
+ },
+ "UploadFileMetadata": {
+ "properties": {
+ "items": {
+ "items": {
+ "$ref": "#/components/schemas/UploadFileMetadataItem"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UploadFileMetadataItem": {
+ "properties": {
+ "column_names": {
+ "description": "A list of columns names in the sheet",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sheet_name": {
+ "description": "The name of the sheet",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "User": {
+ "properties": {
+ "first_name": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "last_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "User1": {
+ "properties": {
+ "first_name": {
"type": "string"
},
- "validator_config_json": {
- "$ref": "#/components/schemas/ValidatorConfigJSON"
+ "id": {
+ "type": "integer"
},
- "validator_type": {
- "description": "Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\n- Not Null - When the return value is Not NULL, Empty, or 0\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`<br>Supports the comparison operators <, <=, >, >=, ==, and !=",
- "enum": ["not null", "operator"],
+ "last_name": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "User2": {
+ "properties": {
+ "first_name": {
+ "type": "string"
+ },
+ "last_name": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserResponseSchema": {
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "first_name": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "is_active": {
+ "type": "boolean"
+ },
+ "is_anonymous": {
+ "type": "boolean"
+ },
+ "last_name": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ValidateSQLRequest": {
+ "properties": {
+ "catalog": {
"nullable": true,
"type": "string"
},
- "working_timeout": {
- "description": "If an alert is staled at a working state, how long until it's state is reseted to error",
- "example": 3600,
- "minimum": 1,
+ "schema": {
+ "nullable": true,
+ "type": "string"
+ },
+ "sql": {
+ "description": "SQL statement to validate",
+ "type": "string"
+ },
+ "template_params": {
"nullable": true,
+ "type": "object"
+ }
+ },
+ "required": [
+ "sql"
+ ],
+ "type": "object"
+ },
+ "ValidateSQLResponse": {
+ "properties": {
+ "end_column": {
+ "type": "integer"
+ },
+ "line_number": {
+ "type": "integer"
+ },
+ "message": {
+ "type": "string"
+ },
+ "start_column": {
"type": "integer"
}
},
"type": "object"
},
- "Resource": {
+ "ValidatorConfigJSON": {
+ "properties": {
+ "op": {
+ "description": "The operation to compare with a threshold to apply to the SQL output\n",
+ "enum": [
+ "<",
+ "<=",
+ ">",
+ ">=",
+ "==",
+ "!="
+ ],
+ "type": "string"
+ },
+ "threshold": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "advanced_data_type_convert_schema": {
+ "properties": {
+ "type": {
+ "default": "port",
+ "type": "string"
+ },
+ "values": {
+ "items": {
+ "default": "http"
+ },
+ "minItems": 1,
+ "type": "array"
+ }
+ },
+ "required": [
+ "type",
+ "values"
+ ],
+ "type": "object"
+ },
+ "database_catalogs_query_schema": {
+ "properties": {
+ "force": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "database_schemas_query_schema": {
+ "properties": {
+ "catalog": {
+ "type": "string"
+ },
+ "force": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "database_tables_query_schema": {
+ "properties": {
+ "catalog_name": {
+ "type": "string"
+ },
+ "force": {
+ "type": "boolean"
+ },
+ "schema_name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "schema_name"
+ ],
+ "type": "object"
+ },
+ "delete_tags_schema": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "get_delete_ids_schema": {
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "get_export_ids_schema": {
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "get_fav_star_ids_schema": {
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "get_info_schema": {
+ "properties": {
+ "add_columns": {
+ "additionalProperties": {
+ "properties": {
+ "page": {
+ "type": "integer"
+ },
+ "page_size": {
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "object"
+ },
+ "edit_columns": {
+ "additionalProperties": {
+ "properties": {
+ "page": {
+ "type": "integer"
+ },
+ "page_size": {
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "object"
+ },
+ "keys": {
+ "items": {
+ "enum": [
+ "add_columns",
+ "edit_columns",
+ "filters",
+ "permissions",
+ "add_title",
+ "edit_title",
+ "none"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "get_item_schema": {
"properties": {
- "id": {
- "type": "string"
+ "columns": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "type": {
- "enum": ["dashboard"]
+ "keys": {
+ "items": {
+ "enum": [
+ "show_columns",
+ "description_columns",
+ "label_columns",
+ "show_title",
+ "none"
+ ],
+ "type": "string"
+ },
+ "type": "array"
}
},
- "required": ["id", "type"],
"type": "object"
},
- "RlsRule": {
+ "get_list_schema": {
"properties": {
- "clause": {
+ "columns": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "filters": {
+ "items": {
+ "properties": {
+ "col": {
+ "type": "string"
+ },
+ "opr": {
+ "type": "string"
+ },
+ "value": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "array"
+ }
+ ]
+ }
+ },
+ "required": [
+ "col",
+ "opr",
+ "value"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "keys": {
+ "items": {
+ "enum": [
+ "list_columns",
+ "order_columns",
+ "label_columns",
+ "description_columns",
+ "list_title",
+ "none"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "order_column": {
"type": "string"
},
- "dataset": {
+ "order_direction": {
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "type": "string"
+ },
+ "page": {
"type": "integer"
- }
- },
- "required": ["clause"],
- "type": "object"
- },
- "Roles": {
- "properties": {
- "id": {
+ },
+ "page_size": {
"type": "integer"
},
- "name": {
- "type": "string"
+ "select_columns": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "Roles1": {
+ "get_recent_activity_schema": {
"properties": {
- "id": {
- "type": "integer"
+ "actions": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "name": {
- "type": "string"
+ "distinct": {
+ "type": "boolean"
+ },
+ "page": {
+ "type": "number"
+ },
+ "page_size": {
+ "type": "number"
}
},
"type": "object"
},
- "SavedQueryRestApi.get": {
+ "get_related_schema": {
"properties": {
- "changed_on_delta_humanized": {
- "readOnly": true
- },
- "created_by": {
- "$ref": "#/components/schemas/SavedQueryRestApi.get.User"
- },
- "database": {
- "$ref": "#/components/schemas/SavedQueryRestApi.get.Database"
- },
- "description": {
- "nullable": true,
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "label": {
- "maxLength": 256,
- "nullable": true,
- "type": "string"
- },
- "schema": {
- "maxLength": 128,
- "nullable": true,
+ "filter": {
"type": "string"
},
- "sql": {
- "nullable": true,
- "type": "string"
+ "include_ids": {
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
},
- "sql_tables": {
- "readOnly": true
+ "page": {
+ "type": "integer"
},
- "template_parameters": {
- "nullable": true,
- "type": "string"
+ "page_size": {
+ "type": "integer"
}
},
"type": "object"
},
- "SavedQueryRestApi.get.Database": {
+ "queries_get_updated_since_schema": {
"properties": {
- "database_name": {
- "maxLength": 250,
- "type": "string"
- },
- "id": {
- "type": "integer"
+ "last_updated_ms": {
+ "type": "number"
}
},
- "required": ["database_name"],
+ "required": [
+ "last_updated_ms"
+ ],
"type": "object"
},
- "SavedQueryRestApi.get.User": {
+ "screenshot_query_schema": {
"properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
+ "force": {
+ "type": "boolean"
},
- "id": {
- "type": "integer"
+ "thumb_size": {
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
},
- "last_name": {
- "maxLength": 64,
- "type": "string"
+ "window_size": {
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
}
},
- "required": ["first_name", "last_name"],
"type": "object"
},
- "SavedQueryRestApi.get_list": {
+ "sql_lab_get_results_schema": {
"properties": {
- "changed_on_delta_humanized": {
- "readOnly": true
- },
- "created_by": {
- "$ref": "#/components/schemas/SavedQueryRestApi.get_list.User"
- },
- "created_on": {
- "format": "date-time",
- "nullable": true,
- "type": "string"
- },
- "database": {
- "$ref": "#/components/schemas/SavedQueryRestApi.get_list.Database"
- },
- "db_id": {
- "nullable": true,
- "type": "integer"
- },
- "description": {
- "nullable": true,
+ "key": {
"type": "string"
+ }
+ },
+ "required": [
+ "key"
+ ],
+ "type": "object"
+ },
+ "thumbnail_query_schema": {
+ "properties": {
+ "force": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "securitySchemes": {
+ "jwt": {
+ "bearerFormat": "JWT",
+ "scheme": "bearer",
+ "type": "http"
+ },
+ "jwt_refresh": {
+ "bearerFormat": "JWT",
+ "scheme": "bearer",
+ "type": "http"
+ }
+ }
+ },
+ "info": {
+ "description": "Superset",
+ "title": "Superset",
+ "version": "v1"
+ },
+ "openapi": "3.0.2",
+ "paths": {
+ "/api/v1/advanced_data_type/convert": {
+ "get": {
+ "description": "Returns an AdvancedDataTypeResponse object populated with the passed in args.",
+ "parameters": [
+ {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/advanced_data_type_convert_schema"
+ }
+ }
+ },
+ "in": "query",
+ "name": "q"
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdvancedDataTypeSchema"
+ }
+ }
+ },
+ "description": "AdvancedDataTypeResponse object has been returned."
},
- "extra": {
- "readOnly": true
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "id": {
- "type": "integer"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "label": {
- "maxLength": 256,
- "nullable": true,
- "type": "string"
+ "403": {
+ "$ref": "#/components/responses/403"
},
- "last_run_delta_humanized": {
- "readOnly": true
+ "404": {
+ "$ref": "#/components/responses/404"
},
- "rows": {
- "nullable": true,
- "type": "integer"
+ "500": {
+ "$ref": "#/components/responses/500"
+ }
+ },
+ "security": [
+ {
+ "jwt": []
+ }
+ ],
+ "summary": "Return an AdvancedDataTypeResponse",
+ "tags": [
+ "Advanced Data Type"
+ ]
+ }
+ },
+ "/api/v1/advanced_data_type/types": {
+ "get": {
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "result": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "a successful return of the available advanced data types has taken place."
},
- "schema": {
- "maxLength": 128,
- "nullable": true,
- "type": "string"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "sql": {
- "nullable": true,
- "type": "string"
+ "403": {
+ "$ref": "#/components/responses/403"
},
- "sql_tables": {
- "readOnly": true
+ "404": {
+ "$ref": "#/components/responses/404"
},
- "tags": {
- "$ref": "#/components/schemas/SavedQueryRestApi.get_list.Tag"
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
- },
- "SavedQueryRestApi.get_list.Database": {
- "properties": {
- "database_name": {
- "maxLength": 250,
- "type": "string"
- },
- "id": {
- "type": "integer"
+ "security": [
+ {
+ "jwt": []
}
- },
- "required": ["database_name"],
- "type": "object"
- },
- "SavedQueryRestApi.get_list.Tag": {
- "properties": {
- "id": {
- "type": "integer"
+ ],
+ "summary": "Return a list of available advanced data types",
+ "tags": [
+ "Advanced Data Type"
+ ]
+ }
+ },
+ "/api/v1/annotation_layer/": {
+ "delete": {
+ "parameters": [
+ {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/get_delete_ids_schema"
+ }
+ }
+ },
+ "in": "query",
+ "name": "q"
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "CSS templates bulk delete"
},
- "name": {
- "maxLength": 250,
- "nullable": true,
- "type": "string"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "type": {
- "enum": [1, 2, 3, 4]
- }
- },
- "type": "object"
- },
- "SavedQueryRestApi.get_list.User": {
- "properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
+ "404": {
+ "$ref": "#/components/responses/404"
},
- "id": {
- "type": "integer"
+ "422": {
+ "$ref": "#/components/responses/422"
},
- "last_name": {
- "maxLength": 64,
- "type": "string"
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "required": ["first_name", "last_name"],
- "type": "object"
+ "security": [
+ {
+ "jwt": []
+ }
+ ],
+ "summary": "Delete multiple annotation layers in a bulk operation",
+ "tags": [
+ "Annotation Layers"
+ ]
},
- "SavedQueryRestApi.post": {
- "properties": {
- "db_id": {
- "nullable": true,
- "type": "integer"
- },
- "description": {
- "nullable": true,
- "type": "string"
+ "get": {
+ "description": "Gets a list of annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.",
+ "parameters": [
+ {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/get_list_schema"
+ }
+ }
+ },
+ "in": "query",
+ "name": "q"
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "description": "The total record count on the backend",
+ "type": "number"
+ },
+ "description_columns": {
+ "properties": {
+ "column_name": {
+ "description": "The description for the column name. Will be translated by babel",
+ "example": "A Nice description for the column",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ids": {
+ "description": "A list of item ids, useful when you don't know the column id",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "label_columns": {
+ "properties": {
+ "column_name": {
+ "description": "The label for the column name. Will be translated by babel",
+ "example": "A Nice label for the column",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "list_columns": {
+ "description": "A list of columns",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "list_title": {
+ "description": "A title to render. Will be translated by babel",
+ "example": "List Items",
+ "type": "string"
+ },
+ "order_columns": {
+ "description": "A list of allowed columns to sort",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "result": {
+ "description": "The result from the get list query",
+ "items": {
+ "$ref": "#/components/schemas/AnnotationLayerRestApi.get_list"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "Items from Model"
},
- "label": {
- "maxLength": 256,
- "nullable": true,
- "type": "string"
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "schema": {
- "maxLength": 128,
- "nullable": true,
- "type": "string"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "sql": {
- "nullable": true,
- "type": "string"
+ "422": {
+ "$ref": "#/components/responses/422"
},
- "template_parameters": {
- "nullable": true,
- "type": "string"
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
+ "security": [
+ {
+ "jwt": []
+ }
+ ],
+ "summary": "Get a list of annotation layers",
+ "tags": [
+ "Annotation Layers"
+ ]
},
- "SavedQueryRestApi.put": {
- "properties": {
- "db_id": {
- "nullable": true,
- "type": "integer"
+ "post": {
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AnnotationLayerRestApi.post"
+ }
+ }
},
- "description": {
- "nullable": true,
- "type": "string"
+ "description": "Annotation Layer schema",
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "result": {
+ "$ref": "#/components/schemas/AnnotationLayerRestApi.post"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "Annotation added"
},
- "label": {
- "maxLength": 256,
- "nullable": true,
- "type": "string"
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "schema": {
- "maxLength": 128,
- "nullable": true,
- "type": "string"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "sql": {
- "nullable": true,
- "type": "string"
+ "404": {
+ "$ref": "#/components/responses/404"
},
- "template_parameters": {
- "nullable": true,
- "type": "string"
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
- },
- "SchemasResponseSchema": {
- "properties": {
- "result": {
- "items": {
- "description": "A database schema name",
- "type": "string"
- },
- "type": "array"
+ "security": [
+ {
+ "jwt": []
}
- },
- "type": "object"
- },
- "SelectStarResponseSchema": {
- "properties": {
- "result": {
- "description": "SQL select star",
- "type": "string"
+ ],
+ "summary": "Create an annotation layer",
+ "tags": [
+ "Annotation Layers"
+ ]
+ }
+ },
+ "/api/v1/annotation_layer/_info": {
+ "get": {
+ "description": "Get metadata information about this API resource",
+ "parameters": [
+ {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/get_info_schema"
+ }
+ }
+ },
+ "in": "query",
+ "name": "q"
}
- },
- "type": "object"
- },
- "Slice": {
- "properties": {
- "cache_timeout": {
- "description": "Duration (in seconds) of the caching timeout for this chart.",
- "type": "integer"
- },
- "certification_details": {
- "description": "Details of the certification.",
- "type": "string"
- },
- "certified_by": {
- "description": "Person or group that has certified this dashboard.",
- "type": "string"
- },
- "changed_on": {
- "description": "Timestamp of the last modification.",
- "format": "date-time",
- "type": "string"
- },
- "changed_on_humanized": {
- "description": "Timestamp of the last modification in human readable form.",
- "type": "string"
- },
- "datasource": {
- "description": "Datasource identifier.",
- "type": "string"
- },
- "description": {
- "description": "Slice description.",
- "type": "string"
- },
- "description_markeddown": {
- "description": "Sanitized HTML version of the chart description.",
- "type": "string"
- },
- "edit_url": {
- "description": "The URL for editing the slice.",
- "type": "string"
- },
- "form_data": {
- "description": "Form data associated with the slice.",
- "type": "object"
- },
- "is_managed_externally": {
- "description": "If the chart is managed outside externally.",
- "type": "boolean"
- },
- "modified": {
- "description": "Last modification in human readable form.",
- "type": "string"
- },
- "owners": {
- "description": "Owners identifiers.",
- "items": {
- "type": "integer"
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "add_columns": {
+ "type": "object"
+ },
+ "edit_columns": {
+ "type": "object"
+ },
+ "filters": {
+ "properties": {
+ "column_name": {
+ "items": {
+ "properties": {
+ "name": {
+ "description": "The filter name. Will be translated by babel",
+ "type": "string"
+ },
+ "operator": {
+ "description": "The filter operation key to use on list filters",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "permissions": {
+ "description": "The user permissions for this API resource",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ }
},
- "type": "array"
+ "description": "Item from Model"
},
- "query_context": {
- "description": "The context associated with the query.",
- "type": "object"
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "slice_id": {
- "description": "The slice ID.",
- "type": "integer"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "slice_name": {
- "description": "The slice name.",
- "type": "string"
+ "422": {
+ "$ref": "#/components/responses/422"
},
- "slice_url": {
- "description": "The slice URL.",
- "type": "string"
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
- },
- "StopQuerySchema": {
- "properties": {
- "client_id": {
- "type": "string"
+ "security": [
+ {
+ "jwt": []
}
- },
- "type": "object"
- },
- "TableExtraMetadataResponseSchema": {
- "properties": {
- "clustering": {
- "type": "object"
- },
- "metadata": {
- "type": "object"
+ ],
+ "summary": "Get metadata information about this API resource",
+ "tags": [
+ "Annotation Layers"
+ ]
+ }
+ },
+ "/api/v1/annotation_layer/related/{column_name}": {
+ "get": {
+ "parameters": [
+ {
+ "in": "path",
+ "name": "column_name",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
},
- "partitions": {
- "type": "object"
+ {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/get_related_schema"
+ }
+ }
+ },
+ "in": "query",
+ "name": "q"
}
- },
- "type": "object"
- },
- "TableMetadataColumnsResponse": {
- "properties": {
- "duplicates_constraint": {
- "type": "string"
- },
- "keys": {
- "description": "",
- "items": {
- "type": "string"
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RelatedResponseSchema"
+ }
+ }
},
- "type": "array"
+ "description": "Related column data"
},
- "longType": {
- "description": "The actual backend long type for the column",
- "type": "string"
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "name": {
- "description": "The column name",
- "type": "string"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "type": {
- "description": "The column type",
- "type": "string"
+ "404": {
+ "$ref": "#/components/responses/404"
+ },
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
- },
- "TableMetadataForeignKeysIndexesResponse": {
- "properties": {
- "column_names": {
- "items": {
- "description": "A list of column names that compose the foreign key or index",
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "The name of the foreign key or index",
- "type": "string"
- },
- "options": {
- "$ref": "#/components/schemas/TableMetadataOptionsResponse"
- },
- "referred_columns": {
- "items": {
- "type": "string"
+ "security": [
+ {
+ "jwt": []
+ }
+ ],
+ "summary": "Get related fields data",
+ "tags": [
+ "Annotation Layers"
+ ]
+ }
+ },
+ "/api/v1/annotation_layer/{pk}": {
+ "delete": {
+ "parameters": [
+ {
+ "description": "The annotation layer pk for this annotation",
+ "in": "path",
+ "name": "pk",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
},
- "type": "array"
+ "description": "Item deleted"
},
- "referred_schema": {
- "type": "string"
+ "404": {
+ "$ref": "#/components/responses/404"
},
- "referred_table": {
- "type": "string"
+ "422": {
+ "$ref": "#/components/responses/422"
},
- "type": {
- "type": "string"
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
+ "security": [
+ {
+ "jwt": []
+ }
+ ],
+ "summary": "Delete annotation layer",
+ "tags": [
+ "Annotation Layers"
+ ]
},
- "TableMetadataOptionsResponse": {
- "properties": {
- "deferrable": {
- "type": "boolean"
+ "get": {
+ "description": "Get an item model",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "pk",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
},
- "initially": {
- "type": "boolean"
+ {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/get_item_schema"
+ }
+ }
+ },
+ "in": "query",
+ "name": "q"
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "description_columns": {
+ "properties": {
+ "column_name": {
+ "description": "The description for the column name. Will be translated by babel",
+ "example": "A Nice description for the column",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The item id",
+ "type": "string"
+ },
+ "label_columns": {
+ "properties": {
+ "column_name": {
+ "description": "The label for the column name. Will be translated by babel",
+ "example": "A Nice label for the column",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "result": {
+ "$ref": "#/components/schemas/AnnotationLayerRestApi.get"
+ },
+ "show_columns": {
+ "description": "A list of columns",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "show_title": {
+ "description": "A title to render. Will be translated by babel",
+ "example": "Show Item Details",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "Item from Model"
+ },
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "match": {
- "type": "boolean"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "ondelete": {
- "type": "boolean"
+ "404": {
+ "$ref": "#/components/responses/404"
},
- "onupdate": {
- "type": "boolean"
+ "422": {
+ "$ref": "#/components/responses/422"
+ },
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
+ "security": [
+ {
+ "jwt": []
+ }
+ ],
+ "summary": "Get an annotation layer",
+ "tags": [
+ "Annotation Layers"
+ ]
},
- "TableMetadataPrimaryKeyResponse": {
- "properties": {
- "column_names": {
- "items": {
- "description": "A list of column names that compose the primary key",
- "type": "string"
+ "put": {
+ "parameters": [
+ {
+ "description": "The annotation layer pk for this annotation",
+ "in": "path",
+ "name": "pk",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AnnotationLayerRestApi.put"
+ }
+ }
+ },
+ "description": "Annotation schema",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "result": {
+ "$ref": "#/components/schemas/AnnotationLayerRestApi.put"
+ }
+ },
+ "type": "object"
+ }
+ }
},
- "type": "array"
+ "description": "Annotation changed"
},
- "name": {
- "description": "The primary key index name",
- "type": "string"
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "type": {
- "type": "string"
+ "401": {
+ "$ref": "#/components/responses/401"
+ },
+ "404": {
+ "$ref": "#/components/responses/404"
+ },
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
- },
- "TableMetadataResponseSchema": {
- "properties": {
- "columns": {
- "description": "A list of columns and their metadata",
- "items": {
- "$ref": "#/components/schemas/TableMetadataColumnsResponse"
- },
- "type": "array"
+ "security": [
+ {
+ "jwt": []
+ }
+ ],
+ "summary": "Update an annotation layer",
+ "tags": [
+ "Annotation Layers"
+ ]
+ }
+ },
+ "/api/v1/annotation_layer/{pk}/annotation/": {
+ "delete": {
+ "parameters": [
+ {
+ "description": "The annotation layer pk for this annotation",
+ "in": "path",
+ "name": "pk",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
},
- "foreignKeys": {
- "description": "A list of foreign keys and their metadata",
- "items": {
- "$ref": "#/components/schemas/TableMetadataForeignKeysIndexesResponse"
+ {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/get_delete_ids_schema"
+ }
+ }
},
- "type": "array"
- },
- "indexes": {
- "description": "A list of indexes and their metadata",
- "items": {
- "$ref": "#/components/schemas/TableMetadataForeignKeysIndexesResponse"
+ "in": "query",
+ "name": "q"
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
},
- "type": "array"
- },
- "name": {
- "description": "The name of the table",
- "type": "string"
+ "description": "Annotations bulk delete"
},
- "primaryKey": {
- "allOf": [
- {
- "$ref": "#/components/schemas/TableMetadataPrimaryKeyResponse"
- }
- ],
- "description": "Primary keys metadata"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "selectStar": {
- "description": "SQL select star",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Tables": {
- "properties": {
- "id": {
- "type": "integer"
+ "404": {
+ "$ref": "#/components/responses/404"
},
- "schema": {
- "type": "string"
+ "422": {
+ "$ref": "#/components/responses/422"
},
- "table_name": {
- "type": "string"
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
+ "security": [
+ {
+ "jwt": []
+ }
+ ],
+ "summary": "Bulk delete annotation layers",
+ "tags": [
+ "Annotation Layers"
+ ]
},
- "Tag": {
- "properties": {
- "id": {
- "type": "integer"
- },
- "name": {
- "type": "string"
+ "get": {
+ "description": "Gets a list of annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.",
+ "parameters": [
+ {
+ "description": "The annotation layer id for this annotation",
+ "in": "path",
+ "name": "pk",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
},
- "type": {
- "enum": [1, 2, 3, 4]
+ {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/get_list_schema"
+ }
+ }
+ },
+ "in": "query",
+ "name": "q"
}
- },
- "type": "object"
- },
- "Tag1": {
- "properties": {
- "id": {
- "type": "integer"
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "description": "The total record count on the backend",
+ "type": "number"
+ },
+ "ids": {
+ "description": "A list of annotation ids",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "result": {
+ "description": "The result from the get list query",
+ "items": {
+ "$ref": "#/components/schemas/AnnotationRestApi.get_list"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "Items from Annotations"
},
- "name": {
- "type": "string"
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "type": {
- "enum": [1, 2, 3, 4]
- }
- },
- "type": "object"
- },
- "TagGetResponseSchema": {
- "properties": {
- "id": {
- "type": "integer"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "name": {
- "type": "string"
+ "422": {
+ "$ref": "#/components/responses/422"
},
- "type": {
- "type": "string"
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
+ "security": [
+ {
+ "jwt": []
+ }
+ ],
+ "summary": "Get a list of annotation layers",
+ "tags": [
+ "Annotation Layers"
+ ]
},
- "TagRestApi.get": {
- "properties": {
- "changed_by": {
- "$ref": "#/components/schemas/TagRestApi.get.User1"
+ "post": {
+ "parameters": [
+ {
+ "description": "The annotation layer pk for this annotation",
+ "in": "path",
+ "name": "pk",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AnnotationRestApi.post"
+ }
+ }
},
- "changed_on_delta_humanized": {
- "readOnly": true
+ "description": "Annotation schema",
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "result": {
+ "$ref": "#/components/schemas/AnnotationRestApi.post"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "Annotation added"
},
- "created_by": {
- "$ref": "#/components/schemas/TagRestApi.get.User"
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "id": {
- "type": "integer"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "name": {
- "maxLength": 250,
- "nullable": true,
- "type": "string"
+ "404": {
+ "$ref": "#/components/responses/404"
},
- "type": {
- "enum": [1, 2, 3, 4]
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
- },
- "TagRestApi.get.User": {
- "properties": {
- "active": {
- "nullable": true,
- "type": "boolean"
- },
- "changed_on": {
- "format": "date-time",
- "nullable": true,
- "type": "string"
- },
- "created_on": {
- "format": "date-time",
- "nullable": true,
- "type": "string"
- },
- "email": {
- "maxLength": 64,
- "type": "string"
- },
- "fail_login_count": {
- "nullable": true,
- "type": "integer"
- },
- "first_name": {
- "maxLength": 64,
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "last_login": {
- "format": "date-time",
- "nullable": true,
- "type": "string"
+ "security": [
+ {
+ "jwt": []
+ }
+ ],
+ "summary": "Create an annotation layer",
+ "tags": [
+ "Annotation Layers"
+ ]
+ }
+ },
+ "/api/v1/annotation_layer/{pk}/annotation/{annotation_id}": {
+ "delete": {
+ "parameters": [
+ {
+ "description": "The annotation layer pk for this annotation",
+ "in": "path",
+ "name": "pk",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
},
- "last_name": {
- "maxLength": 64,
- "type": "string"
+ {
+ "description": "The annotation pk for this annotation",
+ "in": "path",
+ "name": "annotation_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "Item deleted"
},
- "login_count": {
- "nullable": true,
- "type": "integer"
+ "404": {
+ "$ref": "#/components/responses/404"
},
- "password": {
- "maxLength": 256,
- "nullable": true,
- "type": "string"
+ "422": {
+ "$ref": "#/components/responses/422"
},
- "username": {
- "maxLength": 64,
- "type": "string"
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "required": ["email", "first_name", "last_name", "username"],
- "type": "object"
+ "security": [
+ {
+ "jwt": []
+ }
+ ],
+ "summary": "Delete annotation layer",
+ "tags": [
+ "Annotation Layers"
+ ]
},
- "TagRestApi.get.User1": {
- "properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
+ "get": {
+ "parameters": [
+ {
+ "description": "The annotation layer pk for this annotation",
+ "in": "path",
+ "name": "pk",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
},
- "last_name": {
- "maxLength": 64,
- "type": "string"
+ {
+ "description": "The annotation pk",
+ "in": "path",
+ "name": "annotation_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/get_item_schema"
+ }
+ }
+ },
+ "in": "query",
+ "name": "q"
}
- },
- "required": ["first_name", "last_name"],
- "type": "object"
- },
- "TagRestApi.get_list": {
- "properties": {
- "changed_by": {
- "$ref": "#/components/schemas/TagRestApi.get_list.User1"
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "id": {
+ "description": "The item id",
+ "type": "string"
+ },
+ "result": {
+ "$ref": "#/components/schemas/AnnotationRestApi.get"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "Item from Model"
},
- "changed_on_delta_humanized": {
- "readOnly": true
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "created_by": {
- "$ref": "#/components/schemas/TagRestApi.get_list.User"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "id": {
- "type": "integer"
+ "404": {
+ "$ref": "#/components/responses/404"
},
- "name": {
- "maxLength": 250,
- "nullable": true,
- "type": "string"
+ "422": {
+ "$ref": "#/components/responses/422"
},
- "type": {
- "enum": [1, 2, 3, 4]
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
- },
- "TagRestApi.get_list.User": {
- "properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
- },
- "last_name": {
- "maxLength": 64,
- "type": "string"
+ "security": [
+ {
+ "jwt": []
}
- },
- "required": ["first_name", "last_name"],
- "type": "object"
+ ],
+ "summary": "Get an annotation layer",
+ "tags": [
+ "Annotation Layers"
+ ]
},
- "TagRestApi.get_list.User1": {
- "properties": {
- "first_name": {
- "maxLength": 64,
- "type": "string"
+ "put": {
+ "parameters": [
+ {
+ "description": "The annotation layer pk for this annotation",
+ "in": "path",
+ "name": "pk",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
},
- "last_name": {
- "maxLength": 64,
- "type": "string"
+ {
+ "description": "The annotation pk for this annotation",
+ "in": "path",
+ "name": "annotation_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
}
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AnnotationRestApi.put"
+ }
+ }
+ },
+ "description": "Annotation schema",
+ "required": true
},
- "required": ["first_name", "last_name"],
- "type": "object"
- },
- "TagRestApi.post": {
- "properties": {
- "tags": {
- "items": {
- "type": "string"
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "result": {
+ "$ref": "#/components/schemas/AnnotationRestApi.put"
+ }
+ },
+ "type": "object"
+ }
+ }
},
- "type": "array"
- }
- },
- "type": "object"
- },
- "TagRestApi.put": {
- "properties": {
- "id": {
- "type": "integer"
- }
- },
- "type": "object"
- },
- "TaggedObjectEntityResponseSchema": {
- "properties": {
- "changed_on": {
- "format": "date-time",
- "type": "string"
- },
- "created_by": {
- "$ref": "#/components/schemas/User"
- },
- "creator": {
- "type": "string"
+ "description": "Annotation changed"
},
- "id": {
- "type": "integer"
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "name": {
- "type": "string"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "type": {
- "type": "string"
+ "404": {
+ "$ref": "#/components/responses/404"
},
- "url": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "TemporaryCachePostSchema": {
- "properties": {
- "value": {
- "description": "Any type of JSON supported text.",
- "type": "string"
- }
- },
- "required": ["value"],
- "type": "object"
- },
- "TemporaryCachePutSchema": {
- "properties": {
- "value": {
- "description": "Any type of JSON supported text.",
- "type": "string"
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "required": ["value"],
- "type": "object"
- },
- "User": {
- "properties": {
- "first_name": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "last_name": {
- "type": "string"
+ "security": [
+ {
+ "jwt": []
}
- },
- "type": "object"
- },
- "User1": {
- "properties": {
- "first_name": {
- "type": "string"
- },
- "id": {
- "type": "integer"
+ ],
+ "summary": "Update an annotation layer",
+ "tags": [
+ "Annotation Layers"
+ ]
+ }
+ },
+ "/api/v1/apple/health": {
+ "get": {
+ "description": "Endpoint for checking the health status of the metastore and cache",
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AppleHealthResponseSchema"
+ }
+ }
+ },
+ "description": "The"
},
- "last_name": {
- "type": "string"
+ "400": {
+ "$ref": "#/components/responses/400"
},
- "username": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "User2": {
- "properties": {
- "first_name": {
- "type": "string"
+ "401": {
+ "$ref": "#/components/responses/401"
},
- "last_name": {
- "type": "string"
+ "403": {
+ "$ref": "#/components/responses/403"
},
- "username": {
- "type": "string"
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
- "type": "object"
- },
- "UserResponseSchema": {
- "properties": {
- "email": {
- "type": "string"
- },
- "first_name": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "is_active": {
- "type": "boolean"
+ "summary": "Get the health status of the metastore and cache",
+ "tags": [
+ "Apple"
+ ]
+ }
+ },
+ "/api/v1/assets/export/": {
+ "get": {
+ "description": "Gets a ZIP file with all the Superset assets (databases, datasets, charts, dashboards, saved queries) as YAML files.",
+ "responses": {
+ "200": {
+ "content": {
+ "application/zip": {
+ "schema": {
+ "format": "binary",
+ "type": "string"
+ }
+ }
+ },
... 12425 lines suppressed ...