Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Update generated docs (master) (#64078)

github-automation-metabase5fe1efe15ba2
diff --git a/docs/api.html b/docs/api.html
index 4613bbb799b..ad7407898b4 100644
--- a/docs/api.html
+++ b/docs/api.html
@@ -83,30 +83,6 @@ redirect_from:
},
"components" : {
"schemas" : {
- "api.tiles.route-params" : {
- "type" : "object",
- "properties" : {
- "lat-field" : {
- "type" : "string"
- },
- "lon-field" : {
- "type" : "string"
- },
- "x" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- },
- "y" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- },
- "zoom" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- }
- },
- "required" : [ "zoom", "x", "y", "lat-field", "lon-field" ]
- },
"gsheets.response" : {
"anyOf" : [ {
"type" : "object",
@@ -1984,26 +1960,52 @@ redirect_from:
"enum" : [ "none", "global-schedule" ]
},
"metabase-enterprise.transforms.api.transform-source" : {
- "type" : "object",
- "properties" : {
- "query" : {
- "type" : "object",
- "properties" : {
- "database" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "database" ]
+ },
+ "type" : {
+ "const" : "query"
+ }
+ },
+ "required" : [ "type", "query" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "string"
+ },
+ "source-database" : {
+ "type" : "integer"
+ },
+ "source-tables" : {
+ "type" : "object",
+ "additionalProperties" : {
"type" : "integer"
}
},
- "required" : [ "database" ]
+ "type" : {
+ "const" : "python"
+ }
},
- "type" : {
- "const" : "query"
- }
- },
- "required" : [ "type", "query" ]
+ "required" : [ "source-tables", "type", "body" ],
+ "additionalProperties" : false
+ } ]
},
"metabase-enterprise.transforms.api.transform-target" : {
"type" : "object",
"properties" : {
+ "database" : {
+ "type" : "integer"
+ },
"name" : {
"type" : "string"
},
@@ -17607,11 +17609,18 @@ redirect_from:
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/tiles/card/{token}/{zoom}/{x}/{y}/{lat-field}/{lon-field}" : {
+ "/api/embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
"get" : {
- "summary" : "GET /api/embed/tiles/card/{token}/{zoom}/{x}/{y}/{lat-field}/{lon-field}",
+ "summary" : "GET /api/embed/tiles/card/{token}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for an embedded Card using the map visualization.",
"parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
"in" : "path",
"name" : "zoom",
"required" : true,
@@ -17636,34 +17645,27 @@ redirect_from:
},
"description" : "value must be an integer."
}, {
- "in" : "path",
- "name" : "lat-field",
- "required" : true,
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
"schema" : {
"type" : "string"
- }
+ },
+ "description" : "value must be a valid JSON string."
}, {
- "in" : "path",
- "name" : "lon-field",
+ "in" : "query",
+ "name" : "latField",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "in" : "path",
- "name" : "token",
+ "in" : "query",
+ "name" : "lonField",
"required" : true,
"schema" : {
"type" : "string"
}
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "type" : "string"
- },
- "description" : "value must be a valid JSON string."
} ],
"responses" : {
"2XX" : {
@@ -17679,11 +17681,36 @@ redirect_from:
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}/{lat-field}/{lon-field}" : {
+ "/api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
- "summary" : "GET /api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}/{lat-field}/{lon-field}",
+ "summary" : "GET /api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
"parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
"in" : "path",
"name" : "zoom",
"required" : true,
@@ -17708,52 +17735,27 @@ redirect_from:
},
"description" : "value must be an integer."
}, {
- "in" : "path",
- "name" : "lat-field",
- "required" : true,
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
"schema" : {
"type" : "string"
- }
+ },
+ "description" : "value must be a valid JSON string."
}, {
- "in" : "path",
- "name" : "lon-field",
+ "in" : "query",
+ "name" : "latField",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "in" : "path",
- "name" : "token",
+ "in" : "query",
+ "name" : "lonField",
"required" : true,
"schema" : {
"type" : "string"
}
- }, {
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "type" : "string"
- },
- "description" : "value must be a valid JSON string."
} ],
"responses" : {
"2XX" : {
@@ -20763,11 +20765,18 @@ redirect_from:
"tags" : [ "/api/preview_embed" ]
}
},
- "/api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}/{lat-field}/{lon-field}" : {
+ "/api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
"get" : {
- "summary" : "GET /api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}/{lat-field}/{lon-field}",
+ "summary" : "GET /api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for an embedded Card using the map visualization.",
"parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
"in" : "path",
"name" : "zoom",
"required" : true,
@@ -20792,34 +20801,27 @@ redirect_from:
},
"description" : "value must be an integer."
}, {
- "in" : "path",
- "name" : "lat-field",
- "required" : true,
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
"schema" : {
"type" : "string"
- }
+ },
+ "description" : "value must be a valid JSON string."
}, {
- "in" : "path",
- "name" : "lon-field",
+ "in" : "query",
+ "name" : "latField",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "in" : "path",
- "name" : "token",
+ "in" : "query",
+ "name" : "lonField",
"required" : true,
"schema" : {
"type" : "string"
}
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "type" : "string"
- },
- "description" : "value must be a valid JSON string."
} ],
"responses" : {
"2XX" : {
@@ -20835,11 +20837,36 @@ redirect_from:
"tags" : [ "/api/preview_embed" ]
}
},
- "/api/preview_embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}/{lat-field}/{lon-field}" : {
+ "/api/preview_embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
- "summary" : "GET /api/preview_embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}/{lat-field}/{lon-field}",
+ "summary" : "GET /api/preview_embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
"parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
"in" : "path",
"name" : "zoom",
"required" : true,
@@ -20864,52 +20891,27 @@ redirect_from:
},
"description" : "value must be an integer."
}, {
- "in" : "path",
- "name" : "lat-field",
- "required" : true,
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
"schema" : {
"type" : "string"
- }
+ },
+ "description" : "value must be a valid JSON string."
}, {
- "in" : "path",
- "name" : "lon-field",
+ "in" : "query",
+ "name" : "latField",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "in" : "path",
- "name" : "token",
+ "in" : "query",
+ "name" : "lonField",
"required" : true,
"schema" : {
"type" : "string"
}
- }, {
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "type" : "string"
- },
- "description" : "value must be a valid JSON string."
} ],
"responses" : {
"2XX" : {
@@ -21805,11 +21807,20 @@ redirect_from:
"tags" : [ "/api/public" ]
}
},
- "/api/public/tiles/card/{uuid}/{zoom}/{x}/{y}/{lat-field}/{lon-field}" : {
+ "/api/public/tiles/card/{uuid}/{zoom}/{x}/{y}" : {
"get" : {
- "summary" : "GET /api/public/tiles/card/{uuid}/{zoom}/{x}/{y}/{lat-field}/{lon-field}",
+ "summary" : "GET /api/public/tiles/card/{uuid}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a publicly-accessible Card using the map visualization. Does not require auth\n credentials. Public sharing must be enabled.",
"parameters" : [ {
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "description" : "value must be a valid UUID."
+ }, {
"in" : "path",
"name" : "zoom",
"required" : true,
@@ -21834,36 +21845,27 @@ redirect_from:
},
"description" : "value must be an integer."
}, {
- "in" : "path",
- "name" : "lat-field",
- "required" : true,
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
"schema" : {
"type" : "string"
- }
+ },
+ "description" : "value must be a valid JSON string."
}, {
- "in" : "path",
- "name" : "lon-field",
+ "in" : "query",
+ "name" : "latField",
"required" : true,
"schema" : {
"type" : "string"
}
- }, {
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "description" : "value must be a valid UUID."
}, {
"in" : "query",
- "name" : "parameters",
- "required" : false,
+ "name" : "lonField",
+ "required" : true,
"schema" : {
"type" : "string"
- },
- "description" : "value must be a valid JSON string."
+ }
} ],
"responses" : {
"2XX" : {
@@ -21879,75 +21881,61 @@ redirect_from:
"tags" : [ "/api/public" ]
}
},
- "/api/public/tiles/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}/{lat-field}/{lon-field}" : {
+ "/api/public/tiles/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
- "summary" : "GET /api/public/tiles/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}/{lat-field}/{lon-field}",
+ "summary" : "GET /api/public/tiles/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a Card using the map visualization in a publicly-accessible Dashboard. Does not\n require auth credentials. Public sharing must be enabled.",
"parameters" : [ {
"in" : "path",
- "name" : "zoom",
+ "name" : "uuid",
"required" : true,
"schema" : {
- "type" : "integer"
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
- "description" : "value must be an integer."
+ "description" : "value must be a valid UUID."
}, {
"in" : "path",
- "name" : "x",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
- "type" : "integer"
+ "type" : "integer",
+ "minimum" : 1
},
- "description" : "value must be an integer."
+ "description" : "value must be an integer greater than zero."
}, {
"in" : "path",
- "name" : "y",
+ "name" : "card-id",
"required" : true,
"schema" : {
- "type" : "integer"
+ "type" : "integer",
+ "minimum" : 1
},
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "lat-field",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "lon-field",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
+ "description" : "value must be an integer greater than zero."
}, {
"in" : "path",
- "name" : "uuid",
+ "name" : "zoom",
"required" : true,
"schema" : {
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "type" : "integer"
},
- "description" : "value must be a valid UUID."
+ "description" : "value must be an integer."
}, {
"in" : "path",
- "name" : "dashcard-id",
+ "name" : "x",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
},
- "description" : "value must be an integer greater than zero."
+ "description" : "value must be an integer."
}, {
"in" : "path",
- "name" : "card-id",
+ "name" : "y",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
},
- "description" : "value must be an integer greater than zero."
+ "description" : "value must be an integer."
}, {
"in" : "query",
"name" : "parameters",
@@ -21956,6 +21944,20 @@ redirect_from:
"type" : "string"
},
"description" : "value must be a valid JSON string."
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {
@@ -24350,11 +24352,20 @@ redirect_from:
"tags" : [ "/api/task" ]
}
},
- "/api/tiles/{card-id}/{zoom}/{x}/{y}/{lat-field}/{lon-field}" : {
+ "/api/tiles/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
- "summary" : "GET /api/tiles/{card-id}/{zoom}/{x}/{y}/{lat-field}/{lon-field}",
+ "summary" : "GET /api/tiles/{card-id}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a saved Card.",
"parameters" : [ {
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
"in" : "path",
"name" : "zoom",
"required" : true,
@@ -24379,36 +24390,27 @@ redirect_from:
},
"description" : "value must be an integer."
}, {
- "in" : "path",
- "name" : "lat-field",
- "required" : true,
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
"schema" : {
"type" : "string"
- }
+ },
+ "description" : "value must be a valid JSON string."
}, {
- "in" : "path",
- "name" : "lon-field",
+ "in" : "query",
+ "name" : "latField",
"required" : true,
"schema" : {
"type" : "string"
}
- }, {
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
}, {
"in" : "query",
- "name" : "parameters",
- "required" : false,
+ "name" : "lonField",
+ "required" : true,
"schema" : {
"type" : "string"
- },
- "description" : "value must be a valid JSON string."
+ }
} ],
"responses" : {
"2XX" : {
@@ -24424,75 +24426,61 @@ redirect_from:
"tags" : [ "/api/tiles" ]
}
},
- "/api/tiles/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}/{lat-field}/{lon-field}" : {
+ "/api/tiles/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
- "summary" : "GET /api/tiles/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}/{lat-field}/{lon-field}",
+ "summary" : "GET /api/tiles/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for a dashcard.",
"parameters" : [ {
"in" : "path",
- "name" : "zoom",
+ "name" : "dashboard-id",
"required" : true,
"schema" : {
- "type" : "integer"
+ "type" : "integer",
+ "minimum" : 1
},
- "description" : "value must be an integer."
+ "description" : "value must be an integer greater than zero."
}, {
"in" : "path",
- "name" : "x",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
- "type" : "integer"
+ "type" : "integer",
+ "minimum" : 1
},
- "description" : "value must be an integer."
+ "description" : "value must be an integer greater than zero."
}, {
"in" : "path",
- "name" : "y",
+ "name" : "card-id",
"required" : true,
"schema" : {
- "type" : "integer"
+ "type" : "integer",
+ "minimum" : 1
},
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "lat-field",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "lon-field",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
+ "description" : "value must be an integer greater than zero."
}, {
"in" : "path",
- "name" : "dashboard-id",
+ "name" : "zoom",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
},
- "description" : "value must be an integer greater than zero."
+ "description" : "value must be an integer."
}, {
"in" : "path",
- "name" : "dashcard-id",
+ "name" : "x",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
},
- "description" : "value must be an integer greater than zero."
+ "description" : "value must be an integer."
}, {
"in" : "path",
- "name" : "card-id",
+ "name" : "y",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
},
- "description" : "value must be an integer greater than zero."
+ "description" : "value must be an integer."
}, {
"in" : "query",
"name" : "parameters",
@@ -24501,6 +24489,20 @@ redirect_from:
"type" : "string"
},
"description" : "value must be a valid JSON string."
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {
@@ -24516,11 +24518,35 @@ redirect_from:
"tags" : [ "/api/tiles" ]
}
},
- "/api/tiles/{zoom}/{x}/{y}/{lat-field}/{lon-field}" : {
+ "/api/tiles/{zoom}/{x}/{y}" : {
"get" : {
- "summary" : "GET /api/tiles/{zoom}/{x}/{y}/{lat-field}/{lon-field}",
+ "summary" : "GET /api/tiles/{zoom}/{x}/{y}",
"description" : "Generates a single tile image for an ad-hoc query.",
"parameters" : [ {
+ "in" : "path",
+ "name" : "zoom",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "x",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "y",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
"in" : "query",
"name" : "query",
"required" : true,
@@ -24528,6 +24554,20 @@ redirect_from:
"type" : "string"
},
"description" : "value must be a valid JSON string."
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {