QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-05-22 00:05:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: cut 6.1.0 versions for user_docs, admin_docs, developer_docs, components (#40126)

Browse Source 
Co-authored-by: Claude Code <noreply@anthropic.com>
This commit is contained in:
Evan Rusackas
2026-05-18 12:59:39 -07:00
committed by GitHub
parent 43231d56df
commit 6fa0b48752
2045 changed files with 88217 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

826
docs/developer_docs_versioned_docs/version-6.1.0/_versioned_data/static/data/components.json Normal file
View File

@@ -0,0 +1,826 @@
{
"generated": "2026-05-15T16:18:58.919Z",
"statistics": {
"totalComponents": 54,
"byCategory": {
"ui": 46,
"design-system": 7,
"extension": 1
},
"extensionCompatible": 1,
"withGallery": 2,
"withLiveExample": 36
},
"components": [
{
"name": "AutoComplete",
"category": "ui",
"categoryLabel": "Core Components",
"description": "AutoComplete component for search functionality.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 1,
"controlsCount": 16,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/autocomplete",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/AutoComplete/AutoComplete.stories.tsx"
},
{
"name": "Avatar",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 7,
"controlsCount": 7,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/avatar",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Avatar/Avatar.stories.tsx"
},
{
"name": "Badge",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 4,
"controlsCount": 5,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/badge",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Badge/Badge.stories.tsx"
},
{
"name": "Breadcrumb",
"category": "ui",
"categoryLabel": "Core Components",
"description": "Breadcrumb component for displaying navigation paths.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 0,
"controlsCount": 1,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/breadcrumb",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Breadcrumb/Breadcrumb.stories.tsx"
},
{
"name": "Button",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 3,
"controlsCount": 7,
"hasGallery": true,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/button",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Button/Button.stories.tsx"
},
{
"name": "ButtonGroup",
"category": "ui",
"categoryLabel": "Core Components",
"description": "ButtonGroup is a container that groups multiple Button components together with consistent spacing and styling.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 1,
"controlsCount": 2,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/buttongroup",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/ButtonGroup/ButtonGroup.stories.tsx"
},
{
"name": "CachedLabel",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 0,
"controlsCount": 2,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/cachedlabel",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/CachedLabel/CachedLabel.stories.tsx"
},
{
"name": "Card",
"category": "ui",
"categoryLabel": "Core Components",
"description": "A container component for grouping related content. Supports titles, borders, loading states, and hover effects.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 6,
"controlsCount": 6,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/card",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Card/Card.stories.tsx"
},
{
"name": "Checkbox",
"category": "ui",
"categoryLabel": "Core Components",
"description": "Checkbox component that supports both regular and indeterminate states, built on top of Ant Design v5 Checkbox.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 2,
"controlsCount": 2,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/checkbox",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Checkbox/Checkbox.stories.tsx"
},
{
"name": "Collapse",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 5,
"controlsCount": 5,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/collapse",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Collapse/Collapse.stories.tsx"
},
{
"name": "DatePicker",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 2,
"controlsCount": 2,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/datepicker",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/DatePicker/DatePicker.stories.tsx"
},
{
"name": "Divider",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 6,
"controlsCount": 6,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/divider",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Divider/Divider.stories.tsx"
},
{
"name": "DropdownContainer",
"category": "design-system",
"categoryLabel": "Layout Components",
"description": "DropdownContainer arranges items horizontally and moves overflowing items into a dropdown popover. Resize the container to see the overflow behavior.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 0,
"controlsCount": 0,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/design-system/dropdowncontainer",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/DropdownContainer/DropdownContainer.stories.tsx"
},
{
"name": "EditableTitle",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 12,
"controlsCount": 12,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/editabletitle",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/EditableTitle/EditableTitle.stories.tsx"
},
{
"name": "EmptyState",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 5,
"controlsCount": 5,
"hasGallery": true,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/emptystate",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/EmptyState/EmptyState.stories.tsx"
},
{
"name": "FaveStar",
"category": "ui",
"categoryLabel": "Core Components",
"description": "FaveStar component for marking items as favorites",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 3,
"controlsCount": 3,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/favestar",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/FaveStar/FaveStar.stories.tsx"
},
{
"name": "Flex",
"category": "design-system",
"categoryLabel": "Layout Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 6,
"controlsCount": 6,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/design-system/flex",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Flex/Flex.stories.tsx"
},
{
"name": "Grid",
"category": "design-system",
"categoryLabel": "Layout Components",
"description": "The Grid system of Ant Design is based on a 24-grid layout. The `Row` and `Col` components are used to create flexible and responsive grid layouts.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 4,
"controlsCount": 4,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/design-system/grid",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Grid/Grid.stories.tsx"
},
{
"name": "IconButton",
"category": "ui",
"categoryLabel": "Core Components",
"description": "The IconButton component is a versatile button that allows you to combine an icon with a text label. It is designed for use in situations where you want to display an icon along with some text in a single clickable element.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 4,
"controlsCount": 4,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/iconbutton",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/IconButton/IconButton.stories.tsx"
},
{
"name": "IconTooltip",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 1,
"controlsCount": 2,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/icontooltip",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/IconTooltip/IconTooltip.stories.tsx"
},
{
"name": "Icons",
"category": "ui",
"categoryLabel": "Core Components",
"description": "Icon library for Apache Superset. Contains over 200 icons based on Ant Design icons with consistent sizing and theming support.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 1,
"controlsCount": 3,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/icons",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Icons/Icons.stories.tsx"
},
{
"name": "InfoTooltip",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 1,
"controlsCount": 3,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/infotooltip",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/InfoTooltip/InfoTooltip.stories.tsx"
},
{
"name": "Input",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 5,
"controlsCount": 10,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/input",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Input/Input.stories.tsx"
},
{
"name": "Label",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 3,
"controlsCount": 3,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/label",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Label/Label.stories.tsx"
},
{
"name": "Layout",
"category": "design-system",
"categoryLabel": "Layout Components",
"description": "Ant Design Layout component with configurable Sider, Header, Footer, and Content.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 1,
"controlsCount": 1,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/design-system/layout",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Layout/Layout.stories.tsx"
},
{
"name": "List",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 4,
"controlsCount": 4,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/list",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/List/List.stories.tsx"
},
{
"name": "ListViewCard",
"category": "ui",
"categoryLabel": "Core Components",
"description": "ListViewCard is a card component used to display items in list views with an image, title, description, and optional cover sections.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 7,
"controlsCount": 7,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/listviewcard",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/ListViewCard/ListViewCard.stories.tsx"
},
{
"name": "Loading",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 3,
"controlsCount": 3,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/loading",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Loading/Loading.stories.tsx"
},
{
"name": "Menu",
"category": "ui",
"categoryLabel": "Core Components",
"description": "Navigation menu component supporting horizontal, vertical, and inline modes. Based on Ant Design Menu with Superset styling.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 2,
"controlsCount": 4,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/menu",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Menu/Menu.stories.tsx"
},
{
"name": "MetadataBar",
"category": "design-system",
"categoryLabel": "Layout Components",
"description": "MetadataBar displays a row of metadata items (SQL info, owners, last modified, tags, dashboards, etc.) that collapse responsively based on available width.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 4,
"controlsCount": 4,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/design-system/metadatabar",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/MetadataBar/MetadataBar.stories.tsx"
},
{
"name": "Modal",
"category": "ui",
"categoryLabel": "Core Components",
"description": "Modal dialog component for displaying content that requires user attention or interaction. Supports customizable buttons, drag/resize, and confirmation dialogs.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 8,
"controlsCount": 8,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/modal",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Modal/Modal.stories.tsx"
},
{
"name": "ModalTrigger",
"category": "ui",
"categoryLabel": "Core Components",
"description": "A component that renders a trigger element which opens a modal when clicked. Useful for actions that need confirmation or additional input.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 9,
"controlsCount": 9,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/modaltrigger",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/ModalTrigger/ModalTrigger.stories.tsx"
},
{
"name": "Popover",
"category": "ui",
"categoryLabel": "Core Components",
"description": "A floating card that appears when hovering or clicking a trigger element. Supports configurable placement, trigger behavior, and custom content.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 4,
"controlsCount": 6,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/popover",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Popover/Popover.stories.tsx"
},
{
"name": "ProgressBar",
"category": "ui",
"categoryLabel": "Core Components",
"description": "Progress bar component for displaying completion status. Supports line, circle, and dashboard display types.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 6,
"controlsCount": 8,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/progressbar",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/ProgressBar/ProgressBar.stories.tsx"
},
{
"name": "Radio",
"category": "ui",
"categoryLabel": "Core Components",
"description": "Radio button component for selecting one option from a set. Supports standalone radio buttons, radio buttons styled as buttons, and grouped radio buttons with layout configuration.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 4,
"controlsCount": 4,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/radio",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Radio/Radio.stories.tsx"
},
{
"name": "SafeMarkdown",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 1,
"controlsCount": 2,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/safemarkdown",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/SafeMarkdown/SafeMarkdown.stories.tsx"
},
{
"name": "Select",
"category": "ui",
"categoryLabel": "Core Components",
"description": "A versatile select component supporting single and multi-select modes, search filtering, option creation, and both synchronous and asynchronous data sources.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 10,
"controlsCount": 10,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/select",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Select/Select.stories.tsx"
},
{
"name": "Skeleton",
"category": "ui",
"categoryLabel": "Core Components",
"description": "Skeleton loading component with support for avatar, title, paragraph, button, and input placeholders.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 7,
"controlsCount": 7,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/skeleton",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Skeleton/Skeleton.stories.tsx"
},
{
"name": "Slider",
"category": "ui",
"categoryLabel": "Core Components",
"description": "A slider input for selecting a value or range from a continuous or stepped interval. Supports single value, range, vertical orientation, marks, and tooltip display.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 10,
"controlsCount": 12,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/slider",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Slider/Slider.stories.tsx"
},
{
"name": "Space",
"category": "design-system",
"categoryLabel": "Layout Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 3,
"controlsCount": 4,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/design-system/space",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Space/Space.stories.tsx"
},
{
"name": "Steps",
"category": "ui",
"categoryLabel": "Core Components",
"description": "A navigation component for guiding users through multi-step workflows. Supports horizontal, vertical, and inline layouts with progress tracking.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 9,
"controlsCount": 9,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/steps",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Steps/Steps.stories.tsx"
},
{
"name": "Switch",
"category": "ui",
"categoryLabel": "Core Components",
"description": "A toggle switch for boolean on/off states. Supports loading indicators, sizing, and an HTML title attribute for accessibility tooltips.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 3,
"controlsCount": 5,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/switch",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Switch/Switch.stories.tsx"
},
{
"name": "Table",
"category": "design-system",
"categoryLabel": "Layout Components",
"description": "A data table component with sorting, pagination, row selection, resizable columns, reorderable columns, and virtualization for large datasets.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 11,
"controlsCount": 11,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/design-system/table",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Table/Table.stories.tsx"
},
{
"name": "TableCollection",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 0,
"controlsCount": 0,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/ui/tablecollection",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/TableCollection/TableCollection.stories.tsx"
},
{
"name": "TableView",
"category": "ui",
"categoryLabel": "Core Components",
"description": "A data table component with sorting, pagination, text wrapping, and empty state support. Built on react-table.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 12,
"controlsCount": 14,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/tableview",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/TableView/TableView.stories.tsx"
},
{
"name": "Tabs",
"category": "ui",
"categoryLabel": "Core Components",
"description": "A tabs component for switching between different views or content sections. Supports multiple tab styles, positions, and sizes.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 7,
"controlsCount": 7,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/tabs",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Tabs/Tabs.stories.tsx"
},
{
"name": "Timer",
"category": "ui",
"categoryLabel": "Core Components",
"description": "A live elapsed-time display that counts up from a given start time. Used to show query and dashboard load durations. Requires a startTime timestamp to function.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 2,
"controlsCount": 2,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/timer",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Timer/Timer.stories.tsx"
},
{
"name": "Tooltip",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 3,
"controlsCount": 6,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/tooltip",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Tooltip/Tooltip.stories.tsx"
},
{
"name": "Tree",
"category": "ui",
"categoryLabel": "Core Components",
"description": "The Tree component is used to display hierarchical data in a tree structure. It allows for features such as selection, expansion, and drag-and-drop functionality.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 8,
"controlsCount": 8,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/tree",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Tree/Tree.stories.tsx"
},
{
"name": "TreeSelect",
"category": "ui",
"categoryLabel": "Core Components",
"description": "TreeSelect is a select component that allows users to select from a tree structure.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 10,
"controlsCount": 10,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/treeselect",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/TreeSelect/TreeSelect.stories.tsx"
},
{
"name": "Typography",
"category": "ui",
"categoryLabel": "Core Components",
"description": "Typography is a component for displaying text with various styles and formats. It includes subcomponents like Title, Paragraph, and Link.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 11,
"controlsCount": 12,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/typography",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Typography/Typography.stories.tsx"
},
{
"name": "UnsavedChangesModal",
"category": "ui",
"categoryLabel": "Core Components",
"description": "",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 2,
"controlsCount": 2,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/unsavedchangesmodal",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/UnsavedChangesModal/UnsavedChangesModal.stories.tsx"
},
{
"name": "Upload",
"category": "ui",
"categoryLabel": "Core Components",
"description": "Upload component for file selection and uploading. Supports drag-and-drop, multiple files, and different list display styles.",
"importPath": "@superset/components",
"package": "@superset-ui/core/components",
"extensionCompatible": false,
"propsCount": 4,
"controlsCount": 4,
"hasGallery": false,
"hasLiveExample": true,
"docPath": "developer-docs/components/ui/upload",
"storyFile": "superset-frontend/packages/superset-ui-core/src/components/Upload/Upload.stories.tsx"
},
{
"name": "Alert",
"category": "extension",
"categoryLabel": "Extension Components",
"description": "Alert component for displaying important messages to users. Wraps Ant Design Alert with sensible defaults and improved accessibility.",
"importPath": "packages/superset-core/src/components/Alert",
"package": "@apache-superset/core/components",
"extensionCompatible": true,
"propsCount": 5,
"controlsCount": 5,
"hasGallery": false,
"hasLiveExample": false,
"docPath": "developer-docs/components/extension/alert",
"storyFile": "superset-frontend/packages/superset-core/src/components/Alert/Alert.stories.tsx"
}
]
}

650
docs/developer_docs_versioned_docs/version-6.1.0/api.mdx Normal file
View File

@@ -0,0 +1,650 @@
---
title: API Reference
hide_title: true
sidebar_position: 10
---
import { Alert } from 'antd';
## REST API Reference
Superset exposes a comprehensive **REST API** that follows the [OpenAPI specification](https://swagger.io/specification/).
You can use this API to programmatically interact with Superset for automation, integrations, and custom applications.
<Alert
type="info"
showIcon
message="Code Samples & Schema Documentation"
description={
<span>
Each endpoint includes ready-to-use code samples in <strong>cURL</strong>, <strong>Python</strong>, and <strong>JavaScript</strong>.
The sidebar includes <strong>Schema definitions</strong> for detailed data model documentation.
</span>
}
style={{ marginBottom: '24px' }}
/>
---
### Authentication
Most API endpoints require authentication via JWT tokens.
#### Quick Start
```bash
# 1. Get a JWT token
curl -X POST http://localhost:8088/api/v1/security/login \
-H "Content-Type: application/json" \
-d '{"username": "admin", "password": "admin", "provider": "db"}'
# 2. Use the access_token from the response
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
http://localhost:8088/api/v1/dashboard/
```
#### Security Endpoints
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get the CSRF token](/developer-docs/api/get-the-csrf-token) | `/api/v1/security/csrf_token/` |
| `POST` | [Get a guest token](/developer-docs/api/get-a-guest-token) | `/api/v1/security/guest_token/` |
| `POST` | [Create security login](/developer-docs/api/create-security-login) | `/api/v1/security/login` |
| `POST` | [Create security refresh](/developer-docs/api/create-security-refresh) | `/api/v1/security/refresh` |
---
### API Endpoints
#### Core Resources
<details>
<summary><strong>Dashboards</strong> (28 endpoints) — Create, read, update, and delete dashboards.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `DELETE` | [Bulk delete dashboards](/developer-docs/api/bulk-delete-dashboards) | `/api/v1/dashboard/` |
| `GET` | [Get a list of dashboards](/developer-docs/api/get-a-list-of-dashboards) | `/api/v1/dashboard/` |
| `POST` | [Create a new dashboard](/developer-docs/api/create-a-new-dashboard) | `/api/v1/dashboard/` |
| `GET` | [Get metadata information about this API resource (dashboard--info)](/developer-docs/api/get-metadata-information-about-this-api-resource-dashboard-info) | `/api/v1/dashboard/_info` |
| `GET` | [Get a dashboard detail information](/developer-docs/api/get-a-dashboard-detail-information) | `/api/v1/dashboard/{id_or_slug}` |
| `GET` | [Get a dashboard's chart definitions.](/developer-docs/api/get-a-dashboards-chart-definitions) | `/api/v1/dashboard/{id_or_slug}/charts` |
| `POST` | [Create a copy of an existing dashboard](/developer-docs/api/create-a-copy-of-an-existing-dashboard) | `/api/v1/dashboard/{id_or_slug}/copy/` |
| `GET` | [Get dashboard's datasets](/developer-docs/api/get-dashboards-datasets) | `/api/v1/dashboard/{id_or_slug}/datasets` |
| `DELETE` | [Delete a dashboard's embedded configuration](/developer-docs/api/delete-a-dashboards-embedded-configuration) | `/api/v1/dashboard/{id_or_slug}/embedded` |
| `GET` | [Get the dashboard's embedded configuration](/developer-docs/api/get-the-dashboards-embedded-configuration) | `/api/v1/dashboard/{id_or_slug}/embedded` |
| `POST` | [Set a dashboard's embedded configuration](/developer-docs/api/set-a-dashboards-embedded-configuration) | `/api/v1/dashboard/{id_or_slug}/embedded` |
| `PUT` | [Update dashboard by id_or_slug embedded](/developer-docs/api/update-dashboard-by-id-or-slug-embedded) | `/api/v1/dashboard/{id_or_slug}/embedded` |
| `GET` | [Get dashboard's tabs](/developer-docs/api/get-dashboards-tabs) | `/api/v1/dashboard/{id_or_slug}/tabs` |
| `DELETE` | [Delete a dashboard](/developer-docs/api/delete-a-dashboard) | `/api/v1/dashboard/{pk}` |
| `PUT` | [Update a dashboard](/developer-docs/api/update-a-dashboard) | `/api/v1/dashboard/{pk}` |
| `POST` | [Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)](/developer-docs/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot) | `/api/v1/dashboard/{pk}/cache_dashboard_screenshot/` |
| `PUT` | [Update chart customizations configuration for a dashboard.](/developer-docs/api/update-chart-customizations-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/chart_customizations` |
| `PUT` | [Update colors configuration for a dashboard.](/developer-docs/api/update-colors-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/colors` |
| `GET` | [Export dashboard as example bundle](/developer-docs/api/export-dashboard-as-example-bundle) | `/api/v1/dashboard/{pk}/export_as_example/` |
| `DELETE` | [Remove the dashboard from the user favorite list](/developer-docs/api/remove-the-dashboard-from-the-user-favorite-list) | `/api/v1/dashboard/{pk}/favorites/` |
| `POST` | [Mark the dashboard as favorite for the current user](/developer-docs/api/mark-the-dashboard-as-favorite-for-the-current-user) | `/api/v1/dashboard/{pk}/favorites/` |
| `PUT` | [Update native filters configuration for a dashboard.](/developer-docs/api/update-native-filters-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/filters` |
| `GET` | [Get a computed screenshot from cache (dashboard-pk-screenshot-digest)](/developer-docs/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest) | `/api/v1/dashboard/{pk}/screenshot/{digest}/` |
| `GET` | [Get dashboard's thumbnail](/developer-docs/api/get-dashboards-thumbnail) | `/api/v1/dashboard/{pk}/thumbnail/{digest}/` |
| `GET` | [Download multiple dashboards as YAML files](/developer-docs/api/download-multiple-dashboards-as-yaml-files) | `/api/v1/dashboard/export/` |
| `GET` | [Check favorited dashboards for current user](/developer-docs/api/check-favorited-dashboards-for-current-user) | `/api/v1/dashboard/favorite_status/` |
| `POST` | [Import dashboard(s) with associated charts/datasets/databases](/developer-docs/api/import-dashboard-s-with-associated-charts-datasets-databases) | `/api/v1/dashboard/import/` |
| `GET` | [Get related fields data (dashboard-related-column-name)](/developer-docs/api/get-related-fields-data-dashboard-related-column-name) | `/api/v1/dashboard/related/{column_name}` |
</details>
<details>
<summary><strong>Charts</strong> (20 endpoints) — Create, read, update, and delete charts (slices).</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `DELETE` | [Bulk delete charts](/developer-docs/api/bulk-delete-charts) | `/api/v1/chart/` |
| `GET` | [Get a list of charts](/developer-docs/api/get-a-list-of-charts) | `/api/v1/chart/` |
| `POST` | [Create a new chart](/developer-docs/api/create-a-new-chart) | `/api/v1/chart/` |
| `GET` | [Get metadata information about this API resource (chart--info)](/developer-docs/api/get-metadata-information-about-this-api-resource-chart-info) | `/api/v1/chart/_info` |
| `GET` | [Get a chart detail information](/developer-docs/api/get-a-chart-detail-information) | `/api/v1/chart/{id_or_uuid}` |
| `DELETE` | [Delete a chart](/developer-docs/api/delete-a-chart) | `/api/v1/chart/{pk}` |
| `PUT` | [Update a chart](/developer-docs/api/update-a-chart) | `/api/v1/chart/{pk}` |
| `GET` | [Compute and cache a screenshot (chart-pk-cache-screenshot)](/developer-docs/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot) | `/api/v1/chart/{pk}/cache_screenshot/` |
| `GET` | [Return payload data response for a chart](/developer-docs/api/return-payload-data-response-for-a-chart) | `/api/v1/chart/{pk}/data/` |
| `DELETE` | [Remove the chart from the user favorite list](/developer-docs/api/remove-the-chart-from-the-user-favorite-list) | `/api/v1/chart/{pk}/favorites/` |
| `POST` | [Mark the chart as favorite for the current user](/developer-docs/api/mark-the-chart-as-favorite-for-the-current-user) | `/api/v1/chart/{pk}/favorites/` |
| `GET` | [Get a computed screenshot from cache (chart-pk-screenshot-digest)](/developer-docs/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest) | `/api/v1/chart/{pk}/screenshot/{digest}/` |
| `GET` | [Get chart thumbnail](/developer-docs/api/get-chart-thumbnail) | `/api/v1/chart/{pk}/thumbnail/{digest}/` |
| `POST` | [Return payload data response for the given query (chart-data)](/developer-docs/api/return-payload-data-response-for-the-given-query-chart-data) | `/api/v1/chart/data` |
| `GET` | [Return payload data response for the given query (chart-data-cache-key)](/developer-docs/api/return-payload-data-response-for-the-given-query-chart-data-cache-key) | `/api/v1/chart/data/{cache_key}` |
| `GET` | [Download multiple charts as YAML files](/developer-docs/api/download-multiple-charts-as-yaml-files) | `/api/v1/chart/export/` |
| `GET` | [Check favorited charts for current user](/developer-docs/api/check-favorited-charts-for-current-user) | `/api/v1/chart/favorite_status/` |
| `POST` | [Import chart(s) with associated datasets and databases](/developer-docs/api/import-chart-s-with-associated-datasets-and-databases) | `/api/v1/chart/import/` |
| `GET` | [Get related fields data (chart-related-column-name)](/developer-docs/api/get-related-fields-data-chart-related-column-name) | `/api/v1/chart/related/{column_name}` |
| `PUT` | [Warm up the cache for the chart](/developer-docs/api/warm-up-the-cache-for-the-chart) | `/api/v1/chart/warm_up_cache` |
</details>
<details>
<summary><strong>Datasets</strong> (19 endpoints) — Manage datasets (tables) used for building charts.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `DELETE` | [Bulk delete datasets](/developer-docs/api/bulk-delete-datasets) | `/api/v1/dataset/` |
| `GET` | [Get a list of datasets](/developer-docs/api/get-a-list-of-datasets) | `/api/v1/dataset/` |
| `POST` | [Create a new dataset](/developer-docs/api/create-a-new-dataset) | `/api/v1/dataset/` |
| `GET` | [Get metadata information about this API resource (dataset--info)](/developer-docs/api/get-metadata-information-about-this-api-resource-dataset-info) | `/api/v1/dataset/_info` |
| `GET` | [Get a dataset](/developer-docs/api/get-a-dataset) | `/api/v1/dataset/{id_or_uuid}` |
| `GET` | [Get charts and dashboards count associated to a dataset](/developer-docs/api/get-charts-and-dashboards-count-associated-to-a-dataset) | `/api/v1/dataset/{id_or_uuid}/related_objects` |
| `DELETE` | [Delete a dataset](/developer-docs/api/delete-a-dataset) | `/api/v1/dataset/{pk}` |
| `PUT` | [Update a dataset](/developer-docs/api/update-a-dataset) | `/api/v1/dataset/{pk}` |
| `DELETE` | [Delete a dataset column](/developer-docs/api/delete-a-dataset-column) | `/api/v1/dataset/{pk}/column/{column_id}` |
| `GET` | [Get dataset drill info](/developer-docs/api/get-dataset-drill-info) | `/api/v1/dataset/{pk}/drill_info/` |
| `DELETE` | [Delete a dataset metric](/developer-docs/api/delete-a-dataset-metric) | `/api/v1/dataset/{pk}/metric/{metric_id}` |
| `PUT` | [Refresh and update columns of a dataset](/developer-docs/api/refresh-and-update-columns-of-a-dataset) | `/api/v1/dataset/{pk}/refresh` |
| `GET` | [Get distinct values from field data (dataset-distinct-column-name)](/developer-docs/api/get-distinct-values-from-field-data-dataset-distinct-column-name) | `/api/v1/dataset/distinct/{column_name}` |
| `POST` | [Duplicate a dataset](/developer-docs/api/duplicate-a-dataset) | `/api/v1/dataset/duplicate` |
| `GET` | [Download multiple datasets as YAML files](/developer-docs/api/download-multiple-datasets-as-yaml-files) | `/api/v1/dataset/export/` |
| `POST` | [Retrieve a table by name, or create it if it does not exist](/developer-docs/api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist) | `/api/v1/dataset/get_or_create/` |
| `POST` | [Import dataset(s) with associated databases](/developer-docs/api/import-dataset-s-with-associated-databases) | `/api/v1/dataset/import/` |
| `GET` | [Get related fields data (dataset-related-column-name)](/developer-docs/api/get-related-fields-data-dataset-related-column-name) | `/api/v1/dataset/related/{column_name}` |
| `PUT` | [Warm up the cache for each chart powered by the given table](/developer-docs/api/warm-up-the-cache-for-each-chart-powered-by-the-given-table) | `/api/v1/dataset/warm_up_cache` |
</details>
<details>
<summary><strong>Database</strong> (30 endpoints) — Manage database connections and metadata.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get a list of databases](/developer-docs/api/get-a-list-of-databases) | `/api/v1/database/` |
| `POST` | [Create a new database](/developer-docs/api/create-a-new-database) | `/api/v1/database/` |
| `GET` | [Get metadata information about this API resource (database--info)](/developer-docs/api/get-metadata-information-about-this-api-resource-database-info) | `/api/v1/database/_info` |
| `DELETE` | [Delete a database](/developer-docs/api/delete-a-database) | `/api/v1/database/{pk}` |
| `GET` | [Get a database](/developer-docs/api/get-a-database) | `/api/v1/database/{pk}` |
| `PUT` | [Change a database](/developer-docs/api/change-a-database) | `/api/v1/database/{pk}` |
| `GET` | [Get all catalogs from a database](/developer-docs/api/get-all-catalogs-from-a-database) | `/api/v1/database/{pk}/catalogs/` |
| `GET` | [Get a database connection info](/developer-docs/api/get-a-database-connection-info) | `/api/v1/database/{pk}/connection` |
| `GET` | [Get function names supported by a database](/developer-docs/api/get-function-names-supported-by-a-database) | `/api/v1/database/{pk}/function_names/` |
| `GET` | [Get charts and dashboards count associated to a database](/developer-docs/api/get-charts-and-dashboards-count-associated-to-a-database) | `/api/v1/database/{pk}/related_objects/` |
| `GET` | [The list of the database schemas where to upload information](/developer-docs/api/the-list-of-the-database-schemas-where-to-upload-information) | `/api/v1/database/{pk}/schemas_access_for_file_upload/` |
| `GET` | [Get all schemas from a database](/developer-docs/api/get-all-schemas-from-a-database) | `/api/v1/database/{pk}/schemas/` |
| `GET` | [Get database select star for table (database-pk-select-star-table-name)](/developer-docs/api/get-database-select-star-for-table-database-pk-select-star-table-name) | `/api/v1/database/{pk}/select_star/{table_name}/` |
| `GET` | [Get database select star for table (database-pk-select-star-table-name-schema-name)](/developer-docs/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name) | `/api/v1/database/{pk}/select_star/{table_name}/{schema_name}/` |
| `POST` | [Re-sync all permissions for a database connection](/developer-docs/api/re-sync-all-permissions-for-a-database-connection) | `/api/v1/database/{pk}/sync_permissions/` |
| `GET` | [Get table extra metadata (database-pk-table-extra-table-name-schema-name)](/developer-docs/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name) | `/api/v1/database/{pk}/table_extra/{table_name}/{schema_name}/` |
| `GET` | [Get table metadata](/developer-docs/api/get-table-metadata) | `/api/v1/database/{pk}/table_metadata/` |
| `GET` | [Get table extra metadata (database-pk-table-metadata-extra)](/developer-docs/api/get-table-extra-metadata-database-pk-table-metadata-extra) | `/api/v1/database/{pk}/table_metadata/extra/` |
| `GET` | [Get database table metadata](/developer-docs/api/get-database-table-metadata) | `/api/v1/database/{pk}/table/{table_name}/{schema_name}/` |
| `GET` | [Get a list of tables for given database](/developer-docs/api/get-a-list-of-tables-for-given-database) | `/api/v1/database/{pk}/tables/` |
| `POST` | [Upload a file to a database table](/developer-docs/api/upload-a-file-to-a-database-table) | `/api/v1/database/{pk}/upload/` |
| `POST` | [Validate arbitrary SQL](/developer-docs/api/validate-arbitrary-sql) | `/api/v1/database/{pk}/validate_sql/` |
| `GET` | [Get names of databases currently available](/developer-docs/api/get-names-of-databases-currently-available) | `/api/v1/database/available/` |
| `GET` | [Download database(s) and associated dataset(s) as a zip file](/developer-docs/api/download-database-s-and-associated-dataset-s-as-a-zip-file) | `/api/v1/database/export/` |
| `POST` | [Import database(s) with associated datasets](/developer-docs/api/import-database-s-with-associated-datasets) | `/api/v1/database/import/` |
| `GET` | [Receive personal access tokens from OAuth2](/developer-docs/api/receive-personal-access-tokens-from-o-auth-2) | `/api/v1/database/oauth2/` |
| `GET` | [Get related fields data (database-related-column-name)](/developer-docs/api/get-related-fields-data-database-related-column-name) | `/api/v1/database/related/{column_name}` |
| `POST` | [Test a database connection](/developer-docs/api/test-a-database-connection) | `/api/v1/database/test_connection/` |
| `POST` | [Upload a file and returns file metadata](/developer-docs/api/upload-a-file-and-returns-file-metadata) | `/api/v1/database/upload_metadata/` |
| `POST` | [Validate database connection parameters](/developer-docs/api/validate-database-connection-parameters) | `/api/v1/database/validate_parameters/` |
</details>
#### Data Exploration
<details>
<summary><strong>Explore</strong> (1 endpoints) — Chart exploration and data querying endpoints.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Assemble Explore related information in a single endpoint](/developer-docs/api/assemble-explore-related-information-in-a-single-endpoint) | `/api/v1/explore/` |
</details>
<details>
<summary><strong>SQL Lab</strong> (7 endpoints) — Execute SQL queries and manage SQL Lab sessions.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get the bootstrap data for SqlLab page](/developer-docs/api/get-the-bootstrap-data-for-sql-lab-page) | `/api/v1/sqllab/` |
| `POST` | [Estimate the SQL query execution cost](/developer-docs/api/estimate-the-sql-query-execution-cost) | `/api/v1/sqllab/estimate/` |
| `POST` | [Execute a SQL query](/developer-docs/api/execute-a-sql-query) | `/api/v1/sqllab/execute/` |
| `POST` | [Export SQL query results to CSV with streaming](/developer-docs/api/export-sql-query-results-to-csv-with-streaming) | `/api/v1/sqllab/export_streaming/` |
| `GET` | [Export the SQL query results to a CSV](/developer-docs/api/export-the-sql-query-results-to-a-csv) | `/api/v1/sqllab/export/{client_id}/` |
| `POST` | [Format SQL code](/developer-docs/api/format-sql-code) | `/api/v1/sqllab/format_sql/` |
| `GET` | [Get the result of a SQL query execution](/developer-docs/api/get-the-result-of-a-sql-query-execution) | `/api/v1/sqllab/results/` |
</details>
<details>
<summary><strong>Queries</strong> (17 endpoints) — View and manage SQL Lab query history.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get a list of queries](/developer-docs/api/get-a-list-of-queries) | `/api/v1/query/` |
| `GET` | [Get query detail information](/developer-docs/api/get-query-detail-information) | `/api/v1/query/{pk}` |
| `GET` | [Get distinct values from field data (query-distinct-column-name)](/developer-docs/api/get-distinct-values-from-field-data-query-distinct-column-name) | `/api/v1/query/distinct/{column_name}` |
| `GET` | [Get related fields data (query-related-column-name)](/developer-docs/api/get-related-fields-data-query-related-column-name) | `/api/v1/query/related/{column_name}` |
| `POST` | [Manually stop a query with client_id](/developer-docs/api/manually-stop-a-query-with-client-id) | `/api/v1/query/stop` |
| `GET` | [Get a list of queries that changed after last_updated_ms](/developer-docs/api/get-a-list-of-queries-that-changed-after-last-updated-ms) | `/api/v1/query/updated_since` |
| `DELETE` | [Bulk delete saved queries](/developer-docs/api/bulk-delete-saved-queries) | `/api/v1/saved_query/` |
| `GET` | [Get a list of saved queries](/developer-docs/api/get-a-list-of-saved-queries) | `/api/v1/saved_query/` |
| `POST` | [Create a saved query](/developer-docs/api/create-a-saved-query) | `/api/v1/saved_query/` |
| `GET` | [Get metadata information about this API resource (saved-query--info)](/developer-docs/api/get-metadata-information-about-this-api-resource-saved-query-info) | `/api/v1/saved_query/_info` |
| `DELETE` | [Delete a saved query](/developer-docs/api/delete-a-saved-query) | `/api/v1/saved_query/{pk}` |
| `GET` | [Get a saved query](/developer-docs/api/get-a-saved-query) | `/api/v1/saved_query/{pk}` |
| `PUT` | [Update a saved query](/developer-docs/api/update-a-saved-query) | `/api/v1/saved_query/{pk}` |
| `GET` | [Get distinct values from field data (saved-query-distinct-column-name)](/developer-docs/api/get-distinct-values-from-field-data-saved-query-distinct-column-name) | `/api/v1/saved_query/distinct/{column_name}` |
| `GET` | [Download multiple saved queries as YAML files](/developer-docs/api/download-multiple-saved-queries-as-yaml-files) | `/api/v1/saved_query/export/` |
| `POST` | [Import saved queries with associated databases](/developer-docs/api/import-saved-queries-with-associated-databases) | `/api/v1/saved_query/import/` |
| `GET` | [Get related fields data (saved-query-related-column-name)](/developer-docs/api/get-related-fields-data-saved-query-related-column-name) | `/api/v1/saved_query/related/{column_name}` |
</details>
<details>
<summary><strong>Datasources</strong> (2 endpoints) — Query datasource metadata and column values.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get possible values for a datasource column](/developer-docs/api/get-possible-values-for-a-datasource-column) | `/api/v1/datasource/{datasource_type}/{datasource_id}/column/{column_name}/values/` |
| `POST` | [Validate a SQL expression against a datasource](/developer-docs/api/validate-a-sql-expression-against-a-datasource) | `/api/v1/datasource/{datasource_type}/{datasource_id}/validate_expression/` |
</details>
<details>
<summary><strong>Advanced Data Type</strong> (2 endpoints) — Advanced data type operations and conversions.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Return an AdvancedDataTypeResponse](/developer-docs/api/return-an-advanced-data-type-response) | `/api/v1/advanced_data_type/convert` |
| `GET` | [Return a list of available advanced data types](/developer-docs/api/return-a-list-of-available-advanced-data-types) | `/api/v1/advanced_data_type/types` |
</details>
#### Organization & Customization
<details>
<summary><strong>Tags</strong> (15 endpoints) — Organize assets with tags.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `DELETE` | [Bulk delete tags](/developer-docs/api/bulk-delete-tags) | `/api/v1/tag/` |
| `GET` | [Get a list of tags](/developer-docs/api/get-a-list-of-tags) | `/api/v1/tag/` |
| `POST` | [Create a tag](/developer-docs/api/create-a-tag) | `/api/v1/tag/` |
| `GET` | [Get metadata information about tag API endpoints](/developer-docs/api/get-metadata-information-about-tag-api-endpoints) | `/api/v1/tag/_info` |
| `POST` | [Add tags to an object](/developer-docs/api/add-tags-to-an-object) | `/api/v1/tag/{object_type}/{object_id}/` |
| `DELETE` | [Delete a tagged object](/developer-docs/api/delete-a-tagged-object) | `/api/v1/tag/{object_type}/{object_id}/{tag}/` |
| `DELETE` | [Delete a tag](/developer-docs/api/delete-a-tag) | `/api/v1/tag/{pk}` |
| `GET` | [Get a tag detail information](/developer-docs/api/get-a-tag-detail-information) | `/api/v1/tag/{pk}` |
| `PUT` | [Update a tag](/developer-docs/api/update-a-tag) | `/api/v1/tag/{pk}` |
| `DELETE` | [Delete tag by pk favorites](/developer-docs/api/delete-tag-by-pk-favorites) | `/api/v1/tag/{pk}/favorites/` |
| `POST` | [Create tag by pk favorites](/developer-docs/api/create-tag-by-pk-favorites) | `/api/v1/tag/{pk}/favorites/` |
| `POST` | [Bulk create tags and tagged objects](/developer-docs/api/bulk-create-tags-and-tagged-objects) | `/api/v1/tag/bulk_create` |
| `GET` | [Get tag favorite status](/developer-docs/api/get-tag-favorite-status) | `/api/v1/tag/favorite_status/` |
| `GET` | [Get all objects associated with a tag](/developer-docs/api/get-all-objects-associated-with-a-tag) | `/api/v1/tag/get_objects/` |
| `GET` | [Get related fields data (tag-related-column-name)](/developer-docs/api/get-related-fields-data-tag-related-column-name) | `/api/v1/tag/related/{column_name}` |
</details>
<details>
<summary><strong>Annotation Layers</strong> (14 endpoints) — Manage annotation layers and annotations for charts.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `DELETE` | [Delete multiple annotation layers in a bulk operation](/developer-docs/api/delete-multiple-annotation-layers-in-a-bulk-operation) | `/api/v1/annotation_layer/` |
| `GET` | [Get a list of annotation layers (annotation-layer)](/developer-docs/api/get-a-list-of-annotation-layers-annotation-layer) | `/api/v1/annotation_layer/` |
| `POST` | [Create an annotation layer (annotation-layer)](/developer-docs/api/create-an-annotation-layer-annotation-layer) | `/api/v1/annotation_layer/` |
| `GET` | [Get metadata information about this API resource (annotation-layer--info)](/developer-docs/api/get-metadata-information-about-this-api-resource-annotation-layer-info) | `/api/v1/annotation_layer/_info` |
| `DELETE` | [Delete annotation layer (annotation-layer-pk)](/developer-docs/api/delete-annotation-layer-annotation-layer-pk) | `/api/v1/annotation_layer/{pk}` |
| `GET` | [Get an annotation layer (annotation-layer-pk)](/developer-docs/api/get-an-annotation-layer-annotation-layer-pk) | `/api/v1/annotation_layer/{pk}` |
| `PUT` | [Update an annotation layer (annotation-layer-pk)](/developer-docs/api/update-an-annotation-layer-annotation-layer-pk) | `/api/v1/annotation_layer/{pk}` |
| `DELETE` | [Bulk delete annotation layers](/developer-docs/api/bulk-delete-annotation-layers) | `/api/v1/annotation_layer/{pk}/annotation/` |
| `GET` | [Get a list of annotation layers (annotation-layer-pk-annotation)](/developer-docs/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation) | `/api/v1/annotation_layer/{pk}/annotation/` |
| `POST` | [Create an annotation layer (annotation-layer-pk-annotation)](/developer-docs/api/create-an-annotation-layer-annotation-layer-pk-annotation) | `/api/v1/annotation_layer/{pk}/annotation/` |
| `DELETE` | [Delete annotation layer (annotation-layer-pk-annotation-annotation-id)](/developer-docs/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id) | `/api/v1/annotation_layer/{pk}/annotation/{annotation_id}` |
| `GET` | [Get an annotation layer (annotation-layer-pk-annotation-annotation-id)](/developer-docs/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id) | `/api/v1/annotation_layer/{pk}/annotation/{annotation_id}` |
| `PUT` | [Update an annotation layer (annotation-layer-pk-annotation-annotation-id)](/developer-docs/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id) | `/api/v1/annotation_layer/{pk}/annotation/{annotation_id}` |
| `GET` | [Get related fields data (annotation-layer-related-column-name)](/developer-docs/api/get-related-fields-data-annotation-layer-related-column-name) | `/api/v1/annotation_layer/related/{column_name}` |
</details>
<details>
<summary><strong>CSS Templates</strong> (8 endpoints) — Manage CSS templates for custom dashboard styling.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `DELETE` | [Bulk delete CSS templates](/developer-docs/api/bulk-delete-css-templates) | `/api/v1/css_template/` |
| `GET` | [Get a list of CSS templates](/developer-docs/api/get-a-list-of-css-templates) | `/api/v1/css_template/` |
| `POST` | [Create a CSS template](/developer-docs/api/create-a-css-template) | `/api/v1/css_template/` |
| `GET` | [Get metadata information about this API resource (css-template--info)](/developer-docs/api/get-metadata-information-about-this-api-resource-css-template-info) | `/api/v1/css_template/_info` |
| `DELETE` | [Delete a CSS template](/developer-docs/api/delete-a-css-template) | `/api/v1/css_template/{pk}` |
| `GET` | [Get a CSS template](/developer-docs/api/get-a-css-template) | `/api/v1/css_template/{pk}` |
| `PUT` | [Update a CSS template](/developer-docs/api/update-a-css-template) | `/api/v1/css_template/{pk}` |
| `GET` | [Get related fields data (css-template-related-column-name)](/developer-docs/api/get-related-fields-data-css-template-related-column-name) | `/api/v1/css_template/related/{column_name}` |
</details>
#### Sharing & Embedding
<details>
<summary><strong>Dashboard Permanent Link</strong> (2 endpoints) — Permanent links to dashboard states.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `POST` | [Create a new dashboard's permanent link](/developer-docs/api/create-a-new-dashboards-permanent-link) | `/api/v1/dashboard/{pk}/permalink` |
| `GET` | [Get dashboard's permanent link state](/developer-docs/api/get-dashboards-permanent-link-state) | `/api/v1/dashboard/permalink/{key}` |
</details>
<details>
<summary><strong>Explore Permanent Link</strong> (2 endpoints) — Permanent links to chart explore states.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `POST` | [Create a new permanent link (explore-permalink)](/developer-docs/api/create-a-new-permanent-link-explore-permalink) | `/api/v1/explore/permalink` |
| `GET` | [Get chart's permanent link state](/developer-docs/api/get-charts-permanent-link-state) | `/api/v1/explore/permalink/{key}` |
</details>
<details>
<summary><strong>SQL Lab Permanent Link</strong> (2 endpoints) — Permanent links to SQL Lab states.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `POST` | [Create a new permanent link (sqllab-permalink)](/developer-docs/api/create-a-new-permanent-link-sqllab-permalink) | `/api/v1/sqllab/permalink` |
| `GET` | [Get permanent link state for SQLLab editor.](/developer-docs/api/get-permanent-link-state-for-sql-lab-editor) | `/api/v1/sqllab/permalink/{key}` |
</details>
<details>
<summary><strong>Embedded Dashboard</strong> (1 endpoints) — Configure embedded dashboard settings.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get a report schedule log (embedded-dashboard-uuid)](/developer-docs/api/get-a-report-schedule-log-embedded-dashboard-uuid) | `/api/v1/embedded_dashboard/{uuid}` |
</details>
<details>
<summary><strong>Dashboard Filter State</strong> (4 endpoints) — Manage temporary filter state for dashboards.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `POST` | [Create a dashboard's filter state](/developer-docs/api/create-a-dashboards-filter-state) | `/api/v1/dashboard/{pk}/filter_state` |
| `DELETE` | [Delete a dashboard's filter state value](/developer-docs/api/delete-a-dashboards-filter-state-value) | `/api/v1/dashboard/{pk}/filter_state/{key}` |
| `GET` | [Get a dashboard's filter state value](/developer-docs/api/get-a-dashboards-filter-state-value) | `/api/v1/dashboard/{pk}/filter_state/{key}` |
| `PUT` | [Update a dashboard's filter state value](/developer-docs/api/update-a-dashboards-filter-state-value) | `/api/v1/dashboard/{pk}/filter_state/{key}` |
</details>
<details>
<summary><strong>Explore Form Data</strong> (4 endpoints) — Manage temporary form data for chart exploration.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `POST` | [Create a new form_data](/developer-docs/api/create-a-new-form-data) | `/api/v1/explore/form_data` |
| `DELETE` | [Delete a form_data](/developer-docs/api/delete-a-form-data) | `/api/v1/explore/form_data/{key}` |
| `GET` | [Get a form_data](/developer-docs/api/get-a-form-data) | `/api/v1/explore/form_data/{key}` |
| `PUT` | [Update an existing form_data](/developer-docs/api/update-an-existing-form-data) | `/api/v1/explore/form_data/{key}` |
</details>
#### Scheduling & Alerts
<details>
<summary><strong>Report Schedules</strong> (11 endpoints) — Configure scheduled reports and alerts.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `DELETE` | [Bulk delete report schedules](/developer-docs/api/bulk-delete-report-schedules) | `/api/v1/report/` |
| `GET` | [Get a list of report schedules](/developer-docs/api/get-a-list-of-report-schedules) | `/api/v1/report/` |
| `POST` | [Create a report schedule](/developer-docs/api/create-a-report-schedule) | `/api/v1/report/` |
| `GET` | [Get metadata information about this API resource (report--info)](/developer-docs/api/get-metadata-information-about-this-api-resource-report-info) | `/api/v1/report/_info` |
| `DELETE` | [Delete a report schedule](/developer-docs/api/delete-a-report-schedule) | `/api/v1/report/{pk}` |
| `GET` | [Get a report schedule](/developer-docs/api/get-a-report-schedule) | `/api/v1/report/{pk}` |
| `PUT` | [Update a report schedule](/developer-docs/api/update-a-report-schedule) | `/api/v1/report/{pk}` |
| `GET` | [Get a list of report schedule logs](/developer-docs/api/get-a-list-of-report-schedule-logs) | `/api/v1/report/{pk}/log/` |
| `GET` | [Get a report schedule log (report-pk-log-log-id)](/developer-docs/api/get-a-report-schedule-log-report-pk-log-log-id) | `/api/v1/report/{pk}/log/{log_id}` |
| `GET` | [Get related fields data (report-related-column-name)](/developer-docs/api/get-related-fields-data-report-related-column-name) | `/api/v1/report/related/{column_name}` |
| `GET` | [Get slack channels](/developer-docs/api/get-slack-channels) | `/api/v1/report/slack_channels/` |
</details>
#### Security & Access Control
<details>
<summary><strong>Security Roles</strong> (11 endpoints) — Manage security roles and their permissions.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get security roles](/developer-docs/api/get-security-roles) | `/api/v1/security/roles/` |
| `POST` | [Create security roles](/developer-docs/api/create-security-roles) | `/api/v1/security/roles/` |
| `GET` | [Get security roles info](/developer-docs/api/get-security-roles-info) | `/api/v1/security/roles/_info` |
| `DELETE` | [Delete security roles by pk](/developer-docs/api/delete-security-roles-by-pk) | `/api/v1/security/roles/{pk}` |
| `GET` | [Get security roles by pk](/developer-docs/api/get-security-roles-by-pk) | `/api/v1/security/roles/{pk}` |
| `PUT` | [Update security roles by pk](/developer-docs/api/update-security-roles-by-pk) | `/api/v1/security/roles/{pk}` |
| `PUT` | [Update security roles by role_id groups](/developer-docs/api/update-security-roles-by-role-id-groups) | `/api/v1/security/roles/{role_id}/groups` |
| `POST` | [Create security roles by role_id permissions](/developer-docs/api/create-security-roles-by-role-id-permissions) | `/api/v1/security/roles/{role_id}/permissions` |
| `GET` | [Get security roles by role_id permissions](/developer-docs/api/get-security-roles-by-role-id-permissions) | `/api/v1/security/roles/{role_id}/permissions/` |
| `PUT` | [Update security roles by role_id users](/developer-docs/api/update-security-roles-by-role-id-users) | `/api/v1/security/roles/{role_id}/users` |
| `GET` | [List roles](/developer-docs/api/list-roles) | `/api/v1/security/roles/search/` |
</details>
<details>
<summary><strong>Security Users</strong> (6 endpoints) — Manage user accounts.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get security users](/developer-docs/api/get-security-users) | `/api/v1/security/users/` |
| `POST` | [Create security users](/developer-docs/api/create-security-users) | `/api/v1/security/users/` |
| `GET` | [Get security users info](/developer-docs/api/get-security-users-info) | `/api/v1/security/users/_info` |
| `DELETE` | [Delete security users by pk](/developer-docs/api/delete-security-users-by-pk) | `/api/v1/security/users/{pk}` |
| `GET` | [Get security users by pk](/developer-docs/api/get-security-users-by-pk) | `/api/v1/security/users/{pk}` |
| `PUT` | [Update security users by pk](/developer-docs/api/update-security-users-by-pk) | `/api/v1/security/users/{pk}` |
</details>
<details>
<summary><strong>Security Permissions</strong> (3 endpoints) — View available permissions.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get security permissions](/developer-docs/api/get-security-permissions) | `/api/v1/security/permissions/` |
| `GET` | [Get security permissions info](/developer-docs/api/get-security-permissions-info) | `/api/v1/security/permissions/_info` |
| `GET` | [Get security permissions by pk](/developer-docs/api/get-security-permissions-by-pk) | `/api/v1/security/permissions/{pk}` |
</details>
<details>
<summary><strong>Security Resources (View Menus)</strong> (6 endpoints) — Manage security resources (view menus).</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get security resources](/developer-docs/api/get-security-resources) | `/api/v1/security/resources/` |
| `POST` | [Create security resources](/developer-docs/api/create-security-resources) | `/api/v1/security/resources/` |
| `GET` | [Get security resources info](/developer-docs/api/get-security-resources-info) | `/api/v1/security/resources/_info` |
| `DELETE` | [Delete security resources by pk](/developer-docs/api/delete-security-resources-by-pk) | `/api/v1/security/resources/{pk}` |
| `GET` | [Get security resources by pk](/developer-docs/api/get-security-resources-by-pk) | `/api/v1/security/resources/{pk}` |
| `PUT` | [Update security resources by pk](/developer-docs/api/update-security-resources-by-pk) | `/api/v1/security/resources/{pk}` |
</details>
<details>
<summary><strong>Security Permissions on Resources (View Menus)</strong> (6 endpoints) — Permission-resource mappings.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get security permissions resources](/developer-docs/api/get-security-permissions-resources) | `/api/v1/security/permissions-resources/` |
| `POST` | [Create security permissions resources](/developer-docs/api/create-security-permissions-resources) | `/api/v1/security/permissions-resources/` |
| `GET` | [Get security permissions resources info](/developer-docs/api/get-security-permissions-resources-info) | `/api/v1/security/permissions-resources/_info` |
| `DELETE` | [Delete security permissions resources by pk](/developer-docs/api/delete-security-permissions-resources-by-pk) | `/api/v1/security/permissions-resources/{pk}` |
| `GET` | [Get security permissions resources by pk](/developer-docs/api/get-security-permissions-resources-by-pk) | `/api/v1/security/permissions-resources/{pk}` |
| `PUT` | [Update security permissions resources by pk](/developer-docs/api/update-security-permissions-resources-by-pk) | `/api/v1/security/permissions-resources/{pk}` |
</details>
<details>
<summary><strong>Row Level Security</strong> (8 endpoints) — Manage row-level security rules for data access.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `DELETE` | [Bulk delete RLS rules](/developer-docs/api/bulk-delete-rls-rules) | `/api/v1/rowlevelsecurity/` |
| `GET` | [Get a list of RLS](/developer-docs/api/get-a-list-of-rls) | `/api/v1/rowlevelsecurity/` |
| `POST` | [Create a new RLS rule](/developer-docs/api/create-a-new-rls-rule) | `/api/v1/rowlevelsecurity/` |
| `GET` | [Get metadata information about this API resource (rowlevelsecurity--info)](/developer-docs/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info) | `/api/v1/rowlevelsecurity/_info` |
| `DELETE` | [Delete an RLS](/developer-docs/api/delete-an-rls) | `/api/v1/rowlevelsecurity/{pk}` |
| `GET` | [Get an RLS](/developer-docs/api/get-an-rls) | `/api/v1/rowlevelsecurity/{pk}` |
| `PUT` | [Update an RLS rule](/developer-docs/api/update-an-rls-rule) | `/api/v1/rowlevelsecurity/{pk}` |
| `GET` | [Get related fields data (rowlevelsecurity-related-column-name)](/developer-docs/api/get-related-fields-data-rowlevelsecurity-related-column-name) | `/api/v1/rowlevelsecurity/related/{column_name}` |
</details>
#### Import/Export & Administration
<details>
<summary><strong>Import/export</strong> (2 endpoints) — Import and export Superset assets.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Export all assets](/developer-docs/api/export-all-assets) | `/api/v1/assets/export/` |
| `POST` | [Import multiple assets](/developer-docs/api/import-multiple-assets) | `/api/v1/assets/import/` |
</details>
<details>
<summary><strong>CacheRestApi</strong> (1 endpoints) — Cache management and invalidation operations.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `POST` | [Invalidate cache records and remove the database records](/developer-docs/api/invalidate-cache-records-and-remove-the-database-records) | `/api/v1/cachekey/invalidate` |
</details>
<details>
<summary><strong>LogRestApi</strong> (4 endpoints) — Access audit logs and activity history.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get a list of logs](/developer-docs/api/get-a-list-of-logs) | `/api/v1/log/` |
| `POST` | [Create log](/developer-docs/api/create-log) | `/api/v1/log/` |
| `GET` | [Get a log detail information](/developer-docs/api/get-a-log-detail-information) | `/api/v1/log/{pk}` |
| `GET` | [Get recent activity data for a user](/developer-docs/api/get-recent-activity-data-for-a-user) | `/api/v1/log/recent_activity/` |
</details>
#### User & System
<details>
<summary><strong>Current User</strong> (3 endpoints) — Get information about the authenticated user.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get the user object](/developer-docs/api/get-the-user-object) | `/api/v1/me/` |
| `PUT` | [Update the current user](/developer-docs/api/update-the-current-user) | `/api/v1/me/` |
| `GET` | [Get the user roles](/developer-docs/api/get-the-user-roles) | `/api/v1/me/roles/` |
</details>
<details>
<summary><strong>User</strong> (1 endpoints) — User profile and preferences.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get the user avatar](/developer-docs/api/get-the-user-avatar) | `/api/v1/user/{user_id}/avatar.png` |
</details>
<details>
<summary><strong>Menu</strong> (1 endpoints) — Get the Superset menu structure.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get menu](/developer-docs/api/get-menu) | `/api/v1/menu/` |
</details>
<details>
<summary><strong>Available Domains</strong> (1 endpoints) — Get available domains for the Superset instance.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get all available domains](/developer-docs/api/get-all-available-domains) | `/api/v1/available_domains/` |
</details>
<details>
<summary><strong>AsyncEventsRestApi</strong> (1 endpoints) — Real-time event streaming via Server-Sent Events (SSE).</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Read off of the Redis events stream](/developer-docs/api/read-off-of-the-redis-events-stream) | `/api/v1/async_event/` |
</details>
<details>
<summary><strong>OpenApi</strong> (1 endpoints) — Access the OpenAPI specification.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get api by version openapi](/developer-docs/api/get-api-by-version-openapi) | `/api/{version}/_openapi` |
</details>
#### Other
<details>
<summary><strong>Security Groups</strong> (6 endpoints) — Endpoints related to Security Groups.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get security groups](/developer-docs/api/get-security-groups) | `/api/v1/security/groups/` |
| `POST` | [Create security groups](/developer-docs/api/create-security-groups) | `/api/v1/security/groups/` |
| `GET` | [Get security groups info](/developer-docs/api/get-security-groups-info) | `/api/v1/security/groups/_info` |
| `DELETE` | [Delete security groups by pk](/developer-docs/api/delete-security-groups-by-pk) | `/api/v1/security/groups/{pk}` |
| `GET` | [Get security groups by pk](/developer-docs/api/get-security-groups-by-pk) | `/api/v1/security/groups/{pk}` |
| `PUT` | [Update security groups by pk](/developer-docs/api/update-security-groups-by-pk) | `/api/v1/security/groups/{pk}` |
</details>
<details>
<summary><strong>Themes</strong> (14 endpoints) — Manage UI themes for customizing Superset's appearance.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `DELETE` | [Bulk delete themes](/developer-docs/api/bulk-delete-themes) | `/api/v1/theme/` |
| `GET` | [Get a list of themes](/developer-docs/api/get-a-list-of-themes) | `/api/v1/theme/` |
| `POST` | [Create a theme](/developer-docs/api/create-a-theme) | `/api/v1/theme/` |
| `GET` | [Get metadata information about this API resource (theme--info)](/developer-docs/api/get-metadata-information-about-this-api-resource-theme-info) | `/api/v1/theme/_info` |
| `DELETE` | [Delete a theme](/developer-docs/api/delete-a-theme) | `/api/v1/theme/{pk}` |
| `GET` | [Get a theme](/developer-docs/api/get-a-theme) | `/api/v1/theme/{pk}` |
| `PUT` | [Update a theme](/developer-docs/api/update-a-theme) | `/api/v1/theme/{pk}` |
| `PUT` | [Set a theme as the system dark theme](/developer-docs/api/set-a-theme-as-the-system-dark-theme) | `/api/v1/theme/{pk}/set_system_dark` |
| `PUT` | [Set a theme as the system default theme](/developer-docs/api/set-a-theme-as-the-system-default-theme) | `/api/v1/theme/{pk}/set_system_default` |
| `GET` | [Download multiple themes as YAML files](/developer-docs/api/download-multiple-themes-as-yaml-files) | `/api/v1/theme/export/` |
| `POST` | [Import themes from a ZIP file](/developer-docs/api/import-themes-from-a-zip-file) | `/api/v1/theme/import/` |
| `GET` | [Get related fields data (theme-related-column-name)](/developer-docs/api/get-related-fields-data-theme-related-column-name) | `/api/v1/theme/related/{column_name}` |
| `DELETE` | [Clear the system dark theme](/developer-docs/api/clear-the-system-dark-theme) | `/api/v1/theme/unset_system_dark` |
| `DELETE` | [Clear the system default theme](/developer-docs/api/clear-the-system-default-theme) | `/api/v1/theme/unset_system_default` |
</details>
<details>
<summary><strong>UserRegistrationsRestAPI</strong> (8 endpoints) — Endpoints related to UserRegistrationsRestAPI.</summary>
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | [Get security user registrations](/developer-docs/api/get-security-user-registrations) | `/api/v1/security/user_registrations/` |
| `POST` | [Create security user registrations](/developer-docs/api/create-security-user-registrations) | `/api/v1/security/user_registrations/` |
| `GET` | [Get security user registrations info](/developer-docs/api/get-security-user-registrations-info) | `/api/v1/security/user_registrations/_info` |
| `DELETE` | [Delete security user registrations by pk](/developer-docs/api/delete-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` |
| `GET` | [Get security user registrations by pk](/developer-docs/api/get-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` |
| `PUT` | [Update security user registrations by pk](/developer-docs/api/update-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` |
| `GET` | [Get distinct values from field data (security-user-registrations-distinct-column-name)](/developer-docs/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name) | `/api/v1/security/user_registrations/distinct/{column_name}` |
| `GET` | [Get related fields data (security-user-registrations-related-column-name)](/developer-docs/api/get-related-fields-data-security-user-registrations-related-column-name) | `/api/v1/security/user_registrations/related/{column_name}` |
</details>
---
### Additional Resources
- [Superset REST API Blog Post](https://preset.io/blog/2020-10-01-superset-api/)
- [Accessing APIs with Superset](https://preset.io/blog/accessing-apis-with-superset/)

1
docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"in":"path","name":"object_type","required":true,"schema":{"type":"integer"}},{"in":"path","name":"object_id","required":true,"schema":{"type":"integer"}}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"tags":{"description":"list of tag names to add to object","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"tags":["string"]}}},"description":"Tag schema","required":true}}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"201":{"description":"Tag added"},"302":{"description":"Redirects to the current digest"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: add-tags-to-an-object
title: "Add tags to an object"
description: "Adds tags to an object. Creates new tags if they do not already exist."
sidebar_label: "Add tags to an object"
hide_title: true
hide_table_of_contents: true
api: eJzFV21v2zYQ/iuHw4AmmBInXQcUKvohDVq0XZcGsYsNiIKUEc8WG5lUScqNJ+i/D0dK8uu6lw7oJ5nk3fGeh8eH5wYludyqyiujMcUzKR14MXPgDQgN5u4T5f4Yzi0JTw40fYnLagq+oCVIA9p4EKUlIZdAD8r5Y0ywElbMyZN1mF43qDh4JXyBCWoxJ0wxhr71y4owQUufa2VJYuptTQm6vKC5wLTBYJCi0p5mZLFtk6+FU/LfBbuJ1uT8CyOXbJIb7Ul7/imqqlS5YG5GnxwT1KzFqqypyHpFLkQWs/Dd5LNUzoOZMmfAiUZepeRPzBgTVJ7mbi07563SM2yTfkJYK5aMvJ/oXNsE6UHMq5JWGVz37jctO2ymMxEz6ABss9TyhKuMdhHP45PTXTjsL6QkyVv/dPJ41+KKpLKU+wDUFwR5bS1pD1LNyIWUn5ycfAPPc3JOzGgPXX9Dz+CIL4SE7tBTeKMXolQSVgULlTULFUDuMrjmG7Gcfl8sH7SofWGs+oNkCme1L0j7bn8YTngPkHXHiOTJ90VyYTxMTa1lCpOCepKJ6XamtjmBNKxAxkeV2QdqiMG7/Py96+yN9mS1KMGRXZAFstbYFM401JoeKsoZXZgEk4d7svekXgkvymgXNneU11b5ZRDWT188ptc3rGP9/Z/w9ybBh6PcSBqHxKIKl0LPMMX8w9U7TLAUd1SuhpFkHte2hKPf4fL9eAIZFt5X6WhUmlyUhXE+fXry9OlIVGq0OB15MRs1a0reDiMl21GGkGWZBjh6DRmedfUW+E/hBQlLFn44Oz9/OR7fTt7/8vJi0+E8ntzRZFlRCtuHt7KV8KjJ8J6WGaaQ4UKUNWXYPkJ+KjrMl0tfGL2GepgYcKt5ZazvC89lOtO9IsLzYfq4Ms4f8L7wreQkMUpBQpJ1z5stiiKajqYM4UcQeU7O3XpzT7rtvJmK5/vgZ/ow05VV2h/0MI7Z+ODwcJ2Yt2IhxqHa1sjZmFwVhtGO+Rk4EV+E8jAlnxeBkf+DjybCmpMvjGQ8XIbbXKW9GWzXFXPwsS+tJhI2CXx9TFYu65UVWdutrmjd03xn5DKFt+P3F8dRB9R0edDAPS3XOIf2kK2Z+meZjnRJ4cVA1dZBdEampOPSzA7Y9PAZ8l2O8LnJMc6HdsoXmOI/Y5LPLChOvPW15SPdezK4rTXveBkkLag01Zzf7RgpVEwM1FTWeJObsk1Ho4ZDtWnDN6fdiXZeO2/mfYgEF8IqcVdGge3DxB5iKurSd2ligqTrOWtZN+RP0LTN+K8nk0sY4rQJcjab8Qa8O8mNoyjzGndmYCy8ueQgjGUzyF6qOv9g3YZGshfmMT8pEWSQ5wbvQkG+MnYuON7b3ybYdaV8r+IqDs9KAN0m7HxraWrJFf81CEdxRl+tWtyXX2kYE1R6anabunFdkXXEHHrl2Xl9igst2i1OI3/Oz0V4XLvePP57CE3w3RKqe5iKhbHKk9tmde25xl+FvXehh2RH4QYvmBq70VvWbh25pwc/qkqhNGcTirbpLtA1ikpxyqcY3ktMMK3uMcH1hLjOYiFdY9PcCUcfbNm2PP25Jsvv7s2qlsMVk8rxb4npVJSOvgLq4KrryQ7hrzLum369DFemrHmECSs8C8I9tnxSUQnD7nHhLM8p6HXvstPtbAgLyyomyE3gWo8zVFH3g8PvzadpokXU1nZIL7xNnGHb/gm5yu7H
sidebar_class_name: "post api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Add tags to an object"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/tag/{object_type}/{object_id}/"}
context={"endpoint"}
>
</MethodEndpoint>
Adds tags to an object. Creates new tags if they do not already exist.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./add-tags-to-an-object.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./add-tags-to-an-object.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./add-tags-to-an-object.StatusCodes.json")}
>
</StatusCodes>

13
docs/developer_docs_versioned_docs/version-6.1.0/api/advanced-data-type.tag.mdx Normal file
View File

@@ -0,0 +1,13 @@
---
id: advanced-data-type
title: "Advanced Data Type"
description: "Advanced Data Type"
custom_edit_url: null
---
Advanced data type operations and conversions.
| Method | Endpoint | Path |
|--------|----------|------|
| `GET` | [Return an AdvancedDataTypeResponse](./return-an-advanced-data-type-response) | `/api/v1/advanced_data_type/convert` |
| `GET` | [Return a list of available advanced data types](./return-a-list-of-available-advanced-data-types) | `/api/v1/advanced_data_type/types` |

25
docs/developer_docs_versioned_docs/version-6.1.0/api/annotation-layers.tag.mdx Normal file
View File

@@ -0,0 +1,25 @@
---
id: annotation-layers
title: "Annotation Layers"
description: "Annotation Layers"
custom_edit_url: null
---
Manage annotation layers and annotations for charts.
| Method | Endpoint | Path |
|--------|----------|------|
| `DELETE` | [Delete multiple annotation layers in a bulk operation](./delete-multiple-annotation-layers-in-a-bulk-operation) | `/api/v1/annotation_layer/` |
| `GET` | [Get a list of annotation layers (annotation-layer)](./get-a-list-of-annotation-layers-annotation-layer) | `/api/v1/annotation_layer/` |
| `POST` | [Create an annotation layer (annotation-layer)](./create-an-annotation-layer-annotation-layer) | `/api/v1/annotation_layer/` |
| `GET` | [Get metadata information about this API resource (annotation-layer--info)](./get-metadata-information-about-this-api-resource-annotation-layer-info) | `/api/v1/annotation_layer/_info` |
| `DELETE` | [Delete annotation layer (annotation-layer-pk)](./delete-annotation-layer-annotation-layer-pk) | `/api/v1/annotation_layer/{pk}` |
| `GET` | [Get an annotation layer (annotation-layer-pk)](./get-an-annotation-layer-annotation-layer-pk) | `/api/v1/annotation_layer/{pk}` |
| `PUT` | [Update an annotation layer (annotation-layer-pk)](./update-an-annotation-layer-annotation-layer-pk) | `/api/v1/annotation_layer/{pk}` |
| `DELETE` | [Bulk delete annotation layers](./bulk-delete-annotation-layers) | `/api/v1/annotation_layer/{pk}/annotation/` |
| `GET` | [Get a list of annotation layers (annotation-layer-pk-annotation)](./get-a-list-of-annotation-layers-annotation-layer-pk-annotation) | `/api/v1/annotation_layer/{pk}/annotation/` |
| `POST` | [Create an annotation layer (annotation-layer-pk-annotation)](./create-an-annotation-layer-annotation-layer-pk-annotation) | `/api/v1/annotation_layer/{pk}/annotation/` |
| `DELETE` | [Delete annotation layer (annotation-layer-pk-annotation-annotation-id)](./delete-annotation-layer-annotation-layer-pk-annotation-annotation-id) | `/api/v1/annotation_layer/{pk}/annotation/{annotation_id}` |
| `GET` | [Get an annotation layer (annotation-layer-pk-annotation-annotation-id)](./get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id) | `/api/v1/annotation_layer/{pk}/annotation/{annotation_id}` |
| `PUT` | [Update an annotation layer (annotation-layer-pk-annotation-annotation-id)](./update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id) | `/api/v1/annotation_layer/{pk}/annotation/{annotation_id}` |
| `GET` | [Get related fields data (annotation-layer-related-column-name)](./get-related-fields-data-annotation-layer-related-column-name) | `/api/v1/annotation_layer/related/{column_name}` |

1
docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"in":"query","name":"form_data_key","schema":{"type":"string"}},{"in":"query","name":"permalink_key","schema":{"type":"string"}},{"in":"query","name":"slice_id","schema":{"type":"integer"}},{"in":"query","name":"datasource_id","schema":{"type":"integer"}},{"in":"query","name":"datasource_type","schema":{"type":"string"}}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.StatusCodes.json Normal file
View File

File diff suppressed because one or more lines are too long

68
docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: assemble-explore-related-information-in-a-single-endpoint
title: "Assemble Explore related information in a single endpoint"
description: "Assembles Explore related information (form_data, slice, dataset) in a single endpoint.<br/><br/> The information can be assembled from:<br/> - The cache using a form_data_key<br/> - The metadata database using a permalink_key<br/> - Build from scratch using dataset or slice identifiers."
sidebar_label: "Assemble Explore related information in a single endpoint"
hide_title: true
hide_table_of_contents: true
api: eJztGWtvG7nxrxBEgcaoYifBFQj2egUcn3Nx6kvSWGkLRMGG2h1pmXDJDcmVrQr678UMudJK4tpO7tp86RdbS84M5/0gV7wEV1jZeGk0z/ipc1BPFTh2ftMoY4FZUMJDyaSeGVsLhGMP8GdeCi9GzClZwIjhhwN/xKRmgjmp5woY6LIxUvvjv0ztyV/pDxtXsEOrEJpNgYl4cMlm1tRZgH1I0IUoKmAt0mSCbY7OP8OyD1aDF7hOrEyF26I0YGuhpP7cR3nWShUOY66wwhdVhI+SMGODbEyWoL2cSbDumI94I6yowYN1PHu/4hLV9qUFu+QjrkUNPOM7PPIRd0UFteDZivtlgwDOW6nnfL0epQnscPwtBIjzXJYpXKk9zMEOI5MGTGt/FwqEcpsEH0bcgmuMduBw/8mjR/ivMNqD9vhTNI2SBbnLySeHfrrq0WusacB6GbCj9Q43yItyL2swLW3vOv7PrY2+LTVzUBhduiNmZsxHD0TXiNjog8xX0nW+gm6xr5oRL4xqa50HV3eHR57RPov7PRpm+gkKvyUxiOs2To/Y0kPtehrekokLwlqxxO8uQhJq6GJHOGcKSZF/LX1FajiUdntEz+LBB1KUMaxwt0ehc4MRL2EmWuXzLmkkSASITVqJdkgx1ifbIzHEVG81SQRK6fPWqkMKmHnevb0kVhCK3OQOluDGW3FI6uXV61csQDH0fiE1/iRoXJjJeeekoKAGPeA0M/BFlS+EasHljYUSYydhkTfdFmsdmrkCzQgXTw3oIT/eJc9MKg82d6CQg4Nzrs4vz8/GLEAxCmYomTcDdKfGKBD6gHAOWmCBODzgIkTp7jnSsYiQpj23QrdKWOmXufuiEvZ4JWqgDAB1Y6xQLERj0Ba5nqwhHocqw6Wrv1+ybSi4YzbGNDGToErkqITGAqq8HCEZ9rHHxUcmtfMgyp1Yvn9Q739XIJSv8qKC4nNeg3NinnCCFwTFCIpFqKSRZULxXfhc/JzOgNKhapWY5gsJ14OG6yqudEyQBi/FlCFG2nK1kDovva/zwgxEJILs2y0pVQ3eyiKRYDvRIsDX5ddvzIBmNoulK40Y9tOqNrYEm0+XeVEZWUBCokvpkAQjSDZdRrW4W91ty9xd7mauNbVEg8fSfr+ZSqi0J9A+fWq7EvTPKT2G3VsKwtZY2FslkiHYWjpHyfWmsUA/k1badh5pK4X9NGpIZM4Lm0iTtMmEUqxQonVpH3FfEi5/SlHjvPBUFpivBNa0mdTg7szeHpPkQNHGWNJdGqyAEew9e4PeCVA3OETkQzYcE9kOLBozaTxMufncYgZIJ+3O3TbBv82wEhxzbdMYi5xPl/t8/w5BEL6HPAN3kwpqb0uurZZf2v4UkiSxADs1DvJaNIekfhVNQxUKq7kV18Gm3rCItZ+SOn2v91fQAF7Bljuq0t20c3jwc2NrUvG2kejmSuxwrFEulFNvqA8O3XYlrP9jaK4ZDRZJVxgsaad62VWyzfQau43GmgIcHmjhSwsu7a80PP2PJggSdmB+wKNncfDJS/BCqlSlChubk/pYSfEiBJT5dJlMhM5onH7n1rRNyCWVcGyD1o0+rpoaYcv0GZXQcyjzVNM9ljU4L+qmY1kJ51ltyh22w1gUZkl4iHq7/Zy8amuh5b9TDeLdJ+K1BRFgFkRJ6QgZSE8Um/5uIGhp766AvXUuuaKLh7umkt5+Xgv7GcrSXKeoCS09aoa9GP96iUFPda5zGPTA/8IERFGUnhfukzBSRWaf5DYZSJfXQgt0BbjxYLVQKuHcF32RpWMRh5nWO1kC2+IOtJ7kMikXu/wtHjXUO70+6JlSfegtTRNlz5yuUm4SKYtu18JmUt/DyXdzv5SkGe7NhqaCgDvccATswS45oA+6YsB+9/YygXxLPaOIuxUiFq6zoK+r0AXSNC/qRsHu5dOel/fLVcfNts6s1+v9hMDfgm+tDt2bxPClOYaOPsZTf/hNt2S92nmXinYl3ErxTGyKaMYu9EIoWbLt3SiW2oUsoeQJ4Xq4QZbH31eWd1q0vjIWc2TGTltfYcDFOEZGpU0L0kcMkvzwfSV5ZbC3aHWZ0Z14VDL1O7EslQYc08YzuJGo/kOhNjRIoidPvrdtYtNGKRTt4pcZ+we6W7wLs9bYlBxnplUliRopRGw86s/fO3wudKg0zIFdgA1SZOxUs1bDTQMFGo0WmSmK1g444HPhhdqoACfMosXLJHqa+HTtefb+A96wezHH54ouifEPI37zsDAlXBFv4SlDCT3nGS/evb3kI67EFNT2s+t4eNFaxR7+i/1yPmYTXnnfZCcnyhRCVcb57Omjp09PRCNPFo9PIJx2MuFsMploxh6+YBN+GkOGdJ2xZyAsWPaH07Oz86urfPz6b+evJpzj00Jk6M3SV0b3WNosbJiSOO35zt/dRE9096jAftosH8/BP0A+2P05HwX4CkQJ1v202uN/wjM24VGGCWd/YqJAX8u9+Qx6PdFHE91Yqf2Djp9j9K4HR0d9CV+Khbgis/ak3Fncqt9oh4JuhBPXQvpwcUuyfZ1kqx3xsu6b7dsJ5fzYmWoVZByTiB8Dxhr/obw/TnTgkdq4jr896SOQUXCszPwBgh79yNFTa/CVKXnG5+Dptc1XPOP73KNGKHCC51I3kJab74fMJW6zEhagTEPXJYES2SMQWjXWeFMYtc5OTlZIap2t0MHWB9TOWufxCTGQGPGFsBIzlYtZg8iEToUeLyKbfMRBtzWGZPzEfw7jcu9+djx+wzZ08FrXOL9LbyPvAXNXIbfgXrjFseziDd2BGbtHJKmqiE/Qa3qp6/ILtT9BSMoyKz4l33jeTW0v/znuXv2oh6bdbUdGQq9HiJxbmFlw1bcSwe5fz0xi7GkbsA52urztUpyCeMYXj4NKnK8Fpf34iNm9hd/6FJ567t7XY6/O/P+B/e4H9mhdbHVPGiUkTV6x3w/p4D0XjUQbPsY4iiVtxDF6Qni856sVcvjOqvUal8P7NKaKUrr4jDQTysGI4wv74ZM9vX/xLNShAZz9V/r74PQe5u8Dvv8U/5U48fF9i/Vhm6GoNaBnohIsqSagnxYFUMnpsA46o500/cs5xii2wb12aBOp8QdS72ZT3VfVahUgQinB9BqYoOrJ1x/W6/V/AFE8FoM=
sidebar_class_name: "get api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Assemble Explore related information in a single endpoint"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/api/v1/explore/"}
context={"endpoint"}
>
</MethodEndpoint>
Assembles Explore related information (form_data, slice, dataset) in a single endpoint.<br/><br/> The information can be assembled from:<br/> - The cache using a form_data_key<br/> - The metadata database using a permalink_key<br/> - Build from scratch using dataset or slice identifiers.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./assemble-explore-related-information-in-a-single-endpoint.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./assemble-explore-related-information-in-a-single-endpoint.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./assemble-explore-related-information-in-a-single-endpoint.StatusCodes.json")}
>
</StatusCodes>

12
docs/developer_docs_versioned_docs/version-6.1.0/api/async-events-rest-api.tag.mdx Normal file
View File

@@ -0,0 +1,12 @@
---
id: async-events-rest-api
title: "AsyncEventsRestApi"
description: "AsyncEventsRestApi"
custom_edit_url: null
---
Real-time event streaming via Server-Sent Events (SSE).
| Method | Endpoint | Path |
|--------|----------|------|
| `GET` | [Read off of the Redis events stream](./read-off-of-the-redis-events-stream) | `/api/v1/async_event/` |

12
docs/developer_docs_versioned_docs/version-6.1.0/api/available-domains.tag.mdx Normal file
View File

@@ -0,0 +1,12 @@
---
id: available-domains
title: "Available Domains"
description: "Available Domains"
custom_edit_url: null
---
Get available domains for the Superset instance.
| Method | Endpoint | Path |
|--------|----------|------|
| `GET` | [Get all available domains](./get-all-available-domains) | `/api/v1/available_domains/` |

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"tags":{"items":{"properties":{"description":{"nullable":true,"type":"string"},"name":{"minLength":1,"type":"string"},"objects_to_tag":{"description":"Objects to tag","items":{},"type":"array"}},"type":"object","title":"TagObject"},"type":"array"}},"type":"object","title":"TagPostBulkSchema"},"example":{"tags":[{}]}}},"description":"Tag schema","required":true}}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"objects_skipped":{"description":"Objects to tag","items":{},"type":"array"},"objects_tagged":{"description":"Objects to tag","items":{},"type":"array"}},"type":"object","title":"TagPostBulkResponseObject"}},"type":"object","title":"TagPostBulkResponseSchema"},"example":{"result":{}}}},"description":"Bulk created tags and tagged objects"},"302":{"description":"Redirects to the current digest"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

66
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.api.mdx Normal file
View File

@@ -0,0 +1,66 @@
---
id: bulk-create-tags-and-tagged-objects
title: "Bulk create tags and tagged objects"
description: "Bulk create tags and tagged objects"
sidebar_label: "Bulk create tags and tagged objects"
hide_title: true
hide_table_of_contents: true
api: eJzFV21P3DgQ/ivW6KSCLrDQ60lVqn4ARNX2KkDsVncSWVFvMiTuJnZqOwvbKP/9NHaSzb4gtfCBT4ntmfE8z4zH4xo0/qjQ2FOVLCGsIVbSorT0y8syFzG3QsnRd6MkzZk4w4LTX6lVidoKNDSyPHVfYbEw28sJmliLkkzRUFZ5zmc5Qmh1hQHYZYkQgrFayBSaACQvkAQLIb+gTG0G4fEOMTX7jrE1t1bdWp5ubQSXfp1ZxWg96N1remNca76EZjXhbUIAVljyECY89XbgN7WulLGnVT4fe86aAPCBF2WOK8Ju6mbakJl1vyc8ZS3TgQuQ0Jh4shqaMKWSxjP7+ujoGWHTaKrcbs93xJq5KEva+unMDqLE0/R5tn6N7+uWny5qv6e1M1o9T82OaJE2izVyiwkhMIxL95NiwlrwZO+vo9fb4K8xEbqHnyGLK61RWpaIFI3LuTfPCnGBxvDU59z6+dniZR1zrwinPGFtmQjZJ7nguUhYyTUv0KI2rNRqIRJMYBc5K12P5fhlsXyVvLKZ0uInJiE7qWyG0rb7s/6o7QAyVPRI3rwskgtl2Z2qZBKySYYdyUh0G1XpGFmi0DCpLMMHQfRvg+pt0C5/v3SefZIWteQ5M6gXqBlqrXTITiSrJD6UGBM6N8lU7M7Jzkh94JbnXs5tbjCutLBLKrfw/d5CeDNtpkFXgqkIGJgG8HAQqwTHzjFXmyHnMoUQ4q/XXyCAnM8wXw09yTSudM4O/mNXl+MJiyCztgxHo1zFPM+UseHbo7dvR7wUo8XxyPJ0NKvy+a2vFxGwKIokYwcfWQQnbYI5wkN2ilyjZn+cnJ2dj8e3k8t/zi/WFc58qA4myxJDthmtlWzCXtURzHEZQcgiWPC8wgiaV9AEPcirpc2UHMDsJ3qgoiiVtl2mmUhGsruL2Pt++rBUxu7Rvuy32Qi8WoY8QW3e1xucePdbXiJgfzIex2ioAZijbFptwv5+F95I7key1ELavc7vQxLe298fMvGZL/jY5dOAjbXJVeiVNERITwK/58KyO7Rx5ih4EgG1x1GgzVRCACizNskJOzG2mTkE+luXPLVnaOII+hasVIa542nazh8v3fE6U8kyZJ/HlxeH/miLu+Vezea4HJDMmn2SJq7fRdLzk3DLe242mG+FVI6HuUr3SHT/HdDxfPSSffSODcBTBiFQDkIAJafWER6hmyLpKo0/7ZWmQO+MF2y684WWWYILzFVZ0H3tLbk88obqUiurYpU34WhUk6kmrOkANVvWzipjVdGZCGDBtaD+uOuknRnfO9xx14g4NyEAlFVBNawd0sfVsnX7HyeTK9bbaQIgb9bt9Xi3nBv7Ykxr1JYzpdmnKzJCWNaN7KSq1XfSTUOR7Qqya7U8SFeWa5i5rP2gdMHJ3ud/JxQjJwZhuwr9deJANwEp32q802iypxohK0bJ69Vj6Hy7V98A1t5v3WtlNd58ltzQe2faTJsAhLxT203guCpRGxx2poMpSlAvtzj2vBtbcP+Q8jv/2uHYeIS1+C0+2FGZcyHJtkvduj03N8BLQQ4cg7stIYDh6Zl2eXQDdT3jBr/qvGlo+keFmq7b6SqV3aUbgC9ejsw5Lin1B2XIZX5euYZ/s/Ogc+U1TuIYXRV+XHY6qARUO8nx9n1bqIR0NL+npxW/hxAoYo4V/ySiOX8XVL4t8TYpRagDHFDXp1L7Q6i6B4tcDjysay/hqzCdfw/FXVvgnoD/A3qlW3c=
sidebar_class_name: "post api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk create tags and tagged objects"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/tag/bulk_create"}
context={"endpoint"}
>
</MethodEndpoint>
Bulk create tags and tagged objects
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails>
</ParamsDetails>
<RequestSchema
{...require("./bulk-create-tags-and-tagged-objects.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./bulk-create-tags-and-tagged-objects.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Annotations bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: bulk-delete-annotation-layers
title: "Bulk delete annotation layers"
description: "Bulk delete annotation layers"
sidebar_label: "Bulk delete annotation layers"
hide_title: true
hide_table_of_contents: true
api: eJzFV9tu2zgQ/RVisA8JVq2ToAsEKvqQZlO03aAtGnd3gShwGWlsKaZIhRy58Qr698WQkiw7LvYK5EnmbXjOXA7HDVTSyhIJrYP4uoEMXWqLigqjIYZpjkJqbUjyhFByjVZUSzE3VlBeuNEiRFDwkUpSDhFoWSKPlhCBxfu6sJhBTLbGCFyaYykhboDWFe8qNOECLbRt1EBqNKEmXpZVpYrUm5/cOUbUjA4XhKXbZyXqZ6S1cg0RUEGKxwukWYYKCWdF5madqbZtO+z3Ndr1Bvw9tDeM3lVGO/RXnRwd8edvY6ysqdBSEU6X6Jxc4AizI1voBRPvZ8ztHabEJPBBlpXCrYObA220E6uzIRRO3NZqKQJTtvTi6PhpUX/Rsqbc2OIPzGJxVlOOmrr7xZAee0iNDwYmL56WyQdDYm5qncWCi4OxoyPMhEVnapuiyAw6oQ0JfCgc7SM12PCMTk6eOjaVNSkPbxUKjgutY/GrVEUW4oPWGruPx7mpVeapdha603zVT09dKO80odVSCYd2hTawiMWZFrXGhwpTDpqfFCZNa/udBHwjSarBBRE4TGvLHFks774RxNc3rBIkFyygoyoUl6yWDm4ieHiWmgyvPMogs0rqBcSQfvl8CREoeYtqMwyJxOPaKvHsd/HzxeXF9EIkkBNV8WSiTCpVbhzFp0enpxNZFZPV8WSjxTMv1JPx1CQBkSSJFuLZW5HAWVdVfi0Wr1FatOKHs/Pzi6ur2fTjLxcfEgCW4w7ppzXlXuR7rMPEgLYoK2OpLwmX6ET32ileDdPPgywdMBTxXylFwUqOMkPrXjU7xBKIRQIduQTEj0KmnKczMkvUbaIPE13ZQtNBD/S5I0m1m3G8Dsf838uVvPJ5MfLB1uQmakY7dsNAXX6TBYk5Upp72v8H6SYwL5FykzHLkCO7Lon7jWI36Oybr33cm+CXqXfL13Ci5Q/76GWimZJR+FyZxa6rDl/6V3K7al5v3p9H/YODCAJsiKF7o6LQNsTwXR801bIdu4Ed7gs71FNtOR573Qq74C55WWS4QmWqEjV1EuHDHQw1lTVkUqPaeDJp2FQbN5zd7SNr57UjU/YmIlhJW7CSuk7VvBn+neFc1oo6mBAB6rpkyeiG/PFqsW3/7XT6SQx22ggYzba9ge8jcFdB+3iNexphrHj3iY0wl20je13Vnfe725bj3OvfFSt3IOlVsIFbn0tvjC0l23v/2xS6Vo+LIqzCoN6edBvx4ZnFuUWX/1sjvnubm0BnC31doXVIow5wNMW5E/atjoNLHJXSP0td//dXWbx12/BSET7QpFKy0GzV51PTpfc1yKrgq48hgt0Uhwhi3y5v9dScECHi19A0t9LhF6valqdDt/qoaR89urBx1TaqJa59f8vpqmpe90Xc524wWviOIIN4LpXDR3Q3txx87jq4Q/HP/jDsxdb37no9htdjrpbQ3nAVeH3zQMPCWZqi1+H+yKN+gxkOwhPkkr1dUz6K3pBi3Q++YC+ipgk7gma2A0D/tDDGtv0TlHWf6A==
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk delete annotation layers"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/annotation_layer/{pk}/annotation/"}
context={"endpoint"}
>
</MethodEndpoint>
Bulk delete annotation layers
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./bulk-delete-annotation-layers.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./bulk-delete-annotation-layers.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./bulk-delete-annotation-layers.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Charts bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: bulk-delete-charts
title: "Bulk delete charts"
description: "Bulk delete charts"
sidebar_label: "Bulk delete charts"
hide_title: true
hide_table_of_contents: true
api: eJzFVm1v2zYQ/ivEYcAaTImTrgMCFf2QZgnaLuiC2dkLosClpYvFhCIV8uTGE/TfhyNlxXY8oNuXfJJE8Z67514esoVaOlkhofOQXreQW0NoCNIWZF1rlUtS1ozuvDW85vMSK8lvirDy/ELLGiEFZQjn6KBLVivSObmEBEiR5u850rRAjYRTVfhpD9V1XQLKQAoPDTreb2TF2x+gu0nAoa+t8RhcvT485Mc3x1g7W6MjFa0r9F7OcS1mT06ZOXRPMdvZHebEJPBRVrXGDcMngy6BAn3uVM2uIYXTUjryYtboexFJMsibw6OXDfjKyIZK69TfWKTipKESDfX+hcOHRjksdvFZN4xMfnxZJufWzVRRoEnFX7YRhTXfkyjlAkWNrlLeMyOyQuY5ei+oVF449LZxOe4iOOBFdm9elt1nS+LWNqZIxaTEUBn0hMVAQRQWvTCWBD4qT7sYDRiB0evXL915tbNcCjnTKLjraJmK36VWRew+dM66naNkG10Eqj1Cb82ufnppBfhoCJ2RWnh0C3SRRSpOjGgMPtaYc9HCorB53rh/Ga9zSVIPKUjAY9445sgafPeVIL2+YfkjOWdd7uUFbhJ43M9tgeMQWpRsLc0cUsivfruABLScoX767AcghbxxWuz/KX4+uzibnIkMSqI6HY20zaUuraf0+PD4eCRrNVocjXL2N8pAZFlmhNj/IDI46QUh5DoV71E6dOK7k9PTs/F4Ovn1l7PPGUCXDBFdLqm0Zi2mYWGISlW1dbTqd5+ZzKwUX7wblg+ior7iUMS3hp7E3SXKAp1/124RyCAVGfQkMhA/9MoxJXuPpsvMXmZqpwy9WgV04ElS46ec/711np/kQo5Dcde4biw+VcEaz3QHivKrVCRukfIy0Psv5NrIsEIqbcFsYm23qaerjWK7iJyDL6s6tpH/JND/Ei06fnAu3maGQ7caD7Sdb6dk7204qzdb/P3TUSjy2L4JxFghhf6MTKCWVEIKmwQ5ZWG+Yoc3jjO6MzGw7faCf4sCF6htXaGhflJDwSJQWztLNre6S0ejlqG6tOU+7J6hnTaebLWCSGAhnWJB8724BBh+L/BWNpr6MCEBNE3Fk9t/8iPM7yb+h8nkUgw4XQIczSbewPdZcOMoQfyP70zCOvHxkkGYyybIzlT19mF313EFVzI0ZgGNJIMYtTALXXJuXSUZ79MfE65R2AZp/xcGEQ2ku4SNpw5vHfry/4KE2+GtjXQ2om9qdB5p7Ya5tsS9E/ctjmJKPFUynA79/XJnf264GE4Jwkca1VqqcFkITdT2jXsNslbs7wgSCDCQANc5FvIa2nYmPV453XW8HC+53NRbroYjDZ4ysOn3HpfhWsxdqBv+H6Zu1ZLhyEggDn3wEA1O8hyDCK2snp2YjDIMZtQQSIDvf2s5GKrTv7CD1UXfLNfg2zbuiELCIxXjCLoK3U3Xdf8ARu5KZw==
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk delete charts"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/chart/"}
context={"endpoint"}
>
</MethodEndpoint>
Bulk delete charts
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./bulk-delete-charts.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./bulk-delete-charts.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./bulk-delete-charts.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"CSS templates bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: bulk-delete-css-templates
title: "Bulk delete CSS templates"
description: "Bulk delete CSS templates"
sidebar_label: "Bulk delete CSS templates"
hide_title: true
hide_table_of_contents: true
api: eJzFVttu3DYQ/RVi0IcYlb22kQKGgjw4roMkNVKju24LWMaGK413ZVOkQo423gr892JISXvxtmjz4ieJlzkzZ65soZZWVkhoHaS3LeRGE2qCtAVZ16rMJZVGjx6c0bzn8gVWkv9KwsrxD61qhBRKTThHCz7pd6S1cgUJUEmK13OkaYEKCadl4aYdlPc+gVJDCl8btHxfy4qvfwV/l4BFVxvtMKg6PT7mz3+2sbamRktllK7QOTnHDZsd2VLPwa9tNrMHzIlJ4JOsaoVbgmsBn0CBLrdlzaohhYvxWBBWtZKETswa9SgiV8Z6fXzysnbfaNnQwtjyLyxScd7QAjV1+oXFr01psdhHa1MwMnn9skw+GxL3ptFFKiYLDLajIyyERWcam6MoDDqhDQl8Kh3tIzVgBEanpy8dm9qanJczhYLjQqtU/C5VWcT4oLXG7s0506giUO0QOmlW9dNLl8pHTWi1VMKhXaKNLFJxrkWj8anGnIMWNoXJ88b+QwK+lyTV4IIEHOaNZY7crB6+EaS3d9wnSM65gYU6nPR1CHcJPB3mpsBxsDC2OCX1HFLIb367ggSUnKFaL2MS8bqxShz+KX6+vLqcXIoMFkR1Ohopk0u1MI7Ss+Ozs5Gsy9HyZJQ7N+3Lf5SByLJMC3H4QWRw3hVQ8Hwq3qG0aMUP5xcXl+PxdPLrL5efMwCfDIZdr2hh9IZpw8ZgXFnVxlKf/S7Tme4bpXg7bB/FDvSKTRH/k0EShRYoC7TubbvDI4NUZNBxyUD8KGTOGTgl84jaZ/og07UtNb3q7TpyJKlxU47GwSbdT3IpxyHiG5S3NtcxMdox64Gp/CZLEvdI+SKw/A6ObSRaIS1MwaRiwHc9kPYXxW5I2RVf+qi20Q2T4IUvUcLzh13yJtPMwCg8Uma+65mDN2Hgbaf/u/UgEVsjBhKIJkMK3aBJoJa0gBT20mU/hkqMRdBYdvNeb8GuEVd8LApcojJ1hZq6mg5RjEBtbQ2Z3CifjkYtQ/m05Rz1z9AuGkem6iESWEpbcutzXRsKMPxf4L1sFHVmQgKom4prvFvyJ5T4Nv6HyeRaDDg+AbZmG2/g+8y4cWxWfMbPEGGs+HjNIMxlG2Svqzr5cNt7jmffsMbcaiPJ0LZamIWceW9sJRnv0x8TjlG4Bml3CkO7DaR9wsJTi/cW3eJ7QcKD695EOlvWNzVah7TxaNvY4tyJ95Yn0SWOKhnmSPdk+7ds3dI0jBXCJxrVSpaaEUMutV0a34KsS1Z7AglspjIkwFGPYb2Ftp1JhzdWec/b8RXJKb6jcRiFsPbHtvpHXIV3J+ekavg8VGSfoGHUJBAbQtAQBc7zHEOf6qWeTVpGGao19hdIgF9WG64YYtX9sIL+Ja1XG/BtG2/EJsMFFu0IrRf8nff+b2/1FBM=
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk delete CSS templates"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/css_template/"}
context={"endpoint"}
>
</MethodEndpoint>
Bulk delete CSS templates
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./bulk-delete-css-templates.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./bulk-delete-css-templates.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./bulk-delete-css-templates.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Dashboard bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: bulk-delete-dashboards
title: "Bulk delete dashboards"
description: "Bulk delete dashboards"
sidebar_label: "Bulk delete dashboards"
hide_title: true
hide_table_of_contents: true
api: eJzFV21v2zYQ/ivEYcAaTImTrAMCFf2QpgnaLuiC2dkLosClpYulhCIV8uTGE/TfhyMl+SUusO5LPkmmeM/dcy8P6QYqaWWJhNZBfNNAajShJogbkFWlilRSYfTo3hnNay7NsZT8VhCWjl9oWSHEUGjCOVpoo35FWiuXEAEVpPj3HGmaoULCaZG5aQfVtm0EhYYYHmu0vF/Lkrc/QnsbgUVXGe3Quzo+POTHf46xsqZCS0WwLtE5Oce1mB3ZQs+hXcVsZveYEpPAJ1lWCjcMVwZtBBm61BYVu4YY3kuXz4y0mZjV6kEEnozz+vDoZWO+1rKm3NjiH8xicVpTjpo6/8LiY11YzHZRWjcMTH5+WSYXxs6KLEMdi79NLTKjfySRywWKCm1ZOMeMyAiZpuicoLxwwqIztU1xF8EBL7B7/bLsPhsSd6bWWSwmOfrKoCPMBgoiM+iENiTwqXC0i9GA4RkdH79051XWcCnkTKHgrqNlLP6QqshC96G1xu7icWZqlXmqHUJnza5+eWkR+KgJrZZKOLQLtIFFLE61qDU+VZhy0fyiMGla22+M14UkqYYUROAwrS1zZBm+/0oQ39yyApKcszSvFMbBbQRP+6nJcOzDC8qtpJ5DDOn175cQgZIzVKuf3RDEkNZWif2/xPvzy/PJuUggJ6ri0UiZVKrcOIpPDk9ORrIqRoujUdb7HCUgkiTRQux/EAmcdsLgcx6LdygtWvHD6dnZ+Xg8nfz26/nnBKCNhqiulpQbvRbXsDBEVpSVsdT3vUt0onvxF2+H5YOgrK84FPE94UfBIkeZoXVvmy0SCcQigY5IAuKnTkWmZB5Qt4neS3RlC02v+qAOHEmq3ZTrsLfO9ZNcyLEv9BrfjcVVNYx2THmgKb/KgsQdUpp7it9LsAksS6TcZMwo1HmbftxvFNvF5Dx86evZhBxMfAq+BIuWH5yPN4nm8I3CA2Xm22nZe+OP782Wf7c6GkW2aucIQrwQQ3duRlBJyiGG50Q5fX7uQtfXlrO7M0mw7f6SP4sMF6hMVaKmboJ98QJQU1lDJjWqjUejhqHauOG+bJ+hndWOTNlDRLCQtmChc53oeBh+z/BO1oq6MCEC1HXJE9395Ief6U38D5PJlRhw2gg4mk28ge+z4MZBmvgbX6eEseLjFYMwl02Qnanq7P3utuVK9vI0ZmENJL1INTDz3XJhbCkZ79OfE66R3wZx9xUGcfWk24iNpxbvLLr8/4L4i+OdCXQ2oq8rtA5p7fK5tsS9E/YtjkJKHJXSnxrd1fObfbrhZjhBCJ9oVClZ+IuEb6Sma+AbkFXBPo/YuoeCCLjeoaA30DQz6fDaqrbl5XAP5ubecjccebDKxKbvB1z6mzN3o6r5u5/CvjX9kRJBEAHvIRicpil6Yeqtnp2ojDIMadAUiIDvh2t5GKrUvbCD/r+AXq7BN03YEYSFRyvE4bUW2tu2bf8FpG9YOg==
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk delete dashboards"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/dashboard/"}
context={"endpoint"}
>
</MethodEndpoint>
Bulk delete dashboards
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./bulk-delete-dashboards.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./bulk-delete-dashboards.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./bulk-delete-dashboards.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Dataset bulk delete"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: bulk-delete-datasets
title: "Bulk delete datasets"
description: "Bulk delete datasets"
sidebar_label: "Bulk delete datasets"
hide_title: true
hide_table_of_contents: true
api: eJzFV21v2zYQ/ivEYcAaTImTrAMCFf2QpgnaLuiC2dkLosClpYvFRCIV8uQmE/TfhyMl+SUu0O2LP0mmeM/dc+9uoJJWlkhoHcQ3DaRGE2qCuAFZVYVKJSmjR/fOaD5zaY6l5DdFWDp+oecKIQalCedooY36E2mtfIYISFHBv+dI0wwLJJyqzE07qLZtI1AaYnis0fJ9LUu+/gjtbQQWXWW0Q6/q+PCQH99tY2VNhZZUkC7ROTnHFZsdWaXn0C5tNrN7TIlJ4JMsqwLXBJcCbQQZutSqilVDDO8lSYckZnXxIAJLRnm9a4vfyUxYfKzRUSw+6oUsVCaWMReVNQuVYbaN04ps4HK0Wy7XWtaUG6v+wSwWpzXlqKnT7w1VdjuRVcHA5OfdMrkwdqayDHUs/ja1yIz+kUQuFygqtKVyjhmRETJN0TlBuXLCojO1TXEbwQEvsHu9W3afDYk7U+ssFpMc+xTCbKAgMoNOaEMCnxQn10tGA4ZndHy868yrrOFQyFmBgrOOnmPxBxdTyD601thtPM5MXWSeaofQSbOqX3bdHD5qQqtlIRzaBdrAIhanWtQanypMOWj+UJg0re03yutCkiwGF0TgMK0tc+SBcv+VIL655V5Ocs5Dpu+VDm4jeNpPTYZjb1yYQIXUc4ghvf79EiIo5AyL5c+uBGJIa1uI/b/E+/PL88m5SCAnquLRqDCpLHLjKD45PDkZyUqNFkejLGgcJSCSJNFC7H8QCZx2TcH7OxbvUFq04ofTs7Pz8Xg6+e3X888JQBsNNl09U270ilXDwWCXKitjqc95l+hE9yNMvB2OD8KEeMWmiO83Pgr3c5QZWve22aCQQCwS6GgkIH7q+seUzAPqNtF7ia6s0vSqN+nAkaTaTTkGe6tMP8mFHPsQr7BdO1xGwmjHhAeS8qtUJO6Q0twT/G/0msCxRMpNxnxChDfJx/1FsRlI9sKXPpZN8MDEO+BLkGj5wd54k2g23hR4UJj5plP23vgFZGMkLse7yPo0jiBYCzF0kz+CSlIOMWySZMf5Wgu5Xlv261b3wKbqS/4sMlxgYaoSNXVV68MWgJrKGjKpKdp4NGoYqo0bzsf2BdpZ7ciUPUQEC2kVNzfXNRoPw+8Z3sm6oM5MiAB1XXIVdz/54St5Hf/DZHIlBpw2ArZmHW/g+8K4cWhH/I2XQWGs+HjFIMxlHWSrqzp5f7ttOYp9SxpzMw0kfWNqYOYz5cLYUjLepz8nHCN/DeLuKwwN1ZNuIxaeWryz6PL/C+LX3jsT6KxZX1doHdLK6rxyxLkT7i2OgkscldJPim5x/kaOrikZZgbhE42qQiq/Ovg0arrkvQFZKdZ4xNIBCCLgWIdg3kDTzKTDa1u0LR+HDZ4Te0PZMOJg6YV1zQ/47Hd+zsSi5u+++vq09CMkglD8XkMQOE1T9O2ol3oxQRllKM/QSyAC3gdXvDBEqHthBf2/GP28At804UZoKFxWwQ7fYaG9bdv2X7NvmWI=
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk delete datasets"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/dataset/"}
context={"endpoint"}
>
</MethodEndpoint>
Bulk delete datasets
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./bulk-delete-datasets.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./bulk-delete-datasets.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./bulk-delete-datasets.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Report Schedule bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: bulk-delete-report-schedules
title: "Bulk delete report schedules"
description: "Bulk delete report schedules"
sidebar_label: "Bulk delete report schedules"
hide_title: true
hide_table_of_contents: true
api: eJzFV21P5DYQ/ivWqFIPNbBArxLK6T5wFHR3RVd0LH0RQXveZNgYHDvYkz22Uf57NXY2+wJVr/3Cp2Qdz8zzzIyf8bZQSycrJHQe0usWcmsIDUHagqxrrXJJyprRnbeG13xeYiX5TRFWnl9oUSOkoAzhDB10yXJFOicXkAAp0vx7hjQpUCPhRBV+0rvqui4BZSCFhwYd7zey4u0P0N0k4NDX1ngMoQ739/nxzRhrZ2t0pKJ1hd7LGa5h9uSUmUG3wmynd5gTk8BHWdUaNwxXBl0CBfrcqZpDQwqfsbaOxGVeYtFoFNNG34vIlr293j94WeRXRjZUWqf+wiIVxw2VaKiPLxw+NMph8RyxdcPI5MeXZXJm3VQVBZpU/GkbUVjzPYlSzlHU6CrlPTMiK2Seo/eCSuWFQ28bl+NzBAd/kd3rl2X3yZK4tY0pUjEuMVQGPWExUBCFRS+MJYGPytNzjAYfgdHh4Ut3Xu0sl0JONQruOlqk4jepVRG7D52z7jkeJ7bRRaDae+itOdRPLy0FHwyhM1ILj26OLrJIxbERjcHHGnMuWlgUNs8b9w/H60yS1EMKEvCYN445shjffSVIr29YB0nOWKC3dcbDTQKPu7kt8DKAjCqupZlBCvnV53NIQMsp6tXP/iikkDdOi90/xM+n56fjU5FBSVSno5G2udSl9ZQe7R8djWStRvODkQuRRxmILMuMELvvRQbHvTaEtKfiHUqHTnx3fHJyenk5Gf/6y+mnDKBLBkgXCyqtWQM1LAywVBUo9q3vM5OZ5RQQb4flvSiurxiK+GbsSdxeoizQ+bftFoMMUpFBzyID8UOvIhOy92i6zOxkpnbK0Ksloj1Pkho/4QrsrBP9KOfyMhR6jezG4qoO1njmO3CUX6UicYuUl4Hff2LXRooVUmkLphPLu809XW4U22XkJHxZVrKNCRgH/l+iRccPTsabzDB2q3FP29l2TnbehAm+2e/vVnNRRNzCD72cQEQNKfSjM4FaUgkpbHHl9IVzF/u9cZzdZ5ME2wjO+bMocI7a1hUa6k9wKF501NbOks2t7tLRqGVXXdpy3O6Jt5PGk62WLhKYS6dY6HwvOsENvxd4KxtNPUxIAE1T8Ynuf/IjnOZN/+/H4wsx+OkSYDSb/ga+T8BdRmnib3ypEtaJDxfshLlsOnk2Vb192N11XMylPLH+VJFkEKkWpqFhzqyrJPv7+PuYaxS2Qdp/hUFcA+kuYeOJw1uHvvy/TsL18dZGOhvomxqdR1q7gq4tce/EffODmBJPlQxTo7+A/kurbgQb5gjhI41qLVW4ToR2avsevgZZK458AHyvDVlNgEsea3oNbTuVHq+c7jpejhdi7u+tWMPUg1UyNgPf4yJcobkhdcPfw1lcdmeYKglEKQgRosFxnmPQpqXVk6HKXoZDGpUFEuAr4loShkL1Lxxg+afALNbct23cEeWFT1fEEeQWupuu6/4G0RZcQg==
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk delete report schedules"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/report/"}
context={"endpoint"}
>
</MethodEndpoint>
Bulk delete report schedules
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./bulk-delete-report-schedules.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./bulk-delete-report-schedules.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./bulk-delete-report-schedules.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"RLS Rule bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: bulk-delete-rls-rules
title: "Bulk delete RLS rules"
description: "Bulk delete RLS rules"
sidebar_label: "Bulk delete RLS rules"
hide_title: true
hide_table_of_contents: true
api: eJzFV21P4zgQ/ivW6KRbdIECtyehrPYDy4F299AuouVeRFDXTYYm4NjBnhR6Uf77aewktAWkE1/4lNTxPJ5nXp5xG6iklSUSWgfxZQOp0YSaIG5AVpUqUkmF0aMbZzSvuTTHUvJbQVg6fqFlhRBDoQnnaKGN+hVprVxCBFSQ4t9zpGmGCgmnReamHVTbthEUGmK4q9Hyfi1L3n4H7VUEFl1ltEN/1P7uLj/+t4+VNRVaKoJ1ic7JOa747MgWeg7to89mdoMpMQl8kGWlcM3w0aCNIEOX2qLioyGG89OxOK8VilmtbkWgyTDvd/fe1uULLWvKjS3+xSwWhzXlqKk7X1i8qwuL2XOMVg0Dk1/flsmJsbMiy1DH4h9Ti8zon0nkcoGiQlsWzjEjMkKmKTonKC+csOhMbVN8juCAF9i9f1t23wyJa1PrLBaTHH1m0BFmAwWRGXRCGxL4UDh6jtGA4Rnt77915VXWcCrkTKHgqqNlLP6UqshC9aG1xj7H48jUKvNUO4TOmo/67a014IsmtFoq4dAu0AYWsTjUotb4UGHKSfOLwqRpbV9orxNJUg0hiMBhWlvmyCp8c08QX16xAJKcszLDubkXp7hAJcb9zqsIHrZTk+HYuxkEXEk9hxjSi/NTiEDJGarHn10zxJDWVontv8Xvx6fHk2ORQE5UxaORMqlUuXEUH+weHIxkVYwWeyNr7hUf3fs4SkAkSaKF2P4sEjjsdMKnIBafUFq04qfDo6Pj8Xg6+f7H8bcEoI0G586WlBu94t6wMDhYlJWx1LeBS3Si+1EgPg7LO0Fo37Er4hUsomCYo8zQuo/NBpcEYpFAxycB8UunLVMyt6jbRG8lurKFpne9bzuOJNVuylnZWqX8VS7k2Kd/hfba4mNujHbMfGAr72VB4hopzT3TV/JsAtkSKTcZEwvJ34xC3G8Um6nlcPzos9uEUEx8JH4Ei5YfHJYPiWYWRuGOMvPN6Gx98KN9vR8+Pc5NwcPU1lzREQR3IYZupkZQScohhhfpcix9a4aGqC2H+tmIwaYTp/xZZAxnqhI1dU3uMxmAmsoaMqlRbTwaNQzVxg3XavsE7ah2ZMoeIoKFtAVroet0ycPwe4bXslbUuQkRoK5LbvruJz8cPAnZ58nkTAw4bQTszTrewPeJc+OgXvyNL1zCWPHljEGYyzrIs6Hq7P3utuV89gkYs/YGkl7HGpj5mjkxtpSM9/WvCefIb4O4+wqD/nrSbcTGU4vXFl3+WhB/tbw2gc6a93WF1iGtXE9Xlrh2wr7FXgiJo1L6wdJdTl+q1rVThhlD+ECjSsnCXzV8HTVdGV+CrAo+cg8i2CxliICzHtJ6CU0zkw4vrGpbXg73ZS7xjVOH2QiP8Vh34RaX/obNNalq/u47si9QP3siCILgTwgGh2mKXqt6qyejl1GGjg36AhHwRXIlHEOuuhc+oP/PoJcr8E0TdgSR4QYLfnj5hfaqbdv/ANuMaKo=
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk delete RLS rules"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/rowlevelsecurity/"}
context={"endpoint"}
>
</MethodEndpoint>
Bulk delete RLS rules
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./bulk-delete-rls-rules.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./bulk-delete-rls-rules.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./bulk-delete-rls-rules.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Saved queries bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: bulk-delete-saved-queries
title: "Bulk delete saved queries"
description: "Bulk delete saved queries"
sidebar_label: "Bulk delete saved queries"
hide_title: true
hide_table_of_contents: true
api: eJzFVt9v2zYQ/leIwx4aTImToAMCFX1IsxRtF7TZ7GwDosClpYulhCIV8uTGE/i/D0fKsp14w7qXPEmieN/ddz8+soNGWlkjoXWQXneQG02oCdIOZNOoKpdUGT26c0bzmstLrCW/VYS14xdaNggpVJpwjhZ8slqR1solJEAVKf6eI00LVEg4rQo37aG89wlUGlJ4aNHyfi1r3v4A/iYBi64x2mFwdXx4yI//HGNjTYOWqmhdo3NyjhsxO7KVnoNfx2xmd5gTk8BHWTcKtwzXBj6BAl1uq4ZdQwpjucBCMIUKnZi16l5Eroz1+vDoZeO+0rKl0tjqLyxScdpSiZp6/8LiQ1tZLHbR2jSMTF6/LJPPhsStaXWRikmJIXZ0hIWw6ExrcxSFQSe0IYGPlaNdpAaMwOj4+KVr01iT8+dMoeC60DIVv0tVFbE+aK2xu3icmVYVgWqP0Fuzq59eelQ+akKrpRIO7QJtZJGKUy1ajY8N5ly0sChMnrf2HxrwvSSphhQk4DBvLXNksbr7RpBe37BOkJyzgMGvcQLhJoHH/dwUOA6xRXFTUs8hhfzqtwtIQMkZqvVnbB/+bq0S+3+Kn88vzifnIoOSqElHI2VyqUrjKD05PDkZyaYaLY5Gjgd/GrRrlIHIskwLsf9BZHDaT05IeSreobRoxQ+nZ2fn4/F08uWX888ZgE+GuC6XVBq9EdmwMMRW1Y2xtGp7l+lMrxRSvB2WD6L0vOJQxPcRSKJNibJA6952T2hkkIoMeioZiB+FzLnzpmTuUftM72W6sZWmV6uwDhxJat2Ua7G3yfaTXMhxqPQG463FdUWMdkx6ICq/yYrELVJeBpLfT7GLPGuk0hTMKVb7aQLS1UbxtKCcia+rmnYxC5OQhK/RwvODM/Im00zAKDxQZv40MXtvwjm33fXv1ueHcJsnCyQQQ4YU+vMlgUZSCSnsYstZDPMXB6C1nOSduYKnMVzwb1HgApVpatTUT3KoYQTqGmvI5Eb5dDTqGMqnHTeof4Z21joy9QoigYW0FQue68UnwPB7gbeyVdSHCQmgbmue7P6TH2G8t/E/TCaXYsDxCXA023gD32fBjaNE8T++fAhjxcdLBmEu2yA7U9Xbh93eczlXMjVmgY0kg1h1MAst897YWjLepz8mXKOwDdL+LwwiG0j7hI2nFm8tuvL/goRr1q2JdLaibxu0DmnjqraxxL0T9y2OYkoc1TKcHv1F7d+adcvTcJgQPtKoUbLSjBh6qeu7+BpkU7HbI2a07mRIgIseq3oNXTeTDq+s8p6X4xbu8CcOh/MP1unY9n6Py3DZ5JZULf8P87jqz3C+JBDlIHiIBqd5jkGkVlbPjldGGWY1qgskwNepjUwMpepf2MHq+qyXG/BdF3dEieH5inEE3QV/473/G72iEVg=
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk delete saved queries"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/saved_query/"}
context={"endpoint"}
>
</MethodEndpoint>
Bulk delete saved queries
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./bulk-delete-saved-queries.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./bulk-delete-saved-queries.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./bulk-delete-saved-queries.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"delete_tags_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Deletes multiple Tags"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: bulk-delete-tags
title: "Bulk delete tags"
description: "Bulk deletes tags. This will remove all tagged objects with this tag."
sidebar_label: "Bulk delete tags"
hide_title: true
hide_table_of_contents: true
api: eJzFV21P5DYQ/ivWqFIPNbBwvUoop/vAcaC7K7qi7tIXEcSZZNgYHDvYk4VtlP9ejZ0Nu8sioaoSn5L4Zfw88/J40kKBPneqJmUNpPCx0beiQI2EXpCc+h0xKZUX90pr4bCyMxRSa56aYiHs1Q3mxNNUCuKFJKc7kEAtnayQ0HlIz1vIrSE0BGkLsq61yiWfN7rxfGgLPi+xkvymCCvPLzSvEVLw5JSZQpcsBqRzcg4JkCLN3xHrJUO97M10XZeAYjZ3DTpebGTFa++gu0jAoa+t8RiOebu7y48X46udrdGRirsr9F5OcQPeR8DRRcwAH2RVa1zZ+LihS9ZC8amPQtVoUrVGMZFTz3be7e69LuYzIxsqrVP/YJGKg4ZKNNSfLxzeNcphsYnS8sbI5OfXZXJs3ZUqCjSp+Ns2orDmRxKlnKGo0VXKe2ZEVsg8R+9jhjv0tnE5biI42Ivs3r0uu2+WxLVtTJGKSYkhMugJi4GCKCx6YSwJfFCeNjEabARGb9++dubVznIo5JVGwVlH81T8IbUqYvahc9Zt4nFoG10Eqr2Ffjcf9ctri8AXQ+iM1MKjm6GLLFJxYERj8KHGnIMWBoXN88Y9U17HkqQeXJCAx7xxzJEl+OaeID2/YAVksYT0HIKgXCTwsJ3bAscBWNRrLc0UUsjPfj+BBLS8Qv342ad/CnnjtNj+S3w6OjmaHIkMSqI6HY20zaUurad0f3d/fyRrNZrtjUhORxmILMuMENufRQYHvRgEP6fiI0qHTvxwcHh4NB5fTn779ehbBtAlA57TOZXWLCEaBgZMqqqto0Wu+8xkZiH44sMwvBOvjTcMRbwMeBLXligLdP5DuwY/g1Rk0FPIQPzUa8Yl2Vs0XWa2MlM7ZejNAs6OJ0mNv2Tfby2z/CpnchzCusR0ZfAxAtZ4JjsQlPdSkbhGystA7uXU2sivQiptwVxiVNeJp4uFYj2A7IHvixi2kf0kkP8ed3T8YE+8zwwDtxp3tJ2uO2TrfbimI5Dhhg89BZWQwjJ29kUomZi2jWNXbWQM68VywtOiwBlqW1doqC++EIloqK2dJZtb3aWjUcumurTl9OqeWDtsPNlqYSKBmXSKNcr3ehHM8HuB17LR1MOEBNA0FRdj/8mPUJSr9j9PJqdisNMlwGhW7Q18n4AbR1XhOe6EhHXiyykbYS6rRja6qt8fVncdB2ehLGPWxEgy6EsLVyEBjq2rJNv7+ueEYxSWQdrPwqCLgXSX8OZLh9cOfflfjYSe79pGOivomxqdR1pqGpeGOHfiutledImnSgbB77vGpZY4dMTr7lm6OP639rlnRvhAo1pLFfqJkJRtXwbnIGvF+PcgCDokwFkT0+Ic2vZKejxzuut4ODbCXCLPQn/u1Fuch9aZc1o3PB/Kc5Hg4U5JIKpDOCFuOMhzDFq12PXkSl0p8ig2kAA3iEtX6RDr/oUPWPwJmPmS+baNK6LicIFGHEF+obvouu5fNK1zXA==
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk delete tags"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/tag/"}
context={"endpoint"}
>
</MethodEndpoint>
Bulk deletes tags. This will remove all tagged objects with this tag.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./bulk-delete-tags.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./bulk-delete-tags.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./bulk-delete-tags.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Themes bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: bulk-delete-themes
title: "Bulk delete themes"
description: "Bulk delete themes"
sidebar_label: "Bulk delete themes"
hide_title: true
hide_table_of_contents: true
api: eJzFVttu3DYQ/RVi0IcYlb22kQKGgjw4roMkNRKju24LWMaGK41XsilSIUcbbwX+ezGkVnvxFkj74idJFOfMOXMjO2iklTUSWgfpbQe50YSaIO1ANo2qckmV0aMHZzSvubzEWvJbRVg7fqFlg5BCpQnnaMEnqxVprVxCAlSR4u850rRAhYTTqnDTHsp7n0ClIYVvLVrer2XN27+Bv0vAomuMdhhcnR4f8+OHOTbWNGipitY1OifnuMHZka30HPyas5k9YE4sAp9k3SjcMlwb+AQKdLmtGnYNKUxKrNGJWaseRRTJIK+PT16W8I2WLZXGVn9jkYrzlkrU1PsXFr+1lcVin55Nw6jk9csq+WxI3JtWF6mYlBi4oyMshEVnWpujKAw6oQ0JfKoc7RM1YARFp6cvnZvGmpw/ZwoF54WWqfhDqqqI+UFrjd2n48K0qghSe4Teml398tI98lETWi2VcGgXaKOKVJxr0Wp8ajDnpIVFYfK8tf9SgO8lSTWEIAGHeWtZI0+ph+8E6e0dDwiSc55cfQPCXQJPh7kpcByoxaGmpJ5DCvnN71eQgJIzVOvPWD383VolDv8Sv15eXU4uRQYlUZOORsrkUpXGUXp2fHY2kk01WpyMiP2NMhBZlmkhDj+IDM77lgmxTsU7lBat+On84uJyPJ5Ovvx2+TkD8MnA6HpJpdEbnIaFgVVVN8bSqt5dpjO9moni7bB8FGfOK6YifpR6EneXKAu07m23IyCDVGTQi8hA/CxkzsU2JfOI2mf6INONrTS9WhE6ciSpdVOO/8Gmzk9yIcchuRtatxbXWTDasdxBovwuKxL3SHkZ5P0XcV1UWCOVpmA1Mbe70tPVRrGbRI7B11Ueu6h/EuR/jRaeHxyLN5lm6kbhkTLz3ZAcvAmn2XaJv1sfFoJi+SYQuUIK/SmSQCOphBS2BXLIQn/FCm8tR3RvYGDX7RX/FgUuUJmmRk19p4aERaCusYZMbpRPR6OOoXzacR36Z2gXrSNTryASWEhb8UBz/XAJMPxe4L1sFfU0IQHUbc2d23/yI/TvNv6HyeRaDDg+AWazjTfofUZuHEcQ/+NbhTBWfLxmENayDbI3VL192O09Z3A1hsZ5TFjaD6MOZqFK3htbS8b79OeEcxS2Qdr/hWGIBtE+YeOpxXuLrvy/IOH+dG+inC32bYPWIW3cwTaWuHbivsVJDImjWobTob+B7a3PLRfDKUH4RKNGyUozVCiiri/cW5BNxf5OmEdQkgDnOSbyFrpuJh3eWOU9L8drIBf1jqvhSIN1BLb9PuIyXBy5ClXL/0PXrUoyHBkJxKYPHqLBeZ5jGEIrq2cnJqMMjRlnCCTAN6SNGAzZ6V/YweoqrJcb8F0Xd8RBwi0VeYS5Cv7Oe/8P7HX75w==
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk delete themes"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/theme/"}
context={"endpoint"}
>
</MethodEndpoint>
Bulk delete themes
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./bulk-delete-themes.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./bulk-delete-themes.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./bulk-delete-themes.StatusCodes.json")}
>
</StatusCodes>

12
docs/developer_docs_versioned_docs/version-6.1.0/api/cache-rest-api.tag.mdx Normal file
View File

@@ -0,0 +1,12 @@
---
id: cache-rest-api
title: "CacheRestApi"
description: "CacheRestApi"
custom_edit_url: null
---
Cache management and invalidation operations.
| Method | Endpoint | Path |
|--------|----------|------|
| `POST` | [Invalidate cache records and remove the database records](./invalidate-cache-records-and-remove-the-database-records) | `/api/v1/cachekey/invalidate` |

1
docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.RequestSchema.json Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.StatusCodes.json Normal file
View File

File diff suppressed because one or more lines are too long

68
docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: change-a-database
title: "Change a database"
description: "Change a database"
sidebar_label: "Change a database"
hide_title: true
hide_table_of_contents: true
api: eJztXOtvG7kR/1cGbIGz0Y1k5x4N9hwDju1DfHUTJ7LvWkSBSu2OJMZcckNyJauC/vdiyH1JWudx9yEfqk+x+BjODGd+nIeUFcu54Rk6NJbF71ZMKBaznLsZi5jiGdKnexYxgx8LYTBlsTMFRswmM8w4i1fMLXNaJZTDKRq2Xr8Pq9G6Fzpd0pJEK4fK0Z88z6VIuBNa9T9YrWisoZUbnaNxAq1fK6VejBLH/acUbWJETjtZzM5oDs7fXp7dXsLt2YvrSzgbgPbTIBQM3lzDNR+zqOJvrLVErtg6qujOP0v3t6vL37+WbJrJx6gWFo0Fp8EUCpRWTwaX15fnt2Add5ihchYO7m4uzm4vI7i4vL6kfwMnEfR6vcMvY2AiJI6KXGqePsaI0xAWwPngN6ANkHLHQSinwc2E9R/H3OLVBCxKTBymEeQSuUWw6MDNEMK1WfDHYgoTbSCx84q0UHD54AzvfYJXU6gRt0uV7HL6OkfDHfqTKm6Ipl8+M1rpwkKmU4wgQ66EmoKb8cDZxwKNQAvcIOADJoXDFLQCg5l2CAtt7ukmuAWd59piShrRyu9d4BgsmjkaEM6inPTgljTCrS0ytOGQpS5gxucIHM5RolmWNEk3RU6EFygl/cvBoC2kszDmyT2qtAdvcYIGvKZJIuu4lN4hINWJ9WrMtKGpiTaZn+nWYcKTGY6cyFAXbleDF4UJZA+EAouJVqk9BD3x59Jer7OwO1zejBtnw4qWDfTgrF6mJ3AEQqXkwpUyKnIICklt+JALg7YHr7S/PyKFE+6VUEo9lXrMZU1VTKBQKU6EwpREVYWUfCyxApttiIkIUSZiWgo4ytDNdGnt/iAWM/tRckkWuhyRGlm0pZ3zDgogLDlpWtnCxHjg8uYRbsMPlzcJixm6WbhKfMilThEaNAXtJ3Kj5yJF0EougUOLq8IIkhVVkbH4XRe/S8UzkYSP79cRqy5kFIB5x7cbP6EFnukUlROTZbiFRCuFSWVPGX+4RjV1MxY//fEoYplQ1efjR6/AOiPUlG4gNWKOZpeLwZvrsyAHhCUebSw+fq0NTVRToToka9EMS76G5gN5+Eiokf1IS3epX/oVmzZPBwzeXD+GtPjg0CguR4XxaP8FXDjDd48+yU9/Hbx+BWEhXZDjwmOZ3wAbZg4owyvROxmb02PCJYSTRKd4GrQy8tZnT/p+DPT4AyYOpugsFCono00riEc44TAzOHk+ZDPnchv3+4Q+vcYMe9pM+6j6kjzd9RNtsB/Osb2Zy+RfWksTg9zhKEwPGRiUz4dMaZ2jQgNKG8I8g2bITh/bdtLnp5BwKSNYzOhJcrV4GTpON7Ml4J+VzKAcHY+OgmjVGTuyhWeu9090/II7/uXSVTtqwfy9PW3fWy3YBpRX8tGrUyJrhZQWnSPzaBA9vBclHZigS2YdCD7IMSEcEI4epRPrjFbT0yHrZmDIYlgNy7hsd+qno6MIhsyRxXfOrk/65Qk9uCJst+iiUpKFkBKUdjBGQEUkQuTg8bZQHp64FG75R58dUvL3bSWXccqojFMIT9tB0qa2dZZxsEiGRkGDFNafXsU6/uTzwW8htqginyaecvpxXX+GD9LduyHLi7EUyZCRhhM7ryffb+q0BqqJ5HNtINVovVptkefauJJjeoW4WlafhG3zPEbgSYLWUnD3obAOJFJQQ5r1gmOWuyXp84e2PudorNCq0ttEoEyD9koYs0EBISSrgHX8nYVyZxlR2ZkuZEpc+Dd3IdwMbgxap+HihQWrm3u2S+X4A/g3zBhMHDH1Y5spL5YdzYVxBZejYJv+VTbYwWmJ5W1Wq9dcG69HOvYy7Idx4dxG/F8HdUGMhfJW91OboVRYz0PALYNzgYs/xIj365JAHdl6LxqjzyQWM1TB8b3G6dQGEBqee3/vZM8IKUdOj1J0XMg/wqEnQfYUSNCuknrj2TUSPdu5tFFWSCdGCXdc6mntjbWzi8lmDhBumoJVejaCiZVhH5REgkpMofxTWmcDKgX/4tAgkbNIb2k/P2UdL/ZEmwR98jlq8tPN1/t3OsWzQxQ/m4tGwRPKcU/fBgfxVxYcMjyJPnvyq8uzPxmuHX1BGCSyHI3Vit5bykN3pbmalN4XkUwbeVTL8An2ptrr3fNbp1c8yJIUxqBycglST6chlKbzYDHTkBHG+LwpR5MJS2BQ5cNuhhl5Uf/0agIvBeVWKoWZmGMvpGNPe+G56KX6zDte+XpEwRlKGs1tW5/GicSDnC6Ui8iPoaWITzM8F3zz+Nzoh2XPz5V1imV3XibsKOOKTzEdVYGiXH4iTGxtzbi9p20qMcvcBQJfFzjyNBXhDW3F+5uBpAcrD8FVvtNKVFqbWgmod2S7tA4zC1Lco7+iqLEYlcILMX1ToFn6+C2ZQao9ftHRPnMK0Rnpj9KTOOfWLrRJK3BXdJaUy8DReAlN1F856WetvF3MWrFGFTftutJ6OxW8ePEkgJtI2gmcT4nbemsuO4TWdGIwjlGCpiMDP8lPX+flZZyfjV7cvbq4voSyGuaT4TmXIiVTfHl7ezOAsm5me/Da54tzLrzAZJR0BBeqAcIqGP9S5Wzmnp3cbpQmvjKOftqRIlS8PimMtJ+JnAcfZZ046sT6qLmrFkK6mIUilnWmSFxhkAoyBu7eXlXKaKHl8dHTH7bhclc3djZyhVIoy8Lj64kvh24WJEVHRW0weAm3fidcXcABcVzkdKX28IsqGZUbtEqpLXs2Yk6IfY/Lz82PPkmoNFOepgat/dQSCh67yroRqzy3Y/d62zMi5oQjsdlFaQKDwcugJkYF4k29EPFCdHH+BYTfonVnuejlhQuZNs9yidv146D+duW3PeKLtu2BjSJqe6JVsQzDW0W440drU7sFnErKppjSjFSlkNbITiEjMLBZi2iv9y9HM9AR0TSTu/FBoP7IWxYmH3utGrIbgLwNl82ybWhqzbQds7aTxj52wbyCxzpy2mxdrGnA5lrZ4NNPj47+RItiw2hVkY2Dq4T0YN/R2Hc09h2NfUdj39HYdzT2HY19R2Pf0dh3NPYdjX1HY9/R2Hc09h2NfUdj39HYdzT2HY19R2Pf0dh3NB7taOys3+xx0BnH7YLzvunxf9D0eLzr4YNITMlKfvhTnY0MreXTL3KNTYusN7IXPK3wP4Yr5V+G9nNUPtBpVxuntTfIcvxtZblTvHAzbcR/MY3hrHAzqkOG86HuMHUI0t4YJPn+20ryizZjkaaoYvi3LiDV6rvOEDYk0iFmN2h1YRLsErCmF6T74dtK90pT5b9QaeyzstKEMK1FaOoK+CDIuHYlqml4iZ4+/daWlxtNV+HDJrI6t4zhtxBm+SKqMdp0yXHuqxEkakmh3E1H/fitweFKBWCtWlNeihjOFBQKH3LfoAuDoBOf0nS61y+UH9cqIKxNCkMyUqzzYeFY/O49Pc+OT+kHbjVQsvcRe3hCmfnAMxd+/Sa5mrKYJXdvr1nEJB8TAlcfSxeIWVIYCU/+BTd3txBCybjflzrhcqati58dPXvW57noz4/71ePXPx4yGA6HCuDJSxiysxITvLpjeIHcoIG/np2fXw4Go9vX/7h8tbnhPFzUk9tljjFs31WzNoXvVkN2j0sqvg3ZnMsCh2z9HVtHtXg3SzfzsX8lYD1QiygyX3KrovehGqqqaw7Pm6A+L9wBHQtfo4co7JghT9HY56stbQTGS40MGfytRKKR0/eo1uVukvp5l6RDdThUuRHKHVQc92jxweFhWwe/8jkfeDtq6WFjsLlurSypohafL7hwoT7lpf9a2VdBhBAkEe83d7fbaomrVbBtLSTufyqDWQXd3HrV/CdqtrTtJSho12bC6kqjY50uY6AcvBecWUyWByu4x2VLvbA+pNWk5Z+HKmjGV+UqrWzpvFykJfaknh7Q0sOffby8BVU+bAFe54KU8ZRBJKM4OAo/So3ZjlZX+f2aVUFWcOMQFHZeyk7X9JqmIcU5Sp1TM6oEJG8sgdAqN9rpRMt13O+viNQ6XpF/rHd7sIV1OqtIRGzOjSDctiWGejKbbV1is9U1LT/6BJXt6ImSaqjprCNG3GzSq+XdYW4QkJbmfDtVG7i68UmXNltEOlVV7ver1/53vhXaDuidCEJ6zF2xsTfQX3yKS571+y0rfzTs60N+tqk+eKHXEW0eGZwYtLM/SoSoWK3eNr9Avvy23wg72qdAfzYF8lnuUbuy0DqpXVDoHB51bdsuH+zMBJ84ahcJWqWFrYwsYlTO6SilFKRdbCf5raGyecRiNj8Obmhdxn3gVR7YBYsbJ9Txl8MH188lFz4ML5v4ATLfMZ4LOu6YNabIIhbn9wQwAUHesdWKxu+MXK9pmKrOFEW9b0DMY2vVCGHxhEuLO/zUESU7eFumRYfQOOkmn+UgV0uPlbKgTyxi4TLze7amb4mEJ9GfHibaj1tr404ESxAedpwlCfpX/fG171svzs0dIc24/O8L6DtZLGaGL+jbhHwReAxdD495fiyEFkWIbgNJAiPK/lr3VINW+QcJ1amF1SqsCE/7ulaKj4JIL+v1/wCyz0Mx
sidebar_class_name: "put api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Change a database"}
>
</Heading>
<MethodEndpoint
method={"put"}
path={"/api/v1/database/{pk}"}
context={"endpoint"}
>
</MethodEndpoint>
Change a database
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./change-a-database.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./change-a-database.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./change-a-database.StatusCodes.json")}
>
</StatusCodes>

31
docs/developer_docs_versioned_docs/version-6.1.0/api/charts.tag.mdx Normal file
View File

@@ -0,0 +1,31 @@
---
id: charts
title: "Charts"
description: "Charts"
custom_edit_url: null
---
Create, read, update, and delete charts (slices).
| Method | Endpoint | Path |
|--------|----------|------|
| `DELETE` | [Bulk delete charts](./bulk-delete-charts) | `/api/v1/chart/` |
| `GET` | [Get a list of charts](./get-a-list-of-charts) | `/api/v1/chart/` |
| `POST` | [Create a new chart](./create-a-new-chart) | `/api/v1/chart/` |
| `GET` | [Get metadata information about this API resource (chart--info)](./get-metadata-information-about-this-api-resource-chart-info) | `/api/v1/chart/_info` |
| `GET` | [Get a chart detail information](./get-a-chart-detail-information) | `/api/v1/chart/{id_or_uuid}` |
| `DELETE` | [Delete a chart](./delete-a-chart) | `/api/v1/chart/{pk}` |
| `PUT` | [Update a chart](./update-a-chart) | `/api/v1/chart/{pk}` |
| `GET` | [Compute and cache a screenshot (chart-pk-cache-screenshot)](./compute-and-cache-a-screenshot-chart-pk-cache-screenshot) | `/api/v1/chart/{pk}/cache_screenshot/` |
| `GET` | [Return payload data response for a chart](./return-payload-data-response-for-a-chart) | `/api/v1/chart/{pk}/data/` |
| `DELETE` | [Remove the chart from the user favorite list](./remove-the-chart-from-the-user-favorite-list) | `/api/v1/chart/{pk}/favorites/` |
| `POST` | [Mark the chart as favorite for the current user](./mark-the-chart-as-favorite-for-the-current-user) | `/api/v1/chart/{pk}/favorites/` |
| `GET` | [Get a computed screenshot from cache (chart-pk-screenshot-digest)](./get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest) | `/api/v1/chart/{pk}/screenshot/{digest}/` |
| `GET` | [Get chart thumbnail](./get-chart-thumbnail) | `/api/v1/chart/{pk}/thumbnail/{digest}/` |
| `POST` | [Return payload data response for the given query (chart-data)](./return-payload-data-response-for-the-given-query-chart-data) | `/api/v1/chart/data` |
| `GET` | [Return payload data response for the given query (chart-data-cache-key)](./return-payload-data-response-for-the-given-query-chart-data-cache-key) | `/api/v1/chart/data/{cache_key}` |
| `GET` | [Download multiple charts as YAML files](./download-multiple-charts-as-yaml-files) | `/api/v1/chart/export/` |
| `GET` | [Check favorited charts for current user](./check-favorited-charts-for-current-user) | `/api/v1/chart/favorite_status/` |
| `POST` | [Import chart(s) with associated datasets and databases](./import-chart-s-with-associated-datasets-and-databases) | `/api/v1/chart/import/` |
| `GET` | [Get related fields data (chart-related-column-name)](./get-related-fields-data-chart-related-column-name) | `/api/v1/chart/related/{column_name}` |
| `PUT` | [Warm up the cache for the chart](./warm-up-the-cache-for-the-chart) | `/api/v1/chart/warm_up_cache` |

1
docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_fav_star_ids_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A list of results for each corresponding chart in the request","items":{"properties":{"id":{"description":"The Chart id","type":"integer"},"value":{"description":"The FaveStar value","type":"boolean"}},"type":"object","title":"ChartFavStarResponseResult"},"type":"array"}},"type":"object","title":"GetFavStarIdsSchema"},"example":{"result":[]}}},"description":"None"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: check-favorited-charts-for-current-user
title: "Check favorited charts for current user"
description: "Check favorited charts for current user"
sidebar_label: "Check favorited charts for current user"
hide_title: true
hide_table_of_contents: true
api: eJzFVl1P3DgU/SvW1T6ANjCw6kooVR8oAkq3ahEzaFciaGqSOxNDYgf7Zgob5b+vrp1kPpitqvaBpySO7/E598u3gUpaWSKhdRDfNJAaTagJ4gZkVRUqlaSMHt07o3nNpTmWkt8UYen4hZ4rhBiUJpyjhTbqV6S18hkiIEUFf8+RpjO5mDqSdqoyN+3A2raNQGmI4bFGyxZalmzwCO1tBBZdZbRDf9gfBwf8+GGWlTUVWlLB2qKrC2+VoUutqtgKYjgWhXIkzEyEHU7MjBUo01ykxgYCmdJzkebSklBaUI7C4mONjiBa+mL9OJW9PGqSozgJKBlEW5y3kEWN2+3O5ALHJK0IewbrO2MKlBrape/N3T2mtOJ8f+aZXLD9VefRq+COzYh9D+Yce5CLzI27+EWAT7KsClz18c2tj+u6is9GI+9/80thLNE5OceV5HNklZ5vYb7ObTCE9zLr4xeLC72QhcrEshREZc1CZZjBFhErtkHL4etqudayptxY9S9msTiuKUdN3fmeqLLbhawaBiVvXlfJZ0NiZmqdxWKyLDBkdztT2xRFZtAJbUjgk2L3b0uxDoNP+fO18+xCE1otC+HQLtAKtNbYWBxrUWt8qjBldX5RmDSt7f9E6kySLMI+f7jDtLaKnn3Lvv8Wyu02ApJzbuOh2h3cRvC0l5oMx55a6PCF1HOIIb2++gQRFPIOi+VncDN/17YQe/+I89OJSCAnquLRqDCpLHLjKD46ODoayUqNFocj3xRHM7kwVhFye6fajRIQSZJoIfY+iASOu0Tzjo/Fe5QWrfjt+OTkdDyeTr78dfo5AWijgd7lM+VGrxAcFgaKqqyMpT5LXKIT3d8V4t2wvD9H2mEe4md1RME6R5mhde+aDTUJxCKBTlEC4nch0xSdm5J5QN0mejfRlVWadnp2+5x4O7u7q3o/yoUc+4ivaF5bXIbGaMeyB6nym1QkZkhp7pX+is5mTWzcf4vNGLLqr30Ym6B44gV/DRYtP1j920QHxpkkObDd8EW3yRS4X5j5Dm/dfeuv//VCOMkxfRA99yxcyOG69tWjSdQOLURQIuUmC2MHRFBJyiGG7/uAvezrNFRKbTkIW30Jm8Q+8W+R4QILU5XMIyD5GAegprKGTGqKNh6NGoZq44ZTuH2BdlI7MmUPwUOBVfKuwH7I8DBhSJhJf916mhAB6rrkDtB98sP3gXX8D5PJpRhw2giYzTreoPcFuXFoZfyPBzVhrLi4ZBDWsg6y1VWdvd/dthzjvp35gSKI9E2tgTufYWfGlpLxPv494Rj5bTz4+L/LQciLbiM2nlqcWXT5z4L4kXRmXg5i47pC63B1KFpZ4twJ+xaHwSWOSulvmW6o/fEMXjt3uIIIn2hUFVJpxveZ1XTZfQOyUkziECLwuBDBRo5DBJwOId430DR30uG1LdqWl8MAzrm/cfhwg8LSUetMHvDZj+zDBAu+fPvM9TdUBKGv+BOCwXGaom9vvdWLC5pRhmI+P+XY8diy4pIhgt0Lo/cTrX5ewW6asCM0Ki67QMJ3amh5Yv0PqbeFZg==
sidebar_class_name: "get api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Check favorited charts for current user"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/api/v1/chart/favorite_status/"}
context={"endpoint"}
>
</MethodEndpoint>
Check favorited charts for current user
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./check-favorited-charts-for-current-user.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./check-favorited-charts-for-current-user.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./check-favorited-charts-for-current-user.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_fav_star_ids_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A list of results for each corresponding chart in the request","items":{"properties":{"id":{"description":"The Chart id","type":"integer"},"value":{"description":"The FaveStar value","type":"boolean"}},"type":"object","title":"ChartFavStarResponseResult"},"type":"array"}},"type":"object","title":"GetFavStarIdsSchema"},"example":{"result":[]}}},"description":"None"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: check-favorited-dashboards-for-current-user
title: "Check favorited dashboards for current user"
description: "Check favorited dashboards for current user"
sidebar_label: "Check favorited dashboards for current user"
hide_title: true
hide_table_of_contents: true
api: eJzFVttu2zgQ/RVisA8JVq2bRRcIVPTBzSZtukVaxA52gShwx9LYYiqRKkm58Qr698WQknyJ95qHPkmiOGfOmRkOp4EKDZbkyFiIbxtItXKkHMQNYFUVMkUntRrdW614zaY5lchv0lFp+cWtK4IYpHK0JANt1K+gMbiGCJx0BX8vyc0WuJpZh2YmMzvrwNq2jUAqiOFrTYYtFJZs8BXauwgM2UorS97ZTy9e8ONfs6yMrsg4GawN2brwVhnZ1MiKrSCGsSikdUIvRNhhxUIbQZjmItUmEMikWoo0R+OEVMLlJAx9rck6iDax2HUns8eupjmJs4CSQXQgeCssajpsd4Ermjg0IuwZrOdaF4QK2k3s9fyeUrcVfO/zAldsf91F9DqEYz9jfwfzlnqQy8xOuvxFQA9YVgVtx/j2zud1V8WVVsT7Xz4pjSVZi0vaKj7rjFTLA8x3uQ2G8AazPn+xuFQrLGQmNkdBVEavZEYZHBCxZRu0nHxfLTcKa5drI/+gLBbj2uWkXOffE5XmsJBtw6Dk5fdVcqWdWOhaZbGYbg4Ycbitrk1KItNkhdJO0IPk8B8qsQ6Dvfz8vevsUjkyCgthyazICDJGm1iMlagVPVSUsjq/KHSa1uYvMnWBDouwzzu3lNZGurVv2fffwnG7i8Dhkts4/II2n2s0mYW7CB6epTqjiacXunyBagkxpDfXHyCCAudUbD5DqPm7NoV49rt4ez4VCeTOVfFoVOgUi1xbF5++OD0dYSVHq5NR1jscLXCljXTEbd7VdpSASJJECfHsnUhg3BWcT0As3hAaMuKH8dnZ+WQym3789fwqAWijgeKntcu12iI5LAw0ZVlp4/pqsYlKVH9niNfD8vMluSPmIZ6iJQoIOWFGxr5u9hQlEIsEOlUJiB8FpilZO3P6C6k2UceJqoxU7qhn+JyL8Oj4eFvze1zhxGd/S/fO4iZFWlmWPsjFbyidWJBLc6/2qVqbHcFx/y32c8nKP/fpbILqqRf9OVi0/OAIvEpUYJ2hw4HxXjy6Tbqg54VeHvHW41d+HNg9GGc5pV9Ezz0Tg55whfsTpZyoLRmIoCSX6yyMIhBBhS6HGP45Fhxxf37D6akNJ+RgXGGf4Af+LTJaUaGrkrkEJJ/vANRURjud6qKNR6OGodq44ZJuH6Gd1dbpsofgYcFInBfUDx8eJgwPC/TXsKcJEZCqS+4M3Sc/fG/YxX83nX4SA04bAbPZxRv0PiI3CS2O//EAJ7QRl58YhLXsghwMVWfvd7ct57pvc37QCCJ9s2tg7ivtQpsSGe/9b1POkd/GA5H/uxmQvOg2YuOZoYUhm/9fED+qLvTjAW1SV2QsbQ9LW0tcO2Hf6iSExLoS/e3TDbv/rZJ3fA/Xk6MHN6oKlIp9+Opquiq/BawkEzlh6x4bItirdYiAyyLk/RaaZo6WbkzRtrwcBnQ+A3sEhhsWNgHbZfOF1n6kHyZc8Me5r2B/g0UQ+oz3EAzGaUq+5fVWjy5wRhkO9ttzziGPNVthGTLZvTB6P/Gq9RZ204QdoXHx8QskfPeGlifaPwEkK5IW
sidebar_class_name: "get api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Check favorited dashboards for current user"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/api/v1/dashboard/favorite_status/"}
context={"endpoint"}
>
</MethodEndpoint>
Check favorited dashboards for current user
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./check-favorited-dashboards-for-current-user.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./check-favorited-dashboards-for-current-user.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./check-favorited-dashboards-for-current-user.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"},"example":{"result":"string"}}},"description":"System dark theme cleared"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

58
docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.api.mdx Normal file
View File

@@ -0,0 +1,58 @@
---
id: clear-the-system-dark-theme
title: "Clear the system dark theme"
description: "Clear the system dark theme"
sidebar_label: "Clear the system dark theme"
hide_title: true
hide_table_of_contents: true
api: eJzFVm1v2zYQ/ivEYcAaTImTvQABi37wMgdtF2zB7GAbIsOlqUukRCJV8uTGE/TfhyNlxXYyFGsG7JNo8u74PPfy0C049LU1Hj3IFr49PuaPtobQEC9VXZeFVlRYM7rz1vCe1zlWile1szU6KqK3Q9+UwYvWNYIET64wt9B1yWbHLu9QE3QJ4IOq6hK3/R7tuwQy9NoVNV8MEqZrT1iJTLl7QTlWKHSJymHGob4/PnkB6gq9V7f472EPjnBlVEO5dcVfmEkxbihHQ/39wuHHpghIn9LadoxMvvt/mZxbtyyyDI0Uf9pGZNZ8TSJXKxQ1uqrwnhmRFUpr9F5QXnjh0NvGaXyO4BCPb/zhRd31H7B7ZwidUaXw6FboBDpnnRRjIxqDDzVqwixuCqt14/6haueKVBntwuUedeMKWoO8buHuE4G8nnfzBEjdepDXMOOG9TBP4OFQ2wynAZoP5qUytyBBX/12AQmUaonl488+rxJ040px+If4aXIxmU1ECjlRLUej0mpV5taTPD0+PR2puhitTkZhQEaN8UgLHwZnwYOTgkjT1Ahx+FakMO4bLyRfih95mpz4anx2NplOF7Nff578kgJ0yQDxck25NVsgh40BZlHV1lHoePTkU5OajbyIN8P2UYYlEr5iKOKLuSTRPUeVofNv2j1GKUiRQs8qBfFN37ILsvdoutQcpKZ2haFXG4RHnhQ1fsEVOtgm/l6t1DSUf4v8zuZjnazxzH/grD6pgsQNks4D3xexbSPlCim3GdOL7bCfC7kxFPtl5qR82FS6jQmZhXx8iB4dfzg5r1PDXGyJR6W93c/RwWvg/t6dijMWZBZn4ffFGhKIoEFCLD4kUCvKQcJnqHN2w7DGcWkcJ//ZHMI+oAs+FhmusLR1hYb6sQ+1jYHa2lmy2padHI1aDtXJlnu4exLtrPFkq02IBFbKFWpZRm3ahOF1hjcqPmcMExJA01QsA/1P/gQx2I3/dja7FEOcLgFGsxtv4PsE3DTqGZ8ZVaGwTry75CDMZTfIs6nq/YN113FtN5o21VG8ZK9sLSxD/5xbVymO9/73GdcomIHsT2FQ5EC6S9h54fDGoc+/NEiXQGFubKSzg76p0XnktFBBLPrbW9w70W51ElPiqVLhqeFcfbZzd+4a3h7CBxrVpSrCyxa6qe1b+hpUXfDFJwyoj/K0seebEl9D2y6VxytXdh1vf2zQ8WMyf+yy8KQkECc8TMI9rkHCWGsMErRSZcO4nryoXMxh+KJgQAL8t2OLzZDwfsEX9EfKrLfCt220iKrBUxJxBFWFbt513d/O2JHE
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Clear the system dark theme"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/theme/unset_system_dark"}
context={"endpoint"}
>
</MethodEndpoint>
Clear the system dark theme
<ParamsDetails>
</ParamsDetails>
<RequestSchema
{...require("./clear-the-system-dark-theme.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./clear-the-system-dark-theme.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"},"example":{"result":"string"}}},"description":"System default theme cleared"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

58
docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.api.mdx Normal file
View File

@@ -0,0 +1,58 @@
---
id: clear-the-system-default-theme
title: "Clear the system default theme"
description: "Clear the system default theme"
sidebar_label: "Clear the system default theme"
hide_title: true
hide_table_of_contents: true
api: eJzFVmtv2zYU/SvExYA1mBInewABi37IsgRtF3TB7GAbIsOlpZtILUWq5JUbT+B/Hy4pK3aSYY8M2CfRfByecx+H7sGhb63x6EH28PXhIX8KawgN8VC1ra4LRbU1kw/eGp7zRYWN4lHrbIuO6nTaoe90PEXrFkGCJ1ebWwgh28zY5QcsCEIGeKeaVuP2ufv9IYMSfeHqli8GCdO1J2xEiTeq0ySowgZFoVE5LBnt28OjZxBv0Ht1i/+c+XgQrozqqLKu/h1LKU46qtDQcL9w+KmrI9PHyrYPJiXf/L9Kzq1b1mWJRorfbCdKa74kUakVihZdU3vPisgKVRTovaCq9sKht50r8CmBIx7f+N2zCuw/UPfGEDqjtPDoVugEOmedFCdGdAbvWiwIyzQpbFF07k+ydq5I6bQvXu6x6FxNa5DXPXz4TCCv52GeAalbD/IaZlywHuYZ3O0XtsRppObjdq3MLUgorn6+gAy0WqK+/znEVULROS32fxU/nF2czc5EDhVRKycTbQulK+tJHh8eH09UW09WR5PYIJPOeKSFj72zGHonB5HnuRFi/7XI4WSovRh/Kb7nhnLii5PT07PpdDH76cezdzlAyEaWl2uqrNniOU6MTOumtY5i0aMnn5vcbExGvBqnD0rUSPiCqYjnyMkSQoWqROdf9Q9E5SBFDoOwHMRXQ+EuyH5EE3Kzl5vW1YZebEgeeFLU+QXnaW9b+1u1UtNYBFv6dybvs2WN5xCMstVnVZO4QSqqKPm5gvukukGqbMkKU108DIfcbBQPk81xeb/Jd59iMosheZ9OBP5wfF7mhuVYjQfa3j4M095L4ELfbY9TdmZ2aeGfMG7IIPEGCakKIINWUQUS/joAHObYu6l7OsdZeDKY8JDWBS+LEleobdugocEFYpITUN86S7awOsjJpGeoIHuu5/AI7bTzZJsNRAYr5Wq11MmqNjA83hBPNCEDNF3DrjD85E/0hl3817PZpRhxQgbMZhdv1PuI3DTZG68Z1aCwTry5ZBDWsgvyZKiG83F3CJzhjcVNi+RlcjC6Hpaxis6taxTjvf1lxjmK20AOqzAadBQdMj68cHjj0Ff/FiRkUJsbm+TssO9adB45LFQTvwHbU1w7ad/qKIXEU6Piy8Ox+jv1u3Pd+BoR3tGk1aqOb10sqH4o7GtQbc13HzGnAeXJ8p5vEn0Nfb9UHq+cDoGnP3Xo+IWZ39dafGcySN0e++EjrkHCSVFgdKSV0h1Te/TMckrHLkzmARnwf5EtQWPYhwFfMCwps96C7/u0IzkI90riEU0WwjyE8AdoS5vc
sidebar_class_name: "delete api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Clear the system default theme"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/api/v1/theme/unset_system_default"}
context={"endpoint"}
>
</MethodEndpoint>
Clear the system default theme
<ParamsDetails>
</ParamsDetails>
<RequestSchema
{...require("./clear-the-system-default-theme.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./clear-the-system-default-theme.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"force":{"type":"boolean"},"thumb_size":{"items":{"type":"integer"},"type":"array"},"window_size":{"items":{"type":"integer"},"type":"array"}},"type":"object","title":"screenshot_query_schema"}}},"in":"query","name":"q"}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body"}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"cache_key":{"description":"The cache key","type":"string"},"chart_url":{"description":"The url to render the chart","type":"string"},"image_url":{"description":"The url to fetch the screenshot","type":"string"},"task_status":{"description":"The status of the async screenshot","type":"string"},"task_updated_at":{"description":"The timestamp of the last change in status","type":"string"}},"type":"object","title":"ChartCacheScreenshotResponseSchema"},"example":{"cache_key":"string","chart_url":"string","image_url":"string","task_status":"string","task_updated_at":"string"}}},"description":"Chart async result"},"202":{"content":{"application/json":{"schema":{"properties":{"cache_key":{"description":"The cache key","type":"string"},"chart_url":{"description":"The url to render the chart","type":"string"},"image_url":{"description":"The url to fetch the screenshot","type":"string"},"task_status":{"description":"The status of the async screenshot","type":"string"},"task_updated_at":{"description":"The timestamp of the last change in status","type":"string"}},"type":"object","title":"ChartCacheScreenshotResponseSchema"},"example":{"cache_key":"string","chart_url":"string","image_url":"string","task_status":"string","task_updated_at":"string"}}},"description":"Chart screenshot task created"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: compute-and-cache-a-screenshot-chart-pk-cache-screenshot
title: "Compute and cache a screenshot (chart-pk-cache-screenshot)"
description: "Compute and cache a screenshot (chart-pk-cache-screenshot)"
sidebar_label: "Compute and cache a screenshot (chart-pk-cache-screenshot)"
hide_title: true
hide_table_of_contents: true
api: eJztWNtu2zgQ/RVisA8JVqmTogsUKvqQBulti92idrELRIHLSGNLtUQq5MiJK+jfF0Pq5kv30jx0H/pk8zKH5wyHw6FqKKWRBRIaC+FVDZmCEEpJKQSgZIHcWkEABm+rzGACIZkKA7BxioWEsAbalDwrU4RLNNA0QQ2xVoSKeFiWZZ7FkjKtJp+tVtw3GJdGl2goQ8uthTYxjjBvtM5RKmgCoLQqbuY2++LGM8LCHlo86HqkMXLD7btMJfruv1sOHfrmM8YEAVBGOXfY2CAqm2qa31ZoNvNWT8NGzoGue/DgLTTX7EJbamW91Menp/zzjY6KZZzifIUbbiRoY5OVbAghzFIUbljwcC/CksnUkmXGqTQ0r0x+2LYyuSAtDKoEjSBGY4NDSFkhl/iPSAukOHVAg98OoZG0q7klSZU9jOfHhF44MGk3Kv43kFWZSMJkLukwLGUFWpJF2SHn0hKLVksUmWqX3Yf/mwC5YI9d8CZMe34f2t2ftrESAN7LosxxZz87/K2NGjpHPh86t1y30z2WP3Bvgh1POMqtUw3aKiem+Pj08Y8o/RGl/7MoHdwp2FjEBtmY2T55UFot0Fq5HN9AX3Xjtmd6Q3ghE8F3JVoKxRu1lnmWiOGOFaXR6yxhsvvqRrZey9n31fJRyYpSbbIvmITivKIUFbXri74gOCBkbOiVPPm+Sn7TJBa6Ukko+DC1TkZ2t9WViVEkGq1QmgTeZ+z+fVE9Bq/yy/eOszeK0CiZC4tmjUagMdqE4lyJSuF9iTGrc51Cx3FlvrJTLyXJ3M9zi1uMK5PRxtWCn+8Iwqtrrl1ILrk+9AfQwnUA9yexTnDqqPnSMZdqCSHEHz+8gwByeYP50PRu5jYn3JM/xavLmYggJSrDySTXscxTbSl8evr06USW2WR9NnGpZXI28XlnOPWTCEQURUqIk9cigvM21pzvQ/ECpUEjfjq/uLicTuez33+9/C0C4LK0Zfh+Q6lWI459R88yK0ptqAsUG6lIdeWbeN53P1oiHTEP8QApgQdIUSZo7PN6R1AEoYigFRWB+FnIOEZr56RXqJpIHUeqNJmio47gIw6/o+PjseS3ci2nbt9Hsrc6hw3SyrLyXq28kxn5C9KJfaDUektv2LXF7k6y8E/dZtZe9Mxp/uQtGv5hBzyLlCedSJI94R13tJN0jo9yvTziqcfPXF2+c8XooqwIhVRJW6HI8YVz5OSdlKsTN3gyDB1DAAVSqhMIYYnsU/eOCmHbM3W5avadwzvgTrI/S/7qPOhn2GX8jodFgmvMdVmgojYnuP33QHVpNOlY5004mdQM1YQ1R3izh3ZRWdJFBxHAWppM3uQ+cXUwvkZZSC4TPU0IAFVVcI5om/zjMsU2/uvZ7L3ocZoAmM02Xq93j9zUJzse46eV0Ea8ec8grGUb5KCrWns3u2l487uE5woeL9KlvRpuXOi91KZwRcnbP2bQPnvd09SNDvWWE90EbDw3uDBo028FcY/Ihd6vA6dVicbiuIYbdXHs+HnrM+8SS4V091D7DH1QaG9R6e8twnualLnM3CO9LbJ92F+BLDPmddZViRBA6D4m7EY/BMCB4iPhCur6Rlr8aPKm4W7/mOZTscOhv31hcOE2IV+r3rowzisedye+i2kPmln+n0C4kLnFPaXDKkcf2prnWHxtwe4bgtqM1+yIlCtorjnkXe5zq/uB8zhGl4U7k71qgmn32eXVJYcR11jjjyVdMLV/GP0gnbr2M3wybXp27kJhgk3zF/V+R3Q=
sidebar_class_name: "get api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Compute and cache a screenshot (chart-pk-cache-screenshot)"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/api/v1/chart/{pk}/cache_screenshot/"}
context={"endpoint"}
>
</MethodEndpoint>
Compute and cache a screenshot (chart-pk-cache-screenshot)
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./compute-and-cache-a-screenshot-chart-pk-cache-screenshot.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./compute-and-cache-a-screenshot-chart-pk-cache-screenshot.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./compute-and-cache-a-screenshot-chart-pk-cache-screenshot.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"activeTabs":{"description":"A list representing active tabs.","items":{"type":"string"},"type":"array"},"anchor":{"description":"A string representing the anchor.","type":"string"},"dataMask":{"additionalProperties":{},"description":"An object representing the data mask.","type":"object"},"urlParams":{"description":"A list of tuples, each containing two strings.","items":{},"type":"array"}},"type":"object","title":"DashboardScreenshotPostSchema"},"example":{"activeTabs":["string"],"anchor":"string","dataMask":{},"urlParams":[]}}}}}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"cache_key":{"description":"The cache key","type":"string"},"dashboard_url":{"description":"The url to render the dashboard","type":"string"},"image_url":{"description":"The url to fetch the screenshot","type":"string"},"task_status":{"description":"The status of the async screenshot","type":"string"},"task_updated_at":{"description":"The timestamp of the last change in status","type":"string"}},"type":"object","title":"DashboardCacheScreenshotResponseSchema"},"example":{"cache_key":"string","dashboard_url":"string","image_url":"string","task_status":"string","task_updated_at":"string"}}},"description":"Dashboard async result"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot
title: "Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)"
description: "Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)"
sidebar_label: "Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)"
hide_title: true
hide_table_of_contents: true
api: eJzFWG1v2zYQ/isEMaAJpsRJ0QGFin5IsxZtt7VB7GIDoiA9SxeLtUSyJOXEE/TfhyNlvdjOVqwB+skmeXfkPffw7qiaazBQokNjeXxVcyF5zDW4nEdcQok0WvKIG/xaCYMZj52pMOI2zbEEHtfcrTVJCelwgYY3zXWQRuteqWxNIqmSDqWjv6B1IVJwQsnJF6skzfW2tFEajRNovWzqxApnMPejDG1qhCZNHvMzVgjrmEFt0KJ0Qi5YkGcO5vaYR1w4LO3ghNYZIRe8iTYTYAysaQwyzZXZt0nQGW/jcmRBg3bZMZ6Bgz/ALr0HWSbIFhQXQ89IaryRZGr+BVO3uxOZYyXY5WCzIEubVaa4oAA+jJC6Za7SBdqIIaQ5o1iAkN78nWodHOG1A1CzvXHEnXAFTfwKNp8rMNk0NYjS5spdKOumIaJNxPEeSk2i43BebQC77tHfTI0gHPt4dd00dByDVitpA02enjz9DpKlkOZ4s8T1LoKzHJlfZrS8N9St9zeVKfbrV6ZgTjGDMkPTBrRV2mdRlLDA/7R2iy7NvTHbwb7PmgO7vLEOXLWHH2QvrHmOEKntWqbfYrLSGTjMbsDtN+tEidZBqTeWC7COpTnIBTIh2213zX8L0c4pID3bLlsm7GXcILZDco2C1i8MsO8nRxBuTQ9h6H3Yudzd0VuADdqq8Lf32cnJdzC3RGthgXsy3A6OY1g6Rf4KMtbm6pi9kysoRMb6isC0USuRYbbPrYFu8OX0x/rySULlcmXE35jF7KxyOWXRsD/rytceR4aKwZNnP9aTD8qxW1XJLGZ0m1qQkeC2qjIpskyhZVI5hveC4N91qrNBu/zyo3n2Tjo0Egpm0azQMDRGmZidSVZJvNeYknd+kqk0rcwDkXoDDoog5ze3mFZGuLXvXL7cOV8grul2LnyN6W6epTpzf5SqDKf+eKHZKUAueMzTT5e/84gXMMeiHwaoaUxZ9+gvdvFxOmMJz53T8WRSqBSKXFkXPz95/nwCWkxWp5MuuUxOJyH79OmmT6yThLMkSSRjR29Zws9a+vlwxOwVgkHDfjo7P389nd7MPv72+sNY4TwE8mi21hiz7Vj2shl7Uid8ieuExyzhKygqTHjzhDdR5/zF2uVKDtzvJjoARKmVcRse2kQmclOA2ctu+lgr6w5oX/ZoKEXBXI6QobEv6y2sglstXglnPzNIU7T2xqklyqbVJkxe7sMhkYeJ1EZId7Dx55iEDw4Phwi9hxVMPQsHKI0me6oo6ZvSDhy4A+FCvfbQPCowdfCvRJerjBwjhm6DFm/E2DbTCIzPG7LVAbmZB+5z1KsMuRbg2+VbkN7gPVfZOmbvpx8/HIdEIW7XBzX1UAPwWXNI0hSDF4kMuPlWd4PZVkRaIVXgcaEWByR6+ILTZR+niHNV6spRg561vRsMOhp20OF5pJdHXuCon+oFD3nEA670AFKWouxfRTHfjVWtl82/hYsY4vNeyDqhw9jLA77tzu+0zDJcYaF0idK1GdTzMxiqtVFOpapo4smkJlNNXNOFbXasnVfWqXJjIuIrMALmRUjzGzOhpbsF6lHCMXnEUVYlZdR2SD8+p47tv53NLlhnp4k4nWZsr/N353DTUBpojR6eTBn27oKMkC9jI3uhavW9dONfoZvy4HvD4KQvEjWfe9a/Uab0vdv7P2e8fdLSLQ6rfXvqnW4iUr4xeGvQ5v/XCFmxSl727+PXj/tAklVRXNNDQt6q3eZ8Wmk0FoeN9WCKGBrkVqcBeOtK8L1B+yngEW/X6GBdZ+Hw3k10AUK2r1vPTH/xrjhoQac8HTbxPOKx/0Dx8P3jEScUAxeveF3PweInUzQNTX+t0FADcd1fB39LM2Hpf8bjWygs7hy4a6b4wWXbXB6yPtxjRzbvabn2t66oaMQjHp4meskbilnI2H73sDDMvQPFneaNkkHQOEtT9CXpYdnrQWajgsEjPm+/05QqIx0Dd/TFB+7CIZX32V8fPxcKYxU6u2CTeE1N9CCSHf/bP+TVXhjqOkiE0tN0qPgaTsA0zT/bp3gi
sidebar_class_name: "post api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/dashboard/{pk}/cache_dashboard_screenshot/"}
context={"endpoint"}
>
</MethodEndpoint>
Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"duplicate_slices":{"description":"Whether or not to also copy all charts on the dashboard","type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"}},"required":["json_metadata"],"type":"object","title":"DashboardCopySchema"},"example":{"css":"string","dashboard_title":"string","duplicate_slices":true,"json_metadata":"string"}}},"required":true}}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"last_modified_time":{"type":"number"}},"type":"object"},"example":{"id":1,"last_modified_time":1}}},"description":"Id of new dashboard and last modified time"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: create-a-copy-of-an-existing-dashboard
title: "Create a copy of an existing dashboard"
description: "Create a copy of an existing dashboard"
sidebar_label: "Create a copy of an existing dashboard"
hide_title: true
hide_table_of_contents: true
api: eJzFWG1v2zYQ/isHYkATTImTrQUKFf2QZi2armiC2kU3xIFLi2eLDUWqJGXHE/TfhyNlWX5pMbTA+skWdTze8/Dh8U41K7nlBXq0jqW3NRPoMitLL41mKRvlCIK7fGq4FSAFGAtOVXOWMEnvS+5zljDNC2Qpk2Ji7KR9b/FLJS0KlnpbYcJclmPBWVozvyrJ2nkr9Zw1zV00RudfGLEii8xoj9rTX16WSmac4hl8dhRU3XNVWlOi9RJdmObCzzaE6wVaKwXC5XAIM2PB9zGdsmQ3noR1bydeeoX7Pi8gvDjsruAPb1HPfc7SJ2dnCSukXj+fJUxXSvEpOY207C9eRcA4cUpmeADRxxx9jpb2QhsP3gBXzkBmyhVwpSDLufUOjN6ObYN0aoxCrmk1onRSoOeCe76/1CiXDt4Mr9+BmX7GzIN0MEeNlnsUIFaaFzLjSq1gmaOGTMnsXup5WNjxBVKMZoF2aaVHmFbeGw1yJzBYSFyewlXwjg+lcSggRxv5tThDizpD4FqEkdIs0ULl0DpY5gYKvoIl1y0THi2AKzGTM5nBRt0Hdrrpq/R2h4u7zjxCp+lRDeyPdeSXplwNoxibhOEDL8ool6DE9ToHBNV7tbfdURc7G7OJudk9WmHAlUa7KJbfzs5+4AxJ0TuiuiqmaAmb4s5PCiPkTCKhKPCAWbNL2TYp5Pr8sKvzgGtbe1cCzAw0LntKIQnQfFjPhzC/SdjjH0JdoHN8joey07cxdRPZCy6gTWMpXOkFV1L05AelNQspULADUHtzI5bzn4vlg+aVz42V/6BI4aLyOWrfrg+d+g4A6U+MSH7/uUheGTuVQqBO4W9TgTD6kYecMlOJtpDOESLKG1mGzoGnfGfRmcpmeAhg5y+ie/xz0b0zHmam0iIFuqlbCaHoIIAw6MItgQ+SxLWPqPNBqzz52afoSnu0mitwaBdoAa01NoULDZXGhxIzQhcGwWRZZb+iw1fccxXtwuIOs8pKvwolzuelZ+ntHdUdns+p7NlkdEd5/+EkMwKHIbxYFSmu5yxl2Yf3bxllsCmqzWOrlpRllVVw8hfcXA9HMGa592U6GCiTcZUb59OnZ0+fDngpB4vzQZfTBucDurkHYwbj8VgDnLyGMbtoj1EgPoUXyC1a+OXi8vLlcDgZXf/58t32hMu4ZSejVYkp7O7axlbAo3rM7nE1ZimM2YKrCsesecSapIN5s/K50T2g3UAHVRalsX6tODfWY72+hOB5N3xaGuePaF34Dj6SODFHLtC65/UOKxFAy8yYwa/tIZ54c4+6aWcT+ueHEI/18ViXVmp/tI78lIyPjo/7XLzhCz4MyurxsTW42X6jHVHS0cCXXHqYoc/yQMJ3UlBHJAX63AiCQPrapSddm8Guegj2p7WA6sjRKFD0KdlM6esnErWvoWi9ZnZqxCoNxeFpPOZytjqq4R5XPZqhOSZrYvvZWEeGqKLp2NnhvjUyCk+VmR+R6fEzRkd1+4BfWuQegceq18yA65jiqPrsl7yRNWpVjKPdCh1LyvY5rzfdSxPpp70NWSjmgMrS1h/cQbYb3lt6DQIXqExZoPZtPgvKio7q0hpvMqOadDCoyVWT1nSomj1vl5Xzpli7SNiCW0k9hGtTcHATi/cZr5Rvw2QJQ10VlN/aR/oJGW7b/+vR6AY6P03CKJptfx3eveCGMVHTO2oDqeK/uiEnhGXbyUGq2vnBugnN4DpZh8o6ggwpu2bToOJXxhac/L35OGJtYxnamvB2U+YH0NTjLP3E4syiy7/XSdspvd+0qS//j2KfuuyZ2W/LhlWJ1mG/J+kNkWKj3eI8boTzBQ83d9uo/+fTs7Vsd6t7fPCDUnEZqqAg57o9WLeMl5JiOO8zwRKWbn0coHVZwkiKUWu3rK6n3OEHq5qGhr9UaOm6vtvIPX6fkI7+C5bOuHK4F2JXurCj922hegzf+IxxEFI7yPUqnDZV0RNL6BLZ/szR3NFpCRk4RBcN+rm052CvlKJkEGdcZBmGy+Trtne9XEYXAEvYtP1cUhhBcyxf0ncXvozBmsBJOD5hLF5pVayzok/SNRXsvb3t9N/+IVQH6ajraBGvkqZjJ9y+REzT/AslI1mQ
sidebar_class_name: "post api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create a copy of an existing dashboard"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/dashboard/{id_or_slug}/copy/"}
context={"endpoint"}
>
</MethodEndpoint>
Create a copy of an existing dashboard
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./create-a-copy-of-an-existing-dashboard.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./create-a-copy-of-an-existing-dashboard.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./create-a-copy-of-an-existing-dashboard.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"css":{"nullable":true,"type":"string"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"CssTemplateRestApi.post"},"example":{"css":"string","template_name":"string"}}},"description":"Model schema","required":true}}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"properties":{"css":{"nullable":true,"type":"string"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"CssTemplateRestApi.post"}},"type":"object"},"example":{"id":"string","result":{"css":"string","template_name":"string"}}}},"description":"Item inserted"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

66
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.api.mdx Normal file
View File

@@ -0,0 +1,66 @@
---
id: create-a-css-template
title: "Create a CSS template"
description: "Create a CSS template"
sidebar_label: "Create a CSS template"
hide_title: true
hide_table_of_contents: true
api: eJzVV21v2zYQ/ivEYUATjImTYAUCFf2QGCmarmuC2N0GREFKS5dYDUWyJOXEFfTfhyNlWX4purYDin2xZerueM9zzx3pGix+qtD5U53PIakh08qj8vQojJFFJnyh1eCj04rWXDbFUtCTsdqg9QW64ObCl6qkFBOJkHhbIQc/NwgJOG8LdQ8NB4+lkcLjrRIlkkcpnt6iuvdTSI6eH/CvRWi6FT35iJkHDr7wZA5D58Zt9Ct0/sQU+0Y7T7vikyiNxC7RRbiNfJb7NBxydJktDOGHBP7QOUrW4ueBtsJiHvNsaMEZrVyk4+jg8AfILHL63ODOoquk/39xv+GzWg1CuizGEuC/rtJGmc49lqxQDq3HnHb77eDgB0pRonPiHrfU4yvIOkc4FTlrmyxh52omZJEzI6wo0aN1zFg9K3JKdhNNzzdi+RFZ/QdY3itR+am2xWfME3ZS+Skq3+7PupbYAqTvGJAcHf1sJMbqjH5OJDJC4ecJ+5OKE9GgtdpugzLUlcyZ0p61EVpv2ur5zxbbufJolZDMoZ2hjSgSdqJYpfDJYOYxj4tMZ1llv1CuV8IL2VHAwWFWWcKYXNfw8dFDcn3T3HDw4t5Bcg3D0YgtBoCDGw5Pe5nOcRQydMFLCnUPCWTvr94CBykmKJc/na5sRvlnlZVs7292eTEasxSm3ptkMJA6E3KqnU+OD46PB8IUg9nhIHPudjEZBimwNE0VY3uvWQonrdgC7wk7RWHRsl9OhsOz0eh2fPH72btVh2Gs2N54bjBh60Vb2ubsWZ3CA85TSFgKMyErTKF5Bg3vIF7O/VSrHshuoYNZlEZbv2htl6pULc4P9rJbDjN0h/Zl38gFj05TFDla97JeYyQm37KSAvuViYyUfOv1A6qm9SbkL7ehTdVuqowtlN9ZZL1Pxju7u30e3oiZGAVR9bhYWVyWXStHdHQUiEdReHaHPpsGAr4Dfh1RlOinOqf0SVPr1CQLM7auGoL8YSGcOvIzDvR84EuXvm4iSZvaidYLVic6nyfszeji3X7s7uJuvlOzB5z3KGbNLlkT0y9SFdnJhRcdM2u8t0Za4r7U9ztkuvsCqEPXZpdF4ZEJRg27IAw4RJIggXBqczCCLgWwlV6qWxgusa8rS2XdWh1Y3/4tvWY5zlBqU6Ly7ZgKqomBamO115mWTTIY1BSqSWpqlmYj2rByXpeLEBxmwhY0zV07WUMYes7xToSLRUgTOKCqShpb7U/6ClNrNf7r8fiSdXEaDpTNarwO70Zyozh/6R1dWpi27PySghCW1SBbqWr9g3XTUCUXM3hEp0cEGSZxDZOg0lfaloLivflrTDUKZpC0b6E7QQLohpPzrcU7i276vUEoitPqavkX4uybb9ocCnWnIyMrBFQGrcP+LbO3RPKLdrPDyKrzpQinaxv/S1Jf2aU7aD0++YGRolAULUixbrvgGoQpaMtD4NDvBOBAoomquIa6ngiH761sGlr+VKGl8/JmKcxwanKIoyc0zwPOw41iOUSCjmVFOW1cHahLosdJlmGYoF+2vel1NU0+4DBp/+OVOicfKx7p0i0eIQHgoAMnQVdhLc7xKt4rYkwqON3jesR1wmgfCFX7Sqh5L8O6jhZxhlI3RyjhyIHmpmmafwBu2wEd
sidebar_class_name: "post api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create a CSS template"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/css_template/"}
context={"endpoint"}
>
</MethodEndpoint>
Create a CSS template
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails>
</ParamsDetails>
<RequestSchema
{...require("./create-a-css-template.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./create-a-css-template.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.ParamsDetails.json Normal file
View File

@@ -0,0 +1 @@
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}]}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body","body":{"content":{"application/json":{"examples":{"numerical_range_filter":{"description":"**This body should be stringified and put into the value field.**","summary":"Numerical Range Filter","value":{"extraFormData":{"filters":[{"col":"tz_offset","op":">=","val":[1000]},{"col":"tz_offset","op":"<=","val":[2000]}]},"filterState":{"label":"1000 <= x <= 2000","value":[1000,2000]},"id":"NATIVE_FILTER_ID"}},"time_grain_filter":{"description":"**This body should be stringified and put into the value field.**","summary":"Time Grain Filter","value":{"extraFormData":{"time_grain_sqla":"P1W/1970-01-03T00:00:00Z"},"filterState":{"label":"Week ending Saturday","value":["P1W/1970-01-03T00:00:00Z"]},"id":"NATIVE_FILTER_ID"}},"time_range_filter":{"description":"**This body should be stringified and put into the value field.**","summary":"Time Range Filter","value":{"extraFormData":{"time_range":"DATEADD(DATETIME('2025-01-16T00:00:00'), -7, day) : 2025-01-16T00:00:00"},"filterState":{"value":"DATEADD(DATETIME('2025-01-16T00:00:00'), -7, day) : 2025-01-16T00:00:00"},"id":"NATIVE_FILTER_ID"}},"timecolumn_filter":{"description":"**This body should be stringified and put into the value field.**","summary":"Time Column Filter","value":{"extraFormData":{"granularity_sqla":"order_date"},"filterState":{"value":["order_date"]},"id":"NATIVE_FILTER_ID"}},"value_filter":{"description":"**This body should be stringified and put into the value field.**","summary":"Value Filter","value":{"extraFormData":{"filters":[{"col":"real_name","op":"IN","val":["John Doe"]}]},"filterState":{"value":["John Doe"]},"id":"NATIVE_FILTER_ID"}}},"schema":{"properties":{"value":{"description":"Any type of JSON supported text.","type":"string"}},"required":["value"],"type":"object","title":"TemporaryCachePostSchema"},"example":{"value":"string"}}},"required":true}}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the value.","type":"string"}},"type":"object"},"example":{"key":"string"}}},"description":"The value was stored successfully."},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

68
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.api.mdx Normal file
View File

@@ -0,0 +1,68 @@
---
id: create-a-dashboards-filter-state
title: "Create a dashboard's filter state"
description: "Create a dashboard's filter state"
sidebar_label: "Create a dashboard's filter state"
hide_title: true
hide_table_of_contents: true
api: eJzFWAtv20YS/iuDRQHbOdqS3PaaY+sCiu20zuUSw1KSw1mGuiJHImNyl9ldymYJ/vfD7JIU9QqMpEgBw6KW8/q+nZ0ZbckyrniKBpVm/m3JYsF8lnETMY8JniJ9u2ceU/gpjxWGzDcqR4/pIMKUM79kpshIKhYGF6hYVXm1lU85qmJlxvDZNA7ZZ1XvnCPU5oUMCxIJpDAoDD3yLEvigJtYit5HLQWt4SNPswQ1PYs8RRUHPJkqLhY4nceJQUVvQtSBijPSZD579mwcxRpmMixARzJPQpghaKNisYjnMYbARQhZbiAWRoKJEJY8yRHmMSbhybNnhCFPU64K5rM3jVe4Ia/w0nn1mNVxMRrFX0qVXnBjYbvAHN+BTIibP6dyPtdomMdkxnz265mzwPzbQb/fvyNS94j+shI9taJ3lVe7GBlubAgJnyEpky345Qwe6R9Jr+K0fjxnwWNxSNCG46v3l9OXV6/HlzfTqwvaW2biFKcLxWPxjQgexynCb+TwKdx2wtOfEs58dj340Bv866f+cX9w3P9+3O/79u9/bD9NHxDvAUUYiwWMuMlVyIsOU/tNPoG6b5mblronp+UqPOazi+H4cnhxcUif46v/XB4enPZPfyTAg3+2gA+OPDj+yYOQF0fgww6JHSTXAfyVHj5PeSCTPP2m2XpuPT6F84XiIk+4ik3R5KtUIappSGztJe+2K/X5pLMa3wj8e/vqiyqgQp5Mbaeoy9rVm7assVcyEnAhCeqO4tZy0hHbz0jVbUCZkhkqE7sG0sa7ztFQFECdCuQcXo3evgGdZ5lUBkMw+GhOmNc0MsebpX3VL29ru3etmJx9xIDqt4lNQgtjTDOpuCrOeRDhtdRm5EKsvKbDdU9O66ba7Mt2QWdSaIfotD94QhPdx8c9FttsjCOEeyzASFBoVIxLXKXFbi7WYa9jsj7WEG27cxn3wDVoIxWGoPMgQK3neZIUJ2Twh37/K3CmqDVfYGcieWLwrSJ7wUOoJxcfrsSSJ3EIq9EKMiWXcYjhLogdXYfla/bsL8DyTvDcRFLFf2LowzA3EQpT+4c233YA6SpaJKenfzeSTEnKFD5LEAiFKXx4T5vj0KBSUu2Ccm5LoZAGagu1Nrn68e9OtithUAmegEa1ROVQ+DAUkAt8zDCg0mQXQQZBrvZs10tueNJS4DGNQU6NyFbljw+G+bd3NJEbvqBKzS64jmaSq7Cu8OAq8J3HHo8DGeKoGcVvaZISC+az4N3Na+a1c1X9VctcBQQkyFUCx/+F67ejMUxYZEzm93qJDHgSSW385/3nz3s8i3vLQS9svPcGPdcAppr8TxhMJhMBcPw7TNiwTkC7Fz68QK5QwXfD8/PL0Wg6fvvvyzfrCuduF4/HRYY+bG7kSjaEg3JC1WrCfJi4Ujxh1QGjybxGe12YSIoO3nahRRxToTfNcdcTMRFNwYazdvkkk9ockl/4clo8px8hD1Hps3KDHIejJmjC4B/AbVGdGnmPoqq1iYSzXcAn4mgiMhULc9gAOCHhw6OjLiWv+JKPbM51aFlbXCWDFJqYadngDzw2MEcTRJaLr2OidIBSNJEMCQkl3SZLfiMGm7lE6P9o0ql0VI0tU394K5VuNjm+tjPKSTcE0+Tl27HipJm6isOSOmyHbaiOSJpI/3kiHFEhN7wlaWMLaiGZ4EkiF4ckevQzo7O8UeUUcoPAoeXuQIPjDix3zGOOMLoGkJr2y94N+Gyb9TK7r9aIp821BcqVhFzR3u/cQrYZ2Gt6DSEuMZFZisLUpc6mljNUZkoaGcik8nu9kkxVfkmHq9qydp5rI9PGBE2VKqaOoOvqbM24SWfO88TUYTKPochTKn31V/rQbIvG38fja2jtVB6jaNbttXi3ghu5Gk7vaPwFqeDqmowQlnUjO6mq9a10ZW9QmjpuZ0gH0lbzks1s/tIgzsneqw/j5jqGDqB7u5rgLOjKI+WpwrlCHX2pEbKipbhZ3e1c7h9rPRaLudyePEd5hspdfDSDc2eJ8szJLQeOPm1SbltxfQH1lGxf89h2aBrze1nCY0GWbf6V9UG4ZTyLyf2AtBvDzGO+vTZbOw93TWbcsrKccY3vVFJVtOyuyuiUhLEdVkLmz3mi0asH5PbyrCHLnuYmkXdrbmBp5xV2eFMPcUew2qh1jPUiF0XXZxNNds/sDzFXNa1396Jb/zqKW/MRHWOnMQwCtH1gv+xdpwhR0WYem9W3g6kMSUfxB7qi5A8uSGkx28S3a64b5W54cjYpI2lY7Wxym7n1A6HaSUNZOglX/quWFds4iZiq+j+r0jQT
sidebar_class_name: "post api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create a dashboard's filter state"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/dashboard/{pk}/filter_state"}
context={"endpoint"}
>
</MethodEndpoint>
Create a dashboard's filter state
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails
{...require("./create-a-dashboards-filter-state.ParamsDetails.json")}
>
</ParamsDetails>
<RequestSchema
{...require("./create-a-dashboards-filter-state.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./create-a-dashboards-filter-state.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_id` and `datasource_type`.","type":"integer"},"datasource_name":{"description":"The datasource name.","nullable":true,"type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"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 modifiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":1,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"type":"string"}},"required":["datasource_id","datasource_type","slice_name"],"type":"object","title":"ChartRestApi.post"},"example":{"cache_timeout":1,"certification_details":"string","certified_by":"string","dashboards":[1],"datasource_id":1,"datasource_name":"string","datasource_type":"table","description":"string","external_url":"string","is_managed_externally":true,"owners":[1],"params":"string","query_context":"string","query_context_generation":true,"slice_name":"string","uuid":"550e8400-e29b-41d4-a716-446655440000","viz_type":["bar","area","table"]}}},"description":"Chart schema","required":true}}

1
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.StatusCodes.json Normal file
View File

@@ -0,0 +1 @@
{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_id` and `datasource_type`.","type":"integer"},"datasource_name":{"description":"The datasource name.","nullable":true,"type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"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 modifiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":1,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"type":"string"}},"required":["datasource_id","datasource_type","slice_name"],"type":"object","title":"ChartRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"cache_timeout":1,"certification_details":"string","certified_by":"string","dashboards":[],"datasource_id":1,"datasource_name":"string","datasource_type":"table","description":"string","external_url":"string","is_managed_externally":true,"owners":[],"params":"string","query_context":"string","query_context_generation":true,"slice_name":"string","uuid":"550e8400-e29b-41d4-a716-446655440000","viz_type":["bar","area","table"]}}}},"description":"Chart added"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}

66
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.api.mdx Normal file
View File

@@ -0,0 +1,66 @@
---
id: create-a-new-chart
title: "Create a new chart"
description: "Create a new chart"
sidebar_label: "Create a new chart"
hide_title: true
hide_table_of_contents: true
api: eJztWm1vG7kR/isDokBsVLIkx3Z8e8gHx01wyQWJETttD1YgU8uRlgmX3CO5khVB/70YcldavdjnNtcmBfzJEndmOM9w5pnhynNm8fcSnX9hxIwlc5Ya7VF7+siLQsmUe2l057MzmtZcmmHO6VNhTYHWS3RBjacZDrzM0ZRBWaBLrSxImSXsb6UNdmBPanCYGi3cPpgR+AyBdKUeQ6UNI2PBZ9JBmnHrD+Cd8RgXBI54qbwDb4Km4J47U9oUO54PFS5NyBGUWuBIahQHrMV0qRQJsMTbElvMzwpkCZPa4xgtW7RYSlhGFdyBQM+lcjuAxAdL15tad+/jvJV63NgGxWA427Z+gdYZDcbC2JqyAJ9xDxl3sFRrBOYh2wnusqHhVgQo0mO+A9MZKOk8QVqJU4SlTlUpqtBrnMZtwRuK6HYEqxVuLZ/FvevDGUixvetVhiBFHcggjL6zUtrcdiqVgtLhAZxBavJCoW8mAEiBenUWoBGFg5s1J26Aa7G2Rj7f7IbTkNI8x90AGvuT0D2p1jyTte13G6Yn8US24lIDRQFGbyIkD1CXOUuuWSgJVm2IlC+/l2hnrMUcn6AY1N8mEqfs0y5Pm25tZ03j+7IewlERNRj3sGjgrUeruRqUVtEmf6gg3SDnmo9RDGpdNbtHc2iMQq5J1Uw12vsq4T0JALdIiWYdSOGAK2WmVHgGBIakM5Zw6jGusdTrESgcecC88DOYmTJm7BDBaKzjEz1Yi9bDiqnglu/y+ILW0ZNRcnuMGi33KEDMNM9lSsGBaYYaUiXTL4FmMwRKAMJhJminVnqEYem90SB1eI63hTIWgVLjAK4I5pvL9+/ADD9jGhm6MFO0VZymmYGcz2DKNfEDcOXRgiswpYKEYunkg1Ii5OUgNKLbHb2EyiOIQCUCFguLDjU1huqhRBfZk3iAXLJlAGesQEvf60gt2Sd8mEhXciW/Bg5pBbqQGqZkaGRszv1K3GWmVILO16Iv7f2N5g5wg8qLnQW2jXMl3YQ8zdBnBKqWr61LF46nkRTGgjYenImxkR6EQRfWykJQNIJCbkTgF+e5v6+KG6XllLyXKOnJVtrn/PYt6rHPWHJ43G2xXOr6e29H6Moy9pF4EiyJCw+I+UR+fQDVRu5aywAKRzhWvOXUcYhVh9yyFuMWORVu2PfTvVC6Wx4tWmHqkhYFWVxvlNsNYi26K56OtUhOSE+usXMC8AGdPyvkQWGcj/xaeb41o/XuHHpqRzfHldV6c6647n3aava9Hf2zqb3RAVetau10lgrrTWK1fkcviGlQs33wr+bPle4Gy9zxYK1Co91mqq+0YnKy4+Munh51u208/GnYPuqJozZ/1jtpHx2dnBwfHx11u90ua2bk7oRaLDbbbzxdqObvZgKRVyGjXGG0i+P4Ybf3DcN8LLPqaHSZD2NPsuhK5R9n/8fZ/3H2f5z9H2f/x9n/cfZ/nP0fZ/8fdPZfbEqv3waqMX011P23rgc/+O3g//JycMftgAuBgs75qNv9hvk/R+f4GBuXgEb23pdTS0X2gguofllI4LWecCVFoxfQmDCRwdltLA3diOVb7jJ/ApaPmpc+M1Z+RZHAWekzGsLSmoyrYt4BpKkYkTz9vkheGTuUQqBO4DdTgjD6Cd0xJggF2lw6R4ioh6cpOhdHHIuxGHcBXNoL6A4Pv/c5FdaQ4+E6SGfkZwn8nVIvnhVaa+wuHOehnVMrrCxU2rTV8fcupdc6chc4tBO0EUUCZxpKjbcFptTdwyKYNC3tHcn4inuuliFoMYdpaQljcj1nn6eeqHBBHYaPiRYjozjqObft1Ai8DK65IK64HrOEpR8/vGUtpvgQ1eprlS4JS0uroP1PuHh/eQV9lnlfJJ2OMilXmXE+Oe2ennZ4ITuTXic04E6fQb/f1wDtX6DPzqriCZFO4AVyixb+cnZ+/vLycnD1/teX79YVzuMZta9mBSaweUwrWQFP5n32BWd9lkCfTbgqsc8WT9iitcR2MfNZuNbX6JYLS3wyL4z1NVW5vu7r+iUMPF8uh268R/vCQ4PQitIZcoHWPZ9vhCJ6XYWjz+CvVb0OvPmCelFpE+Tnu2D29X5fF1Zqv1e7e0DCe/v7zQC84RN+GfKnEYS1xdVBG+0oDkvsfMqlhxH6NAvI/x3c8+h+jj4zgvym9NmMSVKLwWaeENabOlXmMTBXIS43rZVKM1NidLazJUrX4RwaMUvCReggVrAczfbm8AVnjdjCYp+kKcQ/93UMS7gw1CHZCHglZBQeKDPeI9H9nxlV4QY/WaQBna9eidAEHSLEEhbGPZpiaOJk60GlYwq0EQs3Tkg7D2NrvnpLj0HgBJUpctS+IqCQJNHQvLDGm9SoRdLpzMnUIplTUSy2rJ2Xzpu8NtFiE24l8bSrODOYiUN6eM9Xudl4pVF9pT+Bltbt/3J1dQFLO4sWI2/W7S3xbjl3GZmVnsXLioXXF+HqbeyGkZ2hqvSD9GJB51ez6yX1hQgycOycDUNuvqrvMW/+cUVnFMToWhWerl4LBNCLFikPLI4suuw/NUJWnNEfVv/v8fLO3wa6f9bw392e/rs/0vTf/R+O/09H/PR4dHLUPn7We9Y+Oj45bA+fjtL2YfrTydPRyQkf8ZOHjP8tJvXIbF9oL8sCbXzZV18LG0vEAVFu0oup7XzOw/BS+buTZTbeA9Zngre+Uyguw+RXvb6LBHTNeCFpvx7lSGWF6jUW5DWbz4fc4UerFgtajm8iwz2s5oQwirRY5PrAW19wFsa0FWsHClFleFG2OY8RQUWNszTF0Kvulv3UYFJqNazFhtX/QuVGkI7lU/rBhU9ZwliLmRCMUNJhLXbMMg5r0SbVGo3+jYgta7L6QKjqF3161vBwPo8SsWkRkUYoobmzBd3+/gW6FDTV
sidebar_class_name: "post api-method"
info_path: developer-docs/api/superset
custom_edit_url: null
hide_send_button: true
show_extensions: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create a new chart"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/v1/chart/"}
context={"endpoint"}
>
</MethodEndpoint>
Create a new chart
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>
<ParamsDetails>
</ParamsDetails>
<RequestSchema
{...require("./create-a-new-chart.RequestSchema.json")}
>
</RequestSchema>
<StatusCodes
{...require("./create-a-new-chart.StatusCodes.json")}
>
</StatusCodes>

1
docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboard.RequestSchema.json Normal file
View File

@@ -0,0 +1 @@
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","nullable":true,"type":"string"},"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this dashboard. If left empty you will be one of the owners of the dashboard.","type":"integer"},"type":"array"},"position_json":{"description":"This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view","type":"string"},"published":{"description":"Determines whether or not this dashboard is visible in the list of all dashboards.","type":"boolean"},"roles":{"items":{"description":"Roles is a list which defines access to the dashboard. These roles are always applied in addition to restrictions on dataset level access. If no roles defined then the dashboard is available to all roles.","type":"integer"},"type":"array"},"slug":{"description":"Unique identifying part for the web address of the dashboard.","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"theme_id":{"description":"Theme ID for the dashboard","nullable":true,"type":"integer"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"type":"object","title":"DashboardRestApi.post"},"example":{"certification_details":"string","certified_by":"string","css":"string","dashboard_title":"string","external_url":"string","is_managed_externally":true,"json_metadata":"string","owners":[1],"position_json":"string","published":true,"roles":[1],"slug":"string","theme_id":1,"uuid":"550e8400-e29b-41d4-a716-446655440000"}}},"description":"Dashboard schema","required":true}}

Some files were not shown because too many files have changed in this diff Show More