diff --git a/docs/DOCS_CLAUDE.md b/docs/DOCS_CLAUDE.md index 1ac49462afe..6aae4a2b21d 100644 --- a/docs/DOCS_CLAUDE.md +++ b/docs/DOCS_CLAUDE.md @@ -31,8 +31,9 @@ You are currently in the `/docs` subdirectory of the Apache Superset repository. ├── superset-frontend/ # React/TypeScript frontend └── docs/ # Documentation site (YOU ARE HERE) ├── docs/ # Main documentation content - ├── developer_portal/ # Developer guides (currently disabled) - ├── components/ # Component playground (currently disabled) + ├── admin_docs/ # Admin-focused guides + ├── developer_docs/ # Developer guides + ├── components/ # Component playground └── docusaurus.config.ts # Site configuration ``` @@ -47,11 +48,13 @@ yarn serve # Serve built site locally # Version Management (USE THESE, NOT docusaurus commands) yarn version:add:docs # Add new docs version -yarn version:add:developer_portal # Add developer portal version +yarn version:add:admin_docs # Add admin docs version +yarn version:add:developer_docs # Add developer docs version yarn version:add:components # Add components version yarn version:remove:docs # Remove docs version -yarn version:remove:developer_portal # Remove developer portal version -yarn version:remove:components # Remove components version +yarn version:remove:admin_docs # Remove admin docs version +yarn version:remove:developer_docs # Remove developer docs version +yarn version:remove:components # Remove components version # Quality Checks yarn typecheck # TypeScript validation @@ -95,15 +98,14 @@ docs/ └── [security guides] ``` -### Developer Portal (`/developer_portal`) - Currently Disabled -When enabled, contains developer-focused content: -- API documentation -- Architecture guides -- CLI tools -- Code examples +### Admin Docs (`/admin_docs`) +Admin-focused content: installation, configuration, security. -### Component Playground (`/components`) - Currently Disabled -When enabled, provides interactive component examples for UI development. +### Developer Docs (`/developer_docs`) +Developer-focused content: API documentation, architecture guides, CLI tools, code examples. + +### Component Playground (`/components`) +Interactive component examples for UI development. ## 📝 Documentation Standards diff --git a/docs/README.md b/docs/README.md index 6f3a6b4902e..3c7f268a288 100644 --- a/docs/README.md +++ b/docs/README.md @@ -45,10 +45,13 @@ To create a new version for any section, use the Docusaurus version command with # Main Documentation yarn version:add:docs 1.2.0 -# Developer Portal -yarn version:add:developer_portal 1.2.0 +# Admin Docs +yarn version:add:admin_docs 1.2.0 -# Component Playground (when enabled) +# Developer Docs +yarn version:add:developer_docs 1.2.0 + +# Component Playground yarn version:add:components 1.2.0 ``` @@ -91,8 +94,11 @@ If creating versions manually, you'll need to: # Main Documentation yarn version:remove:docs 1.0.0 -# Developer Portal -yarn version:remove:developer_portal 1.0.0 +# Admin Docs +yarn version:remove:admin_docs 1.0.0 + +# Developer Docs +yarn version:remove:developer_docs 1.0.0 # Component Playground yarn version:remove:components 1.0.0 @@ -103,17 +109,20 @@ To manually remove a version: 1. **Delete the version folder** from the appropriate location: - Main docs: `versioned_docs/version-X.X.X/` (no prefix for main) - - Developer Portal: `developer_portal_versioned_docs/version-X.X.X/` + - Admin Docs: `admin_docs_versioned_docs/version-X.X.X/` + - Developer Docs: `developer_docs_versioned_docs/version-X.X.X/` - Components: `components_versioned_docs/version-X.X.X/` 2. **Delete the version metadata file**: - Main docs: `versioned_sidebars/version-X.X.X-sidebars.json` (no prefix) - - Developer Portal: `developer_portal_versioned_sidebars/version-X.X.X-sidebars.json` + - Admin Docs: `admin_docs_versioned_sidebars/version-X.X.X-sidebars.json` + - Developer Docs: `developer_docs_versioned_sidebars/version-X.X.X-sidebars.json` - Components: `components_versioned_sidebars/version-X.X.X-sidebars.json` 3. **Update the versions list file**: - Main docs: `versions.json` - - Developer Portal: `developer_portal_versions.json` + - Admin Docs: `admin_docs_versions.json` + - Developer Docs: `developer_docs_versions.json` - Components: `components_versions.json` 4. **Update configuration**: @@ -145,12 +154,12 @@ docs: { } ``` -#### Developer Portal & Components (custom plugins) +#### Developer Docs & Components (custom plugins) ```typescript { - id: 'developer_portal', - path: 'developer_portal', - routeBasePath: 'developer_portal', + id: 'developer_docs', + path: 'developer_docs', + routeBasePath: 'developer-docs', includeCurrentVersion: true, lastVersion: '1.1.0', // Default version onlyIncludeVersions: ['current', '1.1.0', '1.0.0'], @@ -194,7 +203,7 @@ For other issues: #### Broken Links in Versioned Documentation When creating a new version, links in the documentation are preserved as-is. Common issues: -- **Cross-section links**: Links between sections (e.g., from developer_portal to docs) need to be version-aware +- **Cross-section links**: Links between sections (e.g., from developer_docs to docs) need to be version-aware - **Absolute vs relative paths**: Use relative paths within the same section - **Version-specific URLs**: Update hardcoded URLs to use version variables diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/alerts-reports.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/alerts-reports.mdx new file mode 100644 index 00000000000..b66f641e290 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/alerts-reports.mdx @@ -0,0 +1,419 @@ +--- +title: Alerts and Reports +hide_title: true +sidebar_position: 2 +version: 2 +--- + +# Alerts and Reports + +Users can configure automated alerts and reports to send dashboards or charts to an email recipient or Slack channel. + +- *Alerts* are sent when a SQL condition is reached +- *Reports* are sent on a schedule + +Alerts and reports are disabled by default. To turn them on, you'll need to change configuration settings and install a suitable headless browser in your environment. + +## Requirements + +### Commons + +#### In your `superset_config.py` or `superset_config_docker.py` + +- `"ALERT_REPORTS"` [feature flag](/admin-docs/configuration/configuring-superset#feature-flags) must be turned to True. +- `beat_schedule` in CeleryConfig must contain schedule for `reports.scheduler`. +- At least one of those must be configured, depending on what you want to use: + - emails: `SMTP_*` settings + - Slack messages: `SLACK_API_TOKEN` +- Users can customize the email subject by including date code placeholders, which will automatically be replaced with the corresponding UTC date when the email is sent. To enable this functionality, activate the `"DATE_FORMAT_IN_EMAIL_SUBJECT"` [feature flag](/admin-docs/configuration/configuring-superset#feature-flags). This enables date formatting in email subjects, preventing all reporting emails from being grouped into the same thread (optional for the reporting feature). + - Use date codes from [strftime.org](https://strftime.org/) to create the email subject. + - If no date code is provided, the original string will be used as the email subject. + +##### Disable dry-run mode + +Screenshots will be taken but no messages actually sent as long as `ALERT_REPORTS_NOTIFICATION_DRY_RUN = True`, its default value in `docker/pythonpath_dev/superset_config.py`. To disable dry-run mode and start receiving email/Slack notifications, set `ALERT_REPORTS_NOTIFICATION_DRY_RUN` to `False` in [superset config](https://github.com/apache/superset/blob/master/docker/pythonpath_dev/superset_config.py). + +#### In your `Dockerfile` + +You'll need to extend the Superset image to include a headless browser. Your options include: +- Use Playwright with Chrome: this is the recommended approach as of version 4.1.x or greater. A working example of a Dockerfile that installs these tools is provided under "Building your own production Docker image" on the [Docker Builds](/admin-docs/installation/docker-builds#building-your-own-production-docker-image) page. Read the code comments there as you'll also need to change a feature flag in your config. +- Use Firefox: you'll need to install geckodriver and Firefox. +- Use Chrome without Playwright: you'll need to install Chrome and set the value of `WEBDRIVER_TYPE` to `"chrome"` in your `superset_config.py`. + +In Superset versions <=4.0x, users installed Firefox or Chrome and that was documented here. + +Only the worker container needs the browser. + +### Slack integration + +To send alerts and reports to Slack channels, you need to create a new Slack Application on your workspace. + +1. Connect to your Slack workspace, then head to [https://api.slack.com/apps]. +2. Create a new app. +3. Go to "OAuth & Permissions" section, and give the following scopes to your app: + - `incoming-webhook` + - `files:write` + - `chat:write` + - `channels:read` + - `groups:read` +4. At the top of the "OAuth and Permissions" section, click "install to workspace". +5. Select a default channel for your app and continue. + (You can post to any channel by inviting your Superset app into that channel). +6. The app should now be installed in your workspace, and a "Bot User OAuth Access Token" should have been created. Copy that token in the `SLACK_API_TOKEN` variable of your `superset_config.py`. +7. Ensure the feature flag `ALERT_REPORT_SLACK_V2` is set to True in `superset_config.py` +8. Restart the service (or run `superset init`) to pull in the new configuration. + +Note: when you configure an alert or a report, the Slack channel list takes channel names without the leading '#' e.g. use `alerts` instead of `#alerts`. + +#### Large Slack Workspaces (10k+ channels) + +For workspaces with many channels, fetching the complete channel list can take several minutes and may encounter Slack API rate limits. Add the following to your `superset_config.py`: + +```python +from datetime import timedelta + +# Increase cache timeout to reduce API calls +# Default: 1 day (86400 seconds) +SLACK_CACHE_TIMEOUT = int(timedelta(days=2).total_seconds()) + +# Increase retry count for rate limit errors +# Default: 2 +SLACK_API_RATE_LIMIT_RETRY_COUNT = 5 +``` + +### Kubernetes-specific + +- You must have a `celery beat` pod running. If you're using the chart included in the GitHub repository under [helm/superset](https://github.com/apache/superset/tree/master/helm/superset), you need to put `supersetCeleryBeat.enabled = true` in your values override. +- You can see the dedicated docs about [Kubernetes installation](/admin-docs/installation/kubernetes) for more details. + +### Docker Compose specific + +#### You must have in your `docker-compose.yml` + +- A Redis message broker +- PostgreSQL DB instead of SQLlite +- One or more `celery worker` +- A single `celery beat` + +This process also works in a Docker swarm environment, you would just need to add `Deploy:` to the Superset, Redis and Postgres services along with your specific configs for your swarm. + +### Detailed config + +The following configurations need to be added to the `superset_config.py` file. This file is loaded when the image runs, and any configurations in it will override the default configurations found in the `config.py`. + +You can find documentation about each field in the default `config.py` in the GitHub repository under [superset/config.py](https://github.com/apache/superset/blob/master/superset/config.py). + +You need to replace default values with your custom Redis, Slack and/or SMTP config. + +Superset uses Celery beat and Celery worker(s) to send alerts and reports. + +- The beat is the scheduler that tells the worker when to perform its tasks. This schedule is defined when you create the alert or report. +- The worker will process the tasks that need to be performed when an alert or report is fired. + +In the `CeleryConfig`, only the `beat_schedule` is relevant to this feature, the rest of the `CeleryConfig` can be changed for your needs. + +```python +from celery.schedules import crontab + +FEATURE_FLAGS = { + "ALERT_REPORTS": True +} + +REDIS_HOST = "superset_cache" +REDIS_PORT = "6379" + +class CeleryConfig: + broker_url = f"redis://{REDIS_HOST}:{REDIS_PORT}/0" + imports = ( + "superset.sql_lab", + "superset.tasks.scheduler", + ) + result_backend = f"redis://{REDIS_HOST}:{REDIS_PORT}/0" + worker_prefetch_multiplier = 10 + task_acks_late = True + task_annotations = { + "sql_lab.get_sql_results": { + "rate_limit": "100/s", + }, + } + beat_schedule = { + "reports.scheduler": { + "task": "reports.scheduler", + "schedule": crontab(minute="*", hour="*"), + }, + "reports.prune_log": { + "task": "reports.prune_log", + "schedule": crontab(minute=0, hour=0), + }, + } +CELERY_CONFIG = CeleryConfig + +SCREENSHOT_LOCATE_WAIT = 100 +SCREENSHOT_LOAD_WAIT = 600 + +# Slack configuration +SLACK_API_TOKEN = "xoxb-" + +# Email configuration +SMTP_HOST = "smtp.sendgrid.net" # change to your host +SMTP_PORT = 2525 # your port, e.g. 587 +SMTP_STARTTLS = True +SMTP_SSL_SERVER_AUTH = True # If you're using an SMTP server with a valid certificate +SMTP_SSL = False +SMTP_USER = "your_user" # use the empty string "" if using an unauthenticated SMTP server +SMTP_PASSWORD = "your_password" # use the empty string "" if using an unauthenticated SMTP server +SMTP_MAIL_FROM = "noreply@youremail.com" +EMAIL_REPORTS_SUBJECT_PREFIX = "[Superset] " # optional - overwrites default value in config.py of "[Report] " + +# WebDriver configuration +# If you use Firefox or Playwright with Chrome, you can stick with default values +# If you use Chrome and are *not* using Playwright, then add the following WEBDRIVER_TYPE and WEBDRIVER_OPTION_ARGS +WEBDRIVER_TYPE = "chrome" +WEBDRIVER_OPTION_ARGS = [ + "--force-device-scale-factor=2.0", + "--high-dpi-support=2.0", + "--headless", + "--disable-gpu", + "--disable-dev-shm-usage", + "--no-sandbox", + "--disable-setuid-sandbox", + "--disable-extensions", +] + +# This is for internal use, you can keep http +WEBDRIVER_BASEURL = "http://superset:8088" # When running using docker compose use "http://superset_app:8088' +# This is the link sent to the recipient. Change to your domain, e.g. https://superset.mydomain.com +WEBDRIVER_BASEURL_USER_FRIENDLY = "http://localhost:8088" +``` + +You also need +to specify on behalf of which username to render the dashboards. In general, dashboards and charts +are not accessible to unauthorized requests, that is why the worker needs to take over credentials +of an existing user to take a snapshot. + +By default, Alerts and Reports are executed as the owner of the alert/report object. To use a fixed user account, +just change the config as follows (`admin` in this example): + +```python +from superset.tasks.types import FixedExecutor + +ALERT_REPORTS_EXECUTORS = [FixedExecutor("admin")] +``` + +Please refer to `ExecutorType` in the codebase for other executor types. + +**Important notes** + +- Be mindful of the concurrency setting for celery (using `-c 4`). Selenium/webdriver instances can + consume a lot of CPU / memory on your servers. +- In some cases, if you notice a lot of leaked geckodriver processes, try running your celery + processes with `celery worker --pool=prefork --max-tasks-per-child=128 ...` +- It is recommended to run separate workers for the `sql_lab` and `email_reports` tasks. This can be + done using the `queue` field in `task_annotations`. +- Adjust `WEBDRIVER_BASEURL` in your configuration file if celery workers can’t access Superset via + its default value of `http://0.0.0.0:8080/`. + +It's also possible to specify a minimum interval between each report's execution through the config file: + +``` python +# Set a minimum interval threshold between executions (for each Alert/Report) +# Value should be an integer +ALERT_MINIMUM_INTERVAL = int(timedelta(minutes=10).total_seconds()) +REPORT_MINIMUM_INTERVAL = int(timedelta(minutes=5).total_seconds()) +``` + +Alternatively, you can assign a function to `ALERT_MINIMUM_INTERVAL` and/or `REPORT_MINIMUM_INTERVAL`. This is useful to dynamically retrieve a value as needed: + +``` python +def alert_dynamic_minimal_interval(**kwargs) -> int: + """ + Define logic here to retrieve the value dynamically + """ + +ALERT_MINIMUM_INTERVAL = alert_dynamic_minimal_interval +``` + +## External Link Redirection + +For security, Superset rewrites external links in alert/report email HTML so +they go through a warning page before the user is navigated to the external +site. Internal links (matching your configured base URL) are not affected. + +```python +# Disable external link redirection entirely (default: True) +ALERT_REPORTS_ENABLE_LINK_REDIRECT = False +``` + +The feature uses `WEBDRIVER_BASEURL_USER_FRIENDLY` (or `WEBDRIVER_BASEURL`) +to determine which hosts are internal. + +## Troubleshooting + +There are many reasons that reports might not be working. Try these steps to check for specific issues. + +### Confirm feature flag is enabled and you have sufficient permissions + +If you don't see "Alerts & Reports" under the *Manage* section of the Settings dropdown in the Superset UI, you need to enable the `ALERT_REPORTS` feature flag (see above). Enable another feature flag and check to see that it took effect, to verify that your config file is getting loaded. + +Log in as an admin user to ensure you have adequate permissions. + +### Check the logs of your Celery worker + +This is the best source of information about the problem. In a docker compose deployment, you can do this with a command like `docker logs superset_worker --since 1h`. + +### Check web browser and webdriver installation + +To take a screenshot, the worker visits the dashboard or chart using a headless browser, then takes a screenshot. If you are able to send a chart as CSV or text but can't send as PNG, your problem may lie with the browser. + +If you are handling the installation of the headless browser on your own, do your own verification to ensure that the headless browser opens successfully in the worker environment. + +### Send a test email + +One symptom of an invalid connection to an email server is receiving an error of `[Errno 110] Connection timed out` in your logs when the report tries to send. + +Confirm via testing that your outbound email configuration is correct. Here is the simplest test, for an un-authenticated email SMTP email service running on port 25. If you are sending over SSL, for instance, study how [Superset's codebase sends emails](https://github.com/apache/superset/blob/master/superset/utils/core.py#L818) and then test with those commands and arguments. + +Start Python in your worker environment, replace all example values, and run: + +```python +import smtplib +from email.mime.multipart import MIMEMultipart +from email.mime.text import MIMEText + +from_email = 'superset_emails@example.com' +to_email = 'your_email@example.com' +msg = MIMEMultipart() +msg['From'] = from_email +msg['To'] = to_email +msg['Subject'] = 'Superset SMTP config test' +message = 'It worked' +msg.attach(MIMEText(message)) +mailserver = smtplib.SMTP('smtpmail.example.com', 25) +mailserver.sendmail(from_email, to_email, msg.as_string()) +mailserver.quit() +``` + +This should send an email. + +Possible fixes: + +- Some cloud hosts disable outgoing unauthenticated SMTP email to prevent spam. For instance, [Azure blocks port 25 by default on some machines](https://learn.microsoft.com/en-us/azure/virtual-network/troubleshoot-outbound-smtp-connectivity). Enable that port or use another sending method. +- Use another set of SMTP credentials that you verify works in this setup. + +### Browse to your report from the worker + +The worker may be unable to reach the report. It will use the value of `WEBDRIVER_BASEURL` to browse to the report. If that route is invalid, or presents an authentication challenge that the worker can't pass, the report screenshot will fail. + +Check this by attempting to `curl` the URL of a report that you see in the error logs of your worker. For instance, from the worker environment, run `curl http://superset_app:8088/superset/dashboard/1/`. You may get different responses depending on whether the dashboard exists - for example, you may need to change the `1` in that URL. If there's a URL in your logs from a failed report screenshot, that's a good place to start. The goal is to determine a valid value for `WEBDRIVER_BASEURL` and determine if an issue like HTTPS or authentication is redirecting your worker. + +In a deployment with authentication measures enabled like HTTPS and Single Sign-On, it may make sense to have the worker navigate directly to the Superset application running in the same location, avoiding the need to sign in. For instance, you could use `WEBDRIVER_BASEURL="http://superset_app:8088"` for a docker compose deployment, and set `"force_https": False,` in your `TALISMAN_CONFIG`. + +### Duplicate report deliveries + +In some deployment configurations a scheduled report can be delivered more than once around its planned time. This typically happens when more than one process is responsible for running the alerts & reports schedule (for example, multiple schedulers or Celery beat instances). To avoid duplicate emails or notifications: + +- Ensure that only a **single scheduler/beat process** is configured to trigger alerts and reports for a given environment. +- If you run **multiple Celery workers**, verify that there is still only one component responsible for scheduling the report tasks (workers should execute tasks, not schedule them independently). +- Review your deployment/orchestration setup (for example systemd, Docker, or Kubernetes) to make sure the alerts & reports scheduler is **not started from multiple places by accident**. + +## Scheduling Queries as Reports + +You can optionally allow your users to schedule queries directly in SQL Lab. This is done by adding +extra metadata to saved queries, which are then picked up by an external scheduled (like +[Apache Airflow](https://airflow.apache.org/)). + +To allow scheduled queries, add the following to `SCHEDULED_QUERIES` in your configuration file: + +```python +SCHEDULED_QUERIES = { + # This information is collected when the user clicks "Schedule query", + # and saved into the `extra` field of saved queries. + # See: https://github.com/mozilla-services/react-jsonschema-form + 'JSONSCHEMA': { + 'title': 'Schedule', + 'description': ( + 'In order to schedule a query, you need to specify when it ' + 'should start running, when it should stop running, and how ' + 'often it should run. You can also optionally specify ' + 'dependencies that should be met before the query is ' + 'executed. Please read the documentation for best practices ' + 'and more information on how to specify dependencies.' + ), + 'type': 'object', + 'properties': { + 'output_table': { + 'type': 'string', + 'title': 'Output table name', + }, + 'start_date': { + 'type': 'string', + 'title': 'Start date', + # date-time is parsed using the chrono library, see + # https://www.npmjs.com/package/chrono-node#usage + 'format': 'date-time', + 'default': 'tomorrow at 9am', + }, + 'end_date': { + 'type': 'string', + 'title': 'End date', + # date-time is parsed using the chrono library, see + # https://www.npmjs.com/package/chrono-node#usage + 'format': 'date-time', + 'default': '9am in 30 days', + }, + 'schedule_interval': { + 'type': 'string', + 'title': 'Schedule interval', + }, + 'dependencies': { + 'type': 'array', + 'title': 'Dependencies', + 'items': { + 'type': 'string', + }, + }, + }, + }, + 'UISCHEMA': { + 'schedule_interval': { + 'ui:placeholder': '@daily, @weekly, etc.', + }, + 'dependencies': { + 'ui:help': ( + 'Check the documentation for the correct format when ' + 'defining dependencies.' + ), + }, + }, + 'VALIDATION': [ + # ensure that start_date <= end_date + { + 'name': 'less_equal', + 'arguments': ['start_date', 'end_date'], + 'message': 'End date cannot be before start date', + # this is where the error message is shown + 'container': 'end_date', + }, + ], + # link to the scheduler; this example links to an Airflow pipeline + # that uses the query id and the output table as its name + 'linkback': ( + 'https://airflow.example.com/admin/airflow/tree?' + 'dag_id=query_${id}_${extra_json.schedule_info.output_table}' + ), +} +``` + +This configuration is based on +[react-jsonschema-form](https://github.com/mozilla-services/react-jsonschema-form) and will add a +menu item called “Schedule” to SQL Lab. When the menu item is clicked, a modal will show up where +the user can add the metadata required for scheduling the query. + +This information can then be retrieved from the endpoint `/api/v1/saved_query/` and used to +schedule the queries that have `schedule_info` in their JSON metadata. For schedulers other than +Airflow, additional fields can be easily added to the configuration file above. + +:::resources +- [Tutorial: Automated Alerts and Reporting via Slack/Email in Superset](https://dev.to/ngtduc693/apache-superset-topic-5-automated-alerts-and-reporting-via-slackemail-in-superset-2gbe) +- [Blog: Integrating Slack alerts and Apache Superset for better data observability](https://medium.com/affinityanswers-tech/integrating-slack-alerts-and-apache-superset-for-better-data-observability-fd2f9a12c350) +::: diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/async-queries-celery.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/async-queries-celery.mdx new file mode 100644 index 00000000000..ee2d2c28624 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/async-queries-celery.mdx @@ -0,0 +1,108 @@ +--- +title: Async Queries via Celery +hide_title: true +sidebar_position: 4 +version: 1 +--- + +# Async Queries via Celery + +## Celery + +On large analytic databases, it’s common to run queries that execute for minutes or hours. To enable +support for long running queries that execute beyond the typical web request’s timeout (30-60 +seconds), it is necessary to configure an asynchronous backend for Superset which consists of: + +- one or many Superset workers (which is implemented as a Celery worker), and can be started with + the `celery worker` command, run `celery worker --help` to view the related options. +- a celery broker (message queue) for which we recommend using Redis or RabbitMQ +- a results backend that defines where the worker will persist the query results + +Configuring Celery requires defining a `CELERY_CONFIG` in your `superset_config.py`. Both the worker +and web server processes should have the same configuration. + +```python +class CeleryConfig(object): + broker_url = "redis://localhost:6379/0" + imports = ( + "superset.sql_lab", + "superset.tasks.scheduler", + ) + result_backend = "redis://localhost:6379/0" + worker_prefetch_multiplier = 10 + task_acks_late = True + task_annotations = { + "sql_lab.get_sql_results": { + "rate_limit": "100/s", + }, + } + +CELERY_CONFIG = CeleryConfig +``` + +To start a Celery worker to leverage the configuration, run the following command: + +```bash +celery --app=superset.tasks.celery_app:app worker --pool=prefork -O fair -c 4 +``` + +To start a job which schedules periodic background jobs, run the following command: + +```bash +celery --app=superset.tasks.celery_app:app beat +``` + +To setup a result backend, you need to pass an instance of a derivative of `BaseCache` (`from +flask_caching.backends.base import BaseCache`) to the RESULTS_BACKEND configuration key in your +superset_config.py. You can use Memcached, Redis, S3 (https://pypi.python.org/pypi/s3werkzeugcache), +memory or the file system (in a single server-type setup or for testing), or to write your own +caching interface. Your `superset_config.py` may look something like: + +```python +# On S3 +from s3cache.s3cache import S3Cache +S3_CACHE_BUCKET = 'foobar-superset' +S3_CACHE_KEY_PREFIX = 'sql_lab_result' +RESULTS_BACKEND = S3Cache(S3_CACHE_BUCKET, S3_CACHE_KEY_PREFIX) + +# On Redis +from flask_caching.backends.rediscache import RedisCache +RESULTS_BACKEND = RedisCache( + host='localhost', port=6379, key_prefix='superset_results') +``` + +For performance gains, [MessagePack](https://github.com/msgpack/msgpack-python) and +[PyArrow](https://arrow.apache.org/docs/python/) are now used for results serialization. This can be +disabled by setting `RESULTS_BACKEND_USE_MSGPACK = False` in your `superset_config.py`, should any +issues arise. Please clear your existing results cache store when upgrading an existing environment. + +**Important Notes** + +- It is important that all the worker nodes and web servers in the Superset cluster _share a common + metadata database_. This means that SQLite will not work in this context since it has limited + support for concurrency and typically lives on the local file system. + +- There should _only be one instance of celery beat running_ in your entire setup. If not, + background jobs can get scheduled multiple times resulting in weird behaviors like duplicate + delivery of reports, higher than expected load / traffic etc. + +- SQL Lab will _only run your queries asynchronously if_ you enable **Asynchronous Query Execution** + in your database settings (Sources > Databases > Edit record). + +## Celery Flower + +Flower is a web based tool for monitoring the Celery cluster which you can install from pip: + +```bash +pip install flower +``` + +You can run flower using: + +```bash +celery --app=superset.tasks.celery_app:app flower +``` + +:::resources +- [Blog: How to Set Up Global Async Queries (GAQ) in Apache Superset](https://medium.com/@ngigilevis/how-to-set-up-global-async-queries-gaq-in-apache-superset-a-complete-guide-9d2f4a047559) +::: diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/aws-iam.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/aws-iam.mdx new file mode 100644 index 00000000000..e3fac57508f --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/aws-iam.mdx @@ -0,0 +1,162 @@ +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +--- +title: AWS IAM Authentication +sidebar_label: AWS IAM Authentication +sidebar_position: 15 +--- + +# AWS IAM Authentication for AWS Databases + +Superset supports IAM-based authentication for **Amazon Aurora** (PostgreSQL and MySQL) and **Amazon Redshift**. IAM auth eliminates the need for database passwords — Superset generates a short-lived auth token using temporary AWS credentials instead. + +Cross-account IAM role assumption via STS `AssumeRole` is supported, allowing a Superset deployment in one AWS account to connect to databases in a different account. + +## Prerequisites + +- Enable the `AWS_DATABASE_IAM_AUTH` feature flag in `superset_config.py`. IAM authentication is gated behind this flag; if it is disabled, connections using `aws_iam` fail with *"AWS IAM database authentication is not enabled."* + ```python + FEATURE_FLAGS = { + "AWS_DATABASE_IAM_AUTH": True, + } + ``` +- `boto3` must be installed in your Superset environment: + ```bash + pip install boto3 + ``` +- The Superset server's IAM role (or static credentials) must have permission to call `sts:AssumeRole` (for cross-account) or the same-account permissions for the target service: + - **Aurora (RDS)**: `rds-db:connect` + - **Redshift provisioned**: `redshift:GetClusterCredentials` + - **Redshift Serverless**: `redshift-serverless:GetCredentials` and `redshift-serverless:GetWorkgroup` +- SSL must be enabled on the Aurora / Redshift endpoint (required for IAM token auth). + +## Configuration + +IAM authentication is configured via the **encrypted_extra** field of the database connection. Access this field in the **Advanced** → **Security** section of the database connection form, under **Secure Extra**. + +### Aurora PostgreSQL or Aurora MySQL + +```json +{ + "aws_iam": { + "enabled": true, + "role_arn": "arn:aws:iam::222222222222:role/SupersetDatabaseAccess", + "external_id": "superset-prod-12345", + "region": "us-east-1", + "db_username": "superset_iam_user", + "session_duration": 3600 + } +} +``` + +| Field | Required | Description | +|-------|----------|-------------| +| `enabled` | Yes | Set to `true` to activate IAM auth | +| `role_arn` | No | ARN of the cross-account IAM role to assume via STS. Omit for same-account auth | +| `external_id` | No | External ID for the STS `AssumeRole` call, if required by the target role's trust policy | +| `region` | Yes | AWS region of the database cluster | +| `db_username` | Yes | The database username associated with the IAM identity | +| `session_duration` | No | STS session duration in seconds (default: `3600`) | + +### Redshift (Serverless) + +```json +{ + "aws_iam": { + "enabled": true, + "role_arn": "arn:aws:iam::222222222222:role/SupersetRedshiftAccess", + "region": "us-east-1", + "workgroup_name": "my-workgroup", + "db_name": "dev" + } +} +``` + +### Redshift (Provisioned Cluster) + +```json +{ + "aws_iam": { + "enabled": true, + "role_arn": "arn:aws:iam::222222222222:role/SupersetRedshiftAccess", + "region": "us-east-1", + "cluster_identifier": "my-cluster", + "db_username": "superset_iam_user", + "db_name": "dev" + } +} +``` + +## Cross-Account IAM Setup + +To connect to a database in Account B from a Superset deployment in Account A: + +**1. In Account B — create a database-access role:** + +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": ["rds-db:connect"], + "Resource": "arn:aws:rds-db:us-east-1:222222222222:dbuser/db-XXXXXXXXXXXX/superset_iam_user" + } + ] +} +``` + +**Trust policy** (allows Account A's Superset role to assume it): + +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::111111111111:role/SupersetInstanceRole" + }, + "Action": "sts:AssumeRole", + "Condition": { + "StringEquals": { + "sts:ExternalId": "superset-prod-12345" + } + } + } + ] +} +``` + +**2. In Account A — grant Superset's role permission to assume the Account B role:** + +```json +{ + "Effect": "Allow", + "Action": "sts:AssumeRole", + "Resource": "arn:aws:iam::222222222222:role/SupersetDatabaseAccess" +} +``` + +**3. Configure the database connection in Superset** using the `role_arn` and `external_id` from the trust policy (as shown in the configuration example above). + +## Credential Caching + +STS credentials are cached in memory keyed by `(role_arn, region, external_id)` with a 10-minute TTL. This reduces the number of STS API calls when multiple queries are executed with the same connection. Tokens are refreshed automatically before expiry. diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/cache.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/cache.mdx new file mode 100644 index 00000000000..ef3fbe1161c --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/cache.mdx @@ -0,0 +1,276 @@ +--- +title: Caching +hide_title: true +sidebar_position: 3 +version: 1 +--- + +# Caching + +:::note +When a cache backend is configured, Superset expects it to remain available. Operations will +fail if the configured backend becomes unavailable rather than silently degrading. This +fail-fast behavior ensures operators are immediately aware of infrastructure issues. +::: + +Superset uses [Flask-Caching](https://flask-caching.readthedocs.io/) for caching purposes. +Flask-Caching supports various caching backends, including Redis (recommended), Memcached, +SimpleCache (in-memory), or the local filesystem. +[Custom cache backends](https://flask-caching.readthedocs.io/en/latest/#custom-cache-backends) +are also supported. + +Caching can be configured by providing dictionaries in +`superset_config.py` that comply with [the Flask-Caching config specifications](https://flask-caching.readthedocs.io/en/latest/#configuring-flask-caching). + +The following cache configurations can be customized in this way: + +- Dashboard filter state (required): `FILTER_STATE_CACHE_CONFIG`. +- Explore chart form data (required): `EXPLORE_FORM_DATA_CACHE_CONFIG` +- Metadata cache (optional): `CACHE_CONFIG` +- Charting data queried from datasets (optional): `DATA_CACHE_CONFIG` + +For example, to configure the filter state cache using Redis: + +```python +FILTER_STATE_CACHE_CONFIG = { + 'CACHE_TYPE': 'RedisCache', + 'CACHE_DEFAULT_TIMEOUT': 86400, + 'CACHE_KEY_PREFIX': 'superset_filter_cache', + 'CACHE_REDIS_URL': 'redis://localhost:6379/0' +} +``` + +## Dependencies + +In order to use dedicated cache stores, additional python libraries must be installed + +- For Redis: we recommend the [redis](https://pypi.python.org/pypi/redis) Python package +- Memcached: we recommend using [pylibmc](https://pypi.org/project/pylibmc/) client library as + `python-memcached` does not handle storing binary data correctly. + +These libraries can be installed using pip. + +## Fallback Metastore Cache + +Note, that some form of Filter State and Explore caching are required. If either of these caches +are undefined, Superset falls back to using a built-in cache that stores data in the metadata +database. While it is recommended to use a dedicated cache, the built-in cache can also be used +to cache other data. + +For example, to use the built-in cache to store chart data, use the following config: + +```python +DATA_CACHE_CONFIG = { + "CACHE_TYPE": "SupersetMetastoreCache", + "CACHE_KEY_PREFIX": "superset_results", # make sure this string is unique to avoid collisions + "CACHE_DEFAULT_TIMEOUT": 86400, # 60 seconds * 60 minutes * 24 hours +} +``` + +## Chart Cache Timeout + +The cache timeout for charts may be overridden by the settings for an individual chart, dataset, or +database. Each of these configurations will be checked in order before falling back to the default +value defined in `DATA_CACHE_CONFIG`. + +Note, that by setting the cache timeout to `-1`, caching for charting data can be disabled, either +per chart, dataset or database, or by default if set in `DATA_CACHE_CONFIG`. + +## SQL Lab Query Results + +Caching for SQL Lab query results is used when async queries are enabled and is configured using +`RESULTS_BACKEND`. + +Note that this configuration does not use a flask-caching dictionary for its configuration, but +instead requires a cachelib object. + +See [Async Queries via Celery](/admin-docs/configuration/async-queries-celery) for details. + +## Caching Thumbnails + +This is an optional feature that can be turned on by activating its [feature flag](/admin-docs/configuration/configuring-superset#feature-flags) on config: + +``` +FEATURE_FLAGS = { + "THUMBNAILS": True, + "THUMBNAILS_SQLA_LISTENERS": True, +} +``` + +By default thumbnails are rendered per user, and will fall back to the Selenium user for anonymous users. +To always render thumbnails as a fixed user (`admin` in this example), use the following configuration: + +```python +from superset.tasks.types import FixedExecutor + +THUMBNAIL_EXECUTORS = [FixedExecutor("admin")] +``` + +For this feature you will need a cache system and celery workers. All thumbnails are stored on cache +and are processed asynchronously by the workers. + +An example config where images are stored on S3 could be: + +```python +from flask import Flask +from s3cache.s3cache import S3Cache + +... + +class CeleryConfig(object): + broker_url = "redis://localhost:6379/0" + imports = ( + "superset.sql_lab", + "superset.tasks.thumbnails", + ) + result_backend = "redis://localhost:6379/0" + worker_prefetch_multiplier = 10 + task_acks_late = True + + +CELERY_CONFIG = CeleryConfig + +def init_thumbnail_cache(app: Flask) -> S3Cache: + return S3Cache("bucket_name", 'thumbs_cache/') + + +THUMBNAIL_CACHE_CONFIG = init_thumbnail_cache +``` + +Using the above example cache keys for dashboards will be `superset_thumb__dashboard__{ID}`. You can +override the base URL for Selenium using: + +``` +WEBDRIVER_BASEURL = "https://superset.company.com" +``` + +To control which user account is used for rendering thumbnails and warming up caches, configure +`THUMBNAIL_EXECUTORS` and `CACHE_WARMUP_EXECUTORS`. Each accepts a list of executor types (which +resolve to an owner, creator, modifier, or the currently-logged-in user) and/or a `FixedExecutor` +pinned to a specific username. By default, thumbnails render as the current user +(`ExecutorType.CURRENT_USER`) and cache warmup runs as the chart/dashboard owner +(`ExecutorType.OWNER`). + +To force both to run as a dedicated service account (`admin` in this example): + +```python +from superset.tasks.types import ExecutorType, FixedExecutor + +THUMBNAIL_EXECUTORS = [FixedExecutor("admin")] +CACHE_WARMUP_EXECUTORS = [FixedExecutor("admin")] +``` + +Use a dedicated read-only service account here rather than a personal admin account, so that +thumbnail rendering and cache warmup tasks don't fail if a specific user's credentials change. + +Additional Selenium WebDriver configuration can be set using `WEBDRIVER_CONFIGURATION`. You can +implement a custom function to authenticate Selenium. The default function uses the `flask-login` +session cookie. Here's an example of a custom function signature: + +```python +def auth_driver(driver: WebDriver, user: "User") -> WebDriver: + pass +``` + +Then on configuration: + +``` +WEBDRIVER_AUTH_FUNC = auth_driver +``` + +## ETag Support for Thumbnails + +Thumbnail and screenshot endpoints return `ETag` response headers based on the cached content digest. Clients can use conditional requests to avoid downloading unchanged images: + +``` +GET /api/v1/chart/42/thumbnail/ +If-None-Match: "abc123..." + +→ 304 Not Modified (if unchanged) +→ 200 OK (with new image if changed) +``` + +This is particularly useful for embedded dashboards and external integrations that periodically poll for updated screenshots — unchanged thumbnails return immediately with no payload. + +## Distributed Coordination Backend + +Superset supports an optional distributed coordination (`DISTRIBUTED_COORDINATION_CONFIG`) for +high-performance distributed operations. This configuration enables: + +- **Distributed locking**: Moves lock operations from the metadata database to Redis, improving + performance and reducing metastore load +- **Real-time event notifications**: Enables instant pub/sub messaging for task abort signals and + completion notifications instead of polling-based approaches + +:::note +This requires Redis or Valkey specifically—it uses Redis-specific features (pub/sub, `SET NX EX`) +that are not available in general Flask-Caching backends. +::: + +### Configuration + +The distributed coordination uses Flask-Caching style configuration for consistency with other cache +backends. Configure `DISTRIBUTED_COORDINATION_CONFIG` in `superset_config.py`: + +```python +DISTRIBUTED_COORDINATION_CONFIG = { + "CACHE_TYPE": "RedisCache", + "CACHE_REDIS_HOST": "localhost", + "CACHE_REDIS_PORT": 6379, + "CACHE_REDIS_DB": 0, + "CACHE_REDIS_PASSWORD": "", # Optional +} +``` + +For Redis Sentinel deployments: + +```python +DISTRIBUTED_COORDINATION_CONFIG = { + "CACHE_TYPE": "RedisSentinelCache", + "CACHE_REDIS_SENTINELS": [("sentinel1", 26379), ("sentinel2", 26379)], + "CACHE_REDIS_SENTINEL_MASTER": "mymaster", + "CACHE_REDIS_SENTINEL_PASSWORD": None, # Sentinel password (if different) + "CACHE_REDIS_PASSWORD": "", # Redis password + "CACHE_REDIS_DB": 0, +} +``` + +For SSL/TLS connections: + +```python +DISTRIBUTED_COORDINATION_CONFIG = { + "CACHE_TYPE": "RedisCache", + "CACHE_REDIS_HOST": "redis.example.com", + "CACHE_REDIS_PORT": 6380, + "CACHE_REDIS_SSL": True, + "CACHE_REDIS_SSL_CERTFILE": "/path/to/client.crt", + "CACHE_REDIS_SSL_KEYFILE": "/path/to/client.key", + "CACHE_REDIS_SSL_CA_CERTS": "/path/to/ca.crt", +} +``` + +### Distributed Lock TTL + +You can configure the default lock TTL (time-to-live) in seconds. Locks automatically expire after +this duration to prevent deadlocks from crashed processes: + +```python +DISTRIBUTED_LOCK_DEFAULT_TTL = 30 # Default: 30 seconds +``` + +Individual lock acquisitions can override this value when needed. + +### Database-Only Mode + +When `DISTRIBUTED_COORDINATION_CONFIG` is not configured, Superset uses database-backed operations: + +- **Locking**: Uses the KeyValue table with periodic cleanup of expired entries +- **Event notifications**: Uses database polling instead of pub/sub + +While database-backed operations work reliably, the Redis backend is recommended for production +deployments where low latency and reduced database load are important. + +:::resources +- [Blog: The Data Engineer's Guide to Lightning-Fast Superset Dashboards](https://preset.io/blog/the-data-engineers-guide-to-lightning-fast-apache-superset-dashboards/) +- [Blog: Accelerating Dashboards with Materialized Views](https://preset.io/blog/accelerating-apache-superset-dashboards-with-materialized-views/) +::: diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/configuring-superset.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/configuring-superset.mdx new file mode 100644 index 00000000000..becdf70888b --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/configuring-superset.mdx @@ -0,0 +1,477 @@ +--- +title: Configuring Superset +hide_title: true +sidebar_position: 1 +version: 1 +--- + +# Configuring Superset + +## superset_config.py + +Superset exposes hundreds of configurable parameters through its +[config.py module](https://github.com/apache/superset/blob/master/superset/config.py). The +variables and objects exposed act as a public interface of the bulk of what you may want +to configure, alter and interface with. In this python module, you'll find all these +parameters, sensible defaults, as well as rich documentation in the form of comments + +To configure your application, you need to create your own configuration module, which +will allow you to override few or many of these parameters. Instead of altering the core module, +you'll want to define your own module (typically a file named `superset_config.py`). +Add this file to your `PYTHONPATH` or create an environment variable +`SUPERSET_CONFIG_PATH` specifying the full path of the `superset_config.py`. + +For example, if deploying on Superset directly on a Linux-based system where your +`superset_config.py` is under `/app` directory, you can run: + +```bash +export SUPERSET_CONFIG_PATH=/app/superset_config.py +``` + +If you are using your own custom Dockerfile with the official Superset image as base image, +then you can add your overrides as shown below: + +```bash +COPY --chown=superset superset_config.py /app/ +ENV SUPERSET_CONFIG_PATH /app/superset_config.py +``` + +Docker compose deployments handle application configuration differently using specific conventions. +Refer to the [docker compose tips & configuration](/admin-docs/installation/docker-compose#docker-compose-tips--configuration) +for details. + +The following is an example of just a few of the parameters you can set in your `superset_config.py` file: + +``` +# Superset specific config +ROW_LIMIT = 5000 + +# Flask App Builder configuration +# Your App secret key will be used for securely signing the session cookie +# and encrypting sensitive information on the database +# Make sure you are changing this key for your deployment with a strong key. +# Alternatively you can set it with `SUPERSET_SECRET_KEY` environment variable. +# You MUST set this for production environments or the server will refuse +# to start and you will see an error in the logs accordingly. +SECRET_KEY = 'YOUR_OWN_RANDOM_GENERATED_SECRET_KEY' + +# The SQLAlchemy connection string to your database backend +# This connection defines the path to the database that stores your +# superset metadata (slices, connections, tables, dashboards, ...). +# Note that the connection information to connect to the datasources +# you want to explore are managed directly in the web UI +# The check_same_thread=false property ensures the sqlite client does not attempt +# to enforce single-threaded access, which may be problematic in some edge cases +SQLALCHEMY_DATABASE_URI = 'sqlite:////path/to/superset.db?check_same_thread=false' + +# Flask-WTF flag for CSRF +WTF_CSRF_ENABLED = True +# Add endpoints that need to be exempt from CSRF protection +WTF_CSRF_EXEMPT_LIST = [] +# A CSRF token that expires in 1 year +WTF_CSRF_TIME_LIMIT = 60 * 60 * 24 * 365 + +# Set this API key to enable Mapbox visualizations +MAPBOX_API_KEY = '' +``` + +:::tip +Note that it is typical to copy and paste [only] the portions of the +core [superset/config.py](https://github.com/apache/superset/blob/master/superset/config.py) that +you want to alter, along with the related comments into your own `superset_config.py` file. +::: + +All the parameters and default values defined +in [superset/config.py](https://github.com/apache/superset/blob/master/superset/config.py) +can be altered in your local `superset_config.py`. Administrators will want to read through the file +to understand what can be configured locally as well as the default values in place. + +Since `superset_config.py` acts as a Flask configuration module, it can be used to alter the +settings of Flask itself, as well as Flask extensions that Superset bundles like +`flask-wtf`, `flask-caching`, `flask-migrate`, +and `flask-appbuilder`. Each one of these extensions offers intricate configurability. +Flask App Builder, the web framework used by Superset, also offers many +configuration settings. Please consult the +[Flask App Builder Documentation](https://flask-appbuilder.readthedocs.org/en/latest/config.html) +for more information on how to configure it. + +At the very least, you'll want to change `SECRET_KEY` and `SQLALCHEMY_DATABASE_URI`. Continue reading for more about each of these. + +## Specifying a SECRET_KEY + +### Adding an initial SECRET_KEY + +Superset requires a user-specified SECRET_KEY to start up. This requirement was [added in version 2.1.0 to force secure configurations](https://preset.io/blog/superset-security-update-default-secret_key-vulnerability/). Add a strong SECRET_KEY to your `superset_config.py` file like: + +```python +SECRET_KEY = 'YOUR_OWN_RANDOM_GENERATED_SECRET_KEY' +``` + +You can generate a strong secure key with `openssl rand -base64 42`. + +Alternatively, you can set the secret key using `SUPERSET_SECRET_KEY` environment variable: + +On a Unix-based system, such as Linux or macOS, you can do so by running the following command in your terminal: + +```bash +export SUPERSET_SECRET_KEY=$(openssl rand -base64 42) +``` + +:::caution Use a strong secret key +This key will be used for securely signing session cookies and encrypting sensitive information stored in Superset's application metadata database. +Your deployment must use a complex, unique key. +::: + +### Rotating to a newer SECRET_KEY + +If you wish to change your existing SECRET_KEY, add the existing SECRET_KEY to your `superset_config.py` file as +`PREVIOUS_SECRET_KEY =`and provide your new key as `SECRET_KEY =`. You can find your current SECRET_KEY with these +commands - if running Superset with Docker, execute from within the Superset application container: + +```python +superset shell +from flask import current_app; print(current_app.config["SECRET_KEY"]) +``` + +Save your `superset_config.py` with these values and then run `superset re-encrypt-secrets`. + +## Setting up a production metadata database + +Superset needs a database to store the information it manages, like the definitions of +charts, dashboards, and many other things. + +By default, Superset is configured to use [SQLite](https://www.sqlite.org/), +a self-contained, single-file database that offers a simple and fast way to get started +(without requiring any installation). However, for production environments, +using SQLite is highly discouraged due to security, scalability, and data integrity reasons. +It's important to use only the supported database engines and consider using a different +database engine on a separate host or container. + +Superset supports the following database engines/versions: + +| Database Engine | Supported Versions | +| ----------------------------------------- | ---------------------------------------- | +| [PostgreSQL](https://www.postgresql.org/) | 10.X, 11.X, 12.X, 13.X, 14.X, 15.X, 16.X | +| [MySQL](https://www.mysql.com/) | 5.7, 8.X | + +Use the following database drivers and connection strings: + +| Database | PyPI package | Connection String | +| ----------------------------------------- | ------------------------- | ---------------------------------------------------------------------- | +| [PostgreSQL](https://www.postgresql.org/) | `pip install psycopg2` | `postgresql://:@/` | +| [MySQL](https://www.mysql.com/) | `pip install mysqlclient` | `mysql://:@/` | + +:::tip +Properly setting up metadata store is beyond the scope of this documentation. We recommend +using a hosted managed service such as [Amazon RDS](https://aws.amazon.com/rds/) or +[Google Cloud Databases](https://cloud.google.com/products/databases?hl=en) to handle +service and supporting infrastructure and backup strategy. +::: + +To configure Superset metastore set `SQLALCHEMY_DATABASE_URI` config key on `superset_config` +to the appropriate connection string. + +## Running on a WSGI HTTP Server + +While you can run Superset on NGINX or Apache, we recommend using Gunicorn in async mode. This +enables impressive concurrency even and is fairly easy to install and configure. Please refer to the +documentation of your preferred technology to set up this Flask WSGI application in a way that works +well in your environment. Here’s an async setup known to work well in production: + +``` + -w 10 \ + -k gevent \ + --worker-connections 1000 \ + --timeout 120 \ + -b 0.0.0.0:6666 \ + --limit-request-line 0 \ + --limit-request-field_size 0 \ + --statsd-host localhost:8125 \ + "superset.app:create_app()" +``` + +Refer to the [Gunicorn documentation](https://docs.gunicorn.org/en/stable/design.html) for more +information. _Note that the development web server (`superset run` or `flask run`) is not intended +for production use._ + +If you're not using Gunicorn, you may want to disable the use of `flask-compress` by setting +`COMPRESS_REGISTER = False` in your `superset_config.py`. + +Currently, the Google BigQuery Python SDK is not compatible with `gevent`, due to some dynamic monkeypatching on python core library by `gevent`. +So, when you use `BigQuery` datasource on Superset, you have to use `gunicorn` worker type except `gevent`. + +## HTTPS Configuration + +You can configure HTTPS upstream via a load balancer or a reverse proxy (such as nginx) and do SSL/TLS Offloading before traffic reaches the Superset application. In this setup, local traffic from a Celery worker taking a snapshot of a chart for Alerts & Reports can access Superset at a `http://` URL, from behind the ingress point. +You can also configure [SSL in Gunicorn](https://docs.gunicorn.org/en/stable/settings.html#ssl) (the Python webserver) if you are using an official Superset Docker image. + +## Configuration Behind a Load Balancer + +If you are running superset behind a load balancer or reverse proxy (e.g. NGINX or ELB on AWS), you +may need to utilize a healthcheck endpoint so that your load balancer knows if your superset +instance is running. This is provided at `/health` which will return a 200 response containing “OK” +if the webserver is running. + +If the load balancer is inserting `X-Forwarded-For/X-Forwarded-Proto` headers, you should set +`ENABLE_PROXY_FIX = True` in the superset config file (`superset_config.py`) to extract and use the +headers. + +In case the reverse proxy is used for providing SSL encryption, an explicit definition of the +`X-Forwarded-Proto` may be required. For the Apache webserver this can be set as follows: + +``` +RequestHeader set X-Forwarded-Proto "https" +``` + +## Configuring the application root + +*Please be advised that this feature is in BETA.* + +Superset supports running the application under a non-root path. The root path +prefix can be specified in one of three ways: + +- Customizing the [Flask entrypoint](https://github.com/apache/superset/blob/master/superset/app.py#L29) + by passing the `superset_app_root` variable; or +- Setting the `SUPERSET_APP_ROOT` environment variable to the desired prefix; or +- Setting the `APPLICATION_ROOT` config in your `superset_config.py` file. + +Note, the prefix should start with a `/`. + +### Customizing the Flask entrypoint + +To configure a prefix, e.g `/analytics`, pass the `superset_app_root` argument to +`create_app` when calling flask run either through the `FLASK_APP` +environment variable: + +```sh +FLASK_APP="superset:create_app(superset_app_root='/analytics')" +``` + +or as part of the `--app` argument to `flask run`: + +```sh +flask --app "superset.app:create_app(superset_app_root='/analytics')" +``` + +### Docker builds + +The [docker compose](/admin-docs/installation/docker-compose#configuring-further) developer +configuration includes an additional environmental variable, +[`SUPERSET_APP_ROOT`](https://github.com/apache/superset/blob/master/docker/.env), +to simplify the process of setting up a non-default root path across the services. + +In `docker/.env-local` set `SUPERSET_APP_ROOT` to the desired prefix and then bring the +services up with `docker compose up --detach`. + +## Custom OAuth2 Configuration + +Superset is built on Flask-AppBuilder (FAB), which supports many providers out of the box +(GitHub, Twitter, LinkedIn, Google, Azure, etc). Beyond those, Superset can be configured to connect +with other OAuth2 Authorization Server implementations that support “code” authorization. + +Make sure the pip package [`Authlib`](https://authlib.org/) is installed on the webserver. + +First, configure authorization in Superset `superset_config.py`. + +```python +from flask_appbuilder.security.manager import AUTH_OAUTH + +# Set the authentication type to OAuth +AUTH_TYPE = AUTH_OAUTH + +OAUTH_PROVIDERS = [ + { 'name':'egaSSO', + 'token_key':'access_token', # Name of the token in the response of access_token_url + 'icon':'fa-address-card', # Icon for the provider + 'remote_app': { + 'client_id':'myClientId', # Client Id (Identify Superset application) + 'client_secret':'MySecret', # Secret for this Client Id (Identify Superset application) + 'client_kwargs':{ + 'scope': 'read' # Scope for the Authorization + }, + 'access_token_method':'POST', # HTTP Method to call access_token_url + 'access_token_params':{ # Additional parameters for calls to access_token_url + 'client_id':'myClientId' + }, + 'jwks_uri':'https://myAuthorizationServe/adfs/discovery/keys', # may be required to generate token + 'access_token_headers':{ # Additional headers for calls to access_token_url + 'Authorization': 'Basic Base64EncodedClientIdAndSecret' + }, + 'api_base_url':'https://myAuthorizationServer/oauth2AuthorizationServer/', + 'access_token_url':'https://myAuthorizationServer/oauth2AuthorizationServer/token', + 'authorize_url':'https://myAuthorizationServer/oauth2AuthorizationServer/authorize' + } + } +] + +# Will allow user self registration, allowing to create Flask users from Authorized User +AUTH_USER_REGISTRATION = True + +# The default user self registration role +AUTH_USER_REGISTRATION_ROLE = "Public" +``` + +In case you want to assign the `Admin` role on new user registration, it can be assigned as follows: +```python +AUTH_USER_REGISTRATION_ROLE = "Admin" +``` +If you encounter the [issue](https://github.com/apache/superset/issues/13243) of not being able to list users from the Superset main page settings, although a newly registered user has an `Admin` role, please re-run `superset init` to sync the required permissions. Below is the command to re-run `superset init` using docker compose. +``` +docker-compose exec superset superset init +``` + +Then, create a `CustomSsoSecurityManager` that extends `SupersetSecurityManager` and overrides +`oauth_user_info`: + +```python +import logging +from superset.security import SupersetSecurityManager + +class CustomSsoSecurityManager(SupersetSecurityManager): + + def oauth_user_info(self, provider, response=None): + logging.debug("Oauth2 provider: {0}.".format(provider)) + if provider == 'egaSSO': + # As example, this line request a GET to base_url + '/' + userDetails with Bearer Authentication, + # and expects that authorization server checks the token, and response with user details + me = self.appbuilder.sm.oauth_remotes[provider].get('userDetails').data + logging.debug("user_data: {0}".format(me)) + return { 'name' : me['name'], 'email' : me['email'], 'id' : me['user_name'], 'username' : me['user_name'], 'first_name':'', 'last_name':''} + ... +``` + +This file must be located in the same directory as `superset_config.py` with the name +`custom_sso_security_manager.py`. Finally, add the following 2 lines to `superset_config.py`: + +``` +from custom_sso_security_manager import CustomSsoSecurityManager +CUSTOM_SECURITY_MANAGER = CustomSsoSecurityManager +``` + +**Notes** + +- The redirect URL will be `https:///oauth-authorized/` + When configuring an OAuth2 authorization provider if needed. For instance, the redirect URL will + be `https:///oauth-authorized/egaSSO` for the above configuration. + +- If an OAuth2 authorization server supports OpenID Connect 1.0, you could configure its configuration + document URL only without providing `api_base_url`, `access_token_url`, `authorize_url` and other + required options like user info endpoint, jwks uri etc. For instance: + + ```python + OAUTH_PROVIDERS = [ + { 'name':'egaSSO', + 'token_key':'access_token', # Name of the token in the response of access_token_url + 'icon':'fa-address-card', # Icon for the provider + 'remote_app': { + 'client_id':'myClientId', # Client Id (Identify Superset application) + 'client_secret':'MySecret', # Secret for this Client Id (Identify Superset application) + 'server_metadata_url': 'https://myAuthorizationServer/.well-known/openid-configuration' + } + } + ] + ``` + +### PKCE Support + +For public OAuth2 clients that cannot securely store a client secret, enable Proof Key for Code Exchange (PKCE) by adding `code_challenge_method` to the `remote_app` configuration: + +```python +OAUTH_PROVIDERS = [ + { + 'name': 'myProvider', + 'remote_app': { + 'client_id': 'myClientId', + 'client_secret': 'mySecret', # may be empty for pure public clients + 'code_challenge_method': 'S256', # enables PKCE + 'server_metadata_url': 'https://myAuthorizationServer/.well-known/openid-configuration' + } + } +] +``` + +PKCE (`S256`) is recommended for all OAuth2 flows, even when a client secret is present, as it protects against authorization code interception attacks. + +## LDAP Authentication + +FAB supports authenticating user credentials against an LDAP server. +To use LDAP you must install the [python-ldap](https://www.python-ldap.org/en/latest/installing.html) package. +See [FAB's LDAP documentation](https://flask-appbuilder.readthedocs.io/en/latest/security.html#authentication-ldap) +for details. + +## Mapping LDAP or OAUTH groups to Superset roles + +AUTH_ROLES_MAPPING in Flask-AppBuilder is a dictionary that maps from LDAP/OAUTH group names to FAB roles. +It is used to assign roles to users who authenticate using LDAP or OAuth. + +### Mapping OAUTH groups to Superset roles + +The following `AUTH_ROLES_MAPPING` dictionary would map the OAUTH group "superset_users" to the Superset roles "Gamma" as well as "Alpha", and the OAUTH group "superset_admins" to the Superset role "Admin". + +```python +AUTH_ROLES_MAPPING = { +"superset_users": ["Gamma","Alpha"], +"superset_admins": ["Admin"], +} +``` + +### Mapping LDAP groups to Superset roles + +The following `AUTH_ROLES_MAPPING` dictionary would map the LDAP DN "cn=superset_users,ou=groups,dc=example,dc=com" to the Superset roles "Gamma" as well as "Alpha", and the LDAP DN "cn=superset_admins,ou=groups,dc=example,dc=com" to the Superset role "Admin". + +```python +AUTH_ROLES_MAPPING = { +"cn=superset_users,ou=groups,dc=example,dc=com": ["Gamma","Alpha"], +"cn=superset_admins,ou=groups,dc=example,dc=com": ["Admin"], +} +``` + +Note: This requires `AUTH_LDAP_SEARCH` to be set. For more details, please see the [FAB Security documentation](https://flask-appbuilder.readthedocs.io/en/latest/security.html). + +### Syncing roles at login + +You can also use the `AUTH_ROLES_SYNC_AT_LOGIN` configuration variable to control how often Flask-AppBuilder syncs the user's roles with the LDAP/OAUTH groups. If `AUTH_ROLES_SYNC_AT_LOGIN` is set to True, Flask-AppBuilder will sync the user's roles each time they log in. If `AUTH_ROLES_SYNC_AT_LOGIN` is set to False, Flask-AppBuilder will only sync the user's roles when they first register. + +## Flask app Configuration Hook + +`FLASK_APP_MUTATOR` is a configuration function that can be provided in your environment, receives +the app object and can alter it in any way. For example, add `FLASK_APP_MUTATOR` into your +`superset_config.py` to setup session cookie expiration time to 24 hours: + +```python +from flask import session +from flask import Flask + + +def make_session_permanent(): + ''' + Enable maxAge for the cookie 'session' + ''' + session.permanent = True + +# Set up max age of session to 24 hours +PERMANENT_SESSION_LIFETIME = timedelta(hours=24) +def FLASK_APP_MUTATOR(app: Flask) -> None: + app.before_request_funcs.setdefault(None, []).append(make_session_permanent) +``` + +## Feature Flags + +To support a diverse set of users, Superset has some features that are not enabled by default. For +example, some users have stronger security restrictions, while some others may not. So Superset +allows users to enable or disable some features by config. For feature owners, you can add optional +functionalities in Superset, but will be only affected by a subset of users. + +You can enable or disable features with flag from `superset_config.py`: + +```python +FEATURE_FLAGS = { + 'PRESTO_EXPAND_DATA': False, +} +``` + +A current list of feature flags can be found in the [Feature Flags](/admin-docs/configuration/feature-flags) documentation. + +:::resources +- [Blog: Feature Flags in Apache Superset](https://preset.io/blog/feature-flags-in-apache-superset-and-preset/) +::: diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/country-map-tools.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/country-map-tools.mdx new file mode 100644 index 00000000000..fb1a04fd880 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/country-map-tools.mdx @@ -0,0 +1,40 @@ +--- +title: Country Map Tools +sidebar_position: 10 +version: 1 +--- + +import countriesData from '../../../data/countries.json'; + +# The Country Map Visualization + +The Country Map visualization allows you to plot lightweight choropleth maps of +your countries by province, states, or other subdivision types. It does not rely +on any third-party map services but would require you to provide the +[ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) codes of your country's +top-level subdivisions. Comparing to a province or state's full names, the ISO +code is less ambiguous and is unique to all regions in the world. + +## Included Maps + +The current list of countries can be found in the src +[legacy-plugin-chart-country-map/src/countries.ts](https://github.com/apache/superset/blob/master/superset-frontend/plugins/legacy-plugin-chart-country-map/src/countries.ts) + +The Country Maps visualization already ships with the maps for the following countries: + +
    +{countriesData.countries.map((country, index) => ( +
  • {country}
    • +))} +
+ +## Adding a New Country + +To add a new country to the list, you'd have to edit files in +[@superset-ui/legacy-plugin-chart-country-map](https://github.com/apache/superset/tree/master/superset-frontend/plugins/legacy-plugin-chart-country-map). + +1. Generate a new GeoJSON file for your country following the guide in [this Jupyter notebook](https://github.com/apache/superset/blob/master/superset-frontend/plugins/legacy-plugin-chart-country-map/scripts/Country%20Map%20GeoJSON%20Generator.ipynb). +2. Edit the countries list in [legacy-plugin-chart-country-map/src/countries.ts](https://github.com/apache/superset/blob/master/superset-frontend/plugins/legacy-plugin-chart-country-map/src/countries.ts). +3. Install superset-frontend dependencies: `cd superset-frontend && npm install` +4. Verify your countries in Superset plugins storybook: `npm run plugins:storybook`. +5. Build and install Superset from source code. diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/event-logging.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/event-logging.mdx new file mode 100644 index 00000000000..ceb751af650 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/event-logging.mdx @@ -0,0 +1,62 @@ +--- +title: Event Logging +sidebar_position: 9 +version: 1 +--- + +# Logging + +## Event Logging + +Superset by default logs special action events in its internal database (DBEventLogger). These logs can be accessed +on the UI by navigating to **Security > Action Log**. You can freely customize these logs by +implementing your own event log class. +**When custom log class is enabled DBEventLogger is disabled and logs +stop being populated in UI logs view.** +To achieve both, custom log class should extend built-in DBEventLogger log class. + +Here's an example of a simple JSON-to-stdout class: + +```python + def log(self, user_id, action, *args, **kwargs): + records = kwargs.get('records', list()) + dashboard_id = kwargs.get('dashboard_id') + slice_id = kwargs.get('slice_id') + duration_ms = kwargs.get('duration_ms') + referrer = kwargs.get('referrer') + + for record in records: + log = dict( + action=action, + json=record, + dashboard_id=dashboard_id, + slice_id=slice_id, + duration_ms=duration_ms, + referrer=referrer, + user_id=user_id + ) + print(json.dumps(log)) +``` + +End by updating your config to pass in an instance of the logger you want to use: + +``` +EVENT_LOGGER = JSONStdOutEventLogger() +``` + +## StatsD Logging + +Superset can be configured to log events to [StatsD](https://github.com/statsd/statsd) +if desired. Most endpoints hit are logged as +well as key events like query start and end in SQL Lab. + +To setup StatsD logging, it’s a matter of configuring the logger in your `superset_config.py`. +If not already present, you need to ensure that the `statsd`-package is installed in Superset's python environment. + +```python +from superset.stats_logger import StatsdStatsLogger +STATS_LOGGER = StatsdStatsLogger(host='localhost', port=8125, prefix='superset') +``` + +Note that it’s also possible to implement your own logger by deriving +`superset.stats_logger.BaseStatsLogger`. diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/feature-flags.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/feature-flags.mdx new file mode 100644 index 00000000000..b573b07d326 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/feature-flags.mdx @@ -0,0 +1,107 @@ +--- +title: Feature Flags +hide_title: true +sidebar_position: 2 +version: 1 +--- + +import featureFlags from '@site/static/feature-flags.json'; + +export const FlagTable = ({flags}) => ( + + + + + + + + + + {flags.map((flag) => ( + + + + + + ))} + +
FlagDefaultDescription
{flag.name}{flag.default ? 'True' : 'False'} + {flag.description} + {flag.docs && ( + <> (docs) + )} +
+); + +# Feature Flags + +Superset uses feature flags to control the availability of features. Feature flags allow +gradual rollout of new functionality and provide a way to enable experimental features. + +To enable a feature flag, add it to your `superset_config.py`: + +```python +FEATURE_FLAGS = { + "ENABLE_TEMPLATE_PROCESSING": True, +} +``` + +## Lifecycle + +Feature flags progress through lifecycle stages: + +| Stage | Description | +|-------|-------------| +| **Development** | Experimental features under active development. May be incomplete or unstable. | +| **Testing** | Feature complete but undergoing testing. Usable but may contain bugs. | +| **Stable** | Production-ready features. Safe for all deployments. | +| **Deprecated** | Features scheduled for removal. Migrate away from these. | + +--- + +## Development + +These features are experimental and under active development. Use only in development environments. + + + +--- + +## Testing + +These features are complete but still being tested. They are usable but may have bugs. + + + +--- + +## Stable + +These features are production-ready and safe to enable. + + + +--- + +## Deprecated + +These features are scheduled for removal. Plan to migrate away from them. + + + +--- + +## Adding New Feature Flags + +When adding a new feature flag to `superset/config.py`, include the following annotations: + +```python +# Description of what the feature does +# @lifecycle: development | testing | stable | deprecated +# @docs: https://superset.apache.org/docs/... (optional) +# @category: runtime_config | path_to_deprecation (optional, for stable flags) +"MY_NEW_FEATURE": False, +``` + +This documentation is auto-generated from the annotations in +[config.py](https://github.com/apache/superset/blob/master/superset/config.py). diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/importing-exporting-datasources.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/importing-exporting-datasources.mdx new file mode 100644 index 00000000000..6fc7ceea9ff --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/importing-exporting-datasources.mdx @@ -0,0 +1,157 @@ +--- +title: Importing and Exporting Datasources +hide_title: true +sidebar_position: 11 +version: 1 +--- + +# Importing and Exporting Datasources + +The superset cli allows you to import and export datasources from and to YAML. Datasources include +databases. The data is expected to be organized in the following hierarchy: + +:::info +Superset's ZIP-based import/export also covers **dashboards**, **charts**, and **saved queries**, exercised through the UI and REST API. The [Dashboard Import Overwrite Behavior](#dashboard-import-overwrite-behavior) and [UUIDs in API Responses](#uuids-in-api-responses) sections below document the behavior shared across all asset types. +::: + +```text +├──databases +| ├──database_1 +| | ├──table_1 +| | | ├──columns +| | | | ├──column_1 +| | | | ├──column_2 +| | | | └──... (more columns) +| | | └──metrics +| | | ├──metric_1 +| | | ├──metric_2 +| | | └──... (more metrics) +| | └── ... (more tables) +| └── ... (more databases) +``` + +:::note +When you export a database connection, the `masked_encrypted_extra` field (used for sensitive connection parameters such as service account JSON, OAuth tokens, and other encrypted credentials) is included in the export. When importing on another instance, these values are decrypted and re-encrypted using the destination instance's `SECRET_KEY`. Ensure the receiving instance has a valid `SECRET_KEY` configured before importing. +::: + +## Exporting Datasources to YAML + +You can print your current datasources to stdout by running: + +```bash +superset export_datasources +``` + +To save your datasources to a ZIP file run: + +```bash +superset export_datasources -f +``` + +By default, default (null) values will be omitted. Use the -d flag to include them. If you want back +references to be included (e.g. a column to include the table id it belongs to) use the -b flag. + +Alternatively, you can export datasources using the UI: + +1. Open **Sources -> Databases** to export all tables associated to a single or multiple databases. + (**Tables** for one or more tables) +2. Select the items you would like to export. +3. Click **Actions -> Export** to YAML +4. If you want to import an item that you exported through the UI, you will need to nest it inside + its parent element, e.g. a database needs to be nested under databases a table needs to be nested + inside a database element. + +In order to obtain an **exhaustive list of all fields** you can import using the YAML import run: + +```bash +superset export_datasource_schema +``` + +As a reminder, you can use the `-b` flag to include back references. + +## Importing Datasources + +In order to import datasources from a ZIP file, run: + +```bash +superset import_datasources -p +``` + +The optional username flag **-u** sets the user used for the datasource import. The default is 'admin'. Example: + +```bash +superset import_datasources -p -u 'admin' +``` + +## Dashboard Import Overwrite Behavior + +When importing a dashboard ZIP with the **overwrite** option enabled, any existing charts that are part of the dashboard are **replaced** rather than duplicated. This applies to: + +- Charts whose UUID matches a chart already present in the target instance +- The full chart configuration (query, visualization type, columns, metrics) is replaced by the imported version + +If you import without the overwrite flag, existing charts with conflicting UUIDs are left unchanged and the import skips those objects. Use overwrite when you want to push a fully updated dashboard (including chart definitions) from a development or staging environment to production. + +## UUIDs in API Responses + +The REST API POST endpoints for **datasets**, **charts**, and **dashboards** include the auto-generated `uuid` field in the response body: + +```json +{ + "id": 42, + "uuid": "b8a8d5c3-1234-4abc-8def-0123456789ab", + ... +} +``` + +UUIDs remain stable across import/export cycles and can be used for cross-environment workflows — for example, recording a UUID when creating a chart in development and using it to identify the matching chart after importing into production. + +## Legacy Importing Datasources + +### From older versions of Superset to current version + +When using Superset version 4.x.x to import from an older version (2.x.x or 3.x.x) importing is supported as the command `legacy_import_datasources` and expects a JSON or directory of JSONs. The options are `-r` for recursive and `-u` for specifying a user. Example of legacy import without options: + +```bash +superset legacy_import_datasources -p +``` + +### From older versions of Superset to older versions + +When using an older Superset version (2.x.x & 3.x.x) of Superset, the command is `import_datasources`. ZIP and YAML files are supported and to switch between them the feature flag `VERSIONED_EXPORT` is used. When `VERSIONED_EXPORT` is `True`, `import_datasources` expects a ZIP file, otherwise YAML. Example: + +```bash +superset import_datasources -p +``` + +When `VERSIONED_EXPORT` is `False`, if you supply a path all files ending with **yaml** or **yml** will be parsed. You can apply +additional flags (e.g. to search the supplied path recursively): + +```bash +superset import_datasources -p -r +``` + +The sync flag **-s** takes parameters in order to sync the supplied elements with your file. Be +careful this can delete the contents of your meta database. Example: + +```bash +superset import_datasources -p -s columns,metrics +``` + +This will sync all metrics and columns for all datasources found in the `` in the +Superset meta database. This means columns and metrics not specified in YAML will be deleted. If you +would add tables to columns,metrics those would be synchronised as well. + +If you don’t supply the sync flag (**-s**) importing will only add and update (override) fields. +E.g. you can add a verbose_name to the column ds in the table random_time_series from the example +datasets by saving the following YAML to file and then running the **import_datasources** command. + +```yaml +databases: +- database_name: main + tables: + - table_name: random_time_series + columns: + - column_name: ds + verbose_name: datetime +``` diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/map-tiles.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/map-tiles.mdx new file mode 100644 index 00000000000..e83608c38bb --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/map-tiles.mdx @@ -0,0 +1,78 @@ +--- +title: Map Tiles +sidebar_position: 12 +version: 1 +--- + +# Map tiles + +Superset uses OSM and Mapbox tiles by default. OSM is free but you still need setting your MAPBOX_API_KEY if you want to use mapbox maps. + +## Setting map tiles + +Map tiles can be set with `DECKGL_BASE_MAP` in your `superset_config.py` or `superset_config_docker.py` +For adding your own map tiles, you can use the following format. + +```python +DECKGL_BASE_MAP = [ + ['tile://https://your_personal_url/{z}/{x}/{y}.png', 'MyTile'] +] +``` +Openstreetmap tiles url can be added without prefix. +```python +DECKGL_BASE_MAP = [ + ['https://c.tile.openstreetmap.org/{z}/{x}/{y}.png', 'OpenStreetMap'] +] +``` + +Default values are: +```python +DECKGL_BASE_MAP = [ + ['https://tile.openstreetmap.org/{z}/{x}/{y}.png', 'Streets (OSM)'], + ['https://tile.osm.ch/osm-swiss-style/{z}/{x}/{y}.png', 'Topography (OSM)'], + ['mapbox://styles/mapbox/streets-v9', 'Streets'], + ['mapbox://styles/mapbox/dark-v9', 'Dark'], + ['mapbox://styles/mapbox/light-v9', 'Light'], + ['mapbox://styles/mapbox/satellite-streets-v9', 'Satellite Streets'], + ['mapbox://styles/mapbox/satellite-v9', 'Satellite'], + ['mapbox://styles/mapbox/outdoors-v9', 'Outdoors'], +] +``` + +It is possible to set only mapbox by removing osm tiles and other way around. + +:::warning +Setting `DECKGL_BASE_MAP` overwrite default values +::: + +After defining your map tiles, set them in these variables: +- `CORS_OPTIONS` +- `connect-src` of `TALISMAN_CONFIG` and `TALISMAN_CONFIG_DEV` variables. + +```python +ENABLE_CORS = True +CORS_OPTIONS: dict[Any, Any] = { + "origins": [ + "https://tile.openstreetmap.org", + "https://tile.osm.ch", + "https://your_personal_url/{z}/{x}/{y}.png", + ] +} + +. +. + +TALISMAN_CONFIG = { + "content_security_policy": { + ... + "connect-src": [ + "'self'", + "https://api.mapbox.com", + "https://events.mapbox.com", + "https://tile.openstreetmap.org", + "https://tile.osm.ch", + "https://your_personal_url/{z}/{x}/{y}.png", + ], + ... +} +``` diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/mcp-server.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/mcp-server.mdx new file mode 100644 index 00000000000..df299acaf8d --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/mcp-server.mdx @@ -0,0 +1,845 @@ +--- +title: MCP Server Deployment & Authentication +hide_title: true +sidebar_position: 14 +version: 1 +--- + + + +# MCP Server Deployment & Authentication + +Superset includes a built-in [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that lets AI assistants -- Claude, ChatGPT, and other MCP-compatible clients -- interact with your Superset instance. Through MCP, clients can list dashboards, query datasets, execute SQL, create charts, and more. + +This guide covers how to run, secure, and deploy the MCP server. + +:::tip Looking for user docs? +See **[Using AI with Superset](/user-docs/using-superset/using-ai-with-superset)** for a guide on what AI can do with Superset and how to connect your AI client. +::: + +```mermaid +flowchart LR + A["AI Client
(Claude, ChatGPT, etc.)"] -- "MCP protocol
(HTTP + JSON-RPC)" --> B["MCP Server
(:5008/mcp)"] + B -- "Superset context
(app, db, RBAC)" --> C["Superset
(:8088)"] + C --> D[("Database
(Postgres)")] +``` + +--- + +## Quick Start + +Get the MCP server running locally and connect an AI client in three steps. + +### 1. Start the MCP server + +The MCP server runs as a separate process alongside Superset: + +```bash +superset mcp run --host 127.0.0.1 --port 5008 +``` + +| Flag | Default | Description | +|------|---------|-------------| +| `--host` | `127.0.0.1` | Host to bind to | +| `--port` | `5008` | Port to bind to | +| `--debug` | off | Enable debug logging | + +The endpoint is available at `http://:/mcp`. + +### 2. Set a development user + +For local development, tell the MCP server which Superset user to impersonate (the user must already exist in your database): + +```python +# superset_config.py +MCP_DEV_USERNAME = "admin" +``` + +### 3. Connect an AI client + +Point your MCP client at the server. For **Claude Desktop**, edit the config file: + +- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json` +- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json` +- **Linux**: `~/.config/Claude/claude_desktop_config.json` + +```json +{ + "mcpServers": { + "superset": { + "url": "http://localhost:5008/mcp" + } + } +} +``` + +Restart Claude Desktop. The hammer icon in the chat bar confirms the connection. + +See [Connecting AI Clients](#connecting-ai-clients) for Claude Code, Claude Web, ChatGPT, and raw HTTP examples. + +--- + +## Prerequisites + +- Apache Superset 5.0+ running and accessible +- Python 3.10+ +- The `fastmcp` package (`pip install fastmcp`) + +--- + +## Authentication + +The MCP server supports multiple authentication methods depending on your deployment scenario. + +```mermaid +flowchart TD + R["Incoming MCP Request"] --> F{"MCP_AUTH_FACTORY
set?"} + F -- Yes --> CF["Custom Auth Provider"] + F -- No --> AE{"MCP_AUTH_ENABLED?"} + AE -- "True" --> JWT["JWT Validation"] + AE -- "False" --> DU["Dev Mode
(MCP_DEV_USERNAME)"] + + JWT --> ALG{"MCP_JWT_ALGORITHM"} + ALG -- "RS256 + JWKS" --> JWKS["Fetch keys from
MCP_JWKS_URI"] + ALG -- "RS256 + static" --> PK["Use
MCP_JWT_PUBLIC_KEY"] + ALG -- "HS256" --> SEC["Use
MCP_JWT_SECRET"] + + JWKS --> V["Validate token
(exp, iss, aud, scopes)"] + PK --> V + SEC --> V + V --> UR["Resolve Superset user
from token claims"] + UR --> OK["Authenticated request"] + CF --> OK + DU --> OK +``` + +### Development Mode (No Auth) + +Disable authentication and use a fixed user: + +```python +# superset_config.py +MCP_AUTH_ENABLED = False +MCP_DEV_USERNAME = "admin" +``` + +All operations run as the configured user. + +:::warning +Never use development mode in production. Always enable authentication for any internet-facing deployment. +::: + +### JWT Authentication + +For production, enable JWT-based authentication. The MCP server validates a Bearer token on every request. + +#### Option A: RS256 with JWKS endpoint + +The most common setup for OAuth 2.0 / OIDC providers that publish a JWKS (JSON Web Key Set) endpoint: + +```python +# superset_config.py +MCP_AUTH_ENABLED = True +MCP_JWT_ALGORITHM = "RS256" +MCP_JWKS_URI = "https://your-identity-provider.com/.well-known/jwks.json" +MCP_JWT_ISSUER = "https://your-identity-provider.com/" +MCP_JWT_AUDIENCE = "your-superset-instance" +``` + +#### Option B: RS256 with static public key + +Use this when you have a fixed RSA key pair (e.g., self-signed tokens): + +```python +# superset_config.py +MCP_AUTH_ENABLED = True +MCP_JWT_ALGORITHM = "RS256" +MCP_JWT_PUBLIC_KEY = """-----BEGIN PUBLIC KEY----- +MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA... +-----END PUBLIC KEY-----""" +MCP_JWT_ISSUER = "your-issuer" +MCP_JWT_AUDIENCE = "your-audience" +``` + +#### Option C: HS256 with shared secret + +Use this when both the token issuer and the MCP server share a symmetric secret: + +```python +# superset_config.py +MCP_AUTH_ENABLED = True +MCP_JWT_ALGORITHM = "HS256" +MCP_JWT_SECRET = "your-shared-secret-key" +MCP_JWT_ISSUER = "your-issuer" +MCP_JWT_AUDIENCE = "your-audience" +``` + +:::warning +Store `MCP_JWT_SECRET` securely. Never commit it to version control. Use environment variables: +```python +import os +MCP_JWT_SECRET = os.environ.get("MCP_JWT_SECRET") +``` +::: + +#### JWT claims + +The MCP server validates these standard claims: + +| Claim | Config Key | Description | +|-------|-----------|-------------| +| `exp` | -- | Expiration time (always validated) | +| `iss` | `MCP_JWT_ISSUER` | Token issuer (optional but recommended) | +| `aud` | `MCP_JWT_AUDIENCE` | Token audience (optional but recommended) | +| `sub` | -- | Subject -- primary claim used to resolve the Superset user | + +#### User resolution + +After validating the token, the MCP server resolves a Superset username from the claims. It checks these in order, using the first non-empty value: + +1. `subject` -- the standard `sub` claim (via the access token object) +2. `client_id` -- for machine-to-machine tokens +3. `payload["sub"]` -- fallback to raw payload +4. `payload["email"]` -- email-based lookup +5. `payload["username"]` -- explicit username claim + +The resolved value must match a `username` in the Superset `ab_user` table. + +#### Scoped access + +Require specific scopes in the JWT to limit what MCP operations a token can perform: + +```python +# superset_config.py +MCP_REQUIRED_SCOPES = ["mcp:read", "mcp:write"] +``` + +Only tokens that include **all** required scopes are accepted. + +### Custom Auth Provider + +For advanced scenarios (e.g., a proprietary auth system), provide a factory function. This takes precedence over all built-in JWT configuration: + +```python +# superset_config.py +def my_custom_auth_factory(app): + """Return a FastMCP auth provider instance.""" + from fastmcp.server.auth.providers.jwt import JWTVerifier + return JWTVerifier( + jwks_uri="https://my-auth.example.com/.well-known/jwks.json", + issuer="https://my-auth.example.com/", + audience="superset-mcp", + ) + +MCP_AUTH_FACTORY = my_custom_auth_factory +``` + +--- + +## Connecting AI Clients + +### Claude Desktop + +**Local development (no auth):** + +```json +{ + "mcpServers": { + "superset": { + "url": "http://localhost:5008/mcp" + } + } +} +``` + +**With JWT authentication:** + +```json +{ + "mcpServers": { + "superset": { + "command": "npx", + "args": [ + "-y", + "mcp-remote@latest", + "http://your-superset-host:5008/mcp", + "--header", + "Authorization: Bearer YOUR_TOKEN" + ] + } + } +} +``` + +### Claude Code (CLI) + +Add to your project's `.mcp.json`: + +```json +{ + "mcpServers": { + "superset": { + "type": "url", + "url": "http://localhost:5008/mcp" + } + } +} +``` + +With authentication: + +```json +{ + "mcpServers": { + "superset": { + "type": "url", + "url": "http://localhost:5008/mcp", + "headers": { + "Authorization": "Bearer YOUR_TOKEN" + } + } + } +} +``` + +### Claude Web (claude.ai) + +1. Open [claude.ai](https://claude.ai) +2. Click the **+** button (or your profile icon) +3. Select **Connectors** +4. Click **Manage Connectors** > **Add custom connector** +5. Enter a name and your MCP URL (e.g., `https://your-superset-host/mcp`) +6. Click **Add** + +:::info +Custom connectors on Claude Web require a Pro, Max, Team, or Enterprise plan. +::: + +### ChatGPT + +1. Click your profile icon > **Settings** > **Apps and Connectors** +2. Enable **Developer Mode** in Advanced Settings +3. In the chat composer, press **+** > **Add sources** > **App** > **Connect more** > **Create app** +4. Enter a name and your MCP server URL +5. Click **I understand and continue** + +:::info +ChatGPT MCP connectors require a Pro, Team, Enterprise, or Edu plan. +::: + +### Direct HTTP requests + +Call the MCP server directly with any HTTP client: + +```bash +curl -X POST http://localhost:5008/mcp \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer YOUR_JWT_TOKEN' \ + -d '{"jsonrpc": "2.0", "method": "tools/list", "id": 1}' +``` + +--- + +## Deployment + +### Single Process + +The simplest setup: run the MCP server alongside Superset on the same host. + +```mermaid +flowchart TD + subgraph host["Host / VM"] + direction TB + S["Superset
:8088"] --> DB[("Postgres")] + M["MCP Server
:5008"] --> DB + end + C["AI Client"] -- "HTTPS" --> P["Reverse Proxy
(Nginx / Caddy)"] + U["Browser"] -- "HTTPS" --> P + P -- ":8088" --> S + P -- ":5008/mcp" --> M +``` + +**superset_config.py:** + +```python +MCP_SERVICE_HOST = "0.0.0.0" +MCP_SERVICE_PORT = 5008 +MCP_DEV_USERNAME = "admin" # or enable JWT auth + +# If behind a reverse proxy, set the public-facing URL so +# MCP-generated links (chart previews, SQL Lab URLs) resolve correctly: +MCP_SERVICE_URL = "https://superset.example.com" +``` + +**Start both processes:** + +```bash +# Terminal 1 -- Superset web server +superset run -h 0.0.0.0 -p 8088 + +# Terminal 2 -- MCP server +superset mcp run --host 0.0.0.0 --port 5008 +``` + +**Nginx reverse proxy with TLS:** + +```nginx +server { + listen 443 ssl; + server_name superset.example.com; + + ssl_certificate /path/to/cert.pem; + ssl_certificate_key /path/to/key.pem; + + # Superset web UI + location / { + proxy_pass http://127.0.0.1:8088; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + } + + # MCP endpoint + location /mcp { + proxy_pass http://127.0.0.1:5008/mcp; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header Authorization $http_authorization; + } +} +``` + +### Docker Compose + +Run Superset and the MCP server as separate containers sharing the same config: + +```yaml +# docker-compose.yml +services: + superset: + image: apache/superset:latest + ports: + - "8088:8088" + volumes: + - ./superset_config.py:/app/superset_config.py + environment: + - SUPERSET_CONFIG_PATH=/app/superset_config.py + + mcp: + image: apache/superset:latest + command: ["superset", "mcp", "run", "--host", "0.0.0.0", "--port", "5008"] + ports: + - "5008:5008" + volumes: + - ./superset_config.py:/app/superset_config.py + environment: + - SUPERSET_CONFIG_PATH=/app/superset_config.py + depends_on: + - superset +``` + +Both containers share the same `superset_config.py`, so authentication settings, database connections, and feature flags stay in sync. + +### Multi-Pod (Kubernetes) + +For high-availability deployments, configure Redis so that replicas share session state: + +```mermaid +flowchart TD + LB["Load Balancer"] --> M1["MCP Pod 1"] + LB --> M2["MCP Pod 2"] + LB --> M3["MCP Pod 3"] + M1 --> R[("Redis
(session store)")] + M2 --> R + M3 --> R + M1 --> DB[("Postgres")] + M2 --> DB + M3 --> DB +``` + +**superset_config.py:** + +```python +MCP_STORE_CONFIG = { + "enabled": True, + "CACHE_REDIS_URL": "redis://redis-host:6379/0", + "event_store_max_events": 100, + "event_store_ttl": 3600, +} +``` + +When `CACHE_REDIS_URL` is set, the MCP server uses a Redis-backed EventStore for session management, allowing replicas to share state. Without Redis, each pod manages its own in-memory sessions and stateful MCP interactions may fail when requests hit different replicas. + +--- + +## Configuration Reference + +All MCP settings go in `superset_config.py`. Defaults are defined in `superset/mcp_service/mcp_config.py`. + +### Core + +| Setting | Default | Description | +|---------|---------|-------------| +| `MCP_SERVICE_HOST` | `"localhost"` | Host the MCP server binds to | +| `MCP_SERVICE_PORT` | `5008` | Port the MCP server binds to | +| `MCP_SERVICE_URL` | `None` | Public base URL for MCP-generated links (set this when behind a reverse proxy) | +| `MCP_DEBUG` | `False` | Enable debug logging | +| `MCP_DEV_USERNAME` | -- | Superset username for development mode (no auth) | +| `MCP_RBAC_ENABLED` | `True` | Enforce Superset's role-based access control on MCP tool calls. When `True`, each tool checks that the authenticated user has the required FAB permission before executing. Disable only for testing or trusted-network deployments. | + +### Authentication + +| Setting | Default | Description | +|---------|---------|-------------| +| `MCP_AUTH_ENABLED` | `False` | Enable JWT authentication | +| `MCP_JWT_ALGORITHM` | `"RS256"` | JWT signing algorithm (`RS256` or `HS256`) | +| `MCP_JWKS_URI` | `None` | JWKS endpoint URL (RS256) | +| `MCP_JWT_PUBLIC_KEY` | `None` | Static RSA public key string (RS256) | +| `MCP_JWT_SECRET` | `None` | Shared secret string (HS256) | +| `MCP_JWT_ISSUER` | `None` | Expected `iss` claim | +| `MCP_JWT_AUDIENCE` | `None` | Expected `aud` claim | +| `MCP_REQUIRED_SCOPES` | `[]` | Required JWT scopes | +| `MCP_JWT_DEBUG_ERRORS` | `False` | Log detailed JWT errors server-side (never exposed in HTTP responses per RFC 6750) | +| `MCP_AUTH_FACTORY` | `None` | Custom auth provider factory `(flask_app) -> auth_provider`. Takes precedence over built-in JWT | +| `MCP_USER_RESOLVER` | `None` | Custom function `(app, access_token) -> username` to extract a Superset username from a validated JWT token. When `None`, the default resolver checks `preferred_username`, `username`, `email`, and `sub` claims in that order. | + +### Response Size Guard + +Limits response sizes to prevent exceeding LLM context windows: + +```python +MCP_RESPONSE_SIZE_CONFIG = { + "enabled": True, + "token_limit": 25000, + "warn_threshold_pct": 80, + "excluded_tools": [ + "health_check", + "get_chart_preview", + "generate_explore_link", + "open_sql_lab_with_context", + ], +} +``` + +| Key | Default | Description | +|-----|---------|-------------| +| `enabled` | `True` | Enable response size checking | +| `token_limit` | `25000` | Maximum estimated token count per response | +| `warn_threshold_pct` | `80` | Warn when response exceeds this percentage of the limit | +| `excluded_tools` | See above | Tools exempt from size checking (e.g., tools that return URLs, not data) | + +### Caching + +Optional response caching for read-heavy workloads. Requires Redis when used with multiple replicas. + +```python +MCP_CACHE_CONFIG = { + "enabled": False, + "CACHE_KEY_PREFIX": None, + "list_tools_ttl": 300, # 5 min + "list_resources_ttl": 300, + "list_prompts_ttl": 300, + "read_resource_ttl": 3600, # 1 hour + "get_prompt_ttl": 3600, + "call_tool_ttl": 3600, + "max_item_size": 1048576, # 1 MB + "excluded_tools": [ + "execute_sql", + "generate_dashboard", + "generate_chart", + "update_chart", + ], +} +``` + +| Key | Default | Description | +|-----|---------|-------------| +| `enabled` | `False` | Enable response caching | +| `CACHE_KEY_PREFIX` | `None` | Optional prefix for cache keys (useful for shared Redis) | +| `list_tools_ttl` | `300` | Cache TTL in seconds for `tools/list` | +| `list_resources_ttl` | `300` | Cache TTL for `resources/list` | +| `list_prompts_ttl` | `300` | Cache TTL for `prompts/list` | +| `read_resource_ttl` | `3600` | Cache TTL for `resources/read` | +| `get_prompt_ttl` | `3600` | Cache TTL for `prompts/get` | +| `call_tool_ttl` | `3600` | Cache TTL for `tools/call` | +| `max_item_size` | `1048576` | Maximum cached item size in bytes (1 MB) | +| `excluded_tools` | See above | Tools that are never cached (mutating or non-deterministic) | + +### Redis Store (Multi-Pod) + +Enables Redis-backed session and event storage for multi-replica deployments: + +```python +MCP_STORE_CONFIG = { + "enabled": False, + "CACHE_REDIS_URL": None, + "event_store_max_events": 100, + "event_store_ttl": 3600, +} +``` + +| Key | Default | Description | +|-----|---------|-------------| +| `enabled` | `False` | Enable Redis-backed store | +| `CACHE_REDIS_URL` | `None` | Redis connection URL (e.g., `redis://redis-host:6379/0`) | +| `event_store_max_events` | `100` | Maximum events retained per session | +| `event_store_ttl` | `3600` | Event TTL in seconds | + +### Tool Search + +By default the MCP server exposes a lightweight tool-search interface instead of advertising every tool at once. This reduces the initial context sent to the LLM by ~70%, which lowers cost and latency. The AI client discovers tools on demand by calling `search_tools` and then invokes them via `call_tool`. + +```python +MCP_TOOL_SEARCH_CONFIG = { + "enabled": True, + "strategy": "bm25", # "bm25" (natural language) or "regex" + "max_results": 5, + "always_visible": [ # Tools always listed (pinned) + "health_check", + "get_instance_info", + ], + "search_tool_name": "search_tools", + "call_tool_name": "call_tool", + "include_schemas": False, # False=summary mode (name + parameters_hint) + "compact_schemas": True, # Strip $defs (only applies when include_schemas=True) + "max_description_length": 300, +} +``` + +| Key | Default | Description | +|-----|---------|-------------| +| `enabled` | `True` | Enable tool search. When `False`, all tools are listed upfront | +| `strategy` | `"bm25"` | Search ranking algorithm. `"bm25"` supports natural language; `"regex"` supports pattern matching | +| `max_results` | `5` | Maximum tools returned per search query | +| `always_visible` | See above | Tools that always appear in `list_tools`, regardless of search | +| `include_schemas` | `False` | When `False` (default, "summary mode"), search results omit `inputSchema` entirely and include a lightweight `parameters_hint` listing top-level parameter names. Set to `True` to include the full `inputSchema` in search results. Full schemas are always used when a tool is actually invoked via `call_tool`. | +| `compact_schemas` | `True` | Strip `$defs` / `$ref` and replace with `{"type": "object"}` in search results to reduce token cost. Only takes effect when `include_schemas=True` — ignored in summary mode. | +| `max_description_length` | `300` | Truncate tool descriptions in search results (0 = no truncation). Applies in both summary and full-schema modes. | + +:::tip +Set `enabled: False` to revert to the traditional "show all tools at once" behavior, which some clients or workflows may prefer. +::: + +Tool search reduces the initial token cost from ~15–20K tokens (full catalog) down to ~4–5K tokens (pinned tools + search interface) — roughly 85% savings at the start of each conversation. + +### Session & CSRF + +These values are flat-merged into the Flask app config used by the MCP server process: + +```python +MCP_SESSION_CONFIG = { + "SESSION_COOKIE_HTTPONLY": True, + "SESSION_COOKIE_SECURE": False, + "SESSION_COOKIE_SAMESITE": "Lax", + "SESSION_COOKIE_NAME": "superset_session", + "PERMANENT_SESSION_LIFETIME": 86400, +} + +MCP_CSRF_CONFIG = { + "WTF_CSRF_ENABLED": True, + "WTF_CSRF_TIME_LIMIT": None, +} +``` + +--- + +## Access Control + +### RBAC Enforcement + +The MCP server respects Superset's full role-based access control (RBAC). Every authenticated user can only access the data and operations their Superset roles permit — the same rules that apply in the Superset UI apply through MCP. + +Each tool declares one or more required FAB permissions. The table below maps tool groups to their permission requirements: + +| Tool group | Required FAB permission | +|------------|------------------------| +| `list_charts`, `get_chart_info`, `get_chart_data`, `get_chart_preview`, `generate_chart`, `update_chart` | `can_read` on `Chart` (read), `can_write` on `Chart` (mutate) | +| `list_dashboards`, `get_dashboard_info`, `generate_dashboard`, `add_chart_to_existing_dashboard` | `can_read` on `Dashboard` (read), `can_write` on `Dashboard` (mutate) | +| `list_datasets`, `get_dataset_info`, `create_virtual_dataset` | `can_read` on `Dataset` (read), `can_write` on `Dataset` (mutate) | +| `list_databases`, `get_database_info` | `can_read` on `Database` | +| `execute_sql` | `can_execute_sql_query` on `SQLLab` | +| `open_sql_lab_with_context` | `can_read` on `SQLLab` | +| `save_sql_query` | `can_write` on `SavedQuery` | +| `health_check` | None (public) | + +To disable RBAC checking globally (for trusted-network deployments or testing), set: + +```python +# superset_config.py +MCP_RBAC_ENABLED = False +``` + +:::warning +Disabling RBAC removes all permission checks from MCP tool calls. Only do this on isolated, internal deployments where all MCP users are trusted admins. +::: + +### Audit Log + +All MCP tool calls are recorded in Superset's action log. You can view them at **Settings → Action Log** (admin only). Each log entry records: + +- The tool name (e.g., `mcp.generate_chart.db_write`) +- The authenticated user +- A timestamp + +This makes MCP activity fully auditable alongside regular Superset activity. The action log uses the same event logger as the rest of Superset, so existing log ingestion pipelines (e.g., sending logs to Elasticsearch or a SIEM) capture MCP events automatically. + +### Middleware Pipeline + +Every MCP request passes through a middleware stack before reaching the tool function. The default stack (assembled in `build_middleware_list()` in `server.py`) is: + +| Middleware | Purpose | Default | +|------------|---------|---------| +| `StructuredContentStripperMiddleware` | Strips `structuredContent` from responses for Claude.ai bridge compatibility | Enabled | +| `LoggingMiddleware` | Logs each tool call with user, parameters, and duration | Enabled | +| `GlobalErrorHandlerMiddleware` | Catches unhandled exceptions and sanitizes sensitive data before it reaches the client | Enabled | +| `ResponseSizeGuardMiddleware` | Estimates token count, warns at 80% of limit, blocks at limit | Enabled (configurable via `MCP_RESPONSE_SIZE_CONFIG`) | +| `ResponseCachingMiddleware` | Caches read-heavy tool responses (in-memory or Redis) | Disabled (enable via `MCP_CACHE_CONFIG`) | + +Additional middleware classes (`RateLimitMiddleware`, `FieldPermissionsMiddleware`, `PrivateToolMiddleware`) are implemented in `superset/mcp_service/middleware.py` but are not added to the default pipeline. They are available for operators who want to layer them in via a custom startup path. + +### Error Sanitization + +The `GlobalErrorHandlerMiddleware` automatically redacts sensitive information from all error messages before they reach the LLM client. The following are replaced with generic messages: + +- **Database connection strings** — replaced with a generic connection error message +- **API keys and tokens** — redacted from error traces +- **File system paths** — stripped to prevent information disclosure +- **IP addresses** — removed from error context + +This ensures that a misconfigured database connection or an unexpected exception never leaks credentials or internal topology to the LLM or its users. All regex patterns used for redaction are bounded to prevent ReDoS attacks. + +--- + +## Performance + +### Connection Pooling + +Each MCP server process maintains its own SQLAlchemy connection pool to the database. For multi-worker deployments, total open connections = **workers × pool size**. + +```python +# superset_config.py +SQLALCHEMY_POOL_SIZE = 5 +SQLALCHEMY_MAX_OVERFLOW = 10 +SQLALCHEMY_POOL_TIMEOUT = 30 +SQLALCHEMY_POOL_RECYCLE = 3600 # Recycle connections after 1 hour +``` + +For a 3-pod Kubernetes deployment with the defaults above, expect up to 3 × (5 + 10) = 45 connections. Size your database's `max_connections` accordingly. + +### Response Caching + +Enable response caching for read-heavy workloads (dashboards/datasets that don't change frequently). With the in-memory backend (default when `MCP_STORE_CONFIG` is disabled), caching is per-process. Use Redis-backed caching for consistent cache hits across multiple pods: + +```python +MCP_CACHE_CONFIG = {"enabled": True, "call_tool_ttl": 3600} +MCP_STORE_CONFIG = {"enabled": True, "CACHE_REDIS_URL": "redis://redis:6379/0"} +``` + +Mutating tools (`generate_chart`, `update_chart`, `execute_sql`, `generate_dashboard`) are always excluded from caching regardless of this setting. + +--- + +## Troubleshooting + +### Server won't start + +- Verify `fastmcp` is installed: `pip install fastmcp` +- Check that `MCP_DEV_USERNAME` is set if auth is disabled -- the server requires a user identity +- Confirm the port is not already in use: `lsof -i :5008` + +### 401 Unauthorized + +- Verify your JWT token has not expired (`exp` claim) +- Check that `MCP_JWT_ISSUER` and `MCP_JWT_AUDIENCE` match the token's `iss` and `aud` claims exactly +- For RS256 with JWKS: confirm the JWKS URI is reachable from the MCP server +- For RS256 with static key: confirm the public key string includes the `BEGIN`/`END` markers +- For HS256: confirm the secret matches between the token issuer and `MCP_JWT_SECRET` +- Enable `MCP_JWT_DEBUG_ERRORS = True` for detailed server-side logging (errors are never leaked to the client) + +### Tool not found + +- Ensure the MCP server and Superset share the same `superset_config.py` +- Check server logs at startup -- tool registration errors are logged with the tool name and reason + +### Client can't connect + +- Verify the MCP server URL is reachable from the client machine +- For Claude Desktop: fully quit the app (not just close the window) and restart after config changes +- For remote access: ensure your firewall and reverse proxy allow traffic to the MCP port +- Confirm the URL path ends with `/mcp` (e.g., `http://localhost:5008/mcp`) + +### Permission errors on tool calls + +- The MCP server enforces Superset's RBAC permissions -- the authenticated user must have the required roles +- In development mode, ensure `MCP_DEV_USERNAME` maps to a user with appropriate roles (e.g., Admin) +- Check `superset/security/manager.py` for the specific permission tuples required by each tool domain (e.g., `("can_execute_sql_query", "SQLLab")`) + +### Response too large + +- If a tool call returns an error about exceeding token limits, the response size guard is blocking an oversized result +- Reduce `page_size` or `limit` parameters, use `select_columns` to exclude large fields, or add filters to narrow results +- To adjust the threshold, change `token_limit` in `MCP_RESPONSE_SIZE_CONFIG` +- To disable the guard entirely, set `MCP_RESPONSE_SIZE_CONFIG = {"enabled": False}` + +--- + +## Audit Events + +All MCP tool calls are logged to Superset's event logger, the same system used by the web UI (viewable at **Settings → Action Log**). Each event captures: + +- **Action**: `mcp..` (e.g., `mcp.list_databases.query`) +- **User**: the resolved Superset username from the JWT or dev config +- **Timestamp**: when the operation ran + +This means MCP activity is auditable alongside normal user activity. No additional configuration is required — logging is on by default whenever the event logger is enabled in your Superset deployment. + +## Tool Pagination + +MCP list tools (`list_datasets`, `list_charts`, `list_dashboards`, `list_databases`) use **offset pagination** via `page` (1-based) and `page_size` parameters. Responses include `page`, `page_size`, `total_count`, `total_pages`, `has_previous`, and `has_next`. To iterate through all results: + +```python +# Example: fetch all charts across pages +all_charts = [] +page = 1 +while True: + result = mcp.list_charts(page=page, page_size=50) + all_charts.extend(result["charts"]) + if not result.get("has_next"): + break + page += 1 +``` + +## Security Best Practices + +- **Use TLS** for all production MCP endpoints -- place the server behind a reverse proxy with HTTPS +- **Enable JWT authentication** for any internet-facing deployment +- **RBAC enforcement** -- The MCP server respects Superset's role-based access control. Users can only access data their roles permit +- **Secrets management** -- Store `MCP_JWT_SECRET`, database credentials, and API keys in environment variables or a secrets manager, never in config files committed to version control +- **Scoped tokens** -- Use `MCP_REQUIRED_SCOPES` to limit what operations a token can perform +- **Network isolation** -- In Kubernetes, restrict MCP pod network policies to only allow traffic from your AI client endpoints +- Review the **[Security documentation](/developer-docs/extensions/security)** for additional extension security guidance + +--- + +## Next Steps + +- **[Using AI with Superset](/user-docs/using-superset/using-ai-with-superset)** -- What AI can do with Superset and how to get started +- **[MCP Integration](/developer-docs/extensions/mcp)** -- Build custom MCP tools and prompts via Superset extensions +- **[Security](/developer-docs/extensions/security)** -- Security best practices for extensions +- **[Deployment](/developer-docs/extensions/deployment)** -- Package and deploy Superset extensions diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/networking-settings.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/networking-settings.mdx new file mode 100644 index 00000000000..b37d93bedcc --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/networking-settings.mdx @@ -0,0 +1,171 @@ +--- +title: Network and Security Settings +sidebar_position: 7 +version: 1 +--- + +# Network and Security Settings + +## CORS + + +:::note +In Superset versions prior to `5.x` you have to install to install `flask-cors` with `pip install flask-cors` to enable CORS support. +::: + + +The following keys in `superset_config.py` can be specified to configure CORS: + +- `ENABLE_CORS`: Must be set to `True` in order to enable CORS +- `CORS_OPTIONS`: options passed to Flask-CORS + ([documentation](https://flask-cors.readthedocs.io/en/latest/api.html#extension)) + +## HTTP headers + +Note that Superset bundles [flask-talisman](https://pypi.org/project/talisman/) +Self-described as a small Flask extension that handles setting HTTP headers that can help +protect against a few common web application security issues. + +## HTML Embedding of Dashboards and Charts + +There are two ways to embed a dashboard: Using the [SDK](https://www.npmjs.com/package/@superset-ui/embedded-sdk) or embedding a direct link. Note that in the latter case everybody who knows the link is able to access the dashboard. + +### Embedding a Public Direct Link to a Dashboard + +This works by first changing the content security policy (CSP) of [flask-talisman](https://github.com/GoogleCloudPlatform/flask-talisman) to allow for certain domains to display Superset content. Then a dashboard can be made publicly accessible, i.e. **bypassing authentication**. Once made public, the dashboard's URL can be added to an iframe in another website's HTML code. + +#### Changing flask-talisman CSP + +Add to `superset_config.py` the entire `TALISMAN_CONFIG` section from `config.py` and include a `frame-ancestors` section: + +```python +TALISMAN_ENABLED = True +TALISMAN_CONFIG = { + "content_security_policy": { + ... + "frame-ancestors": ["*.my-domain.com", "*.another-domain.com"], + ... +``` + +Restart Superset for this configuration change to take effect. + +#### Making a Dashboard Public + +There are two approaches to making dashboards publicly accessible: + +**Option 1: Dataset-based access (simpler)** +1. Set `PUBLIC_ROLE_LIKE = "Public"` in `superset_config.py` +2. Grant the Public role access to the relevant datasets (Menu → Security → List Roles → Public) +3. All published dashboards using those datasets become visible to anonymous users + +**Option 2: Dashboard-level access (selective control)** +1. Set `PUBLIC_ROLE_LIKE = "Public"` in `superset_config.py` +2. Add the `'DASHBOARD_RBAC': True` [Feature Flag](/admin-docs/configuration/feature-flags) +3. Edit each dashboard's properties and add the "Public" role +4. Only dashboards with the Public role explicitly assigned are visible to anonymous users + +See the [Public role documentation](/admin-docs/security/#public) for more details. + +#### Embedding a Public Dashboard + +Now anybody can directly access the dashboard's URL. You can embed it in an iframe like so: + +```html + +``` + +#### Embedding a Chart + +A chart's embed code can be generated by going to a chart's edit view and then clicking at the top right on `...` > `Share` > `Embed code` + +### Enabling Embedding via the SDK + +Clicking on `...` next to `EDIT DASHBOARD` on the top right of the dashboard's overview page should yield a drop-down menu including the entry "Embed dashboard". + +To enable this entry, add the following line to the `.env` file: + +```text +SUPERSET_FEATURE_EMBEDDED_SUPERSET=true +``` + +### Hiding the Logout Button in Embedded Contexts + +When Superset is embedded in an application that manages authentication via SSO (OAuth2, SAML, or JWT), the logout button should be hidden since session management is handled by the parent application. + +To hide the logout button in embedded contexts, add to `superset_config.py`: + +```python +FEATURE_FLAGS = { + "DISABLE_EMBEDDED_SUPERSET_LOGOUT": True, +} +``` + +This flag only hides the logout button when Superset detects it is running inside an iframe. Users accessing Superset directly (not embedded) will still see the logout button regardless of this setting. + +:::note +When embedding with SSO, also set `SESSION_COOKIE_SAMESITE = 'None'` and `SESSION_COOKIE_SECURE = True`. See [Security documentation](/admin-docs/security/securing_superset) for details. +::: + +## CSRF settings + +Similarly, [flask-wtf](https://flask-wtf.readthedocs.io/en/0.15.x/config/) is used to manage +some CSRF configurations. If you need to exempt endpoints from CSRF (e.g. if you are +running a custom auth postback endpoint), you can add the endpoints to `WTF_CSRF_EXEMPT_LIST`: + +## SSH Tunneling + +1. Turn on feature flag + - Change [`SSH_TUNNELING`](https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L489) to `True` + - If you want to add more security when establishing the tunnel we allow users to overwrite the `SSHTunnelManager` class [here](https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L507) + - You can also set the [`SSH_TUNNEL_LOCAL_BIND_ADDRESS`](https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L508) this the host address where the tunnel will be accessible on your VPC + +2. Create database w/ ssh tunnel enabled + - With the feature flag enabled you should now see ssh tunnel toggle. + - Click the toggle to enable SSH tunneling and add your credentials accordingly. + - Superset allows for two different types of authentication (Basic + Private Key). These credentials should come from your service provider. + +3. Verify data is flowing + - Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing. + +## Domain Sharding + +:::note +Domain Sharding is deprecated as of Superset 5.0.0, and will be removed in Superset 6.0.0. Please Enable HTTP2 to keep more open connections per domain. +::: + +Chrome allows up to 6 open connections per domain at a time. When there are more than 6 slices in +dashboard, a lot of time fetch requests are queued up and wait for next available socket. +[PR 5039](https://github.com/apache/superset/pull/5039) adds domain sharding to Superset, +and this feature will be enabled by configuration only (by default Superset doesn’t allow +cross-domain request). + +Add the following setting in your `superset_config.py` file: + +- `SUPERSET_WEBSERVER_DOMAINS`: list of allowed hostnames for domain sharding feature. + +Please create your domain shards as subdomains of your main domain for authorization to +work properly on new domains. For Example: + +- `SUPERSET_WEBSERVER_DOMAINS=['superset-1.mydomain.com','superset-2.mydomain.com','superset-3.mydomain.com','superset-4.mydomain.com']` + +or add the following setting in your `superset_config.py` file if domain shards are not subdomains of main domain. + +- `SESSION_COOKIE_DOMAIN = '.mydomain.com'` + +## Middleware + +Superset allows you to add your own middleware. To add your own middleware, update the +`ADDITIONAL_MIDDLEWARE` key in your `superset_config.py`. `ADDITIONAL_MIDDLEWARE` should be a list +of your additional middleware classes. + +For example, to use `AUTH_REMOTE_USER` from behind a proxy server like nginx, you have to add a +simple middleware class to add the value of `HTTP_X_PROXY_REMOTE_USER` (or any other custom header +from the proxy) to Gunicorn’s `REMOTE_USER` environment variable. diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/sql-templating.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/sql-templating.mdx new file mode 100644 index 00000000000..f2c21bcef79 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/sql-templating.mdx @@ -0,0 +1,629 @@ +--- +title: SQL Templating +hide_title: true +sidebar_position: 5 +version: 1 +--- + +# SQL Templating + +:::tip Looking to use SQL templating? +For a user-focused guide on writing Jinja templates in SQL Lab and virtual datasets, see the [SQL Templating User Guide](/user-docs/using-superset/sql-templating). This page covers administrator configuration options. +::: + +## Jinja Templates + +SQL Lab and Explore supports [Jinja templating](https://jinja.palletsprojects.com/en/2.11.x/) in queries. +To enable templating, the `ENABLE_TEMPLATE_PROCESSING` [feature flag](/admin-docs/configuration/configuring-superset#feature-flags) needs to be enabled in `superset_config.py`. + +:::warning[Security Warning] + +While powerful, this feature executes template code on the server. Within the Superset security model, this is **intended functionality**, as users with permissions to edit charts and virtual datasets are considered **trusted users**. + +If you grant these permissions to untrusted users, this feature can be exploited as a **Server-Side Template Injection (SSTI)** vulnerability. Do not enable `ENABLE_TEMPLATE_PROCESSING` unless you fully understand and accept the associated security risks. + +Additionally: + +- The `url_param()` macro allows URL parameters to influence the rendered SQL. Always validate or restrict `url_param()` values in your templates rather than interpolating them directly. +- `filter.get('val')` returns raw filter values without escaping. Use the safe helpers described below (`|where_in`, `| replace("'", "''")`) rather than concatenating values directly into SQL strings. + +::: + +:::tip +`ENABLE_TEMPLATE_PROCESSING` defaults to `False`. Only enable it if your deployment requires Jinja templates and all users with dataset/chart edit access are administrators or fully trusted internal users. +::: + +When templating is enabled, python code can be embedded in virtual datasets and +in Custom SQL in the filter and metric controls in Explore. By default, the following variables are +made available in the Jinja context: + +- `columns`: columns which to group by in the query +- `filter`: filters applied in the query +- `from_dttm`: start `datetime` value from the selected time range (`None` if undefined). **Note:** Only available in virtual datasets when a time range filter is applied in Explore/Chart views—not available in standalone SQL Lab queries. (deprecated beginning in version 5.0, use `get_time_filter` instead) +- `to_dttm`: end `datetime` value from the selected time range (`None` if undefined). **Note:** Only available in virtual datasets when a time range filter is applied in Explore/Chart views—not available in standalone SQL Lab queries. (deprecated beginning in version 5.0, use `get_time_filter` instead) +- `groupby`: columns which to group by in the query (deprecated) +- `metrics`: aggregate expressions in the query +- `row_limit`: row limit of the query +- `row_offset`: row offset of the query +- `table_columns`: columns available in the dataset +- `time_column`: temporal column of the query (`None` if undefined) +- `time_grain`: selected time grain (`None` if undefined) + +For example, to add a time range to a virtual dataset, you can write the following: + +```sql +SELECT * +FROM tbl +WHERE dttm_col > '{{ from_dttm }}' and dttm_col < '{{ to_dttm }}' +``` + +You can also use [Jinja's logic](https://jinja.palletsprojects.com/en/2.11.x/templates/#tests) +to make your query robust to clearing the timerange filter: + +```sql +SELECT * +FROM tbl +WHERE ( + {% if from_dttm is not none %} + dttm_col > '{{ from_dttm }}' AND + {% endif %} + {% if to_dttm is not none %} + dttm_col < '{{ to_dttm }}' AND + {% endif %} + 1 = 1 +) +``` + +The `1 = 1` at the end ensures a value is present for the `WHERE` clause even when +the time filter is not set. For many database engines, this could be replaced with `true`. + +Note that the Jinja parameters are called within _double_ brackets in the query and with +_single_ brackets in the logic blocks. + +### Understanding Context Availability + +Some Jinja variables like `from_dttm`, `to_dttm`, and `filter` are **only available when a chart or dashboard provides them**. They are populated from: + +- Time range filters applied in Explore/Chart views +- Dashboard native filters +- Filter components + +**These variables are NOT available in standalone SQL Lab queries** because there's no filter context. If you try to use `{{ from_dttm }}` directly in SQL Lab, you'll get an "undefined parameter" error. + +#### Testing Time-Filtered Queries in SQL Lab + +To test queries that use time variables in SQL Lab, you have several options: + +**Option 1: Use Jinja defaults (recommended)** + +```sql +SELECT * +FROM tbl +WHERE dttm_col > '{{ from_dttm | default("2024-01-01", true) }}' + AND dttm_col < '{{ to_dttm | default("2024-12-31", true) }}' +``` + +**Option 2: Use SQL Lab Parameters** + +Set parameters in the SQL Lab UI (Parameters menu): +```json +{ + "from_dttm": "2024-01-01", + "to_dttm": "2024-12-31" +} +``` + +**Option 3: Use `{% set %}` for testing** + +```sql +{% set from_dttm = "2024-01-01" %} +{% set to_dttm = "2024-12-31" %} +SELECT * +FROM tbl +WHERE dttm_col > '{{ from_dttm }}' AND dttm_col < '{{ to_dttm }}' +``` + +:::tip +When you save a SQL Lab query as a virtual dataset and use it in a chart with time filters, +the actual filter values will override any defaults or test values you set. +::: + +To add custom functionality to the Jinja context, you need to overload the default Jinja +context in your environment by defining the `JINJA_CONTEXT_ADDONS` in your superset configuration +(`superset_config.py`). Objects referenced in this dictionary are made available for users to use +where the Jinja context is made available. + +```python +JINJA_CONTEXT_ADDONS = { + 'my_crazy_macro': lambda x: x*2, +} +``` + +Default values for jinja templates can be specified via `Parameters` menu in the SQL Lab user interface. +In the UI you can assign a set of parameters as JSON + +```json +{ + "my_table": "foo" +} +``` + +The parameters become available in your SQL (example: `SELECT * FROM {{ my_table }}` ) by using Jinja templating syntax. +SQL Lab template parameters are stored with the dataset as `TEMPLATE PARAMETERS`. + +There is a special ``_filters`` parameter which can be used to test filters used in the jinja template. + +```json +{ + "_filters": [ + { + "col": "action_type", + "op": "IN", + "val": ["sell", "buy"] + } + ] +} +``` + +```sql +SELECT action, count(*) as times +FROM logs +WHERE action in {{ filter_values('action_type')|where_in }} +GROUP BY action +``` + +Note ``_filters`` is not stored with the dataset. It's only used within the SQL Lab UI. + +Besides default Jinja templating, SQL lab also supports self-defined template processor by setting +the `CUSTOM_TEMPLATE_PROCESSORS` in your superset configuration. The values in this dictionary +overwrite the default Jinja template processors of the specified database engine. The example below +configures a custom presto template processor which implements its own logic of processing macro +template with regex parsing. It uses the `$` style macro instead of `{{ }}` style in Jinja +templating. + +By configuring it with `CUSTOM_TEMPLATE_PROCESSORS`, a SQL template on a presto database is +processed by the custom one rather than the default one. + +```python +def DATE( + ts: datetime, day_offset: SupportsInt = 0, hour_offset: SupportsInt = 0 +) -> str: + """Current day as a string.""" + day_offset, hour_offset = int(day_offset), int(hour_offset) + offset_day = (ts + timedelta(days=day_offset, hours=hour_offset)).date() + return str(offset_day) + +class CustomPrestoTemplateProcessor(PrestoTemplateProcessor): + """A custom presto template processor.""" + + engine = "presto" + + def process_template(self, sql: str, **kwargs) -> str: + """Processes a sql template with $ style macro using regex.""" + # Add custom macros functions. + macros = { + "DATE": partial(DATE, datetime.utcnow()) + } # type: Dict[str, Any] + # Update with macros defined in context and kwargs. + macros.update(self.context) + macros.update(kwargs) + + def replacer(match): + """Expand $ style macros with corresponding function calls.""" + macro_name, args_str = match.groups() + args = [a.strip() for a in args_str.split(",")] + if args == [""]: + args = [] + f = macros[macro_name[1:]] + return f(*args) + + macro_names = ["$" + name for name in macros.keys()] + pattern = r"(%s)\s*\(([^()]*)\)" % "|".join(map(re.escape, macro_names)) + return re.sub(pattern, replacer, sql) + +CUSTOM_TEMPLATE_PROCESSORS = { + CustomPrestoTemplateProcessor.engine: CustomPrestoTemplateProcessor +} +``` + +SQL Lab also includes a live query validation feature with pluggable backends. You can configure +which validation implementation is used with which database engine by adding a block like the +following to your configuration file: + +```python +FEATURE_FLAGS = { + 'SQL_VALIDATORS_BY_ENGINE': { + 'presto': 'PrestoDBSQLValidator', + } +} +``` + +The available validators and names can be found in +[sql_validators](https://github.com/apache/superset/tree/master/superset/sql_validators). + +## Available Macros + +In this section, we'll walkthrough the pre-defined Jinja macros in Superset. + +### Current Username + +The `{{ current_username() }}` macro returns the `username` of the currently logged in user. + +If you have caching enabled in your Superset configuration, then by default the `username` value will be used +by Superset when calculating the cache key. A cache key is a unique identifier that determines if there's a +cache hit in the future and Superset can retrieve cached data. + +You can disable the inclusion of the `username` value in the calculation of the +cache key by adding the following parameter to your Jinja code: + +```python +{{ current_username(add_to_cache_keys=False) }} +``` + +### Current User ID + +The `{{ current_user_id() }}` macro returns the account ID of the currently logged in user. + +If you have caching enabled in your Superset configuration, then by default the account `id` value will be used +by Superset when calculating the cache key. A cache key is a unique identifier that determines if there's a +cache hit in the future and Superset can retrieve cached data. + +You can disable the inclusion of the account `id` value in the calculation of the +cache key by adding the following parameter to your Jinja code: + +```python +{{ current_user_id(add_to_cache_keys=False) }} +``` + +### Current User Email + +The `{{ current_user_email() }}` macro returns the email address of the currently logged in user. + +If you have caching enabled in your Superset configuration, then by default the email address value will be used +by Superset when calculating the cache key. A cache key is a unique identifier that determines if there's a +cache hit in the future and Superset can retrieve cached data. + +You can disable the inclusion of the email value in the calculation of the +cache key by adding the following parameter to your Jinja code: + +```python +{{ current_user_email(add_to_cache_keys=False) }} +``` + +### Current User Roles + +The `{{ current_user_roles() }}` macro returns an array of roles for the logged in user. + +If you have caching enabled in your Superset configuration, then by default the roles value will be used +by Superset when calculating the cache key. A cache key is a unique identifier that determines if there's a +cache hit in the future and Superset can retrieve cached data. + +You can disable the inclusion of the roles value in the calculation of the +cache key by adding the following parameter to your Jinja code: + +```python +{{ current_user_roles(add_to_cache_keys=False) }} +``` + +You can json-stringify the array by adding `|tojson` to your Jinja code: +```python +{{ current_user_roles()|tojson }} +``` + +You can use the `|where_in` filter to use your roles in a SQL statement. For example, if `current_user_roles()` returns `['admin', 'viewer']`, the following template: +```python +SELECT * FROM users WHERE role IN {{ current_user_roles()|where_in }} +``` + +Will be rendered as: +```sql +SELECT * FROM users WHERE role IN ('admin', 'viewer') +``` + +### Current User RLS Rules + +The `{{ current_user_rls_rules() }}` macro returns an array of RLS rules applied to the current dataset for the logged in user. + +If you have caching enabled in your Superset configuration, then the list of RLS Rules will be used +by Superset when calculating the cache key. A cache key is a unique identifier that determines if there's a +cache hit in the future and Superset can retrieve cached data. + +### Custom URL Parameters + +The `{{ url_param('custom_variable') }}` macro lets you define arbitrary URL +parameters and reference them in your SQL code. + +:::warning +Always treat `url_param()` values as untrusted input. Escaping behaviour varies by context and configuration, so do not rely on it. Restrict values to an explicit allowlist before using them in SQL: + +```sql +{% set cc = url_param('countrycode') %} +{% if cc not in ('US', 'ES', 'FR') %}{% set cc = 'US' %}{% endif %} +WHERE country_code = '{{ cc }}' +``` +::: + +Here's a concrete example: + +- You write the following query in SQL Lab: + + ```sql + SELECT count(*) + FROM ORDERS + WHERE country_code = '{{ url_param('countrycode') }}' + ``` + +- You're hosting Superset at the domain www.example.com and you send your + coworker in Spain the following SQL Lab URL `www.example.com/superset/sqllab?countrycode=ES` + and your coworker in the USA the following SQL Lab URL `www.example.com/superset/sqllab?countrycode=US` +- For your coworker in Spain, the SQL Lab query will be rendered as: + + ```sql + SELECT count(*) + FROM ORDERS + WHERE country_code = 'ES' + ``` + +- For your coworker in the USA, the SQL Lab query will be rendered as: + + ```sql + SELECT count(*) + FROM ORDERS + WHERE country_code = 'US' + ``` + +### Explicitly Including Values in Cache Key + +The `{{ cache_key_wrapper() }}` function explicitly instructs Superset to add a value to the +accumulated list of values used in the calculation of the cache key. + +This function is only needed when you want to wrap your own custom function return values +in the cache key. You can gain more context +[here](https://github.com/apache/superset/blob/efd70077014cbed62e493372d33a2af5237eaadf/superset/jinja_context.py#L133-L148). + +Note that this function powers the caching of the `user_id` and `username` values +in the `current_user_id()` and `current_username()` function calls (if you have caching enabled). + +### Filter Values + +You can retrieve the value for a specific filter as a list using `{{ filter_values() }}`. + +This is useful if: + +- You want to use a filter component to filter a query where the name of filter component column doesn't match the one in the select statement +- You want to have the ability to filter inside the main query for performance purposes + +Here's a concrete example: + +```sql +SELECT action, count(*) as times +FROM logs +WHERE + action in {{ filter_values('action_type')|where_in }} +GROUP BY action +``` + +There `where_in` filter converts the list of values from `filter_values('action_type')` into a string suitable for an `IN` expression. + +### Filters for a Specific Column + +The `{{ get_filters() }}` macro returns the filters applied to a given column. In addition to +returning the values (similar to how `filter_values()` does), the `get_filters()` macro +returns the operator specified in the Explore UI. + +This is useful if: + +- You want to handle more than the IN operator in your SQL clause +- You want to handle generating custom SQL conditions for a filter +- You want to have the ability to filter inside the main query for speed purposes + +:::warning +`filter.get('val')` returns the raw filter value without escaping. For multi-value filters, use the `|where_in` Jinja filter, which handles quoting safely. For single-value operators like `LIKE`, escape single quotes before interpolating: + +```sql +{%- if filter.get('op') == 'LIKE' -%} + AND full_name LIKE '{{ filter.get('val') | replace("'", "''") }}' +{%- endif -%} +``` +::: + +Here's a concrete example: + +```sql + WITH RECURSIVE + superiors(employee_id, manager_id, full_name, level, lineage) AS ( + SELECT + employee_id, + manager_id, + full_name, + 1 as level, + employee_id as lineage + FROM + employees + WHERE + 1=1 + + {# Render a blank line #} + {%- for filter in get_filters('full_name', remove_filter=True) -%} + + {%- if filter.get('op') == 'IN' -%} + AND + full_name IN {{ filter.get('val')|where_in }} + {%- endif -%} + + {%- if filter.get('op') == 'LIKE' -%} + AND + full_name LIKE '{{ filter.get('val') | replace("'", "''") }}' + {%- endif -%} + + {%- endfor -%} + UNION ALL + SELECT + e.employee_id, + e.manager_id, + e.full_name, + s.level + 1 as level, + s.lineage + FROM + employees e, + superiors s + WHERE s.manager_id = e.employee_id + ) + + SELECT + employee_id, manager_id, full_name, level, lineage + FROM + superiors + order by lineage, level +``` + +### Time Filter + +The `{{ get_time_filter() }}` macro returns the time filter applied to a specific column. This is useful if you want +to handle time filters inside the virtual dataset, as by default the time filter is placed on the outer query. This can +considerably improve performance, as many databases and query engines are able to optimize the query better +if the temporal filter is placed on the inner query, as opposed to the outer query. + +The macro takes the following parameters: + +- `column`: Name of the temporal column. Leave undefined to reference the time range from a Dashboard Native Time Range + filter (when present). +- `default`: The default value to fall back to if the time filter is not present, or has the value `No filter` +- `target_type`: The target temporal type as recognized by the target database (e.g. `TIMESTAMP`, `DATE` or + `DATETIME`). If `column` is defined, the format will default to the type of the column. This is used to produce + the format of the `from_expr` and `to_expr` properties of the returned `TimeFilter` object. +- `strftime`: format using the `strftime` method of `datetime` for custom time formatting. + ([see docs for valid format codes](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes)). + When defined `target_type` will be ignored. +- `remove_filter`: When set to true, mark the filter as processed, removing it from the outer query. Useful when a + filter should only apply to the inner query. + +The return type has the following properties: + +- `from_expr`: the start of the time filter (if any) +- `to_expr`: the end of the time filter (if any) +- `time_range`: The applied time range + +Here's a concrete example using the `logs` table from the Superset metastore: + +``` +{% set time_filter = get_time_filter("dttm", remove_filter=True) %} +{% set from_expr = time_filter.from_expr %} +{% set to_expr = time_filter.to_expr %} +{% set time_range = time_filter.time_range %} +SELECT + *, + '{{ time_range }}' as time_range +FROM logs +{% if from_expr or to_expr %}WHERE 1 = 1 +{% if from_expr %}AND dttm >= {{ from_expr }}{% endif %} +{% if to_expr %}AND dttm < {{ to_expr }}{% endif %} +{% endif %} +``` + +Assuming we are creating a table chart with a simple `COUNT(*)` as the metric with a time filter `Last week` on the +`dttm` column, this would render the following query on Postgres (note the formatting of the temporal filters, and +the absence of time filters on the outer query): + +``` +SELECT COUNT(*) AS count +FROM + (SELECT *, + 'Last week' AS time_range + FROM public.logs + WHERE 1 = 1 + AND dttm >= TO_TIMESTAMP('2024-08-27 00:00:00.000000', 'YYYY-MM-DD HH24:MI:SS.US') + AND dttm < TO_TIMESTAMP('2024-09-03 00:00:00.000000', 'YYYY-MM-DD HH24:MI:SS.US')) AS virtual_table +ORDER BY count DESC +LIMIT 1000; +``` + +When using the `default` parameter, the templated query can be simplified, as the endpoints will always be defined +(to use a fixed time range, you can also use something like `default="2024-08-27 : 2024-09-03"`) + +``` +{% set time_filter = get_time_filter("dttm", default="Last week", remove_filter=True) %} +SELECT + *, + '{{ time_filter.time_range }}' as time_range +FROM logs +WHERE + dttm >= {{ time_filter.from_expr }} + AND dttm < {{ time_filter.to_expr }} +``` + +### Datasets + +It's possible to query physical and virtual datasets using the `dataset` macro. This is useful if you've defined computed columns and metrics on your datasets, and want to reuse the definition in adhoc SQL Lab queries. + +To use the macro, first you need to find the ID of the dataset. This can be done by going to the view showing all the datasets, hovering over the dataset you're interested in, and looking at its URL. For example, if the URL for a dataset is https://superset.example.org/explore/?dataset_type=table&dataset_id=42 its ID is 42. + +Once you have the ID you can query it as if it were a table: + +```sql +SELECT * FROM {{ dataset(42) }} LIMIT 10 +``` + +If you want to select the metric definitions as well, in addition to the columns, you need to pass an additional keyword argument: + +```sql +SELECT * FROM {{ dataset(42, include_metrics=True) }} LIMIT 10 +``` + +Since metrics are aggregations, the resulting SQL expression will be grouped by all non-metric columns. You can specify a subset of columns to group by instead: + +```sql +SELECT * FROM {{ dataset(42, include_metrics=True, columns=["ds", "category"]) }} LIMIT 10 +``` + +### Metrics + +The `{{ metric('metric_key', dataset_id) }}` macro can be used to retrieve the metric SQL syntax from a dataset. This can be useful for different purposes: + +- Override the metric label in the chart level +- Combine multiple metrics in a calculation +- Retrieve a metric syntax in SQL lab +- Re-use metrics across datasets + +This macro avoids copy/paste, allowing users to centralize the metric definition in the dataset layer. + +The `dataset_id` parameter is optional, and if not provided Superset will use the current dataset from context (for example, when using this macro in the Chart Builder, by default the `macro_key` will be searched in the dataset powering the chart). +The parameter can be used in SQL Lab, or when fetching a metric from another dataset. + +## Available Filters + +Superset supports [builtin filters from the Jinja2 templating package](https://jinja.palletsprojects.com/en/stable/templates/#builtin-filters). Custom filters have also been implemented: + +### Where In +Parses a list into a SQL-compatible statement. This is useful with macros that return an array (for example the `filter_values` macro): + +``` +Dashboard filter with "First", "Second" and "Third" options selected +{{ filter_values('column') }} => ["First", "Second", "Third"] +{{ filter_values('column')|where_in }} => ('First', 'Second', 'Third') +``` + +By default, this filter returns `()` (as a string) in case the value is null. The `default_to_none` parameter can be se to `True` to return null in this case: + +``` +Dashboard filter without any value applied +{{ filter_values('column') }} => () +{{ filter_values('column')|where_in(default_to_none=True) }} => None +``` + +### To Datetime + +Loads a string as a `datetime` object. This is useful when performing date operations. For example: +``` +{% set from_expr = get_time_filter("dttm", strftime="%Y-%m-%d").from_expr %} +{% set to_expr = get_time_filter("dttm", strftime="%Y-%m-%d").to_expr %} +{% if (to_expr|to_datetime(format="%Y-%m-%d") - from_expr|to_datetime(format="%Y-%m-%d")).days > 100 %} + do something +{% else %} + do something else +{% endif %} +``` + +:::resources +- [Blog: Intro to Jinja Templating in Apache Superset](https://preset.io/blog/intro-jinja-templating-apache-superset/) +::: diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/theming.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/theming.mdx new file mode 100644 index 00000000000..c13e42617a0 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/theming.mdx @@ -0,0 +1,448 @@ +--- +title: Theming +hide_title: true +sidebar_position: 12 +version: 1 +--- +# Theming Superset + +:::note +`apache-superset>=6.0` +::: + +Superset now rides on **Ant Design v5's token-based theming**. +Every Antd token works, plus a handful of Superset-specific ones for charts and dashboard chrome. + +## Managing Themes via UI + +Superset includes a built-in **Theme Management** interface accessible from the admin menu under **Settings > Themes**. + +### Creating a New Theme + +1. Navigate to **Settings > Themes** in the Superset interface +2. Click **+ Theme** to create a new theme +3. Use the [Ant Design Theme Editor](https://ant.design/theme-editor) to design your theme: + - Design your palette, typography, and component overrides + - Open the `CONFIG` modal and copy the JSON configuration +4. Paste the JSON into the theme definition field in Superset +5. Give your theme a descriptive name and save + +You can also extend with Superset-specific tokens (documented in the default theme object) before you import. + +### System Theme Administration + +When `ENABLE_UI_THEME_ADMINISTRATION = True` is configured, administrators can manage system-wide themes directly from the UI: + +#### Setting System Themes +- **System Default Theme**: Click the sun icon on any theme to set it as the system-wide default +- **System Dark Theme**: Click the moon icon on any theme to set it as the system dark mode theme +- **Automatic OS Detection**: When both default and dark themes are set, Superset automatically detects and applies the appropriate theme based on OS preferences + +#### Managing System Themes +- System themes are indicated with special badges in the theme list +- Only administrators with write permissions can modify system theme settings +- Removing a system theme designation reverts to configuration file defaults + +### Applying Themes to Dashboards + +Once created, themes can be applied to individual dashboards: +- Edit any dashboard and select your custom theme from the theme dropdown +- Each dashboard can have its own theme, allowing for branded or context-specific styling + +## Configuration Options + +### Python Configuration + +Configure theme behavior via `superset_config.py`: + +```python +# Enable UI-based theme administration for admins +ENABLE_UI_THEME_ADMINISTRATION = True + +# Optional: Set initial default themes via configuration +# These can be overridden via the UI when ENABLE_UI_THEME_ADMINISTRATION = True +THEME_DEFAULT = { + "token": { + "colorPrimary": "#2893B3", + "colorSuccess": "#5ac189", + # ... your theme JSON configuration + } +} + +# Optional: Dark theme configuration +THEME_DARK = { + "algorithm": "dark", + "token": { + "colorPrimary": "#2893B3", + # ... your dark theme overrides + } +} + +# To force a single theme on all users, set THEME_DARK = None +# When both themes are defined (via UI or config): +# - Users can manually switch between themes +# - OS preference detection is automatically enabled +``` + +### App Branding + +The application name shown in the browser title bar and navigation can be +set via the `brandAppName` theme token: + +```python +THEME_DEFAULT = { + "token": { + "brandAppName": "Acme Analytics", + # ... other tokens + } +} +``` + +Or in the theme CRUD UI JSON editor: + +```json +{ + "token": { + "brandAppName": "Acme Analytics" + } +} +``` + +The existing `APP_NAME` Python config key continues to work for backward compatibility. +`brandAppName` takes precedence when both are set, and allows different themes to carry different brand names. +Email and alert/report notification subjects are driven by backend settings such as +`EMAIL_REPORTS_SUBJECT_PREFIX` and `APP_NAME`, not by this theme token. + +### Migration from Configuration to UI + +When `ENABLE_UI_THEME_ADMINISTRATION = True`: + +1. System themes set via the UI take precedence over configuration file settings +2. The UI shows which themes are currently set as system defaults +3. Administrators can change system themes without restarting Superset +4. Configuration file themes serve as fallbacks when no UI themes are set + +### Copying Themes Between Systems + +To export a theme for use in configuration files or another instance: + +1. Navigate to **Settings > Themes** and click the export icon on your desired theme +2. Extract the JSON configuration from the exported YAML file +3. Use this JSON in your `superset_config.py` or import it into another Superset instance + +## Theme Development Workflow + +1. **Design**: Use the [Ant Design Theme Editor](https://ant.design/theme-editor) to iterate on your design +2. **Test**: Create themes in Superset's CRUD interface for testing +3. **Apply**: Assign themes to specific dashboards or configure instance-wide +4. **Iterate**: Modify theme JSON directly in the CRUD interface or re-import from the theme editor + +## Custom Fonts + +Superset supports custom fonts through the theme configuration, allowing you to use branded or custom typefaces without rebuilding the application. + +### Default Fonts + +By default, Superset uses Inter and Fira Code fonts which are bundled with the application via `@fontsource` packages. These fonts work offline and require no external network calls. + +### Configuring Custom Fonts + +To use custom fonts, add font URLs to your theme configuration using the `fontUrls` token: + +```python +THEME_DEFAULT = { + "token": { + # Load fonts from external sources (e.g., Google Fonts, Adobe Fonts) + "fontUrls": [ + "https://fonts.googleapis.com/css2?family=Roboto:wght@400;500;600;700&display=swap", + "https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500&display=swap", + ], + # Reference the loaded fonts + "fontFamily": "Roboto, -apple-system, BlinkMacSystemFont, sans-serif", + "fontFamilyCode": "JetBrains Mono, Monaco, monospace", + # ... other theme tokens + } +} + +# Update CSP to allow font sources +TALISMAN_CONFIG = { + "content_security_policy": { + "font-src": ["'self'", "https://fonts.googleapis.com", "https://fonts.gstatic.com"], + "style-src": ["'self'", "'unsafe-inline'", "https://fonts.googleapis.com"], + } +} +``` + +Or in the CRUD interface theme JSON: + +```json +{ + "token": { + "fontUrls": [ + "https://fonts.googleapis.com/css2?family=Roboto:wght@400;500;600;700&display=swap" + ], + "fontFamily": "Roboto, -apple-system, BlinkMacSystemFont, sans-serif", + "fontFamilyCode": "JetBrains Mono, Monaco, monospace" + } +} +``` + +:::note +Font URLs are validated against a configurable allowlist. By default, fonts from `fonts.googleapis.com`, `fonts.gstatic.com`, and `use.typekit.net` are allowed. Configure `THEME_FONT_URL_ALLOWED_DOMAINS` to customize the allowed domains. +::: + +### Font Sources + +- **Google Fonts**: Free, CDN-hosted fonts with wide variety +- **Adobe Fonts**: Premium fonts (requires subscription and kit ID) +- **Self-hosted**: Place font files in `/static/assets/fonts/` and reference via CSS + +This feature works with the stock Docker image - no custom build required! + +## ECharts Configuration Overrides + +:::note +Available since Superset 6.0 +::: + +Superset provides fine-grained control over ECharts visualizations through theme-level configuration overrides. This allows you to customize the appearance and behavior of all ECharts-based charts without modifying individual chart configurations. + +### Global ECharts Overrides + +Apply settings to all ECharts visualizations using `echartsOptionsOverrides`: + +```python +THEME_DEFAULT = { + "token": { + "colorPrimary": "#2893B3", + # ... other Ant Design tokens + }, + "echartsOptionsOverrides": { + "grid": { + "left": "10%", + "right": "10%", + "top": "15%", + "bottom": "15%" + }, + "tooltip": { + "backgroundColor": "rgba(0, 0, 0, 0.8)", + "borderColor": "#ccc", + "textStyle": { + "color": "#fff" + } + }, + "legend": { + "textStyle": { + "fontSize": 14, + "fontWeight": "bold" + } + } + } +} +``` + +### Chart-Specific Overrides + +Target specific chart types using `echartsOptionsOverridesByChartType`: + +```python +THEME_DEFAULT = { + "token": { + "colorPrimary": "#2893B3", + # ... other tokens + }, + "echartsOptionsOverridesByChartType": { + "echarts_pie": { + "legend": { + "orient": "vertical", + "right": 10, + "top": "center" + } + }, + "echarts_timeseries": { + "xAxis": { + "axisLabel": { + "rotate": 45, + "fontSize": 12 + } + }, + "dataZoom": [{ + "type": "slider", + "show": True, + "start": 0, + "end": 100 + }] + }, + "echarts_bubble": { + "grid": { + "left": "15%", + "bottom": "20%" + } + } + } +} +``` + +### UI Configuration + +You can also configure ECharts overrides through the theme CRUD interface: + +```json +{ + "token": { + "colorPrimary": "#2893B3" + }, + "echartsOptionsOverrides": { + "grid": { + "left": "10%", + "right": "10%" + }, + "tooltip": { + "backgroundColor": "rgba(0, 0, 0, 0.8)" + } + }, + "echartsOptionsOverridesByChartType": { + "echarts_pie": { + "legend": { + "orient": "vertical", + "right": 10 + } + } + } +} +``` + +### Override Precedence + +The system applies overrides in the following order (last wins): + +1. **Base ECharts theme** - Default Superset styling +2. **Plugin options** - Chart-specific configurations +3. **Global overrides** - `echartsOptionsOverrides` +4. **Chart-specific overrides** - `echartsOptionsOverridesByChartType[chartType]` + +This ensures chart-specific overrides take precedence over global ones. + +### Common Chart Types + +Available chart types for `echartsOptionsOverridesByChartType`: + +- `echarts_timeseries` - Time series/line charts +- `echarts_pie` - Pie and donut charts +- `echarts_bubble` - Bubble/scatter charts +- `echarts_funnel` - Funnel charts +- `echarts_gauge` - Gauge charts +- `echarts_radar` - Radar charts +- `echarts_boxplot` - Box plot charts +- `echarts_treemap` - Treemap charts +- `echarts_sunburst` - Sunburst charts +- `echarts_graph` - Network/graph charts +- `echarts_sankey` - Sankey diagrams +- `echarts_heatmap` - Heatmaps +- `echarts_mixed_timeseries` - Mixed time series + +### Array Property Overrides + +Array properties (such as color palettes) are fully supported in overrides. Arrays are **replaced entirely** rather than merged, so specify the complete array: + +```python +THEME_DEFAULT = { + "token": { ... }, + "echartsOptionsOverrides": { + # Replace the default color palette for all ECharts visualizations + "color": ["#1f77b4", "#ff7f0e", "#2ca02c", "#d62728", "#9467bd", "#8c564b"] + } +} +``` + +### Best Practices + +1. **Start with global overrides** for consistent styling across all charts +2. **Use chart-specific overrides** for unique requirements per visualization type +3. **Test thoroughly** as overrides use deep merge for objects, but arrays are completely replaced — always specify the full array value +4. **Document your overrides** to help team members understand custom styling +5. **Consider performance** - complex overrides may impact chart rendering speed + +### Example: Corporate Branding + +```python +# Complete corporate theme with ECharts customization +THEME_DEFAULT = { + "token": { + "colorPrimary": "#1B4D3E", + "fontFamily": "Corporate Sans, Arial, sans-serif" + }, + "echartsOptionsOverrides": { + "grid": { + "left": "8%", + "right": "8%", + "top": "12%", + "bottom": "12%" + }, + "textStyle": { + "fontFamily": "Corporate Sans, Arial, sans-serif" + }, + "title": { + "textStyle": { + "color": "#1B4D3E", + "fontSize": 18, + "fontWeight": "bold" + } + } + }, + "echartsOptionsOverridesByChartType": { + "echarts_timeseries": { + "xAxis": { + "axisLabel": { + "color": "#666", + "fontSize": 11 + } + } + }, + "echarts_pie": { + "legend": { + "textStyle": { + "fontSize": 12 + }, + "itemGap": 20 + } + } + } +} +``` + +This feature provides powerful theming capabilities while maintaining the flexibility of ECharts' extensive configuration options. + +## Advanced Features + +- **System Themes**: Manage system-wide default and dark themes via UI or configuration +- **Per-Dashboard Theming**: Each dashboard can have its own visual identity +- **JSON Editor**: Edit theme configurations directly within Superset's interface +- **Custom Fonts**: Load external fonts via configuration without rebuilding +- **OS Dark Mode Detection**: Automatically switches themes based on system preferences +- **Theme Import/Export**: Share themes between instances via YAML files + +## API Access + +For programmatic theme management, Superset provides REST endpoints: + +- `GET /api/v1/theme/` - List all themes +- `POST /api/v1/theme/` - Create a new theme +- `PUT /api/v1/theme/{id}` - Update a theme +- `DELETE /api/v1/theme/{id}` - Delete a theme +- `PUT /api/v1/theme/{id}/set_system_default` - Set as system default theme (admin only) +- `PUT /api/v1/theme/{id}/set_system_dark` - Set as system dark theme (admin only) +- `DELETE /api/v1/theme/unset_system_default` - Remove system default designation +- `DELETE /api/v1/theme/unset_system_dark` - Remove system dark designation +- `GET /api/v1/theme/export/` - Export themes as YAML +- `POST /api/v1/theme/import/` - Import themes from YAML + +These endpoints require appropriate permissions and are subject to RBAC controls. + +:::resources +- [Video: Live Demo — Theming Apache Superset](https://www.youtube.com/watch?v=XsZAsO9tC3o) +- [CSS and Theming](https://docs.preset.io/docs/css-and-theming) - Additional theming techniques and CSS customization +- [Blog: Customizing Apache Superset Dashboards with CSS](https://preset.io/blog/customizing-superset-dashboards-with-css/) +- [Blog: Customizing Dashboards with CSS — Tips and Tricks](https://preset.io/blog/customizing-apache-superset-dashboards-with-css-additional-tips-and-tricks/) +- [Blog: Customizing Chart Colors](https://preset.io/blog/customizing-chart-colors-with-superset-and-preset/) +::: diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/configuration/timezones.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/timezones.mdx new file mode 100644 index 00000000000..2e2a239f1e2 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/configuration/timezones.mdx @@ -0,0 +1,50 @@ +--- +title: Timezones +hide_title: true +sidebar_position: 6 +version: 1 +--- + +# Timezones + +There are four distinct timezone components which relate to Apache Superset, + +1. The timezone that the underlying data is encoded in. +2. The timezone of the database engine. +3. The timezone of the Apache Superset backend. +4. The timezone of the Apache Superset client. + +where if a temporal field (`DATETIME`, `TIME`, `TIMESTAMP`, etc.) does not explicitly define a timezone it defaults to the underlying timezone of the component. + +To help make the problem somewhat tractable—given that Apache Superset has no control on either how the data is ingested (1) or the timezone of the client (4)—from a consistency standpoint it is highly recommended that both (2) and (3) are configured to use the same timezone with a strong preference given to [UTC](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) to ensure temporal fields without an explicit timestamp are not incorrectly coerced into the wrong timezone. Actually Apache Superset currently has implicit assumptions that timestamps are in UTC and thus configuring (3) to a non-UTC timezone could be problematic. + +To strive for data consistency (regardless of the timezone of the client) the Apache Superset backend tries to ensure that any timestamp sent to the client has an explicit (or semi-explicit as in the case with [Epoch time](https://en.wikipedia.org/wiki/Unix_time) which is always in reference to UTC) timezone encoded within. + +The challenge however lies with the slew of [database engines](/user-docs/databases#installing-drivers-in-docker) which Apache Superset supports and various inconsistencies between their [Python Database API (DB-API)](https://www.python.org/dev/peps/pep-0249/) implementations combined with the fact that we use [Pandas](https://pandas.pydata.org/) to read SQL into a DataFrame prior to serializing to JSON. Regrettably Pandas ignores the DB-API [type_code](https://www.python.org/dev/peps/pep-0249/#type-objects) relying by default on the underlying Python type returned by the DB-API. Currently only a subset of the supported database engines work correctly with Pandas, i.e., ensuring timestamps without an explicit timestamp are serialized to JSON with the server timezone, thus guaranteeing the client will display timestamps in a consistent manner irrespective of the client's timezone. + +For example the following is a comparison of MySQL and Presto, + +```python +import pandas as pd +from sqlalchemy import create_engine + +pd.read_sql_query( + sql="SELECT TIMESTAMP('2022-01-01 00:00:00') AS ts", + con=create_engine("mysql://root@localhost:3360"), +).to_json() + +pd.read_sql_query( + sql="SELECT TIMESTAMP '2022-01-01 00:00:00' AS ts", + con=create_engine("presto://localhost:8080"), +).to_json() +``` + +which outputs `{"ts":{"0":1640995200000}}` (which infers the UTC timezone per the Epoch time definition) and `{"ts":{"0":"2022-01-01 00:00:00.000"}}` (without an explicit timezone) respectively and thus are treated differently in JavaScript: + +```js +new Date(1640995200000) +> Sat Jan 01 2022 13:00:00 GMT+1300 (New Zealand Daylight Time) + +new Date("2022-01-01 00:00:00.000") +> Sat Jan 01 2022 00:00:00 GMT+1300 (New Zealand Daylight Time) +``` diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/index.md b/docs/admin_docs_versioned_docs/version-6.1.0/index.md new file mode 100644 index 00000000000..8b1c1de4b1a --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/index.md @@ -0,0 +1,42 @@ +--- +title: Admin Documentation +description: Administrator guides for installing, configuring, and managing Apache Superset +--- + + + +# Admin Documentation + +This section contains documentation for system administrators and operators who deploy and manage Apache Superset installations. + +## What's in this section + +- **[Installation](/admin-docs/installation/installation-methods)** - Deploy Superset using Docker, Kubernetes, or PyPI +- **[Configuration](/admin-docs/configuration/configuring-superset)** - Configure authentication, caching, feature flags, and more +- **[Security](/admin-docs/security/)** - Set up roles, permissions, and secure your deployment + +## Related + +- **[Database Drivers](/user-docs/databases/)** - See User Docs for database connection setup (admins may need to install drivers) + +## Looking for something else? + +- **[User Documentation](/user-docs/)** - Guides for analysts and business users +- **[Developer Documentation](/developer-docs)** - Contributing, extensions, and development guides diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/installation/architecture.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/installation/architecture.mdx new file mode 100644 index 00000000000..e531b30017e --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/installation/architecture.mdx @@ -0,0 +1,72 @@ +--- +title: Architecture +hide_title: true +sidebar_position: 1 +version: 1 +--- + +import useBaseUrl from "@docusaurus/useBaseUrl"; + +# Architecture + +This page is meant to give new administrators an understanding of Superset's components. + +## Components + +A Superset installation is made up of these components: + +1. The Superset application itself +2. A metadata database +3. A caching layer (optional, but necessary for some features) +4. A worker & beat (optional, but necessary for some features) + +### Optional components and associated features + +The optional components above are necessary to enable these features: + +- [Alerts and Reports](/admin-docs/configuration/alerts-reports) +- [Caching](/admin-docs/configuration/cache) +- [Async Queries](/admin-docs/configuration/async-queries-celery/) +- [Dashboard Thumbnails](/admin-docs/configuration/cache/#caching-thumbnails) + +If you install with Kubernetes or Docker Compose, all of these components will be created. + +However, installing from PyPI only creates the application itself. Users installing from PyPI will need to configure a caching layer, worker, and beat on their own if they wish to enable the above features. Configuration of those components for a PyPI install is not currently covered in this documentation. + +Here are further details on each component. + +### The Superset Application + +This is the core application. Superset operates like this: + +- A user visits a chart or dashboard +- That triggers a SQL query to the data warehouse holding the underlying dataset +- The resulting data is served up in a data visualization +- The Superset application is comprised of the Python (Flask) backend application (server), API layer, and the React frontend, built via Webpack, and static assets needed for the application to work + +### Metadata Database + +This is where chart and dashboard definitions, user information, logs, etc. are stored. Superset is tested to work with PostgreSQL and MySQL databases as the metadata database (not be confused with a data source like your data warehouse, which could be a much greater variety of options like Snowflake, Redshift, etc.). + +Some installation methods like our Quickstart and PyPI come configured by default to use a SQLite on-disk database. And in a Docker Compose installation, the data would be stored in a PostgreSQL container volume. Neither of these cases are recommended for production instances of Superset. + +For production, a properly-configured, managed, standalone database is recommended. No matter what database you use, you should plan to back it up regularly. + +### Caching Layer + +The caching layer serves two main functions: + +- Store the results of queries to your data warehouse so that when a chart is loaded twice, it pulls from the cache the second time, speeding up the application and reducing load on your data warehouse. +- Act as a message broker for the worker, enabling the Alerts & Reports, async queries, and thumbnail caching features. + +Most people use Redis for their cache, but Superset supports other options too. See the [cache docs](/admin-docs/configuration/cache/) for more. + +### Worker and Beat + +This is one or more workers who execute tasks like run async queries or take snapshots of reports and send emails, and a "beat" that acts as the scheduler and tells workers when to perform their tasks. Most installations use Celery for these components. + +## Other components + +Other components can be incorporated into Superset. The best place to learn about additional configurations is the [Configuration page](/admin-docs/configuration/configuring-superset). For instance, you could set up a load balancer or reverse proxy to implement HTTPS in front of your Superset application, or specify a Mapbox URL to enable geospatial charts, etc. + +Superset won't even start without certain configuration settings established, so it's essential to review that page. diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/installation/docker-builds.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/installation/docker-builds.mdx new file mode 100644 index 00000000000..ffd523b906d --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/installation/docker-builds.mdx @@ -0,0 +1,173 @@ +--- +title: Docker Builds +hide_title: true +sidebar_position: 7 +version: 1 +--- + +# Docker builds, images and tags + +The Apache Superset community extensively uses Docker for development, release, +and productionizing Superset. This page details our Docker builds and tag naming +schemes to help users navigate our offerings. + +Images are built and pushed to the [Superset Docker Hub repository]( +https://hub.docker.com/r/apache/superset) using GitHub Actions. +Different sets of images are built and/or published at different times: + +- **Published releases** (`release`): published using + tags like `5.0.0` and the `latest` tag. +- **Pull request iterations** (`pull_request`): for each pull request, while + we actively build the docker to validate the build, we do + not publish those images for security reasons, we simply `docker build --load` +- **Merges to the main branch** (`push`): resulting in new SHAs, with tags + prefixed with `master` for the latest `master` version. + +## Build presets + +We have a set of build "presets" that each represent a combination of +parameters for the build, mostly pointing to either different target layer +for the build, and/or base image. + +Here are the build presets that are exposed through the `supersetbot docker` utility: + +- `lean`: The default Docker image, including both frontend and backend. Tags + without a build_preset are lean builds (ie: `latest`, `5.0.0`, `4.1.2`, ...). `lean` + builds do not contain database + drivers, meaning you need to install your own. That applies to analytics databases **AND + the metadata database**. You'll likely want to layer either `mysqlclient` or `psycopg2-binary` + depending on the metadata database you choose for your installation, plus the required + drivers to connect to your analytics database(s). +- `dev`: For development, with a headless browser, dev-related utilities and root access. This + includes some commonly used database drivers like `mysqlclient`, `psycopg2-binary` and + some other used for development/CI +- `py311`, e.g., Py311: Similar to lean but with a different Python version (in this example, 3.11). +- `ci`: For certain CI workloads. +- `websocket`: For Superset clusters supporting advanced features. +- `dockerize`: Used by Helm in initContainers to wait for database dependencies to be available. + +## Key tags examples + +- `latest`: The latest official release build +- `latest-dev`: the `-dev` image of the latest official release build, with a + headless browser and root access. +- `master`: The latest build from the `master` branch, implicitly the lean build + preset +- `master-dev`: Similar to `master` but includes a headless browser and root access. +- `pr-5252`: The latest commit in PR 5252. +- `30948dc401b40982cb7c0dbf6ebbe443b2748c1b-dev`: A build for + this specific SHA, which could be from a `master` merge, or release. +- `websocket-latest`: The WebSocket image for use in a Superset cluster. + +For insights or modifications to the build matrix and tagging conventions, +check the [supersetbot docker](https://github.com/apache-superset/supersetbot) +subcommand and the [docker.yml](https://github.com/apache/superset/blob/master/.github/workflows/docker.yml) +GitHub action. + +## Building your own production Docker image + +Every Superset deployment will require its own set of drivers depending on the data warehouse(s), +etc. so we recommend that users build their own Docker image by extending the `lean` image. + +Here's an example Dockerfile that does this. Follow the in-line comments to customize it for +your desired Superset version and database drivers. The comments also note that a certain feature flag will +have to be enabled in your config file. + +You would build the image with `docker build -t mysuperset:latest .` or `docker build -t ourcompanysuperset:5.0.0 .` + +```Dockerfile +# change this to apache/superset:5.0.0 or whatever version you want to build from; +# otherwise the default is the latest commit on GitHub master branch +FROM apache/superset:master + +USER root + +# Set environment variable for Playwright +ENV PLAYWRIGHT_BROWSERS_PATH=/usr/local/share/playwright-browsers + +# Install packages using uv into the virtual environment +RUN . /app/.venv/bin/activate && \ + uv pip install \ + # install psycopg2 for using PostgreSQL metadata store - could be a MySQL package if using that backend: + psycopg2-binary \ + # add the driver(s) for your data warehouse(s), in this example we're showing for Microsoft SQL Server: + pymssql \ + # package needed for using single-sign on authentication: + Authlib \ + # openpyxl to be able to upload Excel files + openpyxl \ + # Pillow for Alerts & Reports to generate PDFs of dashboards + Pillow \ + # install Playwright for taking screenshots for Alerts & Reports. This assumes the feature flag PLAYWRIGHT_REPORTS_AND_THUMBNAILS is enabled + # That feature flag will default to True starting in 6.0.0 + # Playwright works only with Chrome. + # If you are still using Selenium instead of Playwright, you would instead install here the selenium package and a headless browser & webdriver + playwright \ + && playwright install-deps \ + && PLAYWRIGHT_BROWSERS_PATH=/usr/local/share/playwright-browsers playwright install chromium + +# Switch back to the superset user +USER superset + +CMD ["/app/docker/entrypoints/run-server.sh"] +``` + +## Key ARGs in Dockerfile + +- `BUILD_TRANSLATIONS`: whether to build the translations into the image. For the + frontend build this tells webpack to strip out all locales other than `en` from + the `moment-timezone` library. For the backendthis skips compiling the + `*.po` translation files +- `DEV_MODE`: whether to skip the frontend build, this is used by our `docker-compose` dev setup + where we mount the local volume and build using `webpack` in `--watch` mode, meaning as you + alter the code in the local file system, webpack, from within a docker image used for this + purpose, will constantly rebuild the frontend as you go. This ARG enables the initial + `docker-compose` build to take much less time and resources +- `INCLUDE_CHROMIUM`: whether to include chromium in the backend build so that it can be + used as a headless browser for workloads related to "Alerts & Reports" and thumbnail generation +- `INCLUDE_FIREFOX`: same as above, but for firefox +- `PY_VER`: specifying the base image for the python backend, we don't recommend altering + this setting if you're not working on forwards or backwards compatibility + +## Caching + +To accelerate builds, we follow Docker best practices and use `apache/superset-cache`. + +## About database drivers + +Our docker images come with little to zero database driver support since +each environment requires different drivers, and maintaining a build with +wide database support would be both challenging (dozens of databases, +python drivers, and os dependencies) and inefficient (longer +build times, larger images, lower layer cache hit rate, ...). + +For production use cases, we recommend that you derive our `lean` image(s) and +add database support for the database you need. + +## On supporting different platforms (namely arm64 AND amd64) + +Currently all automated builds are multi-platform, supporting both `linux/arm64` +and `linux/amd64`. This enables higher level constructs like `helm` and +`docker compose` to point to these images and effectively be multi-platform +as well. + +Pull requests and master builds +are one-image-per-platform so that they can be parallelized and the +build matrix for those is more sparse as we don't need to build every +build preset on every platform, and generally can be more selective here. +For those builds, we suffix tags with `-arm` where it applies. + +### Working with Apple silicon + +Apple's current generation of computers uses ARM-based CPUs, and Docker +running on MACs seem to require `linux/arm64/v8` (at least one user's M2 was +configured in that way). Setting the environment +variable `DOCKER_DEFAULT_PLATFORM` to `linux/amd64` seems to function in +term of leveraging, and building upon the Superset builds provided here. + +```bash +export DOCKER_DEFAULT_PLATFORM=linux/amd64 +``` + +Presumably, `linux/arm64/v8` would be more optimized for this generation +of chips, but less compatible across the ARM ecosystem. diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/installation/docker-compose.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/installation/docker-compose.mdx new file mode 100644 index 00000000000..04d14915860 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/installation/docker-compose.mdx @@ -0,0 +1,286 @@ +--- +title: Docker Compose +hide_title: true +sidebar_position: 5 +version: 1 +--- + +import useBaseUrl from "@docusaurus/useBaseUrl"; + +# Using Docker Compose + + +

+ +:::caution +Since `docker compose` is primarily designed to run a set of containers on **a single host** +and can't support requirements for **high availability**, we do not support nor recommend +using our `docker compose` constructs to support production-type use-cases. For single host +environments, we recommend using [minikube](https://minikube.sigs.k8s.io/docs/start/) along +with our [installing on k8s](https://superset.apache.org/admin-docs/installation/running-on-kubernetes) +documentation. +::: + +As mentioned in our [quickstart guide](/user-docs/quickstart), the fastest way to try +Superset locally is using Docker Compose on a Linux or Mac OSX +computer. Superset does not have official support for Windows. It's also the easiest +way to launch a fully functioning **development environment** quickly. + +Note that there are 4 major ways we support to run `docker compose`: + +1. **docker-compose.yml:** for interactive development, where we mount your local folder with the + frontend/backend files that you can edit and experience the changes you + make in the app in real time +1. **docker-compose-light.yml:** a lightweight configuration with minimal services (database, + Superset app, and frontend dev server) for development. Uses in-memory caching instead of Redis + and is designed for running multiple instances simultaneously +1. **docker-compose-non-dev.yml** where we just build a more immutable image based on the + local branch and get all the required images running. Changes in the local branch + at the time you fire this up will be reflected, but changes to the code + while `up` won't be reflected in the app +1. **docker-compose-image-tag.yml** where we fetch an image from docker-hub say for the + `5.0.0` release for instance, and fire it up so you can try it. Here what's in + the local branch has no effects on what's running, we just fetch and run + pre-built images from docker-hub. For `docker compose` to work along with the + Postgres image it boots up, you'll want to point to a `-dev`-suffixed TAG, as in + `export TAG=5.0.0-dev` or `export TAG=4.1.2-dev`, with `latest-dev` being the default. + The `dev` builds include the `psycopg2-binary` required to connect + to the Postgres database launched as part of the `docker compose` builds. + +More on these approaches after setting up the requirements for either. + +## Requirements + +Note that this documentation assumes that you have [Docker](https://www.docker.com) and +[git](https://git-scm.com/) installed. Note also that we used to use `docker-compose` but that +is on the path to deprecation so we now use `docker compose` instead. + +## 1. Clone Superset's GitHub repository + +[Clone Superset's repo](https://github.com/apache/superset) in your terminal with the +following command: + +```bash +git clone --depth=1 https://github.com/apache/superset.git +``` + +Once that command completes successfully, you should see a new `superset` folder in your +current directory. + +## 2. Launch Superset Through Docker Compose + +First let's assume you're familiar with `docker compose` mechanics. Here we'll refer generally +to `docker compose up` even though in some cases you may want to force a check for newer remote +images using `docker compose pull`, force a build with `docker compose build` or force a build +on latest base images using `docker compose build --pull`. In most cases though, the simple +`up` command should do just fine. Refer to docker compose docs for more information on the topic. + +### Option #1 - for an interactive development environment + +```bash +# The --build argument insures all the layers are up-to-date +docker compose up --build +``` + +:::tip +When running in development mode the `superset-node` +container needs to finish building assets in order for the UI to render properly. If you would just +like to try out Superset without making any code changes follow the steps documented for +`production` or a specific version below. +::: + +:::tip +By default, we mount the local superset-frontend folder here and run `npm install` as well +as `npm run dev` which triggers webpack to compile/bundle the frontend code. Depending +on your local setup, especially if you have less than 16GB of memory, it may be very slow to +perform those operations. In this case, we recommend you set the env var +`BUILD_SUPERSET_FRONTEND_IN_DOCKER` to `false`, and to run this locally instead in a terminal. +Simply trigger `npm i && npm run dev`, this should be MUCH faster. +::: + +:::tip +Sometimes, your npm-related state can get out-of-wack, running `npm run prune` from +the `superset-frontend/` folder will nuke the various' packages `node_module/` folders +and help you start fresh. In the context of `docker compose` setting +`export NPM_RUN_PRUNE=true` prior to running `docker compose up` will trigger that +from within docker. This will slow down the startup, but will fix various npm-related issues. +::: + +### Option #2 - lightweight development with multiple instances + +For a lighter development setup that uses fewer resources and supports running multiple instances: + +```bash +# Single lightweight instance (default port 9001) +docker compose -f docker-compose-light.yml up + +# Multiple instances with different ports +NODE_PORT=9001 docker compose -p superset-1 -f docker-compose-light.yml up +NODE_PORT=9002 docker compose -p superset-2 -f docker-compose-light.yml up +NODE_PORT=9003 docker compose -p superset-3 -f docker-compose-light.yml up +``` + +This configuration includes: +- PostgreSQL database (internal network only) +- Superset application server +- Frontend development server with webpack hot reloading +- In-memory caching (no Redis) +- Isolated volumes and networks per instance + +Access each instance at `http://localhost:{NODE_PORT}` (e.g., `http://localhost:9001`). + +### Option #3 - build a set of immutable images from the local branch + +```bash +docker compose -f docker-compose-non-dev.yml up +``` + +### Option #4 - boot up an official release + +```bash +# Set the version you want to run +export TAG=5.0.0 +# Fetch the tag you're about to check out (assuming you shallow-cloned the repo) +git fetch --depth=1 origin tag $TAG +# Could also fetch all tags too if you've got bandwidth to spare +# git fetch --tags +# Checkout the corresponding git ref +git checkout $TAG +# Fire up docker compose +docker compose -f docker-compose-image-tag.yml up +``` + +Here various release tags, github SHA, and latest `master` can be referenced by the TAG env var. +Refer to the docker-related documentation to learn more about existing tags you can point to +from Docker Hub. + +:::note +For option #2 and #3, we recommend checking out the release tag from the git repository +(ie: `git checkout 5.0.0`) for more guaranteed results. This ensures that the `docker-compose.*.yml` +configurations and that the mounted `docker/` scripts are in sync with the image you are +looking to fire up. +::: + +## `docker compose` tips & configuration + +:::caution +All of the content belonging to a Superset instance - charts, dashboards, users, etc. - is stored in +its metadata database. In production, this database should be backed up. The default installation +with docker compose will store that data in a PostgreSQL database contained in a Docker +[volume](https://docs.docker.com/storage/volumes/), which is not backed up. + +Again, **THE DOCKER-COMPOSE INSTALLATION IS NOT PRODUCTION-READY OUT OF THE BOX.** + +::: + +You should see a stream of logging output from the containers being launched on your machine. Once +this output slows, you should have a running instance of Superset on your local machine! To avoid +the wall of text on future runs, add the `-d` option to the end of the `docker compose up` command. + +### Configuring Further + +The following is for users who want to configure how Superset runs in Docker Compose; otherwise, you +can skip to the next section. + +You can install additional python packages and apply config overrides by following the steps +mentioned in [docker/README.md](https://github.com/apache/superset/tree/master/docker#configuration) + +Note that `docker/.env` sets the default environment variables for all the docker images +used by `docker compose`, and that `docker/.env-local` can be used to override those defaults. +Also note that `docker/.env-local` is referenced in our `.gitignore`, +preventing developers from risking committing potentially sensitive configuration to the repository. + +One important variable is `SUPERSET_LOAD_EXAMPLES` which determines whether the `superset_init` +container will populate example data and visualizations into the metadata database. These examples +are helpful for learning and testing out Superset but unnecessary for experienced users and +production deployments. The loading process can sometimes take a few minutes and a good amount of +CPU, so you may want to disable it on a resource-constrained device. + +For more advanced or dynamic configurations that are typically managed in a `superset_config.py` file +located in your `PYTHONPATH`, note that it can be done by providing a +`docker/pythonpath_dev/superset_config_docker.py` that will be ignored by git +(preventing you to commit/push your local configuration back to the repository). +The mechanics of this are in `docker/pythonpath_dev/superset_config.py` where you can see +that the logic runs a `from superset_config_docker import *` + +:::note +Users often want to connect to other databases from Superset. Currently, the easiest way to +do this is to modify the `docker-compose-non-dev.yml` file and add your database as a service that +the other services depend on (via `x-superset-depends-on`). Others have attempted to set +`network_mode: host` on the Superset services, but these generally break the installation, +because the configuration requires use of the Docker Compose DNS resolver for the service names. +If you have a good solution for this, let us know! +::: + +:::note +Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telemetry +data. Knowing the installation counts for different Superset versions informs the project's +decisions about patching and long-term support. Scarf purges personally identifiable information +(PII) and provides only aggregated statistics. + +To opt-out of this data collection for packages downloaded through the Scarf Gateway by your docker +compose based installation, edit the `x-superset-image:` line in your `docker-compose.yml` and +`docker-compose-non-dev.yml` files, replacing `apachesuperset.docker.scarf.sh/apache/superset` with +`apache/superset` to pull the image directly from Docker Hub. + +To disable the Scarf telemetry pixel, set the `SCARF_ANALYTICS` environment variable to `False` in +your terminal and/or in your `docker/.env` file. +::: + +## 3. Log in to Superset + +Your local Superset instance also includes a Postgres server to store your data and is already +pre-loaded with some example datasets that ship with Superset. You can access Superset now via your +web browser by visiting `http://localhost:8088`. Note that many browsers now default to `https` - if +yours is one of them, please make sure it uses `http`. + +Log in with the default username and password: + +```bash +username: admin +``` + +```bash +password: admin +``` + +## 4. Connecting Superset to your local database instance + +When running Superset using `docker` or `docker compose` it runs in its own docker container, as if +the Superset was running in a separate machine entirely. Therefore attempts to connect to your local +database with the hostname `localhost` won't work as `localhost` refers to the docker container +Superset is running in, and not your actual host machine. Fortunately, docker provides an easy way +to access network resources in the host machine from inside a container, and we will leverage this +capability to connect to our local database instance. + +Here the instructions are for connecting to postgresql (which is running on your host machine) from +Superset (which is running in its docker container). Other databases may have slightly different +configurations but gist would be same and boils down to 2 steps - + +1. **(Mac users may skip this step)** Configuring the local postgresql/database instance to accept +public incoming connections. By default, postgresql only allows incoming connections from +`localhost` and under Docker, unless you use `--network=host`, `localhost` will refer to different +endpoints on the host machine and in a docker container respectively. Allowing postgresql to accept +connections from the Docker involves making one-line changes to the files `postgresql.conf` and +`pg_hba.conf`; you can find helpful links tailored to your OS / PG version on the web easily for +this task. For Docker it suffices to only whitelist IPs `172.0.0.0/8` instead of `*`, but in any +case you are _warned_ that doing this in a production database _may_ have disastrous consequences as +you are opening your database to the public internet. +1. Instead of `localhost`, try using `host.docker.internal` (Mac users, Ubuntu) or `172.18.0.1` +(Linux users) as the hostname when attempting to connect to the database. This is a Docker internal +detail -- what is happening is that, in Mac systems, Docker Desktop creates a dns entry for the +hostname `host.docker.internal` which resolves to the correct address for the host machine, whereas +in Linux this is not the case (at least by default). If neither of these 2 hostnames work then you +may want to find the exact hostname you want to use, for that you can do `ifconfig` or +`ip addr show` and look at the IP address of `docker0` interface that must have been created by +Docker for you. Alternately if you don't even see the `docker0` interface try (if needed with sudo) +`docker network inspect bridge` and see if there is an entry for `"Gateway"` and note the IP +address. + +## 4. To build or not to build + +When running `docker compose up`, docker will build what is required behind the scene, but +may use the docker cache if assets already exist. Running `docker compose build` prior to +`docker compose up` or the equivalent shortcut `docker compose up --build` ensures that your +docker images match the definition in the repository. This should only apply to the main +docker-compose.yml file (default) and not to the alternative methods defined above. diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/installation/installation-methods.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/installation/installation-methods.mdx new file mode 100644 index 00000000000..0e8f11b7d57 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/installation/installation-methods.mdx @@ -0,0 +1,56 @@ +--- +title: Installation Methods +hide_title: true +sidebar_position: 2 +version: 1 +--- + +import useBaseUrl from "@docusaurus/useBaseUrl"; + +# Installation Methods + +How should you install Superset? Here's a comparison of the different options. It will help if you've first read the [Architecture](/admin-docs/installation/architecture) page to understand Superset's different components. + +The fundamental trade-off is between you needing to do more of the detail work yourself vs. using a more complex deployment route that handles those details. + +## [Docker Compose](/admin-docs/installation/docker-compose) + +**Summary:** This takes advantage of containerization while remaining simpler than Kubernetes. This is the best way to try out Superset; it's also useful for developing & contributing back to Superset. + +If you're not just demoing the software, you'll need a moderate understanding of Docker to customize your deployment and avoid a few risks. Even when fully-optimized this is not as robust a method as Kubernetes when it comes to large-scale production deployments. + +You manage a superset-config.py file and a docker-compose.yml file. Docker Compose brings up all the needed services - the Superset application, a Postgres metadata DB, Redis cache, Celery worker and beat. They are automatically connected to each other. + +**Responsibilities** + +You will need to back up your metadata DB. That could mean backing up the service running as a Docker container and its volume; ideally you are running Postgres as a service outside of that container and backing up that service. + +You will also need to extend the Superset docker image. The default `lean` images do not contain drivers needed to access your metadata database (Postgres or MySQL), nor to access your data warehouse, nor the headless browser needed for Alerts & Reports. You could run a `-dev` image while demoing Superset, which has some of this, but you'll still need to install the driver for your data warehouse. The `-dev` images run as root, which is not recommended for production. + +Ideally you will build your own image of Superset that extends `lean`, adding what your deployment needs. See [Building your own production Docker image](/admin-docs/installation/docker-builds/#building-your-own-production-docker-image). + +## [Kubernetes (K8s)](/admin-docs/installation/kubernetes) + +**Summary:** This is the best-practice way to deploy a production instance of Superset, but has the steepest skill requirement - someone who knows Kubernetes. + +You will deploy Superset into a K8s cluster. The most common method is using the community-maintained Helm chart, though work is now underway to implement [SIP-149 - a Kubernetes Operator for Superset](https://github.com/apache/superset/issues/31408). + +A K8s deployment can scale up and down based on usage and deploy rolling updates with zero downtime - features that big deployments appreciate. + +**Responsibilities** + +You will need to build your own Docker image, and back up your metadata DB, both as described in Docker Compose above. You'll also need to customize your Helm chart values and deploy and maintain your Kubernetes cluster. + +## [PyPI (Python)](/admin-docs/installation/pypi) + +**Summary:** This is the only method that requires no knowledge of containers. It requires the most hands-on work to deploy, connect, and maintain each component. + +You install Superset as a Python package and run it that way, providing your own metadata database. Superset has documentation on how to install this way, but it is updated infrequently. + +If you want caching, you'll set up Redis or RabbitMQ. If you want Alerts & Reports, you'll set up Celery. + +**Responsibilities** + +You will need to get the component services running and communicating with each other. You'll need to arrange backups of your metadata database. + +When upgrading, you'll need to manage the system environment and packages and ensure all components have functional dependencies. diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/installation/kubernetes.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/installation/kubernetes.mdx new file mode 100644 index 00000000000..c18bf803f92 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/installation/kubernetes.mdx @@ -0,0 +1,451 @@ +--- +title: Kubernetes +hide_title: true +sidebar_position: 3 +version: 1 +--- + +import useBaseUrl from "@docusaurus/useBaseUrl"; + +# Installing on Kubernetes + + +

+ +Running Superset on Kubernetes is supported with the provided [Helm](https://helm.sh/) chart +found in the official [Superset helm repository](https://apache.github.io/superset/index.yaml). + +## Prerequisites + +- A Kubernetes cluster +- Helm installed + +:::note +For simpler, single host environments, we recommend using +[minikube](https://minikube.sigs.k8s.io/docs/start/) which is easy to setup on many platforms +and works fantastically well with the Helm chart referenced here. +::: + +## Running + +1. Add the Superset helm repository + +```sh +helm repo add superset https://apache.github.io/superset +"superset" has been added to your repositories +``` + +2. View charts in repo + +```sh +helm search repo superset +NAME CHART VERSION APP VERSION DESCRIPTION +superset/superset 0.1.1 1.0 Apache Superset is a modern, enterprise-ready b... +``` + +3. Configure your setting overrides + +Just like any typical Helm chart, you'll need to craft a `values.yaml` file that would define/override any of the values exposed into the default [values.yaml](https://github.com/apache/superset/tree/master/helm/superset/values.yaml), or from any of the dependent charts it depends on: + +- [bitnami/redis](https://artifacthub.io/packages/helm/bitnami/redis) +- [bitnami/postgresql](https://artifacthub.io/packages/helm/bitnami/postgresql) + +More info down below on some important overrides you might need. + +4. Install and run + +```sh +helm upgrade --install --values my-values.yaml superset superset/superset +``` + +You should see various pods popping up, such as: + +```sh +kubectl get pods +NAME READY STATUS RESTARTS AGE +superset-celerybeat-7cdcc9575f-k6xmc 1/1 Running 0 119s +superset-f5c9c667-dw9lp 1/1 Running 0 4m7s +superset-f5c9c667-fk8bk 1/1 Running 0 4m11s +superset-init-db-zlm9z 0/1 Completed 0 111s +superset-postgresql-0 1/1 Running 0 6d20h +superset-redis-master-0 1/1 Running 0 6d20h +superset-worker-75b48bbcc-jmmjr 1/1 Running 0 4m8s +superset-worker-75b48bbcc-qrq49 1/1 Running 0 4m12s +``` + +The exact list will depend on some of your specific configuration overrides but you should generally expect: + +- N `superset-xxxx-yyyy` and `superset-worker-xxxx-yyyy` pods (depending on your `supersetNode.replicaCount` and `supersetWorker.replicaCount` values) +- 1 `superset-postgresql-0` depending on your postgres settings +- 1 `superset-redis-master-0` depending on your redis settings +- 1 `superset-celerybeat-xxxx-yyyy` pod if you have `supersetCeleryBeat.enabled = true` in your values overrides + +1. Access it + +The chart will publish appropriate services to expose the Superset UI internally within your k8s cluster. To access it externally you will have to either: + +- Configure the Service as a `LoadBalancer` or `NodePort` +- Set up an `Ingress` for it - the chart includes a definition, but will need to be tuned to your needs (hostname, tls, annotations etc...) +- Run `kubectl port-forward superset-xxxx-yyyy :8088` to directly tunnel one pod's port into your localhost + +Depending how you configured external access, the URL will vary. Once you've identified the appropriate URL you can log in with: + +- user: `admin` +- password: `admin` + +## Important settings + +### Security settings + +Default security settings and passwords are included but you **MUST** update them to run `prod` instances, in particular: + +```yaml +postgresql: + postgresqlPassword: superset +``` + +Make sure, you set a unique strong complex alphanumeric string for your SECRET_KEY and use a tool to help you generate +a sufficiently random sequence. + +- To generate a good key you can run, `openssl rand -base64 42` + +```yaml +configOverrides: + secret: | + SECRET_KEY = 'YOUR_OWN_RANDOM_GENERATED_SECRET_KEY' +``` + +If you want to change the previous secret key then you should rotate the keys. +Default secret key for kubernetes deployment is `thisISaSECRET_1234` + +```yaml +configOverrides: + my_override: | + PREVIOUS_SECRET_KEY = 'YOUR_PREVIOUS_SECRET_KEY' + SECRET_KEY = 'YOUR_OWN_RANDOM_GENERATED_SECRET_KEY' +init: + command: + - /bin/sh + - -c + - | + . {{ .Values.configMountPath }}/superset_bootstrap.sh + superset re-encrypt-secrets + . {{ .Values.configMountPath }}/superset_init.sh +``` + +:::note +Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics. + +To opt-out of this data collection in your Helm-based installation, edit the `repository:` line in your `helm/superset/values.yaml` file, replacing `apachesuperset.docker.scarf.sh/apache/superset` with `apache/superset` to pull the image directly from Docker Hub. +::: + +### Dependencies + +Install additional packages and do any other bootstrap configuration in the bootstrap script. +For production clusters it's recommended to build own image with this step done in CI. + +:::note + +Superset requires a Python DB-API database driver and a SQLAlchemy +dialect to be installed for each datastore you want to connect to. + +See [Install Database Drivers](/user-docs/databases#installing-database-drivers) for more information. +It is recommended that you refer to versions listed in +[pyproject.toml](https://github.com/apache/superset/blob/master/pyproject.toml) +instead of hard-coding them in your bootstrap script, as seen below. + +::: + +The following example installs the drivers for BigQuery and Elasticsearch, allowing you to connect to these data sources within your Superset setup: + +```yaml +bootstrapScript: | + #!/bin/bash + uv pip install .[postgres] \ + .[bigquery] \ + .[elasticsearch] &&\ + if [ ! -f ~/bootstrap ]; then echo "Running Superset with uid {{ .Values.runAsUser }}" > ~/bootstrap; fi +``` + +### superset_config.py + +The default `superset_config.py` is fairly minimal and you will very likely need to extend it. This is done by specifying one or more key/value entries in `configOverrides`, e.g.: + +```yaml +configOverrides: + my_override: | + # This will make sure the redirect_uri is properly computed, even with SSL offloading + ENABLE_PROXY_FIX = True + FEATURE_FLAGS = { + "DYNAMIC_PLUGINS": True + } +``` + +Those will be evaluated as Helm templates and therefore will be able to reference other `values.yaml` variables e.g. `{{ .Values.ingress.hosts[0] }}` will resolve to your ingress external domain. + +The entire `superset_config.py` will be installed as a secret, so it is safe to pass sensitive parameters directly... however it might be more readable to use secret env variables for that. + +Full python files can be provided by running `helm upgrade --install --values my-values.yaml --set-file configOverrides.oauth=set_oauth.py` + +### Environment Variables + +Those can be passed as key/values either with `extraEnv` or `extraSecretEnv` if they're sensitive. They can then be referenced from `superset_config.py` using e.g. `os.environ.get("VAR")`. + +```yaml +extraEnv: + SMTP_HOST: smtp.gmail.com + SMTP_USER: user@gmail.com + SMTP_PORT: "587" + SMTP_MAIL_FROM: user@gmail.com + +extraSecretEnv: + SMTP_PASSWORD: xxxx + +configOverrides: + smtp: | + import ast + SMTP_HOST = os.getenv("SMTP_HOST","localhost") + SMTP_STARTTLS = ast.literal_eval(os.getenv("SMTP_STARTTLS", "True")) + SMTP_SSL = ast.literal_eval(os.getenv("SMTP_SSL", "False")) + SMTP_USER = os.getenv("SMTP_USER","superset") + SMTP_PORT = os.getenv("SMTP_PORT",25) + SMTP_PASSWORD = os.getenv("SMTP_PASSWORD","superset") +``` + +### System packages + +If new system packages are required, they can be installed before application startup by overriding the container's `command`, e.g.: + +```yaml +supersetWorker: + command: + - /bin/sh + - -c + - | + apt update + apt install -y somepackage + apt autoremove -yqq --purge + apt clean + + # Run celery worker + . {{ .Values.configMountPath }}/superset_bootstrap.sh; celery --app=superset.tasks.celery_app:app worker +``` + +### Data sources + +Data source definitions can be automatically declared by providing key/value yaml definitions in `extraConfigs`: + +```yaml +extraConfigs: + import_datasources.yaml: | + databases: + - allow_file_upload: true + allow_ctas: true + allow_cvas: true + database_name: example-db + extra: "{\r\n \"metadata_params\": {},\r\n \"engine_params\": {},\r\n \"\ + metadata_cache_timeout\": {},\r\n \"schemas_allowed_for_file_upload\": []\r\n\ + }" + sqlalchemy_uri: example://example-db.local + tables: [] +``` + +Those will also be mounted as secrets and can include sensitive parameters. + +## Configuration Examples + +### Setting up OAuth + +:::note + +OAuth setup requires that the [authlib](https://authlib.org/) Python library is installed. This can +be done using `pip` by updating the `bootstrapScript`. See the [Dependencies](#dependencies) section +for more information. + +::: + +```yaml +extraEnv: + AUTH_DOMAIN: example.com + +extraSecretEnv: + GOOGLE_KEY: xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com + GOOGLE_SECRET: xxxxxxxxxxxxxxxxxxxxxxxx + +configOverrides: + enable_oauth: | + # This will make sure the redirect_uri is properly computed, even with SSL offloading + ENABLE_PROXY_FIX = True + + from flask_appbuilder.security.manager import AUTH_OAUTH + AUTH_TYPE = AUTH_OAUTH + OAUTH_PROVIDERS = [ + { + "name": "google", + "icon": "fa-google", + "token_key": "access_token", + "remote_app": { + "client_id": os.getenv("GOOGLE_KEY"), + "client_secret": os.getenv("GOOGLE_SECRET"), + "api_base_url": "https://www.googleapis.com/oauth2/v2/", + "client_kwargs": {"scope": "email profile"}, + "request_token_url": None, + "access_token_url": "https://accounts.google.com/o/oauth2/token", + "authorize_url": "https://accounts.google.com/o/oauth2/auth", + "authorize_params": {"hd": os.getenv("AUTH_DOMAIN", "")} + }, + } + ] + + # Map Authlib roles to superset roles + AUTH_ROLE_ADMIN = 'Admin' + AUTH_ROLE_PUBLIC = 'Public' + + # Will allow user self registration, allowing to create Flask users from Authorized User + AUTH_USER_REGISTRATION = True + + # The default user self registration role + AUTH_USER_REGISTRATION_ROLE = "Admin" +``` + +### Enable Alerts and Reports + +For this, as per the [Alerts and Reports doc](/admin-docs/configuration/alerts-reports), you will need to: + +#### Install a supported webdriver in the Celery worker + +This is done either by using a custom image that has the webdriver pre-installed, or installing at startup time by overriding the `command`. Here's a working example for `chromedriver`: + +```yaml +supersetWorker: + command: + - /bin/sh + - -c + - | + # Install chrome webdriver + # See https://github.com/apache/superset/blob/4fa3b6c7185629b87c27fc2c0e5435d458f7b73d/docs/src/pages/admin-docs/installation/email_reports.mdx + apt-get update + apt-get install -y wget + wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb + apt-get install -y --no-install-recommends ./google-chrome-stable_current_amd64.deb + wget https://chromedriver.storage.googleapis.com/88.0.4324.96/chromedriver_linux64.zip + apt-get install -y zip + unzip chromedriver_linux64.zip + chmod +x chromedriver + mv chromedriver /usr/bin + apt-get autoremove -yqq --purge + apt-get clean + rm -f google-chrome-stable_current_amd64.deb chromedriver_linux64.zip + + # Run + . {{ .Values.configMountPath }}/superset_bootstrap.sh; celery --app=superset.tasks.celery_app:app worker +``` + +#### Run the Celery beat + +This pod will trigger the scheduled tasks configured in the alerts and reports UI section: + +```yaml +supersetCeleryBeat: + enabled: true +``` + +#### Configure the appropriate Celery jobs and SMTP/Slack settings + +```yaml +extraEnv: + SMTP_HOST: smtp.gmail.com + SMTP_USER: user@gmail.com + SMTP_PORT: "587" + SMTP_MAIL_FROM: user@gmail.com + +extraSecretEnv: + SLACK_API_TOKEN: xoxb-xxxx-yyyy + SMTP_PASSWORD: xxxx-yyyy + +configOverrides: + feature_flags: | + import ast + + FEATURE_FLAGS = { + "ALERT_REPORTS": True + } + + SMTP_HOST = os.getenv("SMTP_HOST","localhost") + SMTP_STARTTLS = ast.literal_eval(os.getenv("SMTP_STARTTLS", "True")) + SMTP_SSL = ast.literal_eval(os.getenv("SMTP_SSL", "False")) + SMTP_USER = os.getenv("SMTP_USER","superset") + SMTP_PORT = os.getenv("SMTP_PORT",25) + SMTP_PASSWORD = os.getenv("SMTP_PASSWORD","superset") + SMTP_MAIL_FROM = os.getenv("SMTP_MAIL_FROM","superset@superset.com") + + SLACK_API_TOKEN = os.getenv("SLACK_API_TOKEN",None) + celery_conf: | + from celery.schedules import crontab + + class CeleryConfig: + broker_url = f"redis://{env('REDIS_HOST')}:{env('REDIS_PORT')}/0" + imports = ( + "superset.sql_lab", + "superset.tasks.cache", + "superset.tasks.scheduler", + ) + result_backend = f"redis://{env('REDIS_HOST')}:{env('REDIS_PORT')}/0" + task_annotations = { + "sql_lab.get_sql_results": { + "rate_limit": "100/s", + }, + } + beat_schedule = { + "reports.scheduler": { + "task": "reports.scheduler", + "schedule": crontab(minute="*", hour="*"), + }, + "reports.prune_log": { + "task": "reports.prune_log", + 'schedule': crontab(minute=0, hour=0), + }, + 'cache-warmup-hourly': { + "task": "cache-warmup", + "schedule": crontab(minute="*/30", hour="*"), + "kwargs": { + "strategy_name": "top_n_dashboards", + "top_n": 10, + "since": "7 days ago", + }, + } + } + + CELERY_CONFIG = CeleryConfig + reports: | + EMAIL_PAGE_RENDER_WAIT = 60 + WEBDRIVER_BASEURL = "http://{{ template "superset.fullname" . }}:{{ .Values.service.port }}/" + WEBDRIVER_BASEURL_USER_FRIENDLY = "https://www.example.com/" + WEBDRIVER_TYPE= "chrome" + WEBDRIVER_OPTION_ARGS = [ + "--force-device-scale-factor=2.0", + "--high-dpi-support=2.0", + "--headless", + "--disable-gpu", + "--disable-dev-shm-usage", + # This is required because our process runs as root (in order to install pip packages) + "--no-sandbox", + "--disable-setuid-sandbox", + "--disable-extensions", + ] +``` + +### Load the Examples data and dashboards + +If you are trying Superset out and want some data and dashboards to explore, you can load some examples by creating a `my_values.yaml` and deploying it as described above in the **Configure your setting overrides** step of the **Running** section. +To load the examples, add the following to the `my_values.yaml` file: + +```yaml +init: + loadExamples: true +``` + +:::resources +- [Tutorial: Mastering Data Visualization — Installing Superset on Kubernetes with Helm Chart](https://mahira-technology.medium.com/mastering-data-visualization-installing-superset-on-kubernetes-cluster-using-helm-chart-e4ec99199e1e) +- [Tutorial: Installing Apache Superset in Kubernetes](https://aws.plainenglish.io/installing-apache-superset-in-kubernetes-1aec192ac495) +::: diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/installation/pypi.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/installation/pypi.mdx new file mode 100644 index 00000000000..820ac776b95 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/installation/pypi.mdx @@ -0,0 +1,164 @@ +--- +title: PyPI +hide_title: true +sidebar_position: 4 +version: 1 +--- + +import useBaseUrl from "@docusaurus/useBaseUrl"; + +# Installing Superset from PyPI + + +

+ +This page describes how to install Superset using the `apache_superset` package [published on PyPI](https://pypi.org/project/apache_superset/). + +## OS Dependencies + +Superset stores database connection information in its metadata database. For that purpose, we use +the cryptography Python library to encrypt connection passwords. Unfortunately, this library has OS +level dependencies. + +**Debian and Ubuntu** + +Ubuntu **24.04** uses python 3.12 per default, which currently is not supported by Superset. You need to add a second python installation of 3.11 and install the required additional dependencies. +```bash +sudo add-apt-repository ppa:deadsnakes/ppa +sudo apt update +sudo apt install python3.11 python3.11-dev python3.11-venv build-essential libssl-dev libffi-dev libsasl2-dev libldap2-dev default-libmysqlclient-dev +``` + +In Ubuntu **20.04 and 22.04** the following command will ensure that the required dependencies are installed: + +```bash +sudo apt-get install build-essential libssl-dev libffi-dev python3-dev python3-pip libsasl2-dev libldap2-dev default-libmysqlclient-dev +``` + +In Ubuntu **before 20.04** the following command will ensure that the required dependencies are installed: + +```bash +sudo apt-get install build-essential libssl-dev libffi-dev python-dev python-pip libsasl2-dev libldap2-dev default-libmysqlclient-dev +``` + +**Fedora and RHEL-derivative Linux distributions** + +Install the following packages using the `yum` package manager: + +```bash +sudo yum install gcc gcc-c++ libffi-devel python-devel python-pip python-wheel openssl-devel cyrus-sasl-devel openldap-devel +``` + +In more recent versions of CentOS and Fedora, you may need to install a slightly different set of packages using `dnf`: + +```bash +sudo dnf install gcc gcc-c++ libffi-devel python3-devel python3-pip python3-wheel openssl-devel cyrus-sasl-devel openldap-devel +``` + +Also, on CentOS, you may need to upgrade pip for the install to work: + +```bash +pip3 install --upgrade pip +``` + +**Mac OS X** + +If you're not on the latest version of OS X, we recommend upgrading because we've found that many +issues people have run into are linked to older versions of Mac OS X. After updating, install the +latest version of XCode command line tools: + +```bash +xcode-select --install +``` + +We don't recommend using the system installed Python. Instead, first install the +[homebrew](https://brew.sh/) manager and then run the following commands: + +```bash +brew install readline pkg-config libffi openssl mysql postgresql@14 +``` + +You should install a recent version of Python. Refer to the +[pyproject.toml](https://github.com/apache/superset/blob/master/pyproject.toml) file for a list of Python +versions officially supported by Superset. We'd recommend using a Python version manager +like [pyenv](https://github.com/pyenv/pyenv) +(and also [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv)). + +Let's also make sure we have the latest version of `pip` and `setuptools`: + +```bash +pip install --upgrade setuptools pip +``` + +Lastly, you may need to set LDFLAGS and CFLAGS for certain Python packages to properly build. You can export these variables with: + +```bash +export LDFLAGS="-L$(brew --prefix openssl)/lib" +export CFLAGS="-I$(brew --prefix openssl)/include" +``` + +These will now be available when pip installing requirements. + +## Python Virtual Environment + +We highly recommend installing Superset inside of a virtual environment. + +You can create and activate a virtual environment using the following commands. Ensure you are using a compatible version of python. You might have to explicitly use for example `python3.11` instead of `python3`. + +```bash +# virtualenv is shipped in Python 3.6+ as venv instead of pyvenv. +# See https://docs.python.org/3.6/library/venv.html +python3 -m venv venv +. venv/bin/activate +``` + +Or with pyenv-virtualenv: + +```bash +# Here we name the virtual env 'superset' +pyenv virtualenv superset +pyenv activate superset +``` + +Once you activated your virtual environment, all of the Python packages you install or uninstall +will be confined to this environment. You can exit the environment by running `deactivate` on the +command line. + +### Installing and Initializing Superset + +First, start by installing `apache_superset`: + +```bash +pip install apache_superset +``` + +Then, define mandatory configurations, SECRET_KEY and FLASK_APP: +```bash +export SUPERSET_SECRET_KEY=YOUR-SECRET-KEY # For production use, make sure this is a strong key, for example generated using `openssl rand -base64 42`. See https://superset.apache.org/admin-docs/configuration/configuring-superset#specifying-a-secret_key +export FLASK_APP=superset +``` + +Then, you need to initialize the database: + +```bash +superset db upgrade +``` + +Finish installing by running through the following commands: + +```bash +# Create an admin user in your metadata database (use `admin` as username to be able to load the examples) +superset fab create-admin + +# Load some data to play with +superset load_examples + +# Create default roles and permissions +superset init + +# To start a development web server on port 8088, use -p to bind to another port +superset run -p 8088 --with-threads --reload --debugger +``` + +If everything worked, you should be able to navigate to `hostname:port` in your browser (e.g. +locally by default at `localhost:8088`) and login using the username and password you created. diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/installation/upgrading-superset.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/installation/upgrading-superset.mdx new file mode 100644 index 00000000000..0cf092a5a06 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/installation/upgrading-superset.mdx @@ -0,0 +1,61 @@ +--- +title: Upgrading Superset +hide_title: true +sidebar_position: 6 +version: 1 +--- + +# Upgrading Superset + +## Docker Compose + +First, make sure to shut down the running containers in Docker Compose: + +```bash +docker compose down +``` + +Next, update the folder that mirrors the `superset` repo through git: + +```bash +git pull origin master +``` + +Then, restart the containers and any changed Docker images will be automatically pulled down: + +```bash +docker compose up +``` + +## Updating Superset Manually + +To upgrade superset in a native installation, run the following commands: + +```bash +pip install apache_superset --upgrade +``` + +## Upgrading the Metadata Database + +Migrate the metadata database by running: + +```bash +superset db upgrade +superset init +``` + +While upgrading superset should not delete your charts and dashboards, we recommend following best +practices and to backup your metadata database before upgrading. Before upgrading production, we +recommend upgrading in a staging environment and upgrading production finally during off-peak usage. + +## Breaking Changes + +For a detailed list of breaking changes and migration notes for each version, see +[UPDATING.md](https://github.com/apache/superset/blob/master/UPDATING.md). + +This file documents backwards-incompatible changes and provides guidance for migrating between +major versions, including: +- Configuration changes +- API changes +- Database migrations +- Deprecated features diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/security/cves.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/security/cves.mdx new file mode 100644 index 00000000000..a8c2cbb95c2 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/security/cves.mdx @@ -0,0 +1,140 @@ +--- +title: CVEs fixed by release +sidebar_position: 2 +--- +#### Version 6.0.0 + +| CVE | Title | Affected | +|:---------------|:-----------------------------------------------------------------------------------|---------:| +| CVE-2026-23980 | Improper Neutralization of Special Elements used in a SQL Command | < 6.0.0 | +| CVE-2026-23982 | Improper Authorization in Dataset Creation Allows Access Control Bypass | < 6.0.0 | +| CVE-2026-23983 | Information Disclosure of sensitive user info via Tags | < 6.0.0 | +| CVE-2026-23984 | SQLLab Read-Only Bypass on PostgreSQL (DML execution) | < 6.0.0 | + +#### Version 5.0.0 + +| CVE | Title | Affected | +|:---------------|:-----------------------------------------------------------------------------------|---------:| +| CVE-2025-55673 | Exposure of Sensitive Information to an Unauthorized Actor | < 5.0.0 | +| CVE-2025-55674 | Improper Neutralization of Special Elements used in an SQL Command | < 5.0.0 | +| CVE-2025-55675 | Improper Access Control leading to Information Disclosure | < 5.0.0 | + +#### Version 4.1.3 + +| CVE | Title | Affected | +|:---------------|:-----------------------------------------------------------------------------------|---------:| +| CVE-2025-55672 | Improper Neutralization of Input During Web Page Generation | < 4.1.3 | + +#### Version 4.1.2 + +| CVE | Title | Affected | +|:---------------|:-----------------------------------------------------------------------------------|---------:| +| CVE-2025-27696 | Improper authorization leading to resource ownership takeover | < 4.1.2 | +| CVE-2025-48912 | Improper authorization bypass on row level security via SQL Injection | < 4.1.2 | +| CVE-2026-23969 | Exposure of Sensitive Information via Incomplete ClickHouse Function Filtering | < 4.1.2 | + +#### Version 4.1.0 + +| CVE | Title | Affected | +|:---------------|:-----------------------------------------------------------------------------------|---------:| +| CVE-2024-53947 | Improper SQL authorisation, parse for specific postgres functions | < 4.1.0 | +| CVE-2024-53948 | Error verbosity exposes metadata in analytics databases | < 4.1.0 | +| CVE-2024-53949 | Lower privilege users are able to create Role when FAB_ADD_SECURITY_API is enabled | < 4.1.0 | +| CVE-2024-55633 | SQLLab Improper readonly query validation allows unauthorized write access | < 4.1.0 | + +#### Version 4.0.2 + +| CVE | Title | Affected | +|:---------------|:----------------------------|---------:| +| CVE-2024-39887 | Improper SQL authorization | < 4.0.1 | + +#### Version 3.1.3, 4.0.1 + +| CVE | Title | Affected | +|:---------------|:----------------------------|----------------------------:| +| CVE-2024-34693 | Server arbitrary file read | < 3.1.3, >= 4.0.0, < 4.0.1 | + +#### Version 3.1.2 + +| CVE | Title | Affected | +|:---------------|:--------------------------------------------------------|---------:| +| CVE-2024-28148 | Incorrect datasource authorization on explore REST API | < 3.1.2 | + +#### Version 3.0.4, 3.1.1 + +| CVE | Title | Affected | +|:---------------|:-----------------------------------------------------------------------------|----------------------------:| +| CVE-2024-27315 | Improper error handling on alerts | < 3.0.4, >= 3.1.0, < 3.1.1 | +| CVE-2024-24773 | Improper validation of SQL statements allows for unauthorized access to data | < 3.0.4, >= 3.1.0, < 3.1.1 | +| CVE-2024-24772 | Improper Neutralisation of custom SQL on embedded context | < 3.0.4, >= 3.1.0, < 3.1.1 | +| CVE-2024-24779 | Improper data authorization when creating a new dataset | < 3.0.4, >= 3.1.0, < 3.1.1 | +| CVE-2024-26016 | Improper authorization validation on dashboards and charts import | < 3.0.4, >= 3.1.0, < 3.1.1 | + +#### Version 3.0.3 + +| CVE | Title | Affected | +|:---------------|:----------------------------------------------|---------:| +| CVE-2023-49657 | Stored XSS in Dashboard Title and Chart Title | < 3.0.3 | + +#### Version 3.0.2, 2.1.3 + +| CVE | Title | Affected | +|:---------------|:------------------------------------------------------------|---------------------------:| +| CVE-2023-46104 | Allows for uncontrolled resource consumption via a ZIP bomb | < 2.1.3, >= 3.0.0, < 3.0.2 | +| CVE-2023-49736 | SQL Injection on where_in JINJA macro | < 2.1.3, >= 3.0.0, < 3.0.2 | +| CVE-2023-49734 | Privilege Escalation Vulnerability | < 2.1.3, >= 3.0.0, < 3.0.2 | + +#### Version 3.0.0 + +| CVE | Title | Affected | +|:---------------|:------------------------------------------------------------------------|---------:| +| CVE-2023-42502 | Open Redirect Vulnerability | < 3.0.0 | +| CVE-2023-42505 | Sensitive information disclosure on db connection details | < 3.0.0 | + +#### Version 2.1.3 + +| CVE | Title | Affected | +|:---------------|:------------------------------------------------------------------------|---------:| +| CVE-2023-42504 | Lack of rate limiting allows for possible denial of service | < 2.1.3 | + +#### Version 2.1.2 + +| CVE | Title | Affected | +|:---------------|:------------------------------------------------------------------------|---------:| +| CVE-2023-40610 | Privilege escalation with default examples database | < 2.1.2 | +| CVE-2023-42501 | Unnecessary read permissions within the Gamma role | < 2.1.2 | +| CVE-2023-43701 | Stored XSS on API endpoint | < 2.1.2 | + +#### Version 2.1.1 + +| CVE | Title | Affected | +|:---------------|:------------------------------------------------------------------------|---------:| +| CVE-2023-36387 | Improper API permission for low privilege users | < 2.1.1 | +| CVE-2023-36388 | Improper API permission for low privilege users allows for SSRF | < 2.1.1 | +| CVE-2023-27523 | Improper data permission validation on Jinja templated queries | < 2.1.1 | +| CVE-2023-27526 | Improper Authorization check on import charts | < 2.1.1 | +| CVE-2023-39264 | Stack traces enabled by default | < 2.1.1 | +| CVE-2023-39265 | Possible Unauthorized Registration of SQLite Database Connections | < 2.1.1 | +| CVE-2023-37941 | Metadata db write access can lead to remote code execution | < 2.1.1 | +| CVE-2023-32672 | SQL parser edge case bypasses data access authorization | < 2.1.1 | + +#### Version 2.1.0 + +| CVE | Title | Affected | +|:---------------|:------------------------------------------------------------------------|---------:| +| CVE-2023-25504 | Possible SSRF on import datasets | < 2.1.0 | +| CVE-2023-27524 | Session validation vulnerability when using provided default SECRET_KEY | < 2.1.0 | +| CVE-2023-27525 | Incorrect default permissions for Gamma role | < 2.1.0 | +| CVE-2023-30776 | Database connection password leak | < 2.1.0 | + +#### Version 2.0.1 + +| CVE | Title | Affected | +|:---------------|:------------------------------------------------------------|------------------: | +| CVE-2022-41703 | SQL injection vulnerability in adhoc clauses | < 2.0.1 or < 1.5.2 | +| CVE-2022-43717 | Cross-Site Scripting on dashboards | < 2.0.1 or < 1.5.2 | +| CVE-2022-43718 | Cross-Site Scripting vulnerability on upload forms | < 2.0.1 or < 1.5.2 | +| CVE-2022-43719 | Cross Site Request Forgery (CSRF) on accept, request access | < 2.0.1 or < 1.5.2 | +| CVE-2022-43720 | Improper rendering of user input | < 2.0.1 or < 1.5.2 | +| CVE-2022-43721 | Open Redirect Vulnerability | < 2.0.1 or < 1.5.2 | +| CVE-2022-45438 | Dashboard metadata information leak | < 2.0.1 or < 1.5.2 | diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/security/securing_superset.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/security/securing_superset.mdx new file mode 100644 index 00000000000..92d42e385e0 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/security/securing_superset.mdx @@ -0,0 +1,179 @@ +--- +title: Securing Your Superset Installation for Production +sidebar_position: 3 +--- + +> *This guide applies to Apache Superset version 4.0 and later and is an evolving set of best practices that administrators should adapt to their specific deployment architecture.* + +The default Apache Superset configuration is optimized for ease of use and development, not for security. For any production deployment, it is **critical** that you review and apply the following security configurations to harden your instance, protect user data, and prevent unauthorized access. + +This guide provides a comprehensive checklist of essential security configurations and best practices. + +### **Critical Prerequisites: HTTPS/TLS Configuration** + +Running Superset without HTTPS (TLS) is not secure. Without it, all network traffic—including user credentials, session tokens, and sensitive data—is sent in cleartext and can be easily intercepted. + +* **Use a Reverse Proxy:** Your Superset instance should always be deployed behind a reverse proxy (e.g., Nginx, Traefik) or a load balancer (e.g., AWS ALB, Google Cloud Load Balancer) that is configured to handle HTTPS termination. +* **Enforce Modern TLS:** Configure your proxy to enforce TLS 1.2 or higher with strong, industry-standard cipher suites. +* **Implement HSTS:** Use the HTTP Strict Transport Security (HSTS) header to ensure browsers only connect to your Superset instance over HTTPS. This can be configured in your reverse proxy or within Superset's Talisman settings. + +### **`SUPERSET_SECRET_KEY` Management (CRITICAL)** + +This is the most critical security setting for your Superset instance. It is used to sign all session cookies and encrypt sensitive information in the metadata database, such as database connection credentials. + +* **Generate a Unique, Strong Key:** A unique key must be generated for every Superset instance. Use a cryptographically secure method to create it. + ```bash + # Example using openssl to generate a strong key + openssl rand -base64 42 + ``` +* **Store the Key Securely:** The key must be kept confidential. The recommended approach is to store it as an environment variable or in a secrets management system (e.g., AWS Secrets Manager, HashiCorp Vault). **Do not hardcode the key in `superset_config.py` or commit it to version control.** + ```python + # In superset_config.py + import os + SECRET_KEY = os.environ.get('SUPERSET_SECRET_KEY') + ``` + +> #### ⚠️ Warning: Your `SUPERSET_SECRET_KEY` Must Be Unique +> +> **NEVER** reuse the same `SUPERSET_SECRET_KEY` across different environments (e.g., development, staging, production) or different Superset instances. Reusing a key allows cryptographically signed session cookies to be used across those instances, which can lead to a full authentication bypass if a cookie is compromised. Treat this key like a master password. + +### **Session Management Security (CRITICAL)** + +Properly configuring user sessions is essential to prevent session hijacking and ensure that sessions are terminated correctly. + +#### **Use a Server-Side Session Backend (Strongly Recommended for Production)** + +The default stateless cookie-based session handling presents challenges for immediate session invalidation upon logout. For all production deployments, we strongly recommend configuring an optional server-side session backend like Redis, Memcached, or a database. This ensures that session data is stored securely on the server and can be instantly destroyed upon logout, rendering any copied session cookies immediately useless. + +**Example `superset_config.py` for Redis:** + +```python +# superset_config.py +from redis import Redis +import os + +# 1. Enable server-side sessions +SESSION_SERVER_SIDE = True + +# 2. Choose your backend (e.g., 'redis', 'memcached', 'filesystem', 'sqlalchemy') +SESSION_TYPE = 'redis' + +# 3. Configure your Redis connection +# Use environment variables for sensitive details +SESSION_REDIS = Redis( + host=os.environ.get('REDIS_HOST', 'localhost'), + port=int(os.environ.get('REDIS_PORT', 6379)), + password=os.environ.get('REDIS_PASSWORD'), + db=int(os.environ.get('REDIS_DB', 0)), + ssl=os.environ.get('REDIS_SSL_ENABLED', 'True').lower() == 'true', + ssl_cert_reqs='required' # Or another appropriate SSL setting +) + +# 4. Ensure the session cookie is signed for integrity +SESSION_USE_SIGNER = True +``` + +#### **Configure Session Lifetime and Cookie Security Flags** + +This is mandatory for *all* deployments, whether stateless or server-side. + +```python +# superset_config.py +from datetime import timedelta + +# Set a short absolute session timeout +# The default is 31 days, which is NOT recommended for production. +PERMANENT_SESSION_LIFETIME = timedelta(hours=8) + +# Enforce secure cookie flags to prevent browser-based attacks +SESSION_COOKIE_SECURE = True # Transmit cookie only over HTTPS +SESSION_COOKIE_HTTPONLY = True # Prevent client-side JS from accessing the cookie +SESSION_COOKIE_SAMESITE = 'Lax' # Provide protection against CSRF attacks +``` + +> ##### Note on iFrame Embedding and `SESSION_COOKIE_SAMESITE` +>The recommended default setting `'Lax'` provides good CSRF protection for most use cases. However, if you need to embed Superset dashboards into other applications using an iFrame, you will need to change this setting to `'None'`. + +SESSION_COOKIE_SAMESITE = 'None' + +Setting SameSite to 'None' requires that SESSION_COOKIE_SECURE is also set to True. Be aware that this configuration disables some of the browser's built-in CSRF protections to allow for cross-domain functionality, so it should only be used when iFrame embedding is necessary. + +### **Authentication and Authorization** + +While Superset's built-in database authentication is convenient, for production it's highly recommended to integrate with an enterprise-grade identity provider (IdP). + + * **Use an Enterprise IdP:** Configure authentication via OAuth or LDAP to leverage your organization's existing identity management system. This provides benefits like Single Sign-On (SSO), Multi-Factor Authentication (MFA), and centralized user provisioning/deprovisioning. + * **Principle of Least Privilege:** Assign users to the most restrictive roles necessary for their jobs. Avoid over-provisioning users with Admin or Alpha roles, and ensure row-level security is applied where appropriate. + * **Admin Accounts:** Delete or disable the default admin user after a new administrative account has been configured. + +### **Content Security Policy (CSP) and Other Headers** + +Superset can use Flask-Talisman to set security headers. However, it must be explicitly enabled. + +> #### ⚠️ Important: Talisman is Disabled by Default +> +> In Superset 4.0 and later, Talisman is disabled by default (`TALISMAN_ENABLED = False`). You **must** explicitly enable it in your `superset_config.py` for the security headers defined in `TALISMAN_CONFIG` to take effect. + +Here's the documentation section how how to set up Talisman: https://superset.apache.org/admin-docs/security/#content-security-policy-csp + +### **Database Security** + +> #### ❗ Superset is Not a Database Firewall +> +> It is essential to understand that **Apache Superset is a data visualization and exploration platform, not a database firewall or a comprehensive security solution for your data warehouse.** While Superset provides features to help manage data access, the ultimate responsibility for securing your underlying databases lies with your database administrators (DBAs) and security teams. This includes managing network access, user privileges, and fine-grained permissions directly within the database. The configurations below are an important secondary layer of security but should not be your only line of defense. + + * **Use a Dedicated Database User:** The database connection configured in Superset should use a dedicated, limited-privilege database user. This user should only have the minimum required permissions (e.g., `SELECT` on specific schemas) for the data sources it needs to query. It should **not** have `INSERT`, `UPDATE`, `DELETE`, or administrative privileges. + * **Restrict Dangerous SQL Functions:** To mitigate potential SQL injection risks, configure the `DISALLOWED_SQL_FUNCTIONS` list in your `superset_config.py`. Be aware that this is a defense-in-depth measure, not a substitute for proper database permissions. + +### **Additional Security Layers** + + * **Web Application Firewall (WAF):** Deploying Superset behind a WAF (e.g., Cloudflare, AWS WAF) is strongly recommended. A WAF with a standard ruleset (like the OWASP Core Rule Set) provides a critical layer of defense against common attacks like SQL Injection, XSS, and remote code execution. + +### **Monitoring and Logging** + + * **Configure Structured Logging:** Set up a robust logging configuration to capture important security events. + * **Centralize Logs:** Ship logs from all Superset components (frontend, worker, etc.) to a centralized SIEM (Security Information and Event Management) system for analysis and alerting. + * **Monitor Key Events:** Create alerts for suspicious activities, including: + * Multiple failed login attempts for a single user or from a single IP address. + * Changes to user roles or permissions. + * Creation or deletion of high-privilege users. + * Attempts to use disallowed SQL functions. + +----- + +### **Appendix A: Production Deployment Checklist** + +#### **Initial Setup:** + + - [ ] HTTPS/TLS is configured and enforced via a reverse proxy. + - [ ] A unique, strong `SUPERSET_SECRET_KEY` is generated and secured in an environment variable or secrets vault. + - [ ] Server-side session management is configured (e.g., Redis). + - [ ] `PERMANENT_SESSION_LIFETIME` is set to a short duration (e.g., 8 hours). + - [ ] All session cookie security flags (`Secure`, `HttpOnly`, `SameSite`) are enabled. + - [ ] `DEBUG` mode is set to `False`. + - [ ] Talisman is explicitly enabled and configured with a strict Content Security Policy. + - [ ] Database connections use dedicated, limited-privilege accounts. + - [ ] Authentication is integrated with an enterprise identity provider (OAuth/LDAP). + - [ ] A Web Application Firewall (WAF) is deployed in front of Superset. + - [ ] Logging is configured and logs are shipped to a central monitoring system. + +#### **Ongoing Maintenance:** + + - [ ] Regularly update to the latest major or minor versions of Superset. Those versions receive up-to-date security patches. + - [ ] Rotate the `SUPERSET_SECRET_KEY` periodically (e.g., quarterly) and after any potential security incident. + - [ ] Conduct quarterly access reviews for all users. + - [ ] Assuming logging and monitoring is in place, review security monitoring alerts weekly. + +### **Appendix B: `SECRET_KEY` Rotation and Compromise Response** + +**Why and When to Rotate the `SECRET_KEY`** +Rotating the `SUPERSET_SECRET_KEY` is a critical security procedure. It is mandatory after a known or suspected compromise and is a best practice when an employee with access to the key departs. While periodic rotation can limit the window of exposure for an unknown leak, it is a high-impact operation that will invalidate all user sessions and requires careful execution to avoid breaking your instance. The principles behind managing this key align with general best practices for cryptographic storage, which are further detailed in the OWASP Cryptographic Storage Cheat Sheet here: https://cheatsheetseries.owasp.org/cheatsheets/Cryptographic_Storage_Cheat_Sheet.html + +**Procedure for Rotating the Key** +The procedure for safely rotating the SECRET_KEY must be followed precisely to avoid locking yourself out of your instance. The official Apache Superset documentation maintains the correct, up-to-date procedure. Please follow the official guide here: +https://superset.apache.org/admin-docs/configuration/configuring-superset/#rotating-to-a-newer-secret_key + +:::resources +- [Blog: Running Apache Superset on the Open Internet](https://preset.io/blog/running-apache-superset-on-the-open-internet-a-report-from-the-fireline/) +- [Blog: How Security Vulnerabilities are Reported & Handled in Apache Superset](https://preset.io/blog/how-security-vulnerabilities-are-reported-and-handled-in-apache-superset/) +::: diff --git a/docs/admin_docs_versioned_docs/version-6.1.0/security/security.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/security/security.mdx new file mode 100644 index 00000000000..b4261c60bf5 --- /dev/null +++ b/docs/admin_docs_versioned_docs/version-6.1.0/security/security.mdx @@ -0,0 +1,588 @@ +--- +title: Security Configurations +sidebar_position: 1 +--- + +Authentication and authorization in Superset is handled by Flask AppBuilder (FAB), an application development framework +built on top of Flask. FAB provides authentication, user management, permissions and roles. +Please read its [Security documentation](https://flask-appbuilder.readthedocs.io/en/latest/security.html). + +### Provided Roles + +Superset ships with a set of roles that are handled by Superset itself. You can assume +that these roles will stay up-to-date as Superset evolves (and as you update Superset versions). + +Even though **Admin** users have the ability, we don't recommend altering the +permissions associated with each role (e.g. by removing or adding permissions to them). The permissions +associated with each role will be re-synchronized to their original values when you run +the **superset init** command (often done between Superset versions). + +A table with the permissions for these roles can be found at [/RESOURCES/STANDARD_ROLES.md](https://github.com/apache/superset/blob/master/RESOURCES/STANDARD_ROLES.md). + +### Admin + +Admins have all possible rights, including granting or revoking rights from other +users and altering other people’s slices and dashboards. + +>#### Threat Model and Privilege Boundaries: The Admin Role +> +>Apache Superset is built with a granular permission model where users assigned the Admin role are considered fully trusted. Admins possess complete control over the application's configuration, UI rendering, and access controls. +> +>Consequently, actions performed by an Admin that alter the application's behavior or presentation—such as injecting custom CSS, modifying Jinja templates, or altering security flags—are intended administrative capabilities by design. +> +>In accordance with MITRE CNA Rule 4.1, a vulnerability must represent a violation of an explicit security policy. Because the Admin role is defined as a trusted operational boundary, actions executed with Admin privileges do not cross a security perimeter. Therefore, exploit vectors that strictly require Admin access are not classified as security vulnerabilities and are ineligible for CVE assignment. + +### Alpha + +Alpha users have access to all data sources, but they cannot grant or revoke access +from other users. They are also limited to altering the objects that they own. Alpha users can add and alter data sources. + +### Gamma + +Gamma users have limited access. They can only consume data coming from data sources +they have been given access to through another complementary role. They only have access to +view the slices and dashboards made from data sources that they have access to. Currently Gamma +users are not able to alter or add data sources. We assume that they are mostly content consumers, though they can create slices and dashboards. + +Also note that when Gamma users look at the dashboards and slices list view, they will +only see the objects that they have access to. + +### sql_lab + +The **sql_lab** role grants access to SQL Lab. Note that while **Admin** users have access +to all databases by default, both **Alpha** and **Gamma** users need to be given access on a per database basis. + +Beyond the base `sql_lab` role, two additional SQL Lab permissions must be explicitly granted for users who need these capabilities: + +| Permission | Feature | +|------------|---------| +| `can_estimate_query_cost` on `SQLLab` | Estimate query cost before running | +| `can_format_sql` on `SQLLab` | Format SQL using the database's dialect | + +Grant these in **Security → List Roles** by adding the permissions to the relevant role. + +### Public + +The **Public** role is the most restrictive built-in role, designed specifically for anonymous/unauthenticated +users who need to view dashboards. It provides minimal read-only access for: + +- Viewing dashboards and charts +- Using interactive dashboard filters +- Accessing dashboard and chart permalinks +- Reading embedded dashboards +- Viewing annotations on charts + +The Public role explicitly excludes: +- Any write permissions on dashboards, charts, or datasets +- SQL Lab access +- Share functionality +- User profile or admin features +- Menu access to most Superset features + +Anonymous users are automatically assigned the Public role when `AUTH_ROLE_PUBLIC` is configured +(a Flask-AppBuilder setting). The `PUBLIC_ROLE_LIKE` setting is **optional** and controls what +permissions are synced to the Public role when you run `superset init`: + +```python +# Optional: Sync sensible default permissions to the Public role +PUBLIC_ROLE_LIKE = "Public" + +# Alternative: Copy permissions from Gamma for broader access +# PUBLIC_ROLE_LIKE = "Gamma" +``` + +If you prefer to manually configure the Public role's permissions (or use `DASHBOARD_RBAC` to +grant access at the dashboard level), you do not need to set `PUBLIC_ROLE_LIKE`. + +**Important notes:** + +- **Data access is still required:** The Public role only grants UI/API permissions. You must + also grant access to specific datasets necessary to view a dashboard. As with other roles, + this can be done in two ways: + + - **Without `DASHBOARD_RBAC`:** Dashboards only appear in the list and are accessible if + the user has permission to at least one of their datasets. Grant dataset access by editing + the Public role in the Superset UI (Menu → Security → List Roles → Public) and adding the + relevant data sources. All published dashboards using those datasets become visible. + + - **With `DASHBOARD_RBAC` enabled:** Anonymous users will only see dashboards where the + "Public" role has been explicitly added in the dashboard's properties. Dataset permissions + are not required—DASHBOARD_RBAC handles the cascading permissions check. This provides + fine-grained control over which dashboards are publicly visible. + +- **Role synchronization:** Built-in role permissions (Admin, Alpha, Gamma, sql_lab, and Public + when `PUBLIC_ROLE_LIKE = "Public"`) are synchronized when you run `superset init`. Any manual + permission edits to these roles may be overwritten during upgrades. To customize the Public + role permissions, you can either: + - Edit the Public role directly and avoid setting `PUBLIC_ROLE_LIKE` (permissions won't be + overwritten by `superset init`) + - Copy the Public role via "Copy Role" in the Superset web UI, save it under a different name + (e.g., "Public_Custom"), customize the permissions, then update **both** configs: + `PUBLIC_ROLE_LIKE = "Public_Custom"` and `AUTH_ROLE_PUBLIC = "Public_Custom"` + +### Managing Data Source Access for Gamma Roles + +Here’s how to provide users access to only specific datasets. First make sure the users with +limited access have [only] the Gamma role assigned to them. Second, create a new role (Menu -> Security -> List Roles) and click the + sign. + +This new window allows you to give this new role a name, attribute it to users and select the +tables in the **Permissions** dropdown. To select the data sources you want to associate with this role, simply click on the dropdown and use the typeahead to search for your table names. + +You can then confirm with users assigned to the **Gamma** role that they see the +objects (dashboards and slices) associated with the tables you just extended them. + +### Dashboard Access Control + +Access to dashboards is managed via owners (users that have edit permissions to the dashboard). +Non-owner user access can be managed in two ways. Note that dashboards must be published to be +visible to other users. + +#### Dataset-Based Access (Default) + +By default, users can view published dashboards if they have access to at least one dataset +used in that dashboard. Grant dataset access by adding the relevant data source permissions +to a role (Menu → Security → List Roles). + +This is the simplest approach but provides all-or-nothing access based on dataset permissions— +if a user has access to a dataset, they can see all published dashboards using that dataset. + +#### Dashboard-Level Access (DASHBOARD_RBAC) + +For fine-grained control over which dashboards specific roles can access, enable the +`DASHBOARD_RBAC` feature flag: + +```python +FEATURE_FLAGS = { + "DASHBOARD_RBAC": True, +} +``` + +With this enabled, you can assign specific roles to each dashboard in its properties. Users +will only see dashboards where their role is explicitly added. + +**Important considerations:** +- Dashboard access **bypasses** dataset-level checks—granting a role access to a dashboard + implicitly grants read access to all charts and datasets in that dashboard +- Dashboards without any assigned roles fall back to dataset-based access +- The dashboard must still be published to be visible + +This feature is particularly useful for: +- Making specific dashboards public while keeping others private +- Granting access to dashboards without exposing the underlying datasets for other uses +- Creating dashboard-specific access patterns that don't align with dataset ownership + +### SQL Execution Security Considerations + +Apache Superset includes features designed to provide safeguards when interacting with connected databases, such as the `DISALLOWED_SQL_FUNCTIONS` configuration setting. This aims to prevent the execution of potentially harmful database functions or system variables directly from Superset interfaces like SQL Lab. + +However, it is crucial to understand the following: + +**Superset is Not a Database Firewall**: Superset's built-in checks, like `DISALLOWED_SQL_FUNCTIONS`, provide a layer of protection but cannot guarantee complete security against all database-level threats or advanced bypass techniques (like specific comment injection methods). They should be viewed as a supplement to, not a replacement for, robust database security. + +**Configuration is Key**: The effectiveness of Superset's safeguards heavily depends on proper configuration by the Superset administrator. This includes maintaining the `DISALLOWED_SQL_FUNCTIONS` list, carefully managing feature flags (like `ENABLE_TEMPLATE_PROCESSING`), and configuring other security settings appropriately. + +**Database Security is Paramount**: The ultimate responsibility for securing database access, controlling permissions, and preventing unauthorized function execution lies with the database administrators (DBAs) and security teams managing the underlying database instance. + +**Recommended Database Practices**: We strongly recommend implementing security best practices at the database level, including: +* **Least Privilege**: Connecting Superset using dedicated database user accounts with the minimum permissions required for Superset's operation (typically read-only access to necessary schemas/tables). +* **Database Roles & Permissions**: Utilizing database-native roles and permissions to restrict access to sensitive functions, system variables (like `@@hostname`), schemas, or tables. +* **Network Security**: Employing network-level controls like database firewalls or proxies to restrict connections. +* **Auditing**: Enabling database-level auditing to monitor executed queries and access patterns. + +By combining Superset's configurable safeguards with strong database-level security practices, you can achieve a more robust and layered security posture. + +**Dataset Sample Access**: The `get_samples()` endpoint now enforces datasource-level access control. Users can only fetch sample rows from datasets they have been explicitly granted access to — the same permission check applied when running chart queries. This closes a prior gap where unauthenticated or under-privileged access could retrieve sample data. + +### REST API for user & role management + +Flask-AppBuilder supports a REST API for user CRUD, +but this feature is in beta and is not enabled by default in Superset. +To enable this feature, set the following in your Superset configuration: + +```python +FAB_ADD_SECURITY_API = True +``` + +Once configured, the documentation for additional "Security" endpoints will be visible in Swagger for you to explore. + +### Customizing Permissions + +The permissions exposed by FAB are very granular and allow for a great level of +customization. FAB creates many permissions automatically for each model that is +created (can_add, can_delete, can_show, can_edit, …) as well as for each view. +On top of that, Superset can expose more granular permissions like **all_datasource_access**. + +**We do not recommend altering the 3 base roles as there are a set of assumptions that +Superset is built upon**. It is possible though for you to create your own roles, and union them to existing ones. + +### Permissions + +Roles are composed of a set of permissions, and Superset has many categories of +permissions. Here are the different categories of permissions: + +- Model & Action: models are entities like Dashboard, Slice, or User. Each model has + a fixed set of permissions, like **can_edit**, **can_show**, **can_delete**, **can_list**, **can_add**, + and so on. For example, you can allow a user to delete dashboards by adding **can_delete** on + Dashboard entity to a role and granting this user that role. +- Views: views are individual web pages, like the Explore view or the SQL Lab view. + When granted to a user, they will see that view in its menu items, and be able to load that page. +- Data source: For each data source, a permission is created. If the user does not have the + `all_datasource_access permission` granted, the user will only be able to see Slices or explore the data sources that are granted to them +- Database: Granting access to a database allows for the user to access all + data sources within that database, and will enable the user to query that + database in SQL Lab, provided that the SQL Lab specific permission have been granted to the user + +### Restricting Access to a Subset of Data Sources + +We recommend giving a user the **Gamma** role plus any other roles that would add +access to specific data sources. We recommend that you create individual roles for +each access profile. For example, the users on the Finance team might have access to a set of +databases and data sources; these permissions can be consolidated in a single role. +Users with this profile then need to be assigned the **Gamma** role as a foundation to +the models and views they can access, and that Finance role that is a collection of permissions to data objects. + +A user can have multiple roles associated with them. For example, an executive on the Finance +team could be granted **Gamma**, **Finance**, and the **Executive** roles. The **Executive** +role could provide access to a set of data sources and dashboards made available only to executives. +In the **Dashboards** view, a user can only see the ones they have access to +based on the roles and permissions that were attributed. + +### Row Level Security + +Using Row Level Security filters (under the **Security** menu) you can create filters +that are assigned to a particular dataset, as well as a set of roles. +If you want members of the Finance team to only have access to +rows where `department = "finance"`, you could: + +- Create a Row Level Security filter with that clause (`department = "finance"`) +- Then assign the clause to the **Finance** role and the dataset it applies to + +The **clause** field, which can contain arbitrary text, is then added to the generated +SQL statement's WHERE clause. So you could even do something like create a filter +for the last 30 days and apply it to a specific role, with a clause +like `date_field > DATE_SUB(NOW(), INTERVAL 30 DAY)`. It can also support +multiple conditions: `client_id = 6` AND `advertiser="foo"`, etc. + +RLS clauses also support **Jinja templating** when `ENABLE_TEMPLATE_PROCESSING` is enabled, so you can write dynamic filters such as +`user_id = '{{ current_username() }}'` to restrict rows based on the logged-in user. + +#### Filter Types + +There are two types of RLS filters: + +- **Regular** — The filter clause is applied when the querying user belongs to one of the + roles assigned to the filter. Use this to restrict what specific roles can see. +- **Base** — The filter clause is applied to **all** users _except_ those in the assigned + roles. Use this to define a default restriction that privileged roles (e.g. Admin) are + exempt from. For example, a Base filter with clause `1 = 0` and the Admin role would + hide all rows from everyone except Admin — useful as a deny-by-default baseline. + +#### Group Keys and Filter Combination + +All applicable RLS filters are combined before being added to the query. The combination +rules are: + +- Filters that share the **same group key** are combined with **OR** (any match within + the group is sufficient). +- Different filter groups (different group keys, or no group key) are combined with + **AND** (all groups must match). +- Filters with **no group key** are each treated as their own group and are always AND'd. + +For example, if a dataset has three filters: + +| Filter | Clause | Group Key | +|--------|--------|-----------| +| F1 | `department = 'Finance'` | `department` | +| F2 | `department = 'Marketing'` | `department` | +| F3 | `region = 'Europe'` | `region` | + +The resulting WHERE clause would be: + +```sql +(department = 'Finance' OR department = 'Marketing') AND (region = 'Europe') +``` + +:::caution Conflicting filters +It is possible to create filters that conflict and produce an empty result set. For +example, the filters `client_id = 4` and `client_id = 5` **without a shared group key** +will be AND'd together, producing `client_id = 4 AND client_id = 5`, which can never +be true. + +If you intend for these to be alternatives, assign them the **same group key** so they +are OR'd instead. +::: + +#### RLS and Virtual (SQL-Based) Datasets + +RLS filters are assigned to **datasets**, not to underlying database tables directly. This +has important implications when working with virtual (SQL-based) datasets: + +- **Physical datasets** (backed directly by a table or view) — RLS filters assigned to + the dataset are added as WHERE clauses to the query. +- **Virtual datasets** (defined by a custom SQL query) — RLS filters assigned directly to + the virtual dataset are applied to the _outer_ query that wraps the dataset's SQL. + Additionally, RLS filters on the **underlying physical datasets** referenced by the + virtual dataset's SQL are injected into the inner subquery for each referenced table. + +For example, if you have: + +1. A physical dataset `orders` with RLS filter `region = 'US'` +2. A virtual dataset defined as `SELECT * FROM orders WHERE status = 'active'` + +A user affected by the RLS filter will effectively see: + +```sql +SELECT * FROM ( + SELECT * FROM orders WHERE (region = 'US') AND status = 'active' +) ... +``` + +**Key considerations for virtual datasets:** + +- You generally do **not** need to duplicate RLS filters on both the physical and virtual + dataset — filters on the physical dataset are applied automatically at query time. +- If you assign an RLS filter directly to a virtual dataset, the clause must reference + columns available in the virtual dataset's _output_, not necessarily the underlying + table's columns. +- In **SQL Lab**, RLS is enforced only when the `RLS_IN_SQLLAB` feature flag is enabled: + queries run against tables that have associated datasets with RLS filters will then have + the appropriate predicates injected automatically. + +#### Checking RLS Filters via the API + +You can use the RLS REST API to audit which filters are configured and which datasets +they affect. This requires the `can_read` permission on the `Row Level Security` resource. + +**List all RLS rules:** + +``` +GET /api/v1/rowlevelsecurity/ +``` + +**Filter RLS rules for a specific dataset** (using [Rison](https://github.com/Nanonid/rison) query syntax): + +``` +GET /api/v1/rowlevelsecurity/?q=(filters:!((col:tables,opr:rel_m_m,value:))) +``` + +**Filter RLS rules by role:** + +``` +GET /api/v1/rowlevelsecurity/?q=(filters:!((col:roles,opr:rel_m_m,value:))) +``` + +**View details of a specific rule** (including clause, assigned datasets, and roles): + +``` +GET /api/v1/rowlevelsecurity/ +``` + +The response includes the filter's `name`, `filter_type` (Regular or Base), `clause`, +`group_key`, assigned `tables` (with id, schema, and table\_name), and assigned `roles` +(with id and name). + +:::tip Auditing RLS for virtual datasets +To find all RLS rules that could affect a particular virtual dataset, query the list +endpoint filtered by that dataset's ID for any directly-assigned rules. Then also check +the physical datasets referenced in the virtual dataset's SQL, since their RLS filters +are applied at query time too. +::: + +### User Sessions + +Superset uses [Flask](https://pypi.org/project/Flask/) +and [Flask-Login](https://pypi.org/project/Flask-Login/) for user session management. + +Session cookies are used to maintain session info and user state between requests, +although they do not contain personal user information they serve the purpose of identifying +a user session on the server side. +The session cookie is encrypted with the application `SECRET_KEY` and cannot be read by the client. +So it's very important to keep the `SECRET_KEY` secret and set to a secure unique complex random value. + +Flask and Flask-Login offer a number of configuration options to control session behavior. + +- Relevant Flask settings: + +`SESSION_COOKIE_HTTPONLY`: (default: `False`): Controls if cookies should be set with the `HttpOnly` flag. + +`SESSION_COOKIE_SECURE`: (default: `False`) Browsers will only send cookies with requests over +HTTPS if the cookie is marked “secure”. The application must be served over HTTPS for this to make sense. + +`SESSION_COOKIE_SAMESITE`: (default: "Lax") Prevents the browser from sending this cookie along with cross-site requests. + +`PERMANENT_SESSION_LIFETIME`: (default: "31 days") The lifetime of a permanent session as a `datetime.timedelta` object. + +#### Switching to server side sessions + +Server side sessions offer benefits over client side sessions on security and performance. +By enabling server side sessions, the session data is stored server side and only a session ID +is sent to the client. When a user logs in, a session is created server side and the session ID +is sent to the client in a cookie. The client will send the session ID with each request and the +server will use it to retrieve the session data. +On logout, the session is destroyed server side and the session cookie is deleted on the client side. +This reduces the risk for replay attacks and session hijacking. + +Superset uses [Flask-Session](https://flask-session.readthedocs.io/en/latest/) to manage server side sessions. +To enable this extension you have to set: + +``` python +SESSION_SERVER_SIDE = True +``` + +Flask-Session offers multiple backend session interfaces for Flask, here's an example for Redis: + +``` python +from redis import Redis + +SESSION_TYPE = "redis" +SESSION_REDIS = Redis(host="redis", port=6379, db=0) +# sign the session cookie sid +SESSION_USE_SIGNER = True +``` + +### Content Security Policy (CSP) + +Superset uses the [Talisman](https://pypi.org/project/flask-talisman/) extension to enable implementation of a +[Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP), an added +layer of security that helps to detect and mitigate certain types of attacks, including +Cross-Site Scripting (XSS) and data injection attacks. + +A CSP makes it possible for server administrators to reduce or eliminate the vectors by which XSS can +occur by specifying the domains that the browser should consider to be valid sources of executable scripts. +A CSP-compatible browser will then only execute scripts loaded in source files received from those allowed domains, +ignoring all other scripts (including inline scripts and event-handling HTML attributes). + +A policy is described using a series of policy directives, each of which describes the policy for +a certain resource type or policy area. You can check possible directives +[here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy). + +It's extremely important to correctly configure a Content Security Policy when deploying Superset to +prevent many types of attacks. Superset provides two variables in `config.py` for deploying a CSP: + +- `TALISMAN_ENABLED` defaults to `True`; set this to `False` in order to disable CSP +- `TALISMAN_CONFIG` holds the actual the policy definition (*see example below*) as well as any +other arguments to be passed to Talisman. + +When running in production mode, Superset will check at startup for the presence +of a CSP. If one is not found, it will issue a warning with the security risks. For environments +where CSP policies are defined outside of Superset using other software, administrators can disable +this warning using the `CONTENT_SECURITY_POLICY_WARNING` key in `config.py`. + +#### CSP Requirements + +- Superset needs the `style-src unsafe-inline` CSP directive in order to operate. + + ``` + style-src 'self' 'unsafe-inline' + ``` + +- Only scripts marked with a [nonce](https://content-security-policy.com/nonce/) can be loaded and executed. +Nonce is a random string automatically generated by Talisman on each page load. +You can get current nonce value by calling jinja macro `csp_nonce()`. + + ```html + + ``` + +- Some dashboards load images using data URIs and require `data:` in their `img-src` + + ``` + img-src 'self' data: + ``` + +- MapBox charts use workers and need to connect to MapBox servers in addition to the Superset origin + + ``` + worker-src 'self' blob: + connect-src 'self' https://api.mapbox.com https://events.mapbox.com + ``` + +- Cartodiagram charts request map data (image and json) from external resources that can be edited by users, +and therefore either require a list of allowed domains to request from or a wildcard (`'*'`) for `img-src` and `connect-src`. + +- Other CSP directives default to `'self'` to limit content to the same origin as the Superset server. + +In order to adjust provided CSP configuration to your needs, follow the instructions and examples provided in +[Content Security Policy Reference](https://content-security-policy.com/) + +#### Other Talisman security considerations + +Setting `TALISMAN_ENABLED = True` will invoke Talisman's protection with its default arguments, +of which `content_security_policy` is only one. Those can be found in the +[Talisman documentation](https://pypi.org/project/flask-talisman/) under *Options*. +These generally improve security, but administrators should be aware of their existence. + +In particular, the option of `force_https = True` (`False` by default) may break Superset's Alerts & Reports +if workers are configured to access charts via a `WEBDRIVER_BASEURL` beginning +with `http://`. As long as a Superset deployment enforces https upstream, e.g., +through a load balancer or application gateway, it should be acceptable to keep this +option disabled. Otherwise, you may want to enable `force_https` like this: + +```python +TALISMAN_CONFIG = { + "force_https": True, + "content_security_policy": { ... +``` + +#### Configuring Talisman in Superset + +Talisman settings in Superset can be modified using superset_config.py. If you need to adjust security policies, you can override the default configuration. + +Example: Overriding Talisman Configuration in superset_config.py for loading images form s3 or other external sources. + +```python +TALISMAN_CONFIG = { + "content_security_policy": { + "base-uri": ["'self'"], + "default-src": ["'self'"], + "img-src": [ + "'self'", + "blob:", + "data:", + "https://apachesuperset.gateway.scarf.sh", + "https://static.scarf.sh/", + # "https://cdn.brandfolder.io", # Uncomment when SLACK_ENABLE_AVATARS is True # noqa: E501 + "ows.terrestris.de", + "aws.s3.com", # Add Your Bucket or external data source + ], + "worker-src": ["'self'", "blob:"], + "connect-src": [ + "'self'", + "https://api.mapbox.com", + "https://events.mapbox.com", + ], + "object-src": "'none'", + "style-src": [ + "'self'", + "'unsafe-inline'", + ], + "script-src": ["'self'", "'strict-dynamic'"], + }, + "content_security_policy_nonce_in": ["script-src"], + "force_https": False, + "session_cookie_secure": False, +} +``` + +For more information on setting up Talisman, please refer to +https://superset.apache.org/admin-docs/configuration/networking-settings/#changing-flask-talisman-csp. + +### Reporting Security Vulnerabilities + +Apache Software Foundation takes a rigorous standpoint in annihilating the security issues in its +software projects. Apache Superset is highly sensitive and forthcoming to issues pertaining to its +features and functionality. + +If you have apprehensions regarding Superset security or you discover vulnerability or potential +threat, don’t hesitate to get in touch with the Apache Security Team by dropping a mail at +security@apache.org. In the mail, specify the project name Superset with the description of the +issue or potential threat. You are also urged to recommend the way to reproduce and replicate the +issue. The security team and the Superset community will get back to you after assessing and +analysing the findings. + +PLEASE PAY ATTENTION to report the security issue on the security email before disclosing it on +public domain. The ASF Security Team maintains a page with the description of how vulnerabilities +and potential threats are handled, check [their web page](https://apache.org/security/committers.html) +for more details. diff --git a/docs/admin_docs_versioned_sidebars/version-6.1.0-sidebars.json b/docs/admin_docs_versioned_sidebars/version-6.1.0-sidebars.json new file mode 100644 index 00000000000..63081ec81b8 --- /dev/null +++ b/docs/admin_docs_versioned_sidebars/version-6.1.0-sidebars.json @@ -0,0 +1,48 @@ +{ + "AdminDocsSidebar": [ + { + "type": "doc", + "label": "Overview", + "id": "index" + }, + { + "type": "category", + "label": "Installation", + "collapsed": false, + "items": [ + { + "type": "autogenerated", + "dirName": "installation" + } + ] + }, + { + "type": "category", + "label": "Configuration", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "configuration" + } + ] + }, + { + "type": "link", + "label": "Database Drivers", + "href": "/user-docs/databases/", + "description": "See User Docs for database connection guides" + }, + { + "type": "category", + "label": "Security", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "security" + } + ] + } + ] +} diff --git a/docs/admin_docs_versions.json b/docs/admin_docs_versions.json new file mode 100644 index 00000000000..fc7d70bb315 --- /dev/null +++ b/docs/admin_docs_versions.json @@ -0,0 +1,3 @@ +[ + "6.1.0" +] diff --git a/docs/components/versions.json b/docs/components/versions.json deleted file mode 100644 index fe51488c706..00000000000 --- a/docs/components/versions.json +++ /dev/null @@ -1 +0,0 @@ -[] diff --git a/docs/components_versioned_docs/version-6.1.0/chart-components/bar-chart.md b/docs/components_versioned_docs/version-6.1.0/chart-components/bar-chart.md new file mode 100644 index 00000000000..2b8e336e6ea --- /dev/null +++ b/docs/components_versioned_docs/version-6.1.0/chart-components/bar-chart.md @@ -0,0 +1,105 @@ + +--- +title: Bar Chart +sidebar_position: 1 +--- + +# Bar Chart Component + +The Bar Chart component is used to visualize categorical data with rectangular bars. + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `data` | `array` | `[]` | Array of data objects to visualize | +| `width` | `number` | `800` | Width of the chart in pixels | +| `height` | `number` | `600` | Height of the chart in pixels | +| `xField` | `string` | - | Field name for x-axis values | +| `yField` | `string` | - | Field name for y-axis values | +| `colorField` | `string` | - | Field name for color encoding | +| `colorScheme` | `string` | `'supersetColors'` | Color scheme to use | +| `showLegend` | `boolean` | `true` | Whether to show the legend | +| `showGrid` | `boolean` | `true` | Whether to show grid lines | +| `labelPosition` | `string` | `'top'` | Position of bar labels: 'top', 'middle', 'bottom' | + +## Examples + +### Basic Bar Chart + +```jsx +import { BarChart } from '@superset-ui/chart-components'; + +const data = [ + { category: 'A', value: 10 }, + { category: 'B', value: 20 }, + { category: 'C', value: 15 }, + { category: 'D', value: 25 }, +]; + +function Example() { + return ( + + ); +} +``` + +### Grouped Bar Chart + +```jsx +import { BarChart } from '@superset-ui/chart-components'; + +const data = [ + { category: 'A', group: 'Group 1', value: 10 }, + { category: 'A', group: 'Group 2', value: 15 }, + { category: 'B', group: 'Group 1', value: 20 }, + { category: 'B', group: 'Group 2', value: 25 }, + { category: 'C', group: 'Group 1', value: 15 }, + { category: 'C', group: 'Group 2', value: 10 }, +]; + +function Example() { + return ( + + ); +} +``` + +## Best Practices + +- Use bar charts when comparing quantities across categories +- Sort bars by value for better readability, unless there's a natural order to the categories +- Use consistent colors for the same categories across different charts +- Consider using horizontal bar charts when category labels are long diff --git a/docs/components_versioned_docs/version-6.1.0/index.md b/docs/components_versioned_docs/version-6.1.0/index.md new file mode 100644 index 00000000000..77fb2a9cca9 --- /dev/null +++ b/docs/components_versioned_docs/version-6.1.0/index.md @@ -0,0 +1,59 @@ + +--- +title: Component Library +sidebar_position: 1 +--- + +# Superset Component Library + +Welcome to the Apache Superset Component Library documentation. This section provides comprehensive documentation for all the UI components, chart components, and layout components used in Superset. + +## What is the Component Library? + +The Component Library is a collection of reusable UI components that are used to build the Superset user interface. These components are designed to be consistent, accessible, and easy to use. + +## Component Categories + +The Component Library is organized into the following categories: + +### UI Components + +Basic UI components like buttons, inputs, dropdowns, and other form elements. + +### Chart Components + +Visualization components used to render different types of charts and graphs. + +### Layout Components + +Components used for page layout, such as containers, grids, and navigation elements. + +## Versioning + +The Component Library documentation follows its own versioning scheme, independent from the main Superset documentation. This allows us to update the component documentation as the components evolve, without affecting the main documentation. + +## Getting Started + +Browse the sidebar to explore the different components available in the library. Each component documentation includes: + +- Component description and purpose +- Props and configuration options +- Usage examples +- Best practices diff --git a/docs/components_versioned_docs/version-6.1.0/layout-components/grid.md b/docs/components_versioned_docs/version-6.1.0/layout-components/grid.md new file mode 100644 index 00000000000..a0980d2bdcf --- /dev/null +++ b/docs/components_versioned_docs/version-6.1.0/layout-components/grid.md @@ -0,0 +1,113 @@ + +--- +title: Grid +sidebar_position: 1 +--- + +# Grid Component + +The Grid component provides a flexible layout system for arranging content in rows and columns. + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `gutter` | `number` or `[number, number]` | `0` | Grid spacing between items, can be a single number or [horizontal, vertical] | +| `columns` | `number` | `12` | Number of columns in the grid | +| `justify` | `string` | `'start'` | Horizontal alignment: 'start', 'center', 'end', 'space-between', 'space-around' | +| `align` | `string` | `'top'` | Vertical alignment: 'top', 'middle', 'bottom' | +| `wrap` | `boolean` | `true` | Whether to wrap items when they overflow | + +### Row Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `gutter` | `number` or `[number, number]` | `0` | Spacing between items in the row | +| `justify` | `string` | `'start'` | Horizontal alignment for this row | +| `align` | `string` | `'top'` | Vertical alignment for this row | + +### Col Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `span` | `number` | - | Number of columns the grid item spans | +| `offset` | `number` | `0` | Number of columns the grid item is offset | +| `xs`, `sm`, `md`, `lg`, `xl` | `number` or `object` | - | Responsive props for different screen sizes | + +## Examples + +### Basic Grid + +```jsx +import { Grid, Row, Col } from '@superset-ui/core'; + +function Example() { + return ( + + + +
Column 1
+ + +
Column 2
+ + +
Column 3
+ + + + ); +} +``` + +### Responsive Grid + +```jsx +import { Grid, Row, Col } from '@superset-ui/core'; + +function Example() { + return ( + + + +
Responsive Column 1
+ + +
Responsive Column 2
+ + +
Responsive Column 3
+ + +
Responsive Column 4
+ + + + ); +} +``` + +## Best Practices + +- Use the Grid system for complex layouts that need to be responsive +- Specify column widths for different screen sizes to ensure proper responsive behavior +- Use gutters to create appropriate spacing between grid items +- Keep the grid structure consistent throughout your application +- Consider using the grid system for dashboard layouts to ensure consistent spacing and alignment diff --git a/docs/components_versioned_docs/version-6.1.0/test.mdx b/docs/components_versioned_docs/version-6.1.0/test.mdx new file mode 100644 index 00000000000..d5f842ad631 --- /dev/null +++ b/docs/components_versioned_docs/version-6.1.0/test.mdx @@ -0,0 +1,35 @@ + +--- +title: Test +--- + +import { StoryExample } from '../src/components/StorybookWrapper'; + +# Test + +This is a test using our custom StorybookWrapper component. + + ( +
+ This is a simple example component +
+ )} +/> diff --git a/docs/components_versioned_docs/version-6.1.0/ui-components/button.mdx b/docs/components_versioned_docs/version-6.1.0/ui-components/button.mdx new file mode 100644 index 00000000000..d278d93db73 --- /dev/null +++ b/docs/components_versioned_docs/version-6.1.0/ui-components/button.mdx @@ -0,0 +1,146 @@ + +--- +title: Button Component +sidebar_position: 1 +--- + +import { StoryExample, StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { Button } from '../../../superset-frontend/packages/superset-ui-core/src/components/Button'; + +# Button Component + +The Button component is a fundamental UI element used throughout Superset for user interactions. + +## Basic Usage + +The default button with primary styling: + ( + + )} +/> + +## Interactive Example + + ( + + )} + props={{ + buttonStyle: 'primary', + buttonSize: 'default', + label: 'Click Me', + disabled: false + }} + controls={[ + { + name: 'buttonStyle', + label: 'Button Style', + type: 'select', + options: ['primary', 'secondary', 'tertiary', 'success', 'warning', 'danger', 'default', 'link', 'dashed'] + }, + { + name: 'buttonSize', + label: 'Button Size', + type: 'select', + options: ['default', 'small', 'xsmall'] + }, + { + name: 'label', + label: 'Button Text', + type: 'text' + }, + { + name: 'disabled', + label: 'Disabled', + type: 'boolean' + } + ]} +/> + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `buttonStyle` | `'primary' \| 'secondary' \| 'tertiary' \| 'success' \| 'warning' \| 'danger' \| 'default' \| 'link' \| 'dashed'` | `'default'` | Button style | +| `buttonSize` | `'default' \| 'small' \| 'xsmall'` | `'default'` | Button size | +| `disabled` | `boolean` | `false` | Whether the button is disabled | +| `cta` | `boolean` | `false` | Whether the button is a call-to-action button | +| `tooltip` | `ReactNode` | - | Tooltip content | +| `placement` | `TooltipProps['placement']` | - | Tooltip placement | +| `onClick` | `function` | - | Callback when button is clicked | +| `href` | `string` | - | Turns button into an anchor link | +| `target` | `string` | - | Target attribute for anchor links | + +## Usage + +```jsx +import Button from 'src/components/Button'; + +function MyComponent() { + return ( + + ); +} +``` + +## Button Styles + +Superset provides a variety of button styles for different purposes: + +- **Primary**: Used for primary actions +- **Secondary**: Used for secondary actions +- **Tertiary**: Used for less important actions +- **Success**: Used for successful or confirming actions +- **Warning**: Used for actions that require caution +- **Danger**: Used for destructive actions +- **Link**: Used for navigation +- **Dashed**: Used for adding new items or features + +## Button Sizes + +Buttons come in three sizes: + +- **Default**: Standard size for most use cases +- **Small**: Compact size for tight spaces +- **XSmall**: Extra small size for very limited spaces + +## Best Practices + +- Use primary buttons for the main action in a form or page +- Use secondary buttons for alternative actions +- Use danger buttons for destructive actions +- Limit the number of primary buttons on a page to avoid confusion +- Use consistent button styles throughout your application +- Add tooltips to buttons when their purpose might not be immediately clear diff --git a/docs/components_versioned_sidebars/version-6.1.0-sidebars.json b/docs/components_versioned_sidebars/version-6.1.0-sidebars.json new file mode 100644 index 00000000000..87e987e63c4 --- /dev/null +++ b/docs/components_versioned_sidebars/version-6.1.0-sidebars.json @@ -0,0 +1,39 @@ +{ + "ComponentSidebar": [ + { + "type": "doc", + "label": "Introduction", + "id": "index" + }, + { + "type": "category", + "label": "UI Components", + "items": [ + { + "type": "autogenerated", + "dirName": "ui-components" + } + ] + }, + { + "type": "category", + "label": "Chart Components", + "items": [ + { + "type": "autogenerated", + "dirName": "chart-components" + } + ] + }, + { + "type": "category", + "label": "Layout Components", + "items": [ + { + "type": "autogenerated", + "dirName": "layout-components" + } + ] + } + ] +} diff --git a/docs/components_versions.json b/docs/components_versions.json index fe51488c706..fc7d70bb315 100644 --- a/docs/components_versions.json +++ b/docs/components_versions.json @@ -1 +1,3 @@ -[] +[ + "6.1.0" +] diff --git a/docs/developer_docs/versions.json b/docs/developer_docs/versions.json deleted file mode 100644 index fe51488c706..00000000000 --- a/docs/developer_docs/versions.json +++ /dev/null @@ -1 +0,0 @@ -[] diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api.mdx new file mode 100644 index 00000000000..64f1b28b885 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api.mdx @@ -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. + + + Each endpoint includes ready-to-use code samples in cURL, Python, and JavaScript. + The sidebar includes Schema definitions for detailed data model documentation. + + } + 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 + +
+Dashboards (28 endpoints) — Create, read, update, and delete dashboards. + +| 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}` | + +
+ +
+Charts (20 endpoints) — Create, read, update, and delete charts (slices). + +| 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` | + +
+ +
+Datasets (19 endpoints) — Manage datasets (tables) used for building charts. + +| 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` | + +
+ +
+Database (30 endpoints) — Manage database connections and metadata. + +| 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/` | + +
+ +#### Data Exploration + +
+Explore (1 endpoints) — Chart exploration and data querying endpoints. + +| 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/` | + +
+ +
+SQL Lab (7 endpoints) — Execute SQL queries and manage SQL Lab sessions. + +| 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/` | + +
+ +
+Queries (17 endpoints) — View and manage SQL Lab query history. + +| 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}` | + +
+ +
+Datasources (2 endpoints) — Query datasource metadata and column values. + +| 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/` | + +
+ +
+Advanced Data Type (2 endpoints) — Advanced data type operations and conversions. + +| 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` | + +
+ +#### Organization & Customization + +
+Tags (15 endpoints) — Organize assets with tags. + +| 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}` | + +
+ +
+Annotation Layers (14 endpoints) — Manage annotation layers and annotations for charts. + +| 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}` | + +
+ +
+CSS Templates (8 endpoints) — Manage CSS templates for custom dashboard styling. + +| 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}` | + +
+ +#### Sharing & Embedding + +
+Dashboard Permanent Link (2 endpoints) — Permanent links to dashboard states. + +| 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}` | + +
+ +
+Explore Permanent Link (2 endpoints) — Permanent links to chart explore states. + +| 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}` | + +
+ +
+SQL Lab Permanent Link (2 endpoints) — Permanent links to SQL Lab states. + +| 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}` | + +
+ +
+Embedded Dashboard (1 endpoints) — Configure embedded dashboard settings. + +| 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}` | + +
+ +
+Dashboard Filter State (4 endpoints) — Manage temporary filter state for dashboards. + +| 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}` | + +
+ +
+Explore Form Data (4 endpoints) — Manage temporary form data for chart exploration. + +| 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}` | + +
+ +#### Scheduling & Alerts + +
+Report Schedules (11 endpoints) — Configure scheduled reports and alerts. + +| 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/` | + +
+ +#### Security & Access Control + +
+Security Roles (11 endpoints) — Manage security roles and their permissions. + +| 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/` | + +
+ +
+Security Users (6 endpoints) — Manage user accounts. + +| 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}` | + +
+ +
+Security Permissions (3 endpoints) — View available permissions. + +| 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}` | + +
+ +
+Security Resources (View Menus) (6 endpoints) — Manage security resources (view menus). + +| 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}` | + +
+ +
+Security Permissions on Resources (View Menus) (6 endpoints) — Permission-resource mappings. + +| 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}` | + +
+ +
+Row Level Security (8 endpoints) — Manage row-level security rules for data access. + +| 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}` | + +
+ +#### Import/Export & Administration + +
+Import/export (2 endpoints) — Import and export Superset assets. + +| 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/` | + +
+ +
+CacheRestApi (1 endpoints) — Cache management and invalidation operations. + +| 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` | + +
+ +
+LogRestApi (4 endpoints) — Access audit logs and activity history. + +| 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/` | + +
+ +#### User & System + +
+Current User (3 endpoints) — Get information about the authenticated user. + +| 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/` | + +
+ +
+User (1 endpoints) — User profile and preferences. + +| Method | Endpoint | Description | +|--------|----------|-------------| +| `GET` | [Get the user avatar](/developer-docs/api/get-the-user-avatar) | `/api/v1/user/{user_id}/avatar.png` | + +
+ +
+Menu (1 endpoints) — Get the Superset menu structure. + +| Method | Endpoint | Description | +|--------|----------|-------------| +| `GET` | [Get menu](/developer-docs/api/get-menu) | `/api/v1/menu/` | + +
+ +
+Available Domains (1 endpoints) — Get available domains for the Superset instance. + +| Method | Endpoint | Description | +|--------|----------|-------------| +| `GET` | [Get all available domains](/developer-docs/api/get-all-available-domains) | `/api/v1/available_domains/` | + +
+ +
+AsyncEventsRestApi (1 endpoints) — Real-time event streaming via Server-Sent Events (SSE). + +| 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/` | + +
+ +
+OpenApi (1 endpoints) — Access the OpenAPI specification. + +| Method | Endpoint | Description | +|--------|----------|-------------| +| `GET` | [Get api by version openapi](/developer-docs/api/get-api-by-version-openapi) | `/api/{version}/_openapi` | + +
+ +#### Other + +
+Security Groups (6 endpoints) — Endpoints related to Security Groups. + +| 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}` | + +
+ +
+Themes (14 endpoints) — Manage UI themes for customizing Superset's appearance. + +| 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` | + +
+ +
+UserRegistrationsRestAPI (8 endpoints) — Endpoints related to UserRegistrationsRestAPI. + +| 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}` | + +
+ +--- + +### 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/) diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.ParamsDetails.json new file mode 100644 index 00000000000..75c60b0cf27 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"object_type","required":true,"schema":{"type":"integer"}},{"in":"path","name":"object_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.RequestSchema.json new file mode 100644 index 00000000000..b93e6ea09ca --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.RequestSchema.json @@ -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}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.StatusCodes.json new file mode 100644 index 00000000000..81a6f8b517b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.api.mdx new file mode 100644 index 00000000000..b85bdfb74dc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/add-tags-to-an-object.api.mdx @@ -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: eJzFV21v1DgQ/iuj0Um0urTbcpyEgvhQKhBwCKruojupqYobz24MWTvYzrZ7Uf77aexkN/sC9wI6PiVxZsbzPJ43NyjJ5VZVXhmNKZ5J6cCLmQNvQGgwtx8p98dwbkl4cqDpLv5WU/AFLUEa0MaDKC0JuQS6V84fY4KVsGJOnqzD9KpBxcYr4QtMUIs5YYrR9I1fVoQJWvpcK0sSU29rStDlBc0Fpg0GgRSV9jQji22bfM2ckv/O2HWUJuefGblkkdxoT9rzq6iqUuWCuRl9dExQM7BVWVOR9YpcsCxm4bnJZ6mcBzNlzoAdjbxKyY/oMSaoPM3dwDvnrdIzbJN+QVgrloy8X+hU2wTpXsyrktYeXPXq1y0rbLozETPoAGyz1PKCq4x2Ec/Dk9NdOKwvpCTJW/9y8nBX4pKkspT7ANQXBHltLWkPUs3IBZcfnZx8A89zck7MaA9df0PPShGfCQndoafwSi9EqSSsAxYqaxYqgNxlcKAbsZz+WCzvtah9Yaz6k2QKZ7UvSPtuf1id8B4gQ8WI5NGPRfLWeJiaWssUJgX1JBPT7UxtcwJpuAIZH6vMPlArG7zLrz86zl5pT1aLEhzZBVkga41N4UxDrem+opzRhUUweciTvSf1QnhRRrmwuaO8tsovQ2H9eOcxvbrmOtbn/4Sf1wneH+VG0jg4FqtwKfQMU8zfX77BBEtxS+X6M5LM37Ut4egPuHg3nkCGhfdVOhqVJhdlYZxPH588fjwSlRotTkdezEbNoJK3qy8l21GGkGWZBjh6CRmedfEW+E/hGQlLFn46Oz9/Ph7fTN799vztpsJ5PLmjybKiFLYPby0r4UGT4SdaZphChgtR1pRh+wC5VXSYL5a+MHqAerWwwq3mlbG+DzyX6Uz3FRGerpaPK+P8Ae8L30pOEq0UJCRZ97TZoiii6WjKEH4Gkefk3I03n0i3nTZT8XQf/EwfZrqySvuDHsYxCx8cHg6JeS0WYhyibUDOxuI6MIx2zM+KE3EnlIcp+bwIjHwPPpoIa06+MJLxcBhuc5X2YrAdV8zBhz60mkjYJPD1IVmrDCMrsrYbXVG6p/nWyGUKr8fv3h7HOqCmy4MGPtFywDm0hyzN1D/JdKRLCi9WVG0dRCdkSjouzeyARQ+fIOdyhM9DjnE+jFO+wBT/GZN8ZqHixKyvLR/p3pPB7Vrzhn+DpAWVpppz346WQsREQ01ljTe5Kdt0NGrYVJs2nDntjrXz2nkz700kuBBWidsyFtjeTJwhpqIufecmJki6nnMt6z75EWrapv2Xk8kFrOy0CbI3m/ZWeHecG8eizP94MgNj4dUFG2Esm0b2UtXpB+k2DJJ9YR5zS4kgQ3lu8DYE5Atj54Ltvf59gt1UynkV/+KqrQTQbcLKN5amllzxX42wFWf05XrEff6VgTFBpadmd6gb1xVZR8yhV56Vh0scaFFucRr5c34uQnPtZvMzHni3LxXbhA469fe7hnRkeLr3o6oUSrODIY6bLqeuUFSKUZxiaKGYYLp5NUmHVwsOwhhlV9g0t8LRe1u2LS9/rslyU75eB3rIP6kcv0tMp6J09BXYB5fdwHYIX/K9vxHoZcinsuYvTLj8b92pOGP//62VxJYDKRbqgD/+H5bcgf7OSMZuR42zPKfQgL4sO6yU3CcwwdvuGjc3knWsuOOrjriLvpoAPaRmWIttsI7zWrTJOcOj8WDyW+VW98Ko9rLRNFEidpx2RU7o2ExM2/4FfUdL7A== +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"; + + + + + + + + + + +Adds tags to an object. Creates new tags if they do not already exist. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/advanced-data-type.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/advanced-data-type.tag.mdx new file mode 100644 index 00000000000..97e39dd3f29 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/advanced-data-type.tag.mdx @@ -0,0 +1,13 @@ +--- +id: advanced-data-type +title: "Advanced Data Type" +description: "Advanced Data Type" +custom_edit_url: null +--- + +Endpoints for 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` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/annotation-layers.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/annotation-layers.tag.mdx new file mode 100644 index 00000000000..1b62caa685a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/annotation-layers.tag.mdx @@ -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}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.ParamsDetails.json new file mode 100644 index 00000000000..b27517b453d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.ParamsDetails.json @@ -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"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.StatusCodes.json new file mode 100644 index 00000000000..82ab93e0c76 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"dataset":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this dataset.","type":"integer"},"column_formats":{"description":"Column formats.","type":"object"},"columns":{"description":"Columns metadata.","items":{"type":"object"},"type":"array"},"database":{"description":"Database associated with the dataset.","type":"object"},"datasource_name":{"description":"Dataset name.","type":"string"},"default_endpoint":{"description":"Default endpoint for the dataset.","type":"string"},"description":{"description":"Dataset description.","type":"string"},"edit_url":{"description":"The URL for editing the dataset.","type":"string"},"extra":{"description":"JSON string containing extra configuration elements.","type":"object"},"fetch_values_predicate":{"description":"Predicate used when fetching values from the dataset.","type":"string"},"filter_select":{"description":"SELECT filter applied to the dataset.","type":"boolean"},"filter_select_enabled":{"description":"If the SELECT filter is enabled.","type":"boolean"},"granularity_sqla":{"description":"Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use `granularity` instead.","items":{"items":{"type":"object"},"type":"array"},"type":"array"},"health_check_message":{"description":"Health check message.","type":"string"},"id":{"description":"Dataset ID.","type":"integer"},"is_sqllab_view":{"description":"If the dataset is a SQL Lab view.","type":"boolean"},"main_dttm_col":{"description":"The main temporal column.","type":"string"},"metrics":{"description":"Dataset metrics.","items":{"type":"object"},"type":"array"},"name":{"description":"Dataset name.","type":"string"},"offset":{"description":"Dataset offset.","type":"integer"},"order_by_choices":{"description":"List of order by columns.","items":{"items":{"type":"string"},"type":"array"},"type":"array"},"owners":{"description":"List of owners identifiers","items":{"type":"integer"},"type":"array"},"params":{"description":"Extra params for the dataset.","type":"object"},"perm":{"description":"Permission expression.","type":"string"},"schema":{"description":"Dataset schema.","type":"string"},"select_star":{"description":"Select all clause.","type":"string"},"sql":{"description":"A SQL statement that defines the dataset.","type":"string"},"table_name":{"description":"The name of the table associated with the dataset.","type":"string"},"template_params":{"description":"Table template params.","type":"object"},"time_grain_sqla":{"description":"List of temporal granularities supported by the dataset.","items":{"items":{"type":"string"},"type":"array"},"type":"array"},"type":{"description":"Dataset type.","type":"string"},"uid":{"description":"Dataset unique identifier.","type":"string"},"verbose_map":{"description":"Mapping from raw name to verbose name.","type":"object"}},"type":"object","title":"Dataset"},"form_data":{"description":"Form data from the Explore controls used to form the chart's data query.","type":"object"},"message":{"description":"Any message related to the processed request.","type":"string"},"slice":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart.","type":"integer"},"certification_details":{"description":"Details of the certification.","type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard.","type":"string"},"changed_on":{"description":"Timestamp of the last modification.","format":"date-time","type":"string"},"changed_on_humanized":{"description":"Timestamp of the last modification in human readable form.","type":"string"},"datasource":{"description":"Datasource identifier.","type":"string"},"description":{"description":"Slice description.","type":"string"},"description_markeddown":{"description":"Sanitized HTML version of the chart description.","type":"string"},"edit_url":{"description":"The URL for editing the slice.","type":"string"},"form_data":{"description":"Form data associated with the slice.","type":"object"},"is_managed_externally":{"description":"If the chart is managed outside externally.","type":"boolean"},"modified":{"description":"Last modification in human readable form.","type":"string"},"owners":{"description":"Owners identifiers.","items":{"type":"integer"},"type":"array"},"query_context":{"description":"The context associated with the query.","type":"object"},"slice_id":{"description":"The slice ID.","type":"integer"},"slice_name":{"description":"The slice name.","type":"string"},"slice_url":{"description":"The slice URL.","type":"string"}},"type":"object","title":"Slice"}},"type":"object","title":"ExploreContextSchema"},"example":{"dataset":{},"form_data":{},"message":"string","slice":{}}}},"description":"Returns the initial context."},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.api.mdx new file mode 100644 index 00000000000..41bb9bea3d7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/assemble-explore-related-information-in-a-single-endpoint.api.mdx @@ -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.

The information can be assembled from:
- The cache using a form_data_key
- The metadata database using a permalink_key
- 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"; + + + + + + + + + + +Assembles Explore related information (form_data, slice, dataset) in a single endpoint.

The information can be assembled from:
- The cache using a form_data_key
- The metadata database using a permalink_key
- Build from scratch using dataset or slice identifiers. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/async-events-rest-api.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/async-events-rest-api.tag.mdx new file mode 100644 index 00000000000..30637a3ef7c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/async-events-rest-api.tag.mdx @@ -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/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/available-domains.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/available-domains.tag.mdx new file mode 100644 index 00000000000..e7cd33172eb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/available-domains.tag.mdx @@ -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/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.RequestSchema.json new file mode 100644 index 00000000000..fa2a316cc3b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.RequestSchema.json @@ -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}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.StatusCodes.json new file mode 100644 index 00000000000..a4323ba4bda --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.api.mdx new file mode 100644 index 00000000000..8b2b38d6564 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-create-tags-and-tagged-objects.api.mdx @@ -0,0 +1,68 @@ +--- +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"; + + + + + + + + + + +Bulk create tags and tagged objects + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.ParamsDetails.json new file mode 100644 index 00000000000..13d35164553 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.ParamsDetails.json @@ -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"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.StatusCodes.json new file mode 100644 index 00000000000..3b8705da636 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.api.mdx new file mode 100644 index 00000000000..2af17d15a28 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-annotation-layers.api.mdx @@ -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"; + + + + + + + + + + +Bulk delete annotation layers + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.ParamsDetails.json new file mode 100644 index 00000000000..992981fc7d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.StatusCodes.json new file mode 100644 index 00000000000..41f86a9e504 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.api.mdx new file mode 100644 index 00000000000..822e298940d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-charts.api.mdx @@ -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"; + + + + + + + + + + +Bulk delete charts + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.ParamsDetails.json new file mode 100644 index 00000000000..992981fc7d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.StatusCodes.json new file mode 100644 index 00000000000..d3cf7057895 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.api.mdx new file mode 100644 index 00000000000..7bede99c3ed --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-css-templates.api.mdx @@ -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"; + + + + + + + + + + +Bulk delete CSS templates + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.ParamsDetails.json new file mode 100644 index 00000000000..992981fc7d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.StatusCodes.json new file mode 100644 index 00000000000..535ffe78e96 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.api.mdx new file mode 100644 index 00000000000..b5af911087d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-dashboards.api.mdx @@ -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"; + + + + + + + + + + +Bulk delete dashboards + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.ParamsDetails.json new file mode 100644 index 00000000000..992981fc7d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.StatusCodes.json new file mode 100644 index 00000000000..62a6bad24d2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.api.mdx new file mode 100644 index 00000000000..b5bbdb4d3ff --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-datasets.api.mdx @@ -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"; + + + + + + + + + + +Bulk delete datasets + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.ParamsDetails.json new file mode 100644 index 00000000000..992981fc7d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.StatusCodes.json new file mode 100644 index 00000000000..eb533bc3460 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.api.mdx new file mode 100644 index 00000000000..a99f961a1bc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-report-schedules.api.mdx @@ -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"; + + + + + + + + + + +Bulk delete report schedules + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.ParamsDetails.json new file mode 100644 index 00000000000..992981fc7d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.StatusCodes.json new file mode 100644 index 00000000000..ea320f5587a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.api.mdx new file mode 100644 index 00000000000..845115f0f27 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-rls-rules.api.mdx @@ -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"; + + + + + + + + + + +Bulk delete RLS rules + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.ParamsDetails.json new file mode 100644 index 00000000000..992981fc7d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.StatusCodes.json new file mode 100644 index 00000000000..9487fc8839c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.api.mdx new file mode 100644 index 00000000000..1bf063feeba --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-saved-queries.api.mdx @@ -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"; + + + + + + + + + + +Bulk delete saved queries + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.ParamsDetails.json new file mode 100644 index 00000000000..55d5b6143f8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"delete_tags_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.StatusCodes.json new file mode 100644 index 00000000000..01e848f7ae2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.api.mdx new file mode 100644 index 00000000000..7c8d9d294e1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-tags.api.mdx @@ -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"; + + + + + + + + + + +Bulk deletes tags. This will remove all tagged objects with this tag. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/cache-rest-api.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/cache-rest-api.tag.mdx new file mode 100644 index 00000000000..cfcd6a9119d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/cache-rest-api.tag.mdx @@ -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` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.RequestSchema.json new file mode 100644 index 00000000000..0ecb63ee172 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"

Refer to the SqlAlchemy docs for more information on how to structure your URI.

","maxLength":1024,"minLength":0,"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"type":"object","title":"DatabaseRestApi.put"},"example":{"allow_ctas":true,"allow_cvas":true,"allow_dml":true,"allow_file_upload":true,"allow_run_async":true,"cache_timeout":1,"configuration_method":{},"database_name":"string","driver":"string","engine":"string","expose_in_sqllab":true,"external_url":"string","extra":"string","force_ctas_schema":"string","impersonate_user":true,"is_managed_externally":true,"masked_encrypted_extra":"string","parameters":{},"server_cert":"string","sqlalchemy_uri":"string","ssh_tunnel":{},"uuid":"string"}}},"description":"Database schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.StatusCodes.json new file mode 100644 index 00000000000..27e75e294c9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"

Refer to the SqlAlchemy docs for more information on how to structure your URI.

","maxLength":1024,"minLength":0,"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"type":"object","title":"DatabaseRestApi.put"}},"type":"object"},"example":{"id":1,"result":{"allow_ctas":true,"allow_cvas":true,"allow_dml":true,"allow_file_upload":true,"allow_run_async":true,"cache_timeout":1,"configuration_method":{},"database_name":"string","driver":"string","engine":"string","expose_in_sqllab":true,"external_url":"string","extra":"string","force_ctas_schema":"string","impersonate_user":true,"is_managed_externally":true,"masked_encrypted_extra":"string","parameters":{},"server_cert":"string","sqlalchemy_uri":"string","ssh_tunnel":{},"uuid":"string"}}}},"description":"Database changed"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.api.mdx new file mode 100644 index 00000000000..f28da7b3e98 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/change-a-database.api.mdx @@ -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"; + + + + + + + + + + +Change a database + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/charts.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/charts.tag.mdx new file mode 100644 index 00000000000..07b247cf8a1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/charts.tag.mdx @@ -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` | +| `DELETE` | [Delete a chart](./delete-a-chart) | `/api/v1/chart/{pk}` | +| `GET` | [Get a chart detail information](./get-a-chart-detail-information) | `/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` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.ParamsDetails.json new file mode 100644 index 00000000000..93d7fe662b7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_fav_star_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.StatusCodes.json new file mode 100644 index 00000000000..f696a006165 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.api.mdx new file mode 100644 index 00000000000..60b51a4abb5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-charts-for-current-user.api.mdx @@ -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"; + + + + + + + + + + +Check favorited charts for current user + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.ParamsDetails.json new file mode 100644 index 00000000000..93d7fe662b7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_fav_star_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.StatusCodes.json new file mode 100644 index 00000000000..f696a006165 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.api.mdx new file mode 100644 index 00000000000..c0af7bfad44 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/check-favorited-dashboards-for-current-user.api.mdx @@ -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"; + + + + + + + + + + +Check favorited dashboards for current user + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.ParamsDetails.json new file mode 100644 index 00000000000..9ab8ada76b1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.ParamsDetails.json @@ -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"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.StatusCodes.json new file mode 100644 index 00000000000..2f96284074c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.api.mdx new file mode 100644 index 00000000000..667daabac26 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot.api.mdx @@ -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"; + + + + + + + + + + +Compute and cache a screenshot (chart-pk-cache-screenshot) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.RequestSchema.json new file mode 100644 index 00000000000..5e12a88eb2e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"dataMask":{"type":"object","description":"An object representing the data mask.","additionalProperties":true},"activeTabs":{"type":"array","items":{"type":"string"},"description":"A list representing active tabs."},"anchor":{"type":"string","description":"A string representing the anchor."},"urlParams":{"type":"array","items":{"type":"array","items":{"type":"string"},"minItems":2,"maxItems":2},"description":"A list of tuples, each containing two strings."}},"title":"DashboardScreenshotPostSchema"},"example":{"dataMask":{"key":"value"},"activeTabs":["string"],"anchor":"string","urlParams":[["string"]]}}}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.StatusCodes.json new file mode 100644 index 00000000000..7b3d2f3a589 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.api.mdx new file mode 100644 index 00000000000..490e5d8f3a9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.api.mdx @@ -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/ivEYcASTImbogMKDf2QZi3abmuD2sUGxEF6li4Wa4lUScqJJ+i/D0fKkmy5a9cV6KdE5PF499zDe3ENJRosyJGxEF/VIBXEUKLLIAKFBfHXCiIw9LGShlKInakoAptkVCDENbhNyVJSOVqSgaa5DtJk3VOdblgk0cqRcvwvlmUuE3RSq8kHqxWvjXTpxQdKHERQGl2ScZIs76bo8A+0q0OSKdnEyJL1QgznSoQdYag0ZEk5qZbCZSRYiSjQrk4hAkxTyUcwvxzcxB42EWDi5JpmuLCDC9EY3EAE0lExXLfOSLWEZmSJyKXdMyMoFg4X9pRPoEoybcbKxrrCxtipoMErq0x+ySH9EqM/70wh1cuw+TCCAu+3H5/yU98KV5U52UgQJpngyKNU3s473drPXjcROOlyvu1XtNlCo0mniSFSNtPuUls3DaxoIqB7LEoW3aXAijYQwxrzimAvXFdbF657dHtUBxBd9ZLXTcNWGbKlVjYw7uGDh/+Jv7t8TTDJ6MabWe/BNctI+G3B29EBFm1BualMfvh8ZXLhtDCkUjItt9tDhzTKApf0WW235JLMK7NdNA5pc2hXN9ahq+xhfWHPE4IJajcq+RKVVZmio/QG3WG1ThZkHRblVnOO1okkQ7UkIVV77Vh9E41Sxoh/FxyQnoRvWyYcJOIgtoPnuhu0fmOAfb+4A+He8hCG3ofRq+tMbwE2ZKvcsamPHjz4H8wtyFpc0oGUMMJxF5buIDzFVLRlIBYv1RpzmYq+2IjS6LVMKT3k1uBs8OXs+/ryTmHlMm3k35TG4rxyGefecL/oKuMBR4YHgyePvq8nr7UTt7pSaSz4NbUgE8NtdWUSEqkmK5R2gu4lwz92qtPBt/z8vXn2UjkyCnNhyazJCDJGm1icK1Epui8pYe/8otBJUplPROo5OsyDnL/cUlIZ6Ta+Kfpw5yC+uubOxuHS15fu5VmuMfcniU5p6s0LfVSOagkxJO/e/g4R5LigvP8MUPM3Z92Tv8Tlm+lMzCFzrownk1wnmGfauvjxg8ePJ1jKyfps0iWXydkkZJ8+3fSJdTIHMZ/PlRAnL8Qczlv6+XDE4imhISN+OL+4eDad3sze/Pbs9e6BixDIk9mmpFjsx7KXTcWP9ZxL8BxiMQ9VeA7Nj9BEnfOXG5dpNXC/W+gAkEWpjdvy0M7VXG0LsHjSLZ+W2rojvld8M5SioC4jTMnYJ/UeVsGtFq85iJ8EJglZe+P0ilTTnmZMnhzCYa6O56o0UrmjrT+nLHx0fDxE6BWucepZOEBpZ7Gnila+j+zAwTuULtRrD803BaYO/hXkMp2yY8zQfdDirZjYZxqD8X5LtjogN/PAvY/6I0OuBfjGfAvSW7wXOt3E4tX0zevTkCjk7eao5h5qAL5ojlmaY/DLXAXcfNe/xWwvIq2Qzuk018sjFj3+Bfix76aIC12UleNmO217Nxx0NOKow/OkXJ14gZN+qRc8hggCrjxbaevnHB64YhjHqi5Xzb+Fixni817IOqHDOMiD0TTxO2+LlNaU67Ig5doM6vkZFNWl0U4nOm/iyaRmVU1c84NtRtouKut0sVURwRqNxEUe0vxWTWjpbpF7lGAmRECqKjijtp/8x+fUXf0vZrNL0elpImBrdvV1/o6Mm4bSwHs80wptxMtLVsK+7Co5CFV73ks3fsDdlgffGwYnfZGoYeFZ/1ybwvdur/6cQTst8ysOu3176p1uIj58Y+jWkM2+VglrsVq97UfvZwfnpq8elTpBHibUrR436NOqJGNp2FwPlpilQW59FsC3rkDfH7S/NHzDF7ZjWNddOLp3kzJHqdpR2bPTP74rwFKylWfDRh4iiP3vH59+gxABYxf4eAV1vUBL70zeNLz8sSLDTcR1/yT8S02l5f9TiG8xtzQyuGuo4Oht22Aeiz7ku45sx3m18S+PB+IYIGon5HIFDccsZG1/e9gY5t/BwVEDxwkhnDhPEvJl6dOy14PsxkUDIli0PwMVOuUzBu/4ByW8C0Zq77N/Qn4tFMcqdHdBJ3ObG+lBJLs30P7DXh2Eoa6DRCg/TYeKr+MMTNP8A0Tdl40= +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"; + + + + + + + + + + +Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.ParamsDetails.json new file mode 100644 index 00000000000..74d702d0d05 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.RequestSchema.json new file mode 100644 index 00000000000..c1f43f2dc07 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.RequestSchema.json @@ -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}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.StatusCodes.json new file mode 100644 index 00000000000..dc0f000d393 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.api.mdx new file mode 100644 index 00000000000..a97aab65a1e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-copy-of-an-existing-dashboard.api.mdx @@ -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"; + + + + + + + + + + +Create a copy of an existing dashboard + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.RequestSchema.json new file mode 100644 index 00000000000..df9c665d2a2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.RequestSchema.json @@ -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}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.StatusCodes.json new file mode 100644 index 00000000000..4167d2c3a2d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.api.mdx new file mode 100644 index 00000000000..8ea722939d7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-css-template.api.mdx @@ -0,0 +1,68 @@ +--- +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"; + + + + + + + + + + +Create a CSS template + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.ParamsDetails.json new file mode 100644 index 00000000000..c7b01c489be --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.RequestSchema.json new file mode 100644 index 00000000000..936e4a7a9a0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.RequestSchema.json @@ -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}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.StatusCodes.json new file mode 100644 index 00000000000..4ce99f6bda8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.api.mdx new file mode 100644 index 00000000000..3146f187b00 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-dashboards-filter-state.api.mdx @@ -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"; + + + + + + + + + + +Create a dashboard's filter state + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.RequestSchema.json new file mode 100644 index 00000000000..b627640de47 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.RequestSchema.json @@ -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"},"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","viz_type":["bar","area","table"]}}},"description":"Chart schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.StatusCodes.json new file mode 100644 index 00000000000..04be1644906 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.StatusCodes.json @@ -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"},"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","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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.api.mdx new file mode 100644 index 00000000000..97b5fc8a28c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-chart.api.mdx @@ -0,0 +1,68 @@ +--- +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: eJztWm1v2zgS/isD4oAmODV2erdAoUU/pLkW272iDZr0XhAXDi2OLbYUqSUpO6qh/34YUrLkl+Ry1120H/KpFjUznBnOPPNQzZpZ/K1C518aUbN0zTKjPWpPP3lZKplxL40efXZG05rLciw4/SqtKdF6iS6o8SzHqZcFmiooC3SZlSUps5T9rbLBDhxJDQ4zo4U7BjMHnyOQrtQLaLVhbiz4XDrIcm79CbwzHuOCwDmvlHfgTdAU3HNnKpvhyPOZwo0JOYdKC5xLjeKEJUxXSpEAS72tMGG+LpGlTGqPC7SsSVhGsczbcKcCPZfKHQgkvti4PtS6ex/nrdSLwTYoprN63/oFWmc0GAsLa6oSfM495NzBRm2QmIdsJ7jLZ4ZbEUKRHosDMZ2Bks5TSL04ZVjqTFWiTb3GVdwWvKGM7mewXeHW8jru3R3OVIr9Xa9yBCm6RAZh9KNeaXfblVQKKocncAaZKUqFflgAIAXq/ixAIwoHN1tO3ADXYmuNfL45HM5ASvMCDwcw2J+E7im14ZlsbX/YML2JJ7KXly5QFGD0boTkAeqqYOk1Cy3B2g2R6uW3Cm3NEub4EsW0e1pKXLFPhzwdurVfNYPnTT+EoyJoMO5h2cBbj1ZzNa2sok3+q4J004JrvkAx7XRVfY/mzBiFXJOqWWm093XCexIAbpEKzTqQwgFXyqyo8QwIDEVnLMWpF7iFUm/moHDuAYvS11CbKlbsDMFo7PITPdjK1sOaqeSWH/L4gtbRk1Fye4EaLfcoQNSaFzKj5MAqRw2ZktmXALM5AhUAxWGWaFdWeoRZ5b3RIHV4j7elMhaBSuMErijMXy/fvwMz+4xZROjSrNC2eVrlBgpew4prwgfgyqMFV2JGDQnlxskHlUSoy2kYRLcHZgm1RxCBVgQslhYdahoM7UuJLqIn4QC5ZKsQnLECLT13mdqgT/ixlK7iSn4NGJIEuJAaVmRobmzBfS/uclMpQedr0Vf2/kFzR3DT1ouDDbYfZy89DHmVo88pqE6+sy5dOJ5BURgL2nhwJuZGehAGXVirSkHZCAqFEQFfnOf+vi4etJZT8l6gpDd7ZV/w27eoFz5n6bOfxgkrpO6eTw+kbim/PgAxIwRtHSRFFU4HbzkNDgLHGbcsYdwip/4LwX2616PxnkdNEsiTtCjI4va828f5rST1cBtbipyQnlxj5xTAB3T+rJQnpXE+wmTr+R7VOr2Tu3SO7rKOfn1ID65PP+3N7NMDY3CovTPI+omzdTobhW2s79fvgPRYax1oB/86GOx1d8DijhdbjRbtDiu21+pr7HCJNM3uXIznBS0xHpYE7RNqxJVGu8iTn41Pv4FlRx7VJltXxSwOC4uuUv6RlD+S8kdS/kjKH0n5Iyl/JOWPpPyRlP+xpLzZld6m6S1/7rnZH8Xbf3Da/oOw9jtoOxcCBZ3cX8fjbyDmBTrHFzhg54N6vK9KNorsJRfQfotP4Y1eciXFAKRpfi9lcHY/loFujOVbLhm/QywfNa98bqz8iiKFs8rnxI6yDiXb9jwQyFAxRvKX7xvJa2NnUgjUKfzbVCCMfkLkf4lQoi2kcxQRDdcsQ+ci97AY2+tQgBt7Ibpnz773OZXWkOPhnkZn5OsU/kGlF88KrTX2UBznYc7SjGottNq01U/fu5Xe6IhG4NAu0cYoUjjTUGm8LTGjsRsWwWRZZe8oxtfcc7VJQcIcZpWlGNPrNfu88gRuDc0MviCgi4jiaIrcPs2MwMvgmgviiusFS1n28cNbljDFZ6j6x7ZcUpZVVsHTf8HF+8srmLDc+zIdjZTJuMqN8+nz8fPnI17K0fJ0FEbqaMJgMplogKe/wISdtc0TMp3CS+QWLfzp7Pz81eXl9Or931+921Y4j2f09KouMYXdY+plBTxZT9gXrCcshQlbclXhhDVPWJNsYruofR7u2110m4VNfLIojfUdVLmJnuju6wi82CyH+XpE+8JDk5BE6Ry5QOterHdSEb1u0zFh8Oe2X6fefEHdtNoU8otDYU708USXVmp/1Ll7QsJHx8fDBPzKl/wy1M8gCVuL/UEb7SgPm9j5iksPc/RZHiL/X+JeR/cL9LkR5DeVz25O0k4MduuEYr3pSmUdE3MV8nKT9CrDSonZ2a+WKN2lc2ZEnYYbyknsYDmvj9bwBetBbqE5JmlK8c8THdMSmHyXkp2Et0JG4YkyiyMSPf6ZURfu4JNFYs68/1ZB1DZkiKUsEDjiJcQh2XZS6ZgCbMTGjZzn4GHsMaa39BoELlGZskDtWwAKRRINrUtrvMmMatLRaE2mmnRNTdHsWTuvnDdFZyJhS24l4bRrMTOYibQ7fIBr3Rx8a2gf6Z8AS9v2f7m6uoCNnSZh5M22vU28e85dRmSld/EWYeHNRbgTG7tj5GCqWv0g3TR0fh26XtJciEEGjF2zWajN1+GqRx31zys6oyBG953wtr+vh6CbhJSnFucWXf7/GiErzugP/V9IvLrzM/z496Lz430+P/6R+Pz4hyD0CZN6bvYvnZdViTZ+V+uuboMl6uootzyNxep8wQMdaT04iBs7n9y6LOOtH5WKy8Dl2i9lEVKuGS8l7XdKp95aoQ6MLXbN1usZd/jRqqah5fjRL9yVui4P5CJhEb0DEn3BOhCvHocDKKgqfJPaZVgEOVHjLMswTJ+7ZT8NsJGGB0vYrP17oMII0rF8Rf+3wVcsZSxhJiQjNGlYizOwivQr2qTuITI/yNimy9ofFFX3TU3XAw/X6ygRxxBBYwwljGvW0H3uP6w77KY= +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"; + + + + + + + + + + +Create a new chart + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboard.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboard.RequestSchema.json new file mode 100644 index 00000000000..4b2aa156536 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboard.RequestSchema.json @@ -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"}},"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"}}},"description":"Dashboard schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboard.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboard.StatusCodes.json new file mode 100644 index 00000000000..8dc15a2a64a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"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"}},"type":"object","title":"DashboardRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"certification_details":"string","certified_by":"string","css":"string","dashboard_title":"string","external_url":"string","is_managed_externally":true,"json_metadata":"string","owners":[],"position_json":"string","published":true,"roles":[],"slug":"string"}}}},"description":"Dashboard 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboard.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboard.api.mdx new file mode 100644 index 00000000000..8d4cc7fe37b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboard.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-a-new-dashboard +title: "Create a new dashboard" +description: "Create a new dashboard" +sidebar_label: "Create a new dashboard" +hide_title: true +hide_table_of_contents: true +api: eJztWW1vGzcS/isD4nC1cYolFw0QbJEPjpuizgWJESm4ApGhUsuRljaX3JBcyVth//thyN3V6sVumhQo7uAvtpY7L5xnXvhQ2jCLn0t0/pURFUs2LDXao/b0kReFkin30ujhrTOa1lyaYc7pU2FNgdZLdEGNPi4a6ZlAz6UKLwS61MqCllnCfoovwCzAZwg7WmzAdKkUnytkibclDpivCmQJc95KvWT1oHWDYjavDq1fo3VGg7GwtKYswGfcQ8YddGrgM+lAcJfNDbfii1y6I3G8X6G1UiBcjsewMDZE05k9Y0fsdG9nXnryt2/zAsKL4+Zyfv8W9dJnLHk+Gg1YLnX7PPqCIPDeo9VczUqryPMfKkg3y7nmSxSzVldVj2jOjVHINalSqcxy9Fxwzw/DnFAG3ozfvwMzv8XUg3SwRI2WexQgKs1zmZI3WGeoIVUyvZN6GSBxfIWUXrNCu7bSI8xL740GqXchg5XE9RlcBet4XxiHAjK0EV2LC7SoUwSuRVgpzBotlA6tg3VmIOcVrLn24A1w5dECuAJTqlUouOU5erTuaJ7NWqMNJSM95sdqhwSAW2z8SeGAK2XWVJ4GBCr0Ico043qJeyV7BlcLULjwgHnhK6hMCWupFMwRjMa2s+Iu2qdjlSm1xyVa2nKzwq3lFT0XxsnQx23XH8ngbei0mMH4eo4uOGu1KWmN/7UUS/TuIE1thvpZ39ZCyD8Xt6XzbQG0hpz8PSavdeZgXkHpSE5YvoR/grCmOF4Xx7JWlHMlXYbi6MxCm0uNVBroM7SUHG38XmYokJV0cq6w9auk84QBV2or1y+bXttYo/CxsvlA78kHj2bXmUwzELgIO+Npis5R/ewBPMnQIQTjoea4WvPKQZjtKGijXIgAISlbJEjSiKjRQC3s0IPCFarGSahAbRqbcQM0WHEfa9rrisswLmIjqaj0ZVXoVLk8hOGjlp9LBClQe7moKOEFt76bmmucU0SW0DhW/b1B+v3z5zuD9PwPB+l2l7HyKY44zNlPrZMP6PxFIc8K43wcvTwv4rx/4JBsze8fb711tyN2cJRsX+0O+u36A/M8Rrk3sbda7Sz7dH5zMBW2Ur3eifaaUg5aMYtbBOkk3G2vrl4abjEIlETa1h71BrrCaBf74/vR+TcQFRk6vMmiLvN5LD6LrlT+idc88ZonXvPEa554zROveeI1j/GaA41dpkOn7Hn/VP3fpT5fxXyOEZ9HmA8XAgVB+MNo9A3cJkfn+BJ7BOfBBO+mq1Nkr7iA5huhBK70iispeicDFNasZNjsYTw93RjLt/C0vyCWj5qXPjNW/o4igYuSWtk3/qHjmEcC6SvGSH74eyN5Z2gQlFokNPdakJHgdqa0KYIw6MLsxnsZ+vMgqM4GeXn+d9fZlY6dCA7tCi2gtcYmcKGh1HhfYErRhUUwaVraBzL1M/dcRbng3GFaWukrlnzasNu1p1asbwbM8yW15bblHLsZsPtnqRE4DttzQUVxTU2bfvzwlg2Y4nNU28cINT2XVsGzX+H6/XgCU5Z5XyTDoTIpV5lxPnkxevFiyAs5XJ0Pu4E1nDKYTqca4NkvMGUXTYUFxBN4hdyihX9cXF6+Ho9nk/f/fv1uV+Ey5urZpCowgf10bWUFfLeZsjuspiyBKVtxVeKU1d+xetDFd135LFxM2gi7hS5GmRfG+rbU3FRPdXsLg5fdcjgNTsgv/BkgBlEjQy7QupebPTjizhtIpgz+1ZzQM2/uUNeNNoX98lioU3061YWV2p+0Wz4j4ZPT0z4Ib/iKj0Mt9YDYWdwm3GhHWHTx8zWXHhbo0yxE/2dj38QQcvSZEbR3KqV9XJJWDPbrheL9rS2ZTQRnErD5bbBV6VdMROiwaqJ0C+nciCoJl5iz2NFyUZ1s4A6rHr5Qn5I0wfzjVEdo6PTsYNkDvREyCs+UWZ6Q6OmPjLpyt5cvLXKPwEHjeucqG1FiCQvUY8AKTqyGHYJLKQvjJDZz5AFHE8P2nb+l1yCIDpoiR+2bwRQKJhraFNZ4kxpVJ8PhhkzVyYaapD6wdlk6b/LWxICtuJVEv1wzS4OZyAEXPDCksE0iMbrMaVA1j/QvjKpd+79MJtfQ2akHjHaza6+L92Bz4zhx6Z3mebiRXV3H65HdM3IUqkY/SNc15bGdumM6L2KQYfZu2DzU6M/G5pzsvfnPhHIUxOiWEN5uSXMImm7aaz+zuLDosq810tzXP2x/3Hr9//A93Oir2OjokI4OmNQLc3gNGZcFWof9G0BviVoryq3Omwu1z3ngClRKjzXxjpuON3i898NCcRmuis2XOLG/PzFeSPJ53keaDRi1Q6z3T2yzmXOHH62qa1r+XKKtIv1uWy4wgAGLIzWMhTuknPaHY+hQVYZb2j4Nov6PGhdpiuFYeFj2pjesaKKzAZs3v6vmRpCO5XRNp78Jo8QGQELHhLV4OJWRI0WbVMpER3uodSXffKCo2lumrno73GyiRDwbaE7FUMI5yuqbuq7/CzGng9w= +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"; + + + + + + + + + + +Create a new dashboard + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.ParamsDetails.json new file mode 100644 index 00000000000..929229370aa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.RequestSchema.json new file mode 100644 index 00000000000..28d222028ca --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"examples":{"numerical_range_filter":{"summary":"Numerical Range Filter","value":{"dataMask":{"extraFormData":{"filters":[{"col":"tz_offset","op":">=","val":[1000]},{"col":"tz_offset","op":"<=","val":[2000]}]},"filterState":{"label":"1000 <= x <= 200","value":[1000,2000]},"id":"NATIVE_FILTER_ID"}}},"time_grain_filter":{"summary":"Time Grain Filter","value":{"dataMask":{"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":{"summary":"Time Range Filter","value":{"dataMask":{"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":{"summary":"Time Column Filter","value":{"dataMask":{"extraFormData":{"granularity_sqla":"order_date"},"filterState":{"value":["order_date"]},"id":"NATIVE_FILTER_ID"}}},"value_filter":{"summary":"Value Filter","value":{"dataMask":{"extraFormData":{"filters":[{"col":"real_name","op":"IN","val":["John Doe"]}]},"filterState":{"value":["John Doe"]},"id":"NATIVE_FILTER_ID"}}}},"schema":{"properties":{"activeTabs":{"description":"Current active dashboard tabs","items":{"type":"string"},"nullable":true,"type":"array"},"anchor":{"description":"Optional anchor link added to url hash","nullable":true,"type":"string"},"dataMask":{"description":"Data mask used for native filter state","nullable":true,"type":"object"},"urlParams":{"description":"URL Parameters","items":{"description":"URL Parameter key-value pair","nullable":true},"nullable":true,"type":"array"}},"type":"object","title":"DashboardPermalinkStateSchema"},"example":{"activeTabs":["string"],"anchor":"string","dataMask":{},"urlParams":[{}]}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.StatusCodes.json new file mode 100644 index 00000000000..e498778f061 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the permanent link data.","type":"string"},"url":{"description":"permanent link.","type":"string"}},"type":"object"},"example":{"key":"string","url":"string"}}},"description":"The permanent link 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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.api.mdx new file mode 100644 index 00000000000..98855f53677 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dashboards-permanent-link.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-a-new-dashboards-permanent-link +title: "Create a new dashboard's permanent link" +description: "Create a new dashboard's permanent link" +sidebar_label: "Create a new dashboard's permanent link" +hide_title: true +hide_table_of_contents: true +api: eJzFWA1v2zgS/SvE4IAmOCW2c7e3Pe3mgDRJb9PLtkbstoezDS8tjWPVEqmSlBOvoP9+GFJftpW22xZYIIhtcmY473E4M2QOKVc8QYNKgz/JIRLgQ8rNCjwQPEH6tQYPFH7MIoUh+EZl6IEOVphw8HMw25SktFGRuIeimDlh1OaFDLckEUhhUBj6ytM0jgJuIil6H7QUNIaPPElj1PRdZAmqKODxXHFxj/NlFBtUNKOzJOFqCz68rmTYHcmwl07Ggw2PMyTZkBv+K9drZ90o/lKq5Iob668z6dAGMgYfzO9zuVxqNOCBTMGHf507a+BPBv1+f1Z4T4r+3IieWdFZ4ZVLjAw31p2YL5CUyRb7+Zw90r+zfr9x2S7jOQMeRCGhvBjfvLuev7y5HV/fzW+uoCgKD0yU4Pxe8Uh0UjOOEmT/puk/ykrLsP4Yc/BhOHjfG/zzx/5Jf3DS/9u43/ft3//gaYDvEdcMRRiJezbiJlMh37ZAPm3yS1A/HRAW9VfFQmMYfLi6GF9fXF0d0ef45tfroymc9c9+IGcH/6idncKxx05+9FjIt8fMZx0iHQyV7nzfNT7DWCDjLPlEnFza+T9K2b3iIou5isy2ihSpQlTzkKA+iXzSlvrMdluVTr/f0cy3H3iFPJ7b7Fae4pvX9SmGV3Il2JUkLzvOcg2nJfYJMEU7U6ZKpqhM5FIdD0y0wTFf2F8h6kBFKSVG8OEyUwqFYU6GhVyvFpKrkBkS9yAymOiO5OuByOKYL2Ks8nQpwJXiW5rnIlhJdbjiG/uFx8wJsDgSa8bDEENmJMtUzFZc26LQvUDjQXsvdtegDWEJ12uWaQzZUiomuAXoSGbasvzkGnLxAQNDa2QqHlLd6qDu7d0tGzY1rcXVJ+TYGrcndmtZyiN14MJniS32naQjaGJ75KvNG6JKOPFqg2nkwqLwqvq3HxOTitNZs2vV0A7Lu3xM8mJm4263YtsBnUqhXfSd9QdfUJqfit01bg8ZHa+QeKR4UWhUhBtkZoUsJdyCwtkGFXl+Ch2Bk6n40OiucofeAfO7jFpPG9rsGo0uhesBhj1/H7hm2kiFIdNZEKDWyyyOt6e00N/7/W9gMUGt+T12NVGfBlUrwgsesrLb8tmN2PA4ClnT0rFUyU0UYtiFtaXrsHxLRHwHLG8Fz8xKquh3DH12kZkVClOuz+po7gDSVrRIzs7+bCSpkhQplDAYoTBbn72jzXFoUCmpuqBcyiwOmZCGlRZKbVrqhz872G6EQUU1QqPaoHIofHYhWCbwMcXAYOgGmQwCKmGd2/WSGx7XFHigMcionbAF+sODAX8yo1uE4fc2DdYJlA3rk3kbiTUlxseTQIY4qi4QE+pFxT34ELy9uwWv7kzLn1pmKiAoAVW0k/+y4ZvRmE1hZUzq93qxDHi8ktr4z/vPn/d4GvU2g15dfXuDXlrl8Cmw6XQqGDv5hU3hoow/uxU+e4FcoWJ/ubi8vB6N5uM3/7l+vatw6TbxZLxN0Wf7+9jIhuxZPqUkNgWfTV33MYXiGdCVpIQ63JqVFC2w9UANN0pSqUx12vVUTEVVDdh5PXyaSm2OaF32lZx4TnmFPESlz/M9ZhyIkp0psL8ybhPq3Mg1iqLUJgbOu1BPxfFUpCoS5qjy/pSEj46P23y84hs+svHW4mRnsAkDKTTRUlPBH3hk2BJNsLJEfAMNuUOToFnJkGBQrO1T5FdibD+KCPpvVSDljqexpek3r1Fpx5Ej6zCWnHTF7kKGW5+9Gr15feoSQLTcHuVUuFtUs+KYpInxn6bCsUR1u2Zoj/9SSMZ4Gsv7IxI9/gnoEO+lN4XcIONM4EPT1T7TezUXPHC0UQMgNW2ZfZLw4ZD4PF0XDfe0uTY5uWTgyn3nFsK+b7c0zULcYCzThFxxlmxoOUN5qqSRgYwLv9fLyVTh53SyigNrl5k2MqlM0OVCRVQNdJmZrRnX7ix5FpvSTfAARZZQ2it/0oeGAyZ/GY+HrLZTeEDe7Nqr8R44N3L5m+boFsSkYjdDMkJYdo10UlXqW+nCvvhUOdx2tQ6kzeQ5LGwI032Mk71X78dQ3onoALrZpquzoAuPlOcKlwr16muNkBUtxV3zFnX9fRttuhHYy59YysPGdZSlqNxDUXUTaA1RhDq5zcARr03CbQEvX92+/KjsrFtXd4OPppfGPBKt3tqdognwNCInBhZfaRo88O1TX3OYZlVYTSDPF1zjWxUXBQ1/zJAu5JNZE9n2wIWR7XlC8Jc81njgXN28wNFd2dEds2bndp2urlii9YgE4JU9fboGe0F3mdSu7ibaObGleNAs0bl2GhdBgLYwPC07a6UkSuTgwaJ83kxkSDqKP9A7KX9wTkqL2Z4EO+bKU+Y6KWeTQpQ619au1aFcfiFUnTTkuZNwJaGoWbGVFOwV8P/8zmbG +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"; + + + + + + + + + + +Create a new dashboard's permanent link + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-database.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-database.RequestSchema.json new file mode 100644 index 00000000000..59f66b9df37 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-database.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"

Refer to the SqlAlchemy docs for more information on how to structure your URI.

","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"required":["database_name"],"type":"object","title":"DatabaseRestApi.post"},"example":{"allow_ctas":true,"allow_cvas":true,"allow_dml":true,"allow_file_upload":true,"allow_run_async":true,"cache_timeout":1,"configuration_method":{},"database_name":"string","driver":"string","engine":"string","expose_in_sqllab":true,"external_url":"string","extra":"string","force_ctas_schema":"string","impersonate_user":true,"is_managed_externally":true,"masked_encrypted_extra":"string","parameters":{},"server_cert":"string","sqlalchemy_uri":"string","ssh_tunnel":{},"uuid":"string"}}},"description":"Database schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-database.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-database.StatusCodes.json new file mode 100644 index 00000000000..c178dba40e4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-database.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"

Refer to the SqlAlchemy docs for more information on how to structure your URI.

","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"required":["database_name"],"type":"object","title":"DatabaseRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"allow_ctas":true,"allow_cvas":true,"allow_dml":true,"allow_file_upload":true,"allow_run_async":true,"cache_timeout":1,"configuration_method":{},"database_name":"string","driver":"string","engine":"string","expose_in_sqllab":true,"external_url":"string","extra":"string","force_ctas_schema":"string","impersonate_user":true,"is_managed_externally":true,"masked_encrypted_extra":"string","parameters":{},"server_cert":"string","sqlalchemy_uri":"string","ssh_tunnel":{},"uuid":"string"}}}},"description":"Database 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-database.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-database.api.mdx new file mode 100644 index 00000000000..998c711dd2a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-database.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-a-new-database +title: "Create a new database" +description: "Create a new database" +sidebar_label: "Create a new database" +hide_title: true +hide_table_of_contents: true +api: eJztW+tvG7kR/1cGbIFzUEWy09w10DkG/NAhvrp5ybkrEBl71O5Iy5hLbkiuZFXQ/14MuS89HDtJgftQfUq0JIczP857kiUz+LlA6850smD9JYu1cqgc/ZXnuRQxd0Kr3ierFX2zcYoZp7/lRudonEDr90qp51HsuP+VoI2NyOkk67NTWoPz94PT6wFcn55dDeB0CNovg1AwfHcFV3zMOswtcmR9NtZaIlds1anozh6k+9vl4PevJZtk8j6qhUVjwWkwhQKl1dPh4Gpwfg3WcYcZKmfh4MPbi9PrQQcuBlcD+jNw0oFut/vkcQxMhMSoyKXmyX2MOA1hA5wPfwM6AAl3HIRyGlwqrP855hYvJ2BRYuww6UAukVsEiw5cihCezYK/FhOYaAOxnVWkhYLBnTO8+wVeTaEibhcq3ub0TY6GO/Q3VdwQTb89NVrpwkKmE+xAhlwJNQWX8sDZ5wKNQAvcIOAdxoXDBLQCg5l2CHNtbukluAWd59piQoho5c/OcQwWzQwNCGdRTrpwTYhwa4sMbbhkoQtI+QyBwzlKNIuSJmFT5ER4jlLSnxwM2kI6C2Me36JKuvAeJ2jAI00SWcel9AYBiY6thzHThpYm2mR+ZTeGMY9TjJzIUBduG8GLwgSyB0KBxVirxD4BPfH30lmPWTgdHi/lxtmwo6UDXTitt+kJHIJQCZlwBUZFDkEhwYZ3uTBou/Ba+/cjUjjhHoRS6qnUYy5rqmIChUpwIhQmJKoqpORjiazvTIG16EI5nKLxoms1EdNSwChDl+pS2/1FrM/sZ8klaegiIhhZZwOd8x0UQFgy0qTShYnxjsurR3gN/7l8SZin6NLwlHiXS50g5NzwDB1pl/YLudEzkSBoJRfAocVVYQTJiqrIWP/jLn4XimciDj9vVh1WPUikeIY7bLuxE9rgmU5QOTFZhFeItVIYV/qU8bsrVFOXsv6zHw87LBOq+n1UQ26dEWpKiCdGzNBs3zp8d3Ua+IawxXsXi/c/Y0MT1VSoHZK0aIYtX0Pzjiw6Eiqyn2nrNvWB37Gu43TB8N3VfZ4V7xwaxWVUGO/dH8GFM3z76uP85Nfhm9cQNtKDOC687/IHYE2tAWWICt3jsTk5Ij+EcBzrBE8CKpHXNnvc899Ajz9h7GCKzkKhclLSpHLpCMccUoOTlyOWOpfbfq9H3qbbqF1Xm2kPVU+SZbterA32wj22m7pM/qW1NTbIHUZhecTAoHw5YkrrHBUaUNqQjzNoRuzkvmPHPX4CMZeyA/OUQpCrxcvQcXqZDQG/VzKDMjqKDoNo1R1bsoWw1v0XOn7BHX+8dNWJWjD/bs/a71YLtua6K/koypSetPKMFp0j9Wg8eIgPJR2YoIvTHR57mGNMdi8cBaFj64xW05MR283AiPVhOSrzsO2lnw4POzBijjR+5+rquFfe0IVL8uUWXaeUZC6kBKUdjBFQEYmQKXj/WijvjrgUbvGtYYZA/nsb5DIvicq8hPxnOylaR1tnGQeLpGiUJEhh/e1VbuNvPh/+FnKJKtNp8ien78f6AT4Iu48jlhdjKeIRI4RjO6sXb9YxrR3VRPKZNpBotB5WW+S5Nq7kmKIOV4vql7BtnscIPI7RWkrmPhXWgURKYghZLzhmuVsQns/beM7QWKFVhdtEoEwCeqUbswGAkIJVjnX8g4XyZJlB2VQXMiEufIydC5fCW4PWabg4s2B18852oRy/Ax+zjMHYEVM/tpnyYtloJowruIyCbvoobHAHp6Uvb7NaRW9tPI507SCch3Hh3Fq+XydxQYy58lr3U5uhRFjPQ/BbBmcC59/EiLfrkkCdyXorGqOvHOYpqmD4HnG6tXEIDc/df+xkzwgpI6ejBB0X8ls49CRInwIJOlVSbyy79kQvth4tygrpRBRzx6We1tZYG7uYrOf84aUpOaWwEVSsTPOgJBIgMYXyobTO/lUCPuLQRyJnkWJpLz9hOyL2RJsYfbEZNfXoevT+nW7x7BDFB2vPTrCE8runb4OB+CcLBhlCoq+W/O7y7i+mZ4ePSINElqOxWlG8pbpzW5rLSWl9HZJprW5qKT65van2uHt+63KKB1niwhhUTi5A6uk0pM50H8xTDRn5GF8n5WgyYckZVPWvSzEjK+qdXE7glaBaSiWQihl2Q/n1rBvCRTfRp97wyujRCcZQ0mhe2/qyTcTeyelCuQ7ZMbSA+DLDM8HXr8+Nvlt0/VrZl1jsrsOEjTKu+BSTqEoU5eILaWLraMbtLR1TsVnkLhD4usSRJ4kIMbSV368nkt5ZeRdc1TetwqR1qFVwekO2C+swsyDFLfon6jQaoxI4E9N3BZqFz9/iFBLt/Rdd7SulkJ0RflSO9HNu7VybpHLuiu6SchE4Gi+gyforI31Qy5tyy/eLaijetvtIq83S7+LsaXBuIm4XbL4EbuPWPHZIrenGoBxRjGZHxX2cn7zJy8c4P43OPry+uBpA2f3yxe+MS5GQKr66vn47hLJPZrvwxteHMy68wKSUdAUXqnGEVTL+WHDWa82d3K61Ir4yj362o0SoeH1aGGkfyJyHn2VdOOrY+qx5V++DsEhD08o6U8SuMEgNGAMf3l9WYLS85dHhs+cPVrPWppErlEJZNhrfTFj/42YDUuzooA2Hr+Dan4TLCzggjoucntQ+eVTnojIDorytz0bMyGPf4uKh9eiLhEo15Uli0NovbaHksbXe4rSy3B2nV5uW0WFOOBKbXZQqMBy+CjCx1c0mLkS8ELs4X3V871gYTKgpst7xuHn41vdo3Wkuurm2LtThPMslbnaTw+O0+8DtL76F2/6w1lJtL7T6l+HzRkvu6N5O1XY7p8KgabU0X6pGSevLVpsjMLDeqWjv93Gl+bAj32kWt7OHQP2eSBcW74tlDdk1d73pTJttm46rtdI221qLGu3ZdvWV86zzqka9Sk00aHOtbLD4Z4dH3zGwWFNpVWTjYEiheNjPN/bzjf18Yz/f2M839vON/XxjP9/Yzzf28439fGM/39jPN/bzjf18Yz/f2M839vON/XxjP9/Yzzf2841Hzje22FyfeBAHR+32834E8n8wArl/BsKTBBPSkeeHh98x5cjQWj59lNms62N9kJ3xpIoNfbhUPmq0Q1UZvJNdI53W2SDL90xs/geyfFC8cKk24j+Y9OG0cCn1JMP9UBv7DkHaB4Mkz/9cSV5r6pMXKun7mqYEGQluqwsTY1OV453wDmhLqJoG3fLjn61nlypYaDXxQGO06cOpgkLhXe7nPuEj6Nhnzjtf6hcqw8I+f7nFuDDCLXxI/TR3rP/xhqKA41NLbr2yOPLod0+pABx65qw/ILmasj6LP7y/Yh0m+ZhMufoZgKbfhZHw9N/w9s3wGkLK0u/1pI65TLV1/ReHL170eC56s6Ne5UZ7Iwaj0UgBPH0FI3ZaqpeHuw9nyA0a+Ovp+flgOIyu3/xz8Hr9wHl4qKfXixz7sPlWzd4EfliO2C0uqMczYjMuCxyx1Q9s1anFe7twqU8xKwHrD7WIIvOdnSpJHKmRqoax8LLJHSnWHdC98BU4dMKBFHmCxr5cbqARGC8RGTH4W9k5ipy+RbUqT5PUL3dJOlJPRio3QrmDiuMubT548qSNwa98xodej1o4rH1snlsrS1DU4vM5Fy60QbzwXyn6MkgQgi2xTnq0CUu/2gab2kLi/lEpzDJgc+2h+aPTHGnrSwBoW2fC7grRsU4WfaBSrxuMWUwWB0u4xUULXlg9od2E8s8jFZDxzZ8KlQ3My01aYlfq6QFtffKzT8s2RmK+FwEcFM7rsoOS6zIjYT6rohhNaTXbgpZV4TrYcUgvdr7K1jTuipYhwRlKndPQo/RIXlsCoWVutNOxlqt+r7ckUqv+kgxktT3bK6zTWUWiw2bcCMo+belEPZn1cSGx2ZrGlT99IcS2gKLiDWo6qw4jbtbp1fJuMTcMrpbW/JhOG7h865N7bTaI7ISqPO93r1b0ipW7HVKgCEJ6p7tkY6+hv/hSikzr92t6I7+N+hB+talyvdCrDh2ODE4M2vRbiRAVq9X75v+5Dv7cf2l0uE+mvzeZ9vXSYbuCbd3ULlx3fo52HdssU7dWgk0ctovRVgm7kdt3GLUNdpTsBaGL7Xqx9akcUrA+mx0FM7Qu4z7zKi+8zy+u3VInYQ7vXC+XXPgGXzkwDi7zI+O5oCuPWKOOrMPIwwQX8pEtl/Txg5GrFX2m9iblUTeNF/PZVIeFGOU9bUC9HW2805MF8bOVUpJLDSdO4xh9mL1/703L/VOIZB02Lv/XOv3jG9Znhs/pn43xOesz1mGh3e2dkP8Wgn0R8s1Ak7wDpfYt0GovUv6FpCqXuFq0OFwuw44QbMn1B1F8XsJWN6vV6r9CEHBu +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"; + + + + + + + + + + +Create a new database + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dataset.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dataset.RequestSchema.json new file mode 100644 index 00000000000..7f5b06453dd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"always_filter_main_dttm":{"default":false,"type":"boolean"},"catalog":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"database":{"type":"integer"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"normalize_columns":{"default":false,"type":"boolean"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["database","table_name"],"type":"object","title":"DatasetRestApi.post"},"example":{"always_filter_main_dttm":true,"catalog":"string","database":1,"external_url":"string","is_managed_externally":true,"normalize_columns":true,"owners":[1],"schema":"string","sql":"string","table_name":"string"}}},"description":"Dataset schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dataset.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dataset.StatusCodes.json new file mode 100644 index 00000000000..7030b3700ad --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"always_filter_main_dttm":{"default":false,"type":"boolean"},"catalog":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"database":{"type":"integer"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"normalize_columns":{"default":false,"type":"boolean"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["database","table_name"],"type":"object","title":"DatasetRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"always_filter_main_dttm":true,"catalog":"string","database":1,"external_url":"string","is_managed_externally":true,"normalize_columns":true,"owners":[],"schema":"string","sql":"string","table_name":"string"}}}},"description":"Dataset 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dataset.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dataset.api.mdx new file mode 100644 index 00000000000..e9ceb676c69 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dataset.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-a-new-dataset +title: "Create a new dataset" +description: "Create a new dataset" +sidebar_label: "Create a new dataset" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/isEMaAJpsR2sAKFin5IshRtVzRB7W4DosClpbPNhiJVkrKjCvrvw5F6s+OkWVOg/dBPsci7I5/n7h6dUlINn3Mw9kQlBQ1LGitpQVr8ybJM8JhZruTgk1ES10y8hJThr0yrDLTlYJytWLPCTOdcWNDTlHE5TaxNcSuBOcuFpeGcCQMBtUUGNKQzpQQwSauAxswyoRZonLKbtyAXdknDo6fDgKZcNs/DgMpcCDYTQEOr8y6UsZrLBUZKmGUzZgBD1ZtcWliAxl24saAlE9NcC7T4ajhupimTbAHJtPEVxT2ePUxS6ZQJ/gWmsRJ5Ks3DqFBrCdrZcgup2Y2jXmFaswKfu6Q8kj7z+WG8WNydSpbCVw4d3XKuAldxXENCw8suYRtBr1o3NfsEscVdbvFC9E9mmQH7How9zvhhpoz1qWVpJuDeUvRg2mJrrtSvmtF2kXRGd9SCD7oj236jyefl6KrLUxfUEd499nntGMO6BhNrnmErdhyQOl6fUTzVUWwyJY3vzaPh6BGdzZNeEco8nfka1GBcJf8Sgl9C8PMIQbVtvykNWMujfu3+nFrxCKm4UytYkkCCdPwxHD5CDVIwhi36bdXL533Ut470hCWkHjpC8lqumOAJyZhmKVjQhmRarbi77G00PV+P5THK9h2wfJAst0ul+RdIQnKc2yVIW59P2vLeAaTv6JAcHf1oJJlWMT7OBBBEYYuQ/I3J8WhAa6V3QTlVuUiIVJbUEWpvPOrpjy6219K3HzGgV6A9ipAcS5JLuMkgtpD4RaLiONd3pOslCkFLQUANxLlGjOFlST+tLTZthWLFFtjATdcZFLCbg1glMHaXM85BMImaEn94/5YGVLAZiO7RqFzHePU414Ic/EsuzscTEtGltVk4GAgVM7FUxobPhs+eDVjGB6vRIPHnDSJKoiiShBy8IhE9rkvMsR2SE2AaNPnt+PT0bDyeTs7/Onu36XDq83QwKTIIyXaqOtuEPCkjeg1FREMS0RUTOUS0ekKroEV3Udilkj187UKLkKeZ0rZpaBPJSDaDC3nRLjtp38NzycNpCLz9ElgC2rwot8jw964JiSj5nbAYS3dq1TXIqvZG0C92AY3kfiQzzaXday58iMZ7+/t9Ct6wFRu7KurRsLHYJVtJg0y06NmacUvmYOOlw/7/kJceQAp2qRK8ORbRNithY0a2awXRfmzKpfTUTBwzH4POpV8tnp/bFeOtG0JnKilC8mZ8/u7QdzKfF3sluYaixy6p9tEaSX4eSU8MwmtJ2aK8NlICDoVa7KHp/nOK3bilUxqYBcKIhDWp+aIB9RzRkLoJIqAZw3mFbhOLyXIS4lvYv/B3poRuH/wWt0kCKxAqS0HaWoxcqfhAZaaVVbESVTgYlBiqCktsjupWtNPcWJU2IQK6YpqjZptaP12YjRnTXZMGFGSeojjVj/jHCdRm/FeTyQVp41QBxdtsxmvx3rrc2Kss7uFoQpQmry8wCGLZDLKTqtrfWVcV5rBR2jG+IzxIp7clnbn6fInTFMZ788+E1nOTG6XdLm3fEw50FaDzVMNcg1l+axCMYpR83/3j5OwBX5/1pH/vSDn8fiNlfVw7Uw6/eagMKJdz5ZO3kas8A+17qJnJe0vYKd5uNfIFYGzK3Ou+jn9HP24c0r74LdzYQSYYdx9H9Webb9VLyjKOJ45qLn0crGxfupe0LJHfD1pUFS5/zkEXfs5uuse9wAPqldF1+DUUbrjpNM41m8jdF9f2FIOt7D2O4xictt9te9VTHRRmGtBZ/e+3VCXoo9kaP+vZmoaUBlQ5OlzxuzX/hsn9iONjYlXiSNnjrK3e+geiar4YZdG7YVl6Cy/xKDkeinsZ0uqqqqr/AONx9uQ= +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"; + + + + + + + + + + +Create a new dataset + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.ParamsDetails.json new file mode 100644 index 00000000000..5e4888401a0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"query","name":"tab_id","schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.RequestSchema.json new file mode 100644 index 00000000000..afbc36e6219 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"chart_id":{"description":"The chart ID","type":"integer"},"datasource_id":{"description":"The datasource ID","type":"integer"},"datasource_type":{"description":"The datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"},"form_data":{"description":"Any type of JSON supported text.","type":"string"}},"required":["datasource_id","datasource_type","form_data"],"type":"object","title":"FormDataPostSchema"},"example":{"chart_id":1,"datasource_id":1,"datasource_type":"table","form_data":"string"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.StatusCodes.json new file mode 100644 index 00000000000..f481dc28551 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the form_data.","type":"string"}},"type":"object"},"example":{"key":"string"}}},"description":"The form_data 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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.api.mdx new file mode 100644 index 00000000000..9609c6e94ff --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-form-data.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-a-new-form-data +title: "Create a new form_data" +description: "Create a new form_data" +sidebar_label: "Create a new form_data" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/iuHw4AmmBInxQoULPohSVM0XdEGtbsNiIKUls6RWolUScqJJ+i/D0fKsvwSrGsG9EtikffC57kXHhuspJElOTIWxVWDuUKB32oyC4xQyZJQoJPTmzzFCG2SUSlRNOgWFe/kytEtGWzb6wgNfavJulOdLlgk0cqRcvxTVlWRJ9LlWo2+WK14bWWrMroi43KyXi2TxrE70WBKNjF5xXoocJIR+F24eIXR1hEiTKWTVtcmoQf1VyLfYSRs/osZLxQhqbpEccVcFfztJchh1JNp5ZzSm+XXPKc7vO4PYJ3J1S37n2lT3rD2tucTtfDuQM/g7fjDe7B1VWnjKAVH9+4Qt8y1ISq5oZQPt07QNtah99XZ9PQLJYzE5a7ghdfalK+kk5faunEIYxsh3cuyKmg9hsdbUTneQXHP2gD8CsMaCGdq8gu20sqGlHl6dPyIhPtKi91B/koLcBoMOZPTnMBlBP0Bd5O9ztg6Kd7PGqptl715uJMWrNOGUrB1kpC1s7ooFods9Lejo0fgLclaeUuDKv5OAL0insoUumoXcKHmsshTWDUSqIye5ymlu2AOdAOWx8Tuf8DyScnaZdrkf1Mq4KR2GSnX+Yc+73YAGSp6JE+f/mwkldGcKVxMwCjcQsAfHJyAhozRZheUM10XKSjtoLPQabOrZz872S6UI6NkAZbMnExAIeBEQa3ovqKE+59fBJ0ktXkgXK+lk0VPQYSWktowRr71vtw5FFfXfIs5ecs3IZ7fV4U2BNzs4FXXEe8PEp3S2J8y3JeFVLcoMPn08R1GWMgpFavP0OT4uzYFHPwFlx/GE4gxc64So1GhE1lk2jrx/Oj585Gs8tH8eETB8ajvBTFCHMcK4OANxHjSJZ3nX8ApSUMGfjk5Ozsfj28mH34/f7+ucBYidzBZVCRgM3gr2RSeNDF3qRgFxDiXRU0xtk+wjXqYlwuXaTUA2i/0UPOSr6RlidtYxWrZrOFlv3xYaev22C/8AB9RUMxIpmTsy2aDlQCgYyZG+BWk76A3Tn8l1XbajP7lLsSx2o9VZXLl9pYnP2Thvf39IRdv5VyOfYIN+FhbXIVfK8uU9DTIO5k7mJFLMk/CD1LQBCQluUynDIHza5MesRSDzexh2J+XCdQEjiaeos/RSmWYP4Go7RwK0ktmpzpdCD+hHIZqz2eLvYbv0wHN0O6zNLP9IlaBIX/zLdnZ4L4T0gUdFvp2j0X3XyBX7EYvMyQdgQRFd6v7FCMMLKFATj2MsJIuQ4EPcswB9B0nFHptOL47w4SbZ3jH25DSnApdlaRc17t8+gRDTWW004kuWjEaNWyqFQ1XTrtl7ay2TpdLExHOpcm5xduu3XozYYSZybpw3TEHQ2n3yf8sbjH2ZjK5hN5OGyGfZt1ej3frcOPQlHmPXwugDVxcshHGsm5kJ1Wdvpdu/TNi2Zj9ZBlA+vbc4NSnKjdkyfbe/jlZvkm4yMLuaizzoNuIlW8MzQzZ7EeNsBWr1cfVA+d817B7tDXsHv3XYTfCXM309jw6risy4T2xnMIHS5ykQW5+HLi3rpT+Yu6ecA9WxZqb/pLm58SoKmSu2JzP2KYrmCuUVc4+jznBQtFsPhxCAl1h00ylpU+maFteDm8fLqY090NKimImC0tRNxz3D03fI1Cgr+9lvvsbOsLQ1ryZoDVsUAPdrTGFiy9onCQJ+Q79sOz1oGFwV8UIp93DttQp6xh5h5H/KxAj1J5Dn65+LdwTdZhhgk3OI54ZB0T3+db9YFTdllSLwQmbJkiE/sxNoqOMv7G9btv2H+1hcSk= +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"; + + + + + + + + + + +Create a new form_data + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-explore-permalink.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-explore-permalink.RequestSchema.json new file mode 100644 index 00000000000..fccb93729cb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-explore-permalink.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"formData":{"description":"Chart form data","type":"object"},"urlParams":{"description":"URL Parameters","items":{"description":"URL Parameter key-value pair","nullable":true},"nullable":true,"type":"array"}},"required":["formData"],"type":"object","title":"ExplorePermalinkStateSchema"},"example":{"formData":{},"urlParams":[{}]}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-explore-permalink.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-explore-permalink.StatusCodes.json new file mode 100644 index 00000000000..e498778f061 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-explore-permalink.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the permanent link data.","type":"string"},"url":{"description":"permanent link.","type":"string"}},"type":"object"},"example":{"key":"string","url":"string"}}},"description":"The permanent link 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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-explore-permalink.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-explore-permalink.api.mdx new file mode 100644 index 00000000000..1b107f2b669 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-explore-permalink.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-a-new-permanent-link-explore-permalink +title: "Create a new permanent link (explore-permalink)" +description: "Create a new permanent link (explore-permalink)" +sidebar_label: "Create a new permanent link (explore-permalink)" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYUATTImTYgUKFfmQZinaLmiN2tkGREZLS+dIDUWyJOXEE/TfhyMlWX4JtqUD+iWxqLvjPc+9qgaD3yq07rXKVhDXkCrpUDr6ybUWRcpdoeToq1WSzmyaY8nplzZKo3EFWnpaKFP+yp1/k6FNTaFJD2K4yLlxjN6zjAQicCuNEIOaf8XUQRNBZcSYG17aXe3rT1fMv0OHxkIEhcN/lGN3uDpaclEh07wwEIGshOBzgRA7U2GzfdD7xI3hK2iayNNSGMwgvlmDm207H4ErHFmBywctlMExmpKLQt5NHHc4CWw1EeADLzUJblC1if2mbmbN5t2ttwatVtIGqp+fnH5HoO5wtcveNEfijDnFDDpT4BKZy5FpQiNROkaQfPyO1wG0zhTytg3grtFN5T16zZ5UGPDkPe2E2zvWuk20B8OWv/fcMuuUwYzZKk3R2kUlxOqYLvrl5OQ7WCzRWn7r3fxvoHpFeM0z1tZezN7JJRdFxnSf6kwbtSwyzPZhHegGLN+TEf8DlmvJK5crU/yFWczOK5ejdO39rM/mPUCGih7J8+c/Gok2ijKFmgMjFG4Vs98pOAENGqPMPigXqhIZk8qx1kKrTVe9+NHJ9k46NJILZtEs0QQUMTuXrJL4oDF1mIVDptK0Mo+E6w13XPQURGAxrQxhjG9q+HrvIL6ZNdQk+S31s64psnFfl1eFvKM2+nCUqgwn3lXf+kBweQsxpNefriACweco1o9WVSYlIGllBDv6k40/TqYsgdw5HY9GQqVc5Mq6+OXJy5cjrovR8nSE4faR7npyAixJEsnY0VuWwHmbeT4IMXuN3KBhP51fXFxOJp+nH3+7/LCpcBHCdzRdaYzZdgTXshl7VifUvhKIWQJ+ECXQPIMm6mGOVy5XcgC0P+ihFqVWxnV1bhOZyG4OsLP++Fgr6w7oXvYEPqKgmCPP0NizeouVAKBlJgH2M+O+jX526g5l02oT+rN9iBN5mEhtCukOOs+PSfjg8HDIxXu+5BOfZQM+Ng7X4VfSEiU9DfyeF44t0KW5J+GJFNQBSYkuVxlBoPzapifuxNh29hDsL10C1YGjqafoS7RWGeZPIGo3h4J0x+xcZauYvZ98/HAcSr5YrA5qGtUDmllzSNLE9qtEBoZoUvfsbHHfCimBx0LdHpDo4Sugst1qaAa5Q8aZxPvtyXrQEnnUE3kIEQT6aPQrS2HT3OUQw6PkU2R9PwodIEz4vfGDbeeu6DXLcIlC6ZL8CpZ8XgVDtTbKqVSJJh6NajLVxDWVVLNj7aKyTpWdiQiW3BQ0AGzbjL2ZsOEseCVc6yZEgLIqqdO1j/TPwg6Vb6fTMevtNBGQN5v2erw7zk1Cy6Z3kpfIlGHvxmSEsGwa2UtVq++lm4bi3LVtv54GkL551zD3OfxGmZKTvfd/TClGXgzi9u16kfOgm4iUPxtcGLT5U42QFavkp/XHyOW/2ZhpjZ81ERRyoXY30Eml0VgcrumDI8q7ILc8DXRaV3I/iYnnJ1XAxv39uHb44EZa8EIOluVQHDfAdUHOnFIyBZNUOX2JzLpkuYG6nnOL10Y0DR1/q9DQ5J2t89XP3whCv/I1FZboYefx6S0q/7WzvYRQ8QSN8zRF33ofl50NCp7aJUQwbz8iS5WRjuH3EPm/MUAEyvPi082fhQFQhQ0l2KQ8oI1wQF6fL+0PQtV9rcnVwMO6DhKh8VKRByh+VoH/tPobNxopOQ== +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"; + + + + + + + + + + +Create a new permanent link (explore-permalink) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-sqllab-permalink.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-sqllab-permalink.RequestSchema.json new file mode 100644 index 00000000000..fccb93729cb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-sqllab-permalink.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"formData":{"description":"Chart form data","type":"object"},"urlParams":{"description":"URL Parameters","items":{"description":"URL Parameter key-value pair","nullable":true},"nullable":true,"type":"array"}},"required":["formData"],"type":"object","title":"ExplorePermalinkStateSchema"},"example":{"formData":{},"urlParams":[{}]}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-sqllab-permalink.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-sqllab-permalink.StatusCodes.json new file mode 100644 index 00000000000..e498778f061 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-sqllab-permalink.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the permanent link data.","type":"string"},"url":{"description":"permanent link.","type":"string"}},"type":"object"},"example":{"key":"string","url":"string"}}},"description":"The permanent link 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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-sqllab-permalink.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-sqllab-permalink.api.mdx new file mode 100644 index 00000000000..87740c0616f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-permanent-link-sqllab-permalink.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-a-new-permanent-link-sqllab-permalink +title: "Create a new permanent link (sqllab-permalink)" +description: "Create a new permanent link (sqllab-permalink)" +sidebar_label: "Create a new permanent link (sqllab-permalink)" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/iuHw4AmmBInxQoUKvohzVK0XdB6tbMNiIyWli6RGopUScqJJ+i/D0fKsvxSbG0H9EtiUXfHe557VYOGPtdk3QudLTFuMNXKkXL8U1SVLFLhCq1Gn6xWfGbTnErBvyqjKzKuIMtPN9qUvwrn32RkU1NUrIcxnufCOOD3kLFAhG5ZEcao558oddhGWBs5FkaUdlf76v0l+HfkyFiMsHD0r3JwR8ujhZA1QSUKgxGqWkoxl4SxMzW12we9T8IYscS2jTwthaEM4+s1uNm28xG6wrEVvHiopDY0JlMKWai7iROOJoGtNkJ6EGXFghtUbWK/btpZu3l3560hW2llA9WPT06/I1B3tNxlb5oTcwZOgyFnCloQuJygYjSKlAOG5ON3vA6gdaZQt10Ad41uKu/Ra/ekwoAn7+lKuLtjrdtGezBs+XsvLFinDWVg6zQla29qKZfHfNEvJyffwWJJ1opb7+bXgeoV8YXIoKu9GF6rhZBFBlWf6lAZvSgyyvZhHegGLN+TEf8DlislapdrU/xNWQxntctJue5+6LN5D5Chokfy+PGPRlIZzZnCzQEYhVvG8AcHJ6AhY7TZB+Vc1zIDpR10FjptvurJj06218qRUUKCJbMgE1DEcKagVvRQUeooC4eg07Q2XwjXS+GE7CmI0FJaG8YYXzf46d5hfD1ruUmKW+5nOPn9Ei7FHMZ9XV4W6o7b6MNRqjOaeFd960Mp1C3GmF69v8QIpZiTXD9aXZuUgaS1kXD0F4zfTaaQYO5cFY9GUqdC5tq6+OnJ06cjURWjxenIfuYeP6pWLTlBSJJEARy9ggTPusTzMYjhBQlDBn46Oz+/mEw+TN/9dvF2U+E8RO9ouqwohu0ArmUzeNQk3L0SjCFBP4cSbB9hG/Uox0uXazXA2R/0SIuy0satytwmKlGrMQDP++PjSlt3wPfC19MRBb2cREbGPm+2SAn+d8QkCD+D8E30g9N3pNpOm8E/3wc4UYeJqkyh3MHK8WMWPjg8HFLxRizExOfYgI6Nw3XwtbLMSM+CuBeFgxtyae45+DYGmgCkJJfrjBFwcm2zE6/EYDt3GPXHVfo0gaKpZ+hjtFYZZk/gaTeDgvSK2LnOljG8mbx7exzqvbhZHjQ8pwcsQ3vI0kz2s0QFgnhM9+RsUd8JaUnHUt8esOjhM+Sa3epmhoQjEKDofnusHgQej3oeDzHCwB6PfW05aJVwOcb4Jeo5rL4VheIPw31v8HDbtUt+DRktSOqqZK+CJZ9UwVBTGe10qmUbj0YNm2rjhsup3bF2Xluny5WJCBfCFNz7bdeHvZmw3NyIWrrOTYyQVF1yk+se+Z/FHSJfTadj6O20EbI3m/Z6vDvOTUK35ndKlATawOsxG2Esm0b2UtXpe+m25SivOrbfTANI37cbnPsMfqlNKdjemz+nHCMvhnH3dr3DedBtxMofDN0Ysvm3GmErVqv36++Qi/+yLPMGP2sjLNSN3l0+J3VFxtJwQx8ccd4FucVpoNO6UvghzDx/S/5vXN8PakcPblRJUajBmhxK4xpFVbAvp0yRt8hl0xfIbJUq19g0c2Hpysi25ePPNRkeubN1tvrBG2HoVb6iwvY87Do+uWXtP3O2tw8unaBxlqbku+6XZWeDaudWiRHOu6/HUmesY8Q9Rv5vjBih9rT4ZPNnoffXYTUJNjkLeBUccNdnS/eDUa0+09Ry4GHTBInQdLnEAxQ/ptB/U/0Dczok+Q== +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"; + + + + + + + + + + +Create a new permanent link (sqllab-permalink) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-rls-rule.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-rls-rule.RequestSchema.json new file mode 100644 index 00000000000..eca3f99a355 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-rls-rule.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","nullable":true,"type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","nullable":true,"type":"string"},"name":{"description":"name_description","maxLength":255,"minLength":1,"type":"string"},"roles":{"description":"roles_description","items":{"type":"integer"},"type":"array"},"tables":{"description":"tables_description","items":{"type":"integer"},"minItems":1,"type":"array"}},"required":["clause","filter_type","name","roles","tables"],"type":"object","title":"RLSRestApi.post"},"example":{"clause":"string","description":"string","filter_type":"Regular","group_key":"string","name":"string","roles":[1],"tables":[1]}}},"description":"RLS schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-rls-rule.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-rls-rule.StatusCodes.json new file mode 100644 index 00000000000..f831a0c46b8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-rls-rule.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","nullable":true,"type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","nullable":true,"type":"string"},"name":{"description":"name_description","maxLength":255,"minLength":1,"type":"string"},"roles":{"description":"roles_description","items":{"type":"integer"},"type":"array"},"tables":{"description":"tables_description","items":{"type":"integer"},"minItems":1,"type":"array"}},"required":["clause","filter_type","name","roles","tables"],"type":"object","title":"RLSRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"clause":"string","description":"string","filter_type":"Regular","group_key":"string","name":"string","roles":[],"tables":[]}}}},"description":"RLS Rule 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-rls-rule.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-rls-rule.api.mdx new file mode 100644 index 00000000000..878beb62c6f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-rls-rule.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-a-new-rls-rule +title: "Create a new RLS rule" +description: "Create a new RLS rule" +sidebar_label: "Create a new RLS rule" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/isEMaAJpsRx0AKFinxIghZNF7RB7G4DoiClpbPNhiJVvtjxBP334UhJlmUH29JhAYZ+inU6PuTz3AtPKamGbw6MPVPZisYlTZW0IC3+ZEUheMosV3Lw1SiJNpPOIWf4q9CqAG05GL9MMGcAf2VgUs0LXEXj2n7XNUbUrgqgMTVWczmjVbS5pg/ReerhSCcEmwigsdUOduBOubCg74K9j9t52cMF6XIa39BrmDnBNI3oGTNAb3fsMNPKFXf3sNrGb1/901NLlu84Llp7SDl7uAQ5s3MaH796FdGcy+Z5uANXKxGCtQnszT1kbiH3rjUIlxZmoBGltjCt2co/I5cdsMH+93FzLi/C22F/Ezw7fHNcQ4ZhqXNtM7y1bA3L9lzroKnJV0gtvuEW1afXl6NrMPa04IeFMhYPAQ8sLwR0M7oRsJela/NGknVyppMaa+cQ2/VzHZOb4e1ayZvhbVX1qwJPS+rq68qBOeT1MYWSJgTi+Gj4HaXMs06ApMsnIT4ajBP2R+X/qPz/YeVXfd/NXoAlMeyWwH/bHLq9AVvDzt5w7QQQlmWQ4eFfHh19RwvIwRg2g064mlz6C6HahfSMZaQeLWJyIRdM8IwUTLMcLGhDCq0W3B92m05nbeDyPe3sX+DyWTJn50rzPyCLyamzc5C23p+0+bmDSHdhYPLyeZl8VJZMlZNZTMZzaEQGlNsop1MgmQJDpLIEHrivjC1SLYZndHz83LEptErxcSKAYFzsKia/YrqF+IDWSu/ica6cyDzVGqFejVu9eu7yuZAWtGSCGNAL0IFFTE4lcRIeCkgxaN5IVJo6/UgCvmOWiVaCiBpInUaO8U1Jvy6tbyi+vcyMv/fUklzCAgQZNZ63EX04SFUGI39M45cKJmd4x3++vqQRFWwCYv0YMgmfnRbk4Hdy9Wk0JgmdW1vEg4FQKRNzZWz8+uj16wEr+GAxHGi1FLhxc8JBQkmSJJKQg/ckoad1HfkAxOQMmAZNfjo9P387Gt2NP/3y9uPmgvMQuoPxqoCY9KO39s3IizKh97BKaEwSumDCQUKrF7SKWppXKzv3l1hDtDW0VHleKG2bgjKJTGQzkpGT1uxvmz3clzxBjygsnAPLQJuTsqdKIFArk1DyM2EppvWdVfcgq3o1sj/ZxTiR+4ksNJd2rzn5ITrv7e93tfjAFmzkM6yjx4ZxHX4lDUrSysCWjFsyBZvOvQhPlKAMTHKwc5UhBcyvvjxx40b62YO0vzQJVAaNxl6iL9F6STd/glDbORS8G2UnKlvF5MPo08fDUO58utoryT2sOjKTah+9Ue03iQwKZcyyVp2e9rWTEnAo1GwPXfffUCzZXjPTwCwQRiQsCY4D2gmciYJINKZ+zolowXBGpI9KjPHzHSfUudMY3p1R2pp5LvE1yRBOFTlIW/cunz0BqCy0sipVoooHgxKhqrjEwqm20M6dsSpvICK6YJq382YDE2bPKfNTmT9mZ4avH/GPHwY38d+Px1ekxakiiqfZxGv5bh1uFJoyvsOZjShNLq4QBLlsguyUql7vvasKo9kEYIRXSiDp23NJJz5T3ymdM8T78NsYY+TdaFy/XX9ZedJVhIvvNEw1mPlTQRDFKHm9/v/Q2+f6Oj7qTsBHt1VEuZyq7S+PkStAG+iO+h0TZnXwWwxDsIzNmb/J640fq6LeV2pNxsKDHRSCcYloPsPLusBuKCs4bjn0LDaLjEYU8zEk3A0tywkz8FmLqkLzNwd6FYb+Juf9LR3R0Nl8XQbduj3Kl4hw/tupP6pgAYYVp2kKvkk/7nvbaRrYWGlEJ/X/BnOV4RrNlsiKLWlMaUSV18WnrLeFq8KFOSZgYi7hJNwRr825+geyar795KpzwrIMHqFFY6MIVPytRiv8HvoTt9sxCA== +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"; + + + + + + + + + + +Create a new RLS rule + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-report-schedule.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-report-schedule.RequestSchema.json new file mode 100644 index 00000000000..177dc37fdca --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-report-schedule.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"active":{"type":"boolean"},"chart":{"nullable":true,"type":"integer"},"context_markdown":{"description":"Markdown description","nullable":true,"type":"string"},"creation_method":{"description":"Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.","enum":["charts","dashboards","alerts_reports"]},"crontab":{"description":"A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.","example":"*/5 * * * *","maxLength":1000,"minLength":1,"type":"string"},"custom_width":{"description":"Custom width of the screenshot in pixels","example":1000,"nullable":true,"type":"integer"},"dashboard":{"nullable":true,"type":"integer"},"database":{"type":"integer"},"description":{"description":"Use a nice description to give context to this Alert/Report","example":"Daily sales dashboard to marketing","nullable":true,"type":"string"},"email_subject":{"description":"The report schedule subject line","example":"[Report] Report name: Dashboard or chart name","nullable":true,"type":"string"},"extra":{"type":"object"},"force_screenshot":{"type":"boolean"},"grace_period":{"description":"Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)","example":14400,"minimum":1,"type":"integer"},"log_retention":{"description":"How long to keep the logs around for this report (in days)","example":90,"minimum":1,"type":"integer"},"name":{"description":"The report schedule name.","example":"Daily dashboard email","maxLength":150,"minLength":1,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.","type":"integer"},"type":"array"},"recipients":{"items":{"properties":{"recipient_config_json":{"properties":{"bccTarget":{"type":"string"},"ccTarget":{"type":"string"},"target":{"type":"string"}},"type":"object","title":"ReportRecipientConfigJSON"},"type":{"description":"The recipient type, check spec for valid options","enum":["Email","Slack","SlackV2"],"type":"string"}},"required":["type"],"type":"object","title":"ReportRecipient"},"type":"array"},"report_format":{"enum":["PDF","PNG","CSV","TEXT"],"type":"string"},"selected_tabs":{"items":{"type":"integer"},"nullable":true,"type":"array"},"sql":{"description":"A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.","example":"SELECT value FROM time_series_table","type":"string"},"timezone":{"description":"A timezone string that represents the location of the timezone.","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"type":"string"},"type":{"description":"The report schedule type","enum":["Alert","Report"],"type":"string"},"validator_config_json":{"properties":{"op":{"description":"The operation to compare with a threshold to apply to the SQL output\n","enum":["<","<=",">",">=","==","!="],"type":"string"},"threshold":{"type":"number"}},"type":"object","title":"ValidatorConfigJSON"},"validator_type":{"description":"Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\n- Not Null - When the return value is Not NULL, Empty, or 0\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`
Supports the comparison operators <, <=, >, >=, ==, and !=","enum":["not null","operator"],"type":"string"},"working_timeout":{"description":"If an alert is staled at a working state, how long until it's state is reset to error","example":3600,"minimum":1,"type":"integer"}},"required":["crontab","name","type"],"type":"object","title":"ReportScheduleRestApi.post"},"example":{"active":true,"chart":1,"context_markdown":"string","creation_method":{},"crontab":"*/5 * * * *","custom_width":1000,"dashboard":1,"database":1,"description":"Daily sales dashboard to marketing","email_subject":"[Report] Report name: Dashboard or chart name","extra":{},"force_screenshot":true,"grace_period":14400,"log_retention":90,"name":"Daily dashboard email","owners":[1],"recipients":[{}],"report_format":"PDF","selected_tabs":[1],"sql":"SELECT value FROM time_series_table","timezone":"Africa/Abidjan","type":"Alert","validator_config_json":{"op":"<","threshold":1},"validator_type":"not null","working_timeout":3600}}},"description":"Report Schedule schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-report-schedule.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-report-schedule.StatusCodes.json new file mode 100644 index 00000000000..7a011e56bac --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-report-schedule.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"active":{"type":"boolean"},"chart":{"nullable":true,"type":"integer"},"context_markdown":{"description":"Markdown description","nullable":true,"type":"string"},"creation_method":{"description":"Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.","enum":["charts","dashboards","alerts_reports"]},"crontab":{"description":"A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.","example":"*/5 * * * *","maxLength":1000,"minLength":1,"type":"string"},"custom_width":{"description":"Custom width of the screenshot in pixels","example":1000,"nullable":true,"type":"integer"},"dashboard":{"nullable":true,"type":"integer"},"database":{"type":"integer"},"description":{"description":"Use a nice description to give context to this Alert/Report","example":"Daily sales dashboard to marketing","nullable":true,"type":"string"},"email_subject":{"description":"The report schedule subject line","example":"[Report] Report name: Dashboard or chart name","nullable":true,"type":"string"},"extra":{"type":"object"},"force_screenshot":{"type":"boolean"},"grace_period":{"description":"Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)","example":14400,"minimum":1,"type":"integer"},"log_retention":{"description":"How long to keep the logs around for this report (in days)","example":90,"minimum":1,"type":"integer"},"name":{"description":"The report schedule name.","example":"Daily dashboard email","maxLength":150,"minLength":1,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.","type":"integer"},"type":"array"},"recipients":{"items":{"properties":{"recipient_config_json":{"properties":{"bccTarget":{"type":"string"},"ccTarget":{"type":"string"},"target":{"type":"string"}},"type":"object","title":"ReportRecipientConfigJSON"},"type":{"description":"The recipient type, check spec for valid options","enum":["Email","Slack","SlackV2"],"type":"string"}},"required":["type"],"type":"object","title":"ReportRecipient"},"type":"array"},"report_format":{"enum":["PDF","PNG","CSV","TEXT"],"type":"string"},"selected_tabs":{"items":{"type":"integer"},"nullable":true,"type":"array"},"sql":{"description":"A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.","example":"SELECT value FROM time_series_table","type":"string"},"timezone":{"description":"A timezone string that represents the location of the timezone.","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"type":"string"},"type":{"description":"The report schedule type","enum":["Alert","Report"],"type":"string"},"validator_config_json":{"properties":{"op":{"description":"The operation to compare with a threshold to apply to the SQL output\n","enum":["<","<=",">",">=","==","!="],"type":"string"},"threshold":{"type":"number"}},"type":"object","title":"ValidatorConfigJSON"},"validator_type":{"description":"Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\n- Not Null - When the return value is Not NULL, Empty, or 0\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`
Supports the comparison operators <, <=, >, >=, ==, and !=","enum":["not null","operator"],"type":"string"},"working_timeout":{"description":"If an alert is staled at a working state, how long until it's state is reset to error","example":3600,"minimum":1,"type":"integer"}},"required":["crontab","name","type"],"type":"object","title":"ReportScheduleRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"active":true,"chart":1,"context_markdown":"string","creation_method":{},"crontab":"*/5 * * * *","custom_width":1000,"dashboard":1,"database":1,"description":"Daily sales dashboard to marketing","email_subject":"[Report] Report name: Dashboard or chart name","extra":{},"force_screenshot":true,"grace_period":14400,"log_retention":90,"name":"Daily dashboard email","owners":[],"recipients":[],"report_format":"PDF","selected_tabs":[],"sql":"SELECT value FROM time_series_table","timezone":"Africa/Abidjan","type":"Alert","validator_type":"not null","working_timeout":3600}}}},"description":"Report schedule 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-report-schedule.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-report-schedule.api.mdx new file mode 100644 index 00000000000..7694a8b0684 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-report-schedule.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-a-report-schedule +title: "Create a report schedule" +description: "Create a report schedule" +sidebar_label: "Create a report schedule" +hide_title: true +hide_table_of_contents: true +api: eJztXQtzI7eR/ivI1FXFTqiV1rETR/G6SqK0klailhYp7dnW1rg5A85AxACzeFBLqfTfrxqYB0Bx7U1yd76qY6Winf7QwDQajUYDg6YfE0U/WKrNocxXyf5jkklhqDD4CHXNWQaGSbF7p6VATGclrQCfaiVrqgyj2vFmhi0pPplVTZP9ZCYlpyCSp0GSlaBcg8JyDjNOk32jLB20rEwYWlDlWPHtH01agVrk8t69Mqc6U6xGMZL9ZNSUkBAefKppbRQThWtZUdeTtKKmlPnzhocNA/EMhGliNc2JkYSJuVQVMSUlc+X0k5P7kpqSKgcqWktldoFTZcg9aOJeRnPChCvPQZczCSofEKeLAZGKOG5NQORNfU2uz14kg4QKWyX7P3u16WSQdNWR8NXSpkry3nVNCgOz5106IMOrt5eEfqwV1ZpJ8eLnoeclJ1bZ91+UxtR6f3e3aeFFYZXd/RK7DqSkvJ5bThTV0qqMElOCIRkIV0JW0pJMwdwQePYW7MRHqGocjuRPu9+QP/n/JYOkgo8XVBSmTPZf7u3tDZKKiQ7YNGxWG1ml9yxHjmdj5kqJKyVy7pStM0Wp0KU0qP6afaRchwL51/62KXZa/zzLzcHADHQ4BcLSUOz1XlxrSoAIltHQqNHwCrakpJkTSJuSaXKAFrB75Qwg0vQRML4iGjjVvclhNZxN1KBGP2Oi0AoYT7Wd3dHMPBd22tk7QV+QW05Jw0w4EzSS6Gcv5XtC/AMRUNF9ctQJJ5WfEa7gs6T7aBQEOpZezKdBMpcqo2k/+pt9UaEgo2lNFdvkA96KjBIQfm7iNDCKFQVVNB+QUt4TLkUxQLPSNJMi1wMyo3OpKJnYmipNsR+FdnMDCmDiBfmiZ/4yssKvv26sn1U43V9usikui1RRdMcb7ea0kQiHeEFp7cyfy0ITUNKKnMyl8ibTDBgKk8MqluTvvymGG5vPMgTkfLHBJntrdNa15ge++W03IO8FVW6hYYZWesPIIQMBRdFpK01YrglwLu+9B88pp4Y25iYKGqrlBTmbE07nhtCqNis3eveMczKjRAra+hUvQks1VZNN+moQUApWSCuasZpRYeIOxAtox5RmUsxZkbYrbsw2y7IpqIKG5h14y18rNJ8q6kVuZtMgMcy44fPT9qqVbehEezN5e9n3c7NdNBUI8uCqR7MF0TXNnE0ugbOcSFdDByvecWMcEw7Zov335qvk/TOLcFr9YJmiOVZ0pe8/uxubBwlZUlzowSmpFWp89DoZJOPLk2SQDCc3ySCZHv/ndINMg0RTTjND89TALB7rDZNqs6fr5NEf+KYFffLDBdEGDK2cdnFJzumcCaqjiMQ7MF1Ky3NSUNM7MpwDQpoXBMfpg6VqhX6Ofqyd5DhXFDVWCUKZa+3y+uLChStE2GpG3eDZtUk+Ob44Hk59CXl99XZEDKtoqqliVKMyOE02qAuZHqTYYEMHpC0jnt33VFEMMXAiNa7OB6ftnGzrhEHUwVyxDHYPZiy/AwwUWyDLFARknjOdHsxgFoK8YOh1ekBXENXSFQ3pQ6hgIUNaFJZF9J3lAc20BhvQHIRZKRogCh4eYMk4D0F7Z6uZDd88BKZkSGqYcRBZyEKtCUkpYKFWPXAEC1AhqVKq0wlwgCqA79hMWhN06kha4EHDxzw9AGYDXb9WlBoM5jvkBGZSSRH06RQUhB1/I0sQguqZVUWA2nB8zqGqo1efYyghbSDuOSuAs5AWugQd1LmAQgZDfMFmiq7p+0JWIWVB5GEDdmarGeiShZiGRcAzAg4zGdK1NRGtqQoMYYSGGKpnJAvImS5DHimUXLLgLZdoBLNAjMv8DioqQhYGFQ0G/VJaWGSlNKbH3looIJe2kMHbxlIZuXMpl4HUE5DpNNLNlFUzuzBBvalitQxHYGoFC/T9jom8lBS9/UFFm7kIESmyUiooaIQVlnE/9B1kWGEjREFhgYkYKzCaEjiJqJA6PWCK6o0MQzBQgco2Vx/KSuZXbAk5NGOwgUXlcra57I29s6uNJReQXjF5t7naiIpcPmwuu2IyPQHOaWPPzxgmwM3mqhMQ6Rvr3ePGwgvLNrc5tZmtPlHxWpcW1nRjY31oKzK/f+8gwxZyEbdoFmGlQyjZMzo9BJFTBToqUDPII2UcUk6rmGYPoWGhB852JjDjkVSHEtIbpiP1HcpCrgFMR21ttrAhVDPF8oKmh7CK8VqmJwo7EsEisyICFGQQt/jcUoewokLEDa3ikRqWLINCxkhpoYxm0ZDZHHI0D0UfQlwq4OkpqJm0KsbXrH4otUGjjuVTVJtIx0PLIK5nsaOhfEcgcCurS1iKCL7X8jmQDhWNHMsRFUuqIsAoyUyISNwKRZIe55UUsajHTFlB61C7xxyXyiXkMnzBsdBUQB429xqjzEvKY4kd+g5W0YghCJxG8/2E4/41tpwTmZsSZhEi9TMutKx0atUiAtflO7GQUy5t1LsTixEn8DXGFXywLmDvsRVE/vYUOJvDxwhZrrFQVUnNOA9H+kzkDET3Ly4hekPxuZAfN8AjUFQUm9obU0NVF1SsFU4p5+mQmdWGshu6hI04ExlOtE3SvWMCKsielzzvjl2ycFjOPgC3kWG+gQpiu1xfQt5YQX0w2QDnVBibLVa7F9Iy3cU066UjKQzLaKx/VGx6dhkiCjgVObsL5byAdAyhV7hgVSjjBfo/UVAe6WejPBfynqp0rFCfIfMIMspkBAiIF3pEbFxHsUKaGDFMsA+WRqCBSioZV30AwyM/+XzRHVGBfoJGjVHF8pjJcFhgYxH4kWVy3chGKFi84oykyMw6YqhSdLWOLVlO5RqoKPA1SFOlINTJJbS7jxag9+mPMvIPl6xmRSTGZRPwdaSSooQYMWV6BAtpcIG1HMpPlQ4pdulTpSjOBOIF+9LaULy3d0xAEb59DDjnYqAQTBkrighVuGSyWai4cSmpYKFDwah3B+yON8u1glTO00kNTKzhMj3I1DqzTG8oL6O3WYrwFctiVBhID9Ath2Z5BUys0isWr19XIBZMpGeC03Bg8ZxjTiOgiMPgK6oltybiYTI9VCAiaa6kBhXNvgmgfGcaZpSvwyoaKoRYHF8gJFO3xq7hMh2DjTzQJJOK6tlKW5GHcMlqJbPQCCYsDhAnJj0EZUqM9VYx/kaWQsfQOTNmDbqwGVtrcFrKCtbYvOsPFT+5Z3OTDq1SMT6lhc1wJ1qHzU5LG3nAaWkxhl1btqfszsYL5hSnnJExYmTkZ25wIG1sLTdMFZGxviuZoaVUUdT6jgnBahpOlh9hYU3kOn7E5eJ+IRozw7HPDPMHD95B9dARLP1iF0AWQ6qja9UtAn3ZCLIPFhR7BrcxXoBlI6tyGYNj4JXvdo9dSTzKghicSGvKdCzXBZis5P0a61RJzmPoRmojnRU6YPdCimJFQc1W1EmpGW5kg2degff5jqqaUNwRAvKV6qgPxjvlhpAz2lG6LGDmB6KhFyXMIO8As1J95UMoyrwvPIRSNc7Kk4uAUxQL3xtPKgH+nMqRlCnbvfSQ6XJBe16MhFlLDYFn1vhdkaNLFhKSzYDrvufDUorig/8u1QBWFIsQkFxW3kkjeQRZBj1Rgc78wu/osjlzcQTjnVRHdgYBoUsQvVJfQwWF1b2YJ/DQPeP2plfZKZ0p2VMyHZYsHTFR9pAo0nPZi38ql53+z9TCGt0p7kwbELNey2/w+K2X4g2soG6O+BxNldXtYojAOQSVz6HKSjB9989xk1iynkTTUT1pygpEbgMgpksQ+arom5N8Ab1w5wq0kCtQfXfO8RAwvbBVbfvX2KwMxvLc3gPr7GjU7u1awvZEAXlvJCNYYKCielow3okysjrrZ8Qly6RmXSEeVy3sg6CB3hHTbMYC2d9WwbOCTqvjUsgqHdN+gMcYK4OAjn28wnkPfSd/ANOL+gPufAV00/6H1cOKS5V3Al6BKGRvUldsBXn3sgm0oZenFiVwFtC4FQbR2deEyt4gJviVq+ytfsJEAbVUndlPFM0FXUi+Cjo/BVb3k3kKONNFp9zpjHGm+2Jaqn6UppSnB0u27OgSjwJDqi57Ui5WsicCCa7vrCjSMZ6w9jq95gBiBqFmrzmI9BCM7BFlqw+dcNfa7FzSfvrc4Gcf1hypOoBDzpadE0fILXM6IEWg/h/pAgxVTLR7Rw8quvQ6wD0DrgMHD7I57mmRQ6oq64e8hYYgwB+990hN0xuq/NFPi74GquQasga8AZGOoFl0WnAEOWUqeuUVXS3uoNlltqBfAk+oVAWLuCcmPaW8OTnuQRDcr+5WGwUcV5zhNKZzyoH5XnTgoWK6Pc4OQLmgIj1lfmXt8CE6Z+WF70Grmoigg45A3fvZ0EHHNuNxvVM5A3dJoocuTs9imomcNqtxD0qVp6fyPn7liHI87FrryOXkXUzjHiZCxnQd+cHiJQXezN4OduMRI6tcrKl8CroCweKO3rDMSLUGvqM67vuPGBXeM+HGFT8tMb7b7FUa6oj2G7oGOgbXSkM1bQ6Pp+5z6PSvwyP3BHiMtNvaSo/gFs+71AbA5qgSPTCSuOVhAXJJ7+d4f6HRT4OOIWPzsOkJ6AWYrKT3EFT+0S7crB2WjFP8ymWYoMJ4ERzmJThr1T/0Z9LHrkfHk+bvN8euX8fFqsb+HjOnpWOT7Z6Mpv3Tn/eC55fhc1QQlXwVEOHzX4Lnr4Pnb4LnvwbPfwuevw2e/94/7wRS7LwMn6OCqOSrkPhLSARC7YRcIVPIEwi+Ewi+Ewi+Ewi+EwjeiYe3ee5ZVjb09bBV/vV02D4J3BZrN8JI/2Q5rjTHFi9O7B5UONq5+4bZQiKX3sO0AE6QRenMqIVMSd1WsaEPKZ/7idADhQLn6TpE+fW5pRUYpjksIcSs1v5CWotYvABFo6ZtDvUaopkoaND4sGSaCQg6OpQ1FSVEXEd2Fol0wmYKvwKpALJUCb9pa5BTyjUTC9YjZ5pTPO0YhRoKAtgGeYNXoIKGzjFeYQLVFICMLkNKyZBcsYC6YHomgzde3NkZv/Ob4RaSIo9Y7EdaoZMuemwEuWJ5SPvvYB2pGC2hCloZMeHigJaUAtyxSEfrTN73dB91NsBbzQP2MSgWDPhY5oVU/iy3hfBLZWBJV6wISq/8iVtDubgPQhoDAMWEDDEFd3S5hphQ0xNWzamStQzGb7KQ9V34KjkPezUxMluUkgczaQqcMxFobsqUX+gDWkcvueYrEHIZ6vf6oSykksEQ3UBuH0IS99zBazCcC83ghnHBbKDkG8kLGRveO1AaglH7CQpFZyFdSyUfylUg/k9Wed9zcuj+7DTrgF8DWv/fOtrGb4U+69StJ7gvXPht4VlGm3XHfwvA79YgMB5kbrwadFg21xI6WjFt/BFUC8ks4pB4lN3T51QVFmO4HhpBSUOK52xJdYhYxYzXYwetpDFBrStqhf9ie+aj/zOtwB0F9l8o3kDtis7v4Q44dQ7ogs1WWDZyy+xo0vz928gts/5YfPcQ7gDDJxpDE7elbIATKqgPKC5/cn92hqcH2MYlLOEOFTC+wpVhPJl+O3aNN4HD7kHtrLkjbbZohqKFDqXFW5vtqVQLD0swpVtAesSfQ7e0DylCYA4mbOIYT/Zm1gX9LfYaFiDnMkTYHQtJK2Du79q00AlwqBvT6LFqxqK34zc84BkIp6cADftwKoXkfqlsIXc86r86tNA5iDWAoY1UEIl1LtEKQiAY+hYbwZ1VMgIUph5A2JkRy+8h1NIlWBXKeMls+KJLqeaSLyLEVjQc6DEUeLxcyAjjELY6ZiYDpkJxx7IUfjfcIwJqGgHKpCN/Th3AV6CkkaIIhZgA85OiByoZMkyhZJFOp6DgPuLAJg3UodxTFdnhO1jQiOT+Q2ML/Ag1UrK1e6mMLZyRXL0dur/neO0yOCzA78VuTfeR1/Vk94Bj3N0+U4vb6oZS7EGKpqgP/K8nbn7sNB8/e8RvA64nu6dwD4z554ZrZ2Lw0rrHRiwrWdG+JtgwXE+CbcH1pFOqDw7DwPDdzuQa/3Hux0WImy5w/tqN1vims+MMrhnifUtUoL+Vv6ltd+kVTyx+/YKvrDcLgDzQ5gVksqrxrvM9MyUBYkpFdSm5u76JWTsrnyxA3XVRaU1tza0IxP0uGSTfvUoGyff4f3x4hX/+8GqzVtrmg5us/jLor94dvmk7HN8a7vWwWdtH+Im+am+0uu42l1ebW62YZZETOZ83F07nSlZNkbvP+sJnSOjuEnd/99Xpy5RUU9KJ4YZS79+KHXIpDbm0nJMd8s692g28uw3rX8W057m+uBiQY7wt7lJ59rDyWzdAUrWVf9EfeOprp762HzWGV1Nky9zp9hdsfKosJfRF8YL88s0e+e4V+ds3v3w3U99PbO0zhFCivhnSNqPJdwPy3asB+X5Avn81IK9eDVxi0R9eBYMupCF46zgZJG29jcN9LxUewad4nVbaDSkgZ/MoR0LjJZWcAGYCNXX9FeU+Z4JYYRgnzPxR+yLibt9jwoSRhCrlzvG6C8V/+etv5Uas3f9uM6CaXIXBZ14InzSz+Ypqc1CzF7XUxieZNIL0eW3+knaTyfZyU6Jaq8FNqWZhktZaQlSc4OSTk4LUo5dhZtHLwfpc+ZyMn7WEnn8+KafNudmYZOMVE6fVNMkta+krmGjiU0k+mRXSpnn8/PJ9nDbx8+PT+2d39Jur+Wu37l1dd3v+c++ld9fQn98Wb+ynde+f9OHotZ1XDXzlyw3OLpyEz+YZmv3T03q2WGOrZNJlW/kUzHAG4CC4KaFrKbRfSL7ae/lv5HOyTc7evcFys03/3KZ/btM/t+mf2/TPbfrnNv1zm/65Tf/cpn9u0z+36Z9sm/7ZYNv0z2365zb9c5v+uU3/3KZ/btM/I2Sb/rlN/9ymf27TP7fpn9v0zxbfpn9u0z+36Z/b9M9t+uc2/XOb/rlN/9ymf27TP7fpn9v0z2365zb9c5v+uU3/3KZ/btM/t+mf2/TPbfrnNv1zm/65Tf/cpn9u0z+36Z/b9M//ifTPZyYdJ4Qyn5TZJ8JtM0R/lwzR9QTRz04P/d/IDv38ZM9PZXt2Kw3kOc3RBr/e2/s38jkrqjVeov2M9I/Y3ruKySFgqqL7j4XukzPhszhqvEnhblWRGu8jO2Gf9yqo6/vy7+Sm/jf05VqANaVU7IHm++TA4nGPad5POteyoSNhRd+Tr3/fnuCC5I5L94kPVJySad4nbuaSasz5IPQjcw7uWae6NlyPvvrq9x4bvOKB5IxTguNiVvukCSdwfPyCsaEfQ5fvgl1tWmhq46u++b2nzxledhLAiaZqSZXvxT45EMSKLv/GgURmGV4i2WiAr8EA71SA7i3DbfsKc+STu3uDHg5z5Q0U6O3Ws8c1LosfdzKZ04kT0iXXJxy/t+0n2fXVRTJIuLve05HejpC2ipOd/yTjt5MpuU0wfXh/dxfzcHgptdn/du/bb3ehZrvLl7tNUvRtQm5vbwUhO6fkNjlo5o5T+j45pKCoIv9xMBweTybp9O358WVcYeiHa2e6quk+WR+xnjcnf3y8TRZ0dZvsk9vE+fTb5OmPydOg69x4ZUq3l2271wFdB1nllNVMIn0rbkWbU09edbALFL7A95LP1sLAs5cUcqr0q8c1XXixG33cJuTPBDI04NTgZ7Knpjb2+dWmft6KL29FrZgwX7TyvkDmL778MtTAG1jCxNlSoIUI7IdaCo2K6DqPezRD5tRkpev6P9XxRy+/j3ZQcLSgdaXst2xk3VKws7+0xvLoNTN1ivll0FcJbcWr57m9eO5WnzOZr/YJ7kxe+OnM5qsvHsmCrgLlkqcvkRt1/I9b4fWCAVenkzWNN0yS0xdcFl8g65f/SHBKbvjBAcz8XttbYnZsExUmLiIdJDVg5Jes6dbFNuhK/BS2Ckdz46Ak6+++wGKS0yXlsnaphL4lZyy+occaTzEyyZ/2d3cfsamn/Ud879Oz1po0/KYJjIMUQ9/dprm6Zvw+Yg4uanZiBnuThnS/R5A809TpdDomXTtPgwSlidvr+vtMuIn3tliGoSWGrmdjbMTt1KNGNqqqqe+4n55wGFuPiy618p10fvcxmTkTfd3Gn2/e4WmDW1JcGror7cNG1+mnAVZOFZ3jRvBfbQRb0VJc9f8p9+Pf+Ambvd/aoPxLe5G9cC+y9/9mL7L37NdqPp3PHWRwB+regJk1pA80fJ705/8gzt7/kR/E2fuXfhBnkODvrzw/hmh/cyHY1gcQukXPt3zpZzt+P3GiNaP6K/537ec6GklxsuzWHI8enwbeSz42rvnnBGo8wFy+TNpBSQYJejLvqn5OHh9xUlwr/vSEsDup8pvR1lu6wG2Q+MXQ2RCevO5Hy5rXuHWZ4uvRK7puX+Mgy2htfpX3fbDI4FqcDBJcDF3EKnOso9zHMvy7n7gjI5+tjz9VgJiPKawPbX2b6IVwcxT+8kbrrZoH7FWb6S5WgYSPj57Dr+q4xPiuuPAneXr/9PT0X6fuS/A= +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"; + + + + + + + + + + +Create a report schedule + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-saved-query.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-saved-query.RequestSchema.json new file mode 100644 index 00000000000..3e44fcebf7a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-saved-query.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra_json":{"nullable":true,"type":"string"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"template_parameters":{"nullable":true,"type":"string"}},"type":"object","title":"SavedQueryRestApi.post"},"example":{"catalog":"string","db_id":1,"description":"string","extra_json":"string","label":"string","schema":"string","sql":"string","template_parameters":"string"}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-saved-query.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-saved-query.StatusCodes.json new file mode 100644 index 00000000000..232115ffc88 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-saved-query.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra_json":{"nullable":true,"type":"string"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"template_parameters":{"nullable":true,"type":"string"}},"type":"object","title":"SavedQueryRestApi.post"}},"type":"object"},"example":{"id":"string","result":{"catalog":"string","db_id":1,"description":"string","extra_json":"string","label":"string","schema":"string","sql":"string","template_parameters":"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-saved-query.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-saved-query.api.mdx new file mode 100644 index 00000000000..60980cd59f3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-saved-query.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-a-saved-query +title: "Create a saved query" +description: "Create a saved query" +sidebar_label: "Create a saved query" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/ivEYUATTImTYB0CFf2QBi2ari9Z7W4DosClpYuthiIZknLiCfrvw5GyJL9kTdsBHYZ9iny6O93z3HMnKhUYvCnRumcqW0BcQaqkQ+nokmst8pS7XMnBJ6sk2Ww6w4LTlTZKo3E5Wh/GHRdqSpcFv3uNcupmEB89/jkCWQrBJwIhdqbECNxCI8RgncnlFOoIssk4zyjyHs9cOpyi8a5oU5NrKulvArrUeOcMHy+L/6y74BMUX4Wh46UXenh0/JDQG/Gg4hwWWnCHY80NL9ChsQ+Iq1uLmnzC1EEELnfkDkM+x+zXEs3iPVp3ovN9rawLtPFCk0+vscuMbb8O19rROfRZ76wNuZ1hyVnPcrPisBVxh2xdD/BGZShYkzbyys4NZoGZmgxWK2mDYo8ODr9B70GwGz0yaEvh/h+P//J4bISsDgz1qpNwJ4h/8yBtTNKZw4Ll0qJxmBHAnw4OvmFaCrSWT3HLyHyGzDYQnvGMNa+qmJ3JORd5xjo4TBs1zzMqdhNNLzZg+ZbJ/wewfJC8dDNl8j8xi9lJ6WYoXfN81m6tLUD6gR7J0dH3RqKNSunnRCAjFG4Rs9+oOQENGqPMNiinqhQZk8qxJkMTTY96/L3FdiYdGskFs2jmaAKKmJ1IVkq805g6zIKRqTQtzT3tekEj31IQgcW0NIQxvqjg062D+OKyvozA8amF+AJo2RCIywju9lKV4dDXZr2/4JKWR/rh/eveDmh+WlWalCpPSyPY3h/s/N1wxBKYOafjwUColIuZsi4+Pjg+HnCdD+aHA0sLbnxDG26QAEuSRDK295IlcNKozBMes2fIDRr2w8np6fPhcDx698vzt6sBp6FVe6OFxpitd6vzzdijKoFrXCQQswTmXJSYQP0I6qhFeL5wMyV7GFtDizIvtDJuOdM2kYlcvtvZ09bs9/UOPZd9GRVRiJkhz9DYp9UaIaH2hpQE2I+Mp6TgsVPXKOsmmoA/3QY2kbuJ1CaXbmdZ9D457+zu9ml4xed86MXUo2LF2DVdSUtstAzwW547doUunXn8X46+CiAKdDOVUfUkqHVm4qUbW9cMIf64lE0V6Bl5dj5GXUhfNYGjTeUE7yWpE5UtYvZq+O7tfhjq/GqxU7FrXPQYZvUueRPRTxIZyMm44y0xa7Q3TkrgvlDTHXLdfQI0mGsryyB3yDjzfDHPF0QQOIIY/PEgAs3pcAPbyKWm+Y0SRro01NOtrYH1h7+m2yzDOQqlC5Su2U1eMiFRpY1yKlWijgeDilLVcUWDUm9kOy2tU8UyRQRzbnJa4bZZpz4NXWd4xf0BxpdJRxJZFrSrmp/0xy+s1fwvR6Nz1uapI6BqVvO1eDeKG4alS/ckL5Apw87OKQlhWU2ylaom3nvXNfVxuXiH9MoIIP36rWDiNfpCmYJTvle/j5bnKRqscBfa14YHXUcUPDZ4ZdDOvjYJZbFKvu++vp8/5KPr4DufFSPI5ZUKTVjhvNRoLK6cnzsTKT74zQ9DI60rePjo4J6ke2Zr7YOmYdDhnRtowXNJybz4q2bsLoDrnJ54SMi60YMISKVBhhdQVRNu8YMRdU3m4BJfXHaT4N/NEYRN56f1Ghf+3NLtLD84oqSSNg4oNJYh4iRN0e/r+30ve1uEFi1EMGn+H1OojGIMv6WvCX4LMUAEylPihext4a1RhtNLyEkKo9Nij7dWic0FoWpucbnoVVhVwSOsbFofAYp/wUF9Wdf1X5RoRcg= +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"; + + + + + + + + + + +Create a saved query + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-tag.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-tag.RequestSchema.json new file mode 100644 index 00000000000..fb3ba1b81e9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-tag.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"description":{"nullable":true,"type":"string"},"name":{"minLength":1,"type":"string"},"objects_to_tag":{"description":"Objects to tag","items":{},"type":"array"}},"type":"object","title":"TagRestApi.post"},"example":{"description":"string","name":"string","objects_to_tag":[]}}},"description":"Tag schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-tag.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-tag.StatusCodes.json new file mode 100644 index 00000000000..76da10551a7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-tag.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"description":{"nullable":true,"type":"string"},"name":{"minLength":1,"type":"string"},"objects_to_tag":{"description":"Objects to tag","items":{},"type":"array"}},"type":"object","title":"TagRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"description":"string","name":"string","objects_to_tag":[]}}}},"description":"Tag 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-tag.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-tag.api.mdx new file mode 100644 index 00000000000..acaeb411ced --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-tag.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-a-tag +title: "Create a tag" +description: "Create a new Tag" +sidebar_label: "Create a tag" +hide_title: true +hide_table_of_contents: true +api: eJzdV21r3EYQ/ivLUIhNZZ8dWggK+eCYhCQNscld2oJlnD1pfKd4tbvZHZ19FfrvZXZ1Ot1LaKgLgX6xT6t5e5552VEDBfrclZZKoyGFc4eSUEih8V5M5AwScPi1Rk8vTbGEtIHcaEJN/FNaq8pcsuroi2f9Bnw+x0ryL+uMRUclen7acNOArpWSU4WQkqsxAVpahBQ8uVLPoE1AywpZsCr1e9QzmkN6ukfMTL9gTv6GzA3J2Y4juIjvBRlBAU1JWHFAbW9MOieX0K4Pok1IgEriCGEiZx/R05ktj63xxH7xQVZW4a7DLrQVgPXzdqRX1y373NSeyJnoGIzElw6LyFHLB94a7SOhT09OH5GOsuC/HWBdV1N0ED3Uiv7n2duR3cwnU3M6pOIxCd6bYVkUWLDXX05OHpHDCr2XMxwkcsXsPyDsFeGlLETX36l4qxdSlYWw0skKCZ0X1plFGYLdRTLQjVgeU4//AZZPWtY0N678C4tUnNU0R02df9H30h4gQ8WA5OnTH43EOpPz41ShYBS0TMXvnJyIBp0zbh+Uc1OrQmhDorPQabOrX390sb3VhE5LJTy6BbqIIhVnWtQaHyzmhEU8FCbPa/eNdL2WJFVPQQIe89oxxvSqgS/3FDrvOgGSMw/pFXech+sEHo5yU+A4BOaDsJJ6Binknz6+hwSUnKJaP3pTu5zDzmunxNGf4vJiPBEZzIlsOhopk0s1N57SZyfPno2kLUeL0xHJ2SgDkWWZFuLojcjgrCutwHIqXqJ06MRPZ+fnr8bjm8nFb68+bCqcx/wcTZYWU7GdorVsIZ40GdzhMoNUZLCQqsYM2ifQJj2yyyXNjR5g6w96dGVljaNVI/tMZ3p1zYgX/XGYnAfsV3wfBUmUnaMs0PkXzRYRMeaOjAzEz0LmXK43ZO5Qt502A36xD2SmDzNtXanpYBXsMQsfHB4O4b+TCzkOlTOgYONwnWSjPbPQI5f3siRxi5TPA+7vR93E4CukuSk4ai6cbUbSlZjYrhFG+nlVJk2kZRJY+ZysVYZVErnZrZQovSJzaoplKt6NLz4cx84tb5cHjbjD5YBZ0R6yNBP8PNORlEKS7AnZorsTMgqPlZkdsOjhc+Dui/AhhXDnJmAlLwEw5Iv5D5MgdmPtOD17WYbtGfCeX4sCF6iMrVBTN1NC9qOhxjpDJjeqTUejhk21acO13u5YO689mWplIoGFdCWPXt+NwWAmbgK3MiwFIUxIAHVd8YzpHvlfmDWb9t9MJpeit9MmwNFs2uvx7gQ3jsOS3/HGIYwTby/ZCGPZNLKXqk4/SLctp2Y1MMc86iPIMDYbmIaye21cJdneuz8mnKMgBmn3FvpxH0C3CSvfOLx16Of/1ghb8UZ/XH9qvHr8gs1b6nWbQKlvza6dcW3ReRxuioMjrsootziNZHuqZFx+o9/+Syluplsbcn/L7vui6qATPtDIKllq9hCqtun65AqkLTmMUwgXGSTAZRXr5gqaZio9fnKqbfn4a42Or7/rdemGSzCBOG1Ce93hMiwI67kRKl3VYYve3gS4j6LGWZ5jmJXflh22Ow87SGDafS1WpmAdJ+/5g0beQwqcqsBTqLxwFid2HdeEaJNLgteywcLRl073g1GtvgL0chBh00SJODa53yOUcLlAy3v53yyEIZQ= +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"; + + + + + + + + + + +Create a new Tag + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.ParamsDetails.json new file mode 100644 index 00000000000..a21f8dd40a1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.RequestSchema.json new file mode 100644 index 00000000000..cb2e4093eef --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"required":["end_dttm","short_descr","start_dttm"],"type":"object","title":"AnnotationRestApi.post"},"example":{"end_dttm":"2024-01-15T10:30:00Z","json_metadata":"string","long_descr":"string","short_descr":"string","start_dttm":"2024-01-15T10:30:00Z"}}},"description":"Annotation schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.StatusCodes.json new file mode 100644 index 00000000000..ff4829f957d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"required":["end_dttm","short_descr","start_dttm"],"type":"object","title":"AnnotationRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"end_dttm":"2024-01-15T10:30:00Z","json_metadata":"string","long_descr":"string","short_descr":"string","start_dttm":"2024-01-15T10:30:00Z"}}}},"description":"Annotation 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.api.mdx new file mode 100644 index 00000000000..d3a675d64f6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer-pk-annotation.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-an-annotation-layer-annotation-layer-pk-annotation +title: "Create an annotation layer (annotation-layer-pk-annotation)" +description: "Create an annotation layer (annotation-layer-pk-annotation)" +sidebar_label: "Create an annotation layer (annotation-layer-pk-annotation)" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/ivEYUAdTI7tLEEzFf3gBi3aLmiD2MWGRYFLS2dLjUSqJOXEE/TfhyNlWX5J0DYdug/9ZOt4PN49vOd4ZAk5VzxDg0qDf1VChDpUSW4SKcCHcYyMCyENJwFL+RIVy2/YTCpm4kS3BsGDhKbk3MTggeAZ0tcNeKDwc5EojMA3qkAPdBhjxsEvwSxz0kqEwTkqqKprp43avJDRklRCKQwKQ395nqdJaFfrfdLkYNmylSuZozIJavpCEU0iYzL6/2BMKCIWcYPMJBmCBzOpMm7ABxJ2a2HtpzYqEXOoPKDlJxkaHnHDd9d4O3r/jjXDHogiTfk0xRUCO/ZSKeYTa2PX2JDRKGsLv8CijqUy95u0w1s2M353jmJuYvBP+n0PskSsvgf7VjCcVvgSkK3qV8NctVPnar2lm8FtOHLdGJHTTxgaMpoYggmGjTuXqM0wTw5zqQ0Fgnc8y0mnnTZw1D867vYH3cHJeND3f+v7/f7fsLPzK2c3t3At3diGlriF3f6VKgp/a9dagLq03+aWRUznUmjHgqP+4BEcSqIWR0WRTYmidoUiNT8p95Ny30q5anvKJgkp7wbtPPtfsfIhWvIowoiiOe73H0G8DLXmc2yxr7U/DyHXTIQXPGL1SeqzN2LB0yRi67Oe5UouEuvsbkCtuS6WxxSR7xDLB8ELE0uV/IORz4aFiVGYen3WpOueQNoTXSTHPzaSd9KwmSxE5DOiaw0yEtxaFipEFknUTEjD8C6xVNkJqrFBq5z86Dx7IwwqwVOmUS1QMVRKKp8NBSsE3uUYUnRWyGQYFuqenXrFDU+dnl1cY1ioxCxtT/rp1oB/dU3NoeFz6lPbnDunplRTGbrrhjLCkfXSdbMpF3PwIfxweU61gE8xXX86xOm7UCnr/sUu3o/GLIDYmNzv9VIZ8jSW2vin/dPTHs+T3mLQW1fYie2Ge21RLwAWBIFgrPuaBTCsk8+O+ewFcoWK/TI8O3s5Gk3G7/94+W5zwpnbxu54maPPtndyrRuxJ2UAN7gMwGcBLHhaYADVE6i8JuaLpYntEbOKuhE0cSdZTidSnYU6EIFYdQ/seSO2NbtD67LHguM5KzHyCJV+Xm5B5KKpYQqA/cp4GKLWEyNvUFT1bILi+b7wA3EQiFwlwnRWYRyScufgoA3MW77gI5t6LXA2hOvEkEITPg0m/JYnhs3QhLFF5HvgUbqwMjSxjCgeSsNtrPyVGtvOK8Lg4yq1SgfY2OL10VtPaWeWQ203u5z2CuapjJY+o67q0BWFZLbslOwGly3MWXVA2gT9s0A4uOgEbqDa2ohaSaZ4mMp5h1QPngERe7McnCmkxoWL3dtnZy3pWkk3v+muZQfUVFko6fZJ3YbnrqQ+3LsrZX5TtTeGUsBWM1dECkUZsnejYdvxcxpmES4wlXmGwtR10SagM1TmShoZyrTye72STFV+SUSsdqydFdrIbGXCgwVXCXWgui7l1ozrBGfc9krWTfAARZFRnaw/6ceWyE37r8fjC9bYqTwgbzbtNfHuODdyBZ/G6LLPpGJvLsgIxbJpZC9U9XyrXdmb/6roj+i4ckHa0l/C1Ob3q1UD+/bPMdTPCERTN7puZm3QdGO4NROFM4U6/lYj9b3jcv0m8fKBy+LT7tHv48GJfzLwj04P+08H/2lrume1ih5hZnL3cjAqclQa2815S0Sp7vQWA7eD2mTctg71O87jCLnhS9NrGLwzvTzliaA1LTnKmqtXwPOEHBuAB9t8BQ98+6608fhE2e3S9wrKcso1flBpVZH4c4GKOonrNYPcW1ei6X8E/oynGnf8bLoq6FzWXeYB+7onsb2h1kIulpbTaUFf4NGJ5p7Mqmvioq381lE30K7hrYk7DR+VGjdjGIZoT7T7da9b5ZIOHvBgWr+8ZTKiOYrf0jsDv3VOSguPJaeVuXO1cN2gs0msoca7tdcNu+o/FNVeGMrSabgjrGpQsS0AAVNV/wKKjhoF +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"; + + + + + + + + + + +Create an annotation layer (annotation-layer-pk-annotation) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer.RequestSchema.json new file mode 100644 index 00000000000..232b0e6f057 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"descr":{"description":"Give a description for this annotation layer","nullable":true,"type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"required":["name"],"type":"object","title":"AnnotationLayerRestApi.post"},"example":{"descr":"string","name":"string"}}},"description":"Annotation Layer schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer.StatusCodes.json new file mode 100644 index 00000000000..27bcb1948a0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"descr":{"description":"Give a description for this annotation layer","nullable":true,"type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"required":["name"],"type":"object","title":"AnnotationLayerRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"descr":"string","name":"string"}}}},"description":"Annotation 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer.api.mdx new file mode 100644 index 00000000000..a676853149f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-an-annotation-layer-annotation-layer.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-an-annotation-layer-annotation-layer +title: "Create an annotation layer (annotation-layer)" +description: "Create an annotation layer (annotation-layer)" +sidebar_label: "Create an annotation layer (annotation-layer)" +hide_title: true +hide_table_of_contents: true +api: eJztV21v2zYQ/iuHw4AmmBInRQsUKvLBDdq1XdAGtYMNiIKUls4RG4lUScqJJ+i/D0fKsmyn7dYO6Jd9SSTqXvg89/B4btDQ55qse6GzJcYNplo5Uo4fRVUVMhVOajX6ZLXiNZvmVAp+qoyuyDhJlt8ysqnpH2TFThjjb3JBIGCwCHNtwOXSglBKOx8dCrEkgxGquijErCCMnakpQresCGO0zkh1g22ESpS0m2Wa00408KYRluL+jNSNyzF+/PQowlKq1fvxToI28nRIQxnGlyHbVW+lZ58odRihk473iOM+5xmn/EDWjSt5WGnreLN0L8qqoAE9q0QrIOvEbbSFaR0bfHDomB/ukEnyW7aVVjYU4vHR8Q+UUWb8t8Or6nJGBkOGunD/V/3bVW+3/TZ1wPweD/n8tjC+pgyRZZRxiidHRz9Q9ZKsFTc0KP2Amq/B6R3xhcig6yQxvFELUcgMKmFESY6MhcrohfSb3QU08A1YfkTB/wGWCyVql2sj/6IshnHtclKuyw+9Uh4AMnQMSJ78XCTvtIO5rlUWA5+WjmRiuq2uTUqQabKgtAO6l16/O6D6GJzl6c/W2RvlyChRgCWzIANkjDYxjBXUiu4rShmdXwSdprX5QqVeCSeKYOeTW0prI90S48sGP905jC+vWu4B4sZyT9juxpYbxP1BqjOa+F1a71kIdYMxphcfzjDCQsyoWL8Gxvm9NgUc/Ann7ydTSDB3ropHo0Knosi1dfGzo2fPRqKSo8XxaN3grn2DGyUISZIogIPXkOC405u3iOEFCUMGfhmfnr6cTK6n739/+W7T4TRU7mC6rCiG7eKtbTN41CR4S8sEY0hwIYqaEmwfYRv1MM+XLtdqALRf6KHKstLGrYRnE5Wo1W0FJ/2y7517nBe+g48oOOYkMjL2pNliJQDomEkQfgWRpmTttdO3pNrOm9GfPIQ4UfuJqoxUbm+180M23tvfH3LxVizExAtswMfG4rr8WlmmpKdB3AnpYE4uzT0J30lBE5CU5HKdMQTW1zY98coMttXDsD+uBNQEjqaeoo/R2mWon0DUroaC9YrZmc6WMbydvH93GE67nC/3Gril5YBmaPfZmtl+nqjAUCac6NnZ4r4z0gUdFvpmj033nyOf2M1zfmpIOB4TdieFvfXKgV/Z57nBk4cx+ts8wkrwyIBfpJ7r6htROP+14bI/WD3c3toZf4aMFlToqiTlupbmVRUCNZXRTqe6aOPRqOFQbdzwgWp3op3W1ulyFSLChTCSZyrbdWEfJgwcc+FnD79NjJBUXXKL6175n+9um/FfT6fn0MdpI+TdbMbr8e5sbhJ6NX/j8Qa0gTfnHISxbAZ5kKrO31u3LVd51a8nfNMEkL5rNzjzCn6lTSk43ts/plwjb4Zx9xX728aDbiN2vjY0N2Tz7w3CUaxWH9Y/p17+8/k/QqnmenfGndQVGUvD8XOwxLoLdovjQKd1pfBXcBf/3+p/I3t/Szu6d6OqEFJxFq/NpjsalygqyVs5xgi3jwdGyEoKUrnEppkJSxemaFte/lyT4Qv3aq1Wf+1GGHqVP1G3tGQYg67jxV3UvK+d2YOPTvAYpyn5tvtl26vBcedWiRHOuh/Bpc7Yx4g7/r0l7jBGjFB7XrzY/Fpo/nUYTEJMVgHPgAPyerV0D4yq+yTUcrDDpgkWoenyEQ9Q/D2F7VXbtn8DHyJojw== +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"; + + + + + + + + + + +Create an annotation layer (annotation-layer) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-log.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-log.RequestSchema.json new file mode 100644 index 00000000000..0d971beca60 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-log.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"LogRestApi.post"},"example":{"id":1}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-log.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-log.StatusCodes.json new file mode 100644 index 00000000000..63460d51ee7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-log.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"properties":{"id":{"type":"integer"}},"type":"object","title":"LogRestApi.post"}},"type":"object"},"example":{"id":"string","result":{"id":1}}}},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-log.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-log.api.mdx new file mode 100644 index 00000000000..b23de3c44eb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-log.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-log +title: "Create log" +description: "Create log" +sidebar_label: "Create log" +hide_title: true +hide_table_of_contents: true +api: eJzFV21P5DYQ/ivWqNKBGlhArYR84gMgTge9Hohd2koEcd5k2A04ts92FrZR/ns1djab3eXUU++q+wLJZGY8zzNv3hosfq7Q+ROdz4HXkGnlUXl6FMbIIhO+0Grw6LQimcumWAp6MlYbtL5AR29FTn/93CBwKJTHCVpommQh0uNHzDwk4AsvSfBBT67R+WNT7BrtPDQJ4IsoDX2M7vYbss/RZbYwFARw+F3nKFkbRBJiLyzmwL2tsCGBM1q5GNPB3v73QuS8LdQE4gmV9P8HARu6m5Qs4uiHsaBqg6tzjyUrlEPrMSdnv+ztfQMfJTonJvgKKf8SeGcIJyJnbblxdq5mQhY5M8KKEj1ax4zVsyKnYDfR9Gwjlm/J7XfAcqNE5afaFn9jztlx5aeofHs+6+ryFSB9w4Dk4OBHIzFWZ/Q6lsgIhZ9z9gclJ6JBa7V9DcqprmTOlPas9dBa01G//uhiO1cerRKSObQztBEFZ8eKVQpfDGYe8yhkOssq+4V0vRNeyI6CBBxmlSWM/LaGx2cP/PauuUvAi4kDfttra7hLgDAFxOfUvZlF4fFeaurgl51M5zgMkbvgTQo1Ia2b6w+QgBRjlMtXpyubEa6sspLt/MWuLocjlsLUe8MHA6kzIafaeX64d3g4EKYYzPYHUk8GKbA0TRVjO+9ZCsdt7YWgODtBYdGyn45PT8+Gw/vR5W9nH1cNTmMCd0Zzg5yt53Cpm7M3dQpPOE+BsxRmQlaYQvMGmqRDdjX3U6162DpBh64ojbZ+0ekuValazHR21InDxNyic9nXUZBE3SmKHK07qteIiDG3ZKTAfmYio3q+9/oJVdNaE+Cj10CmajtVxhbKby2C3SXlre3tPvwLMRPDUFo9ClaEyyRr5YiFDrl4FoVnD+izacD99ajrGHyJfqpzipoKZ50RvlBj6zVCSD8tyqSOtIwCK5+SpUm/SiI3m5UStRdkjnU+5+xiePlxN7Z28TDfqtkTznvMsmabtIngt6mKpOTCi46QNbpbJS1xV+rJFqluvwVqz7XBFRqRxUaMzACHsIYTMMJPgUOfSkpNmCKxUStLmXs1AbB+1Af6zHKcodSmROXbeRQKIzqqjdVeZ1o2fDCoyVXDa2qDZsPbaeW8LhcuEpgJW9DYdu0IDW7oOccHES4IIUxIAFVV0nxqX+mfgw1i3o9GV6zz0yRA0az66/BuBDeMg5a+KVEi05adX5ETwrLq5FWqWvug3TSUtcWwHdKaiCDDyK1hHCrynbalIH8Xf44oR0ENePsVulURQDcJGd9bfLDopv/VCXlxWl0vb81nq3e0vSaBQj3oCHgFX2XQOuxfAnsiqq6oN9uPpDlfirAlic31ql1x3W1Jjy9+YKQoFLkI5VW3BX0LwhR0zj5Nn+CD8h8TfAt1PRYOb6xsGhJ/rtDSjrtb1ljYdAnEiRH64Ann4Raw7P1QkrKiUDbWPRV8tDjOMgzz7su6d72+pIEFCYzbXyilzsnGime6B4tn4AC0ack6lEiQxalbxbtA9Em5o7tXj68ux+0DoWo/CTXvRVjXUSOOPmrMCCUsCGjumqb5B8w4i9E= +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"; + + + + + + + + + + +Create log + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-login.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-login.RequestSchema.json new file mode 100644 index 00000000000..8df812ab7ce --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-login.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"password":{"description":"The password for authentication","example":"complex-password","type":"string"},"provider":{"description":"Choose an authentication provider","enum":["db","ldap"],"example":"db","type":"string"},"refresh":{"description":"If true a refresh token is provided also","example":true,"type":"boolean"},"username":{"description":"The username for authentication","example":"admin","type":"string"}},"type":"object"},"example":{"password":"complex-password","provider":"db","refresh":true,"username":"admin"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-login.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-login.StatusCodes.json new file mode 100644 index 00000000000..7d8ac1f014c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-login.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"access_token":{"type":"string"},"refresh_token":{"type":"string"}},"type":"object"},"example":{"access_token":"string","refresh_token":"string"}}},"description":"Authentication Successful"},"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"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-login.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-login.api.mdx new file mode 100644 index 00000000000..4c74a2f0966 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-login.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-security-login +title: "Create security login" +description: "Authenticate and get a JWT access and refresh token" +sidebar_label: "Create security login" +hide_title: true +hide_table_of_contents: true +api: eJzFV1tP3DgU/itH1koFbWBgtSuhVDzAiKqwVUGdQV2JIOpJzkxSHDu1nYHZKP99dezc5oKqUq3KC4lzbt93Lj5TsQRNrLPCZkqykJ2VNkVps5hbBC4TWKAFDlefp8DjGI1xhxrnGk0KVj2iZAHT+K1EY89VsmJhxWIlLUpLj7woBBnLlBx9NeSiYiZOMef0VGhVoLYZGvfGjXlSOqHn9aimKUL7FeZKA+/DJImA4TPPC4EsZLGih+eDzlrA7KqgL8bqTC5YHZDfZZag3vY0TpUyhHzDBXQqAUNZ5iy8Y8mMBUwkvGD3wwDc8ZbLhrJtj5dzsLpE4OusQmZanwlwYdQQJCl0PmZKCeSSnJQGteQ57maw/fo9BnmSZ3IbQ92dqNlXjC057JSG2duVgp5xz09Hh4fSB954r+val1WmMfFS7sAUShpfLn8cHf1EsflqfvAVHFYvJuxFie/QsW6/1doy25urg5dbkQpwUjqL81KQpz9/CnyOxvAF/jiqTpGdcxoDru1DuJRLLrIECq55jhZ1X7u7kA10PZbjX4vlVlI3KJ39i0kIG7x3RbgDyFCRrP/1q7NyKS01kgCDeokaUGulQziTUEp8LjC2mPhDUHFc6hdwveOWCy/nnfOFoYk3wbjUmV3RwKPIHa5L1/IaucUH0wg8CLVwM+T5IFYJTlyoZKJigssFKdx++kDjk89Q9K9GlTp2U7zUAg7+gZvryRQillpbhKORUDEXqTI2PDk6ORnxIhstj0et05FzGjGIokgCHLyHyDUR5cdFGsI5co0afjsbjy8mk4fp9d8XH9cVxj53B9NVgSFspq+XTeBNFbFHXEUshIgtuSgxYvUbVgcdxpuVTd1sbVF2Bx3OLC+Utm03mEhGsh1ycNodHxbK2D3yCz9KRuC1UuQJanNabVDio29oiRj8DsPBVTfaBP10F9xI7key0Jm0e23YhyS8t78/JOKKL/nE1deAjLXDPvFKGuKj44A/8czCHG2cOgZeg7/yMHK0qUoofiqrTW7CVgw264Ywf2lLp/IETR0/X4JeZVg5nqXt6vHSLa0zlaxCuJpcfzz0nZ7NV3sVPOJqwDHU+yRNVL+NpKcn4ZZ31GwQ3wgpgYdCLfZIdP8tq+8D5uGzkFE10Z3MbcpCtps5yombIb5rS00p28k825weH+gzJLhEoYocpW2mkasIb6gqtLIqVqIOR6OKTNVhRZ1Qb1kbl8aqvDURsCXXGZ+JZmVszPiFZ85LYZswB3ta80r/DE2udfvvp9Mb6OzUAaNo1u11eLeCm/gxS9/cZqU0XN64DVPpDSM7qWr0nXRdU5LaLEzokvAgvz45UzNXgO+UzjnZu/o8pRw5MdoC3dd+a3Og64CUHwa752uMkBWj5Kd+yb/439a+gGVyrrb310lZoDZIGbCZdWvq4IjK1Mstjz37xubcXbaN+bG7n6BlF9oaX/MyuLlf+UOo4c3isx0VgntEruSrpt3uGC8yCvmY9cmmqegCum/L745V1YwbvNWirun4W4l6xcK7+74D6I3q1Y0v16WPuCKsg0HkGkaUjuHNVYTa0WucxTG6Mfyy7HB+0PRkAZs1P/dylZCO5k+UYf7EQsZoPyBtV8DuzF8Gpd9TvE36+w+8rgRj +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"; + + + + + + + + + + +Authenticate and get a JWT access and refresh token + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-permissions-resources.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-permissions-resources.RequestSchema.json new file mode 100644 index 00000000000..5f16808168d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-permissions-resources.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"permission_id":{"nullable":true,"type":"integer"},"view_menu_id":{"nullable":true,"type":"integer"}},"type":"object","title":"PermissionViewMenuApi.post"},"example":{"permission_id":1,"view_menu_id":1}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-permissions-resources.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-permissions-resources.StatusCodes.json new file mode 100644 index 00000000000..0e1c148e174 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-permissions-resources.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"properties":{"permission_id":{"nullable":true,"type":"integer"},"view_menu_id":{"nullable":true,"type":"integer"}},"type":"object","title":"PermissionViewMenuApi.post"}},"type":"object"},"example":{"id":"string","result":{"permission_id":1,"view_menu_id":1}}}},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-permissions-resources.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-permissions-resources.api.mdx new file mode 100644 index 00000000000..eef8dd815e5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-permissions-resources.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-security-permissions-resources +title: "Create security permissions resources" +description: "Create security permissions resources" +sidebar_label: "Create security permissions resources" +hide_title: true +hide_table_of_contents: true +api: eJzVV21v2zYQ/ivEYUATTImTYgUKFf2QBi2arm2C2u0GRIFLS5eYDUWyJOXEE/TfhyMlWX4p1i0Fin2yRd0d73nuuSNVg8WvFTr/QhdLSGvItfKoPP3lxkiRcy+0Gn1xWtGay+dYcvpnrDZovUAXntCWwjmh1VQUtKAqKflMIqTeVpiAXxqEFITyeIMWmgQWAu+mJarqOz2afknPvmDuIQEvPNnDRb/7J4F371BVJ0YcGu08bYT3vDRkt5Xm8WYWxw1tU6DLrTAEHFJ4pwuUrAWeBL6ExSKm2dCCM1q5yMPjo+MHsBiJaFE6b4W6gbhDJf3/ifQtt/Uy0N4dvjV431GerfqceSyZUA6tx4I2+u3o6AE1KNE5foM7CvEPoHpHeMEL1rZVys7UgktRMMMtL9GjdcxYvRAFJbuNZuAbsTxETz8Ay0fFKz/XVvyFRcpOKj9H5dv9Wd8LO4AMHQOSx49/NhJjdU6PM4mMUPhlyj5RcSIatFbbXVBOdSULprRnbYTWm7Z68rPFdqY8WsUlc2gXaCOKlJ0oVim8N5h7LOIi03le2W+U6xX3XPYUJOAwryxhTC9r+HLnIb28aq4S8PzGQXoJ4/Y9W40Bx7RiH9Dpyubo2B6NBUZzwe3DVQKEO7ByRt2fW+Qep90201Xru6ntYkAC9we5LnAcgLuQjOTqhgJ8/PAWEpB8hnL1GB3pubKSHfzJLs7HE5bB3HuTjkZS51zOtfPp06OnT0fciNHieNQlMRokcdAnMcqAZVmmGDt4zTI4aVUdoKTsBXKLlv1ycnr6cjyeTs5/f/l+3eE0SuNgsjSYsk11rGwL9qjO4BaXGaQsgwWXFWbQPIIm6UFfLP1cqwHsfqEHLkqjre9miMtUproTij3vl8Oc3qN92YPZSWKYOfICrXteb3AU4bQ8ZcB+ZTynJpp6fYuqab2Ji+e78GdqP1PGCuX3OhyHZLy3vz9k5g1f8HHQ84CdtcWVNLRyRFBPCr/jwrNr9Pk8UPJDCKkjrhL9XBcEiJS4SVbambFNZREJnztx1ZGxSSDsc7JyGWor0ratr2jd8TzTxTJlb8bn7w/jqBHXy72a3eJyQDpr9smauH+WqchXwT3vudqoRGukJR5KfbNHpvvPgMbFxiANTc86AtmAQDZs+kgapBBuEwkY7ueQwncWgGodZmGcF5UlKeysKGwm+JZeswIXKLUpUfl2qgalxUC1sdrrXMsmHY1qCtWkNbVcsxXttHJel12IBBbcCjp8XHsQhDD0v8BrHq5AIU1IAFVV0pRtH+nHwRadryeTC9bHaRKgbNbj9Xi3khvH44LeKV4i05adXVAQwrIeZCdVrX+wbhqqdVeWMR12EWQ4OGqYBR2/0rbkFO/NHxOqUTCDtH0L/YEXQDcJOU8tXlt08/8ahKI4rT6svnFefvNj4GjztnnUJCDUtY5krGGvDFqHw9vwYImUF+0Wx5FQ50se7gHE9L/og7Vd+yuCx3s/MpILRdGDKuu2RS6BG0EpHMPgCE9gZ6NAAqSpKJpLqOsZd/jRyqah5a8VWjr9r1a6DXeABOLsCr11i8twP1pNoSBzWVGeWxchaqLocZLnGIbyt22vBmOARickMGu/UUtdkI/ld/T1wO8gBaD7BXkH2YW1eDRU8ZYUY5Ie6FY6ILPXTfuHULWvuFoOMqzraBGHMDV7hBJOMWiumqb5G1owU9Y= +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"; + + + + + + + + + + +Create security permissions resources + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-refresh.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-refresh.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-refresh.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-refresh.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-refresh.StatusCodes.json new file mode 100644 index 00000000000..f18ddde0790 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-refresh.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"access_token":{"description":"A new refreshed access token","type":"string"}},"type":"object"},"example":{"access_token":"string"}}},"description":"Refresh Successful"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-refresh.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-refresh.api.mdx new file mode 100644 index 00000000000..e96541d871d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-refresh.api.mdx @@ -0,0 +1,60 @@ +--- +id: create-security-refresh +title: "Create security refresh" +description: "Use the refresh token to get a new JWT access token" +sidebar_label: "Create security refresh" +hide_title: true +hide_table_of_contents: true +api: eJytVk1v2zgQ/SvEYA8OVomTxS4QsOghG7RoskUTVA66QGSktDS2lEikSlJOXIH/fTGkJMtOemi6J8vUzOO8N19qIUOT6qK2hZLA4cYgszkyjUuNJmdWPaBkVrEVWiaYxEd2+WXGRJqiMeEtRKDR1EoaNMBb+OP4mH5SJS1KS4+irssiFXTF9N7QPS2YNMdK0FOtVY3aFsE7IN8FZN7uhXfmI+iCw2w/DrupETgYqwu5AueGE7W4x9SCiwCfRFWX+PyqrZeL9m793IkRN95j2ZSE9OfxyS/wrNAYsfJx/FzUgyPcSNHYXOniO2acnTU2R2m7+5nGb02hMXuJz9iR0P/6pYz9D0wupEUtRckM6jVqhlorzdmZZI3EpxpTi1k4ZCpNG/0DXu+FFWWw85cbTBtd2A3w2xbuH+1dVzjAb+duHoEVKwP8FuLebh4BMfO8LzLgkGoUFu96oAEggqfDVGUYezLGX1AKuSKXm88fIYJSLLDc/jWq0SlRTRtdssN/2fVVPGMJ5NbWfDotVSrKXBnLT49PT6eiLqbrk2l/7bS7NgGWJIlk7PADS+Csy6GPlrO/UWjU7Lez8/N3cXw3u/rn3acEwEVDZNcbmys5im04GKIrqlpp64sHjTWJTGTf2+ztcHxUK2MnFAj7eQpR8MtRZKjN23aPSAKcJdCRSYD9zsZt6jpvqklyfcBNcFiLssEEXCIPElnrQtpJH/gRGU8ODsZSXIq1iH3ljOTYOdwmTElDigwqiEdRWLZEm+Zeg9cp0AYiFdpcZcSACmJfHd6bsf18E+uvfcrbINHMK/Q12rqch44+nG1qDDrtN3YCwboXdqGyDWeX8dWno9DFxXIzadkDbkYqM3dA1iT2m0QGgTJhxSDOnvSdkSrxqFSrCZkevAHqwEAfOFBFQQS1sDlw+JF2lBc/IULHNZrS9qL6sD8bPtJrluEaS1VXKG03a3xVBKC21sqqVJWOT6ctQTneUj+4Z2jnjbGq6iEiWAtdiEUZBmIPE9bXUjSl7cKECFA2Fc2c7i/9GJo7u/gfZrNrNuC4CCiaXbyB77Pg4jBE6Z0UFTKl2cU1gRCXXZAXper8vbVzlKY+DzGtgEDy/tFDLXwJvle6EoR3+WVGOfJmwLu328XsSbtodxa/DsRFUMilev6JEDc1aoMkiy0sbZrxEdVOsFufBEmMrYTfb6QVpdaPfNZTZtvS27lntC5f+dHU0bH4ZKd1KQpJ8fhKbLs+uAVRFxT0CYyWGX1uhZDmfV3cQtsuhMEbXTpHx98a1LT25tvS9EsvgjBZfPs84IY+qdIU/cTzzQ38+e7faVQaUxABfUCMNv6Qo+6B4LtXQm5G4G0bLMKsosYKUQRR3Nw59x/gVqMm +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"; + + + + + + + + + + +Use the refresh token to get a new JWT access token + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-resources.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-resources.RequestSchema.json new file mode 100644 index 00000000000..c7da9454640 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-resources.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"ViewMenuApi.post"},"example":{"name":"string"}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-resources.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-resources.StatusCodes.json new file mode 100644 index 00000000000..639ddbf0e86 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-resources.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"ViewMenuApi.post"}},"type":"object"},"example":{"id":"string","result":{"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-resources.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-resources.api.mdx new file mode 100644 index 00000000000..04c11af2b7c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-resources.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-security-resources +title: "Create security resources" +description: "Create security resources" +sidebar_label: "Create security resources" +hide_title: true +hide_table_of_contents: true +api: eJzFV21P4zgQ/ivW6KSlukAB3UooKz4UxGrh2AXRsncSQaybDG0gsb22U+hF+e+nsZM0fWFPgpP4Aokzb8/jZ8ZuCRp/FmjskUzmEJYQS2FRWHrkSmVpzG0qRf/BSEFrJp5izulJaalQ2xQNvQmeI/3P+fM5iomdQrj/cTcAO1cIIRirUzGBqgpcvlRjAuGN97ptreT4AWMLAdjUZrTwPcWnryiKgUp3lDQWqgDwmecqw0XSRfAqgARNrFNFNUMIX2WCGatr7qa2ukBXi1FSGA9hf3fvDQSkCf1dgesyFJl9P76qVeNlBqnqJlm32DVm16g9tZizVBjUFhOK+sfu7hvoy9EYPsENHP4HgtYRjnjCajGH7FTMeJYmTHHNc7SoDVNaztKEil1H0/H1WN4ihf8By7XghZ1Knf6DScgGhZ2isHV+1ipiA5Cuo0Oyv//eSJSWMb2OM2SEws5D9p02x6NBraXeBOVYFlnChLSsjlB7U6qP7y22U2FRC54xg3qG2qMI2UCwQuCzwthi4heZjONCv7Bdn7nlWUtBAAbjQhPG8KaEhycL4c1tRQ3PJ4YGwLD+zq7QyELHaNgWNT2jrjc9mg0E1NFwSr0da+QW75q4d7rxgwCet2OZ4NChMy5jxsWEnK6vziGAjI8xW7x6R3ovdMa2/2aXF8MRi2BqrQr7/UzGPJtKY8OD3YODPldpf7bXbxL328T9CFgURYKx7S8sgkEtV1dyyI6Qa9Tst8Hx8clweDe6+PPk27LDsd/z7dFcYchWt31hm7APZQSPOI8gZBHMeFZgBNUHqIIW6OXcTqXoQG0XWrBprqS2zXAwkYhEc2qww3bZTdstystexUjgXafIE9TmsFzhxUOouYmA/c54TB1xZ+Ujiqr2JvyHmzBHohcJpVNht5rad8h4q9frsnHGZ3zoxNlhZGlxIQEpDJHSEsGfeGrZPdp46mh4NQmlx5KjncqEQJDKVgkKGzO2qiAC/qMRUelZGjmSfgQLl66GPFXrOvLWDbdjmcxDdja8+LbjZ0V6P98q2SPOO0SzqkfWxPenSHiOEm55y88K+7WRzHAnk5MtMu19Aur3lUnompg1pLFuE3uiIAR33gegON0l4BdE0z66oeV7vtC0zRt3C1YLOafPLMEZZlLlKGw9/pyKfKBSaWllLLMq7PdLClWFJbVQtRbtuDBW5k2IAGZcp3RKmHpiuzD0nOA9dxcTVyYEgKLIaRzWr/TPwBptX0ajS9bGqQKgapbjtXjXihv6uU7f6DLEpGanlxSEsCwH2UhV7e+sq4r2tNmKIZ1KHqSb8CWMnV4/S51zinf214j2yJlBWH+F9mRyoKuAnO803ms009cGoShGiqvFT4CTF2/XAaTiXnrkS0ALhdpg9xraWSKZebvZnmfP2JyLTvxfiXspU3tYW3y2fZXxVFBEJ7uy1v0NcJVS2j3oHKbuZtsGJaF4JdxAWY65wWudVRUt/yxQ09l7uxCjO4ED8IPHNcwjzt3tZDFCnHazgmpbu4ZQZ3iPQRyjm6Iv2952+pnmHgQwrn+X5TIhH82fCA5/ghCADnvydlpya36WF/6O4mPSJtOdsENgK4b6gVDVn7iYdyosS2/hJyh1sIfijh2obquq+hezueko +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"; + + + + + + + + + + +Create security resources + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.ParamsDetails.json new file mode 100644 index 00000000000..5c0c197a9fc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"role_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.RequestSchema.json new file mode 100644 index 00000000000..b21ddd94de4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"permission_view_menu_ids":{"description":"List of permission view menu id","items":{"type":"integer"},"type":"array"}},"required":["permission_view_menu_ids"],"type":"object","title":"RolePermissionPostSchema"},"example":{"permission_view_menu_ids":[1]}}},"description":"Add role permissions schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.StatusCodes.json new file mode 100644 index 00000000000..ecd27a73bc9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"permission_view_menu_ids":{"description":"List of permission view menu id","items":{"type":"integer"},"type":"array"}},"required":["permission_view_menu_ids"],"type":"object","title":"RolePermissionPostSchema"}},"type":"object"},"example":{"result":{"permission_view_menu_ids":[]}}}},"description":"Permissions 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.api.mdx new file mode 100644 index 00000000000..6c138a6ecd1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles-by-role-id-permissions.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-security-roles-by-role-id-permissions +title: "Create security roles by role_id permissions" +description: "Create security roles by role_id permissions" +sidebar_label: "Create security roles by role_id permissions" +hide_title: true +hide_table_of_contents: true +api: eJzlWG1v2zYQ/ivEYUATTImTogMKFf2QBimarmiM2N0GRIZLi+eYqUSqJOXEE/TfhyMlWX7Jtq4F8mGfLFF3x3ueO94dXUHBDc/RobEQ31QgFcRQcLeACBTPEWIwOsOpFBCBwa+lNCggdqbECGy6wJxDXIFbFSQqlcNbNFDXkyCN1r3RYkUiqVYOlaNHXhSZTLmTWg3urFa0trZVGF2gcRKtf0OTS2ulVtOlxPtpjqqcSuG/CbSpkQXZgRg+SOuYnrO1BiMNRhrM+y8d5nafu1G7wo3hK6jrPtabx32YdIp6doepgwicdBktXOsMh53eUFs3CgjrCPCB5wVJ/R28m9NJTY5sgjwTglFAeigta7jbDpBHYQutbKDy+cnJdwTCoC0z938IUL2ttBmyHhGPB49itxO8YS9mXAgUZPnFd0UlR2v5LfY4s85IdfuPKDpFeMMFa85qzC7VkmdSsHVZYIXRS+md3UXU0w1YTp8WyyfFS7fQRv6JImZnpVugcs3+rMuYPUD6igHJi6dF8lE7NtelEjEbL7AlGYluq0uTIhMaLVPaMXyQRP8uqM6GR/T8+VPHpjA6pddZhozi4lYx+43SLcQHjdFmH45zXWbCQ20sNNq01S9PfXwulUOjeMYsmiWagCJmZ4qVCh8KTClofpHpNC3NIwn4ljuedRREYDEtDWGkrnx373xNoXLGb6m+wKj5zqiO+UJHuDzqSwExpAa5w2lrZkpNw05n4WEqxbTXQCCCh6NUCxx5fGESyLi6JTufrj9ABBmfYbZ+DSlI76XJ2NEfbHg1GrMEFs4V8WCQ6ZRnC21d/PLk5csBL+RgeTpofRl4XwZV40k96LmSAEuSRDF29I4lcNacSQ8rZm+QGzTsp7Pz84vRaDq++vXi46bCeUiDo/GqwJhtZ8JaVrBnVQJfcJVAzBJY8qzEBOpnUEcd8uHKLbTqYe8WOvQyL7Rx7eG0iUpU23HZ6275uNDWHdC+7MdQFAVbC+QCjX1dbREVMDVkJcB+ZjylUzN1+guqutEmQl7vIyFRh4kqjFTuoAVzTMIHh4d9et7zJR/5BO5RtLG4ThKtLLHUMcPvuXRsji5deF5+HCtVAJejW2hBqCgxtxmLWzG2nWPExOc2zapA29iz9jlaq/SzLHC3m2lBuiV7psUqZu9HVx+PQ4GR89VBxb7gqsc8qw9JmgLwKlGBNMEd7wjbCkcjpDM8zvTtAYkevgIqElvl05cC1rLo50fLZuFhSs1+oxQE7ugaoC2F0d8GYviWYFDwfTUMpaQ0lBt7Qwzbzn6gz0zgEjNd5KhcU1d96gVDVWG006nO6ngwqMhUHVd0EOsda+eldTpvTUSw5EZS+7FNK/BmwqQ6536q825CBKjKnOps80o/vspu2n83Hg9ZZ6eOgLzZtNfh3XFuFBoGfaOrFtOGXQ7JCGHZNLKXqkbfS9f+ytXGxk+yAaRvHRXMfE6/1SbnZO/972No7m90QMNX6FqeB11HpDw1ODdoF//VCFmxWl2vL4MX/+r2czKpI5BqrnfvEaOyQGOxP8z3lijrgtzyNJBpXc79FNBcaL/xPGxs3s0JDh/coMi4VLSJT8yqOSo3wAtJnpxCr49H/iJNBuP1jbq/06TNnhuoqhm3+MlkdU3LX0s0NAhM1gnsz5WQfpYSEM95ZnHH1W4ogoPrZvY9ZOsAbUJoL1hq5c9JVtIbRNQfen8C1BSWUEa9C+FrvyD2tHcmMTrDQeMsTdE3icdlJ71SRFUcIpg1/yXkWvh/Jvg90crvg6faAw+XVVoLraoMY1qwSelIg34vkF3aNg+Eai8XVRUkQj+oO2p8VyVi6vovd6UNnA== +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"; + + + + + + + + + + +Create security roles by role_id permissions + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles.RequestSchema.json new file mode 100644 index 00000000000..131674ef874 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetRoleApi.post"},"example":{"name":"string"}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles.StatusCodes.json new file mode 100644 index 00000000000..4a4fc522433 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"properties":{"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetRoleApi.post"}},"type":"object"},"example":{"id":"string","result":{"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles.api.mdx new file mode 100644 index 00000000000..aded2824f5d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-roles.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-security-roles +title: "Create security roles" +description: "Create security roles" +sidebar_label: "Create security roles" +hide_title: true +hide_table_of_contents: true +api: eJzFV21P5DYQ/ivWqNKBGlhA1wrlxAdAnA5KD8QubSWCOG8ysAHH9tnOwjbKf6/GTrLZF1T1qMQXNnHm7XnmxUMFBr+XaN2RymYQV5Aq6VA6euRaizzlLldy8GiVpDObTrDg9KSN0mhcjpbeJC+Qfgv+co7ywU0g/vVjBG6mEWKwzuTyAeo68u5ygxnEN0HptpNS40dMHUTgcifoYFhqNBbdlRJ4qPNtrayDOgJ84YUWOPc7d1BHkKFNTa4pbIjhd5WhYE3YfffOlOjjsVpJG1Ds7ey+gYM8o79LkL2HUrh3paxeVlgkkQJvHfbjXSF3hd1ThwXLpUXjMCOrH3d23sBggdbyB1xD478g6BThiGesKemYncopF3nGNDe8QIfGMm3UNM8o2FU0Pd2A5S3V8D9guZa8dBNl8r8xi9lh6SYoXeOfdVWxBkhf0SPZ23tvJNqolF7HAhmhcLOY/UHJCWjQGGXWQTlWpciYVI41FhptcvXLexfbqXRoJBfMopmiCShidihZKfFFY+owC4dMpWlpXknXZ+646CiIwGJaGsIY31Tw+Owgvrmtqen5g6UhMGy+M+pyS+OAcHnUp9TKqUHu8K41c2e8WAQvW6nKcOiBWG9ccPlACtdX5xCB4GMU81erSpMSzLQ0gm39xS4vhiOWwMQ5HQ8GQqVcTJR18f7O/v6A63ww3R20Tgfe6SABliSJZGzrC0vgsKlKH2rMjpAbNOynw+Pjk+HwbnTx28nXRYXjkNqt0UxjzJazO5fN2IcqgSecJRCzBKZclJhA/QHqqAN5OXMTJXswu4MOaF5oZVw7A2wiE9neD+ygO/ZDdYP8sv/MRhTUJsgzNPagWuIkhN/wkgD7mfGUiv7OqSeUdaNN2A/W4U3kZiK1yaXbaOPeJuGNzc0+E2d8yoe+/npsLBzOU6+kJUI6Evgzzx27R5dOPAU/REAVcBToJiojAFRZy+TErRhbrhwC/a0tniowNPIEfYvmKv3aCTSt1k+Qbnkdq2wWs7PhxdftMAry+9lGxZ5w1iOZ1ZskTVx/SmTgJ+OOd9wsMd8IKYHbQj1skOjmJ6B2Xhp0vmlZSxhrmzaQBDH4qzwCzWlTgFcIptz5WRT6uzSU2rUZguUAzukzy3CKQukCpWummq+cYKjSRjmVKlHHg0FFpuq4opapV6wdl9apojURwZSbnIa/bQaxN0PPGd5zv2/4MCEClGVBU655pR8/4xbtfxmNLllnp46Aolm01+FdCW4YxjV9ox2HKcNOL8kIYVk0spaqRt9L1zXlsk3DkC6bANIP7grGvk4/K1Nwsnf254hy5MUgbr5Cd+F40HVEyncG7w3ayY8aIStWyav5fn/y6t4cQS7vVUC+ALRZJ9dsmJRTNDbITXcDe9YVXPbsv1bUC166+9fhixtowXNJ1nzJVU293wDXObnchd79GEFrkAokVMANVNWYW7w2oq7p+HuJhq7S23kR+gs1gjBofKM84cwvG/OR4WtWlBTXylZBHRE0DtMU/cR8Xfa218M05yCCcfPPVqEy0jH8maDwZ4gB6DInbV9D/izM7TKsHMEmJZdWvB55XRE0D4Sq+cTlrBdhVQWJMDGpcwMUf8VAfVvX9T8mSNiu +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"; + + + + + + + + + + +Create security roles + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-users.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-users.RequestSchema.json new file mode 100644 index 00000000000..41073db9876 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-users.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"active":{"description":"Is user active?It's not a good policy to remove a user, just make it inactive","type":"boolean"},"email":{"description":"The user's email","type":"string"},"first_name":{"description":"The user's first name","type":"string"},"last_name":{"description":"The user's last name","type":"string"},"password":{"description":"The user's password for authentication","type":"string"},"roles":{"description":"The user's roles","items":{"type":"integer"},"minItems":1,"type":"array"},"username":{"description":"The user's username","maxLength":250,"minLength":1,"type":"string"}},"required":["email","first_name","last_name","password","roles","username"],"type":"object","title":"SupersetUserApi.post"},"example":{"active":true,"email":"string","first_name":"string","last_name":"string","password":"string","roles":[1],"username":"string"}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-users.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-users.StatusCodes.json new file mode 100644 index 00000000000..ebc7f893b2e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-users.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"active":{"description":"Is user active?It's not a good policy to remove a user, just make it inactive","type":"boolean"},"email":{"description":"The user's email","type":"string"},"first_name":{"description":"The user's first name","type":"string"},"last_name":{"description":"The user's last name","type":"string"},"password":{"description":"The user's password for authentication","type":"string"},"roles":{"description":"The user's roles","items":{"type":"integer"},"minItems":1,"type":"array"},"username":{"description":"The user's username","maxLength":250,"minLength":1,"type":"string"}},"required":["email","first_name","last_name","password","roles","username"],"type":"object","title":"SupersetUserApi.post"}},"type":"object"},"example":{"result":{"active":true,"email":"string","first_name":"string","last_name":"string","password":"string","roles":[],"username":"string"}}}},"description":"Item changed"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-users.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-users.api.mdx new file mode 100644 index 00000000000..a41ce019117 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-users.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-security-users +title: "Create security users" +description: "Create security users" +sidebar_label: "Create security users" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/isHYkASTInjoAUKFcWQBi2ari9B7WwDoiClpbPNRCJVknKiCfrvw5GSLL91Wzu0wNBPlqi7R3yee+HJFdP4qUBjn6ukZGHFYiUtSkuXPM9TEXMrlBzcGiVpzcRzzDhd5VrlqK1A42xjKxZIVwmaWIucvFjIzg0UBjX457+c2z0DUlngMFMqgVylIi7BKtCYqQUCd+YB3BbGQsbvEIQFIRv4gNkyRxayiVIpcsnqgGHGRbr54vEcHdSeAW/R+RqrhZyR61RoY28kz7ZsvOfvzMCZbQFJ+T/BIKudEDk35l7p5LMIrRFMlQZe2DlK20RnG6ZWqY/MTkBvETBhMXOWDYaQFmeoCSQT8tw/HXav4Frzkh4SzN/y7owClvGHNyhnds7Ck8fHDry9H24QIAb4qRAaExZesTaEvYj1le9J2DLv7e+6Q1eTW4wtySVsSgujIkdt0F4a1Ke5OMqVsS6pHniWp9jPbKsL7LKt3edqDi1Xe0mxXFyGebnWhOlqeN0XdClDHaxp+1YlmEJThn2RaH9ONZMraXzsT46HX1HTGk2R2h+1/qPW/8e1Xq87rFb/sga+TR/Y1QY2+gDFCuI5lzNMaM+Pjo+/otQzNIbPsJcZveB8Tp/OkT3nCTSzRAjncsFTkUDONc/QojaQa7UQCW12k0zP13P5mrb1H3C5lFR0Sos/MQnhdKUAocvVLUT6jp7Jo+/L5J2yMFWFTEKgSm1ERpLbqELHCIlC36bxQbiC2CDVYThGJyffOza5VjHdTlIEiostQ/iN0s3HB7VWehuPM1WkiaPaIDTe9KrH37t8zqWlsk/BoF6g9ixCOJVQSHzIMaaguUVQcVzoHQn4kluedhIEzGBcaOIYXlXs9t5Si6mpSfIZtRs2ap4DdUVD7ZN4Odbn1KBijdziTQtzUzizgD0cxirBkSNiHHjK5YwcLj+8cY1vguny1uca3Rc6hcM/4OL9aAwRm1ubh4NBqmKezpWx4ZPjJ08GPBeDxXDQvnTgXjqIGERRJAEOX0HETps6c1sN4TlyjRp+Oj07ezEa3Yzf//ri3arDmQ/t4bjMMYT16C5tE9irInaHZcRCiNiCpwVGrN5jddCRvCjt3B3FLc1uoSMqslxp2xaciWQk29EMnnXL7hDap/fCv1Yj8G5z5Alq86xa08Rvv9ElYvAz8JiS/saqO5R1403cn23jG8mDSOZaSLvf7vuIjPcPDvpKvOYLPnL511NjZXEZeiUNCdKJwO+5sDBFG8+dBF8kQOV5ZGjnKiEClFnr4oStGaxnDpH+2CZP5RUaO4E+BkuXfu54mTbzx1u3uk5UUobwevT+3ZFvBWJa7ldwh2VPZKgPyJq0fhpJr0/CLe+0WVO+MVIpHqVqtk+mB08ZlfNao3NFC61g0BatF4mFzI0+NIjQQMZ2CEyxc73I13ehKbRbI8TWN/CGHkOCC0xVnqG0TVdzmeOBqlwrq2KV1uFgUBFUHVZUMvUG2llhrMpaiIAtuBbU/E3TiB2Mn0yn3E1rbpssYCiLjLpcc0s/rset4r8ajy+gw6kDRrtZxev4bmxu5Ns1PaOhDZSG8ws36Cu9BrJVqsbfWdc1xbINw4gOG0/SNe6KTVyevlQ644T3+vcxxciZ0XeSe7r8PnCk64CcbzRONZr5l4IQilHyw/Kvohff+gP5ePtkHDAhp2rzs6Qd9rfM/5RBqI23Wwx9rIzNuDviG/xdJbTylu60t/hgB3nKhftKdQleNdV1xXgu6JVD1juNPRcCpHT0+XbFqmrCDV7qtK5p+VOBuvTfBG3Ku+M7YL6tubK8w9KNNssG5SokLdz32/oMQ/XnPU7jGF1/3m173esY1FVZwCbNv4SZSshH83sKEb9nIWM0OpC3/++A1vwpUfgBx2NSKtGI3BOvS7nmgli135+y7O2wqryF78/UJzwVd6Cx+rqu678AKEEwQA== +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"; + + + + + + + + + + +Create security users + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.StatusCodes.json new file mode 100644 index 00000000000..4de62cbbfd6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"},"example":{"result":{}}}},"description":"Tag added to favorites"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.api.mdx new file mode 100644 index 00000000000..8fcdbf627ad --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-tag-by-pk-favorites.api.mdx @@ -0,0 +1,68 @@ +--- +id: create-tag-by-pk-favorites +title: "Create tag by pk favorites" +description: "Marks the tag as favorite for the current user" +sidebar_label: "Create tag by pk favorites" +hide_title: true +hide_table_of_contents: true +api: eJzFVlFv2zYQ/ivEYQ8JpsRJ0AGBij5kRosm65qgdrYBUeDS0tlSLJMseXLjCvrvw5GyIjvehrYD+mSTujve9/Hu49WQoUttYajQCmL4XdqFE5SjIDkX0omZXGlbEIqZtn4/raxFRaJyaCECI61cIqF1EN/VUHAQIymHCJRcIq8WEIHFT1VhMYOYbIURuDTHpYS4BlobtioU4RwtNM09WzujlUPHBmcnJ/yTakWoiP9KY8oilZzy4MFx3nUvoLHaoKUieFt0VUm9g/T0AVOCpol2dyLAR7k0JW75NQ2bbrM0Zm6yDDNBumPIcYQXJ6ffkewSnZNz7GXryBZq/p/Zdo5wq2RFubbFF8xicVFRjora80V3C3sw9R0Dkhc/Fsl7TWKmK5XFYpyjzx0dYSYsOl3ZFEWm0QmlSeBj4WgfqC6GR3R29qPvxlid8nJaouB7oXUs/pBlkYX7QWu13YdjqKsy81DbCK03H/XLd/XH/wDrUhFaJUvh0K7QBhSxuFCiUvhoMOVL85tCp14+9hbgG0my7CiIwGFaWcbIuvLwmSC+u2dxIDlnreEmdHAfAaPxWC8ziCG1KAknJOeT6XpiFpOn9ozg8SjVGY48hqBXpVRz9rr98A4iKOUUy6dlKDNeV7YUR3+Jm+vRWCSQE5l4MCh1KstcO4rPT87PB9IUg9XpgOR8cDroTh0kIJIkUUIcvRUJXLQ95hOOxa8oLVrx08Vw+Ho0moyvf3v9PgFooi6zmzXlWvVy6za67Iql0ZY2DeISlaiNgIpX3fax0Y4OOBHx9RCi4JejzNC6V/UOkARikUALJgHxs5ApV+mE9AJV03pzKbLrAtfBYSXLChNoEnWYKGMLRQebxI/Z+ODwsE/FlVzJkS+YHh1bm08XppVjRjoW5GdZkJghpbnn4NsYqAOQJVKuM0bABbHLTrwxE7v3zag/bq68DhSNPUMfoyeXYWjko/HaYOBpt58TCNYbYqc6W8fianT9/jg0bzFbH9Rigesey6I5ZGsm+2WiAkGZJNmRs0N9a6RLPC71/IBND18CN2CAzy+7duRHAMohhj53tVk0Pfr4arw2hKarLN/c3guAXVV4x59FhisstVny4BEi+cIIgWpjNelUl008GNQcqolrbonmWbRh5UgvNyEiWElbsBi7Vhh9GP6f4Uz699+nCRGgqpasOu2Sf7z6bMd/Ox7fiC5OEwFnsx2vw/ssuVGQT/7Go5PQVlzecBDGsh1kL1Wtv7du/By1kdARi38A6YW0hqmvwjfaLiXHu/pzDO1Qxu0TvkL3AHjQTcTOE4sziy7/1iBNBIWa6QBnK/vKoHXItFBB/Mb0t7h2gt3qNFDiaCn9y9aOmUMv/H5sna6FWYi+8G8d1Xsrv37ebcEQPtLAlLJQnI2vw7pthDuQpuCUT8E/VhBB7GfgfkJcOqE27qCup9LhrS2bhrc/VWj50bt/Kk/fNVnh54YM4pksHf4LqIMP7Zx3KP4p43ZTqrXvgrLiFUSszWFkb+65er2i+dPDh4s0Ra+0G5dno8aWQLA8QgQ8WPYGjK4w2j8cfm8+dR0sgkY2XXr+VeEMm+ZvTwBfwA== +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"; + + + + + + + + + + +Marks the tag as favorite for the current user + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/css-templates.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/css-templates.tag.mdx new file mode 100644 index 00000000000..d8ec2c84d76 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/css-templates.tag.mdx @@ -0,0 +1,19 @@ +--- +id: css-templates +title: "CSS Templates" +description: "CSS Templates" +custom_edit_url: null +--- + +Manage CSS templates for custom dashboard styling. + +| Method | Endpoint | Path | +|--------|----------|------| +| `DELETE` | [Bulk delete CSS templates](./bulk-delete-css-templates) | `/api/v1/css_template/` | +| `GET` | [Get a list of CSS templates](./get-a-list-of-css-templates) | `/api/v1/css_template/` | +| `POST` | [Create a CSS template](./create-a-css-template) | `/api/v1/css_template/` | +| `GET` | [Get metadata information about this API resource (css-template--info)](./get-metadata-information-about-this-api-resource-css-template-info) | `/api/v1/css_template/_info` | +| `DELETE` | [Delete a CSS template](./delete-a-css-template) | `/api/v1/css_template/{pk}` | +| `GET` | [Get a CSS template](./get-a-css-template) | `/api/v1/css_template/{pk}` | +| `PUT` | [Update a CSS template](./update-a-css-template) | `/api/v1/css_template/{pk}` | +| `GET` | [Get related fields data (css-template-related-column-name)](./get-related-fields-data-css-template-related-column-name) | `/api/v1/css_template/related/{column_name}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/current-user.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/current-user.tag.mdx new file mode 100644 index 00000000000..242e437ec80 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/current-user.tag.mdx @@ -0,0 +1,13 @@ +--- +id: current-user +title: "Current User" +description: "Current User" +custom_edit_url: null +--- + +Get information about the currently authenticated user. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get the user object](./get-the-user-object) | `/api/v1/me/` | +| `GET` | [Get the user roles](./get-the-user-roles) | `/api/v1/me/roles/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboard-filter-state.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboard-filter-state.tag.mdx new file mode 100644 index 00000000000..bdf49500926 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboard-filter-state.tag.mdx @@ -0,0 +1,15 @@ +--- +id: dashboard-filter-state +title: "Dashboard Filter State" +description: "Dashboard Filter State" +custom_edit_url: null +--- + +Manage temporary filter state for dashboards. + +| Method | Endpoint | Path | +|--------|----------|------| +| `POST` | [Create a dashboard's filter state](./create-a-dashboards-filter-state) | `/api/v1/dashboard/{pk}/filter_state` | +| `DELETE` | [Delete a dashboard's filter state value](./delete-a-dashboards-filter-state-value) | `/api/v1/dashboard/{pk}/filter_state/{key}` | +| `GET` | [Get a dashboard's filter state value](./get-a-dashboards-filter-state-value) | `/api/v1/dashboard/{pk}/filter_state/{key}` | +| `PUT` | [Update a dashboard's filter state value](./update-a-dashboards-filter-state-value) | `/api/v1/dashboard/{pk}/filter_state/{key}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboard-permanent-link.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboard-permanent-link.tag.mdx new file mode 100644 index 00000000000..af2fd306f8a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboard-permanent-link.tag.mdx @@ -0,0 +1,13 @@ +--- +id: dashboard-permanent-link +title: "Dashboard Permanent Link" +description: "Dashboard Permanent Link" +custom_edit_url: null +--- + +Create and retrieve permanent links to dashboard states. + +| Method | Endpoint | Path | +|--------|----------|------| +| `POST` | [Create a new dashboard's permanent link](./create-a-new-dashboards-permanent-link) | `/api/v1/dashboard/{pk}/permalink` | +| `GET` | [Get dashboard's permanent link state](./get-dashboards-permanent-link-state) | `/api/v1/dashboard/permalink/{key}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboards.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboards.tag.mdx new file mode 100644 index 00000000000..3d168337203 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboards.tag.mdx @@ -0,0 +1,37 @@ +--- +id: dashboards +title: "Dashboards" +description: "Dashboards" +custom_edit_url: null +--- + +Create, read, update, and delete dashboards. + +| Method | Endpoint | Path | +|--------|----------|------| +| `DELETE` | [Bulk delete dashboards](./bulk-delete-dashboards) | `/api/v1/dashboard/` | +| `GET` | [Get a list of dashboards](./get-a-list-of-dashboards) | `/api/v1/dashboard/` | +| `POST` | [Create a new dashboard](./create-a-new-dashboard) | `/api/v1/dashboard/` | +| `GET` | [Get metadata information about this API resource (dashboard--info)](./get-metadata-information-about-this-api-resource-dashboard-info) | `/api/v1/dashboard/_info` | +| `GET` | [Get a dashboard detail information](./get-a-dashboard-detail-information) | `/api/v1/dashboard/{id_or_slug}` | +| `GET` | [Get a dashboard's chart definitions.](./get-a-dashboards-chart-definitions) | `/api/v1/dashboard/{id_or_slug}/charts` | +| `POST` | [Create a copy of an existing dashboard](./create-a-copy-of-an-existing-dashboard) | `/api/v1/dashboard/{id_or_slug}/copy/` | +| `GET` | [Get dashboard's datasets](./get-dashboards-datasets) | `/api/v1/dashboard/{id_or_slug}/datasets` | +| `DELETE` | [Delete a dashboard's embedded configuration](./delete-a-dashboards-embedded-configuration) | `/api/v1/dashboard/{id_or_slug}/embedded` | +| `GET` | [Get the dashboard's embedded configuration](./get-the-dashboards-embedded-configuration) | `/api/v1/dashboard/{id_or_slug}/embedded` | +| `POST` | [Set a dashboard's embedded configuration](./set-a-dashboards-embedded-configuration) | `/api/v1/dashboard/{id_or_slug}/embedded` | +| `PUT` | [Update dashboard by id_or_slug embedded](./update-dashboard-by-id-or-slug-embedded) | `/api/v1/dashboard/{id_or_slug}/embedded` | +| `GET` | [Get dashboard's tabs](./get-dashboards-tabs) | `/api/v1/dashboard/{id_or_slug}/tabs` | +| `DELETE` | [Delete a dashboard](./delete-a-dashboard) | `/api/v1/dashboard/{pk}` | +| `PUT` | [Update a dashboard](./update-a-dashboard) | `/api/v1/dashboard/{pk}` | +| `POST` | [Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)](./compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot) | `/api/v1/dashboard/{pk}/cache_dashboard_screenshot/` | +| `PUT` | [Update colors configuration for a dashboard.](./update-colors-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/colors` | +| `DELETE` | [Remove the dashboard from the user favorite list](./remove-the-dashboard-from-the-user-favorite-list) | `/api/v1/dashboard/{pk}/favorites/` | +| `POST` | [Mark the dashboard as favorite for the current user](./mark-the-dashboard-as-favorite-for-the-current-user) | `/api/v1/dashboard/{pk}/favorites/` | +| `PUT` | [Update native filters configuration for a dashboard.](./update-native-filters-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/filters` | +| `GET` | [Get a computed screenshot from cache (dashboard-pk-screenshot-digest)](./get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest) | `/api/v1/dashboard/{pk}/screenshot/{digest}/` | +| `GET` | [Get dashboard's thumbnail](./get-dashboards-thumbnail) | `/api/v1/dashboard/{pk}/thumbnail/{digest}/` | +| `GET` | [Download multiple dashboards as YAML files](./download-multiple-dashboards-as-yaml-files) | `/api/v1/dashboard/export/` | +| `GET` | [Check favorited dashboards for current user](./check-favorited-dashboards-for-current-user) | `/api/v1/dashboard/favorite_status/` | +| `POST` | [Import dashboard(s) with associated charts/datasets/databases](./import-dashboard-s-with-associated-charts-datasets-databases) | `/api/v1/dashboard/import/` | +| `GET` | [Get related fields data (dashboard-related-column-name)](./get-related-fields-data-dashboard-related-column-name) | `/api/v1/dashboard/related/{column_name}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/database.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/database.tag.mdx new file mode 100644 index 00000000000..ca6ecd024e1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/database.tag.mdx @@ -0,0 +1,42 @@ +--- +id: database +title: "Database" +description: "Database" +custom_edit_url: null +--- + +Manage database connections and metadata. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get a list of databases](./get-a-list-of-databases) | `/api/v1/database/` | +| `POST` | [Create a new database](./create-a-new-database) | `/api/v1/database/` | +| `GET` | [Get metadata information about this API resource (database--info)](./get-metadata-information-about-this-api-resource-database-info) | `/api/v1/database/_info` | +| `DELETE` | [Delete a database](./delete-a-database) | `/api/v1/database/{pk}` | +| `GET` | [Get a database](./get-a-database) | `/api/v1/database/{pk}` | +| `PUT` | [Change a database](./change-a-database) | `/api/v1/database/{pk}` | +| `GET` | [Get all catalogs from a database](./get-all-catalogs-from-a-database) | `/api/v1/database/{pk}/catalogs/` | +| `GET` | [Get a database connection info](./get-a-database-connection-info) | `/api/v1/database/{pk}/connection` | +| `GET` | [Get function names supported by a database](./get-function-names-supported-by-a-database) | `/api/v1/database/{pk}/function_names/` | +| `GET` | [Get charts and dashboards count associated to a database](./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](./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](./get-all-schemas-from-a-database) | `/api/v1/database/{pk}/schemas/` | +| `GET` | [Get database select star for table (database-pk-select-star-table-name)](./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)](./get-database-select-star-for-table-database-pk-select-star-table-name-schema-name) | `/api/v1/database/{pk}/select_star/{table_name}/{schema_name}/` | +| `DELETE` | [Delete a SSH tunnel](./delete-a-ssh-tunnel) | `/api/v1/database/{pk}/ssh_tunnel/` | +| `POST` | [Re-sync all permissions for a database connection](./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)](./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](./get-table-metadata) | `/api/v1/database/{pk}/table_metadata/` | +| `GET` | [Get table extra metadata (database-pk-table-metadata-extra)](./get-table-extra-metadata-database-pk-table-metadata-extra) | `/api/v1/database/{pk}/table_metadata/extra/` | +| `GET` | [Get database table metadata](./get-database-table-metadata) | `/api/v1/database/{pk}/table/{table_name}/{schema_name}/` | +| `GET` | [Get a list of tables for given database](./get-a-list-of-tables-for-given-database) | `/api/v1/database/{pk}/tables/` | +| `POST` | [Upload a file to a database table](./upload-a-file-to-a-database-table) | `/api/v1/database/{pk}/upload/` | +| `POST` | [Validate arbitrary SQL](./validate-arbitrary-sql) | `/api/v1/database/{pk}/validate_sql/` | +| `GET` | [Get names of databases currently available](./get-names-of-databases-currently-available) | `/api/v1/database/available/` | +| `GET` | [Download database(s) and associated dataset(s) as a zip file](./download-database-s-and-associated-dataset-s-as-a-zip-file) | `/api/v1/database/export/` | +| `POST` | [Import database(s) with associated datasets](./import-database-s-with-associated-datasets) | `/api/v1/database/import/` | +| `GET` | [Receive personal access tokens from OAuth2](./receive-personal-access-tokens-from-o-auth-2) | `/api/v1/database/oauth2/` | +| `GET` | [Get related fields data (database-related-column-name)](./get-related-fields-data-database-related-column-name) | `/api/v1/database/related/{column_name}` | +| `POST` | [Test a database connection](./test-a-database-connection) | `/api/v1/database/test_connection/` | +| `POST` | [Upload a file and returns file metadata](./upload-a-file-and-returns-file-metadata) | `/api/v1/database/upload_metadata/` | +| `POST` | [Validate database connection parameters](./validate-database-connection-parameters) | `/api/v1/database/validate_parameters/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/datasets.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/datasets.tag.mdx new file mode 100644 index 00000000000..bc3d3e33c2f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/datasets.tag.mdx @@ -0,0 +1,29 @@ +--- +id: datasets +title: "Datasets" +description: "Datasets" +custom_edit_url: null +--- + +Manage datasets (tables) used for building charts. + +| Method | Endpoint | Path | +|--------|----------|------| +| `DELETE` | [Bulk delete datasets](./bulk-delete-datasets) | `/api/v1/dataset/` | +| `GET` | [Get a list of datasets](./get-a-list-of-datasets) | `/api/v1/dataset/` | +| `POST` | [Create a new dataset](./create-a-new-dataset) | `/api/v1/dataset/` | +| `GET` | [Get metadata information about this API resource (dataset--info)](./get-metadata-information-about-this-api-resource-dataset-info) | `/api/v1/dataset/_info` | +| `DELETE` | [Delete a dataset](./delete-a-dataset) | `/api/v1/dataset/{pk}` | +| `GET` | [Get a dataset](./get-a-dataset) | `/api/v1/dataset/{pk}` | +| `PUT` | [Update a dataset](./update-a-dataset) | `/api/v1/dataset/{pk}` | +| `DELETE` | [Delete a dataset column](./delete-a-dataset-column) | `/api/v1/dataset/{pk}/column/{column_id}` | +| `DELETE` | [Delete a dataset metric](./delete-a-dataset-metric) | `/api/v1/dataset/{pk}/metric/{metric_id}` | +| `PUT` | [Refresh and update columns of a dataset](./refresh-and-update-columns-of-a-dataset) | `/api/v1/dataset/{pk}/refresh` | +| `GET` | [Get charts and dashboards count associated to a dataset](./get-charts-and-dashboards-count-associated-to-a-dataset) | `/api/v1/dataset/{pk}/related_objects` | +| `GET` | [Get distinct values from field data (dataset-distinct-column-name)](./get-distinct-values-from-field-data-dataset-distinct-column-name) | `/api/v1/dataset/distinct/{column_name}` | +| `POST` | [Duplicate a dataset](./duplicate-a-dataset) | `/api/v1/dataset/duplicate` | +| `GET` | [Download multiple datasets as YAML files](./download-multiple-datasets-as-yaml-files) | `/api/v1/dataset/export/` | +| `POST` | [Retrieve a table by name, or create it if it does not exist](./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](./import-dataset-s-with-associated-databases) | `/api/v1/dataset/import/` | +| `GET` | [Get related fields data (dataset-related-column-name)](./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](./warm-up-the-cache-for-each-chart-powered-by-the-given-table) | `/api/v1/dataset/warm_up_cache` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/datasources.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/datasources.tag.mdx new file mode 100644 index 00000000000..a50dd0a0b14 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/datasources.tag.mdx @@ -0,0 +1,12 @@ +--- +id: datasources +title: "Datasources" +description: "Datasources" +custom_edit_url: null +--- + +Query datasource metadata and column values. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get possible values for a datasource column](./get-possible-values-for-a-datasource-column) | `/api/v1/datasource/{datasource_type}/{datasource_id}/column/{column_name}/values/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.StatusCodes.json new file mode 100644 index 00000000000..4688364905b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Chart 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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.api.mdx new file mode 100644 index 00000000000..82cd06d403d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-chart.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-chart +title: "Delete a chart" +description: "Delete a chart" +sidebar_label: "Delete a chart" +hide_title: true +hide_table_of_contents: true +api: eJzFVu9P5DYQ/VesUaWCGli4XiXk032gHOjuiq7odukPEcSZZCCGxPbZkz1olP+9Gjub3YWt1PYLn5I4nvF7M8/P7sAprxok9AHkRQfagASnqIIMjGqQv+4hA49fW+2xBEm+xQxCUWGjQHZAj45naUN4ix76/pJnB2dNwMATXu3t8aOwhtAQvyrnal0o0tZM7oI1PLZM6Lx16Emn6AZDULe4slIgr80t9H22GLHXd1gQ9Bngg2pcjWuBy4A+gxJD4bXjpUHCUaU8iRJrJOTw13v7Lwv13KiWKuv1X1hKcdhShYaG9cXYgw1MVgMTkx9flsmJ9de6LNFI8adtRWnN9yQqNUfh0Dc6BGZEVqiiwBAEVToIj8G2vsBNBMd8id3rl2X3yZK4sa0ppZhVGDuDgbAcKYjSYhDGksAHHWgTozFHZPTq1Usrz3nLrVDXNQpWHT1K8ZuqdZnUh95bv3ET2bYuI9UhwxDNS/300nv/gyH0RtUioJ+jTyykODSiNfjgsOCmxUFhi6L1/7C9ThSpeixBBgGL1jNH9sy7bwTy4pKNj9Qt+2gylgCXGTzsFLbEaYSWLLZW5hYkFOefTyGDWl1jvfwcNoCEovW12PlDvDs+PZ4dixwqIicnk9oWqq5sIHmwd3AwUU5P5vuTgteb7Ocg8jw3Quy8FzkcDo4Qiy3Fz6g8evHd4dHR8XR6Nfv1l+NPOUCfjZDOHqmyZgXUODDC0o2znhaCD7nJzcLsxdtxeDdZ6hZDEf8ae5amV6hK9OFt94RBDlLkMLDIQfwweMcV2Xs0fW62c+O8NrS1QLQbSFEbrrgD26tEP6q5msb2rpBdG1z2wZrAfEeO6pvSJG6Qiiry+0/sukSxQapsyXRSe59yl4uJ4mkbuQhfFp3sUgFmkf+XFNHzg4vxJjeM3da4W9vbpzXZfgOs13WVv4tdE0pE0JBBwgkShiMyS1cDCevsOnffc83iFksibz2XdGNl4Omyp/xblDjH2roGDQ2bNXYsJeqct2QLW/dyMuk4VS87VmL/LNtRG8g2ixQZzJXX7Glh8JeYht9LvFFtTQNMyABN2/DmHT75Ebfwev73s9mZGPP0GTCa9Xwj32fgpsmF+B/froT14sMZJ2Eu60k2lmqIj7P7eNVaONGUPTSRjH7UwXVUyYn1jeJ8H3+fwXBvY12nvzD6aCTdZxx85fHGY6j+b5I+A21ubKKzhr516ANyWUgTW/XqEGsnzZvvp5IEalQ8IIab6DN9rqUfDwnCB5q4Wul4V4gC6gbhXoBymtfahwwWWaS75zanPl5A112rgOe+7nse/tqiZ5+/XEopKrzU8agsQd6oOuAzMOOZB1ufh4vbtliWah3kMKjMY1Rs3fIXZHCPj+kG3l+y0qI7xNXTj8OiwGhXi5BnpytLZNzFyWwgA74rrhRsbOPwwgtsRNR1aUZynH4EGB2YMfb933xAO3I= +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"; + + + + + + + + + + +Delete a chart + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.api.mdx new file mode 100644 index 00000000000..41a20ca07a5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-css-template.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-css-template +title: "Delete a CSS template" +description: "Delete a CSS template" +sidebar_label: "Delete a CSS template" +hide_title: true +hide_table_of_contents: true +api: eJzFVlFP3DgQ/ivW6B5AF1hAPQml6gNHqUoPtai73J1EEDXJ7G7AsV17soWL/N9PY2ezu7D3cH3hKbHjGX/fzDcz6cBKJxskdB7y6w5qDTlYSXPIQMsGefUAGTj83tYOK8jJtZiBL+fYSMg7oCfLp2pNOEMHIdzwaW+N9uj5wNHBAT9Kowk18au0VtWlpNro0b03mvdWDq0zFh3VybpB7+UM127y5Go9gxCy5Y65u8eSIGSAj7KxCjcMVwYhgwp96WrLV0MO54SNqFAhYcXmbw7evC7Uz4bE1LS6ysVkjoKjjp6wEg69aV2JojLohTYk8LH2tI3U4CMyOjp6XUZX2jpT8vJOoUBNNT3l4k+p6ipiEOiccdt4nJpWVZFq76G35qt+e21NnWtCp6USHt0CXWKRixMtWo2PFktOWtwUpixbx6WzheMHSVINIcjAY9k65si1eP+DIL++4YIiOeP6hNPxWEywsUoSerjJ4HGvNBWOI8JUwUrqGeRQXn29gAyUvEO1WiYR8bp1Suz9Ld6fXZxNzkQBcyKbj0bKlFLNjaf8+OD4eCRtPVocjkrvb6m/dnRYgCiKQgux91EUcNLS3Lj6nxj6XPyO0qETv5ycnp6Nx7eTL3+cfS4AQjYgu3yiudFr2IaNAV3dWONoKX9f6EIvW4p4N2zvp8rdYSji/1LIktUcZYXOv+ueESkgFwX0ZAoQvwpZsgZvyTygDoXeLbR1taadJbB9T5Jaf8v52F3n+0ku5DjmfI3zxuYqK0Z7pj1QlT9kTWKKVM4jzZ8h2SWmDdLcVMwq5fx5CPLlQfE8qRyLb8u8dikOkxiGb8ki8INj8rbQTMEo3Fdm9jw0u2+BtbxZAe9jDoUULO0ldsggwYUcUpIhS1Mph61cO/sQOJCxGFMdtI7jvDVc8BzEBX8WFS5QGdugpr6sYxqTo846Q6Y0KuSjUceuQt6xSsMLb6etJ9MsXWSwkK7m7uf7ThTd8HuFU9kq6mFCBqjbhsu8X/IjVvmm/4+TyaUY/IQMGM2mv4HvC3Dj1K/4G893YZw4v2QnzGXTydZQ9fbxdIjDftmzxtxtE8nYuTq4i5r5YFwj2d+nvybQ/zmw2NNXGDpuJB0yNr51OHXo5z/rJGRQ66lJdDbQtxadRw4L1cRNfX2LtZPOLQ5TSDw1Mo6S/l/ov9S6ccswVQgfaWSVrDV7izrqehlfg7Q1X3kIGaxLGTLI7QMnPWX1GrruTnq8cioE3v7eouP5cLMSVtR7VccRW0E+lcrjC0zDrISdr/3P3K5YBW4Ta78p9VPUr2p5BRk84FP6Iww3rLvYOeLt6cNJWWLsaEuTF1OZBTOUdmpEkIFsab4WtyGp/QtfsBVR16UTqRuFAWBs0owxhH8BGwC6VQ== +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"; + + + + + + + + + + +Delete a CSS template + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.StatusCodes.json new file mode 100644 index 00000000000..641f0757a7b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Dashboard deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.api.mdx new file mode 100644 index 00000000000..64652a4c800 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboard.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-dashboard +title: "Delete a dashboard" +description: "Delete a dashboard" +sidebar_label: "Delete a dashboard" +hide_title: true +hide_table_of_contents: true +api: eJzFVttu3DYQ/RViUKA2KnvtNAUMBXlwHRtJaqRGdt0LLMPhSrMr2hLJkKONXUH/Xgyp1V68fUhf/CRpxJk5Z2Z4yBasdLJGQuchvWlBaUjBSiohAS1r5K8HSMDh10Y5LCAl12ACPi+xlpC2QE+WVylNOEcHXXfLq7012qPnBa+OjviRG02oiV+ltZXKJSmjR/feaLatAlpnLDpS0btG7+Uc1zJ5ckrPoeuSpcVM7zEn6BLAR1nbCjccVw5dAgX63CnLqSGFd9KXUyNdIQqskLDgGK+Pjl8W77WWDZXGqX+wSMVpQyVq6vOLoRE76Kw7RiY/vyyTC+OmqihQp+Jv04jC6B9JlHKBwqKrlffMiIyQeY7eCyqVFw69aVyOuwgO8SK71y/L7pMhMTONLlIxKTF0Bj1hMVAQhUEvtCGBj8rTLkZDjMDo1auXnjzrDLdCTisUPHX0lIo/ZKWKOH3onHG7eJyZpioC1T5C782pfnlpAfigCZ2WlfDoFugii1ScatFofLSYc9OCUZg8b9x/bK8LSbIaSpCAx7xxzJGF8/4bQXpzy+pHcs5iulIXD7cJPB7kpsBxgBe1tpJ6Dink158vIYFKTrFaffabIIW8cZU4+Eu8O788n5yLDEoim45GlcllVRpP6cnRyclIWjVaHI+KZc7RcQYiyzItxMF7kcFprwyh6Kn4FaVDJ344PTs7H4/vJr//dv4pA+iSAdbVE5VGrwEbDAM0VVvjaDn4PtOZXiq/eDuYD6O27jEU8V34k+hSoizQ+bftFosMUpFBzyQD8VOvI3dkHlB3md7PtHVK094S1aEnSY2/407sr5P9KBdyHFq9RnjDuOqH0Z45DzzlN6lIzJDyMnD8boZtpFkjlaZgSrHV2/zT5UKx3U4uxJdlR9tYhEmowZfo0fGDC/Im04zfVHhYmfl2XfbfAM/v1hkZuiekGIBDAhErpBB7C0m8M6TwnGVrHzquX9h6cfAbx+XdWSXYTn/Jv0WBC6yMrVFTv4lD92Kg1jpDJjdVl45GLYfq0pYns3sW7azxZOpliAQW0inWOt/rTgjD7wXOZFNRDxMSQN3UvKn7T36Ebb0Z//1kciWGOF0CjGYz3sD3GbhxVCf+x1cvYZz4cMVBmMtmkJ2l6v3D6i7cw5YKNWZtjSSDTrUwDdNyYVwtOd7HPyfQX+p4xuNfGPQ1kO4Sdr5zOHPoy/8bpEtA6ZmJdDbQNxadRy4LKWIJXzfx7MR1i+NYEk+1DAdHf03dOacbKYYDhPCRRraSKtwjwhC1/QDfgLSK8x2z91qk1D5wu2M/b6Btp9Ljtau6js1fG3R8DtyuRipMeqHCUVpAOpOVx2eAhjMR9j73F7t9sSrZJtDeKPVTmNyq4S9I4AGf4jW9u+WJC2oRsscfp3mOQcKWLs9OXx6VYUdH8YEE+C65VrShnf0LJ9iJqG3jiqhA3QAwqDJj7Lp/AYj7Shw= +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"; + + + + + + + + + + +Delete a dashboard + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.ParamsDetails.json new file mode 100644 index 00000000000..74d702d0d05 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.StatusCodes.json new file mode 100644 index 00000000000..e0fd53d13ce --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Successfully removed the configuration"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.api.mdx new file mode 100644 index 00000000000..b75851f1f18 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-embedded-configuration.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-dashboards-embedded-configuration +title: "Delete a dashboard's embedded configuration" +description: "Delete a dashboard's embedded configuration" +sidebar_label: "Delete a dashboard's embedded configuration" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYUATTImTYQMCFf2QJSnaLuiC2kEHRIZLS2dLKUWq5MmNJ+i/D0dK8ku8AcuXfhJF8o7Pc/fwjg1U0soSCa2D+KGBDF1qi4oKoyGGSY4iky6fG2kzUWTCWOFUvYQICl6vJOUQgZYlQgxFNjN21q1b/FYXFjOIydYYgUtzLCXEDdC64t2ObKGX0LZT3uwqox06Xv/l7Iw/qdGEmngoq0oVqWRQo0fHyJotf5U1FVoqgnWJzsklHjoo6mfM/BFTgjYCfJJlpXDHcGPQRnvxGNdpis4taqXWwmJpVpgJylGkRi+KZW09Rnb869n5jyVxr2VNubHF35jF4rKmHDV154shOQc4bhuy999+dDrea0KrpRIO7QqtQGuNjcWlFrXGpwpTwixMCpOmtf0XXm8lSRX2+cMdprUtaO1l//idIH6YshZJLvkqwHWvewfTCJ5OUpPh2MMLN0VJvYQY0vtPtxCBknNUm19napsy+LS2Spz8Ja5vbm8mNyKBnKiKRyNlUqly4yi+OLu4GMmqGK3OR8NdG52PsJxjlmGWgEiSRAtx8k4kcNnlxkc/Fr+jtGjFT5dXVzfj8Wzy5x83HxOANhrw3a0pN3oL4TAxYCzKyljyokBHLtGJ7i+keDNMn2aokPCIoYiXEYmCbY4yQ+veNHt0EohFAh2lBMTPQvrrNiPzFXWb6ONEV7bQdNTDO3UkqXYzzs3xNusPciXHPvlbzHcmNxky2jH5gbD8LgsSC6Q092RfTrUJfEuk3GTMLahgPxBxv1HsJ5gj8qXPcROiMfHB+BIsWv5wZF4nmokYhafKLPcDdPwaWNq7F+La51PITYV/5UTPYK+iRRBIQAxBBhCF4h/D8zg0m0bQDiHhkPv7G25PbTkjBwML+0BveVlkuEJlqhI1dZXAJzw4aipryKRGtfFo1LCrNm5Y1e0zb1e1I1P2LiJYSVvIuQrlqnfD4wwXslbUwYQIUNclV4bulz++Nuz6fzeZ3InBTxsBo9n1N/B9Bm4cShyvcVPlfvv+jp0wl10nB0PV2fvdrW+tfZkbc4EOJH2xa2DudfXW2FKyvw+fJ9C1ab4WYRWGIu1JtxEbzywuLLr8pU5afj0sTKCz214rtA45LFQQ94HtKdZO2Lc6DyFxVErffboHyP9T9M7ZQ3sifKJRpWTh27hXV9NJ/QFkVTCQc7buj4AI4p2Xz6D4aZ/7B2iauXR4b1Xb8vS3Gi03nulGfuH1VTgeZxAvpHL4DOPQhOHoU9fCj8V/PNIOcuompV579aua/yCCr7jefcS1U1avr1EeXdhwmaboK2hv+uw5wLIbykUoeRABvyq24jxIoxvwAQeRNU3YEepeOwD1TYExtu0/kp21Mw== +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"; + + + + + + + + + + +Delete a dashboard's embedded configuration + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.ParamsDetails.json new file mode 100644 index 00000000000..6cee950ed81 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The value key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.StatusCodes.json new file mode 100644 index 00000000000..6c4a32ce88d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"description":"The result of the operation","type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Deleted the stored value."},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.api.mdx new file mode 100644 index 00000000000..ebacbb523c3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dashboards-filter-state-value.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-dashboards-filter-state-value +title: "Delete a dashboard's filter state value" +description: "Delete a dashboard's filter state value" +sidebar_label: "Delete a dashboard's filter state value" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zgM/isEccC1OLdpix1QeNiHri9Yd8VWLOndAXXQKTYTu1UkT5Kz5gz/9wMlx3k9YOgN6Jc4kkXyeUiKpGsshRFTcmQsxvc1FgpjLIXLMUIlpsSrJ4zQ0LeqMJRh7ExFEdo0p6nAuEY3L/lUoRxNyGDTRDVmZFNTlK7QrG6QE8yErAieaH6I0S4jTzT/ESvWmUJNsGmGfNiWWlmy/P7k6IgfqVaOlOO/oixlkQrG0Hu0DKRe0VcaXZJxRZCekrViQvx3G7ohW0kHegwuJ2AxrxSjLVDdjh49UuqwiZCexbSUtGZkKdBEG/YuSJKjzFuyThvKgucOWdebn8Xxpbjfiww4RGRdDNdqJmSRwTKBoDR6VmSU7WK2Ihu4HL8ulzslKpdrU/xDWQxnlctJudY+dHm4g8iqYGDy5nWZfNIOxrpSWQwhXb2Tid1tdWVSgkyTBaUd0HPB7t8m1enwjE5OXjs2pdEpL0eSgOPi5jH8yekW4kPGaLOLx7muZOapthpaaTb1+2tfn2vlyCghwZKZkQksYjhTUCl6LinloPlN0Glamf9IwCvhhOxcEKGltDLMkev343eH8f2Q66MTE67peCFsPtLCZHBVSEcG+k44wmGEzwepzqjvoYbyL4WaYIzp3ZcbjFCKEcnlMmQTrysj4eBvuLi8uRxcQoK5c2Xc60mdCplr6+LTo9PTniiL3uy4ly3s9457Y4/gwTKCXv1E8yZBSJJEARx8gATP2qvlYxLDexKGDPxydn5+2e8/DD7/cfkpQeQW0yK9nbvc1+IF1m6jQ1tMS23c4l7YRCVq0TrgXbd9mPnSu8dQ4P9SioKWnERGxr6rN4glGEOCLbkE4TcQKSfrg9NPpJpE7SeqNIVyewugh6y+sg8cr/1V/h/FTPR9cqz4YG1zGTWtLLuhoy6+i8LBmFyae9o/g3QdmE/J5TpjliFHNl0SLw7CZtDZN18Xca+DXwbeLV+DRMMP9tHbRDElLelQ6smmq/bfIl+CXe0VBHRcfrUQuIDnErotRhgIYIwhLTAK80qM296oy6dmh0PY9f6eh5tVGY7MTgfjJswbfg0ZzUjqckrKtRXDBz4oqkujnU61bOJer2ZVTVxznjdb2s4r6/R0oSLCmTAFF1bbFjmvJow+Y1FJ18LECElVU64g7ZIfFrec+mEwuIVOTxMho1nX1/HdAtcPpZDf8SQI2sD1LSthLutKdrqqlfenGz8WLsphnwt5IOmLYo0jn1VX2kwF6/v41wDbEZOvR3i7nOo86SZi4QdDY0M2f6mShkfesd4eL/tVScYSu8UVjvvF6hbnTjg3Ow4usW4qfJdqp+Yfz+c1u10Lc/TseqUUhWL9PrPqNtHvUZQFgzhm6YV6jDD23wOr+c6bPL8PF6G/x7oeCUt3RjYNb3+ryHB/Gi6zz1+KrPAtPsN4LKSlLZhdr8a9L+1Itg9L767DbzeFmvskZ94xYuQ/LfxXjP8yeYnFrQ+YF9jn32bIt8NXQE8/vDlLU/KVeiGzNZZwWncFKRRUjJDH0JVYdqnX/mEDOyHVdTgRqmrTIfTNhzE2zb/pfNxD +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"; + + + + + + + + + + +Delete a dashboard's filter state value + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.StatusCodes.json new file mode 100644 index 00000000000..a7c0ba507c6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Database deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.api.mdx new file mode 100644 index 00000000000..76963cb96e3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-database.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-database +title: "Delete a database" +description: "Delete a database" +sidebar_label: "Delete a database" +hide_title: true +hide_table_of_contents: true +api: eJzFVttu3DYQ/RViUKA2KnvtNAUMBXlwHRtJaqRGdt0LLMPhSrMWbYlkyNHGrqB/L4bUaq99SF/8JGnEmTlnZnjIFqx0skZC5yG9aUFpSMFKKiEBLWvkr0dIwOHXRjksICXXYAI+L7GWkLZAz5ZXKU14jw667pZXe2u0R88LXh0d8SM3mlATv0prK5VLUkaPHrzRbFsGtM5YdKSid43ey3tcyeTJKX0PXZcsLGb6gDlBlwA+ydpWuOa4dOgSKNDnTllODSm8kySn0qMosELCgkO8Pjp+WbjXWjZUGqf+wSIVpw2VqKnPL4Y+7GCz6hiZ/PyyTC6Mm6qiQJ2Kv00jCqN/JFHKOQqLrlbeMyMyQuY5ei+oVF449KZxOe4iOMSL7F6/LLtPhsTMNLpIxaTE0Bn0hMVAQRQGvdCGBD4pT7sYDTECo1evXnryrDPcCjmtUPDU0XMq/pCVKuL0oXPG7eJxZpqqCFT7CL03p/rlpff/B03otKyERzdHF1mk4lSLRuOTxZybFozC5Hnj/mN7XUiS1VCCBDzmjWOOrJsP3wjSm1sWP5L3rKWDuMBtAk8HuSlwHMBFoa2kvocU8uvPl5BAJadYLT/7LZBC3rhKHPwl3p1fnk/ORQYlkU1Ho8rksiqNp/Tk6ORkJK0azY9HRZ9xdJyByLJMC3HwXmRw2stCqHgqfkXp0IkfTs/Ozsfju8nvv51/ygC6ZEB19Uyl0Su4BsOATNXWOFpMvc90pheqL94O5sMorHsMRXwP/CR6lCgLdP5tu0Eig1Rk0BPJQPzUa8gdmUfUXab3M22d0rS3AHXoSVLj77gP+6tcP8q5HIc2r/BdMy67YbRnygNN+U0qEjOkvAwUv5dgG1nWSKUpmFHs8yb9dLFQbDaT6/Bl0c821mASSvAlenT84Hq8yTTDNxUeVuZ+syz7b4BHd+N0DL0TUixwQwIRKqQQGwtJvCyksMWxtY8dFy/suTjzjePa7iwRbCa/5N+iwDlWxtaoqd+9oXUxUGudIZObqktHo5ZDdWnLU9ltRTtrPJl6ESKBuXSKRc73ghPC8HuBM9lU1MOEBFA3Ne/m/pMfHrZK9X4yuRJDnC4BRrMeb+C7BW4cZYn/8ZVLGCc+XHEQ5rIeZGepev+wugv3r4U0jVlUI8kgUC1Mw6xcGFdLjvfxzwn0lzke8PgXBmENpLuEne8czhz68v8G6RJQemYinTX0jUXnkctCili7V008O3Hd/DiWxFMtw4nRX093TelahuHgIHyika2kCveHMENtP743IK3idMfsvQyU2kduduzmDbQt269d1XVs/tqgY/m/XQ5UmPNChRO0gHQmK49beIajEPY+9/e5fbEs2DrO3ij1c5jbquEvSOARn+PlvLvleQtKEbLHH6d5jkG9Fi5bhy4PyrCdo/BAAnyFXKnZ0Mz+hRPsRNS2cUVUn24AGASZMXbdv7guRZ4= +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"; + + + + + + + + + + +Delete a database + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.ParamsDetails.json new file mode 100644 index 00000000000..48b355eb663 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The dataset pk for this column","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The column id for this dataset","in":"path","name":"column_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.StatusCodes.json new file mode 100644 index 00000000000..2906336fe36 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Column deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.api.mdx new file mode 100644 index 00000000000..f60f4611146 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-column.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-dataset-column +title: "Delete a dataset column" +description: "Delete a dataset column" +sidebar_label: "Delete a dataset column" +hide_title: true +hide_table_of_contents: true +api: eJzFV9tu3DYQ/RViUKA2KnttNwUMBXlwfUGSGomRXfcCa+FwpdkVbYlUyNHGrqB/L4bUai/etKjz4CdJFDlzzszwcNhAJa0skdA6iG8ayNClVlWkjIYYRjmKTJJ0SKK6F1NjBeXKidQUdakhAsWzKkk5RKBlifx1DxFY/FIrixnEZGuMwKU5lhLiBuix4llKE87QQttG25wGB0JlS58dju1Ow/xblf0/32Oe7SqjHTqecHRwwI/UaEJN/CqrqlCpZGiDO8f4mhWDlTUVWlJhdYnOyRmueHJklZ4xycWImdxhStBGgA+yrApcW7hc0EYbUTkNEcmwQMKMDbw6OHxZsNda1pQbq/7GLBYnNeWoqfMv+ixs4bK6MDD5+WWZXBg7UVmGOhZ/mVpkRv9IIpdzFBXaUjnHjMgImaboXKhHi87UNsVtBHt7gd2rl2X3wZCYmlpnseC9xZlBR5j1FERm0AltSOCDcrSNUW/DMzo6eunKq6zhVMhJgYKrjh5j8bssVBaqD601dvs2qovMU+0sdKvZ1S8vvfvfaUKrZSEc2jnawCIWJ1rUGh8qTDlpflCYNK3tN7bXhSRZ9CGIwGFaW+bIAn/3lSC+GbP0kZyx6MNZUFYH4wge9lKT4dCDCydCIfWMFfb60yVEUMgJFsvPbgvEkNa2EHt/irPzy/PRuUggJ6riwaAwqSxy4yg+Pjg+HshKDeaHg07LB4eDINyDphfwNgGRJIkWYu+tSOCkEwqfg1j8itKiFT+cnJ6eD4e3o4+/nX9IAPgQ6XBePVJu9ArSfqDHqsrKWFrsA5foRC9OAfGmH94PUrvDUMT3EYqCjRxlhta9aTZoJRCLBDpqCYifOp25JXOPuk30bqIrqzTtLGDuO5JUu1vO1e4q+/dyLoe+FFYisDa4zJjRjoPQE5dfpSIxRUpzT/r7KTeBd4mUm4w5hurYDEi8mCg2E86R+bzIeROiMvJB+RxWtPzgCL1ONBMyBe4XZrYZqN3XwAW/vk3OfH6F7DucvqsJgCGGUAIQhW4jhk3uTXXfbqHPYfY7OOyg2nIWtgYTNkFd8m+R4RwLU5WoqdMCn+RgqKmsIZOaoo0Hg4ZNtXHDFd0+sXZaOzLlwkQEc2kVS6br5Mub4fcMp7IuqIMJEaCuS9aG7pMfXh/W7b8dja5Eb6eNgNGs2+v5PgE3DCLH/7iLE8aKd1dshLmsG9kaqm69n936Xm4hdEOW6EDSy10DE19DF8aWku29/2MEXWPIWyH8hV6mPek24sW3FqcWXf5cIy23q1MT6Kyhryu0oZ8lRXwSrA5x7YR588MQEkel9OdP1/F+u3rX/PSHEeEDDapCKt+T+EpqurK+AVkpdnrIq/s2O/adfG82XvbY40Wib6BpJtLhtS3aloe/1Gj5nBkvay1cK5Q/qjOIp7Jw+ARkf+bCzqeucdwV/3n72EqtG5T60Rd8UfMXRHCPj+F24m8cz8XzrxeTZ+BZBrUd8/7xiuhDFv6fpCl63V6sfNKScOH3ghUEFiLgBnsl+31xdi/sYCuwpgkzgsq2PU5/FDHGtv0HoO7ntQ== +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"; + + + + + + + + + + +Delete a dataset column + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.ParamsDetails.json new file mode 100644 index 00000000000..1b32f1d0630 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The dataset pk for this column","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The metric id for this dataset","in":"path","name":"metric_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.StatusCodes.json new file mode 100644 index 00000000000..237298dbe6e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Metric deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.api.mdx new file mode 100644 index 00000000000..8f99df07529 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset-metric.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-dataset-metric +title: "Delete a dataset metric" +description: "Delete a dataset metric" +sidebar_label: "Delete a dataset metric" +hide_title: true +hide_table_of_contents: true +api: eJzFV9tu3DYQ/RViUKA2KnttNwUMBXlwfUGSuqmRXfcCa+FwpdkVbYlUyNHGrqB/L4bUai/etKjz4CdJFDk8Z2Z4ZthAJa0skdA6iG8ayNClVlWkjIYYRjmKTJJ0SKK6F1NjBeXKidQUdakhAsWzKkk5RKBlifx1DxFY/FwrixnEZGuMwKU5lhLiBuix4llKE87QQttG2zYtkaxKhcqWe3Y4tm8a5t+q7P/tPebZrjLaoeMJRwcH/EiNJtTEr7KqCpVKhja4c4yvWTFYWVOhJRVWl+icnOHKTo6s0jMmuRgxkztMCdoI8EGWVYFrC5cL2mjDK78Gj2RYIGHGBl4dHL4s2Gsta8qNVX9jFouTmnLU1O0v+ihs4bK6MDD58WWZXBg7UVmGOhZ/mVpkRn9PIpdzFBXaUjnHjMgImaboXMhHi87UNsVtBHt7gd2rl2X3wZCYmlpnseCzxZFBR5j1FERm0AltSOCDcrSNUW/DMzo6eunMq6zhUMhJgYKzjh5j8bssVBayD601dhuPU1MXmafaWehW81Y/vfTpf6cJrZaFcGjnaAOLWJxoUWt8qDDloPlBYdK0tl85XheSZNG7IAKHaW2ZIwv83ReC+GbM0kdyxqIPZ0FZHYwjeNhLTYZDDy5UhELqGcSQXn+8hAgKOcFi+dkdgRjS2hZi709xdn55PjoXCeREVTwYFCaVRW4cxccHx8cDWanB/HDQafngcBCEe9D0At4mIJIk0ULsvRUJnHRC4WMQi59RWrTiu5PT0/Ph8Hb02y/nHxIALiIdzqtHyo1eQdoP9FhVWRlLi3PgEp3oRRUQb/rh/SC1OwxFfBuhKNjIUWZo3Ztmg1YCsUigo5aA+KHTmVsy96jbRO8murJK084C5r4jSbW75VjtrrJ/L+dy6FNhxQNrg8uIGe3YCT1x+UUqElOkNPekv51yE3iXSLnJmGPIjk2HxIuJYjPg7JlPi5g3wSsj75RPYUXLD/bQ60QzIVPgfmFmm47afQ2c8OvH5MzHV8i+wwn4IYIAGGIIKQBR6DZi2OTeVPftFvrsZn+CwwmqLUdhqzNhE9Ql/xYZzrEwVYmaOi3wQQ6GmsoaMqkp2ngwaNhUGzec0e0Ta6e1I1MuTEQwl1axZLpOvrwZfs9wKuuCOpgQAeq6ZG3oPvnh9WHd/tvR6Er0dtoIGM26vZ7vE3DDIHL8j7s4Yax4d8VGmMu6ka2u6tb72a3v5RZCN2SJDiS93DUw8Tl0YWwp2d77P0bQNYZ8FMJf6GXak24jXnxrcWrR5c810nK7OjWBzhr6ukIb+llSxJVgdYhzJ8ybHwaXOCqlrz9dx/v17F3bpy9GhA80qAqpfE/iM6np0voGZKV400Ne3bfZse/ke7PxssceLwJ9A00zkQ6vbdG2PPy5Rst1ZrzMtXCtUL5UZxBPZeHwCci+5sLOx65x3BX/efvYSq0blPrRJ3xR8xdEcI+P4XbibxzPxfOvF5Nn4Fk6tR3z+fGK6F0W/p+kKXrdXqx80pJw4veCFQQWIuAGeyX6fXJ2L7zBVmBNE2YElW17nL4UMca2/QeYWOcL +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"; + + + + + + + + + + +Delete a dataset metric + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.StatusCodes.json new file mode 100644 index 00000000000..e3987fc23f7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Dataset 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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.api.mdx new file mode 100644 index 00000000000..ca74144b9ae --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-dataset.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-dataset +title: "Delete a dataset" +description: "Delete a dataset" +sidebar_label: "Delete a dataset" +hide_title: true +hide_table_of_contents: true +api: eJzFVttu3DYQ/RViUKA2KnvtNAUMBnlwHRtJaqRGdt0LLMPhSrMr2RLJkKONXUH/Xgyp1V68fUhf/CRpxJk5Z2Z4yBascqpGQudB3rRQapBgFRWQgFY18tcDJODwa1M6zEGSazABnxVYK5At0JPlVaUmnKODrrvl1d4a7dHzgldHR/zIjCbUxK/K2qrMFJVGj+690WxbBbTOWHRURu8avVdzXMvkyZV6Dl2XLC1meo8ZQZcAPqraVrjhuHLoEsjRZ660nBokvFOkPJLIsUJCDvD66PhlwV5r1VBhXPkP5lKcNlSgpj6/GLqwg8u6Y2Ty88syuTBuWuY5ain+No3Ijf6RRKEWKCy6uvSeGZERKsvQe0FF6YVDbxqX4S6CQ7zI7vXLsvtkSMxMo3MpJgWGzqAnzAcKIjfohTYk8LH0tIvRECMwevXqpSfPOsOtUNMKBU8dPUnxh6rKPE4fOmfcLh5npqnyQLWP0Htzql9eevd/0IROq0p4dAt0kYUUp1o0Gh8tZty0YBQmyxr3H9vrQpGqhhIk4DFrHHNk1bz/RiBvbln6SM1ZSZfS4uE2gceDzOQ4DuCizFZKz0FCdv35EhKo1BSr1We/BSRkjavEwV/i3fnl+eRcpFAQWTkaVSZTVWE8yZOjk5ORsuVocTzKY8bRcQoiTVMtxMF7kcJprwqh4FL8isqhEz+cnp2dj8d3k99/O/+UAnTJAOrqiQqj12ANhgFYWVvjaDn0PtWpXkq+eDuYD6Os7jEU8R3ok+hQoMrR+bftFocUpEih55GC+KlXkDsyD6i7VO+n2rpS094S06EnRY2/4y7sr1P9qBZqHJq8RnfDuOqF0Z4ZDyzVN1WSmCFlRWD4nfzaSLJGKkzOhGKTt9nL5UKx3Uouw5dlN9tYgkmowJfo0fGDy/Em1YzeVHhYmfl2VfbfAM/t1sEYOieU6GFDAhEpSOgPyyReEyRsM2ztQ8eVC9stjnvjuLA76wPbqS/5t8hxgZWxNWrqN27oWwzUWmfIZKbq5GjUcqhOtjyR3bNoZ40nUy9DJLBQrmR9873WhDD8nuNMNRX1MCEB1E3NG7n/5EfYzJvx308mV2KI0yXAaDbjDXyfgRtHReJ/fNcSxokPVxyEuWwG2Vmq3j+s7sLFa6lKY9bTSDJoUwvTMCkXxtWK4338cwL9LY6nO/6FQVMD6S5h5zuHM4e++L9BugRKPTORzgb6xqKLs0UlsWyvm3h24rrFcSyJp1qFw6K/l+6Y0Y0Ew5FB+EgjW6ky3BzCCLX98N6AsiVnO2bvIY60D9zq2MsbaNup8njtqq5j89cGHev+7WqcwpTnZTg6c5AzVXl8Bmc4A2Hvc3+R2xercm3C7I1KP4WprRr+ggQe8CneybtbnragEiF7/HGaZRiEa+ny7LTlMRn2chQdSIDvjmslG1rZv3CCnYjaNq6IytMNAIMWM8au+xf/lkLm +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"; + + + + + + + + + + +Delete a dataset + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.ParamsDetails.json new file mode 100644 index 00000000000..3bd4599a740 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The form_data key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.StatusCodes.json new file mode 100644 index 00000000000..e52f3adc900 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"description":"The result of the operation","type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Deleted the stored form_data."},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.api.mdx new file mode 100644 index 00000000000..40dae9e6994 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-form-data.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-form-data +title: "Delete a form_data" +description: "Delete a form_data" +sidebar_label: "Delete a form_data" +hide_title: true +hide_table_of_contents: true +api: eJzFV1Fv2zYQ/ivEYQ8JpsRJ0AGBij6kiYumC7qgdtYCkZEy0jlSQpEqeXLtCfrvw5Gy7NgeBmQD8iSJ5B3vu/v48dRAJa0skdA6iG8byNCltqioMBpiGOcopsaWd5kkKZ5wcQgRFDxTScohAi1LhBiecAERWPxRFxYziMnWGIFLcywlxA3QouJljmyhH6BtJ7zYVUY7dDx/cnTEj9RoQk38KqtKFankOAaPjoNp1vxV1lRoqQjWJTonH5Bft8O36GpFwkwF5SjYzDuFaCuofsTcP2JK0EaAc1lWCp9tsjJoo439LlAhYeZ3cmQsZqvsHbK/N/8XzpfG/l5mgsuEjmJxqWdSFZlYUUBU1syKDLNd6NZsA5bj18Vyo2VNubHFX5jF4qymHDV1+4ueizuArBsGJG9eF8lnQ2Jqap3FIlDWJxk53c7UNkWRGXRCGxI4Lzj926B6Hx7Ryclr16ayJuXPe4WC60KLWPzJdAv1QWuN3YXj3NQq81A7D501b/Xbax+fS01otVTCoZ2hDShicaZFrXFeYcpF84PCpGlt/4GAHyRJ1acgAodpbRkjK/DjT4L4dsIaSfKBVRmG80oZi+KDsaW4kCRhEsH8IDUZjnyUQbuV1A8QQ3rz5QoiUPIe1eozEIm/a6vEwTdxMbwajocigZyoigcDZVKpcuMoPj06PR3IqhjMjgcYth70OjZonnDRJiCSJNFCHHwUCZx1x8nXIRbvUVq04pez8/PhaHQ3/uP34ecEoI36EK8XlHsNXgbZD/RhFmVlLC3Pgkt0opdXhnjXDx9mXnL3OBTxYixRMM9RZmjdu2YDUQKxSKBDlYD4VciUmXlH5gl1m+j9RFe20LS3jPDQkaTa3XGF9teBf5IzOfJMWAP/bHBVJ6Md4+8xy5+yIDFFSnOP9z+hbQLkEik3GcMLdNjMRbxcKDbLzEn5vqx0ExIy9vn4HixafnBy3iaasRiFh8o8bOZo/y0w1XddpEKurk+IIMQKMYSaQxSakBj+BTEn1R/XcEpqyznfmTrYjOOKp0WGM1SmKlFTd/B9SYOjprKGTGpUGw8GDbtq44ap2255O68dmXLpIoKZtAXro+u0yrsJXcxU1oq6MCEC1HXJQtB98sPBVtY+jsfXovfTRsDRPPfX490KbhQUjee4qRPGistrdsJYnjvZmarO3q9ufYe3VLUR63EA6bWtgXtPG1Yzyf4+fR1D1y0y8cPsqkHzoNuIje8sTi26/KVOWu5ep2a7UxzVFVqHnBYqiGV/fYi5E9bNjkNKHJXSXzZdA7yTsM+26C8dwjkNKiULza48iZqOybcgq4L3O+aaBzZDBOs+Y261J8vS3kLT3EuHN1a1LQ//qNHyNTJZsSu09YW/iTOIp1I53Iqtv1Jh70vXOe2Lnd3/ThTdoNQLT2tV8xdE/r8g/B20E+ajFxUfUJg5S1P0qre02brPmUj9wQ8aBRFw/7aW0r7Y3QtvsDOkpgkrglC1fYReyDnGtv0bHDaEQw== +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"; + + + + + + + + + + +Delete a form_data + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.ParamsDetails.json new file mode 100644 index 00000000000..f57c10b0276 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The report schedule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.StatusCodes.json new file mode 100644 index 00000000000..d7efdcde69b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.api.mdx new file mode 100644 index 00000000000..1defa7119a7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-report-schedule.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-report-schedule +title: "Delete a report schedule" +description: "Delete a report schedule" +sidebar_label: "Delete a report schedule" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1P5DYQ/ivWqFJBDSzQq4Ryug+U43Rc0R1il76IIM6bzBJDYht7sgeN8t+rsbNhd9lWbb/wKfHLjJ9nZvx4WrDSyRoJnYf0qoUCfe6UJWU0pDApUTi0xpHweYlFU6Gw95CA4lUrqYQEtKyRRzzv8KFRDgtIyTWYAFvVEtIW6MnyLqUJb9FB113zbm+N9uh5w8HeHn9yowk18a+0tlK5ZCyjO8+A2iWH1hmLjlS0rtF7eYtLJ3lySt9C1yWLGTO9w5ygSwAfZW0rXDF8NuiStTCcEtaiwAoJCzZ/s/fj60L9YNxUFQXqVPxhGlEY/T2JUs5RWHS18l4ZLcgImefovaBSeeHQm8bluIng4C+ye/O67D4bEjPT6CIVsQAfGvSExUBBFAa90IYEPipPmxgNPgKjg4PXZXSprTOcCjmtUKAmRU+p+FVWqggYBDpn3CYex6apikC199Bb81E/vfaNOdWETstKeHRzdJFFKo60aDQ+Wsw5aWFSmDxvHAvDpuqTJKshBAl4zBvHHFmQ7r4RpFfXLBckb1mk4CIq0rhXJA/XCTzu5KbAcQAZlayS+hZSyC8vziCBSk6xeh72VyGFvHGV2PldvD85O5mciAxKIpuORpXJZVUaT+nh3uHhSFo1mu+PohaO9jMQWZZpIXY+igyOGiqNU3+GuKfiZ5QOnfju6Pj4ZDy+mXz55eRzBtAlA6bzJyqNXkI1TAy4VB049rXvM53phVqKd8P0bhSlLYYi/j34JO4vURbo/Lt2jUIGqcigp5GB+KHXkRsy96i7TG9n2jqlaWsBadeTpMbfcA62l5l+knM5DqleYrsy+ZwJoz0THkjKb1KRmCHlZSD43+i1kWONVJqC+cQMr5NPFxvFeiI5Cl8XuWxjBCYhAF+jRccfjsbbTDN4U+FuZW7Xg7L9Frh4V0v+fcibkOuvKyQQEUMKMbeQxHc2hTWirb3vOH7h6sWSbxyHd2OUYB3BGS+LAudYGVujpv4Sh+xFR611hkxuqi4djVp21aUtn9298HbceDL1wkUCc+kUa53vdSe44f8CZ7KpqIcJCaBuar7U/ZA/4UKv+v84mZyLwU+XAKNZ9TfwfQFuHNWJ17hXEcaJ03N2wlxWnWwMVW8fdnehcVkoFEtQHUkGnWphGgrmg3G1ZH+ffptA3wVxjcdVGPQ1kO4SNr5xOHPoy//rpOOmbGYinRX0jUXnkcNCiljCl6e4duK++X4Miadahoej7+v+oVRXDhqeEcJHGtlKqtBNhFJq+xq+AmkVn7ofesUQ0QRSe88Zjym9gradSo+Xruo6nn5o0PFTcP1cVbFTVeE1LSCdycrjCzTDswhbF31Xui3+tqHdiL2flPoplHTV8AgSuMen2PB211yKQUkCprhwlOcYtG1h8uJZ5hoa7nkUJkhANlQuxXHIc//DB2xE1LZxR1SnbgAY5Joxdt1fEKcXvg== +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"; + + + + + + + + + + +Delete a report schedule + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.api.mdx new file mode 100644 index 00000000000..a8a2d1eba97 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-saved-query.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-saved-query +title: "Delete a saved query" +description: "Delete a saved query" +sidebar_label: "Delete a saved query" +hide_title: true +hide_table_of_contents: true +api: eJzFVlFv2zYQ/ivEYQ8JpsRJ0AGBij5kaYqmC7qsdrYBUZAy0tlSIpEseXLtCfzvw5GybCfew/qSJ4kn3vH77r47qgMjrWyQ0DpIbzuoFKRgJJWQgJIN8uoJErD4ra0sFpCSbTEBl5fYSEg7oKXhXZUinKEF7+94tzNaOXS84eToiB+5VoSK+FUaU1e5pEqr0aPTim3rgMZqg5aq6N2gc3KGGyc5spWagffJyqIfHjEn8AngQjamxi3HtYNPoECX28rw0ZDCJWEjCqyRsGD3N0dvXhfqZ01iqltVpGJSouCsoyMshEWnW5ujKDQ6oTQJXFSOdpEaYgRGJyevy+hGGatzXj7UKFBRRctU/CnrqggYBFqr7S4e57qti0C1j9B781G/vLamLhWhVbIWDu0cbWSRijMlWoULgzkXLRiFzvPWcuvs4PhBkqyHFCTgMG8tc+RefPxOkN7ecUORnHF/wh8tWiZxl8DiINcFjgO22Lu1VDNIIb/5cgUJ1PIB6/UyyofXra3Fwd/i/cXVxeRCZFASmXQ0qnUu61I7Sk+PTk9H0lSj+fHIyTkW999atMvRcQYiyzIlxMFHkcFZS6W21T8h56n4FaVFK346Oz+/GI/vJ7//dvE5A/DJAOx6SaVWG9AGwwCuaoy2tNK9y1SmVrNEvBvMh7Fl9xiK+J8MkuhUoizQunfdMx4ZpCKDnksG4mchc9bePeknVD5T+5kytlK0t8J16EhS6+65GvubdD/JuRyHWm9Q3jKua6KVY9YDU/ldViSmSHkZWP4Axy4SbZBKXTCpWPDnGUhXG8XzknIqvq6q2sU0TEIWvkYPzw9OydtMMQNd42GtZ88zs/8WWMLbwn8fKiikCNBFgA4JRLSQQqwwJPEuSmEX0848ec5i6MDYAq3lJO/MFTyHcMWfRYFzrLVpUFHfy6GGMVBnrCad69qno1HHoXzasUL9i2jnrSPdrEIkMJe24pHn+vETwvB7gVPZ1tTDhARQtQ33dr/kR2jw7fgfJ5NrMcTxCTCa7XgD3xfgxnFI8Te+1IW24vKagzCX7SA7U9X7h90+3PCrQTXmERtJhnHVwUNQzAdtG8nxPv01gf53gZUev8IwZgNpn7DzvcWpRVf+aBCfQKWmOtLZQt8atA45LVQRT/JNE2sn7psfx5Q4amS4P/ofoP/Q6tYhw01CuKCRqWWlOFiQUdeL+BakqfjEYyazFjIkkJonLnms6S103YN0eGNr79kcd6W3d2tZBbUXVbhVC0insnb4AtJwPcLel/7/bV+s07YNtTdKtQzqrVteQQJPuIw/gf6OVRemRjg9fjjLcwzDbOXy4iJmuQx9HYcQJCBbKjfSNpS0f+EDdiLqurgjTiI/AAzzmTF6/y+f5La3 +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"; + + + + + + + + + + +Delete a saved query + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.StatusCodes.json new file mode 100644 index 00000000000..8463d859dd3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"SSH Tunnel deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.api.mdx new file mode 100644 index 00000000000..8d055e9827d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-ssh-tunnel.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-ssh-tunnel +title: "Delete a SSH tunnel" +description: "Delete a SSH tunnel" +sidebar_label: "Delete a SSH tunnel" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYcASTImTrgMCFf2Q5QVpF3RB7ewFUZDS0jliQpEqeXKTCfrvw5GybMfel+5DPkk68Y7Pc3d8eC3U0skKCZ2H9KYFZSCFWlIJCRhZIX89QgIOvzbKYQEpuQYT8HmJlYS0BXqueZUyhPfooOtuebWvrfHoecGbgwN+5NYQGuJXWdda5ZKUNaMHbw3blgFrZ2t0pKJ3hd7Le1zZyZNT5h66LllY7PQBc4IuAXySVa1xzXHp0CVQoM+dqnlrSGE8vhCTxhjUokCNhAUHeXtw+LqAr41sqLRO/YNFKo4bKtFQv78YKrGFz6pjZPLz6zI5t26qigJNKv62jSis+ZFEKecoanSV8p4ZkRUyz9F7QaXywqG3jctxG8EhXmT39nXZfbIkZrYxRSomJYbKoCcsBgqisOiFsSTwSXnaxmiIERi9efPanVc7y6WQU42Cu46eU/GH1KqI3YfOWbeNx4ltdBGo9hF6b97ql9dWgA+G0BmphUc3RxdZpOLYiMbgU405Fy0Yhc3zxv3H8TqXJPWQggQ85o1jjqycD98I0ptblj+S96ymcCpJTqVHuE3gaS+3BY4DuCi1Wpp7SCG//nwJCWg5Rb387I9ACnnjtNj7S5yeXZ5NzkQGJVGdjkba5lKX1lN6dHB0NJK1Gs0PR0W/4+hw5H15R0HbRhmILMuMEHsXIoPjXiJC9lPxK0qHTvxwfHJyNh7fTX7/7exTBtAlA8KrZyqtWcE4GAaUqqqto8UJ8JnJzOIOEO8H834U2R2GIr6XShK9S5QFOv++fUEog1Rk0JPKQPzUa8sd2Uc0XWZ2M1M7ZWhnAXDfk6TG33F9dld5f5RzOQ7lX+G+ZlxWyRrP9AfK8ptUJGZIeRno/h+ybWRcIZW2YHaxF16mIl0sFC+LzDn5sqhzG/MxCen4Ej06fnBu3mWGqViN+9rev0zR7jvg9l4/FKehpkIKvkwjcEgggoUUYskhiUNFChuM2/qxWyXNaQ2nNJ6SxnHWtyYPXkK55N+iwDlqW1doqD/voagxUFs7Sza3uktHo5ZDdWnLvdttRDtpPNlqESKBuXSKZdH3EhXC8HuBM9lo6mFCAmiais9//8kPDxuJu5hMrsQQp0uA0azHG/hugBtHIeN/PKYJ68SHKw7CXNaDbE1V7x9Wd2FmW4jZmGU4kgyS1sI0dM65dZXkeB//nEA/AHLrx78wSHEg3SXsfOdw5tCX3xukS0CZmY101tA3NTqPnBZSxGq/auLeievmhzElnioZ7ph+pN3es2t7DJcN4RONai1VmDlCF7V9M9+ArBVveMjeC7FPIA0j87KnIQEuf6zvDbQtr7t2uuvY/LVBx1fI7bLFQucXKtzCBaQzqT1u4BuuU9j53M+Eu2KZwnXcvVGa59DJuuEvSOARn+OI391yBwYlCbvHH8d5jkHpFi4bFze3znDYozBBAjyGruRwKG//whtsRdS2cUVUp24AGMSbMXbdv/hKXpI= +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"; + + + + + + + + + + +Delete a SSH tunnel + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.api.mdx new file mode 100644 index 00000000000..a7b878c777c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tag.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-tag +title: "Delete a tag" +description: "Delete a tag" +sidebar_label: "Delete a tag" +hide_title: true +hide_table_of_contents: true +api: eJzFVk1v3DYQ/SvEoAcblb22kQKGghxcx0GcBqmRXbcFLMOhpdld2RTJkKONXYH/vRhSq/3wHtpefJI44gzfm3kzVAdWOtkgofOQ33RQa8jBSppDBlo2yKtHyMDh97Z2WEFOrsUMfDnHRkLeAT1b3lVrwhk6COGWd3trtEfPG06OjvhRGk2oiV+ltaouJdVGjx680WxbBbTOWHRUJ+8GvZczXDvJk6v1DELIlhZz/4AlQcgAn2RjFW44rhxCBhX60tWWj4YcLgkbUaFCword3xy9eV2oXwyJqWl1lYvJHAVnHT1hJRx607oSRWXQC21I4FPtaRepIUZkdHLyuoyutXWm5OW9QoGaanrOxR9S1VXEINA543bxODetqiLVPkLvzUf98tqautSETkslPLoFusQiF2datBqfLJZctGgUpixbx62zg+MHSVINKcjAY9k65si9+PCDIL+55YYiOeP+hAk/bzN4OihNheMILDWuknoGOZTXXz9DBkreo1otk3Z43TolDv4S7y8+X0wuRAFzIpuPRsqUUs2Np/z06PR0JG09WhyPSM5GxwWIoii0EAcfRQFnLc2Nq/+Oic7FrygdOvHT2fn5xXh8N/n9t4svBUDIBkBXzzQ3eg3SYBhA1Y01jpZi94Uu9HKAiHeD+TD16R5DEf8SeZY2z1FW6Py7bgt/AbkooOdQgPhZyJKFdkfmEXUo9H6hras17S3xHHqS1Po7zv7+Os1PciHHsbBrVDeMqxoY7ZntwFD+kDWJKVI5j+z+A7cuEWyQ5qZiMqmw28zz5UaxXUJOwbdlFbtEfxLZf0segR+cireFZuRG4aEys+2M7L8F1ummut/HigkpSM4gg4QSckiVhCxdNDmsM+vsY+BsxbZK0m4dJ3NnTmD7yM/8WVS4QGVsg5r6Bo21SoE66wyZ0qiQj0Ydhwp5xwoML6Kdt55MswyRwUK6mueY72dKDMPvFU5lq6iHCRmgbhtu2H7Jj9i4m/E/TiZXYogTMmA0m/EGvi/AjdPk4W98UwvjxOUVB2Eum0F2pqr3j7tDvLaX02fMczORjDOog/uokA/GNZLjffpzAv0/ACs6fYVhdkbSIWPnO4dTh37+f4OEDGo9NYnOBvrWovPIaaGaeDyvm1g7ad/iOKXEUyPjpdD/1WxpcyP4cC0QPtHIKllrDhLl0/WivQFpaz7pGOJ4hgxy+8glTjW8ga67lx6vnQqBzd9bdDzXb1cyiuqu6ng1VpBPpfL4Aspwx8He1/4nbF+s0rQJsTdK/RzVqlpeQQaP+Jz+5MItqyxOhXh6+nBWlhiH1NLlxW3K8hj6Nw0ZyEC2NF9L11DC/oUP2Imo69KONGnCADDOXcYYwj8Sjp3y +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"; + + + + + + + + + + +Delete a tag + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.ParamsDetails.json new file mode 100644 index 00000000000..cff15ab98e6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"tag","required":true,"schema":{"type":"string"}},{"in":"path","name":"object_type","required":true,"schema":{"type":"integer"}},{"in":"path","name":"object_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.StatusCodes.json new file mode 100644 index 00000000000..4688364905b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Chart 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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.api.mdx new file mode 100644 index 00000000000..9eecc2fbd24 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-tagged-object.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-tagged-object +title: "Delete a tagged object" +description: "Delete a tagged object" +sidebar_label: "Delete a tagged object" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYcASTImTrgMCFv2QpQnaLuiC2tkLoiClpbPFVCJV8uQmE/TfhyNl2U5cbB2K5ZMsijze89zdc+cWauVUhYTOg7xqQRuQUCsqIAGjKgQJpOaQgMNPjXaYgyTXYAI+K7BSIFug+5q3eXLazKHrkq1W7PQWM7oJm/+FNW0I5+j+yZzOv87YNe/2tTUePW94dnDAj8waQkP8U9V1qTNF2prRrbeG11YGa2drdKTj6Qq9V3PcSsJyJToKXQJ4p6q6xI2DqwNdAjn6zOmarwYJJ4VyJHIskZCPPz84fFpXL41qqLBO/4W5FMcNFWiov18MMdiCZP1gRPLj0yI5s26q8xyNFH/aRuTWfE+iUAsUNbpKe8+IyAqVZei9oEJ74dDbxmW4DeBgL6J7/rTo3lkSM9uYXIpJgSEy6AnzAYLILXphLAm80562IRpsBETPnj115tXOcijUtETBWUf3UvymSp3H7EPnrNtaRLYp8wC1t9Cf5qt+euraf2MInVGl8OgW6CIKKY6NaAze1Zhx0MKisFnWuC+U15kiVQ4UJOAxaxxjZD2//Uwgr65Z+EjNWeNhws/rBO72MpvjODgWxb9UZg4Sssv355BAqaZYrl779JeQNa4Ue3+IV6fnp5NTkUJBVMvRqLSZKgvrSR4dHB2NVK1Hi8MRqfmoXRP/bnjTeTdqSc27UQoiTVMjxN5rkcJxLxYhDlL8jMqhE98dn5ycjsc3k19/OX2XAnBf6P29uKfCmjWPh4XBZ13V1tGyFnxqUrPsA+LlsLwf1XaHXRHfBlgSbRWocnT+ZfsAXgpSpNBDTEH80GvODdmPaLrU7KamdtrQztLdfU+KGn/DsdtdZ+GtWqhxSIs1JjYWVxG0xjMZAwHqs9IkZkhZEcB/O+htxF8hFTZnrDFrHhIjlxvFwwRghj4sc6CN7EwCOR/iiY4fzNSL1DAwW+J+aecPCdt9AVwEm6XzKsRbKEFqPsdc9AWbQPQXJPT9N4njh4SvoYApD5Udq6txHJGtxMJDx875s8hxgaWtKzTUa0QIeDTU1s6SzWzZydGoZVOdbDnLu0fWThpPtlqaSGChnGYp9b2sBTP8O8eZakrq3YQE0DQVa0b/yo+gHZv2X08mF2Kw0yXA3mzaG/A+cm4cxY+/8WwnrBNvLtgIY9k0spWq/nzY3YUJbymAY5buCDLIYAvTkEdn1lWK7b39fQL9uMhlEb/CIN8BdJfw4RuHM4e++K9GugS0mdkIZ8P7pkbnkWkhTdwh1pc4d+K+xWGkxFOlQl/q5+AvZvDGNUOPIryjUV0qHUaVkEhtn9pXoGrNdx5C0s/8cnNol+tDt4xbOBlitK+gbafK46Uru46XPzXouAldrxIu1EGuQx/PQc5U6fGRq0NDhp33/VS5K1aEbkLoF5W5D3ldNvwGCXzE+/6vC1fM/3jlOmVPc7XOobvmIgzSGiiP34+zDEMjWJ58NO9w9QzSF5UaEuDpfS2Hhgzvf/AFWx1r27gjynW3igq/s49d9zfXdP6F +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"; + + + + + + + + + + +Delete a tagged object + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.api.mdx new file mode 100644 index 00000000000..d13f4b88eec --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-an-rls.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-an-rls +title: "Delete an RLS" +description: "Delete an RLS" +sidebar_label: "Delete an RLS" +hide_title: true +hide_table_of_contents: true +api: eJzFVt1P5DYQ/1esUR9ADSygq4RyugfKcTqu6IrYpa1EEGeS2U3AsXP2ZIFG/t+rsbPZD7YvvPCUeOwZ/37z6Q4aaWWNhNZBetNBpSGFRlIJCWhZI68eIQGLP9vKYgEp2RYTcHmJtYS0A3pp+FSlCWdowftbPu0aox06PnB0cMCf3GhCTfwrm0ZVuaTK6NGDM5plS4ONNQ1aqqJ2jc7JGa7c5MhWegbeJwuJuX/AnMAngM+ybhSuKS4VfAIFutxWDV8NKZwT1qJAhYQFq384+PC+UL8bElPT6iIVkxIFex0dYSEsOtPaHEVh0AltSOBz5WgbqcFGYHR09L6MrnVjTc7Le4UCNVX0koq/pKqKgEGgtcZu43FqWlUEqr2FXpuv+u29c+pcE1otlXBo52gji1ScaNFqfG4w56AFoTB53lounS0cv0iSanBBAg7z1jJHrsWHJ4L05pYLiuSM6xOuzJO4wDkqMV6cvE3geS83BY4DzFjGSuoZpJBfX11AAkreo1ouYybxurVK7P0jPp9dnE3ORAYlUZOORsrkUpXGUXp8cHw8kk01mh+OrHlSfPUC4+gwA5FlmRZi76vI4KSl0tjq3xCDVPyO0qIVv5ycnp6Nx3eTP/84+54B+GRAd/lCpdEr+AbBgLCqG2NpUQcu05le9BbxaRDvxxLeYSjiLTSSqFmiLNC6T90GmQxSkUFPKAPxq5A5J+QdmUfUPtO7mW5spWlnAW7fkaTW3XFcdlc5f5NzOQ4JsMJ7TbiMjtGOqQ905ZOsSEyR8jJQfSvRLrKtkUpTMLMY/003pIuDYjO47I8fi/h20ReT4IofUcPzh/3yMdNMwyjcV2a26Z7dj8DJvV4Sn0MshdTi6mIMCUSYkEIMMiRxPKXwvzy75tGzI0NlxnpoLft5q7tgE8AFb4uCTZqmRk19jYcwRkNdYw2Z3CifjkYdm/Jpx5nqX1k7bR2ZemEigbm0FbdC17elYIb/C5zKVlEPExJA3dZc8/2SPw5euevrZHIpBjs+AUazbm/g+wrcODYv3uNhL4wV55dshLmsG9nqql4/nPZh8i+CMObWG0mGNtbBfciXL8bWku19+3sC/TOCkz3uwtB+A2mfsPKdxalFV77ViE+g0lMT6ayhbxu0DtktVBF3+FUR5048Nz+MLnFUyzBX+ofRZqauWR9GC+EzjRolK81WQv50fQrfgGwqvuqQX1gbaQwJpM0jBzxG9Aa67l46vLbKexb/bNHyoLhdJlXI9aIKs7aAdCqVw1e4hqEJO1f9q25XLJ22jrcXSv0Scle1vIIEHvElPg39Ledc6Bjh9rhxkucYutlC5dV45mQZSjs2IEhAtlSu+G4IaP/DF2xF1HXxROxCfgAYGjRj9P4/6/2/zQ== +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"; + + + + + + + + + + +Delete an RLS + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.ParamsDetails.json new file mode 100644 index 00000000000..32e33f67aca --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The annotation pk for this annotation","in":"path","name":"annotation_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.api.mdx new file mode 100644 index 00000000000..740afa5eb76 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-annotation-layer-annotation-layer-pk-annotation-annotation-id +title: "Delete annotation layer (annotation-layer-pk-annotation-annotation-id)" +description: "Delete annotation layer (annotation-layer-pk-annotation-annotation-id)" +sidebar_label: "Delete annotation layer (annotation-layer-pk-annotation-annotation-id)" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYR8STI6ToAMCFf2QpSmaLuiC2tkGREbKSGeLCUWyJOXGE/TfhyNl+SXehgwZ8knikTw+9/Du4TVguOUVerQO0psGCnS5FcYLrSCFcYmMK6U9JwOTfIGWmQc21Zb5Uri1SUhA0BbDfQkJKF4hjR4gAYvfamGxgNTbGhNweYkVh7QBvzC0SiiPM7TQtsm/IHjO2av5W1E8D8aEVjujlUNHC44PD+mTa+VRefrlxkiRB+/De0dQmzWHxmqD1ou4u0Ln+AzXTnLeCjWjeJcWfXePuYc2AXzklZG4sXG1oU22CLrwWLECJXosaPubwzevC/Wz9myqa1WkjC6PWEfnsWAWna5tjqzQ6JjSnuGjcH5XUL2PENHx8etGdK2M1TkN7yQyVF74Rcp+41IUMSvRWm13xXGma1mEUDsP3W466qfXzqkL5dEqLplDO0cbo0jZqWK1wkeDOV1aMDKd57Wl0tkR4wfuuewpSMBhXluKkeTk/ruH9GZCBeX5jCQGTlfVfEl64mCSwOMg1wWOAsooRJKrGaSQX3+5hAQkv0O5GsZEonFtJRv8wd6fX56Pz1kGpfcmHQ6lzrkstfPpyeHJyZAbMZwfDdcUIUjZcN00bDYEo82AZVmmGBt8ZBmc1r7UVvwZplP2M3KLlv1wenZ2Phrdjn/95fxzBkD61QG/WvgyKNMSem/owYvKaOuXFeIylaml6rB3vfkgFvceQWEvHGESnZbIC7TuXbMVZwYpy6CLNQP2I+M5ZfGt1w+o2kztZ8pYofzeEveB89zX7pZuc3+djk98zkcha9Yo2TCu7lQrR6z0TPDvXHg2RZ+XgYX/gYMmElGhL3VBQceE2mYoXS5k2ylBVH1dZkUTaRoHlr7GHS19iLK3maIItcQDqWfbzO2/BSqWzRJ7HzLg6Uu8t7IMgmVgHgZrtrVfUexDAjE+SCHmFCTxyUzhb7lrzEP7D/TRvQX1iEVbW7rWnbcD20Fd0jQrcI5SmwqV73QoZE101Birvc61bNPhsCFXbdpQzbRPvJ3Vzutq6SKBObeC5Np10hnc0H+BU15L38GEBFDVFelSN6RPkKRN/x/H4yvW+2kTIDSb/vp4n4AbRYGlOepNmLbs4oqcUCybTnZS1e0Pq9vQnSxFdkTPQwwySG0DdyEHP2hbcfL36fcxdK0O1Vachf6JCEG3CW2+tTi16Mr/6qSlJmyqYzgb6GuD1iHR4oWnV2jdRLkT182PIiXOVzy8fV0f92LZvwGrfzc9PvqhkVwoOj4kXtOVxQ1wIwjjESSwXRqQQBra240+NN3sOifLRLmBprnjDq+tbFsyf6vR0hs5WeVqbMBFaDMKSKdcOnyCuu8XYO9L19Dus+f16TsD74xcLUL1yJpGkMADLmIfH3rzFwD3krA2yW4nVJdBqQOVcc1pnmN4YJa7n7RZVFC9Mkbhp2utfbmWJn3Sdz90wE5wTRNXRPVve6zhzSSMbfsXQ+avqw== +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"; + + + + + + + + + + +Delete annotation layer (annotation-layer-pk-annotation-annotation-id) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.ParamsDetails.json new file mode 100644 index 00000000000..a21f8dd40a1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.api.mdx new file mode 100644 index 00000000000..5701ba0f39e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-annotation-layer-annotation-layer-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-annotation-layer-annotation-layer-pk +title: "Delete annotation layer (annotation-layer-pk)" +description: "Delete annotation layer (annotation-layer-pk)" +sidebar_label: "Delete annotation layer (annotation-layer-pk)" +hide_title: true +hide_table_of_contents: true +api: eJzFVt1P3DgQ/1es0T2ALrCAehJK1QeOUpUe6qHucncSQdQks5uwju3aky1clP/9NHY2+8HeQ/vCU+KxZzy/+fh5WrDSyRoJnYf0toUCfe4qS5XRkMKkRCG1NiRZIJR8RifsXEyNE1RWfm0TEqhYxUoqIQEta+TVHBJw+K2pHBaQkmswAZ+XWEtIW6Bny6cqTThDB113x6e9Ndqj5wMnR0f8yY0m1MS/0lpV5eHK0aNnL9s1g9YZi46qqF2j93KGazd5cpWeQdclS4l5eMScoEsAn2RtFW4orhS6ZCs2l4S1KFAhYcHqb47evK6rnw2JqWl0kQrOG0cdPWEhHHrTuBxFYdALbUjgU+VpF6jBRkB0cvK6iG60dSbn5YNCgZoqek7FX1JVRSxIdM64XTjOTaOKALW30GvzVb+9dk1dakKnpRIe3QJdRJGKMy0ajU8Wc05aEAqT543j1tmB8YMkqYYQJOAxbxxj5D5+/E6Q3t5xQ5GccW/D2aqRr7iRPdwl8HSQmwLHwcvIAErqGaSQ33y5ggSUfEC1WsZC4nXjlDj4R7y/uLqYXIgMSiKbjkbK5FKVxlN6enR6OpK2Gi2ORyuauA8cMjrOQGRZpoU4+CgyOGuoNK76NxxJxe8oHTrxy9n5+cV4fD/584+LzxlAlwzeXT9TGThn6d8gGDysamscLdvAZzrTS2oR7wbxYezgPXZF/AyMJGqWKAt0/l27BSaDVGTQA8pA/CpkzvV4T2aOusv0fqatqzTtLZ079CSp8fecl/11zJ/kQo5D/tdwbwhX2THaM/QBrvwuKxJTpLwMUH8WaBvR1kilKRhZzP92GNLlQbGdXI7H12V+2xiLSQjF16jR8Yfj8jbTDMMoPFRmth2e/bfAtb3ZEe9DLl++WHsryUGQHNj5PiQQYUAKsQggia9XCv8bh9bOOw50aNzYL43jPOwMJ2w7eMXbosAFKmNr1NRTQEhzNNRaZ8jkRnXpaNSyqS5tuZK7F9bOG0+mXppIYCFdxUzpe9YKZvi/wKlsFPVuQgKom5opoV/yJ7DBpv2Pk8m1GOx0CbA3m/YGvC+cG0du4z2eBYRx4vKajTCWTSM7Q9Xrh9NdGAyW/DZmZo4gA8u18BDq6YNxtWR7n/6eQD9lcDPEXRjYOYDuEla+dzh16MufNdLx0DM1Ec6G941F55HDQhXxA7Au4tqJ5xbHMSSeahmenX5u+tFK3rh9eJkIn2hklaw03xLqq+1L/BakrdiVY0hgu8whgdTOuSBixm+hbR+kxxunuo7F3xp0/M7crYouTo9VeKoLSKdSeXzh1/Dmwt6XfijcFz82ZO6E1gulfg5toBpeQQJzfI5DaHfH5RvIKTgaN87yHANxLlVeDAJcdwNLRK7jeDVUroV5qI3+hy/Y6VHbxhOR8LrBwfAWsI9d9x8N4/4V +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"; + + + + + + + + + + +Delete annotation layer (annotation-layer-pk) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.ParamsDetails.json new file mode 100644 index 00000000000..992981fc7d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.StatusCodes.json new file mode 100644 index 00000000000..d3cf7057895 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.api.mdx new file mode 100644 index 00000000000..e64590aa33e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-multiple-annotation-layers-in-a-bulk-operation.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-multiple-annotation-layers-in-a-bulk-operation +title: "Delete multiple annotation layers in a bulk operation" +description: "Delete multiple annotation layers in a bulk operation" +sidebar_label: "Delete multiple annotation layers in a bulk operation" +hide_title: true +hide_table_of_contents: true +api: eJzFVttu3DYQ/RVi0IcYlb22kQKGgjxsHQdJaiRGd90WsIwNLY1XsimSJkcbbwX9ezGkVnuxAxR+8ZPEywzPmcshW7DSyRoJnYf0qoXcaEJNkLYgrVVVLqkyenTnjeY5n5dYS/6rCGvPP7S0CClUmnCODrpkNSOdk0tIgCpSPJ4jzQpUSDirCj/rXXVdl0ClIYWHBh3v17Lm7Q/QXSfg0FujPYajjg8P+fO/MVpnLDqqonWN3ss5bmD25Co9h26N2dzcYU5MAh9lbRVuGa4NugQK9LmrLB8NKZxOJoKwtkoSenHTqHsRubKvt4dHr4v7UsuGSuOqf7FIxbihEjX15wuHD03lsHiO1qZhZPL2dZl8NSRuTaOLVExLDNjRExbCoTeNy1EUBr3QhgQ+Vp6eIzX4CIyOj187N9aZnIc3CgXnhZap+Euqqoj5QeeMe7bmTKOKQLX30FvzUb+9dqt81oROSyU8ugW6yCIVYy0ajY8Wc05amBQmzxv3kwL8KEmqIQQJeMwbxxxZrO5+EKRX16wTJOcsYDDW2lCM27lcsqpdJ/C4n5sCJwFllDkl9RxSyC//PIcElLxBtR7GQuJx45TY/0d8ODs/m56JDEoim45GyuRSlcZTenJ4cjKSthotjkZyOHqm+OhRBiLLMi3E/ieRwbhvpLAjFb+jdOjEL+PT07PJZDb99sfZ1wygSwZwF0sqjd6AN0wMAKvaGkerLvCZzvRKMMX7YfogKtEbhiJewCKJhiXKAp1/3+5wySAVGfR8MhC/CplzNc7I3KPuMr2XaesqTW9W2A48SWr8jLOyt0n5i1zIScj+Bu2tyXVujPbMfGArf8iKxC1SXgamL+TZRrI1UmkKJhaTvxuFdLVR7KaWw/F9ld02hmIaIvE9WnT84bC8yzSzMAoPlJnvRmfvXbgAt9vhQ8ikqBtFlVUo1ixEYOFFpYWM9w83dFiCBCIdSKG/lBKwkkpI4afh4FiHzo0N0zhOxbMRhV2Q57wsClygMrZGTb0GhExHR611hkxuVJeORi276tKWa7l74u208WTqlYsEFtJVLJW+l63ghv8LvJWNoh4mJIC6qVkT+iF/ghxs+/80nV6IwU+XAKPZ9jfwfQJuEsWN1/jZIowTny/YCXPZdvJsqHr7sLvrON8rgZuwNEeSQeZauAk19dG4WrK/L39POUdhG6T9KgzyHEh3CRvPHN469OVLnYQH2q2JdLbQNxadR9p45G1Mce3EfYujGBJPtQz3Tv/Ee2k1b6EYrijCRxpZJSvNp4U6a/syvwJpK4Z0BAnsljokwFUR034FbXsjPV461XU8HV+l3AI7pw5XK6zjtQ3hHpfhHcs1qxpeDx29KuBwdSUQBSWcEA3GeY5B61ZWT25u9jJ0dNQn5tVQuRGOIZf9Dx+wepnr5Yb7to07okhxA0YcQb6hu+667j+lkjSV +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"; + + + + + + + + + + +Delete multiple annotation layers in a bulk operation + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.api.mdx new file mode 100644 index 00000000000..fdb7640658f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-permissions-resources-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-security-permissions-resources-by-pk +title: "Delete security permissions resources by pk" +description: "Delete security permissions resources by pk" +sidebar_label: "Delete security permissions resources by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFVltv2zYU/ivEwR4STImToAMCFX3I0hRN13VB7HQDosClpWOLiUSyJOXEE/jfh0NKsp34YTcgTxIv5/D7vnMhW9Dc8BodGgvpbQtCQgqauxISkLxGGj1AAga/N8JgAakzDSZg8xJrDmkLbqVpl5AOF2jA+zvabbWSFi1tODk6ok+upEPp6JdrXYmcO6Hk6N4qSXNrh9oojcaJaF2jtXyBGydZZ4RcgPdJP6Nm95g78AngE691hVuGawOfQIE2N0LT0ZDCpcOaFVihw4LM3xy9eV2oX5Rjc9XIImWTEhmpjtZhwQxa1ZgcWaHQMqkcwydh3S5Sg4/A6OTkdRndSG1UTsNZhQylE26Vsq+8EkXAwNAYZXbxOFdNVQSqnYfOmo766bVz6lI6NJJXzKJZooksUnYmWSPxSWNOQQuTTOV5Y6h0dnD8wB2vBgkSsJg3hjhSLd4/Okhv76igHF9QfcK4W2dXaGphrVDSMiXZdZcelu19FfjIfkXZ2H24S4B4B1UuC0gh5vq0P2aq126mfYrZ6Ww1DUX/dJCrAseBfmwPFZcLSCG/uf4MCVR8htV6GM1p3JiKHfzB3l98vphcsAxK53Q6GlUq51WprEtPj05PR1yL0fJ41IMZbYA5GMCMjjNgWZZJxg4+sgzOGlcqI/4MnFL2M3KDhv1wdn5+MR5PJ7/9cvElA/DJgPVq5UolN9AOEwNeUWtlXF9tNpOZ7DsYezdMH0bx9ggK+++kkuinRF6gse/aZ9QySFkGHb0M2I+M51QEU6ceUPpM7mdSGyHdXg/10DruGjulmO1vKvCJL/k4JN2GCluT68gpaUmIgTx/5MKxObq8DMT/H9pt5F6jK1VBPGOmPBcl7Tey54Endb71sW+jMpMgzLdo4elDKr3NJJFSFR5WavFcrP23QOW1XZTvQ5xZz4VtcBn6sGWzFQtFEkkMtQVJvD5T+JuatPrBUwhCH4lV1hiK0E6h4TnYz7TMClxipXSN0nUdKSRAdNRqo5zKVeXT0aglVz5tKeP9C2/njXWq7l0ksORGUOO2XRMNbui/wDlvKtfBhARQNjV1qG5IHwsvpP04mVyxwY9PgNBs+xv4vgA3jq2W1uhpwpRhl1fkhLhsO9kpVWcfdvvwTulDM6aLIpIMTbeFWcitD8rUnPx9+n0C3aOHyiSuwnBZBNI+IeOpwblBW/5bJz4BIecq0tlC32g0FkkWJxzdR5tTlDtx3/I4SmJdzcMt2D3j/llWb509XJMOn9xIV1xIOiNkV9ul+y1wLQjIMWxcYwnsTHpIINUPlB4x/rfQtjNu8cZU3tP09wYNXYJ36xQMlVGI8I4oIJ3zyuILnMODAPauuxfrPltLvI2/m+RyFTK9amgECTzgKj57/R1laOhF4fS4cJbnGLpmb/Li6UGpNbSF2NogAd64ckPLIfzdDx2wE1Hbxh2xv/kBYLgICKP3fwEEhxZN +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"; + + + + + + + + + + +Delete security permissions resources by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.api.mdx new file mode 100644 index 00000000000..47df04fa134 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-resources-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-security-resources-by-pk +title: "Delete security resources by pk" +description: "Delete security resources by pk" +sidebar_label: "Delete security resources by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFVt9P3DgQ/les0T2ALrCAehJK1QeOUpUe1yJ26Z1E0NabzBKDY7u2s7AX5X8/jZ1kd2F1J/HCU+IfM/6+mW/GbsBwyyv0aB2kNw0IBSkY7ktIQPEKafQACVj8WQuLBaTe1piAy0usOKQN+KWhXUJ5vEMLbXtLu53RyqGjDUcHB/TJtfKoPP1yY6TIuRdaje6dVjS3cmisNmi9iNYVOsfvcO0k561Qd9C2ST+jZ/eYe2gTwCdeGYkbhiuDNoECXW6FoaMhhXOPFStQoseCzN8dvHtbqF+1Z3NdqyJlkxIZRR2dx4JZdLq2ObJCo2NKe4ZPwvltpAYfgdHR0dsyulbG6pyGM4kMlRd+mbLvXIoiYGBorbbbeJzqWhaBauehs6ajfntrTZ0rj1ZxyRzaBdrIImUnitUKnwzmlLQwyXSe15ZKZwvHT9xzOYQgAYd5bYkj1eL9o4f05pYKyvM7qk8Yd+vsqtODYzvfBT6yP1HVbhduEyCiIQznBaQQxT3t/U57HbnpbDkNlf20l+sCx4Fj7AGSqztIIb++uoAEJJ+hXA2jOY1rK9ne3+zj2cXZ5IxlUHpv0tFI6pzLUjufHh8cH4+4EaPF4agHMBoAjA4zYFmWKcb2PrMMTmpfaiv+CdhT9jtyi5b9cnJ6ejYeTyff/jj7mgG0yYDvculLrdYQDhMDRlEZbX1fRi5TmepbE/swTO/HIO0QFPY6Ikm0LZEXaN2H5hmdDFKWQUcpA/Yr4zkpeur1A6o2U7uZMlYov9PD23ee+9pNKTe766y/8AUfBwWtMd+YXGVIK0fkB8L8kQvP5ujzMpB9PdUm8q3Ql7ogblEFzwOR9hvZ8wRTRH70OW5iNCYhGD+iRUsfisz7TBERLXFf6rvnAdp9D1Qfm1X1MeST9fiH5unYbMmC6CPwoT4giXdeCv/BvTEPLYU3FHyslNpS9LcGEZ6DuqBlVuACpTYVKt+1jpDc6KgxVnuda9mmo1FDrtq0IQW3L7yd1s7rqneRwIJbQR3Wdd0uuKH/Aue8lr6DCQmgqitqJd2QPg5ehPDzZHLJBj9tAoRm09/A9wW4ceyJtEZvCKYtO78kJ8Rl08nWUHX2YXcbHhR9OsbU0SPJ0B0bmAUNfdK24uTvy18T6F4nVAJxFYauHki3CRlPLc4tuvK1TtoEhJrrSGcDfW3QOqSweOHp4lifIu3EfYvDGBLnKx6uq+699f/q3ThvuMM8PvmRkVwo8hsU1XSyvgFuBB1+CGt3THinRdeQQGoeSAYxzzfQNDPu8NrKtqXpnzVaupVuV1ILFVCIcLEXkM65dPgC23BDw85V94TcZatQbmLuJrlaBkXLmkaQwAMu4zu0vSUlht4STo8LJ3mOofP1Ji/eAiShoeRjq4IEeO3LtfgNae5+6ICtiJom7oj9qh0AhmZOGNv2X4Gx6SU= +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"; + + + + + + + + + + +Delete security resources by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.api.mdx new file mode 100644 index 00000000000..e4dc1250c00 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-roles-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-security-roles-by-pk +title: "Delete security roles by pk" +description: "Delete security roles by pk" +sidebar_label: "Delete security roles by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFVt9v2zYQ/leIwx4STImToAMCFX3I0hRNF3RB7KwFosClpbOlhCJZknLjCfzfhyMl2U68AetLniT+uOP33X13ZAuaG16jQ2MhvWuhkpCC5q6EBCSvkUaPkIDB701lsIDUmQYTsHmJNYe0BbfStKuSDhdowPt72m21khYtbTg5OqJPrqRD6eiXay2qnLtKydGDVZLm1g61URqNq6J1jdbyBW6cZJ2p5AK8T/oZNXvA3IFPAJ94rQVuGa4NfAIF2txUmo6GFC4d1qxAgQ4LMn9z9OZ1oX5Wjs1VI4uUTUpkFHW0Dgtm0KrG5MgKhZZJ5Rg+VdbtIjX4CIxOTl6X0a3URuU0nAlkKF3lVin7i4uqCBgYGqPMLh7nqhFFoNp56KzpqN9eW1OX0qGRXDCLZokmskjZmWSNxCeNOSUtTDKV542h0tnB8QN3XAwhSMBi3hjiSLX48MNBendPBeX4guoTxt06u1ECLdwnQLwC68sCUohanvZupoa2TWeraSjip4NcFTgOdGK5Cy4XkEJ+e3MFCQg+Q7EeRsXRuDGCHXxl7y+uLiYXLIPSOZ2ORkLlXJTKuvT06PR0xHU1Wh6P+sNH4fDRcQYsyzLJ2MFHlsFZ40plqr8D5pT9jtygYb+cnZ9fjMfTyZ9/XHzOAHwyYLteuVLJDXTDxICvqrUyrq8Wm8lM9h2IvRumD2Nw9ggK+/8kkmhXIi/Q2HftMyoZpCyDjk4G7FfGcxLt1KlHlD6T+5nUppJur4d2aB13jZ1STvY3GX/iSz4OItlgvTW5zoySlogPZPkPXjk2R5eXgejP0Wwj1xpdqQriFTP/PAhpv5E9TyxF41uf2zZGYhIC8S1aePpQVN5mkkgogYdCLZ4HZ/8tkPy3i+Z9yCPrsbOAnc1WLIg8gh5qAZJ4naXwL5xb/egppKGOY1U0hiK+M3DwHMwVLbMClyiUrlG6riOEhEZHrTbKqVwJn45GLbnyaUuK9S+8nTfWqbp3kcCSm4oap+2aWHBD/wXOeSNcBxMSQNnU1CG6IX1Cf9j2/3EyuWaDH58Aodn2N/B9AW4cWx2t0dOAKcMur8kJcdl2sjNUnX3Y7cM7oU/FmBp1JBmaXguzoJ0PytSc/H36MoHu0UGyj6swNOtA2idkPDU4N2jLn3XiE6jkXEU6W+gbjcYihcVVju6DzSnSTty3PI4hsa7m4RbqnlH/rdqts4ZryeGTG2nBK0k+g5raTs53wHVFBx/DxrWRQHALCaT6kdIf83sHbTvjFm+N8J6mvzdo6JK5X0ssKL+owj1dQDrnwuILXMOFC3s33Ytwn61DuI23m+RyFZQsGhpBAo+4is9Kf08KDL0knB4XzvIcQ5frTV5c7SSdocxja4IEeOPKjdgN6e1+6ICdiNo27oj9yQ8AQ+MmjN7/A7B51Ys= +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"; + + + + + + + + + + +Delete security roles by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.api.mdx new file mode 100644 index 00000000000..4efa2ca10ca --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-users-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-security-users-by-pk +title: "Delete security users by pk" +description: "Delete security users by pk" +sidebar_label: "Delete security users by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFVt9v2zYQ/leIwx4STImToAMCFX3I0hRNF3RB7WwDosClpbOlhCJZknLtCfzfhyMl2U68AetLniT+uOP33X13ZAuaG16jQ2MhvW+hkpCC5q6EBCSvkUZPkIDBb01lsIDUmQYTsHmJNYe0BbfWtKuSDhdowPsH2m21khYtbTg7OaFPrqRD6eiXay2qnLtKydGjVZLmNg61URqNq6J1jdbyBW6dZJ2p5AK8T/oZNXvE3IFPAFe81gJ3DDcGPoECbW4qTUdDCtcOa1agQIcFmb85efO6UD8rx+aqkUXKJiUyijpahwUzaFVjcmSFQsukcgxXlXX7SA0+AqOzs9dldCe1UTkNZwIZSle5dcr+4KIqAgaGxiizj8elakQRqHYeOms66pfX1tS1dGgkF8yiWaKJLFJ2IVkjcaUxp6SFSabyvDFUOns4fuCOiyEECVjMG0McqRYfvztI7x+ooBxfUH3CuFtnd5Yq9iEB4hVYXxeQQtTytHczbWjbdLaehiJeHeWqwHGgE8tdcLmAFPK7LzeQgOAzFJthVByNGyPY0V/s/dXN1eSKZVA6p9PRSKici1JZl56fnJ+PuK5Gy9NRf/goHD46zYBlWSYZO/rIMrhoXKlM9XfAnLJfkRs07KeLy8ur8Xg6+f23q88ZgE8GbLdrVyq5hW6YGPBVtVbG9dViM5nJvgOxd8P0cQzOAUFh/59EEu1K5AUa+659RiWDlGXQ0cmA/cx4TqKdOvWE0mfyMJPaVNId9NCOreOusVPKyeE24098ycdBJFusdyY3mVHSEvGBLP/OK8fm6PIyEP0xmm3kWqMrVUG8YuafByHtN7LniaVofO1z28ZITEIgvkYLTx+KyttMEgkl8FioxfPgHL4Fkv9u0bwPeWQ9dhaws9maBZFH0EMtQBKvsxT+hXOrnzyFNNRxrIrGUMT3Bg6eg7mhZVbgEoXSNUrXdYSQ0Oio1UY5lSvh09GoJVc+bUmx/oW3y8Y6VfcuElhyU1HjtF0TC27ov8A5b4TrYEICKJuaOkQ3pE/oD7v+P04mt2zw4xMgNLv+Br4vwI1jq6M1ehowZdj1LTkhLrtO9oaqsw+7fXgn9KkYU6OOJEPTa2EWtPNBmZqTv09/TqB7dJDs4yoMzTqQ9gkZTw3ODdryR534BCo5V5HODvpGo7FIYXGVo/tge4q0E/ctT2NIrKt5uIW6Z9R/q3bnrOFacrhyIy14JclnUFPbyfkeuK7o4FPYujYSCG4hgVQ/Ufpjfu+hbWfc4p0R3tP0twYNXTIPG4kF5RdVuKcLSOdcWHyBa7hw4eBL9yI8ZJsQ7uLtJrlcByWLhkaQwBOu47PSP5ACQy8Jp8eFizzH0OV6kxdXO0lnKPPYmiAB3rhyK3ZDersfOmAvoraNO2J/8gPA0LgJo/f/AO311gA= +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"; + + + + + + + + + + +Delete security users by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.StatusCodes.json new file mode 100644 index 00000000000..7da8a07ea37 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"},"example":{"result":{}}}},"description":"Tag removed from favorites"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.api.mdx new file mode 100644 index 00000000000..487b9923a5b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-tag-by-pk-favorites.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-tag-by-pk-favorites +title: "Delete tag by pk favorites" +description: "Remove the tag from the user favorite list" +sidebar_label: "Delete tag by pk favorites" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYR8STImToAMCFf2QpSmaruiC2NkGRIFLS2dLCUWq5MmNJ+i/D0fKiuy4G9oO6CeJb8fnuZeH10CGLrVFRYXREMM1lmaJgnIUJBdibk3pB7VDK+ZyaWxBKFThCCKopJUlEloH8W0DBRuoJOUQgZYl8ugBIrD4qS4sZhCTrTECl+ZYSogboFXFuwpNuEALbXvHu11ltEPHG06OjviTGk2oiX9lVakilQx3dO8YczMwWFlToaUinLboakWDi8zsHlOCto22ZyLAR1lWCjfOtS1v3fTQRC6E9V7KgnvWXnFs5cXR8XcALtE5ucABYke20Iv/RNwfhBsta8qNLf7GLBZnNeWoqbtf9JHYwWt4MDB58WOZfDAk5qbWWSwmOXrs6AgzYdGZ2qYoMoNOaEMCHzkhd5DqbXhGJyc/OjaVNSkPZwoFx4VWsfhDqiIL8UFrjd3F49zUKvNUOwvdab7ql++qkf+B1qUmtFoq4dAu0QYWsTjTotb4WGHKQfOTwqRpbb+QgG8kSdW7IAKHaW2ZI2vL/WeC+PaOBYLkgvWGC9HBXQTMxnO9zCCGDBUSTkkuprPVtHqYPpVnBI8Hqclw7DkEzVJSLyCG9Ob6PUSg5AzV0zCkGY9rq8TBX+L1xfuLyYVIICeq4tFImVSq3DiKT49OT0eyKkbL4xHJxeh41N87SkAkSaKFOHgrEjjrqsxDjsWvKC1a8dPZ+fnFeDyd/P7bxYcEoI16bFcryo0eoOsnenxFWRlL6xJxiU70WkbFq376MPhmj6GIrycRhXM5ygyte9VsUUkgFgl0dBIQPwuZcqZOyTygbhO9n+jKFpr21tAOHUmq3ZRjsj9k/E4u5dhnxoD1xuRTZIx2TLwnKz/LgsQcKc090W+j2QSuJVJuMuYVIr/thHi9UWwHlr3xcR3bJnhi4h3xMZxo+cNeeZloJmEUHiqz2HbO/kvgnA9A+vT2by/lEMOQR1M9tAMq7CZfkCHTa8te3OkM2C7F97wsMlyiMlWJmrrS9kEKhprKGjKpUW08GjVsqo0bzsL2mbXz2pEp1yYiWEpbsAK6To28Gf7PcC79w+thQgSo65JLvRvyx5f8pv23k8mV6O20ETCaTXs932fgxkGzeI17FmGsuLxiI8xl08hOV3Xn/e7WNzBr3Rqz4gaSXr0amPl8eGNsKdneuz8n0HVDnMphFXrV9aTbiA9PLc4tuvxbjbQRFHpuAp0N9HWF1iG7hQpiYR9Oce6Efcvj4BJHpfTPSdffvfbp6FvF2UpUD2KothtXDR6or2syOyKEjzSqlCw0I/E52HRFcAuyKhjuMfjXASKIfeM5BMNpE/LiFppmJh3eWNW2PP2pRsuvzN1TavqKyQr/UGcQz6Vy+C+E9q67xmpffAlxNyn1yleAqnkEETzgKvTJ7R1nrtcVf3tYOEtT9Iq3PvLsbd+QhyBTEAH3coM3vU+L7ocv2ImoacKOoFVtD9CLOGNs238AtA8zFw== +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"; + + + + + + + + + + +Remove the tag from the user favorite list + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.ParamsDetails.json new file mode 100644 index 00000000000..724c921ddcf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.StatusCodes.json new file mode 100644 index 00000000000..b047f269e63 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"A zip file with database(s) and dataset(s) as YAML"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.api.mdx new file mode 100644 index 00000000000..8376ef27475 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-database-s-and-associated-dataset-s-as-a-zip-file.api.mdx @@ -0,0 +1,68 @@ +--- +id: download-database-s-and-associated-dataset-s-as-a-zip-file +title: "Download database(s) and associated dataset(s) as a zip file" +description: "Download database(s) and associated dataset(s) as a zip file" +sidebar_label: "Download database(s) and associated dataset(s) as a zip file" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYR8STImToQMCFf3gpenb2i6YHWxDFLi0dLaYSqRCnhw7gv77cKSk2HkpsA7YPkkkj3fPc69soJJWlkhoHcSXDaRGE2qCuAFZVYVKJSmjR9fOaN5zaY6l5D9FWDr+oU2FEIPShEu00Eb9jrRWbiACUlTweok0w3VlLM1U5madqrZtI1AaYrip0bK8liWL30B7FYFFVxnt0Jv66eiIP89gvFPVLsSFsaUkiGGutPSqO2SOrNLLYDpDl1pVsQaIYSzuVCUWqkBxqygXmSQ5lw733L6QOvNrh+SXTvw1/vSRCb84Ov4Grse+q6yp0JIKrEp0Ti5xy5cDvgGxmV9jSmwL17KsCty5CBda1pQbq+4wi8W4phw1dfaFxZtaWcye4rt9MTB58f8y+WxILEyts1hMc/TY0RFmwqIztU1RZAad0IYErpWjp0gNOtjKz9/Mmf+A0XtNaLUshEO7QivQWmNjMdai1riuMGV2flOYNK3tM5F6I0kWQc4bd5jWVtHGV+31LUF8ecUFQ3LJlQyvu8yFqwjWB6nJcOLBhTIvpF5CDOnF7x8hgkLOsbhfBkfzuraFOPhTvD2bigRyoioejQqTyiI3juKTo5OTkazUaHU86gtlFCp8lIBIkkQLcfBOJDDuksw7PRa/oLRoxQ/j09OzyWQ2/e3Xs88JQBsNwM43lBu9BW3YGMCpkg31GeISnei+WYhXw/bhEmmPcYh/ziAK93KUGVr3qnnAI4FYJNBxSUD8KGSaonMzMl9Rt4neT3Rllaa9Htchp9ve/v420w9yJSc+zltsdzbvw2G0Y8IDSXkrFYkFUpp7jt/HsNmhGfdr8TBuzPdLH7omcJ16ql/CjZY/zPtlogNWtjjgfOCFTsgUeFiY5R6L7r/0PX838V+bW10YmT3qxdI5kyrJ5bPbluXQxCGCEik3WRg/EEElKYcYnnMJu9uXaSiT2nI0nnQqPMT5kY9FhissTFWipq7gfbCDoqayhkxqijYejRpW1cYN220faTutHZmyVxHBSlol50XoSr0a/s9wIeuCOpgQAeq65AbQLfnj4JFX302n52LQ00bAaHb1DXwfgZuETsZnPKyFseL9OSthLrtKnnRVd99Lty2HvO9mE+7DgaTvaQ3MfcK96Uf5hz+mHCMvxpPdn95Pdk+6jfjyzOLCosu/V4l/lixMoLODvq7QOp9N/dNma4tzJ8itjoNLHJXSD5nuYfMvE3oHzDCWCNc0qgqpNBv16dZ0yX4JslKM7Jhv92OBp5UPQAScHSH8l9A0fHphi7bl7fAm41J4YHaYp3Dvt10MX3HjX3Gcu0XN5764+0T28yqC0HW8hXBhnKbo215/6+ETj5UMRf32jCPJb5gtXwzx7H5Yef8m1Zst1U0TJEIX4yIMGHwDh/aqbdu/AWNe0U8= +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"; + + + + + + + + + + +Download database(s) and associated dataset(s) as a zip file + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.ParamsDetails.json new file mode 100644 index 00000000000..724c921ddcf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.StatusCodes.json new file mode 100644 index 00000000000..b3350aaba3d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"A zip file with chart(s), dataset(s) and database(s) as YAML"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.api.mdx new file mode 100644 index 00000000000..0cf4bcf268d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-charts-as-yaml-files.api.mdx @@ -0,0 +1,68 @@ +--- +id: download-multiple-charts-as-yaml-files +title: "Download multiple charts as YAML files" +description: "Download multiple charts as YAML files" +sidebar_label: "Download multiple charts as YAML files" +hide_title: true +hide_table_of_contents: true +api: eJzFVlFv2zYQ/ivEYQ8JpsTJ0AGBij64Wdqm67pgdrANUeDS0tliSpEMSTl2BP334UhJsZN02PqSJ5EU+d333R2P14Dhllfo0TpIrxrItfKoPKQNcGOkyLkXWo1unFa05vISK04j4bFyNPAbg5CCUB6XaKFN+hVuLd9AAl54SfMl+hmujbZ+Jgo366Datk1AKEjhtkZL+xWvaPsttNcJWHRGK4fB1E9HR/T5Bsd7YXYpLrStuIcU5kLxAN0xc94KtYymC3S5FYYQIIUxuxeGLYREdid8yfKSW7/n9hNWcM8d0phxVYTpnDsMc8f+Hv/2iaS/+leGT71orDZovYj6KnSOL3HLqwPTgbue32DuyRaueWUk7hyEt7xgFm9rdD5l52rFpSjYQ4yZsXolCiyeE791Nmo5flktl4rXvtRW3GORsnHtS1S+sx+ICvu8kO2DUcmrl1XyWXu20LUqUjYtsXcykrudrm2OrNDomNKe4VqQ+5+KGjDIys8vnWfnyqNVXDKHdoWWobXapmysWK1wbTAndWGR6Tyv7Tci9Y57LuO+YNxhXlvhN6EW3dx5SK+uqQx4vqT6BKd0Hx1cJ7A+yHWBk0Atli7J1RJSyC//+AQJSD5H+TCNbqZ5bSU7+Iu9P5uyDErvTToaSZ1zWWrn05Ojk5MRN2K0Oh6Fyz+KJWuUAcuyTDF28IFlMO7yK/g7ZW+RW7Tsh/Hp6dlkMpv+/uvZ5wygTQZWFxtfarXFa1gYmImKDPXJ4TKVqb76sTfD8uES/R7xYP+TfhIPlcgLtO5N80hEBinLoBOSAfuR8TxH52Zef0XVZmo/U8YK5fd6UoeUZnv7+9syP/IVn4T4bkndWXwIhFaO1A4K+R0Xni3Q52UQ+B3ymh2NaT9njyNGYr/0QWui0GnQ+SWeaOlDol9nKhKlgj+QfOSCbpOWeCj1co+27r8Oz9dutv+i75TUvGBVLb0wEuP74voXJDw8DhKo0Je6iG8mJGC4LyGFZ5WTS8MVjJegtuTxZx0Hj+l8ot+swBVKbSpUvrvMIaARqDFWe51r2aajUUNQbdqQ3fYJ2mntvK56iARW3Ao+l7Hi9DA0LnDBa+k7mpAAqrqiy91N6ROu+C7+h+n0gg04bQLEZhdv0PuE3CRWKfpH7QXTlp1fEAhp2QV51lXd+bC7bSmyfaWaUI2NIkO9amAe8upd33x8/HNKMQrbqBcJfx96kSC6TejwzOLCoiu/FyQ0Ugsd5eywrw1aF1Kpb8a2lih34r7VcXSJ8xUPD0jXiv3nvN0xOzwuHtd+ZCQXiuBDYjVdTl8BN4I4HEMCAZTyIWQ2JEBJEKN8BU1D7dallW1Ly7FZpIx/ZHN4EuHBPbsEvuImtJeUorKm/+Gq9vkanpwEYg0JFuKBcZ5jqGD9qce9J4EMF/f9GQWM2pAtRwxh6wYE3jfLarMF3TRxR6xJdNcih1CLob1u2/YfzQkHNQ== +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"; + + + + + + + + + + +Download multiple charts as YAML files + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.ParamsDetails.json new file mode 100644 index 00000000000..724c921ddcf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.StatusCodes.json new file mode 100644 index 00000000000..596ebe80964 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Dashboard export"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.api.mdx new file mode 100644 index 00000000000..37c7a663369 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-dashboards-as-yaml-files.api.mdx @@ -0,0 +1,68 @@ +--- +id: download-multiple-dashboards-as-yaml-files +title: "Download multiple dashboards as YAML files" +description: "Download multiple dashboards as YAML files" +sidebar_label: "Download multiple dashboards as YAML files" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYR8STImToAMCFf3gZmmbLuuC2dkLoiClpbPFlCIVknLsCfrvw5GSIjvugOVLPkl8ubvnuTdeDSU3vECHxkJ8U0OqlUPlIK6Bl6UUKXdCq9G91Yr2bJpjwelPOCws/bh1iRCDUA4XaKCJuh1uDF9DBE44SesFujtcldq4O5HZu1ZV0zQRCAUxPFRo6L7iBV1/gOY2AoO21MqiN3VydESfAUaHKzcqJRdb6FoI1hmhFsFGhjY1oiQ6EMPP3OYzzU3GAiTC/eaZ+v92QWl0icaJAK5Aa/kCd1nvXaJn95h6W7jiRSlxQxDe84wZfKjQuphdqCWXImNPAWKl0UuRYbaL0EA2cDl+XS7Xilcu10b8g1nMxpXLUbnWvgcqzG4iQ8HA5M3rMvmiHZvrSmUxm+bYORnJ3VZXJkWWabRMacdwJcj9z0n1Ojyjk5PXjk1pdErLmURGcXHrmP1B6Rbig8Zos4vHma5k5qm2GlppMvXTa5fPhXJoFJfMolmiCSxiNlasUrgqMaWg+U2m07Qy30nAD9xx2bsgAotpZYgj9cf7RwfxzS21JscX1DOfWomF2whWB6nOcOLhhZYquVpADOn175cQgeQzlE/LkEG0roxkB3+xj+dTlkDuXBmPRlKnXObauvj06PR0xEsxWh6Pss7gKPSuUQIsSRLF2MEnlsC4LR/v95i9R27QsB/GZ2fnk8nd9Ldfzr8kAE3UI7tau1yrAbZ+o0cnCjLU5b5NVKK6zsze9duHC3R7hIO9gEIUBHPkGRr7rt4ikkDMEmjJJMB+ZDylBLxz+huqJlH7iSqNUG6vA3ZIKbe3vz+k+pkv+cTHekB3Y/MpIFpZYtyz5I9cODZHl+ae5Asp1hs8427NtiNHhL92wasD2ann+jVINPQh4m8TFcBm3PEe6JYb2kta4qHUiz26uv/WP7FbD6N+VFLzjBWVdKKUyHoilnHL/h7/esnmgpI7ggJdrrPwtkMEJXc5xPBdD5B7fWmGwqgMeX+nE2Eb1iUdswyXKHVZoHJtkfvgBkV1abTTqZZNPBrVpKqJa7LbPNN2Vlmni05FBEtuBPVC2/Ylr4b+M5zzSroWJkSAqiqo6NslfXzZb+r/NJ1esV5PEwGh2dTX830GbhK6F53RKMS0YRdXpMTPKRtKdrqqlQ9TTUMR7jrYhHpvIOn7WA0zn18ftCk46fv855Ri5K9B3J5C33896SYi4TuDc4M2f6kSP/TNdaCzgb4q0VifTt3gONii3An3lsfBJdYV3D8s7dj4v/J3w3T/8AyGyiYKyVW3uX0DvBSE45ikO8WUF2GKjICSIUT7Bup6xi1eG9k0tB0GXMr8Lbv9kwlPbtoE8Q3XfiSmVJUVnfvS7fLWP0kRhJ7iLQSBcZqi72qd1FDr7aB+P55TzGjwGvihj1z7Q3q72V6tB1rrOtwI7YnKLZj3rRma26Zp/gUNr0ja +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"; + + + + + + + + + + +Download multiple dashboards as YAML files + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.ParamsDetails.json new file mode 100644 index 00000000000..724c921ddcf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.StatusCodes.json new file mode 100644 index 00000000000..df353b5058b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Dataset export"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.api.mdx new file mode 100644 index 00000000000..d6e3a73d6ad --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-datasets-as-yaml-files.api.mdx @@ -0,0 +1,68 @@ +--- +id: download-multiple-datasets-as-yaml-files +title: "Download multiple datasets as YAML files" +description: "Download multiple datasets as YAML files" +sidebar_label: "Download multiple datasets as YAML files" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYR8STImSoQMCFf3gZmmbLu2C2cE2RIHLSGeLKUUqJOXEE/TfhyMlRXbcAe2XfJL4cnfPc2+8BipueIkOjYXkuoFMK4fKQdIAryopMu6EVvGd1Yr2bFZgyelPOCwt/bh1hZCAUA6XaKCN+h1uDF9DBE44Seslujk+Vtq4ucjtvFPVtm0EQkEC9zUauq94Sdfvob2JwKCttLLoTf1ydESfEUaHjy6uJBdb6DoI1hmhlsFGjjYzoiI6kMBv3HGLjgVAhPrVM+X/74DK6AqNEwFaidbyJe6yPThE395h5m3hIy8riRuC8JbnzOB9jdYl7FytuBQ5ewoPq4xeiRzzXXRGsoHL8ctyuVK8doU24l/MEzapXYHKdfY9UGF2ExkLBiavXpbJZ+3YQtcqT9iswN7JSO62ujYZslyjZUpTLgly/3NSgw6y8utL59m5cmgUl8yiWaFhaIw2CZsoVit8rDAjdn6T6SyrzTci9Y47LsM9b9xiVhvh1r6N3D04SK5vqIIdX1Jr6SvOwk0EjweZznHqwYW+I7laQgLZ1Z8XEIHktyiflsHRtK6NZAd/s/dnM5ZC4VyVxLHUGZeFti45OTo5iXkl4tVxnAdzcSjwOAWWpqli7OADS2HS5Zj3ecLeIjdo2E+T09Oz6XQ+++P3s88pQBsNuC7XrtBqhGzYGLCJkgz1CWJTlaq+ebE3w/bhEt0e4WDfTSAKYgXyHI1902zRSCFhKXRUUmA/M55laO3c6a+o2lTtp6oyQrm9HtYhJdve/v6Y6Ee+4lMf5RHZjc2nYGhlie/AkT9w4dgCXVZ4ij9EsNlgmfRrth01ovulD1wTqM480y9BoqUP0X6dqgCVDA4wt5zQXdISD6Ve7tHV/df+Bdp6N/SDkprnrKylE5VE1tGwjFv2z+TTBVsISuoISnSFzsPDBxFU3BWQwDfYk2N9OYZyqA35faf7YBvSBR2zHFcodVWicl1h+7AGRU1ltNOZlm0Sxw2papOG7LbPtJ3W1umyVxHBihvBb2XoPr0a+s9xwWvpOpgQAaq6pELvlvTxxb6p/8NsdskGPW0EhGZT38D3Gbhp6Fh0RlMC04adX5IS/4hvKNnpqk4+PPktRbfvWlPqt4Gk710N3PrceqdNyUnfx79mFCN/DZLuFIae60m3EQnPDS4M2uJHlfh5aKEDnQ30dYXG+mTqZ6rRFuVOuLc6Di6xruT+Mekmqu/I3Q3Dw1MzmrbaKKRW0+X1NfBKEIpjkg5qKSfCeBUBJUKI9DU0zS23eGVk29J2mPso67esDk8kPLloE8JXXPtJkdJU1nTuS7bPWf8ERRB6ibcQBCZZhr6X9VJjrTejyn1/RvGiiWTkhSFq3Q/p7UdetR5pbZpwI7QlKrVg3jdkaG/atv0PXLv1Rw== +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"; + + + + + + + + + + +Download multiple datasets as YAML files + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.ParamsDetails.json new file mode 100644 index 00000000000..724c921ddcf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.StatusCodes.json new file mode 100644 index 00000000000..8bbabecdb59 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"A zip file with saved query(ies) and database(s) as YAML"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.api.mdx new file mode 100644 index 00000000000..62ad674f178 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-saved-queries-as-yaml-files.api.mdx @@ -0,0 +1,68 @@ +--- +id: download-multiple-saved-queries-as-yaml-files +title: "Download multiple saved queries as YAML files" +description: "Download multiple saved queries as YAML files" +sidebar_label: "Download multiple saved queries as YAML files" +hide_title: true +hide_table_of_contents: true +api: eJzFVt9v2zYQ/leIwx4cTImToQMCFX1ws7RN13bZ7GAbosClpbPFlCIVknLsCPrfhyMl+UfSAstLniSSx7vvuzveXQ0lN7xAh8ZCfF1DqpVD5SCugZelFCl3QqvhrdWK9myaY8HpTzgsLP24dYkQg1AOF2igibodbgxfQwROOEnrBboprkpt3FRkdtqqapomAqEghrsKDckrXpD4HTQ3ERi0pVYWvalfjo/p8x2MD6LchTjXpuAOYpgJxb3qFpl1RqhFMJ2hTY0oSQPEMGIPomRzIZHdC5czy5eYMY9sINAeMK4ylnHHZ9zigNaW/Tv6/Ilov/ohusceLI0u0TgRuBVoLV/glkd7lD1uPbvF1JEtXPGilLhzEd7yjBm8q9C6mF2oJZciY5v4stLopcgwe4r41t3A5eRluVwpXrlcG/GAWcxGlctRuda+ByrM00S2LwYmr16WyRft2FxXKovZJMfOyUjutroyKbJMo2VKO4YrQe5/TKrXQVZ+fek8u1AOjeKSWTRLNAyN0SZmI8UqhasSU2LnN5lO08p8J1LvuOMyyHnjFtPKCLf2dej23kF8fUMlwPEF1Sb4s0JDJG4iWB2mOsOxxxbqluRqATGkV399gggkn6HcLIOfaV0ZyQ7/Ye/PJyyB3LkyHg6lTrnMtXXx6fHp6ZCXYrg8GfqXP/Uvfxiq1jABliSJYuzwA0tg1KaZd3vM3iI3aNhPo7Oz8/F4Ovnj9/MvCUAT9dgu1y7Xagtdv9HjEwUZ6nLEJipRXQFkb/rtowW6AeFgzyIRhas58gyNfVPvUUkgZgm0dBJgPzOepmjt1OlvqJpEHSSqNEK5QQftiHJucHCwTfYjX/KxD/YW4Z3NTVC0ssS558nvuXBsji7NPc1nk6x3mMbdmu1Hjyh/7QJYB7oTz/ZruNHQh6i/TlSASz2gh7rniFZISzySejEg0YPXvpvtPoDf9L2SmmesqKQTpcStdiPQdr3FtyMLERTocp2FTgoRlNzlEMMP3EBe9k80vJHKUBCe9CXsY/tExyzDJUpdFqhc+9h9jIOiujTa6VTLJh4Oa1LVxDXZbR5pO6us00WnIoIlN4LPZKhInRr6z3DOK+lamBABqqqgx98u6eMrwK7+D5PJJev1NBEQml19Pd9H4MahitEZjR5MG3ZxSUqIy66SJ13V3vfSTUNh7irZmGpwIOnrWQ0zn2TvusHk498TipEXoznFn27mFE+6iejy1ODcoM2fq8QPWXMd6Oygr0o01idUN6htbVHuBLnlSXCJdQX3DaYd0/5vEu9Y73uQw5UblpILRVZ8ftVtgl8DLwVBOSGWmySn5PBpDhFQRoSQX0Nd02x2ZWTT0HaQpfTfs9z3T9j4ahfGN1z7OZTyVVZ07h9xl7y+P0UQqou3EC6M0hR9hetu7Q+ppKR/y+/PKXo0s2y5o49h+0PKu6larbdU13WQCNWKHl7A4Gs1NDdN0/wHiioZIw== +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"; + + + + + + + + + + +Download multiple saved queries as YAML files + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/duplicate-a-dataset.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/duplicate-a-dataset.RequestSchema.json new file mode 100644 index 00000000000..ce202cadb7b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/duplicate-a-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"base_model_id":{"type":"integer"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["base_model_id","table_name"],"type":"object","title":"DatasetDuplicateSchema"},"example":{"base_model_id":1,"table_name":"string"}}},"description":"Dataset schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/duplicate-a-dataset.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/duplicate-a-dataset.StatusCodes.json new file mode 100644 index 00000000000..26236545f12 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/duplicate-a-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"base_model_id":{"type":"integer"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["base_model_id","table_name"],"type":"object","title":"DatasetDuplicateSchema"}},"type":"object"},"example":{"id":1,"result":{"base_model_id":1,"table_name":"string"}}}},"description":"Dataset duplicated"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/duplicate-a-dataset.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/duplicate-a-dataset.api.mdx new file mode 100644 index 00000000000..955137d1955 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/duplicate-a-dataset.api.mdx @@ -0,0 +1,68 @@ +--- +id: duplicate-a-dataset +title: "Duplicate a dataset" +description: "Duplicate a dataset" +sidebar_label: "Duplicate a dataset" +hide_title: true +hide_table_of_contents: true +api: eJzdV21v2zYQ/ivEYUATTImTrAUKFv2Qpi3armiD2t0LoiClxUvERiJVknLiCfrvw5GSLDvOMLQDAuyTZYp3vOe5546nBix+q9H5F0YugTeQGe1Re3oUVVWoTHhl9OSrM5rWXJZjKeipsqZC6xU6+jcXDi9KI7G4UJIW/LJC4KC0xyu00CbgxbzACy1KpPeluH2P+srnwI+eHCRQKt3/P0x6a+et0lfQtkkIU1mUwM82DlvzfD7YmvlXzDy9Vb6ghZfCC4f+ZR1R4TRCaRPAW1FWBW7Bcbge9iqgNgGJLrOqInpW3llH0Dhgb2sMCFxltIt8HR0c/gDbaxTrupxHhi26uvD/q+S0mybr6epytAL+r/N3bwJlH4Kksx4fHPxAnkp0TlzhiPIRaf+EazCEF0KyrkQ5e6sXolCSVcKKEj1axyprFkpSsHchjWwjlh/R3H+A5bMWtc+NVX+h5Oy49jlq353PBg1tATI2jEh+eVgkr42dKylRc/anqZk0+pFnuVggq9CWyjlC5A0TWYbOMZ8rxyw6U9sMtwEc/EV0jx8W3Qfj2aWpteRslmMvIZQDBCYNOqaNZ3irSFx3EQ0+AqKjo4dWXmUNpYKaASPV+SVnv1ExRfWhtcZuw3Fi6kIGqJ2HzpqOevLQzeGt9mi1KJhDu0AbUXB2rFmt8bbCjJIWFpnJstreU16vhRfFQEECDrPaEkZ+1sDXGw/87Lyl5i2uHLX4rlU6aui3e5mROA3BuWBQCH0FHLLPn95DAoWYY7H625UAh6y2Bdv7g51+nM5YCrn3FZ9MCpOJIjfO86cHT59ORKUmi8OJjOdNhtacAkvTVDO294alcNz1hkA7Zy9QWLTsp+OTk1fT6cXs46+vPqwbnMSE7c2WFXK2mbPVXskeNSlc4zIFzlJYiKLGFNpH0CYDzNOlz40eAR0WBqiqrIz1fRm5VKe6nwXY82F5vzLO79C57Dv4SKJhjkKidc+bDVYigI6ZFNjPXWe68OYaddtZE/rn2xCnejfVlVXa7/SR79Pmnd3dMRfvxEJMg65GfKwtrtJvtCNKBhrEjVCeXaLP8kDCd1LQRCQl+txIgkD62qSH99vYpnoI9pdeQE3kaBYo+pKsTMb6iUTd1VDc3TM7N3LJ2bvpxw/7scjV5XKnYde4HNHM2l3aTWw/S3VkiHAO7Gxw320yBe4X5mqHtu4+AyrUjcmm54gJ1vEGCUSKgAPpDhKoBI13cC/BlL3QZWKV15aSuzVHsBnAe3rNJC6wMFWJ2nf9KmgnOmoqa7zJTNHyyaQhVy1vqGzaO95OaudN2btIYCGsorbuuhYb3NCzxEsRxsIQJiSAui6pf3V/6Sf0sHX/b2azUzb4aROgaNb9DXjvBDeNjZje0cjJjGVvT8kJYVl3spWqzj7sblvKZd+Mw0QcQYaW3MA86PS1saUgf+9+n1GOwjbg3VsYrpIAuk3I+MLipUWXf68T8uKM/rT6cnx17xfUwT0TeAJKX5rIyBoBdYU2KrT/NhgtkfzivsVhZNX5UoRrtvO/XexrZwz3rcdbP6kKocLYFYTYdHVwBqJSdOAhWa/8DNVw3uviDJqGMH+2RdvS8rcaLV2d5ytphgs0gdh+Qvlc4zIMF6tGEpRc1BTXnSmC6iRaHGcZhk56/97zUW1T94ME5t3HPaUFOFhxQx+o4gY4QAIm8BKUFdZiP6/jiBF9UsppBB+RN0ijeyBU3Suhl6MImybuiH2U6jlCCVcPtOdt2/4NMdy0Tw== +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"; + + + + + + + + + + +Duplicate a dataset + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/embedded-dashboard.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/embedded-dashboard.tag.mdx new file mode 100644 index 00000000000..26d2bd28645 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/embedded-dashboard.tag.mdx @@ -0,0 +1,12 @@ +--- +id: embedded-dashboard +title: "Embedded Dashboard" +description: "Embedded Dashboard" +custom_edit_url: null +--- + +Configure embedded dashboard settings. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get a report schedule log (embedded-dashboard-uuid)](./get-a-report-schedule-log-embedded-dashboard-uuid) | `/api/v1/embedded_dashboard/{uuid}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/estimate-the-sql-query-execution-cost.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/estimate-the-sql-query-execution-cost.RequestSchema.json new file mode 100644 index 00000000000..5f22952aa91 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/estimate-the-sql-query-execution-cost.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"catalog":{"description":"The database catalog","nullable":true,"type":"string"},"database_id":{"description":"The database id","type":"integer"},"schema":{"description":"The database schema","nullable":true,"type":"string"},"sql":{"description":"The SQL query to estimate","type":"string"},"template_params":{"description":"The SQL query template params","type":"object"}},"required":["database_id","sql"],"type":"object","title":"EstimateQueryCostSchema"},"example":{"catalog":"string","database_id":1,"schema":"string","sql":"string","template_params":{}}}},"description":"SQL query and params","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/estimate-the-sql-query-execution-cost.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/estimate-the-sql-query-execution-cost.StatusCodes.json new file mode 100644 index 00000000000..b243f006ab4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/estimate-the-sql-query-execution-cost.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"},"example":{"result":{}}}},"description":"Query estimation 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/estimate-the-sql-query-execution-cost.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/estimate-the-sql-query-execution-cost.api.mdx new file mode 100644 index 00000000000..9127af016f2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/estimate-the-sql-query-execution-cost.api.mdx @@ -0,0 +1,68 @@ +--- +id: estimate-the-sql-query-execution-cost +title: "Estimate the SQL query execution cost" +description: "Estimate the SQL query execution cost" +sidebar_label: "Estimate the SQL query execution cost" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v3DYM/isCMaAJ5uSSrQMKF/mQBinaLmjT3hXbEAepzmZiNbakSPIlN8P/faDkt3vp2qYf+ul8MknzefiQpmsweFehdS9UtoS4hlRJh9LRJde6ECl3QsnJZ6skndk0x5LTlTZKo3ECrXfjjhfqhi4ztKkRmtwghlmOLOOOz7lF1llFIKui4PMCIXamwgjcUiPEYJ0R8gaaCDqfK5F9JajIoPcX0uENGgowZPo/vq3RN+Rj74rtsabvz9hdhWbJnGJonSi5Q9gSwWGpC+7wSnPDS/vVaK05a837iGr+GVMHTRP52gmDGcQXK4SFdC/XXSJwwhFGOG3zfE+POlHWTQMRTQT4wEtNRqOidijWynI4sDxYeKKGv5uom4ZSX4U+wOYyGxAP+KgqHrDVStqgud8ODn5AsQZtVXivTV7XTlZI6f224fB8dioQSrLWuong6Q9lW6K1/AZH6XbC+kq6vSO84Blrmz1mr+WCF6KlGh0ay7RRC5FhBltwjXwDlsOfi+Wj5JXLlRH/Yhaz48rlKF37fNarZguQsWNA8vvPRfJSmbnIMpQx+0dVLFPyiWM5XyDTaEphLSFyivE0RWuZy4UlUanKpLgNYB+PnvjHz9bca+nQSF4wi2aBhqExysTsWLJK4oPG1GEWDplK08p8oWovaRAFO/9wi2llhFtCfFHD53sH8cVlQ+OO31iahTROzvicJuDDXqoynPrcrLcvuKSRln78cAYRFHyOxfC3JTaGtDIF2/ubnb+bzlgCuXM6nkwKlfIiV9bFzw6ePZtwLSaLw4m9o5fHpBv+kwRYkiSSsb1XLIHjVnCe9Ji9QG7QsF+OT05Op9Or2bs/T9+uOpyEcu3Nlhpjtl6xwTZjT+oEbnGZQMwSWPCiwgSaJ9BEPcrzpcuVHOHsD3qkotTKuK69bSIT2Y1ZdtQf72tl3Q49l30/HVHwy5FnaOxRvUZKyL8lJgH2a6v2K6duUTatN4E/2gY4kbuJ1EZIt9Mlvk/GO7u7Yyre8AWfelGN6Fg5HIqvpCVGehb4PReOXaNLc8/B4xioA5ASXa4yQkDiWmcn7szYunYI9adOPnWgaOYZ+hQNLmP1BJ42FRSsO2LnKlvG7M303dv90ODierlTs1tcjlhmzS5ZE9nPExkIomWgJ2eN+tZIFbhfqJsdMt19DtSkq63dbSLMrWw/+IBp5ad5qizVJpAGMejwX3OXQwxfYpyq6UdO6PnKULG31gzWMzqj2yzDBRZKlyhdO7y8lkKgWhvlVKqKJp5MagrVxDV1UbMR7aSyTpVdiAgW3AhaNG07b32YsAtec79Y+DQhApRVScOs/Us/Fjb4ezWbnbM+ThMBZbMar8e7kdw0TGW6J3mJTBn2+pyCEJbVIFupav29ddNQcbvJ7PfJANLP5xrmXrgvlSk5xXvz1wza9ZE6LtwdllwPuonI+crgtUGbPzYIRbFKfhi+c06/fcU9eOSKG4GQ12pzx59WGo3F8S4+OiK9BrvFYSiDdSX3L2mqz3e0y8pT+/e3wwc30QUXfjvwWq7bTroArgWlcBgAFnxOGhy+Z0h6QVsXUNdE0EdTNA0d+xzoHTzI27+RIwgzzbfgLS6pHUbTyXdDUVFiG2sJ9VrwOE5T9NP5y7aXo/FAIxUimLefs6XKyMfwe/qc4PcQA0SgPDHhM4DOwjuiCjtLiEklpFVxxF4vr/aCULW3uFyOMqzrYBGGM82EAMW/zqC5bJrmP4lsU7s= +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"; + + + + + + + + + + +Estimate the SQL query execution cost + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/execute-a-sql-query.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/execute-a-sql-query.RequestSchema.json new file mode 100644 index 00000000000..c179846b187 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/execute-a-sql-query.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"catalog":{"nullable":true,"type":"string"},"client_id":{"nullable":true,"type":"string"},"ctas_method":{"nullable":true,"type":"string"},"database_id":{"type":"integer"},"expand_data":{"nullable":true,"type":"boolean"},"json":{"nullable":true,"type":"boolean"},"queryLimit":{"nullable":true,"type":"integer"},"runAsync":{"nullable":true,"type":"boolean"},"schema":{"nullable":true,"type":"string"},"select_as_cta":{"nullable":true,"type":"boolean"},"sql":{"type":"string"},"sql_editor_id":{"nullable":true,"type":"string"},"tab":{"nullable":true,"type":"string"},"templateParams":{"nullable":true,"type":"string"},"tmp_table_name":{"nullable":true,"type":"string"}},"required":["database_id","sql"],"type":"object","title":"ExecutePayloadSchema"},"example":{"catalog":"string","client_id":"string","ctas_method":"string","database_id":1,"expand_data":true,"json":true,"queryLimit":1,"runAsync":true,"schema":"string","select_as_cta":true,"sql":"string","sql_editor_id":"string","tab":"string","templateParams":"string","tmp_table_name":"string"}}},"description":"SQL query and params","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/execute-a-sql-query.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/execute-a-sql-query.StatusCodes.json new file mode 100644 index 00000000000..064893f34db --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/execute-a-sql-query.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"object"},"type":"array"},"data":{"items":{"type":"object"},"type":"array"},"expanded_columns":{"items":{"type":"object"},"type":"array"},"query":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object","title":"QueryResult"},"query_id":{"type":"integer"},"selected_columns":{"items":{"type":"object"},"type":"array"},"status":{"type":"string"}},"type":"object","title":"QueryExecutionResponseSchema"},"example":{"columns":[{}],"data":[{}],"expanded_columns":[{}],"query":{},"query_id":1,"selected_columns":[{}],"status":"string"}}},"description":"Query execution result"},"202":{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"object"},"type":"array"},"data":{"items":{"type":"object"},"type":"array"},"expanded_columns":{"items":{"type":"object"},"type":"array"},"query":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object","title":"QueryResult"},"query_id":{"type":"integer"},"selected_columns":{"items":{"type":"object"},"type":"array"},"status":{"type":"string"}},"type":"object","title":"QueryExecutionResponseSchema"},"example":{"columns":[{}],"data":[{}],"expanded_columns":[{}],"query":{},"query_id":1,"selected_columns":[{}],"status":"string"}}},"description":"Query execution result, query still running"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/execute-a-sql-query.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/execute-a-sql-query.api.mdx new file mode 100644 index 00000000000..2d09583546e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/execute-a-sql-query.api.mdx @@ -0,0 +1,68 @@ +--- +id: execute-a-sql-query +title: "Execute a SQL query" +description: "Execute a SQL query" +sidebar_label: "Execute a SQL query" +hide_title: true +hide_table_of_contents: true +api: eJztWVFv2zYQ/isEMaAJptRJ1wGFij6kWYqmzdq0drENceDS0sVmQ5EKeXLiGfrvw5GSLDty67YYigJ5skzeHXnf3X06Ugtu4boAh89NOufxgidGI2ikR5HnSiYCpdG9T85oGnPJFDJBT7k1OViU4LyaQKHMhB51oZQYK+Ax2gIijvMceMwdWqknvIx4oiRoHMl0O2kUbpQBTs128qlAMRYOKvvVvNQIE7AkALe50OmI5D5jcGyMAqFJofb9y5LXBdj5qcwkfka+tRVb6EM318l21pfYfxEEBwoSHAk3Srb10l2rFl4tU9dqBKlEY7eNGIrxdnKQ5UognAkrMredSpaPkCRGWmSwhQqBDNeFtJDy+HwlOYLLF42KGX+CBHnEUSLZ48e3kBS0vbkyIu0H9H0CiSxXsJL29YIr2d0abCfxcnglVw/WUjP4E5IvPLfT66CdPWG6zo+l/bU0qMQo0C2Z1fguJ3wYW3/XotWaWQvKEnwqR3CJlTmRCI95/90p814woVOWB1PtENEWfcxcbrQL3PJof/97mMmoItP+USKEPFuNeNmkgLBWzGsS+TqNEDpIR9+0nsekY+9ToSeQjoKHl8ZmAnlMu4M9lBnwDXzZWrNV4em4s8DT8ckmptTpH4hZa1IX2bias9bYP8E5MdmmDgkgX01pfwPPwC1a0QnWCpEvFVTNs3c37qeknrwQCRrbqZ1bM7HgXLcBH49NsFhwhUL3Guadlq252WB1maIdhG1nYDet+BluPvale9INkUNhcWMIHQqETr2KwTsZu7/9W4jEB0FiG2krkiupJx+s2kq+cNAdWproRrLcTPbvKOLvfWSbBNjYQgRe/dZiJ9wL17H1L20vvJCk0e8reux+J9V7Ol+UFzWVhee7JBXGa/pZcfygy88gX3vwGab3G2ZQ75jZBtpH+4/u6fyezu/p/J7O7+n856bzqGrmHUqlmC20rmL2+Lta9mzJQ1+CdBWrRpE/FymrbjZidqJnQsnqvAEI1rHcmplMIe3ytaUbfDn4sb580KLAqbHyX0hjdljgFDRW67Pm6NThSFsxePLbj/XkhbFjmaagY/aPKVhq9ANkUzEDloPNpHPkERomkgScYziVjjLNFDaBLgcbe8G7xz/WuzcG2aUpdBqzwRTqFIK0cYGlBhzTBhncSkquux41NmiV3390FZ1oBKuFYuF9xnyXELNDzQoNt7knkzDITJIUdkMevqBbkiDnF3eQFFbinPiHf7pBHp9fEA+hmBAn+VuCUzGmu5nbvcSk0Pd783zFldB035J8eH/KI67EGNTyb5UqMU8Kq9je3+zsbX/AhnyKmMe9njKJUFPjMH6y/+RJT+SyNzvouWt6NfWqjqY35Gw4HGrG9l6yIT+sKshjHrPnICxY9svh0dFxvz8avH19/GZV4ShEa28wzyFm6wFbyqbswWLIr2A+5DEb8plQBQx5+YCXUePk2RynRrfcbAYaR2WWG4t1srmhHur68oQ9a4Yf5sbhDq3LvhqNKKhNQaRg3bPFGiZh+xUuQ85+rap3hOYKdFlpk+/Puvwd6t2hzq3UuFPv+yEJ7+zutpF4JWai71OqhcbK4DL0RjsCpAFB3AiJ7BIwmXoIvgmARfAj3OGRA5RZ6+DEtRhbzxxy+mOdPIuA0MAD9DFaqrRzJ8B0N3+CdI3r2KTzmL3qv33zMFS3vJzvLNgVzFsgs3KXpAnrp0Md8KE+osFmDflKyCh4qMxkh0R3n3LffazUdXVBygRr7vV4xJtrTso5HvFc4JTHfAO8vG6WQ3UX1C12x4evL39K0yyFGSiTZ6CxoimfN8HQIrcGTWJUGfd6CzJVxgsqmPKOtaPCoclqExGfCSupYXUVs3oz9JzCpaC2MmyT07mqyIi2qr/04/gdsF4OBmessVNGnHazaq/x987m+oF/aY7uWJmx7OTMn3uMXTPSCVWl76XL0vd8FQf7njM46Zl4wcc+S1/Up9NXfw14ddbxB1A/uzypeqfpI8kNjixcWnDTbzVSfWp5v/wgdfz/3LTvf9VN+/5PcNMecakvTUiElbgXOVgH7aNHa4iqLsjNDkIyOcxE+NYV7HdX+MoaTXeBcIu9XAnpu7EiHPtC8Z9zkUta8CDAoMSYN1cIPOJULaEczvliQXH6YFVZ8uVZ5vxiWZG+XYh44FzPGld0dl9hT1/AqvAHtfWeieghaBwmCfiXx2bZixahEeXziI+rT6WZSUnHihv6hCFueMx5xI3HxReUHwuvsCI0VMEmZTp15u17nboiqgfyqj5o6nlrh4tFkAgvD6Kx4Ip/2/LyoizL/wCq9VFC +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"; + + + + + + + + + + +Execute a SQL query + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/explore-form-data.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/explore-form-data.tag.mdx new file mode 100644 index 00000000000..252da1d576d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/explore-form-data.tag.mdx @@ -0,0 +1,15 @@ +--- +id: explore-form-data +title: "Explore Form Data" +description: "Explore Form Data" +custom_edit_url: null +--- + +Manage temporary form data for chart exploration. + +| Method | Endpoint | Path | +|--------|----------|------| +| `POST` | [Create a new form_data](./create-a-new-form-data) | `/api/v1/explore/form_data` | +| `DELETE` | [Delete a form_data](./delete-a-form-data) | `/api/v1/explore/form_data/{key}` | +| `GET` | [Get a form_data](./get-a-form-data) | `/api/v1/explore/form_data/{key}` | +| `PUT` | [Update an existing form_data](./update-an-existing-form-data) | `/api/v1/explore/form_data/{key}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/explore-permanent-link.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/explore-permanent-link.tag.mdx new file mode 100644 index 00000000000..5a06feba933 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/explore-permanent-link.tag.mdx @@ -0,0 +1,13 @@ +--- +id: explore-permanent-link +title: "Explore Permanent Link" +description: "Explore Permanent Link" +custom_edit_url: null +--- + +Create and retrieve permanent links to chart explore states. + +| Method | Endpoint | Path | +|--------|----------|------| +| `POST` | [Create a new permanent link (explore-permalink)](./create-a-new-permanent-link-explore-permalink) | `/api/v1/explore/permalink` | +| `GET` | [Get chart's permanent link state](./get-charts-permanent-link-state) | `/api/v1/explore/permalink/{key}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/explore.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/explore.tag.mdx new file mode 100644 index 00000000000..0f4413ebcfb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/explore.tag.mdx @@ -0,0 +1,12 @@ +--- +id: explore +title: "Explore" +description: "Explore" +custom_edit_url: null +--- + +Chart exploration and data querying endpoints. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Assemble Explore related information in a single endpoint](./assemble-explore-related-information-in-a-single-endpoint) | `/api/v1/explore/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-all-assets.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-all-assets.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-all-assets.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-all-assets.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-all-assets.StatusCodes.json new file mode 100644 index 00000000000..b61948eba2f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-all-assets.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"ZIP file"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-all-assets.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-all-assets.api.mdx new file mode 100644 index 00000000000..e62264d51a3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-all-assets.api.mdx @@ -0,0 +1,60 @@ +--- +id: export-all-assets +title: "Export all assets" +description: "Gets a ZIP file with all the Superset assets (databases, datasets, charts, dashboards, saved queries) as YAML files." +sidebar_label: "Export all assets" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/iuHwz4kmBInQwcEKvrBC9I0XdYGs4O9REFKS2eLqUyq5MmxK+i/D0fJiu16BdYP6ydRR/Luee6VNWbkU6dL1tZgjJfEHhT8fXUDU10QPGnOQRUFcE4wqkpynhiU93LuIFOsJsqTj0CWIowgzZXjIPH5xCqX+Qi8WlAGnypymvwhKA9/DX+7Dib8MUboyJfWePIY1/jTyYl8UmuYDMtSlWWhUyUYB591KSKf5jRXsppaN1eMMU60UW6FEfKqJIzRs9Nmhk3TRDss1/SwifDFyelXrD16ubBprnS2JMe6xTon79WMZLlrtcdhJ4+UstiipZqXBW1dxFujKs6t058pi2FYcU6GO/vg6FOlHWX7WGxebJm8+L5M3lmGqa1MFsM4p4CdPFMGjrytXEqQWfJgLAMtted9pHodYuXnr2bC/8DoyjA5owrw5BbkgJyzLoahgcrQsqRU2AUh2DSt3L9E6rViVbTngnFPaeU0rzC+q/HxiTG+u2/uI2Q18xjf4dW8tI4HtJQP3ke4PEptRqOA0IdbhTIzjDG9/f0aIyzUhIrn39bb8l+5Ao7+hMuLMSSYM5fxYFDYVBW59RyfnZydDVSpB4vTQVvTnc1BgpAkiQE4egMJDrs8C36P4RdSjhz8MDw/vxiNHsbvf714lyA2UQ/rZsW5NRvAekEPTQeO6yTxiUnMugvAq158PCM+EBzwX/FH7a2cVEbOv6p3WCQYQ4IdkwThR1BpSt4/sP1IpknMYWJKpw0frFEdS74dHB5u8nyrFmoUAr3BdUv4HAprvNDtKaonpRmmxGkeGH4Lv3qLZLz+h92YCdsP67DVLdNxIPqhvdHIR1i/TEyLVBp6j3LHB90hW9BxYWdhDBy+RMngOXFuM4xxRsK+VJxjjPs5iHdCWbUZXTlx3l4f4G5BXcs2ZLSgwpZzMtwVaIhNq6gunWWb2qKJB4NaVDVxLXabL7SdV57tfK0iwoVyWk2Ktous1cg6o6mqCu5gYoRkqrkUbPcrHy/1uq3/zXh8A72eJkJBs62v5/sFuFHbeWTPqDmBdXB1I0pCb9hSstdV3f1wumkkRuvuM5K+2ZIMPajGSciQ1+uB+vaPscQoHJP5Gnaf52sg3URy+cHR1JHPv1VJE6E2U9vS2ULfPTnkgmZpz5siyZ323OK0dYnnuQpDQXyFMV6EVAsvmDb5dv2zMV2+1+On8wTTkgdlobQRKiGJ666A7lCVWvieYoQ9j248RCgZ16bUHda1YLp1RdOIWKzKmLl/zuowbCJse0aovI+0whiHaUqhZS1UUQmg3VfXVn1fXkhY5QGyMV/74HYLUd5tKbPaUF3X7Ym2B0lFthhC88XmvmmafwBddqTy +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"; + + + + + + + + + + +Gets a ZIP file with all the Superset assets (databases, datasets, charts, dashboards, saved queries) as YAML files. + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.ParamsDetails.json new file mode 100644 index 00000000000..44d1d1bbab0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The SQL query result identifier","in":"path","name":"client_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.StatusCodes.json new file mode 100644 index 00000000000..569a6285260 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"text/csv":{"schema":{"type":"string"}}},"description":"SQL query results"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.api.mdx new file mode 100644 index 00000000000..bcd96f4d733 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-the-sql-query-results-to-a-csv.api.mdx @@ -0,0 +1,68 @@ +--- +id: export-the-sql-query-results-to-a-csv +title: "Export the SQL query results to a CSV" +description: "Export the SQL query results to a CSV" +sidebar_label: "Export the SQL query results to a CSV" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYcASTImTrQMCFf2QBklfFnRZ7ewFUZDS0tliSpEKeXKTCfrvw5GyYsceOqwf8kkSdTw+z/Hhw2uhlk5WSOg8pFctFOhzp2pS1kAKkxLF+LdzcdegexAOfaNJqAINqZlCBwkoDqsllZCAkRVCCrlWaOhGFZCAw7tGOSwgJddgAj4vsZKQtkAPNQcrQzhHB113zdG+tsaj54AfDw74kVtDaChMwXsa5X7B7xuJPDll5tB1XfKExFMCHroEXmxkl3WtVS550ujW88zVVWpna3SkIrYKvZdz3LZ8shyx01vMidfCe1nVGtcmwmtZCK4OekrFO7OQWhXicTNE7exCFVhsY7QyN3I5fF4ul0Y2VFqn/sYiFccNlayQuL4YJLCFyOrEyOSn52VyZt1UFQWaVPxlG1FY8z2JUi5Q1Ogq5T0zIitknqP3gkrlWVW2cTluIzjki+xePC+7D5bEzDamSAWf7F5CWAwURGHRC2NJ4L1icW0yGnLwKj8/9yl6ZwidkVp4dAt0Ap2zLhXHRjQG72vMmV0YFDbPG/cvOjyTJHWMC4t7zBun6CFY4u0XgvTqmg2K5JxtMljKuZzCdQL3e7ktcBywRQvV0szZBi8/nkMCWk5RP372Ukkhb5wWe3+KN6cTkUFJVKejkba51KX1lB4dHB2NZK1Gi8ORv9NaTkd4X1tHo3bw126UgciyzAix91ZkcNyfpVD9VLxG6dCJ745PTk7H45vJr7+cfsgAumSAePFApTUrIIeBAaaqeNGlVHxmMrN0afFqGN6fI+0wDvEtXJKYoURZoPOv2ieMMkhFBj2rDMQP/Sm8IfsZTZeZ3czUThnaWSLcZwXu7O6ucn4vF3Ictn6F99rg4xZZ45n6QFd+kYrEDCkvA9tv5dquEU6X3+LpXjLzT8vtbCPrSSD9Kc7o+MEVeJmZiLqQJAfET+rRB1mN+9rOdzh09yWwvtdPxWkALmhLE+CDCYqT8e+QQIVU2gJSmCPXL3QDKXy9ClzrcGzjuWkcb8XWisJTaOf8WxS4QG3rCg31BhB2OiZqa2fJ5lZ36WjUcqoubRlDt5HtpPFkq2WKBBbSKTnV0aWWafi9wJlsNPUwIQE0TcWG0H/yw8NGId9OJhdiyNMlwGjW8w18N8CNo7PxP26whHXi3QUnYS7rSbaWqp8forvQZi3dbcy+HEkGj2thGjR2Zl0lOd/7PybQ92x8HuJfGLw5kO4SnnzjcObQl/83Sced5MxGOmvomxqdD7oiRWz/q0OsnRi3OIwl8VTJcOn0zeh/1fDaqsN9FDrOWksV7u+gq7bX9xXIWjGEQ2YXNM56CMtBAulqF8yKiFt+BW07lR4vne46Hg6A+Hp5VF3sw5Xn9wLSmdQeNwAOVy7sfOwbrF3x9XZ9K69+UJqHoH3d8Bck8Bkf1tr57pqlG8wqYIz/j/Mcg28uZw5tOmtt8IY3pywDbvdW6juIoX/hrFvRtG2MiK7XDeCC9TOwrvsH/lRpvg== +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"; + + + + + + + + + + +Export the SQL query results to a CSV + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/format-sql-code.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/format-sql-code.RequestSchema.json new file mode 100644 index 00000000000..937ce244b75 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/format-sql-code.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["sql"],"properties":{"sql":{"type":"string","description":"The SQL query to format."},"engine":{"type":"string","nullable":true,"description":"The database engine."},"database_id":{"type":"integer","nullable":true,"description":"The database id."},"template_params":{"type":"string","nullable":true,"description":"The SQL query template params as JSON string."}},"title":"FormatQueryPayloadSchema"},"example":{"sql":"string","engine":"string","database_id":1,"template_params":"string"}}},"description":"SQL query","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/format-sql-code.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/format-sql-code.StatusCodes.json new file mode 100644 index 00000000000..f02329ada24 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/format-sql-code.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"},"example":{"result":"string"}}},"description":"Format SQL 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/format-sql-code.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/format-sql-code.api.mdx new file mode 100644 index 00000000000..a03612d8d26 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/format-sql-code.api.mdx @@ -0,0 +1,68 @@ +--- +id: format-sql-code +title: "Format SQL code" +description: "Format SQL code" +sidebar_label: "Format SQL code" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYUASTImTvQABi35IgxZtFzRp7WIboiClpYvFhiIVknLiCfrvw5GyLMdOh2Yf+skydXfk89xzx1MDFu9qdP6VyRfAG8iM9qg9PYqqUjITXho9+uqMpjWXFVgKevKLCoGDmX7FzEMS4kiLOfBLcHcKrhKorKnQeokuuN6pgZ/zVuoZJJCjy6ysaBfgMCmQjT+esbsa7YJ5w26MLYU/gDYB1DOpcVsMXSslpgqBe1vjtpi58GIqHLIYJMRbrl3LfBBUao8ztN8XVeYhoseyUsLjdSWsKN3zjjqA34VjMRwTjr0fn39gMdgBtLSl9BQM3gSePpLfhVgoI/JxTBUR9yDKSmGfhNVplpQO0jEk5WgLpKVpS7uvn74/+ZocCGdLC64y2kUt/HJ4+F1iW1eSRVcrv8lu4GNNluvgl37fgBBpDDnorNsEfvtfpy3ROTHbotv/Om7vCK9Ezro65eydngsl8ygK9Ggdq6yZyxzzbYgGvhHL0Y/F8lmL2hfGyn8w5+yk9gVq3+3PetVsATJ0jEh+/bFI3hg7lXmOmrO/Tc1yo3c8K8QcWYW2lM4RIm+YyDJ0jvlCOhKVqW2GT2gvxqMdf//RmnunPVotFHNo52gZWmssZyea1RofKsw85nGRmSyr7RNZeyO8UNEubO4wq630C+CXDXy998Avr9qrBLyYObo6qPLOxJSuj4f9zOQ4DmdzwV4JPQMO2edPZ5CAElNUq78dsRyy2iq2/xe7OB9PWAqF9xUfjZTJhCqM8/z48Ph4JCo5mh+N3B2141G8Za7dnRqlwNI01Yztv2UpnHSSC7Rz9gqFRct+Ojk9fT0eX0/O/3j9Yd3hNCZsf7KokLPHOVvZ5mynSeEWFylwlsJcqBpTaHegTXqcFwtfGD1A2i/0WGVZGeuXBe5Sneplo2Uv++WDyji/S/uy5xCSRM8CRY7WvWwe0RIRdNSkwH7uFH/tzS3qtvMm+C+3QU71XqorK7XfXR79gIx39/aGZLwXczEOwhoQsra4EoDRjjjpeRD3Qnp2gz4rAgvP5aCJUEr0hckJA0nsMT98acYe64dwf1lKqIkkTQJHX5KVy1BBkalNFUXrJbVTky94GA0OYpnLm8Vuw25xMeCZtXtkTXS/SHWkiC77np5H5HdGRuGBMrNdMt17AVSqT96YVK6QQKQHOJDqIIFK+AI4PM0u5S40mVjltaXUbs3Qxrx4Rq9ZjnNUpipR+65dBeXEQE1ljTeZUS0fjRoK1fKGqqbdiHZaO2/KZYgE5sJKGtZc12FDGHrO8UbEUYKOGQapuqT21f2lHwcbXL2dTC5YH6dNgE6zHq/Hu3G4cezD9E6LEpmx7N0FBSEs60G2UtX5B+u2pUQue3GYFCPI0JEbmAaRxtRSmf05oRwFM+DdW+hvkgC6Tcj52uKNRVc8NwhFcUZ/Wn2UvH7u8Hr4reE1AalvTGRtjaS6QuuQ2F9O1oMlkmi0mx9F5p0vRbiJKSVbq2Etfn8de3zwo0oJGS77INSmK5RLEJWkzY6IrlAskMCqXCABUlaUziU0DSH+bFXb0nKcv/nl1Uq94YpNILanUGG3uCC1DxpNELuq6WgbcwaVUvQ4yTIMrfZp26tB/VN3hASm3adlSYRwsOKevg/EPXCABEygJs71tBYbfh2HkBiTVEGz34C/Xj3dA6HqXgm9GJywaaJF7LNU8hFKuJugvWrb9l9gLiiw +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"; + + + + + + + + + + +Format SQL code + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.StatusCodes.json new file mode 100644 index 00000000000..32532dc8eec --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"dashboards":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"}},"type":"object","title":"ChartRestApi.get.Dashboard"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get.User"},"params":{"nullable":true,"type":"string"},"query_context":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"tags":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"ChartRestApi.get.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"ChartRestApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"cache_timeout":1,"certification_details":"string","certified_by":"string","changed_on_delta_humanized":{},"description":"string","id":1,"is_managed_externally":true,"params":"string","query_context":"string","slice_name":"string","thumbnail_url":{},"url":{},"viz_type":"string"},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.api.mdx new file mode 100644 index 00000000000..fa630a95aaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-chart-detail-information.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-chart-detail-information +title: "Get a chart detail information" +description: "Get an item model" +sidebar_label: "Get a chart detail information" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isEsQ8JpsZJlg6Fin5w07TN1rVF46wD4kClpbPFhiJVknLiCvrvw5GSLNty6nQD8skWyTs+z/HeyJImYGLNc8uVpCF9A5YwSbiFjGQqAUEDmjPNMrCgDQ2vSspxXc5sSgMqWQb4dUMDquFbwTUkNLS6gICaOIWM0bCkdpHjKi4tzEDTqgpKGitpQVqcZnkueMwQweCrQRhlRzjXKgdtORj8ipUoMun+IkbTUW+s5nJGq6AZYFqzBX7fwGJVAmSR0fCKmlTdRo3KoGuKzqhgExCdbydkuRWABlAS6HXwIwzLATX5CrGlAfUaQjoDGyGwqKZc4WJn428F6MXSyN9odY1WNrmSxlvj+PDQG+WnbNlHd4vBI4+hXPOWUQqkM0KmShObAvFCBIUOyGcuBJkAsZpJI5iFhEwWZIJWpQGFO5blzhBD8p7H9+mjG2beMCuaLunH6VyaJ5tK1k/44SZw8v8L+T5Nu9HWYAphe8CzOIXI8gxU4aZlIQSb4KY+TNeDM6AxSk9rL4oSsIwLc4/o0pC1JCTRZLGbQMrkDJLI7SMsi9IiY5J/B3eIGljyQYqFF68CmjCTThTTSc8ptXN1bIYlzdjdO5Azm9Lw6eFh8GM43nc2LYKRFGVgWcIs24HYPeF+mjJtP4Gxw5wfzMAevGpw40YrvrWD/bYB5ibKmGRoWrizoCUTYtFZOlFKAJO4VN1Kl9nX7Tnl2tjW6Tum/P3kAUAE21lJ1S0hV939u2quH2DaS+NBuAK2mwe7nBu5hHp3X7gsJYzgMfRRPH66i8tZNusx/jZz/vw2bqCtfEfBcfBbcHL9IE8dMa8qLbKJZFxEhRa9YbptfM6/Rw2QBzJ4AE53KN3CvpGzh0RwY4makmVV372b6NT/Hs1uglhFNMgE9O4V4CJVt+Qci9SrOuPulPdbBVvr+Ur52qHK1tHc7NpTHns19paulcK0VoqOtlaa5darBaUzfl/dWM+jSzHkdbQ1O3rHa5LFUmotJywnuqG/HF2PjzYgViKgm0FWnPWqmbledbUeB3Gt4ipVNz/VKiN/ue69CujJf2oSMzCGzaAnMn7gja0gfckSgpkdjA3JuZwzwROyvFSQXKs5TyDp49OR9VyOHpfLpWSFTZVGVwvJsLApSFvvT9ry1UOkK+iZnDwuk/fKkqkqZBIS7GFrIwOa26hCY45QYIhUlsAdR/Nvkmp1OEbHx499NrlWMX5OBBA8F7sIyd/obv58QGul+3icqkIkjmqtoZbGrZ4+dvicS5+iiAE9B+1ZhGQoSSHhLocYD80NEhXHhd7igK+ZZaI1QUANxIVGjnin/3praXh1jRdM35Bc+bJqMAvdPYlVAhcOmn8CEEzOaEjjy0/vmvqw/PTeg9+FFuTJP+TN2YiMaWptHg4GQsVMpMrY8Nnhs2cDlvPB/GgQ42aDozEl4/FYEvLkLRnTYR0wztIheQlMgya/DE9Pzy4uotGHP8/ejynFx4Qaz8eFTZXsIGoHWkw8y5W2jbebsRzL5kZNXrTD2EbsIQ6yM/DAL0+BJaDNi3IN/piGZExrCmNKfiUsRkeLrLoBWY3l/ljmmku718A5QNfa29/vEvyDzdmFO9MOyZXBpfGVNMiz5cZuGbdkCjZOHbUHEStX2IXNN1k/JaT5pTmo0lMcOYZfvESFP0j3+Vh6iHilauGtka8XKQEHQs32cOn+c/cMkoFNVeKfT9wTFTaSdBV8md9UaBIXNt5xXSHuJ07XA+YdTpME5iBUnoG0dQC6A/GKylwrq2IlqnAwKFFVFZboYNWGttPCWJU1KgI6Z5pjnmqaf6fGd3FT5homBxNbxPqxqv7EHxeWq/rfjkYfSaunCiiiWdXX8t0Ad+EzC85hN0OUJucf3c1J6TUlvaaq5d3qqsLzabLLBeZFT9LlmJJOnHe8VjpjqO+PzyNavxW6i6mbXba+jjTewG9tpGGqwaQ/q8Q9q03VZtN+UeSgDXTvFJ0h9B2/bn7kTWJsxvz13Hd+7s2UOJ8jvocluBFi4y77rN3q21LS+9paY8Zec5ALxl0TXd+ovJtfUZZzRHbkO2GNMMP8Bp3Cn/oVLcsJM3CpRVXhsH9KxAjYimXb1jewcI+P6LKiwHkXgI3/eqXc1dyEhlMmDNzDeO9T3SPtk20bNvctueju2QDJb2h1je7tUpHb3U8M4xhcCmxENsr0St54c4Yugz1Z91mkcZz6D2rvhVOWfoXPbVWLzmVzBFhV/wIWHBgu +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.ParamsDetails.json new file mode 100644 index 00000000000..d61a43745de --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"digest","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.StatusCodes.json new file mode 100644 index 00000000000..30de2de2f9a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Chart screenshot image"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.api.mdx new file mode 100644 index 00000000000..d24e6feb735 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest +title: "Get a computed screenshot from cache (chart-pk-screenshot-digest)" +description: "Get a computed screenshot from cache (chart-pk-screenshot-digest)" +sidebar_label: "Get a computed screenshot from cache (chart-pk-screenshot-digest)" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYR/sTY6SoQMCFf2QBmmaruiC2sEGREFKS2eLiUSyJOXGE/TfhyMl2Y49YFiH5ZPEt+ee53h3vAY0N7xCh8ZCctuAkJCA5q6ACCSvkEaPEIHBr7UwmEPiTI0R2KzAikPSgFtr2iWkwyUaaNvoIEoulmjdP0Gyzgi5hLa9o81WK2nR0vrPx8f0yZR0KB39ioovMf6RfjcwC2Uq7iCBuZDcrCHaA24jyNFmRmgnFFE9L7hxzGYGUdpCOeaBoY3g1Z5NrnUpMk4n4wdLx7eNa6M0GicC4wqtJaAD4gZWav6AmSNb+MQrXeLOQXjLc0YuQ+sSdiVXvBQ521wa00atRI75IVlbZ4OWk5fVciN57QplxJ+YJ+ysdgVK19lnQ1wcELJ9MCh59bJKPinHFqqWecJmBfZORnK3VbXJkOUKLZPKMXwS5P59UQMGWfnlpePsSjo0kpfMolmhYWiMMgk7k6yW+KQxI3V+kqksq83f3NQ77ngZ9nnjFrPaCLf2xeXhm4Pk9o4S2/ElFZyQeRbuIniaZCrHqacWalHJ5RISyG4+f4QISj7HcjMMbqZxbUo2+YNdXsxYCoVzOonjUmW8LJR1yenx6WnMtYhXJ3FGxuKTeJPocRPqUhunwNI0lYxN3rMUzrpw8+5P2FvkBg374ez8/GI6vZ/99uvFpxSASl1H8nrtCiW3aA4TA1FRaWVcHys2lansyxt7M0wfLdGNiAf7PjVRwCiQ52jsm+aZphQSlkKnKwX2E+NZhtbeO/WIsk3lOJXaCOlGPccjCsLReLyt+gNf8am//S3lO5Oba1LSkvhBMP/GhWMLdFnh9X6/2mZHctKP2fP7JO1f+ittgu6Zl/0lnGjpQz54ncrAO+eOD5yfeaTbpEo8KtVyRFvHr4GCfDc1LtExzjJV6Zpyaeu1WRhVsYxnBbKR1znRj5PN+iToHEMEFbpC5ZDAEsm7/olNYNdHjX5sD7qJrsMnd0iv2tBtHXQ6POf+kZZZjissla5Quq5M+GAIQI02yqlMlW0Sxw1BtUlDEd/uoZ3X1qmqh4hgxY3g8zLUsh6G/nNc8Lp0HU2IAGVdUdnohvTxxWMX//1sds0GnDYCYrOLN+jdIzcN9Y/WqHVhyrCrawIhLbsgB13Vnfe7W9/E9DVwStU7iPSVsIG5D8J3fcPy4fcZdA0RpUxY3fQvXnQb0eF7gwuDtvi3IG0EQi5UkLPDvtZorA8uJxw9EttTFDth3+okuMS6ivunqWvz/osg32E0vGgOn1ysSy4kWfYx13QJcAtcC6J3AhF4bIgg8X3rxgBNDU0oxUwIiltomjm3eGPKtqXprzUaeq7uNnHp0yUXlv5zSBa8tLhHc3i6YfS5a2XGbOP3XfrdJJdrH/5lTSOI4BHXoeOmvPofLXaOae8oWXz99JrD4lmWoS/m/bG+7abgHirS5QXFHfVpW5c2RF/3Q6AHmTRN2BHqcDsQ888R8WrbvwAO41mu +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"; + + + + + + + + + + +Get a computed screenshot from cache (chart-pk-screenshot-digest) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.ParamsDetails.json new file mode 100644 index 00000000000..395d5c98f92 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"digest","required":true,"schema":{"type":"string"}},{"in":"query","name":"download_format","schema":{"enum":["png","pdf"],"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.StatusCodes.json new file mode 100644 index 00000000000..4beeba52627 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Dashboard thumbnail image"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.api.mdx new file mode 100644 index 00000000000..752b46af063 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest +title: "Get a computed screenshot from cache (dashboard-pk-screenshot-digest)" +description: "Get a computed screenshot from cache (dashboard-pk-screenshot-digest)" +sidebar_label: "Get a computed screenshot from cache (dashboard-pk-screenshot-digest)" +hide_title: true +hide_table_of_contents: true +api: eJzFVl1v2zYU/SvExR6cTY6SoQUCFX1IszRNV3RB7WADoiClpWuLiUSyJOUkE/Tfh0tKspx4wLAVy5Mkijz3nPvF24Dmhlfo0FhIrhoQEhLQ3BUQgeQV0tcdRGDwWy0M5pA4U2MENiuw4pA04B417RLS4QoNtG20EyUXK7TunyBZZ4RcjYC+1WgeR0jqXpaK5zdLZSpOkBsIlHUFyRVouYIIdL6E6+gZ7jWRsFpJi5YO/XxwQI9MSYfS0auo+ArjH+l1g92ZS2AhJPeEngK3EeRoMyO0E4qY/8JtsVDc5MwVdbWQXJTMY0MbwatnZrnWpcg4HY5vLSGM7WujNBonAukKrSWgXX7rV9TiFjNHtvCBV7rErYPwjueMooHWJexcrnkpcrbJB6aNWosc813KRmeDlsOX1XIpee0KZcSfmCfsuHYFStfZZ0PK7RAyPhiUvHpZJZ+VY0tVyzxh8wJ7JyO526raZMhyhZZJ5Rg+CHL/c1EDBll5/dJ5di4dGslLZtGs0TA0RpmEHUtWS3zQmJE6v8hUltXmbyL1njtehn3euMWsNsI9+r51e+8gubqm2nZ8Rb1sU3yWmsDDNFM5zjy90OpKLleQQHb55RNEUPIFlpvP4Gr6rk3Jpn+ws9M5S6FwTidxXKqMl4WyLjk6ODqKuRbx+jDOe4PxYWwzgyhtoVzchNbXximwNE0lY9MPLIXjLu18GBL2DrlBw344Pjk5nc1u5r/9evo5BaAm2BG9eHSFkiOqw8JAVlRaGdfnjE1lKvtOx94Oy/srdBPiwf67oijgFMhzNPZt80RXCglLodOWAvuJ8SxDa2+cukPZpnIvldoI6SY9z31KyMne3lj5R77mM58JI/Vbi5twKWnJAYNofs+FY0t0WeE1fx/FzZbspP9mT+NK+r/2oW2C9rmX/jWcaOlBfniTysA9544PvJ94pdukStwv1WpCW/feACX9dqmcoWOcZarSNdXWRghbGlWxjGcFssmgdarvpps906B1DyKo0BUqhwRWSF72N3oCz33V6Lt2p7soNL7oQ8nVhiK3MwDwVMMn+s1yXGOpdIXSde3DJ0YAarRRTmWqbJM4bgiqTRqqgPYZ2kltnap6iAjW3Ai+KEOP62HoPcclr0vX0YRoGCm6T3r4hrKN/2E+v2ADThsBsdnGG/Q+IzcLfZH+0YzDlGHnFwRCWrZBdrqqO+93t36+6XvjjLp6EOk7ZAMLn4zv+1nm4+/zfoCi8gl/N6ONF91GdPjG4NKgLf4tSBuBkEsV5GyxrzUa6xPMCUeXx3iJcifsWx8Gl1hXcX9ldfPg90r2LVbDbefwwcW65EKSdZ93TVcIV8C1IIqHdLrHhwgSPzJvjNDSMP9S7oTkuIKmWXCLl6ZsW1oOgy4VSi4sZWcOyZKXFiO4w8edo++alzXR9E2gT+rdEE/0DfMATL5089Ee2wRtW3e3yOXj2GZPS9/5ovwfLXbebK+p0nwT9prDz+MsQz12Tj/Ok4+GlnZ2SklLw98o2kPqdi8EupNJ04QdoZm3AzF/rxGvtv0LaGCW7w== +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"; + + + + + + + + + + +Get a computed screenshot from cache (dashboard-pk-screenshot-digest) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.StatusCodes.json new file mode 100644 index 00000000000..b5f9b1cc89a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get.User1"},"css":{"nullable":true,"type":"string"},"id":{"type":"integer"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"CssTemplateRestApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"changed_on_delta_humanized":{},"css":"string","id":1,"template_name":"string"},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.api.mdx new file mode 100644 index 00000000000..dac194110e1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-css-template.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-css-template +title: "Get a CSS template" +description: "Get an item model" +sidebar_label: "Get a CSS template" +hide_title: true +hide_table_of_contents: true +api: eJzdWG1v2zYQ/isHYh8STI2ToB0KFf3gZmmbrm+onXVAHLi0dLbUUKRKUk48Qf99OFKSZVtJ025AgH2y+XZ8nueOx6NKFqOJdJrbVEkWsldogUtILWaQqRgFC1jONc/QojYsvChZSvNybhMWMMkzpNYVC5jGb0WqMWah1QUGzEQJZpyFJbOrnGal0uICNauqoGSRkhalpWGe5yKNOCEYfDUEo+wszrXKUdsUDbUiJYpMur+E0XTMG6tTuWBV0HRwrfmK2le42lyBsshYeMFMoq6njcmgK0WnV/AZik7bLbKpFUgCKInsMvgehnWHmn3FyLKAeQshW6CdErBpTbmiyU7jbwXq1Vrkb6y6JJVNrqTxahwfHnpRfkrLPrq3CD71GMqtaBknCJ0emCsNNkHwi4AWHcDnVAiYIVjNpRHcYgyzFcxIVRYwvOFZ7oQYwvs0usse25F5R1aSLu7H6UI6jXeNbHv4xyVw6/8T8n2W7kdboymE7QGfcLnAeDpb7Y7NU21syyvjN29RLmzCwt8e96jkhd0+y6TevY1U3Sxx0d2/a+by9sNyYswYs5yE/ITGDvP0YIH24Nx4KA1ZJacxCsunSZFxmf6NDrpGHn+QYuUTFE3XSB75/2tz5MQxjpgshOAzWuHT9L252Np4H5/jJ4fB9yzfkQP7odOmGxl65/ANQaTGgprDOj3f/1roJPIey24ArAKNMkZ9/6M8StQ1nFG2+R0tT4W53wFuDdyamDfy0D3SZe3LZteePNdrsTcHbWSYO49ZE2nrbQnE0U78dByz6eSLZuRy00U9wrq7ctNxbnyuVQbvXPlSBezxv7olMzSGL7Anor7jxXYhe8FjoLONxoZwJpdcpDGsqyrItVqmMcZ9fDprPZejh+VyLnlhE6XJ2yEMC5ugtPX+0CawHiLdhZ7J44dl8l5ZmKtCxiHQJV6LjCS3UYWms6XQgFQW8CYl+XdJtTYco+Pjh/ZNrlVEzZlAIL/YVQh/Urh5/6DWSvfxOFGFiB3V2kK9mrZ68tDH50xa1JILMKiXqD2LEIYSCok3OUbkNNcJKooKfUsAvuSWi1aCgBmMCk0c6VHz9dqy8OKSKmzLFy4LnYxG0NxKhpLRzaNIxThyCP1TSHC5YCGLzj+9bdLruumDiNqFFvDoL3h1OoYJS6zNw8FAqIiLRBkbPj18+nTA83SwPBpExkybPDk4mjCYTCYS4NFrmLBhfXyc7iG8QK5Rwy/Dk5PT0Wg6/vDH6fsJY/S2qmF9XNlEyQ6wtqOFlma50raJfTORE9k8MOB5202X8R7hgB/FH/hVCfIYtXlebrGYsBAmrGYyYfAr8Iiib2rVFcpqIvcnMteptHsNqgOKt739/S7PN3zJR87RHa4bnWtXKGmIbkuRX/PUwhxtlDiGP8Ov3CAZNm3Y9hmx/dK4rfRMx47oF7+ioh9i/WwiPdKYW96i3NKgnqQEHgi12KOp+8/cGzFDm6jYvy3d+51KNNbLocyvKhLInSwf1IUm/XplYNtn6i0NQ4xLFCrPUNr6jDr3eENlrpVVkRJVOBiUZKoKS4q6asfaSWGsyhoTAVtynVIqa95kzowvkObc1SIOJlVf9YO+btKPO7Kb9l+Pxx+htVMFjNBs2mv57oAb+eRDY1TAgNJw9pGMEJdNI71S1evd7KoiNzUJaESp05N0aahkMxckL5XOONl783nM6u8pFMR+dF1VOtJVQIunGucaTfKzRtynh7narYdHRY7aYLdo73RR7Ph5yyMvibEZd/dCXey570pAKbUJvW2BOjdM71eoGqfFGzvIBU9dTepCrKwj/ILxPCU0R8zVoNPOVmF+RfHgHX7BynLGDZ5rUVXU7b+0UPDfCuk2BFe4ct9mKFpFQePuCDah642m7kaOWTjnwuAdxPc+1RXUPty2YfOKkavung2Q/IpVlxTZLhm53f3AMIrQ5cJmyc4lvpE5Xp1StFDF1rm525ip/5D1Xjhl6Wf47Fa16FxaJ4BV9Q+4yxVy +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.ParamsDetails.json new file mode 100644 index 00000000000..20033d43cea --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"Either the id of the dashboard, or its slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.StatusCodes.json new file mode 100644 index 00000000000..7ee371f4dcf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"certification_details":{"description":"Details of the certification","type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","type":"string"},"changed_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"changed_by_name":{"type":"string"},"changed_on":{"format":"date-time","type":"string"},"changed_on_delta_humanized":{"type":"string"},"charts":{"items":{"description":"The names of the dashboard's charts. Names are used for legacy reasons.","type":"string"},"type":"array"},"created_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"created_on_delta_humanized":{"type":"string"},"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","type":"string"},"id":{"type":"integer"},"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":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"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":{"type":"boolean"},"roles":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","title":"Roles"},"type":"array"},"slug":{"type":"string"},"tags":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"Tag"},"type":"array"},"thumbnail_url":{"nullable":true,"type":"string"},"url":{"type":"string"}},"type":"object","title":"DashboardGetResponseSchema"}},"type":"object"},"example":{"result":{"certification_details":"string","certified_by":"string","changed_by_name":"string","changed_on":"2024-01-15T10:30:00Z","changed_on_delta_humanized":"string","charts":[],"created_on_delta_humanized":"string","css":"string","dashboard_title":"string","id":1,"is_managed_externally":true,"json_metadata":"string","owners":[],"position_json":"string","published":true,"roles":[],"slug":"string","tags":[],"thumbnail_url":"string","url":"string"}}}},"description":"Dashboard"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.api.mdx new file mode 100644 index 00000000000..6287b7cd7c4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboard-detail-information.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-dashboard-detail-information +title: "Get a dashboard detail information" +description: "Get a dashboard detail information" +sidebar_label: "Get a dashboard detail information" +hide_title: true +hide_table_of_contents: true +api: eJzNWP9v27YS/1cOxMOW4Clx3PYBhYb9kHVZ125oizrF+xIHHi2dLaYSqZEnO56h/304UpJlWwnS9x7Q/WSZ5B0/n7vj8Y5bUUorCyS0TsQ3W5GiS6wqSRktYnGlKEMLlCGoFMzCf6XSZXMjbRqBsaDIgcurpYiEYpFSUiYioWWBIhYqnRk7a+Yt/l4pi6mIyVYYCZdkWEgRbwVtSl7tyCq9FHV9y4tdabRDx/PPLi74JzGaUBN/yrLMVSIZ5+jOMdhtT19pTYmWVJC26KqcjscT/lw0WmYpklS5n9g3wo9hoqW/JyWiQ+xRqxbT2XxzrO0DWmc0W25pTVUCZZIgkw46MaBMuZ2VB7fIpF52G+yzWijraBbsf2TZSKi0N6w04RItj+fyYam6g2Dmd5gQQ1KU88AnF8R3iB7eul0TvLUwtpAkYpFKwjNSBT7G1DsoJznLqkJq9QemD21hyZtBERYDzrzOEBigO4rmbx0E6XN45xdIi1A5TGFhLOS4lMkGLEpntDsfgtoMSGvlxmOxKOmv5aQG0VON6QYM+H6F1qoU4dVk4i2zZ8RBw3SzswbQoc5L8BNPVPeQcZSbFVJLjha8J7Ra5rk3va7yXM5545B3GtG5MTlKzaKcQWYFkkwlyaGgUQ7eTt6/g2BaUA6WqNGyNSHdaFmohHeDdYYaklwln5Veei5OrpBPu1mhXVtFCPOKyGhQep8rrBSuz+GN1473peHQy9AGs1hcoEWdIEgdIrI0a7QcoNbBOjNQyA2spSYgAzIntACuxIRTFeyS/KBFzVr7/N87NX+FcD08UKVxyqfqNuEPeOnOJ9fgpTA9R+cN3UqzY5qzv1bpEskduaL1Qt+zO397H8v0rnLUOrlV5NQfwUHtZg7mG6gcr0utXMI3kFpTDvt+yDNlNc+Vy/YOaC9urcnxMb895Jgv98lHv9OAU/zdPhQUJJf/R2jtxluBuipEfDOOnkXPoxe3j4G+loOJmbKqmGup8lll80cSxG7vZt3TzfVj69nXSB+bSmYSypNjsToSeC+LMqTGXbXyQH3S7n9YafTGDy/j4yl/Yp5dPHtxdjE+G//jenwRP7+ILy7+Ix6/c/c0+av25vbxi6Un4fbQH10LuykOjvGDGT046SBn74TbbMbADlLGblHvYAV1zVFioRDSu7UhknnmIHJ2S/b+1jX7+KCI7Mq5OhIv/qdytkDn5PJJ53c/sjpB8YNMgatxdBTDG72SuUp7lwSU1qxUiqkYYNKTDVzGX5fLJy0ryozlaIvhsqIMNTX7Q9dyDBDpCwYmz78uk5+Mnas0RR3Dv00FqdHfcmuwQijRFso5ZsS3e5Kgc6FNsOhMZRMcItjpC+xefF127wzBwlQ6jYGL8CaEMO0oQGrQgTYEeK84uI4ZdTr8vg6Tyira+Mb1bk18Rrl1bM7r7sw5cRuJ+7PEpDjxyEKvm0vN5zz59PFXwcXKHPPd38assUgqm8PZv+D11TVMRUZUxqNRbhKZZ8ZR/PLi5cuRLNVoNR51GW00ngqYTqca4OxnmIrLJtC8sWP4AaVFC3+7fPXqajKZXb//5erdVIg66jB92FDmu8sWVTfQ4VJFaSy1dnRTPdVtzwzfd8PnS6QTxgFfBD4KIhnKFK37fntAYSpimIqGxlTA35uYnJH5jLqe6tOpLq3SdNJCOucIOzk97ZN8K1dy4r3bI7o3uHOC0Y65dvzkWiqCBVKSeXpfTG67xzBu/8Oht5jqb63DtoHmtWf5W5Co+YcpfzfVASZfSB3EAwM0i0yO57lZnvDS0+8ER+1+pL9GAtkrEMPtD0qHtjk8PRRImeErdolsLf/0EotjztvdM0zNVkW7at97wsU1aDtxiOlXnoYUV5ibskBNEDR5nwZF29IaMonJ63g02rKqOt5ynNZH2l5VjkzRqojESlrFRVhbK3o1ocpfSF8ReZgiaivA9i//+BO+r//n6+sP0OmpI8Fo9vV1fI/ATTwq4DmuoLiBe/Mh9CD2QMmgqRp5v7r271ltsvJVYCDpU9ZWzH1w/dQ+h7z957Vo3sZ8te9nd72BJ80t65pmFhcWXfbfKuHOTS/McSc1qUq0DvsFbW+IYyesW42btowK6a+Pptp8UvDubdldK4T3NCpzqXSv7g6BfSNkqXj/cb94FJGIe6+Mt62fb8R2O5cOP9m8rnn49wrtJpRxbaiFF0/l+DsV8ULmDo+AdTemOPnYVBOn8GUPo4Pc2q5Eb3zw5xX/E5H4jJv9h9P6loPX5ykPOCy4TBL0ObIVPbrOOeq6DPH6igOCC55+J9mGRfPB2gdhbbdhRUh8dYfSp3sGWNd/AgDGvK8= +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"; + + + + + + + + + + +Get a dashboard detail information + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.ParamsDetails.json new file mode 100644 index 00000000000..d6b6943ed6f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.StatusCodes.json new file mode 100644 index 00000000000..9e9502edf88 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","type":"integer"},"certification_details":{"description":"Details of the certification","type":"string"},"certified_by":{"description":"Person or group that has certified this chart","type":"string"},"changed_on":{"description":"The ISO date that the chart was last changed.","format":"date-time","type":"string"},"description":{"description":"A description of the chart propose.","type":"string"},"description_markeddown":{"description":"Sanitized HTML version of the chart description.","type":"string"},"form_data":{"description":"Form data from the Explore controls used to form the chart's data query.","type":"object"},"id":{"description":"The id of the chart.","type":"integer"},"slice_name":{"description":"The name of the chart.","type":"string"},"slice_url":{"description":"The URL of the chart.","type":"string"}},"type":"object","title":"ChartEntityResponseSchema"},"type":"array"}},"type":"object"},"example":{"result":[{}]}}},"description":"Dashboard chart definitions"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.api.mdx new file mode 100644 index 00000000000..6f42c7fb8b0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-chart-definitions.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-dashboards-chart-definitions +title: "Get a dashboard's chart definitions." +description: "Get a dashboard's chart definitions." +sidebar_label: "Get a dashboard's chart definitions." +hide_title: true +hide_table_of_contents: true +api: eJzFV9tu3DYQ/ZXBoEBsVPbGbR4CBXlwEufSuonhXaMtvMaGK86umEikQlJrbwX9ezHUZW9qU6QPedoVxTk8ZzgcHlVYCCty8mQdxrcVKo0xFsKnGKEWOWGMSs6MnbmsXGKElr6UypLE2NuSInRJSrnAuEK/Lni281bpJdb1HU92hdGOHL//6fFj/kmM9qQ9/xVFkalEeGX06JMzmsc2eIU1BVmvmmhLrsxClPKUu8MJiUhSmnmVkynDPEkusapgdIzxVWnDQnCkNDhKjJbuGMwCfErAsUovoY2GhbHgU+UgSYX1p/DeeGoGJC1EmXkH3oRIKbxwprQJjbyYZ9RDqAWUWtJCaZKnGHXZUdrTkizWESbMfdHqn0nyQmVugHjzoqe6HbXB7bLew5KczdeHaFdkndFgLCytKQvwqfCQCgd92JbwQfhU6CXJWbNbu+CTlODd+AMnhRrkwJih4F44yITz0AJwThbG5sJjjBxwwpkbWnFnjf0lz2Hruc9RWJHLwzg6/QrmLBf2M0lp7gfgx0Irr/4iCW8nv13Ciqw7WGcrYnAtVjnjOjmEf21sHkoIFtbkAfPiociMJeBjYk3moHS8J4ZrMt+s+sg1cV9KsuutZc38EyWel1VyeIOU3KE/XJsuUwnNmvM/BMJv/glmo7xBKW02DHJzffk1jHpfWIRe+YwHXnLIhfbKr6/bNjNuescmSFgr1gModYT0IPIio+3WclvVd3W9X3H4Srh0boSV/X4vFFeF0Y6BnvyvtpaTc2JJQ/3z30n3gfhCSOCuTM7H8E6vRKYkbLo6n4OVkiRxQNtWbKPl7PtqudGi9KmxfORiOC99Stq360N/9QwI2Q5slPz8fZW8NnaupCQdw5+mBGn0I260K4KCbK5c6CPegEgScq5pupaaq2RIYI/XqHvyfdW9N3xJllrGwCe5LSGSvQSQhhxo44EeFBfXoaIeI6zrKCmt8utgQj7d83G8YwvhxZKNyeYUOryL8OEkMZLGgVnjWzKhlxhjcnN9iRFmYk7Z5rFNa4xJaTM4+QPeXExgiqn3RTwaZSYRWWqcj58+fvp0JAo1Wp2NZLfg6GwUDr6bIkynUw1w8hameN7WW8h5DC9IWLLww/nLlxfj8Wzy4deL91PEOuqpXa19Gq7sjlw/0NNTeWGs79LppnqqOwsFz/vh0yX5I+YB36IhaiJTEpKse17tKZliDFNs1UwRfmwrdObNZ9L1VB9PdWGV9kcds1Out6Pj422tv4iVGIe93tK7M7jZEqMdS+5linuhPCzIJ2lQ+a0aqx2hcfcM+3vHij9221c1aidB7McmouYfVv5sqhu24ertmO7loZ1kMjrNzPKIpx4/Qy7l3fJ/Qx4E9OwfucPrhS/EnHxqJMa4JE5bcOYxHoqvNi69bvPAWSa76px9uIeHc4n75C75NUhaUWaKnLSHBinscQNUFdZ4k5isjkejiqHquOLyrQ/QXpbOm7yDiHAlrGKz3Ln4ANN4hOCuW5oYIeky59PfPvJPOP+7+G8nkyvoceoImc0uXq/3gNw4sAJ+17gaC++uGIS17IIMpqqND7Pr8NXTtbJgRxqRoaFVOA9V9rqzvb/8PsH2C4pPQvN2Y4KC6Dri4JmlhSWXfisI+0G9MAMGtyzIOto2VltDrd/FGFdnTUqcz0W4XNpvw/9YxXsevuXm6cGPikyocKm1PrGp8FsUhWIGZxzdwWOE8c7XaFvod92W32JVzYWjG5vVNQ8Hf8x3yabqwmGQyvF/ifFCZI4OGPZXKx5dt7bjGDZZ3WXeuU29DsWdlfyEEX6m9e7nc33HxRkaUmDRTDhPEgo9sQs9uMy5qvpG8OaCN5ztzlYq+21v/zD6IK2qamY0Ha7uWYb2jsEA/w1krZOT +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"; + + + + + + + + + + +Get a dashboard's chart definitions. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.ParamsDetails.json new file mode 100644 index 00000000000..5e7ca7ceed3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"key","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.StatusCodes.json new file mode 100644 index 00000000000..c4bb1f53ee4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"value":{"description":"The stored value","type":"string"}},"type":"object"},"example":{"value":"string"}}},"description":"Returns the stored value."},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.api.mdx new file mode 100644 index 00000000000..9f42ffe1f0a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dashboards-filter-state-value.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-dashboards-filter-state-value +title: "Get a dashboard's filter state value" +description: "Get a dashboard's filter state value" +sidebar_label: "Get a dashboard's filter state value" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYcASTImSoAUCFf2QZkmaruiC2NkGREZKS2dLiUSq5MmNJ+i/D0fK8uuGYh2WL5ZI8R7ec/fweG6gkkaWSGgsRPcN5AoiqCRlEICSJfLoCQIw+KXODaYQkakxAJtkWEqIGqB5xatyRThFA20b7ER5wvm3wFgyuZpC2454sa20smj5+8nRET8SrQgV8ausqiJPJOVahY9WK55b4lVGV2go99YzWdTILynaxOQVG0EEwwyFJW0wFX5FsOVHP6PHj5gQtAHgsyyrAldwl8vbYGOLW6TaKCtoY6tDRnr1XaRKtFZOcVf0/tnr3hDeyVRwTtBSJK7VTBZ5KpaSEJXRszzFdBezFVvP5fhludwpWVOmTf4nppE4qylDRd3+ohfeDiKrhp7Jq5dl8kmTmOhapZFghXZBRg631bVJUKQarVCaBD7nHP5tUj2GY3Ry8tK5qYxOeDguUHBeaB6J31huPj9ojDa7eJzrukgd1Q6hs+atXr/08blWhEbJQlg0MzSeRSTOlKgVPleYcNLcpNBJUpu/EeClJFn0IQjAYlIb5sgV+fErQXQ/4oJIcspVGn6WNhtraVJxmReERgxIEsIogOeDRKc4cK76gl5INYUIkrvbjxBAIcdYLIdeTTyuTSEO/hBXF0MRQ0ZURWFY6EQWmbYUnR6dnoayysPZcZguNg+Pw4nb/sHy9mHzhPM2BhHHsRLi4L2I4aw7Vy4hkXiH0qARP5ydn18MBg/DX3+5+BQD8I3RuXkzp0yrFUf7id7VvKy0ocWhsLGK1eKiEG/76cMp0h77Ib6XT+BRMpQpGvu22WAVQyRi6JjFIH4SMmGZPpB+QtXGaj9WlckV7S28PGRh7u3vr/L+IGdy4BSxwn1tcpkqrSzT7ynLrzInMUFKMsf4v+DbrJGOFmOxmVNm/3mR1sYzHzrin71Fyw+OwptYec9TSbL3eiMm3SJd4GGhp3u8dP8NsPTXD8wVkpCiZ/KjFZ6JcEz6u7xEynQKEUyRQ+gakgi2A9FUT+2OWHDU3bn2J6k2nJSdsYVNBz/yZ5HiDAtdlaioqxAu5x6oqYwmneiijcKwYag2alja7RbaeW1JlwuIAGbS5FxIbVfUHIzvbiayLqhzEwJAVZdcMbohPyxshfP9cHgjepw2APZmHa/nu+XcwJc+/satntBGXN8wCHNZB9kZqs7erW5d37cofwMu3J6kK4INjJ3SLrUpJeN9+H0IXQ/JJ8N/XfZwjnQbsPGDwYlBm/1bkDaAXE30dgc5qCs01smLcuL7YXWKtePXzY59SCyV0t1KXVv8jUpe27S/rwifKawKmSsGd7JqOpXfg6xy9uCYrRfwEEDk2vlVsfMkd+ejRd7voWnG0uKdKdqWp7/UaPgyGi2l505Emrv7PIVoIguLW272FzPs3Xb9175Yhnbd/W5SqrlTuO+rIXB/HNyfED46/+OO/NuO+DC4IugI+y9nSYKuJi9stroOVnFffK4uWGDcYq6krpdZ98LoO/1pGr/CV9W2d89dL+xg2/4FTQS/8A== +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"; + + + + + + + + + + +Get a dashboard's filter state value + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.ParamsDetails.json new file mode 100644 index 00000000000..194d0eaad92 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.StatusCodes.json new file mode 100644 index 00000000000..39fef5e3ce9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"backend":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","type":"string"},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine_information":{"properties":{"disable_ssh_tunneling":{"description":"SSH tunnel is not available to the database","type":"boolean"},"supports_dynamic_catalog":{"description":"The database supports multiple catalogs in a single connection","type":"boolean"},"supports_file_upload":{"description":"Users can upload files to the database","type":"boolean"},"supports_oauth2":{"description":"The database supports OAuth2","type":"boolean"}},"type":"object","title":"EngineInformation"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"id":{"description":"Database ID (for updates)","type":"integer"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"parameters_schema":{"additionalProperties":{},"description":"JSONSchema for configuring the database by parameters instead of SQLAlchemy URI","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"

Refer to the SqlAlchemy docs for more information on how to structure your URI.

","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"type":"object","title":"DatabaseConnectionSchema"},"example":{"allow_ctas":true,"allow_cvas":true,"allow_dml":true,"allow_file_upload":true,"allow_run_async":true,"backend":"string","cache_timeout":1,"configuration_method":"string","database_name":"string","driver":"string","engine_information":{},"expose_in_sqllab":true,"extra":"string","force_ctas_schema":"string","id":1,"impersonate_user":true,"is_managed_externally":true,"masked_encrypted_extra":"string","parameters":{},"parameters_schema":{},"server_cert":"string","sqlalchemy_uri":"string","ssh_tunnel":{},"uuid":"string"}}},"description":"Database with connection info"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.api.mdx new file mode 100644 index 00000000000..fb66e62671f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database-connection-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-database-connection-info +title: "Get a database connection info" +description: "Get a database connection info" +sidebar_label: "Get a database connection info" +hide_title: true +hide_table_of_contents: true +api: eJzFWutv2zgS/1cGvAMuwal2ktvdK7xpgDy82+zl+nLaPaAOdLQ0tthQpEpSdnyG//fDkJIsx8qj3Q/7KZFIDuc9vxl5xQpueI4OjWWDzyuWok2MKJzQig3YdYaQcscn3CKIlEVM0OuCu4xFTPEc6emWRczg11IYTNnAmRIjZpMMc84GK+aWBe0SyuEMDVuvb2i3LbSyaGnD0cEB/Um0cqgc/cuLQoqEExP9L5Y4WbUIFkYXaJwIp7mUehEnjvunbfZPaQ3OPwxPr4dwfXp2NYTTEWi/DELB6P0VXPEJi2omJ1pL5Iqto5ru/Em6ny6Hv38r2TSXD1EtLRoLToMpFSitXoyGV8Pza7COO8xROQt7H99dnF4PI7gYXg3pb+Akgl6vt/88BqZCYlwWUvP0IUachrABzkefgA54VwChnAaXCdt4xuUULEpMHKYRFBLJWSw6cBlCMJsFfy2mMNUGEjuvSQsFwztneO8RXk2pYm6XKtnl9G2Bhjv0N238VIHfnhmtdGkh1ylGkCNXQs3AZTxw9rVEI9ACNwh4h0npMAWtwGCuHcJCm1uyBLegi0JbTEkjWvmzC5yARTNHA8JZlNMeXJNGuLVljjZcstQlZHyOwOEcJZplRZN0UxZEeIFS0l8OBm0pnYUJT25RpT34gFM04DVNElnHpfQBAalOrFdjrg0tTbXJ/Uq3DiuKu7obvb86lWSdJaCaCYXe4hYpsEsp+URiHcwVVeuMUDMimvAkw9iJHHXpdklflCbwuicUWEy0Su0+6KkXhs56Q4TTwSMybpwNO1qO1YPTZpuewgEIlVJeqDVck0NQSLbAu0IYtD14o71TECmccq/ZSpUzqSdcNlTFFEqV4lQoTHsPS94kr4jS1FTMKgHjHF2mO5R73rELhCX9prUTTY3PeN6vghn968pgsMjQZcEH8K6QOkXY5GrQfqEwei5SBK3kEjjYr5IHk8alES1/2FiuVm0ckvdO6G/CiDZ41lJUTkyXQZ+JVgqT2t1yfneFauYyNjj68SBiuVD18+Ez3Cg1Yo7mUdcMW77BNYMvx6242K0ZqbBEI7Y2i12pFEo6vMvG6DWEZTKd0g74nAt/fe1OtbY6Q8+WRaGNs3G6VDwXSZxwx6XuuGmrztbHIC+lE4UkH/fnrE9tYIWa0cvGEo9f/miq/+irTcJVnZBpt/026TQvXXb0XKHenvrduxTXzSs9+YKJoy3CkaXZ0Nv0smVSMvQdZeVYqNh+JZ/YZWDod2ynFBJt9P7qoeqIVIx2KR0XJ7+N3r6B4GakeseFLyf+AGwlBUAZCnXveGJODqk0IBwnOsWTyjl9HNvjvn8HQVyYobNQqoLCP62rLMIxh8zg9NWYZc4VdtDvUwHobUK9p82sj6ovKS+6fqIN9sM9tpe5XP6ltTUxyB3GYXnMwKB8NWZK6wIVGlDaUNkxaMbs5KFjx31+AgmXMoJFRqjANeLl6Dgp+p6Af1QygzI+jA+CaPUdO7IFpNH7Nzp+wR1/vnT1iUYwb7ejtt0awbYKXy0fFf6qDtV1xaJz5B6b+hdKdkUHpuiSrKPejQpMKNcKR7jg2Dqj1exkzLoZGLMBrMYVNN5d+ungIIIxcz7Xda2uj/vVDT24pEpo0UWVJAshpc95EwRURCKAN1+5SuUTD5fCLb+3SJOS/9FWcgUV4woqxlNt2slrW9s6zzlYJEcj3CaF9bfXcNPffD76FOBdDT43kNbph3X9BB+ku89jVpQTKZIxIw0ndt4s3mzrtMk7U8nn2kCqMZSSKiFWHFM952pZPwnb5nmCwJMErSV8/aW0DiQSriTNesExL9yS9PlDW59zNFZoVettKlCmQXtVGrNBAQEV13ly8jcL1ckK1NpMlzIlLjx6WQiXwTuD1mm4OLNg9cbOdqkcvwOPE4zBxBFTP7aZ8mLZeC6MK7mMg296fGOwg9MqNbdZrXGRNl6PdO0wnIdJ6dxWC9bg6iDGQnmv+6nNUI0FQt4yOBe4+C5GfFxXBJrmwkfRBH0zt8hQhcD3GvcwokkIG557/+xkzwgpY6fjFB0X8ns49CTInwIJOlVR30R2k4le7hgt9nCkxjBNNDbBLqbbbViwNEF7KhvBxSo0XgOaoBJTKl9Km4ZMpeArDr0kchaplvaLky5AO9UmQd//x5sRwXb1/p1u8ewQxSfHAVGIhOq9p29DgNTIb4KBQV/Nwu7q7kch8cEz4KvoAGkXtUovL2CPLFUWKal8n3U1KCIv0FitqGLTMGGX3uW0it+ItLLVDLdChxLnTHvLeYmbHpkHbSSlMaicXILUs1loa+g+WGQacspSvvkt0OTCUjqphxouw5zisH9yOYXXghpklUIm5tgLPfVRLxScXqpPfehW9ScK4VTR2PiL9b24SHya1KVyEWUCaCnicYbngm9fXxh9t+z5tapxWHY318LGOVd8hmmMdw6N4lIuSeEP2Ll1NOf2lo6pxCwLFwh8G/TkaSpCFW71AttQ1Kc7n8Tr3rPVNLYOtbolnwrs0jrMLUhxi95E0cZjVApnYva+RLP0CDDJINU+A9LVvosN+I70R03koODWLrRJ6/Kg6C4pl4GjyRI2/V4d5k/GSXtsuWIbVbxrN3rUYm5H0tmLkB5F0m6m/QiirTd2vxfZurGVaJ57MZlwFGp7+7ImL9YRPlm2+aK5D/KUgE2rJf744bKLv+C8cYKmYyJzXJy8LSpnOT+Nzz6+ubgaQjVy9f3enEtBWQVeX1+/GwHNc9E624O3frbQNL7kYmjIBzdc1+3Gc423Pafo5HZr/vWNncJRRxNU8/qiNNI+0RuMvspm/KAT6/uCroEb6SILk1LrTJm40iBN/QyZqFZGqx4cHhz9cH9GsqubZiZRTbffTv1gfnuC0VUmaFxxHcYVHYXi6clWHaatoX0r3oyYU0W5xeVT6/GjhCo35Wlq0NrHthA87vqAELE6s3ScfmSKUJfR0eh1UBOjTxHbeiHipeji/BmEz5uEGkI9DBR4Xki8/6Ui2KD9jaH9xn8eaL/YmuG0F1qz8fC6GffWjO8Maw8fmmFuTtwbErYWqoHd5k3nuK1zOhP4q6rchkAHftsskiUOuyBNIPZA+Q2LDxXYDfWtGvJAhr+fWDen7yex1ko7hBuP2njSblmqE6nvre7VZfKiH/7QJ7IcreWzZ0XLtsc2B9kZT+uSMIBL5YtFu1JVmCLtkq51Nshy+OfK8lHRwFIb8T9MB0DjSBpwh/uh+Y7ZIUj7oJfk6OjPlqQwmgYDvjKTFG45gE+hkvtJpDHadIly7lt6Am0Vheo0XfXjn+1slyrEcv2JzUsxgFMFpcK7wn9oDC9BJx7Vd5rrF2oyGxVQHCelIRmpnH5ZODb4fEMVwPEZfftuopDdROzuBbW3I89c+DAuOX0iYMnHD1csYpJPKLrrR6tLkxDrSWkkvPgP/Dq8hoBWBv2+1AmXmbZu8PLg5cs+L0R/ftivk2z/sL+J+DGD8XisAF68hjE7rdzNa34AZ8gNGvjr6fn5cDSKr9/+a/hmzNg6arh7t3SZR681f82LhkOR+7FTje/Gaqzqr/HwagP7Zuj2iA/4TjGicDhDnqKxr1b3hKEh2phVAo0Z/L2acMVO36Jaj9X+WBVGKLdXM9cjx9vb32+L+xuf85G3eEvkrZcbw2hlSepGUr7gwoVxjBf0D4i52pJ1UD/DfQuS0P+tjbgKAl97ef8bTqzpDwn/81gFhv1sqGb2niqqTVpiT+rZHm3d/9ljmu04+BUd8A1Yv19eItYAgBk6XxYJm7IdyVfF7bq/9dUpxGeIj9KQ8jt1yO5zdEXLkOIcpS7oU0kV6d62gdCqMNrpRMv1oN9fEan1YEWeu96hdl5ap/OaRMTm3AhKiLZKTp5MgMt++lSx6cFLmVPkV4++uWA7+qOGCBo664gRN9v0Gnl3mBuFFEZr/oOqNnD5zgNmbe4R6VRVdd7vXvvfztRpzGPMIKRPZis28a71iwdiFAi/X7Pqhzh+9uBXN52jF3od0eHY4NSgzb6XCE1CyJV2W5KSgBu2wXLrVTVmZgM2PwwqsS7nvrpUwPNJ1926rqk4Du9cv5Bc+EmLd6hV5dafGS8E3X3YwrksYgP/K6aWd9/Udv7MViva9NHI9Zpe09yJisjNxtXCT6eqYSobTLm0uMNcU1DZ3ocKZezD7i+sOmWoXnK19A4uS3piEfPtGP0Ca31DjukzkGcmLJwmCfo8WB/ZqeTkUU38/zokYxPIaSmzMXn1D1HvZGe1CjtCSls33PmUTgyu1/8HCIaTGw== +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"; + + + + + + + + + + +Get a database connection info + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.ParamsDetails.json new file mode 100644 index 00000000000..194d0eaad92 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.StatusCodes.json new file mode 100644 index 00000000000..ee233bc70d2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Database"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.api.mdx new file mode 100644 index 00000000000..aa093d4788c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-database.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-database +title: "Get a database" +description: "Get a database" +sidebar_label: "Get a database" +hide_title: true +hide_table_of_contents: true +api: eJzFVl1P3TgQ/SvWaB9AG7iAdiWUqg+UpZRu1UW9l+5KBFGTDDeBxHbtyS1s5P9ejZ2b+7kP7AtPiT9mfM7M8Xg6MNLKBgmtg/S6gwJdbitDlVaQwqREUUiSd9KhqApIoOJpI6mEBJRskEePkIDF721lsYCUbIsJuLzERkLaAT0b3lUpwila8P6GdzujlUPHG44ODviTa0WoiH+lMXWVSwYxenCMpNt0qO8eMCfw3idrqP/oEYNP4LcXOjdWG7RURWgNOienuHSqI1upKfChazgSwCfZmBpXDOGdLAQHBx2l4kLNZF0VYhF0YayeVQUW24gs2UYuh6/L5UrJlkptq3+xSMVJSyUq6s8XgwK2EFk2DEyOjl6bibE65+FdjYJZ0HMqvnJyIhu0VtttVE51WxdCaRK9h96aj/r9tcV2oQitkrVwaGdoI4tUnCjRKnwymBMWcVLoPG/tf6TrvSRZDyFIwGHeWubIFeLhB0F6fcPXmOSUq8biwt0k8LSX6wLHAVwsKbVUU0ghv/ryCRKo5R3Wi6HTrc0Zet7aWuz9I87PJiKDksiko1Gtc1mX2lF6fHB8PJKmGs0OR/OKNDrMQGRZpoTY+yAyOOk1FsKdincoLVrxy8np6dl4fDv568+zzxmATwZIl89UarUEapgYYFWN0Zbmt9BlKlPz4iXeDtP7U6QdxiFegj2JFiXKAq17260xyCAVGfQsMhC/Cpmz4G5JP6LymdrNlLGVop05on2W2M7u7jLHj3ImxyG3SzxXJhcp0Mox1YGe/CErEvdIeRnYvZRbt0IwnY/Feq6Y6bd5urrIchJIfosWnj/M+E2mIko+a0C4xr/fpGvcr/V0h7fuvgEW7KrMz5GEHN43SKBBKnUBKUyRAxOeuRQ26HXm0XPcwh2LGm8th3VrdGD92E+8LAqcYa1Ng4r62xqyFh11xmrSua59Ohp17MqnHQvRb3g7bR3pZu4igZm0FRc11xeY4Ib/C7yXbU09TEgAVdvw7e2H/HGwEaQPk8mlGPz4BBjNqr+B7wa4cSxDvMbNgtBWXFyyE+ay6mRrqHr7sNuHzmFeisZcRCPJUJA6uAv6ea9tI9nfx78n0LchrO24CkMhDaR9wsa3Fu8tuvL/OvHcFd3rSGcFfWvQuiAlqohr9fIUayfumx3GkDhqZHgh+sZqQ58r7odXgvCJRqaWlWI3QUBdr91rkKbisw7ZeuEoNY+c6ZjKa+g6nr+ytfc8/b1Fy7X+ZqGm2BtW4bksIL2XtcMNPMO7Bztf+mZgV2y2kFth95NSPQcN1y2PIIFHfI4tpr9h7YVKEsDEhZM8x1DE5iYbDy6LZrjX52ecT+5FluI3ZLX/Ye9b4XRd3BFLkx/QhXrMAL3/CV074NA= +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"; + + + + + + + + + + +Get a database + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.ParamsDetails.json new file mode 100644 index 00000000000..ac60e9ca213 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The dataset ID","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"},{"description":"Should Jinja macros from sql, metrics and columns be rendered and included in the response","in":"query","name":"include_rendered_sql","schema":{"type":"boolean"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.StatusCodes.json new file mode 100644 index 00000000000..bb67c8b9e0b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"The item id","type":"string"},"result":{"properties":{"always_filter_main_dttm":{"nullable":true,"type":"boolean"},"cache_timeout":{"nullable":true,"type":"integer"},"catalog":{"maxLength":256,"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get.User2"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_humanized":{"readOnly":true},"column_formats":{"readOnly":true},"columns":{"properties":{"advanced_data_type":{"maxLength":255,"nullable":true,"type":"string"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"column_name":{"maxLength":255,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"filterable":{"nullable":true,"type":"boolean"},"groupby":{"nullable":true,"type":"boolean"},"id":{"type":"integer"},"is_active":{"nullable":true,"type":"boolean"},"is_dttm":{"nullable":true,"type":"boolean"},"python_date_format":{"maxLength":255,"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"type_generic":{"readOnly":true},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"maxLength":1024,"nullable":true,"type":"string"}},"required":["column_name"],"type":"object","title":"DatasetRestApi.get.TableColumn"},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get.User1"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"created_on_humanized":{"readOnly":true},"database":{"properties":{"allow_multi_catalog":{"readOnly":true},"backend":{"readOnly":true},"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"DatasetRestApi.get.Database"},"datasource_name":{"readOnly":true},"datasource_type":{"readOnly":true},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"fetch_values_predicate":{"nullable":true,"type":"string"},"filter_select_enabled":{"nullable":true,"type":"boolean"},"folders":{"nullable":true},"granularity_sqla":{"readOnly":true},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"is_sqllab_view":{"nullable":true,"type":"boolean"},"kind":{"readOnly":true},"main_dttm_col":{"maxLength":250,"nullable":true,"type":"string"},"metrics":{"properties":{"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"currency":{"nullable":true},"d3format":{"maxLength":128,"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"type":"string"},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"metric_name":{"maxLength":255,"type":"string"},"metric_type":{"maxLength":32,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"maxLength":1024,"nullable":true,"type":"string"},"warning_text":{"nullable":true,"type":"string"}},"required":["expression","metric_name"],"type":"object","title":"DatasetRestApi.get.SqlMetric"},"name":{"readOnly":true},"normalize_columns":{"nullable":true,"type":"boolean"},"offset":{"nullable":true,"type":"integer"},"order_by_choices":{"readOnly":true},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get.User"},"schema":{"maxLength":255,"nullable":true,"type":"string"},"select_star":{"readOnly":true},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"},"template_params":{"nullable":true,"type":"string"},"time_grain_sqla":{"readOnly":true},"uid":{"readOnly":true},"url":{"readOnly":true},"verbose_map":{"readOnly":true}},"required":["columns","database","metrics","table_name"],"type":"object","title":"DatasetRestApi.get"}},"type":"object"},"example":{"id":"string","result":{"always_filter_main_dttm":true,"cache_timeout":1,"catalog":"string","changed_on":"2024-01-15T10:30:00Z","changed_on_humanized":{},"column_formats":{},"created_on":"2024-01-15T10:30:00Z","created_on_humanized":{},"datasource_name":{},"datasource_type":{},"default_endpoint":"string","description":"string","extra":"string","fetch_values_predicate":"string","filter_select_enabled":true,"folders":{},"granularity_sqla":{},"id":1,"is_managed_externally":true,"is_sqllab_view":true,"kind":{},"main_dttm_col":"string","name":{},"normalize_columns":true,"offset":1,"order_by_choices":{},"schema":"string","select_star":{},"sql":"string","table_name":"string","template_params":"string","time_grain_sqla":{},"uid":{},"url":{},"verbose_map":{}}}}},"description":"Dataset object has been returned."},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.api.mdx new file mode 100644 index 00000000000..74aaf4b3e68 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-dataset.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-dataset +title: "Get a dataset" +description: "Get a dataset by ID" +sidebar_label: "Get a dataset" +hide_title: true +hide_table_of_contents: true +api: eJzdWl9z2zYS/yoYzD3Yc7L1J0knw04fXCdNk8tdM7Fz16nlYSFyJSIGARoAZasafvebBUiRkiBbitNJpy+2CSwWu4vd3y6wXtIUTKJ5YbmSNKJvwBJGUmaZAUsmC/L2Fe3RgmmWgwVtaHS13FhymcFqgaPmOFowm9EelSwH/LqhParhtuQaUhpZXUKPmiSDnNFoSe2iQCouLcxA06rqLWmipAVpcZoVheAJw/36nw1uuuwsLrQqQFsOBr8SJcpcuj+5hdx02BuruZzRqtcMMK3ZAr9vYLG+AmSZ0+iKmkzdxQ3LXlfxzqhgExCdb7fIcisADaAk0OveYzK0A2ryGRJLe9RziOgMbIyCxbXKFRI7G9+WoBetkW8p2m39cC4yVYqUvOPyMyM5S7QyZKpVTsyt6JEcrOaJIUympJafTIBokCloSN04l4koU8A/iM1w0hRKGqBhIWryuOERm1tBA2c9UUoAk7SqrtEzPE9n+9Fg4A/yi86fp/hz20PRgoSnNHASGkwp7DYrJu7YwsRTLizoOGdcxqm1OU7JUgg2wePxrrypVI8mLMkgtjwHVdoHlqx8HpdYJtQMiXN2/x7kzGY0Gr34rrdrcatDkjE5gzSeLLb1mHJtbOzPZ431d88DnATbm7jqxvRVd58um+vdrv3Kw8ZHMPas4KczsKefDOhRVyN/3FOlc2ZpRFNm4QTNSg+wipJxVuZM8j/AuYcGlv4ixcIvRELn/LHfxTxAYgJuks6ZTCCNEQRjL8PGCb44SNYn6OvVCJyek2GbXgOzT9xzLdR2unlLD/eFBmP2J7ea7UXp49ST7BOhM63KwsfL48QeVrZjlpuYJZbP99yTmwMgpFjYTEl0K4ibs/kCx2o8ci/CeAYSNE+CIVCW3gwrR3EDe4gwBz1RBkKOORyMnj/KYQNoum5+GLpc4ibnbnnX//8WqDn8WhHd8ngENRHwJsxAKHUKdRfnpbA87qS1LQ4TltyAfJh7GM4GAcHDQbph73W2h5n5VaNwLZ5RpU5aAYMq1DRNFG7TwJSVwsYg00Jx+VCt8BTQ3RtFwSZZPGeiBBMXGlIsvPbDj7pQMiAgQX2QON0P6qZKpO52sUnscJrJUjDN7QKLSRa04gP4nDPJMLHCvQUtmRCLUBnqSM0t7h3POdztJ/cN3+G8q2oR7wUh533UmnVtHrjhfI1C4WvARKk1yCSQQNFBnwUz1nD08k8vKZ7g/Lu8yJ/F/nVVTR+oBZ+N9tD/m+XZHr1jWnI5iy3c74NEG9jaOYh1ox0Gsxe34t9uMUq0E1wlWkfwPyDulOaPh6yaTg3seSNTOgUdTxZxkimeQPhioO5kDV1PKSB2ud5foLBAMdrr9sH1Z50PjGU6aD98INirPMXZ/YsBC3khsHR2j1cPOUdnDc8hnmnE7p2Zpo7N7XEtguNNTOasCMwHK1v31NSUGm0mWDPBQccYeF9yuMjywt+WUKfGDt0HkZ1PIN6AG48cw84bRsutm6/oaDB6fjIYngxfXA4H0bNBNBj8Rnde1EM3843stZNjuIgNFm7BSi1YmrVarb8wrYbrXNMO7KqnOhThsslbuC2MwpVQjRzDnZWOZ7NZ2/jRunrZLlda4VoLBeDWc2kAdRjEyw52tFzXIaHBgHa+G+qd0c2I7kxtBe4qUlehuRWLVeWeUtdPsg4e4sOEZAxfREESDbbUEtJTjJznT3qizMEYNoNArfJIlK4W0h9ZShA3wNiIvJVzJnhK2ld6Umg15ymkNKBhZ63XZfhtdfkkWWkzpTFCI3JW2gykrfcnK3AMKNJd6DQZjb61JoVWCX5OBBDUwi4i8l88HK8NaK10SJVz90ovlSU1h3o1bvXiWzvbW+nhhBjQc9Bei4icSVJKuC8gsZD6QaISdysIHtdPmBpWJkAQSEqEMtdS+nxnaXR1jc0Ay2bYZmoi0WCquz9JVAoXTjjfgxJMYpZJPn1837Rg2k+P5PhdakFOfiVvXl+SMc2sLaJ+X6iEiUwZG70cvHzZZwXvz4f9uoXVH44pGY/HkpCTn8mYntUu5qwdkR+BadDkH2fn568vLuLLX/71+j9j6hovtUQf3KtdR6bVwEoqnhdK2yYIzViOZdMBIT+shjFxH6Ec5ADRe35BBgzTxg/LDQXGNCJjWisxpuSfhCXobrFVNyCrsTwey0JzaY8agU7RwY6Oj7sqvmNzduFOtqPm2mB7AEoaSzrasTvGLXFZ0Sl3oGrLNf2i5ptsnhQq+ntzWEuv5KXT8Xe/osJfqPD3Y+mFxK1WAm6oXxMpAadCzY6Q9Ph7it6ag81U6tt0rlOKFSndFH9Z3FQu72EAeQd2SSms/FZ58R6nSQpzEKrIQdo6FN2heEbLQiurEiWqqN9fIqsqWqKbVVvczktjsQPoWfTonGmOiNXcYRwb30Vz9U8tJlY3dVu0/sRfLjzX+f98efmBrPhUPYrSrPNb6bsl3IXHGJzD/E+UJm8/uNdwpTeYBE1Vr3fUlWsuNjhzgQjplXRos6QT5x8/Nbfsd/+7bDqV7s7oZtuGoVO66uHiWMNUg8m+lIlr4E7VdqfyoixAG+hW850h9B1PNx96kxibM/9G4multfb9pm06OWRHn78WEi///UIw7i7M9cXGe/YVZQVHUYb1HcXvExU36Af+oK/ocolXl09aVBUO+xbx1n8OdOXZtfkNLFxnG71UlDjvm9zc1GXylAkDDyj6pzbAHxB5Rx+81eK6DTxvmr1VOvpYF0XHZOt/L4ISNf9qIBddCRpJixtaXWOUOkx1sviJsyQBh+bNkq26Yw0A37xGz8eSrPu+2vh//QdyD4qzXHoKD9LVSjqXmFDAqvo/qOQPcg== +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"; + + + + + + + + + + +Get a dataset by ID + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.ParamsDetails.json new file mode 100644 index 00000000000..eccdacad2de --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.StatusCodes.json new file mode 100644 index 00000000000..3e4375bbca8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"form_data":{"description":"The stored form_data","type":"string"}},"type":"object"},"example":{"form_data":"string"}}},"description":"Returns the stored form_data."},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.api.mdx new file mode 100644 index 00000000000..3e09776bb2e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-form-data.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-form-data +title: "Get a form_data" +description: "Get a form_data" +sidebar_label: "Get a form_data" +hide_title: true +hide_table_of_contents: true +api: eJzFVttu3DYQ/RVi0Acblb2xkQIGgzw4ruM4DVLDu24LWAuHlmZXsimSIanNbgX9ezGkVnttCyQPfpJ4mcM5M4fDacAIKyr0aB3w+wZKBRyM8AUkoESFwOEZF5CAxa91aTEH7m2NCbiswEoAb8AvDG1z3pZqCm07ps3OaOXQ0frpq1f0ybTyqDz9CmNkmQlfajV4clrR3ArPWG3Q+jJaT7StHnLhw1KOLrOlIUPgMCqQOa8t5my1K9nxp5/Rj0+YeWgTwLmojMQt/JVJm2wddYu+tsoxv+fIY0J8/UMkK3ROTHFfNP/b+94Q3omcUY7Qec6u1UzIMmer5DJj9azMMd/Hbs02cjl5WS53StS+0Lb8G3POzmtfoPLd+awX4h4i64aRyeuXZfJZezbRtco5I7V2QUYKt9O1zZDlGh1T2jOclxT+XVI9RmB0evrSuTFWZzR8lMgoL37B2R8kt5gftFbbfTwudC3zQLVD6KzpqF9e+vpcK49WCckc2hnayIKzc8VqhXODGSUtTDKdZbX9FwG+F17IPgQJOMxqSxyptj5988Dvx1QgvZhSvYXLuZHaInuvbcV+pSo0TmB+lOkch8HLWJWlUFPgkN3dfoIEpHhEuRpGIdG4tpId/cWuLkcshcJ7wwcDqTMhC+08P3t1djYQphzMTgYYzx30RWzQPOOiTYGlaaoYO/rAUjjv7lJIAmfvUFi07Kfzi4vL4fBh9Ptvl59TgDbp/btZ+EKrNQ/7id7HsjLa+uVFcKlK1fKxYG/76eMp+gPyg303kSSaFyhytO5ts0UnBc5S6CilwH5mIiNNPnj9jKpN1WGqjC2VP1i6d0wqPDg8XCf8UczEMKR/jfTG5Co5Wjni3XMV30Tp2QR9VgSqP0S02WDLl2O2nUWi/WWZyCZSHgXGX6JFSx+i/yZV0WU6q3d3KxjdJi3xWOrpAW09fAMk8M1rcYWeiY1HukJf6Bw4TJHCFDoODv9DluIZrme8FbWlcO+NGmx78ImWWY4zlNpUqHx30UM2I1BjrPY607Llg0FDUC1vSK3tDtpF7byulhAJzIQtqR66rjYFmNiwTEQtfecmJICqrujid0P6ONiJ14fR6Ib1OG0C5M0mXs93x7lhrGC0Rh0c05Zd3xAIcdkE2Ruqzj7sbkM7t6xiQ6q/kWSoZQ08BilR9RKE9/HPEXStIWk+rq5askC6Tcj4weLEoiu+F6RNoFQTvdsUDmuD1gVR+dJTmV+fIu3EfbOTGBLnKxEel67b3ZXqBn7/wnic+4GRolSEExTUdDK+B2FKOuyEEh6lDAmsY3JqqsfLvN5D0zwKh3dWti1Nf63R0psxXkkrKD4vw7ObA58I6XDHt/79hIPbrk06ZKvQbfrcTQq1CAqWNY0gCf1+7PrbMUkv1JRwfFw5zzIMtW1ps/NUk2b6C351Semkvmwten1Sux9C3+tP08QdsUi1vXuhTJODbfsPnv5pgA== +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"; + + + + + + + + + + +Get a form_data + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-guest-token.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-guest-token.RequestSchema.json new file mode 100644 index 00000000000..84252b40396 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-guest-token.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"resources":{"items":{"properties":{"id":{"type":"string"},"type":{"enum":["dashboard"]}},"required":["id","type"],"type":"object","title":"Resource"},"type":"array"},"rls":{"items":{"properties":{"clause":{"type":"string"},"dataset":{"type":"integer"}},"required":["clause"],"type":"object","title":"RlsRule"},"type":"array"},"user":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User2"}},"required":["resources","rls"],"type":"object","title":"GuestTokenCreate"},"example":{"resources":[{}],"rls":[{}],"user":{"first_name":"string","last_name":"string","username":"string"}}}},"description":"Parameters for the guest token","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-guest-token.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-guest-token.StatusCodes.json new file mode 100644 index 00000000000..e47f61b5cec --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-guest-token.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"token":{"type":"string"}},"type":"object"},"example":{"token":"string"}}},"description":"Result contains the guest token"},"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"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-guest-token.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-guest-token.api.mdx new file mode 100644 index 00000000000..b7b29a32ef7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-guest-token.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-guest-token +title: "Get a guest token" +description: "Get a guest token" +sidebar_label: "Get a guest token" +hide_title: true +hide_table_of_contents: true +api: eJzFV9tu2zgQ/RVisEATrBInxS5QqOhDEvS6RRvEDnaByEhpaWyzoUiVpJx4Bf37YkjdfElQtAv0xZbImeGcMxeOKjD4rUTrznW2hriCVCuHytEjLwopUu6EVqOvVitas+kSc05PhdEFGifQ0ptBq0uThhfhMLe7MiKjX7cuEGKwzgi1gDpqFipAVeYQ30DG7XKmuclgWteR908YzGhLZNDIT1s90LOvmDpaF07SwlXjSm8buDF8Te9GPuVgKnlpca+TGXfcohvsCeVwgQa2fWyMPOWgtFel3OtfadHs+jUXxrpbxfP9vkn+1C6ZfGSzftzHa4vm+Q62PsqByidAvqWkmug7VBcGufNo8YHnhcStfLmp6mkTmfDYkjCE3fq8gbZf7EH24Mj5DG1qREEpDDFccsNzdGgsm2vD3BLZgtxkjvyEIVZnSvTgbaGVDWF4fnLyExUSzviOIGwS1agNYG2jukJbSsfILS6U3YFVR/DHT3meo7V88V0JtOl7pwjnPGNNo4nZe7XiUmSs6MNRGL0SGWb78A10A5bTX4vlWvHSLbUR/2IWs7PSLVG55nzWZdAeIENFsv7nr47Ke+WobCSzaFZoGBqjTczOFCsVPhSYOszCItNpWppHcL3hjssg5w+3mJZGuDXVM3y9dxDfTKmuHV9QjcO43Z9G8HCU6gzH3jnfAEBytYAY0uurj77aZyj716azx5CWRrKjf9jl5/GEJbB0rohHI6lTLpfauvjFyYsXI16I0ep01Poz8lVx66tilABLkkQxdvSOJXDWBMZTH7Nz5AYN++3s4uL1eHw7+fzX60+bChchaEeTdYEx245bL5uxZ1UCd7hOIGYJrLgsMYH6GdRRB/Vy7ZZaDcB2Cx1ckRfauLYMbKIS1bYm9qpbPi60dQd0LvtBTqKgvESeobGvqi1mAoiGnQTY74ynKVob9OtGmxh4tQ91og4TVRih3EHr/TEJHxweDvn4wFd87PNrwMnGYp8GWlmipaOC33Ph2BxduvRE/AQNVUCTo1vqjGBQrm1TFLdibDuLCPqXNpGqwJO/D+svUa8yzKNA1m4uBemW3ZnO1jH7MP786TgUvJivDyp2h+sB1aw+JGli/GWiAks0wnQMbfHfCGmJx1IvDkj08CVQ0W6W+lt0jG9dmoEgiIGyDyIouFtCDE9STDH0PSfUfGkoxHsjBdsufKRtluEKpS5yVK7pXj6DgqGqMNrpVMs6Ho0qMlXHFRVQvWPtorRO562JCFbcCD6T2E6H3gw9ZzjnpXSNmxB142rzSn9+INq0/24yuWSdnToC8mbTXod3x7lxaMu0R8MN04a9vyQjhGXTyF6qGn0vXdcUzTYYY7pUAkjfoCuY+Ux9o03Oyd6HvycUIy8GcbML3cXiQdcRKd8anBu0yx81QlasVlf9Z8jrR8ZE/wHR3XL9zNjN7f082I3rJ//jQBmBUHMdeN+guSzQ0Gn99DtYoiQPcqvTEDvrcu6v9uaAfUW1cUJ3wzt8cKNCcuGnOp/sVVNvN8ALQcedwuAGjmBQdRABJWjIwBuoqhm3eG1kXdPytxINXdnTvgj8xR1BaHWe6TtcU9EMmpavGVn6r5jt6YUqMmicpSn6zv247HTQSajTQgSz5ps01xnpGH5PMzq/hxggAu3ZCV+ftBbujzKMNsEmxYxmrgGFXRI2D4Sq/QpT64GHVRUkQs+mzhGgNEP1tK7r/wDlLj3e +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"; + + + + + + + + + + +Get a guest token + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.ParamsDetails.json new file mode 100644 index 00000000000..36406a55692 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The annotation layer id for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.StatusCodes.json new file mode 100644 index 00000000000..a098be6e5f7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"ids":{"description":"A list of annotation ids","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object","title":"AnnotationRestApi.get_list.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object","title":"AnnotationRestApi.get_list.User1"},"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"long_descr":{"nullable":true,"type":"string"},"short_descr":{"maxLength":500,"nullable":true,"type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"}},"type":"object","title":"AnnotationRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"ids":["string"],"result":[{}]}}},"description":"Items from Annotations"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.api.mdx new file mode 100644 index 00000000000..da4ca7b667a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-annotation-layers-annotation-layer-pk-annotation +title: "Get a list of annotation layers (annotation-layer-pk-annotation)" +description: "Gets a list of annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of annotation layers (annotation-layer-pk-annotation)" +hide_title: true +hide_table_of_contents: true +api: eJzVWG1v2zYQ/isEsQ8JpsRJ0Q6Fin5wgzRNVzRFnGwD4sClpbPFmiJV8uTGFfTfhyMlW37r+jKg2ydbfDk+z/Ge45EVT8ElVhYojeYxvwB0TDAlHTIzYUJrg4L6mBILsC5ipQN2LZ3RzFj2enD1ln0swS5YIazIAcE6NjGWTaRCsFJPI+aMRf+nEFOpgzWhUz/MgYKEepkrIJETmbDEqDLXzg/JAUUqUBzziK8W4PFdtYH7JoMtsEyGNTCTrtPJIy5pSiEw4xHXIgf6mvGIW/hYSgspj9GWEHGXZJALHlccFwWNkhphCpbXdVTxxGgEjdQtikLJxJvvfXCEqOpMLqwpwKIER18NP/orEXLXMe+QPMbrqG0Q1ooFfQd3rk/aMrvTkinszva5UCV47HpxNfEubcboMh8Tx2h71rJlbIwCobtNDdb7uu468s4DCzDaRe+X/Mz4AyS4i/AMFutsQZc5maPQHLU+jLixKdjOtxJjUJ3vTph0R5ERlKiAIsDoLqb9m9Bda7ev/YBUWorpEAUtbOGSBs3OpQoxhV1xFnpGTn7e0x0ENPqOoKo3dyHiwSMxnwKOvIuaGK5psBeN1/pKNR95fU+77QqjXYjDRycnIRy/UxxlmLQtbzQoFLOQGJsyP44ZzTADNhbJDHTKo60I5jJ129b6u/IbjYy+QZEWXKn2QA19bGJN7gFOAcOSrfv2aTgTegrpaLzY7ptI63AU/F7xXDy8AT3FjMe/Pd4RTzLdnbXWlNkxuSXJVTD0lz66Bof9Qh634XF864KXW9xGj1JQKEZZmQstP4NHYUGkV1otQlal4RYE/s9ontJyoNNRiph7oMbmAnnMU4FwhDL3qaRUSozJXjhAvhJwxJXR05EPJOr/RzMuMxZX4ztuenJy8hUwHAqa/wNUvpA99nvyK5IQeflB5IWCTjo4bYR81y5/v9LfXUVHTh1tyPCSFBYUuMLjyPzjH0pQOTi3nqv3emSdynIifyFSRvEJDmN2qedCybRbPhXWzGUKKd9BqzM3cDn9uVxutSgxM5a0HrN+iRlobNZnSxHuINKd6Jk8evSzmRTWJPQ5VsCIBS5i9gdtTmAD1hq7i8qZKVXKtEHWWGhm01JPfnawXWoEq4ViDuwcbGARs75mpYaHAhKENDQykySl3bNdLwUdvq0LqOxISkscqW788Il0eE+lAIqp1+lKc+yNvziQZB+OEpPCwKMMRbwSespjntxev2lrt9WnM6VNiENSWsWO/mIX5zdsyDPEIu71lEmEyozD+OnJ06c9Ucje/LS3OtBH/g7Q6zb1hpwNh0PN2NErNuT9JgB9X8xegLBg2S/9s7PzwWB0c/X7+dsh9xVuA/PdAjN/f2iBLhuWUGVeGIutRN1QD3VbHbHny2ZKiAeEg/0onyhYyUCkYN3zaoPVkMdsyBtmQ85+ZSKhCB2hmYGuh/pwqAsrNR60KI8pJg8OD7u8X4u5GPhg6HBfa1xtldGO6C8pi09CIpsAJpln/G/wrdZIx+0329xTYv++3dYqML/xxN+HGTX9kBeeDXVATpfNJeoNnzSDjIJjZaYHNPTwmS+Ac8DMpKFw9jdVOon5Xk5VMau7tMiBXp1BFKUl/+50E9/U5RvqZinMQZkiB42Nzv32BUNVYQ2axKg67vUqMlXHFUVpvWXtrHRo8tYEXdespHTYlqreTCh5J8Kfvh4mj5bXnOaTfrzk1+2/url5x5Z26ogTmnV7S75b4AYhgVEf1XL0/HD5zt+QjN0wstNVzXw/uq5p29okNqD0G0j6VFbxsQ+al21d9PrPG968BvjLr+9dXTc86TqiySMLEwsu+14j/p41MdvXikFZgHXQrbM6TRQ7Ydz8NLjEYS782dLc1C4Av/Suww5WTUe+6aiYHa3aDjfd2TnT/suPRo1zER6wVygh6cUi6KJqZHrHRSHJhac84ptS5RGP/cvQ2vMRBXaI3DteVWPh4NaquqbmcMHbep/qemsfqhks/I16+TTDfW5pNRiMSl+epDyeCOXgC3tycN0UX4fs297GdmJri3a96MJrMRczevaJeEjIHmjo6CcJ+POhnbJV/Kxlz4tzUgjVhZ2KZ6mT5k/noWodTlWFESHD10t0/qjz71L1379SRvI= +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"; + + + + + + + + + + +Gets a list of annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.StatusCodes.json new file mode 100644 index 00000000000..c07f153ff7e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"AnnotationLayerRestApi.get_list.User1"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"AnnotationLayerRestApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"descr":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"AnnotationLayerRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.api.mdx new file mode 100644 index 00000000000..3bfb687a6bf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-annotation-layers-annotation-layer.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-annotation-layers-annotation-layer +title: "Get a list of annotation layers (annotation-layer)" +description: "Gets a list of annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of annotation layers (annotation-layer)" +hide_title: true +hide_table_of_contents: true +api: eJzdWG1v2zYQ/isHYsASTImbYh0KDf3gFlnXLmuLJlkHxIFHS2ebDUWqJJXEE/TfhyMlWbLlNE0HdNgnWyTveM+9PEeyZCnaxIjcCa1YzF6is8BBCutAz4ErpR2nOZB8hcZGUFiE98JqBdrA69O3b+BTgWYFOTc8Q4fGwlwbmAvp0Ai1iMBq4/yfnC+ECtq4Sv0yixITmgWbYyLmIoFEyyJT1i/J0PGUO37IIrbegMUXJUu0cqgci0vG81yKxCsefbSEo2Q2WWLG6V9udI7GCbT0VWunv8Jh5v+4VY4sZtaRvayKmgFuDF/RdwDTF9pSO6hJ52Zw/JrLAr3tavV27gHVa1SRzdCwKtqWakdmWkvkqjtU23pZVREz+KkQBlMWX3jDghnNppctPj37iIkbAnyFqz5aVEVG6igxpo0PI6ZNiqbzLfkMZee7k1zdVaTECSeRRUxp1bVpdxC6ew372i9IhaGMClnQmM1tUlszuFXOF9hRKZTDhY+Bn5la8feO6ZC+0wckVbUZhYgFj8RsgW7qXVTncEWLBVWnrzTyGc9o4SdWXVK0ba6VDXn4+NGjkI4PLI4iCPVJ4WyJ4LTjEgwm2qTg14FW4JYIM55coUpZtJXBg+HfUZHTgGlo686I5wzaNAgBCR3CByElzBCc4cpK7jCF2QpmlIssYnjLs9w7dgxvRHKXPraVG1tholCkdtvQccuZlAEg0kCV80LCzRIVrHQBqVbfO7hS+qaLQZDr7s9F/RL7cm96+X/Fj0Oa7ufBHovc4co1ZXyBf9bkMqDZT4DTYFClaO6P+YRMeuWtGCCQPg/egYhLqW8wbZuc0749fhFCg7aQO8o0zMHc6MxHZYEu7N1Qx67+teRqgel0ttqemwtjXZtRGb89QbVwSxb/9OOAKyS/9+KNVtXZp6tmq1+tmXLcHk9O6HTyHq0b5+KwIdDDc4vmiIxq4AX6m2uTccdilnKHB074DVUhJZ+RWmcKHAC21jFNUTo+XRYZV+JvMr5kBnn6VslVEKflBimb/oceZR10X+NQn70k/tmVIh1uvwNOefzk0We3vqP3fgb/Pfp41WGNtqMe7eyFPb6+R4dq+s9Fg+ZyoCUMKh2k6y0y7untUGmfADf4rivUsNNFSYfR/iGAxcxrCPz0u05RkgU/ftWhJUNr++e3u1pPJzatIHvOU6C6QetieKWuuRRp90KTG30tUkzZAKCObMBy9G2xnCteuKU2REwxjAu3ROXq/aElhwEgXUGP5PHjb40kNzqhz5lEIBRuFcMfFJyABo3RZgjKC13IFJR2UGuopWmrJ9862V4ph0ZxCRbNNZqAIoaxgkLhbY4JnUH8IOgkKcyOcP3C6UDeuICuIklhCCPdJT/eUAVe0vXA8YWv0DWzgac2S8V6e5DoFE+9leFaLblasJgl5+9Pmvvc+tPqwiSEISmMhIM/4eXxGUzY0rk8Ho2kTrhcauvip4+ePh3xXIyuj0brJ4Spf0IYTRhMJhMFcPArTNi4zjm/IobnyA0a+G784sXx6en07O1vx28mzF90a8verdxSq45t7UBrnchybVxTlXaiJqq5JMGzdphIfY/sgAdAiILgEnmKxj4rN4BMWAwTVoOZMPgBeEJ5OHX6ClU1UfsTlRuh3F5j2CFl3t7+fhfqa37NT33IO3B7g+uAaGUJcYuS33DhYI4uWXqQD4RY9nDGzTdsRo4A/9UErwxgzzzWv4JERT8E/OeJCsbSu05r6IYb6kVa4qHUiz1auv+zv+1m6JY6Dbdk/yhETZ/thEE+8mUWsrsw5MJBT7DNAjuhaUjxGqXOM1SuLlgfoaCozI12OtGyikejklRVcUm5V21pe1FYp7NGBb3FGEG81pzFvZpwpp9z30C9mXQHqd8w6k/68bXb1//r2dk7aPVUESNr+vpavFvGnQYmojk6M9DL3qt3/vmD7iY9JYOuquX96qqiMDVsdEo8GkB6TirZzCfJL82J8fWHM4qRX0YvW352fcXyoKuIhKcG5wbt8qFK/CPKXG/fm06LHI3F7jGwM0S5E9ZdHwWXWJdx3yTq89VLdHc9mcLeeujAD+1vOrDTjv7LL7C1Ox3eulEuufDHR18JZV2IF4zngpx2xCK2WYwsYpS3ITEvWFnOuMVzI6uKhsMFlYp0p2t2mXCFK/8a1j6rMk8VTYn5ThixwGF+hyAwThL0LNpIbR0EeoTz8piSjM5Ine7fplr9p/OQy9Wqo7ssw4pAisQPwQjfEPy7bfUPRdIzEw== +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"; + + + + + + + + + + +Gets a list of annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.StatusCodes.json new file mode 100644 index 00000000000..aec9ca0e21a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_dttm":{"readOnly":true},"changed_on_utc":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User1"},"created_by_name":{"readOnly":true},"created_on_delta_humanized":{"readOnly":true},"dashboards":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object","title":"ChartRestApi.get_list.Dashboard"},"datasource_id":{"nullable":true,"type":"integer"},"datasource_name_text":{"readOnly":true},"datasource_type":{"maxLength":200,"nullable":true,"type":"string"},"datasource_url":{"readOnly":true},"description":{"nullable":true,"type":"string"},"description_markeddown":{"readOnly":true},"edit_url":{"readOnly":true},"form_data":{"readOnly":true},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"last_saved_at":{"format":"date-time","nullable":true,"type":"string"},"last_saved_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User2"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User3"},"params":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"slice_url":{"readOnly":true},"table":{"properties":{"default_endpoint":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["table_name"],"type":"object","title":"ChartRestApi.get_list.SqlaTable"},"tags":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"ChartRestApi.get_list.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"uuid":{"format":"uuid","nullable":true,"type":"string"},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"ChartRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.api.mdx new file mode 100644 index 00000000000..7fdbf598f82 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-charts.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-charts +title: "Get a list of charts" +description: "Gets a list of charts, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of charts" +hide_title: true +hide_table_of_contents: true +api: eJzdWeGP27YO/1cEYcBazL3c3dqh8LAPt3td165riyZ9e8Dl4Ck2E6snS64k5y4N/L8PlGxHTpw01/eAPvRTYomk+KNISqTWNAOTal5ariSN6XOwhjAiuLFEzUmaM21NRCoD5B03ShKlycvxm9fkYwV6RUqmWQEWtCFzpcmcCwuay0VEjNLW/SnZgkuG4gmTGXF0BgSkOE1MCSmf85SkSlSFNI6mAMsyZtkJjehmBRpfrWmqpAVpabymrCwFT53k0QeD2q+pSXMoGP4rtSpBWw4Gvxrp+JdbKNwfuyqBxtRYVJjWUTvAtGYr/PZo+kw7YgclqVIPji+ZqMDpLldv5g5QQyOrYgaa1tEuVzcyU0oAk+FQo+t1XUdUw8eKa8hofOUU82q0i153+NTsA6R2CPANrPpoQVYFikN3SFobRlTpDHTwLdgMRPAduFRIhUIstwJoRKWSoU77NyFca9jWjiDjGj3Ke0GrNjNpo83gUiVbQCCSSwsLtwduJjH8055p777JFzhVvb0LEfUWiekCbOJM1PhwjcQcY9KFGtqMFUj4kdbXuNumVNJ4Pzw/PfXu+IXBUXmmfiqY5ECsskwQDanSGXF0RElicyAzlt6AzGi048GD278nIhOPaWjpYMTlDFzUMxFkOiF/cSHIDIjVTBrBLGRktiIz9EUaUbhjRekMe0Fe8/SQPLrjGzvbhFuRmV1FL7pMiR5AeOZz5bwS5DYHSVaqIpmS31tyI9VtiIGj6Y7PRf0Qu781Hf//xI5Dko6zYC+LHDDlJmXcwz6b5DIg2U0Qq4gGmYE+HvMrVOmF02IggfTz4AFETAh1C1l3yFnlzsd7IdRgKrEnTP0cmWtVuF1ZgPVrt6lj3/nF0hwSywtQlRMtKyHYDKFbXUE0kPtS5J43qSXJwDIuzAHWDaCGE7JktjqOIWdy0ZH3NZ9zbWzn7wW7ewVyYXMa//R4QBLPhhO5YEcL2Tpgg/VDMTun7Ca/X+JV6h0Ye1HykzbZn7w3jVk7rJ0+Glj2RoqVt09A4+wuLEvyqmCSf4Lss+TWFp+jqWw6TKIB4+Ob34Uz2gN7YBsamiO3IWMmnymms4H46+Y2qSvA/+T0NPp8lAxb9cBFY9gE/2pVcSc4s8yoSqeQePGfzwsBC1ousXBn99ijI/RSepjPj8IcyKi0GF4mTJJHJJvw0lIwfQNZpm7loGjIuN277lzpIkH9Bmf3hQA3ScEkw1CEOwtaMiFWAenm6u/d3LAlZAlzFsYV8R9aBR5hMqdHmDAQ861H9rk7q29lU8t9u0B/9LWLZsVxJ7IRvAnX7Sh8ckwUevZ9gWA9707KgzmrhE1AZqXi8tCtI7gL4exeRQ8bOOC9t1HHHwWbOM2cEosB/9nnEV9s1TYpNkXsWXQe/Rg9vr5/Rp8wLy+viplkXOzdqb3jlQfXJRg3cASEJf80mNuPwH9flEeU2HVwoe+K3bO9ZWqvlDqieGxLw6sWw/VAtTYodLCS2qmTenKDKqdfm2yVIiFTWzhcrbFPtH00UifBlw5/qgwEavD4v+onFGBMv7VyqCoM9qZjpL+yjGAQg7ExeSGXTPAsbDaWWi15BhkdABTweixnXxfLe8kqmyuNN8SYXFQ2B2mb9UmXqQaAhIwOyfn510ZSapXi50wAQRR2FZN/4+Z4NKC10kNQLlUlMiKVJY2EhhuXevK1ne2F9DcuYkAvQXsUMbmQpJJwV0KK7QE3SFSaVnrPdv3GsFfWmgC7hGmlESO2eT/cYgReY+fOnyNXPp8ZjNC7R6nKYOxU821uweSCxjR9/+5V21/dfPqbL35XWpBH/yHPn03IlObWlvFoJFTKRK6MjZ+ePn06YiUfLc9GrpE/mlIynU4lIY9+J1N60XiXM3RMfgWmQZPvLi4vn43HyeTNH89eT6nrNjfqvF3ZXMlAoW6gU4kXpdK2jT8zlVPZdirJL90wpu8HqAc5Vu/IU+fAMtDml/WW9lMakyltEEwp+YGwFN0sseoGZD2VD6ey1FzaB602J+hYDx4+DPG9ZEs2djsaYOwNbkyvpEGYHTR2y7glc7Bp7pDdB9e6By5uv8n2HiHKv9ttWnuEEwfwb89R4w+i/XkqvYZYiXTabWFviJSAE6EWD5D04c+uuVyAzVXmm9LuDQaPb9rXHa3h4sV7rLtEDGOm25HyCqdJBksQqixA2iby3F54QetSK6tSJep4NFqjqDpeo2vVO9IuK2NV0YrA9w7NMUG1lzUnJrh6Nmpin695J2g+8cfFY1/+75PJW9LJqSOK2vTldXh3lBv7lIJzePjj89mLt+6ajv2/npBBUzX8jrqucW/atDLGhOhBuuSypjPnGb+1t7WXf01wjxwZlpBudtPGdKDrCJkTDXMNJv9SIe6hYq52e5PjqgRtILzFBUPoO55ueeZNYmzBfLnuL0rPwe48Rm6bKDg5/v9eLxszYTNkVArG3f2uuW/7qLqirORojDPq2nGuK4xO6L3siq7XM2bgvRZ1jcO+o4sRt9cK+9a9gZV7PureIakL9jZe3PkUUZ+F3Aqe4SJNwSW/lmvneO6ljOfP0GPw5hL2L1q/af4EL59MrgLZ67Wn8GkNg90r4fK4e+is/wG9pq+k +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"; + + + + + + + + + + +Gets a list of charts, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.StatusCodes.json new file mode 100644 index 00000000000..694eb8d780f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get_list.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get_list.User1"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"css":{"nullable":true,"type":"string"},"id":{"type":"integer"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"CssTemplateRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.api.mdx new file mode 100644 index 00000000000..b08db717502 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-css-templates.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-css-templates +title: "Get a list of CSS templates" +description: "Gets a list of CSS templates, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of CSS templates" +hide_title: true +hide_table_of_contents: true +api: eJzlWG1v2zYQ/isHYsASzImTYB0KFf2QBmnaLmuKOlkHxIFLS2ebDUWqJJXEFfTfhyMlRYrlNMkGdMA+2SJ5x3vu5TmSBUvQxkZkTmjFInaEzgIHKawDPYOD0QgcppnkDu0AcovwUVitQBt4Nzp5D19zNEvIuOEpOjQWZtrATEiHRqj5AKw2zv/J+FwoTrsAV4lfZlFiTLNgM4zFTMQQa5mnyvolKTqecMe32YDdbsCi84LFWjlUjkUF41kmRewVD79YwlAwGy8w5fQvMzpD4wRa+qq001/hMPV/3DJDFjHryF5WDuoBbgxf0ncA0xVaUdurSWemd/yKyxy97Wp5MvOAqjUqT6doWDlYlWpGplpL5Ko9VNl6UZYDZvBrLgwmLDr3hgUz6k0vGnx6+gVj1wf4EpddtKjylNRRUkxqHw6YNgma1rfkU5St71ZitVeREiecRDZgSqu2TeuD0N6r39d+QSIMZVTIgtpsbuPKmt6tMj7HlkqhHM59DPzMxIpva6ZD+k6ekFTl3SgMWPBIxOboJt5FVQ6XtFhQZfpKI5/xlBZ+ZeUFRdtmWtmQh3s7OyEdn1gceRDqEsLpAsFpxyUYjLVJwK8DrcAtEKY8vkSVsMFKBveGf01FTgKmvq1bI54zaNMgBCS0DZ+ElDBFcIYrSzSVwHQJU8pFNmB4w9PMO3Yf3ov4Pn1sJTdWwkShSOyqofsNX1IGgEgCVc5yCdcLVLDUOSRa/ezgUunrNgZBrns4F3VL7PHe9PL/ih/7ND3Mgx0WuceVt5TxCP/ckkuPZj8BToNBlaB5OOZjMumtt6KHQLo8eA8iLqW+xqRpck779vgohAZtLteUaZiDmdGpj8ocXdi7po51/WvB1RyTyXS5OjcTxromo1J+c4xq7hYs+u3XHleIpJ8qJX+wkjstrLV/W81KH7tl0ANrT6sTy0e0bj8T2zWpbp/ZYE+NWKtJgtLxySJPuRLf0NtvkCcnSi5Z5EyOtNwgJcf/xEG7rAU59IyZNil3LGIJd7jlhN9M5VLyKakkN/WAja330HfXrXNKffDsc8zes53vWnBPm73HBw9o12WLHJrGubu25XVo+QGNqG4z5zWSix7m71Xay8ornNvR22LMLs/dobW2UE1C5wWdObu9nkXMawg09IdOUJIFv/6js0mK1naPafd1mFZsGkH2iidAdYPWRfBWXXEpkva9JTP6SiSYsB5ALdmAZffHYjlTPHcLbYiwItjP3QKVq/aHhhx6gLQFPZK9vR+NJDM6ps+pRCAUbhnBnxScgAaN0aYPyoHOZQJKO6g0VNK01bMfnWxvlUOjuASL5gpNQBHBvoJc4U2GMR01/CDoOM7NmnC95nTurl1AN444N4SRroxfrqkCL+gW4PjcVyjd1mtas1SoN1uxTnDkLQw3Z8nVnEUsPvt4XF/Zbj+tzk1M9se5kbD1FxwdnsKYLZzLouFQ6pjLhbYuer7z/PmQZ2J4tTuMrZ3URD0cMxiPxwpg6w2M2X6Va97tEbxCbtDAT/sHB4ej0eT05PfD92Pm77GVVR+WbqFVy65moLFMpJk2rq5GO1ZjVd+B4GUzTGS+QXbAI80fBKEF8gSNfVncATFmEYxZBWTM4BfgMeXexOlLVOVYbY5VZoRyG7VR25RtG5ubbZjv+BUf+TC3oHYGbwOhlSW0DUJ+zYWDGbp44QE+AV7RwRjV33A3YgT2cx20IgA99Tg/B4mSfgj0i7EKhtJzTWPkHRdUi7TEbannG7R084W/xKboFjoJl1//1kMNnvVCIN/4kgrZnBtyXa8H2N1iOqZpSPAKpc5SVK4qTh+ZoKjIjHY61rKMhsOCVJVRQflWrmg7yK3Taa2CnleMIA6rj9deTTimz7hvlt5MulZUzxLVJ/34Wu3qf3N6+gEaPeWAkTVdfQ3eFeNGgXVojs4H9Fj39oN/0aDrRkdJr6sqeb+6LClENfOMiDMDSM8/BZv6BHldHxDffTqlGPll9FjlZ29vTR50OSDhicGZQbt4qhL/LjLTq1ehUZ6hsdg+7rWGKHfCuqvd4BLrUu4bQnWWOkK37gX0rqdaPea/+nJa+czhjRtmkgt/HvTpXlSVds54Jsgzu8yf2ZtqYwNGiRky75wVxZRbPDOyLGk4XCqpCte6ZN32l7j0L1jNUyjzPFDXkG9rAxYIyu8QBPbjGD091lIrXb3DJkeHlEV04Gm18iaXqj+tx1euli3dRRFWBMYjAghGeKb3b63l38cPEaE= +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"; + + + + + + + + + + +Gets a list of CSS templates, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.StatusCodes.json new file mode 100644 index 00000000000..2a8ba789c64 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DashboardRestApi.get_list.User"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_utc":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DashboardRestApi.get_list.User1"},"created_on_delta_humanized":{"readOnly":true},"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DashboardRestApi.get_list.User2"},"published":{"nullable":true,"type":"boolean"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"DashboardRestApi.get_list.Role"},"slug":{"maxLength":255,"nullable":true,"type":"string"},"status":{"readOnly":true},"tags":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"DashboardRestApi.get_list.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"type":"object","title":"DashboardRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.api.mdx new file mode 100644 index 00000000000..2355d9981a9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-dashboards.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-dashboards +title: "Get a list of dashboards" +description: "Gets a list of dashboards, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of dashboards" +hide_title: true +hide_table_of_contents: true +api: eJzlWW1v2zYQ/isHYsBaTI2TrBkKFfuQdW3XrmuLJt0GxIFLS2eLDUWqJJXENfTfhyMlWbLl1MkGdNg+WaLujvfcG4/nJUvRJkYUTmjFYvYcnQUOUlgHegYpt9lUc5PaCEqL8E5YrUAbeHny5jV8KtEsoOCG5+jQWJhpAzMhHRqh5hFYbZx/KPhcKE5bAFcpeDqLEhP6DLbARMxEAomWZa6sp8nR8ZQ7vscittqBxWdLlmjlUDkWLxkvCikSL3n00RKCJbNJhjmnp8LoAo0TaOmtlk6PwmHuH9yiQBYz60hhVkXNAjeGL+g9oOkzbYgdlKQLM7h+yWWJXne1eDPzgGoaVeZTNKyKNrnalanWErnqLtW6nldVxAx+KoXBlMVnXrGgRrPpeYtPTz9i4oYAX+CijxZVmZM4ColJY8OIaZOi6bxLPkXZee+EVZeKhDjhJLKIKa26Om13QnevYVt7glQYiqgQBY3a3Ca1NoNbFXyOHZFCOZx7H/gvEys+b/kcwndyh6Cq1r0QsWCRmM3RTbyJ6hiuiFhQXvpUI5vxnAg/seqcvG0LrWyIw8P9/RCOd0yOMjD1y8FphuC04xIMJtqk4OlAK3AZwpQnF6hSFm1E8KD7t2TkJGAa2rqz4msGbRqYgJj24A8hJUwRnOHKSu4whekCphSLLGJ4zfPCG/YYXovkJnlsIzY23ESuSO2mosdttaQIAFHXylkp4SpDBQtdQqrVtw4ulL7qYhBkut1rUT/Fbm9Nz/+P2HFI0m4W7FWRG0y5Khm3sM+quAxI9h/AaTCoUjS7Y35FKr3wWgwUkH4dvAERl1JfYdoeck778/FWCA3aUm5J0/ANZkbn3itzdGHvpnRsO7/ocVbXiUmKjgvpP6hSSj4lEzhT4gD0mhPTyXSxG0PG1bwl76sxE8a6Nnhzfv0K1dxlLP7h4YAkkQ5XZcl3FrJ2Wnb274rZODJXxfrnpjd6h9YdF2Kvqd57723QZoW31ckgT98ouQg26tB420vHJ1mZcyU+Y/ol8tIlwyQGKZj/F1Y+YB3AO5qw7WlXtaKD4Wh/P/pyJG+zjLCTnCtOHsJrh0ZxKRcd0lX7xvSVqhvL/7aLDn0zVU6lsFnwyBbrdmxjtMQB02wDeyecd0f1Tkv0LaAs52vbHh4d7RA91nFX2sHgdHz+94AfHu0Sv2Gh7ZIPosPo++jh+U296XZ7nPIgMyvzqeJCTkojB8FtXS8DwJk2OXcsDgtfhHEXZXdox6vO4d82xgdbW9pe27VDo9m0kWcNjvOBzm5Q6GDXtdFT9eR2OqJ+H7PWtnSZmibjbEl3yn4vz2LmJYQ24zedoiQNHv6tu0eO1vavYTd1kB3ftIzsJ54CJTdaF8MLdcmlSLuDicLoS5FiygYAdXgDloOvi+W94qXLtKEDLIbj0mWoXL0/tBVsAEiX0SM5PPzaSAqjE3qdSgRC4RYx/E7OCWjQGG2GoDzRpUxBaQe1hJqbtjr62sH2QoWTHSyaSzQBRQzHCkqF1wUmdJXwi6CTpDRb3PWM0726MQFNFJLSEEYaCX28ogw8p1t+OBLOVjXNUpZeP0h0iidevTAWk1zNWcyS9+9eNfOY1avVpUlI+aQ0Eh78Cc+fnsKYZc4V8WgkdcJlpq2LH+0/ejTihRhdHozaRmk0ZjAejxXAg19gzI7rKPMGj+En5AYNfHP85MnTk5PJ6Ztfn74eMz+hqlV6u3CZVh2l2oVWLZEX2rgmD+1YjVUz3YAf22Uq4/dID7iN7lHgyJCnaOyPyzUEYxbDmNUoxgy+A55QyE2cvkBVjdX9sSqMUO5eo9EeBdm9+/e7GF/yS37ivdvB2VtcuUArS1BbePyKCwczdEnm0d0W27IHMG7eYd1XhPRD465lQHnqQX4IHBX9EOLHYxW0pBFsq+Ea/ppIS9yTen6PSO8/9oOpHF2m0zDQ8vNb6kzYpv5kFZ9DIYJ9fzCMna1nzyv6DCleotRFjsrV2eh9EgQtC6OdTrSs4tFoSaKqeElhVm1Ie1Jap/NGBM1LjaCi1fRiXky4d8+4Px29mjQnqOeM9Sv9+Pzsy//l9PQttHKqiJE2fXkt3g3lTkKZoW/UEND4/cVb31XT/KAnZNBUNb+nriryT1NqTqhIBpC+4CzZ1EfHs6YRe/nHKfnIk1GL7r+uxiAedBUR88TgzKDN7irEDzpnenO2cVIWaCx2u7vOEsVOoLs8CCaxLuf+BKibp+foBv/QWDdT50T5d/4LUpvL4bUbFZIL3/vVLXXIsDPGC0FGOWCday6LGAVkiLgztlxOucX3RlYVLYfpEGXfVmts2/sCF34U3f6nwXzyN7njz6+IharkdwgMx0mCviA2XBvHd6+EPH9K0UOdTfce3cRQ/dD5F4WrRUf2chkoQpmjxA9K+Nru/zSp/gJ1sGIW +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"; + + + + + + + + + + +Gets a list of dashboards, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.StatusCodes.json new file mode 100644 index 00000000000..b0d91e674b1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"allow_ctas":{"nullable":true,"type":"boolean"},"allow_cvas":{"nullable":true,"type":"boolean"},"allow_dml":{"nullable":true,"type":"boolean"},"allow_file_upload":{"nullable":true,"type":"boolean"},"allow_multi_catalog":{"readOnly":true},"allow_run_async":{"nullable":true,"type":"boolean"},"allows_cost_estimate":{"readOnly":true},"allows_subquery":{"readOnly":true},"allows_virtual_table_explore":{"readOnly":true},"backend":{"readOnly":true},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatabaseRestApi.get_list.User"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatabaseRestApi.get_list.User1"},"database_name":{"maxLength":250,"type":"string"},"disable_data_preview":{"readOnly":true},"disable_drill_to_detail":{"readOnly":true},"engine_information":{"readOnly":true},"explore_database_id":{"readOnly":true},"expose_in_sqllab":{"nullable":true,"type":"boolean"},"extra":{"nullable":true,"type":"string"},"force_ctas_schema":{"maxLength":250,"nullable":true,"type":"string"},"id":{"type":"integer"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["database_name"],"type":"object","title":"DatabaseRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.api.mdx new file mode 100644 index 00000000000..3ea808e38b0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-databases.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-databases +title: "Get a list of databases" +description: "Gets a list of databases, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of databases" +hide_title: true +hide_table_of_contents: true +api: eJzdWW2P2zYS/isEUeASVFlng6YIVPTDNpemSdMkyG6uB6wXKi2NbWYpUiFH3nUF/fdiSEmWLHm7zh2Qw32ySM4M55k3DumKZ+BSKwuURvOYvwR0TDAlHTKzZJlAsRAOXMRKB+yDdEYzY9nr83dv2ecS7JYVwoocEKxjS2PZUioEK/UqYs5Y9B+FWEktaAcmdMY8nQMFKS0zV0AqlzJlqVFlrp2nyQEFbX7CI77bgceXFU+NRtDI44qLolAy9ZJnnxwBqLhL15AL+iqsKcCiBEejRjp9SoTcf+C2AB5zh6Qwr6N2QlgrtjQOaIZMI7GTkkxhJ+c3QpXgddfbd0sPqKHRZb4Ay+tozNXNLIxRIHR/qtH1qq4jbuFzKS1kPL70igU12k2vOnxm8QlSnAJ8DdshWtBlTuIoIpLWhhE3NgPbGyuxANUb96KqT0VCUKICHnFtdF+nw07o7zVta0+QSUsRFaKgVVu4tNFmcqtCrKAnUmqElfeBX0mc/PPAcgjf5AuCqt73QsSDRWK+Aky8iZoYrolYUlr6VCObiZwIP/P6irztCqNdiMMnjx+HcPzC5CgD07AaXKyBoUGhmIXU2Ix5OmY0wzWwhUivQWc8GkXwpPsPZGQSME1t3ZvxNYM2DUyMmE7Y71IptgCGVminBELGFlu2oFjkEYdbkRfesGfsrUzvksdHsTFyE7kic2NFz7piSRHAZBZq5bJU7GYNmm1NyTKj/4HsWpubPgZJprt/LRqm2PHW9Pz/FTtOSbqfBQdV5A5T7krGEfbZFZcJyX6BoWEWdAb2/pjfkEqvvBYTBWRYB+9AJJQyN5B1hxwafz4ehdCCK9WBNA1rbGlN7r2yAgx7t6XjwPnl9UpSFH6kS6XEgnCjLSEaHzst/eY4+ixXx5AvpYKkLJQR2TFsealQJqlAocyKGC2I7J1W28DY0dlSJ8JtdXqEcJekxmECDmUuEA5Ld4krF8Hod9BspMVSqARp6wRuC2XstNC2yk6tpWuhV5Ali+3YsUtpHXblIBe3b0CvcM3j77+biGMl7k2812f09umLGTUbu2Pun01T+QEcnhXypD32Tj66cHq0sMKZtTQ2F8hjngmERyj9Rge8tgO0k5FkoFAk6zIXWv4JByxpgUrA/5MlT/1B3FBMafTk6eMJ/TPpfEwSZ1JY2Ei4mTRZR2ilUgmaJAMUUk3Sgl5JDYnUwZlNkzYmC3mQdFrLaW/BbWFoVSfuM8XB/fIYbtGKO0h3Nlgam4IvismuY9q33N9KCcqPe8eyDCtdYPuJvxW4Fy1Dz35BkNyjNa17B2HXJJ4ebO8GLcg9mq62pbpsMV5NdDmTQic7kFF/MZDb6w6GZ/reEd5nag/cy4ruV8O+lsfcSwhH7m8mA0UafPcf9eE5ODe8ktzVTfV80zHyn0TGKE7AYcxe6Y1QMutf0gtrNjKDjE8A6vEGLKdfF8tHLUpcG0tlO2ZnJa5BY7M/65JhAkif0SN58uRrIymsSWm4UMAIBW5j9i9yTkAD1ho7BeW5KVXGtEHWSGi4aaunXzvYXmkEq4ViDuwGbEARszPNSg23BaTUVvtJZtK0tAfc9TO1bJ0J6HadlpYw0vPIpxvKwCu68aJY+QxtSxrl6O2j1GRw7pULD0RK6BWPefrxw5v2ZWI3dKa0KamellaxR/9mL19csDlfIxbxbKZMKtTaOIyfPX72bCYKOducztpSO5tzNp/PNWOPfmFzftaEmLd2zH4CYcGyb86eP39xfp5cvPv1xds59081jUbvt7g2uqdTN9FpJfPCWGyT0M31XLfXfPZjN001/AHpwY5QPQoMaxAZWPdjtQdgzmM25w2IOWffMpFSuCVorkHXc/1wrgsrNT5oFTqhAHvw8GEf4muxEefesz2Yg8mdA4x2hLRDJ26ERLYETNce3JHQqgG+uB2zfU8R0D9aZ1UB5IXH+EfgqOmHAP8w10FJ2qpTcA9+Q2QUnCizekCkD3/w7zM54Npk4V3HP2NS68BH6pNNfPaE6C0tmWwSOd/Pmze0zDLYgDJFDhqbPPQeCYKqwho0qVF1PJtVJKqOK4qxeiTteenQ5K0IejW0kspVe2v0YsLtcyn8uejVpNty89rWDOnHUW4O5f9ycfGedXLqiJM2Q3kd3pFy56HA0Bq1AvQI/eq9f6ijW/RAyKSpGn5PXdfknrbInFN5DCB9qan4wgfHz2179vr3C/KRJ6OO0q/uHgM86Doi5sTC0oJbf6kQ/9y3NOMb/nlZgHXQb+t6UxQ7gW5zGkziMBe+9jdt00vAqVf9fSv1jpL/yX8CGmMh3OKsUEL6ns/HedWk1yUXhSSTnPLd5YdHnKIxhNslryqa/GhVXdN0c1e/rA7b4tDW17D1r7Hdsz73id8mjj+2Ih4qkt8hMJylKfha2HKNTu1B+Xj5gkKHGpreUd0FUPPR+yNB6G1PdlUFilDiKOuDEr6s+/8N6r8Aj2oTYQ== +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"; + + + + + + + + + + +Gets a list of databases, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.StatusCodes.json new file mode 100644 index 00000000000..dd6445c58ee --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get_list.User"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_utc":{"readOnly":true},"database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"DatasetRestApi.get_list.Database"},"datasource_type":{"readOnly":true},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"explore_url":{"readOnly":true},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"kind":{"readOnly":true},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get_list.User1"},"schema":{"maxLength":255,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["database","table_name"],"type":"object","title":"DatasetRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.api.mdx new file mode 100644 index 00000000000..847cded6fdd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-datasets.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-datasets +title: "Get a list of datasets" +description: "Gets a list of datasets, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of datasets" +hide_title: true +hide_table_of_contents: true +api: eJzdWG1v2zYQ/isHYsBazI2bYC0KDf2QdV3XrmuLJl0HxIFHS2ebDUWq5CmJZ+i/D0dKimTLrdMN6LBPEsnj8Z7jvfHWIkOfOlWQskYk4hmSBwlaeQI7h0yS9Eh+BKVHeKu8NWAdvDh5/Qo+luhWUEgncyR0HubWwVxpQqfMYgTeOgo/hVwoI/kAkCaDQOdRY8rL4AtM1VylkFpd5sYHmhxJ8tkHYiRuThDJ2Vqk1hAaEslayKLQKg2cxx88y78WPl1iLvmvcLZARwo9j2ru/KsI8/BDqwJFIjyxwKIaNRPSObnicUTT37TFdpCTLdzg/KXUJQbZzer1PACqaUyZz9CJarS9q52ZWatRmu5ULet5VY2Ew4+lcpiJ5CwIFsVoDj1v8dnZB0xpCPAFrvpo0ZQ5s2ODmDY6HAnrMnSdsZYz1J1xx6i6VMyEFGkUI2Gs6cq0+xK6Zw3rOhBkyrFFRStoxJY+raUZPKqQC+ywVIZwEe4grEy9+mvHcjTf6RcYVbV5CyMRNZKIBdI0qKi24YqJFXtlcDXWmcyZ8KOozvm2fWGNj3Z4dP9+NMcvdI4ybuoHg9MlAlmSGhym1mUQ6MAaoCXCTKYXaDIx2rLgwevf4ZHTiGno6M5MiBl8aNwEvOkA3iutYYZAThqvJWEGsxXM2BbFSOC1zIug2GN4pdJP8RNbtrF1TXwVmd8W9LiNlWwBoLIYK+elhqslGljZEjJrviW4MPaqi0Gx6vaPRX0Xu702w/5/RY9DnPbTYC+KfEKVNyHjFvq5CS4DnMMCkAWHJkO3P+aXLNLzIMVAAOnHwU8gklrbK8zaJEc25MdbIXToS73DTeMazJ3Nw60skOLZTejYlb8kSW0X/JvL65doFrQUydGDhyNhSq3ljJVArsQB8OlSmgVm09lqm+9cOU+tNXZYP/x+gJPKhsOslnsz2Uh/nfO7bLZy4E30/SmWOm/R03GhDppgfPDOR1lu0LYSOZTZa6NXUUMdGmumGWqS02WZS6P+wuxz5CWlgyRcBM2kx20NNytD+jl6cH9vLW8ors/2C/T1UyNxLb23pUtxGtkMIcS5LDVN0WSFVTENfdb0eg6wBz1eF9o6nJZODwqB1+TkXpx2meqFMsOXbK9MXUL+nz3kMFRFbXnRs8UHe8QS/1HvpX7i1f1Nviyj4ubW5ZJEEic+K88OnxC982+vqT2qwaqTe9q67HBnRdXL+nvUOU0Vc9ZAPR8oLAaZDib9rZTe49tJyP00upE1u5uaHHe25ifNpqeLwCFmud9shpol+P4flb45et9/BXyqgOncTbtR/CgzYHNBTwk8N5dSq6z7Li6cvVQZZmIAUGdvxHL4dbG8M7KkpXWcsxI4LmmJhurzofWJASDdjQHJ0dHXRlI4m/JwphEYBa0S+J0vJ6JB56wbgvLEljoDYwlqDvVuPurB1za254bQGanBo7tEF1EkcGygNHhdYMqVbJgEm6al23FdP3Pd16qAH7Rp6RgjdyQ+XLEHnvMjk+QieGgd0Tz76PW91GZ4EoSLPRktzUIkIn339mXTDLgZxgKAx6XTcO8PePb0FCZiSVQk47G2qdRL6yl5dP/Ro7Es1PjycFz3ncYTAZPJxADc+wUm4ri2sKDsBH5E6dDBN8dPnjw9OZmevv716auJCM2RWqA3K1pa0xGpnWiFUnlhHTU+6CdmYpqHNTxupzmE32E5YH/JR5F+iTJD5x+vN+SfiAQmosYwEfAdyJSNbUr2Ak01MXcnpnDK0J1GngM2rzt373YRvpCX8iTcawdlb/JG/dZ4BtqCk1dSEcyR0mXAdjtk6x68pBnD5j0xzj+bq1pHjKcB4p9xR8UfxvvDxEQZ+aRWvg30NZHVeKDt4g6T3v0h9ENypKXNYh8ltA25LBCb0rNGgudEyw0F4TBusekzL3kZMrxEbYscDdU+GO4jMloXzpJNra6S8XjNrKpkzQZWbXF7UnqyecOCm3ROcahqSsXAJj72QoFci8mP07q5VQ/5E/yyz/+X09M30PKpRoKl6fNr8W4JdxKDC69xGcA93+dvQl+MH609JoOqqvcH6qri22kCzAmHxggyhJm1mAXb+Lmp0F68PxV1KRlanmH15u0dQFcj3jx1OHfol1/KJHTX5nb7QX1SFug8diu6zhTbTqS7PIwq8ZTL+A6JJdMzpIEe+qaSOlnkv9h2r1VFeE3jQksVqr36/RR960zIQrFCDkX91Av6YVOMtnYm1muum985XVU8HZsR7Hc7NbHr5Atchc5n20IXwekbrwn5aiRiNAonxA3HaYohDDa7ttJ1L3Q8e8p2w5VMJ0e31lP/dJr20qw6vNfrSBHDG7t8FCJE9NCjr/4G+SHVRQ== +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"; + + + + + + + + + + +Gets a list of datasets, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.StatusCodes.json new file mode 100644 index 00000000000..98013398488 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"action":{"maxLength":512,"nullable":true,"type":"string"},"dashboard_id":{"nullable":true,"type":"integer"},"dttm":{"format":"date-time","nullable":true,"type":"string"},"duration_ms":{"nullable":true,"type":"integer"},"json":{"nullable":true,"type":"string"},"referrer":{"maxLength":1024,"nullable":true,"type":"string"},"slice_id":{"nullable":true,"type":"integer"},"user":{"properties":{"username":{"maxLength":64,"type":"string"}},"required":["username"],"type":"object","title":"LogRestApi.get_list.User"},"user_id":{"nullable":true,"type":"integer"}},"type":"object","title":"LogRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.api.mdx new file mode 100644 index 00000000000..2c7d0795bcd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-logs.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-logs +title: "Get a list of logs" +description: "Gets a list of logs, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of logs" +hide_title: true +hide_table_of_contents: true +api: eJzNWG1v2zYQ/isHYsASzImToB0KFf2QBn1Jl7VFk6wD4sClpbPNhiJVkkriCvrvw5GSLNly6nYDuk+2+HK8516eO7JgCdrYiMwJrVjEXqGzwEEK60BPQeqZHUBuET4IqxVoA2/O372FLzmaBWTc8BQdGgtTbWAqpEMj1GwAVhvn/2R8JhQn4cBVAn6dRYkxTYPNMBZTEUOsZZ4q69ek6HjCHd9nA7Y8gUVXBYu1cqgciwrGs0yK2Esefrake8FsPMeU07/M6AyNE2jpq5JOf4XD1P9xiwxZxKwjhVk5qAe4MXxB3wFNd9Oa2F5JOjO947dc5uh1V4t3Uw+oWqPydIKGlYP1Xc3IRGuJXLWHKl2vy3LADH7JhcGERVdesaBGfeh1g09PPmPs+gDf4KKLFlWekjgKhnFtwwHTJkHT+pZ8grL13Qqo9ioS4oSTyAZMadXWabMT2mf129ovSIShiApRUKvNbVxp03tUxmfYEimUw5n3gZ8ZW/F1w3QI3/EPBFW56oUBCxaJ2Azd2JuoiuGSFgvKSJ9qZDOe0sIvrLwmb9tMKxvi8OjgIITjDyZHHjZ1ieBijuC04xIMxtok4NeBVuDmCBMe36BK2GAtgnvdvyEjxwFT39GtEc8ZdGjYBLRpHz4KKWGC4AxXVnKHCUwWMKFYZAOG9zzNvGGP4a2IH5LH1mJjzU3kisSuK3rc8CRFAIgkcOU0l3A3RwULnUOi1a8ObpS+a2MQZLrtuaibYt9vTb//P7Fjn6TtLNhhkQdMuaSM77DPklx6JPsJcBoMqgTN9pjPSKVTr0UPgXR58AFEXEp9h0lT5Jz29fG7EBq0udyQpmEOpkan3iszdOHsmjo21C/eUGbK789QzdycRY8PjwZM5VLyCdnAmRx7sCfczieam2QsEhKwYUOLNRPnUlo51SbljkUs4Q73nEh9PfjmebnxbDYOOL59XM1635RscIrGoFkxw+HB0aMt9LJSxLi1DXIbzum6gUbr1G1p8PujvrRql/lm41p1X9aVMz37gNYdZ2K/LjH7l3apzpa6P1C5ek7YovKVrTxratDhxurRYbgtOL1m7Kvadtc9JNortJfg1uirI7dFPl3KWGGI9qY6n68Kat+6ZZNFzEsIGf2nTlCSBo/+VZlP0dpux/MQWbd802xkz3kCFH9oXQSn6pZLkbTvAJnRtyLBhPUAau0NWA5/LpZLxXM310Z8xSSC49zNUbnqfGiSrAdIe6NHcnT0s5FkRsf0OZEIhMItIviLnBPQoDHa9EE50blMQGkHlYRqNx31+GcH26lyxG4SLJpbNAFFBMcKcoX3GcZUtf0g6DjOzQZ3veTUwtYmoOY9zg1hpNvX5zvKwGtqqB2f+Qxdshll6f1erBM89+qFG6jkasYiFl9+OKuvPstPq3MTk/JxbiTs/Q2vXlzAiM2dy6LhUOqYy7m2Lnpy8OTJkGdieHs4lHo2HDEYjUYKYO81jNhxFV/e1BE8R27QwC/HJycvzs/HF+/+ePF2xPw1sFLm/cLNtWqp0ww0Cok008bVGWhHaqTqKwQ8a4aJwHdID9hO60FYO0eeoLHPihXdRyyCEav0HzH4DXhMYTZ2+gZVOVK7I5UZodxOrcs+BdbO7m4b3Rt+y8+9R1sIO4NLs2tlCWQDjN9x4WCKLp57XNujKjrQovobVv1DGD/VLioCvgsP71PYUdIPYX06UkE/ettodFtBXi3SEvelnu3Q0t2n/saXopvrJNwU/cMI9QisrTlZwudKiNTckKF68bLVLDmjaUjwFqXOUlSuyjrvhyCoyIx2OtayjIbDgkSVUUFBVa5JO8mt02ktgp4gjCByqltQLya0slPuq6BXk1rv6upefdKPpTzsyn99cfEeGjnlgJE2XXkN3jXlzgOd0BwVfnrROn3vb/3UkneE9Jqq2u9XlyV5pqaUcyLDANITS8EmPi5e1h3vm48X5CO/jB50/OzyZuFBU+t658YGpwbt/EeF+LeDqV6/LpznGRqL7f6tNUSxE9bdHgaTWJfy0EeHJukVupXXwVUDtWrG/+0xsTKRw3s3zCQXvq/z0V1U+XTFeCbIEIfENXrGBozCL8TXFSuKCbd4aWRZ0nC4XlGubbTAplNvcOHfcppHQeaTvM4UX5UGLLCPPyFsOI5j9JRX71oryh2qePWCYoX6lVYlbiKm+tN6huRq0ZJdFGFFoDNK86CEZ2//6lj+A45MtHM= +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"; + + + + + + + + + + +Gets a list of logs, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.ParamsDetails.json new file mode 100644 index 00000000000..ad384af5708 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"last_updated_ms":{"type":"number"}},"required":["last_updated_ms"],"type":"object","title":"queries_get_updated_since_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.StatusCodes.json new file mode 100644 index 00000000000..f6ed85c127b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A List of queries that changed after last_updated_ms","items":{"properties":{"changed_on":{"format":"date-time","nullable":true,"type":"string"},"client_id":{"maxLength":11,"type":"string"},"database":{"properties":{"id":{"type":"integer"}},"type":"object","title":"QueryRestApi.get.Database"},"end_result_backend_time":{"nullable":true,"type":"number"},"end_time":{"nullable":true,"type":"number"},"error_message":{"nullable":true,"type":"string"},"executed_sql":{"nullable":true,"type":"string"},"id":{"type":"integer"},"limit":{"nullable":true,"type":"integer"},"progress":{"nullable":true,"type":"integer"},"results_key":{"maxLength":64,"nullable":true,"type":"string"},"rows":{"nullable":true,"type":"integer"},"schema":{"maxLength":256,"nullable":true,"type":"string"},"select_as_cta":{"nullable":true,"type":"boolean"},"select_as_cta_used":{"nullable":true,"type":"boolean"},"select_sql":{"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_editor_id":{"maxLength":256,"nullable":true,"type":"string"},"start_running_time":{"nullable":true,"type":"number"},"start_time":{"nullable":true,"type":"number"},"status":{"maxLength":16,"nullable":true,"type":"string"},"tab_name":{"maxLength":256,"nullable":true,"type":"string"},"tmp_schema_name":{"maxLength":256,"nullable":true,"type":"string"},"tmp_table_name":{"maxLength":256,"nullable":true,"type":"string"},"tracking_url":{"readOnly":true}},"required":["client_id","database"],"type":"object","title":"QueryRestApi.get"},"type":"array"}},"type":"object"},"example":{"result":[{}]}}},"description":"Queries list"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.api.mdx new file mode 100644 index 00000000000..3f3dadd142d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries-that-changed-after-last-updated-ms.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-queries-that-changed-after-last-updated-ms +title: "Get a list of queries that changed after last_updated_ms" +description: "Get a list of queries that changed after last_updated_ms" +sidebar_label: "Get a list of queries that changed after last_updated_ms" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zgM/iuCcB9anNusw24YPOxDtuverthbM9wBdeEpNpNolSVXorPmDP/3AyXbeV0vbT/sk2OZD8WHpEgqNS+FFQUgWMfji5pnRiNo5HHNRVkqmQmURg++O6NpzWUzKAT9Kq0pwaIER29KOEyrMhcIeVr4JVyUwGOuq2IMljdNxC1cV9JCzuOLLcBl1AHM+DtkyCOOEhUtXFdgJbh0CkuEkzqDtLWmIeVSt6ILHnEtCo/kzSVt60qjXTD08aNH9LgnTQuuUh6Vg8usLAnFYz5kZ9IhMxPWGstwJpBlM6GnkDMxQbBsk3LEJULw1fouLSwNtkyMLQTymBPwCGUBRLBSSozJPWgr6H3n0Eo95U3EMyVBYypzUlGImzPQU5zx+ORkh3AuUIyFg21TAr4FSI0wbWP5s2B9pgh8AYfDUh5PAY//7HQ3EQedp8GF6VhkV/Tq+cT1zwh12ROw+wtba2xagHNiehti6QK4gazymXWt9gLs9kzElSwk3qJhRbS0ZmrBuf2kg+NcegWLjZg+fbJHQljzY8+Nlsm/ssfjP57usYkDBRmmwqUZilt2GxujQOgtSFo5yO+E2zdcd5BLIZdo7PbZ2dMHKCymttJa6un+KRtgdxHHym0e7n3sQzFOQ328BzksyrbqPkwHksQDVFiRXZF7K6tCXRb5R60WAbDZa5a1cKXU3dJwNmsYX9Y7Ya1Y7CiAvoKIolSw2iYu6ubSN6f1bvG57RFKOo988qCetFLlNvz0P1b2QP5S5IwcBg5j9k7PhZI5Ww4GrLRmLnPI+Q4yK9jA5eTXcvmqRYUzY+W/kMdsWOEMNLb7sz4rdhBZBQYmT34tkw8G2cRUOo/ZaAadk4Hc7UxlM2C5Ace0QQY3PpW2SfU6aJc/fnWevdMIVgvFHNg5WObbdMyGmlUabkrIiJ1fZCbLKvuTSL0WKFSQ85s7yCorceEH2O8/6OBd0uCHYkpDbXfe6MjfHGUmh3NvWxh4ldBTHvPs65czHnElxqCWr8HP9F5ZxY7+YW9ORyzhM8QyHgyUyYSaGYfxs0fPng1EKQfzk4GfQQdrg2rCWZIkmrGjtyzhwzbNvNtj9hKEBct+G756dXp+no4+/nX6IeG8iXrbPi1wZvSKdf1Cb58sSmOxyxGX6ER3Yy970S9TMTsgO9i9SEQBOgORg3Uv6g0qCY9Zwls6CWe/M5Fl4FyK5gp0k+jDRJdWajzoTDumnDs4PFwl+17MxbkP9grhtcVlUIx2xLnnKX4IiWwCmM08zXuTrNeYxt0724weUf7WBbAOdEee7beAaOhB1J8nOphLDag3dcMRrZBRcKzM9IBED5/7O8z6AXgDyIRvH3e+chSAM5PzmFNfi3gpqOnyWzxCDvenNRwX33B3u5VvmnlGn1kOc1CmLEBje+59uIOiurQGTWZUEw8GNalq4ppSudnS9qpyaIpORcTnwkoaEroLlFcTrmYT4duvN5PT1aEqqA60r/TwxWBd/9vR6BPr9TQRJ2vW9fV8t4w7DwWNvtFQw4xl7z75Gd/YDSU7XdXivXTTUMS7onZO5TiQ9KWt5mOfb6+7a+H7v0e8Hdr9iOy/8r4ke9JNRODUwsSCm91Xib9lT8z29fe8KsE6WJ2hVpYod4Lc/CS4xGEhfK9p7+kPyOc1Q/rOhHCDg1IJ6a8K7ZAYcv2Ci1KSVSc86v8vWM/4yy72F7yuaVj8alXT0HKQp3OwsW/fU/nSaetG+Gsbv/aJqyr67g92l8W+Z0U8VBy/QwAMswx81etQWy2btPSn+s0pxZEGmRVv9NFsf5D2bp7VixXddR0kQgmjIxiM8AWc+1n2P8ZZUtw= +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"; + + + + + + + + + + +Get a list of queries that changed after last_updated_ms + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.StatusCodes.json new file mode 100644 index 00000000000..cfbefa4489e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"changed_on":{"format":"date-time","type":"string"},"database":{"properties":{"database_name":{"type":"string"}},"type":"object","title":"Database1"},"end_time":{"type":"number"},"executed_sql":{"type":"string"},"id":{"type":"integer"},"rows":{"type":"integer"},"schema":{"type":"string"},"sql":{"type":"string"},"sql_tables":{"readOnly":true},"start_time":{"type":"number"},"status":{"type":"string"},"tab_name":{"type":"string"},"tmp_table_name":{"type":"string"},"tracking_url":{"type":"string"},"user":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"}},"type":"object","title":"QueryRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.api.mdx new file mode 100644 index 00000000000..0421e6b08fa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-queries.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-queries +title: "Get a list of queries" +description: "Gets a list of queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of queries" +hide_title: true +hide_table_of_contents: true +api: eJzNWG1v2zYQ/isHYsBaTI2bYgMKDfuQdl3XrmvaJl0HxIFHS2ebDUUq5CmJa+i/D0dKihTLWdoN6D7ZIu+O99w7uRE5+sypkpQ1IhXPkTxI0MoT2AWcV+gU+gQqj/BOeWvAOnh5dPg6bK2hlE4WSOg8LKyDhdKETpllAt46Cn9KuVRGsnyQJodA51FjxtvgS8zUQmWQWV0VxgeaAknmkuSeSMT1CSI92YjMGkJDIt0IWZZaZUHy5KNn9TfCZyssJP8rnS3RkULPX410/qsIi/CH1iWKVHhihUWdtAvSObnm74hmyLQldlSSLd3o+oXUFQbdzfpwEQA1NKYq5uhEnWxzdStzazVK019qdD2t60Q4PK+Uw1ykJ0GxqEZ76GmHz84/YkZjgM9wPUSLpipYHMfDrLVhIqzL0fW+tZyj7n33YqpPxUJIkUaRCGNNX6fdTuifNW7rQJArxxEVo6BVW/qs0Wb0qFIusSdSGcJl8EHYmXn1acd2DN/ZFwRVfdMLiYgWScUSaRZM1MRwzcSKkzKkGttMFkx4LupT9rYvrfExDh89fBjD8QuTo4pMw1pwvEIgS1KDw8y6HAIdWAO0QpjL7AxNLpKtCB51/46MnEVMY0f3VkLN4EMjEzDTHnxQWsMcgZw0XkvCHOZrmHMsikTglSzKYNgDeK2y2+SJrdjYchO7Ivfbih50pZIjAFQea+Wi0nC5QgNrW0FuzbcEZ8Ze9jEoNt3da9EwxT7fmoH/P7HjmKS7WXBQRW4x5XXJ+Az7XBeXEclhA8iCQ5OjuzvmV6zSi6DFSAEZ1sFbEEmt7SXmXZMjG/rjZyF06Cu9I03jHiycLYJXlkjx7LZ07OpfK2mWmM9ifVhYV0gSqcgl4QNSBY6B5sY8lx63pbU7XRj+U0xcF7+fG9Z9PgFNPgunp9vtUeAVZhVhPvPn471X5eNF29lLP75zXRe3hO06xJ/rGcm5jsAdyvzQ6LVIyVXI2yQd7cbgSVK1w+tyvst8iaCijKfeQuJkdqbMcla5cc0rj27bdQvlPO2WusumWu7musXb71mH2wjecti+Q08HpdprG+Mdumndy92ur+3v7EiDqnmHPtF2gZMW5OlIYR4VOlo0t0riQG6voA3L0I2q02dqa8TJhkfCYSsWqQgSYpX43eaoWYPv/9XoUKD3wynqtgbQ803HKJ7IHHh0RU8pvDAXUqu8f68onb1QOeZiBFCPN2LZ/7pY3htZ0co69QnzFA4qWqGh5nzo5vMRIH3GgOTRo6+NpHQ248+5RmAUtE7hD3ZORIPOWTcG5amtdA7GEjQSGm4+6oevHWwvDKEzUoNHd4EuokjhwEBl8KrEjCeBsAg2yyq3w12/SB6LWxPwhSCrHGPkG93HS87AUx7SSS5Dhr6N92hO0asHmc3xKOgWr7RamqVIRfb+3av2LnX96W3lMtY8q5yGB3/C82fHMBUrojKdTLTNpF5ZT+njh48fT2SpJhf7k9D0J1MB0+nUADz4FabioAmvYOkUnqB06OCbg6dPnx0dzY4Pf3v2eirCzbJR582aVtb0FOoWOpVUUVpHbQL6qZma9lYCP3XLXL/vsR5wV72TSL1CmaPzP21uaD8VKUxFg2Aq4DuQGcfZjOwZmnpq7k9N6ZShe602exxZ9+7f7+N7KS/kUXBpD+Ng8dr01niG2UGTl1IRLJCyVUD2Obg2A3Bp+w03fcQo/2rdtIkIjwPAvyJHzT+M9sepiRry/NVpdwN7Q2Q17mm7vMek938MF8kCaWXzeAEN7y20EqkY6s7WCAkTIzbMFuOYxc1UecXbkOMFalsWaKhJveCLKGhTOks2s7pOJ5MNi6rTDYdWvSXtaeXJFq0IfttwqhvDWjFxRl7I0AqDmjzTN28CzSf/hHwcyv/1+PgNdHLqRLA2Q3kd3i3ljmJN4T3u/vxU9uJNeE7gWX8gZNRUDX+grmv2TVtXjrgiRpChumzEPETGL+3E/vLDsWgG2fBSFHavp/cAuk6YeeZw4dCvvlRIeJRY2O17yFFVovPYH+N6Sxw7ke5iP5rEUyFDuW8mpedI2y+PN23U6x3/w7fKxlCEVzQptVRhxGsG8ZhXJ0KWis2xL5LuXYfDMMbZidhs+Br03um65uVIwjm30wy7zj3DdXgs6l4dRUj3NmNCi0pErEPhhMhwkGUYyl/LtdWhB0Xj+TOOGR5eem25i5zmT++dU5p1T/ZmEyliYeN0j0qESh6eNeu/AQOV2YQ= +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"; + + + + + + + + + + +Gets a list of queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.ParamsDetails.json new file mode 100644 index 00000000000..cd52b2bd2b6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The report schedule id for these logs","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.StatusCodes.json new file mode 100644 index 00000000000..ce04e8fb6a0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"ids":{"description":"A list of log ids","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"id":{"type":"integer"},"scheduled_dttm":{"format":"date-time","type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"},"state":{"maxLength":50,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"value":{"nullable":true,"type":"number"},"value_row_json":{"nullable":true,"type":"string"}},"required":["scheduled_dttm","state"],"type":"object","title":"ReportExecutionLogRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"ids":["string"],"result":[{}]}}},"description":"Items from logs"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.api.mdx new file mode 100644 index 00000000000..a8a9139fb9d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedule-logs.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-report-schedule-logs +title: "Get a list of report schedule logs" +description: "Gets a list of report schedule logs, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of report schedule logs" +hide_title: true +hide_table_of_contents: true +api: eJzNWNtu2zgQ/RWC2IcEq8RJsQUKFX1IgzRNN2iLON1dIApcWhrbbChSJUduXEH/XgwpyfKtadOH7pMtXobnDM8Mh6x4Bi61skBpNI/5OaBjginpkJkJs1AYi8ylM8hKBUyZqYtY6YBdSWc0M5a9Gb57yz6XYBesEFbkgGAdmxjLJlIhWKmnEXPGov9TiKnUghZjQmd+mAMFKfUyV0AqJzJlqVFlrp0fkgOKTKA45BFfLsDjm2oN+vUMNvDKsATOwAXwPOKSBhcCZzziWuRAX3c84hY+l9JCxmO0JUScjOSCxxXHRUGjpEaYguV1HVU8NRpBI3WLolAy9aQGnxxhqXqTC2sKsCjB0VfDjP5KhNz1zDskX/E6ahuEtWJB38GRq5M2zG61ZAq7tX0uVAkeu168m3hnNmN0mY+JY7Q5q2sZG6NA6H5Tg/W2rvuOvPHAAox20duOnxl/ghS3Eb6DxSpb0GVO5kiXo9aHETc2A9v7VmIMqvfdE0h/FBlBiQpIAUb3Me3ehP5a233tB2TSkpqDClrYwqUNmq1LFWIK23QWekZOft3RHUJn9AhR1eu7EPHgkZhPAUfeRY2Gaxrsg8ZH+TJqPvP6lnbbFUa7oMMnR0dBjo8MjjJM2gxsNCgUs5AamzE/jhlNcc3GIr0DnfFoQ8FcZm7T2kmX3JSZMhoS/UQoWnCl2oEx9LGJNblHNgUMa7V+2xG8oLNRhpjT/4mxuUAe80wgHKDMvUZLpcSYNidkpg2UYK2xoxyca5T04AyZ7VBUkzkfQLRhz6Gw+IssHAr06HNxfwl6ijMePz3aMrAsA/xuGd/wAyt0aW/HyKV0/MiRNV9GrWgfML6W99b82JLbSH7LsLvyR9fZPaQlaerSTK/A4UkhD9uA/IEoJi3ci7xQ0Iun4yYSblqwt0sd31SUs+toTc4XpNSgZH9q1hH/65dCu6fNTcd9j0M3kb8UGSMXg8OYXei5UDLrlxyFNXOZQca38OnNDVyOfy+XD1qUODNWfoUsZiclzkBjsz7rdLSFSH+iZ/Lkye9mUliT0udYASMWuIjZP7Q5gY3PTduonJpSZUwbZI2FZjYt9fR3i+1CI1gtFHNg52ADi5idaFZquC8gRchCIzNpWtod2/VK0LHVuoAO7LS0xJEqrk9fKABv6RBFMfUBGpIAGzbZw1Go3h+kJoOhBxnqXiX0lMc8/XB12RY9y09nSpsShbS0ih38x87PrlnCZ4hFPBgokwo1Mw7jZ0fPng1EIQfz40EomwfHA2Wmg4SzJEk0YwevWcJPGrl5z8fsJQgLlv1xcnp6NhyOrt/9ffY24b4SbFC9X+DM6B6urqFDJnPPsglIl+hEt1UEe9E1U97bIxzsJ+FHYdIMRAbWvajWSCQ8ZglviCSc/clESvIbobkDXSd6P9GFlRr3WlCHJLi9/f0+zTdiLoZ+p3tUVxqXG2G0I7YdQ/FFSGQTwHTmCT6CXrXCMW6/2fqOEdmP7aZVgei15/kxzKjph0g/T3QASpetDuSaC5pBRsGhMtM9Grr/3JeBOeDMZKF89Dc1Or35GoWquKs9C3KPD6wg6NKS97Y6ga+H1CV1swzmoEyRg8YmRP3mBENVYQ2a1Kg6HgwqMlXHFQGoN6ydlg5N3pqgc99KymRtmebNhHJvIvyJ6WHyqKvtm0/68eG6av/19fV71tmpI05oVu11fDfADUPuoT4quem2ffHeXwuMXTOy1VXNfD+6rmmX2vxDCSYPJH0WqvjYa+RVW1G9+feaN1dgf+PzvcvCz5OuI5o8sjCx4GaPNeIvFxOzWVIPywKsg36N1Gsi7YRx8+PgEoe5CJVauJ6cAz7wkrHusN6B8z9/CGk8iHCPg0IJqX1ZbL1SQ+jdcFFI8tOxf9rwGoh47F86lJnyiJNYgxpveFWNhYMPVtU1NYcLy8YTS98/u0DcwcJfDbtim/v00MZVMCp9tZDxeCKUg+/swt5VUwvtsx993tmKqi2b9aIPrEVb3NHLRcRDNvUQQ8dJmoLP5e2UjSpkJfWdn5HeqUDrlR6d6ps/vbeWVThVFUaE9Fx36Pyx5J9W6m9ACc01 +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"; + + + + + + + + + + +Gets a list of report schedule logs, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.StatusCodes.json new file mode 100644 index 00000000000..b82f16d7bfc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get_list.User"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"chart_id":{"nullable":true,"type":"integer"},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get_list.User1"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"creation_method":{"maxLength":255,"nullable":true,"type":"string"},"crontab":{"maxLength":1000,"type":"string"},"crontab_humanized":{"readOnly":true},"dashboard_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra":{"readOnly":true},"id":{"type":"integer"},"last_eval_dttm":{"format":"date-time","nullable":true,"type":"string"},"last_state":{"maxLength":50,"nullable":true,"type":"string"},"name":{"maxLength":150,"type":"string"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get_list.User2"},"recipients":{"properties":{"id":{"type":"integer"},"type":{"maxLength":50,"type":"string"}},"required":["type"],"type":"object","title":"ReportScheduleRestApi.get_list.ReportRecipients"},"timezone":{"maxLength":100,"type":"string"},"type":{"maxLength":50,"type":"string"}},"required":["crontab","name","recipients","type"],"type":"object","title":"ReportScheduleRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.api.mdx new file mode 100644 index 00000000000..56345e52dce --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-report-schedules.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-report-schedules +title: "Get a list of report schedules" +description: "Gets a list of report schedules, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of report schedules" +hide_title: true +hide_table_of_contents: true +api: eJzdWW1v2zYQ/isEMWAt5sZJsAyFin3Iiq5r17VFkm4D4sCjpbPFhiJV8uTEFfTfhyMlW7LkzEkHdNgnWyTv5bk3nk4lT8DFVuYojeYRfwnomGBKOmRmzizkxiJzcQpJocCNWOGAnUlnNDOWvT5/95Z9KsCuWC6syADBOjY3ls2lQrBSL0bMGYv+Ty4WUgsSxIRO/DEHCmLaZS6HWM5lzGKjikw7fyQDFIlAccBHfCOAR5clj41G0Mijkos8VzL2jMcfHcEoOWmcCfqXW5ODRQmOnmru9FciZP4PrnLgEXdI+vJq1CwIa8WKngOYLlGP7SAnk9vB9aVQBXjd9erd3AOqz+gim4Hl1ahPtV6ZGaNA6PZSretVVY24hU+FtJDw6NIrFtRohF6t8ZnZR4hxCPA1rLpoQRcZsaO4mDY2HHFjE7CtZyVmoFrPrdhqnyImKFEBH3FtdFun3U5oyxq2tT+QSEsRFaKgUVu4uNZmUFQuFtBiKTXCwvvA70yd/LxjO4Tv9AFBVW17YcSDRSK+AJx6E9UxXNFhScnpM41sJjI6+IlXV+RtlxvtQhweHx6GcHxgchSBqFsTLlJgaFAoZiE2NmH+HDOaYQpsJuJr0Akf9SJ40P07MnIaMA2Jbq34mkFCAxEjogP2h1SKzYChFdopgZCw2YrNKBb5iMOtyHJv2FP2VsZ38eO92Oi5iVyRuL6ip+uSSRHAZBJK5bxQ7CYFzVamYInR3yK71uamjUGS6favRd0Uu781Pf2/YschTvtZsFNF7jDlpmTcwz6b4jLA2W8wNMyCTsDuj/kNqfTKazFQQLp18A5EQilzA8n6kkPjr8d7IbTgCrUjTcMem1uTea8sAIPspnTsuL9EjHLpLaYLpcSMMKMtYNS/cnicCr2AZDpb9fnMpXW4jr5M3L4BvcCURz98P2A2JfY+vHWtteS02fTutk1VPfOdzHndyJyBw9NcHjS19uCDCyWrARcK5dzYTCCPeCIQnqD04nZYaANrw2OagEIxTYtMaPmZVC+5BZG802oVyMNxi1OZ3GH91pUTW6Ao/f9Z/6iN7ovMTzzoyskAU5NsoTs+OdmLh9EoZlu0R4eHh7sP/4ObE+HSmRE22dvVnfTeSbDRA27RikHZQWJfgvcdLIWaJojZw03u+TgUuB1LJ4d7UA/E4NHJkKHNja7b8C+J+zuN8d/Jh+NQ62OZS9A4gHoXjrDSc8PdEPzuwxUO22cbbUkPmcFn6u57SbSz27+n0k2W1iHUMdfoCyHt0bJXrQZh3Twf7Wx7O63ZHs1o02peNvCvBrq/QaaDnVmv7+rwbXVN3V5nq7VpEzWNyGVJ753bBYt7DqEV+c0koEiD77/o/SQD57qvand1mS3frAn5TyJhFELgMGKv9FIombRnF7k1S5lAwgcAtWgDlqOvi+WDFgWmxtKVE7HTAlPQWMtn6zwZANIm9EiOj782ktyamB5nChihwFXEfifnBDRgrbFDUJ6bQiVMG2Q1h5qaRJ187WB7pRGsFoo5sEuwAUXETjUrNNzmENPrhl9kJo4Lu8NdPwt6925MQFOHuLCEkcZGH28oA69oEoBi4TM0FDbWVDZHuXr7JDYJnHslwwBNCb3gEY8/nL1pJjebR2cKGxOEuLCKPfmTvXxxwSY8Rcyj8ViZWKjUOIyeHj59Oha5HC+PxmFWOJ5wNplMNGNPfmETfloHmrd5xH4CYcGyb06fP39xfj69ePfri7cT7gdZtT7vV5ga3dJovbDWSWYeX52KbqInuhmCsB/Xy1TJH5EebG/FR+F4CiIB634st9Sf8IhNeA1hwtl3TMQUclM016CriX480bmVGh816hxQkD16/LgN8LVYinPv3RbIzuLG+EY7wrnGJm6ERDYHjFMP7V7Ayg66qHlm214imH81jioDxAuP8K9AUdEPwX020UFFmtGu1dsCXx8yCg6UWTyio4+f+clV05/TxMsPeOnW51vKkz189oSoLSyZaxA1386bN7TNEliCMnkGGus89N4IjMrcGjSxUVU0HpfEqopKklv1uD0vHJqsYUHTVCupXDWdmWcT3srnwt+LXk2aItRTyPqRfnxOdvn/cnHxnq35VCNO2nT5rfH2lDsPBYb2qBWg2fyr936ASdOFDpNBU9X0/nRVkXOaIkNVJAsgfakp+cyHxs/Ni8LrPy7IR/4YDQr87mZI4kFXIyKeWphbcOlDmfgx6Nz0Jx/nRQ7WQbu5ay1R7IRzy6NgEoeZCK9UoW16CXjHN49tY7VulP/w55Lacgi3OM6VkL4B9EFf1pl2yUUuyT5HvnPOwxyKAjNE3iUvy5lw8MGqqqLlMEOiLNxpj12Cr2HlB9brLx/cV4Amh/wNNuKhNHkJgeA0jsGXxIaqd4F36sjLFxRF1Nu0bu11LNV/Wt9ahF61eJdlOBFqHRWAoISv7v7TSvU3itFx+Q== +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"; + + + + + + + + + + +Gets a list of report schedules, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.StatusCodes.json new file mode 100644 index 00000000000..ef3bbd36fc4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"changed_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"changed_on_delta_humanized":{"readOnly":true},"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","type":"string"},"id":{"description":"id_description","type":"integer"},"name":{"description":"name_description","type":"string"},"roles":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","title":"Roles1"},"type":"array"},"tables":{"items":{"properties":{"id":{"type":"integer"},"schema":{"type":"string"},"table_name":{"type":"string"}},"type":"object","title":"Tables"},"type":"array"}},"type":"object","title":"RLSRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.api.mdx new file mode 100644 index 00000000000..442d39961cd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-rls.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-rls +title: "Get a list of RLS" +description: "Gets a list of RLS, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of RLS" +hide_title: true +hide_table_of_contents: true +api: eJzNWG1v2zYQ/isHYsBSTI2bYgMKFf2QBm2WLmuKOF0HxIFLS2ebDUUqJJXUFfTfhyMlRbLlNMkGdJ9skbzjPfd+LFmKNjEid0IrFrNDdBY4SGEd6DmcHo8jKCzCqbBagTbwbnzyHq4KNCvIueEZOjQW5trAXEiHRqhFBFYb5//kfCEUJ97AVeqPWZSY0C7YHBMxFwkkWhaZsv5Iho6n3PFdFrHbC1h8XrJEK4fKsbhkPM+lSDzj0RdLkpfMJkvMOP3Ljc7ROIGWvmru9Fc4zPwft8qRxcw6kpdVUbPAjeEr+g5g+kQbbAc56dwMrl9zWaCXXa1O5h5QfUYV2QwNq6JNqnZlprVErrpLtawXVRUxg1eFMJiy+NwLFsRoLr1o8enZF0zcEOBLXPXRoioyYkeuMG10GDFtUjSdb8lnKDvfHXfqniImTjiJLGJKq65M243QvWtY1/5AKgx5VPCCRmxuk1qawatyvsAOS6EcLrwN/M7Uim9btoP7Th/hVNW6FSIWNBKzBbqpV1HtwxUdFhSPPtJIZzyjg1esuiBr21wrG/zw+bNnwR0fGRxFIOqngbMlgtOOSzCYaJOCPwdagVsizHhyiSpl0YYHD5p/S0ROA6ahqzsrPmfQpYEIiGgXPgkpYYbgDFdWcocpzFYwI19kEcOvPMu9YvfhvUju4sc2fGPDTGSK1G4Kut9mSfIAEKn1qXJeSLhZooKVLiDV6mcHl0rfdDEIUt39c1E/xB6uTU//n+hxiNP9NNjLIneo8jZlPEA/t8llgLPfAKfBoErR3B/zMYl05KUYSCD9PHgHIi6lvsG0LXJO+/L4IIQGbSG3hGnYg7nRmbfKAl24u0kd2+rXkqsFptPZanNvLox1rUdtiCfS4dwo+XaqO7LfRxvIG4m0mqYoHZ8ui4wr8Q39dQZ5eqLkisXOFEjHJS/sgMnD+rS7OGC/Hs06i24W+w6f0ChMw/o6n87mGp+mTJ3iopCcSvVrboer4sLoIp9e4mqTf7v1PSmDxfrEIh2m6hh0OKfQ6vcuNFriXd3TNhd6uPec0k17Q1Hj+OxxQtwWy83IJJ6P8PGzIMtDmoLT4/EpWrefi92mP7gHfdVJYW1539tamHvF4x7lsimG5w3oi4H6NMh0sHZsVIYe305e72fjteTbJWpS5XlJnfF6oDPPISTLP3WKkiT49V91UBla228m76qDHdu0hOw1T4E6eLQuhiN1zaVIu9NVbvS1SDFlA4A6tAHL3o/F8lHxwi21obQdw37hlqhcfT+0Y8oAkC6hR/L8+Y9Gkhud0OdMIhAKt4rhLzJOQIPGaDME5UAXMgWlHdQcamq66rcf7WxHyqFRXIJFc40moIhhX0Gh8GuOCTVEfhF0khRmi7necpoOGhXQXJQUhjDSYPvlhiLwgmYVxxc+Qk/1DRzjNUoYNycvIvb1aaJTHHsxw5AvuVpQEf94etxMl7efVhcmIRBJYSQ8/RsO35zBhC2dy+PRSOqEy6W2Ln7x7MWLEc/F6HpvZPSNpHsbAUcTBpPJRAE8/R0mbL92Oq//GF4jN2jgp/2Dgzfj8fTs5I837yfMj921ZB9WbulrXiNbu9BKJ7JcG9eEpZ2oiWpGNnjVLlNW3yE54BEQokC4RJ6isa/KNSATFsOE1WAmDH4BnpAjTp2+RFVN1JOJyo1QbqcRbJdcb+fJky7Ud/yaj73NO3B7i7cG0coS4hYlv+HCwRxdsvQgHwmx7OGMm29YtxwB/twYrwxgzzzWz4Gioh8C/nKigrD0ytQKuqaG+pCWuCv1YoeOPnnpZ+8M3VKnYWb3T1RuyWK2FQbpyMdZ8O7CkAoHNcHWI+yYtiEldjrPULk6Yr2FAqMyN9rpRMsqHo1KYlXFJfletcHtoLBOZw0Lehkyou2PGjah15tzX0G9mJ1Wtf6kH0ux2+f/+9nZB2j5VBEjafr8Wrwbwo1DKqI9ahronfHog3+MoUmpx2RQVTW9P11VZKbGAGNKpAGkT0olm3kneatNxonfu09nrO74/Dub373taD3oKiLiqcG5Qbt8LBP/pDPXm/30uMjRWOz2fp0l8p1w7novqMS6jPsqUTdYh+j6T7br+umUm//XA2+tH4df3SiXXPiG0Lt2WUfWOeO5IC3sMRoq+tHFIkaOGDztnJXljFv8aGRV0XKYfynqtipjmwh+2GJX7QNqzHzsNzHja1vEQlLyNwSC/SRBnxYbqo3S3ssgh2/Ia6jr6dTz1nfqP513Yq5WHd5lGU6ELEcBH4TwGd4/C1f/AKiaTcI= +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"; + + + + + + + + + + +Gets a list of RLS, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.StatusCodes.json new file mode 100644 index 00000000000..62c58afa92a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get_list.User"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get_list.User1"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"SavedQueryRestApi.get_list.Database"},"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra":{"readOnly":true},"id":{"type":"integer"},"label":{"maxLength":256,"nullable":true,"type":"string"},"last_run_delta_humanized":{"readOnly":true},"rows":{"nullable":true,"type":"integer"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_tables":{"readOnly":true},"tags":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"SavedQueryRestApi.get_list.Tag"}},"type":"object","title":"SavedQueryRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.api.mdx new file mode 100644 index 00000000000..57137ebecbe --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-saved-queries.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-saved-queries +title: "Get a list of saved queries" +description: "Gets a list of saved queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of saved queries" +hide_title: true +hide_table_of_contents: true +api: eJzlWe9v2zYT/lcOxIC1mBo3edui0LAPWd+ua9e1XZ1uA+LAo6WzzYYiFZJy4gn634cjJVmy5czJBvQF3k8Wf9zxnod3xyNdshRtYkTuhFYsZq/QWeAghXWg52D5ClO4KtAItBEUFuGjsFqBNvBm/P6dH1pDzg3P0KGxMNcG5kI6NEItIrDaOP+R84VQnFYBrlI/zaLEhEbB5piIuUgg0bLIlPVTMnQ85Y4fsYhtFmDxeckSrRwqx+KS8TyXIvGKR58tYSiZTZaYcfrKjc7ROIGWWrV2+hQOM//h1jmymFlH9rIqajq4MXxN7QCmL7SjdlCTzs1g/4rLAr3tav1+7gHVc1SRzdCwKtqVantmWkvkqttV23pRVREzeFUIgymLz71hwYxm0YsWn559xsQNAb7EdR8tqiIjdeQU04bDiGmToum0JZ+h7LQ7jtWdRUqccBJZxJRWXZv2b0J3rWGu/YRUGPKo4AWN2dwmtTWDS+V8gR2VQjlc+D3wI1Mr/twzHNx3eg+nqrZ3IWKBkZgt0E09RbUPVzRZUGT6SCPOeEYTr1h1Qbttc61s8MOTx4+DO94zOIog1E8IZ0sEpx2XYDDRJgU/D7QCt0SY8eQSVcqiHQ8e3P49ETkNmIaW7vT4nEGLBiEgoSP4TUgJMwRnuLKSO0xhtoYZ+SKLGN7wLPfEnsI7kdymj+34xs420VakdtfQ0zZfkgeASEOqnBcSrpeoYK0LSLX62sGl0tddDIKoOzwX9UPs7mx6+X+FxyFNhzHYyyK3ULlJGXfgZ5NcBjT7AXAaDKoUzeGY35JJr70VAwmknwdvQcSl1NeYtoec0/54vBNCg7aQe8I0jMHc6MzvygJdWLtJHfvOL+641Av6zPjNW1QLt2TxydNnEVOFlHxGJDhT4AD4ZMnVAtPpbL2rdy6Mda03dlQ/ezKgSaTDaVbyg5VsHX+d9btqds7ATfYdU7nzC7H1Ea07zcVRk4+PPtlgTgM4JNO5Nhl3LGYpd/jICb/UwaRpNU1ROj5dFhlX4k/0FBjk6Xsl10Gcphsk3/z/4PiYdRD/E5KpdJxxi7ucNSNDiE+ePj6Yty0q+mrvx8B/G6MJwGwa1t0DtbN/vVywV2CDB2+c4YO+tt9DKCneJ0N4pzDFYa5u9LU9DPKmjOlYdHzy/ACL7JU8iCV7JaeOZthBWx1fDCTTfQTu87W/tSJ0tOXscXQS/Sd6cnFbEXmLg53xoWP5ENEDytiqc2i2BeXx3lKwV64cUKA15dd5w87FQEU0qHSwWtmpRXp6O5VE//zfOu67Qs3hfF7SXWw7LpnXEI7nn3WKkix48o9q9gyt7V9fbqu8OnvTCrLveQqUxdC6GF6rFZci7d7nc6NXIsWUDQDqyAYsx18WyyfFC7fUhtJLDKeFW6Jy9frQpuoBIF1Bj+Tk5EsjyY1OqDmTCITCrWP4lTYnoEFjtBmC8kIXMgWlHdQaamla6umXdrbXyqFRXIJFs0ITUMRwqqBQeJNjQiW47wSdJIXZs10/UMHaUkA38aQwhJGeUj5fUwRe0O04ZOhz9kt4v6IQvXmU6BTH3rbwliS5WrCYJZ8+vmXtOdc0rS5MQpYnhZHw6Hd49fIMJmzpXB6PRlInXC61dfHzx8+fj3guRqvjkX8zm/qaezRhMJlMFMCjH2HCTmsn83zH8D1ygwa+On3x4uV4PD17/9PLdxPmH3Zqoz6s3VKrjlltR2uYyHJtXBOGdqImqnkUgO/absriD8gOuJv1UZBZIk/R2O/KLQwTFsOE1TgmDL4BnpDPTZ2+RFVN1MOJyo1Q7kFj0xF52YOHD7so3/AVH/vt7SDtdW62QStLYFuA/JoLB3N0ydLjuzu6sgcxbtqwvV+E9Y9my8qA88zD/CNIVPRDmL+dqGAnVYStjVsM1JO0xCOpFw9o6sNv/ZtOhm6p0/AW5J8+qVZgQwiIGR9IwZMLQ8QN4mfbIfSWhiHFFUqdZ6hcHZJ+X4KiMjfa6UTLKh6NSlJVxSU5W7Wj7UVhnc4aFfTYaERbODVqwqV1zv0R6c2kS3b9SFc36cfHaV//j2dnH6DVU0WMrOnra/HuGDcOuYbGqCqgp+vXH/z7Hl2+e0oGqarl/eyqoh1q8s2YMmUA6bNOyWbeP35oLixvfjtjdanqn2796OYNwYOuIhKeGpwbtMv7KvGvhHO9+zAwLnI0Fns13qaLfCfMWx0HSqzLeLhEhArqFbp9/wdsM9U5Wf5X/0eoOXN440a55MJXgd7dyzrQzhnPBTFzTKRvgo1FjPwyON45K0u6pn0ysqqoO0yhINzLyL7VL3Htn3Pb/wWYzwJNCPmzLGIhPfkVgsBpkqDPjY3UzlHeyyWvXpITUZXTOb9bV6o/Ov9EcLXu6C7LMCPkO4r/YIRP8/6Ph+ovut0gnA== +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"; + + + + + + + + + + +Gets a list of saved queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.ParamsDetails.json new file mode 100644 index 00000000000..40deeb0739f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"catalog_name":{"type":"string"},"force":{"type":"boolean"},"schema_name":{"type":"string"}},"required":["schema_name"],"type":"object","title":"database_tables_query_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.StatusCodes.json new file mode 100644 index 00000000000..dc416613f60 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"result":{"description":"A List of tables for given database","items":{"properties":{"extra":{"description":"Extra data used to specify column metadata","type":"object"},"type":{"description":"table or view","type":"string"},"value":{"description":"The table or view name","type":"string"}},"type":"object","title":"DatabaseTablesResponse"},"type":"array"}},"type":"object"},"example":{"count":1,"result":[{}]}}},"description":"Tables list"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.api.mdx new file mode 100644 index 00000000000..3f4398845ac --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tables-for-given-database.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-tables-for-given-database +title: "Get a list of tables for given database" +description: "Get a list of tables for given database" +sidebar_label: "Get a list of tables for given database" +hide_title: true +hide_table_of_contents: true +api: eJzFV99v2zYQ/leIwx4STKmbogMKFX1Is/TXirao3W1AFLiMdLbZUCRLUm48Qf/7cKQky5azDdlDnmyRvLvvuzveHWsw3PISPVoH6WUNBbrcCuOFVpDCbIWs4J5fc4dMFJCAoGXD/QoSULxE+rqBBCx+r4TFAlJvK0zA5SssOaQ1+I2hU0J5XKKFpklqyLXyqDxtc2OkyDkZnHxzZLUeCBurDVov0NFXzj2XejmPhnvVzluhltAksNA2H+5cay2RK9qKOu8SbYYMLncOXyXdYX39DXMPCXjhJS10rpl7fi3Rzb9XaDfzFn1DSoO7wvLWX9+huSJzzmjlIrEnjx8Hfvd0i66i0L6rg5VKhr3dwJ6x98J5phcsQmcLbdlSrFH18aZgeyzd2B7eesvHOi9oOYizymHBvGbOYC4WG5ZrWZWKleg57cO+S5tuYV9nQMe0ZWuBP7Zi24ivuawOyFHi7siy4PyRgubu4P7a+mEWHPS5DdcWKnBr+eaAiiYBvOWlkTgIzuk2Fpd1cxWSYw9yDIQULqh4+r9SokTn+PKOTP8nuL0gvOQFozuBzqfsrVpzKQq2rRbMWL0WBRZwgMtANnI5fVguXxSv/Epb8RcWKTur/AqVb+2z/uIfIDIUjEyePiyTD9qzha5UkTLK8dbJSO52urI5skKjY0p7hrchlcakeh2B0ZMnDx0bY3VOn3RdKS5+k7LfKd1ifNBabQ/xONeVLALVVkMrTaZ+eejr81Z5tIpL5tCu0UYWKTtTrFJ4azCnoIVFpvO8snck4Ctqeb0LEnCYV5Y4UrP+9oPKyRW1E8+X1MD7qkVt6/Yk1wVOA7jY3SVXS0gh//L5PSQg+TXK7WfMH/qurGQnf7LXFzOWwcp7k04mUudcrrTz6bPHz55NuBGT9emkaxaT00lsJJMMWJZlirGTNyyDs/b2BLen7CVyi5b9dHZ+fjGdzmcff7v4kAHQSNBC+7TxK60G4PqFHp4ojba+S32XqUx1zZS96JcfLdEfEQ52Hw5JlFwhL9C6F/UekwxSlkHLJgP2M+M5JeDc6xtUTaaOM2WsUP6oQ/aIUu7o+HjI9R1f82mI9YDvzuI2JFo5otzT5D+48GyBPl8FlvflWO8QTbtvth87Yvy1C18d2c4C2a9RoqEfYv48UxFtmAQ6pHt+aA9piY+kXh7R0ePnYS7aTf/X6BkPPfHfZpUS/UoXkMISyXNhRE1hxL82N03nAnJwuJzxclSW/H/QjbCP6z1tswLXKLUpUfn2mofwRkW1sdrrXMsmnUxqUtWkNWVuM9J2Xjmvy04FDTVWBIhtZQpq4pCz4GGGCDAhAVRVSde+/aQfByMvvpnNPrFeT5MAodnV1/MdgZvG+kV7NEPRQPX2EykhLrtKDrqqlQ+nm4ZC3NWwKVXfSDJUshquQ4K90rbkpO/dHzNoJ/cwzYfd7RAXSDcJCc8tLiy61X2VhFF9oceD5LQyaB0OB8PBEuVOPLc+jS5xvuShtbTD/n9P4B27fd/xeOsnRnIRHjEhs+o2uS+BG0EgTkl6qygND7JoChKgdIjxvoS6pjNfrGwaWo4Pk9Gzb9A2YeuoXSQ3uAlPmX4Ch3B7u8yNSkXo6QWkCy4djihurRx9bmewYzZ+ch60383gajOE0OEyN9BcUZ6HshbAxI2zPMdQWTuR0VRALPpa8vqCcodGwOGjssug9g9pPwinruOJWCebHl1oEhAeAX8DJMFXGg== +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"; + + + + + + + + + + +Get a list of tables for given database + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.StatusCodes.json new file mode 100644 index 00000000000..deef9a5a4d4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"TagRestApi.get_list.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"TagRestApi.get_list.User1"},"created_on_delta_humanized":{"readOnly":true},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"TagRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.api.mdx new file mode 100644 index 00000000000..9dc531589f6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-tags.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-tags +title: "Get a list of tags" +description: "Get a list of tags, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of tags" +hide_title: true +hide_table_of_contents: true +api: eJzdWG1v2zYQ/isHYsAaTI2brB0KFf2QFmnXLmuKxl0HxIFLS2ebDUWqJJXEFfTfhyMlRbLlzO0GdNgnW+TxeM+9PEeyZCnaxIjcCa1YzF6iAw5SWAd6Do4vbASFRXgnrFagDbw+O30Dnws0K8i54Rk6NBbm2sBcSIdGqEUEVhvn/+R8IRQn3cBVCl7OosSEpsHmmIi5SCDRssiU9TIZOp5yx/dZxG53YPF5yRKtHCrH4pLxPJci8ZpHnyyZXjKbLDHj9C83OkfjBFr6qrXTX+Ew83/cKkcWM+vIYFZFzQA3hq/oO6DpL9pQO6hJ52Zw/IrLAr3tanU694BqGVVkMzSsijZXtSMzrSVy1R2qbb2oqogZ/FwIgymLz71hwYxm04sWn559wsQNAb7EVR8tqiIjdZQM08aHEdMmRdP5lnyGsvPdyaeuFClxwklkEVNadW3aHoTuXsO+9gKpMJRRIQsas7lNamsGt8r5AjsqhXK48DHwM1MrvmyZDuk7/YakqtajELHgkZgt0E29i+ocrkhYUEH6UiOf8YwEP7PqgqJtc61syMPDBw9COn5jcRRhUZ8HxksEpx2XYDDRJgUvB1qBWyLMeHKJKmXRRgYPhn9LRU4DpqGtOyOeM2jTsAho0T58EFLCDMEZrqzkDlOYrWBGucgihjc8y71jj+CNSO7SxzZyYyNMFIrUbhp61PIkZQCINHDlvJBwvUQFK11AqtWPDi6Vvu5iEOS63bmoX2Jf702//l/x45Cm3TzYY5E7XHlLGV/hn1tyGdDsJ8BpMKhSNLtjPiGTXnkrBgikz4N3IOJS6mtM2ybntO+PX4XQoC3kljINczA3OvNRWaALezfUsa1/LblaYDqdrTbn5sJY12ZUxm9OUC3cksW/PBxwheQ7C6+1qs4+XTUb/eqWKcd88Q6tO8rFfkOa++9t4J4GkVbTFKXj02WRcSW+0F4lM8jTUyVXLHamQBI3SMH/nzjggHUg7eiBXjKVTBVS8hntQvMDOEU63BMHoB8+ehD9vcIw0Dbtg+gw+jl6eHFXqxzAv0OrrTqF3Ta9g63tqkepOzSRpkWcN9guBlh7UOkgo27wZU9vh+36HLVGSd1FDYGcl3ReXA898xoChfyuU5RkwcN/dK7I0Nr+Eeuu7tCJTbuQPeMpUK2gdTG8UldcirR76ciNvhIppmwAUGdtwHLwfbG8V7xwS22oFGM4KtwSlav3h5YQBoB0F3okh4ffG0ludEKfM4lAKNwqhj8oOAENGqPNEJTnupApKO2g1lCvpq0efe9ke6UcGsUlWDRXaAKKGI4UFApvckzomOAHQSdJYbaE6wWnM3PjArotJIUhjHTd+3RNFXhBJ3i6WVOFjun3ImI39xOd4pk3LFx2JVcLFrPk/buT5pZ1+2l1YRIyOymMhPt/wsvjMUzY0rk8Ho2kTrhcauvixw8ePx7xXIyuDkaOL0YTBpPJRAHc/xUm7KjOLO/kGJ4hN2jgh6Pnz4/Pzqbj09+O30yYv3HWxrxduaVWHXPagdYgkeXauKb27ERNVHNbgaftMFH3PbIDdrM6CrJL5Cka+7Rcs33CYpiw2v4Jg5+AJ5RgU6cvUVUTtTdRuRHK3Wts2aeUure310X3ml/xMx/LDsLe4K3btbIEsgXGr7lwMEeXLD2u3VGVPWhx8w3r8SGMH5sQlQHf2MP7GFZU9ENYn0xUsI+eUVrb1pDXQlrivtSLeyS698RfLjN0S52GS6l/g6F2zrqWkyd8lYRMLQw5ahAvW6+PE5qGFK9Q6jxD5ep683EIisrcaKcTLat4NCpJVRWXlFTVhrbnhXU6a1TQa4cRREvNaderCafmOff9z5tJp/z6laD+pB9fh339v47Hb6HVU0WMrOnra/FuGHcWiITmqOXT49mrt/6BgU7/PSWDrqrXe+mqosg0ZHJGNBhAekop2cznxQttMk76Xn8YU4y8GL0d+dnbS4wHXUW0eGpwbtAuv1WJf6aY682byVmRo7HYPbl1hih3gtzVQXCJdRkPh9BwPNp8iFx3UKdb/MeeLWsPObxxo1xy4Q90PrnLupzOGc8F+eGA+V7AIkbZF9LrnJXljFt8b2RV0XC4yFGpbXXAtl0vceVfjdrnR+ZrvCkU344iFsjH7xAWHCUJesZrVm104x5TvDymVKGDSqcFtwlT/+k8eHK16uguyyAR2IyqPBjhydu/b1Z/AeQ32UQ= +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"; + + + + + + + + + + +Get a list of tags, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.StatusCodes.json new file mode 100644 index 00000000000..a9213bcd850 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"action":{"maxLength":512,"nullable":true,"type":"string"},"dashboard_id":{"nullable":true,"type":"integer"},"dttm":{"format":"date-time","nullable":true,"type":"string"},"duration_ms":{"nullable":true,"type":"integer"},"json":{"nullable":true,"type":"string"},"referrer":{"maxLength":1024,"nullable":true,"type":"string"},"slice_id":{"nullable":true,"type":"integer"},"user":{"properties":{"username":{"maxLength":64,"type":"string"}},"required":["username"],"type":"object","title":"LogRestApi.get.User"},"user_id":{"nullable":true,"type":"integer"}},"type":"object","title":"LogRestApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"action":"string","dashboard_id":1,"dttm":"2024-01-15T10:30:00Z","duration_ms":1,"json":"string","referrer":"string","slice_id":1,"user_id":1},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.api.mdx new file mode 100644 index 00000000000..cddbbc9aaae --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-log-detail-information.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-log-detail-information +title: "Get a log detail information" +description: "Get an item model" +sidebar_label: "Get a log detail information" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isEsQ8JpsR2lg6Fin5ws7TNlnVF7azD4sClpbPFhiJVknLiCfrvw5GSJdtK43YD8snmyx2f5954VEFjMJHmmeVK0pC+AUuYJNxCSlIVg6ABzZhmKVjQhobXBeW4L2M2oQGVLAUc3dKAaviScw0xDa3OIaAmSiBlNCyoXWW4i0sLC9C0LIOCRkpakBaXWZYJHjFE0PtsEEbREs60ykBbDgZHkRJ5Kt1fxGha6o3VXC5oGdQTTGu2wvEtrDYlQOYpDa+pSdTdtFYZtE3RmhVsBqI1dkKWWwFoACWB3gSPYWgm1OwzRJYG1GsI6QLsFIFNK8olbnY2/pKDXjVG/kLLG7SyyZQ03hon/b43ynfZsovuAwafegzFVrSMEyCtGTJXmtgEiBciKHRMPnIhyAyI1UwawSzEZLYiM7QqDSjcszRzhhiSdzz6mj66Y+Yds6Lp4m6cLqR5vKtk28PfbgIn/7+Q79K0H20NJhd2FzyLPNCCpuz+EuTCJjR8NjgJqMyFYDM83efrjlliZpKZYjqeeps+ILBO64DG1qa4c650yiwNacwsHFmeulR59Lxcu8Cd+iR9/Lg6wB/VrGEOWoPeMsOgf3K6By4jeAR72yA3/pxNN+BsHUAtBD+fdjm3qaTXjeDNwyXkUi0+gLHDjB8vwB5fmQbJnrC/Up82lTt7tKvmTkIMieDGEjUnTcncv1S3imuHZrdArCIaZAx6//QaJeqOXGAF+AUs48Lsl1RrBQ8Wy43asEcJqwpUfWpH7enU2FkXNrK+zvNG82b6DurspCf9k9Oj/uBo8Gw86Ic/9cN+/2+6lX2DOrkadU0ONXNNZgxa4TbYiZHrWuRm08MdfnHX36bf3fpcq5T87jqSMqCn/+niS8EYtoCOgHwkCNaC9BWLCaYpGBuSC7lkgsekaZRIptWSxxB38WnJei6Dp+VyJVluE6X5PxCHZJjbBKStzifrWtRBpC3omZw+LZN3ypK5ymUcEryXKyMDmtuoXGNqKjBEKkvgnqP5d0mtdThGJydP7ZtMqwiHMwEE/WJXIfkTw837B7RWuovHmcpF7KhWGippPOrZU6fPhbR4rQliQC9BexYhGUqSS7jPIEKnuUmioijXDwTga2aZWJsgoAaiXCNHfKd8vrM0vL7BptmyhatCzV2Glej+KFIxjBw8/7QRTC5oSKOrD5d1aW6GPoJwnGtBjv4ib87HZEITa7Ow1xMqYiJRxobP+8+f91jGe8tBT6hFbzChZDKZSEKO3pIJHVYp42wdklfANGjyw/Ds7Hw0mo7/+O383YRSfCJVaN6vbKJkC896Yo2Ip5nSto53M5ETWb8TyMv1NN7fB4iD7Ak78JsTYDFo87LYAj+hIZnQisCEkh8JizDQplbdgiwn8nAiM82lPajBHGNoHRwetun9ypZs5Hzaorgx2RheSYMs18zYHeOWzMFGiSP2DbSKDW5hPSbbHkKSn2onFZ7g2PH75CVK/EGyLybSA4yZZWtwW9SrTUrAsVCLA9x6+MI97FKwiYr9g9A9urE/pG3oRXZbojlcyviAzTVaq5M03U6WS1wmMSxBqCwFaavkc87wiopMK6siJcqw1ytQVRkWGFrljraz3FiV1ioCumSaY42q309OjW+c5sz1KA4mdmXV47sa4o/BdNzU/3Y8fk/WesqAIppNfWu+O+BGvqrgGvZRRGly8R6VIJdNJZ2mquTd7rJE79SVZYQ10ZN09aWgMxcbr+sXz68fx7T69oEh61ebbtORxqfLnZ1qmGswyfcqcZ8J5mq3Tx7lGWgD7Sa+NYWx4/ctB94kxqbMv6N8z+m+ARGhFiR2TRnBYxAZd1Vn47DWJdL57ahCbOHe9jLBuOtaXbAVVYhfU5ZxxDXA/FfYVobZLQaE9/g1LYoZM3ClRVnitP8sgtH/IJKHDr6FlfuQguEqclx3qVfHrlfK3V0b03DOhIGv8D34UPVGh+ShA+vnjVy1z6yBZLe0vMHQdkXIne4XhlEErvTVIjvX80bFeHOO4YK9WOtOXgdN9Qe1d8IpCr/DV7Vyjc5VcQRYlv8C5HPvsw== +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.ParamsDetails.json new file mode 100644 index 00000000000..3bb55a3ad8c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The embedded configuration uuid","in":"path","name":"uuid","required":true,"schema":{"type":"string"}},{"description":"The ui config of embedded dashboard (optional).","in":"query","name":"uiConfig","schema":{"type":"number"}},{"description":"Show filters (optional).","in":"query","name":"show_filters","schema":{"type":"boolean"}},{"description":"Expand filters (optional).","in":"query","name":"expand_filters","schema":{"type":"boolean"}},{"description":"Native filters key to apply filters. (optional).","in":"query","name":"native_filters_key","schema":{"type":"string"}},{"description":"Permalink key to apply filters. (optional).","in":"query","name":"permalink_key","schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.StatusCodes.json new file mode 100644 index 00000000000..032f7bd7b1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"},"changed_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User1"},"changed_on":{"format":"date-time","type":"string"},"dashboard_id":{"type":"string"},"uuid":{"type":"string"}},"type":"object","title":"EmbeddedDashboardResponseSchema"}},"type":"object"},"example":{"result":{"allowed_domains":[],"changed_on":"2024-01-15T10:30:00Z","dashboard_id":"string","uuid":"string"}}},"text/html":{"schema":{"type":"string"}}},"description":"Result contains the embedded dashboard configuration"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.api.mdx new file mode 100644 index 00000000000..1e02f8634a0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-embedded-dashboard-uuid.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-report-schedule-log-embedded-dashboard-uuid +title: "Get a report schedule log (embedded-dashboard-uuid)" +description: "Get a report schedule log (embedded-dashboard-uuid)" +sidebar_label: "Get a report schedule log (embedded-dashboard-uuid)" +hide_title: true +hide_table_of_contents: true +api: eJzFWFtv2zYU/isEsQcbk2O7a4FCRR+yLL2t6ILYwYZFgUtLxxYbilRJyokn6L8Ph7rYshUndQbsyTYv53zfufEc5zRlmiVgQRvqX+c0AhNqnlquJPXpNAYCyRyiCCISKrngy0wz3CRZxiPqUY7HUmZj6lHJEqA+rXY0fM+4hoj6VmfgURPGkDDq59SuUzxnrOZySYvC61Kb8UohUYsNhoiZeK6YjkhPudNM9E9qGN8z0OstHPzMCaAdumWWzEF36Z7E6o4suECLPEGJidXdrDrepWiulAAmuzSd36dMRj+gC9yFI7V9YZavoNF2C2tiFWFpKtb14skTMEgnpsYwu4V1F46HXXsBOmGCy9ujEaS1hEeV32AQmlRJAwb3X4xG+BEqaUFa/IrKeegCevjNIMB8S16qVQra8vK2BpMJu7/OhFB3EM0ilTAu3RK3kJgORF69wLRma/wdxkwuIZrN1/uCF1wbOytZd4ji0dYylxaWGNAeFezQrcyAfmBzA0/Nv0FoqUcttwIXrgzo8Tbe0lQLpRNmqU8jZmFgeQLU21fZ5OysBXkLU9a5cQDPeVUPfqtFX1Z+npTO279beBTuWZIKaPtyz3vXN22W9MXoxcvBaDwYv5qOR/4vI380+pvusqpB12Q2JBAJ3NthbBPRDq9dumiqVq5cOpRYBi1iI3a7Gm8qYasuI9GXo/Ez4jwBY9jySQHSNmpzkV5JltlYaf4PRD45zWwM0lb6SfMudDDevlgyefn/MvmiLFmoTEY+wUcJsYOxEBENRmU6BBIpMEQqS+CeG9tFqpGBWl49qwb9B4w+SosVQBADegWagNZK++RUkkzCfQohsnOLRIVhph/w1DtmmSjPOeUGwkxzu3ZNxLc7i4mEBdiyJSZVk7GkSVl649H7QagimDiYZf8hmFxSn4ZXl58p1rI5iM3P0uT4O9OCDP4i78+nJKCxtak/HAoVMhErY/3Xo9evhyzlw9V4WCfMrEmYYY45WgSUBEEgCRl8IAE9reLO+cEnvwLToMlPp2dn55PJbPrH7+dfAkrxPasQXqxtrOQWxmahQcmTVGlbB40JZCDr94i8bZZPlmB7iIM8g4pXCoiBRaDN23yHUEB9EtCKVEDJz4SFIRgzs+oWZBHIfiBTzaXt1QBPMBR7/f425U9sxSYuBrZotxY3DlLSIPOGLbtj3JIF2DB2ZJ9JNW/x9evfZNeTSPxr7cy8JD11nL+WNwr8QAO8CWQJOmKWNYB3zFEdUgJOhFr28Gj/DcU4b2fHe7CEEQ3O/5jMUSaACLUkvZrZoGE2QGJ96tEEbKzw8VgCGtN11T591CRod5fLZQZlGt3SaV26i/MzbpMIViBUmoC0VVVwXi8F5alWVoVKFP5wmKOows+RV7En7SwzViW1CI+umOZsLsrSVYvB7xEsmHt/HUzqUZBZglWi+okfhu5Z9cN0ekEaOYVHEU1bXsN3D9ykLHe4h/0PUZp8vEAhyKUtpNNU1X13unC9ZV3yXM9RknSFL6dzF3Dv6u7o05/Tuk91Tbrb3XRKjnTh4eWZhoUGEx8rBNtCuVAlnRb6LAVtYLuH2lrC2CnPrcalSYxNmHuJqqb7uIBuYWieLNcOpYJx16y4KMurYL+mLOUIaIxBsRfw1KO+669uat9f0zyfMwNXWhQFLpfDgptkucHgi6i/YMLAHprmCT5i3OxkguNIa+pcMZHhMZdNT4dzYAI9oHdnED1S98GZ9ID2vdH0SP1HTKkHUHUOq0ci+7HB9QCo3fl1g+dmUzJ/MIJ7l1VT3SeP/2XTia0eTGULUhPUeLO4wZLrXlwHr9w6DUNwb399aa+fRV7N0/b+HMsYdvnbf1vUxaz6gtI7AeV5eaJ8wosGn2tjEGBR/AtUjYCW +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"; + + + + + + + + + + +Get a report schedule log (embedded-dashboard-uuid) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.ParamsDetails.json new file mode 100644 index 00000000000..833ec79d401 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The report schedule pk for log","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The log pk","in":"path","name":"log_id","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.StatusCodes.json new file mode 100644 index 00000000000..afc7b1f6813 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"The log id","type":"string"},"result":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"id":{"type":"integer"},"scheduled_dttm":{"format":"date-time","type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"},"state":{"maxLength":50,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"value":{"nullable":true,"type":"number"},"value_row_json":{"nullable":true,"type":"string"}},"required":["scheduled_dttm","state"],"type":"object","title":"ReportExecutionLogRestApi.get"}},"type":"object"},"example":{"id":"string","result":{"end_dttm":"2024-01-15T10:30:00Z","error_message":"string","id":1,"scheduled_dttm":"2024-01-15T10:30:00Z","start_dttm":"2024-01-15T10:30:00Z","state":"string","uuid":"550e8400-e29b-41d4-a716-446655440000","value":1,"value_row_json":"string"}}}},"description":"Item log"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.api.mdx new file mode 100644 index 00000000000..1dc86559dc3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule-log-report-pk-log-log-id.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-report-schedule-log-report-pk-log-log-id +title: "Get a report schedule log (report-pk-log-log-id)" +description: "Get a report schedule log (report-pk-log-log-id)" +sidebar_label: "Get a report schedule log (report-pk-log-log-id)" +hide_title: true +hide_table_of_contents: true +api: eJzFWN9v2zYQ/lcIYg8JJtdyZneZij6kQdqmDboicbdhUeDS0llWTZEqSTnxBP3vw5GSLEdus6UPeUgsUuTx++4X71TSnCmWgQGlaXBd0hh0pNLcpFLQgE6XQBTkUhmioyXEBQeSr8hCKsJlQj2a4qqcmSX1qGAZ4GhFParga5EqiGlgVAEexd0Zo0FJzSbHVakwkICiVeXtO5TLhFhBew7gMpml8f8+JJLCgDD4muU5TyOG5w2/aDy07GzOlcxBmRQ0jiLJi0zYx9RApjvitVGpSGjlNRNMKbbB8Qo2uztAFBkNrqleyttZI9LrEu/McjYH3hnbTSY1HFAJUgC98R7CsJ2Q8y8QGepRJyGgCZgZApvVlCtcbPX8tQC12Sr6K61uUMs6l0I7bRz5vlPKo3SZxvh/v7WtRXukFOiCm74kEPEsNibD54VUGTM0oDEzMDBpZtVUcM7myNf5Rk8yKCXVLAOtWQIo5sEdDv1913Juh5HxAKKePG2YMj/IQhtmLPqM3V2ASMySBhN/z8KicPDbY+zEfzhhzXjxPf2IIps7PdiVMyVvZ40fPCC86obw9X09NuRuvu3JlzY1nd1BVKA3XcjkErQ5ydNnCZg9MYBmv2NZzqHxxgZL19O2vkWP/KPxwB8NRpPpyA9+8QPf/5v2fGcrBEWO+h7xLTldD/jOGrNzhrMknUx8OB77/gCOfpsPxqN4PGC/jp4PxuPnzyeT8dj3fZ+25hv1zbM1AypqNyjPDWQ2w1ceHf9QyHcCrG/971lnq91XLCboJ6BNQM7FmvE0Jttri+RKrtMYYrqHSGev4zJ6Wi6fBCvMUqr0H4gDclKYJQhTn0/aYNhDpLvRMRk/LZMP0pCFLEQcEFclWCUDqlvLQkVAYgmaCGkI3KWo/j6pVoZldHT01LbJlYxwOOdA0C5mE5A/0N2cfWzY7+NxKgseW6q1hHo3HjV56vA5FwaUYJxoUGtQjkVATgQpBNzlEKHR7CSRUVSobzjga2YYb1XgUQ1RoZAjVo1fbg0Nrm+wXDAswUqyzs3kqk6FGvP43SCSMVxZkK7c5EwkNKDRp8uLpvDZDp0f4bhQnAz+Im/OpiSkS2PyYDjkMmJ8KbUJjv3j4yHL0+F6NHTV6nA05DIZlq5UrEJKwjAUhAzekpCe1IFkLRCQV8AUKPLTyenp2dXVbPr7+7MPIaVYMtboPm7MUooOvnaiRZhmlm0dBToUoWjqJvKyncZr6QBxkEfS8NzmJbAYlH5Z3iMT0oCEtCYUUvIzYRG648zIFYgqFIehyFUqzEED7hk64MHhYZfuO7ZmV9byHco7k1vDSKGRdcuU3bLUkAWYaGmJ/gDNcodr0IzJfQsi6c+NEUtHeGr5fnY7KvxB8i9C4QDHzLAW7D1V1Iskh2dcJge49PCFLYR34+ENGMJ6zRFWsgducpCvBlwm9i+ND6lHMzBLGbsKnHquqwnoPV2U+araUQfq20aui5hCoTn2apXex3iBr0kMa+Ayz0CYOgdYaztBZa6kkZHkVTAcliiqCkoEUvWknRbayKwRgQWFSjFV6jptWTGuwF8wW0tZmFgv1d1PPcQfmw925b+dTj+SVk7lUUSzK6/l2wN35ZIbvsPuhUhFzj+iEOSyK2Svqur9dnVVobmbBIcZLHMkbZor6dw62+umkn7355TWzSfGhHu7Lfgt6crDzTMFCwV6+Vghtk9byH4TdVXkoDR0a+POFPqOW7ceOZVokzFXobtO7xHOvAOgvZ0M3JlhzlkqbNOhrD84R7+mLE8RzchW21bTHg1sl+8+JgR1Z3/TmP6aluWcafikeFXhtGtQe98pOtcr3epsF8sKNralbUtiaoO6cWInNLV3f0yDBeMaeiS3pxxc1rXaIXnwG8leOE23LjZdRA3MfGVD9NF42s8njzi7NkJ1gxFok6/VjXt5EkVgr4BmW6+YQaW2ie7NGXo1Vq4dH2l9u35A6XshlaVb4bJ51SK0txkCrKp/AaRcZ3o= +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"; + + + + + + + + + + +Get a report schedule log (report-pk-log-log-id) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.StatusCodes.json new file mode 100644 index 00000000000..32a35542965 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"active":{"nullable":true,"type":"boolean"},"chart":{"properties":{"id":{"type":"integer"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"ReportScheduleRestApi.get.Slice"},"context_markdown":{"nullable":true,"type":"string"},"creation_method":{"maxLength":255,"nullable":true,"type":"string"},"crontab":{"maxLength":1000,"type":"string"},"custom_width":{"nullable":true,"type":"integer"},"dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object","title":"ReportScheduleRestApi.get.Dashboard"},"database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"ReportScheduleRestApi.get.Database"},"description":{"nullable":true,"type":"string"},"email_subject":{"maxLength":255,"nullable":true,"type":"string"},"extra":{"readOnly":true},"force_screenshot":{"nullable":true,"type":"boolean"},"grace_period":{"nullable":true,"type":"integer"},"id":{"type":"integer"},"last_eval_dttm":{"format":"date-time","nullable":true,"type":"string"},"last_state":{"maxLength":50,"nullable":true,"type":"string"},"last_value":{"nullable":true,"type":"number"},"last_value_row_json":{"nullable":true,"type":"string"},"log_retention":{"nullable":true,"type":"integer"},"name":{"maxLength":150,"type":"string"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get.User"},"recipients":{"properties":{"id":{"type":"integer"},"recipient_config_json":{"nullable":true,"type":"string"},"type":{"maxLength":50,"type":"string"}},"required":["type"],"type":"object","title":"ReportScheduleRestApi.get.ReportRecipients"},"report_format":{"maxLength":50,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"timezone":{"maxLength":100,"type":"string"},"type":{"maxLength":50,"type":"string"},"validator_config_json":{"nullable":true,"type":"string"},"validator_type":{"maxLength":100,"nullable":true,"type":"string"},"working_timeout":{"nullable":true,"type":"integer"}},"required":["crontab","name","recipients","type"],"type":"object","title":"ReportScheduleRestApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"active":true,"context_markdown":"string","creation_method":"string","crontab":"string","custom_width":1,"description":"string","email_subject":"string","extra":{},"force_screenshot":true,"grace_period":1,"id":1,"last_eval_dttm":"2024-01-15T10:30:00Z","last_state":"string","last_value":1,"last_value_row_json":"string","log_retention":1,"name":"string","report_format":"string","sql":"string","timezone":"string","type":"string","validator_config_json":"string","validator_type":"string","working_timeout":1},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.api.mdx new file mode 100644 index 00000000000..c015c546ba8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-report-schedule.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-report-schedule +title: "Get a report schedule" +description: "Get an item model" +sidebar_label: "Get a report schedule" +hide_title: true +hide_table_of_contents: true +api: eJzFWVtv2zgW/isEsQ8JVontbLMoNJiHTKfT6Wy3U8TpzmLjQENLxxZrilRJyokr6L8vDinJki0nTnaBPtm8HX7f4bmRKmkCJtY8t1xJGtJ3YAmThFvISKYSEDSgOdMsAwva0PC2pBzn5cymNKCSZYCtFQ2ohq8F15DQ0OoCAmriFDJGw5LaTY6zuLSwBE2rKihprKQFaXGY5bngMUMEoy8GYZSdxblWOWjLwWArVqLIpPuLGE1HvLGayyWtgqaDac022F7Bpr8CZJHR8JaaVN1Hjcigq4pOr2BzEJ22W2S5FYAKUBLoXfAUhm2Hmn+B2NKAegkhXYKNEFhUU65wstPx1wL0Zqvkr7S6Qy2bXEnjtXExHnulvEiXQ3QPKDzyGModa7lJgXR6yEJpYlMgfhHBRefkDy4EmQOxmkkjmIWEzDdkjlqlAYUHluVOEVfkI48fk0f31LynVlRdMozTmTRP9oXsnvDzVeDW/1/ID0k6jrYGUwi7D57Flq8dblkIwea4m/fPWsRcKQFMoow4ZXpAhNforhMH1AgeQ6uWjD18ALm0KQ0vLsfBoe22Wl/zb5HvfPbiR9zpGnKl7TROISkEXIOxVzk/X4I9nyJcRxPd5cFGGdOrRN3LR5SzRRtrcF4VZWBTleyBvjyCcayVtGy+s3YyHo+HJhfGqiy65wlOOoiwcx4JM+lcMZ0MuHozVAeuPoLL8THnNWwGLzqKn1ukDrZlc2ZgCLUfOWhjx2PcJqfbHbF3LyNQY66Cfjw4wpIgY1xEpvC7vcSO4MFqF881sOR3KTZ+ZhXQhdIxRCbWANKkyh7n90vNYohy0Nwb9tOmdigkCGZsBGsmosTaDOcslM6YpSFqHc4sz1zWfIqhk2Mss/umeuzqNRPFY3FPFtm8A9pNj7S6j5q0+fQ2ahlpwMz7+NF39DNgyJNBQ1b30tVbuy6x4NrYIX/4+6uj3aFmfJyQHd/p7N8V8yIn+mw8Gg0xzzlIO8D3EIN2TRQrueDL409tIOUMnMAObTf6IpJ+5HpL0UnGvqhxjecbuPkqjuPKM/iGFepexnmxYgK6ZoInzCr9bNVvVw7sNTkqCd0rveJyGSEzVTwW3w5F/yYJ187YM7/g5QftjqV7ndirFK+I4MYStSDbu8Txd5jOrWNAshsgVhENMgF9fN05TdU9eY+l8c9gGRfmuGqzFXDwFtErmo+o7eto1ew6UJQPShwsmHvlcFMAe+PYr/22O+6VeN2hunLrdPXqs8lOHbCdt5PuOwN1Fh9M2x5tPzFPvIom+2mWXowvXp2NJ2eTy5vJOPzbOByP/0P7abSr2W16nBxIf53Z/Sw3ae+j7YydcLYdcGFq29xGo05fz9YOBpehCbtL90LDZM8lb5vZd32HGnADdw3vH6kbX2iVkX+6l5EqoK/+pwt4BsawJQz4/xM+1y6kP7GEYHQDY0PyXjrtkO2DDcm1WvMEkiE+nbWey+T7cvksWWFTpfk3SEJyVdgUjc7vT9oQPkCku9AzefV9mXxUlixUIZOQ4PtArWRAdRtVaIyECgyRyhJ44Kj+fVKtDMfo4uJ7n02uVYzNuQCC52I3IfmXd0Y8H9Ba6SEeb1QhEke1llCvxq0uv7f7vJcWtGSCGNBr0J5FSK4kKSQ85BDjoblOouK40AcM8BdmmWhVEFADcaGRI76Xfrm3NLy9w8c7y5YuCvkqgjRlhMF49HAWqwSmDqR/aBVMLmlI48/XH5p8uG16O8J2oQU5+zd59/aGzGhqbR6ORkLFTKTK2PD1+PXrEcv5aD0Z+UA9mswomc1mkpCzX8mMXtW+45Qekp+AadDkL1dv3rydTqOb3//x9uOMUnyzrQF92thUyQ6ktqMFxTNHsDZ8M5Mz2Txckh/bbqybThAHOR554OenwBLQ5sdyB/+MhmRGaw4zSv5KWIxGF1m1AlnN5OlM5ppLe9LgOUczOzk97TL8ja3Z1J1vh2Wvc6t+JQ0Sbcmxe8YtWYCNU8fteczKHr2waZPdc0KefzZHVXqON47in35FhT/I94eZ9Bjx2aPFt8O+nqQEnAu1PMGppz+49+a2FsIaN/Dv/iHdQV/mqwqV4pzIG2+hUWeD1Omu+3zAYZLAGoTKM5C2dkd3JF5QmWtlVaxEFY5GJYqqwhL3rvakvXGFWSMCKwbNMWo1t0snxleuC+aKRAcTK7L6s0DdxB/nmn35v97cfCKtnCqgiKYvr+W7B27q4wyOYRlFlCbvP6EQ5NIXMqiqer2bXVV4QE2swWCSeZIu4pR07szjl6Ys++2PG1p/lXHvP250W4I50lWAiyMNCw0mfakQ9wFjofYvKtMiB22ge6HqdKHt+HnriVeJsRnzV0tfcrqvU8QbHTF19NzVUSefDH7OqqHiNWCUC8bdfcFZWVmb9y1lOUdAk7a6pQEN8xUagz/tW1qW+AD4WYuqwm7/sQYt/yCYQ3uvYOM+77jiFoty6jyvsVsvlLvMm9BwwYSBRyifXNeV0ik5tGFzt5Sb7p4NkHxFqzs0axeD3O5+4CqOwQW/Zslesu4FjHdv0VSwMutk6NZg6j8ofRBOWfoZPqhVLToXxxFgVf0Xil/3Iw== +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.StatusCodes.json new file mode 100644 index 00000000000..191f16d03e0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get.User"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get.User1"},"database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"SavedQueryRestApi.get.Database"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_tables":{"readOnly":true},"template_parameters":{"nullable":true,"type":"string"}},"type":"object","title":"SavedQueryRestApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"catalog":"string","changed_on":"2024-01-15T10:30:00Z","changed_on_delta_humanized":{},"description":"string","id":1,"label":"string","schema":"string","sql":"string","sql_tables":{},"template_parameters":"string"},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.api.mdx new file mode 100644 index 00000000000..d8ce0945cdd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-saved-query.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-saved-query +title: "Get a saved query" +description: "Get an item model" +sidebar_label: "Get a saved query" +hide_title: true +hide_table_of_contents: true +api: eJzdWG1v2zYQ/isEsQ8JpsR2lhSBin5w07RN17Vd7azD4sClpbOlhiIVknLiCfrvw5GSLNty42YDAuyTzZc73nN87oXKaQg6UHFqYimoT9+AIUyQ2EBCEhkCpx5NmWIJGFCa+lc5jXFfykxEPSpYAji6oR5VcJvFCkLqG5WBR3UQQcKon1OzSHFXLAzMQNGi8HIaSGFAGFxmacrjgKEFnW8azcgbwqmSKSgTg8ZRIHmWCPsXbdQN9dqoWMxo4VUTTCm2wPENLFYlQGQJ9a+ojuTduFLpNV3RmOVsArwxtkImNhzQAVIAvfYesmE5ISffIDDUo06DT2dgxmjYuIRc4Gbr49sM1GLp5FtaXKOXdSqFdt446nadUx7lyza4Wxw+djbka2wZRkAaM2QqFTERECdEUOiQfIk5JxMgRjGhOTMQksmCTNCr1KNwz5LUOqJPPsTB9/TRDTdvuBVdF7bbaSkdh5tK1m/4x11g5f8T8G2adoOtQGfctBjPDONyhn8Tdv8exMxE1D86eeZRkXHOJni8C9gNvwQREzMIx5PFpt5prLSpfdJQ/ey4RZO7lPU8gJ7fWUnRzDBXzfObaq63B9qAzSH8HWPqM2jTT+PDGZjDS+0sqbC6kJlKlTBDfRoyAwcmtqfs7C8pxiFww8ZRljAR/w0WvQIWfhR84cRxuwIkxP/evT00JWSGTZiGljRUrrQZenTS3RnuGoJVtT9s+KvK3sJbjfj8YR5svw4M+8dE4jKFN0R7R6e7iN7ynYzWt3xscIduJauBJMX8NW52Aw+q/U7da3W7NaRZlDfybZ/wWBsip2RZkXfvBBq1u0WzXSBGEgUiBLV79h5E8o5cYIF5BYbFXO+Ws2sFW2vxSunZoUKW5KtObSltrRpby85KUanLyFJ1M2PSo+7R8UG3d9A7Gfa6/i9dv9v9iz6QEdcja6kaMfTqeFnOV2HQmLnla8Mlibextkn6Fa5dVSvXq0xpuV/bpa1ab9enSibkN9s4Fx49/lf9WQJasxm0EPsBMtWC9CULCSZF0MYnF2LOeBySpS9IquQ8DiFsw9OQdVh6T4vlUrDMRFIhe3zSz0wEwpTnkzrztwBpCjokx0+L5IM0ZCozEfoE28fSyYDu1jJTGOISNBHSELiP0f2boGodFtHR0VPfTapkgMMJB4L3YhY++QPp5u4HlJKqDceZzHhooZYaSmk86uSpw+dCGFCCcaJBzUE5FD7pC5IJuE8hwEuzk0QGQaa2EPA1Js/aBR7VEGQKMeJz+tudof7VNb7tDJvZLIRVEUFce/T+IJAhDKxt7vnNmcA0HFx+fk+XKbIcOvrgOFOcHPxJ3pwPyYhGxqR+p8NlwHgktfFPu6enHZbGnXmvo7EQj+1js9MbUTIajQQhB2/JiPbLuLEO98lLYAoU+al/dnY+GIyHH389/zCiFJ/zpVWfFiaSomFXPVFbFiepVKYivR6JkajetORFPY3NwB7aQX7QfM8JRcBCUPpFvgZiRH0yoiWQESU/ExYg68ZG3oAoRmJ/JFIVC7NXGXWIPNvb32/CfMfmbGAvuAF1ZXJ5EVJoRFsjZHcsNmQKJogswEfAy1cw+tWYrN8Ygv1aXVrugA4tzq9OosAfBP18JJyh2DXXRq65oNwkORxyOdvDrfvP7UeJBEwkQ/cxw34wwvaUtkHI05sC3WPjyRE6U+i9VifQ9Uh6j8skhDlwmSYgTBmZ9nKcojxV0shA8sLvdHJUVfg5Uq7Y0HaWaSOTSoVH50zFdQdcqXHd2ZTZRsiaia1f+QGpHOKPDddV/W+Hw0+k1lN4FK1Z1Vfj3TBu4FIOrmGzRqQiF59QCWJZVdLqqlLe7i4KvKUq7QwwYTqQNvnkdGI58rp69L77MqyaLaSwW122tBZ04aHwWMFUgY4eq8R+6prKzWZ8kKWgNKw8GJZTyB23b95zLtEmYe5x5hpb+x2TWOaR6jva2jOuLiutHz1LMw3cm07KWWz7YcuwvOT3FWVpjMb0EOeS49SjfnqDbHDXfUXzHF+Sl4oXBU67XUj9rRZtM+AGFvZLIHKVZ7hu468irlMa2yocUn/KuIbv4N77XHZN+2TbgdUDSiyaZ1aGpDe0uEZe20xkT3cL/SAAmwcrkY3CvZI23pwjV7BLa1TrmjHlH9Teak6eux0utRW1dTalo4FF8Q9gp+pR +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.StatusCodes.json new file mode 100644 index 00000000000..b8292fb7a65 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"TagRestApi.get.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"email":{"maxLength":320,"type":"string"},"fail_login_count":{"nullable":true,"type":"integer"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_login":{"format":"date-time","nullable":true,"type":"string"},"last_name":{"maxLength":64,"type":"string"},"login_count":{"nullable":true,"type":"integer"},"password":{"maxLength":256,"nullable":true,"type":"string"},"username":{"maxLength":64,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object","title":"TagRestApi.get.User1"},"created_on_delta_humanized":{"readOnly":true},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"TagRestApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"changed_on_delta_humanized":{},"created_on_delta_humanized":{},"description":"string","id":1,"name":"string","type":{}},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.api.mdx new file mode 100644 index 00000000000..f69f8456728 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-tag-detail-information.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-tag-detail-information +title: "Get a tag detail information" +description: "Get an item model" +sidebar_label: "Get a tag detail information" +hide_title: true +hide_table_of_contents: true +api: eJzFWFtv2zYU/isEsYcEU+IkTYtCRR/SLG3TdW1RO+uAOHBp6dhiQ5EqSTnxBP334ZCSLNty4qQD8mSLl8PvO3eyoDGYSPPMciVpSN+BJUwSbiElqYpB0IBmTLMULGhDw8uCclyXMZvQgEqWAn5d04Bq+JlzDTENrc4hoCZKIGU0LKidZ7iKSwtT0LQsg4JGSlqQFqdZlgkeMUTQ+2EQRtHanGmVgbYcDH5FSuSpdH8Ro2mJN1ZzOaVlUA8wrdkcv69hvrwDZJ7S8JKaRN2MapFBWxWtUcHGIFrfbpPlVgAqQEmgV8F9GBYDavwDIksD6iWEdAp2hMBGFeUSFzsd/8xBzxdK/knLK9SyyZQ0XhtHBwdeKY/SZRfdDQofeQzFircMEiCtETJRmtgEiN9EcNM++caFIGMgVjNpBLMQk/GcjFGrNKBwy9LMKeKEfOLRXfLomprX1Iqqi7txOpfm8bqQVQs/XAVu//9CvkvSdrQ1mFzYDvAJk1OIR+P5+tyEa2MbXim7/QhyahMavjju1NLWi8t2Nrhsn9MWc7U5KAZs+hWMPcn4/hTs/oXBtBE0ZJQcxSAsGyV5yiT/F5zNNbD4sxRzn4BwuQbUeCd3Flk+c1RkLgQb47E+b1WYxkoJYHL5WKc1pVNmaUhjZmHPcsdqg5CF9mosvyIDUsbFivafHR10rJwwLkZCTTlGdu5TwwbxTVYOHugPPtDWpTgDu7Mfz/QBvhbQB/PMmDE3Sscrwo+ev9gCWm5APyoKvPWCTdHQkvywwDhcdq+tImMph21U2f227lDE0fODLbToB5pKfBgcBc+C46u7CuUydRSyVL7XMvMJEdxYoiZkUbu37xlaVb5DspsgVhENMga9fZ7vJ+qGnGMp+gMs48Jsl90bARur9lKR2qKWVkatT+0ogp0SOwvUUvm5M0ff56mrrrmAh2APm16oGa78qFzzhst6zdWyLTss4Dqu5WPd/ESrlPzlmuAyoMe/1GulYAybQofr3WPuZiN9w2KC+QSMDcm5nDHBY7LozUmm1YzHEHfxae31XA6flsuFZLlNlEazh+QktwlIW51PmqTZQaS90TM5flomn5QlE5XLOCTYClZKBlS3UbnGIFRgiFSWwC1H9a+TamQ4RkdHT22bTKsIP8cCCNrFzkPyN7qbtw9orXQXj1OVi9hRrSRUu/Go508dPufSYnkVxICegfYsQnIiSS7hNoMIjeYGiYqiXG9wwLfMMtGoIKAGolwjR7wa/7ixNLy8wnuaZVOXhQb4exXQ271IxdB3wPw9WjA5pSGNLr5+rNPv4tP7Dn7nWpC9f8i7swEZ0sTaLOz1hIqYSJSx4cuDly97LOO92WHPsmnvcEjJcDiUhOy9J0N6UgWL03JI3gDToMlvJ6enZ/3+aPD5z7NPQ0rxPl6h+TK3iZItPM1Ag4inmdK29nQzlENZX0rJ62YYa/QO4iBbwg784gRYDNq8LlbAD2lIhrQiMKTkd8IidLGRVdcgy6HcHcpMc2l3ajD76FQ7u7tteh/YjPWdNVsUlwYXilfSIMuGGbth3JIJ2ChxxB5Aq1jiFtbfZNVCSPJ7baTCExw4ft/9jhJ/kOyrofQAY2ZZA26FerVICdgXarqDS3dfuVeEFGyiYv/64F54sHOjbehFdl2iOlyweIfNNWqrkzRdDZOPOE1imIFQWQrSVmHnjOEFFZlWVkVKlGGvV6CoMizQtco1aae5sSqtRQR0xjTH7FRf1p0Y3xxNmOtDHEzsvKqXnuoTf1w4Lst/Pxh8IY2cMqCIZllew3cNXN/nE5zD7oQoTc6/uGuG0itCOlVV7XeryxKtU+eUPmZDT9JlloKOnW+8re9UH74NaPXQ5q6sbnbRUTrSZYCbRxomGkzyWCHuTWqi1nvhfp6BNtBu1FtD6Dt+3ezQq8TYlPk7h+/k3IMjsWxKYteOETwGkXGXdVYuKk356HyorBBbuLW9TDDuOlPnbEXl4peUZRxxHVKXomlAw+waHcJb/JIWxZgZuNCiLHHYv8Gh929Esunga5i7Vzt0V5HjvAu92ne9UO6qbEzDCRMG7uC787XqinbJpgPrK4yct8+sgWTXtLxC13ZJyJ3uJ06iCFzqq7esFealjPHuDN0Fu7BWNW6cpvqD0jvhFIVf4bNa2aBzWRwBluV/NgzMSg== +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-available-domains.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-available-domains.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-available-domains.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-available-domains.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-available-domains.StatusCodes.json new file mode 100644 index 00000000000..72fd49951b0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-available-domains.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"domains":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"AvailableDomainsSchema"}},"type":"object"},"example":{"result":{"domains":[]}}}},"description":"a list of available domains"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-available-domains.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-available-domains.api.mdx new file mode 100644 index 00000000000..fb311b10d25 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-available-domains.api.mdx @@ -0,0 +1,60 @@ +--- +id: get-all-available-domains +title: "Get all available domains" +description: "Get all available domains" +sidebar_label: "Get all available domains" +hide_title: true +hide_table_of_contents: true +api: eJzFVttu3DYQ/RViUKA2Klt22wdDQR5c13GaBqnRXaMtLMPhSrMrOhSpkKONt4L+vRjqstcigPvQJ1EjztE5cyMbcOgrazx6SBr4/uyMH5k1hIZ4KatKq0ySsiZ+8tawzWcFlpJXlbMVOlKdt0Nfa9q357aUyoSlIizDglYVQgKenDILaKPBIJ2TK2jXBjt7wowgAlKk2XC5lErLmcafO9hJx2bfpY0An2VZsdcmuZHO/UPbsluOPnOqYo3MQGjlSdi5kMOfxODSRvDj2fl/CFGJ3ssFHojAV+iPjnBnZE2FdepvzBNxWVOBhvr/C4efa+UwhwPCNh07JT/8v0reWDdTeY4mEX/ZWuTWfEuikEsUFbpSec+KyAqZZei9oEJ54dDb2mV4SOCIFzh4zGqnaAXJfQNPXyjk+yECkgvO/bqORF9I8BDB80lmc5wEsj54amkWkEB29/t7iEDLGer1a88lgax2Wpz8KW6upyKFgqhK4ljbTOrCekouzi4uYlmpeHkej1X12FdVnIJI09QIcfJWpHDZJymkIRE/oXToxDeXV1fXk8nj9Ldfrz+kAG00UrtdUWHNBrnRMNJTZWUdhepATz41qRn6XrwezacLpCPmIV6iIeo8C5Q5Ov+62VGSQiJS6NWkIL7r0/pI9hOaNjXHqamcMnQ0MDvlEjw6Pt7U+k4u5SSkfEPvlnGdEms8Sx5lyi9SkZgjZUVQ+VKNzZbQZHgXu7ljxR+H9DWd2mkQ+7HzaPnByl+lpmObS5Ij05049JusxlNtF0e89fgVcEVvd8ENkpBaH5heEZRIhc0hgQVyrCpJBSTw74o5nuiW6LpeqB2H+2DUYJfGe/4sclyitlWJhkSHFLLZATWVs2Qzq9skjhuGapOGC7XdQ7uqPdlygIhgKZ1ipr4fTAEmDHecyzDnA02IAE1dcrv3r/wInb6N/3Y6vRUjThsBs9nGG/XukZsEVoK/GVmisE78cssgrGUb5GCoev+wu205o8PsCmdbJzJMsAZmoZ7eWFdKxnv3x5RzFLZB0n+FcQAH0W3Ezo8O5w598VKQNgJl5raTs8W+rtB53DyiN0xcO92+5XkXEk+lDCcLx+or9br1p/GgIXymuNJSGUYMtdT0tXwPslL823OIYK+eIQJOfZfbe2iamfR453TbsvlzjY5Pi4d1eYUzI4Ku1UMLfMIV30GyDMO0WUpdh2vL7snJWRy77eaaA8yn74aKMcz9gtGHS5BZbWA3Tbejmx3cGx2JMDih5UvMP87QXXg= +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"; + + + + + + + + + + +Get all available domains + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.ParamsDetails.json new file mode 100644 index 00000000000..96c579d7663 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"force":{"type":"boolean"}},"type":"object","title":"database_catalogs_query_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.StatusCodes.json new file mode 100644 index 00000000000..11461c53d49 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"description":"A database catalog name","type":"string"},"type":"array"}},"type":"object","title":"CatalogsResponseSchema"},"example":{"result":["string"]}}},"description":"A List of all catalogs from the database"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.api.mdx new file mode 100644 index 00000000000..997f0f0be38 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-catalogs-from-a-database.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-all-catalogs-from-a-database +title: "Get all catalogs from a database" +description: "Get all catalogs from a database" +sidebar_label: "Get all catalogs from a database" +hide_title: true +hide_table_of_contents: true +api: eJzFV99v4zYM/lcEYg8t5tbtcAMKH+4h1/V6vRV3RZNiA+oip9pMrFaWXEnONTP8vw+Uf6bJhqF76JMjSiS/jyIppoKCG56jQ2Mhuq0gRZsYUTihFUQwy5Cl3PF7bpGJFAIQJC64yyAAxXOk1SMEYPCpFAZTiJwpMQCbZJhziCpw64JOCeVwiQbqOqgg0cqhcrTNi0KKhJPD8MGS12qkXBhdoHECLa0W2iQ4snmvtUSuyGYn0vcPmDgIwAknSdDBnyfccamXdv5UolnPWx816XpSXjyweoL6jmjZQivbuP/l6Ig+rwRv0JbSawmHuRdtBnsyhLrFyjyWnpt1RqglDGS5MXz9r+xPW9LXLY9pyzoAfOZ5IXGM7LbzcOej8hLdpbCO6QXjUnYALVsYnTM3ShOy/e5/BSpHa/lyfM8d8S2imzx6RfjIU0YZidZF7EKtuBQpGzKdFUavRIop7CA60m24HL8tlxvFS5dpI/7CNGKT0mWoXOuf9WW3g8hYsWHy7m2ZfNWOLXSp0ohRY2mDjBRuq0uTIEs1Wqa0Y/gsKPzbpHob5OXXt86zC+XQKC6ZRbNCw9AYbSI2UaxU+FxgQuy8kOkkKc0/3NQnqqbmnHduMSmNcGvfkR9+UGneUTdyfEldGn7rau0ugOeDRKc49eCaFi65WkIEyc31JQQg+T3KYdkEmtalkezgT3Z+NmMxZM4VURhKnXCZaeuik6OTk5AXIlwdh11ph8dhV/dhDCyOY8XYwWcWw6RNNB/4iH1EbtCwnyanp2fT6Xz27fezrzEAdf4W3NXaZVqN4PWCHqDIC21clyU2VrHqujH70IsPl+j2CAd7HYug0c2Qp2jsh+oFlxgiFkPLJwb2M+NJgtbOnX5EVcdqP1aFEcrtddgOKe329vfHbL/wFZ/6+x4x3hAO16KVJdI9Uf6DC8cW6JLM83w9y2qDatSt2cv7I87fuyusGr4zT/d7o1HTh7i/j1WDl7z2WF9Eoj2kJR5Kvdyjo/vv/eO6WQTn6HY8LXx4WALI0WU6hQiWSEHzY0gEW9Sr4rEe2FN0fXU21VEaCv7OGMJLSJe0zVJcodRFjsq1de7vtjFUFUY7nWhZR2FYkak6qihx6y1rp6V1Ou9MBLDiRvB72TSjzkwzFiy4f5A9TAgAVZlT3bdL+ljYCuDn2eyK9XbqAAjNpr2e7xa4adPAaI+GDqYNu7giI8Rl08jOULX6/nRd0+12TcyPHA1J38oquPe59UmbnJO9L3/MoB0Y/VDnd4epx5OuA1KeG1wYtNlrjfhRb6G3R69pWaCxOJ6cRiLKnebc6rgJiXU5929LOyz+h9zdcNi/OA6fXVhILhQZ9ilVtXl9C7wQ5P2YtAdDkZ+3O08QAGVCc9W3UFV06sbIuiZxM9NuzfWjJxOGGG1iecS1n4IpT2VJ+75mu6RtjApLv1OIFlxa3CI5eNm7bgeVfbb9n2Kn/27EVesxhA5X8Qj1HaW4b2YeTLMxSRL0HbVT2ZoIiEXfSM7PKG1oThr/reiSp/1B1nfCqarmRNMd6x6dfxwIYF3/DS96mMc= +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"; + + + + + + + + + + +Get all catalogs from a database + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.ParamsDetails.json new file mode 100644 index 00000000000..7c5698d51de --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"tag_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.StatusCodes.json new file mode 100644 index 00000000000..7bc899cfaad --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"changed_on":{"format":"date-time","type":"string"},"created_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"creator":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"owners":{"items":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User1"},"type":"array"},"tags":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"}},"type":"object","title":"TagGetResponseSchema"},"type":"array"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object","title":"TaggedObjectEntityResponseSchema"},"type":"array"}},"type":"object"},"example":{"result":[{}]}}},"description":"List of tagged objects associated with a Tag"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.api.mdx new file mode 100644 index 00000000000..3594fd5d218 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-objects-associated-with-a-tag.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-all-objects-associated-with-a-tag +title: "Get all objects associated with a tag" +description: "Get all objects associated with a tag" +sidebar_label: "Get all objects associated with a tag" +hide_title: true +hide_table_of_contents: true +api: eJzFV1Fv2zgM/isCcQ8tzl3a3Q4YPOyhG7puu2ErmhR3QF1kqs3Y2mzJk+i0OcP//UApdpIm3a09HPZkSyap7yMpkm6hllZWSGgdxJctKA0x1JIKiEDLCiEGkvlUZRCBxW+NsphBTLbBCFxaYCUhboEWNUsqTZijha67YmlXG+3QscDTw0N+pEYTauJXWdelSiUpo0dfnNG8tzJYW1OjJRW0Lbqm9FqKsHLbAmkhdY7ZNJiZGVtJghgySXhAqkKIeoiOrNI5dBGkFiVhNr1ebNubKetoGvi326oq20U6glLer9UNEMz1F0yJISkqeePCBXWPyNgHHXkvRnOjfUzv9dn/wDGCxqF9nAOOYCUgrZULv5b59yg82Clh4yHQJjI/RTpf5vI4JOgupLstR9DY8sEn5ph98tsnmhQt/u30LWNdBHgrq7rE9dtz2XZXHQtn6FKrar56EMMH5UiYmSB/rggmnJDOmVTxDRE3igohxUR6Qr8dPmWrm0bOMVPW65ERVKBIG2tRk8hUjs4jevafSkCFzsn8h4K3yX5QhFcyE1zC0FEs3um5LFUmVuVP1NbMVYYZ7HDSmm7gcvRzuVxo2VBhrPobs1gcN1SgpuX5YqjTO4isKwYmz34uk4+GxMw0OovFpMDeycjudqaxKYrMoBPakMBbxe7fJjXY4FN+/9l59k4TF8FSOLRztAKtNTYWx1o0Gm9rTJmd3xQm9fdkZ6TeSJJlkPOHO0wbq2jh2/SXG77QV9xnQ4285Lrh4CqC24PUZDj2wEJPL6XOIYb04vwDcAG/xnK1DE7mdWNLcfCXOD2ZiAQKojoejUqTyrIwjuLnh8+fj2StRvOjEcl8lCNNl7VilIBIkkQLcfBWJHC8TDDv8Fi8QmnRil+OX78+GY+nk09/nHxMALpoAHa2oMLoNWjDxgBOVbWx1GeHS3Si+/lCvBy2n+RIe4xDPJxBFPQKlBla97K9wyOBWCSw5JKA+FXINEXnpmS+ou4SvZ/o2ipNez2uJ5xqe/v760zfy7kc+xivsd3YXIXDaMeEB5LyRioSM6S08Bwfx7DdoBn3a3E3bsz3cx+6NnCdeKqfg0bHD+b9ItEBayZJDjjveGEpZEp8Upp8j0X3XwCn72bSnyIJWZbf6UIkc4igQipMBjHkyF7zA2sM93Fnv/q7GO6Db8m7vQdb3ZE/iwznWJq64o4WLPmoBkNtbQ2Z1JRdPBq1bKqLW07Xbsva68aRqXoTEcylVfK6xH628WZCd51J37Q9TIgAdVPxLV8u+eFv+6b9t5PJmRjsdBEwmk17A98tcONQrvgbD1DCWPHujI0wl00jO1211PfSnf8F6EuWH1wCSV+4Wrj2mfWmH9Tf/zmB5f8E5374uhraPekuYuWpxZlFVzzWCE+2ema2J5hxU6N1uD6JrW1x7gS5+VFwiaNK+k6y/Ev60czdOHVoMoS3NKpLqfTazBiy+hJkrRjCEfhiDxGs5TZEwGkQ4nwJbXstHV7Ysut4+1uDlhvG1SrV/A3IlOP3DOKZLB1uoRqaJ+ydL4eJfbFy5SbafhjVC5/RZcMriOArLlZ/j90VZ6OvOh5B+HicpujLXq+21ao5jYbLfnrCEeYBZs11Q5yXL2x9J6S2DRKhjHUrhLwGPxv/A+tYLfE= +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"; + + + + + + + + + + +Get all objects associated with a tag + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.ParamsDetails.json new file mode 100644 index 00000000000..fbd3d4edd37 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"catalog":{"type":"string"},"force":{"type":"boolean"},"upload_allowed":{"type":"boolean"}},"type":"object","title":"database_schemas_query_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.StatusCodes.json new file mode 100644 index 00000000000..5471ccb4891 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"description":"A database schema name","type":"string"},"type":"array"}},"type":"object","title":"SchemasResponseSchema"},"example":{"result":["string"]}}},"description":"A List of all schemas from the database"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.api.mdx new file mode 100644 index 00000000000..9e10d328efd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-all-schemas-from-a-database.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-all-schemas-from-a-database +title: "Get all schemas from a database" +description: "Get all schemas from a database" +sidebar_label: "Get all schemas from a database" +hide_title: true +hide_table_of_contents: true +api: eJzFV1Fv4zYM/isCsYcWc5t2uAGFD/eQ63q93g53RZNiA+oip9pMolaWXElOmxn+7wMl23HqbAO6hz4lokTy+yiSoisouOE5OjQW4psKMrSpEYUTWkEM0yWyjDt+xy0ykUEEgsQFd0uIQPEcafUAERh8LIXBDGJnSozApkvMOcQVuHVBp4RyuEADdR1VkGrlUDna5kUhRcrJ4ejekteqp1wYXaBxAi2tUu641IueVeuMUAuoI5hrk2Jv505riVzRVllIzbMZl1I/EcLhmTpqRfruHlMHETjhJAla+rMAys4eSzTrZgU1qfqYePEmKI9Q31JUbKGVDeh/OTryJF7H3aAtpdcSDnMv2r6r8eamgg3moUTDUDUCbgxf/yv3SaB81bCYNJwjwGeeFxL7uG5aB7c+Ji+xfRXWMT1nXMoGnmVzo3PmeilGpt/9ryjlaC1f4I4MGdDcptEpwkeeMcpmtC5mF2rFpcjYpkpYYfRKZJjBDp493cDl+G25XCteuqU24i/MYjYu3RKVa/yzrmR3EOkrBibv3pbJN+3YXJcqixk1pSbISOG2ujQpskyjZUo7hs+Cwj8k1dkgL7++dZ5dKIdGccksmhUahsZoE7OxYqXC5wJTYueFTKdpaf7hpj5RTwznvHOLaWmEW/tufv9ElXlLrcjxBXV4+K2ttdsIng9SneHEgwvtX3K1gBjS66uvEIHkdyg3yxBoWpdGsoM/2fnZlCWwdK6IRyOpUy6X2rr45OjkZMQLMVodj9rSHh2PmrIfJcCSJFGMHXxmCYybPPNxj9lH5AYN+2l8eno2mcym338/+5YA0KPRYLtcu6VWPXSdoMMn8kIb1yaJTVSi2k7MPnTiwwW6PcLBXkUiCqpL5Bka+6F6QSWBmCXQ0EmA/cx4mqK1M6cfUNWJ2k9UYYRyey20Q0q6vf39PtkvfMUn/rZ7hLeEm0vRyhLnjid/4sKxObp06Wm+mmS1xTRu1+zl7RHlH+0FVoHu1LP9ETRq+iHq7xMV4JLTDuqLQDSHtMRDqRd7dHT/vX9WtyvgHN3wWeGbRyWCHN1SZxDDAilkfnyJYUC8Kh7qjjuF1hdmKIzSUOR3BhBeAvpK2yzDFUpd5KhcU+L+YoOhqjDa6VTLOh6NKjJVxxUlbT2wdlpap/PWRAQrbgS/k6EPtWbCODDn/in2MCECVGVOJd8s6cfCIHyfp9NL1tmpIyA02/Y6vgNwk9C7aI+mDaYNu7gkI8Rl28jOUDX6/nRd0922/csPG4Gk72IV3PnM+qRNzsnelz+m0MyZfpbzu5txx5OuI1KeGZwbtMvXGvEj3lwPR65JWaCxuDUybUSUO+Hc6jiExLqc+2elGRL/O3O3/HVvjcNnNyokF2G8Nf76Q1bfAC8EOT8m7Y2h2E/pjSOIgPIgXPQNVBUdujayrkkcJtnBx0DvrYRNhLahPODaz76UpbKkfV+vbcoGo8LS/wziOZcWBxw3Xvaumgllnw0/RHb6bydbte5DaHEVD1DfUoL7RubBhI1xmqJvpq3KYBQgFl0XOT+jpKEBqf8t0aZO84es74RTVeFE6Ix1h86/CwSwrv8GmtKqow== +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"; + + + + + + + + + + +Get all schemas from a database + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.ParamsDetails.json new file mode 100644 index 00000000000..42979d8698c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The annotation pk","in":"path","name":"annotation_id","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.StatusCodes.json new file mode 100644 index 00000000000..3cf7d625652 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"The item id","type":"string"},"result":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"},"layer":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"AnnotationRestApi.get.AnnotationLayer"},"long_descr":{"nullable":true,"type":"string"},"short_descr":{"maxLength":500,"nullable":true,"type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"}},"required":["layer"],"type":"object","title":"AnnotationRestApi.get"}},"type":"object"},"example":{"id":"string","result":{"end_dttm":"2024-01-15T10:30:00Z","id":1,"json_metadata":"string","long_descr":"string","short_descr":"string","start_dttm":"2024-01-15T10:30:00Z"}}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.api.mdx new file mode 100644 index 00000000000..351553a73af --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id +title: "Get an annotation layer (annotation-layer-pk-annotation-annotation-id)" +description: "Get an annotation layer (annotation-layer-pk-annotation-annotation-id)" +sidebar_label: "Get an annotation layer (annotation-layer-pk-annotation-annotation-id)" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/ivEYR8STI7trAEKFf2QBmmbLuuKxt2GRYHLSGdLtUQqJOXEE/TfhyP1GrvN+jLkiy2eyOM9z73wqBJyrniGBpUG/7KECHWoktwkUoAPsxgZF0IaTgKW8g0qlq/YQipm4kT3XoIHCS3JuYnBA8EzpNEKPFB4UyQKI/CNKtADHcaYcfBLMJucZiXC4BIVVJX3gAVW3459uinzJPrqLUMpDApDr3mep0loNY0/aTKh7C3OlcxRmQQ1jUKZFpmwj4nBTPfUa6MSsYTKawRcKb6h8Qo3wxUoigz8S9CxvJ03Kr0+DT1pyq8x7Y3tIpOYFIkLKRCuvIds6ATy+hOGBjxwGnxYopmTYfMackWTLd03BapNx/cNVFfEss6l0I6Nw8nEkfJNXCYR/W77nqxh1qVbqBTqIjXbqlBE88iYjJ4XUmXcgA8RNzgySWZ5KtKUXxNgFxxbmp0x9yPFAwIxz9DwiBuL4UFNNmM+h3Z7A8duCRm/O0exNDH4h0eTBy3+gkeP28R4j9oc58nBEs1BJz23BpKlUiznlv//BEzHUplufs/go8nDBnugDaf13+Gmqp/llzXTV1/JxA7uKg/wjmd5io2nmi37IdcFGRxODp+MJtPR9Gg2nfi/TPzJ5G9wQTTdiplOV5/wTjrgtSfu0bV7w8rm6jCBzih5Fkpm7DcZYUrQnnxXlmaoNV/ijkL3AI3tQnjBI0Z+Q218dibWPE0i1h1CLFdynUQYwQ48vbUOy/RxsXwQvDCxVMk/GPnsuDAxClPvz9rg3AGkv9AhefK4SN5KwxayEJHPqOrWJCPRrWWhQmSRRM2ENAzvEqJ/G1SrwyI6PHxs3+RKhjS8TpGRX8zGZ39QuDn/oFJS7cJxIos0slBrDfVq2urosdPnTBhUgqdMo1qjcih8dixYIfAux5CcZoVMhmGhPhOAL7nhaUuBBxrDQhFG6gE/3RrwL6/ohDd8SX1hr3gye2JoqrR3o1BGeGGtdN1jysUSfAg/vD9vmpVu6AKJxoVK2egv9up0xgKIjcn98TiVIU9jqY3/dPL06ZjnyXg9Hff6Olvgx33RuBy0fVUALAgCwdjoNQvguM4w+9pnL5ArVOyn45OT04uL+ez3X0/fBgDU/tVWv9uY2Paxjd2toLU8yXKpTJMeOhCBaHog9rwV08GyR3awHwzPc0pj5BEq/by8BzIAnwVQAw2A/cx4SPE7N3KFogrEfiBylQiz1xh9QBG7t7/fp+ENX/MLGyo9KgbCzpFSaGKjZYDf8sSwBZowtgT8D/DLAQd+M2b3PU5kfGycXjoiZpaHj25FRX9EyrNAOCB0Qrcg7lFUT5IpHqRyuUdT95/ZJniYWK/QMC62L017nWRkJaN8NerJeo9JtA8eZGhiGbmeHDx33fHhs8yV+ar6AnnkNVswXJ4Wipy60zdwH9E5vWYRrjGVeYbC1KXHxoxTVOZKGhnKtPLH45JUVX5JmVJtaTsptJFZo8KDNVcJVWhdV0urxl0FFtz2WtZM8Np7Uj2kP1uFhvpfz2bvWKun8oCsGepr8W4Zd+FqKr2jTpxJxc7ekRLCMlSyk6p6vZ1dVRQcTV29oBPBgbTVtYRrG5ovm8b3zZ8zqK+plFnubXfrsaDpBnJr5goXCnX8rUrsjW4ht69bF0WOSmO/Z+6JKHbcvPXUUaJNxu1xV98Jf1joD8xqj0qDd2acpzwRtL0NvLJOi0vgeUI2TsGD+6kBHvj2s8HgW4U//GJw1QTKJZTlNdf4QaVVRWJ38d36NNLrAaBjeGjjCjf2qkxRnhb03haMJuSd0sQ2KBH4C55q3ALf7bL3vm4o99nXfZbZaVvzSUBs+uY1Nucrm90/wjhL/TeYMPRPdUWpbGu+pc3NOQ5DtCdSs3qrGSO+20r66pTSgzrvXli1SVI/kPadlpWlm+EOkao11B6uZGBV/QsX4rDj +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"; + + + + + + + + + + +Get an annotation layer (annotation-layer-pk-annotation-annotation-id) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.StatusCodes.json new file mode 100644 index 00000000000..15d74c7d48b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"descr":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"AnnotationLayerRestApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"descr":"string","id":1,"name":"string"},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.api.mdx new file mode 100644 index 00000000000..1204381ac5a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-annotation-layer-annotation-layer-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-an-annotation-layer-annotation-layer-pk +title: "Get an annotation layer (annotation-layer-pk)" +description: "Get an item model" +sidebar_label: "Get an annotation layer (annotation-layer-pk)" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isHYh8STImToAMKFf3gZmmbLuuKOl0HxIFLS2dLNUWqJOXEE/TfhyMlWbblNssG5FPMt+M9zz13PKVkMZpIp7lNlWQhe4MWuITUYgaZilGwgOVc8wwtasPCm5KltC/nNmEBkzxDGi1YwDR+K1KNMQutLjBgJkow4ywsmV3ltCuVFueoWVUFJYuUtCgtLfM8F2nEyYPBV0NulJ3DuVY5apuioVGkRJFJ95N8NB3zxupUzlkVNBNca76i8QJXmydQFhkLb5hJ1N2kMRl0qejMCj5F0Rm7Qza1AokAJZHdBj/yYT2hpl8xsixg3kLI5mgn5NikhlzRZsfxtwL1ak3yN1bdEssmV9J4Ns5OTjwpj+KyD+4ewifeh3JLLdcJQmcGZkqDTRD8IaBDx/A5FQKmCFZzaQS3GMN0BVNilQUM73mWOyKG8D6NvmeP7dC8QytRF/f76SSdxrtGtiP87ylw5/8X8H2WHgZboymE3RNk+iELIfiULvPpucOCJ247Vxv5lSzj91co5zZh4dkvJ8GPDH5H8kMplXUaveIr1B/R2GGeHs/RIdlIyh2+hyBSY0HNYJ2RD68EndztsewWwCrQKGPUD4/eKFF3cEkC+xUtT4V5WMxaA3tzcUN6D8iQOozNrT3S7rXYK7sNUdUyWhuma07b2rRmfDN6N83K7Sb3PYy5urcZEbc+0yqD391TVAXs2X+qeBkaw+fYI5UfhKc9yF7xGOilQ2NDuJRLLtIY1i8k5Fot0xjjPjydsx7L6dNi+SR5YROl078xDmFY2ASlre+H9jnvAdI96JE8e1ok75WFmSpkHAIV5JpkJLqNKjQljUIDUlnA+5To3wXV2nCIzs6eOja5VhENpwKB4mJXIfxJcvPxQa2V7sNxrgoRO6i1hfo0XfXLU6fPpbSoJRdgUC9RexQhDCUUEu9zjChobhJUFBV6jwBfc8tFS0HADEaFJozUoH69syy8uaVuyfK5q0LrFwfck2OoIN0fRSrGkfPSt7aCyzkLWfTp41VTO9dDLyQaF1rA0V/w5uIaxiyxNg8HA6EiLhJlbPj85PnzAc/TwfJ0wNt7J4LuHZyOGYzHYwlw9BbGbFinkdsSwivkGjX8NDw/vxiNJtd//HbxfswY9cu1ax9WNlGy41w70bqXZrnStskBM5Zj2TSN8LKdptf2gPyAx2AI/MkEeYzavCy3kIxZCGNWoxkz+Bl4REqcWLVAWY3l4VjmOpX2oPHsmLR3cHjYxfqOL/nIBb2Dd2NyHRIlDUFuYfI7nlqYoY0Sh/KxGMsNoGEzhu3YEeIvTfhKj/bagf3iT1T0h5C/GEvvbcwtbz3d4qHepAQeCzU/oK2HL1z/n6FNVOy/G9y3GfVjbC+OMl9URJTLNi/yQhOPvXSw7Ty7omWIcYlC5RlKW+etC5M3VOZaWRUpUYWDQUmmqrAkBVY71s4LY1XWmAjYkuuUylvTczszvtuYcdd4ODep1ao/2Ooh/XEpvGn/7fX1B2jtVAEjbzbttXh3nBv5gkRr1NSA0nD5gYwQlk0jvVTV593uqqJQNUVpROXUg3SlqWRTJ5TXSmec7L37fM3q72USs19dt5AOdBXQ4YnGmUaTPNaI+7Scqd3md1TkqA12u/TOFGnH71ueekqMzbh7K+oGsP6/wVp/4PQHB+uZIzdzlC8Ot7nrPEi9/4CoIVi8t4Nc8NT1pk59ZZ0AN4znKTl6ygK2nQQsYGG+ILl4Pdywspxyg5+0qCqa9h/alBt73drnxQJX7tOcxCwKWndZ2ijbG03dIx6zcMaFwe+AP/hYN12HsO/C5otGrrp3No7kC1bdkvBdvXK3+4VhFKErmc2RnXd/o7i8uSAxUZPXeexbSdU/yHqvO2Xpd/gCWLXeuepPDlbVP6aiZGA= +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.StatusCodes.json new file mode 100644 index 00000000000..f277ed4a6b7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","type":"string"},"id":{"description":"id_description","type":"integer"},"name":{"description":"name_description","type":"string"},"roles":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","title":"Roles1"},"type":"array"},"tables":{"items":{"properties":{"id":{"type":"integer"},"schema":{"type":"string"},"table_name":{"type":"string"}},"type":"object","title":"Tables"},"type":"array"}},"type":"object","title":"RLSRestApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"clause":"string","description":"string","filter_type":"Regular","group_key":"string","id":1,"name":"string","roles":[],"tables":[]},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.api.mdx new file mode 100644 index 00000000000..6ee49ac5f74 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-an-rls +title: "Get an RLS" +description: "Get an item model" +sidebar_label: "Get an RLS" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isEsQ8JpsZNsQGFin5ws7RNl3WF7a4D7MClpbPFhiIVknLiCfrvw5GSLNlyk2YD8snmyx2f5954VEFjMJHmmeVK0pC+A0uYJNxCSlIVg6ABzZhmKVjQhobTgnLclzGb0IBKlgKOrmlANdzkXENMQ6tzCKiJEkgZDQtqNxnu4tLCCjQty6CgkZIWpMVllmWCRwwRDL4ZhFG0hDOtMtCWg8FRpESeSvcXMZqWemM1lytaBvUE05ptcHwNm64EyDyl4ZSaRN3Oa5VB2xStWcEWIFpjJ2S5FYAGUBLoVXAfhu2EWnyDyNKAeg0hXYGdI7B5RbnEzc7GNznozdbIN7S8QiubTEnjrfHi+XNvlEfZso/uAYPPPYZiJ1omCZDWDFkqTWwCxAsRFDohX7gQZAHEaiaNYBZistiQBVqVBhTuWJo5QwzJRx59Tx/dM/OeWdF0cT9OF9I83ley6+EfN4GT/1/I92l6GG0NJhe2B7xguenB7efn7ckey3RkdlW04+cePUsuLOi5n9/V01rc0VPn6QhWuWCaBvQNM/35ttIqz+bXsNnX3yzdh7IvdHjcL9UUszo/dwVx9r4DtRLQrUxd53lAh0+8Ly62VWaEJ532FUfLFo8DsVffW8UPdc5/HOXEY/mR8jm6HI/A2GHGT1bgMqFT1PfcMiSCG0vUkmwr+sNvklbt79HsFohVRIOMQT88+8eJuiUXWKB+A8u4MA/L+UbBwVreKV0PqLBVEtSn9pTGXo29ZatTlOoytNXcNV4z3akUrcRv5fd2M2I9bS7IZrpKq+nVNrqnV3uRMa0Frrp+7fGGu5O7gN36UquU/OHapDKgv/yn2zgFY9jqQQnTdX0jSN+wmGAXBsaG5EKumeAx2XZvJNNqzWOI+/i0ZD2X06fl8lmy3CZK838gDskwtwlIW51Pmlazh0hb0DP55WmZfFSWLFUu45Bgs1AZGdDcRuUaE1KBIVJZAncczb9PqtHhGL148dS+ybSKcLgQQNAvdhOSvzDcvH9Aa6X7eJypXMSOaqWhksajfn3q9LmQFrRkghjQa9CeRUiGkuQS7jKI0GlukqgoyvWBAHzLLBONCQJqIMo1csTH07db64qRK00rV4VG6pZcwhoEGdc7rwJ69yxSMYwdTP/uEkyusHH7PLqsC/N26CMJx7kW5Nnf5N35hMxoYm0WDgZCRUwkytjw5fOXLwcs44P16UCrW4Hn1gAHpzNKZrOZJOTZezKjwyqPnANC8gaYBk1+Gp6dnY/H88mfv59/nFGKj7kK2qeNTVyjU4NrJhp4PM2UtnUSmJmcyfpFQ14303iVHyEO8hgOgZdMgMWgzetih8mMhmRGKzYzSn4mLMJQnFt1DbKcyeOZzDSX9qhGdoLBd3R83Ob6ga3Z2Hm9xbczuXWJkgYpNzTZLeOWLMFGiWP5WI5Fh2hYj8mu75Dx19p9hWc7cWS/eokSf5D5q5n0aGNmWYN0xw7VJiXgRKjVEW49fuUepynYRMX+Ues+HNiEhvQgjyK7LtFQLt18kOca7dhrjr2e4RKXSYwqVZaCtFXiOjd5RUWmlVWREmU4GBSoqgwLjMByT9tZbqxKaxUBXTPNm9a4VuNbrSVzXY2D2XqlVEP8MZjCXf3vJ5NPpNFTBhTRdPU1fPfAjX1FwjVsdojS5OITKkEuXSW9pqrk3e6yRFfVThhjPfUkXW0q6MIFylulU4b6PnyZ0KrZx2D2q9v+1JEuAxSea1hqMMljlbjvHku131mP8wy0gXbb35rC2PH71qfeJMamzF0WVWNYfdQaXY53DdO6bno/fVX4LNzZQSYYd12tC62iiu4pZRlHFKeu8exGOA1omF1jLHhnT2lRLJiBz1qUJU77TzwY+AdhHULhW+EbF6kix3WXgnXYeqXcXdExDZdMGPgO+aNR1VIdk0MH1m8huWmfWQPJrmmJPbYvRu50vzCMInD1sBbZu9U7lePdOUYKtnCtq7yJl+oPau+FUxR+h69uZYPOlXYEWJb/Agl2Qoo= +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.ParamsDetails.json new file mode 100644 index 00000000000..e653b382431 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"version","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.StatusCodes.json new file mode 100644 index 00000000000..b6b7d584c52 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"The OpenAPI spec"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.api.mdx new file mode 100644 index 00000000000..176a6c63cdb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-api-by-version-openapi.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-api-by-version-openapi +title: "Get api by version openapi" +description: "Get the OpenAPI spec for a specific API version" +sidebar_label: "Get api by version openapi" +hide_title: true +hide_table_of_contents: true +api: eJytVttu2zgQ/RVisA8JVomziy4QqOhDNkjTdIs2qF1sgchwaWlsMZVIlhy5cQX9+2Koiy9xCyTYJ96H5wzPzLCGDH3qlCVlNMRwjSQoR/HBor64vRHeYioWxgkZumqhUsHzK3SeT0RgpZMlEjoP8V0Niq1YSTlEoGWJEMNmr8NvlXKYQUyuwgh8mmMpIa6B1pa3enJKL6FpprzZW6M9el7/8+yMm9RoQk3cldYWKpWMe3TvGXz92J6Z32NK0DRNtEd0skcSmghenL140iXWGYuOVAuxRO/lEg+xifbxRIAPsrQF7hyE94bEwlQ6iwXjY3ehJ8yEQ28ql6LIDHqhDQl8UP4gscEG3/LXE932vzO60YROy0J4dCt0Ap0zLhYXWlQaHyymzC5MCpOmlWNxHCD1WpIs2n3hco9p5RStg+TuvxPEd1PWDMklyxDCy1oF0wiYUKB7k0EMS6SZtGo2X886Wc5mxqKWVkEEDyepyXAceLRyLqReQgzpp4/vIIJCzrHYDNs34XHlCnHyWVxfTUQCOZGNR6PCpLLIjaf4/Oz8fCStGtXdnc2ovzQBkSSJFuLkjUjgoqLcOPUj4I3F3ygdOvHbxeXl1Xg8m3z45+p9AtBEA67bNeUhsnpkw8SATZXWOOq15BOd6D6yxKth+nSJdMQ4xJMJRO2xHGWGzr+q92gkEIsEOioJiN+FTFP0fkbmK+om0ceJtk5pOuphnbIuj46Pt4m+lSs5DoLYIrszuXkMoz3zHTjK71KRWCCleaD4LIL1Dsu4H4v9V2O6X/qHq1uqk8D0S3ui4YZpv0x0CzWTJAeYe07oNpkCTwuzPOKtxy+BpV4i5aaTdEjDlEMMPyHB/gkB2Kq6cuy+g16A/dB7x8siwxUWxpaoqQvl8Dqtodo6QyY1RROPRjWbauKaVdc8snZZeTJlbyKClXRKzos23/RmuJ/hQlYFdTAhAtRVyaHdDbnxHN+79t9MJrdisNNEwGh27Q18H4EbtzmK17h0CePEzS0bYS67Rg66qjsfdjehhvV5aswZtiUZslUN8yCR18aVku29/XcCXT1kDberMGTZQLqJ+PDM4cKhz59rpIlA6YVp6eygryw6H8REijiRb0/1RTyG1R+tSzyVMpSPrszz10FaJebr/ncgxEZ+O3dtVaRn/Dg6OoQPNLKFVJrxBCXWXRjcQXtpvDk0RMK018Qd1PVcevzkiqbh6W8VOq4o040sQ7RkynM/g3ghC4+/4HL0sfvgHIuf4ewmpV4H9RcVjyCCr7je+io1U5ZuyDUBQrt6kaYYcl1/7lEx30kM11csB1lRvlXBB1F0HbZ+EFNdtzva5NUMEEPaZoBN8x+o5YQb +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"; + + + + + + + + + + +Get the OpenAPI spec for a specific API version + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.ParamsDetails.json new file mode 100644 index 00000000000..a379640172f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"A hex digest that makes this chart unique","in":"path","name":"digest","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.StatusCodes.json new file mode 100644 index 00000000000..889228c0287 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Chart thumbnail image"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.api.mdx new file mode 100644 index 00000000000..d3449f4c8af --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-chart-thumbnail.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-chart-thumbnail +title: "Get chart thumbnail" +description: "Compute or get already computed chart thumbnail from cache." +sidebar_label: "Get chart thumbnail" +hide_title: true +hide_table_of_contents: true +api: eJzFVlFv2zYQ/ivEYQ/JpkRJ1wGBij6kQdqmK9ogdrABUdDS0tliI5EKeXLjCfrvw5GSYjvesLUPfZJEkR+/73h3/FrI0WVW1aSMhgTOTFU3hMJYsUASsrQo85XIwnAuskJaElQ01UxLVYq5NZXIZFbgIURQSysrJLQOkpsWFCPWkgqIQMsK+esOIrB43yiLOSRkG4zAZQVWEpIWaFXzLKUJF2ih66J2i+CpKPBB5GqBjnlIEpW8QyeoUK5n12h13yBEu/YPC/8LB0dW6QV03S1PdrXRDh3/f3Z0xI/MaEJN/KoqucD4Z359hJkbW0mCBGZKS7uC6AlwF20Hfyu4Hhe6CH49esaQm7OvMFcWM3KCjKACRdZYi5r64PC650+oyrouVSYZIv7iGGedc21NjZZUEFqhc0xgR0xGMWb2BTO/Fz7Iqi5xYyG8krngSKOjRFzopSxVLh6zRNTWLFWO+a5orK0NWo5/rJZrLRsqjFV/YZ6I04YK1NTvL8Z02iFkfWFQ8vzHKvlgSMxNo/NETAscgowcbmcam6HIDTqhDQl8UBz+p6JGDN7ltx+dZxea0GpZCod2iVagtcYm4lSLRuNDjRmr84PCZL5Odp7Ua0myDPP85g6zxipa+W725StBcnPL/YDkgjtcKFgHtxE8HGQmx4mnFppfKfUCEsiur95DBKWcYfn4GcLM340txcGf4s35VKRQENVJHJcmk2VhHCUnRycnsaxVvDyOfXOLj+OxP8RtqPQuTkGkaaqFOHgrUjjts81HPxGvUFq04qfTs7PzyeTT9OPv5x9SAG6tPcfLFRVGr7EcB0aeqqqNpSFVXKpTPTRF8XIcPlwg7TEP8V1iogBRoMzRupftlqQUEpFCLysF8YuQWYbOfSJzh7pL9X6qa6s07Q0UDzkF9/b310W/k0s58We/Jnxj8PGQjHasfdQrv0pFYo6UFV7ud4ttNxQnw7fYPk2W/nk40DbInnrVn8OKjh8cghepDrRzSXKkvBWQfpIp8bA0iz2euv8COMMrpMLkkMACyV/sVEACm4La+q7bpYlD58swFEJjObI7AwTbBfief4scl1iauuLLLCD5gwtAbW0NmcyUXRLHLUN1ScvJ2T1BO2scmWqAiGAprZKzMnSdASZcrHPZlNTThAhQNxUXeP/JD1/mm/hvp9NLMeJ0ETCbTbxR7xNyk9Cp+B97E3ZcF5cMwlo2QXaGql/vZ3fepQzdasJ9Noj0PauFmc+Y14MjeffHFHrHw+kd/j4aFC+6i3jxJ4tzi674VpCOTdjcPDUvk6ZG63xukSJu5+tDnDth3vI4hMRRJf0l0vu4N0jbXnQ7Qmv30Xfa2l4S4QPFdSmVZk4+G9u+Mm5A1oqJH0MEHgwiSLzZXeeXjPaTkylkyw207Uw6vLZl1/HwfYOWb5zbx4T1dZQrx+85JHNZOvwXtXtXvRvZF//Evh+UeuXromz4CyK4w1Vw6d55f8uO/8egfwO1wdzecrn5dumDE36eZhn61j0sG5z5Rkt7c86Zy55szXKM+du/MOhOJm0bZoS2243E/OXDvLrub7ZelMI= +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"; + + + + + + + + + + +Compute or get already computed chart thumbnail from cache. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.StatusCodes.json new file mode 100644 index 00000000000..3c87c657dd1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"charts":{"properties":{"count":{"description":"Chart count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object","title":"DatabaseRelatedChart"},"type":"array"}},"type":"object","title":"DatabaseRelatedCharts"},"dashboards":{"properties":{"count":{"description":"Dashboard count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DatabaseRelatedDashboard"},"type":"array"}},"type":"object","title":"DatabaseRelatedDashboards"}},"type":"object","title":"DatabaseRelatedObjectsResponse"},"example":{"charts":{},"dashboards":{}}}},"description":"Query result"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.api.mdx new file mode 100644 index 00000000000..8e407fab5c8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-database.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-charts-and-dashboards-count-associated-to-a-database +title: "Get charts and dashboards count associated to a database" +description: "Get charts and dashboards count associated to a database" +sidebar_label: "Get charts and dashboards count associated to a database" +hide_title: true +hide_table_of_contents: true +api: eJzFV1Fv2zgM/isCcQ8tzm3aww4oPOyh13bddsPWNSnugLrIVJuJtdqSJ9FpM8P//UDJcZImB2yXA/Zkm6Ko7yMpkm6gklaWSGgdxLcNKA0xVJJyiEDLEvnrASKw+LVWFjOIydYYgUtzLCXEDdC8Yi2lCadooW3vWNtVRjt0rPDb0RE/UqMJNfGrrKpCpZKU0YMvzmiWLQ1W1lRoSYXdaS4tuS1yUwdjGbrUqoqNQQxnrC7CYrSBzSOriy37TkWhHAkzEZl0+b2RNnMQgSIstxyusm3MI3CFSnEc/NavO7JKT3l5pr6Ng3Bjse3BmvsvmHrwigoWnEuS99LhNRaSMPMMYakvrZXzHzbg2MIK1e/17/liy0/zMSfMuESSmaTVBOxo+yjU063+7xyyg/N7+rsE4HzJ/gd2ffTr7rq7WgwAn2RZBUb9NXke1rblM9YD8alGOxddmNoIXhwd73BDS3ROTr/Lr+uY+41wo2VNubHqG2axOK0pR03d+aIvPVuYrG4MTF78XCYfDImJqXUWi1GOHjs6woy9bWqbosgMOqENCXxSjraR6m3wKb/vVD3/B0ZvNaHVshAO7QytQGuNjcWpFrXGpwpTZueFwqRpbf8lUq8lySLo+cMdprVVNPdd58sjQXx7x62D5JQ7UZ/9cBfB00FqMhx6cKFNFVJPIYb05vo9RFDIeyyWn8HR/F3bQhz8LS4vRiKBnKiKB4PCpLLIjaP45OjkZCArNZgdD7LuuMHxwIb7Ng5+cYMERJIkWoiDNyKB0y7fvP9j8QdKi1b8cnp2djEcjkcf/7z4kAC0UY/xak650Ssoe0GPU5WVsbRIFpfoRC86qHjViw+nSHuMQ+xEJgomcpQZWveqeUYpgVgk0NFKQPwqZJqic2MyD6jbRO8nurJK094C4iEn4d7+/irpd3Imhz76K8TXhMsgGe2Ye89XPkpFYoKU5p7uzmSbNcbx4ls8jyZT/7wIaBNojzzrz2FHyw92wctEB9h8eA/5mUM6JVPgYWGme6y6/xI4x9dvxiWSCOVbSJ2t9MbQYoV0zqSKiQkyQooFYYigRMpNBjFMkX3q57YYNjzTVA/thnM4Bv5GhxtVWw7RVk/Dc8TveVlkOMPCVCVq6mqDz4BgqKmsIZOaoo0Hg4ZNtXHDWd5uWDurHZlyYSKCmbRK3he4mAm8mTBNTKQfLDxMiAB1XXKt6D754WDDv29GoyvR22kjYDTr9nq+G+CGoejxGo91wljx9oqNMJd1I1td1e332q2fjReFb8glO5D05a+Be596r40tJdt799cIukGb70lYXQ5cnjTPQ480tjix6PL/aqSNQOmJ2ZzYhnWF1uHqVLIi4twJerPj4BJHpfT9qPt12CG114D03YvwiQZVIZXmA32qNV3a34KsFKM65t1LQ3H3/7KW/RABJ0rIhFtoGla+sUXbsvgrz0fckJbJ6O9Iphy/ZxBPZOFwA2TfpGHvuhta9sXS2evgF9OjnvucL2r+gggecB5+uto7zlVftPzpYeE0TdEX0MWWjXGAk6wvDJcXHH8ekla82GdB98LWt8JpmqARqmDbo/O9gAG27T/UKOxp +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"; + + + + + + + + + + +Get charts and dashboards count associated to a database + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.StatusCodes.json new file mode 100644 index 00000000000..dbc813faa23 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"charts":{"properties":{"count":{"description":"Chart count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object","title":"DatasetRelatedChart"},"type":"array"}},"type":"object","title":"DatasetRelatedCharts"},"dashboards":{"properties":{"count":{"description":"Dashboard count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DatasetRelatedDashboard"},"type":"array"}},"type":"object","title":"DatasetRelatedDashboards"}},"type":"object","title":"DatasetRelatedObjectsResponse"},"example":{"charts":{},"dashboards":{}}}},"description":"Query result"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.api.mdx new file mode 100644 index 00000000000..a9fd47ff9da --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-and-dashboards-count-associated-to-a-dataset.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-charts-and-dashboards-count-associated-to-a-dataset +title: "Get charts and dashboards count associated to a dataset" +description: "Get charts and dashboards count associated to a dataset" +sidebar_label: "Get charts and dashboards count associated to a dataset" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v3DYM/isCsQ8J5vaSoQMCF/1wS9O3FX3JXbEBcXBVbN5ZjS25En3J1fB/HyjZvtcBXTOgn+4kkdTzkBRJN1BJK0sktA7iqwaUhhgqSTlEoGWJvLqFCCx+rZXFDGKyNUbg0hxLCXEDtKpYSmnCBVpo22uWdpXRDh0L/HZywj+p0YSa+K+sqkKlkpTRoy/OaN5bG6ysqdCSCtppLi25A/umDsYydKlVFRuDGM5ZXITDaA+bR1YXB/TGolCOhJmLTLr8xkibOYhAEZYHLlfZIeYRuEKlOAt+G84dWaUXfLxU32Zhc++wHcCamy+YevCKCt54Lkk6pEssJGHmCcJaXForV/9V37GBDaLf693nvcpP8zCny6xEkpmkzfTrWPsY1IuD3u/88eOuH9g/wP3P19y/X+m9P3aX3avi6/FellWgM7yQ3Zi2LV+xHYWPNdqV6GLURvDk5PQBj7NE5+Tiu5y6jXlQhE9a1pQbq75hFotxTTlq6u4XQ9U5wGRTMTB58nOZvDMk5qbWWSymOXrs6Agz9rapbYoiM+iENiTwXjk6RGqwwbf8/qDC+T8weq0JrZaFcGiXaAVaa2wsxlrUGu8rTJmd3xQmTWv7L5F6IUkWQc5f7jCtraKVbzhf7gjiq2vuGiQX3IT65HdwHcH9o9RkOPHgQocqpF5ADOmny7cQQSFvsFgvg6N5XdtCPPpbvLyYigRyoioejQqTyiI3juKzk7OzkazUaHk6ysJ1o9ORDc9tFtziEhBJkmghHr0SCYy7bPPej8UfKC1a8cv4/PxiMplN3/958S4BaKMB4YcV5UZvYBw2BpSqrIylPlVcohPdt07xbNh+vEA6YhziAVSiYCBHmaF1z5odQgnEIoGOVALiVyHTFJ2bkblF3Sb6ONGVVZqOeoCPOQGPjo83Kb+RSznxkd+gvbW5DpDRjpkPbOWdVCTmSGnuyT6QarPFN+7XYjeSTPxzH8wmkJ56zp+DRss/7ICniQ6g+eoB8I47OiFT4OPCLI5Y9PgpcHZvv4mXSCIUbiF1ttESQ2cV0jmTKuYlyAgpOroQQYmUmwxiWPiln9Vi2HVLU922u55h9/uHHB5SbTk6B50Mu3Df8rHIcImFqUrU1JUEH/xgqKmsIZOaoo1Ho4ZNtXHD6d3uWTuvHZmyNxHBUlolbwrs5wBvJkwQc+mHCQ8TIkBdl1wiuiX/+DKxbf/VdPpBDHbaCBjNtr2B7x64Sah1fMaDnDBWvP7ARpjLtpGDrur0vXTrp+G+3k24UgeSvuo1cOPz7oWxpWR7b/6aQjda8xMJp+shy5PmGeiOZhbnFl3+o0baCJSem/0pbVJXaEOi9bPIxhbnTpBbngaXOCqlb0Pdx8KP5/UWjqFnEd7TqCqk0nyfz7Smy/krkJViUKesPdiJu++V7dS/7pPgCprmRjr8ZIu25e2vPBFxC1rnoX8emXL8P4N4LguHewCHtgxHl92YcizWft4G3k+LeuXTvah5BRHc4ip8YbXXnKa+WPnbw8E4TdGXzV5lbwDg/BoqwssLDj2PRRseHBKg+8PWD8JpmiARql87oPMdgAG27T/1Peet +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"; + + + + + + + + + + +Get charts and dashboards count associated to a dataset + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.ParamsDetails.json new file mode 100644 index 00000000000..eccdacad2de --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.StatusCodes.json new file mode 100644 index 00000000000..a3c84540baf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"state":{"description":"The stored state","type":"object"}},"type":"object"},"example":{"state":{}}}},"description":"Returns the stored form_data."},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.api.mdx new file mode 100644 index 00000000000..98bb0377e10 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-charts-permanent-link-state.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-charts-permanent-link-state +title: "Get chart's permanent link state" +description: "Get chart's permanent link state" +sidebar_label: "Get chart's permanent link state" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYcASTImToAMCFf2QBmmarmiD2NkGREbKSGdLiUSy5Mm1J+i/D0fKsh17L2g/5JNEind8nruHx1MDRlpZIaF1EN81UCiIwUjKIQIlK4QYnnABEVj8WhcWM4jJ1hiBS3OsJMQN0MLwMke2UFNo2zEvdkYrh46/nxwd8SPVilARv0pjyiKVVGg1eHRa8dzKn7HaoKUiWDuShPySoUttYdgIYhjlKBxpi5kIK6IlDv3wiClB227NRIBzWZkS1/22La/cdH6DVFvlBK02mWhb3WeS5CH7efVDlCp0Tk5xV+z+HXNvCG9lJjgj6CgWV2omyyITq1QKY/WsyDCDHezWbAOX45flcqtkTbm2xV+YxeKsphwVdfuLXnY7iKwbBiavXpbJJ01iomuVxYL12QUZOdxO1zZFkWl0QmkSOC84/Nukeh+e0cnJS+fGWJ3y8KFEwXmhRSx+Z7mF/KC12u7ica7rMvNUOw+dNW/160sfnytFaJUshUM7QxtYxOJMiVrh3GDKSfOTQqdpbf9BgO8kybIPQQQO09oyR66kj98I4rsxl0OSU66ucDE3pbYortFWUqEi8bFQTzCOYH6Q6gyHHmooxKVUU4ghvb35CBGU8gHL1TCoice1LcXBn+LyYiQSyIlMPBiUOpVlrh3Fp0enpwNpisHseIBh84HhzctCPQ2aJ1y0CYgkSZQQB+9FAmfdgfKZiMVblBat+Ons/PxiOLwfff7t4lMC0EY9vusF5VqtIewneoxFZbSl5WlwiUrU8n4Qb/rpwynSHuMQ300kCuY5ygyte9M8o5NALBLoKCUgfhEyZWHek35C1SZqP1HGFor2lvAOWYp7+/vrhD/ImRx6DayR3phcJUcrx7x7rvKbLEhMkNLcU/0hos0G23g5Fs+zyLS/LBPZBMojz/hLsGj5wfRfJypA5nuuh/ssGN0iXeJhqad7vHT/NbDKN8/GJZJIc2npZydMr3dm0V/YFVKuM4hhihw333XE8B/sOcD+0IZjUluO/84wwnNIH/mzyHCGpTYVwwmefHqDo8ZYTTrVZRsPBg27auOG5dtueTuvHelq6SKCmbQFV0nXVSzvJjQuE1mX1MGECFDVFZeDbsgPB1sBfD8aXYveTxsBo9n01/PdAjcMdY2/cRcntBVX1+yEuWw62Rmqzt6vbn1Lt6xtQ67KgaSvcA08eG2907aS7O/DHyPo2kM+BOHrqj3zpNuIje8tTiy6/HudtBEUaqK3m8NhbdA6LyoqiIv/+hRrJ6ybHYeQOKqkv3K6jvd/aHdjw/4iIpzTwJSyUOzYS6rpdH0H0hS8+zErIGibRb9UN0QQc6c9Xib6DprmQTq8tWXb8vTXGi1fLeOV1vwRyAp/O2cQT2TpcAtbf83C3k3XTe2LVSw3MXeTUi28pMuaRxD5n4DwK9COWYu+6vjtw5ezNEVf/ZY2Wzc6i6g/8ZcXnF9u39ai12e5e2HvO/E0TVgRyljbw/OFnAG27d8pY3Jf +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"; + + + + + + + + + + +Get chart's permanent link state + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.ParamsDetails.json new file mode 100644 index 00000000000..20033d43cea --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"Either the id of the dashboard, or its slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.StatusCodes.json new file mode 100644 index 00000000000..04ee5c53e16 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"always_filter_main_dttm":{"type":"boolean"},"cache_timeout":{"type":"integer"},"column_formats":{"type":"object"},"column_names":{"items":{"type":"string"},"type":"array"},"column_types":{"items":{"type":"integer"},"type":"array"},"columns":{"items":{"type":"object"},"type":"array"},"database":{"properties":{"allow_multi_catalog":{"type":"boolean"},"allows_cost_estimate":{"type":"boolean"},"allows_subquery":{"type":"boolean"},"allows_virtual_table_explore":{"type":"boolean"},"backend":{"type":"string"},"disable_data_preview":{"type":"boolean"},"disable_drill_to_detail":{"type":"boolean"},"explore_database_id":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","title":"Database"},"datasource_name":{"type":"string"},"default_endpoint":{"type":"string"},"edit_url":{"type":"string"},"fetch_values_predicate":{"type":"string"},"filter_select":{"type":"boolean"},"filter_select_enabled":{"type":"boolean"},"granularity_sqla":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"health_check_message":{"type":"string"},"id":{"type":"integer"},"is_sqllab_view":{"type":"boolean"},"main_dttm_col":{"type":"string"},"metrics":{"items":{"type":"object"},"type":"array"},"name":{"type":"string"},"normalize_columns":{"type":"boolean"},"offset":{"type":"integer"},"order_by_choices":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"owners":{"items":{"type":"object"},"type":"array"},"params":{"type":"string"},"perm":{"type":"string"},"schema":{"type":"string"},"select_star":{"type":"string"},"sql":{"type":"string"},"table_name":{"type":"string"},"template_params":{"type":"string"},"time_grain_sqla":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"type":{"type":"string"},"uid":{"type":"string"},"verbose_map":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object","title":"DashboardDatasetSchema"},"type":"array"}},"type":"object"},"example":{"result":[{}]}}},"description":"Dashboard dataset definitions"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.api.mdx new file mode 100644 index 00000000000..8008e197009 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-datasets.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-dashboards-datasets +title: "Get dashboard's datasets" +description: "Returns a list of a dashboard's datasets. Each dataset includes only the information necessary to render the dashboard's charts." +sidebar_label: "Get dashboard's datasets" +hide_title: true +hide_table_of_contents: true +api: eJzNWG2P1DYQ/iuWVYk7NdxCywcUxAdejpcWUcQdaqvbk/HGsxuDYwd7sscS5b9X47xcdjd7LbQS/ZTEnpk8z3g8nnHNFYTM6xK1szzlbwErbwOTzOiAzC2ZZEqGfOGkV7cCUxJlAAwn7FRmef/JtM1MpSAwZ82GYQ5M26XzhSSzzEIGIUi/YeiYB6vAR5mx4SyXHsMJT3gpvSwAwQeeXtQ7+E415p22VgRvy07CnGcaAwumWvGEa1IpJeY84VYWwFOulXBedPMePlXag+Ip+goSHrIcCsnTmuOmJOmAXtsVb5pLEg6lswECzf905w49MmcRLNKrLEujs0h49iEQ2Hpkr/SuBI+61fYQKhO1NEIR9gWkuZKbIJbaIHhRSG2FQixGyBbOGZCWNwnPZJaDQF2Aq3Akoi3CCnwUcaYqrGiXJIxk3OIDZDgSITeFLWQ7rkj6Aem93Iw0aXhSc4RjWnVS6xrZrhIF3UIGmHKbcVeiqAxqkUmUxq2mXRYFg8hcQAEBdSERbpQM1eJTBX5zo9Bae6ykESgXBgR8Lo3zB8wuZPYRrJr0r9IhGiCeovSw1nA1bWWQ9NoYgU4oQKnNtHCHR/TuE1pNL9Kh8XYH7e+NZGfJEo4aDQ087VeqW7XgKp+BOGAo4QqWsjIowKrSaYuTQqA0isqbycklYJaLtTQVBPKdoi05/bNucwUwBHrSZVsiAiw5W02Lrry0lZFe40aET0ZuhfQ/30u73zlIg7nIcsg+ioKy6GqazcHFDATHyIU4HEZDfhGZm3ZrAeh19pX79OAyW0pDRn8BMdr/+7DcchngQEJzXoEXi43Icqeznbzz7e52VzaeO19DM55X078rwReTEwcPmoR3wRZQ+un5T9NL1Cadgz5HKEojEcQNcOkIEStP0fAfhnD7PaFY6en8twa/cAFEIcuY1JXSdKpK82Yr2R8C0q/UjXmpKxietvXLWbsce+D3jVIalUVpYHyMX9TNZdPE/DWuVYa/DGWSgqW2kUwgU/f+VRFxOBv8DexBkT+WilENBAFT9tKupdGKXddfrPRurRUoPsFupNtyuft9ubyzssLcef0FVMoeVZiDxe7/bCj0JoiMFVsmP39fJs+cX2ilwKbsT1cx5ewtZLlcA6N8okMgRuiYzKisZpjrwDy0Z+sUwcFey+7e92X32iFbusqqlJ3n0IcQqIECUw4Csw4ZfNYUXPuMBhvxvwGyis7d2C58uKINeUkFO8oVtRDX+zDwy4R/vp05BWcRWdthGGlXPOXZu7eveMKNXIC5/uzcmvKs8obd/oM9Pz1nc54jlulsZlwmTe4Cpvfv3L8/k6Were/Ohn5kRu9twzTnbD6fW8Zuv2Bz/qiLuOj1lD0G6cGzHx49eXJ6dibOf/v19PWc8yYZwL3ZYO7sCN4wMADURek89g4Nczu3fcvCHg7DJyvAI8LBvo1F0urmIBX48LDe4TLnKZvzjs+csx+7KBXoPoJt5vZ4bkuvLR712E4o5o6Oj8dsf5FreRbXe8R4a/B6WZwNRHogKq+kRhbrwMjz21nWW1TT/pvtrh9xft8vYd3yPY9037caDT2I+4O5bfHSnwasO57ohJyBE+NWRyR6/IBTQBeAuVM85SvA2ChjzlO+z6S+bnKbgRQ5Dfy6b6tjAT3tGr673V7RNFOwBuPKAiyy1lJcstZQXXqHLnOmSWezmkw1aU3x2OxZe1IFdEVvIuFr6TXVLn0bHM3Qe9cNdDB5wsFWBW3o7pMecUtv239xfv6GDXaohnYBt+0NfPfAnUVUjOaolKL7hJdvYinn/I6RSVd1+lG6idcGfXaKNUZLMuaomi9iyDyLPTnF9+/nvKsMYyEcZ/mQViPpJiFl4WHpIeTfaoTaArt0LZ0t9FUJPsC4VBoNUey0cuu7rUsCFjKeF93lynOqcSZui3bdNDp//g83Tp1zED7jrDRSx4Oy6zDbTXbBZanJBXeJSm+EJzzduk8a+F72UXfB65o64HfeNA0Nd7cIF5fXgd9ec7WtvOLpUpoANzjs6G1XzByzr7sNm6TZF7x2E7eiqeiLJ/wjbLZvy5rLth1V4CPgVuBRlkFMyL3qXjWxlbien1J4Ur01bvn6IO1eyPokrLpuJdrk2gwo49nCYw3+F0lxQP8= +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"; + + + + + + + + + + +Returns a list of a dashboard's datasets. Each dataset includes only the information necessary to render the dashboard's charts. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.ParamsDetails.json new file mode 100644 index 00000000000..eccdacad2de --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.StatusCodes.json new file mode 100644 index 00000000000..cf4255d5277 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"state":{"description":"The stored state","type":"object"}},"type":"object"},"example":{"state":{}}}},"description":"Returns the stored state."},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.api.mdx new file mode 100644 index 00000000000..759224ac69e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-permanent-link-state.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-dashboards-permanent-link-state +title: "Get dashboard's permanent link state" +description: "Get dashboard's permanent link state" +sidebar_label: "Get dashboard's permanent link state" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYcASTImToAUCFv2QZmmaLuiC2NkGREZKS2dLiUSyJOXaE/TfhyMl2Y69Fywf8kkixXt4z93D46kGLYwo0aGxwO9ryCVw0MJlEIEUJQKHJ1xCBAa/VbnBFLgzFUZgkwxLAbwGt9S0zDqTyxk0zZgWW62kRUvfT46O6JEo6VA6ehVaF3kiXK7k4NEqSXMrPG2URuPyYG2dcEgvKdrE5JqMgMMoQ2adMpiysCLq/FCTR0wcNM3WTAS4EKUucB23aWjlJvgtuspIy9yzTQ4J482L6JRorZjhrrj9s7+9IXwQKaNsoHWcXcm5KPKUrdLItFHzPMUUdjBbsw1cjl+Xy50UlcuUyf/ElLOzymUoXbs/6yW3g8i6YWDy5nWZfFGOTVUlU85Im22QkcJtVWUSZKlCy6RyDBc5hX+bVI/hGZ2cvHZutFEJDScFMsqLW3L2G8kt5AeNUWYXj3NVFamn2iK01rTV29c+PlfSoZGiYBbNHE1gwdmZZJXEhcaEkuYnmUqSyvyNAD8KJ4o+BBFYTCpDHKmKPn53wO/HVAqdmFFlhZ+FzSZKmJTdoCmFROnYdS6fYBzB4iBRKQ69s6EMF0LOgENyd3sNERRigsVqGPRE48oU7OAPdnkxYjFkzmk+GBQqEUWmrOOnR6enA6Hzwfx4kHbbDzRtX+TyaVA/4bKJgcVxLBk7+MRiOGsPlc8GZx9QGDTsh7Pz84vh8GH06y8XX2KAJuo9vFm6TMk1H/uJ3su81Mq47kTYWMayux/Y+376cIZuj/xgL6ASBYAMRYrGvq+fEYqBsxhaUjGwn5hISJ4PTj2hbGK5H0ttcun2OgcPSZB7+/vrlD+LuRh6JazR3phcJUhJS8x7tuK7yB2boksyT/aFVOsNvrwbs+eZJOJfu2TWgfTIc/4aLBp6UADexTI4nQoneoefhaNdpAo8LNRsj5buvwNS++YZuUTCaSn8aJnulU9M+ou7RJepFDjMkKLnuw8O/xoDCrQ/wuHIVIbysDOc8Nyxa/rMUpxjoXRJDgUkn+YAVGujnEpU0fDBoCaohtck5GYL7byyTpUdRARzYXKqmbatXx4mtDBTURWudRMiQFmVVBzaIT0sbIXx02h0w3qcJgLyZhOv57vl3DBUOfpG/RxThl3dEAhx2QTZGarW3q9ufHPXVboh1ehA0te7GiZeYR+VKQXhff59BG2jSIchfF01ap50E5Hxg8GpQZv9X5AmglxO1XabOKw0Gutl5XJHV8H6FGknrJsfh5BYVwp/AbW9739U8Mam/dXkcOEGuhC5JHAvq7pV9z0InZMHx2TdbUDi7zQOEXDqvMdduu+hrifC4p0pmoamv1Vo6LoZrxTnD0Ka+xs7BT4VhcUt7/qrF/Zu2w5rn60iuul1Oynk0gu7qGgEkf8pCL8GzZgU6SuQ3z58OUsS9LWws9m65UlK/cm/vKAsU0u3Fr8+1+0Loe/0p67DilDSmt49X9bJwab5C0krd/U= +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"; + + + + + + + + + + +Get dashboard's permanent link state + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.ParamsDetails.json new file mode 100644 index 00000000000..20033d43cea --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"Either the id of the dashboard, or its slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.StatusCodes.json new file mode 100644 index 00000000000..bf2824a96dc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"all_tabs":{"additionalProperties":{"type":"string"},"type":"object"},"tab_tree":{"items":{"properties":{"children":{"items":"circular(Tab)","type":"array"},"parents":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"value":{"type":"string"}},"type":"object","title":"Tab"},"type":"array"}},"type":"object","title":"TabsPayloadSchema"},"type":"object"}},"type":"object"},"example":{"result":{}}}},"description":"Dashboard tabs"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.api.mdx new file mode 100644 index 00000000000..c8a86786063 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-tabs.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-dashboards-tabs +title: "Get dashboard's tabs" +description: "Returns a list of a dashboard's tabs and dashboard's nested tree structure for associated tabs." +sidebar_label: "Get dashboard's tabs" +hide_title: true +hide_table_of_contents: true +api: eJzFV9tu3DYQ/RViUCA2qnjjNg+Ggjw4qXNrkBrxBm1hGc6sOLtioiUVcrSxK+jfi6Eu3luDJgWaJ0nkzPCc4ZBz1ICmkHtTsXEWUnhLXHsbFKrSBFZurlBpDMXModf3gmKcBYVWbwxaCkxasSdSgX2dc+1JzZ1XGILLDcZZnIUjSKBCj0ti8gHSy2Zr+TPDBXnFBSmjZXV5G5dKlPPKcFChrBeQgBGXCrmABCwuCVIw+tr5637e06faeNKQsq8pgZAXtERIG+DbSqwDe2MX0LZXYhwqZwMFmf/pwQN55M4yWZZXrKrS5Cg4Jx+CgG3W4lXeVeTZdN6eQl1GL8O0DLsGWJbXko/4rrWRqFieb9hsQUyGATf7QDnHAZxdS86/sFBemFJ7smsmkBuf1yX6gynODmGMi97jrYSt0JPlsBH1n8CMTmy4pL2WKyzrfTM7jMYgMMXZ7hpftg/neFs61Bfdluyma18C6QaXVQd73LK2FdPNqvxlKMBYxOL58D/Vx5JCwMW/SsomytERnqBWUt4UOFUv7QpLo9Xd0VKVdyujScMeOmu+HZfj78vlncWaC+fNX6RTdVpzQZb79dV4hvcQWXfsmPz8fZk8c35mtCabqj9drbSz91gVuCJVkV+aEIQRO4V5TiEoLkxQnoKrfU77CI7xOnYPvy+7N47V3NVWp2pa0FBCpEcKSjsKyjpWdGOkuHYZjTHiuoHy2hu+jZ3gw2eG9PJK7mLGhXSHu4MX4CqBm/u503QRkXXNo0S7kBvt3dvXkECJMyrvPvu0ppDXvlT3/1DPz6Yqg4K5SieT0uVYFi5wevLg5GSClZmsjidjq5kcT+SsZ6CyLLNK3X+hMjjtqy1mPFVPCD159cPp06dnFxfX099+PXuTAbTJCOz8lgtn16CNAyM4s6yc5yGZIbOZHTqRejwOHy2IDwSH+noGSedXEGry4XGzxSODVGXQc8lA/dhX5zW7j2TbzB5mtvLG8sGA60hq7eDwcJ3pK1zhRdznNbYbg3fb4WwQwiNJ/IyG1Zw4LyLHb2PYbNBMh2+1vW/C9/2wdU3HdRqpvu88WnkI70eZ7bBqZBxxbmWhN3IlHZVucSCmh49AinhJXDgNKSyIo+7hAlLYZdHcaZY2EpJkkV8NCqn2ksu9KYHt4/VappWmFZWuWpJl1UWKW9UFairv2OWubNPJpJFQbdpIDbY70Z7Wgd1yCCGt3BuclTQIjRhG3jXNMbbPCBMSIFsv5QD3n/KIR3gz/ovp9FyNcdoEBM1mvJHvDriLiErJnGg/kYYvz6N+cX4ryN5U9f7Ruo0KcLiNooboSMY7qYFZLJdnzi9R4r36fQq9mpSC7mbvlFQk3SbifO1p7ikU3xqkFZE7dx2dDfR1RT7QugpaG5La6exWx11KAi8x9odeJz8n3tH12yla6zX/w39Bz5vphidViSb2vFiyTX92LgErI+yOBemwDiSQbqj+SOVqKKZLaJoZBnrny7aV4U81eWk4V3f13P2ImCDvGtI5loG+kIuDt70mOVRf97+yl+Kgcu0tjGIZIIGPdLv5P9NeyQmJ11sE3Bmc5jnF+3Vw3REFG3fR8zOpOpFNa0pgrL3+RaLvhdU0nUV3X7YjytgqBGDb/g2Q6vDx +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"; + + + + + + + + + + +Returns a list of a dashboard's tabs and dashboard's nested tree structure for associated tabs. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.ParamsDetails.json new file mode 100644 index 00000000000..f7194104764 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"A hex digest that makes this dashboard unique","in":"path","name":"digest","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.StatusCodes.json new file mode 100644 index 00000000000..95d3dad363d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Dashboard thumbnail image"},"202":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Thumbnail does not exist on cache, fired async to compute"},"302":{"description":"Redirects to the current digest"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.api.mdx new file mode 100644 index 00000000000..04d0a559c49 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dashboards-thumbnail.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-dashboards-thumbnail +title: "Get dashboard's thumbnail" +description: "Computes async or get already computed dashboard thumbnail from cache." +sidebar_label: "Get dashboard's thumbnail" +hide_title: true +hide_table_of_contents: true +api: eJzFV9tu3DYQ/RViUKB2K1u2mwKGgjy4rnNrkAbZdVvAMhKuNLtiLJEyOXK8FfTvxZCS9uJt0KZB8yTxdnjOcGY4bCFHl1lVkzIaEjg3Vd0QOiHdUmfCWLFAErK0KPOlyMJoLnLpipmRNhdUNNVMS1WKuTWVyGRW4CFEUEsrKyS0DpKrFhSD15IKiEDLCrl1AxFYvG2UxRwSsg1G4LICKwlJC7SseZbShAu00HVRu8X1TBR4L3K1QEeCCkmikjfoBBXKrTFstLptEKJdHMLif8LDkVV6AV13zZNdbbRDx+MnR0f8yYwm1MS/qpILjL/j3xXM3NhKEiQwU1raJUQPgLtoS9/PO4zssaGL4OToZGtbWdelyiQvjj84Rljfv7amRksqkK7QOQbaoW8kZmYfMCPeC+9lVZe4sfATvKcj29ygE9qQwHvlSBgd/CMSc7Z172NkBr/ivX4IujYR32KuLGbkeDIVKLLGWtTUHz6ve3R0/HXtcallQ4Wx6k/ME3HWUIGa+v3F6F47zLW+MCh59HWVvDYk5qbReSKmBXru6DjqLTrT2Ay3znWXqBHDKzr5yr56qWtrMm7OShR8LrRMxG+yVHk4H7TW2F06zk1T5l5qj9Cv5q1+fBD5/7OsF5rQalkKh/YObVCRiDMtGo33NWZ8aL5TmMyHzE4HfCpJlqMJInCYNZY1cuL+8JEgubrmtEdywcl8lZccXEdwf5CZHCeeXsj1pdQLSCC7fPsKIijlDMtVM3gQtxtbioM/xLOLqUihIKqTOC5NJsvCOEpOj05PY1mr+O44HnN5fByPqTBuQ/B3cQoiTVMtxMFzkcJZH0z+FBLxE0qLVnxzdn5+MZm8m/76y8XrFIBvk57nmyUVRq8xHTtGrqqqjaUhElyqUz3cAeLJ2H24QNpjHuI/C4oCTIEyR+uetFuyUkhECr20FMT3QmbsnO/I3KDuUr2f6toqTXsDzUN2x739/XXhL+WdnHg/WBO/0bk6LKMd6x81y49SkZgjZYWX/EUEtxuqk6Ettk+V5b8fDrYN0qde+fuwouMPm+FxqgP1XJIcaW8ZpZ9kSjwszWKPp+4/Bvb4CqkwOSSwQPI1DRWQwENRbX3T7dLFJvShGQKjsWzhnYaC7aB8xcMixzssTV3xXReQ/AEGoLa2hkxmyi6J45ahuqRlR+0eoJ03jkw1QERwJ63iXOj6vORhwr07l01JPU2IAHVTcdD3Tf74sN/Efz6dvhEjThcBs9nEG/U+IDcJ2YvHuCzjovPFGwZhLZsgO03Vr/ezO1+gDRlswrk3iPR5rIWZ95qnQzH28vcp9MUeu3kYXdVmXnQX8eJ3FucWXfG5IB3Xn3PzsLaZNDVa5/2LFHGKX+9i3wnz7o6DSRxV0l8sfQn7DGlV7H7rVrXitp3WbqovV+b3GgnvKa5LqTST9O7Z9uFyBbJWrOSYCQ2AEEHiHwDrdJOxHGcPCy50BW07kw4vbdl13H3boOWr6XrlxT64cuVv9xySuSwdfkL83tu+GtsXf6eg75R66YOlbLgFEdzgMrxc/Gvkc3b8t4+Wz6A3FMXXHIc+l3oDhcGzLEOf24dlw2tlI989u2CX5rp0rT4ZHbv/YdCdTNo2zAg5uRuJ+duJeXXdX+zN/q8= +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"; + + + + + + + + + + +Computes async or get already computed dashboard thumbnail from cache. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.ParamsDetails.json new file mode 100644 index 00000000000..0d1f3566c3c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.StatusCodes.json new file mode 100644 index 00000000000..f23fffb91f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"SQL select star","type":"string"}},"type":"object","title":"SelectStarResponseSchema"},"example":{"result":"string"}}},"description":"SQL statement for a select star for table"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.api.mdx new file mode 100644 index 00000000000..7a74476d71c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-database-select-star-for-table-database-pk-select-star-table-name-schema-name +title: "Get database select star for table (database-pk-select-star-table-name-schema-name)" +description: "Get database select star for table (database-pk-select-star-table-name-schema-name)" +sidebar_label: "Get database select star for table (database-pk-select-star-table-name-schema-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYR9sTI6SoAMCFf2QZmmarmiz2NkGREHKSGdLiUyyJOUmE/TfhyMlWY5VbEsR5JPElzs+z73wjhUorvkSLWoD0WUFKZpE58rmUkAEswxZyi2/4QZZnkIAOU0rbjMIQPAl0ugOAtD4tcw1phBZXWIAJslwySGqwD4o2pULiwvUUNfB1in8pkDmtA0eYGn9uln/14OM1blYfP+cRmDwJL/2/4+6os1GSWHQ0Pr+7i59EiksCku/XKkiTzghCW8Nwal6+pSWCrXNvbRGUxZOahP/9PePzGCBiWXGcg3BNuV2Rt7cYmJpR24Lmpg6uanl+rwBOvWn1wHgPV8q2rU+eq2yDoZQWG5xicKyudSM91G5GecxUv3qhwyxRGP4Aged+4jpJo1OEN7ylJEf0diInYoVL/KUrWOeKS1XeYrpENOerOey97JcLgQvbSZ1/jemETssbYbCNuezLlgHiPQFPZNXL8vkk6TIKUUaMbpiGiMjmdvIUifIUomGCWkZ3udk/m1SnQ7HaH//pX2jtExoSHcM+cU+ROwPCjfvH9Ra6iEeR7IsUke10dBI01G/vHT6nAqLWvCCGdQr1J5FxA4FKwXeK0zIaW6SySQp9XcC8B23vOhMEIDBpNTEkUrO7TcL0eUVXaKWL6gMwa9NzYGrAO4niUxx6sD5GlVwsYAIkovzjxBAwW+wWA99/NC41AWb/MVOjmcshsxaFYVhIRNeZNLY6GD34CDkKg9Xe2Fb4sK90N9k13SThdW68NRh1asNdRgDi+NYMDZ5z2I4bLLLuSVib5Fr1Oynw6Oj4+n0evb5t+NPMQAVpAb62YPNpOiB7yY6+PlSSW3b1DCxiEVbYtibbnpngXZEONhzcAy85gx5itq8qR4xjSFiMTRsY2A/M55QAF9beYeijsU4Fkrnwo5a5DsUsqPxuG+LD3zFpy5WevbYmFy7VApDJunMwL/x3LI52iRzVnguG1QbhojaMXvse7LIl9b9lbfGzBnji5eo6UOWeR0Lz4YwdUwe2anZJAvcKeRiRFvHr4ESZTO9TtCu27TBWsxG7fpE3U38lgltmbjlCbGdeObufwwBLNFmMoUIFkhecJ1SBFu2rNRd/V/NSc50F4lP5FKTrwddBo85fqRlluIKC6lc6+E1uVDyiiqlpZWJLOooDCtSVUcVZVG9pe2oNFYuWxUBrLjOCbVpblGnxndgc+47IoIJAaAol3RFNUP6GNjyyPvZ7Ix1euoACM2mvo7vFripv2tpjczGpGanZ6SEuGwqGTRVI+921645be9b1/N5ku7WreDGBes7qZec9H34cwZNo0sJ51fXjaYjXQckfK1xrtFkT1VSUwM+lwNdbqlQG9xoXtdTFDt+32rPm8TYJXdlsOnhnycZNjB29dTivQ1VwXNBWFwUVk2iXAJXOQHeI+m2ngUQuedSL19obuOFE22+Qii4fPRcQlWRlgtd1DVNfy1RUw29Wgewf8Tlrg1JIZrzwuAW+q6fgNF50zaO2fZbb5BkM8nFg0uboqQRBHCHD/4t6N5dTwLQfwY+4eyeEX8QQ/dEfAKKvvPqK8p8VzScX/yOwyRBV9da2a2ejlK2u31PjimbqIHvBV6XU80PaR/EVVV+h69C9dpYNCaAdf0PiwiKBA== +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"; + + + + + + + + + + +Get database select star for table (database-pk-select-star-table-name-schema-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.ParamsDetails.json new file mode 100644 index 00000000000..0d1f3566c3c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.StatusCodes.json new file mode 100644 index 00000000000..f23fffb91f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"SQL select star","type":"string"}},"type":"object","title":"SelectStarResponseSchema"},"example":{"result":"string"}}},"description":"SQL statement for a select star for table"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.api.mdx new file mode 100644 index 00000000000..c230061f7e9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-select-star-for-table-database-pk-select-star-table-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-database-select-star-for-table-database-pk-select-star-table-name +title: "Get database select star for table (database-pk-select-star-table-name)" +description: "Get database select star for table (database-pk-select-star-table-name)" +sidebar_label: "Get database select star for table (database-pk-select-star-table-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV21P5DYQ/ivWqB921SwBdJVQTveBoxzH9XSl7NJWIogzyewmkLV9trMHjfLfq7GTbJYNqsoh8Snxy4yfZ1484woU13yJFrWB6LKCFE2ic2VzKSCCWYYs5ZbfcIMsTyGAnKYVtxkEIPgSaXQHAWj8VuYaU4isLjEAk2S45BBVYB8U7cqFxQVqqOtg6xR+UyBz2gYPsLR+3az/50HG6lwsnj6nERg8ya/9/6OuaLNRUhg0tL6/u0ufRAqLwtIvV6rIE05IwltDcKqePqWlQm1zL63RlIWT2sQ//eMzM1hgYpmxXEOwTbmdkTe3mFjakduCJqZObmq5Pm+ATv3pdQB4z5eKdq2PXqusgyEUlltcorBsLjXjfVRuxnmMVL/5IUMs0Ri+wEHnPmK6SaMThPc8ZeRHNDZip2LFizxl65hnSstVnmI6xLQn67nsvS6XC8FLm0md/4NpxA5Lm6GwzfmsC9YBIn1Bz+TN6zL5IilySpFGjK6YxshI5jay1AmyVKJhQlqG9zmZf5tUp8Mx2t9/bd8oLRMa0h1DfrEPEfuTws37B7WWeojHkSyL1FFtNDTSdNQvr50+p8KiFrxgBvUKtWcRsUPBSoH3ChNymptkMklK/UQAfuCWF50JAjCYlJo4Usm5/W4huryiS9TyBZUh+LWpOXAVwP0kkSlOHThfowouFhBBcnH+GQIo+A0W66GPHxqXumCTv9nJ8YzFkFmrojAsZMKLTBobHeweHIRc5eFqL2xLXLgX+pvsmm6ysFoXnjqMgcVxLBibfGQxHDb55BwRsffINWr20+HR0fF0ej37/bfjLzEAlaAG7NmDzaTowe0mOsD5Uklt22QwsYhFW1TYu256Z4F2RDjYy7AKvK4MeYravKsecYshYjE0/GJgPzOeUJBeW3mHoo7FOBZK58KOWqw7FJaj8bjP/hNf8amLh54FNibXbpPCkBE64vw7zy2bo00yx/vlWFcb1KN2zB77l2zwtXVx5fnPHP2vXqKmD9nibSw8fkLRYX9kmWaTLHCnkIsRbR2/BQr/zaQ5QbtuvgYrLBu16xN1N/FbJrRl4pYnxHYMASzRZjKFCBZItnY9TwRbFqvUXf200chJ7hLwSVhq8uGgK+Axk8+0zFJcYSGVaxu8JhciXlGltLQykUUdhWFFquqoonyot7QdlcbKZasigBXXOeE0zQ3o1Pjuac59N0MwIQAU5ZKul2ZIHwNbdv84m52xTk8dAKHZ1Nfx3QI39fckrZHZmNTs9IyUEJdNJYOmauTd7to1lu1d6fo1T9LdmBXcuJD8IPWSk75Pf82gaVIpkfzqukl0pOuAhK81zjWa7LlKamqe53KgQy0VaoMbjed6imLH71vteZMYu+SuhDX998uF/Aaurv5ZvLehKngu6HwXeVWTDpfAVU4g90i6rT8BRO5508sKmtt4kVAE+RC5hKoisQtd1DVNfytRU5G7Wkepf2Xlrk9IIZrzwuAW3K7gw+i86evGbPsxNsiqmeTiweVGUdIIArjDB/9Ycw+jZwHov9OecXbPaj+IoXvDPQNF/41XX1F6u/vf+cXvOEwSdEWpld1quigvu0v15JhShjrsXqR1idP8kPZBXFXld/iCUq+NRWMCWNf/AhLKZbE= +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"; + + + + + + + + + + +Get database select star for table (database-pk-select-star-table-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.ParamsDetails.json new file mode 100644 index 00000000000..0d1f3566c3c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.StatusCodes.json new file mode 100644 index 00000000000..4434213df1c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"columns":{"description":"A list of columns and their metadata","items":{"properties":{"duplicates_constraint":{"type":"string"},"keys":{"description":"","items":{"type":"string"},"type":"array"},"longType":{"description":"The actual backend long type for the column","type":"string"},"name":{"description":"The column name","type":"string"},"type":{"description":"The column type","type":"string"}},"type":"object","title":"TableMetadataColumnsResponse"},"type":"array"},"foreignKeys":{"description":"A list of foreign keys and their metadata","items":{"properties":{"column_names":{"items":{"description":"A list of column names that compose the foreign key or index","type":"string"},"type":"array"},"name":{"description":"The name of the foreign key or index","type":"string"},"options":{"properties":{"deferrable":{"type":"boolean"},"initially":{"type":"boolean"},"match":{"type":"boolean"},"ondelete":{"type":"boolean"},"onupdate":{"type":"boolean"}},"type":"object","title":"TableMetadataOptionsResponse"},"referred_columns":{"items":{"type":"string"},"type":"array"},"referred_schema":{"type":"string"},"referred_table":{"type":"string"},"type":{"type":"string"}},"type":"object","title":"TableMetadataForeignKeysIndexesResponse"},"type":"array"},"indexes":{"description":"A list of indexes and their metadata","items":{"properties":{"column_names":{"items":{"description":"A list of column names that compose the foreign key or index","type":"string"},"type":"array"},"name":{"description":"The name of the foreign key or index","type":"string"},"options":{"properties":{"deferrable":{"type":"boolean"},"initially":{"type":"boolean"},"match":{"type":"boolean"},"ondelete":{"type":"boolean"},"onupdate":{"type":"boolean"}},"type":"object","title":"TableMetadataOptionsResponse"},"referred_columns":{"items":{"type":"string"},"type":"array"},"referred_schema":{"type":"string"},"referred_table":{"type":"string"},"type":{"type":"string"}},"type":"object","title":"TableMetadataForeignKeysIndexesResponse"},"type":"array"},"name":{"description":"The name of the table","type":"string"},"primaryKey":{"allOf":[{"properties":{"column_names":{"items":{"description":"A list of column names that compose the primary key","type":"string"},"type":"array"},"name":{"description":"The primary key index name","type":"string"},"type":{"type":"string"}},"type":"object","title":"TableMetadataPrimaryKeyResponse"}],"description":"Primary keys metadata"},"selectStar":{"description":"SQL select star","type":"string"}},"type":"object","title":"TableMetadataResponseSchema"},"example":{"columns":[],"foreignKeys":[],"indexes":[],"name":"string","primaryKey":{},"selectStar":"string"}}},"description":"Table metadata information"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.api.mdx new file mode 100644 index 00000000000..ff343b9be00 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-database-table-metadata.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-database-table-metadata +title: "Get database table metadata" +description: "Get database table metadata" +sidebar_label: "Get database table metadata" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/isEsQ8JptZN0QGFin5Is7TN2rVZ7W4DoiBlpLPFhiJVknLjCfrvw5F6syWnqdshwNBPtsjj8Z6758jjlTRnmmVgQRsanpU0ARNrnluuJA3pLAWSMMsumQHCExpQjsM5sykNqGQZ4NcVDaiGTwXXkNDQ6gICauIUMkbDktpVjlJcWliAplUVDHZhlwKI0za6gcX5i3r+ixsZq7lcbN+nXjC6k5/7+q3OUdjkShowOP/wwQP8iZW0IC3+ZXkueMzQkslHg+aUPX25Vjloy/3qWIkik+7vOoBDIrixRM1JLUKYTIhNgWuSgWUYKgRmITNDtUnhTQBzEStprGbc27aBJqBXsBrZva95sKQeYFqzFX4LJRczNzbGKRbbgglyyeIrkAlBYYIayFxpxFPjo8FwIx+pMaV+TcOjLRbesNAJDBZ22NTlR4gtSnAroOHT77Xfj3xE3tU0GPPJXGngC/lq1LtdbGsxglH4qgB7HI697rsVu5lFzmOG2JRZEqssVwZcDHp2EKUJ4TKB6+2e7XBuDxHO4MYj6rdqV07BGJ9hDlpjDHqMvFRKAJO4kEtuORNiNT6dMRun41NKJiDAbtGrZJEnbHz2tmx560H12aIdHEgueul/+3xrV289pHoydsNpwyTZMQmedww/wXjCjfnAvchNDK1FfqTBjzT436bB7XjijR0hRq55xvTqFbgAMyHezl0l958mRb0psvbbUqGnyHP/i/f3jjE5bd3UxeI82LDotLPGdCdNFVADAmI7tUwPYUz/eE38PDEosHMJ0Rg29dytAgrXLMs9R9t0ODvfqCRwoD1K8aMpZv32GwzZANMZWW06w5fLjRcIl3OlM1fBommPvqnEzcAYtrhVPNfd0C6kz1hCsEIHY0NyIpdM8IR0rxmSa7XkCSRj0HprPZaDu8XyXrLCpkrzfyAJyWFhU5C23p+0z5ARIP2FHsmju0XyRlkyV4VMQoLpXTsZ0N1GFToGkigwRCpL4Jqj+4egWh0O0cOHdx2bXKsYPzEdMC52FZI/kW4+PqC10mM4jlQhEge11lCvxq1+uev0OZEWtGSCGNBL0B5FSA4lKSRc5xBj0NwgUXFc6C0EfM4sE60L8GyJC40Y8Qr6+NniiYTnrGULPJ3or3U3gZ4H9PperBKYOuN890EwuaAhjd+/e00DKtgliO7T8we/Cy3Ivb/Ji+MZiWhqbR5OJkLFTKTK2PDxg8ePJyznk+XBpGleTA4m7gKdlF0zoZqUvfd+NYkoiaJIEnLvJYnoYZ1XLiAheQZMgyY/HR4dHU+nF7O3r47fRJRik6E2+nRlUyV7ZrcDreE8y5W2TVKYSEayaRuQp+3w/QXYPbSDfF90gdeZAktAm6flBsaIhiSiNc6Ikp8Ji5G0F1ZdgawiuR/JXHNp9xqb7yNN9/b3+174jS3Z1PGj54m1wS6M2IQgPQewz4xbMgcbpw7/90dfrrkgbL7JZrzRFx+akJfeDzPnhg9+RYU/6JMnkfQ43B3ZYNjwUC2kBNwXarGHovtPRsqPF2C7dptdu35pQDOwqUpoSBeAfnSdq5AOvFHmV9WXHYKBcInvE6/QGKdRd9NNK1/jNElgCULlGUhbHyGOBl5RmWtlVaxEFU4mJaqqwhK5Xw20HRXGqqxREdAl0xytbl46Tk39zmGFsLWZNKAgiwyPlPoTfwwd+PTlbHZKWj1VQNGadX0t3oFxU3824pyvxTU5OXVFt9IbSkZdVa930pVrEzbno6vxPEh3Spb00tHtuauxMGf+mtG65eieVm62qy0d6CrAxRca5hpMuqsS90acq5HCtshBG+jXq70h5I6XWx54lxibMXdt1QXozXRe26u9xyxc20kuGHdFpmNTWVP9jLKc48YHuLq5RwIaugZ08z4K17rF4XpHF+nh439GyxLXv9eiqnD4UwF65evnhoK+Ic7dxZ/QcM6EgYHd7Q1O997Vhdo+GfbNR+E1zyS5csQXBfg2K76qXF/d9bB3MqDfUt9h754Tv9GGtt2+gxX94FXnmLvu4HZx8RKHcQzuVmnWDqooTLr25HxxjPmAJXO/a9FkRf0HtY/aVZZewt8EVecs/EYDq+pf80TLqA== +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"; + + + + + + + + + + +Get database table metadata + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.StatusCodes.json new file mode 100644 index 00000000000..5454dd1d7e7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of distinct values","type":"integer"},"result":{"items":{"properties":{"text":{"description":"The distinct item","type":"string"}},"type":"object","title":"DistinctResultResponse"},"type":"array"}},"type":"object","title":"DistincResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Distinct field data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.api.mdx new file mode 100644 index 00000000000..38e5a8183aa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-dataset-distinct-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-distinct-values-from-field-data-dataset-distinct-column-name +title: "Get distinct values from field data (dataset-distinct-column-name)" +description: "Get distinct values from field data (dataset-distinct-column-name)" +sidebar_label: "Get distinct values from field data (dataset-distinct-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV22P0zgQ/ivW6D7s6rKUPXESCuLDAsvbIUDbojtpsyreZNoaHDvYk7Ilyn8/jZ2kaberOwESnxrb8/I84/HMtIFKOlkiofOQXjagDKRQSVpBAkaWCCnkVtelmYdVAg6/1MphASm5GhPw+QpLCWkDtKlY3JNTZgltmzSQW0NoiE9lVWmVS1LWTD55a3hvq1s5W6EjhZ5XC6UJ3QGbCSiT67rAuSqCpCIs/UhQGcIlOpbsdqRzcsPrSi7xsCSfzL36dvB4a8lef8KcIAFSpHljiTR3qCVhMe+otG3ACCl8qdFttkH8Au0VB89X1vjI8o/79/nnO2OU2zoqFehzpypWghRmKxRkSWph6vIanbALUShPyuQk1lLX6CE5EAOHvta0E9Jdf4Q3d7gbzLPm1vg2D+4M4LNO8yI4v+iCc/vy/ttErzvtriEBvJFlpXEUqtMty8urcFG7XHo0YqFQF6KQFAw9+KFrKtH73cS7My67oAdFeCILwa8OPaXilVlLrQqxfbaicnatCizgAKeRbuRy+mu5fDCyppV16hsWqTiraYWGOv9iKC0HiIwVI5MHv5bJW0tiYWtTpIIfQRdk5HB7W7scRWHRC2NJ4I3i8N8mNdhgL3/+6jx7ZQidkVp4dGt0Ap2zLhVnRtQGbyrMmV3YFDbPa3fHTT2XXH2CXHDuMa+dok1oL5++xtd3lQDJJbcceCZJeiQPVwncnOS2wGkAF/uRlmbJPejDxRtIQMtr1NtlDDSva6fFyT/ixflMZLAiqtLJRNtc6pX1lD68//DhRFZqsj6dFNHdpK9ak2bU39oMRJZlRoiTlyKDsy7lwhWk4glKh078dvb06fl0Op+9++v8bQbAja6D+X5DK2tGQIeNAaoqK+uozxefmcz0XUE8HrbvLZGOGIf4UT5JtLJCWaDzj5s9VhmkIoOOWQbidyHzHL2fk/2Mps3McWYqpwwd9SjvcSoeHR+Peb+WazkNOTDivrO5vSprPNMfKMuvUpFYIOWrwPhn8G12SKf9WuzfKbP/2F9rE5nPAvGPUaPlH47Co8xE5Ox/QL0Xk07Iaryn7fKIRY8fhca/+0ReIO03ZbFwthx1HnHUET3pBU8izxPmeQwJlEgrW8QxBJI4s6Xw/8LEFxIeeXxkteP7Ohh22Mf+ho9FgWvUtirRUFcuQjpEQ03lLNnc6jadTBo21aYNZ317y9rT2pMtexMJrKVT8lpjP4AEM3HsWMjQugNMSABNXXL56Jb8E0rIrv2Xs9l7MdhpE2A0u/YGvrfATWMd5DOOmrBOvHofBkbr9owcDFWnH6TbltOgr4VhTIkkQ0Vs4Dok4XPrSsn2Xv89g2625kcTT7ezVSDdJqw8d7hw6FffayTMqwt7e7Sb1hU6j+Nha7TFuRPl1qcxJJ5KGVpUN/H+lCTfgTS0Np5FJ5WWyrDrkHRN9wAuQVaK8Z2ydrTOX519SCAd/5+56jPiEprmWnr84HTb8nac3/l17GEYGjRsQ7kL6DNuwsTP6axrPg81oM/taFR5/i4gXUjt8RbTrZeji24sOhZ3OeynZbMZ++yBjPm2V/wGQlkMMKLEWZ5jqNK97q3Jg/EPBefFOecVz2OjOxmyq/tg6wdxNU2UiHW2HWCGhsMA2/ZfO0kORw== +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"; + + + + + + + + + + +Get distinct values from field data (dataset-distinct-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.StatusCodes.json new file mode 100644 index 00000000000..5454dd1d7e7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of distinct values","type":"integer"},"result":{"items":{"properties":{"text":{"description":"The distinct item","type":"string"}},"type":"object","title":"DistinctResultResponse"},"type":"array"}},"type":"object","title":"DistincResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Distinct field data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.api.mdx new file mode 100644 index 00000000000..bc523b4a233 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-query-distinct-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-distinct-values-from-field-data-query-distinct-column-name +title: "Get distinct values from field data (query-distinct-column-name)" +description: "Get distinct values from field data (query-distinct-column-name)" +sidebar_label: "Get distinct values from field data (query-distinct-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYR8STI6ToQMCFf2QZmmaruiy2MEGRIFLS2ebKUWqJOXGFfTfhyMlWX4JNjQD8kkmeXd8nrvj3bmCghueo0NjIb6rQCiIoeBuAREoniPEkGpZ5mriVxEY/FoKgxnEzpQYgU0XmHOIK3CrgsStM0LNoa6jClKtHCpHp7wopEi5E1oNH6xWtLfWLYwu0DiBllYzIR2aPTYjECqVZYYTkXlJ4TC3PUGhHM7RkGSzw43hK1oXfI77JelkYsX3vcdrS3r6gKmDCJxwkjbm6CYGJXeYTRoqde0xQgxfSzSrtRO/Qn1PzrOFVjaw/OX4mD4/6KNUl0EpQ5saUZASxDBeIHPacclUmU/RMD1jmbBOqNSxJZclWoj2+MCgLaXbcOnmfQ4fn7iuM0+aa+PrPHjSgb81mjf+8pvGObvB+3cTre6oCUME+MjzQmLPVSdrlnf3PlCbXFo0bCZQZizjzht69aww5WjtZuI96ZdN0J0ivOUZo1eH1sXsSi25FBlbP1tWGL0UGWawh1NPN3A5eVkut4qXbqGN+I5ZzM5Kt0DlmvtZV1r2EOkrBiavXpbJJ+3YTJcqixk9gsbJSO62ujQpskyjZUo7ho+C3L9LqrNBt/z60nl2pRwaxSWzaJZoGBqjTczOFCsVPhaYEju/yXSaluaJSL3jVH28nL/cYloa4Va+vTx8C6/vPgLH59Ry4M8SDZG4j+BxkOoMRx5baEeSqzm1oNubjxCB5FOU62XwM61LI9ngb3Z5MWYJLJwr4uFQ6pTLhbYuPj0+PR3yQgyXJ0NflodtyRpWveZWJ8CSJFGMDd6zBM6afPP+j9lb5AYN++ns/PxiNJqM//j94lMCQF2uAXm9cgutejC7jQ6oyAttXJssNlGJalsCe9NtH83RHRAO9jw2UbCxQJ6hsW+qLU4JxCyBhlcC7GfG0xStnTj9BVWdqMNEFUYod9BiPKIsPDg87LP+wJd85MPfY76xuQ6TVpbId4T5Ny4cm6FLF57v89lWG5Tjds2240ncP7chrQLvsaf9OWjU9CEfvE5UwE39oMO85ZFGSEs8knp+QKKHr33H33wbl+i2uzGbGZ33Wg478DQHrdggsBwQy0OIIEe30FmYPiAKo1oM/8VFFAr/ssPTKg1Faq/DYRv3RzpmGS5R6iJH5Zoa4RMhGKoKo51Otazj4bAiU3VcUbbXO9bOS+t03pqIYMmN4FOJ7dThzYRZY8Z9v/YwIQJUZU41o1nSxxeOTfvvx+Nr1tmpIyA0m/Y6vjvgRqH40Rl5jWnDrq79lKjNlpG9rmr0vXRdUwq0BdDPJoGkL4MVTH0CvtMm52Tvw19jaAZqei7hdD1QedJ1RMoTgzODdvGjRvyQOtO789yoLNBY7E9YvS3KnSC3PAkusS7nvi81Y+7/kOAbgLpuRuPnsJBcKLrYp1zVJP8d8EIQuhOIurG7tQ4RxP0/MPdtNtxBVU25xVsj65q2gya9jC0EXUeGtRs34XzBlR/xKZVlSef+7bd5HYwKS78ziGdcWtzhub7l4KaZgw7ZUxe247Fa9e9sgfT51veU/74cehhB4ixN0dfmVndn1CD8Xam5vKCcogGsF5Eus5ofZH0vrqoKEqG+1h1M32YIYF3/A1fcCRw= +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"; + + + + + + + + + + +Get distinct values from field data (query-distinct-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.StatusCodes.json new file mode 100644 index 00000000000..5454dd1d7e7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of distinct values","type":"integer"},"result":{"items":{"properties":{"text":{"description":"The distinct item","type":"string"}},"type":"object","title":"DistinctResultResponse"},"type":"array"}},"type":"object","title":"DistincResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Distinct field data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.api.mdx new file mode 100644 index 00000000000..08244d0dd2d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-saved-query-distinct-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-distinct-values-from-field-data-saved-query-distinct-column-name +title: "Get distinct values from field data (saved-query-distinct-column-name)" +description: "Get distinct values from field data (saved-query-distinct-column-name)" +sidebar_label: "Get distinct values from field data (saved-query-distinct-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV1tv2zYU/ivEwR4cTK6ToQMCFX1Is/S2outiBxsQBS4tHdtsKVIlKTeuoP8+HFI3X4INXYA+ySTP7Tt3V1Bww3N0aCzEtxUIBTEU3K0hAsVzhBhSLctczf0pAoNfSmEwg9iZEiOw6RpzDnEFblsQuXVGqBXUdVRBqpVD5eiVF4UUKXdCq8knqxXd9byF0QUaJ9DSaSmkQ3NEZgRCpbLMcC4yTykc5nZAKJTDFRqibG64MXxL54Kv8Dglvcyt+Hb0uZekF58wdRCBE07SxQrd3KDkDrN5A6WuvY0Qw5cSzbZ34heo78h5ttDKBpS/nJ7S5zt9lOoyMGVoUyMKYoIYZmtkTjsumSrzBRqmlywT1gmVOrbhskQL0REfGLSldDsu3dXn8P4BdZ144uyF93nwoAN/azivvfLrxjmHwft3ES3vtAlDBHjP80LiwFVnPcrbOx+oXSytNWwpUGYs484Levq/wpSjtbuJ96Bfdo3uGOEFzxhVHVoXszdqw6XIWF+2rDB6IzLM4AimAW/AcvZjsdwoXrq1NuIbZjG7KN0alWv0s661HAEyZAxInv5YJO+1Y0tdqixmVASNk5HcbXVpUmSZRsuUdgzvBbn/EFQng7T8+qPz7I1yaBSXzKLZoGFojDYxu1CsVHhfYEro/CXTaVqaByL1klP38XReucW0NMJt/Xj59DVU310Ejq9o5MCfJRoCcRfB/TjVGU69bWEcSa5WNIJurt9BBJIvUPbH4Gc6l0ay8d/s1dWMJbB2rognE6lTLtfauvj89Px8wgsx2ZxNLN9gNvfNedI2rkk1GHF1AixJEsXY+DVL4KLJOh+FmL1AbtCwny4uL6+m0/nsj9+v3icANOsaUz9s3VqrgbHdRWeuyAttXJsyNlGJagcDe95dP1mhG5Ed7DEwRUHSGnmGxj6v9pAlELMEGnQJsJ8ZT1O0du70Z1R1ok4SVRih3Ki19All5OjkZIj9Ld/wqU+FAf6dyz5kWllyQQebf+XCsSW6dO1RPxbmagd43J7ZfmzJAx/b8FYB/cyD/xg4avqQJ54lKlhPE6KzfM8vDZGW+ETq1YhIT575HWC3Wl6h25/PbGl0PhhCbOTBjj3YcUs8DljHhPUEIsjRrXUWthKIwgoXw393FwXH130ovNJQ7I6GAPYxvKNnluEGpS5yVK7pID41gqCqMNrpVMs6nkwqElXHFVVBfSDtsrRO562ICDbcCL6Q2O4kXkzYRJbcT3NvJkSAqsypozRH+vi2siv/9Wz2gXVy6gjIml15Hd4D46ahNdIbeY1pw9588DukNntCjrqq4ffUdU3p0LZHv7kEkL5JVrDwyfhSm5yTvLd/zaBZt6mAwmu/bnnQdUTMc4NLg3b9vUL8CrvUh9vetCzQWBzuX4Mryp1AtzkLLrEu535qNUvwoyX7jlndxKMVdVJILhSp94lXNYVwC7wQZOMZwe+LgWQ1OiCCePhX567NjFuoqgW3eGNkXdN14KQq2bOjm93Qu3TXqM+49X8GKK1lSe++J7Q5HoQKS78ziJdcWjxA22sZXTcb0wl7SGG7SKvtUGdryBBvfUe14NukNyNQXKQp+s7d8h4sJWR/13xeXVF+0ao2iEuXZc0Pkn7UrqoKFKHv1p2ZfgiRgXX9DwSsGdY= +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"; + + + + + + + + + + +Get distinct values from field data (saved-query-distinct-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.StatusCodes.json new file mode 100644 index 00000000000..f060b1aa8f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"function_names":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"DatabaseFunctionNamesResponse"},"example":{"function_names":["string"]}}},"description":"Query result"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.api.mdx new file mode 100644 index 00000000000..b9ee3fbd216 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-function-names-supported-by-a-database.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-function-names-supported-by-a-database +title: "Get function names supported by a database" +description: "Get function names supported by a database" +sidebar_label: "Get function names supported by a database" +hide_title: true +hide_table_of_contents: true +api: eJzFVt9v3DYM/lcEYg8J5sTJ0AGBiz5kWZK2K7Isd0ELxEGqs3lnJ7bkSvT1bob/94GS7fu5hy0D9mSLosjvIymKDVTSyBIJjYXooYFcQQSVpAwCULJEXr1AAAa/1bnBFCIyNQZgkwxLCVEDtKxYK1eEMzTQto+sbSutLFpW+OnkhD+JVoSK+FdWVZEnknKtwmerFctWBiujKzSU+9PTWiWs+MRonCQnLO2aZ0smVzNog14gjZFLaFcCPXnGhCAAyqlgwa+S5ERavOqM37Dtuw40W8KFLCtW3QXw0Dt8bNlFijYxecUaEMEfNZqlMGjrgtjOm5PTV3Av0Vo5wz1cd7htYh4Owr2SNWXa5H9iGonzmjJU1PkXQ1L3MFk/6Jm8+X+Z3GgSU12rNBLjDB12tIQpR1vXJkGRarRCaRK4yC3tIzXYYC8/v6ou/wNGHxShUbIQFs0cjUBjtInEuRK1wkWFCbNzQqGTpDZ/k6krSbLwes65xaQ2OS3dfX7+ThA9PPKlJDlz5dsXPzwGsDhKdIojB843gEKqGUSQ3N99ggAKOcFitfSB5nVtCnH0RVxfjkUMGVEVhWGhE1lk2lJ0dnJ2FsoqD+enYdq5C0/DzasUxiDiOFZCHL0XMZx35ebCH4lfUBo04ofzi4vL0ehp/PtvlzcxQBsMEG+XlGm1BnIQDDDzstKG+lqxsYpV35rEu0F8PEM6YBziNVwCbyFDmaKx75otRjFEIoaOVQziRyGTBK19Iv2Cqo3VYawqkys66BEecwkeHB6uc/4o53Lkcr/Ge0O4SpFWlqkPdOV3mZOYIiWZY/tars0G4ahfi+1cMvOvfTobz3rsSH/1J1r+cATexsqjZt8D4q14dEq6wONCzw5Y9fAtcIFvXotrJNEDFw64sHXF9YCpmCyFFD1DCKBEynQKEcyQg+gewAh2QtFUL+12NDjm7v76+1MbTsneyMI2xE+8LVKcY6GrEhV1ncBl3BtqKqNJJ7poozBs2FQbNUyi3bF2UVvSZW8igLk0uZwUvl31Zvg/xank98nDhABQ1SV3hm7JHws7AX0/Ht+KwU4bAKPZtDfw3QE38i2O9zhsQhvx4ZaNMJdNI3tD1Z132q2bMfo2N+IG7Um6ZtfAxNXalTalZHsfP4+hG1j4XvhdGJq0I90GfPjJ4NSgzf6tkTaAXE21p7OBvq7QWFwfQdZEXDteb37qQ2KplO716Uawf1TLG66H14lwQWFVyFyxC1dcTVfnDyCrnHGc8umVochNflvzTwBcGT71D9A0rHtvirZl8Tcef/i9WVWfuxRpbvk/hWgqC4s7GIc3GA7uupnkUKyiu4m9n/LU0hV5UfMKAnjBpZ9W20cuTteWnHe/cZ4k6Dpkf2TnteeqGhrB9SUnnGegtSAOae9+2PpeOE3jNXyfawd0rtkzwLb9C1ny9IE= +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"; + + + + + + + + + + +Get function names supported by a database + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-menu.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-menu.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-menu.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-menu.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-menu.StatusCodes.json new file mode 100644 index 00000000000..f07ec8f629a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-menu.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"Menu items in a forest like data structure","items":{"properties":{"childs":{"items":{"type":"object"},"type":"array"},"icon":{"description":"Icon name to show for this menu item","type":"string"},"label":{"description":"Pretty name for the menu item","type":"string"},"name":{"description":"The internal menu item name, maps to permission_name","type":"string"},"url":{"description":"The URL for the menu item","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"example":{"result":[{"childs":[],"icon":"string","label":"string","name":"string","url":"string"}]}}},"description":"Get menu data"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-menu.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-menu.api.mdx new file mode 100644 index 00000000000..bde653dd86c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-menu.api.mdx @@ -0,0 +1,60 @@ +--- +id: get-menu +title: "Get menu" +description: "Get the menu data structure. Returns a forest like structure with the menu the user has access to" +sidebar_label: "Get menu" +hide_title: true +hide_table_of_contents: true +api: eJy9Vl1P5DYU/SvWVR9ADQxUfUBZ7QNFlGVLu4gZ1EpkNGsyl4khsbP2zcA0yn+vrp1kMh9dbVupT3Gc6+Nz7mdqmKNLrSpJGQ0xXCEJylAUqCsxlySFI1ulVFk8FndIldVOSPFkLDoSuXrBtYF4VZStT/OicmhFJp2QaYrOCTIQgUVXGu3QQVzDDycn/EiNJtTES1mWuUolExo9O2ZVg0szLCSvSmtKtKTCaYuuyv2pTRm/MgFFWDih9BbfTVUQgbfbxU4zlc/9qjegVYkQg3l8xpSgiboNaa1c8btKA99NNtep0ULLAgUZ4TLzynwEZcoFTzE+9GCOrNILRsvlI+a7cLcWiVYBMADh13HYchdmkqFQmtBqma/Pe9hIFLLkaIkSbaGcU0bPPMoe9Mru4cjg93c338Jv7ca/8+s+C3yTRZnjMAke1jF7mHax6K7pvbneCG5Zv3shPa1pw/fuVkdfGczix5PT/5C9BTonFzjIrK/5ZKC4Pwj3WlaUGav+xHkszivKUFN7v7D4pVIW57BHyvCgv89hWllFK+/H51f257SZRkBywQ71JQXTCFiAh7+eQwwLpBl7BCJ4O0rNHMeepPMoudQLiCG9v7sZ+L99daayKUtIK5uLoz/E1eVEJJARlfFolJtU5plxFJ+dnJ2NZKlGy9MR3zRKQCRJooU4+iASOG9VeEqx+AmlRSu+O7+4uByPZ5NPv1z+lgA0Uc/mdkWZ0QM+/UbPSBWlseTdh45cohPd9Szxvt8+XiAdMA/xjbSjYJyhnKN17+st8gnEIoFWQALi+7Zpzsi8oG4SfZjo0ipNBx2ZY06wg8PDobyPcinHPs4DiRuba8cb7Vhlr0y+SkXiCSnNvLB/IKve0BZ372I7QizycxekOgiceH2fw4mGHyz2XaIDQd+vO3Jb0lsjk+NxbhYHbHr4DjhtC6TMtBkKEZSSMohhgzr7Au0SbcjWUP57FcN29dzwZzHHJeamLFCTCEg+EgGoLq0hk5q8iUejmqGauOa8anbQLipHpuggIlhKq+Rjjt1Q8jChxz5J3+o8TYgAdVVwcbav/HBcpJv4HyaTW9HjNBEwm028Xu8OubFnJfibnzjGiutbBmEtmyB7XdWe99ZNw6HpOs2Y22IQ6ftNDY8+MX42tpCM9/H3CcfIm0Hcfl0PEC+6ifjwzOKTRZf9WxAe3frJ7M6xcVWidT6FSBF33+EW506wW54GlzgqpO/57XDpJsa2WwYz43/552rVEr7RqMyl0oPJHWrjAWSpWNMpcPV4ypxKIVceoK4fpcN7mzcNb3+p0K7CoO3S1U+MCEIP8CX1giuI4TxN0XeepcwrP9a3Z+RGwV5dcsB4Og0GYx+2dsHo3U+CXg2w6zpYhKbCtRZI+CYapvpf3ZbBJg== +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"; + + + + + + + + + + +Get the menu data structure. Returns a forest like structure with the menu the user has access to + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.api.mdx new file mode 100644 index 00000000000..c823d25841f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-tag-api-endpoints.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-metadata-information-about-tag-api-endpoints +title: "Get metadata information about tag API endpoints" +description: "Get metadata information about this API resource" +sidebar_label: "Get metadata information about tag API endpoints" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/ivEYR8STI2bYgMCFf2QBmmbrduCxV0HRIFLS2ebDUWq5MmNK+i/D0dKjmU7LdoN6D5JIu+Oz3NvPDVQoM+dqkhZAym8RBIlkiwkSaHMzLpS8paQU1uToIXy4vTyQjj0tnY5QgKVdLJEQuchvW4gt4bQEKQNyKrSKg/6o/ee7Tfg8wWWkt8qZyt0pNAH2aKY5FbXpek/FetJfTkQGypVco78pFWFkIIyhHN00CZhZ+LVp73bbdIv2el7zAn2LWCh6P+F6BZX4QxFWIYXNHUJ6fXAd1vAE5gpHWKTQIWuVN4rG9ZZiRRp7FX6D2MNws36fE9OmfkGIOmcXO2BnEC0kMIcacK5M+mC3bKw4vT6UKNb8RmyZMEP0N4k4NBX1vjowCePH/Pjv8miLwZ1R6D31o7lqDSJwDdiMJTqt4dFNV6giIYFCxyJt0prMUVBThqvJWEhpisxlVPUsMfxfIIk6z5rOQpxqd7iSpAVtUdhjdDKk7hPgi3jn0m8h+LcDjNpL6baoxMbUmJm3d7msfbj12YbB/NOlpXG3bjvBnoY2UEsr5v2ZpvSdY/jJqTukN8FYSlmzpbiN1ugZiQ//aukLdH7Ydv4XHQ2WK8V4bkshMMPNXpKxYVZSq0Kcd+YReXsUhVYwB4+G7qRy/H35fLGyJoW1qlPWKTitKYFGurOD0CV209kUzEwefLkezOpnM35c6pRMAtapeIvDk5kg85Zt4/Kma11IYwl0VnotPmon793sl0YQmekFh7dEl1kkYpTI2qDdxXm3M/CorB5XrsHwvVCktRrFyTgMa8dc+Qp4v1HgvT6hq8HkvNQkmN+3iRw9yi3BV4FYHHk0NLMIYX8zZ+vIQEd2uj6s2s1KeS10+LR3+Ll+VhksCCq0tFI21zqhfWUnjw+ORnJSo2WxyOS81G4wTIQWZYZIR69EhmcdukVPJ2K5ygdOvHD6dnZ+dXVZPzHr+e/ZwBtskZ0uaKFNRuY1gtrVKqsrKO+AH1mMtPfh+LZevlojnTAOMRXQE+iwgJlgc4/a7YIZJCKDDoSGYgfhcw51SZkb9G0mTnMTOWUoYMe0BEn18Hh4SbFX+RSXoWobtAcLN4HwBrPTNfs5EepSMyQ8kUg95XUmgG/tP8W25Fiou/6YDWR5DhwfBc1Wn4w4aeZiSDD+NsD3KLfCVmNR9rOD1j08GkYZEqkhS3iABQGY1pACjvw2SehcmL21o5dtpc5bNfMa94WBS5R26pEQ10NhohEQ03lLNnc6jYdjRo21aYN51i7Y+2s9mTL3kQCS+kUt6p+sAlm4gU/k7WmDiYPjN3k2X3yI9Tm0P6r8fhSrO20CTCaob013x1wV7G58B5f1MI6cXEZhg/rtozsdVWnH6TblsPTN5grbo2RZGgzDUxDcrwIPzucvm/HHKMgBmm3ez87BdJtwsoThzOHfvGtRsJcPLO7Q9RVXaHzuDlVbyxx7kS55XF0iadSmvsJ9Iv/cXIeJjE0RWWVIb/tvo375Vv+CTuShHc0qrRUhlGG/Gy6srgGWSmmcgyhxUMCsThu+jS5hqaZSo9vnG5bXo4/D1wyD0J96OhbXIXfDc5xXfN+KNg+4cNVk0DsJOGEqHCa5xh6WK+1c9MOyv7lOYech5CN63Ud+O6FrfezrVlt2G6aKBFbE1drBBHaMbQ8iv4DO31wXg== +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.api.mdx new file mode 100644 index 00000000000..410c6ada3f4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-annotation-layer-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-metadata-information-about-this-api-resource-annotation-layer-info +title: "Get metadata information about this API resource (annotation-layer--info)" +description: "Get metadata information about this API resource" +sidebar_label: "Get metadata information about this API resource (annotation-layer--info)" +hide_title: true +hide_table_of_contents: true +api: eJzNV1Fv2zYQ/isHYg8JpsRNsQGBij64Qdpm67ZgdtcBVuDS0tlmQ5EqSblxBf334UhJkWwnQ9sB3ZMk8u543913x1PFMrSpEYUTWrGYvUIHOTqeccdBqKU2Oact4AtdOnBrYWF8fQUGrS5NiixiBTc8R4fGsnhWsVQrh8qxuGK8KKRIvf7ogyX7FbPpGnNOb4XRBRon0HrZLJunWpa5aj8F6XF5PRAbKhV8hfR02wJZzIRyuELD6sjvzK34fHC7jtolvfiAqWOHFjAT7v/l0S1u/RnCYe5fUJU5i2eD2O04HrGlkD43ESvQ5MJaof06KTnhJLYq7YfSCtlNd751RqhVzyFuDN8ecDliwULMVujmxJ15k+yahAXR62OJZktn8JwEP7L6JmIGbaGVDQF8+uQJPf4bFv1rUvcE2mjtWQ5K8+B4LwdDqXZ7WFTTNUIwDCRwCu+ElLBAcIYrK7nDDBZbWPAFSnYg8HQCd9o8ajkIUane4hachtIiaAVSWAf3JNgx/gjxHspzPWTSQZ9KiwZ6UrDU5mDz6OL4pWyjZN7xvJC4n/f9RA8zO8jlrKpvdiHNWj9uPHWH+K4c5rA0OoffdIaSPPnpm0ibo7XDtvFYdnqoO0X2gmdg8GOJ1sVwpTZcigzuGzMURm9Ehhk7gKenG7CcfV8sbxUv3Vob8RmzGMalW6NyzfneUWEOA+kreiRPn35vJIXRKX0uJAKhcNsY/qLkBDRojDaHoFzoUmagtIPGQqNNR/38vcl2pRwaxSVYNBs0AUUMYwWlwrsCU+pnfhF0mpbmgXS95I7LLgQRs5iWhjDSFPHhk2Px7IauB8dXviTHSmkX4vaGb6mUbyJ2d5LqDCfeyzB/SK5WLGbp2z/fsIhJ31O7z6bvxCwtjYSTv+HV5RQStnauiEcjqVMu19q6+PzJ+fmIF2K0ORvx7ty5pHNH/m5LGCRJogBOXkPCxg3xvFgML5AbNPDD+OLicjKZT//49fL3hLE66ty73rq1Vj0Hu4XORZEX2ri2NG2iEtXelPC8Wz5doTsiP+BrcURBe408Q2OfVztoEhZDwhpECYMfgafEyLnTt6jqRB0nqjBCuaPWu1Pi4NHxcR/vL3zDJz75PcyDxfvUaGUJdgeVf+LCwRJduvZIvwVnNQAbt9+wm0NC/b5NYxUQTz3g90Gjpgehf5ao4LEfmVtvd2LRCGmJp1Kvjkj0+JkffnJ0a52FockP027NYvY4FoqWL73A+NJQMA/GhO0W3Rvahgw3KHWRo3JNEftcBUNVYbTTqZZ1PBpVZKqOK6JivWftorRO562JiG24EdTr2snImwkTwpKX0jVu0sTZjK7NJz18PQ/tv55Or6GzU0eMvBna6/DuOTcJ3Yn26KYHbeDq2k8v2uwYORiqRt9L1zXlqu1QE+qtAaTvUxVbeKa89H9LROx3U8qRF2Nxs3s/fHnQdUTKc4NLg3b9tUb8YL3U+1PYpCzQWOyP5b0l4k6Q25yFkFiXc3U/wn7xjyAc3XP1xHP15ITUjnfj2ru5vuZvs0Hv8M6NCsmFIvc9caumeGaMF4IwntFfzk4BsYiFErppyTRjVbXgFt8aWde0HP5RqLAe9PshP25x6/9qqBJkSfu+xtuy8DdaxELz8ScEhXGaou+BrdbehT7oFK8uiRg06/Ru8Y4ezQtZb0dote3ZrqogEboZ1XRwwrdzVtPE+w9RoZnt +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.api.mdx new file mode 100644 index 00000000000..7f59ee69387 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-chart-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-metadata-information-about-this-api-resource-chart-info +title: "Get metadata information about this API resource (chart--info)" +description: "Get metadata information about this API resource" +sidebar_label: "Get metadata information about this API resource (chart--info)" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/isHYh8STImbYgMKFf2QBmmbvQazuw6wApeWzhYbilRJyo0r6L8PR0qKZDsd0g3oPkki747Pc2881SxDmxpROqEVi9lrdFCg4xl3HIRaaVNw2gK+1JUDlwsL59dXYNDqyqTIIlZywwt0aCyL5zVLtXKoHItrxstSitTrTz5Ysl8zm+ZYcHorjS7ROIHWy2bZItWyKlT3KUiPy+uR2Fip5Gukp9uWyGImlMM1GtZEfmdhxeeD203ULenlB0wdO7SAmXD/L0S3uPVnCIeFf0FVFSyej3y3AzxiKyF9bCJWoimEtUL7dVJywknsVLoPpRWym/5864xQ6wEgbgzfHoAcsWAhZmt0C8qdRRvshoQFpdfHCs2WzuAFCX5kzU3EDNpSKxsc+PTJE3r8N1n0j0HdE+i8tWc5KC0C8EEMxlLd9rioZjlCMAwkcArvhJSwRHCGKyu5wwyWW1jyJUp2wPF0AnfafNFyEKJSvcUtOA2VRdAKpLAO7pNgx/gXEu+hODfjTDqIqbJoYCAFK20ONo/ej4/NNgrmHS9Kiftx3w/0OLKjWM7r5maX0rzDceNTd8zvymEBK6ML+FVnKAnJD/8qaQu0dtw2vhSdAetekb3kGRj8WKF1MVypDZcig/vGDKXRG5Fhxg7wGegGLmfflstbxSuXayM+YxbDeeVyVK493wMV5jCRoaJn8vTpt2ZSGp3S51IiEAu3jeFPCk5gg8Zoc4jKha5kBko7aC202nTUj9862a6UQ6O4BItmgyawiOFcQaXwrsSU+plfBJ2mlXkgXK+447J3QcQsppUhjjRFfPjkWDy/oevB8bUvyYucG2fpZro7SXWGUw8tDB2SqzWLWfr2j19YxKRvpP1n22xillZGwslf8PpyBgnLnSvjyUTqlMtcWxc/e/Ls2YSXYrI5m6R02MTfYgmDJEkUwMkbSNh5m2Le2zG8RG7QwHfnFxeX0+li9vvPl78ljDVRj+l663KtBqj6hR6XKEptXFeENlGJ6u5EeNEvn67RHREOeBT4KKjkyDM09kW9QyFhMSSspZEw+B54Sgm3cPoWVZOo40SVRih31EE6pRQ7Oj4ekvyJb/jUx3ZAdLR4HwStLHHt+fFPXDhYoUtzT+/R5OoRw7j7ht1oEdX3XcDqQHPmWb4PGg09iPLzRAWYfgzuIO44oBXSEk+lXh+R6PFzP9AU6HKdhUHID8guZzE7QID84msoZHFlyG0H2bPd6vmFtiHDDUpdFqhcW40+KsFQXRrtdKplE08mNZlq4poyrdmzdlFZp4vORMQ23AhqWt2I482Eq37FK+lamDQ6tjNo+0kPX6Nj+29ms2vo7TQRIzRjez3fPXDT0GZoj65s0Aaurv0Yos2OkYOuavW9dNNQgLpWM6UmGUj6hlOzpU+PV/63h1L43Yxi5MVY3O7eT1GedBOR8sLgyqDNv9aIn5BXen+cmlYlGovD+XqwRLkT5DZnwSXWFVzdz6KP/qODI5+gJycke7zrzMG98zX/ii1lh3duUkouFGH22Vq3ZTJnvBRE7IxFzCNhEQvFctOlzZzV9ZJbfGtk09By+K2gEnoQ7EOH3+LW/4hQzsuK9n0JdwXgL6GIhd7iTwgK52mKvq91Wnt38KgRvL6kFKDxZHDx9onQvpD1bupV24Htug4SoVlR9QYQvkWzhobUvwGyYHn7 +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.api.mdx new file mode 100644 index 00000000000..dd78a0bf3e6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-css-template-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-metadata-information-about-this-api-resource-css-template-info +title: "Get metadata information about this API resource (css-template--info)" +description: "Get metadata information about this API resource" +sidebar_label: "Get metadata information about this API resource (css-template--info)" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/isHYh8STImbYgMKFf2QBmmbvQazuw6wApeWzhYbilRJyo0r6L8PR0qKZDsdmg3oPkki747Pc2881SxDmxpROqEVi9lrdFCg4xl3HIRaaVNw2gK+1JUDlwsL59dXYNDqyqTIIlZywwt0aCyL5zVLtXKoHItrxstSitTrTz5Ysl8zm+ZYcHorjS7ROIHWy2bZItWyKlT3KUiPy+uR2Fip5Gukp9uWyGImlMM1GtZEfmdhxeeD203ULenlB0wdO7SAmXD/L0S3uPVnCIeFf0FVFSyej3y3AzxiKyF9bCJWoimEtUL7dVJywknsVLoPpRWym/5864xQ6wEgbgzfHoAcsWAhZmt0C8qdRRvshoQFpdfHCs2WzuAFCX5kzU3EDNpSKxsc+PTJE3r8N1n0j0HdE+i8tWc5KC0C8EEMxlLd9rioZjlCMAwkcArvhJSwRHCGKyu5wwyWW1jyJUp2wPF0AnfafNFyEKJSvcUtOA2VRdAKpLAO7pNgx/gXEu+hODfjTDqIqbJoYCAFK20ONo/ej1+bbRTMO16UEvfjvh/ocWRHsZzXzc0upXmH48an7pjflcMCVkYX8KvOUBKSH/5V0hZo7bhtfCk6A9a9InvJMzD4sULrYrhSGy5FBveNGUqjNyLDjB3gM9ANXM6+LZe3ilcu10Z8xiyG88rlqFx7vgcqzGEiQ0XP5OnTb82kNDqlz6VEIBZuG8OfFJzABo3R5hCVC13JDJR20FpotemoH791sl0ph0ZxCRbNBk1gEcO5gkrhXYkp9TO/CDpNK/NAuF5xx2XvgohZTCtDHGmK+PDJsXh+Q9eD42tfkhfTKcywKKlfWrqg7k5SneHUIwyzh+RqzWKWvv3jFxYx6ftp/9n2nJillZFw8he8vpxBwnLnyngykTrlMtfWxc+ePHs24aWYbM4mqbUL15458XdawiBJEgVw8gYSdt4mnPd9DC+RGzTw3fnFxeV0upj9/vPlbwljTdRDu966XKsBuH6hhyeKUhvXlaRNVKK6GxJe9Muna3RHhAMewyEKmjnyDI19Ue8wSVgMCWvZJAy+B55SFi6cvkXVJOo4UaURyh11yE4p746Oj4dcf+IbPvUBH/AdLd6HRCtLlHua/BMXDlbo0tyzfCzHekQ07r5hN3bE+H0XvjqwnXmy74NGQw9i/jxRAa0fkTukO35ohbTEU6nXRyR6/NwPOwW6XGdhSPLDs8tZzB7mQV7yZRYyvDLkxIO+YLsF9gttQ4YblLosULm2YH2MgqG6NNrpVMsmnkxqMtXENaVfs2ftorJOF52JiG24EdTXuinImwnTwIpX0rUwabpsx9T2kx6+fsf238xm19DbaSJGaMb2er574KahE9Ee3eqgDVxd+0lFmx0jB13V6nvppqE4dd1oSn00kPQ9qWZLnyWv/J8RJfS7GcXIi7G43b0ftDzpJiLlhcGVQZs/1ogfold6f+KaViUai8MRfLBEuRPkNmfBJdYVXN2Pq1/90wdHqbUnXZ6enJDK8a5PBzfUY/4qW+YO79yklFwogu6Ttm6LZs54KYjfGYvYsHBYxELp3HRJNGd1veQW3xrZNLQc/kOooB7E/BCGW9z6PxeqAFnRvq/rrhz8rRWx0HD8CUHhPE3R97xOa+/SHnWH15eUEDTPDG7qPi3aF7LejclqO7Bd10EidDCq5QDCt2/W0FT7N1pZjcg= +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.api.mdx new file mode 100644 index 00000000000..14a8dadf6cf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dashboard-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-metadata-information-about-this-api-resource-dashboard-info +title: "Get metadata information about this API resource (dashboard--info)" +description: "Get metadata information about this API resource" +sidebar_label: "Get metadata information about this API resource (dashboard--info)" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/isHYh8STImbYgMKFf2QZmmbrduC2V0HWIFLS2eLDUWqJOXGFfTfhyMlRbKdDu0GdJ8kkXfH57k3nmqWoU2NKJ3QisXsJToo0PGMOw5CrbQpOG0BX+rKgcuFhfPrKzBodWVSZBErueEFOjSWxfOapVo5VI7FNeNlKUXq9SfvLdmvmU1zLDi9lUaXaJxA62WzbJFqWRWq+xSkx+X1SGysVPI10tNtS2QxE8rhGg1rIr+zsOLTwe0m6pb08j2mjh1awEy4/xeiW9z6M4TDwr+gqgoWz0e+2wEesZWQPjYRK9EUwlqh/TopOeEkdirdh9IK2U1/vnVGqPUAEDeGbw9AjliwELM1ugXlzqINdkPCgtLrQ4VmS2fwggQ/sOYmYgZtqZUNDnz86BE9/pss+seg7gl03tqzHJQWAfggBmOpbntcVLMcIRgGEjiFt0JKWCI4w5WV3GEGyy0s+RIlO+B4OoE7bT5rOQhRqd7iFpyGyiJoBVJYB/dJsGP8M4n3UJybcSYdxFRZNDCQgpU2B5tH78cvzTYK5h0vSon7cd8P9Diyo1jO6+Zml9K8w3HjU3fM78phASujC/hVZygJyQ//KmkLtHbcNj4XnQHrXpE95xkY/FChdTFcqQ2XIoP7xgyl0RuRYcYO8BnoBi5n35bLG8Url2sjPmEWw3nlclSuPd8DFeYwkaGiZ/L48bdmUhqd0udSIhALt43hTwpOYIPGaHOIyoWuZAZKO2gttNp01I/fOtmulEOjuASLZoMmsIjhXEGl8K7ElPqZXwSdppV5IFwvuOOyd0HELKaVIY40Rbz/6Fg8v6HrwfG1L8mfuM2XmpvM0u10d5LqDKceXhg8JFdrFrP0zR+vWcSkb6b9Z9twYpZWRsLJX/DycgYJy50r48lE6pTLXFsXP3n05MmEl2KyOZtk3YETf5slDJIkUQAnryBh522qea/H8By5QQPfnV9cXE6ni9nvv1z+ljDWRD2u663LtRog6xd6bKIotXFdMdpEJaq7G+FZv3y6RndEOOCLCURBLUeeobHP6h0aCYshYS2VhMH3wFNKvoXTt6iaRB0nqjRCuaMO1iml29Hx8ZDoz3zDpz7OA7KjxftgaGWJb8+Rf+TCwQpdmnuKX0WwHrGMu2/YjRrRfdcFrg5UZ57pu6DR0INoP01UgOrH4g7mjhNaIS3xVOr1EYkeP/UDToEu11kYjPzA7HIWswdIkH98XYWsrgy576AX2G5FvaZtyHCDUpcFKtdWqI9OMFSXRjudatnEk0lNppq4pqxr9qxdVNbpojMRsQ03ghpZN/Z4M+H6X/FKuhYmjZPtXNp+0sPX7Nj+q9nsGno7TcQIzdhez3cP3DS0Htqjaxy0gatrP5pos2PkoKtafS/dNBSkrv1MqXEGkr4J1WzpU+SF/xWiVH47oxh5MRa3u/eTlSfdRKS8MLgyaPOvNeKn5pXeH7GmVYnG4nDmHixR7gS5zVlwiXUFV/fz6Rf/5cFRn6QnJyR/vOvQwX30Nf+QLW2Hd25SSi4U4fYZW7flMme8FETujI7u0LCIhaK56dJnzup6yS2+MbJpaDn8clApPQj4IQC3uPU/KZT7sqJ9X85dIfgLKmKhz/gTgsJ5mqLvc53W3v08agovLykVaHQZXMp9QrQvZL2biNV2YLuug0RoXFTFAYRv2ayhAfZv8UeFFQ== +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.api.mdx new file mode 100644 index 00000000000..ff601913ab5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-database-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-metadata-information-about-this-api-resource-database-info +title: "Get metadata information about this API resource (database--info)" +description: "Get metadata information about this API resource" +sidebar_label: "Get metadata information about this API resource (database--info)" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/isHYh8STImbYgMKFf2QZmmbrduCOV0HRIFLS2ebDUWq5MmNK+i/D0dKjmU7HdoN6D5JIu+Oz3NvPDWiQJ87VZGyRqTiJRKUSLKQJEGZmXWl5C2QU1sT0EJ5OL28AIfe1i5HkYhKOlkiofMivW5Ebg2hIZE2QlaVVnnQH733bL8RPl9gKfmtcrZCRwp9kC2KSW51XZr+U7Ge1JcDsaFSJefIT1pVKFKhDOEcnWiTsDPx6tPe7Tbpl+z0PeYk9i1goej/hegWV+EMRViGFzR1KdLrge+2gCdipnSITSIqdKXyXtmwzkqkSGOv0n8Ya1DcrM/35JSZbwCSzsnVHsiJiBZSMUeacO5MumC3LKw4vT7U6FZ8hixZ8INobxLh0FfW+OjAx48e8eO/yaJ/DOqOQO+tHctRaRKBb8RgKNVvD4vqaoEQDQMLHMNbpTVMEchJ47UkLGC6gqmcohZ7HM8nSLLus5ajEJfqLa6ALNQewRrQyhPcJ8GW8c8k3kNxboeZtBdT7dHBhhTMrNvbPNZ+/NJs42DeybLSuBv33UAPIzuI5XXT3mxTuu5x3ITUHfK7ICxh5mwJv9oCNSP54V8lbYneD9vG56KzwXqtKJ7LAhx+qNFTChdmKbUq4L4xQ+XsUhVYiD18NnQjl5Nvy+WNkTUtrFOfsEjhtKYFGurOD0CV209kUzEwefz4WzOpnM35c6oRmAWtUviTgxPZoHPW7aNyZmtdgLEEnYVOm4/68Vsn24UhdEZq8OiW6CKLFE4N1AbvKsy5n4VFsHleuwfC9UKS1GsXJMJjXjvmyFPE+48k0usbvh5IzkNJ/iRJTqUPd9PdUW4LHAdwcezQ0sxFKvI3f7wWidChla4/u3aTirx2Go7+gpfnV5CJBVGVjkba5lIvrKf0yaMnT0ayUqPlyajojhuFqywTkGWZATh6BZk47fIsuDyF5ygdOvju9OzsfDyeXP3+y/lvmRBtsoZ1uaKFNRvA1gtraKqsrKO+En1mMtNfjPBsvXw8RzpgHPCl+JOotUBZoPPPmi0WmUghEx2TTMD3IHNOvAnZWzRtZg4zUzll6KBHdcypdnB4uMnzZ7mU4xDjDa6DxftQWOOZ7pqi/CgVwQwpXwSGX8OvGZBM+2/YjhmzfdeHrYlMrwLRd1Gj5QezfpqZiDRMxD3KLR90QlbjsbbzAxY9fBpmmxJpYYs4E4VZmRYiFfs5sHdCRcWMrh07b68PxHYtveZtKHCJ2lYlGupqM8QmGmoqZ8nmVrfpaNSwqTZtOOXaHWtntSdb9iYSsZROcQvrB55gJl78M1lr6mDyINlNpN0nPzzX69D+q6urS1jbaRPBaIb21nx3wI1j0+E9vsDBOri4DEOJdVtG9rqq0w/Sbcsx6hvPmFtmJBnaTyOmIUNehJ8gTuS3VxyjICbSbvd+pgqk24SVJw5nDv3ia42EeXlmd4ercV2h87g5bW8sce5EueVJdImnUpr7yfSL/+/goM/RoyMWP9z258ZF9DU/jx1rwjsaVVoqw7BDwjZdsVwLWSnmdsJH93dAImLJ3PTJcy2ahnfeON22vBx/NbiQHsT70Pm3uAo/J5z5uub9UMt9GYSLKRGxyYQTosJpnmPocb3Wzr086AgvzzkReGTZuIzX6dC9sPV+EjarDdtNEyVi1+IajiBCuxYtD65/A4SDgX0= +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.api.mdx new file mode 100644 index 00000000000..41880bc931c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-dataset-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-metadata-information-about-this-api-resource-dataset-info +title: "Get metadata information about this API resource (dataset--info)" +description: "Get metadata information about this API resource" +sidebar_label: "Get metadata information about this API resource (dataset--info)" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/isHYh8STImbYgMKFf2QZmmbrduCOV0HRIFLS2ebDUWq5MmNK+i/D0dKjmU7HdoN6D5JIu+Oz3NvPDWiQJ87VZGyRqTiJRKUSLKQJEGZmXWl5C2QU1sT0EJ5OL28AIfe1i5HkYhKOlkiofMivW5Ebg2hIZE2QlaVVnnQH733bL8RPl9gKfmtcrZCRwp9kC2KSW51XZr+U7Ge1JcDsaFSJefIT1pVKFKhDOEcnWiTsDPx6tPe7Tbpl+z0PeYk9i1goej/hegWV+EMRViGFzR1KdLrge+2gCdipnSITSIqdKXyXtmwzkqkSGOv0n8Ya1DcrM/35JSZbwCSzsnVHsiJiBZSMUeacO5MumC3LKw4vT7U6FZ8hixZ8INobxLh0FfW+OjAx48e8eO/yaJ/DOqOQO+tHctRaRKBb8RgKNVvD4vqaoEQDQMLHMNbpTVMEchJ47UkLGC6gqmcohZ7HM8nSLLus5ajEJfqLa6ALNQewRrQyhPcJ8GW8c8k3kNxboeZtBdT7dHBhhTMrNvbPNZ+/NJs42DeybLSuBv33UAPIzuI5XXT3mxTuu5x3ITUHfK7ICxh5mwJv9oCNSP54V8lbYneD9vG56KzwXqtKJ7LAhx+qNFTChdmKbUq4L4xQ+XsUhVYiD18NnQjl5Nvy+WNkTUtrFOfsEjhtKYFGurOD0CV209kUzEwefz4WzOpnM35c6oRmAWtUviTgxPZoHPW7aNyZmtdgLEEnYVOm4/68Vsn24UhdEZq8OiW6CKLFE4N1AbvKsy5n4VFsHleuwfC9UKS1GsXJMJjXjvmyFPE+48k0usbvh5IzkNJ/iRJeiTPd9PdUW4LHAdwcezQ0sxFKvI3f7wWidChla4/u3aTirx2Go7+gpfnV5CJBVGVjkba5lIvrKf0yaMnT0ayUqPlyaiIx43CTZYJyLLMABy9gkycdmkWPJ7Cc5QOHXx3enZ2Ph5Prn7/5fy3TIg2WaO6XNHCmg1c64U1MlVW1lFfiD4zmenvRXi2Xj6eIx0wDvhC+ElUWqAs0PlnzRaJTKSQiY5IJuB7kDmn3YTsLZo2M4eZqZwydNCDOuZEOzg83KT5s1zKcYjwBtXB4n0grPHMds1QfpSKYIaULwLBr6DXDDim/TdsR4zJvuuD1kSiV4Hnu6jR8oNJP81MBBrG4R7klgs6IavxWNv5AYsePg2DTYm0sEUciMKgTAuRir0U2DehmmI2145dt9cDYruOXvM2FLhEbasSDXV1GSITDTWVs2Rzq9t0NGrYVJs2nG/tjrWz2pMtexOJWEqnuH31w04wEy/9maw1dTB5iOym0e6TH6FWh/ZfXV1dwtpOmwhGM7S35rsDbhwbDu/x5Q3WwcVlGEis2zKy11WdfpBuWw5R33TG3C4jydB6GjENCfIi/ABxGr+94hgFMZF2u/fzVCDdJqw8cThz6BdfayTMyjO7O1iN6wqdx81Je2OJcyfKLU+iSzyV0txPpV/8bwcHXYoeHbH04bY7N+6gr/lv7EgT3tGo0lIZRh3ytelK5VrISjG1Ez46YhGJiAVz06fOtWiaqfT4xum25eX4k8Fl9CDch46/xVX4LeG81zXvh0LuiyBcSYmIHSacEBVO8xxDf+u1dm7kQTt4ec5pwMPKxjW8Tobuha33M7BZbdhumigRWxZXcAQRWrVoeWT9G0wBf8c= +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.api.mdx new file mode 100644 index 00000000000..7415777fbef --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-report-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-metadata-information-about-this-api-resource-report-info +title: "Get metadata information about this API resource (report--info)" +description: "Get metadata information about this API resource" +sidebar_label: "Get metadata information about this API resource (report--info)" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/isHYh8STImbYgMCFf2QBmmarduC2l0HWIFLS2eLDUWqJOXGFfTfhyMlR7KdDukGZJ8kkXfH57k3nmqWoU2NKJ3QisXsEh0U6HjGHQehFtoUnLaAz3XlwOXCwtn1FRi0ujIpsoiV3PACHRrL4mnNUq0cKsfimvGylCL1+qNPluzXzKY5FpzeSqNLNE6g9bJZNku1rArVfQrS4/J6IDZUKvkS6enWJbKYCeVwiYY1kd+ZWfF173YTdUt6/glTx/YtYCbc/wvRLa79GcJh4V9QVQWLpwPfbQGP2EJIH5uIlWgKYa3Qfp2UnHASO5XuQ2mF7GZzvnVGqGUPEDeGr/dAjliwELMluhnlzqwNdkPCgtLrc4VmTWfwggQ/s+YmYgZtqZUNDnz+7Bk9/pss+seg7gh03tqxHJRmAXgvBkOpbntYVJMcIRgGEjiGD0JKmCM4w5WV3GEG8zXM+Rwl2+N4OoE7bb5pOQhRqd7iGpyGyiJoBVJYB/dJsGX8G4n3UJybYSbtxVRZNNCTgoU2e5vHxo+PzTYK5h0vSom7cd8N9DCyg1hO6+Zmm9K0w3HjU3fI78phAQujC/hNZygJyU//KmkLtHbYNr4VnR7rjSJ7xTMw+LlC62K4UisuRQb3jRlKo1ciw4zt4dPTDVxOnpbLe8Url2sjvmIWw1nlclSuPd8DFWY/kb6iZ/L8+VMzKY1O6XMuEYiFW8fwJwUnsEFjtNlH5VxXMgOlHbQWWm066uenTrYr5dAoLsGiWaEJLGI4U1ApvCsxpX7mF0GnaWUeCNdr7rjcuCBiFtPKEEeaIj59cSye3tD14PjSl+Q7LLVxME5zzCqJlu6ou6NUZzj2IMP4Iblaspil79+9ZRGTvqVuPtu2E7O0MhKO/oLLiwkkLHeujEcjqVMuc21dfPrs9HTESzFanYyMP3bkL7SEQZIkCuDoDSTsrM027/gYXiE3aOCHs/Pzi/F4Nvnj14vfE8aaaAPqeu1yrXqwNgsbYKLwJNt6tIlKVHc9wsvN8vES3QHhgMehj4JOjjxDY1/WWxwSFkPCWh4Jgx+Bp5R8M6dvUTWJOkxUaYRyBx2mY0q3g8PDPstf+IqPfZx7TAeL92HQyhLZDUH+hQsHC3Rp7vk9nl09oBh337AdL+L6sQtZHXhOPM2PQaOhB3F+kaiA08/EHcYtD7RCWuKx1MsDEj184aebAl2uszAV+WnZ5Sxm+xiQZ3xFhUyuDDluL3+2XUtvaRsyXKHUZYHKtbXp4xIM1aXRTqdaNvFoVJOpJq7p8GbH2nllnS46ExFbcSOohXUDjzcTLv4Fr6RrYdIg2U6k7Sc9fJ0O7b+ZTK5hY6eJGKEZ2tvw3QE3Dk2H9ugCB23g6toPJdpsGdnrqlbfSzcNRahrPNRZikDSt5+azX1+vPY/QZTEHyYUIy/G4nb3fqbypJuIlGcGFwZt/r1G/Ly80LvD1bgq0VjsT9u9JcqdILc6CS6xruDqfjJ99P8dHIQMPToi4cNtb/auoe/5dWw5O7xzo1JyoQi0T9e6LZQp46UgZieMfhR81CIWyuWmS5wpq+s5t/jeyKah5fCbQUX0INqHTr/Ftf8xoayXFe37Ku5KwF9KEQvtxZ8QFM7SFH1v67R27uRBL7i8oCSgcaV3EW9SoX0h690UrNY923UdJEK/ovoNIHybZg0NrX8DuHaBDg== +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.api.mdx new file mode 100644 index 00000000000..064f1dc9f90 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-metadata-information-about-this-api-resource-rowlevelsecurity-info +title: "Get metadata information about this API resource (rowlevelsecurity--info)" +description: "Get metadata information about this API resource" +sidebar_label: "Get metadata information about this API resource (rowlevelsecurity--info)" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/isHYh8STImbYgMKFf2QBmmXrduC2l0HWIZLS2ebDUWqJOXEFfTfhyMlRbKdDG0HdJ8kkXfH57k3niqWoU2NKJzQisXsNTrI0fGMOw5CLbXJOW0BX+jSgVsLC+fXV2DQ6tKkyCJWcMNzdGgsi6cVS7VyqByLK8aLQorU648+WrJfMZuuMef0VhhdoHECrZfNsnmqZZmr9lOQHpfXA7GhUsFXSE+3LZDFTCiHKzSsjvzO3IrPB7frqF3Si4+YOnZoATPh/l+IbnDrzxAOc/+CqsxZPB34bgd4xJZC+thErECTC2uF9uuk5IST2Kq0H0orZLPufOuMUKseIG4M3x6AHLFgIWYrdHPKnXkT7JqEBaXXpxLNls7gOQl+YvUsYgZtoZUNDnz65Ak9/pss+teg7gm03tqzHJTmAXgvBkOpdntYVJM1QjAMJHAK74WUsEBwhisrucMMFltY8AVKdsDxdAJ32jxqOQhRqd7gFpyG0iJoBVJYB/dJsGP8kcR7KM71MJMOYiotGuhJwVKbg82j8+OXZhsF847nhcT9uO8HehjZQSynVT3bpTRtccx86g75XTnMYWl0Dr/rDCUh+embkjZHa4dt47Ho9Fh3iuwlz8DgpxKti+FKbbgUGdw3ZiiM3ogMM3aAT083cDn7vlzeKV66tTbiM2YxnJdujco153ugwhwm0lf0TJ4+/d5MCqNT+lxIBGLhtjH8RcEJbNAYbQ5RudClzEBpB42FRpuO+vl7J9uVcmgUl2DRbNAEFjGcKygV3hWYUj/zi6DTtDQPhOsVd1x2LoiYxbQ0xJGmiI+3jsXTGV0Pjq98Sb7Vt/AGNyhh3ErOInZ3kuoMxx5mGEAkVysWs/Td2zcsYtI31e6zaTwxS0sj4eRveH05gYStnSvi0UjqlMu1ti5+9uTZsxEvxGhzNjL6VtK5LcCRv9wSBkmSKICTXyBh503m+SDE8BK5QQM/nF9cXI7H88mfv13+kTBWRx28661ba9UD2C10EEVeaOPa2rSJSlR7VcKLbvl0he6IcMDX8oiC9hp5hsa+qHbYJCyGhDWMEgY/Ak8pJedO36CqE3WcqMII5Y5adKeUhEfHx32+v/INH/vo9zgPFu9Do5Ul2h1VfsuFgyW6dO2ZfgvPakA2br9hN4bE+kMbxiownnjCH4JGTQ9i/zxRAbGfmVu0O75ohLTEU6lXRyR6/NxPPzm6tc7C1OSnabdmMXucC3nL117I+NKQMw/6hO1W3Rvahoxs6iJH5Zoq9rEKhqrCaKdTLet4NKrIVB1XlIr1nrWL0jqdtyYituFGULNrRyNvJowIS15K18CkkbOZXZtPeliq56H9XyaTa+js1BEjNEN7Hd89cOPQnmiPrnrQBq6u/fiizY6Rg65q9L10XVOs2iiMqbkGkr5RVWzhM+WV/12ixH4/oRh5MRY3u/fTlyddR6Q8N7g0aNdfa8RP1ku9P4aNywKNxf5c3lui3Alym7PgEutyru5n2C/+E4Sj3Vw9OSG1412/9q6ur/ndbNg7vHOjQnKhCL5P3KopninjhSCOZyxiu6BYxEIJzdpkmrKqWnCL74ysa1oOPylUWA/ifgjHDW79bw1Vgixp39d4Wxb+SotYaD7+hKBwnqboe2CrtXejDzrF60tKDBp2etd4lx7NC1lvZ2i17dmuqiARuhnVdADh2zmraeT9B3nlm2I= +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.api.mdx new file mode 100644 index 00000000000..119c3086154 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-saved-query-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-metadata-information-about-this-api-resource-saved-query-info +title: "Get metadata information about this API resource (saved-query--info)" +description: "Get metadata information about this API resource" +sidebar_label: "Get metadata information about this API resource (saved-query--info)" +hide_title: true +hide_table_of_contents: true +api: eJzNV1Fv2zYQ/isHYg8JpsRNsQGFij6kQdpm67ZsdtcBluHS0tlmQ5EKSblxBf334UhJkWynQ7MB3ZMk8u543913x1PFMrSpEYUTWrGYvUYHOTqeccdBqKU2Oact4AtdOnBrYeH8+goMWl2aFFnECm54jg6NZfG0YqlWDpVjccV4UUiRev3RR0v2K2bTNeac3gqjCzROoPWyWTZPtSxz1X4K0uPyeiA2VCr4CunptgWymAnlcIWG1ZHfmVvx+eB2HbVLevERU8cOLWAm3P/Loxvc+jOEw9y/oCpzFk8HsdtxPGJLIX1uIlagyYW1Qvt1UnLCSWxV2g+lFbJZd751RqhVzyFuDN8ecDliwULMVujmxJ15k+yahAXR67ZEs6UzeE6Ct6yeRcygLbSyIYBPnzyhx3/Don9M6p5AG609y0FpHhzv5WAo1W4Pi2qyRgiGgQRO4b2QEhYIznBlJXeYwWILC75AyQ4Enk7gTpsvWg5CVKo3uAWnobQIWoEU1sE9CXaMf4F4D+W5HjLpoE+lRQM9KVhqc7B5dHH8WrZRMu94Xkjcz/t+ooeZHeRyWtWzXUjT1o+Zp+4Q35XDHJZG5/CLzlCSJz/8K9LmaO2wbXwpOz3UnSJ7yTMweFuidTFcqQ2XIoP7xgyF0RuRYcYO4OnpBixn3xbLO8VLt9ZGfMYshvPSrVG55nzvqDCHgfQVPZKnT781ksLolD4XEoFQuG0Mf1JyAho0RptDUC50KTNQ2kFjodGmo3781mS7Ug6N4hIsmg2agCKGcwWlwrsCU+pnfhF0mpbmgXS94o7LLgQRs5iWhjDSFPHxk2PxdEbXg+MrX5K/l2gIxCxidyepznDsfQtTh+RqxWKWvvvjLYuY9J20+2y6TczS0kg4+QteX04gYWvning0kjrlcq2ti589efZsxAsx2pyNLN9gNvf31chfZgmDJEkUwMkbSNh5wzQf9BheIjdo4Lvzi4vL8Xg++e3ny18Txuqo8+x669Za9XzrFjrvRF5o49patIlKVHs1wotu+XSF7oj8gEdAiILiGnmGxr6odoAkLIaENWASBt8DT4l9c6dvUNWJOk5UYYRyR61jp8S3o+PjPtSf+IaPfaJ7cAeL9wnRyhLiDiX/xIWDJbp07UE+EmI1wBm337CbOQL8oU1eFcBOPNYPQaOmBwF/nqjgrJ+MW0d3wtAIaYmnUq+OSPT4uZ9xcnRrnYXZyM/Mbs1i9iAMipEvrsDu0lAID0aC7ZbVW9qGDDcodZGjck2Z+gwFQ1VhtNOplnU8GlVkqo4r4l69Z+2itE7nrYmIbbgR1M3a2cebCTPAkpfSNW7STNkMp80nPXztDu2/mUyuobNTR4y8Gdrr8O45Nw79h/boLgdt4Orazyfa7Bg5GKpG30vXNaWp7UFj6p4BpO9EFVt4krzy/0NE5/cTypEXY3Gzez9eedB1RMpzg0uDdv1YI350Xur9OWtcFmgs9gfv3hJxJ8htzkJIrMu5uh9Sv/pXD448TU88TU9OSON4N6S9a+kxv5INcId3blRILhR57jlbNSUzZbwQBO+MIndfNixioXBmLYWmrKoW3OI7I+ualoMcldODLj/kwg1u/d8K8V+WtO+Lui0Gf1NFLHQbf0JQOE9T9P2u1dq7qAet4fUl0YFmmN7t3JGieSHr7Wistj3bVRUkQvuiSg5O+NbNappk/wa3hYnG +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-names-of-databases-currently-available.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-names-of-databases-currently-available.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-names-of-databases-currently-available.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-names-of-databases-currently-available.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-names-of-databases-currently-available.StatusCodes.json new file mode 100644 index 00000000000..19cc9fbdc83 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-names-of-databases-currently-available.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"available_drivers":{"description":"Installed drivers for the engine","items":{"type":"string"},"type":"array"},"default_driver":{"description":"Default driver for the engine","type":"string"},"engine":{"description":"Name of the SQLAlchemy engine","type":"string"},"engine_information":{"description":"Dict with public properties form the DB Engine","properties":{"disable_ssh_tunneling":{"description":"Whether the engine supports SSH Tunnels","type":"boolean"},"supports_file_upload":{"description":"Whether the engine supports file uploads","type":"boolean"}},"type":"object"},"name":{"description":"Name of the database","type":"string"},"parameters":{"description":"JSON schema defining the needed parameters","type":"object"},"preferred":{"description":"Is the database preferred?","type":"boolean"},"sqlalchemy_uri_placeholder":{"description":"Example placeholder for the SQLAlchemy URI","type":"string"}},"type":"object"},"type":"array"},"example":[{"available_drivers":["string"],"default_driver":"string","engine":"string","engine_information":{"disable_ssh_tunneling":true,"supports_file_upload":true},"name":"string","parameters":{},"preferred":true,"sqlalchemy_uri_placeholder":"string"}]}},"description":"Database names"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-names-of-databases-currently-available.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-names-of-databases-currently-available.api.mdx new file mode 100644 index 00000000000..f52c3914e30 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-names-of-databases-currently-available.api.mdx @@ -0,0 +1,60 @@ +--- +id: get-names-of-databases-currently-available +title: "Get names of databases currently available" +description: "Get names of databases currently available" +sidebar_label: "Get names of databases currently available" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/isEsQ8J5tTJsAGFimJI0zRNV7RZ7aIDosClpbPFliIV8uTGFfTfhyMlWba0Fu2XfbJF3ttz99wdK27BFUY7cDyq+G+np/STGI2gkf6KolAyESiNnn5yRtOZSzLIBf2TCLlXLKwpwKIMZsRGSCWWChaplRuw/jAFl1hZkCUe8WvtUCgFKWtE2MpYhhkw0GupgU92xnFbAI+4Qyv1mteT9kBYK7b0ncJKlAobb0Nnz8N942roaeCguRkYeiNyYGbltWd/vz5XlIntdw0tpF4Zm4tgZRCdTJB9kZixolwqmbBdMinU3Ht7/oxdtl72k51K51PtXLbAUmtQ5Hvg5UMGmEEfOHNlURiLjs1mL9ncq7odiKUxCoQmFK3gYiUVLMpCGZH+mAdSZEFxzMWupmb5CRIkp1rk36lAKlAshRtNfCGsyAFHufdq9vYNCyRmKayklnrtDWqAFFLW0x2Jq7CwAmthJAPXbi8u1on+OZ7WeyUCgxallYtCiQQyo9IxCl8+iLxQwHpCHY97THz/7nqYjbHsHrYQBPs8uh1t39vW2N2w29qrXdscngz4P05ZtCX8F9noriPFzv5emfeL01j7Ro67BN3VfojsNWVbQ/LoKEO//+Bs3O/SHJwTaxgZZ2PV6arRU+TPRMos3JfgMGLXeiOU7HOVxsZGppDyeginp0v2//i/sVxrBKuFYg4sjWSw1tiInWtWangoIEFIwyEzSVL6io7AeiFQqCDnnTtISitx62n86Qvy6PauvptwFGtP4raqROOHk8SkMPPBOa+gBLGQJ+/fveYTrsQS1O7TmdImFHpSWsVO/mFXl3MW8wyxiKZTZRKhMuMwenz6+PFUFHK6OZu2g2DaddQ05iyOY83YyUsW8/MSM2PlV5/3iD0DYcGyX84vLi5ns8X87V+Xb2LO60kX280WM6N70XUHXXwyp/Zpq+1iHet2x7On3fGjNeARxcF+CsQkqGYgUrDuaXUAJeYRi3kDJ+bsVyaSBJxboPkMuo71cawLKzUetaE9ItIdHR/3wb4SGzHz1e4B3jvcFcVoR5g7nOKLkMhWgEnmYf40yGoPadR+s8PqEeSPbQGrAHfu0X4MGjX9EPQnsQ7hktMu1INENEJGwSNl1kckevyE13eHHXAFGEYULcUWhWO+ZTSqLesA8QnPATOT8oivAf3wxIxH/Bs5oBT7Bg0NUlqqwGgi+WFgr+mapbABZYocNDat7gscDFWFNWgSo+poOq3IVB1VRN56YO2idGjy1sSEb4SVFGH7+PRmwtb0y6kJ02+gMqfWbz7px/FBGl/O5zess1NPOEWzb6/DOwhuFmYY3Wn/PLHs+sY/FYw9MDKaqkbfS9c11bidYzOawAGkn2YVX3qGvfDblLrhw5xq5MXoceFvdy8AD7qekPLCwsqCy37WSD3htMWHL5NZWYB1nlAokQZ9/4i4E+Q2ZyElDnPh10uzy3+IwXuuu/WD8IDTQgnpn1WeXFXD7lsuCklxnJH27sHYN0p0CPW+5VVFAu+tqms6vi/B0ja521HO75QJDwPBt8Vn2PKInycJ+KG0Ear0b6vDlUqV7Vrw6pKSLkrMekC61Dd/yHr7UtPbnu2qChJhwlC/hCD8fPUPmvpfRyfS7Q== +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"; + + + + + + + + + + +Get names of databases currently available + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.ParamsDetails.json new file mode 100644 index 00000000000..eccdacad2de --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.StatusCodes.json new file mode 100644 index 00000000000..a3c84540baf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"state":{"description":"The stored state","type":"object"}},"type":"object"},"example":{"state":{}}}},"description":"Returns the stored form_data."},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.api.mdx new file mode 100644 index 00000000000..467e8484a8f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-permanent-link-state-for-sql-lab-editor.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-permanent-link-state-for-sql-lab-editor +title: "Get permanent link state for SQLLab editor." +description: "Get permanent link state for SQLLab editor." +sidebar_label: "Get permanent link state for SQLLab editor." +hide_title: true +hide_table_of_contents: true +api: eJzFV1Fv2zYQ/ivEYQ8JpsRJ0AGBij6kQZqmM7o0drYBkZHS0tlWQpEKeXLjCfrvw5GybMdegbUPeZJIkcfvu/t4d6qhlFYWSGgdxHc15BpiKCXNIAItC4QYHnEBEVh8qnKLGcRkK4zApTMsJMQ10KLkZY5srqfQNCNe7EqjHTr+fnJ0xI/UaEJN/CrLUuWppNzo3oMzmudW9kprSrSUh92OJCG/ZOhSm5e8CWIYzlA4MhYzEVZESxxm/IApQdNszUSAz7IoFa7bbRpeuWn8Bqmy2glaHTIxtrjPJMlDtvPmpygV6Jyc4i7ffR9ztxHey0xwRNBRLK70XKo8E6tQitKaeZ5hBjvYre0NXI5fl8utlhXNjM3/wSwWZxXNUFN7vuhkt4PI+sbA5M3rMvlsSExMpbNYsD5bJyO725nKpigyg05oQwKfc3b/NqnOhmd0cvLasSmtSXk4Vig4LrSIxZ8stxAftNbYXTzOTaUyT7W10O7mo3577etzpQmtlko4tHO0gUUszrSoND6XmHLQ/KQwaVrZ/xDgB0lSdS6IwGFaWebImfThG0F8N+J0SHLK2RUGX/qiL8fiGm0hNWoS/Vw/wiiC54PUZDjwUEMiVlJPIYb09qYPESg5RrUaBjXxuLJKHPwtLi+GIoEZURn3esqkUs2Mo/j06PS0J8u8Nz/uuSel5LhX8tkq14+9+hEXTQIiSRItxMFHkcBZe598IGLxHqVFK345Oz+/GAzuh3/8fvE5AWiiDt71gmZGrwHsJjqIeVEaS8vL4BKd6GV5EO+66cMp0h7jED/KIwq7ZygztO5d/YJNArFIoGWUgPhVyJRleU/mEXWT6P1ElzbXtLdEd8hC3NvfX+f7Sc7lwCtgjfPG5Co0Rjum3VGV32ROYoKUzjzTn+FZb5CNl2PxMobM+usyjHVgPPSEv4YdDT+Y/dtEB8Rc5Dq0L3zRLjIKD5WZ7vHS/bfAEt+8GJdIouxEzuhDleYyKgZf+nwJMMvJ2EOIoECamQximCJ70HcfMXzfD+xpf3fDbaksB2KnP+EluD5/FhnOUZmyYIDBko9zMFSX1pBJjWriXq9mU01cs4ybLWvnlSNTLE1EMJc252Tp2sTlzYT+ZSIrRS1MiAB1VXBWaIf8cLDlyo/D4bXo7DQRMJpNex3fLXCDkN74Gzdzwlhxdc1GmMumkZ2uavf71Y3v7JYpbsDJOZD0ia6GsVfZB2MLyfY+/TWEtkvk2xC+rro0T7qJePO9xYlFN/tRI00EuZ6Y7R5xUJVondcU5cQ1YH2KtRPWzY+DSxwV0leetvH9fyreOLsrTYTP1CuVzDWf4dVVtwq/A1nmDOSYOXqVs/qXOocIYm69R8uQ30Fdj6XDW6uahqefKrRca0Yr1fnLkOW+XGcQT6RyuAWtq7uwd9O2V/ti5dVNyO2k1AsvblXxCCL/VxD+DZoRq9JnIn98+HKWpugT4nLPVolnOXVX//KCI8393Jrzuni3L2x9J566DitCams6eD63M8Cm+ReMs3Y9 +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"; + + + + + + + + + + +Get permanent link state for SQLLab editor. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.ParamsDetails.json new file mode 100644 index 00000000000..90f11632978 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The type of datasource","in":"path","name":"datasource_type","required":true,"schema":{"type":"string"}},{"description":"The id of the datasource","in":"path","name":"datasource_id","required":true,"schema":{"type":"integer"}},{"description":"The name of the column to get values for","in":"path","name":"column_name","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.StatusCodes.json new file mode 100644 index 00000000000..4ae492932a6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"type":"array"}},"type":"object"},"example":{"result":[{}]}}},"description":"A List of distinct values for the column"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.api.mdx new file mode 100644 index 00000000000..58d2db9fdfc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-possible-values-for-a-datasource-column.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-possible-values-for-a-datasource-column +title: "Get possible values for a datasource column" +description: "Get possible values for a datasource column" +sidebar_label: "Get possible values for a datasource column" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v3DYM/isCMWAJ5tbN1gGFin5IszR9Q1s0V2xDHKQ6m3dWakuuJF+TGf7vAyXbZ99dhrYZmk+2aYrkQ/G1gUoYUaJDY4GfNZChTY2snNQKOMxyZO66QqYXLBNOWF2bFCECSX8r4XKIQIkSgcP6/wUdgQgMfq6lwQy4MzVGYNMcSwG8Ac/AwToj1RLaNtqlWGak1uX4Lapl9jWKpXK4RHOTZhLb6051UZeKOc2W6NhKFDVattBmtyWB+8J/fYsDzonZVlpZtPT/1wcP6JFq5VA5ehVVVchUkJXxpSVTm5G8yugKjZPhtEFbF/6UdFh6klb4duFveEN1tO2UNUnV5XxKmWtdoFBjkp5fYuqgPW+jniSMEdfk3U2eCPBKlFWBYzPPmva8JebpTRyy19I6H3rSOqnSsftHd0NSH97KXyVaK5a4MzL/E8FwEJ6KjNF1o3WcvVArUciMrXOLVUavZIYZ7AA6OhuwHNwtlg9K1C7XRv6DGWeHtctRuU4/G2J6B5DxwYDkt7tF8kybucwyVJz9rWuWafWzY7lYIavQlNJaQuQ0E2mK1jKXS8sMdqVmB8BBXkD38G7RvdGOLXStMs6oanUhhNkAgWUaLVPaMbySFFzbiAYZpOX3u86iF8qhUaJgFs0KDUNjtOHsULFa4VWFKaHzRKbTtDY3xOEz4UQR+Lxyi2ltpLv29e/yC5Wccyq5Tiyp68EfQ/+wcB7B1b1UZ3jq7QtdsRBqSdX9w/vXEEEh5lisP7tw4ZDWpmD3/mInxzOWQO5cxeO40Kkocm0df/Tg0aNYVDJeHcTrjhU3G42znVBk1sahzMXNqLm0cSiFcQIsSRLF2L3nLIHDLv38hXH2FIVBw346PDo6Pj29mL19dfwmAV+7O0Tvrl2u1QjTQBhQybLSxvXRZROVqL5VsScD+f4S3R7ZwX4g9CgozFFkaOyTZsMBCXCWQOeEBNgvXZ5fOP0JVZuo/URVRiq31wO6TzG+t78/dtFLsRKnPrhGbpoQ1wGglSVPDd4RX4R0bIEuzb1zfrBrmol/eP/NNiOFHPWxD5YmOGnmffQxnGjpQQ57nKgAkowZAG64r2PSBd4v9HKPWPcfAyXcNE1P0LFKWyvnBY5buxgNfH2Pj6BEl+sMOCyRnO7nLg7/u+voPn3xCZlfG7runbcGm3he02+W4QoLXZWoXFfGfDQFQU1ltNOpLloexw2JanlD+dVuSTuqrdNlLyKClTBSzItQa3sx9J7hQvg5ypsJEaCqSypr3Sc9fF2byn8+m71jg5w2ArJmKm/Au2XcaajP9C8My4a9eEdCCMtUyE5Xdec9d+vH375Gn1J3CSB9pW5g7gPzmTalIHkv/5xBN0r7gdT/haHDeNBtRIcvDC4M2vx7hbQ04i90gDOxvq7QWB+GTjpqYmMSxU7gWx0El1hXCt86uy3h2wJ/onvorQ6vXFwVQvpZxEdX0yXFGYhKkiEHdHq8O/HtJY1vLk+DXj5dZoKdEAGFUoiVM2iaubD4wRRtS+TPNRrqsufrcA1bpbT0ngFfiMLiFqZh4oC99918uc9uXD53eqDfPNR1bytwgAg+4fWO5dTvfd9r1A2L6e3MktntjPrKnfU7jByHgV/yQj/xFxs4DtMUfSfsz26NjZThQwE/Oabko1VhFM9DCnYvo1V1alfTBI7QoNrBTN/UwW+S/wL8k99G +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"; + + + + + + + + + + +Get possible values for a datasource column + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.StatusCodes.json new file mode 100644 index 00000000000..ca8268fed08 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"changed_on":{"format":"date-time","nullable":true,"type":"string"},"client_id":{"maxLength":11,"type":"string"},"database":{"properties":{"id":{"type":"integer"}},"type":"object","title":"QueryRestApi.get.Database"},"end_result_backend_time":{"nullable":true,"type":"number"},"end_time":{"nullable":true,"type":"number"},"error_message":{"nullable":true,"type":"string"},"executed_sql":{"nullable":true,"type":"string"},"id":{"type":"integer"},"limit":{"nullable":true,"type":"integer"},"progress":{"nullable":true,"type":"integer"},"results_key":{"maxLength":64,"nullable":true,"type":"string"},"rows":{"nullable":true,"type":"integer"},"schema":{"maxLength":256,"nullable":true,"type":"string"},"select_as_cta":{"nullable":true,"type":"boolean"},"select_as_cta_used":{"nullable":true,"type":"boolean"},"select_sql":{"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_editor_id":{"maxLength":256,"nullable":true,"type":"string"},"start_running_time":{"nullable":true,"type":"number"},"start_time":{"nullable":true,"type":"number"},"status":{"maxLength":16,"nullable":true,"type":"string"},"tab_name":{"maxLength":256,"nullable":true,"type":"string"},"tmp_schema_name":{"maxLength":256,"nullable":true,"type":"string"},"tmp_table_name":{"maxLength":256,"nullable":true,"type":"string"},"tracking_url":{"readOnly":true}},"required":["client_id","database"],"type":"object","title":"QueryRestApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"changed_on":"2024-01-15T10:30:00Z","client_id":"string","end_result_backend_time":1,"end_time":1,"error_message":"string","executed_sql":"string","id":1,"limit":1,"progress":1,"results_key":"string","rows":1,"schema":"string","select_as_cta":true,"select_as_cta_used":true,"select_sql":"string","sql":"string","sql_editor_id":"string","start_running_time":1,"start_time":1,"status":"string","tab_name":"string","tmp_schema_name":"string","tmp_table_name":"string","tracking_url":{}},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.api.mdx new file mode 100644 index 00000000000..47eed0b84a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-query-detail-information.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-query-detail-information +title: "Get query detail information" +description: "Get an item model" +sidebar_label: "Get query detail information" +hide_title: true +hide_table_of_contents: true +api: eJzFWFFv2zYQ/isEsYcEU2Ira4tCwx6yruu6dV3XpNuwONBo6WyzpkiFpJJ4gv77cKRkSZacOeuAPtki7473HY/fHVnSFEyieW65kjSir8ASJgm3kJFMpSBoQHOmWQYWtKHRVUk5yuXMrmhAJcsAv9Y0oBpuCq4hpZHVBQTUJCvIGI1Kajc5SnFpYQmaVlVQ0kRJC9LiNMtzwROGHkw+GnSj7CjnWuWgLQeDX4kSRSbdX/TRdMwbq7lc0ipoBpjWbIPfa9j0NUAWGY2uqFmpu7gxGXRD0RkVbA6i8+2ULLcCMABKAr0O/s2HdkDNP0JiaUC9hYguwcboWFxDrlDYxfimAL1pg3xDq2uMssmVND4aZ9OpD8p/iuUY3D0Bj70P5U62XK6AdEbIQmliV0C8EkGlU/I7F4LMgVjNpBHMQkrmGzLHqNKAwj3LcheIc/KWJw/Zo4MwD8KKoUvH/XQpzdOhkd0dfnwInP7/An7M0mGwNZhC2BHnV0wuIY19KiyUzpilEU2ZhRPLM5fDhRBsjm74gzuITyI4SBv7yGbs/g3IpV3RKAxHhFNm2ZwZGLri9YdksPdo/IoH4D0Ye57z0yXY0+8a21VAQaaxBx3PWbLGT4cnKvcBkkU2xxW97uHCWisdZ2AMWz6k0YYA7iEpLKSxuREHKYxHJqCCZ9w+YKEjmmu11GDMYdI+cCZew2ZnT589OSAhtLo7cKGWezprnD19dsAiBgQkNmYmTix7YLW5UgKYHKjEhYH0UXqHbtcj5GJIuVV6eHYOjIFl2sa6kJLL5eEp69UeI24Ls3u4D/HPsvmWFx8NzmZ5XfQ+zYZFiU8woVmyxvAW2m2rBpb+IsXGK1RVt7O56nBhh+quD+cwF+9u2zGoKOdEcGOJWpC25zi81+l0JyOW3QSximiQKejD69PFSt2R11hCvwPLuDCHVaWtgb3dRq+4HtAD1GzZrDpSvEctjhbWXtnsFkp6Nj17cjINT8Knl+E0+moaTad/0l4hbB3YW4jCbqEJB4WkY6FXL9pxXCfcVoGwS/LhDoe3Sp6bw5Z626kdRq3b9BHO7M3sODX87HJcZ2KEusI+NYUt9bR6LaV0xnaZoj/VJYDOTP9cV4ODd9XIXvePzUiyu6a8f5jc/EKrjPzs7klVQJ98Ujve6TAed7LajPqWpQTJCoyNyGt5ywRPSXt9I7lWtzyFdAxPR9djCT8vlg+SFXalNP8b0oicF3YF0tbrky0jjwDpKnokTz4vkrfKkoUqZBoRvC3UQQYMt1GFRr5TYIhUlsA9x/APQW1tOERnZ597b3KtEvycCyC4L3YTkd8w3fz+OKobw/FCFSJ1UGsLtTYu9fRzH5/X0oKWTBAD+ha0RxGRc0kKCfc5JLhpbpCoJCn0ngT8nlkmtiFAHk0KjRjx9eTjnaXR1TVe5S1bOhbCFgFBXAf0/iRRKVw43/xri2BySSOafHj/pil27adPH/wutCAnf5BXLy/JjK6szaPJRKiEiZUyNno+ff58wnI+uQ0n7lVhEs4omc1mkpCTH8iMntcnxoU6It8C06DJF+cvXry8uIgvf/np5dsZpfhuU/vzbmNXSnY82g5sfeJZrrRt0t3M5Ew2jxfkm+0w9kRH6Ac52PHAi6+ApaDNN+WO+zMakRmtIcwo+ZKwBDMttmoNsprJ45nMNZf2qHHnFHPr6Pi4C/BHdssu3KZ2QPYG2+AraRDnFhu7Y9ySBdhk5aA9CljZQxc132R3lxDmX81GlR7ipUP4l9eo8Afhfj2T3kXsV7fu7YCvhZSAU6GWRyh6/LV7ccrArlTqX6rcayC21rTvfJmvK9dg4Lnxieuq7jhwunti3uA0SeEWhMozkLY+gW5DvKEy18qqRIkqmkxKNFVFJSZYNbD2ojBWZY2JgN4yzZGomqcdZ8a3pAvmuj/npmvl/Ltg/Yk/7lj27f9wefmObO1UAUVv+va2eAfOXXhqwTlsWIjS5PU7d4FXesfIaKhqfSddVbg/Db1cIDF6kI5kSjp32fF98+bz4++XtG4L3f3XzbZ9vANdBagca1hoMKv/asS9YC7U8AZyUeSgDXQvSJ0hzB0vdxv6kBibMcf6dXOHz9Mu40jqOjOCy6Bn3HFPb7FOJRl91q49tnBvJ7lg3N0H6jugT/IrynKOfoU02L7GRvkaU8Lv+RUtS7wBftCiqnDYS2H+7/Vl39K+j79xCSsKnHfHr8leb5S7kpvSaMGEgQcQH72vW6Rjsm/B5uooN901G0fyNa2uMbkdEbnV/cR5koAjwEZlUKV7rPHqJSYMtmSd0rxNm/oPWh91pyy9hGe2auud43J0sKr+AWqSkc4= +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.ParamsDetails.json new file mode 100644 index 00000000000..12b1e3d5613 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The id of the user","in":"path","name":"user_id","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"actions":{"items":{"type":"string"},"type":"array"},"distinct":{"type":"boolean"},"page":{"type":"number"},"page_size":{"type":"number"}},"type":"object","title":"get_recent_activity_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.StatusCodes.json new file mode 100644 index 00000000000..5955b3ccc16 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A list of recent activity objects","items":{"properties":{"action":{"description":"Action taken describing type of activity","type":"string"},"item_title":{"description":"Title of item","type":"string"},"item_type":{"description":"Type of item, e.g. slice or dashboard","type":"string"},"item_url":{"description":"URL to item","type":"string"},"time":{"description":"Time of activity, in epoch milliseconds","type":"number"},"time_delta_humanized":{"description":"Human-readable description of how long ago activity took place.","type":"string"}},"type":"object","title":"RecentActivity"},"type":"array"}},"type":"object","title":"RecentActivityResponseSchema"},"example":{"result":[]}}},"description":"A List of recent activity objects"},"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"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.api.mdx new file mode 100644 index 00000000000..0fb6535a5f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-recent-activity-data-for-a-user.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-recent-activity-data-for-a-user +title: "Get recent activity data for a user" +description: "Get recent activity data for a user" +sidebar_label: "Get recent activity data for a user" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYcASTImbvQCFin5wi/RtwVbEDrYhClxaukhsKFIlKTeuoP8+HCnZsuV0Rfahn2zxeHfPcy/ksYGKG16iQ2Mhvm4gQ5saUTmhFcQwL5CJjOlb5gpktUUDEQiSVNwVEIHiJUIMJFmIDCIw+KkWBjOInakxApsWWHKIG3DrirYK5TBHA20bNZBq5VA5EvOqkiLl5Hjy0ZL3ZqBcGV2hcQKt35vSNv9XOCztwLx1Rqgc2qhf4MbwNX1nwjqhUjfYvNRaIlckrXiOA4mqyyWBDIKFFV8OSbde9PIjpg4icMJJWsjRLQymqNyC0K6EWy86Oi3p+SB+qtGst1H8BO0NRdBWWtnA9OcnT+jnkXEyaGvptXbTOmVSWEdpDRBZD5EFHpay3Af2UOgPmPTrzPE7VCyIlkLljOJDjnoPEI0zRa4WXeBGFUjLZIA2PazsV0e6nW/aEjE8zU+ZlSJFpg3LuC2WmpvsQZu1kWOTV5cXzOkHwThRHuRQ7sQgYkIxrHRasFJIKSymWmV2a3BbfWRwkaF0fFHUJVfiC7XWvoM3JDoxyDO+lMgGQnJb6M9MapUznuttpp3Wd6ySPMXTMZOvFPalr5hpn85Ro32z6mVX57OuKyLAe15WoQj6yr2+8d2yX74X/1G+bQS//q/OKdHa3RPhwdDsAt8owgueMToN0bqYvVUrLkXGtqctq4xeiQwzOMBwoBu4nH1fLleK167QhsovZtPaFahc559tjvwDRIaKgckv35fJK22WIstQxewfXbNMqx8dK/gKWYWmFNb6U4z6JEVrmSuEZQatrk2Khwhu7JHH3753zb1VDo3iklk0KzQMjdEmZlPFaoX3FaYOs7DIdJrW5oGsveKOy7DPO7eY1oa6nSaEj59DX95E4HhOUwNc6PwSrZtWAm4iuD9JdYYzDy8MFZKrHGJIry4vIALJlyi3n11sY0hrI9nJ3+z1+ZwlUDhXxZOJ1CmXhbYufvrk6dMJr8RkdTaROp/s3a6TBFiSJIqxkzcsgWlXdj70MXuB3KBhP0xfvjyfzRbzP38//yMBoBmkA/d+7QqtBvA2CxuAoqy0cX1j2kQlqr+s2fPN8mmO7ohwsMexiIJugTxDY583e1wSiFkCHZ8E2E9dqS6cvkPVJuo4UZURyh312E6p8I6Oj4ds3/EVn/mMDxjvLG7TopUl0hui/DMXjt2iSwvP8/Esmx2qcf/N9vNHnD/0KWwC37mn+yFotPRD3J8lKuDNuOMbrHuR6DZpiadS50e09fiZn7122+A1utEN4+3easN4Pw6X6AqdhZEPojAYx/A19hRd35+hO/ygcTiGsA/pgsQswxVKXZWELFjyuQ2Gmspop1Mt23gyachUGzdUuO3I2svaOl32JiJYcSNogujnPm8mjBu33N/HHiZEgKouqfO7T/qxMArgm/n8PdvYaSMgNLv2NnxH4GbhCCMZzcc0tL197ydybfaMHAxVp+93ty1ltz/G/MQRSPrDrIGlr61X2pSc7L37aw7d08U/E7x0OyV50m1EyguDtwZt8Vgj/iVwq8cj3ayu0Fgcjk+DJaqdsG91FkJiXcn97dK9Jb6tdnd8bq4dh/duUkku/KXWzcGhrq+BV4IAnNG5oXP/4tupboiACiFk+hqaZsktXhnZtrQcXjyjh+bgzoRtiHZx3OHav5GoTGVNct+yfc0Go8LS/wziWy4tjghuvRxddlPLMTv4yD0IoZ901XqIoofWP4LbG6p0f6Z5UEE6TVP0B2uvNxoNiM3mMHl9TtVDw9PwvdrXUPeHrB/E1DRhRzgk2w1Ef0cQwLb9F93+h4M= +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"; + + + + + + + + + + +Get recent activity data for a user + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.api.mdx new file mode 100644 index 00000000000..075deac0f02 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-annotation-layer-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-annotation-layer-related-column-name +title: "Get related fields data (annotation-layer-related-column-name)" +description: "Get related fields data (annotation-layer-related-column-name)" +sidebar_label: "Get related fields data (annotation-layer-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV1tvEzkU/ivW0T602gmhK1aqBvEQUIGyFaAmaFfqRMGdOUlcPPbU9oSG0fz31bHnlgsrFpB4Snw5x+f7znUqKLjhOTo0FuKbCoSCGAru1hCB4jlCDKmWZa4WfhWBwftSGMwgdqbECGy6xpxDXIHbFnTdOiPUCuo6qiDVyqFydMqLQoqUO6HV+M5qRXu9bGF0gcYJtLRaCunQHNEZgVCpLDNciMzfFA5zO7golMMVGrrZ7HBj+JbWBV/h8Zt0srDiy9HjXpO+vcPUQQROOEkbK3QLg5I7zBYNlLr2NkIM9yWabU/iPdRzIs8WWtmA8o/Hj+nnOzlKdRmEMrSpEQUJQQyzNTKnHZdMlfktGqaXrLGRbbgs0UJ0hAKDtpRuh9Hd5/DBGX78OX/EcnQ8446zpTbdi6QM9gkkRvHhK7YPJVlwOzNYGLSonGem19dHhUf2DQpFhsqJpUBzhIX/8PR1UHLtWbpunHgYZN+kwctOm3CJAB94XkgcuPSsd8fN3AfULqpGFQt5yYh0UvTkh8IpR2t3E6TP40P/DYzuBOE5zxhVB7QuZpdqw6XIWF9eWGH0RmSYwRFMA9mA5ezXYvmgeOnW2ogvmMVsUro1BU54n3Ul8AiQoWBA8uTXInmrHVvqUmUxC+ngSUai2+rSpMgyjZYp7Rg+CKL/EFSng17581fH2aVyaBSXzKLZoGFojDYxmyhWKnwoMCV0fpPpNC3NVzz1klOV9Pf84xbT0gi39W3w7nPIvnkEjq+oNcJEKR0qELviW+qX8wgeRqnOcOqtDA1UcrWipvnh+goikPwWZb8MjNO6NJKN/mGvLmYsgbVzRTweS51yudbWxeePz8/HvBDjzdmYd+8uJL07birauBo05joBliSJYmz0miUwaWLQi8XsOXKDhv02efHiYjpdzN79dfE2AaAO3Zj7fuvWvrS2BncbnckiL7RxbQDZRCWqbWfsWbf9aIXuhOxgPwtXFLStkWdo7LNqD10CMUugQZgA+53xNEVrF05/QlUn6jRRhRHKnbTWPqIYPTk9HeJ/wzd86oNjwMHOZu86rSzR0EHnn7lwbIkuXXvkPxN3tQM+btds38fEwsfWzVVgYOYJ+BgkavohNp4mKiDwzbq1fo+b5pKW+Ejq1QldPX3qJ5jdHHqFrmuwS4Eys0HtSQ9y5EGOmlujgHFEGE8hghzdWmdhloIoDJ4x/D+qyDm+EoQELA357qgLYN/+KzpmGW5Q6iJH5Zqa4kMjKKoKo51Otazj8bgiVXVcUSbUB9pelNbpvFVBU4kR/FZiO055NWFKWXLf372ZEAGqMqca0yzpx5eXXf2vZ7P3rNNTR0DW7Orr8B4YNw3Fks6INaYNu3zvp19t9pQcpaqR97frmkKhLZh+lgkgfdms4NYH4kttck763vw9g+ZDgRIonPYDmAddRyS8MLg0aNffq8QP30t9OAlOywKNxeFENtii2An3NmeBEuty7vtYM77/cKDvmNP1PpqDx4XkQtGzPuCqJglugBeCbDuDCPYTwX+H+Xcggnj4gTZvo+IGquqWW/xgZF3TdvggoQzZs6Xr5NDTuWvYJ9z6T5hu0AZfC9r4DkqFpf8ZxEsuLR4g7l85uW7mp1P2tQfbsVpth2+2hgzx1nPKA18evRnhxiRN0VftVvZgRCH7u+Lz6oJiiwa3gW+6CGv+kPajdlVVuBHqbd2Z6RsQGVjX/wJG9lrr +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"; + + + + + + + + + + +Get related fields data (annotation-layer-related-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.api.mdx new file mode 100644 index 00000000000..38ea1e1f247 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-chart-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-chart-related-column-name +title: "Get related fields data (chart-related-column-name)" +description: "Get a list of all possible owners for a chart. Use `owners` has the `column_name` parameter" +sidebar_label: "Get related fields data (chart-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/iuHwz4kmBI3QwcEKvohDdK3FV0RJ9iAKHAY6WyxpUiVpNykgv77cKRky7EzdC2GfpJEHo/3PPeqFgtyuZW1l0Zjiq/IgwAlnQczB6EU1MY5easIzBdN1sHcWBCQl8L6Q7h0BDdx4wZK4cCXBDe5UU2lZ1pUdAO1sKIiTxYTXL07TK9alHxjLXyJCbIwpjg6igla+txISwWm3jaUoMtLqgSmLfr7msWdt1IvsOuSFnOjPWnPu6KulcwFY5p8dAysHZ2tranJekmOv+ZSsXHbOhOUOldNQTNZBEnpqXIjQak9LciyZL8irBX3/F2LBe2W5J2Zk193bq81mduPlHtM0EuveGFBfmZJCU/FrIfSdcFGTPFzQ/Z+TeJn7K6ZPFcb7SLK35484cd3cpSbJh7aDJaLksAbLxToprolyyHT2whLoRpymOygwJJrlN9gdPM6uvNW7L4ubEFFXhTCixCMw42sDB8SyIzS3SO2j09CdDtYqi050j4ws9a3joqA7BsUyoK0l3MZIv8/ePo8KjkPLJ33TtwOsm/SEM5O+3BJkO5EVSsaufRo7Y6r6xBQm6h6VRDzEph0VvT0h8KpIuc2E2Sdx9v+Gxm9OogvRAFcHcj5FN7opVCyWJcaB7U1S1lQgTswjc5GLEc/F8ulFo0vjZVfqUjhpPElB068H1YlcAeQ8cGI5OnPRfLeeJibRhcpxHQIJBPT7Uxjc4LCkANtPNCdZPq3Qa108C2//+w4e6M9WS0UOLJLskDWGpvCiYZG011NOaMLi2DyvLGPeOql4CoZ5MLljvLGSn8f2uDHLzH7rhP0YsGtEU+5vTq8TvDuIDcFTYNpsWsqoRfcKS/P32GCStySWn9Gmvm7sQoO/oZXZxeQYel9nU4myuRClcb59PjJ8fFE1HKyPJqEXj7pa9ekHbXgLkPIskwDHLyGDE/6aAvsp/CChCULv5ycnp5Np7OLP/84e58hci/ubfxw78tQRAcrVwsrO2VVG+uHUHGZzvTQuOD5avlwQX6P7YAfApNEFSWJgqx73j6AlGEKGfawMoRfQeQ5OTfz5hPpLtP7ma6t1H5vMPGQQ3Bvf38M+q1Yimnw/Qj4xuLaSUY7xr7CK74I6WFOPi8D3B8G224gTodveOhNhn4zOLSNsC8C6pt4ouMHU/As09Hs0IAHkx8Q0gsZRYfKLPZYdP9ZmEoq8qUp4kATJkJfYorfAIh5CzkYs6CxTOtOdvBh9r3jbShoScrUFWnfZ3PwWlTU1tZ4kxvVpZNJy6q6tOXI7La0nTbOm2pQwfOAleJW0TDIBDVxPpiL0FmDmZgg6abi7O4/+RFyfFP/64uLD7DS0yXI1mzqW+HdMm4ayxTvMWtgLLz5EOZOYx8o2UlVfz5Idx07bChVYYqIIEPBavE2hMtLYyvB+t7+dYH9iM6xHXfXo08A3SV8eGZpbsmV36skjL1zsz2DTZuarKPxLDRa4tiJcsujSInzlQgdpB+c+e9nmOHmklThYpTvhbg86LcOYlge8KH9hwyOmtX//DPVU8Lj7aRWQmrGFKK57dPqCkUtGfgRJhguCf9UAQQmmI5/tq6HOLvCtr0Vji6t6jpejj8XnHOPAn3Mmk90H35HVkMzhhowZExUKh2/F5jOhXL0L3Tunfez0D48duEwIuv78Z2DIWO83TVnViiLwYwocZLnFEr0cHZr3NioYa/OOFp5CBvNGKuY7V9Y+0672jZKxDrbrcwM3YYN7Lp/AFgTajU= +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"; + + + + + + + + + + +Get a list of all possible owners for a chart. Use `owners` has the `column_name` parameter + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.api.mdx new file mode 100644 index 00000000000..6e3c2b70425 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-css-template-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-css-template-related-column-name +title: "Get related fields data (css-template-related-column-name)" +description: "Get related fields data (css-template-related-column-name)" +sidebar_label: "Get related fields data (css-template-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV9tu2zgQ/RVisA8JVq6bRRcIVPQhDdI03aIbxA52gShwGWlsM6VIlaRcu4L+fTGkbr50UbQF8mSTHB7OmbsqKLjhOTo0FuK7CoSCGArulhCB4jlCDKmWZa5mfhWBwc+lMJhB7EyJEdh0iTmHuAK3KUjcOiPUAuo6qiDVyqFydMqLQoqUO6HV+NFqRXv93cLoAo0TaGk1F9KhOYAZgVCpLDOcicxLCoe5HQgK5XCBhiSbHW4M39C64As8LEknMyu+HjzukfTDI6YOInDCSdpYoJsZlNxhNmuo1LXXEWL4XKLZ9Eb8DPU9Gc8WWtnA8o/nz+nnB22U6jJcytCmRhR0CWKYLpE57bhkqswf0DA9Z42ObMVliRaiAyYwaEvptiy6/RyuneGHn/NHLEfHM+44m2vTvUhgsGtAsiiuv6H78CYLbmcGC4MWlfOW6fH6qPDMvgNQZKicmAs0B6zwP56+CSA33ko3jRP3g+y7EPzdSRMuEeCa54XEgUtPenfc3fuA2mbVQLGQl4yMTkAvfiqccrR2O0H6PN7330Dp7iK85hmj6oDWxexKrbgUGevLCyuMXokMMzjAaXA3cDl5Wi63ipduqY34ilnMzkq3pMAJ77OuBB4gMrwYmLx4WiYftGNzXaosZiEdvJGRzG11aVJkmUbLlHYM14LMv0+qw6BX/nzqOLtSDo3iklk0KzQMjdEmZmeKlQrXBabEzm8ynaal+Yan3nCqkl7OP24xLY1wG98GH7+E7LuPwPEFtUY4n0zYFPOCks/CfQTrUaoznHgNQ/OUXC2oYd7evIcIJH9A2S+DtWldGslG/7LLiylLYOlcEY/HUqdcLrV18enz09MxL8R4dTJOrZ255s1xU8nG1aAh1wmwJEkUY6O3LIGzJva8L2L2GrlBw347Oz+/mExm07//uviQAFBnblS93rilL6mtst1Gp67IC21cGzg2UYlq2xh71W0/W6A7Ij3Yr+AUBaQl8gyNfVXtMEsgZgk07BJgvzOepki4+hOqOlHHiSqMUO6o1fQZxeXR8fGQ+zu+4hMfEAP+W5u9y7SyZIKONv/ChWNzdOnSs/5VnKst4nG7Zru+JQt8bN1bBfZTT/5juFHTD1niZaKC9r45t5rv2KUR0hKfSb04ItHjl35i2c6ZS3RdQ50LlJkNsEeptaOW4KiRGAV+I+J3DBHk6JY6C3MTRGHIjOH7TUQO8Rkfkq005K+DZoddvd/TMctwhVIXOSrX1A4fDgGoKox2OtWyjsfjiqDquKLIr/fQzkvrdN5C0PRhBH+Q2I5NHiZMI3Pu+7hXEyJAVeZUS5ol/fhSso3/djq9Zh1OHQFps43X8d1TbhKKIp2R1Zg27OraT7na7IAcNFVz30vXNYVAWxj9zBJI+vJYwYMPwDfa5Jzw3v0zheaDgJImnPaDliddR3R5ZnBu0C5/FMQP2XO9P/FNygKNxeHkNdii2Alyq5NgEuty7vtVM6b/VIBvqdL1N5p1x4XkQtGTPtiqJvjvgBeC9DqBCIYJ4L+z/BsQQTz8ALtvo+EOquqBW7w1sq5pO3xwUGbs6NF1aujNuK3UJ9z4T5RukAaf+21cB1Bh6X8G8ZxLi3ts+1eObpr56Jh968F2bFab4ZutIkO+9T3Fvy+HXo0gcZam6Ct0e3dvBCH9u4JzeUExRYPZwC9dZDV/CP2gXlUVJEJ9rTs1fbMhBev6P+RSTRM= +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"; + + + + + + + + + + +Get related fields data (css-template-related-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.api.mdx new file mode 100644 index 00000000000..085927bd1ec --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dashboard-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-dashboard-related-column-name +title: "Get related fields data (dashboard-related-column-name)" +description: "Get a list of all possible owners for a dashboard." +sidebar_label: "Get related fields data (dashboard-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV1tv2zYU/isHB3tIMCVuhg4oVPQh7dLbhq6IXWxAFLi0dGyzpUiVpNy4gv77cEjJli8pinZAn2xezsfznbsaLMjlVlZeGo0pviAPApR0HswchFJQGefkTBGYz5qsg7mxIKAQbjkzwhbnmGAlrCjJk3WY3jQoGagSfokJalESppgbVZd6GlYJWvpUS0sFpt7WlKDLl1QKTBv064qvO2+lXmDbJg3mRnvSnk9FVSmZC1Z19MGxvs1AtrKmIuslOV7NpfJkj2AmKHWu6oKmsgg3pafSDS5K7WlBlm92O8JaseZ1JRZ0/CafTJ38cvR4i2RmHyj3mKCXXvHGgvzUkhKeimlHpW2Djpjip5rsemvET9jesvFcZbSLLH978IB/vtNGuamj0G4MTJYE3nihQNfljCxHQqcjrISqyWFyxASWXK38jkV3n6M7b8Xx58IRlORFIbwIMda/yGC4b0C2KN3do/tQEqLbwVJlyZH2wTJbvG1UBGbfACgL0l7OJdkjVviKp68jyHWw0nXnxMMg+yaEIDvuwiVBuhNlpWjg0outO25uQ0DtsuqgIOYlsNEZ6OEPhVNJzu0myDaPD/03UHojiE9FAVwdyPkUXumVULKAbXmBypqVLKjAI5wGspHLxc/l8k6L2i+NlV+oSOGy9ksOnPg+bErgESJDwcjk4c9l8sZ4mJtaFynEdAhGJja3M7XNCQpDDrTxQHeSzX9IaoPBr/z+s+PslfZktVDgyK7IAllrbAqXGmpNdxXlzC5sgsnz2t7jqeeCq2S4Fx53lNdW+nVogx8+x+y7TdCLBbdG/KPvmg5vE7w7y01B46Be7JxK6AV3y3fXf2GCSsxIbZfR1LyurYKzf+HF1QQyXHpfpaORMrlQS+N8+ujBo0cjUcnR6mK0adOjroaNmkErbjOELMs0wNlLyPCyi7rghRSekrBk4ZfLZ8+uxuPp5O8/r95kiNyTOz3frv0yFNNe083GRldZVsb6PmRcpjPdNzB4stk+X5A/YT3ghwklEWZJoiDrnjR7tDJMIcOOWobwK4g8J+em3nwk3Wb6NNOVldqf9GqeczienJ4Oib8WKzEOcTAgv7O5dZbRjvlvOIvPQnqYk8+XgfL/QrjZYZ32a9j3KtN/3zu2idQngfn7KNHyD5vhcaaj6qEh92rvGaW7ZBSdK7M44aunj8OUUpJfmiIOOGFC9EtM8RtJsf1CXsasqC2b96iVcD8j/+JjKGhFylQlad9lePBeBGoqa7zJjWrT0ahhqDZtOErbA7RntfOm7CF4RrBSzBT1w02AiTPDXIRuG9TEBEnXJWd8t+SfkPO7+C8nk7ewwWkTZG128TZ8D5Qbx9LFZ2w1MBZevQ2zqLF7IEdN1cmH223LTuvLV5gsIslQxBqchZB5bmwpGO/1PxPsxnaO8Xi6HYcC6TZh4amluSW3/F6QMArPzeFcNq4rso6G89Fgi2Mn3ltdRJM4X4rQVbphmj90+rluLkkVLkb6ySY2z7rjsxiaZyx4um/FQRP7vm+nji1Ps6NKCalZ3RCoTZc1NygqyZwu+PFeNnxGBf0wwXT4fXXbh9ENNs1MOHpnVdvydvye4JS6l8N9Gn2kdfgC2czJGNK8T4gIKh3/LzCdC+XoK5Y6ue7Gn1O478F+Ktbr4Zu9IkO+7S0nTqh8QY144zLPKVTiXvZgwtgpUy+uOBh57hqMFZuQ7P4w+lG9mibeiKW03agZmgor2Lb/AQ7SVs0= +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"; + + + + + + + + + + +Get a list of all possible owners for a dashboard. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.api.mdx new file mode 100644 index 00000000000..7bab2b3d979 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-database-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-database-related-column-name +title: "Get related fields data (database-related-column-name)" +description: "Get related fields data (database-related-column-name)" +sidebar_label: "Get related fields data (database-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV22P2zYM/isCsQ93mK/pDR1QuOiHa3d9W9EVlxQbcD6kOptJ1MqSK9HppYb/+0DJdpyXDkU7oJ8SSST1PCRF0g1U0skSCZ2H9LoBZSCFStIKEjCyREght7ouzTysEnD4qVYOC0jJ1ZiAz1dYSkgboE3F4p6cMkto26SB3BpCQ3wqq0qrXJKyZvLBW8N7W93K2QodKfS8WihN6I7YTECZXNcFzlURJBVh6UeCyhAu0bFktyOdkxteV3KJxyX5ZO7Vl6PHW0v29gPmBAmQIs0bS6S5Qy0Ji3lHpW0DRkjhU41us3XiJ2hv2Hm+ssZHlr/dv88/3+mj3NZRqUCfO1WxEqQwW6EgS1ILU5e36IRdiA6jWEtdo4fkiAsc+lrTjkd3r8M7cvL4deFIlEiykCTFwrrhRjYG+w5kj+LdV7CPNUUMu3BYOfRoKHhma2+bFYHZNxhUBRpSC4XuiBf+I9JX0chV8NJVF8TDJPsmC0F32qVLAngny0rjKKTn23Bc34SE2mXVmRLxXQp2Oht68EPpVKL3uw9k+44P4zcCPSjCE1kIrg7oKRUvzVpqVYhteRGVs2tVYAFHOI10I5fzn8vlnZE1raxTX7BIxUVNK06ceL8YSuARImPFyOTBz2XyxpJY2NoUqYjPITgZ2d3e1i5HUVj0wlgSeKfY/YekBht8y+8/O89eGkJnpBYe3RqdQOesS8WFEbXBuwpzZhc2hc3z2n0lUs8kV8kgFy73mNdO0Sa0wQ+f4+u7SYDkklsj/CFJ3kqPcJPA3VluC5wGcLFvammW3CvfXb2GBLS8Rb1dRkfzunZanP0jnl/ORAYroiqdTLTNpV5ZT+nD+w8fTmSlJuvzSdFdN+kK2KQZ9eE2A5FlmRHi7IXI4KJLuRCCVDxB6dCJXy6ePr2cTuezv/68fJMBcEPuYL7d0CpU0h7osDFAVWVlHfX54jOTmb57icfD9r0l0gnjED/KJ4lWVigLdP5xs8cqg1Rk0DHLQPwqZJ6j93OyH9G0mTnNTOWUoZMe5T1OxZPT0zHvV3ItpyEHRtx3NrehssYz/YGy/CwViQVSvgqM/w++zQ7ptF+L/Zgy+/d9WJvIfBaIv48aLf+wFx5lJiIPvbhHveeTTshqvKft8oRFTx+FAWX3iTxHGvrnQqEufDR70pM7607PIrcz5nYKCZRIK1vEEQmSOE+m8G2u4SCEhx0fVu04RkddDft4X/OxKHCN2lYlGupKREiBaKipnCWbW92mk0nDptq04UxvD6w9rT3ZsjfBQ4ZT8lZjPx0FM3HoWMjQrgNMSABNXXLJ6Jb84+HAuy9ms7disNMmwGh27Q18D8BNY+3jM/aasE68fBuGWev2jBx1VacfpNuWQ9/XvzCaRJKhCjZwGxLvmXWlZHuv/p5BN/fzQ4mn23kqkG4TVp47XDj0q+81EmbphT0c7KZ1hc7jeMAabXHuRLn1eXSJp1KGttRN49+d2DswhhbG4+yk0lIZvi4kWtMl/TXISjGmc9buWwhPeME+JJCOv69u+iy4hqZh0XdOty1vx+8JfhF7GIZGDFv37QL6iJvwBTLMyRDeep/P0ajy/L+AdCG1xwOm21tOrrrx51R87cJ+Kjab8Z09kDHf9obzPpS/ACNKXOQ5hmrc6x5MGIx/KDLPLzmXeO4axWTIqO4PWz+Kq2miRKyn7QAzNBYG2Lb/AvVpPys= +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"; + + + + + + + + + + +Get related fields data (database-related-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.api.mdx new file mode 100644 index 00000000000..0fcc8114f1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-dataset-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-dataset-related-column-name +title: "Get related fields data (dataset-related-column-name)" +description: "Get related fields data (dataset-related-column-name)" +sidebar_label: "Get related fields data (dataset-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV22P0zgQ/ivW6D7s6rKUPXESCuLDwi1vhzi0LbqTNqviTaatwbGDPSlbovz309hJmr5wQnASn1q/PX6emfHMpIFKOlkiofOQXjegDKRQSVpBAkaWCCnkVtelmYdRAg4/1cphASm5GhPw+QpLCWkDtKl4uyenzBLaNmkgt4bQEK/KqtIql6SsmXzw1vDc9mzlbIWOFHoeLZQmdEcwE1Am13WBc1WEnYqw9KONyhAu0fHObkY6Jzc8ruQSj+/klblXX44ub5Hs7QfMCRIgRZonlkhzh1oSFvNOStsGjpDCpxrdZmvET9DesPF8ZY2PKn+7f59/vtNGua3joQJ97lTFhyCF2QoFWZJamLq8RSfsQnQcxVrqGj0kR0zg0Neadiy6ex3ekZPHrwtLokSShSQpFtYNNzIY7BuQLYp3X+E+Pimi24XDyqFHQ8EyW7xtVARl3wCoCjSkFgrdESv8h6evIshVsNJV58TDIPsmhHB22oVLAngny0rjyKXnW3dc34SA2lXVQYn4LgUbnYEe/FA4lej97gPZvuND/41IDwfhiSwEZwf0lIqXZi21KsQ2vYjK2bUqsIAjmkZno5bzn6vlnZE1raxTX7BIxUVNKw6ceL8YUuARIeODUcmDn6vkjSWxsLUpUhGfQzAysrm9rV2OorDohbEk8E6x+Q9FDRh8y+8/O85eGkJnpBYe3RqdQOesS8WFEbXBuwpzVhcmhc3z2n3FU88kZ8mwL1zuMa+dok0ogx8+x9d3kwDJJZdG+EOS9EgebhK4O8ttgdNALtZNLc2Sa+W7q9eQgJa3qLfDaGge106Ls3/E88uZyGBFVKWTiba51CvrKX14/+HDiazUZH0+KeJ1ky5/TZpRGW4zEFmWGSHOXogMLrqICx5IxROUDp345eLp08vpdD7768/LNxkA1+OO5dsNrUIi7XkOEwNTVVbWUR8uPjOZ6YuXeDxM31sinTAP8YNykgiyQlmg84+bPVEZpCKDTlgG4lch8xy9n5P9iKbNzGlmKqcMnfQk73EgnpyejmW/kms5DREwkr4zuXWUNZ7VD4rlZ6lILJDyVRD8P8htdjSn/Vjse5TFv++d2kThs6D7fTzR8g8b4VFmIvFQiHvSeybpNlmN97RdnvDW00ehO9l9H8+RhuK5UKgLH2FPOm1n3eJZlHbG0k4hgRJpZYvYHkESe8kUvskw7IHwpuObqh076KidYZ/ta14WBa5R26pEQ112CP6PQE3lLNnc6jadTBqGatOGo7w9QHtae7JlD8H9hVPyVmPfGAWY2G8sZKjUgSYkgKYuOVt0Q/4JGWMX/8Vs9lYMOG0CzGYXb9B7QG4a0x6vsdWEdeLl29DHWrcHctRU3fmwu23Z8X3qC11JFBkSYAO3IeyeWVdKxnv19wy6lp9fSVzdtlJBdJvw4bnDhUO/+l6Q0EYv7GFPN60rdB7HvdVoimMn7lufR5N4KmWoSF0j/r1hvcNiKF7cyE4qLZXh20KcNV3IX4OsFFM659MRPHw/BXhIIB1/WN30MXANTXMrPb5zum15On5I8HvYozBUYNgab5fPR9yET4+hQYbwzvtojqDK8/8C0oXUHg+Ebm85uer6nlPxtQv7dthsxnf2RMZ62xuO+pD6Ao244yLPMSTi/uxBa8H8hwzz/JIjiRuukUuGeOr+MPpRXk0Td8Rc2g40Q01hgm37L3Y2PSY= +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"; + + + + + + + + + + +Get related fields data (dataset-related-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.api.mdx new file mode 100644 index 00000000000..b6b716dffad --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-query-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-query-related-column-name +title: "Get related fields data (query-related-column-name)" +description: "Get related fields data (query-related-column-name)" +sidebar_label: "Get related fields data (query-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV22P0zgQ/ivW6D7s6rKUPXESCuLDgpa3Q8Bti+6kzap4k2lrcOwwdsqWKP/9NHaSpi+cEHzgU+u3x88zM56ZNFBJkiV6JAfpdQPKQAqV9CtIwMgSIYXc6ro08zBKgPBzrQgLSD3VmIDLV1hKSBvwm4q3O0/KLKFtkwZyazwaz6uyqrTKpVfWTD46a3hue7YiWyF5hY5HC6U90hHMBJTJdV3gXBVhp/JYutFGZTwukXhnNyOJ5IbHlVzi8Z28Mnfq69HlLZK9/Yi5hwS88ponlujnhFp6LOadlLYNHCGFzzXSZmvEz9DesPFcZY2LKv+4f59/ftBGua3joQJdTqriQ5DCbIXCWy+1MHV5iyTsQnQcxVrqGh0kR0xA6Grtdyy6ex3eeZLHrwtLokQvC+mlWFgabmQw2DcgWxTvvsF9fFJEtwvCitCh8cEyW7xtVARl3wGoCjReLRTSESv8j6evIshVsNJV58TDIPsuhHB22oVLAngny0rjyKXnW3dc34SA2lXVQYn4LgUbnYEe/FQ4lejc7gPZvuND/41IDwfhiSwEZwd0PhUvzVpqVYhtehEV2bUqsIAjmkZno5bzX6vlvZG1X1lSX7FIxUXtVxw48X4xpMAjQsYHo5IHv1bJG+vFwtamSEV8DsHIyOZ2tqYcRWHRCWO9wDvF5j8UNWDwLX/+6jh7aTySkVo4pDWSQCJLqbgwojZ4V2HO6sKksHle0zc89Uxylgz7wuUO85qU34Qy+PFLfH03CXi55NIIf9dILOImgbuz3BY4Ddxi2dTSLLlUvr96DQloeYt6O4x25nFNWpz9K55fzkQGK++rdDLRNpd6ZZ1PH95/+HAiKzVZn09C+Zh0yWvSjGpwm4HIsswIcfZCZHDRhVswfyqeoCQk8dvF06eX0+l89vavyzcZABfjjuO7jV+FLNqzHCYGnqqsLPk+VlxmMtNXLvF4mL63RH/CPMRPiUkixAplgeQeN3uSMkhFBp2sDMTvQuY5Ojf39hOaNjOnmalIGX/SU7zHMXhyejoW/Uqu5TQ4fyR8Z3LrJGscax/0yi9SebFAn6+C3J8W2+woTvux2PcmS//QO7SJsmdB9Yd4ouUfNsGjzETaoQL3lPcM0m2yGu9puzzhraePQluy+zCeox+q5kKhLlyEPQnKzrqlsyjsjIWdQgIl+pUtYlcESWwhU/gOo7Dtw0OOL6kmds1RC8M+09e8LApco7ZVicZ3KSF4PgI1FVlvc6vbdDJpGKpNG47u9gDtae28LXsIbipIyVuNfTcUYGKTsZChPAeakACauuQU0Q35J+SJXfwXs9k7MeC0CTCbXbxB7wG5acx1vMZWE5bEy3ehebW0B3LUVN35sLtt2el9vgutSBQZsl4DtyHknlkqJeO9+mcGXZ/P7yOubvunILpN+PCccEHoVj8KEnrnhT1s5KZ1heRw3FCNpjh24r71eTSJ86UMZajrvn8spHc4DPWKe9dJpaUyfFeIsqYL92uQlWJC55AMHwAdOCSQjr+kbnr/X0PT3EqH70m3LU/Hg/wW9ggMJRe2httl8wk34Vtj6IghvO8+kiOocvy/gHQhtcMDmdtbTq66RudUfOvCvv81m/GdPZGx3vaGIz6kvEAj7rjIcwzptz970Esw/yG3PL/kKOIOa+SQIZa6P4x+lFfTxB0xh7YDzVBJmGDb/gfBzTf7 +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"; + + + + + + + + + + +Get related fields data (query-related-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.api.mdx new file mode 100644 index 00000000000..5f0c13e0b67 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-report-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-report-related-column-name +title: "Get related fields data (report-related-column-name)" +description: "Get related fields data (report-related-column-name)" +sidebar_label: "Get related fields data (report-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV9tu2zgQ/RVisA8JVqmbRRcIVPQhLdLbFt0idrELRIHLSGObLUWqQ8qNK+jfF0NKsnzpomgf+mTzdnjOzHBm1EAlSZbokRykNw0oAylU0q8gASNLhBRyq+vSzMMoAcLPtSIsIPVUYwIuX2EpIW3Abyre7jwps4S2TRrIrfFoPK/KqtIql15ZM/norOG57dmKbIXkFToeLZT2SEcwE1Am13WBc1WEncpj6UYblfG4ROKd3YwkkhseV3KJx3fyytypr0eXt0j27iPmHhLwymueWKKfE2rpsZh3Uto2cIQUPtdIm60RP0N7y8ZzlTUuqvzj4UP++UEb5baOhwp0OamKD0EKsxUKb73UwtTlHZKwC9FxFGupa3SQHDEBoau137Ho7nV470kevy4siRK9LKSXYmFpuJHBYN+AbFG8/wb38UkR3S4IK0KHxgfLbPG2URGUfQegKtB4tVBIR6zwP56+jiDXwUrXnRMPg+y7EMLZaRcuCeC9LCuNI5eeb91xcxsCaldVByXiuxRsdAZ69FPhVKJzuw9k+44P/TciPRyEp7IQnB3Q+VS8MmupVSG26UVUZNeqwAKOaBqdjVrOf62W90bWfmVJfcUiFZe1X3HgxPvFkAKPCBkfjEoe/Volb60XC1ubIhXxOQQjI5vb2ZpyFIVFJ4z1Au8Vm/9Q1IDBt/z5q+PslfFIRmrhkNZIAokspeLSiNrgfYU5qwuTwuZ5Td/w1HPJWTLsC5c7zGtSfhPK4Mcv8fXdJuDlkksjXGNlyQt+uUWt0cFtAvdnuS1wGkjG+qmlWXLNfH/9BhLQ8g71dhgNzuOatDj7V7y4mokMVt5X6WSibS71yjqfXjy8uJjISk3W5xMK1066NDZpRtW4zUBkWWaEOHspMrjsAi84IhVPURKS+O3y2bOr6XQ++/uvq7cZAJfljuS7jV+FfNrTHCYGoqoMoruocZnJTF/DxJNh+sES/QnzED+nJokYK5QFknvS7GnKIBUZdLoyEL8Lmefo3NzbT2jazJxmpiJl/EnP8QGH48np6Vj1a7mW0xAHI+U7k1s3WeNY/CBYfpHKiwX6fBX0/rzaZkdy2o/Fvj9Z+4fepU3UPQuyP8QTLf+wDR5nJvIO1bjnvGeRbpPV+EDb5QlvPX0cWpTdR/IC/VBBFwp14SLsSZR21q2dRWVnrOwUEijRr2wRWyRIYj+ZwveYhc0fnnV8TjWxd44aGfa5vuFlUeAata1KNL5LEMH5EaipyHqbW92mk0nDUG3aMJn2AO1Z7bwtewhuMUjJO419bxRgYsuxkKFYB5qQAJq65ITRDfknJItd/Jez2Tsx4LQJMJtdvEHvAblpzHy8xlYTlsSrd6GVtbQHctRU3fmwu23Z7X32C41JFBlyYAN3IeieWyol473+ZwZd189PJK5uu6kguk348JxwQehWPwoSOumFPWzrpnWF5HDcXo2mOHbivvV5NInzpQxFqevFfzCod0gM5Ytb2UmlpTJ8WQizpgv4G5CVYkbn4bspWJv/BHRIIB1/Wd32EXADTXMnHb4n3bY8Hb8k+DXsMRhKMGxNt0vnE27Ct8fQIUN4430sR1Dl+H8B6UJqhwc6t7ecXHeNz6n41oV9P2w24zt7ImO97S3HfEh7gUbccZnnGHJwf/agt2D+Q3p5ccVxxB3XyCNDNHV/GP0or6aJO2IebQeaoZwwwbb9D66JPiM= +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"; + + + + + + + + + + +Get related fields data (report-related-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.api.mdx new file mode 100644 index 00000000000..350920d6d45 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-rowlevelsecurity-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-rowlevelsecurity-related-column-name +title: "Get related fields data (rowlevelsecurity-related-column-name)" +description: "Get related fields data (rowlevelsecurity-related-column-name)" +sidebar_label: "Get related fields data (rowlevelsecurity-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zgM/isCcR8anNOshx1QeNiHbujebtiKJsMdUBeZYjOJNlnyJDltZvi/Hyj5LS897LYB+5RIokg+DymSrqDghufo0FiIbyoQCmIouFtDBIrnCDGkWpa5mvtVBAa/lMJgBrEzJUZg0zXmHOIK3LYgceuMUCuo66iCVCuHytEpLwopUu6EVpNPViva6+8WRhdonEBLq6WQDs0RnREIlcoyw7nIvKRwmNuBoFAOV2hIstnhxvAtrQu+wuOSdDK34uvR416TXnzC1EEETjhJGyt0c4OSO8zmDZS69j5CDF9KNNuexC9Q3xJ5ttDKBpR/PHpEP9/JUarLcClDmxpR0CWIYbZG5rTjkqkyX6BheskaH9mGyxItREcoMGhL6XYY3TWH987w4+b8EcvR8Yw7zpbadBZJGewTSIzi/QO+D2+yEHZmsDBoUTnPTK+vzwqP7BsUigyVE0uB5ggL/xHp66Dk2rN03QTxMMm+SYO/O23SJQK853khcRDSsz4cN7c+oXZRNapYeJeMSCdFj38onXK0dveB9O/4MH4Dp7uL8IxnjKoDWhez12rDpchYX15YYfRGZJjBEUyDuwHL2a/F8kHx0q21EV8xi9lF6daUOME+60rgESDDiwHJ41+L5J12bKlLlcUsPAdPMhLdVpcmRZZptExpx/BeEP2HoDodZOXPX51nr5VDo7hkFs0GDUNjtInZhWKlwvsCU0LnN5lO09I8EKkXnKqkl/PGLaalEW7r2+Cnu/D6biNwfEWtEa71HXuLG5Rs2kreRnA/TnWGU+9m6KCSqxV1zQ/XbyECyRco+2WgnNalkWz8D3t5OWMJrJ0r4slE6pTLtbYuPn90fj7hhZhsziZG30my2zo4aUrapBp05joBliSJYmz8iiVw0SShD0rMniE3aNhvF8+fX06n89n7vy7fJQDUoht3r7Zu7Wtr63C30bks8kIb12aQTVSi2n7Gnnbbpyt0J+QH+1m4oqBtjTxDY59We+gSiFkCDcIE2O+MpylaO3f6M6o6UaNEFUYod9J6e0pJejIaDfG/4Rs+9dkx4GBnsw+dVpZo6KDzOy4cW6JL1x75z8Rd7YCP2zXbjzGx8LENcxUYmHkCPoYbNf0QG08SFRD4bt16v8dNI6Qlnkq9OiHR0RM/wuw+opfoug67FCgzG9Se7IMcN1LjgHFMGEcQQY5urbMwTEEUJs8Y/h9VFBxfCsIDLA3F7mgIYN//t3TMMrKhixyVa4qKT42gqCqMdjrVso4nk4pU1XFFL6E+0Pa8tE7nrQoaS4zgC4ntPOXVhDFlyX2D925CBKjKnIpMs6QfCwdsv5rNrlinp46AvNnV1+E9cG4aqiWdEWtMG/b6yo+/2uwpOUpVc99L1zWlQhsVP8wEkL5uVrDwifhCm5yTvjd/z6D5UqAHFE77CcyDriO6PDe4NGjX36vET99LfTgKTssCjcXhSDbYotwJcpuzQIl1OfeNrJnffzjRd9zpmh8NwpNCcqHIrE+4qnkEN8ALQb6d0VfXnhX/IebtQATx8Avtts2KG6iqBbf4wci6pu3wRUIvZM+XrpVDT+euY59x679hukkbfC1o8zsoFZb+ZxAvubR4gLi3cnLdDFAj9pDBdq5W26HN1pEh3vqW3oEvj96NIHGRpuirdnv3YEYh/7vi8/KScosmt0Fsugxr/pD2o35VVZAI9bbu3PQNiBys638BqtNcww== +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"; + + + + + + + + + + +Get related fields data (rowlevelsecurity-related-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.api.mdx new file mode 100644 index 00000000000..c63d6088b65 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-saved-query-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-saved-query-related-column-name +title: "Get related fields data (saved-query-related-column-name)" +description: "Get related fields data (saved-query-related-column-name)" +sidebar_label: "Get related fields data (saved-query-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zgM/isCcR9anLO0hx1QeNiHrui67oat12S4A+oiU20mUSdLriRnzQz/9wMlv+Vlh2Eb0E+JJJJ6HpIi6QoKbniODo2F+KYCoSCGgrslRKB4jhBDqmWZq5lfRWDwoRQGM4idKTECmy4x5xBX4NYFiVtnhFpAXUcVpFo5VI5OeVFIkXIntBrfW61or9ctjC7QOIGWVnMhHZo9NiMQKpVlhjOReUnhMLcDQaEcLtCQZLPDjeFrWhd8gfsl6WRmxde9x70lfXePqYMInHCSNhboZgYld5jNGip17TFCDA8lmnXvxAeob8l5ttDKBpZ/HB3Rzw/6KNVlUMrQpkYUpAQxTJfInHZcMlXmd2iYnrMGI1txWaKFaI8LDNpSug2Pbl6Hj87w/df5I5aj4xl3nM216W4kY7DtQPIoPn4D+1CThbAzg4VBi8p5z/T2+qzwzL7DoMhQOTEXaPZ44X8ifR2MXHsvXTdB3E2y77LgdSdNukSAjzwvJA5CetyH4+bWJ9Qmq8YUC++SkdPJ0POfSqccrd18IP073o3fAHSnCK94xqg6oHUxu1QrLkXG+vLCCqNXIsMM9nAa6AYux0/L5aPipVtqI75iFrPT0i0pccL9rCuBe4gMFQOT50/L5L12bK5LlcUsPAfvZCR3W12aFFmm0TKlHcNHQe7fJdXZoFv+fOo8u1QOjeKSWTQrNAyN0SZmp4qVCh8LTImd32Q6TUvzjUi95lQlvZy/3GJaGuHWvg3efwmv7zYCxxfUGuHvEg2RuI3gcZTqDCceW2ibkqsFtcqP1+8gAsnvUPbL4Gdal0ay0b/s4nzKElg6V8TjsdQpl0ttXXxydHIy5oUYr47Hlq8wm/kmMm5K2LgadOI6AZYkiWJs9IYlcNoknQ9CzF4hN2jYb6dnZ+eTyWz64a/z9wkAteQG6dXaLX0tbbF2Gx1akRfauDZjbKIS1fYv9rLbfrZAd0A42C+gFAVDS+QZGvuy2iKWQMwSaMglwH5nPE3R2pnTn1HViTpMVGGEcgct0GeUjweHh0Pqb/mKT3wiDOhvbPYB08qSBzrW/AsXjs3RpUtP+hdRrjZ4x+2abUeWHPCpDW4VyE89909Bo6YfcsSLRAXwvie3wLfc0ghpic+kXhyQ6OELP6hsPpULdF0fnQuUmQ1mDzy/kec3agRGgd6I6B1CBDm6pc7CtARRGC1j+G4HUTT8Mw/vrDQUrL0+h23U7+iYZbhCqYsclWsKhs+FYKgqjHY61bKOx+OKTNVxRVlf71g7K63TeWuCRg4j+J3EdlbyZsIIMue+eXuYEAGqMqcC0izpx1eRTftvptMr1tmpIyA0m/Y6vjvgJqES0hl5jWnDLq/8aKvNlpG9rmr0vXRdUwK01dAPKoGkr4kV3Pn0e61Nzsne23+m0HwF0IsJp/105UnXESnPDM4N2uWPGvGT9VzvjnmTskBjcThuDbYod4Lc6ji4xLqc+ybVzOY/k94bSLqeRvPtuJBcKLrR51rVpP4N8EIQrGNi3Ke//7TyV0AE8fCb67bNhRuoqjtu8aORdU3bQZHexRaMrjlD78RNTJ9x7b9KutkZ/LtvszoYFZb+ZxDPubS4Q7a/5eC6GYkO2bcubCdltR7e2QIZ8q1vKft9KfQwgsRpmqIvzq3uztRB+Ltqc3FOGUWz2CAsXV41f8j6XlxVFSRCba07mL7PEMC6/g8j/0i1 +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"; + + + + + + + + + + +Get related fields data (saved-query-related-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.api.mdx new file mode 100644 index 00000000000..d64e8858c8b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-tag-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-tag-related-column-name +title: "Get related fields data (tag-related-column-name)" +description: "Get related fields data (tag-related-column-name)" +sidebar_label: "Get related fields data (tag-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV22P0zgQ/ivW6D7s6rKUPXESCuLDgpa3Q4C2RXfSZlW8ybQ1OHawJ2VLlP9+GjtJ0xfuEHzgU+u3x88zM56ZNFBJJ0skdB7S6waUgRQqSStIwMgSIYXc6ro08zBKwOHnWjksICVXYwI+X2EpIW2ANhVv9+SUWULbJg3k1hAa4lVZVVrlkpQ1k4/eGp7bnq2crdCRQs+jhdKE7ghmAsrkui5wroqwUxGWfrRRGcIlOt7ZzUjn5IbHlVzi8Z28Mvfq69HlLZK9/Yg5QQKkSPPEEmnuUEvCYt5JadvAEVL4XKPbbI34GdobNp6vrPFR5R/37/PPD9oot3U8VKDPnar4EKQwW6EgS1ILU5e36IRdiI6jWEtdo4fkiAkc+lrTjkV3r8M7cvL4dWFJlEiykCTFwrrhRgaDfQOyRfHuG9zHJ0V0u3BYOfRoKFhmi7eNiqDsOwBVgYbUQqE7YoX/8PRVBLkKVrrqnHgYZN+FEM5Ou3BJAO9kWWkcufR8647rmxBQu6o6KBHfpWCjM9CDnwqnEr3ffSDbd3zovxHp4SA8kYXg7ICeUvHSrKVWhdimF1E5u1YFFnBE0+hs1HL+a7W8N7KmlXXqKxapuKhpxYET7xdDCjwiZHwwKnnwa5W8sSQWtjZFKuJzCEZGNre3tctRFBa9MJYE3ik2/6GoAYNv+fNXx9lLQ+iM1MKjW6MT6Jx1qbgwojZ4V2HO6sKksHleu2946pnkLBn2hcs95rVTtAll8OOX+PpuEiC55NIIM/69SeDuLLcFTgOxWDO1NEuuk++vXkMCWt6i3g6jkXlcOy3O/hHPL2cigxVRlU4m2uZSr6yn9OH9hw8nslKT9fmE5HLS5a1JMyq/bQYiyzIjxNkLkcFFF2nB8ql4gtKhE79dPH16OZ3OZ2//unyTAXAd7hi+29AqJNCe4zAxsFRlZR31YeIzk5m+aInHw/S9JdIJ8xA/ISWJACuUBTr/uNkTlEEqMuhEZSB+FzLP0fs52U9o2sycZqZyytBJT/AeB9/J6elY8iu5ltPg9ZHsncmtg6zxrHxQK79IRWKBlK+C2J+U2uzoTfux2PckC//QO7OJomdB84d4ouUfNsCjzETSofD2hPfM0W2yGu9puzzhraePQjey+x6eIw3FcqFQFz7CnpBcnnULZ1HWGcs6hQRKpJUtYisESewbU/hfg7DVw9uN76d27JSjtoV9lq95WRS4Rm2rEg11WSD4PAI1lbNkc6vbdDJpGKpNG47q9gDtae3Jlj0E9xFOyVuNfQMUYGJfsZChIgeakACauuSs0A35J2SHXfwXs9k7MeC0CTCbXbxB7wG5aUxvvMZWE9aJl+9Cv2rdHshRU3Xnw+62ZYf3KS50H1FkSHQN3IZwe2ZdKRnv1d8z6Fp7fhlxddsyBdFtwofnDhcO/epHQUK7vLCHvdu0rtB5HPdQoymOnbhvfR5N4qmUofJ0DfePhPMOg6FAcbM6qbRUhm8KMdZ0oX4NslJM5xxCoQjfRwEaEkjHH043ve+voWlupcf3TrctT8cPBX4He9cPFRa2Rtvl8gk34dNiaIAhvOs+iiOo8vy/gHQhtccDkdtbTq66vuZUfOvCvt01m/GdPZGx3vaGoz2kukAj7rjIcwxJtz970Dow/yGrPL/kCOKGauSOIY66P4x+lFfTxB0xd7YDzVA/mGDb/gtQ3S/W +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"; + + + + + + + + + + +Get related fields data (tag-related-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.StatusCodes.json new file mode 100644 index 00000000000..de3f23619c2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"id":{"type":"integer"},"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"id":1,"name":"string"},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.api.mdx new file mode 100644 index 00000000000..65ae3e576fe --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-permissions-by-pk +title: "Get security permissions by pk" +description: "Get an item model" +sidebar_label: "Get security permissions by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isHYh8STI2TogMKFf3gZmmbru2C2l0HRIFLS2eLjUSqJOXEE/TfhyMlWbaVNmsH5FPCt+M9zz13PLliCZpYi8IKJVnIXqEFLkFYzCFXCWYsYAXXPEeL2rDwsmKC9hXcpixgkudIo2sWMI1fS6ExYaHVJQbMxCnmnIUVs+uCdglpcYma1XVQsVhJi9LSMi+KTMScPBh9MeRG1TtcaFWgtgINjWKVlbl0/5KPpmfeWC3kktVBO8G15msaX+N6+wTKMmfhJTOpupm1JoM+Fb3ZjM8x643dIStshkSAksiugu/5sJlQ8y8YWxYwbyFkS7QzcmzWQK5ps+P4a4l6vSH5K6uviGVTKGk8G4+Pjz0pP8TlENw7CJ95H6odtUxThN4MLJQGmyL4Q0CHjuCTyDKYI1jNpcm4xQTma5gTqyxgeMvzwhExhvci/pY9tkfzHq1EXTLsp5O0SPaN7Eb4v1Pgzv8v4Ics3Q+2RlNmdt95T8duBraiqljOb9+iXNqUhSfHx0NXbfL60p+6ulvMF6hzYYxQclyIoyU617aybI/AMWTCWFAL2KTY/VO7l4wDlt0CWAUaZYL6/uGYpOoGzkkxv6PlIjP3C0Jn4M7k2tLSPSTfCLq9dUCrgxYHdbSlErJ60tWWDcHbwbpsV662qR4gyNWt7QC49YVWObxzT0kdsCc/VbFyNIYvcUAZ34lGd5C94AmQotHYEM7limcigc0LB4VWK5FgMoSnd9ZjOXlYLB8lL22qtPgHkxDGpU1R2uZ+6NJ2AEj/oEfy5GGRvFcWFqqUSQhUUBuSkeg2qtSUIwoNSGUBbwXRvw+qs+EQPX780LEptIppOM8QKC52HcJfJDcfH9Ra6SEcp6rMEge1sdCcpqt+e+j0OZcWteQZGNQr1B5FCGMJpcTbAmMKmpsEFcelvkOAL7nlWUdBwAzGpSaM1GB+ubEsvLyibsfypatCk2YdNg+MoZpE6Bz286RppVpLs2KzczZfz1yLevsoVglOHC7fzGZcLlnI4o8f3rbFdTP00qNxqTN49De8OptCxFJri3A0ylTMs1QZGz49fvp0xAsxWp2M2vtHvftHJxGDKIokwKPXELFxk3zO8xBeINeo4Zfx6enZZDKb/vnH2fuIMeqSG/cu1jZVsudgN9G5KPJCadtmjolkJNtWEZ530/QkH5Af8KM4An86RZ6gNs+rHTQRCyFiDaKIwa/AY9LwzKprlHUkDyNZaCHtQevdEan24PCwj/cNX/GJk0sP89bkJjRKGoLdQeU3XFhYoI1Th/RncFZbYMN2DLsxJNSf2zBWHvHUAf7sT9T0h9A/i6T3OOGWd97ucNFsUhkeZWp5QFsPn7nuP0ebqkbq7suM+jb2TSxVcV0TYS5fvehLTXwO0sJ2M/UtLUOCK8xUkaO0Tea7cHlDVaGVVbHK6nA0qshUHVakxnrP2mlprMpbEwFbcS2oQLZdtzPj26cFd52Kc5N6s+aTrRnSH1cBtu2/nk4voLNTB4y82bbX4d1zbuJLGq1RWwRKw/kFGSEs20YGqWrOu911TeFqAzKhguxBuuJWsbkTy0ulc0723nyasuaLmUTtVzc9pwNdB3R4pnGh0aQ/asR9XC7Ufrc8KQvUBvvdfG+KtOP3rU48Jcbm3L02TQtJvxy0eKEnQGqwXfHduq73hg3+5tD4bPHWjoqMC9e9OrlVjeovGS8EeXbCeu9HwHpXs4CFxTWpxMvgklXVnBv8qLO6pmn/hU0pcadzd/lyjWv3TU4azkpadwnaCtobFe71T1i44JnBb1Bw8KHp1g7hrgvbLx+57t/ZOlJcs/qK9O5KlbvdL4zjGF3FbI/sNQxbdeXVGWmIusNel9ApqfmHrA+6U1V+h699deedK/7kYF3/CxDjZJw= +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.api.mdx new file mode 100644 index 00000000000..ad4cbe38877 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-permissions-info +title: "Get security permissions info" +description: "Get metadata information about this API resource" +sidebar_label: "Get security permissions info" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/isHYh8STI2bYgMCFf2QBmmbrduC2V0HWIZLS2eLDUWqJOXGFfTfhyMlR7KdFGsGdJ8kkXfH57k3nmqWoU2NKJ3QisXsNToo0PGMOw5CLbUpOG0BX+jKgcuFhfPrKzBodWVSZBErueEFOjSWxdOapVo5VI7FNeNlKUXq9UcfLdmvmU1zLDi9lUaXaJxA62WzbJ5qWRWq+xSkx+X1QGyoVPIV0tNtSmQxE8rhCg1rIr8zt+LLwe0m6pb04iOmjh1awEy4/xeiG9z4M4TDwr+gqgoWTwe+2wEesaWQPjYRK9EUwlqh/TopOeEkdirdh9IK2Wx7vnVGqFUPEDeGbw5AjliwELMVujnlzrwNdkPCgtLrU4VmQ2fwggQ/sWYWMYO21MoGBz57+pQe/00WfTWoewKdt/YsB6V5AN6LwVCq2x4W1SRHCIaBBE7gvZASFgjOcGUld5jBYgMLvkDJDjieTuBOmwctByEq1RvcgNNQWQStQArr4C4Jdow/kHj3xbkZZtJBTJVFAz0pWGpzsHls/fhvs42CecuLUuJ+3PcDPYzsIJbTupntUpp2OGY+dYf8rhwWsDS6gN90hpKQ/PSopC3Q2mHbeCg6PdZbRfaSZ2DwU4XWxXCl1lyKDO4aM5RGr0WGGTvAp6cbuJx+Xy7vFK9cro34glkM55XLUbn2fA9UmMNE+oqeybNn35tJaXRKnwuJQCzcJoa/KDiBDRqjzSEqF7qSGSjtoLXQatNRP3/vZLtSDo3iEiyaNZrAIoZzBZXC2xJT6md+EXSaVuaecL3ijsutCyJmMa0McaQp4uNnx+LpjK4Hx1e+JMftPlz3SnXWdUeh1VXW3j2dpXmvqOf+RmIRu32S6gzHnleYWCRXKxaz9N2fb1nEpO/C28+2U8UsrYyEJ3/D68sJJCx3roxHI6lTLnNtXXz29OxsxEsxWp+OuvNHvfNH/vyEQZIkCuDJG0jYeZuuHn0ML5EbNPDD+cXF5Xg8n/zx6+XvCWNNtIV4vXG5Vj2Q24UtTFGU2riuoG2iEtXdr/Biu3yyQndEOOAxXKJgIUeeobEv6h1GCYshYS2rhMGPwFPK5bnTN6iaRB0nqjRCuaMO4Qll79HxcZ/zL3zNxz5terwHi3ch0soS9S1d/pkLB0t0ae7ZPpZrPSAcd9+wG0ti/qELZx1YTzzpD0GjoQd54HmiAmo/cHeId/zRCmmJJ1Kvjkj0+LkfnQp0uW7T3o/iLmcx+zof8pov3lABlSGnHvQN2y3bt7QNGa5R6rJA5do24GMWDNWl0U6nWjbxaFSTqSauKS2bPWsXlXW66ExEbM2NoG7ZzVbeTJgxlrySroVJM2s7/Laf9PDtYGj/zWRyDVs7TcQIzdDelu8euHHob7RHswJoA1fXfv7RZsfIQVe1+l66aSheXUTG1J0DSd/parbw2fLK/29Rgr+fUIy8GIvb3bvxzZNuIlKeG1watPm3GvGj+VLvz3HjqkRjsT/Y95Yod4Lc+jS4xLqCq7sh2P9KdnwHsyC0GTg4rnehfctPaEvJ4a0blZILRZh8NtZtVUwZLwUBP2W9u2b3ryhUx6zLkymr6wW3+M7IpqHl8ANDNXMv+vvQ3ODG//JQksuK9n0Jdxnvr7uIhd7iTwgK52mKvs11Wnu3/aARvL6kmNMg1Lvit5FvX8h6N1+rTc92XQeJ0KyoXAMI37FZQ+PwPwnupqM= +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.StatusCodes.json new file mode 100644 index 00000000000..bee995032a1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"id":{"type":"integer"},"permission":{"properties":{"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get.Permission"},"view_menu":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get.ViewMenu"}},"type":"object","title":"PermissionViewMenuApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"id":1},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.api.mdx new file mode 100644 index 00000000000..ecf1774159e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-permissions-resources-by-pk +title: "Get security permissions resources by pk" +description: "Get an item model" +sidebar_label: "Get security permissions resources by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFWFFv2zYQ/isHYg8JpsRJ0AKFij64Wdqma7ugTtsBceDS0tliI5EqSTnxBP334UhJlm25zdoOeUpI6o7f9/HueHTJYjSRFrkVSrKQvUQLXIKwmEGmYkxZwHKueYYWtWHhVckEfZdzm7CASZ4hjW5YwDR+LYTGmIVWFxgwEyWYcRaWzC5z+kpIi3PUrKqCkkVKWpSWlnmepyLihGDwxRCMsmOca5WjtgINjSKVFpl0/xJG03FvrBZyzqqgmeBa8yWNb3C5boGyyFh4xUyibieNy6ArRWc25VNMO2NnZIVNkQRQEtl18D0Mqwk1/YKRZQHzHkI2RzshYJOackUfO42/FqiXK5G/suqaVDa5ksarcXJ05EX5IS376O4QfOIxlBvRcpkgdGZgpjTYBMEbARkdwieRpjBFsJpLk3KLMUyXMCVVWcDwjme5E2II70T0LX9sS+YtWUm6uB+nC2kRbzvZPOH/LoGz/yXk+zzdj7ZGU6R2G7yXYzMDA5ajzoQxwofIuk3DNON3b1DObcLC46OjPhirnL/yVte7A/2i3fGjwNu3KIthLg7naA9XK4RsIfB2kqEs7gXs5PH/CKwZfzOBd5oTmbUKsxU8Q0iFsaBmsCov9y9rnULU49ktgFWgUcao7x+Ko0Tdwjllyx9ouUjN/QKwdbCzsKzl0T3SvU7mZteePO312JtDaxlCXo+3Dueq2eh6XdoeQVyNXhfcrc+0yuCtuzargD36qeqcoTF8jj2R8B31W0P2nMdAiYDGhnAuFzwVMaxuc8i1WogY4z4+HVvP5fhhuXyQvLCJ0uIfjEMYFjZBaev9oc32HiJdQ8/k0cMyeacszFQh4xDo8qhFRpLbqEJTTig0IJUFvBMk/zap1odjdHLy0GeTaxXRcJoi0LnYZQgfKdz8+aDWSvfxOFVFGjuqtYfamrZ6/NDpcy4taslTMKgXqD2LEIYSCol3OUZ0aG4SVBQVekcAvuCWp60EATMYFZo4UjP95day8OqaOjvL564Kjep1WF0sBpSE93V4GNijiwbopjH7VK2It1PlPK4bymaPyeqaN5Mmvsxkupy4lv3uIFIxjhx339ynXM5ZyKIP7980BXc19OY0LnQKB3/Dy7NLGLPE2jwcDFIV8TRRxoZPjp48GfBcDBbHgwbJoIPkoEUyOB4zGI/HEuDgFYzZsE5VxyaE58g1avhteHp6NhpNLv/68+zdmDF6P9RAL5Y2UbIDtZ1owYosV9o2eWbGciybJhqetdN0Ye8RDvh5RoH3kyCPUZtn5QavMQthzGpuYwa/A48o9idW3aCsxnJ/LHMtpN1rcB5StO/t73eZv+YLPnJh1mG/Nrk6LiUNCdCS5rdcWJihjRLH+dcwLtdoh80YNs+V+H9ujrb03C8d9c/eoqI/pMPTsfTYY255i3tDlfojleJhquZ79On+U/dWytAmqk4J946lhpHdk1WZ31Qkost9nxyFJo17pWKbWf+GliHGBaYqz1Dauoq4I/SOylwrqyKVVuFgUJKrKiwpVqstb6eFsSprXARswbWgYtu8Vpwb33rNuOtyHEzq6+qnbj2kP4Zqxrr/V5eXF9D6qQJGaNb9tXy3wI18eaQ16sRAaTi/cG8MpTec9EpV27uvq4oOrjmaERV3T9IVypJNXdi8UDrj5O/1p0tW/9JAge5XV/2qI10FZDzRONNokh914h7lM7XdaY+KHLXB7ougM0Wx479bHHtJjM24XD1m3C8uDV/ohGLbDhhq0125Xtu4czP2/mpTo7d4Zwd5yoXrgV3glXUmXDGeC8J4zDq3Uvdp2MkHFrAwv6HI8aFxxcpyyg1+0GlV0bT/tYLSZCfMXahucOl+36C4Tgtad+nbBLl3Klx3EbNwxlOD3xBj733dDe7Drg2bl5RcdvdsgOQ3rLqmHHCFzO3uF4ZRhK6yNiZbDcla1Xl5RnFF3WenC2mjq/6HvPfCKUv/ha+MVYvOXRIEsKr+BTwO3m0= +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.api.mdx new file mode 100644 index 00000000000..a6605cab956 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-permissions-resources-info +title: "Get security permissions resources info" +description: "Get metadata information about this API resource" +sidebar_label: "Get security permissions resources info" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/iuHwz4kmBI3xQYUKvohDdI2W7cFddoOiAKXls42W4pUScqNK+i/D0e9RLKdDu0KdJ8kkXfH57k3nirMyKVWFl4ajTE+Jw85eZEJL0DqhbG54C0Qc1N68Cvp4PTyAiw5U9qUMMJCWJGTJ+swvq4wNdqT9hhXKIpCyTToT947tl+hS1eUC34rrCnIekkuyGbZLDWqzHX3KVlPqMuR2FipEEvip98UhDFK7WlJFuso7Myc/Lx3u466JTN/T6nHfQuUSf//QvSBNuEM6SkPL6TLHOPrke+2gEe4kCrEJsKCbC6dkyass5KXXlGn0n1oowlv+vOdt1IvB4CEtWKzB3KEjYUYl+RnnDuzNtg1C0tOr48l2Q2fIXIW/Ij1TYSWXGG0axz48MEDfnyfLPrXoO4IdN7asdwozRrggxiMpbrtcVFdrQgaw8ACx/BWKgVzAm+Fdkp4ymC+gbmYk8I9jucThDf2i5YbIS7VD7QBb6B0BEaDks7DXRJsGf9C4t0X53qcSXsxlY4sDKRgYeze5tH78WuzjYN5K/JC0W7cdwM9juwoltdVfbNN6brDcRNSd8zvwlMOC2ty+MNkpBjJL/8paXNybtw2vhSdAeteEZ+KDCx9LMn5GC70WiiZwV1jhsKatcwowz18BroNl5Mfy+W1FqVfGSs/UxbDaelXpH17fgAq7X4iQ8XA5OHDH82ksCblz7kiYBZ+E8MbDk7Dhqw1dh+VM1OqDLTx0FpotfmoX390sl1oT1YLBY7smmzDIoZTDaWm24JS7mdhEUyalvaecD0TXqjeBRE6SkvLHHmKeP/JY3x9w9eDF8tQktN2Hy4HfcVoeNV2EwcHbyR9gj9Il+6Qb7C+JV5k7a3UnTEblPusa0duFm4tjPD2KDUZTQP3ZqpRQi8xxvT1q5cYoQqduv9su1mMaWkVHP0Nz8+vIMGV90U8mSiTCrUyzsePHjx6NBGFnKxPJh2SyQDJUY9kEpAkCEmSaICjF5DgaZvcgVEMT0lYsvDT6dnZ+XQ6u/rr9/M/E8Q66sFebvzK6AHcfqEHLPPCWN+Vv0t0orvbGJ70y8dL8geMA74Pq6ixtSKRkXVPqi1uCcaQYMsvQfgZRMo1MPPmA+k60YeJLqzU/qDDesxZf3B4OGT/m1iLaUi3gQdGi3dhM9qxE3ri4pOQHhbk01Xg/f1YVyPqcfcN2/FlH7zrQlw1/K8C/XeNRs0P9sXjRDf4w8jeYd/yTCtkFB0rszxg0cPHYfjKya9MWx5hmPcrjPFrmLEnQyNoKqW07Oi9/sLtFvCStyGjNSlT5KR921JCHBtDVWGNN6lRdTyZVGyqjitO2nrH2lnpvMk7ExGuhZXcebs5LZhp5pWFKJVvYfL82w7S7Sc/HDeQsf0XV1eX0NupI2Q0Y3s93x1w06ZX8h7PHWAsXFyGWcrYLSN7XdXqB+m65sh1sZlyp29Ihq5Z4TzkzbPw78ZJ//aKYxTEMG5370bBQLqOWHlmaWHJrb7VSBjzF2Z3JpyWBVlHw5+EwRLnTiO3Pmlc4nwu9N1AHX5LO76jubLPRYA2F0cHD67Jb/m1bcl5uvWTQgmpGV3Iy6qtlGsUhWQKJzi4wUbj5F29YIRNxdx0uXONVTUXjl5bVde83PwgcR3dy+M+XB9oE36pOPFVyfuhwLsqCNdphE3nCSc0CqdpSqEddlo708SoTTw/5zzgQWswQvTZ0L6w9W5+15uB7apqJJpWxiXcgAidHWset/8BrpTMDA== +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.StatusCodes.json new file mode 100644 index 00000000000..51d8204b03f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"id":{"type":"integer"},"permission":{"properties":{"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get_list.Permission"},"view_menu":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get_list.ViewMenu"}},"type":"object","title":"PermissionViewMenuApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.api.mdx new file mode 100644 index 00000000000..07bd1ca36d1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions-resources.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-permissions-resources +title: "Get security permissions resources" +description: "Get a list of models" +sidebar_label: "Get security permissions resources" +hide_title: true +hide_table_of_contents: true +api: eJzFWNtu2zgQ/ZUBscAmWDdOii1QqOhDWvSSbi9Bk7YLxIFLS2ObDUWqJJXEFfTviyElmYrlIL0s+mSL5AznzOVwyIplaFMjCie0Ygl7gQ44SGEd6DnkOkNp2YgV3PAcHRrLkrOKpVo5VI4lFeNFIUXKSXz8xZKOitl0iTmnf4XRBRon0NJXqmWZK/9XOMz9H7cqkCXMOiPUgtWjdoAbw1f0PRcy7BsJbagd1KQLMzh+yWWJ3na1ejf3gJo1qsxnaFg92pTqRmZaS+QqHmpsPa/rETP4tRQGM5acecOCGe2m5x0+PfuCqRsCfIGrPlpUZU7qKCrT1ocjpk2GJvqWfIYy+o4CG68iJU44iWzElFaxTduDEO817Gu/IBMG05BJa7O5TRtrBrcq+AIjlUI5XPgY+JmpFd+2TFuUmK4d8h1JVd+MwogFjyRsgW7qXdTkcE2LBVXG1xLNinzGc1r4ldXnFG1baGVDHt7f3w/p+IPFUQahfkGeLhGcdlyCwVSbDPw60ArcEmHG0wtUGRttZPBg+LdU5DRgGto6GoG5Nn7TIAQktAefhJQwQ3CGKyu5wwxmK5hRLrIRw2ueF96xh/BWpLfpYxu5sREmCkVmNw097AiLMgBEZkdQWpyXEq6WqGClS8i0+tPBhdJXMQZBrrs7F/VL7Pu96eV/iR+HNN3Ngz0WucWVa8r4Dv+syWVAs58Ap8GgytDcHfNrMunIWzFAIH0evAURl1JfYdYiI0usNu67EBq0pdxSpmEO5kbnPioLdGHvljq2nF8i28J/aHJhbUOnfZk2x3J+/RrVwi1ZcrC/P5QA8YHkpTbOoDX7HXc7fhR49QZVeViIvZYT99bT/hgVeDXNUZV3su7+g//bunbwVn6/Xccdjoo6SsyOtA+20m2PEu5Agi3FnbVOOh9gnUGlg4ywUe89vVG19mvsRknFQm0BnFXU7/TPGZYwryGUwBtqHsmCv3/qXMzR2n6LcBu7RbHpBNkTngElGlqXwJG65FJksG5poTD6UmSYsQFAkWzAcvB7sXxQvHRLbcQ3zBI4LN0SlWv2h66aBoDEgh7J/fu/G0lhdEqfM4lAKNwqgY8UnIAGjdFmCMpTXcoMlHbQaGikaasHvzvZjpRDo7gEi+YSTUCRwKGCUuF1gSkdc34QdJqWZku4nnPq+VoXULebloYw0nXlyxVV4Dl1oI4vfIWeNPOwZjhLXeJ7tLo0KVrYIcYDojy7S5VMuL1XjrKm8W33mK5PHjs1rQI2Ytf3Up3hiUcdboKSqwVLWPrh/ev2CrL+DIL0XRoJ9/6FF89OYcKWzhXJeCx1yuVSW5c83H/4cMwLMb48GLc2jCMb7nU2jCcMJpOJArj3EibssMloDyOBJ8gNGvjj8OnTZycn09N3/zx7O2H+ptbYebxyS60iS7uBzlaRF9q4tubtRE1U2+XD426YjowdsgN+GtAoqFkiz9DYx9UNWBOWwIQ10CYM/gKeUs5Pnb5AVU/U7kQVRii305q5R1m+s7sbA3/FL/mJT68IfG9wHSytLOHvMPMrLhzM0aVLD/mXAK56qJP2G25GleB/bgNbBeinHvnnIFHTD7nh0UQF0zPueGf2Dac0i7TEPakXO7R095G/yuXolrqpBP/iQV0LuyMo8p8v91AVpSH3DnqJ3Sz01zQNGV6i1EWOyjXE4aMXFFWF0U6nWtbJeFyRqjqpKEvrDW1PS+t03qqgZwcjiF/bttOrCe3rnPuD3JtJ7XZzXW8+6ccSTfT1vzw9PYZOTz1iZE1fX4d3w7iTwIg0R70LaANHx77TpTa8p2TQVY28X13XFLQ2LCfE5wGk58aKzXzKPNcm56Tv1adTipFfRo84fnZ9m/Cg6xEJTw3ODdrljyrx7wVzvXlFOCkLNBbjbjQaotwJ6y4Pgkusy7lad9P+aa7FC1EaQszQvS2jY3Dbw15jusNrNy4kF75l9FlXNSVwxnghyMADFp1C8e0kKgQ2YpQzISnOWFXNuMUPRtY1DYd7EBXIVjO3mXSBK//o0r3eMV+0bXr703DEApv4HYLAYZqiZ7dWaqMZ6JX+i2cUYOqTog6gC3PzJ3ov5GoV6a6qsCLQE9VmMMITtX8erP8DDz14Dw== +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"; + + + + + + + + + + +Get a list of models + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.StatusCodes.json new file mode 100644 index 00000000000..6967236bb32 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"id":{"type":"integer"},"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.api.mdx new file mode 100644 index 00000000000..b899485923d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-permissions.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-permissions +title: "Get security permissions" +description: "Get a list of models" +sidebar_label: "Get security permissions" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isHYsASTI2TYgMKFf3gBmmbLmuDOV0HxIFLS2ebDUUqJOXEFfTfhyMlW4rlIGkH9JPNlzvec/fc8aiSpWgTI3IntGIxe4sOOEhhHegZZDpFaVnEcm54hg6NZfFlyRKtHCrH4pLxPJci4SQ++GpJR8lsssCM07/c6ByNE2hplGhZZMr/FQ4z/8etcmQxs84INWdV1ExwY/iKxjMhw7ktoS21vZp0bnrnl1wW6G1Xq48zD6jeo4psioZV0bbUemaqtUSu2lO1rVdVFTGDN4UwmLL40hsWzGgOvVrj09OvmLg+wNe46qJFVWSkjqIyaXwYMW1SNK2x5FOUrXErsO1dpMQJJ5FFTGnVtml3ENpn9fvab0iFwSQwaWM2t0ltTe9ROZ9jS6VQDuc+Bn5lYsW3HcsWJSYbhzyBVNX9KEQseCRmc3QT76KawxVtFpQZNwWaFfmMZ7TxhlVXFG2ba2UDD58fHgY6fmdyFEGom5AXCwSnHZdgMNEmBb8PtAK3QJjy5BpVyqItBveGf0dGTgKmvqNbMzDTxh8ahICEDuCzkBKmCM5wZSV3mMJ0BVPiIosY3vEs944dwgeRPKSPbXFjK0wUitRuGzpcFyxiAIjURlBYnBUSbheoYKULSLX61cG10rdtDIJc9/ha1E2xp3vTy/8vfuzT9DgPdqrIA67clIwn+GdTXHo0+wVwGgyqFM3jMZ+RSafeip4C0q2DDyDiUupbTBtkZInVxj0JoUFbyB1pGtZgZnTmozJHF85uSseO+0uk/QWu4VHG785Qzd2CxUeHh31Bbl86XmrrntlUuHM0mbBWaDXMxUFT7x5RJKtWSNbl6mhnoekkwyPSv0nuywbYVU++9SrtzYUtpnf0tnjaZdc9MrWFmtBflnTTdyssi5nXEIL/F7VNZMHvP3QjZGht93J8KK9bsVkLstc8BSIHWhfDqVpyKVLYNHOQG70UKaasB1BLNmA5+rlYPileuIU24humMQwLt0Dl6vNhnQE9QNqCHsnz5z8bSW50QsOpRCAUbhXDPxScgAaN0aYPyrEuZApKO6g11NJ01B8/m2ynyqFRXIJFs0QTUMQwVFAovMsxoQLvJ0EnSWF2hOsNp26ncQH1eUlhCCM16l9vKQOvqPdyfO4zdFSvw6ayWcpXQuexn6Z1Y9domuStnRG7e5boFEceUXjfSK7mLGbJp7/PmsZ6M7S6MAnhTQoj4dm/8PbkAsZs4VweDwZSJ1wutHXxi8MXLwY8F4Pl0aA5edA6eTBmMB6PFcCzdzBmw5qj3uQYXiM3aOCX4fHxyWg0ufj458mHMfOvjtq685VbaNWybz2xtlBkuTauyWI7VmPVdKzwaj1Nl8Ae2QHfCSMKwgvkKRr7qrwHZsxiGLMa0JjBb8AT4u7E6WtU1Vjtj1VuhHJ7jXEHxNa9/f023Pd8yUeeJi3InclNYLSyhHqNlN9y4WCGLll4oD8As+xgjZsx3I8ggf7SBLEMgC883i9BoqIfAv9yrILBKXd8bew9V9SbtMQDqed7tHX/pX+CZOgWuma4f6lTn8AehEK+8ika2F4YcmWvR9j95DyjZUhxiVLnGSpXJ7uPVFBU5kY7nWhZxYNBSaqquCQeVlvajgvrdNaooEeyEVQTmybJqwnN1oz7y9ebSc1h/bish/Tjk76r/93FxTms9VQRI2u6+tZ4t4wbhSpGa9RvgDZweu7fpdQ0dpT0uqqW97urikLVBGNENTiA9PWsZFNPlDfaZJz0vf98QTHy2+iTg1/d9L4edBWR8MTgzKBdfK8S/7qd6e2GdlTkaCy2O8fWFHEn7FseBZdYl3F/wdS9GX1IavBCt952DmpdWLs+PtUGO7xzg1xy4Zs7z7Wypvsl47kgs45Y676IWPdc4kcgwCUryym3+MnIqqLp0KFTMuw0bpch17jynwPW35WYT8uGyv62ilioF/6EIDBMEvRVq5Hauqw7yf32hIJJfUzrhl6HtP7T+pLF1aqluyzDjlCAKA+DEb4A+w9X1X+GcfTT +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"; + + + + + + + + + + +Get a list of models + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.StatusCodes.json new file mode 100644 index 00000000000..f6642d93a45 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"ViewMenuApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"id":1,"name":"string"},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.api.mdx new file mode 100644 index 00000000000..b57437ae3a5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-resources-by-pk +title: "Get security resources by pk" +description: "Get an item model" +sidebar_label: "Get security resources by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFWNtu2zgQ/ZUBsQ8JVo2ToAUKFX1ws2mbbm+o03aBKHBpaWypoUiVpJx4Bf37YkhJlm2lzWYXyFPCywznHJ4ZjlyxBE2ss8JmSrKQvUILXEJmMYdcJShYwAqueY4WtWHhRcUy2ldwm7KASZ4jja5YwDT+KDONCQutLjFgJk4x5yysmF0VtCuTFheoWV0HFYuVtCgtLfOiEFnMKYLRd0NhVD3jQqsCtc3Q0ChWosyl+5diND33xupMLlgdtBNca76i8RWuNi1QljkLL5hJ1fW0dRn0qejNCj5D0Rs7I5tZgUSAksgug1/FsJ5Qs+8YWxYw7yFkC7RTCmzaQK5ps+P4R4l6tSb5B6sviWVTKGk8G8eHh56Ue3E5BPcWwqc+hmpLLecpQm8G5kqDTRG8EZDRAXzNhIAZgtVcGsEtJjBbwYxYZQHDG54XjogxvM/in/ljOzTv0ErUJcNxOklnya6T7Rv+9xQ4+/8F/JCnu8HWaEphd4P3dGxnYCuqiuX85i3KhU1ZePzkcOiodV5feKvL28X8JcPrdyjLcZEdLNAFtpFjO/SNQWTGgprDOsHunti9VBzw7BbAKtAoE9R3v4xJqq7hjPTyB1qeCXO3K+gc3JpaG0q6g+AbObenDih10OOgijY0Ql6PusqyJnjzsi7alctNqgcIclVr8wLc+lyrHN65h6QO2OP/VK9yNIYvcEAZv7iNzpC94AmQntHYEM7kkossgfX7BoVWyyzBZAhPz9ZjOXpYLJ8lL22qdPY3JiGMS5uitM350CXtAJC+oUfy+GGRvFcW5qqUSQhUThuSkeg2qtSUIwoNSGUBbzKifxdU58MhOj5+6LsptIppOBMIdC92FcIXkpu/H9Ra6SEcJ6oUiYPaeGis6agnD50+Z9KillyAQb1E7VGEMJZQSrwpMKZLc5Og4rjUtwjwJbdcdBQEzGBcasJI7eX3a8vCi0vqdSxfuCo0adbhU6MHA3v00gA9NWafyhMBdTScJU1P1TqdtiIy09lq6jrVm0exSnDiAPqeVnC5YCGLP39621bZ9dCb07jUAh79Ba9OzyFiqbVFOBoJFXORKmPDp4dPn454kY2WR6P29FF3+ugoYhBFkQR49BoiNm5y0EUdwgvkGjX8Nj45OZ1Mpucf/jx9HzFGrXIT3MeVTZXshddNdAFmeaG0bRPIRDKSbb8Iz7tpepn3KA64H4rA26bIE9TmebWFJWIhRKzBEzH4HXhMQp5adYWyjuR+JAudSbvXxnZA0t3b3++jfcOXfOI000O8Mbm+FiUNge6A8mueWZijjVOH8/4oqw2oYTuG7fsjzN/aK6w83nMH95u3qOkPYX8WSR9vwi3vYt1iotmkBB4ItdijrfvPXPufo01VI3H3aUaNG/sJkqq4qoksl7Be7KUmLgcpYdup+paWIcElClXkKG2T+u6qvKOq0MqqWIk6HI0qclWHFemw3vF2Uhqr8tZFwJZcZ1Qh26bbufH905y7VsWFSc1Z88XWDOmPobzf9P/6/PwjdH7qgFE0m/46vDvBTXxNozXqi0BpOPtITgjLppNBqhp7t7uu6bLa65hQRfYgXXWr2MxJ5aXSOSd/b76es+aDmQTtV9dNpwNdB2Q81TjXaNL7OnHflnO12y5PygK1wX4z35si7fh9yyNPibE5d89N00PSDwct3u7dNtRfu5K7cVjvCRv8waGJ2OKNHRWCZ655dWKrGsVfMF5kFNcR6z0frsP1B7OAhcUVKcRL4IJV1Ywb/KxFXdO0/7imdLg1tNsiucKV+xwn/YqS1l1qtmL2TjP39CcsnHNh8CcE7H1qWrV9uO3A9rNHrvpntoEUV6y+JK27IuVO9wvjOEZXKVuTnW5ho6K8OiX9UGvYaxE6FTX/kPfBcKrK7/BVr+6ic0WfAqzrfwBimmDV +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.api.mdx new file mode 100644 index 00000000000..a6d6412063b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-resources-info +title: "Get security resources info" +description: "Get metadata information about this API resource" +sidebar_label: "Get security resources info" +hide_title: true +hide_table_of_contents: true +api: eJzNV1Fv2zYQ/isHYg8JpsZNsQGFij6kQdpm67agdtsBVuDS0tliQ5EqSblxBf334UhJkWynxdoB3ZMk8u74fbyPx1PNMrSpEaUTWrGYvUAHBTqeccdBqJU2Bacp4EtdOXC5sHB2dQkGra5MiixiJTe8QIfGsnhes1Qrh8qxuGa8LKVIvf/kg6X4NbNpjgWnt9LoEo0TaL1tli1SLatCdZ+C/Li8GpmNnUq+Rnq6bYksZkI5XKNhTeRnFlZ8PjjdRN2QXn7A1LFDA5gJ9/9CdINbv4ZwWPgXVFXB4vlo73aAR2wlpM9NxEo0hbBWaD9OTk44iZ1L96G0Qnbdr2+dEWo9AMSN4dsDkCMWIsRsjW5B2lm0yW7IWJC8PlZotrQGL8jwI2uuI2bQllrZsIGPHj6kx3+joq8mdc+g2629yMFpEYAPcjC26qbHh2qWI4TAQAYn8E5ICUsEZ7iykjvMYLmFJV+iZAc2nlbgTpsvRg5GdFRvcAtOQ2URtAIprIM7EewE/4Lw7stzM1bSQUyVRQMDK1hpc7B49Pv4b9VGybzlRSlxP+/7iR5ndpTLed1c71KadziuvXTH/C4dFrAyuoA/dIaSkPzyXaIt0Npx2fhSdgase0f2jGdg8GOF1sVwqTZcigzuCjOURm9Ehhk7wGfgG7ic/lgubxSvXK6N+IxZDGeVy1G5dn0PVJjDRIaOnsmjRz+aSWl0Sp9LiUAs3DaGt5ScwAaN0eYQlXNdyQyUdtBGaL1pqV9/tNgulUOjuASLZoMmsIjhTEGl8LbElOqZHwSdppW5J13PueOy34KIWUwrQxypi/jwybF4fk3Xg+NrfySn7Ty8bsuHhaO3Aj/BH6gqe0xXVl8DL7P2GuqCLrqaYxf+amIRu32Q6gynnmBoXSRXaxaz9M3rVyxi0pfj/rMtWTFLKyPhwd/w4mIGCcudK+PJROqUy1xbFz9++PjxhJdisjmddKtP+tUnfvWEQZIkCuDBS0jYWatajzyGZ8gNGvjp7Pz8YjpdzP76/eLPhLEm6gFebV2u1QBiP9CDFEWpjevOtU1UorprFp72wydrdEeEA76dSRT8c+QZGvu03uGTsBgS1nJKGPwMPCVBL5y+QdUk6jhRpRHKHXX4TkjCR8fHQ8a/8Q2feu0MWI8G79KjlSXiPVn+iQsHK3Rp7rl+H9N6RDfuvmE3j8T7fZfKOnCeecrvg0dDD+L/JFEBs++5O7w7u9EaaYknUq+PyPT4ie+eCnS5buXuu3GXs5h9jQ3tmD+9QfmVoQ09uC9s99y+omnIcINSlwUq19YBn68QqC6NdjrVsoknk5pCNXFNgmz2op1X1umiCxGxDTeCymXXXPkwoclY8Uq6FiY1rW33237Sw1IRGMd/OZtdQR+niRihGcfr+e6Bm4YCR3PULIA2cHnlGyBtdoIc3KrW31s3DWWry8eUynMg6UtdzZZeK8/9DxeJ+92McuTNWNzO3vVvnnQTkfPC4Mqgzb81iO/NV3q/kZtWJRqLw85+METaCXab07Al1hVc3XXB/l+y49v3fBag1d9oscF99i3/oC0hh7duUkouFCHyWqzbEzFnvBQE+5QNrhr/8xFwsYiFk3HdaWTO6nrJLb4xsmloOPy90Hm5F/t9WG5w6/93SOCyonl/eDu1+7suYqGq+BWCw1maoi9vndfeVT8qAS8uKN/UBQ3u9z7r7QtF75prtR3ErutgEcoUHdUAwldq1lAv/A+BZaPP +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.StatusCodes.json new file mode 100644 index 00000000000..2337cd4fec9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"ViewMenuApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.api.mdx new file mode 100644 index 00000000000..248315efe67 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-resources.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-resources +title: "Get security resources" +description: "Get a list of models" +sidebar_label: "Get security resources" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zgM/iuEcMC1uKxpixsweNiHrOi23u0NS7cd0BSZYjOJVlnyJDltZvi/HyjZjt04Rds7YJ8SvZDiQz6kKBcsQRsbkTmhFYvYa3TAQQrrQM8h1QlKywYs44an6NBYFl0ULNbKoXIsKhjPMiliTuLD75Z0FMzGS0w5/cuMztA4gZZGsZZ5qvxf4TD1f9w6QxYx64xQC1YO6gluDF/TeC5kOLcltKW2V5POTO/8isscve1q/WHuAVV7VJ7O0LBysC3VzMy0lshVe6qy9bIsB8zgj1wYTFh04Q0LZtSHXjb49Ow7xq4P8BWuu2hR5Smpo6hMax8OmDYJmtZY8hnK1rgV2PYuUuKEk8gGTGnVtml3ENpn9fvab0iEwTgwaWM2t3FlTe9RGV9gS6VQDhc+Bn5lasXPHcsWJcYbhzyAVOXtKAxY8EjEFuim3kUVh0vaLCgzfuRo1uQzntLGH6y8pGjbTCsbeHh8eBjo+MjkyINQNyHPlwhOOy7BYKxNAn4faAVuiTDj8RWqhA22GNwb/h0ZOQ2Y+o5uzcBcG39oEAISOoCvQkqYITjDlZXcYQKzNcyIi2zA8IanmXfsCN6L+C59bIsbW2GiUCR229BRU7CIASASO4Dc4jyXcL1EBWudQ6LV7w6ulL5uYxDkuvvXom6KPdybXv5/8WOfpvt5sFNF7nDlpmQ8wD+b4tKj2S+A02BQJWjuj/ktmXTmregpIN06eAciLqW+xqRGRpZYbdyDEBq0udyRpmEN5kanPioLdOHsunTsuL9E0l/gah6l/OYtqoVbsuj46WFfkNuXjpfaumc2Fe6LwOt3qPJRJg7qanePElm2AtIUq6OdZaaTCvdI/jq1L2pYlz3Z1qu0NxO2eN7R22Jpl1u3qNQWqgN/UdA9362vLGJeQwj9O2qayII//9N9kKK13avxrqxuxaYRZC95AkQNtC6CM7XiUiSwaeUgM3olEkxYD6CWbMBy9GuxfFY8d0ttxE9MIhjlbonKVedDw/8eIG1Bj+T4+FcjyYyOaTiTCITCrSP4QsEJaNAYbfqgnOhcJqC0g0pDJU1HPf3VZDtTDo3iEiyaFZqAIoKRglzhTYYxlXc/CTqOc7MjXK849Tq1C6jLi3NDGKlN/35NGXhJnZfjC5+h42odPqHVuYnRwh6VOKAaZ/cpdQmod8NZUnV4tdKpqYXYgN08iXWCYw8tPHMkVwsWsfjzp7d1f70ZBkEa50bCk3/g9ek5TNjSuSwaDqWOuVxq66Jnh8+eDXkmhqujYX3usDl3OGEwmUwUwJM3MGGjiqre3AheIjdo4LfRycnpeDw9//D36fsJ80+PyraPa7fUqmVdM9HYJ9JMG1cns52oiarbVnjRTNNdsEd2wKNADILoEnmCxr4obkGZsAgmrIIzYfAH8JgIPHX6ClU5UfsTlRmh3F5t2gFRdm9/vw32L77iY8+VFuDO5CYoWlnC3ODk11w4mKOLlx7mo0EWHaRRPYbb0SPI3+oAFgHuuUf7LUiU9EPQn09UMDfhjjem3nJEtUlLPJB6sUdb95/7N0iKbqkrZvunOjUK7A4g5Cefo4HluSE39nqD3c7Ot7QMCa5Q6ixF5aps91EKiorMaKdjLctoOCxIVRkVxMByS9tJbp1OaxX0RjaCimLdI3k1odeac3/7ejOpN6zeltWQfiylelf/m/Pzj9DoKQeMrOnqa/BuGTcOZYzWqOEAbeDso3+WUs/YUdLrqkre7y5LClQdijEV4QDSF7SCzTxNXmmTctL319dzipHfRl8c/Oqm9fWgywEJTw3ODdrlY5X4x+1cb/ez4zxDY7HdOLamiDth3+oouMS6lPsbpmrO6DtSjRfaVbZzTOu+2vXlqTLX4Y0bZpIL39t5phUV1S8YzwQZdcRa14Xv2JpTiRsh+BesKGbc4mcjy5KmQ3NOibDTtF1mXOHafwloPikxn5A1jf1VNWChUvgTgsAojtFXq1pq66bupPXrUwokNTGt67kJZ/Wn9RGLq3VLd1GEHaH0UA4GI3zh9d+syn8BeEPxDA== +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"; + + + + + + + + + + +Get a list of models + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.StatusCodes.json new file mode 100644 index 00000000000..b6932ecbf13 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetRoleApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"id":1,"name":"string"},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.api.mdx new file mode 100644 index 00000000000..ef18864c82d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-roles-by-pk +title: "Get security roles by pk" +description: "Get an item model" +sidebar_label: "Get security roles by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isHYh8STI2bohsKFf3gZmmbruuK2l0HRIFLS2dLDUWqJOXEE/TfhyMlWbblNu0G5FPCt+M9zz13PLliCZpYZ4XNlGQhe4kWuITMYg65SlCwgBVc8xwtasPCy4pltK/gNmUBkzxHGl2zgGn8UmYaExZaXWLATJxizllYMbsuaFcmLS5Rs7oOKhYraVFaWuZFIbKYkwejz4bcqHqHC60K1DZDQ6NYiTKX7l/y0fTMG6szuWR10E5wrfmaxte43j6BssxZeMlMqm5mrcmgT0VvVvA5it7YHbKZFUgEKInsKviWD5sJNf+MsWUB8xZCtkQ7I8dmDeSaNjuOv5So1xuSv7D6ilg2hZLGs/Ho4UNPyg9xOQT3AOEz70O1o5ZpitCbgYXSYFMEfwjo0Al8zISAOYLVXBrBLSYwX8OcWGUBw1ueF46IMbzN4q/ZY3s079FK1CXDfjpJZ8m+kd0Ifz8F7vz/An7I0t1gazSlsPvOezp2M7AVVcVyfvsG5dKmLPz18dBNm7S+9IeuDmt5UhaoDdr3SuC4yE6W6HzbSrM9BscgMmNBLWCTY3fP7V42Dlh2C2AVaJQJ6rvHY5KqG7ggyfyGlmfC3C0KnYGD2bUlpjtovlF0e+uAWActDgppSyZk9bQrLhuCt4N12a5cbVM9QJArXNsBcOsLrXL4w70ldcAe/6eSlaMxfIkDyvhGNLqD7DlPgDSNxoZwIVdcZAlsnjgotFplCSZDeHpnPZbT+8XyQfLSpkpn/2ASwri0KUrb3A9d4g4A6R/0SB7fL5K3ysJClTIJgSpqQzIS3UaVmnJEoQGpLOBtRvTvg+psOESPHt13bAqtYhrOBQLFxa5D+Ivk5uODWis9hONMlSJxUBsLzWm66pf7Tp8LaVFLLsCgXqH2KEIYSygl3hYYU9DcJKg4LvUBAb7glouOgoAZjEtNGKnD/HxjWXh5Re2O5UtXhSbNOtDTYqgaES6H+iJpuqjWxkzTntl8PXN96e2DWCU4cVh8Byu4XLKQxR/ev2kL6mbo5UbjUgt48De8PJ9CxFJri3A0EirmIlXGhk8ePnky4kU2Wp2O2ptH7ubRacQgiiIJ8OAVRGzcpJrzNoTnyDVq+Gl8dnY+mcymf/5+/jZijJrixrF3a5sq2XOtm+icy/JCadvmiYlkJNvOEJ510/QAH5Ef8P0IAn8uRZ6gNs+qHRwRCyFiDZaIwc/AY9LqzKprlHUkjyNZ6Ezao9avE1Ln0fFxH+lrvuITJ4se2q3JTTiUNAS4A8lveGZhgTZOHcYfQ1htwQzbMezGjfB+akNXeaxTB/WTP1HTH8L9NJLe14Rb3vm5w0KzSQk8EWp5RFuPn7oGP0ebqkbS7uOLWjN2AEVVXNdEkstFL+5SE4eDVLDdLHxDy5DgCoUqcpS2yWoXIm+oKrSyKlaiDkejikzVYUXaq/esnZXGqrw1EbAV1xkVv7aldmZ8a7TgrgtxblLf1XyPNUP643J82/6r6fQddHbqgJE32/Y6vHvOTXy5ojVqeUBpuHhHRgjLtpFBqprzbnddU6DaUEyo2HqQrnBVbO5k8kLpnJO91x+nrPkcJiH71U0/6UDXAR2eaVxoNOmPGnFfjgu13wm3jflAr06BQm38vtWpp8TYnLuXpGkP6WeBFi846VHb7Mrr1kW9l2nwp4TGW4u3dlQInrme1AmtapR+yXiRkU+nrPcqBMxdygIWFtekDB/6S1ZVc27wgxZ1TdP+k5nS4KBbh7y4xrX7yCbdipLWXTq2IvZGM/eaJyxccGHwK+CP3jfd1zEcurD9kpHr/p2tI8U1q69I464wudv9wjiO0VXG9sheA7BVRV6ek26o2+u9+p16mn/I+qA7VeV3+EpXd965Ik8O1vW/269QgQ== +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.ParamsDetails.json new file mode 100644 index 00000000000..5c0c197a9fc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"role_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.StatusCodes.json new file mode 100644 index 00000000000..7824f647872 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"id":{"type":"integer"},"permission_name":{"type":"string"},"view_menu_name":{"type":"string"}},"type":"object","title":"RolePermissionListSchema"}},"type":"object"},"example":{"result":{"id":1,"permission_name":"string","view_menu_name":"string"}}}},"description":"List of permissions"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.api.mdx new file mode 100644 index 00000000000..973532db566 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-by-role-id-permissions.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-roles-by-role-id-permissions +title: "Get security roles by role_id permissions" +description: "Get security roles by role_id permissions" +sidebar_label: "Get security roles by role_id permissions" +hide_title: true +hide_table_of_contents: true +api: eJzFV1Fv3DYM/isCsYcEc+Kk6IDARR/SIE3TFW2Qu2wD4uCqs3lntbLkSvIlmeH/PlCyfb7cFVi3AnmyRVPU95EUSTdQccNLdGgsJLcNCAUJVNwVEIHiJUICRkuciRwiMPitFgZzSJypMQKbFVhySBpwjxWpCuVwiQba9o60baWVRUsKL46O6JFp5VA5euVVJUXGndAq/mK1ItnaYGV0hcaJsNugraXblot81+ERVGhKYa3QahZIDErWGaGWpLMSeD8rUdXfU2mjXqLnXzBzEIETTpLgWku8Gs74IKybBOTbm9oI8IGXlcRNIgT9eAfS/vhtgGtgdEqONjOiIvdBAgSB6QVbm7N08sv/5fUSreXLf+WaTZbDRnjDc0ZZg9Yl7FKtuBQ5W6ccq4xeiRxz2MFptDdwOX5eLjeK167QRvyNecJOa1egct35bLgaO4iMNwYmL5+XyUft2ELXKk/YtMDeyUjutro2GbJco2VKO4YPgty/TWqw4Rm9ePHcsamMzmg5l8goLu4xYX9QuoX4oDHa7OJxpmuZe6qdhW43HfXbc1+fS+XQKC6ZRbNCE1gk7FSxWuFDhRkFzQuZzrLafCcB33LH5eCCCCxmtSGOVPG/3DtIbu+oYju+pC4Ak+47ozpn4S4C4uVZX+aQwBLdrLcxo/ZgZ/PwMhP5bFyDIng4yHSOE08utBjJ1RISyG6uP0AEks9Rrpch/2hdG8kO/mIX51OWQuFclcSx1BmXhbYuOTk6OYl5JeLVcdxDiT2UuOmAtPEISZwCS9NUMXbwjqVw2l1Izylhb5AbNOyX07Oz88lkNv30+/nHFKCNBrRXj67QaoR3EAyIRVlp4/rbZFOVqr4FsteD+HCJbo9wsJ9EKwrGCuQ5Gvu6eUIuhYSl0BFMgf3KeEZpPnP6K6o2VfupqoxQbq8He0iJvbe/P6b/nq/4xGfUyAUbwnXgtLLkhYE5v+fCsQW6rPDEfyLtZoN70q/Z0wiTEz73QW6CA6ae/+ewo6UHOeNVqgKBnDs+gH/imk5JSzyUerlHqvuvgG7Q5r27QMd6OszTYfPwMqM2uHFPSnSF7i4XRGEES+CHnEJR8HUi3LPaUJB2+hq25gf6zHJcodRVicp1FcfnQDDUVEY7nWnZJnHckKk2aSjj2y1rZ7V1uuxNRLDiRlBhtl2R9GboPccF9/OQhwkRoKpLqkDdkh6+/mzafzedXrHBThsBodm0N/DdAjcJpZS+0VzFtGGXV35o1OaJkZ2u6vZ77dYPun1w/AwYSPqi2sDcp9xbbUpO9t7/OYVuaqabEr7C0Aw86TaizTODC4O2+K9G2giEWuhAZwN9XaGxOB5mRyLKnaC3Og4usa7kvst1M+iPpPTGyUMTdPjg4kpyoegEn1tNl+63wCtBMI5h1KQi/wdCBpP1r8jmSZQiIQduoWnm3OKNkW1L4m81Gmp0d+s09LcjF35WyCFZcGlxC+3Q9GHvupvt9tnazZssOiFXjz7bZU0riOArPo5+oNo7SlVfqzyE8PU0y9BX0H7f1oxBOTaUh4tzCj8NlCOfDknQvZD1nZiaJmiE4tcOEH0zIIBt+w89iOf9 +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"; + + + + + + + + + + +Get security roles by role_id permissions + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.api.mdx new file mode 100644 index 00000000000..95265f4801f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-roles-info +title: "Get security roles info" +description: "Get metadata information about this API resource" +sidebar_label: "Get security roles info" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/iuHwz4kmBo3xQYUKvohDdI2ew1qdx1gBS4tnW02FKmSlBtX0H8fjpIcyXYyLBvQfZJE3h2f5954qjAjl1pZeGk0xviGPOTkRSa8AKkXxuaCt0DMTenBr6SDs6tLsORMaVPCCAthRU6erMN4WmFqtCftMa5QFIWSadAffXJsv0KXrigX/FZYU5D1klyQzbJZalSZ6+5Tsp5QVwOxoVIhlsRPvykIY5Ta05Is1lHYmTn59eB2HXVLZv6JUo+HFiiT/v+F6IY24QzpKQ8vpMsc4+nAdzvAI1xIFWITYUE2l85JE9ZZyUuvqFPpPrTRhNfb8523Ui97gIS1YnMAcoSNhRiX5GecO7M22DULS06vzyXZDZ8hchb8jPV1hJZcYbRrHPjs6VN+/DdZ9LdB3RPovLVnuVGaNcB7MRhKddvDopqsCBrDwAIn8EEqBXMCb4V2SnjKYL6BuZiTwgOO5xOEN/ZBy40Ql+oNbcAbKB2B0aCk83CXBDvGH0i8++JcDzPpIKbSkYWeFCyMPdg8tn78p9nGwbwVeaFoP+77gR5GdhDLaVVf71KadjiuQ+oO+V16ymFhTQ6/mowUI/nhXyVtTs4N28ZD0emx3iriK5GBpc8lOR/DpV4LJTO4a8xQWLOWGWV4gE9Pt+Fy+m25vNei9Ctj5VfKYjgr/Yq0b88PQKU9TKSvGJg8e/atmRTWpPw5VwTMwm9i+IOD07Aha409ROXclCoDbTy0FlptPurHb51sl9qT1UKBI7sm27CI4UxDqem2oJT7WVgEk6alvSdcr4UXauuCCB2lpWWOPEV8+uIxnl7z9eDFMpTkuN2Hd0aR4xtq2/Ius/bW6WzMLMvMwi2EEd4+SU1G48ClmVKU0EuMMX3/7heMUIXOu/1su1OMaWkVPPkT3lxMIMGV90U8GimTCrUyzsfPnz5/PhKFHK1PR93Jo3DyKJycICRJogGevIUEz9rkDIhjeEXCkoXvzs7PL8bj2eT3ny9+SxDraAvuauNXRvfgbRe2AGVeGOu78nWJTnR3m8LL7fLJkvwR44DHsYga3RWJjKx7We1wSTCGBFs+CcL3IFLO2Zk3N6TrRB8nurBS+6MO2wln6dHxcZ/tT2ItxiE9eowHi3dhMdox6S1R8UVIDwvy6SrwfDzLakA17r5hN37M+WMXwqrhOwl0PzYaNT+Y+4tEN3jDSN1h3fFEK2QUnSizPGLR4xdhOMrJr0yb3mHY9iuM8SEm7KlQmE2ml5YdedAfuFuSv/A2ZLQmZYqctG9LPMSpMVQV1niTGlXHo1HFpuq44iSs96ydl86bvDMR4VpYyZ2wm5uCmWZ+WIhS+RYmz6PtYNt+8iMU/ND+28nkCrZ26ggZzdDelu8euHHTu3iP5wAwFi6vwmxj7I6Rg65q9YN0XXOkuliMufM2JEMXq3Ae8uR1+JfipP4w4RgFMYzb3bvRLJCuI1aeWVpYcqvHGglj98Lsz2jjsiDrqD+095Y4dxq59WnjEudzoe8G3PCb2PGFkHsAbe4NDupdU4/5tWzJeLr1o0IJqRlNyMOqrYQpikIy5FPs3SARBkwYYVMR111uTLGq5sLRe6vqmpebHxKuk3tx34fjhjbhF4YTW5W8Hwq2y/JwfUXYdJJwQqNwlqYU2lmntXd7D8r+zQXHmQeb3pW9jXb7wta7eVlverarqpFoWhOXaAMidGasebz9C0Q9kes= +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.StatusCodes.json new file mode 100644 index 00000000000..82cf06a0741 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetRoleApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.api.mdx new file mode 100644 index 00000000000..7d892dbe5cb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-roles.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-roles +title: "Get security roles" +description: "Get a list of models" +sidebar_label: "Get security roles" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isHYsASTI2bohsKFf3gBmmbLmuL2l0HRIFLS2dbDUWqJOXEFfTfhyMlWYrlIOkG9JPNlzs+z73xqJIlaGKd5jZVkoXsNVrgIFJjQS0gUwkKwwKWc80ztKgNCy9KFitpUVoWloznuUhjTuKjr4Z0lMzEK8w4/cu1ylHbFA2NYiWKTLq/qcXM/bGbHFnIjNWpXLIqaCa41nxD40Uq/LkdoR21g5pUrgfn11wU6LDLzfuFI1TvkUU2R82qYFeqnZkrJZDL7lSN9bKqAqbxW5FqTFh44YB5GM2hly0/Nf+KsR0ifIWbPluURUbqyCuzxoYBUzpB3RkLPkfRGXcc291FSmxqBbKASSW7mPY7oXvWsK3dhiTVGPtI2sLmJq7RDB6V8yV2VKbS4tL5wK3MTPp9z7JBgfHWIA8Iquq2FwLmLRKyJdqZM1EdwxVtTikzvhWoN2QzntHGb6y6JG+bXEnj4/DJ48c+HH8wOQov1E/I6QrBKssFaIyVTsDtAyXBrhDmPL5CmbBgJ4IH3b8nI2ee09DRnRlYKO0O9UJAQkfwORUC5ghWc2kEt5jAfANzikUWMLzhWe4MO4Z3aXyXPrYTGztuIlckZhfouC1YFAGQJiaAwuCiEHC9QgkbVUCi5K8WrqS67nJIyXT3r0X9FHu4NZ38/2LHIU33s2Cvitxhym3JeIB9tsVlQLNbAKtAo0xQ35/zOUE6cygGCki/Dt7BiAuhrjFpmBESo7R9EEONphB70tSvwUKrzHllidaf3ZSOPfdXmgwXuCaOMn5zjnJpVyz84+mQj7t3jhPauWa2BW5S5KgN2o9K4DhPj5qCd48qWXV80tar472VppcN98j/JrsvGmqXAwk3qHQwGXZCvae3E6j98LoVTV2hxvcXJV31/RLLQuY0eO//RX0TIXj6n66EDI3p3453JXbHN60ge8kToPBAY0M4k2su0gS23RzkWq3TBBM2QKgj67kc/1wunyQv7Erp9DsmIYwLu0Jp6/OhzYEBIl1Bx+TJk5/NJNcqpuFcIBALuwnhb3KOZ4NaKz1E5UQVIgGpLNQaamk66vefHWxn0qKWXIBBvUbtWYQwllBIvMkxpgrvJkHFcaH3uOsVp3anMQE1enGhiSN16l+vKQMvqfmyfOkydFKvA9U0Q5lKvBzrs6Tu6RodM+32BOzmUawSnDgW/lEjuFyykMWfPp433fR2aFShY+IYF1rAo3/g9ekUIrayNg9HI6FiLlbK2PDZ42fPRjxPR+vjUXPmyJ05ihhEUSQBHr2BiI3riHQwQ3iJXKOGX8YnJ6eTyWz6/s/TdxFzj4wa14eNXSnZQdZOtNjSLFfaNjlrIhnJpkGFF+00lfwDwgEPJhB4sRXyBLV5Ud6iEbEQIlZTiRj8BjymGJ1ZdYWyiuRhJHOdSnvQwDqiqDw4POwSfcvXfOLCoUO2N7l1hpKG+LYc+TVPLSzQxitH8YcIlj2WYTOG214jul8ax5We6tQx/eIlKvoh2s8j6aEm3PIW5i0j1JuUwCOhlge09fC5e2VkaFeqjmT3GKdWgO0hQfZx6eejutBkvkErsNuJd07LkOAahcozlLZOZOcdr6jMtbIqVqIKR6OSVFVhSVFX7Wg7KYxVWaOCXsA6pXrXdEBOje+kFtxdrA4mdX71y7Ee0o9L677+N9PpB2j1VAEjNH19Ld8dcBNfoWiNeglQGs4+uEcndYQ9JYOmquXd7qoiJzVumFB99SRdrSrZ3IXIK6UzTvrefp6Sj9w2+p7gVreNrSNdBSQ807jQaFY/qsQ9XRdqt1ttmsCBvpAchdr4fetjbxJjM+4uj7rvoq9EDV9oKmrviM41tO+bUg3V4o0d5YKnrmVzUVbWIX7BeJ4SoGPWuQUC1pxIMeGdfsHKcs4NftKiqmjat9yUAHth7YNwhRv3vm8/FDGXhE34utsnYL46uBO8wDiO0VWnRmrn8u2l8utTciD1JZ0bt3Vj/afzaYrLTUd3WfodvtxQ7nkQrtC6L1HVv5u+4Lg= +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"; + + + + + + + + + + +Get a list of models + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.StatusCodes.json new file mode 100644 index 00000000000..0be2e07eefd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_by":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get.User1"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_by":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"email":{"maxLength":320,"type":"string"},"fail_login_count":{"nullable":true,"type":"integer"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_login":{"format":"date-time","nullable":true,"type":"string"},"last_name":{"maxLength":64,"type":"string"},"login_count":{"nullable":true,"type":"integer"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetUserApi.get.Role"},"username":{"maxLength":64,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object","title":"SupersetUserApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"active":true,"changed_on":"2024-01-15T10:30:00Z","created_on":"2024-01-15T10:30:00Z","email":"string","fail_login_count":1,"first_name":"string","id":1,"last_login":"2024-01-15T10:30:00Z","last_name":"string","login_count":1,"username":"string"},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.api.mdx new file mode 100644 index 00000000000..b1006f760c3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-users-by-pk +title: "Get security users by pk" +description: "Get an item model" +sidebar_label: "Get security users by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFWFFv2zYQ/isEsYcEU2I7TYdCRR/cLG3TdV1RO+uwOHBp6WyxoUiVpJx4gv77cKRkS7HcJumGPNkieXffd7w7HlnQGEykeWa5kjSkr8ESJgm3kJJUxSBoQDOmWQoWtKHhRUE5rsuYTWhAJUsBv65oQDV8zbmGmIZW5xBQEyWQMhoW1K4yXMWlhQVoWpZBQSMlLUiL0yzLBI8YIuh9MQijaAhnWmWgLQeDX5ESeSrdX8RoGuqN1VwuaBnUA0xrtsLvK1i1JUDmKQ0vqEnU9bRWGTRd0RgVbAai8e2ELLcC0AFKAr0MvodhM6BmXyCyNKBeQ0gXYKcIbFpRLnGx8/HXHPRq4+SvtLxEL5tMSeO9cdTve6c8yJdddHc4fOoxFLeiZZwAaYyQudLEJkC8EEGhQ/KJC0FmQKxm0ghmISazFZmhV2lA4YalmXPEkLzn0bf00S03b7kVXRd343QhzeNtJbd3+P4ucPL/CfkuTXejrcHkwm6DZ5HlS4db5kKwGVrz+VmpmCklgEnUESVMLiCezlbberxbtzN5Z1yP8gy0AXtuQA8zfrgAe4j/B01LPkDnSqfM0pDGzMKB5anLrG64m12LNKA//1+0TUM/AhZSxgWKp+zmHciFTWj45KjfsXLOuJgKteCYlLnP6h3q18QCOufa2HWINoz8ctxho9s9mAjGetsPZ+p03BXIvXlqJaAjRXcRuhuOsnl4XXihy/vFykclAA3mBvSDjPoAaW1k05cNzfdDhqBax9xWBRsSwY0lak42Z9zdz9bGadih2U0Qq4gGGYO+ez0cJeqanGHJ/hUs48LcrQquFew83VrF/A5nTpUttdWOw6JTY2chb5XpujD7SG8WRHrUPzo+6A8OBk/Hg374pB/2+3/Tdh3ataaqMxu42+Vk0K4Wm6XIc9AuArvMNJK84ZlbVja50Iifdixe1DOX7Ujq2H/XF7Xjy83PtUrJ765VLQN6/EMdUQrGsAV0BP53gm0tSF+ymGBeg7EhOZNLJnhMNh00ybRa8hjiLj4NWc9l8LhcziXLbaI0/wfikAxzm4C0lX2yLl4dRJqCnsnx4zJ5ryyZq1zGIcGGrXIyoLuNyjWWAAWGSGUJ3HB0/zaptQ7H6Ojosfcm0yrCz5kAgvtiVyH5E8PN7w9orXQXjxOVi9hRrTRU0mjq6WOnz5m0WDQEMaCXoD2LkAwlySXcZBDhprlBoqIo1zsC8BWzTKxdEFADUa6RI15gv1xbGl5c4m3KsoWrQqNqnuDJabAaIS/H+iyuLmm1jinWNTOdrabu2ntzEKkYRo6LvyALJhc0pNH5x3f1ebH59OGG37kW5OAv8vp0TCY0sTYLez2hIiYSZWz4rP/sWY9lvLcc9GrLPWe5N5hQMplMJCEHb8iEDqtUc2hD8hKYBk1+Gp6cnI5G0/Efv52+n1CKd+4K2IeVTZRsQFsPrMHxNFPa1nliJnIi64snebEexv5iD3GQ+zMIvFwCLAZtXhS3eExoSCa04jKh5GfCIozVqVVXIMuJ3J/ITHNp92pchxide/v7TaZv2ZKNXFg02LYGN9uhpEHCa5LsmnFL5mCjxHF8GMOiRTOsv8ntfUO+n+utKzzXsaP62UuU+IO8n0+kxxozy9Y4b3mhWqQEHAq12MOl+8/d+0EKNlFVSLu3HWxP6Q4WRXZVopNcLvrgzjX6sNMV9HYWvsNpEsMShMpSkLbKardFXlGRaWVVpEQZ9noFqirDAmOv3NJ2khur0lpFQJdMcyx+9XXAqfGd35y5JsvBxKaoeu6pPvHH5Xhb/5vx+ANZ6ykDimja+tZ8t8CNfLnCOWx5iNLk7AMqQS5tJZ2uquTd6rLEjaq3YoTF1pN0haugMxcmr+rb2dtPY1q9trn7vJvdtMuOdBmg8FTDXINJHqrEPUzN1XajX987Oq4iuFGgjV+3HHiXGJsyd5JU7SG+OtZ8iQs9vBW48toy1DiZOl8qK7QWbmwvE4y7ltsFWlFF+gVlGUdMA9o4FXyvineMMLvCyPBbf0GLYsYMnGtRljjsX+QwDXbC2oXiClbuDQ/jVuQ479KxDmKvlLvTPKbhnAkD3yC/97HqvvbJLoP1RU2umjZrINkVLS8xxl1hctb9xDCKwFXGWmSrAWhVkdenGDfY7TVO/XX0VH9QeyecovArfKUr1+hckUeAZfkvcUXKZw== +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"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.api.mdx new file mode 100644 index 00000000000..c9360bd38f0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-users-info +title: "Get security users info" +description: "Get metadata information about this API resource" +sidebar_label: "Get security users info" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/iuHwz4kmBo3xQYEKvohDdI2W7cFc7IOiAyXls42G4pUScqNK+i/D0dJjmQ7GZYN6D5JIu+Oz3NvPFWYkUutLLw0GmN8Sx5y8iITXoDUc2NzwVsgZqb04JfSwenlBVhyprQpYYSFsCInT9ZhfFNharQn7TGuUBSFkmnQH31ybL9Cly4pF/xWWFOQ9ZJckM2yaWpUmevuU7KeUJcDsaFSIRbET78uCGOU2tOCLNZR2Jk6+XXvdh11S2b2iVKP+xYok/7/heiW1uEM6SkPL6TLHOObge+2gEc4lyrEJsKCbC6dkyass5KXXlGn0n1oowknm/Odt1IveoCEtWK9B3KEjYUYF+SnnDvTNtg1C0tOr88l2TWfIXIW/Iz1JEJLrjDaNQ588fw5P/6bLPrboO4IdN7asdwoTRvgvRgMpbrtYVFdLQkaw8ACR/BBKgUzAm+Fdkp4ymC2hpmYkcI9jucThDf2UcuNEJfqLa3BGygdgdGgpPNwnwRbxh9JvIfiXA8zaS+m0pGFnhTMjd3bPDZ+/KfZxsG8E3mhaDfuu4EeRnYQy5uqnmxTuulwTELqDvldeMphbk0Ov5iMFCP54V8lbU7ODdvGY9Hpsd4o4muRgaXPJTkfw4VeCSUzuG/MUFizkhlluIdPT7fhcvxtuVxrUfqlsfIrZTGcln5J2rfnB6DS7ifSVwxMXrz41kwKa1L+nCkCZuHXMfzBwWnYkLXG7qNyZkqVgTYeWgutNh/147dOtgvtyWqhwJFdkW1YxHCqodR0V1DK/SwsgknT0j4QrjfCC7VxQYSO0tIyR54iPn3xGN9M+HrwYhFKctzuw7XjOp50fVEafZG1t05nY8oNyE3DLYQR3j1LTUbjwKWZUpTQC4wxvf79PUaoQufdfLbdKca0tAqe/Qlvz68gwaX3RTwaKZMKtTTOxyfPT05GopCj1fGoO3kUTh6FkxOEJEk0wLN3kOBpm5wBcQyvSViy8N3p2dn5eDy9+u3n818TxDragLtc+6XRPXibhQ1AmRfG+q58XaIT3d2m8GqzfLQgf8A44GksokZ3SSIj615VW1wSjCHBlk+C8D2IlHN26s0t6TrRh4kurNT+oMN2xFl6cHjYZ/uTWIlxSI8e48HifViMdkx6Q1R8EdLDnHy6DDyfzrIaUI27b9iOH3P+2IWwavheBbofG42aH8z9ZaIbvGGk7rBueaIVMoqOlFkcsOjhyzAc5eSXpk3vMGz7Jcb4GBP2VCjMJtNLy47c6w/cLsn3vA0ZrUiZIift2xIPcWoMVYU13qRG1fFoVLGpOq44Cesda2el8ybvTES4ElZyJ+zmpmCmmR/molS+hcnzaDvYtp/8CAU/tP/u6uoSNnbqCBnN0N6G7w64cdO7eI/nADAWLi7DbGPslpG9rmr1g3Rdc6S6WIy58zYkQxercBby5E34l+Kk/nDFMQpiGLe796NZIF1HrDy1NLfklk81Esbuudmd0cZlQdZRf2jvLXHuNHKr48YlzudC3w+44Tex4xuGPQfQ5t7goN419ZRfy5aMpzs/KpSQmtGEPKzaSrhBUUiGfIy9GyTCgAkjbCpi0uXGDVbVTDi6tqquebn5IeE6eRD3QzhuaR1+YTixVcn7oWC7LA/XV4RNJwknNAqnaUqhnXVaO7f3oOzfnnOcebDpXdmbaLcvbL2bl/W6Z7uqGommNXGJNiBCZ8aax9u/AEFLklM= +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"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.ParamsDetails.json new file mode 100644 index 00000000000..a97496dc4f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.StatusCodes.json new file mode 100644 index 00000000000..68842287a2e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_by":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get_list.User1"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_by":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"email":{"maxLength":320,"type":"string"},"fail_login_count":{"nullable":true,"type":"integer"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_login":{"format":"date-time","nullable":true,"type":"string"},"last_name":{"maxLength":64,"type":"string"},"login_count":{"nullable":true,"type":"integer"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetUserApi.get_list.Role"},"username":{"maxLength":64,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object","title":"SupersetUserApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.api.mdx new file mode 100644 index 00000000000..07f685f647f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-users +title: "Get security users" +description: "Get a list of models" +sidebar_label: "Get security users" +hide_title: true +hide_table_of_contents: true +api: eJzFWFtv2zYU/isEMWAJpsRJ1g2Fij64Qdpmy9qiTtYBceDS0rHNhiJVknLiCvrvwyElmYrlIEmH9ckWyXP5zp0saQom0Ty3XEka0zdgCSOCG0vUjGQqBWFoRHOmWQYWtKHxZUkTJS1IS+OSsjwXPGFIPvhikEdJTbKAjOG/XKsctOVg8CtRosik+8stZO6PXeVAY2qs5nJOq6hZYFqzFX7PuPByA6INtr2cVK5715dMFOB0l6v3MweoPiOLbAqaVtEmVbsyVUoAk+FSretVVUVUw9eCa0hpfOkU82o0Qq9afGr6BRLbB/gaVl20IIsM2aFXJo0NI6p0Cjr4FmwKIvgOHBueQiaWWwE0olLJUKftTghl9dvaHUi5hsRH0lptZpJam15ROZtDwJJLC3PnA7czMfzblm0DApK1QR4RVNVdL0TUWySmc7ATZ6I6his8zDEzvhagV2gzluHBr7S6Qm+bXEnj4/Do4MCH4xOTo/BE3YQ8XwCxyjJBNCRKp8SdI0oSuwAyZck1yJRGGxHc6/4tGTnxmPpEBytkprQT6okIEu2TT1wIMgViNZNGMAspma7IFGORRhRuWZY7ww7JO57cx49uxMaGm9AVqdlUdNgWLIwAwlMTkcLArBDkZgGSrFRBUiV/tuRaqpsQA0fTPbwWdVPs8dZ09P+JHfs4PcyCnSpyjynXJeMR9lkXlx7OboNYRTTIFPTDMZ+hSqdOi54C0q2D9yBiQqgbSBtkqIlR2j4KoQZTiC1p6vfITKvMeWUO1stuSseW/sUSy5fOYrIQgk0Rs9UFRJsthyYLJueQTqarTT487SuU9xS7UZGDNmAvDOhhzveb4rePC4ehOF+6ZkpnzNKYpszCnuWZ6yH9Oq9NmGhA1/4PKofSvkdjyBh3I0XGbs9Azu2Cxr8eHfScnDEuJkLNOdbYun5vYR90rhnXxrZlIhDy+7MeGf02wmJkrJf9dKSOx0MVeTROrQT0xPs2QA/T486M5Yg2xqoHBMxHJQClFgb0kyT7KOl4MzRowPkJ6j1gaKmCEtmOD4dbG3+nOT2gHTfN9rLBf9XT/3qZ9vamjc7T4Rv0jW61v1PcQ6KmFF+WOHl3Jx4aU8fBF+O/8BqDGjz7rgktA2O6w+p9fTbwTUtIX7GUYAyBsTE5lUsmeErWlyuSa7XkKaS0B1BA67Ec/lgsF5IVdqE0/wZpTIaFXYC0tXzSJkoPkJDQITk6+tFIcq0S/JwKIIjCrmLyNzrHowGtle6DcqwKkRKpLKk51NQo6rcfHWyn0mIBEsSAXoL2KGIylKSQcJtDggOXWyQqSQq9xV2vGd4+GhPgvSspNGLEi/OXG8zAK7wLWTZ3GTqq9wnWNIOZirgc6tO0vmI1PCaFOxPR271EpTByKPwbg2ByTmOaXHw8ay6360+jCp0gxqTQguz9Q96cnJMxXVibx4OBUAkTC2Vs/Pzg+fMBy/lgeThoZA6czMGYkvF4LAnZe0vGdFhHpFMzJq+AadDkp+Hx8cloNDl//+fJuzF1d/5arw8ru1Ay0KxdaHXjWa60bXLWjOVYNvdF8rJdxpK/g3qQRwOIPNkCWAravCzvwBjTmIxpDWVMyS+EJRijE6uuQVZjuTuWuebS7jRq7WNU7uzuhkD/YEs2cuEQgO0srp2hpEG8LUZ2w7glM7DJwkF8EsCygzJuvsldryHcz43jSg/13CH97Ckq/EHYL8bSq5oyy1o17xihPqQE7As138Gjuy/cpT8Du1B1JLu3MZwX6BYQaB+Xfj6qC43m67UCvZt4Z7hNUliCUHkG0taJ7LzjGZW5VlYlSlTxYFAiqyouMeqqDW7HhbEqa1jgg5TmWO+aAc2x8RebGXON1amJF7H6Iaf+xB+X1l3+b8/PP5CWTxVR1KbLr8W7odzIVyjcw1mCKE1OP7g3ILygdZj0mqqmd6erCp3UuGGE9dWDdLWqpFMXIq+befmPT+foI3cM71pud33PdKCrCIknGmYazOKpTNxL0kxtXh6bIbBnLkRHgTb+3PLQm8TYjLnmUc9d+Gjb4CVNRe2ICNrQtifeWlULt3aQC8bdyOairKxD/JKynKNChzToAn7ORQ4YE97pl7Qsp8zAhRZVhcv+BowJsFWtbSpcw8o9t7XvttQlYRO+rvtE1FcHJ8ETDJMEXHVqqDaabyeV35ygA3EuCTpu68b6T/BSzOQq4F2W/oQvN5h7XglXaN3DcPUvcakdVg== +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"; + + + + + + + + + + +Get a list of models + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.ParamsDetails.json new file mode 100644 index 00000000000..280fa66944b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"type":"object","properties":{"search_string":{"type":"string","description":"String to search for in channel names."},"types":{"type":"array","items":{"type":"string","enum":["public_channel","private_channel"]},"description":"Types of channels to search."},"exact_match":{"type":"boolean","description":"Whether to match channel names exactly."}},"title":"get_slack_channels_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.StatusCodes.json new file mode 100644 index 00000000000..74faf9dfe89 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"example":{"result":[{"id":"string","name":"string"}]}}},"description":"Slack channels"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.api.mdx new file mode 100644 index 00000000000..e95c35ea195 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-slack-channels.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-slack-channels +title: "Get slack channels" +description: "Get slack channels" +sidebar_label: "Get slack channels" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYcASTImTrgMKFf2QBenbijZo3HVDFLg0dY7YUqRKUm48Qf99OFJSpNgZinZAP1mi7h4+z93xeG4gRyesrLw0GlJ4hp45xcUnJgquNSoHCVTc8hI9WgfpZQPCaI/aQ9oAryolBSfn2UdHCA04UWDJ6clvKoQUzPIjCk841lRovUQX7JBbUSyct1Jfj8y7heQOs4uwzLxh0ZGtjGVS9zyZ5iW6Q2iTgONGgNxavoEEpMfS7doIdV1CeglVvVRSLDrEQFiuucdh5aq9y2pOezGzGsJ1SzBwwRsu/KLkXhSjnZfGKOR6S+P7An2BljCCy1QcC2BqcwgtqZReEdY1+kXIWM/SLboMtGQmCfdzjZYiQDD0Cu1VAhZdZbSLoXpwdEQ/X53aaSotuloFryHGUwOZb8e97flsfehyeFs6twsxlzst8IaXlcIxn8u4822muwD0G12FEN2ps2n1twk8PDr+jtiU6By//lqZIxGDI7zTvPaFsfIfzFN2UvsCte/2ZxY/19JiDju0jB2jkl9/rJKnxi5lnqNO2d+mZrnRP3tW8DWyCm0pnSNF3jAuBDrHfCEds+hMbQXuEjjgRXUPf6y618azlal1nrJ5gSEz6DzmgwSWG3RMG8/wRjq/S9GAERQ9ePCjK6+yhlLBlwoZVZ3fpOxPrmQeqw+tNXaXjlNTqzxI7RA6b9rqt+9qNv+DrBfao9VcMYd2jTaqSNmJZrXGmwoFJS0sMiNEbe85Xk+552oIQQIORW1JIzWej1+oAV1Rp/X8mm5OeIuVsZ5diALzWqGDqwRuDoTJ8SKQjNer4nQdgnj39hUkoPgS1e1rdxRSELVV7OAv9uxszjIovK/S2UwZwVVhnE8fHT16NOOVnK2PZzZsO5teErMMWJZlmrGD5yyDk65PhBSk7HfkFi376eT09OziYjF/88fZ6wygTQZ65xtfGD0iOCwMFGUZ5HbHwGU60/2dw54My4fX6PeIB/tWHUn0LpDnaN2T5o6aDFKWQacoA/ZL110W3nxC3WZ6P9OVldrv9ewOqQT39vfHel/yNb8IuR9pnizepsZoR7IHqfwLl56t0IsiKP0enc1EbNq/s7s5JNUf+jQ2UfE8CP4QPVr6IfWPMx0Z59zzge2dWHRGRuGhMtd7ZLr/OIwRJfrC5HEQCbOiLyCF/9ZC0QonL1Z8bSmYO2OyNSK9os8sxzUqU5WofXeGQ64iUFNZ440wqk1ns4ag2rQhGu0W2mntvCl7iATW3Epqdf0IE2DoOccVDyNFoDmaGbtX+gnneYr/fD4/ZwNOmwCxmeINercn3tic6BvNLcxY9uKcQEjLFGRnqDr/YN22lKu+QVEHKqPI0KYaWIZKeWpsyQnv5fs55SiY0bwavsLQXoPoNiHnhcWVRVd8K0gYUVcmypmwryu0LtRUP+qOlqh2ot36OIbE+ZKHe6Ob8Xb+k5lsMbqBdlt3RD3e+FmluAxTRqixpqvzS+CVJDrHQAN1CHUC02qHBKgwYuYvoWmW3OE7q9qWluNoTqfgXm73MfmEmzDMU9mqmr6HA9nXcLh9EoidIuwQHU6EwNCweq+ty3dyrJ+dURZpjhz/gelz2T0Qej+h680Iu2miRWw9dAAjidB74wD+L7rbBus= +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"; + + + + + + + + + + +Get slack channels + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.ParamsDetails.json new file mode 100644 index 00000000000..0d1f3566c3c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.StatusCodes.json new file mode 100644 index 00000000000..00d6098abd1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"clustering":{"type":"object"},"metadata":{"type":"object"},"partitions":{"type":"object"}},"type":"object","title":"TableExtraMetadataResponseSchema"},"example":{"clustering":{},"metadata":{},"partitions":{}}}},"description":"Table extra metadata information"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.api.mdx new file mode 100644 index 00000000000..3294e8ce3cb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-table-extra-metadata-database-pk-table-extra-table-name-schema-name +title: "Get table extra metadata (database-pk-table-extra-table-name-schema-name)" +description: "Response depends on each DB engine spec normally focused on partitions." +sidebar_label: "Get table extra metadata (database-pk-table-extra-table-name-schema-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV+tv2zYQ/1eIwz4kmBw1RQcEKvohTdPH1nZF424DoiBlpLOlRiZZ8uQmE/S/D0dKtmyre6Qr8kkiebzH755sIEeX2dJQqRUk8B6d0cqhyNGgyp3QSqDMCvHsqUA1LxUKZzATStuFrKpbMdNZ7TBnOiMtlczHHUAERlq5QELrIDlvtsRMCxS5JHklHYoyhwhK3jaSCohAyQXy6hoisPi5Li3mkJCtMQKXFbiQkDRAt4apSkU4RwttG+1IkVcVCs9tVADx+WV3/o+CHNlSzb8up7swKimc/XdRF0wcPOL4/OGDB/zJtCJUxL/SmKrMJGsSf3KsTjPgZ6w2aKkMt7OqdoSe9VqWvvqEGUEbwQJJslNGD9fOHTluo62dCKikCntsTm/Iyjcd+z7EzoKWbQR4IxeGqbdU3NRpW4m2ZbljnkAWJ/qrolQzjlZP0kbw6JswXKBzco6jcbGL2sCy1UV4KnPBIYCOEvFKLWVV5mKdLsJYvSxzzGHEwMHdYMvh/dryQcmaCm3LPzFPxHFNBSrq5ItVnI8YMrwYLHl0v5a81SRmulZ5Irg6dSAjw+10bTMUuUYnlCaBNyXDv2vUioe36OHD+/aNsTrjpU8KRSXdJuI3DrfgH7RW2zE7TnRd5d7UjkN3m0X9dN/p80oRWiUr4dAu0QYrEnGsRK3wxmDGTvObQmdZbb8SgM8lyWoFQQQOs9qyjdytPn0hSM4vuP6SnHMHg2ddu4KLCG4mmc7xzCsX2lsluWJB9uH9a4igkldYrZchfnhd20pM/hAvTqcihYLIJHFc6UxWhXaUHD04OoqlKePlYdx3x/gwDm3KF7W4WfesNm4GbaWNUxBpmiohJi9FCsdddnm3JOIpSotW/HB8cnJ6dnY5/fWX07cpAPeyTvV3t1RoNVB+tbFSv1wYbalPDZeqVPXdSTxZbR/MkfZYD/E9bIwC5wJljtY9abYsTSERKXTWpiB+FDLjAL4kfY2qTdV+qowtFe31mh9wyO7t7w+x+Fku5ZmPlQEeG5trl2rlGJIVDPKLLEnMkLLCo/C9MGg2gEj6tdj2PSPysXd/E9CYejA+hhstfxiZx6kK1viu2VuyhVNHpCs8qPR8j0n3HwMnygKp0DkkMEfy8x8VkMCOnY25bv+tqQy0T/KQZLVlP4zCCdvp/ZqPRY5LrLRZoKKuXHg3B0aNsZp0pqs2ieOGWbVJwxHe7nA7qR3pRc8igqW0JWvtugrn2fB/jjNZV9SpCRGgqhdcProlfxyXkE3+L6fTd2LFp42Atdnkt7J3R7mzUAf5jGET2opX7/zMpu0Wk1GouvueuvUzZ18L/YgWjPQVsYErH0jP/TzFOfH7FLr5lZMhnMKqknuj24gvX1qcWXTFXZm0PFfPdDBnQ/vaoHU4nDkHWxw7gW55GCBxtJC+RXWj+QskQWNj414fshNzPfEUE0/R/fP1SYhW/7+/jeugR/6Pz6oOFMIbik0lSz/S+nhuupQ7B2lKNv2QNeq7VgSJf08NMo/3Np5AyeYzhcM0xOE5NA1z+WCrtuXtzzVa7pQX61QIr7zSDxs5JDNZOfwbRPbed8Phvth9DI4a2W1KdesTsKp5BRFc4214LPqH2Z0UGL4T7yB7AOI36rB6Q95Bi6Hz2guuIb41eL8EiuMsQ9+9+rs7k9tGHX9xynnJY/pgXFtlZ/fD3Ef1appAEXpNuwaL16xg2/4FDbq2sg== +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"; + + + + + + + + + + +Response depends on each DB engine spec normally focused on partitions. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.ParamsDetails.json new file mode 100644 index 00000000000..56c845107bc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"query","name":"name","required":true,"schema":{"type":"string"}},{"description":"Optional table schema, if not passed the schema configured in the database will be used","in":"query","name":"schema","schema":{"type":"string"}},{"description":"Optional table catalog, if not passed the catalog configured in the database will be used","in":"query","name":"catalog","schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.StatusCodes.json new file mode 100644 index 00000000000..55b71756adb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"clustering":{"type":"object"},"metadata":{"type":"object"},"partitions":{"type":"object"}},"type":"object","title":"TableExtraMetadataResponseSchema"},"example":{"clustering":{},"metadata":{},"partitions":{}}}},"description":"Table extra metadata information"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.api.mdx new file mode 100644 index 00000000000..70eec151b89 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-extra-metadata-database-pk-table-metadata-extra.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-table-extra-metadata-database-pk-table-metadata-extra +title: "Get table extra metadata (database-pk-table-metadata-extra)" +description: "Extra metadata associated with the table (partitions, description, etc.)" +sidebar_label: "Get table extra metadata (database-pk-table-metadata-extra)" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v3DYM/isCsQ93mC9Ohg4oXPRDlqVpt64tmis2IA5Sxead1diSK9GXZIb/+0D55d7cbFgy7JMtUSKfhyIpqoYUXWJVScpoiOD0jqwUBZJMJUkhnTOJkoSpuFWUCcpQkLzOUUxKaUnxLheIDR2BQEoOphBAKa0skNA6iC7qHTvzDAVbuJYOhUohAMXTpaQMAtCyQB7dQAAWv1bKYgoR2QoDcEmGhYSoBroveZXShEu00DTBnhUP1WvrDHyt0N6vLXSiv7XhyCq9HDPx3v/IvHNLuzMQaiG0IVFK5zD1bmslIjF6oZaVxVQo7QWDG25VnotrFJXD9Bt4O2CPQZhIkrlZjkHsRI/E2Gl5EOQl+9yVRjt0LP/h8JA/idGEmvhXlmWuEsnQwy+OidQb+kprSrSk2t1JXjlCr3pty1x/wYSgCaCP5lHhOoxHxE2wMxMAKcqxDy2fLb916j92hM5blE0AeCeLklfvQNzGtAuiadjuWCDjdnIqvTC28C5ia88Ojx7hwwKdk0scjah9r20wGzbCJy0ryoxVf2IaieOKMtTU2RdDio2w29zYMnn2/zJ5Z0gsTKXTSHChYuzouAhadKayCYrUoPPpg3fK0RipQQdb+fFR8f0EjN5oQstFwKFdoRVorbGRONai0nhXYsLs/KQwSVLZb5zUK87tdp037jCprKJ7X+G/3BJEF5ec3CSXXPXh565uwGUAd7PEpHjuwbVXQi45HSD59PEtBJDLa8zXw9bRPK5sLmZ/iLPTuYghIyqjMMxNIvPMOIqeHz5/HspShaujsC9T4VHoi91VnyuhT50wBhHHsRZi9lrEcNwFnT+ESPyE0qIV3x2fnJyen1/N3/96+i4G4ILaAf1wT5nRG1CHiQGsKkpjqY8YF+tY94VOvBymD5ZIE8YhHs8oaPVkKFO07mW9wyuGSMTQcYtBfC9kkqBzV2RuUDexnsa6tErTpMd5wOE4mU43mf8iV/Lcx8EG+63J9XEZ7dgBA2l5KxWJBVKSec5Pw7jeoh31Y7F7rsz/c3+0dct97ql/bnc0/GE/vIh1i90X1x73jle6RSbHg9wsJ7x0+gI45AukzKQQwRLJdz+UQQR7rOryphknxk70ydkmR2XZx6Ougt20fMtikeIKc1MWqKlLc3+EraK6tIZMYvImCsOaVTVRzbHa7Gk7qRyZolcRwEpaxYBdV5m8Gv5PcSGrnDqYEADqquC074b8cZz62/pfz+cfxKCnCYDRbOsb+O6BO2/rF8u43xDGijcf/EVu7I6SUVd1+/3qxjcifQ3z93ZL0leyGq592LzylyzH++/zvqnhQG+lMFRgT7oJePOVxYVFl/1bJQ13VgvT0tlCX5VoHW42IhtTHDvtutVR6xJHhfRXS9ebnSF1beBOLzHpA3RW3sz8ilkvm/ml011PbtxmT/lq6PxAeEdhmUvlWxsfwnWXUxcgS8VsjxhSf8EEEPnnwnZqcUwyNgiA47ANtAuoa97zyeZNw9NtA+sfKcrx/hSihcwdPkB58rFraKZi65Uxiv8G79ePjZXMK17ik/OfG/zvHhoPQB7eG08D+knfHg/AXj9B1rgv14XsEUe992wdRdFNSn2/CaFHV95Ac8llz99dHkwrOE4S9Jdpv2WvSdy6aM5OuZRw67zRGQ4Fpfth7aNw6rpd0V6GzYDO9wUMsGn+AriOkLg= +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"; + + + + + + + + + + +Extra metadata associated with the table (partitions, description, etc.) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.ParamsDetails.json new file mode 100644 index 00000000000..5f63de0ed67 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"query","name":"name","required":true,"schema":{"type":"string"}},{"description":"Optional table schema, if not passed default schema will be used","in":"query","name":"schema","schema":{"type":"string"}},{"description":"Optional table catalog, if not passed default catalog will be used","in":"query","name":"catalog","schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.StatusCodes.json new file mode 100644 index 00000000000..6f0dacefaca --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"clustering":{"type":"object"},"metadata":{"type":"object"},"partitions":{"type":"object"}},"type":"object","title":"TableExtraMetadataResponseSchema"},"example":{"clustering":{},"metadata":{},"partitions":{}}}},"description":"Table metadata information"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.api.mdx new file mode 100644 index 00000000000..c280c5b263c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-table-metadata.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-table-metadata +title: "Get table metadata" +description: "Metadata associated with the table (columns, indexes, etc.)" +sidebar_label: "Get table metadata" +hide_title: true +hide_table_of_contents: true +api: eJzFV9tu3DYQ/RVi0Acblb12kQKGgjy4qeOkzcWIN2gBy3BoaXbFWCIVcrReV9C/F0NR2mvcIGugT5LI4cw5w7mpgQxdalVFymiI4R2SzCRJIZ0zqZKEmbhXlAvKUZC8LVDspaaoS+0ioXSGc3SRQEoP9yGCSlpZIqF1EF81a6rHOQpWfSsdCpVBBIqXK0k5RKBlifx1BxFY/ForixnEZGuMwKU5lhLiBuihYimlCadooW2jDSseo9cWDHyt0T4sLISt/7ThyCo93Wbig3+RRfBHdzISaiK0IVFJ5zATGU5kXVDYFfeqKMQtitph9g1gAcEuUFJJsjDTb2EJ298DJog+iuaavegqox063v/l6IgfqdGEmvhVVlWhUskYR18cI26W9FXWVGhJdafTonaEXvXClrn9gilBG0EZAnPrZiUtKbbitmy30dpKBKSowD5YzuZkZR/3HwOhyw5lGwHOZVmx9BrEVUzrINqW7W4Lzf6QUHpibOmdw3aeHR3v4L0SnZNT3Bo0m/5a4jQchE9a1pQbq/7BLBanNeWoKdgXQ7ps4bV8sGPy7P9l8t6QmJhaZ7HgosPY0XEls+hMbVMUmUHnMwTnytE2UoMOtvLrTpH9BIzeaELLee7QztAKtNbYWJxqUWucV5gyO78oTJrW9hs39YqzupPzxh2mtVX04Kv1l3uC+Oqa05rklCs4/B7KNVxHMD9ITYaXHlxX3gvJiQDpp49vIYJC3mKx+Owczd+1LcTB3+L8bCwSyImqeDQqTCqL3DiKT45OTkayUqPZ8ajvDqPjka9nN32ujBIQSZJoIQ5eiwROQ7h598fiN5QWrfjp9OXLs8vLm/GHP8/eJwBcLQPEiwfKjV4COSwMMFVZGUt9rLhEJ7ovbuLFsHw4RdpjHGIXLlGnIUeZoXUvmjVGCcQigcAqAfGzkGmKzt2QuUPdJno/0ZVVmvZ6hIccgnv7+8uc/5Azeenvfon3yuLiiox2TH2gK++lIjFBSnPPdleuzQrhuP8W63fJzD/319l0rMee9OfuRMsP9sDzRHeofSntEa/5IwiZAg8LM91j0f3nwAFeIuUmgximSH5uoRxi2ODTVHftOiV2nE/CLglqy37d6h5YT7+3vC0ynGFhqhI1hXT219YpaipryKSmaOPRqGFVbdxwZLYb2l7WjkzZq4hgJq1iqC5UIK+G30P7DzAhAtR1yekdPvnhOMVX9b8ejy/EoKeNgNGs6hv4boC77OoU7/FEIYwVby58qzZ2TclWV4XzXrr1o0Zfq3xn7kj6itXArQ+YV76Zcoz/Ne7HFg7ubheGSutJtxEfvrE4sejyH1XS8uw0MR2dFfR1hdbh8qixtMSx08nNjjuXOCqlbyFh+jpHChPdMGKsOWipGe04swdGhHMaVYVUfhjxwdiEvLgCWSnGfcwo+pYQQeyH9dX0gAg4krpQuYKmYdlPtmhbXu6GTP9roByfyyCeyMLhI+z2PobRY1+szPZbcd/hw2LEn8miZhGfXt9v8AnG+0ewDVP+06D7sYn/EXyLwX8B8HpRXHa4vI3fv60owqLUD8sQenTVHbTXXIp8J/Fguo3TNEXf1PojGwPaStk/P+P05rF1aSobkjy8sPatcJqmk+haUzug8/2ZAbbtv+faR+o= +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"; + + + + + + + + + + +Metadata associated with the table (columns, indexes, etc.) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.ParamsDetails.json new file mode 100644 index 00000000000..93d7fe662b7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_fav_star_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.StatusCodes.json new file mode 100644 index 00000000000..f696a006165 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.StatusCodes.json @@ -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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.api.mdx new file mode 100644 index 00000000000..6da4a60e783 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-tag-favorite-status.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-tag-favorite-status +title: "Get tag favorite status" +description: "Get favorited tags for current user" +sidebar_label: "Get tag favorite status" +hide_title: true +hide_table_of_contents: true +api: eJzFVt9v00gQ/ldWo3todYa0J06qjHgIVVvKIahI0J1UV2FrT+IFe9fsjkNzlv/30+zajpMGhLgHnmyvd76Zb343kKFLrapIGQ0xXCGJpVwbqwgzQXLlxNJYkdbWoiZRO7QQQSWtLJHQOohvG0iNJtQEcQOyqgqVSkabfHIM2YBLcywlvynC0vELbSqEGJQmXKGFNupPpLVyAxGQooK/V0iLpVwvHEm7UJlbdGBt20ag2OIvNVqW0LJkgS/Q3kVg0VVGO/TK/jg54ccPW1lZU6ElFaQturrwUruemopCORJmKcKN4CiUaS5SY4MBmdIrkebSklBaUI7C4pcaHUG09cWuOpU9VjXPUZwHlAyiA85by6LGw3KXco0zklaEO4P0vTEFSg3t1vfm/hOmNHK+13kp1yz/vvPo++CO/Yh9D+YKe5DrzM26+EWAD7KsChz7+PbOx3WXxVujke8/+19hLNE5ucJR8jmySq8OWL5r2yAIL2XWxy8W13otC5WJbSmIypq1yjCDAyRGsoHL6a/l8kHLmnJj1b+YxWJaU46aOv3eUGUPExkLBibPfi2Tt4bE0tQ6i8V8W2DI7namtimKzKAT2pDAB8XuP5RiHQZr+fNX59m1JrRaFsKhXaMVaK2xsZhqUWt8qDBldv5QmNR35oORupQki3DPK3eY1lbRxrfsT19Dud1FwE0e4luY8/MuAmbjuV5nXQMmuVr0Q4E7MdUOInh4kpoMZ55AmAOF1CuIIf3w/g1EUMh7LLafIRj8XdtCPPlHXF3MRQI5URVPJoVJZZEbR/HZydnZRFZqsj6dkFxN9hRPEhBJkmghnrwSCUy7ZPQGx+IlSotW/DY9P7+YzRbzd39dvE0A2mgw7mZDudEj84aDwUBVVsZSn0ku0Ynu54l4MRw/XSEdsR3i51hEQTZHmaF1L5o9LgnEIoGOTwLidyHTFJ1bkPmMuk30caIrqzQd9bY95dQ8Oj4es30t13Lmc2LEeOdwGxajHZMeiMqvUpFYIqW55/nzLJsdqnH/Lfbjx5w/9iFsAt+5p/sxSLT8YO7PEx3szSTJwdY9T3SXTIFPC7M64qvHz/16UCLlpstuv85QDjF8jwl7yldjyPTasiMP+gP26/AN/xYZrrEwVclbVEDycQpATWUNmdQUbTyZNAzVxg0nYfsI7bx2ZMoegke/VfK+wH6V8DBhFVhKP1S9mRAB6rrkOu8++eHrfRf/1Xx+IwacNgK2Zhdv4PvIuFloWPyP1zFhrLi+YRDmsgty0FWdvL/dthypvmn5tSGQ9K2rgXufJ5fGlpLxXv895xj5a7ze+L/bdceTbiMWXlhcWnT5z4L4xXNpHq9bs7pC63C8+oyOOHfCvfVpcImjUvpZ0q2uvHuTXA37txha7Y6e0Wj6wXW9M5/wgSZVIZVm/T7zmi73b0FWio08BT8QIILHDZ+TJWTDLTTNvXT4wRZty8dhCefK+Kap37LjM2782j5sseBLtM9rP6UiCL3DawgC0zRF38B6qUdDeqfQry44sry6jCbzEN/uhdH7rVZvRthNE26EZsRFGYzwvRha3lr/A2N3mOw= +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"; + + + + + + + + + + +Get favorited tags for current user + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-bootstrap-data-for-sql-lab-page.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-bootstrap-data-for-sql-lab-page.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-bootstrap-data-for-sql-lab-page.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-bootstrap-data-for-sql-lab-page.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-bootstrap-data-for-sql-lab-page.StatusCodes.json new file mode 100644 index 00000000000..f0fa891e4ef --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-bootstrap-data-for-sql-lab-page.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"active_tab":{"properties":{"active":{"type":"boolean"},"autorun":{"type":"boolean"},"database_id":{"type":"integer"},"extra_json":{"type":"object"},"hide_left_bar":{"type":"boolean"},"id":{"type":"string"},"label":{"type":"string"},"latest_query":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object","title":"QueryResult"},"query_limit":{"type":"integer"},"saved_query":{"nullable":true,"type":"object"},"schema":{"type":"string"},"sql":{"type":"string"},"table_schemas":{"items":{"properties":{"database_id":{"type":"integer"},"description":{"type":"string"},"expanded":{"type":"boolean"},"id":{"type":"integer"},"schema":{"type":"string"},"tab_state_id":{"type":"integer"},"table":{"type":"string"}},"type":"object","title":"Table"},"type":"array"},"user_id":{"type":"integer"}},"type":"object","title":"TabState"},"databases":{"additionalProperties":{"properties":{"allow_csv_upload":{"type":"boolean"},"allow_ctas":{"type":"boolean"},"allow_cvas":{"type":"boolean"},"allow_dml":{"type":"boolean"},"allow_run_async":{"type":"boolean"},"cache_timeout":{"nullable":true,"type":"integer"},"database_name":{"type":"string"},"encrypted_extra":{"nullable":true,"type":"string"},"expose_in_sqllab":{"type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"properties":{"allow_multi_catalog":{"type":"boolean"},"allows_virtual_table_explore":{"type":"boolean"},"cancel_query_on_windows_unload":{"type":"boolean"},"cost_estimate_enabled":{"type":"boolean"},"disable_data_preview":{"type":"boolean"},"disable_drill_to_detail":{"type":"boolean"},"engine_params":{"additionalProperties":{},"type":"object"},"metadata_cache_timeout":{"additionalProperties":{"type":"integer"},"type":"object"},"metadata_params":{"additionalProperties":{},"type":"object"},"schema_options":{"additionalProperties":{},"type":"object"},"schemas_allowed_for_csv_upload":{"items":{"type":"string"},"type":"array"},"version":{"nullable":true,"type":"string"}},"type":"object","title":"ImportV1DatabaseExtra"},"impersonate_user":{"type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"password":{"nullable":true,"type":"string"},"sqlalchemy_uri":{"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true},"uuid":{"format":"uuid","type":"string"},"version":{"type":"string"}},"required":["database_name","sqlalchemy_uri","uuid","version"],"type":"object","title":"ImportV1Database"},"type":"object"},"queries":{"additionalProperties":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object","title":"QueryResult"},"type":"object"},"tab_state_ids":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"SQLLabBootstrapSchema"},"example":{"active_tab":{},"databases":{"key":"value"},"queries":{"key":"value"},"tab_state_ids":["string"]}}},"description":"Returns the initial bootstrap data for SqlLab"},"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"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-bootstrap-data-for-sql-lab-page.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-bootstrap-data-for-sql-lab-page.api.mdx new file mode 100644 index 00000000000..2ebb50313b1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-bootstrap-data-for-sql-lab-page.api.mdx @@ -0,0 +1,60 @@ +--- +id: get-the-bootstrap-data-for-sql-lab-page +title: "Get the bootstrap data for SqlLab page" +description: "Assembles SQLLab bootstrap data (active_tab, databases, queries, tab_state_ids) in a single endpoint. The data can be assembled from the current user's id." +sidebar_label: "Get the bootstrap data for SqlLab page" +hide_title: true +hide_table_of_contents: true +api: eJztWd1v2zgS/1cI4oBNcG7c3AdQaLEPaZu22c3dtnV6H4gDLi2NbbYUqZAjJz7D//thSMmWZcnx9h56D32yTQ6H8/mbGXrFM/CpUwUqa3jCL7yHfKLBs9GH62s5YRNr0aOTBcskSnYiU1QLECgng7AykR78gN2X4BR9QTkRHiWCUJk/ZcowybwyMw0MTFZYZfCM3cwhskulYRNgsro1Y1Nnc4ZzYGnpHBhkpQf3g2cqO+MD7sAX1njwPFnxPz1/Th+pNQgG6assCq1SSaoMP3vSZ8V9Oodc0rfC2QIcqnh6q0ffHn3DZQE84RNrNUjD1wMuS7SuNN2btUGEyhoEyiDMwBEBPKKTopat2reTz5Aibc9VBkLDFMVEuu4rdjh7dMrMaFnLCeieHQSPghy03Fc1nUszg0xEgabW5RJ5QorAM1Q58ME+xxSl79F/0ilCNrnqs4fJXiPmjU1T5pNqzznr/gbey1nwhSm1lhMNPEFXQodc8AhpiZCN7rstEYzfafc+o6pcYbfgYUuZ2RuZonWdpwtnZw6872YQ/NFnFge+1Oh/gWUnZ2cferhuo33vkAe3ANd3o++xmb/Xl5lCu3uwsY/SYa8LAxB0nqvybn8d8mK0UeJJlxP5TaQ4htrJ9Isys09OH0VP2NMpJW10W3I9aEXXgKNCuoN/II9/DJ7dBIA4EGJeLiDb5m2PtNsgPuT7Hu8iMRTxYIgohZD7fZR4Etd2ikhn6hXSZNA83Ydpx0Vzs8x0H8Y6LFpnD3goRtKWQDonl7W/ey46zG4UEqBRGWJ9yTJFppL6/Y6ZW1VIa/sgUr8QZaGt7LFdRdULydX+4vB+lutD2640QvqlSbuJUpnOQVC5sCUeiNVmwNQRZWTejRBgUrcsEDKxwe0jKkBhKUqN8PdE2i0uPCI4I7Uoj8SBjQBdDspLjUqkEqW2swNG9GKhHJZSi5h18Fho63q6jFSaFHRMfmGNeFAmIxal6Y+E1HoU4FHllBZg6JYe0kz5IAN5QRQOFgoenqB0SmuBVmSAUvUEC5iZMiAK6WR+KND3cmY94DmgDOLsBVNftnSkfC/TrxIpwo+wAda+7rAXwfeQial1rVzeYO0+uLXgZwHOV8j6RKweQKOrvLAO/3H+usq8yxDUhL55Ac5bQ1HTqnhNjPYil0bOYj6G/NGH6lLjaCG9f7AuOyrX/L2Wmmy3FKVT3dXMzwWWxsSGV2r965Qnt+3sjHC9O92MRu/YTTjJrl6zk6l1rCyo1/WnfHAEajU16ej31IJs+KWna2vsi4OMYqcmZJa12sc9EvJodyqQI3ug9UCM1LExGr2LZuLru7ZdiHkZjbsZF8JChzMbgbsvhIP7UjmCqNtWOdiLgkF9Q83w7vg47wSGalw9vhh/n5O+z0nf56RvMSftBeHOC9PvKaQH7oyPXS/rt67KsiEXZF5Es+28GLVb+gD6fCF1CS18ae20pL+tpb1br9tzFP8IWDrjw3uYMgqV1O33OCpho3t9LSfE/C//05NYvsWQp0rGrmU2B/lLmTHCdfCYsCuzkFplLDRfgOA8K5xdKJoDO7RtnI26nH9bXT4ZWeLcOvUfyBJ2UeIcDFb3s03x6lCkeTBq8udvq8kb6yYqy8Ak7N+2ZJk1PyCbywWwAlyuPJVUhpbJNAVP4aY8c+Bt6VLoUnDDj27867eOuSsT21EWkZuFepiwC8NKA48FpAhZXGQ2Dc/KnV57QxNcpAuXe0hLp3AZWsvPD8iT2zvqhlDOQt6OPlwzSru7AX98ltoMRkE2H+i1NDOe8PTTx2u+eZytf1aGTXhaOs2e/Yu9vbxhYz5HLJLhUNtU6rn1mLx4/uLFUBZquDgfxnl2OOZsPB4bxp69Y2N+UYVZMHXCXoJ04NgfLl69uhyNxM2vv1z+fcz5erCR5/0S59Y0JNosbGRSoX2qE9GPzdjUr+7sp83y2QzwhORgRws+iORzkBk4/9OqJf6YJ2zMKxXGnP2xikaB9guY9dicjk3hlMGTWpwziq2T09Omgj/LhRwFpzaU3FncGt8aT3pudJMPUiGbAqbzoNrvUmy1o11S/2ZtL5Gav9WOWkUVb4KGv8UTa/ogdX8cmyhiwPlavJbyFZHVcKbt7IRIT38MTXsOOLcZT/gMSO1C4pwnvCU8r9udGLXhPaRba95Ol2vaZhksQNsip39qIqfgjchoVTiLNrV6nQyHK2K1TlYUXes9bq9KjzavWQz4QjpFLUfdiQc2cZ6bSmoMopicOuMyp3SsftKHp5zc5f/u5uY92/Chf1qsx11+G333hBtFXKE9Gk+Ydezqfehcq/Fry6TTVNX5QL1ek3NqbAl9RlQyIMyKT0JovKnni5//ecOrbjWMEGF3O2sEpdcDOiwcTB34+dcyoe7eTG3HzFzS8wDsdEvbpc2Exxfn0SQecxmfKsL4yd8Chgamt3FhBeH43hvypqD8n/8nWVkR4RGHhZYqFMXqZTFm3S2XBc2wi/M42dLD5IBTkMYovOWrFYn8yen1mparN//bu20ihOoz4BFfQrLGvvIiTSHgWmwwk/3iuwMGby8pFKg9aQ6mdUBUX4h73TmbZYP3ahUpImBRFkchAkTzNbWw/wW/ko+1 +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"; + + + + + + + + + + +Assembles SQLLab bootstrap data (active_tab, databases, queries, tab_state_ids) in a single endpoint. The data can be assembled from the current user's id. + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-csrf-token.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-csrf-token.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-csrf-token.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-csrf-token.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-csrf-token.StatusCodes.json new file mode 100644 index 00000000000..b384ebd6f81 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-csrf-token.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"},"example":{"result":"string"}}},"description":"Result contains the CSRF token"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-csrf-token.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-csrf-token.api.mdx new file mode 100644 index 00000000000..41f3e88dcbd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-csrf-token.api.mdx @@ -0,0 +1,60 @@ +--- +id: get-the-csrf-token +title: "Get the CSRF token" +description: "Get the CSRF token" +sidebar_label: "Get the CSRF token" +hide_title: true +hide_table_of_contents: true +api: eJytVm1v2zYQ/ivEYR8STImSYQMCFv3gBUnartiC2MEGWEZK02dLqUSqJOXGE/jfhyMl+SXpgKX7ROp4d3yee6NaMGhrrSxa4C38dHZGi9TKoXK0FXVdFlK4Qqv00WpFMitzrATtaqNrNK6I1gZtUwYrt6kROFhnCrUC75NeouePKB34BPBJVHWJu3ZbfZ/AAq00RU0XA4e7oMIImCiUZS5Hdjm+u2ZOf0ZF/n4+O/8O6BVaK1b437EPhnCvRONybYq/ccHZqHE5Ktfdzwx+aQqDi5e47RqS91++Kwn/A5P3yqFRomQWzRoNQ2O04WykWKPwqUbpcBGFTEvZmG/wuhZOlFEvXG5RNqZwG+DTFh6/OuDTmZ8l4MTKAp/CuD+fJfB0IvUCxwGcDQalUCvgIO/vPkICpZhjuf20ujGSoMvGlOzkL3ZzNWEZ5M7VPE1LLUWZa+v4xdnFRSrqIl2fpz2cVFqzfAh1lGbAsixTjJ28YxmMurSEwHP2KwqDhv0wury8Go8fJn/8dvV7BuCTAdztxuVa7cAbBAPAoqq1caEe0DqbqUz1HcjeDuLTFbojwsFexyKJtjmKBRr7tj3gkgFnGXR8MmA/MiElWhvtfaaOM1WbQrmjHtspld3R8fEu2w9iLcYh3zuM94TbtGhlifRAVHwVhWNLdDIPPF/Pst2jyvtvdpg/4vypT2Eb+U4C3U/RwtNC3N9kKuJdCCcGrAeR6JR0iaelXh2R6vEboHLeb4IbdIfDKoEKXa4XwGGFFKZauBw4/BtZCmZoxtgMjaFYvxgyOETwkY7ZAtdY6rpC5bq2DqmMjtraaKelLj1P05Zced5Snfpn3i4b63TVu0hgLUwh5mWcPb0b2i9wKeJUJ5iQAKqmojbvPmmx8Cxe7yaTWzb48QkQmn1/A99n4MZxXtGZEhUybdj7W3JCXPadvBiqzj5oe0/J7HMxpmkbSYbJ1cI8lNK1NpUgfx/+nFCOghrw7hSGiRtI+4SMHwwuDdr8tU58AoVa6khnD31To7GholzhaKjviqh2ot76PIbEukqEp4Ri9a1S3btieFIcPrm0LkURnt5QRG1XxlMQdUH3ncPOyE9gW8yQAOU9JnYKbTsXFu9N6T2JvzRo6ImYbWsrPBQJxBYP9f8ZN8BhJCWGObMWZUOwnr2TlMKh2W6uKLr01u4wGWLcbch7dyTUZsd320aNODOoMSKI7gdk5r3/B+k3Md4= +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"; + + + + + + + + + + +Get the CSRF token + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.ParamsDetails.json new file mode 100644 index 00000000000..74d702d0d05 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.StatusCodes.json new file mode 100644 index 00000000000..3e8a06ed29e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"},"changed_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User1"},"changed_on":{"format":"date-time","type":"string"},"dashboard_id":{"type":"string"},"uuid":{"type":"string"}},"type":"object","title":"EmbeddedDashboardResponseSchema"}},"type":"object"},"example":{"result":{"allowed_domains":[],"changed_on":"2024-01-15T10:30:00Z","dashboard_id":"string","uuid":"string"}}}},"description":"Result contains the embedded dashboard config"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.api.mdx new file mode 100644 index 00000000000..cdbfa799a1f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-dashboards-embedded-configuration.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-the-dashboards-embedded-configuration +title: "Get the dashboard's embedded configuration" +description: "Get the dashboard's embedded configuration" +sidebar_label: "Get the dashboard's embedded configuration" +hide_title: true +hide_table_of_contents: true +api: eJytVm1v2zYQ/ivEYcASTIntrgUCFf2QZWn6hi2IHWxYFLi0dLaYSqRKUk48Qf99OFKSpdgNtnSfJB7J4/PcPTxeBQXXPEeL2kB4U0GCJtaisEJJCGGWIku4SReK64SJhCnNTFauIABB8wW3KQQgeY4QgkjmSs+beY1fS6ExgdDqEgMwcYo5h7ACuylotbFayBXU9S0tNoWSBg3NvxiP6RMraVFa+uVFkYmYE6jRnSFkVc9foVWB2gq/W6MpM7tr51mm7jGZJyrnQjqTsJibPYiC1sC15hsaxymXK0zmi82u46XQxs59CPa4EknPLKTFFWqyZ/ypXaVB/Y3JLTy1uMPYQgBW2IwM1wb1pI/Xh2qpdM4thJBwi0dW5AjB7pFdnucDyD1M5d6JJ/Cc5wtMEkx+bV1fNXme+uTt7q0DwAeeFxkOc7mTvZvbIUt4MX7x8mg8OZq8mk3G4c/jcDz+Cx6zakG3ZLYkCMpQ+1fucEYypCOZTZFhQ6h3KWIll8LF5+V48h26zdEYvvpXCR8GqdsI15KXNlVa/I1JyE5Lm6K0zfmsu497qPY3kvdX33UD/wcm76Ul/WfMoF6jZqi10iE7layU+FBgbDHxRqbiuNTf4PWWW575de5wg3Gphd24Snd3b0lGVH4sX5GkoNOpgdsAHo5ileDUwfPFMeNyBSHE11efgG7wArPt0KhSxwQ+LnXGjv5kF+czFkFqbRGORpmKeZYqY8OT8cnJiBditJ6MOhmNJqNWWxGwKIokY0fvWASnTWJc6EP2C3KNmv1wenZ2Pp3OZ79/PP8tAqiDDtzlxqZK9uB1hg6gyAulrVMEGmsiGcm2ALM3nfl4hfaAcLDnsQj83hR5gtq8qR5xiSBkETR8ImA/MR7HaMzcqi8o60geRrLQQtqDFtsxCe/g8LDP9gNf86nLeI/xwLhNi5KGSHdE+T0Xli3Rxqnj+XyW1YBq2I7Z4/wR589tCivPd+bofvY7avoQ99eR9HgTbnmH9VEkmkUqw+NMrQ5o6eFrIEEPr8EFWle9OgY/mm0l8/Wr1A4gBJCjTRWVxhVS+NwLH8JuEKrta1938aB4uxvr70upKR17owqPQX6iaZbgGjNV5Chtc/ddtr2jqtDKqlhldTgaVeSqDiuScr3j7aw0VuWtiwDWXAu+yHyBat3Qf4JL7t4YBxMCQFnmVAuaIX1cNRj6fzebXbLOTx0AoRn66/jugJv6okZz9MZTU/X+kpwQl6GTvaFq9rvVteuf2sLm3lVP0pW3ChZObW/bDuDDHzNoejG6E3522w040nVAm+calxpN+lwn1PrIpfJ0BujLArXBfp/QM5F2/Lr1xIfE2Jy796bpMv+TmgdHd++RxQc7KjIupOtrtFOCV/oN8EIQjkm/eYAAwkF32wn+tk39DVTVghu81lldk/lriXrjG5VWfb7DFob+EwiXPDO4g7F7deHgqnmzD9kTjfheTm0DKzdO/FlJIwjgC26GjXp9S+J1hcuh8wtO4xhd9Wy37rz/pLquVFyckyCoh+gFuZNF80Pe98KqKr/CV8K6Q+keAgJY1/8A79ZZyw== +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"; + + + + + + + + + + +Get the dashboard's embedded configuration + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.ParamsDetails.json new file mode 100644 index 00000000000..0cc13bf0501 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"key":{"type":"string"}},"required":["key"],"type":"object","title":"sql_lab_get_results_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.StatusCodes.json new file mode 100644 index 00000000000..25e3f34ecd0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"object"},"type":"array"},"data":{"items":{"type":"object"},"type":"array"},"expanded_columns":{"items":{"type":"object"},"type":"array"},"query":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object","title":"QueryResult"},"query_id":{"type":"integer"},"selected_columns":{"items":{"type":"object"},"type":"array"},"status":{"type":"string"}},"type":"object","title":"QueryExecutionResponseSchema"},"example":{"columns":[{}],"data":[{}],"expanded_columns":[{}],"query":{},"query_id":1,"selected_columns":[{}],"status":"string"}}},"description":"SQL query execution 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"},"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"},"410":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"error_type":{"enum":["FRONTEND_CSRF_ERROR","FRONTEND_NETWORK_ERROR","FRONTEND_TIMEOUT_ERROR","GENERIC_DB_ENGINE_ERROR","COLUMN_DOES_NOT_EXIST_ERROR","TABLE_DOES_NOT_EXIST_ERROR","SCHEMA_DOES_NOT_EXIST_ERROR","CONNECTION_INVALID_USERNAME_ERROR","CONNECTION_INVALID_PASSWORD_ERROR","CONNECTION_INVALID_HOSTNAME_ERROR","CONNECTION_PORT_CLOSED_ERROR","CONNECTION_INVALID_PORT_ERROR","CONNECTION_HOST_DOWN_ERROR","CONNECTION_ACCESS_DENIED_ERROR","CONNECTION_UNKNOWN_DATABASE_ERROR","CONNECTION_DATABASE_PERMISSIONS_ERROR","CONNECTION_MISSING_PARAMETERS_ERROR","OBJECT_DOES_NOT_EXIST_ERROR","SYNTAX_ERROR","CONNECTION_DATABASE_TIMEOUT","VIZ_GET_DF_ERROR","UNKNOWN_DATASOURCE_TYPE_ERROR","FAILED_FETCHING_DATASOURCE_INFO_ERROR","TABLE_SECURITY_ACCESS_ERROR","DATASOURCE_SECURITY_ACCESS_ERROR","DATABASE_SECURITY_ACCESS_ERROR","QUERY_SECURITY_ACCESS_ERROR","MISSING_OWNERSHIP_ERROR","USER_ACTIVITY_SECURITY_ACCESS_ERROR","DASHBOARD_SECURITY_ACCESS_ERROR","CHART_SECURITY_ACCESS_ERROR","OAUTH2_REDIRECT","OAUTH2_REDIRECT_ERROR","BACKEND_TIMEOUT_ERROR","DATABASE_NOT_FOUND_ERROR","TABLE_NOT_FOUND_ERROR","MISSING_TEMPLATE_PARAMS_ERROR","INVALID_TEMPLATE_PARAMS_ERROR","RESULTS_BACKEND_NOT_CONFIGURED_ERROR","DML_NOT_ALLOWED_ERROR","INVALID_CTAS_QUERY_ERROR","INVALID_CVAS_QUERY_ERROR","SQLLAB_TIMEOUT_ERROR","RESULTS_BACKEND_ERROR","ASYNC_WORKERS_ERROR","ADHOC_SUBQUERY_NOT_ALLOWED_ERROR","INVALID_SQL_ERROR","RESULT_TOO_LARGE_ERROR","GENERIC_COMMAND_ERROR","GENERIC_BACKEND_ERROR","INVALID_PAYLOAD_FORMAT_ERROR","INVALID_PAYLOAD_SCHEMA_ERROR","MARSHMALLOW_ERROR","REPORT_NOTIFICATION_ERROR"],"type":"string"},"extra":{"type":"object"},"level":{"enum":["info","warning","error"],"type":"string"},"message":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Gone"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.api.mdx new file mode 100644 index 00000000000..e9848dd92c4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-result-of-a-sql-query-execution.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-the-result-of-a-sql-query-execution +title: "Get the result of a SQL query execution" +description: "Get the result of a SQL query execution" +sidebar_label: "Get the result of a SQL query execution" +hide_title: true +hide_table_of_contents: true +api: eJzFWW1zmzoW/isazc5sO+vWzd27Mx3u3A8E45jGBgdw02zc4cqg2LRYIpJIk/Xw33ckAcY2pG3uh36yrfOi5znn6CCOdzBHDG2xwIxD43YHY0oEJgIaO4jyPEtjJFJKhl84JXKNxxu8RfJbzmiOmUgxl7++4if5IZ5yDA3IBUvJGpblADJ8X6QMJ9C4VUqfB7USXX3BsYADKFKRKav7LMrQKlpjETHMi0zwqNqvlK5SAg14X2D2BAeQoK20uYflZ7kJzynhGspv797JjxcSiWlWbIn6mgq85S1WFeCyYYAYQ0/yd4IE+jkL/JgjkuAketF+Ogin2DeIrHESaYZ3lG2RgIZEh9+IdIvh4DhBAxgL1N5zRWmGEVGkVh0ZlctO0hKkROA1ZooTSUZCbFtCUmxXlYwxymaYc7TGUoEUWYZWMu2CFbgDF37EcSFwEtxnnTDwo2CoM1hp0mmQpdtUdANXopSsxygWlHVa54yuGea824HKR19YqlK+7DwhA8jotx6v+xI9MeKYPWDWtyPviRm/z+wkFfTQsCUXiIneFHKBBO60E6i7VATe5kFD4rspl+qh1vgRbYbirylZL1j2Q/oFx92plYLuSJb9vepKZtxXmW0KIEr78oEzHIuXHnYZ94J3QP8ePFsdoZQSv2qPVS7U6UHbXAe6wXS7k61UtzL9/bRJ6fW6/RwQP+viqfVrBnvkso9gHrM0l/igAYOrKVC+AK5RA9aE9/e/1dK3+7bzvQgehqYxhOcoAfJJhrkwgEMeUJYmYP/kBDmjD2mCky5qLVvN5ezXclkQVIgNZen/cGIAsxAbTES1P2ge1x1E2oaayb9/LZMxZas0STAxwA0tQELJPwXYoAcMcsy2KeeSkaAAxTHmHIhNymVR0YLFuItg40+z+/3XsnOpAHe0IIkBwg2uSwgnDQWQUMwBoQLgx1QW1ymjxodidPZ3TpF6gh+2rg6FSHPbQUyKrbzzjX3PDW13FFmBP45s3/d8ONivunZ47fmXp4LQmdneImwEF7Zr+44Vjc4j271wXLuRWN50MXOjkWcHkeuFkf3JCfZ2oXk+tfuEgTWxZ2af1PJc17ZCx3Mjx/1oTp1RtAhs3zVn9nM6czMIrj1/9JzOxAvCPj9zzw8ja+oF9rMulFqHXLqORt612yU0LcsOgmhku06394V76UrbkRma52bQCbCRzW1/5gSB47lBl56SuRfR3PTNmR3a/l7LO/9gW2FvWm7c0Pz07NZVecAB/Oj8N7qww2i0r642icBb+JYdhTfzPZex6UztUTS2Q2siAbb0HHfsHdVOYFsL3wlv6uDV0pbVcyoKbp/C1cL2b3qldQC9a9f2g4kz3zMMbD8yrdD5KM36tw8m557pj3o1rInph71Sz1yEk98i3x45vm2FpyuN5rlpXXad2iYAMsljb+GOjoJ7ul6TDu3ZfGqGti6fPai6/vvkvh0spmEQ1ZDkDpbnjp2Lhd+q+dFsqkTmdOpdt9Zr91ZoBpFOz4no44kouJpOzfMT+sdY6nUzuHGtSDa+9qEwRxPPioLFufb9HLrganq0SRR6XjQ1/Yt9mdct0/JmM7O1e71+jGrfwG6mnjmKxp4/M8NecdU8m7yZfjCZKcAtaKpLuV7ojB3LVEdYyz53vvL1vdJl+AFn7adKSu4oHMBviBFpXL1fdnr9uSfx8eX7Z6xPH78XlGDp5T+/+v7qEIEZQRnQL45AhcsAJgEFwY+5urXrRUDjuGA9N8AxEijTempzjuOCpeJJTY6+fBPQuP0sL/wCreXlX93qp2gl8/L4JqYJDhQ2PWnKEFlDA8YLfwoHMEMrmeL6Z3VJM2BcsAy8+QQu7BAs4UaI3BgOMxqjbEO5MN6/e/9+iPJ0+HA25PfyFXBYvW8PlxAsl0sCwJsJWEKzurqqkBvgHCOGGfhH1fFC79J2lxCWgwbX/ElsKGkhaxYabOk2p0zUNzO+JEtST6LAn83y2zUWryQO8NMEBtpsg1GCGf9zd0RjCQ2whBWVJQT/qm66kaBfMSmX5PWS5Cwl4lUN662stVevX7eJfkAPKFBJbpE9WNwngxIu+TYc0TeUCnCHRbxRFF9EcHfA0qh/g+OsSbp/1YnbaaqhYvqXtijlh6T9x5JoqPJttoF5FIRKiWb4bUbXr6Tq6z/UOPHoEGMBhLqAS9SA3gEEOl5XoWwWYkMTaMA1lmHLkdhAA/aQh/UUR5+GQo4xuqMHjxFNpRgksinSfIuJqI61yqp2tMsZFTSmWWkMhzvpqjR2slrLE29WwQXd1i4G8AGxVE5S6iu+ciO/J/gOyRdyDVM23aobVz/lB4cn8ZuE4Rw0fsoBlGgO/TV8T8AFul9JmZz4AsqAM1cDOcqOnHSGqrJX2mWphhFVz1LDEE1Sda4dXKnSGtdj0w/X8sajmrKajCrpfoSqSJcDaRwxfMcw37zUiZpt31FN5wB9kWPGcXuy01qStaP1Hs50SLjYIvUoqabjP166B/s2zxmBH8Uwz1Cq3ogLPWnTZX0LUZ5KEGdQDRYztILNrBMOoKwDnehbuNutEMcLlpUl3I+PbnfHuzbPR7iP0CEE9TcDvFdVmhVSrg5sXbLq+TOAupOoHbSBGcdYdbLa6uTxK700x/fClkmTw472ZLxOXfVFeq9vC+Sp5Xu30xq6NcnzpkGopgzLz2VZ/h+iOHOn +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"; + + + + + + + + + + +Get the result of a SQL query execution + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.ParamsDetails.json new file mode 100644 index 00000000000..3bd8889b85e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The ID of the user","in":"path","name":"user_id","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.StatusCodes.json new file mode 100644 index 00000000000..eb4e69c9447 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"301":{"description":"A redirect to the user's avatar URL"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.api.mdx new file mode 100644 index 00000000000..17f78f57933 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-avatar.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-the-user-avatar +title: "Get the user avatar" +description: "Gets the avatar URL for the user with the given ID, or returns a 401 error if the user is unauthenticated." +sidebar_label: "Get the user avatar" +hide_title: true +hide_table_of_contents: true +api: eJzFVttu3DYQ/ZXBoEBsVPbaqB8MBXlwHddxGiRGdo0UsAyHlmZXdCRSIUdrbwX9ezGUVnvxogUaoH2SeDs8Z3g4wwYz8qnTFWtrMMZLYg+cE6i5YuXg5vMHmFoXumpPDp4056E103MycPU2AuvAEdfOeFBwcnQM5Jx1oKerVdpDbVTNORnWqWLKDjHCSjlVEpPzGN82W0wmOcHVW7ArFIxQy0ilOMcIjSoJY5SRe51hhI6+19pRhjG7miL0aU6lwrhBXlQy1bPTZoZteyeTfWWNJy/jvxwdy2eTwBk4yrSjlIHtQOKVXwsNthGedGtTa5gMy6+qqkJEamtGj16wmjUulbMVOdbdziV5r2a0i2S07LEPj5Sy7EXPqqwK2liINyGw1uk/KYvhbBVkbQ0MMWkFcFPg+sJOycn/q+SjZZja2mQxyOkLd/JMGTjytnYpQWbJg7EM9Kw97xI1YHT7qpl4C2/EPncRPh+kNqNx2LszXaHMDGNM5TQjLNQDFatmt6u0a1fAwR9weTGBBHPmKh6NCpuqIree49Oj09ORqvRofjwSk4ya3pXtqDPLYWVmCUKSJAbg4B0keNaHPgQ3hl9JOXLw09n5+cV4fD/59PvFxwSxjQaG1wvOrVnjOHQMLHVZWcfLuPnEJGZpc3gzdB/OiPeEB/yAlKgDyEll5PybZktQgjEk2ItKEH4Glabk/T3bb2TaxOwnpnLa8N6S4KH4a29/f13yezVX43C2a7I3OlcHZI0X5YNa9aQ0w5Q4zYPYH5TabOiNl23YPkkR/nV5mE0nehI0f+1WtPKRALxOTEc6U6wGwlvh6CfZgg4LO9uTqfuvUfJXSZzbDGOcEYdUyjnG+I9yJGbk5suUWzsJ6c7I4PbN+iDDkNGcCluVZBg6pHBiHVBTOcs2tUUbj0aNQLVxI55sX6Cd155tuYSIcK6cVg9Fl0uWMF1Snqq64J4mRkimLuVO9035eLnbm/jvJpNrGHDaCIXNJt6g9wW5cWAFMiZVRirc1bWAiJZNkJ2h6teH2W0oN57S2mlejCV7diIfnwLUQzDLb9aVSvDef5lgX7rE190oDhk0iG4jWXzvaOrI5/8WpJVyOrUvC9+4rsj5YCvWLEl6vUu8082bH3ch8VyqUBr6inxJvKr8nfW2I7RWZf7bJ0cfAaZnHlWF0kYkBPM2/R26RVVp0XmMEfbPjnj1yFi7SndLU91i0zwoTzeuaFvp/l6TW2B8e7fydffC0V7+M4ynqvD0N0HZ+9wX7n3Y+RDaqaPvVGYRLlRRSwsj/EaLtYdSeye3ISSyQKobPUtTCil1ue5F7d/IOpcXE2zbvwAbdoIm +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"; + + + + + + + + + + +Gets the avatar URL for the user with the given ID, or returns a 401 error if the user is unauthenticated. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-object.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-object.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-object.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-object.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-object.StatusCodes.json new file mode 100644 index 00000000000..0d0d2162faf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-object.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"integer"},"is_active":{"type":"boolean"},"is_anonymous":{"type":"boolean"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"UserResponseSchema"}},"type":"object"},"example":{"result":{"email":"string","first_name":"string","id":1,"is_active":true,"is_anonymous":true,"last_name":"string","username":"string"}}}},"description":"The current user"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-object.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-object.api.mdx new file mode 100644 index 00000000000..0602b2102a1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-object.api.mdx @@ -0,0 +1,60 @@ +--- +id: get-the-user-object +title: "Get the user object" +description: "Gets the user object corresponding to the agent making the request, or returns a 401 error if the user is unauthenticated." +sidebar_label: "Get the user object" +hide_title: true +hide_table_of_contents: true +api: eJzFVlFv2zYQ/ivEYQ8JpsTx0IdCRR+yIEvXFVtQO9iAKEhp6WwxkUj1eHLjCfrvw1GyLTnZEGwPexJ5PB6/7+PdUQ1k6FMyFRtnIYYrZK84R1V7JOUWD5iySh0R+srZzNiVYhcc9Aotq1I/BluOivBrjZ4j5UgRck3WK63enE0VEjlSZrkPbLyqra45R8sm1YzZKUTQHeLRQ9zAD2dn8kmdZbQsQ11VhTgbZycPXuA24NMcSy2jilyFxKbbTejrgp/bsdSmkAFvKoQYPJOxK2gjWBryfG91iS8um2xgNpZxhRTs/l6nbNbDXQvnCtR2u2yd3ZSu9i97FPqfjhW1/maxjbaW7pogAjZciOHGI33uxZx1Cj13byPAJ11WBY4F6yXanjNWZm8VQaYj/kw1HjLubAOO+wB7antKgnKckPMcVVoTSbLJDoH95mz6H1KjRO/16lWKjiXabYSbkLuOzJ+Yxep8n8fG2VAHhjCDF9gMN3bn6ZWH+BYueopyc3AXwdNJ6jKchbPFoYFC2xXEkN58/gSi6AKL/dS7mlJBltZUqJM/1NXlXCWQM1fxZFK4VBe58xy/PXv7dqIrM1lPJyVOElBJklilTj6oBM57aIFGrH5ETUjqu/OLi8vZ7H7+2y+XvyYAbbTDcr3h3NkBmp1hh8eUlSPe9gaf2MRuq1y935lPV8hHgkO9CnTUueaoMyT/vjmAnkCsEujhJ6C+VzpN0ft7do9o28QeJ7YiY/loC+VUcubo+HhI7qNe61m4ugHBkXEvurNeOO546W/asFoip3mg9WpSzYhZvJ2rw9sRil+2F9R09OaB3ZduRysfofousR28TLPeQTsg3ju5Ak8LtzoS1+N30N5FUCLnLoMYViiUK805xDAALjogrZG6LK1JZHqRLRwWwydZVhmusXBVKdnfRQq30AVqKnLsUle08WTSSKg2biSj2mfRLmrPrtyGiGCtyehF0dX8NoyMM1zq0OoCTIgAbV1KDfZT+XipwXH8D/P5tdrFaSMQNON4O77PwM0CKiVr0vLkifz5WoIIl3GQF6Xq9wfvtpWL8ZjWZHgT2ntH8uFbCLUIafGTo1JLvI+/z+WOgpu8PGEVdp0ukG4j2XxPuCT0+b8NIs+dXbqOzgh9XSF5HL5QA5PkTue3nnaSeC51aOH983CFfPhPcqjQ4DX4f/9hekUYn3hSFdqENz4kc9NXzy3oygjvKUh9QQSSbF023ULTLLTHGyraVsxfa6QNxLd3+4SWmaRf6BGh6B5xAzGcpymGvrTWRS0Ynj2Ko4K+upxD2/4FuGhu2Q== +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"; + + + + + + + + + + +Gets the user object corresponding to the agent making the request, or returns a 401 error if the user is unauthenticated. + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-roles.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-roles.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-roles.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-roles.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-roles.StatusCodes.json new file mode 100644 index 00000000000..0d0d2162faf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-roles.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"integer"},"is_active":{"type":"boolean"},"is_anonymous":{"type":"boolean"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"UserResponseSchema"}},"type":"object"},"example":{"result":{"email":"string","first_name":"string","id":1,"is_active":true,"is_anonymous":true,"last_name":"string","username":"string"}}}},"description":"The current user"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-roles.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-roles.api.mdx new file mode 100644 index 00000000000..db848876da1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-the-user-roles.api.mdx @@ -0,0 +1,60 @@ +--- +id: get-the-user-roles +title: "Get the user roles" +description: "Gets the user roles corresponding to the agent making the request, or returns a 401 error if the user is unauthenticated." +sidebar_label: "Get the user roles" +hide_title: true +hide_table_of_contents: true +api: eJzFVt1v2zYQ/1eIwx4STInjoQ+Bij6kQZauK7agdrACUZDS0tliIpHq8eTGFfS/D0fJH7KzYd0e9iTyeHf8/Y73oQYy9CmZio2zEMM1sleco6o9kiJXoFepI0JfOZsZu1DswrleoGVV6qcgy1ERfqnRc6QcKUKuyXql1auzsUIiR8rMt36NV7XVNedo2aSaMTuFCLpLPHqIG/jp7Ew+qbOMlmWpq6oQZePs6NEL2gZ8mmOpZVWRq5DYdNaEvi74UI6lNoUseFUhxOCZjF1AG8HckOcHq0t88dhkO2JjGRdIQe4fdMpmuWs1c65AbdfH1tlV6Wr/skah/+5aidZfHLbRWuJmj5gyRMCGCxHceqSPfTAnXYQO1dsI8FmXVYHDgPUhWt8zjMxWKgEZD/gz1bjPuJPtcNw62FLbUhKUw3yc5qjSmkiSTSwE9quz8X9IjRK914t/FNFhiDaGcBty15H5hlmsLrZ5bJwNdWAIM3iBza5hd59eeIjv4LKnKC8H9xE8n6Quw0m4WxQaKLRdQAzp7ccPIBGdYbHdeldTKsjSmgp18kldX01VAjlzFY9GhUt1kTvP8fnZ+flIV2a0HI9KHIXyHiWgkiSxSp28Uwlc9AADmVi9RU1I6oeLy8uryeRh+vuvV78lAG20QXSz4tzZHUwbwQaVKStHvO4QPrGJXde6erMRny6QjwSH+g7oUWeQo86Q/Jtmj0ACsUqgJ5GA+lHpNEXvH9g9oW0Te5zYiozlozWgU8mfo+PjXYrv9VJPwjPu0BwItw/grBemG3b6qzas5shpHsh9J7VmwC9e79X+SwnRz+vHajqS08Dxc2fRykcIv05sBzLTrDcA9+j3Sq7A08ItjkT1+DW09xGUyLnLIIYFCvFKcw4xHMCXmCAtkbrsrUlC9iJz2C+SD3KsMlxi4apSqqLzFF6kc9RU5Nilrmjj0agRV23cSI61B94ua8+uXLuIYKnJ6FnR9YK1G1lnONehBQaYEAHaupTa7Lfy8VKbQ//vptMbtfHTRiBohv42fA/ATQIqJWfSCmV0/nIjToTL0MmLoertg3bbyvN4TGsyvAptvyP5+DW4moXk+NlRqcXf+z+m8kZBTSZSOIVNBwyk20iMHwjnhD7/t05kDNq56+gM0NcVksfdybUjktzp9JbjLiSeSx1aez82rpH3flX2A7QzJP7XP5s+HozPPKoKbcLkD6nc9BV0B7oywnoMUmPyN9QTkpTrcuoOmmamPd5S0bYi/lIjrSC+u9+mtewkCUO/CKX3hCuI4SJNMXSqpS5qwXIwMgfFfX01hbb9E706ecg= +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"; + + + + + + + + + + +Gets the user roles corresponding to the agent making the request, or returns a 401 error if the user is unauthenticated. + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-chart-s-with-associated-datasets-and-databases.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-chart-s-with-associated-datasets-and-databases.RequestSchema.json new file mode 100644 index 00000000000..bfce4beffd3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-chart-s-with-associated-datasets-and-databases.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing charts?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key_password\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key\"}`.","type":"string"}},"type":"object"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-chart-s-with-associated-datasets-and-databases.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-chart-s-with-associated-datasets-and-databases.StatusCodes.json new file mode 100644 index 00000000000..ec8f40024c1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-chart-s-with-associated-datasets-and-databases.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Chart import 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-chart-s-with-associated-datasets-and-databases.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-chart-s-with-associated-datasets-and-databases.api.mdx new file mode 100644 index 00000000000..40cd35a74b6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-chart-s-with-associated-datasets-and-databases.api.mdx @@ -0,0 +1,68 @@ +--- +id: import-chart-s-with-associated-datasets-and-databases +title: "Import chart(s) with associated datasets and databases" +description: "Import chart(s) with associated datasets and databases" +sidebar_label: "Import chart(s) with associated datasets and databases" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/iuHw4AmmBI3xQYUKoohTVssXdcGc7oNjYKEls4RG4pUScqJJ+i/D0fKsuM4WJthyAbskyXy7uHdc2+UW7T0uSHnX5hijmmLudGetOfHqlFe1sL60dTYaqcQXvCyy0uqwlNtTU3WS3L8xkIve5mCXG5l7aXRmGJTKyMKmEpFsPXx8GgbkyAtPKY4kVrYOSbo5zVhis5bqS+wS9DMyF5Z6ek24rAFdC2dl/oC8lJY735YAk2MUSQ0I9XCuStjC3cb6c34/TuoRA1mCoMYTI0FEnkJUxK+sVQAez8RjkBq8CXBx8Oj4NAuHE6HBalz1RTkQCzlc6On8mKhVgtfwvli041+nr/sn3fnolLnSS8VDQFXmkYVMCGorZnJgooF0NQoZa7Y8chkCudthncCZ5hChtX8bAGdYXe+u4l158oz32hN6uz+tC1BQDhncik8FeANiPszuoL5X+bUypnwdHZJ8y/md5PKv5vrpcX/BN0b+PhK6r+c8f+JDuh38NsNK2byiXKPHS/xSJGWCky9bSgsuNpoF+fEk8eP1waNqGslc8GBGH1yHI27p0xFzomLMBL+0pYE6VpUtaIbikuFLlnLgQOeISCr2lgPllyjAsp3D23xC1FAP6dTONQzoWQBtbCiIk/WDQHf5NOKbvRl72F9+aBF40tj5R9UpLDf+JK078+HIXM2OLKqGDx58uShPamtyfl1ogjYCz9P4VcOTvSGrDV2Y56FStXGQ4/Qa/NR3z90sh1qT1YLBY7sjGz0IoV9DY2m65py7nphEUyeN/aOcL0WXqiBggQd5Y1lH9OTFj9deUxPTrvTBL24cJiexNpzeJrg9U5uChoH01wQV0JfYIr5h1/eYoJKTEgtX51pbM6G541VsPM7HL0fH0OGpfd1OhopkwtVGufTp4+fPh2JWo5me6NwWxzFSh9lCFmWaYCdHyHD/T7LAuEpvCBhycI3+wcHr8bjs+P3P716d1PhIIZq53heUwrr0VrKFvCozTA0U26wM6EayrB7hF0yuHg096XRK04OC4ObQ3sKNe0ynelFf4Xnw/JubZzf4nPhK7lIolJJoiDrnrdrjETje1YyhG9B5JzCZ95cku56bfb8+SZvM72d6dpK7bcWVu+y8Nb29ioPb8RMjEM2rXBxY3EZdqNd6NYLCsSVkB6m5PMyEHAP99voRUW+NAWbzzm1Tk26EIP1rGGXzxeJ00Z+jgM958lSZTVvIkm3cydKL1idmGKeAt9UdmNZy+l8q4VLmq9QDN02SzPTzzId2eFZPzCzxnsvZBTtKnOxxaLbz5BL82ZBH8a8C3RtuW24kr5cvQixoiPvQOjlPchhgpFFTJFTEvlrzJeY4kb+ObCh7cTCbyzHfWP4cN2+t7wNBc1Imboi7fsGFtIqArW1Nd7kRnXpaNQyVJe2fG53C+2gcd5UC4gEZ8JK7vOu77kBJt4ip4LvCdFMTJB0U3FD61/5J7S1m/g/Hh8fwYDTJcjW3MQb/L1l3Dh2Zt7ToiIwFg6PwoeusWsgG6nq9YN013GoF915zHMlOhl6dIuTkMavF5/rb3475hgFMf7IDrvLi2FwuktY+czS1JIr7wvSJSj11Ny+qY+bmqwjpsVLz+NrdYlzJ8rN9iIlzlciDE3m6u8k8g0zhgHr6dqPaiVk+KshJFrb5/gJilqyTXuYYDgPk75/Y4KcFDHqJ9i2fMgHq7qOlz83ZHlSni4TL8zLBGPvCcVxSfNwl1h2kZCnqmGrNv15w4UQlfbznEIXXYjfumNwUgyFy90PE5z0/xFVpmAdBg64yfIxGskXtRWGhvj2D2x8vyX0fMWKto0SsVdyUUZzw2jB7rTruj8BrEKHBA== +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"; + + + + + + + + + + +Import chart(s) with associated datasets and databases + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dashboard-s-with-associated-charts-datasets-databases.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dashboard-s-with-associated-charts-datasets-databases.RequestSchema.json new file mode 100644 index 00000000000..e37e9ae83d9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dashboard-s-with-associated-charts-datasets-databases.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP or JSON)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing dashboards?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key_password\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key\"}`.","type":"string"}},"type":"object"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dashboard-s-with-associated-charts-datasets-databases.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dashboard-s-with-associated-charts-datasets-databases.StatusCodes.json new file mode 100644 index 00000000000..7692ed4a255 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dashboard-s-with-associated-charts-datasets-databases.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Dashboard import 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dashboard-s-with-associated-charts-datasets-databases.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dashboard-s-with-associated-charts-datasets-databases.api.mdx new file mode 100644 index 00000000000..91f3ac8c4ed --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dashboard-s-with-associated-charts-datasets-databases.api.mdx @@ -0,0 +1,68 @@ +--- +id: import-dashboard-s-with-associated-charts-datasets-databases +title: "Import dashboard(s) with associated charts/datasets/databases" +description: "Import dashboard(s) with associated charts/datasets/databases" +sidebar_label: "Import dashboard(s) with associated charts/datasets/databases" +hide_title: true +hide_table_of_contents: true +api: eJztWGFv2zYQ/SuHw4AmmBK3xQYUKoohTVssXdcGc7oNi4KEls4RW4pUScqJJ+i/D0dKsuM4WBds6AbskyXq7nTv3eMd5RYtfWrI+eemWGLaYm60J+35smqUl7WwfjI3ttorhBe87PKSqnBVW1OT9ZIc37HRi96mIJdbWXtpNKbY1MqIAuZSEez8dnQMxsLr6bu3u5gEL+ExxZnUwi4xQb+sCVN03kp9iV2CZkH2ykpPtyOPj4CupfNSX0IhXDkzwhbuu1WwmTGKhOZotXDuytjC3Y7GOUElajBzGM1gbiyQyEuYk/CNpQKYiZlwBFKDLwkYEoPbh6P5uCB1rpqCHIiVfW70XF4ObrXwJVwMD93kx+WL/np/KSp1kfRWMRFwpWlUATOC2pqFLKgYAs2NUuaKwUc2U7hoM7wzcIYpZFgtz4fQGXYX+9uYd648943WpM7vT9sqCAjnTC6FpwK8AXF/Rtdi/pc5tXIhPJ1/pOVn87vN5d/N9Srjf4LuLXz8Reo/n/H/iQ7R7+C3G1fM7APlHjte4vEiLRWYettQWHC10S7OjMcPH24MHVHXSuaCCzH54Lgad0+cipwTl2Es/GkuCdK1qGpFNxxXDl2yoYEXwxwBWdXGerDkGhUiffOls34uCujndgpHeiGULKAWVlTkybqx6NtwrflGLI++LJb3WjS+NFb+TkUKB40vSfv+/TCqZwuQdceA5PHjL42ktibn25kiYBR+mcLPXJyIhqw1dhuUw7BbtfHQR+i9+VXffmmxHWlPVgsFjuyCbESRwoGGRtN1TTl3vrAIJs8be0e5Xgkv1EhBgo7yxjLG9LTFD1ce09Oz7ixBLy4dpqer/efwLMHrvdwUNA3pueCihL7EFPP3P73BBJWYkVrdOtPYnJPPG6tg71c4fjc9gQxL7+t0MlEmF6o0zqdPHj55MhG1nCweTcaT4yTu+EmGkGWZBtj7HjI86NUWiE/hOQlLFr46ODx8OZ2en7z74eXbmw6HsWR7J8uaUtis2sq2gAdthqGxcrNdCNVQht0D7JIR5vHSl0avAR0XRqhjmwp722U600OvhWfj8n5tnN/h98I9+EiiY0miIOuetRusRAA9MxnC1yBylvO5Nx9Jd703o3+2DXGmdzNdW6n9zpD5Phvv7O6uc/FaLMQ0KGuNjxuLq/Ib7ULnHmgQV0J6mJPPy0DCPSloI5KKfGkKhsD62qQnHcxgUz0M+2IQUBs5OgkUXSQrl3X9RKJuayhaD8zOTLFMw6fVftzmcr7caeEjLddohm6XrZntp5mODPH8H9nZ4L43Mor2lbncYdPdp8hb9eYGP4r6GynbcbtwJX25fkDKS2G9m3AMR/1FOHdggpFMTJEVivyh5ktM8c5ScJ1DR4r9oLEsg63VxM1U3/BjKGhBytQVad/3tqCyGKitrfEmN6pLJ5OWQ3Vpy+/tbkU7bJw31RAiwYWwkkeA69txCBMPmXPBR4iYJiZIuqm41/W3/BO63c3435+cHMMYp0uQs7kZb8R7K7lpbNr8TIuK+NP76Dh8Bxu7EWQrVb1/sO46rvrQuKc8ciLI0L5bnAVFvxq+6F//csI1Cmb8DR6ers6NAXSXsPO5pbklV943SJeg1HNz+yA/bWqyjpgWLz1PtvUl1k60WzyKlDhfiTBPmau/QdM3shlHsKdrP6mVkOEPiaC3tpf7KYpacmqP2Ht4LSZ9d8cEWR9RAKfYtvyi91Z1HS9/asjyPD1baTBM1QRjRwr75CMtw4lj1VuCZFXDmW37y4f3RHQ6yHMK/XUwv3USYX2M+5h7IiY46/9ZqkzBPhw4xE1WlzFJPs6tsTSWur/g5PtHQi/XsmjbaBE7KO/PmG4YOtiddV33B9oCnBs= +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"; + + + + + + + + + + +Import dashboard(s) with associated charts/datasets/databases + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-database-s-with-associated-datasets.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-database-s-with-associated-datasets.RequestSchema.json new file mode 100644 index 00000000000..400a83ef831 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-database-s-with-associated-datasets.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing databases?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key_password\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key\"}`.","type":"string"}},"type":"object"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-database-s-with-associated-datasets.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-database-s-with-associated-datasets.StatusCodes.json new file mode 100644 index 00000000000..126f4f7a972 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-database-s-with-associated-datasets.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Database import 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-database-s-with-associated-datasets.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-database-s-with-associated-datasets.api.mdx new file mode 100644 index 00000000000..89eb639912a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-database-s-with-associated-datasets.api.mdx @@ -0,0 +1,68 @@ +--- +id: import-database-s-with-associated-datasets +title: "Import database(s) with associated datasets" +description: "Import database(s) with associated datasets" +sidebar_label: "Import database(s) with associated datasets" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/iuHw4AmmBI3xQYUKoohTVs0XdcGs7sNjYKEls6RGopUScqJJ+i/D0dKsmM7WBtgyAbskyXy7njPc2+UGzT0pSbrXuhsgXGDqVaOlOPHspauqIRxo5k25V4mnOBlm+ZU+qfK6IqMK8jyGwu97GQysqkpKldohTHWldQig1khCXY+HZ/sYuSlhcMYp4USZoERukVFGKN1plCX2Eao52SuTeFo0+KwBXRTWFeoS2D3psKS/Wlpa6q1JKHYWCWsvdYms5vG3o4/vIdSVKBnMIjBTBsgkeYwI+FqQ9lwAhQKXE7w6fjEY9qH49mwUKhU1hlZEEv5VKtZcdmrVcLlcDG4O/pl8bJ73l+IUl5EnVRwBGyua5nBlKAyel5klPWGZlpKfc3YA5kxXDQJ3mk4wRgSLBfnvekE24v9bcRbm5+7WimS5/enbWkEhLU6LYSjDJwGcX9GV2z+lzk1xVw4Or+ixVfzu03l38310uN/gu4tfHwj9V/P+P9Ee+t38NsOK3r6mVKHLS/xVCkMZRg7U5NfsJVWNoyKJ48fr80aUVWySAUHYvTZcjTuHjQlWSsu/VT4W18ipBtRVpJuKS4V2mgtB14O0SsrbRwYsrX0hn54aKdfiAy6aR3DsZoLWWRQCSNKcmTsEPNtsFZ0A5aDh8XyUYna5doUf1IWw2HtclKuOx+G5NkCZFXRI3ny5KGRVEan/DqVBIzCLWL4jYMT0JAx2myDcuSLVWkHnYVOm4/68aGT7Vg5MkpIsGTmZAKKGA4V1IpuKkq58flF0GlamzvC9Vo4IQcKIrSU1oYxxqcNfr52GJ+etWcROnFpMT4dyg/PIrzZS3VGY++c9QpSqEuMMf346zuMUIopyeWr1bVJ2fW0NhL2/oCTD+MJJJg7V8WjkdSpkLm2Ln76+OnTkaiK0fxg1HfAUSj3UYKQJIkC2HsDCR52qeZZj+EFCUMGvjs8Ono1Hp9PPvz86v1thaMQr73JoqIY1kO2lM3gUZOgb6rcaOdC1pRg+wjbaEB5snC5Vis4h4UB6dCjfGHbRCWq77PwfFjer7R1O3wufDsdUdDLSWRk7PNmjZTgf0dMgvA9iJRT+dzpK1Jtp83gn28DnKjdRFWmUG6nd3yfhXd2d1epeCvmYuyzaoWOW4vL4GtlfdfuWRDXonAwI5fmnoP7MdAEICW5XGeMgJNrnZ24F4P13GHUF336NIGiiWfoIlqqrGZP4Gkzg4J0T+xUZ4sY+N6yHyq8mC12GriixQrL0O6yNJP9LFGBIIY5kLNGfSekJe1LfbnDorvPkKv0dm0fh+zrGduxu3BduHz1ZsR7lpzFCAN1GCNnI/IHmcsxxrt455j6zhMqvzYc8q2Rw3W/3vE2ZDQnqauSlOt6mM+oYKipjHY61bKNR6OGTbVxw+e2G9aOaut02ZuIcC5Mwa3edm3Xmwl3yZngq0JwEyMkVZfc07pX/rG4weKbyeQEBjtthOzNbXsD3g3nxqE5854SJYE2cHziP3e1WTOylapO30u3LYe4b9BjHi0BpG/TDU59+r7uv9vf/j7hGHkx/tT2u8vroQfdRqx8bmhmyOb3NdJGWKiZ3ryvj+uKjCWmxRWOJ9jqEudOkJsfBEqsK4Wfm8zVNyfwrbOHweroxo0qKQr/L4PPrqbL7VMUVcGOHLB2P9iirmtjhJwMIdqn2DS8+9HItuXlLzUZHpJny4TzozLC0Gt8UVzRwl8jll3D56es2bFt/95wAQSlwzQl3zh78Y3rBSfDULPc7TDCafcnUakz1mHD3m60fAxO8h1thaQhrt0DO99tCbVY8aJpgkTojVyMwV0/TbA9a9v2L9Wqh7k= +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"; + + + + + + + + + + +Import database(s) with associated datasets + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dataset-s-with-associated-databases.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dataset-s-with-associated-databases.RequestSchema.json new file mode 100644 index 00000000000..5b9f8c7f350 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dataset-s-with-associated-databases.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP or YAML)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing datasets?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key_password\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key\"}`.","type":"string"},"sync_columns":{"description":"sync columns?","type":"boolean"},"sync_metrics":{"description":"sync metrics?","type":"boolean"}},"type":"object"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dataset-s-with-associated-databases.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dataset-s-with-associated-databases.StatusCodes.json new file mode 100644 index 00000000000..803ede4cf18 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dataset-s-with-associated-databases.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Dataset import 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dataset-s-with-associated-databases.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dataset-s-with-associated-databases.api.mdx new file mode 100644 index 00000000000..b333ddd6b35 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-dataset-s-with-associated-databases.api.mdx @@ -0,0 +1,68 @@ +--- +id: import-dataset-s-with-associated-databases +title: "Import dataset(s) with associated databases" +description: "Import dataset(s) with associated databases" +sidebar_label: "Import dataset(s) with associated databases" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/iuHw4AmmBI3xQYUKoohTVs0XV+COd1bFDi0dI7YSKRKUk40Qf99OFKWHdsB2gBDNmCfLJF3x3ueO96d3KKhLzVZ90JnDcYtplo5Uo4fy7pwshLGjWbalHuZcIKXbZpT6Z8qoysyTpLlNxZ62ctkZFMjKye1whjrqtAig5ksCHb+PD4BbeCPw/fvdjHyWsJhjFOphGkwQtdUhDFaZ6S6xC5CPSdzbaSjTcvDFtCNtE6qS2A3LTn709LUVOuChGJblbD2WpvMbtp6O/74AUpRgZ7BIAYzbYBEmsOMhKsNZf6AqbAEUoHLCRgQQ9uH49mwIFVa1BlZEEv5VKuZvFyoVcLlcLHYtKP3zcv+eb8RZXER9VLBEbC5rosMpgSV0XOZUbYwNNNFoa8ZeuAyhos2wTsNJxhDgmUzWZhOsLvY38a7tfnE1UpRMbk/bUsjIKzVqRSOMnAaxP0ZXbH5X+bUyLlwNLmi5qv53aby7+Z66fE/QfcWPr6R+q9n/H+ivfW7+W1UOkl1UZdqC6m8C/3u9tLs9UtyRqZ36fe72/S7YUlPP1PqsOMlbm7SUIaxMzX5BVtpZUPHevL48VrLE1VVyFTwmaPPlg++u9+VZK249E1pjYtNXyKkG1FWBd1SXCp00Rrcl6GLgSwrbRwYsnXh7fzw0D6/EBn0M0MMx2ouCplBJYwoyZGxQ8ptQ7WiG7AcPCyWT0rULtdG/kVZDIe1y0m5/nwYcmcLkFVFj+TJk4dGUhmd8uu0IGAUronhVw5OQEPGaLMNypGvFUo76C302nzUjw+dbMfKkVGiAEtmTiagiOFQQa3opqKU665fBJ2mtbkjXK+FE8VAQYSW0towxvisxc/XDuOz8+48QicuLcZni9tn8TzCm71UZzT2zlmvUAh1iTGmn355hxEWYkrF8tXq2qTselqbAvZ+h5OP41NIMHeuikejQqeiyLV18dPHT5+ORCVH84NRP7OOwm0fJQhJkiiAvTeQ4GGfaZ70GF6QMGTgu8Ojo1fj8eT048+vPtxWOArh2jttKophPWJL2QwetQn6ks5lfi6KmhLsHmEXDSBPGpdrtQJzWBiADiXK32ubqEQtqiw8H5b3K23dDp8L38xGFNRyEhkZ+7xd4yS43/OSIHwPIuVEnjh9RarrtRn78214E7WbqMpI5XYWfu+z8M7u7ioTb8VcjH1OrbBxa3EZeq2sr9kLEsS1kA5m5NLcU3AvAtqAoySX64wBcGatkxMvxGA9cxj0xSJ52sDQqSfoIlqqrOZOoGkzf4L0gtepzpoYeGbaD9dbzpqdFq6oWSEZul2WZq6fJSrwwygHbtaY74V0QfuFvtxh0d1nyFf09sU+DrnXE7Zjd+Faunx1KBtmG4wwUIcxci4ifwy6HGO8g3aOqK864dbXhgO+NW647tY73oaM5lToqiTl+vrl8ykYaiujnU510cWjUcumurjlc7sNa0e1dbpcmIhwLozkMm/7kuvNhIlpJnhMCG5ihKTqkutZ/8o/vqbdtv/m9PQEBjtdhOzNbXsD3g3nxqEw854SJfGn/fGJ/9LWZs3IVqp6fS/ddRzhRXEec1sJIH2JbnHqs/f14h+Dt7+dcoy8GI+Cfnc5GnrQXcTKE0MzQza/r5EuQqlmenMqHdcVGUtMi5OOu9fqEudOkJsfBEqsK4XvmczVN+fvrbOHpuroxo2qQkg/RfvsavvUPkNRSXbkgLXDIRj1FRsj5FwIwT7DtuVjPpmi63j5S02G++P5Mt98l4wwVBp/J66o8RPEsmb49Cxq9mvb30ec/0HpME3JV82F+MZkwbkw3FiudRjhtP+XqtQZ67BhbzdaPgYneTxb4WgIa//AzvdbQjUrXrRtkAiVke9icNe3EuzOu677GybQtZg= +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"; + + + + + + + + + + +Import dataset(s) with associated databases + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-export.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-export.tag.mdx new file mode 100644 index 00000000000..f081ae4a9b6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-export.tag.mdx @@ -0,0 +1,13 @@ +--- +id: import-export +title: "Import/export" +description: "Import/export" +custom_edit_url: null +--- + +Import and export Superset assets (dashboards, charts, databases). + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Export all assets](./export-all-assets) | `/api/v1/assets/export/` | +| `POST` | [Import multiple assets](./import-multiple-assets) | `/api/v1/assets/import/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-multiple-assets.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-multiple-assets.RequestSchema.json new file mode 100644 index 00000000000..90230f1924b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-multiple-assets.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"multipart/form-data":{"schema":{"properties":{"bundle":{"description":"upload file (ZIP or JSON)","format":"binary","type":"string"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"sparse":{"description":"allow sparse update of resources","type":"boolean"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key_password\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key\"}`.","type":"string"}},"type":"object"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-multiple-assets.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-multiple-assets.StatusCodes.json new file mode 100644 index 00000000000..4dade005a51 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-multiple-assets.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Assets import 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-multiple-assets.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-multiple-assets.api.mdx new file mode 100644 index 00000000000..e6066629533 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-multiple-assets.api.mdx @@ -0,0 +1,68 @@ +--- +id: import-multiple-assets +title: "Import multiple assets" +description: "Import multiple assets" +sidebar_label: "Import multiple assets" +hide_title: true +hide_table_of_contents: true +api: eJztWFFv2zYQ/iuHw4AmmBI3xQYUKvqQZi2armuCOd2GRUFCS+dIDUWyJOXEE/TfhyNl2XGcrQ0wZAP2ZIq8+3j33fGOdIuWPjfk/CtdzDFtMdfKk/I8rBvpKyOsH021rXcK4QVPu7ykOoyM1Yasr8jx16RRhSQeFeRyWxlfaYUpNkZqUcC0kgRbvx8eg7bwbnz0YRsTZGDhMcVJpYSdY4J+bghTdN5W6hK7BI1w7lrbwt1FZhSohQE9hUEMptoCibyEKQnfWCqALZ8IR1Ap8CUBG8Hm7MLhdJioVC6bghyIpXyu1bS6XKgZ4Uu4WCy60U/zH/rx7lzU8iLppaIh4ErdyAImBMbqWVVQsQCaain1daUuIfqfwkWb4b3AGaaQYT0/X0Bn2F3sbuLKGWHdhhAI3g/iKjSmEJ6YM0tONzYnt8SaaC1JqADmynPfKEXy/OExWIKAcE7nlfBUgNcgHh6eFcz/XIBWOLXVTHg6v6L5F/O7SeXfzfXS4n+C7g18fCX1X874/0QH9Hv47YYZPflEuceOp7i3VJYKTL1tKEw4o5WLDePZ06drHUcYI6tccCBGnxxH4/52U5Nz4jIUu7+1JUG6EbWJ3WlQXCp0yVoO7DtH3kFVG20918lGBpjvHtvkV6KAvmOncKhmQlYFGGFFTZ6sGyK+yakV3ejL3uP68lGJxpfaVn9QkcJ+40tSvt8fhtTZ4MiqYvDk2bPH9sRYnfPnRBKwF36ewi8cnOgNWavtJlcOwlFV2kOP0GvzVt8/drIdKk9WCQmO7Ixs9CKFfQWNohtDOZe9MAk6zxt7T7jeCC/kQEGCjvLGso/paYufrj2mp2fdWYJeXDpMT/EwnLoR3fAPniV4s5PrgsbBQhe0pFCXmGL+8ef3mKAUE5LLz3ip4e/GStj5DY6PxieQYem9SUcjqXMhS+18+vzp8+cjYarRbG8kwokfxRM/yhCyLFMAO28hw/0+2wLxKbwiYcnCN/sHB6/H4/OTox9ff7itcBBDtnMyN5TCetSWsgU8aTMMVZUr7UzIhjLsnmCXDD4ez32p1YqXw8Tg51Cmwtl2mcrUotDCy2F612jnt3hf+FoykqhVkijIupftGiXR+p6WDOFbEDnn8rnXV6S6Xptdf7nJ3UxtZ8rYSvmthdm7LLy1vb1KxDsxE+OQVitk3JpcBl4rF8r2ggNxLSoPU/J5GRh4iP9tdKMmX+qC7ee0WucmXYjBet6wzxeL1GkjQSeBn4tkqbKaOZGlu9kTpRe0TnQxT8ODajce8Go632rhiuYrHEO3zdJM9YtMRXq47Q/UrBHfC2lJu1JfbrHo9gvkQ3r7aMejCvGlKAkicZhgZAlT5KRDfsX5ElPcTDCHLlSYeLgby5HdGCBcN+A9L0NBM5La1KR8X6tC4kSg1ljtda5ll45GLUN1acv7dnfQDhrndb2ASHAmbMUl3fXlNcDEG+NU8JUgmokJkmpqrl39J/84vEPX25OTYxhwugTZmtt4g793jBvHIsxrStTEz+jD4/BC5jJ5C2QjVb1+kO46juWiEI+5hUQnQzlucRLy9M3idf7u1xOOURDjR2JYXV4Cg9NdwsrnlqaWXPlQkC7BSk313Vv5uDFkHTEtvvLcqVanOHei3GwvUuJ8LUJ/ZK7+KlNvbTP0Sk83fmSkqMJTOCRS2yfxKQpT8Z57mOAAE1MZE+Sox7CeYtvyXfqjlV3H058bstz1zpaZFXpfgrF6hOy/onm4FyzrQEhE2bBZm/6S4UyPSvt5TqEQLsTv3Bc46sPR5PqFCU76f35qXbAOAwfcZDmMRvKla4WiIYD9gI3vl4Sar1jRtlEiVjs+ddHc0B2wO+u67k90knh7 +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"; + + + + + + + + + + +Import multiple assets + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-saved-queries-with-associated-databases.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-saved-queries-with-associated-databases.RequestSchema.json new file mode 100644 index 00000000000..b6193130e6b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-saved-queries-with-associated-databases.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing saved queries?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_password\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key_password\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\"databases/MyDatabase.yaml\": \"my_private_key\"}`.","type":"string"}},"type":"object"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-saved-queries-with-associated-databases.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-saved-queries-with-associated-databases.StatusCodes.json new file mode 100644 index 00000000000..2f1c57b6b7b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-saved-queries-with-associated-databases.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Saved Query import 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-saved-queries-with-associated-databases.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-saved-queries-with-associated-databases.api.mdx new file mode 100644 index 00000000000..fd28b012137 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-saved-queries-with-associated-databases.api.mdx @@ -0,0 +1,68 @@ +--- +id: import-saved-queries-with-associated-databases +title: "Import saved queries with associated databases" +description: "Import saved queries with associated databases" +sidebar_label: "Import saved queries with associated databases" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v3DYM/isEMaAJ5uSaYgMKF8WQpi2armvTXboNjYOLzubFam3JleRLPMP/faDk873ksnUBhmzAPp0tkRSfhxRJX4uGvtRk3TOdNRi3mGrlSDl+LOvCyUoYN5ppU+5lwgletmlOpX+qjK7IOEmW31joeS+TkU2NrJzUCmOsq0KLDGayINj5eHyyi5GXFg5jnEolTIMRuqYijNE6I9UldhHqOZkrIx3dtDhsAV1L66S6BCvmlMGXmowk+8PS3lTrgoRig5Ww9kqbzN40+Hr87i2UogI9g0EMZtoAiTSHGQlXG8qASZgKSyAVuJzg4/GJx7UPx7NhQaq0qDOyIJbyqVYzeblQq4TL4WKxaUc/Nc/75/1GlMVF1EsFR8Dmui4ymBJURs9lRtnC0EwXhb5i/IHQGC7aBG81nGAMCZbNZGE6we5ifxv51uYTVytFxeTutC2NgLBWp1I4ysBpEHdndMXmf5lTI+fC0eQzNV/N7zaVfzfXS4//Cbq38PE3qf96xv8n2lu/hd9uWNHTT5Q67HiJO4s0lGHsTE1+wVZa2dAuHj18uNFvRFUVMhUciNEny9G4vdmUZK249J3hL32JkK5FWRW0prhU6KKNHBj7VvK+JtOALCttHBiydeFtfXfffj8TGfRNO4ZjNReFzKASRpTkyNgh7NuQregGLAf3i+WDErXLtZG/UxbDYe1yUq4/H4b82QJkVdEjefTovpFURqf8Oi0IGIVrYviFgxPQkDHabINy5O+r0g56C702H/X9fSfbsXJklCjAkpmTCShiOFRQK7quKOXa5xdBp2ltbgnXS+FEMVAQoaW0NowxPmvx05XD+Oy8O4/QiUuL8Rm+D2Mcnkd4vZfqjMbeN+vlC6EuMcb0w89vMMJCTKlYvlpdm5Q9T2tTwN5vcPJufAoJ5s5V8WhU6FQUubYufvzw8eORqORofjDys+OEZ8dmFC78KEFIkkQB7L2CBA/7ZPO8x/CMhCED3xweHb0Yjyen73588XZd4ShEbO+0qSiGzaAtZTN40CboKytX27koakqwe4BdNAA9aVyu1QrUYWEAO1Qpf7VtohK1KLbwdFjer7R1O3wu3ImRKKjmJDIy9mm7wUuA0HOTIHwLIuV8njj9mVTXazP+p9swJ2o3UZWRyu0sfN9n4Z3d3VU2Xou5GPvUWmFkbXGZAlpZX7oXRIgrIR3MyKW5p+HOJLQBS0ku1xmD4CzbJCheiMFmBjHwi0UStYGlU0/SRbRUWc2hQNXNPArSC26nOmti4BFmP9x0OWt2WvhMzQrR0O2yNPP9JFGBIx4CBn422O+FdEH7hb7cYdHdJ8i3df2OH4ccXPsOgyvp8tUxaZg2MMLAHsbIaYn8eeZyjPFP2Ofg+joUCkFtOPZbQ4ib3r3hbchoToWuSlKur2g+tYKhtjLa6VQXXTwatWyqi1s+t7th7ai2TpcLExHOhZFc+G1fhL2ZMFzOBA8OwU2MkFRdcoXrX/nHl7l1+69OT09gsNNFyN6s2xvw3nBuHEo17ylREmgDxyf++1ebDSNbqer1vXTXcaAX5XrMjSaA9EW7xalP4peLj/nXv55yjLwYf3v73eW86EF3EStPDM0M2fyuRroIpZrpmwP8uK7IWGJanHTcz1aXOHeC3PwgUGJdKXwXZa7uksZrxw+d1tG1G1WFkP6fB59gbZ/hZygqyb4cMMxllmPU13GMkFMixPwM25aP+mCKruPlIBufnS/TzrfPCEPd8VfjMzV+tFhWEJ+lRc2+bftjh69BUDpMU/J1dCF+Y+TglBguL1c+jHDa/39U6ox12LC3Gy0fg5M8t63wNES3f2Dn+y2hmhUv2jZIhDrJVzK465sLdudd1/0B2sWUbA== +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"; + + + + + + + + + + +Import saved queries with associated databases + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/invalidate-cache-records-and-remove-the-database-records.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/invalidate-cache-records-and-remove-the-database-records.RequestSchema.json new file mode 100644 index 00000000000..1349268ad50 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/invalidate-cache-records-and-remove-the-database-records.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"datasource_uids":{"description":"The uid of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_uid` ","items":{"type":"string"},"type":"array"},"datasources":{"description":"A list of the data source and database names","items":{"properties":{"catalog":{"description":"Datasource catalog","nullable":true,"type":"string"},"database_name":{"description":"Datasource name","type":"string"},"datasource_name":{"description":"The datasource name.","type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"type":"string"},"schema":{"description":"Datasource schema","type":"string"}},"required":["datasource_type"],"type":"object","title":"Datasource"},"type":"array"}},"type":"object","title":"CacheInvalidationRequestSchema"},"example":{"datasource_uids":["string"],"datasources":[{}]}}},"description":"A list of datasources uuid or the tuples of database and datasource names","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/invalidate-cache-records-and-remove-the-database-records.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/invalidate-cache-records-and-remove-the-database-records.StatusCodes.json new file mode 100644 index 00000000000..7293178251c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/invalidate-cache-records-and-remove-the-database-records.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"cache was successfully invalidated"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/invalidate-cache-records-and-remove-the-database-records.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/invalidate-cache-records-and-remove-the-database-records.api.mdx new file mode 100644 index 00000000000..3505fddbba4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/invalidate-cache-records-and-remove-the-database-records.api.mdx @@ -0,0 +1,68 @@ +--- +id: invalidate-cache-records-and-remove-the-database-records +title: "Invalidate cache records and remove the database records" +description: "Takes a list of datasources, finds and invalidates the associated cache records and removes the database records." +sidebar_label: "Invalidate cache records and remove the database records" +hide_title: true +hide_table_of_contents: true +api: eJzFV1Fv2zYQ/ivEYUATTImTYQUKFX1wsxZtV7RB7WIDrCBhpHPEhiJVkrLjCfrvw5GSLNlOB2QPfbJF3h3vvvvueKwhQ5saUTqhFcQw5/doGWdSWMf0kmXccasrk6KN2FKozDKuMibUikuRcYeWuRwZt1angjvMWMrTHJnBVJtW2GChV60g2bvlthc4hQgMfq/Qutc620BcQ6qVQ+XoLy9LKVJOvk2+WXKwBpvmWHD6VxpdonECLX1tPb2uRBaWxqHlyCqRUVSdJxbdZKvHXC4sU7hmac6NY2shJassnrIpS3VRSnQ4AISJDJUTy9ZBphAzy27GftwwiEA4LLxDblMixGCdEeoOmqhb4MbwDX0P4N4PYNpnpfOftZ4Qyj2yihdoh6eOcUq541Lf7Zv/YxtZJxOBqqTktxIhdqbCaD+C7thrOvaHRr3AIxZawA7bmOcj2Eno9D8Mhb1DhminJ/Y4/V0+MWNajRIpshs6EVVVQLwA5xFpD0QHEXyv0GwgAstXmF13XyuBa7g64OmWw4+i1YrsKTehXoTBjFzZjXl7mr79hin55oSj/A2M7zOveVztgur5fVfvQqsvoVxnwcEmAnzgVBwHi3DROX61Q+5F3Vw1dO5jHB9Is8rXrfG8d1Up0XYSnvEd/QcEsTDEibjrgbOlVjbUwW9n5/sJCM1rzS2zVZqitctKys2g3WUU8O9nZ/+jURVoLb/DA/1gLwtjcHtFeM2pq/o0xKzNDSu54QU6NJaVRq9ERs7uIzzQJfvPf3Ys75VDo7hkFs0KDUNjtInZVLFK4UOJKV0qfpHpNK2MORzWW2pZQc4fbjGtjHAbYhp8WzuIF1cNVQe/87T0tP6C1k1LQeR8OEl1hjPvoKcnSK7uiBJfv3yECCS/Rbn9bAsphrQykp38zS4/z+Ysgdy5Mp5MpE65zLV18YuzFy8mvBST1fnEs+seN5MtnxJgSZIoxk7esQSmlcu1Ef948GP2GrlBw36ZXly8mc2u55//fPNprHAR0nYy35QYs93MbWUz9qxO4B43CcQsgRWXFSbQPIMm6gO93Lhcq0Go/UIfrChKbVxHH5uoRHU1xV71y6eltu6IzmVPQiQKqjnyDI19Ve/gEkJosUmA/cq4L9Vrp+9RNa02xf/qUMyJOk5UaYRyR53vpyR8dHw8ROMDX/GZ59cAkdHilgJaWQKlB4KvuXBsiS7NPQxPBqEOsRTocp1REMSyXYDiToztMogCv+lIVAeU5h6km2irMuRQgGqfR0G6w/ZWZ5uYfZh9/nQayl0sN0c1u8fNAGjWHJM04f0yUQEjP7N0+Oyg3wppiadS3x2R6PFLoJIN4UMMxCuIoOQuhxh+AB9lx3eTUMmVoeQdzAHs9pGPtM0yXKHUZYHKtX3JcyMYqkujnU61bOLJpCZTTVxTYTR71i4q63TRmYhgxY2g4aGby7yZcA0teSVd6+Zg1mg/6cf6S3Rk/918fsl6O00E5M3YXh/vnnOz0HBpj65MumDfX5IRimVs5CBUrb6XbhrKVNd0/WwQgvStt4Zbz8K32hSc7H34aw7tGEQVFHa3w44PuolI+drg0qDNn2qErNh+aKE3xpunjSvbwbmT2Rt+xxujmfbgVutoN052l2x/h141EQi11Ptzyqwq0YTRs5vTBktE/CC3Og/5tK7g/iJvvennOXz0vXbwubbLgcHg8FOejh2C+OAmpeRCUbi+Suu2TSyAl4IwOYcIulZBr6Nts7jqymYBdU0nfDWyaWg5DPLx4mpbuX6OiCD0Xs8LshePuqgvdFn5+Xp3mKI2EjSmaYr+Inlcdtj8qPVDBLftK7nQGekYvqZJl68hBohA+7z4wvNr4TqrwqQVbFJF8Mrlg5mtr5z2D0XVvQ/UZuBhXQeJcIlQuwuh+JsX/ED/L9EPq4I= +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"; + + + + + + + + + + +Takes a list of datasources, finds and invalidates the associated cache records and removes the database records. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.ParamsDetails.json new file mode 100644 index 00000000000..6f651b11f2f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"query","name":"q","schema":{"properties":{"filters":{"items":{"properties":{"col":{"enum":["user_ids","permission_ids","name"],"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"order_column":{"default":"id","enum":["id","name"],"type":"string"},"order_direction":{"default":"asc","enum":["asc","desc"],"type":"string"},"page":{"default":0,"type":"integer"},"page_size":{"default":10,"type":"integer"}},"type":"object"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.StatusCodes.json new file mode 100644 index 00000000000..292bd6c40bf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"ids":{"items":{"type":"integer"},"type":"array"},"result":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"permission_ids":{"items":{"type":"integer"},"type":"array"},"user_ids":{"items":{"type":"integer"},"type":"array"}},"type":"object","title":"RoleResponseSchema"},"type":"array"}},"type":"object","title":"RolesResponseSchema"},"example":{"count":1,"ids":[1],"result":[]}}},"description":"Successfully retrieved roles"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"}},"type":"object"},"example":{"error":"string"}}},"description":"Bad request (invalid input)"},"403":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"}},"type":"object"},"example":{"error":"string"}}},"description":"Forbidden"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.api.mdx new file mode 100644 index 00000000000..81e64aaf5f5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/list-roles.api.mdx @@ -0,0 +1,68 @@ +--- +id: list-roles +title: "List roles" +description: "Fetch a paginated list of roles with user and permission IDs." +sidebar_label: "List roles" +hide_title: true +hide_table_of_contents: true +api: eJzNVt9v2zYQ/leIwx4STInjbQ+Bij6kWdIfK7ogdrEBVuDS0tliSpEqSTlxBf3vw5GSItvJsDQve5JIHT99393x7mrI0KZGlE5oBTFcoktzxlnJV0JxhxmTwjqml8xoiZbdCZezyqJhXGWsRFMIa4VW7P3v9hgiKLnhBTo0FuJZDYIwv1VoNhCB4gXSEiKwaY4Fh7iG0ugSjRNoabUUMpytQTgs7L5FqiU9UFUFxDMgKnORWfp1T6bd8P+7icBtSvqvdUaoFTQRrLmskFB2vjS9rV7cYurgYYMbwze01iZDM0+1rApFEBkueSUdxCAyiHpefvEkgQCSCYNp8PsQh9t0ABRWFKRHkUq+wq3jJ72RUA5XaDqruRXft03Hj9juu6C5icCgLbWyIQK/nJyEQCiHytErL0spUk5SRrc26HkqwqmuwqF9lhS1YeD3LXaDYdB6JU9mi8geBwqpuJcAe0n0PDp9Mj7n2J7HI3DCSdq41hKvW9dPgj+fe9zun8d7XpQSB8EYt76fjW8efDq7aQh8uzxMqjRFa5eVlBtm0BmBa8xCbSDs316UG2iMNv/xXg5UtMcezPdov+EZM/itQuvYgVBrLkXGhCordxhY//p/ZH2pzUJkGSqPZTGtjHAbX1dv70KEqCTwFYUOJu135sNOxeL+KNUZTvwfQzmWXK0ghvTz9UeIQPIFyoel1ZVJiW5aGcmO/mZvL6Ysgdy5Mh6NpE65zLV18enJ6emIl2K0Ho86UiOfASOL3KT5KAGWJIli7OgdS+Cscrk24rv3ZszeIDdo2E9n5+cXk8l8+ucfF58SgCbq6V1tXK7VgGC/0VMURamN62JqE5Workax1/328QrdAfFgP6ojCqdz5Bka+7reUZNAzBJoFSXAfmbc34+5019RNYk6TFRphHIHHbtjyqaDw8Oh3g98zSc+7gPNW5sPodHKkuxeKr/jwrEldW2v9CU66y2xcbdmuzEk1V+6MNZB8dQL/hJONPQg9a8SFRhn3PGe7Y4vWiMt8Vjq1QGZHr4CSu0CXa4ziGGFzs8WLocY/l0LeQvNuhtAKkPOfNQnsHvfPtJnluEapS4LVI4FJB+rAFSXRjudatnEo1FNUE1cUyo2e2jnlXW66CBo6DCCLyR2XcrDbHd+ojlo/e2SHv4+b+O/m06vWI/TREBstvF6vXvkJp4Vo2/UCpk27P2V73/a7IA86qr2vLdu/IjQRcP3mSDSF6kaFj5TLrUpOOF9+GvaDYCU0eEr9LXSi24iOjw3uDRo8x8FoZFCLXWQs93FSjQWh71ysEW5E+zW4+AS6wruW0A7wX6kkTj0vB3HDJrIi0fpVovDezcqJRfKjxjG50y4CjPgpSDGYxj0hwg6auFKQASUPSE9ZlDXC27xs5FNQ9thOKerkglL+ZlBvOTSYgRfcdOO6+3ADP5WdonsG1AEoVx4hHDgLE3RV63u1F4z3brbby8olLxy+aCH9gFtXwi9m3vUZoBd18Ei1B+6hYGEL8DQ0AzzDx62Z9Y= +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"; + + + + + + + + + + +Fetch a paginated list of roles with user and permission IDs. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/log-rest-api.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/log-rest-api.tag.mdx new file mode 100644 index 00000000000..b696bdb148d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/log-rest-api.tag.mdx @@ -0,0 +1,15 @@ +--- +id: log-rest-api +title: "LogRestApi" +description: "LogRestApi" +custom_edit_url: null +--- + +Access audit logs and activity history. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get a list of logs](./get-a-list-of-logs) | `/api/v1/log/` | +| `POST` | [Create log](./create-log) | `/api/v1/log/` | +| `GET` | [Get a log detail information](./get-a-log-detail-information) | `/api/v1/log/{pk}` | +| `GET` | [Get recent activity data for a user](./get-recent-activity-data-for-a-user) | `/api/v1/log/recent_activity/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/manually-stop-a-query-with-client-id.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/manually-stop-a-query-with-client-id.RequestSchema.json new file mode 100644 index 00000000000..433cf12ddaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/manually-stop-a-query-with-client-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"client_id":{"type":"string"}},"type":"object","title":"StopQuerySchema"},"example":{"client_id":"string"}}},"description":"Stop query schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/manually-stop-a-query-with-client-id.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/manually-stop-a-query-with-client-id.StatusCodes.json new file mode 100644 index 00000000000..627e8a5a87c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/manually-stop-a-query-with-client-id.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"},"example":{"result":"string"}}},"description":"Query stopped"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/manually-stop-a-query-with-client-id.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/manually-stop-a-query-with-client-id.api.mdx new file mode 100644 index 00000000000..1fba6601fee --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/manually-stop-a-query-with-client-id.api.mdx @@ -0,0 +1,68 @@ +--- +id: manually-stop-a-query-with-client-id +title: "Manually stop a query with client_id" +description: "Manually stop a query with client_id" +sidebar_label: "Manually stop a query with client_id" +hide_title: true +hide_table_of_contents: true +api: eJzFV21P3DgQ/ivW6KSCLrBwaiXkig+AqArXA9pddCdtVtSbDCSQ2K7tLOxF+e+nsZPsG63K9QOfNpnMjOd5/MzYW4PBbxVad6zSOfAaEiUdSkePQusiT4TLlRzcWyXJZpMMS0FP2iiNxuVofViRo3Q3eUovbq4ROFhncnkHTRN1FjW9x8RBBC53BRmGTunPFZr5MORtIsAnUWr6uJJ0kayJIEWbmFxTYW0O9o2SsLa6yIPKDabAnamwIYPVStpQ7B97e78A1aCtCvczOFfRdHE/gPI5oHBKa0wp/O0vVVqiteIOX15qHwjHImWtQjg7kzNR5CnTwogSHRrLtFGzPKViN9EsxQYs+6+L5VqKymXK5P9iytlR5TKUrl2f9Yp5BshyYEDy9nWRXCjHblUlU85GGXYkI9FtVWUSZKlCy6RyDJ9yon8TVJ+DVnn32jo7kw6NFAWzaGZoGBqjDGdHklUSnzQmhM4bmUqSynxnpz4IJ4rg5xe3mFQmd3Pg4xruHx3w8aSZRODEnQU+9g1HICYRPO0kKsWhr816/0LIO+CQXH/5BBEUYorF4jXwTO+VKdjOP+zqcjhiMWTOaT4YFCoRRaas4wd7BwcDofPBbH/gp9SA+jsGFsexZGznI4vhqJWXp5uzYxQGDfvt6OTkdDi8GV3+eXqxGnASNmpnNNfI2fpeLXxT9qaO4QHnMXAWw0wUFcbQvIEm6vFdzV2m5BLC3tBjzEutjOt0ZmMZy26gssPevKuVdVu0LnsJEVGIyFCkaOxhvUZHqLylJAb2OxNJgtbeOPWAsmmjCfbhc1BjuR1LbXLptrqSd8l5a3t7mYRzMRNDL6QlIlaMiw1X0hIXPX7xKHLHbtElmUf/Uux1gFCiy1RKtZOU1nnhnRtb1wvh/dpJpg7kjDw3X6NFyLJiAkObqgneHaVTlc45Ox9eXuyGds5v51s1e8D5Er+s2SZvovl9LAM1qXCip2WN9NZJFbhbqLstct1+D9SSq438l5CVKIpwGDLRnu+PucvY4lYQQeAMOJD0IAItXAYcNqmmDfSTJbR2ZWh/n90mWC/lE31mKc6wULpE6doZ5eUTEtXaKKcSVTR8MKgpVcNraplmI9tJZZ0quxQRzITJxbQIg7RLQ88p3opwX6AyIQKUVUkzq32lHz+4VvN/HI2uWJ+niYCqWc3X490obhiGL32TokSmDDu7oiSEZTXJs1S18d67aWhXuwHs73cBpB/DNUy9Yj8oUwrKd/73iPbIuwFvv0J/fHjQTUTBNwZvDdrs/yahLFbJL4t77+mPr5wR5PJWBfgraCuNxuLKfXZhIq0Fv9l+oNC6UvhzlLj9eY2vLNqfsA6f3EAXIpeU3MuwbuU/BqFzqmAfIvBJiRRqgkknhzHU9VRYvDZF05A5uPHxZKFIf1ZGEOaP75oHnJOClyaJF3BRUUEbFwZqjxBxlCToZ+j3fSdLvUzjDyKYtv9ISpVSjBGPdLEXj8ABIlCekHAhJ1uY5FW4TYSctNN0cVtirVdE+0Co2k9CzpcqrOvgEQYptXGA4g8daCZN0/wHmnWOXA== +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"; + + + + + + + + + + +Manually stop a query with client_id + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.StatusCodes.json new file mode 100644 index 00000000000..bde035b8224 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"},"example":{"result":{}}}},"description":"Chart added to favorites"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.api.mdx new file mode 100644 index 00000000000..ead02b1160e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-chart-as-favorite-for-the-current-user.api.mdx @@ -0,0 +1,68 @@ +--- +id: mark-the-chart-as-favorite-for-the-current-user +title: "Mark the chart as favorite for the current user" +description: "Mark the chart as favorite for the current user" +sidebar_label: "Mark the chart as favorite for the current user" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYR9sTImSoQMCFf2QBS3arGuC2sEGREFKS2dLsUSq5MmNJ/C/D0fK8ksyDEsH7JNE8u743HNv7KCRRtZIaCwktx2UChJoJBUQgZI18moJERj82pYGc0jItBiBzQqsJSQd0LphqVIRLtCAc3csbRutLFoW+OnkhD+ZVoSK+Fc2TVVmkkqt4gerFe9tDTZGN2ioDNoGbVvRzkV69oAZgXPR4U4E+CjrpsI9PedYNEebmbLhKyGBi0IaEjLPMRekxVyutCkJLdt4dXL6HXBrtFYucAevJVOqxT/iHRThRsmWCm3KPzFPxHlLBSrq7xdDHJ7xalcxePLq//XkkyYx163KEzEt0GNHS5gLg1a3JkORa7RCaRL4WFp6zqnBBt/y83el0n/g0QdFaJSshEWzQiPQGG0Sca5Eq/CxwYy985tCZ1lr/iZS7yTJKsj5yy1mrSlp7Uvw4RtBcnvHdURywWUZ8tXCXQSPR5nOceKhhYqtpFpAAtnN548QQSVnWG2XgWZet6YSR3+I66vJVKRQEDVJHFc6k1WhLSVnJ2dnsWzKeHUaZ3xbfBoPZRGnINI0VUIcvRcpnPdZ5llPxC8oDRrxw/nFxdvJ5H569evbTymAiwZs12sqtNpBN2wM+Mq60YY2KWJTlapNExFvhu3jRlsaMRDxEieioFmgzNHYN92BKykkIoXenRTEj0JmGVp7T3qJyvXanGWsusR1UFjJqsUUXKrGqWpMqWi0gX7MwqPxeJeMS7mSE58LO4TsbW6DppVlTgYe5DdZkpgjZYVn4aUcdMGVGqnQOfvAaXHIT7IRE4cxZ7+/bMLeBZKmnqMv0VblIlTp0XTdYGDqsFhTCNIbamc6XyficnL16ThUZjlfjzqxxPUOz8KNWZrpfp2qQFEuSQ70HJDfC+kKjyu9GLHo+DVwde3X5G/SLAUVKLIwHOwwFsRcm3DCBa1ItBYNRBDo4wmpLcfNj80E9tnvmqXbCQCH17eOULyt4eg/G0Q4BPiRj0WOK6x0UzOOYMknVzDUNUaTznTlkjju2JRLOi4s98TaRWtJ1xsTEaykKeWsCp1yY4b/c5xLP0k9TIgAVVtzU+qX/PGtad/+++n0Wgx2XASMZt/e4O8TcJPQXfmMHyFCG/Hhmo2wL/tGnqWq1/fSzr9INh12wrMhOOn7bAczn8fvtKkl27v8fQr984ZLMJzCMB+80y5i5XuDc4O2eKkRF0Gp5jq4s4e+bdBYZFqoJB5Bu1ucO0FudRoosVRLP/j6B9u/z+S9+4fpSPhIcVPJUvE9PsO6PslvQTYlgzmFCPw1EEHiX4rbx1QEnBYh7rfQdTNp8cZUzvH21xYNz7u7ber5ishLy/85JHNZWXyCbZj9MPrcv4XGYkvtPuZ+U6q1z/Cq5RVE3LvDw9bdcWb6fudvDwfnWYa+E29UnrwyOKWG8ufmCRHw42uHvSHo/Q+bfxZP1wWJ0EHdAM9PHUbo3F/htPv8 +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"; + + + + + + + + + + +Mark the chart as favorite for the current user + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.StatusCodes.json new file mode 100644 index 00000000000..dec39d31680 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"},"example":{"result":{}}}},"description":"Dashboard added to favorites"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.api.mdx new file mode 100644 index 00000000000..98480c437c3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/mark-the-dashboard-as-favorite-for-the-current-user.api.mdx @@ -0,0 +1,68 @@ +--- +id: mark-the-dashboard-as-favorite-for-the-current-user +title: "Mark the dashboard as favorite for the current user" +description: "Mark the dashboard as favorite for the current user" +sidebar_label: "Mark the dashboard as favorite for the current user" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYR9sTImSoQMCFf2QZS3arEuC2sEGREFKS2dLiUyq5MmNJ/C/D0dK8ksyDEgG7JMk6u743HOvLdTSyCUSGgvJTQulggRqSQVEoOQS+esBIjD4rSkN5pCQaTACmxW4lJC0QOuapUpFuEADzt2ytK21smhZ4KejI35kWhEq4ldZ11WZSSq1iu+tVny2MVgbXaOhMmgbtE1FWxfp2T1mBM5F+ycR4KNc1hXu6DnHojnazJQ1XwkJ/CptMdPS5ELmOeaCtJjLlTYloWU7b46OXwF5idbKBW5htmRKtfhXzIMiXCvZUKFN+RfmiThtqEBF3f1iiMUznm0rBk/e/L+eXGgSc92oPBHTAj12tIS5MGh1YzIUuUYrlCaBj6Wl55wabPAtP78qnf4Djz4pQqNkJSyaFRqBxmiTiFMlGoWPNWbsnT8UOssa8w+R+iBJVkHOX24xa0xJa1+G998JkptbriWSCy7NTc5auI3g8SDTOU48vFC5lVQLSCC7/vIZIqjkDKvNZ6CavxtTiYM/xdXlZCpSKIjqJI4rncmq0JaSk6OTk1jWZbw6jvP+xvg4HsojTkGkaaqEOPgoUjjtss2zn4hfUBo04ofTs7P3k8nd9PK39xcpgIsGfFdrKrTaQjgcDBjLZa0N9aliU5WqvqGId8PxYa0tjRiIeKkjUdAuUOZo7Lt2z50UEpFC51IK4kchswytvSP9gMp12pxxrPqA66CwklWDKbhUjVNVm1LRqId/yMKj8XibkHO5khOfF1uk7BxugqeVZV4GLuR3WZKYI2WFZ+I1PLTBnSVSoXP2g1Nkn6OkFxP7sWffv/bhbwNRU8/T12ijchaq9mC6rjGwtV+8KQTpnt6ZzteJOJ9cXhyGSi3n61ErHnC9xbVwY5Zmyt+mKtCUS5IDRXsB6IR0hYeVXoxYdPwWuNp2a/R3aR4EFSjyzcCww6gQc238X1/kikRj0UAEgUKenNpy/Pw4TeBpFNr6wW0FgkPtW0oo6MZwJjwbUNgH+pl/ixxXWOl6yViCJZ9owVBbG00605VL4rhlUy5pudDcE2tnjSW97E1EsJKmlLMqdNDeDL/nOJd+ynqYEAGqZsnNqvvkh29Xu/Y/TqdXYrDjImA0u/YGf5+Am4Suy/94QRHaiE9XbIR92TXyLFWdvpd2flvpO++EZ0Zw0vffFmY+nz9os5Rs7/yPKXSrD5dj+AvD3PBOu4iV7wzODdripUZcBKWa6+DODvqmRmORaaGSeDRtH3HuBLnVcaDE0lL6gdgtcy/L6B0Mw+QkfKS4rmSp+C6fZW2X7Dcg65IBHbN2fxVEkPhtcrNsRcDpEeJ/A207kxavTeUcH39r0PA8vN2koK+MvLT8nkMyl5XFJ/iG3QBGX7pdaSw2FO/i7g6lWvtMrxr+goj7eVh+3S1nqO9//vbw4zTL0HfnXuXJFsKpNbQCbqYQAS9nWwwOwe9e2PyzeNo2SISO6gZ4fhIxQuf+BhODClE= +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"; + + + + + + + + + + +Mark the dashboard as favorite for the current user + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/menu.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/menu.tag.mdx new file mode 100644 index 00000000000..8b87fac326c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/menu.tag.mdx @@ -0,0 +1,12 @@ +--- +id: menu +title: "Menu" +description: "Menu" +custom_edit_url: null +--- + +Get the Superset menu structure. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get menu](./get-menu) | `/api/v1/menu/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/open-api.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/open-api.tag.mdx new file mode 100644 index 00000000000..e89635adf8b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/open-api.tag.mdx @@ -0,0 +1,12 @@ +--- +id: open-api +title: "OpenApi" +description: "OpenApi" +custom_edit_url: null +--- + +Access the OpenAPI specification. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get api by version openapi](./get-api-by-version-openapi) | `/api/{version}/_openapi` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/queries.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/queries.tag.mdx new file mode 100644 index 00000000000..f10d90fa60f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/queries.tag.mdx @@ -0,0 +1,28 @@ +--- +id: queries +title: "Queries" +description: "Queries" +custom_edit_url: null +--- + +View and manage SQL Lab query history. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get a list of queries](./get-a-list-of-queries) | `/api/v1/query/` | +| `GET` | [Get query detail information](./get-query-detail-information) | `/api/v1/query/{pk}` | +| `GET` | [Get distinct values from field data (query-distinct-column-name)](./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)](./get-related-fields-data-query-related-column-name) | `/api/v1/query/related/{column_name}` | +| `POST` | [Manually stop a query with client_id](./manually-stop-a-query-with-client-id) | `/api/v1/query/stop` | +| `GET` | [Get a list of queries that changed after last_updated_ms](./get-a-list-of-queries-that-changed-after-last-updated-ms) | `/api/v1/query/updated_since` | +| `DELETE` | [Bulk delete saved queries](./bulk-delete-saved-queries) | `/api/v1/saved_query/` | +| `GET` | [Get a list of saved queries](./get-a-list-of-saved-queries) | `/api/v1/saved_query/` | +| `POST` | [Create a saved query](./create-a-saved-query) | `/api/v1/saved_query/` | +| `GET` | [Get metadata information about this API resource (saved-query--info)](./get-metadata-information-about-this-api-resource-saved-query-info) | `/api/v1/saved_query/_info` | +| `DELETE` | [Delete a saved query](./delete-a-saved-query) | `/api/v1/saved_query/{pk}` | +| `GET` | [Get a saved query](./get-a-saved-query) | `/api/v1/saved_query/{pk}` | +| `PUT` | [Update a saved query](./update-a-saved-query) | `/api/v1/saved_query/{pk}` | +| `GET` | [Get distinct values from field data (saved-query-distinct-column-name)](./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](./download-multiple-saved-queries-as-yaml-files) | `/api/v1/saved_query/export/` | +| `POST` | [Import saved queries with associated databases](./import-saved-queries-with-associated-databases) | `/api/v1/saved_query/import/` | +| `GET` | [Get related fields data (saved-query-related-column-name)](./get-related-fields-data-saved-query-related-column-name) | `/api/v1/saved_query/related/{column_name}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.ParamsDetails.json new file mode 100644 index 00000000000..995b1752157 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The database connection ID","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.StatusCodes.json new file mode 100644 index 00000000000..39a9f2bda6e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Task created to sync permissions."},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.api.mdx new file mode 100644 index 00000000000..75c1c832b15 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/re-sync-all-permissions-for-a-database-connection.api.mdx @@ -0,0 +1,68 @@ +--- +id: re-sync-all-permissions-for-a-database-connection +title: "Re-sync all permissions for a database connection" +description: "Re-sync all permissions for a database connection" +sidebar_label: "Re-sync all permissions for a database connection" +hide_title: true +hide_table_of_contents: true +api: eJzFV99P3DgQ/ldGo3sAXWDh1JNQqj5Q2qpwFSB20Z1EEDXJLGtIbNd2tmyj/O+nsZOwv+4e2geeNnFmxvN9/mY826ARVlTkyTpMbxosyOVWGi+1whQnM4JCeHEvHEGulaKcv8DpB0xQsoURfoYJKlERvz1hgpa+1dJSgam3NSXo8hlVAtMG/cKwlVSeHshi296ytTNaOXJs8MfBAf/kWnlSnh+FMaXMBe86enScVLMU0FhtyHoZvStyTjzQ0k7OW6kesG2TfkXfP1LusU2QnkVlSlpxfHFok3UqhHuC3JLwVIDX4BYqB0O2ks5Jrdw+x3zz2vm/FwUw/+R8CqdqLkpZwMsRg7F6LgsqtiFc8o1YDl8Xy7UStZ9pK39QkcJx7WekfLc/DCLbAmTZMSJ587pIzrWHqa5VkQJXVEcyMd1O1zYnKDQ5UNoDPUumfxPUEIN3+fO1dXaqPFklSnBk52SBrNU2hWMFtaJnQzmjC4ug87y2/3FSn4QXZbQLmzvKayv9IrSix+8e05tbbhJePHB7wg9dL8LbBJ/3cl3QOCQXe1cp1AOmmF9ffcEES3FP5ctrJJrfa1vC3j9weTGeQIYz7006GpU6F+VMO58eHRwdjYSRo/nhqO99o8MR1/vdUr2PMoQsyxTA3mfI8LhTXDiBFN6TsGTht+OTk4/j8d3k4q+P5xlimwxZXi78TKulPIeFIVNZGW19LxeXqUz13RLeDcv7Rju/w4nAr8FJYowZiYKse9esgcowhQw7YBnC7yDynJy78/qJVNt5s/bY9YkW0WEuypoybDO1myljpfI7PYh9Nt7Z3V2m5UzMxTgoZImalcWXg9TKMTsDI+K7kB6m5PNZ4OPX2WgiqIr8TBeMhkWzzlTam8G6DpiBr70UmkjXJLD1NXlxOYlVvDdZGIqcrRdzhtG6J/leF4sUzsYX5/uxcuV0sdPAEy2WGId2l62Z+LeZimQx5IGotWPojHRJ+6V+2GHT3bfI1bdas1e0F+4+UZbL9x9MtQWxbVrABCOBPCBox2cYpoYUN06iMU/t5mHwoYc2E8u8tqyJrUeL68l+4c9Q0JxKbSpSvmtYQXIxUGOs9jrXZZuORg2HatOGC6/diHZSO6+rPkSCc2GluC9jV+3D8HNBU1GXvksTEyRVV9zAulf+cbhB7efJ5BKGOG2CnM1qvAHvRnLj2In5G09joC2cXnIQxrIaZCtVnX+wbsNo1nfjMd8jEWToyQ3eB01/0rYSHO/s7wl2cx4XZvyKw10SQLcJO99Zmlpys58N0vLYOdURzkr2tSHriGnx0vN1tbzE2ol288NIifOVCJdkN7n+jKpXMhjuUk/PfmRKIRXvFDTWdIK/QWEkp3PI3v1dlmAa5uZ13WOCLJGogRtsGra+tmXb8vK3mizfk7cvMowDvHT8XGA6FaWjjSyHmQF3rroZahf+d87fiqtbFGoR6qCs+Q0T7vvxf0B7y/oNHTLkFT8c5zmFLt67bMwtLLyhXXC7xQR5nFtieJBG98Dht+bTNNEi9tx2SC/cWJxh2/4L4O96DQ== +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"; + + + + + + + + + + +Re-sync all permissions for a database connection + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.ParamsDetails.json new file mode 100644 index 00000000000..eb93b6e0897 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"Last ID received by the client","in":"query","name":"last_id","schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.StatusCodes.json new file mode 100644 index 00000000000..e131d7d10b8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"channel_id":{"type":"string"},"errors":{"items":{"type":"object"},"type":"array"},"id":{"type":"string"},"job_id":{"type":"string"},"result_url":{"type":"string"},"status":{"type":"string"},"user_id":{"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"example":{"result":[{"channel_id":"string","errors":[],"id":"string","job_id":"string","result_url":"string","status":"string","user_id":1}]}}},"description":"Async event results"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.api.mdx new file mode 100644 index 00000000000..9eb6c0c16ae --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/read-off-of-the-redis-events-stream.api.mdx @@ -0,0 +1,68 @@ +--- +id: read-off-of-the-redis-events-stream +title: "Read off of the Redis events stream" +description: "Reads off of the Redis events stream, using the user's JWT token and optional query params for last event received." +sidebar_label: "Read off of the Redis events stream" +hide_title: true +hide_table_of_contents: true +api: eJzFVmFv2zYQ/SvEYcASTImTYQMCFf3gZWmbLOiC2EEHRIFLS2eLKUWqJOXEE/TfhyMtWUqcFl0H7JMt8vj43vHxeDVkaFMjSie0ghiukWeW6cWC6QVzObJrzIRluELlLLPOIC8iVlmhln66smh+tOziw5Q5/QkV4ypj2qNxyT5XaNas5IYXli20YZJbF8CYwRTFCrNDiMBHoENjIb6tn1C6pDXnv3cL2Hztt06lQOUgAkFRfiuIQPECIQbaaCYyiMCmORYc4hrcuqQp64xQS2iauwgM2lIri5bmfz46op9UK0fAcQ28LKVIOREZ3VtiU/fwSqNLNE6E1QZtJf0q4bCwzwPSnCuFklg9JxMBGqONHazfxOj5PaaOYjYD3Bi+pu8XoO71/KVdAstZZeTOaeu4q+zOKTrpIapQDpdooNkye4nqrgh85EUpsZ+722GW2t23ybm9C6K3M63W7Uhf4na0VbYd6QQdN3cNMRzabmzXKu28SpCWWP9ydPwdJinQWr7EXW78coa6hXCjeOVybcTfmMVsXLkcldvszwx+roTBDHYI6i8k9F+/y+7/gZJz5dBQmbBoVmiYP+SYjRWrFD6WmDrMwiDTaVqZF3S94Y7LEOc3t5hWRri1t9P9A9nqju6640tyUDjYM1/QrtG6cSngLoLHg1RnOPE0QxWSXC0hhvTm+hIikHyOcvtpdWVSEpFWRrKDv9jbsylLIHeujEcjqVMuc21dfHJ0cjLipRitjkecNp55R40SYEmSKMYO3rEExpuD8amP2W/IDRr2w/j09GwymU3//OPsfQLQRB2pq7XLterR6gY6YqIotXHeEWidTVSi2mrHXnfDh0t0e8SDfRv7KKzJkWdo7Ov6iYYEYpbARkcC7CfG0xStnflHoknUfqJKI5TbazkdkuH29vf7Ki/4ik/8SfeUDga3x6CV9fe0FcgfuHBsgS7Nvb5vV1cPJMbtN3t6XqT1Y3tkddA59TI/hhUN/ZDmV4kKPDPueMfxSQY2QVriodTLPQrdfwVk4AJdrqnULdH5R9PlEMMuBZQZf6eCk0Mp3Kkfnt6mS5pmGa5Q6rKg4heQ/LkEoLo02ulUyyYejWqCauKazNY8QzutrNNFCxHBihvB5xLb59HD0P8MF9w/AZ4mVXxVFXRbN5/0Y+meDvHfTadXrMNpIiA2Q7xO7zNyk1B2aI66BqYNO78iENIyBNmZqs16H934dqItPRMqmkGkL0A1zL0/3mhTcMK7+DBtWxNyb5iFrnB60fSQP7iZwYVBm/9bEOoS1EIHOQP2VYnGeic54ag294fIOyFudRxSYl3B/Yuw6bCoU/xKo/g0Y73H5n9qNDepcfjoRqXkQvnOJjRD4T7dAi8FJeAYIujdKYiA7Bf8dQt1PecWb4xsGhoO3afvXYUlg2cQL7i0+IUMfLWv3Un2E64H7e2Ky4qifIVor5d/8iIIpcvTCsvGaYq+brarnr34gzrz9owMRl1D75nvbLb5Q+hts6fWPey6DhGhFlJtCCT88YHvuf4BD4xMxw== +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"; + + + + + + + + + + +Reads off of the Redis events stream, using the user's JWT token and optional query params for last event received. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.ParamsDetails.json new file mode 100644 index 00000000000..7b843360b67 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"query","name":"state","schema":{"type":"string"}},{"in":"query","name":"code","schema":{"type":"string"}},{"in":"query","name":"scope","schema":{"type":"string"}},{"in":"query","name":"error","schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.StatusCodes.json new file mode 100644 index 00000000000..189c0e10c53 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"text/html":{"schema":{"type":"string"}}},"description":"A dummy self-closing HTML page"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.api.mdx new file mode 100644 index 00000000000..82ec8e53dd5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/receive-personal-access-tokens-from-o-auth-2.api.mdx @@ -0,0 +1,68 @@ +--- +id: receive-personal-access-tokens-from-o-auth-2 +title: "Receive personal access tokens from OAuth2" +description: "-> Receive and store personal access tokens from OAuth for user-level authorization" +sidebar_label: "Receive personal access tokens from OAuth2" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/iuHwz4kmBwnQQcEKjrAzdKmXdoGtYsNiIKUkc6WUopUScqNJ+i/D0dKfouzdQGGfpJI3h3vuZeH12BGNjVF5QqtMMbBr/CRUirmBEJlYJ02BBUZq5WQINKUrAWnv5CyMDW6hA+j2uUw1QZqS2YgaU4SRO1ybYq/hLcaYSWMKMmRsRhfNVjwTV9rMguMUImSMEbrhCOM0KY5lQLjBt2iCgemUDNs22i3YqqzJ+nZVFdPUiRjtPlHxesIDdlKK0uWz48PD/mTauVIOa9B926Yu1Ly4nFDbbSVnhFkdVkuwJKcDlKpbaFmcD55dwGVmBG2ET57cJeoKlmkPhXDO8tm1q+sjK7IuCJ4WpK1bGhXNPodfXtHqeO76F6UlaQNRXwpMjD0tSbrYnij5kIWGawKACqj50VG2S54a7oBy7Mfi+W9djDVtcpimOTUu0bspNW1SQkyTRaUdkD3BTv9ENPSBt/yy4/OzhvlyHArWzJzMuCLOYaRglrRfUUpo/OboNO0NmZ3ol4JJ2SQ85dbSmtTuIVv77tvDuOra24DJ2bc8vibcOJWWMLrCO8H3LJj71zgAynUjDv508cLjFCKW5KrZQg0r2sjYfAnvD6bQIK5c1U8HEqdCplr6+KTw5OToaiK4fxomHXXDTUz0fEwQUiSRAEMziHB0To7xfCShCEDP41OT8/G45vJh9/P3ieI3P6dY5cLl3se611bbiydK8pKG9dXiE1UonoKgBfL7YMZuT32A/47gijo5SQyMvZFs4UjwRgS7LAkCD93ZH3jybpN1H6iKlMot9f7dcDltre/v470rZiLsc/zGtqNzVU6tLIMeAlSfBOFgym5NPcYn4aw2YAZ92vYzhvj/dynrglYJx7q56DR8odxP09U8JVvXPq5FYVOSEs6kHq2x6L7z5FLuCSX6wxjnJHzT5nLMcbHUHCEfGeFyq4NB3BnHHC7py74GDJ+QHVVknJdj/r8BENNZbTTqZZtPBw2bKqNGy689oG109o6XfYmIpwLU4hbGYikN8P/GU1FLV3nJkZIqi65Z7slfyz37ab988nkEpZ22gjZm017S7wPnBsH8uEzflRBG3hzyUYYy6aRnaHq9L1069/bnoDGTJ0BpKehBm99jbzSphRs7+0fk/7t5ioOp7ikTw+6jVj5xtDUkM2faqSNsFBTHeBseF/zQOWryRWOGXp9i2snyM2PQkisK4V/F7oBpB/Q/nUsO94O3NrL8z9Nel0E/HxTSVEohuCLt+la5wpFVTDOI/aufxciDA2EEXKthWK6wqbh009Gti1vh0mMGysrLFdzhvFUSEsRfqHF2hQ5F7JmP3zvPCLbDY7fI9rPit8j24+HK9nrVff5dzHCwG4eSFAapSl5eu21VgPiBge9PuPC40itDQHL8ut+2Gx3JNRizWjTBInAk8wZ4XafZWyv27b9G5UyHr0= +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"; + + + + + + + + + + +-> Receive and store personal access tokens from OAuth for user-level authorization + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.StatusCodes.json new file mode 100644 index 00000000000..e3987fc23f7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Dataset 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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.api.mdx new file mode 100644 index 00000000000..571a114938d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/refresh-and-update-columns-of-a-dataset.api.mdx @@ -0,0 +1,68 @@ +--- +id: refresh-and-update-columns-of-a-dataset +title: "Refresh and update columns of a dataset" +description: "Refresh and update columns of a dataset" +sidebar_label: "Refresh and update columns of a dataset" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYcASTImTrgMCFf2QZS3armiD2tkLoqClpXOkhiJZ8uTGE/TfhyMl+SUeMORLPlkk7473PPfCcwtWOlkjofOQXrdQaUjBSiohAS1r5NUdJODwW1M5LCAl12ACPi+xlpC2QCvLUpUmvEUHXXfD0t4a7dGzwLOTE/7JjSbUxJ/SWlXlkiqjJ1+90by3Nmidseioito1ei9vceMmT67St9B1ybBj5l8xJ+gSwHtZW4VbimuFLoECfe4qy1dDCr9Jkh5JFKiQkA08Pzl9WmevtGyoNK76B4tUnDdUoqb+fjFGYQ+WTcWI5OenRfLauHlVFKhT8bdpRGH0jyRKuURh0dWV94yIjJB5jt4LKisvHHrTuBz3ARztRXTPnxbdB0NiYRpdpGJWYogMesJihCAKg15oQwLvK0/7EI02AqJnz54686wzHAo5Vyg462iVij+kqoqYfeiccftwXJhGFQFqb6HX5qt+eerqf6sJnZZKeHRLdBFFKs61aDTeW8w5aGFTmDxv3H+U12tJUo0UJOAxbxxj5K759TtBen3DrY/kLXfSobV4uEng/ig3BU6Dc7HNKqlvIYX86tN7SEDJOar1si+BFPLGKXH0l7i8mokMSiKbTibK5FKVxlN6dnJ2NpG2mixPJ0W8bnI6cbhw6MsMRJZlWoijNyKD8741BNZT8StKh078cH5x8Wo6/Tz7+PurDxlAl4yeXa6oNHrDt3Fj9K6qrXE0ZL7PdKaHvi9ejtvHtqED9kM8AkISFUuUBTr/st0BkkEqMujBZCB+6nvJZzJ3qLtem3OMVe9wFRWWUjWYQZfpw0xbV2k6GBw/ZuGDw8NNKt7JpZyGTNigY2tzHTCjPTMysiC/y4rEAikvAwmPpKCNSGqk0hQM4fJqtstOOkiJ3Xgz6i9DyNtI0Sww9CVZq1zECj2arSxGnnYLNYMoPRA7N8UqFe+mHz8cx6qsFquDVtzhaoNl0R2yNJP9ItORIIY5krNDfS9kFB4rc3vAoocvgCtrux4/RYKE1IVobCEJRW5UU2svzEJI0VMJCUTWeJBpeBmGmxR2KW/tXTewziENzSIWa+M44nsDB7tuvedjUeASlbE1aurbTkioaKi1zpDJjerSyaRlU13acil1D6xdNJ5MPZhIYCldxd3Z950ymOHvAheyUdS7CQmgbmpuQ/2Sf0Ir2rb/Zja7FKOdLgH2ZtveiPeBc9PYT/mMJ0VhnHh7yUYYy7aRvVT1+kG6C2Pj0FOn/BpEkKGztjAP2fvauFqyvXd/zqCfQbns4imML0IA3SWs/HkI6SONdAlUemEinC3vG4suJhhVxI/O5hbnTpRbnkZKPNUyPHX9VP3/83fr3vEdJLyniVWyCuNQyKy2z+1rkLZiJ05Ze7ST9oN85ONmCPY1tO1cerxyqut4+1uDjp+1m3W+hTIoqjAZFJAupPL4wLHxiYeDT/2ceijWfG473G9KvQpprRpeQcJNOv7l6G44HUNrC7fHg/M8x9ByB5UHwwTn0Vjxl1ccYp6LN5gbA91/sPW97rRtlIi9shu9C68LO9h1/wJRLI3I +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"; + + + + + + + + + + +Refresh and update columns of a dataset + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.StatusCodes.json new file mode 100644 index 00000000000..ae188c143b1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"},"example":{"result":{}}}},"description":"Chart removed from favorites"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.api.mdx new file mode 100644 index 00000000000..09e545f4fe5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-chart-from-the-user-favorite-list.api.mdx @@ -0,0 +1,68 @@ +--- +id: remove-the-chart-from-the-user-favorite-list +title: "Remove the chart from the user favorite list" +description: "Remove the chart from the user favorite list" +sidebar_label: "Remove the chart from the user favorite list" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1P3EYQ/iurUT+AajBUqYQc5QOlREmKEsQdSiSMyGLPnRfsXWd3fIFa+9+r2fX5XqCqSir1k71vM88zL89uD620skFC6yC76kFpyKCVVEECWjbIo3tIwOK3TlksISPbYQKuqLCRkPVAjy3vUppwjha8v+bdrjXaoeMNvxwc8KcwmlAT/8q2rVUhSRmd3jmjeW5lsLWmRUsqnrbouprWHJnbOywIvE+2ZxLAB9m0NW6c8563lugKq1p2CRmcVNKSsNiYBZZiZk0jZnJhrCJ0bOfVweEPQG7QOTnHNcyOrNLzf8Q8HoRLLTuqjFV/YpmJ444q1DT4F2MunmG2fjAyefX/MvloSMxMp8tMTCsM2NERlsKiM50tUJQGndCGBD4oR8+RGm2wl19/qJz+A0bvNaHVshYO7QKtQGuNzcSxFp3GhxYLZhcmhSmKzv5Npt5KknXcF5w7LDqr6DG04d13guzqmnuJ5JxbM9asg+sEHvYKU+IkQItdW0s9hwyKy4szSKCWt1ivhjHMPO5sLfa+iN9Pz06npyKHiqjN0rQ2hawr4yg7Ojg6SmWr0sVhWrC/9DAdGyPNQeR5roXYeydyOB7qLMQ9E7+htGjFT8cnJ6eTyc300x+nH3MAn4zozh+pMnoN3zgxIlRNa0JjhiJxuc71UkrEm3F6v8QaCXcYingJjSSerFCWaN2bfotMDpnIYSCUg/hZyKJA527I3KP2ud7NdWuVpp0luH1Hkjp3w3nZXef8QS7kJCR9jffG5Co7RjumPtKV36UiMUMqqkD1pUT7yLZBqkzJzGL+t8OQLTeK7eRyPL4u89vHWExDKL7GE54/HJfXuWYapsb92sy3w7P7GrigN9vgIoiwoApFYBDVmIedQzvKsqhZGxKILCCDWAOQxMsqg80w9O29X4sExzk0a2yXznIano0mbOM742VR4gJr0zaoaWj7kOVoqG+tIVOY2mdp2rMpn/VcyP6JtZPOkWmWJhJYSKvkbR21aWmG/0ucyXB/BZiQAOquYRkYhvwJYrBp/910ei5GOz4BRrNpb+T7BNwk6hmv8dUvjBXvz9kIc9k08myohvNhtw/vgKWmTViNI8mgbD3chnJ6a2wj2d6Hz1MYHhXcC3EVRkUOpH3Ch28sziy66qVGfAJKz0yks4G+a9E65LCQIhb99SmunbhvcRhD4qiR4aoZnkn/spA3nI+XEeEDpW0tlWYnobz6ocKvQLaKkRxCAsEDJJCFx9nq7ZIA10RM+hX0/a10eGlr73n6W4eWr5frVd2FdiiV4/8SspmsHT7BNl61sHMxPD12xSqum5iHSakfQ3nXHY8ggXt8jG9Jf81lGTQneI8Lx0WBQQ+XR55c6lxPY/dHCYME+LWzFr8x58MPO3gWUd/HHVHH/AgwSDxj9P4vMXPQOw== +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"; + + + + + + + + + + +Remove the chart from the user favorite list + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.StatusCodes.json new file mode 100644 index 00000000000..e753aec7674 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"},"example":{"result":{}}}},"description":"Dashboard removed from favorites"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.api.mdx new file mode 100644 index 00000000000..f66b4ac3ef8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/remove-the-dashboard-from-the-user-favorite-list.api.mdx @@ -0,0 +1,68 @@ +--- +id: remove-the-dashboard-from-the-user-favorite-list +title: "Remove the dashboard from the user favorite list" +description: "Remove the dashboard from the user favorite list" +sidebar_label: "Remove the dashboard from the user favorite list" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1P3EYQ/iurUT+AajBUqYQc5QMlREmKEsQdaiWMyJ49dzbYu87u+HLU2v9eza7te4GqElTqJ9vj3ZnnmZdnt4NGGlkjobGQ3HRQKkigkVRABErWyF8PEIHB721pMIeETIsR2KzAWkLSAT02vKpUhAs04Nwtr7aNVhYtL/jl6IgfmVaEivhVNk1VZpJKreJ7qxXb1g4boxs0VIbdBm1b0UYgPbvHjMC5aNcSAa5k3VS4tc85XpqjzUzZcEhI4L20xUxLkwuDtV5iLuZG12Iul9qUhJZ9vTk6fgXsGq2VC9zAbcmUavGvuMeNcK1kS4U25V+YJ+K0pQIV9fHFWI9n2G1uDEze/L9MvmgSc92qPBHTAj12tIScfatbk6HINVqhNAlclZaeIzX64Ci/vqql/gNGnxShUbISFs0SjUBjtEnEqRKtwlWDGbPzRqGzrDX/UKkPkmQV1vngFrPWlPToR/H+B0Fyc8vzRHLB47nuWwu3EawOMp3jxMML01tJtYAEsuurC4igkjOs1p8h1fzdmkoc/Cnen1+cT89FCgVRk8RxpTNZFdpScnJ0chLLpoyXx3E+xIyP43FA4hREmqZKiIOPIoXTvt98/hPxG0qDRvx0enZ2PpncTb/+fv4lBXDRiPDykQqtNjCOhhFlWTfa0NAsNlWpGmRFvBvNhzlWSLjHUMRLqURhd4EyR2PfdTuEUkhECj2pFMTPQmYZWntH+gGVS9V+qhpTKtobAB5aktTaO67P/ibvz3IpJ74BNrhvGddV0soy/ZGy/CFLEnOkrPB0X0O2C4xrpELnzC70wm4qkmGh2C0y5+TbUOcu5GPq0/Et7HD84Ny8TRVT0RUeVnqxm6L9t8ANvj0WV16UBRUoRhZBodnUWjSjVIuK9SKCwAQSCP0AUTjEEniajq55cBsZ4Zz7IQ4j1BouybOZhV2cF/xb5LjESjc1KurlwFc8OOoao0lnunJJHHfsyiUdN7Z74u2staTrwUUES2lKOauCZg1u+D3HufRnm4cJEaBqa5aH/pMfXiC2/X+cTi/F6MdFwGi2/Y18n4CbBJ3jf3wtENqIT5fshLlsO3k2Vf1+v9r5O8KgdRNW6UDSK14HM99WH7SpJfv7/McU+gsHz0X4C6NSe9Iu4s13BucGbfFSJy6CUs11oLOFvm3QWOS0UEl8GGyauHfCuuVxSImlWvojqL9CvaChtwCMBxXhiuKmkqXiQL7Fur7Tb0A2JaM55t1DFIgg8Re49d0mAu6NUPwb6LqZtHhtKufY/L1Fw8fP7br//FjkpeX3HJK5rCw+wTcexbB31V9N9sU6v9u4e6NUj77Nq5a/IIIHfAz3TXfL7ek1yEcPP06zDL1GDlueHPrcV6MSBEmDCPg2tJHDsfb9Cwd4FlHXhRVB19wI0Ms+Y3Tub2ZC3oE= +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"; + + + + + + + + + + +Remove the dashboard from the user favorite list + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/report-schedules.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/report-schedules.tag.mdx new file mode 100644 index 00000000000..00b7c2917c2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/report-schedules.tag.mdx @@ -0,0 +1,22 @@ +--- +id: report-schedules +title: "Report Schedules" +description: "Report Schedules" +custom_edit_url: null +--- + +Configure scheduled reports and alerts. + +| Method | Endpoint | Path | +|--------|----------|------| +| `DELETE` | [Bulk delete report schedules](./bulk-delete-report-schedules) | `/api/v1/report/` | +| `GET` | [Get a list of report schedules](./get-a-list-of-report-schedules) | `/api/v1/report/` | +| `POST` | [Create a report schedule](./create-a-report-schedule) | `/api/v1/report/` | +| `GET` | [Get metadata information about this API resource (report--info)](./get-metadata-information-about-this-api-resource-report-info) | `/api/v1/report/_info` | +| `DELETE` | [Delete a report schedule](./delete-a-report-schedule) | `/api/v1/report/{pk}` | +| `GET` | [Get a report schedule](./get-a-report-schedule) | `/api/v1/report/{pk}` | +| `PUT` | [Update a report schedule](./update-a-report-schedule) | `/api/v1/report/{pk}` | +| `GET` | [Get a list of report schedule logs](./get-a-list-of-report-schedule-logs) | `/api/v1/report/{pk}/log/` | +| `GET` | [Get a report schedule log (report-pk-log-log-id)](./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)](./get-related-fields-data-report-related-column-name) | `/api/v1/report/related/{column_name}` | +| `GET` | [Get slack channels](./get-slack-channels) | `/api/v1/report/slack_channels/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist.RequestSchema.json new file mode 100644 index 00000000000..7dc7c8a93f2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"always_filter_main_dttm":{"default":false,"type":"boolean"},"catalog":{"description":"The catalog the table belongs to","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"database_id":{"description":"ID of database table belongs to","type":"integer"},"normalize_columns":{"default":false,"type":"boolean"},"schema":{"description":"The schema the table belongs to","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"table_name":{"description":"Name of table","type":"string"},"template_params":{"description":"Template params for the table","type":"string"}},"required":["database_id","table_name"],"type":"object","title":"GetOrCreateDatasetSchema"},"example":{"always_filter_main_dttm":true,"catalog":"string","database_id":1,"normalize_columns":true,"schema":"string","table_name":"string","template_params":"string"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist.StatusCodes.json new file mode 100644 index 00000000000..8504b3c8a5d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"table_id":{"type":"integer"}},"type":"object"}},"type":"object"},"example":{"result":{"table_id":1}}}},"description":"The ID of the table"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist.api.mdx new file mode 100644 index 00000000000..270d9a7f6b1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist.api.mdx @@ -0,0 +1,68 @@ +--- +id: retrieve-a-table-by-name-or-create-it-if-it-does-not-exist +title: "Retrieve a table by name, or create it if it does not exist" +description: "Retrieve a table by name, or create it if it does not exist" +sidebar_label: "Retrieve a table by name, or create it if it does not exist" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/ivEYUATTImTYAUKFfmQpu2armiC2tkGRIFLS2ebDUWqJOXEFfTfiyNlSX5pVzQY+sWxybvjPQ+fO51SgcHPJVr3QmdLiCtItXKoHH3lRSFFyp3QavDJakVrNp1jzulbYXSBxgm03lbe86UdT4V0aMY5F2qcOZfTVoZTXkoH8ZRLixG4ZYEQw0RriVxBHUHKHZd6FoxtakRBZ0IMozmyZpO5OTLHJxLZBKVWM8uchghy/vAO1czNIT55ehRBLtTq91EEqpSSfCB2puzOts4INaOjM+74hFsci2z7+IuXTE/ZymTX6U08oRzO0FBApU3OpfiC41TLMlf2xyjoeN1mIOz9TwT4iGPFc9w+/D3PkRjwNrDLGfNCcofjghue2x3pNwYsGLCpNh2O7Yh15OUoDGYQ36xdzlqmt62nnnzC1NGucIQS/kR3ac4NcocvueMW3TBQW0eADzwvJH5Xr4GmVpGr1DaUcrzzooPv6io71z7HvdVN8joa1nigqH7BFlrZUG4nR0ePKFaD1qtxcz3kGSphU9n1JuU7VtYY7g7pwh7XHtu2xEOldcqoI/jjURBztJbPsIekp7Hvpd06wguesaY5xuxCLbgUWdAxOjSWFUYvRIYZ7MDU8w1Yjn8tlmvFSzfXRnzBLGZnpZujcs35rJXaDiB9R4/k5ORXIymMTukndUJC4ZYx+5suJ6BBY7TZBeVclzJjSjvWRGi86ainv1psF8qhUVwyi2aBJqCI2ZlipcKHAlOHWVhkOk1L843rek19q6UgAotpaQhjfFPBp3sH8c1tTd2Tzyx12KZFWuqoDwepznDok7PeQXJFLTC9/vAOIpB8grL7aXVpUko9LY1kB/+yq8vhiCUwd66IBwOpUy7n2rr42dGzZwNeiMHieJCF8wYzdGNtxqnv04MEWJIkirGDNyyBs0ZwnvuYvUBu0LDfzs7PXw2H49HlX6/erzuch1s7GC0LjNnmxXW2GXtSJXCHywRilsCCyxITqJ9AHbVYr5ZurlUPbbvQ4hV5oY1blbdNVKJWvZmdtsuHhbZuj85lP0tKFLznyDM09rTaoCagaOhJgP3OeEqyHjt9h6puvImC012wE7WfqMII5fZW6R+S8d7+fp+Qt3zBh15hPVLWFjshaGWJl5YLfs+FY1N06dwz8RgeqgAnRzfXGeEguW1yFK/M2KaOCPvHlZSqQNTI8/Qx6lz6SgpsbaspWK/onehsGbO3w8v3h6HmxXS5V7E7XPa4ZvU+WRPlzxMVaCKwLUUbF9AYaYmHUs/2yHT/OVDdrlf7B3RG4AIZXw2GS0ZTRsS0YYE+JhwTU/rMNFrf/fBBWLq3QCXEQEqFCApOMyN8/zbovn2HCh2iNCSHnbcKm9m+o22W4QKlLnJUrul1Xm0hUFUY7XSqZR0PBhWFquOKqq3einZeWqfzVYgIFtwI4sA27dmHWZu9fZoQAaoyp97X/KQ/vv+tx38zGl2xNk4dAWWzHq/Fu5XcMDRx2lN+hjbs4oqCEJb1IDupavy9dV3Txa8auR9mA0jfziuYeFG/pmmU4r39ZwTNDOpfMfxuN2l70HVEzmODU4N2/rNBKIrV6kP3/vjqB+br5g3ovwbso50DduP8+Ak7AqGmevt9ZVgWaCz2Xyh6SyT7YLc4DrdpXc79aNAc/biKXMulnSUcPrhBIbnwL4q+UKqmWG+AF4ISO274C3mulSxEQOoO8r2BqiKOr42sa1r+XKKh6eC2qyA/I0QQWqqv8jtc+vmpa46+4GRJ6W0NSlTOweMsTdE/Ir5te9vrQ9TRIYJJ85+IXGfkY/g9RP4zBohAe3rCawythQdVGaaoEJOUSVNrj8NWwc0XQtVscbXsZVhVwSI8G6jtBCj+mQr1bV3XXwH4HvKT +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"; + + + + + + + + + + +Retrieve a table by name, or create it if it does not exist + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-a-list-of-available-advanced-data-types.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-a-list-of-available-advanced-data-types.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-a-list-of-available-advanced-data-types.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-a-list-of-available-advanced-data-types.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-a-list-of-available-advanced-data-types.StatusCodes.json new file mode 100644 index 00000000000..0c7ab7bfcd8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-a-list-of-available-advanced-data-types.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"result":["string"]}}},"description":"a successful return of the available advanced data types has taken place."},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-a-list-of-available-advanced-data-types.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-a-list-of-available-advanced-data-types.api.mdx new file mode 100644 index 00000000000..cddc63e57c7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-a-list-of-available-advanced-data-types.api.mdx @@ -0,0 +1,60 @@ +--- +id: return-a-list-of-available-advanced-data-types +title: "Return a list of available advanced data types" +description: "Return a list of available advanced data types" +sidebar_label: "Return a list of available advanced data types" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1P3EYQ/iujUaWCajhoUwk5yocrhbw0SlE41FYYkcWeOy/Yu87u+MLV8n+vZv3CHdBGgkr5ZHs88+w887oNOvKVNZ48xg3+uLcnj9QaJsPyqqqq0Klibc3k2lsjMp/mVCp5q5ytyLHurB35ughWmqkMIl5VhDF6dtossI0GgXJOrbC9E9ira0pZNOhWlVVB64DnA8BFKyYZ+dTpSnwSKPB1mpL387oAR1w7A3YOnBOopdKFuioIVLZUJqUMMsUK5EwPufLA6oYMVIVKaVcOf7G3/4wAlOS9WtAjxL9CdDTEM6Nqzq3Tf1MWw7TmnAz354Ojz7V2lOEjYVg37Jj89G2ZHFt3pbOMTAx/2Roya75nyNWSoCJXau+FEVtQIXnAufbgyNvapfQYwRGvY/fi27L7YBnmtjZZDLOcQmbIM2UjBcgseTCWgW6158cYjRhyys/Par3/gdFbw+SMKsCTW5IDcs66GKYGakO3FaXCLgjBpmnt/qUOjxWrotMLh3tKa6d5hfF5g9dfpJsv2osIWS28dPZ06MxfpTNn4upFhLc7qc3oNLjpg2mhzAJjTM8+vscIC3VFxd1nXzUxprUrYOdPeH00gwRz5iqeTAqbqiK3nuODvYODiar0ZLk/GUbCpYyES4nRJMyFBCFJEgOw8wYSnPZNFdIQwy+kHDn4bnp4eHR6ejn7/bejDwliG40Onqw4t2bNxVEwOqnLyjoeasYnJjHDFIZXo3h3QbwlfsDTmUSdfU4qI+dfNff4JBhDgj2nBOGHvhkv2d6QaROznZjKacNbg3+7Uohb29vrjN+ppToNFbDGekN4lx5rvBAfyaovSjPMidM8cH0e02aDbjx8w/08Cu9PQyqbjvMsUP7UWbTyEP4vE9P5HPbG4O+9aPRKtqDdwi62RHX7JUqRb7bGx245KSi0Z9lR/7mfMMKSOLcZxrggCWOlOMcYvxYMCXho4a5xaif5eDSseN/D9/IbMlpSYauSDPfDIKS7A2oqZ9mmtmjjyaQRqDZupJ7bB2iHtWdbDhARLpXTwtb38yvAyHtGcxUWfXATIyRTlzIc+k95eHwQzzez2QmMOG2E4s0m3sj3gXOn3ZSTf0aVBNbB2xMBES6bII+GqrcP2m0ryR4m3anM6I5kmHcNXoVSO7auVIL37o+Z5CioYdz/xXFOB9JtJMaXjuaOfP5UkDZCbea2o7PhfV2R86GqWLOsgnWR1E6nt9zvQuK5VGEBSayeUsobx49LiumWJ1WhdFjqocCavszPUVVafNnHCB+Wes80VEWX9nNsmivl6cwVbSvizzU5WTsXd5UXlk+E3YAI3XFDK4xxmqYUJtVSFXW4n97fvZLgsR1fH0ns5b61xmXMQP8i6MNt16zWsJum0+gmjrRN50QYutjKHfcfW+UElA== +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"; + + + + + + + + + + +Return a list of available advanced data types + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.ParamsDetails.json new file mode 100644 index 00000000000..3cc2fd1ba6c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"type":{"default":"port","type":"string"},"values":{"items":{"default":"http"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"advanced_data_type_convert_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.StatusCodes.json new file mode 100644 index 00000000000..d6bec92af2c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"display_value":{"description":"The string representation of the parsed values","type":"string"},"error_message":{"type":"string"},"valid_filter_operators":{"items":{"type":"string"},"type":"array"},"values":{"items":{"description":"parsed value (can be any value)","type":"string"},"type":"array"}},"type":"object","title":"AdvancedDataTypeSchema"},"example":{"display_value":"string","error_message":"string","valid_filter_operators":["string"],"values":["string"]}}},"description":"AdvancedDataTypeResponse object has been returned."},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.api.mdx new file mode 100644 index 00000000000..4139d8f498d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-an-advanced-data-type-response.api.mdx @@ -0,0 +1,68 @@ +--- +id: return-an-advanced-data-type-response +title: "Return an AdvancedDataTypeResponse" +description: "Returns an AdvancedDataTypeResponse object populated with the passed in args." +sidebar_label: "Return an AdvancedDataTypeResponse" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/isHYsASTI2brQMKFf2QdmmbruiK2sU2RIFLS2eLqUQq5MmJJ+i/D0dKsh3bK9AOyCfZ5PF4z3OvbESGLrWqImW0iMVHpNpqB1LDWbaUOsXsN0lysqrwI7rKaIdgZteYElSmqgtJmMGtohwoR6ikc5iB0iDtwp2ISFTSyhIJrRPxZSNSowk1ibgRsqoKlUq+d3Tt+PJGuDTHUvKvypoKLSl0/I9WFfI3w7msCxKxqIwlEXUbwpFVeiHaSCxlUYczirB024dyooqFSqUvwu7poEJaK1eibSNh8aZWFjMRX4bNQevVIB0oYAMUFf54R9Y0kySnLDVNjV6ipWkHqmXdijm+qdGuRCS0LPnojWiv+NbArjf558eP+fONbGXKVYVcTb3VgYFNF09yhEAYWKwsOtTkFYOZd1607MUO9B6S0VpjpyU6Jxe49s+2G1Q2nauC0E7ZNknGbrtl58y2Iw64chPIpp1wlEoNMwSpV2HleJ/lO84+5M/7wT/unBgJvJNlVeAeovt7dghabxzi5bIXuVrjXq/50NnG/rXkzKWDGaIG6xMasxO2/cl3xdVhh+8Quc3TmogXMgPOL3QUw4X2dMC6RkBlzVJlmIk9kDfOBiynD4vlk5Y15caqfzCL4aymHDV198NQRPYA2TwYkPzysEheGTtTWYY6hr9NDZnRP3IELREqtKVyjhGRAZmm6BxQrhxYdKa2Ke4DOOgL6J48LLr3hmBuap3FwKWvCyHMBgiQGXSgDQHeKQ6uXUSDDr7l14fOogtNaLUswKFdogVfbmI401BrvKswZXR+EUya1vZAHL6SJIsg5y93mNZW0cp36utbEvHlFbcmkgtfjvqaA1x0gKsOl6u7R6nJcOzNDE2+kHohYpF++vhORKKQMyzWf7uoiUVa2wIe/QWvzyeQ+NYcj0aFSWWRG0fx08dPn45kpUbL09Fucx11zTURkCSJBnj0BhJx1qWVd0QML1BatPDD2cuX5+PxdPLH7+fvEyHaaDDxw4pyozeMHBYGM1XJo0YfNS7Rie5bNTwflk8WSEdsB3wPlihoyFFmaN3z5h6iRMSQiA5VIuCnLiGnZL6gbhN9nOjKKk1HvYUnHIxHx8ebmN/KpRz7KNjAvbW4dpHRjqEPcOWtVARzpDT3aL8Xa7MFOO7/w31fMvLPvTubgHriQX8OJ1r+MAPPEh2s5isHi+/x0QmZAk8Kszhi0eNnfgorkXKTiVgskPz0SrmIxdfxMGs+F0MG1Lboxs0dbsT9LHzH25DhEgtTlaipy2rvs6Coqawhk5qijUejhlW1ccNh2e5oe1k7MmWvgocJq+SsCKWnV7NnKo4E6rrkLO/+8sdPvNv630wmH2DQ00aCrdnWN+DdMW4cyhXv8ewLxsLFB1bip/ktJXup6s576bZlf/Uly49nAaQvXI2Y+Wh5ZWwpWd/bPyfsIy8m4m53PSH2L4PrW5panFt0+bcq8VP+3OyOq+O6Qutwc8rcWOLYCXLL00CJo1L6TtK9E8LT7L9eZvcJ2+hR//vDrsNMeEejqpDK93ofrk2XNpdCVoqRnYpoz/tIRKJPnqs+jC5F08ykw0+2aFteDk8lTqmDwA7Z8gVX/nHVDdQs2V6tE8I3t0iE0uNvCAfO0hR9FexP7fT2rTrx+pxDgue5jYY+BEb3g7X3Lw+92tDdNEEi1DLO5mCEL+ii5cH/X8aDctI= +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"; + + + + + + + + + + +Returns an AdvancedDataTypeResponse object populated with the passed in args. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.ParamsDetails.json new file mode 100644 index 00000000000..b81014de5fc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The chart ID","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The format in which the data should be returned","in":"query","name":"format","schema":{"type":"string"}},{"description":"The type in which the data should be returned","in":"query","name":"type","schema":{"type":"string"}},{"description":"Should the queries be forced to load from the source","in":"query","name":"force","schema":{"type":"boolean"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.StatusCodes.json new file mode 100644 index 00000000000..6e59625e818 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A list of results for each corresponding query in the request.","items":{"properties":{"annotation_data":{"description":"All requested annotation data","items":{"additionalProperties":{"type":"string"},"type":"object"},"nullable":true,"type":"array"},"applied_filters":{"description":"A list with applied filters","items":{"type":"object"},"type":"array"},"cache_key":{"description":"Unique cache key for query object","nullable":true,"type":"string"},"cache_timeout":{"description":"Cache timeout in following order: custom timeout, datasource timeout, cache default timeout, config default cache timeout.","nullable":true,"type":"integer"},"cached_dttm":{"description":"Cache timestamp","nullable":true,"type":"string"},"colnames":{"description":"A list of column names","items":{"type":"string"},"type":"array"},"coltypes":{"description":"A list of generic data types of each column","items":{"type":"integer"},"type":"array"},"data":{"description":"A list with results","items":{"type":"object"},"type":"array"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"query":{"description":"The executed query statement","type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","query"],"type":"object","title":"ChartDataResponseResult"},"type":"array"}},"type":"object","title":"ChartDataResponseSchema"},"example":{"result":[]}}},"description":"Query result"},"202":{"content":{"application/json":{"schema":{"properties":{"channel_id":{"description":"Unique session async channel ID","type":"string"},"job_id":{"description":"Unique async job ID","type":"string"},"result_url":{"description":"Unique result URL for fetching async query data","type":"string"},"status":{"description":"Status value for async job","type":"string"},"user_id":{"description":"Requesting user ID","nullable":true,"type":"string"}},"type":"object","title":"ChartDataAsyncResponseSchema"},"example":{"channel_id":"string","job_id":"string","result_url":"string","status":"string","user_id":"string"}}},"description":"Async job details"},"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"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.api.mdx new file mode 100644 index 00000000000..72c18450bba --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-a-chart.api.mdx @@ -0,0 +1,68 @@ +--- +id: return-payload-data-response-for-a-chart +title: "Return payload data response for a chart" +description: "Takes a chart ID and uses the query context stored when the chart was saved to return payload data response." +sidebar_label: "Return payload data response for a chart" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isEsQ8J5tZNsQGFin3I0rRNV2xdnGAD4sCjqbPFhCJVkrLjGfrvw5HUi23ZS1Jg+2SLL3fPc3e8O3JNU7DciMIJrWhCr9g9WMIIz5hx5OIdYSolpQVLXAbkawlmRbhWDh4csU4bSMkyA+Vnw54ls8SyBaTEaWLAlUaRgq2kZilJmWPEgC20svCSDmjBDMvBgbE0uVlvY2lkXryjAypwrGAuowOqWA74dU8H1MDXUhhIaeJMCQNqeQY5o8maulWBq4RyMAdDq2rQp2KmTc4cEYosM8EzT8UDtZkuZUqmEGlAWqPwdmhhBAm0R7V1Rqj5Ps246Fv0eiVP0joKomtfCrCoZqYND/7yXpoZnfslVpeGw37SvFf7VGsJTNGqukXnBGdbXPD61Sv88fGjHP5lRSEFZ4hueGcR4rojsDC6AONE2G3AltLv2uR0SqSwjugZCSss8iHAeEa4NgFAKtQ8Rq8IwYpRA9ZhEAoHud3Vx5TSzkOboFt6FEtZi4GUtMu9F7tyWZoKnGDyy4aGLXcN6gE9vQPucECVUrKphDq24wJmDFvhvLcfpJOZkOEQ7THOUriMxMWkXtxBuKN4WxFnPIPJPax2VVwr8bUE4leQe1h58wdbR3l7ebTMg3wnctBlj4/PvPA4jS6caSn1Er2qTQomIby0DsM2LBl4H4T4bccCxBRmrJSuM6zVTMybcd7V9XI/+CatRPTpJHUuP4TdOpYXj7KGlnjK9vtTzwjXsswVCet2XbkTVK0rtcShg8LnoMAIHvKRX42j8Uyh3h6NHXtsq9xzfjqxGY/uk2ISjNFmV+y5H36ElTHP7fHZyGHZaXyG5PGDGKbm8KiQEHYSomJX+IWNGcg24YYZfjt9DmLG3dmPpQMegJeYdsJBs445yDGp9vA0gBZ8bJaoVz8rTRi95LpUfVk6x3GfpfXS4hGO/C10QHcMaB3j984wDr3uiXNEzNCYBnzfwRSBx3ofTVb22GLkx73H646HDiioMqfJDbVOF4V314wJ6f8U4MsLdiKlUuEf1rC0DPO25Bws2hFDKJ1ggrvtAeT0nmA8V+k3hGLV7ZBuOol8O+luprFuBNeReLtdoZCSQ9X0DPu0d8yxy1jwL0O13omRnSp3QMYodAJ41B9YXkjotgE3txUK2zTV7/40mEb361evv6Hj4BlTCuRE9BziWPUsWIsln9mV4iRuCP3qjoPv9PSQqCDiTk/3bA+sJqWRe0XEI3V9+dkX4Rk4nmGNDKJDqojNyVPPw4LJ0neKLc4+KaUF00vyMjRKiAbXBI7/ckgfEyuniOZgwHS9WItundGOdO3bjtZmaUcaii3OnTg8bXyZgmNCWsT0wze1vzlYy+bQ2+bvJuYO/2Yj/ZmldcOakAu1YFKkpL2CkcLohUgh7WPU2Ru4nPy/XK4VK12mjfgb0oScli4D5aJ+0iS8HiLdjSj9x//bKxfKgVFMEgtmASZUsIScKlIqeChCMfaDRHNemj283jPHZCx/OGuBl0a4lb9Y3y1DxsQMzuZ42Q4nyGJOf3jBdQojDy3cwyVTc5pQfn35mQ6oZFOQ7We8FSaUl0aSF3+SD+dXZEwz54pkOJSaM5lp65I3r968GbJCDBcnQ3+NH54MMfkMx5SMx2NFyIuPZExPoze8vRPyMzADhnx3enZ2PhpNrn775fzXMaV4lY2ovqxcplUHVzPQIBN5oY2r49WO1VjVF1HyUzP8cg7uCHGQJ8IfhE0ZsBSM/Wm9RWJMEzKmkciYku8J8x3AxOl7UNVYHY9VYYRyR81TCIbZ0fFxl+YntmAj798O1Y3B1hFaWUc6DNmSCRfSvyf4DHrrDY5J/U22PYZk/6qdtg5ErzzPv8KOCn+Q9NuxCkD9paIGuWWCuEhLeCn1/AiXHr+lGLc5uExj1p37htE/BCV0k8K6uK8CCzSPP04hoENS7zUC3T5In3GapLAAqQvsqePB9M4JgtaF0U5zLatkOFyjqCpZY8hVO9LOwr00ihjQBTMCS1794ODFhHLpr58RZqfljJ/444/rpvyPV1dfSCOnGlBEsymv4bsDbhQyDs7hPZJoQy6+oBDksimk11Rxv19d+feeOuv4ShxI+tyzplMfI+/DU1lCP/1xVT8e+VuPn207Ck8ae6almxiYGbDZc4XgZUzNdE9nUxZg4vUjthWdIYydsG5xEkxiXc58MYgvYJcHHjdDpxSeL7fN1ik2//V7azQMihsWkgl/zYwdZThRN5QVAumf4IUgwk/8Q2vsHDEGQ5Dd0PV6yixcG1lVOBwvrPiSKyxGeUqTGZMWDlngyU+wvST801T7EuvbVZqEwvE0ME95lT0AJT7OPhPIMx9qD5uGbwK6bbPRE312dBkbrGOy9UjfC6C+AapVV38NrLin1S0mLl9qPJIwcco5FF1n7jRmG3XhwzkmA2zuuo/RdUqIf1B6L5z1OqwItatq0PmajQCr6h/1vrwe +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"; + + + + + + + + + + +Takes a chart ID and uses the query context stored when the chart was saved to return payload data response. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.ParamsDetails.json new file mode 100644 index 00000000000..2778da0e092 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"cache_key","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.StatusCodes.json new file mode 100644 index 00000000000..f70b26d0894 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A list of results for each corresponding query in the request.","items":{"properties":{"annotation_data":{"description":"All requested annotation data","items":{"additionalProperties":{"type":"string"},"type":"object"},"nullable":true,"type":"array"},"applied_filters":{"description":"A list with applied filters","items":{"type":"object"},"type":"array"},"cache_key":{"description":"Unique cache key for query object","nullable":true,"type":"string"},"cache_timeout":{"description":"Cache timeout in following order: custom timeout, datasource timeout, cache default timeout, config default cache timeout.","nullable":true,"type":"integer"},"cached_dttm":{"description":"Cache timestamp","nullable":true,"type":"string"},"colnames":{"description":"A list of column names","items":{"type":"string"},"type":"array"},"coltypes":{"description":"A list of generic data types of each column","items":{"type":"integer"},"type":"array"},"data":{"description":"A list with results","items":{"type":"object"},"type":"array"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"query":{"description":"The executed query statement","type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","query"],"type":"object","title":"ChartDataResponseResult"},"type":"array"}},"type":"object","title":"ChartDataResponseSchema"},"example":{"result":[]}}},"description":"Query 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.api.mdx new file mode 100644 index 00000000000..8646d321f60 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data-cache-key.api.mdx @@ -0,0 +1,68 @@ +--- +id: return-payload-data-response-for-the-given-query-chart-data-cache-key +title: "Return payload data response for the given query (chart-data-cache-key)" +description: "Takes a query context cache key and returns payload data response for the given query." +sidebar_label: "Return payload data response for the given query (chart-data-cache-key)" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isHYh8SzInbogMKFf2QZunbiq5L3G1AHLiMdLbYUKRKUk48Qf99OJKSZVsOshZDP0niy909z73wqJplaFMjSie0Ygmb8Bu0wOFrhWYFqVYO7xykPM0RbnAFXGVg0FVGWSj5SmqeQcYdB4O21MoizLUBlyMsxBJVkHPMRqzkhhfo0FiWXNZMkLKSu5yNmOIFsoR5JbMbXLERM/i1EgYzljhT4YjZNMeCs6RmblXSYuuMUAvWNFe0OKi2NP/k0SN6eMuVo1dellKknACOv1hCWffklUaXaJwIuw3aSvpdm7ScgBTWgZ5DWGE9TORpDqk2wYBMqEXkTShPAaFA6wi+cFjYXX1cKe28aTNicUCxlK0YzGC93JPel8uzTNAElx83NGzxNWoH9PUXTB0NqEpKfi2x5Tou4MbwFc17/jCbzYUM7ttDzq1wOcTF0C7uWbijeFvROgB2VHxS4muFvTgk+gPXUd5eHGvkQb4TBepqwMenXnicJhfOtZT6lryqTYYmgbSyThftkpH3gdWVSXE9FkzMcM4r6XrDWs3FohtP+7qO9xsvlMMFms76bJY5V9xnu3W8KB/EhpaUePv9qeeQalkVCsK6XVfuBNXalVrS0L3CF6jQiDSUD7+aRmNOkd4BjT0+tlXuyZ9ebMbU/U8xicZosyv2zA8/gOW50cUen104btzaZwSePsBwtcAHhYSwsxAVu8Lf2liBbBduGetkXGstkSuS4ZNod/8kR8A7TCsqOyHRrOMOCyqqAzgNEoMPrRLt6m8qE0bfprpSQ1W6oHFfpfWtpRSO+C32jO4RaB1Pb5zhKQ66J86BmBOZBuGWW+AK8KHeJ8qqAS4u/Lj3eI6BXjZiqKqCJZfMOl2W3l1zLqR/KdEfL3QyVkqFNzrDsirM2ypN0RKPFELZjArc1YBBTu8JxjOVfUcoNv0T+3LjJN8suptlrB/BbSRebZ9QBMmRanaac+N+5Y6fxwP/PJzWOzGyc8rdI+MidAKU6ne8KCX224DLq4aEbVL1h88G0+l++l0dR4HW8gUOtTYDZ3XPxm4je8mztkdI4K1acikyWPdbUBq9FBlmbABMb2/A8vjHYvmkeOVybcQ/mCVwUrkclYv6oYuxASD9jQHJ0x+L5IN2MNeVyhKYrHtBJLpjz5BptKC0A7wTRP8uqE6GR/TkyY/2TWk0lRkqBUB+casE/qRwC/4JdXEAx6muZOahRglxN6n65Uenz1vl0CguwaJZogkoEjhRUCm8K8NB5QdBp2ll9gTgK+647CgYMYtpZQgjXXe+3IZqQtWNL+gKFCqRpXp3d5TqDC+8aeF2JLla0I3o0/l7NmKSX6Ncf4booe/KSDj6G16fTWDKcufKZDyWOuUy19Ylzx49ezbmpRgvH49TUjamFmlcd9W5mTKYTqcK4OgNTNlJzB9PfAIvkRs08NPJ6enZxcVs8vtvZx+mjDWjzryPK5dr1TOwG+hMFEWpjWuD307VVHUXxRfd8PEC3QHZAd+KYxR258gzNPZFvYVmyhKYsohoyuBn4P68nDl9g6qZqsOpKo1Q7qC17pgC7+DwsI/3HV/yC+/xHuaNwbVrtLIOelD5LRcO5ujS3CP9Hpz1Btik/YZtHxLqz60b64B44gF/DjsaehD651MVLPa9eGvtFhdxkZZ4LPXigJYePmcU0gW6XGcsYQvfZ/lrfcLux0Js+XwLEV8ZInOQE7adae9pGjJcotQlNaQxc72vgqC6NNrpVMsmGY9rEtUkNYVisyPtNFzqoogRW3IjqMC1t3UvJjRM/u4Wzez1a/GTHj6fN+W/mUw+QienGTGyZlNeh3fHuItQkmiOLmGgDbz9SEIIy6aQQarifr+68T9L2rLk+54A0henml37SHmlTcFJ3ru/JrHJ9H9nwuy6i/agmxFtnhmcG7T5twqhm4ya64E2uSrRxN499m+9IYqdsG75OFBiXcH9aRH/KJ37H1UP/08FBz5Wj2jhkQ/VoxtcHW6z2jus/r//ZZEhEjcuJRf+suaDu44Jdsl4KYiHx9RWk+Es3oJHLFm34FdtxF2yur7mFj8Z2TQ0HK9+l1froPe5mAl/wmcsmXNp8R70B+exIzuEfSa3nbla+dySFX2xEfO/eXo3heaKUsOXNG9EmD9JU/SVtd250xts1J/XZxRu1Aj2GoIu6OILSR+0qq7DilAjm85If0iQgU3zL5T8Yxs= +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"; + + + + + + + + + + +Takes a query context cache key and returns payload data response for the given query. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data.RequestSchema.json new file mode 100644 index 00000000000..c512e8a9c3a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"custom_cache_timeout":{"description":"Override the default cache timeout","nullable":true,"type":"integer"},"datasource":{"properties":{"id":{"description":"Datasource id/uuid","oneOf":[{"type":"integer"},{"type":"string"}]},"type":{"description":"Datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"}},"required":["id"],"type":"object","title":"ChartDataDatasource"},"force":{"description":"Should the queries be forced to load from the source. Default: `false`","nullable":true,"type":"boolean"},"form_data":{"nullable":true},"queries":{"items":{"properties":{"annotation_layers":{"description":"Annotation layers to apply to chart","items":{"properties":{"annotationType":{"description":"Type of annotation layer","enum":["FORMULA","INTERVAL","EVENT","TIME_SERIES"],"type":"string"},"color":{"description":"Layer color","nullable":true,"type":"string"},"descriptionColumns":{"description":"Columns to use as the description. If none are provided, all will be shown.","items":{"type":"string"},"type":"array"},"hideLine":{"description":"Should line be hidden. Only applies to line annotations","nullable":true,"type":"boolean"},"intervalEndColumn":{"description":"Column containing end of interval. Only applies to interval layers","nullable":true,"type":"string"},"name":{"description":"Name of layer","type":"string"},"opacity":{"description":"Opacity of layer","enum":["","opacityLow","opacityMedium","opacityHigh"],"nullable":true,"type":"string"},"overrides":{"additionalProperties":{"nullable":true},"description":"which properties should be overridable","nullable":true,"type":"object"},"show":{"description":"Should the layer be shown","type":"boolean"},"showLabel":{"description":"Should the label always be shown","nullable":true,"type":"boolean"},"showMarkers":{"description":"Should markers be shown. Only applies to line annotations.","type":"boolean"},"sourceType":{"description":"Type of source for annotation data","enum":["","line","NATIVE","table"],"type":"string"},"style":{"description":"Line style. Only applies to time-series annotations","enum":["dashed","dotted","solid","longDashed"],"type":"string"},"timeColumn":{"description":"Column with event date or interval start date","nullable":true,"type":"string"},"titleColumn":{"description":"Column with title","nullable":true,"type":"string"},"value":{"description":"For formula annotations, this contains the formula. For other types, this is the primary key of the source object."},"width":{"description":"Width of annotation line","minimum":0,"type":"number"}},"required":["name","show","showMarkers","value"],"type":"object","title":"AnnotationLayer"},"nullable":true,"type":"array"},"applied_time_extras":{"description":"A mapping of temporal extras that have been applied to the query","example":{"__time_range":"1 year ago : now"},"nullable":true,"type":"object"},"apply_fetch_values_predicate":{"description":"Add fetch values predicate (where clause) to query if defined in datasource","nullable":true,"type":"boolean"},"columns":{"description":"Columns which to select in the query.","items":{},"nullable":true,"type":"array"},"datasource":{"allOf":[{"properties":{"id":{"description":"Datasource id/uuid","oneOf":[{"type":"integer"},{"type":"string"}]},"type":{"description":"Datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"}},"required":["id"],"type":"object","title":"ChartDataDatasource"}],"nullable":true},"extras":{"allOf":[{"properties":{"having":{"description":"HAVING clause to be added to aggregate queries using AND operator.","type":"string"},"instant_time_comparison_range":{"description":"This is only set using the new time comparison controls that is made available in some plugins behind the experimental feature flag.","nullable":true,"type":"string"},"relative_end":{"description":"End time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"relative_start":{"description":"Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"time_grain_sqla":{"description":"To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z"],"example":"P1D","nullable":true,"type":"string"},"where":{"description":"WHERE clause to be added to queries using AND operator.","type":"string"}},"type":"object","title":"ChartDataExtras"}],"description":"Extra parameters to add to the query.","nullable":true},"filters":{"items":{"properties":{"col":{"description":"The column to filter by. Can be either a string (physical or saved expression) or an object (adhoc column)","example":"country"},"grain":{"description":"Optional time grain for temporal filters","example":"PT1M","type":"string"},"isExtra":{"description":"Indicates if the filter has been added by a filter component as opposed to being a part of the original query.","type":"boolean"},"op":{"description":"The comparison operator.","enum":["==","!=",">","<",">=","<=","LIKE","NOT LIKE","ILIKE","IS NULL","IS NOT NULL","IN","NOT IN","IS TRUE","IS FALSE","TEMPORAL_RANGE"],"example":"IN","type":"string"},"val":{"description":"The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.","example":["China","France","Japan"],"nullable":true}},"required":["col","op"],"type":"object","title":"ChartDataFilter"},"nullable":true,"type":"array"},"granularity":{"description":"Name of temporal column used for time filtering. ","nullable":true,"type":"string"},"granularity_sqla":{"deprecated":true,"description":"Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use `granularity` instead.","nullable":true,"type":"string"},"groupby":{"description":"Columns by which to group the query. This field is deprecated, use `columns` instead.","items":{},"nullable":true,"type":"array"},"having":{"deprecated":true,"description":"HAVING clause to be added to aggregate queries using AND operator. This field is deprecated and should be passed to `extras`.","nullable":true,"type":"string"},"is_rowcount":{"description":"Should the rowcount of the actual query be returned","nullable":true,"type":"boolean"},"is_timeseries":{"description":"Is the `query_object` a timeseries.","nullable":true,"type":"boolean"},"metrics":{"description":"Aggregate expressions. Metrics can be passed as both references to datasource metrics (strings), or ad-hoc metricswhich are defined only within the query object. See `ChartDataAdhocMetricSchema` for the structure of ad-hoc metrics.","items":{},"nullable":true,"type":"array"},"order_desc":{"description":"Reverse order. Default: `false`","nullable":true,"type":"boolean"},"orderby":{"description":"Expects a list of lists where the first element is the column name which to sort by, and the second element is a boolean.","example":[["my_col_1",false],["my_col_2",true]],"items":{},"nullable":true,"type":"array"},"post_processing":{"description":"Post processing operations to be applied to the result set. Operations are applied to the result set in sequential order.","items":{"allOf":[{"properties":{"operation":{"description":"Post processing operation type","enum":["aggregate","boxplot","compare","contribution","cum","diff","escape_separator","flatten","geodetic_parse","geohash_decode","geohash_encode","histogram","pivot","prophet","rank","rename","resample","rolling","select","sort","unescape_separator"],"example":"aggregate","type":"string"},"options":{"description":"Options specifying how to perform the operation. Please refer to the respective post processing operation option schemas. For example, `ChartDataPostProcessingOperationOptions` specifies the required options for the pivot operation.","example":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]},"type":"object"}},"required":["operation"],"type":"object","title":"ChartDataPostProcessingOperation"}],"nullable":true},"nullable":true,"type":"array"},"result_type":{"enum":["columns","full","query","results","samples","timegrains","post_processed","drill_detail"],"nullable":true},"row_limit":{"description":"Maximum row count (0=disabled). Default: `config[\"ROW_LIMIT\"]`","minimum":0,"nullable":true,"type":"integer"},"row_offset":{"description":"Number of rows to skip. Default: `0`","minimum":0,"nullable":true,"type":"integer"},"series_columns":{"description":"Columns to use when limiting series count. All columns must be present in the `columns` property. Requires `series_limit` and `series_limit_metric` to be set.","items":{},"nullable":true,"type":"array"},"series_limit":{"description":"Maximum number of series. Requires `series` and `series_limit_metric` to be set.","nullable":true,"type":"integer"},"series_limit_metric":{"description":"Metric used to limit timeseries queries by. Requires `series` and `series_limit` to be set.","nullable":true},"time_offsets":{"items":{"type":"string"},"nullable":true,"type":"array"},"time_range":{"description":"A time rage, either expressed as a colon separated string `since : until` or human readable freeform. Valid formats for `since` and `until` are: \n- ISO 8601\n- X days/years/hours/day/year/weeks\n- X days/years/hours/day/year/weeks ago\n- X days/years/hours/day/year/weeks from now\n\nAdditionally, the following freeform can be used:\n\n- Last day\n- Last week\n- Last month\n- Last quarter\n- Last year\n- No filter\n- Last X seconds/minutes/hours/days/weeks/months/years\n- Next X seconds/minutes/hours/days/weeks/months/years\n","example":"Last week","nullable":true,"type":"string"},"time_shift":{"description":"A human-readable date/time string. Please refer to [parsdatetime](https://github.com/bear/parsedatetime) documentation for details on valid values.","nullable":true,"type":"string"},"timeseries_limit":{"description":"Maximum row count for timeseries queries. This field is deprecated, use `series_limit` instead.Default: `0`","nullable":true,"type":"integer"},"timeseries_limit_metric":{"description":"Metric used to limit timeseries queries by. This field is deprecated, use `series_limit_metric` instead.","nullable":true},"url_params":{"additionalProperties":{"description":"The value of the query parameter","type":"string"},"description":"Optional query parameters passed to a dashboard or Explore view","nullable":true,"type":"object"},"where":{"deprecated":true,"description":"WHERE clause to be added to queries using AND operator.This field is deprecated and should be passed to `extras`.","nullable":true,"type":"string"}},"type":"object","title":"ChartDataQueryObject"},"type":"array"},"result_format":{"enum":["csv","json","xlsx"]},"result_type":{"enum":["columns","full","query","results","samples","timegrains","post_processed","drill_detail"]}},"type":"object","title":"ChartDataQueryContextSchema"},"example":{"custom_cache_timeout":1,"datasource":{"id":{},"type":"table"},"force":true,"form_data":{},"queries":[{}],"result_format":{},"result_type":{}}}},"description":"A query context consists of a datasource from which to fetch data and one or many query objects.","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data.StatusCodes.json new file mode 100644 index 00000000000..6e59625e818 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A list of results for each corresponding query in the request.","items":{"properties":{"annotation_data":{"description":"All requested annotation data","items":{"additionalProperties":{"type":"string"},"type":"object"},"nullable":true,"type":"array"},"applied_filters":{"description":"A list with applied filters","items":{"type":"object"},"type":"array"},"cache_key":{"description":"Unique cache key for query object","nullable":true,"type":"string"},"cache_timeout":{"description":"Cache timeout in following order: custom timeout, datasource timeout, cache default timeout, config default cache timeout.","nullable":true,"type":"integer"},"cached_dttm":{"description":"Cache timestamp","nullable":true,"type":"string"},"colnames":{"description":"A list of column names","items":{"type":"string"},"type":"array"},"coltypes":{"description":"A list of generic data types of each column","items":{"type":"integer"},"type":"array"},"data":{"description":"A list with results","items":{"type":"object"},"type":"array"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"query":{"description":"The executed query statement","type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","query"],"type":"object","title":"ChartDataResponseResult"},"type":"array"}},"type":"object","title":"ChartDataResponseSchema"},"example":{"result":[]}}},"description":"Query result"},"202":{"content":{"application/json":{"schema":{"properties":{"channel_id":{"description":"Unique session async channel ID","type":"string"},"job_id":{"description":"Unique async job ID","type":"string"},"result_url":{"description":"Unique result URL for fetching async query data","type":"string"},"status":{"description":"Status value for async job","type":"string"},"user_id":{"description":"Requesting user ID","nullable":true,"type":"string"}},"type":"object","title":"ChartDataAsyncResponseSchema"},"example":{"channel_id":"string","job_id":"string","result_url":"string","status":"string","user_id":"string"}}},"description":"Async job details"},"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"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data.api.mdx new file mode 100644 index 00000000000..5ca4450c2ee --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/return-payload-data-response-for-the-given-query-chart-data.api.mdx @@ -0,0 +1,68 @@ +--- +id: return-payload-data-response-for-the-given-query-chart-data +title: "Return payload data response for the given query (chart-data)" +description: "Takes a query context constructed in the client and returns payload data response for the given query." +sidebar_label: "Return payload data response for the given query (chart-data)" +hide_title: true +hide_table_of_contents: true +api: eJztXG1z4zaS/is43FWtXUtL9mSTS7Q7V6XMeHac9dheW5PkznbJEAmJiEmAA4CWdS7996tuACQkUbac7G3uw1VNWRIIgI1Go/vpF8wTzbhJtaisUJIO6Ijdc0MY+VJzvSCpkpY/Wvg0Vtep5RkRktick7QQXFrCZEY0t7WWhlRsUSiWkYxZRjQ3lZKGk6nSOGAmHrh08/ZoQjX/UnNjv1fZgg6eKL5JWvjKqqoQKQOC+r8YoOqJmjTnJYNvlVYV11Zwg8NqY1U5Tlma87EVJVc1zrG6qPMHrrXIONKR8SmrC0twDAljEirromCTgtOB1TVPqF1UnA6okJbPuKbLhMK6jKp1yjcJEdnma983/YnI+nUtMppQJfn5lA6unzZf0DQZq4Wc0eXtMpDxzNTYIaFc1iUdXFOLa/DEclgYspwm1LAHno3DrwfB5/Q2WX/l0u2M0DyD2UQW9VGTX3gKM1phgU/0Xc60BVJacoBPU+VZtErzVa7qIsM9ACIEN2SC4pHyjFhFUHamWpXYxU3XI+/ddg3I3ZQVht9t36mJUgVn0lNQjoEDQMVq96VjSNg2y0uzuZtMSmVRAscFW3BtNlczbLoQ1wWWAKK7gC8pcIYmL88/6txeaCVqStjaS6J9/nB++enz6ZAm9ORsdHz54/CUJvT4x+OzEU3o6OTT8fjq+PLk+KpjjxOaqkLpzdeewjuIe7iVze0s0eB3qqhL2cEm/wB4UhtOmPFnsOnTIydTIpXkhGlOKq0eRMazhLCiIHNRFCAjJldz2YvZuUGLb2BaswX8zkXGT4XcLoaFkBzmzkWWcdkj57JY4P6BXII0wvOW/2YnuYOzrB9YcSwzt/BtDEHNyoQUcka4zGCvw9hNUsITL2i7bI1kZcfSz1iJYhVkaWOYqlgq7KJDg7oH8eAgiLQZdqrm7Y9PPBN12f7+KGY5yOKLpCuvrN1ByTIBJLDiYuUAbZzpVXLnuUhz0p45kCDY9AknfnqvJbdQ4zXdMqEges+qMmRHI6S0SyrgySmb8OKFiSa8IKyYs4WJ53tZ6qDnJ6bvO/WUf0Ppnren6UWB73WvBdXy81rLGyYw/JECQ3W8IjbwRprQs+Ho5MdjeBsus0tfGbsoOl4IB5zgs83lgGE/MM7MrB7jQEHGTM7BJGfKWvxiVIE2ulBy9t497aIGpn7heM+FzQl/AISUMcuJ0u0pNpZp17zLSUZbu8vbnFHeYcYHVtQdzPygNGxZWRcsZlhCbC5M0FdOfftuPQJjlM25RhQS+grXq9KiZHpB7jnqjdaoE3e8ekDMXGQ23yTmJ2het4BOXEohRQk7eNisTdblBBDUGnhBJeiP8OopCUx4Btu09h2tIirVbs42NsdJX4Y4dMwfrWZduIGUrKpA7wNPeFkpzQriehObM0ty9gCWiUsvzgiOAmoC6MYfWVm58zB2L9NMzoCUI7LgTBM2U2RApJo/Q3Wr4hC0jKfcpvkY2WLGleYZQPAOMRlmGcG+xPUlTV+yN8+5Bs+A1YbvA9XOixBTAN1COuchQtG7KLf0JWThdL1VxPCCpzb4J42jETDDDhu4CvBZUXik/v9Qvxvqb5jzJQhnkPtt/MvZA7x/Y6Efhz+enP3Viw9s6IQTlmVO/tlspvkMpCz4DrWBQzQ8e09gcmaV7nVBGiGNZdK6c5KqsmJaGCXDkdmwYV6BKTAnhlv/GpAoyedoVUg7C6pFrQp/coUhJcs4YQ9MIFdAGI0qOamKegbac8JzIZ29548V16Lk0rKCTDmzteZkWrBZbxclrnnBrHjgYy47xPEY3gGkgg0OXV1LxgvLTOxXpUpOxez6hr4//jD8fDoaXx6fokkeX42Gl6MxOBM39PYuljyVMZAsUDFdFrKhDm1dByhBE/h7UojiMNNMyLH5UrAOQVBkDnta8AdegK6eaSbrgmmAwaaFbY0Kd4oKhTbIatYjV3VVKW0NuT65OifffnN4dLuXW1uZQb/PZW8u7kXFM8F6Ss/68Kt/cnU+hn7/+r7WzgTvkyx87UVLvBgdXdGEXoy+dh9fHbrPo0+u1X0cHfpP//ur8PsjfnyDH0fv8e9P+Beff4V/j/6TJvTou2++Ozh6c/Dm29Hh4QD//VffdW4efbfx6OLop/7Rd/9+eHB4dHD4Vft4/dGfoke3kW3zRL14ENDmdACIj8eXx1t0yas0yHIHnXjsdB7ow7VzCA9IxTQruQ0xgmzVoG8edwhgiMJ6OL8lhJCqDndiBIE5J4dWETcJmSx65B1DyeQCwRojbnVkr8oXRqSsAICKRgPUkubGCCX3CQJ4j9bIHstylfrp92MYQlNVS6vRhOKR6vIfnRfnTjh2coHBcHrCglckwInypko3yNfNt5xIh0QMQA4Eqo4DOTMeUKEITBaEhUegy5XESKYhqqqUcTIy4cAf3Dsb0KvSYiZgEc2+bcIVVW3blcZmxMIWzvLbtzSh/wJ//oMm9C/wCT/+An9OT/4G3tHZ+Yj4ryfh84qcfT499d/OR82vM98fv5xckdHlZ9//w/D0Cr6Ojj9dnF8OT8eXw7O/Hq+ePBzV5TZ0Lw1xIMiKB4QQ/sLVgiYEn8E28hcELyEeCiUk46koWZGQM4gBKU0KYSw0V1xmCJMdnlvhWiD1mr7LhQS38oNmEhHlD6xicjPQsI524Pjgbu2CeT6grOziAkRGYnv4Zd1k1CBzeBrQIOLLhJz1yC76L3pjZMkqzeEgZGHYbyIEm67+fhpBd9MjiJSmghcZ4J72lQkG+u4iuu4ICAFn2U7IZqZVXU062BcA/2TRYn7sHOnSl6jy3sQKRa9wEGLo+jyLfzuY3boUzLm0Aa2KGa+z7hz2vtuJzcKMtZqj5n42LBU6BSXIUlsHFQivd8kfDJ/sEB81iMNNE39f098ucHCHk4/debwjjLRjnlla9JqSWy3SLue7YXxr5kyPfHL9Seq0lOcoGA1lc6L5lGsuU6fa2jNA/GvInuOq2U/QYmYHYCf9QyepoAuDC4yeBURsYkc1hETIFefkrlE8QzC5jrorzIDdNek0l48DnwGiJCvvfKVQK51xPQZGbTLskj9wbUAvZ1z/ymQMju060MePFU8tZBtB52NsWRgLHj2EEZz91sYSXnBwk0JcySsriO5Ezr/SlkwWCR4O5A9PlczisYx4olZNyDUtF+NUFeMjmuCqbpOm6Q1NYFW3t69iaKWMHVdapSBgXZ7uhTKWtB38mQdZDJpiNfCjuYGMpeG2R87bvmhht/VE1xNyrNIKxHewgXEKZZt73hDzCrrXIxONgqMJnajHqlBgVz0qwG/SajGpcd6EppgoyMR0CnOYlFV8bDjAZouZqGnBrOXQc8ZVxq1IxxXThruGnJl8nPFUZXEDl74hF8aqmWbwiko8ICWw4hwjJprJe8xG+2Ch5sYJRkK1KgrYvoS6yBIGiDGrV8sNIlcAVLz8jhyLC0RvwciGmIqnYroABudqDjtbcQ0h1wgHYeLsouDMcKefIgGAQwXOdLV1txwJxCXVjQvjeuqTSPvAdl804xvB83TeeUIx3o5vdujKz24aTYVMj+hejWA2vHJCOePjEvSG83Aw6A2NiNWcYaQDWnrNAr2/HD3ft+I6hTNQuPaG91/o4LD35uvlMoYc140rA4IkM67p7YYDuA4l2wOzC5bcwtTuYNpLmsYd93EIHIbjF2KmCZ3WRRHFBV1/gxFC2ABDXSQEHTL4EasulxvRoijGGbdMFB2oGk7JfFyIUnSgiE/sESL1ACGIwxB7h28zYWB8tt8Z4Lk8/2l8evLpZOTDOXGw/+UCDaBFTacQC90E35gjACOj1Rz1rLkXVUzE4etf6EDJ+MUYtc9+z3MOaYxSWDiPPjmFnOmRYRFguCFlbSwCEc0NGi+HFFr06jX2okcunSAacudpwenv0AyuNI0dOLjzFgZsyetgQjzZ9r2WDZs9YNugcGfadmZ/PEcHZdjufBtMc5bCRoiyrUXp4GYHrc8SGQKLTghXwzebOfoXGB5ndjazSOiiaTbjSYjqeEjrkCvDMg6AAGiheBZCPndGyJSTAalBKd4BYs3rkkmiOcOsOJlqzsHc9MiPrBDoEJbMOn3uRnu2+BmY5gNyIw9IiHDC959JxhamD+ko089VrU0/Ywv83Z9zfm926gSZrN06Yt2QVPMbeSOHTdFAsUh8wrIo1BxdWb+4gPVBLAYw6ICcMgNp2UXzHWZufpRK2rz59aVm2nLd/AZK4MdZiLo1T372SNT0SyFryyP6jaO9j1P71eEkUHL36nErobOG/t1SzCUfm1xMO8710EnHQSMdkLfuo/C5CTZhyDVgM+gGvdpo90zYvJ70UlX2J7BviOBCt32SqbTGZAhCE5A1Z3QgFQORJZH5+NJO3m17vnc3TiHwsaoXXgwprCqHEFdYMysv67J1iv8h+uwVpDc6eGusZpnQWhdjjGY/W5yzNUQ4jRzeJijehZG3BI/XRpoo9sEIlHNMFNMZqLRj8Dk0JwRznzskwaM0wvOBnV+ZWPjfDObskqL4O7DuvFnuFiDpVP0KlDQPNKFYhpvQx8I8IiD+Z+PO3Zf4zlUsu2gJXa64Gt3FwkfreX/M77cvdFn2tqzVbUFcYRqXlF4/AZBfZ+cGy5bod6yr2s2ia4yHQIAnjjuhrWsiH64YA2uuQZZ8FL1kcrESWjKh6Nq5LQG9+yptPLdvDg9/Qym2W2CXBQnRHS8FqGg5S3OSKu0IwEC/LxaRjTfJzQpG3V6jGyp9115cFGEaPGfrlWhtJGSLHttWZNpqjV0rgqJ0XidzsIArhHLaVNg6dlRbz6+T6XveEWX7LMWXmvtyd6jFAvbHkrGLPX2hwP5dXEtPMLcXABcGngbEnb3QJYnFuWlzJIb6/LYZncPuuv3d/AQcko0za8vnaDeWldVO3FAFhIu276eaxlHKrq3cXrmcqgKL6Z6bfMYlBxCApx57Q6s/UxgJ2XxjjDU66p6el81Wge8uk1zrriLzY2zegcug5rbsWVs/gnuGyML5Q3L2TFlZxAJhnB3oKJ45MXEo1ffqCmw769YJePgjT2tQO+6gGcssxqG7wI7mwMFdtUTo/avUxPaMz7AMSR4MjwgZhZJpp+9tWXpvNeu86dE884l4zckcnFJJ+K67Dyyru+qZsX0FS0aBZ2NVVeF2TZko8IvPI4P1q6X0AV3Y09o9N3UKqMMjkmwMCq6zYkhtEcZQbPXrRHE9L90o8nWlu6rGYgkOkrhL+PHSG/xLZ603ZGQXoBXm6ARZAQZc33ZAHIRoXrJg3JvDN78BcaQ5k5IX466CTG/1jMvxEWYWMiV+ADl533UOf1GT56ZyU/yiJluGe4BX644yCT+FP1KfL0/RCCNywzITnNqpCg9OXnsenIeFJfeBzq5ZasN15yIvHVACaqCPW+M/wO8YAjXPCky8i2HqdjPalpi/bWtgS9vSLLGlcxNqN3vpgwxA059+E/wtuTHMhepeYtPq+puB9HuWBcA6ICfSBT1ib9dfjupaUTTWreXo913LZ8lqmyst/ptnAzKsbQ5JGPf+JlXUtZB4IMz+9e+9KydwbwOiD4brBwizggUbkKEkteSYwYaqOWgkKk1rvWVdHxjU+Trzt8TYdVq7MqHrJ/rL3GlM0OBsZlxhE9PWgE5/PIBM5pV3nKF7wSCrTNPPl1DtVbirReFncGRpWuuCHPxMLs6vRuSGQhxu0O8XKmVFrowdfHv47bd9Von+w1Ef7yv2QffcUHJzcyMJOfhIbujQ7wVye0C+50xzTf5t+O7d8dXVeHT+t+Oz1QHv3D4dwF2gAVnfqrZvRv7wdEPv+eKGDsiNu45xQ5d/wNp4v76Lhc0x7hBW2DQ0axRQwGSD5BsI5DYXj982zT0IL+zBe8lrGJG4ETlnGdfm7dMaOxzlniU3lPyRMEQSY6vuuVz60bDst11LvZH7N7LSQtq9QHIPOu/t78dM+IE9sCuUo4gRK43thsMtbRKtn82ZsM7M4Opfu/Ynt4SS21xlQDuI0jpfBqEbWZcXWO9dEJknx5wR8uYuaYfEEuM4tCk1rndg6URliwH54er8rOdOs5gu9p7At434S5b70BvY/Ocb6ViD7lJgyxrTfSdV8F6hZnvQdf/PmJV1y4dUsjJYPMDgxhLd5BpWCoCOcKfUWapOjtN17XAKj0kGteaqwoIVNxNKgpvoqdLKqlQVy0G//wRTLQdPIP3LjdneOWfbTwGlm1qAHQ9RFJzGYQD0qT2ZEY72PzF2TzfKmj+ORhekmQfq4oAzK/M1690g7sqpUXiGJTxKk5MLVzaj1ybpZJUfj72XS9igoEoRXrhFokJ9ohMUvg8+DEd/+GnkwX+Jrhw+bWESLhqA4NyONZ9qbvJfO8nSxUwv2//k4PilOORhVxyyvePWHYaM4o5dl9avN6+aRxfH/S3wFjp1Xei+Do9v40vV7u0d153bydwV5PZ3c7cYbwxHl3ybW7Zu0ui2bNvQXG/1TdEtVEqb+6Htlc74imZLwspdyrbZ30E8BFnacodvh3t2z1+jc3Q3hQLXAK1vd9zxloxQf9rS/sL1phg+xxeGmvsx6zd1mgcbF2T8hQyfKInjNCFsce1vJcRFNO46QCjlbyr3HTugWN5Vm2Nx+fZqbtiZldLqdl1t7Y5n6Uphq5fT1bJT19gUiYaBcR2kpy9ULu5aJLhR+Xe9Uk+3UhgW1SL936+BwqRGW+lzuFprc7hZCROYupqEPVyvj4i1y8oJixPYcX46PszrKd7DtQTlEm9VCjlVHW5zXUFha+yzRk1gw12/h6NQ0Vm6HfFq7RLLnnf/L2/IHuKEA8QV6zYtcm/+ef8BT9Ay/NH2qwKOqUvwIkZAiHNNWSWAG0dgLPz/aIJA5zaY/Gv69DRhhn/WxXIJzT4men3bog70bBLq4CIeCcxTrAC/5kb2YNO9AwjkRgzTlCPk3d43xmuAVrEA1f0XQyXUgw6oZnOs+5x7S9QeB2xzwLt2vp+bE44HOKWRF9lYff8luuTL5CKi8OnJ9XC4F6CaWwr6CHDtd7n8HxwLq18= +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"; + + + + + + + + + + +Takes a query context constructed in the client and returns payload data response for the given query. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/row-level-security.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/row-level-security.tag.mdx new file mode 100644 index 00000000000..8a8a34f8710 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/row-level-security.tag.mdx @@ -0,0 +1,19 @@ +--- +id: row-level-security +title: "Row Level Security" +description: "Row Level Security" +custom_edit_url: null +--- + +Manage row-level security rules for data access control. + +| Method | Endpoint | Path | +|--------|----------|------| +| `DELETE` | [Bulk delete RLS rules](./bulk-delete-rls-rules) | `/api/v1/rowlevelsecurity/` | +| `GET` | [Get a list of RLS](./get-a-list-of-rls) | `/api/v1/rowlevelsecurity/` | +| `POST` | [Create a new RLS rule](./create-a-new-rls-rule) | `/api/v1/rowlevelsecurity/` | +| `GET` | [Get metadata information about this API resource (rowlevelsecurity--info)](./get-metadata-information-about-this-api-resource-rowlevelsecurity-info) | `/api/v1/rowlevelsecurity/_info` | +| `DELETE` | [Delete an RLS](./delete-an-rls) | `/api/v1/rowlevelsecurity/{pk}` | +| `GET` | [Get an RLS](./get-an-rls) | `/api/v1/rowlevelsecurity/{pk}` | +| `PUT` | [Update an RLS rule](./update-an-rls-rule) | `/api/v1/rowlevelsecurity/{pk}` | +| `GET` | [Get related fields data (rowlevelsecurity-related-column-name)](./get-related-fields-data-rowlevelsecurity-related-column-name) | `/api/v1/rowlevelsecurity/related/{column_name}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanced-data-type-convert-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanced-data-type-convert-schema.Schema.json new file mode 100644 index 00000000000..8dc1c265b8a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanced-data-type-convert-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"type":{"default":"port","type":"string"},"values":{"items":{"default":"http"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"advanced_data_type_convert_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanced-data-type-convert-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanced-data-type-convert-schema.schema.mdx new file mode 100644 index 00000000000..5569717e5b8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanced-data-type-convert-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: advanced-data-type-convert-schema +title: "advanced_data_type_convert_schema" +description: "" +sidebar_label: "advanced_data_type_convert_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"type":"port","values":[null]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanceddatatypeschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanceddatatypeschema.Schema.json new file mode 100644 index 00000000000..9ec66cd7c77 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanceddatatypeschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"display_value":{"description":"The string representation of the parsed values","type":"string"},"error_message":{"type":"string"},"valid_filter_operators":{"items":{"type":"string"},"type":"array"},"values":{"items":{"description":"parsed value (can be any value)","type":"string"},"type":"array"}},"type":"object","title":"AdvancedDataTypeSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanceddatatypeschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanceddatatypeschema.schema.mdx new file mode 100644 index 00000000000..1c6a9445e58 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/advanceddatatypeschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: advanceddatatypeschema +title: "AdvancedDataTypeSchema" +description: "" +sidebar_label: "AdvancedDataTypeSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"display_value":"string","error_message":"string","valid_filter_operators":["string"],"values":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayer.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayer.Schema.json new file mode 100644 index 00000000000..fc8f6ef0ec8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayer.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"annotationType":{"description":"Type of annotation layer","enum":["FORMULA","INTERVAL","EVENT","TIME_SERIES"],"type":"string"},"color":{"description":"Layer color","nullable":true,"type":"string"},"descriptionColumns":{"description":"Columns to use as the description. If none are provided, all will be shown.","items":{"type":"string"},"type":"array"},"hideLine":{"description":"Should line be hidden. Only applies to line annotations","nullable":true,"type":"boolean"},"intervalEndColumn":{"description":"Column containing end of interval. Only applies to interval layers","nullable":true,"type":"string"},"name":{"description":"Name of layer","type":"string"},"opacity":{"description":"Opacity of layer","enum":["","opacityLow","opacityMedium","opacityHigh"],"nullable":true,"type":"string"},"overrides":{"additionalProperties":{"nullable":true},"description":"which properties should be overridable","nullable":true,"type":"object"},"show":{"description":"Should the layer be shown","type":"boolean"},"showLabel":{"description":"Should the label always be shown","nullable":true,"type":"boolean"},"showMarkers":{"description":"Should markers be shown. Only applies to line annotations.","type":"boolean"},"sourceType":{"description":"Type of source for annotation data","enum":["","line","NATIVE","table"],"type":"string"},"style":{"description":"Line style. Only applies to time-series annotations","enum":["dashed","dotted","solid","longDashed"],"type":"string"},"timeColumn":{"description":"Column with event date or interval start date","nullable":true,"type":"string"},"titleColumn":{"description":"Column with title","nullable":true,"type":"string"},"value":{"description":"For formula annotations, this contains the formula. For other types, this is the primary key of the source object."},"width":{"description":"Width of annotation line","minimum":0,"type":"number"}},"required":["name","show","showMarkers","value"],"type":"object","title":"AnnotationLayer"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayer.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayer.schema.mdx new file mode 100644 index 00000000000..134dbca960d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayer.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationlayer +title: "AnnotationLayer" +description: "" +sidebar_label: "AnnotationLayer" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"annotationType":"FORMULA","color":"string","descriptionColumns":["string"],"hideLine":true,"intervalEndColumn":"string","name":"string","opacity":"","overrides":{},"show":true,"showLabel":true,"showMarkers":true,"sourceType":"","style":"dashed","timeColumn":"string","titleColumn":"string","width":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..c1f5a8cc8c8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"AnnotationLayerRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..98c50faf0df --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationlayerrestapi-get-list-user-1 +title: "AnnotationLayerRestApi.get_list.User1" +description: "" +sidebar_label: "AnnotationLayerRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..74b526e37f8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"AnnotationLayerRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..c9d1bdc2ded --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationlayerrestapi-get-list-user +title: "AnnotationLayerRestApi.get_list.User" +description: "" +sidebar_label: "AnnotationLayerRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list.Schema.json new file mode 100644 index 00000000000..b1912c9b7eb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"AnnotationLayerRestApi.get_list.User1"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"AnnotationLayerRestApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"descr":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"AnnotationLayerRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..468ccddadac --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationlayerrestapi-get-list +title: "AnnotationLayerRestApi.get_list" +description: "" +sidebar_label: "AnnotationLayerRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_by":{"first_name":"string","last_name":"string"},"changed_on":"2024-07-29T15:51:28.071Z","created_by":{"first_name":"string","last_name":"string"},"created_on":"2024-07-29T15:51:28.071Z","descr":"string","id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get.Schema.json new file mode 100644 index 00000000000..467bd810ee2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"descr":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"AnnotationLayerRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get.schema.mdx new file mode 100644 index 00000000000..a52e636b14e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationlayerrestapi-get +title: "AnnotationLayerRestApi.get" +description: "" +sidebar_label: "AnnotationLayerRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"descr":"string","id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-post.Schema.json new file mode 100644 index 00000000000..2c6e8064ec2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"descr":{"description":"Give a description for this annotation layer","nullable":true,"type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"required":["name"],"type":"object","title":"AnnotationLayerRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-post.schema.mdx new file mode 100644 index 00000000000..146da742bee --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationlayerrestapi-post +title: "AnnotationLayerRestApi.post" +description: "" +sidebar_label: "AnnotationLayerRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"descr":"string","name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-put.Schema.json new file mode 100644 index 00000000000..deafa6293e2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"descr":{"description":"Give a description for this annotation layer","type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"type":"object","title":"AnnotationLayerRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-put.schema.mdx new file mode 100644 index 00000000000..dda051aa024 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationlayerrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationlayerrestapi-put +title: "AnnotationLayerRestApi.put" +description: "" +sidebar_label: "AnnotationLayerRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"descr":"string","name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-annotationlayer.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-annotationlayer.Schema.json new file mode 100644 index 00000000000..247ce30f9b9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-annotationlayer.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"AnnotationRestApi.get.AnnotationLayer"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-annotationlayer.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-annotationlayer.schema.mdx new file mode 100644 index 00000000000..70aa4941b37 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-annotationlayer.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationrestapi-get-annotationlayer +title: "AnnotationRestApi.get.AnnotationLayer" +description: "" +sidebar_label: "AnnotationRestApi.get.AnnotationLayer" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..bed0614ea63 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object","title":"AnnotationRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..ea419f20de9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationrestapi-get-list-user-1 +title: "AnnotationRestApi.get_list.User1" +description: "" +sidebar_label: "AnnotationRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..00317466960 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object","title":"AnnotationRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..5bf7145755a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationrestapi-get-list-user +title: "AnnotationRestApi.get_list.User" +description: "" +sidebar_label: "AnnotationRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list.Schema.json new file mode 100644 index 00000000000..3d702e80e8f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object","title":"AnnotationRestApi.get_list.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object","title":"AnnotationRestApi.get_list.User1"},"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"long_descr":{"nullable":true,"type":"string"},"short_descr":{"maxLength":500,"nullable":true,"type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"}},"type":"object","title":"AnnotationRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..6d2084b67a6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationrestapi-get-list +title: "AnnotationRestApi.get_list" +description: "" +sidebar_label: "AnnotationRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_by":{"first_name":"string","id":0},"created_by":{"first_name":"string","id":0},"end_dttm":"2024-07-29T15:51:28.071Z","id":0,"long_descr":"string","short_descr":"string","start_dttm":"2024-07-29T15:51:28.071Z"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get.Schema.json new file mode 100644 index 00000000000..6a2e79779ea --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"},"layer":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"AnnotationRestApi.get.AnnotationLayer"},"long_descr":{"nullable":true,"type":"string"},"short_descr":{"maxLength":500,"nullable":true,"type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"}},"required":["layer"],"type":"object","title":"AnnotationRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get.schema.mdx new file mode 100644 index 00000000000..1d984278236 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationrestapi-get +title: "AnnotationRestApi.get" +description: "" +sidebar_label: "AnnotationRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"end_dttm":"2024-07-29T15:51:28.071Z","id":0,"json_metadata":"string","layer":{"id":0,"name":"string"},"long_descr":"string","short_descr":"string","start_dttm":"2024-07-29T15:51:28.071Z"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-post.Schema.json new file mode 100644 index 00000000000..ae1f1f54647 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"required":["end_dttm","short_descr","start_dttm"],"type":"object","title":"AnnotationRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-post.schema.mdx new file mode 100644 index 00000000000..f182a8bc6a6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationrestapi-post +title: "AnnotationRestApi.post" +description: "" +sidebar_label: "AnnotationRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"end_dttm":"2024-07-29T15:51:28.071Z","json_metadata":"string","long_descr":"string","short_descr":"string","start_dttm":"2024-07-29T15:51:28.071Z"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-put.Schema.json new file mode 100644 index 00000000000..081b8d4d2a3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"type":"object","title":"AnnotationRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-put.schema.mdx new file mode 100644 index 00000000000..f027d1d1262 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/annotationrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: annotationrestapi-put +title: "AnnotationRestApi.put" +description: "" +sidebar_label: "AnnotationRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"end_dttm":"2024-07-29T15:51:28.071Z","json_metadata":"string","long_descr":"string","short_descr":"string","start_dttm":"2024-07-29T15:51:28.071Z"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/availabledomainsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/availabledomainsschema.Schema.json new file mode 100644 index 00000000000..4bcae782c2a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/availabledomainsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"domains":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"AvailableDomainsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/availabledomainsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/availabledomainsschema.schema.mdx new file mode 100644 index 00000000000..00d34bcf426 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/availabledomainsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: availabledomainsschema +title: "AvailableDomainsSchema" +description: "" +sidebar_label: "AvailableDomainsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"domains":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacheinvalidationrequestschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacheinvalidationrequestschema.Schema.json new file mode 100644 index 00000000000..6a4dbf17ee1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacheinvalidationrequestschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"datasource_uids":{"description":"The uid of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_uid` ","items":{"type":"string"},"type":"array"},"datasources":{"description":"A list of the data source and database names","items":{"properties":{"catalog":{"description":"Datasource catalog","nullable":true,"type":"string"},"database_name":{"description":"Datasource name","type":"string"},"datasource_name":{"description":"The datasource name.","type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"type":"string"},"schema":{"description":"Datasource schema","type":"string"}},"required":["datasource_type"],"type":"object","title":"Datasource"},"type":"array"}},"type":"object","title":"CacheInvalidationRequestSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacheinvalidationrequestschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacheinvalidationrequestschema.schema.mdx new file mode 100644 index 00000000000..f655f8e994e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacheinvalidationrequestschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: cacheinvalidationrequestschema +title: "CacheInvalidationRequestSchema" +description: "" +sidebar_label: "CacheInvalidationRequestSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"datasource_uids":["string"],"datasources":[{"catalog":"string","database_name":"string","datasource_name":"string","datasource_type":"table","schema":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get-list.Schema.json new file mode 100644 index 00000000000..c69d99efe8e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"CacheRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get-list.schema.mdx new file mode 100644 index 00000000000..07cfce250dc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: cacherestapi-get-list +title: "CacheRestApi.get_list" +description: "" +sidebar_label: "CacheRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get.Schema.json new file mode 100644 index 00000000000..ed1ff1d01f0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"CacheRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get.schema.mdx new file mode 100644 index 00000000000..cb9b84c2137 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: cacherestapi-get +title: "CacheRestApi.get" +description: "" +sidebar_label: "CacheRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-post.Schema.json new file mode 100644 index 00000000000..44892c6836f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"CacheRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-post.schema.mdx new file mode 100644 index 00000000000..3d0baf8140c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: cacherestapi-post +title: "CacheRestApi.post" +description: "" +sidebar_label: "CacheRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-put.Schema.json new file mode 100644 index 00000000000..96ae75090fe --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"CacheRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-put.schema.mdx new file mode 100644 index 00000000000..6b76a3037c6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/cacherestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: cacherestapi-put +title: "CacheRestApi.put" +description: "" +sidebar_label: "CacheRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/catalogsresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/catalogsresponseschema.Schema.json new file mode 100644 index 00000000000..ff0ff774550 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/catalogsresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"result":{"items":{"description":"A database catalog name","type":"string"},"type":"array"}},"type":"object","title":"CatalogsResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/catalogsresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/catalogsresponseschema.schema.mdx new file mode 100644 index 00000000000..ac591dde11c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/catalogsresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: catalogsresponseschema +title: "CatalogsResponseSchema" +description: "" +sidebar_label: "CatalogsResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"result":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachescreenshotresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachescreenshotresponseschema.Schema.json new file mode 100644 index 00000000000..67563b540a9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachescreenshotresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"cache_key":{"description":"The cache key","type":"string"},"chart_url":{"description":"The url to render the chart","type":"string"},"image_url":{"description":"The url to fetch the screenshot","type":"string"},"task_status":{"description":"The status of the async screenshot","type":"string"},"task_updated_at":{"description":"The timestamp of the last change in status","type":"string"}},"type":"object","title":"ChartCacheScreenshotResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachescreenshotresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachescreenshotresponseschema.schema.mdx new file mode 100644 index 00000000000..7cb434db2eb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachescreenshotresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartcachescreenshotresponseschema +title: "ChartCacheScreenshotResponseSchema" +description: "" +sidebar_label: "ChartCacheScreenshotResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_key":"string","chart_url":"string","image_url":"string","task_status":"string","task_updated_at":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmuprequestschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmuprequestschema.Schema.json new file mode 100644 index 00000000000..65c0f2bc8d4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmuprequestschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"chart_id":{"description":"The ID of the chart to warm up cache for","type":"integer"},"dashboard_id":{"description":"The ID of the dashboard to get filters for when warming cache","type":"integer"},"extra_filters":{"description":"Extra filters to apply when warming up cache","type":"string"}},"required":["chart_id"],"type":"object","title":"ChartCacheWarmUpRequestSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmuprequestschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmuprequestschema.schema.mdx new file mode 100644 index 00000000000..ad3254562b6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmuprequestschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartcachewarmuprequestschema +title: "ChartCacheWarmUpRequestSchema" +description: "" +sidebar_label: "ChartCacheWarmUpRequestSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"chart_id":0,"dashboard_id":0,"extra_filters":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponseschema.Schema.json new file mode 100644 index 00000000000..af91b0821e3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"result":{"description":"A list of each chart's warmup status and errors if any","items":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object","title":"ChartCacheWarmUpResponseSingle"},"type":"array"}},"type":"object","title":"ChartCacheWarmUpResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponseschema.schema.mdx new file mode 100644 index 00000000000..89de1881c03 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartcachewarmupresponseschema +title: "ChartCacheWarmUpResponseSchema" +description: "" +sidebar_label: "ChartCacheWarmUpResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"result":[{"chart_id":0,"viz_error":"string","viz_status":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponsesingle.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponsesingle.Schema.json new file mode 100644 index 00000000000..675c8d1dabb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponsesingle.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object","title":"ChartCacheWarmUpResponseSingle"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponsesingle.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponsesingle.schema.mdx new file mode 100644 index 00000000000..73c1bcaec21 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartcachewarmupresponsesingle.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartcachewarmupresponsesingle +title: "ChartCacheWarmUpResponseSingle" +description: "" +sidebar_label: "ChartCacheWarmUpResponseSingle" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"chart_id":0,"viz_error":"string","viz_status":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataadhocmetricschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataadhocmetricschema.Schema.json new file mode 100644 index 00000000000..98e5dc8e351 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataadhocmetricschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"aggregate":{"description":"Aggregation operator.Only required for simple expression types.","enum":["AVG","COUNT","COUNT_DISTINCT","MAX","MIN","SUM"],"type":"string"},"column":{"properties":{"column_name":{"description":"The name of the target column","example":"mycol","type":"string"},"type":{"description":"Type of target column","example":"BIGINT","type":"string"}},"type":"object","title":"ChartDataColumn"},"expressionType":{"description":"Simple or SQL metric","enum":["SIMPLE","SQL"],"example":"SQL","type":"string"},"hasCustomLabel":{"description":"When false, the label will be automatically generated based on the aggregate expression. When true, a custom label has to be specified.","example":true,"type":"boolean"},"isExtra":{"description":"Indicates if the filter has been added by a filter component as opposed to being a part of the original query.","type":"boolean"},"label":{"description":"Label for the metric. Is automatically generated unlesshasCustomLabel is true, in which case label must be defined.","example":"Weighted observations","type":"string"},"optionName":{"description":"Unique identifier. Can be any string value, as long as all metrics have a unique identifier. If undefined, a random namewill be generated.","example":"metric_aec60732-fac0-4b17-b736-93f1a5c93e30","type":"string"},"sqlExpression":{"description":"The metric as defined by a SQL aggregate expression. Only required for SQL expression type.","example":"SUM(weight * observations) / SUM(weight)","type":"string"},"timeGrain":{"description":"Optional time grain for temporal filters","example":"PT1M","type":"string"}},"required":["expressionType"],"type":"object","title":"ChartDataAdhocMetricSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataadhocmetricschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataadhocmetricschema.schema.mdx new file mode 100644 index 00000000000..24c69271db4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataadhocmetricschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdataadhocmetricschema +title: "ChartDataAdhocMetricSchema" +description: "" +sidebar_label: "ChartDataAdhocMetricSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"aggregate":"AVG","column":{"column_name":"mycol","type":"BIGINT"},"expressionType":"SQL","hasCustomLabel":true,"isExtra":true,"label":"Weighted observations","optionName":"metric_aec60732-fac0-4b17-b736-93f1a5c93e30","sqlExpression":"SUM(weight * observations) / SUM(weight)","timeGrain":"PT1M"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataaggregateoptionsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataaggregateoptionsschema.Schema.json new file mode 100644 index 00000000000..eeee0cb3b36 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataaggregateoptionsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"aggregates":{"description":"The keys are the name of the aggregate column to be created, and the values specify the details of how to apply the aggregation. If an operator requires additional options, these can be passed here to be unpacked in the operator call. The following numpy operators are supported: average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, min, percentile, prod, product, std, sum, var. Any options required by the operator can be passed to the `options` object.\n\nIn the example, a new column `first_quantile` is created based on values in the column `my_col` using the `percentile` operator with the `q=0.25` parameter.","example":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"type":"object"}},"type":"object","title":"ChartDataAggregateOptionsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataaggregateoptionsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataaggregateoptionsschema.schema.mdx new file mode 100644 index 00000000000..a7d47077209 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataaggregateoptionsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdataaggregateoptionsschema +title: "ChartDataAggregateOptionsSchema" +description: "" +sidebar_label: "ChartDataAggregateOptionsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"aggregates":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataasyncresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataasyncresponseschema.Schema.json new file mode 100644 index 00000000000..c2b40d350cb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataasyncresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"channel_id":{"description":"Unique session async channel ID","type":"string"},"job_id":{"description":"Unique async job ID","type":"string"},"result_url":{"description":"Unique result URL for fetching async query data","type":"string"},"status":{"description":"Status value for async job","type":"string"},"user_id":{"description":"Requesting user ID","nullable":true,"type":"string"}},"type":"object","title":"ChartDataAsyncResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataasyncresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataasyncresponseschema.schema.mdx new file mode 100644 index 00000000000..a4e889b072a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataasyncresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdataasyncresponseschema +title: "ChartDataAsyncResponseSchema" +description: "" +sidebar_label: "ChartDataAsyncResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"channel_id":"string","job_id":"string","result_url":"string","status":"string","user_id":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataboxplotoptionsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataboxplotoptionsschema.Schema.json new file mode 100644 index 00000000000..005a58b9a56 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataboxplotoptionsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"groupby":{"items":{"description":"Columns by which to group the query.","type":"string"},"nullable":true,"type":"array"},"metrics":{"description":"Aggregate expressions. Metrics can be passed as both references to datasource metrics (strings), or ad-hoc metricswhich are defined only within the query object. See `ChartDataAdhocMetricSchema` for the structure of ad-hoc metrics. When metrics is undefined or null, the query is executed without a groupby. However, when metrics is an array (length >= 0), a groupby clause is added to the query.","items":{},"nullable":true,"type":"array"},"percentiles":{"description":"Upper and lower percentiles for percentile whisker type.","example":[1,99]},"whisker_type":{"description":"Whisker type. Any numpy function will work.","enum":["tukey","min/max","percentile"],"example":"tukey","type":"string"}},"required":["whisker_type"],"type":"object","title":"ChartDataBoxplotOptionsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataboxplotoptionsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataboxplotoptionsschema.schema.mdx new file mode 100644 index 00000000000..68b843d2c3f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataboxplotoptionsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdataboxplotoptionsschema +title: "ChartDataBoxplotOptionsSchema" +description: "" +sidebar_label: "ChartDataBoxplotOptionsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"groupby":["string"],"metrics":[null],"percentiles":[1,99],"whisker_type":"tukey"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacolumn.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacolumn.Schema.json new file mode 100644 index 00000000000..b13fb436581 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacolumn.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"column_name":{"description":"The name of the target column","example":"mycol","type":"string"},"type":{"description":"Type of target column","example":"BIGINT","type":"string"}},"type":"object","title":"ChartDataColumn"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacolumn.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacolumn.schema.mdx new file mode 100644 index 00000000000..2192ce3ea99 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacolumn.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatacolumn +title: "ChartDataColumn" +description: "" +sidebar_label: "ChartDataColumn" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"column_name":"mycol","type":"BIGINT"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacontributionoptionsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacontributionoptionsschema.Schema.json new file mode 100644 index 00000000000..a5cb95b5064 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacontributionoptionsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"orientation":{"description":"Should cell values be calculated across the row or column.","enum":["row","column"],"example":"row","type":"string"}},"required":["orientation"],"type":"object","title":"ChartDataContributionOptionsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacontributionoptionsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacontributionoptionsschema.schema.mdx new file mode 100644 index 00000000000..7d75d891a3a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatacontributionoptionsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatacontributionoptionsschema +title: "ChartDataContributionOptionsSchema" +description: "" +sidebar_label: "ChartDataContributionOptionsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"orientation":"row"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatadatasource.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatadatasource.Schema.json new file mode 100644 index 00000000000..c3e26f03e17 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatadatasource.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"description":"Datasource id/uuid","oneOf":[{"type":"integer"},{"type":"string"}]},"type":{"description":"Datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"}},"required":["id"],"type":"object","title":"ChartDataDatasource"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatadatasource.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatadatasource.schema.mdx new file mode 100644 index 00000000000..c0f38abeda1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatadatasource.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatadatasource +title: "ChartDataDatasource" +description: "" +sidebar_label: "ChartDataDatasource" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"type":"table"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataextras.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataextras.Schema.json new file mode 100644 index 00000000000..0ff408cce3b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataextras.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"having":{"description":"HAVING clause to be added to aggregate queries using AND operator.","type":"string"},"instant_time_comparison_range":{"description":"This is only set using the new time comparison controls that is made available in some plugins behind the experimental feature flag.","nullable":true,"type":"string"},"relative_end":{"description":"End time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"relative_start":{"description":"Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"time_grain_sqla":{"description":"To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z"],"example":"P1D","nullable":true,"type":"string"},"where":{"description":"WHERE clause to be added to queries using AND operator.","type":"string"}},"type":"object","title":"ChartDataExtras"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataextras.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataextras.schema.mdx new file mode 100644 index 00000000000..0a56a289bab --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataextras.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdataextras +title: "ChartDataExtras" +description: "" +sidebar_label: "ChartDataExtras" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"having":"string","instant_time_comparison_range":"string","relative_end":"today","relative_start":"today","time_grain_sqla":"P1D","where":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatafilter.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatafilter.Schema.json new file mode 100644 index 00000000000..082415e250c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatafilter.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"col":{"description":"The column to filter by. Can be either a string (physical or saved expression) or an object (adhoc column)","example":"country"},"grain":{"description":"Optional time grain for temporal filters","example":"PT1M","type":"string"},"isExtra":{"description":"Indicates if the filter has been added by a filter component as opposed to being a part of the original query.","type":"boolean"},"op":{"description":"The comparison operator.","enum":["==","!=",">","<",">=","<=","LIKE","NOT LIKE","ILIKE","IS NULL","IS NOT NULL","IN","NOT IN","IS TRUE","IS FALSE","TEMPORAL_RANGE"],"example":"IN","type":"string"},"val":{"description":"The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.","example":["China","France","Japan"],"nullable":true}},"required":["col","op"],"type":"object","title":"ChartDataFilter"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatafilter.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatafilter.schema.mdx new file mode 100644 index 00000000000..757fd446807 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatafilter.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatafilter +title: "ChartDataFilter" +description: "" +sidebar_label: "ChartDataFilter" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"col":"country","grain":"PT1M","isExtra":true,"op":"IN","val":["China","France","Japan"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageodeticparseoptionsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageodeticparseoptionsschema.Schema.json new file mode 100644 index 00000000000..fa401eb5dad --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageodeticparseoptionsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"altitude":{"description":"Name of target column for decoded altitude. If omitted, altitude information in geodetic string is ignored.","type":"string"},"geodetic":{"description":"Name of source column containing geodetic point strings","type":"string"},"latitude":{"description":"Name of target column for decoded latitude","type":"string"},"longitude":{"description":"Name of target column for decoded longitude","type":"string"}},"required":["geodetic","latitude","longitude"],"type":"object","title":"ChartDataGeodeticParseOptionsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageodeticparseoptionsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageodeticparseoptionsschema.schema.mdx new file mode 100644 index 00000000000..7d42da33068 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageodeticparseoptionsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatageodeticparseoptionsschema +title: "ChartDataGeodeticParseOptionsSchema" +description: "" +sidebar_label: "ChartDataGeodeticParseOptionsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"altitude":"string","geodetic":"string","latitude":"string","longitude":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashdecodeoptionsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashdecodeoptionsschema.Schema.json new file mode 100644 index 00000000000..5972efd0e47 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashdecodeoptionsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"geohash":{"description":"Name of source column containing geohash string","type":"string"},"latitude":{"description":"Name of target column for decoded latitude","type":"string"},"longitude":{"description":"Name of target column for decoded longitude","type":"string"}},"required":["geohash","latitude","longitude"],"type":"object","title":"ChartDataGeohashDecodeOptionsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashdecodeoptionsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashdecodeoptionsschema.schema.mdx new file mode 100644 index 00000000000..d40cce5f08a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashdecodeoptionsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatageohashdecodeoptionsschema +title: "ChartDataGeohashDecodeOptionsSchema" +description: "" +sidebar_label: "ChartDataGeohashDecodeOptionsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"geohash":"string","latitude":"string","longitude":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashencodeoptionsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashencodeoptionsschema.Schema.json new file mode 100644 index 00000000000..ee3f2704d03 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashencodeoptionsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"geohash":{"description":"Name of target column for encoded geohash string","type":"string"},"latitude":{"description":"Name of source latitude column","type":"string"},"longitude":{"description":"Name of source longitude column","type":"string"}},"required":["geohash","latitude","longitude"],"type":"object","title":"ChartDataGeohashEncodeOptionsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashencodeoptionsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashencodeoptionsschema.schema.mdx new file mode 100644 index 00000000000..c5550493c38 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatageohashencodeoptionsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatageohashencodeoptionsschema +title: "ChartDataGeohashEncodeOptionsSchema" +description: "" +sidebar_label: "ChartDataGeohashEncodeOptionsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"geohash":"string","latitude":"string","longitude":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapivotoptionsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapivotoptionsschema.Schema.json new file mode 100644 index 00000000000..44fa31c6b77 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapivotoptionsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"aggregates":{"description":"The keys are the name of the aggregate column to be created, and the values specify the details of how to apply the aggregation. If an operator requires additional options, these can be passed here to be unpacked in the operator call. The following numpy operators are supported: average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, min, percentile, prod, product, std, sum, var. Any options required by the operator can be passed to the `options` object.\n\nIn the example, a new column `first_quantile` is created based on values in the column `my_col` using the `percentile` operator with the `q=0.25` parameter.","example":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"type":"object"},"column_fill_value":{"description":"Value to replace missing pivot columns names with.","type":"string"},"columns":{"description":"Columns to group by on the table columns","items":{"type":"string"},"type":"array"},"drop_missing_columns":{"description":"Do not include columns whose entries are all missing (default: `true`).","type":"boolean"},"marginal_distribution_name":{"description":"Name of marginal distribution row/column. (default: `All`)","type":"string"},"marginal_distributions":{"description":"Add totals for row/column. (default: `false`)","type":"boolean"},"metric_fill_value":{"description":"Value to replace missing values with in aggregate calculations.","type":"number"}},"type":"object","title":"ChartDataPivotOptionsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapivotoptionsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapivotoptionsschema.schema.mdx new file mode 100644 index 00000000000..feab3d0c824 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapivotoptionsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatapivotoptionsschema +title: "ChartDataPivotOptionsSchema" +description: "" +sidebar_label: "ChartDataPivotOptionsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"aggregates":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"column_fill_value":"string","columns":["string"],"drop_missing_columns":true,"marginal_distribution_name":"string","marginal_distributions":true,"metric_fill_value":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapostprocessingoperation.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapostprocessingoperation.Schema.json new file mode 100644 index 00000000000..8dcc9cede66 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapostprocessingoperation.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"operation":{"description":"Post processing operation type","enum":["aggregate","boxplot","compare","contribution","cum","diff","escape_separator","flatten","geodetic_parse","geohash_decode","geohash_encode","histogram","pivot","prophet","rank","rename","resample","rolling","select","sort","unescape_separator"],"example":"aggregate","type":"string"},"options":{"description":"Options specifying how to perform the operation. Please refer to the respective post processing operation option schemas. For example, `ChartDataPostProcessingOperationOptions` specifies the required options for the pivot operation.","example":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]},"type":"object"}},"required":["operation"],"type":"object","title":"ChartDataPostProcessingOperation"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapostprocessingoperation.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapostprocessingoperation.schema.mdx new file mode 100644 index 00000000000..abc3ac1032a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatapostprocessingoperation.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatapostprocessingoperation +title: "ChartDataPostProcessingOperation" +description: "" +sidebar_label: "ChartDataPostProcessingOperation" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"operation":"aggregate","options":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataprophetoptionsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataprophetoptionsschema.Schema.json new file mode 100644 index 00000000000..7ff7e844f7b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataprophetoptionsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"confidence_interval":{"description":"Width of predicted confidence interval","example":0.8,"maximum":1,"minimum":0,"type":"number"},"monthly_seasonality":{"description":"Should monthly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false},"periods":{"description":"Time periods (in units of `time_grain`) to predict into the future","example":7,"type":"integer"},"time_grain":{"description":"Time grain used to specify time period increments in prediction. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z"],"example":"P1D","type":"string"},"weekly_seasonality":{"description":"Should weekly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false},"yearly_seasonality":{"description":"Should yearly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false}},"required":["confidence_interval","periods","time_grain"],"type":"object","title":"ChartDataProphetOptionsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataprophetoptionsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataprophetoptionsschema.schema.mdx new file mode 100644 index 00000000000..20375059c33 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataprophetoptionsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdataprophetoptionsschema +title: "ChartDataProphetOptionsSchema" +description: "" +sidebar_label: "ChartDataProphetOptionsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"confidence_interval":0.8,"monthly_seasonality":false,"periods":7,"time_grain":"P1D","weekly_seasonality":false,"yearly_seasonality":false} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataquerycontextschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataquerycontextschema.Schema.json new file mode 100644 index 00000000000..3e6a10b8b2e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataquerycontextschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"custom_cache_timeout":{"description":"Override the default cache timeout","nullable":true,"type":"integer"},"datasource":{"properties":{"id":{"description":"Datasource id/uuid","oneOf":[{"type":"integer"},{"type":"string"}]},"type":{"description":"Datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"}},"required":["id"],"type":"object","title":"ChartDataDatasource"},"force":{"description":"Should the queries be forced to load from the source. Default: `false`","nullable":true,"type":"boolean"},"form_data":{"nullable":true},"queries":{"items":{"properties":{"annotation_layers":{"description":"Annotation layers to apply to chart","items":{"properties":{"annotationType":{"description":"Type of annotation layer","enum":["FORMULA","INTERVAL","EVENT","TIME_SERIES"],"type":"string"},"color":{"description":"Layer color","nullable":true,"type":"string"},"descriptionColumns":{"description":"Columns to use as the description. If none are provided, all will be shown.","items":{"type":"string"},"type":"array"},"hideLine":{"description":"Should line be hidden. Only applies to line annotations","nullable":true,"type":"boolean"},"intervalEndColumn":{"description":"Column containing end of interval. Only applies to interval layers","nullable":true,"type":"string"},"name":{"description":"Name of layer","type":"string"},"opacity":{"description":"Opacity of layer","enum":["","opacityLow","opacityMedium","opacityHigh"],"nullable":true,"type":"string"},"overrides":{"additionalProperties":{"nullable":true},"description":"which properties should be overridable","nullable":true,"type":"object"},"show":{"description":"Should the layer be shown","type":"boolean"},"showLabel":{"description":"Should the label always be shown","nullable":true,"type":"boolean"},"showMarkers":{"description":"Should markers be shown. Only applies to line annotations.","type":"boolean"},"sourceType":{"description":"Type of source for annotation data","enum":["","line","NATIVE","table"],"type":"string"},"style":{"description":"Line style. Only applies to time-series annotations","enum":["dashed","dotted","solid","longDashed"],"type":"string"},"timeColumn":{"description":"Column with event date or interval start date","nullable":true,"type":"string"},"titleColumn":{"description":"Column with title","nullable":true,"type":"string"},"value":{"description":"For formula annotations, this contains the formula. For other types, this is the primary key of the source object."},"width":{"description":"Width of annotation line","minimum":0,"type":"number"}},"required":["name","show","showMarkers","value"],"type":"object","title":"AnnotationLayer"},"nullable":true,"type":"array"},"applied_time_extras":{"description":"A mapping of temporal extras that have been applied to the query","example":{"__time_range":"1 year ago : now"},"nullable":true,"type":"object"},"apply_fetch_values_predicate":{"description":"Add fetch values predicate (where clause) to query if defined in datasource","nullable":true,"type":"boolean"},"columns":{"description":"Columns which to select in the query.","items":{},"nullable":true,"type":"array"},"datasource":{"allOf":[{"properties":{"id":{"description":"Datasource id/uuid","oneOf":[{"type":"integer"},{"type":"string"}]},"type":{"description":"Datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"}},"required":["id"],"type":"object","title":"ChartDataDatasource"}],"nullable":true},"extras":{"allOf":[{"properties":{"having":{"description":"HAVING clause to be added to aggregate queries using AND operator.","type":"string"},"instant_time_comparison_range":{"description":"This is only set using the new time comparison controls that is made available in some plugins behind the experimental feature flag.","nullable":true,"type":"string"},"relative_end":{"description":"End time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"relative_start":{"description":"Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"time_grain_sqla":{"description":"To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z"],"example":"P1D","nullable":true,"type":"string"},"where":{"description":"WHERE clause to be added to queries using AND operator.","type":"string"}},"type":"object","title":"ChartDataExtras"}],"description":"Extra parameters to add to the query.","nullable":true},"filters":{"items":{"properties":{"col":{"description":"The column to filter by. Can be either a string (physical or saved expression) or an object (adhoc column)","example":"country"},"grain":{"description":"Optional time grain for temporal filters","example":"PT1M","type":"string"},"isExtra":{"description":"Indicates if the filter has been added by a filter component as opposed to being a part of the original query.","type":"boolean"},"op":{"description":"The comparison operator.","enum":["==","!=",">","<",">=","<=","LIKE","NOT LIKE","ILIKE","IS NULL","IS NOT NULL","IN","NOT IN","IS TRUE","IS FALSE","TEMPORAL_RANGE"],"example":"IN","type":"string"},"val":{"description":"The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.","example":["China","France","Japan"],"nullable":true}},"required":["col","op"],"type":"object","title":"ChartDataFilter"},"nullable":true,"type":"array"},"granularity":{"description":"Name of temporal column used for time filtering. ","nullable":true,"type":"string"},"granularity_sqla":{"deprecated":true,"description":"Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use `granularity` instead.","nullable":true,"type":"string"},"groupby":{"description":"Columns by which to group the query. This field is deprecated, use `columns` instead.","items":{},"nullable":true,"type":"array"},"having":{"deprecated":true,"description":"HAVING clause to be added to aggregate queries using AND operator. This field is deprecated and should be passed to `extras`.","nullable":true,"type":"string"},"is_rowcount":{"description":"Should the rowcount of the actual query be returned","nullable":true,"type":"boolean"},"is_timeseries":{"description":"Is the `query_object` a timeseries.","nullable":true,"type":"boolean"},"metrics":{"description":"Aggregate expressions. Metrics can be passed as both references to datasource metrics (strings), or ad-hoc metricswhich are defined only within the query object. See `ChartDataAdhocMetricSchema` for the structure of ad-hoc metrics.","items":{},"nullable":true,"type":"array"},"order_desc":{"description":"Reverse order. Default: `false`","nullable":true,"type":"boolean"},"orderby":{"description":"Expects a list of lists where the first element is the column name which to sort by, and the second element is a boolean.","example":[["my_col_1",false],["my_col_2",true]],"items":{},"nullable":true,"type":"array"},"post_processing":{"description":"Post processing operations to be applied to the result set. Operations are applied to the result set in sequential order.","items":{"allOf":[{"properties":{"operation":{"description":"Post processing operation type","enum":["aggregate","boxplot","compare","contribution","cum","diff","escape_separator","flatten","geodetic_parse","geohash_decode","geohash_encode","histogram","pivot","prophet","rank","rename","resample","rolling","select","sort","unescape_separator"],"example":"aggregate","type":"string"},"options":{"description":"Options specifying how to perform the operation. Please refer to the respective post processing operation option schemas. For example, `ChartDataPostProcessingOperationOptions` specifies the required options for the pivot operation.","example":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]},"type":"object"}},"required":["operation"],"type":"object","title":"ChartDataPostProcessingOperation"}],"nullable":true},"nullable":true,"type":"array"},"result_type":{"enum":["columns","full","query","results","samples","timegrains","post_processed","drill_detail"],"nullable":true},"row_limit":{"description":"Maximum row count (0=disabled). Default: `config[\"ROW_LIMIT\"]`","minimum":0,"nullable":true,"type":"integer"},"row_offset":{"description":"Number of rows to skip. Default: `0`","minimum":0,"nullable":true,"type":"integer"},"series_columns":{"description":"Columns to use when limiting series count. All columns must be present in the `columns` property. Requires `series_limit` and `series_limit_metric` to be set.","items":{},"nullable":true,"type":"array"},"series_limit":{"description":"Maximum number of series. Requires `series` and `series_limit_metric` to be set.","nullable":true,"type":"integer"},"series_limit_metric":{"description":"Metric used to limit timeseries queries by. Requires `series` and `series_limit` to be set.","nullable":true},"time_offsets":{"items":{"type":"string"},"nullable":true,"type":"array"},"time_range":{"description":"A time rage, either expressed as a colon separated string `since : until` or human readable freeform. Valid formats for `since` and `until` are: \n- ISO 8601\n- X days/years/hours/day/year/weeks\n- X days/years/hours/day/year/weeks ago\n- X days/years/hours/day/year/weeks from now\n\nAdditionally, the following freeform can be used:\n\n- Last day\n- Last week\n- Last month\n- Last quarter\n- Last year\n- No filter\n- Last X seconds/minutes/hours/days/weeks/months/years\n- Next X seconds/minutes/hours/days/weeks/months/years\n","example":"Last week","nullable":true,"type":"string"},"time_shift":{"description":"A human-readable date/time string. Please refer to [parsdatetime](https://github.com/bear/parsedatetime) documentation for details on valid values.","nullable":true,"type":"string"},"timeseries_limit":{"description":"Maximum row count for timeseries queries. This field is deprecated, use `series_limit` instead.Default: `0`","nullable":true,"type":"integer"},"timeseries_limit_metric":{"description":"Metric used to limit timeseries queries by. This field is deprecated, use `series_limit_metric` instead.","nullable":true},"url_params":{"additionalProperties":{"description":"The value of the query parameter","type":"string"},"description":"Optional query parameters passed to a dashboard or Explore view","nullable":true,"type":"object"},"where":{"deprecated":true,"description":"WHERE clause to be added to queries using AND operator.This field is deprecated and should be passed to `extras`.","nullable":true,"type":"string"}},"type":"object","title":"ChartDataQueryObject"},"type":"array"},"result_format":{"enum":["csv","json","xlsx"]},"result_type":{"enum":["columns","full","query","results","samples","timegrains","post_processed","drill_detail"]}},"type":"object","title":"ChartDataQueryContextSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataquerycontextschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataquerycontextschema.schema.mdx new file mode 100644 index 00000000000..4bf90090829 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataquerycontextschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdataquerycontextschema +title: "ChartDataQueryContextSchema" +description: "" +sidebar_label: "ChartDataQueryContextSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"custom_cache_timeout":0,"datasource":{"id":0,"type":"table"},"force":true,"queries":[{"annotation_layers":[{"annotationType":"FORMULA","color":"string","descriptionColumns":["string"],"hideLine":true,"intervalEndColumn":"string","name":"string","opacity":"","overrides":{},"show":true,"showLabel":true,"showMarkers":true,"sourceType":"","style":"dashed","timeColumn":"string","titleColumn":"string","width":0}],"applied_time_extras":{"__time_range":"1 year ago : now"},"apply_fetch_values_predicate":true,"columns":[null],"datasource":{"id":0,"type":"table"},"extras":{"having":"string","instant_time_comparison_range":"string","relative_end":"today","relative_start":"today","time_grain_sqla":"P1D","where":"string"},"filters":[{"col":"country","grain":"PT1M","isExtra":true,"op":"IN","val":["China","France","Japan"]}],"granularity":"string","groupby":[null],"is_rowcount":true,"is_timeseries":true,"metrics":[null],"order_desc":true,"orderby":[["my_col_1",false],["my_col_2",true]],"post_processing":[{"operation":"aggregate","options":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]}}],"row_limit":0,"row_offset":0,"series_columns":[null],"series_limit":0,"time_offsets":["string"],"time_range":"Last week","time_shift":"string","timeseries_limit":0,"url_params":{}}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataqueryobject.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataqueryobject.Schema.json new file mode 100644 index 00000000000..323ba6c4f6f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataqueryobject.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"annotation_layers":{"description":"Annotation layers to apply to chart","items":{"properties":{"annotationType":{"description":"Type of annotation layer","enum":["FORMULA","INTERVAL","EVENT","TIME_SERIES"],"type":"string"},"color":{"description":"Layer color","nullable":true,"type":"string"},"descriptionColumns":{"description":"Columns to use as the description. If none are provided, all will be shown.","items":{"type":"string"},"type":"array"},"hideLine":{"description":"Should line be hidden. Only applies to line annotations","nullable":true,"type":"boolean"},"intervalEndColumn":{"description":"Column containing end of interval. Only applies to interval layers","nullable":true,"type":"string"},"name":{"description":"Name of layer","type":"string"},"opacity":{"description":"Opacity of layer","enum":["","opacityLow","opacityMedium","opacityHigh"],"nullable":true,"type":"string"},"overrides":{"additionalProperties":{"nullable":true},"description":"which properties should be overridable","nullable":true,"type":"object"},"show":{"description":"Should the layer be shown","type":"boolean"},"showLabel":{"description":"Should the label always be shown","nullable":true,"type":"boolean"},"showMarkers":{"description":"Should markers be shown. Only applies to line annotations.","type":"boolean"},"sourceType":{"description":"Type of source for annotation data","enum":["","line","NATIVE","table"],"type":"string"},"style":{"description":"Line style. Only applies to time-series annotations","enum":["dashed","dotted","solid","longDashed"],"type":"string"},"timeColumn":{"description":"Column with event date or interval start date","nullable":true,"type":"string"},"titleColumn":{"description":"Column with title","nullable":true,"type":"string"},"value":{"description":"For formula annotations, this contains the formula. For other types, this is the primary key of the source object."},"width":{"description":"Width of annotation line","minimum":0,"type":"number"}},"required":["name","show","showMarkers","value"],"type":"object","title":"AnnotationLayer"},"nullable":true,"type":"array"},"applied_time_extras":{"description":"A mapping of temporal extras that have been applied to the query","example":{"__time_range":"1 year ago : now"},"nullable":true,"type":"object"},"apply_fetch_values_predicate":{"description":"Add fetch values predicate (where clause) to query if defined in datasource","nullable":true,"type":"boolean"},"columns":{"description":"Columns which to select in the query.","items":{},"nullable":true,"type":"array"},"datasource":{"allOf":[{"properties":{"id":{"description":"Datasource id/uuid","oneOf":[{"type":"integer"},{"type":"string"}]},"type":{"description":"Datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"}},"required":["id"],"type":"object","title":"ChartDataDatasource"}],"nullable":true},"extras":{"allOf":[{"properties":{"having":{"description":"HAVING clause to be added to aggregate queries using AND operator.","type":"string"},"instant_time_comparison_range":{"description":"This is only set using the new time comparison controls that is made available in some plugins behind the experimental feature flag.","nullable":true,"type":"string"},"relative_end":{"description":"End time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"relative_start":{"description":"Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"time_grain_sqla":{"description":"To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z"],"example":"P1D","nullable":true,"type":"string"},"where":{"description":"WHERE clause to be added to queries using AND operator.","type":"string"}},"type":"object","title":"ChartDataExtras"}],"description":"Extra parameters to add to the query.","nullable":true},"filters":{"items":{"properties":{"col":{"description":"The column to filter by. Can be either a string (physical or saved expression) or an object (adhoc column)","example":"country"},"grain":{"description":"Optional time grain for temporal filters","example":"PT1M","type":"string"},"isExtra":{"description":"Indicates if the filter has been added by a filter component as opposed to being a part of the original query.","type":"boolean"},"op":{"description":"The comparison operator.","enum":["==","!=",">","<",">=","<=","LIKE","NOT LIKE","ILIKE","IS NULL","IS NOT NULL","IN","NOT IN","IS TRUE","IS FALSE","TEMPORAL_RANGE"],"example":"IN","type":"string"},"val":{"description":"The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.","example":["China","France","Japan"],"nullable":true}},"required":["col","op"],"type":"object","title":"ChartDataFilter"},"nullable":true,"type":"array"},"granularity":{"description":"Name of temporal column used for time filtering. ","nullable":true,"type":"string"},"granularity_sqla":{"deprecated":true,"description":"Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use `granularity` instead.","nullable":true,"type":"string"},"groupby":{"description":"Columns by which to group the query. This field is deprecated, use `columns` instead.","items":{},"nullable":true,"type":"array"},"having":{"deprecated":true,"description":"HAVING clause to be added to aggregate queries using AND operator. This field is deprecated and should be passed to `extras`.","nullable":true,"type":"string"},"is_rowcount":{"description":"Should the rowcount of the actual query be returned","nullable":true,"type":"boolean"},"is_timeseries":{"description":"Is the `query_object` a timeseries.","nullable":true,"type":"boolean"},"metrics":{"description":"Aggregate expressions. Metrics can be passed as both references to datasource metrics (strings), or ad-hoc metricswhich are defined only within the query object. See `ChartDataAdhocMetricSchema` for the structure of ad-hoc metrics.","items":{},"nullable":true,"type":"array"},"order_desc":{"description":"Reverse order. Default: `false`","nullable":true,"type":"boolean"},"orderby":{"description":"Expects a list of lists where the first element is the column name which to sort by, and the second element is a boolean.","example":[["my_col_1",false],["my_col_2",true]],"items":{},"nullable":true,"type":"array"},"post_processing":{"description":"Post processing operations to be applied to the result set. Operations are applied to the result set in sequential order.","items":{"allOf":[{"properties":{"operation":{"description":"Post processing operation type","enum":["aggregate","boxplot","compare","contribution","cum","diff","escape_separator","flatten","geodetic_parse","geohash_decode","geohash_encode","histogram","pivot","prophet","rank","rename","resample","rolling","select","sort","unescape_separator"],"example":"aggregate","type":"string"},"options":{"description":"Options specifying how to perform the operation. Please refer to the respective post processing operation option schemas. For example, `ChartDataPostProcessingOperationOptions` specifies the required options for the pivot operation.","example":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]},"type":"object"}},"required":["operation"],"type":"object","title":"ChartDataPostProcessingOperation"}],"nullable":true},"nullable":true,"type":"array"},"result_type":{"enum":["columns","full","query","results","samples","timegrains","post_processed","drill_detail"],"nullable":true},"row_limit":{"description":"Maximum row count (0=disabled). Default: `config[\"ROW_LIMIT\"]`","minimum":0,"nullable":true,"type":"integer"},"row_offset":{"description":"Number of rows to skip. Default: `0`","minimum":0,"nullable":true,"type":"integer"},"series_columns":{"description":"Columns to use when limiting series count. All columns must be present in the `columns` property. Requires `series_limit` and `series_limit_metric` to be set.","items":{},"nullable":true,"type":"array"},"series_limit":{"description":"Maximum number of series. Requires `series` and `series_limit_metric` to be set.","nullable":true,"type":"integer"},"series_limit_metric":{"description":"Metric used to limit timeseries queries by. Requires `series` and `series_limit` to be set.","nullable":true},"time_offsets":{"items":{"type":"string"},"nullable":true,"type":"array"},"time_range":{"description":"A time rage, either expressed as a colon separated string `since : until` or human readable freeform. Valid formats for `since` and `until` are: \n- ISO 8601\n- X days/years/hours/day/year/weeks\n- X days/years/hours/day/year/weeks ago\n- X days/years/hours/day/year/weeks from now\n\nAdditionally, the following freeform can be used:\n\n- Last day\n- Last week\n- Last month\n- Last quarter\n- Last year\n- No filter\n- Last X seconds/minutes/hours/days/weeks/months/years\n- Next X seconds/minutes/hours/days/weeks/months/years\n","example":"Last week","nullable":true,"type":"string"},"time_shift":{"description":"A human-readable date/time string. Please refer to [parsdatetime](https://github.com/bear/parsedatetime) documentation for details on valid values.","nullable":true,"type":"string"},"timeseries_limit":{"description":"Maximum row count for timeseries queries. This field is deprecated, use `series_limit` instead.Default: `0`","nullable":true,"type":"integer"},"timeseries_limit_metric":{"description":"Metric used to limit timeseries queries by. This field is deprecated, use `series_limit_metric` instead.","nullable":true},"url_params":{"additionalProperties":{"description":"The value of the query parameter","type":"string"},"description":"Optional query parameters passed to a dashboard or Explore view","nullable":true,"type":"object"},"where":{"deprecated":true,"description":"WHERE clause to be added to queries using AND operator.This field is deprecated and should be passed to `extras`.","nullable":true,"type":"string"}},"type":"object","title":"ChartDataQueryObject"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataqueryobject.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataqueryobject.schema.mdx new file mode 100644 index 00000000000..aa40bad5605 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataqueryobject.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdataqueryobject +title: "ChartDataQueryObject" +description: "" +sidebar_label: "ChartDataQueryObject" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"annotation_layers":[{"annotationType":"FORMULA","color":"string","descriptionColumns":["string"],"hideLine":true,"intervalEndColumn":"string","name":"string","opacity":"","overrides":{},"show":true,"showLabel":true,"showMarkers":true,"sourceType":"","style":"dashed","timeColumn":"string","titleColumn":"string","width":0}],"applied_time_extras":{"__time_range":"1 year ago : now"},"apply_fetch_values_predicate":true,"columns":[null],"datasource":{"id":0,"type":"table"},"extras":{"having":"string","instant_time_comparison_range":"string","relative_end":"today","relative_start":"today","time_grain_sqla":"P1D","where":"string"},"filters":[{"col":"country","grain":"PT1M","isExtra":true,"op":"IN","val":["China","France","Japan"]}],"granularity":"string","groupby":[null],"is_rowcount":true,"is_timeseries":true,"metrics":[null],"order_desc":true,"orderby":[["my_col_1",false],["my_col_2",true]],"post_processing":[{"operation":"aggregate","options":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]}}],"row_limit":0,"row_offset":0,"series_columns":[null],"series_limit":0,"time_offsets":["string"],"time_range":"Last week","time_shift":"string","timeseries_limit":0,"url_params":{}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseresult.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseresult.Schema.json new file mode 100644 index 00000000000..bd006f0f564 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseresult.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"annotation_data":{"description":"All requested annotation data","items":{"additionalProperties":{"type":"string"},"type":"object"},"nullable":true,"type":"array"},"applied_filters":{"description":"A list with applied filters","items":{"type":"object"},"type":"array"},"cache_key":{"description":"Unique cache key for query object","nullable":true,"type":"string"},"cache_timeout":{"description":"Cache timeout in following order: custom timeout, datasource timeout, cache default timeout, config default cache timeout.","nullable":true,"type":"integer"},"cached_dttm":{"description":"Cache timestamp","nullable":true,"type":"string"},"colnames":{"description":"A list of column names","items":{"type":"string"},"type":"array"},"coltypes":{"description":"A list of generic data types of each column","items":{"type":"integer"},"type":"array"},"data":{"description":"A list with results","items":{"type":"object"},"type":"array"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"query":{"description":"The executed query statement","type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","query"],"type":"object","title":"ChartDataResponseResult"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseresult.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseresult.schema.mdx new file mode 100644 index 00000000000..54593ba9168 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseresult.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdataresponseresult +title: "ChartDataResponseResult" +description: "" +sidebar_label: "ChartDataResponseResult" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"annotation_data":[{}],"applied_filters":[{}],"cache_key":"string","cache_timeout":0,"cached_dttm":"string","colnames":["string"],"coltypes":[0],"data":[{}],"error":"string","from_dttm":0,"is_cached":true,"query":"string","rejected_filters":[{}],"rowcount":0,"stacktrace":"string","status":"stopped","to_dttm":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseschema.Schema.json new file mode 100644 index 00000000000..af45d23e1d7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"result":{"description":"A list of results for each corresponding query in the request.","items":{"properties":{"annotation_data":{"description":"All requested annotation data","items":{"additionalProperties":{"type":"string"},"type":"object"},"nullable":true,"type":"array"},"applied_filters":{"description":"A list with applied filters","items":{"type":"object"},"type":"array"},"cache_key":{"description":"Unique cache key for query object","nullable":true,"type":"string"},"cache_timeout":{"description":"Cache timeout in following order: custom timeout, datasource timeout, cache default timeout, config default cache timeout.","nullable":true,"type":"integer"},"cached_dttm":{"description":"Cache timestamp","nullable":true,"type":"string"},"colnames":{"description":"A list of column names","items":{"type":"string"},"type":"array"},"coltypes":{"description":"A list of generic data types of each column","items":{"type":"integer"},"type":"array"},"data":{"description":"A list with results","items":{"type":"object"},"type":"array"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"query":{"description":"The executed query statement","type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","query"],"type":"object","title":"ChartDataResponseResult"},"type":"array"}},"type":"object","title":"ChartDataResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseschema.schema.mdx new file mode 100644 index 00000000000..6d01fc722fa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdataresponseschema +title: "ChartDataResponseSchema" +description: "" +sidebar_label: "ChartDataResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"result":[{"annotation_data":[{}],"applied_filters":[{}],"cache_key":"string","cache_timeout":0,"cached_dttm":"string","colnames":["string"],"coltypes":[0],"data":[{}],"error":"string","from_dttm":0,"is_cached":true,"query":"string","rejected_filters":[{}],"rowcount":0,"stacktrace":"string","status":"stopped","to_dttm":0}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-dashboard.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-dashboard.Schema.json new file mode 100644 index 00000000000..b02a5383db8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-dashboard.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"}},"type":"object","title":"ChartDataRestApi.get.Dashboard"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-dashboard.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-dashboard.schema.mdx new file mode 100644 index 00000000000..ebc4b142a85 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-dashboard.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get-dashboard +title: "ChartDataRestApi.get.Dashboard" +description: "" +sidebar_label: "ChartDataRestApi.get.Dashboard" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"dashboard_title":"string","id":0,"json_metadata":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-dashboard.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-dashboard.Schema.json new file mode 100644 index 00000000000..e1b29df3825 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-dashboard.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object","title":"ChartDataRestApi.get_list.Dashboard"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-dashboard.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-dashboard.schema.mdx new file mode 100644 index 00000000000..89be507abff --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-dashboard.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get-list-dashboard +title: "ChartDataRestApi.get_list.Dashboard" +description: "" +sidebar_label: "ChartDataRestApi.get_list.Dashboard" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"dashboard_title":"string","id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-sqlatable.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-sqlatable.Schema.json new file mode 100644 index 00000000000..7c28f1c117a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-sqlatable.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"default_endpoint":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["table_name"],"type":"object","title":"ChartDataRestApi.get_list.SqlaTable"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-sqlatable.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-sqlatable.schema.mdx new file mode 100644 index 00000000000..999b03e4b82 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-sqlatable.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get-list-sqlatable +title: "ChartDataRestApi.get_list.SqlaTable" +description: "" +sidebar_label: "ChartDataRestApi.get_list.SqlaTable" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"default_endpoint":"string","table_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-tag.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-tag.Schema.json new file mode 100644 index 00000000000..45324284f2d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-tag.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"ChartDataRestApi.get_list.Tag"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-tag.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-tag.schema.mdx new file mode 100644 index 00000000000..089b1d6a886 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-tag.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get-list-tag +title: "ChartDataRestApi.get_list.Tag" +description: "" +sidebar_label: "ChartDataRestApi.get_list.Tag" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..d27fd53bb98 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartDataRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..33bf7aea9e1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get-list-user-1 +title: "ChartDataRestApi.get_list.User1" +description: "" +sidebar_label: "ChartDataRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-2.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-2.Schema.json new file mode 100644 index 00000000000..dd4fc2d65f5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-2.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartDataRestApi.get_list.User2"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-2.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-2.schema.mdx new file mode 100644 index 00000000000..ecd270f0900 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-2.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get-list-user-2 +title: "ChartDataRestApi.get_list.User2" +description: "" +sidebar_label: "ChartDataRestApi.get_list.User2" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-3.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-3.Schema.json new file mode 100644 index 00000000000..bd31a60ae3e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-3.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartDataRestApi.get_list.User3"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-3.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-3.schema.mdx new file mode 100644 index 00000000000..9b093775c24 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user-3.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get-list-user-3 +title: "ChartDataRestApi.get_list.User3" +description: "" +sidebar_label: "ChartDataRestApi.get_list.User3" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..7124b3e131a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartDataRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..0c4342d3412 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get-list-user +title: "ChartDataRestApi.get_list.User" +description: "" +sidebar_label: "ChartDataRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list.Schema.json new file mode 100644 index 00000000000..0ce0425ae51 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartDataRestApi.get_list.User"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_dttm":{"readOnly":true},"changed_on_utc":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartDataRestApi.get_list.User1"},"created_by_name":{"readOnly":true},"created_on_delta_humanized":{"readOnly":true},"dashboards":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object","title":"ChartDataRestApi.get_list.Dashboard"},"datasource_id":{"nullable":true,"type":"integer"},"datasource_name_text":{"readOnly":true},"datasource_type":{"maxLength":200,"nullable":true,"type":"string"},"datasource_url":{"readOnly":true},"description":{"nullable":true,"type":"string"},"description_markeddown":{"readOnly":true},"edit_url":{"readOnly":true},"form_data":{"readOnly":true},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"last_saved_at":{"format":"date-time","nullable":true,"type":"string"},"last_saved_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartDataRestApi.get_list.User2"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartDataRestApi.get_list.User3"},"params":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"slice_url":{"readOnly":true},"table":{"properties":{"default_endpoint":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["table_name"],"type":"object","title":"ChartDataRestApi.get_list.SqlaTable"},"tags":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"ChartDataRestApi.get_list.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"uuid":{"format":"uuid","nullable":true,"type":"string"},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"ChartDataRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list.schema.mdx new file mode 100644 index 00000000000..17126c3f9d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get-list +title: "ChartDataRestApi.get_list" +description: "" +sidebar_label: "ChartDataRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":0,"certification_details":"string","certified_by":"string","changed_by":{"first_name":"string","id":0,"last_name":"string"},"created_by":{"first_name":"string","id":0,"last_name":"string"},"dashboards":{"dashboard_title":"string","id":0},"datasource_id":0,"datasource_type":"string","description":"string","id":0,"is_managed_externally":true,"last_saved_at":"2024-07-29T15:51:28.071Z","last_saved_by":{"first_name":"string","id":0,"last_name":"string"},"owners":{"first_name":"string","id":0,"last_name":"string"},"params":"string","slice_name":"string","table":{"default_endpoint":"string","table_name":"string"},"tags":{"id":0,"name":"string"},"uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","viz_type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-tag.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-tag.Schema.json new file mode 100644 index 00000000000..2229ad90a62 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-tag.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"ChartDataRestApi.get.Tag"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-tag.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-tag.schema.mdx new file mode 100644 index 00000000000..a20599273a3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-tag.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get-tag +title: "ChartDataRestApi.get.Tag" +description: "" +sidebar_label: "ChartDataRestApi.get.Tag" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-user.Schema.json new file mode 100644 index 00000000000..badd2f3108c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartDataRestApi.get.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-user.schema.mdx new file mode 100644 index 00000000000..b535aec7376 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get-user +title: "ChartDataRestApi.get.User" +description: "" +sidebar_label: "ChartDataRestApi.get.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get.Schema.json new file mode 100644 index 00000000000..33d80831975 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"dashboards":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"}},"type":"object","title":"ChartDataRestApi.get.Dashboard"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartDataRestApi.get.User"},"params":{"nullable":true,"type":"string"},"query_context":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"tags":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"ChartDataRestApi.get.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"ChartDataRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get.schema.mdx new file mode 100644 index 00000000000..f35be70c386 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-get +title: "ChartDataRestApi.get" +description: "" +sidebar_label: "ChartDataRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":0,"certification_details":"string","certified_by":"string","dashboards":{"dashboard_title":"string","id":0,"json_metadata":"string"},"description":"string","id":0,"is_managed_externally":true,"owners":{"first_name":"string","id":0,"last_name":"string"},"params":"string","query_context":"string","slice_name":"string","tags":{"id":0,"name":"string"},"viz_type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-post.Schema.json new file mode 100644 index 00000000000..73201dc91f6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-post.Schema.json @@ -0,0 +1 @@ +{"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"},"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":"ChartDataRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-post.schema.mdx new file mode 100644 index 00000000000..09af592c178 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-post +title: "ChartDataRestApi.post" +description: "" +sidebar_label: "ChartDataRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":0,"certification_details":"string","certified_by":"string","dashboards":[0],"datasource_id":0,"datasource_name":"string","datasource_type":"table","description":"string","external_url":"string","is_managed_externally":true,"owners":[0],"params":"string","query_context":"string","query_context_generation":true,"slice_name":"string","viz_type":["bar","area","table"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-put.Schema.json new file mode 100644 index 00000000000..fbc29f119f3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-put.Schema.json @@ -0,0 +1 @@ +{"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`.","nullable":true,"type":"integer"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"nullable":true,"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":0,"nullable":true,"type":"string"},"tags":{"items":{"description":"Tags to be associated with the chart","type":"integer"},"type":"array"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"nullable":true,"type":"string"}},"type":"object","title":"ChartDataRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-put.schema.mdx new file mode 100644 index 00000000000..4e44d6eb3df --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarestapi-put +title: "ChartDataRestApi.put" +description: "" +sidebar_label: "ChartDataRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":0,"certification_details":"string","certified_by":"string","dashboards":[0],"datasource_id":0,"datasource_type":"table","description":"string","external_url":"string","is_managed_externally":true,"owners":[0],"params":"string","query_context":"string","query_context_generation":true,"slice_name":"string","tags":[0],"viz_type":["bar","area","table"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarollingoptionsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarollingoptionsschema.Schema.json new file mode 100644 index 00000000000..29db91f96aa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarollingoptionsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"center":{"description":"Should the label be at the center of the window.Default: `false`","example":false,"type":"boolean"},"min_periods":{"description":"The minimum amount of periods required for a row to be included in the result set.","example":7,"type":"integer"},"rolling_type":{"description":"Type of rolling window. Any numpy function will work.","enum":["average","argmin","argmax","cumsum","cumprod","max","mean","median","nansum","nanmin","nanmax","nanmean","nanmedian","nanpercentile","min","percentile","prod","product","std","sum","var"],"example":"percentile","type":"string"},"rolling_type_options":{"description":"Optional options to pass to rolling method. Needed for e.g. quantile operation.","example":{},"type":"object"},"win_type":{"description":"Type of window function. See [SciPy window functions](https://docs.scipy.org/doc/scipy/reference /signal.windows.html#module-scipy.signal.windows) for more details. Some window functions require passing additional parameters to `rolling_type_options`. For instance, to use `gaussian`, the parameter `std` needs to be provided.","enum":["boxcar","triang","blackman","hamming","bartlett","parzen","bohman","blackmanharris","nuttall","barthann","kaiser","gaussian","general_gaussian","slepian","exponential"],"type":"string"},"window":{"description":"Size of the rolling window in days.","example":7,"type":"integer"}},"required":["rolling_type","window"],"type":"object","title":"ChartDataRollingOptionsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarollingoptionsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarollingoptionsschema.schema.mdx new file mode 100644 index 00000000000..99c35c1756d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarollingoptionsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatarollingoptionsschema +title: "ChartDataRollingOptionsSchema" +description: "" +sidebar_label: "ChartDataRollingOptionsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"center":false,"min_periods":7,"rolling_type":"percentile","rolling_type_options":{},"win_type":"boxcar","window":7} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataselectoptionsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataselectoptionsschema.Schema.json new file mode 100644 index 00000000000..0085a6b7d62 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataselectoptionsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"columns":{"description":"Columns which to select from the input data, in the desired order. If columns are renamed, the original column name should be referenced here.","example":["country","gender","age"],"items":{"type":"string"},"type":"array"},"exclude":{"description":"Columns to exclude from selection.","example":["my_temp_column"],"items":{"type":"string"},"type":"array"},"rename":{"description":"columns which to rename, mapping source column to target column. For instance, `{'y': 'y2'}` will rename the column `y` to `y2`.","example":[{"age":"average_age"}],"items":{"type":"object"},"type":"array"}},"type":"object","title":"ChartDataSelectOptionsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataselectoptionsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataselectoptionsschema.schema.mdx new file mode 100644 index 00000000000..fea92d8964c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdataselectoptionsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdataselectoptionsschema +title: "ChartDataSelectOptionsSchema" +description: "" +sidebar_label: "ChartDataSelectOptionsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"columns":["country","gender","age"],"exclude":["my_temp_column"],"rename":[{"age":"average_age"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatasortoptionsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatasortoptionsschema.Schema.json new file mode 100644 index 00000000000..76e6981a10f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatasortoptionsschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"aggregates":{"description":"The keys are the name of the aggregate column to be created, and the values specify the details of how to apply the aggregation. If an operator requires additional options, these can be passed here to be unpacked in the operator call. The following numpy operators are supported: average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, min, percentile, prod, product, std, sum, var. Any options required by the operator can be passed to the `options` object.\n\nIn the example, a new column `first_quantile` is created based on values in the column `my_col` using the `percentile` operator with the `q=0.25` parameter.","example":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"type":"object"},"columns":{"description":"columns by by which to sort. The key specifies the column name, value specifies if sorting in ascending order.","example":{"country":true,"gender":false},"type":"object"}},"required":["columns"],"type":"object","title":"ChartDataSortOptionsSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatasortoptionsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatasortoptionsschema.schema.mdx new file mode 100644 index 00000000000..41496426ba7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatasortoptionsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartdatasortoptionsschema +title: "ChartDataSortOptionsSchema" +description: "" +sidebar_label: "ChartDataSortOptionsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"aggregates":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"columns":{"country":true,"gender":false}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartentityresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartentityresponseschema.Schema.json new file mode 100644 index 00000000000..ceb35014566 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartentityresponseschema.Schema.json @@ -0,0 +1 @@ +{"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.","type":"integer"},"certification_details":{"description":"Details of the certification","type":"string"},"certified_by":{"description":"Person or group that has certified this chart","type":"string"},"changed_on":{"description":"The ISO date that the chart was last changed.","format":"date-time","type":"string"},"description":{"description":"A description of the chart propose.","type":"string"},"description_markeddown":{"description":"Sanitized HTML version of the chart description.","type":"string"},"form_data":{"description":"Form data from the Explore controls used to form the chart's data query.","type":"object"},"id":{"description":"The id of the chart.","type":"integer"},"slice_name":{"description":"The name of the chart.","type":"string"},"slice_url":{"description":"The URL of the chart.","type":"string"}},"type":"object","title":"ChartEntityResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartentityresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartentityresponseschema.schema.mdx new file mode 100644 index 00000000000..86950d5ecef --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartentityresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartentityresponseschema +title: "ChartEntityResponseSchema" +description: "" +sidebar_label: "ChartEntityResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":0,"certification_details":"string","certified_by":"string","changed_on":"2024-07-29T15:51:28.071Z","description":"string","description_markeddown":"string","form_data":{},"id":0,"slice_name":"string","slice_url":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartfavstarresponseresult.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartfavstarresponseresult.Schema.json new file mode 100644 index 00000000000..0c381d231a6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartfavstarresponseresult.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"description":"The Chart id","type":"integer"},"value":{"description":"The FaveStar value","type":"boolean"}},"type":"object","title":"ChartFavStarResponseResult"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartfavstarresponseresult.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartfavstarresponseresult.schema.mdx new file mode 100644 index 00000000000..0ea86fbd6ed --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartfavstarresponseresult.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartfavstarresponseresult +title: "ChartFavStarResponseResult" +description: "" +sidebar_label: "ChartFavStarResponseResult" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"value":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectdataresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectdataresponse.Schema.json new file mode 100644 index 00000000000..08f0b857a93 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectdataresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"datasource_id":{"description":"The datasource identifier","type":"integer"},"datasource_type":{"description":"The datasource type","type":"integer"}},"type":"object","title":"ChartGetDatasourceObjectDataResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectdataresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectdataresponse.schema.mdx new file mode 100644 index 00000000000..5a17ba26c29 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectdataresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartgetdatasourceobjectdataresponse +title: "ChartGetDatasourceObjectDataResponse" +description: "" +sidebar_label: "ChartGetDatasourceObjectDataResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"datasource_id":0,"datasource_type":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectresponse.Schema.json new file mode 100644 index 00000000000..6193ac9fd44 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"label":{"description":"The name of the datasource","type":"string"},"value":{"properties":{"datasource_id":{"description":"The datasource identifier","type":"integer"},"datasource_type":{"description":"The datasource type","type":"integer"}},"type":"object","title":"ChartGetDatasourceObjectDataResponse"}},"type":"object","title":"ChartGetDatasourceObjectResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectresponse.schema.mdx new file mode 100644 index 00000000000..40f1ae88758 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceobjectresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartgetdatasourceobjectresponse +title: "ChartGetDatasourceObjectResponse" +description: "" +sidebar_label: "ChartGetDatasourceObjectResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"label":"string","value":{"datasource_id":0,"datasource_type":0}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceresponseschema.Schema.json new file mode 100644 index 00000000000..db170429c5e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"count":{"description":"The total number of datasources","type":"integer"},"result":{"properties":{"label":{"description":"The name of the datasource","type":"string"},"value":{"properties":{"datasource_id":{"description":"The datasource identifier","type":"integer"},"datasource_type":{"description":"The datasource type","type":"integer"}},"type":"object","title":"ChartGetDatasourceObjectDataResponse"}},"type":"object","title":"ChartGetDatasourceObjectResponse"}},"type":"object","title":"ChartGetDatasourceResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceresponseschema.schema.mdx new file mode 100644 index 00000000000..804e91bfd33 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetdatasourceresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartgetdatasourceresponseschema +title: "ChartGetDatasourceResponseSchema" +description: "" +sidebar_label: "ChartGetDatasourceResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"count":0,"result":{"label":"string","value":{"datasource_id":0,"datasource_type":0}}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-dashboard.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-dashboard.Schema.json new file mode 100644 index 00000000000..fce86536167 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-dashboard.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"}},"type":"object","title":"ChartRestApi.get.Dashboard"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-dashboard.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-dashboard.schema.mdx new file mode 100644 index 00000000000..271f2dbe36d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-dashboard.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get-dashboard +title: "ChartRestApi.get.Dashboard" +description: "" +sidebar_label: "ChartRestApi.get.Dashboard" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"dashboard_title":"string","id":0,"json_metadata":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-dashboard.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-dashboard.Schema.json new file mode 100644 index 00000000000..62002ca1a31 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-dashboard.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object","title":"ChartRestApi.get_list.Dashboard"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-dashboard.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-dashboard.schema.mdx new file mode 100644 index 00000000000..1bf9373df3e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-dashboard.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get-list-dashboard +title: "ChartRestApi.get_list.Dashboard" +description: "" +sidebar_label: "ChartRestApi.get_list.Dashboard" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"dashboard_title":"string","id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-sqlatable.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-sqlatable.Schema.json new file mode 100644 index 00000000000..c8747090efc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-sqlatable.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"default_endpoint":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["table_name"],"type":"object","title":"ChartRestApi.get_list.SqlaTable"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-sqlatable.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-sqlatable.schema.mdx new file mode 100644 index 00000000000..7b14c87e41c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-sqlatable.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get-list-sqlatable +title: "ChartRestApi.get_list.SqlaTable" +description: "" +sidebar_label: "ChartRestApi.get_list.SqlaTable" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"default_endpoint":"string","table_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-tag.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-tag.Schema.json new file mode 100644 index 00000000000..1d6d5aadb35 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-tag.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"ChartRestApi.get_list.Tag"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-tag.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-tag.schema.mdx new file mode 100644 index 00000000000..2626a4f77fd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-tag.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get-list-tag +title: "ChartRestApi.get_list.Tag" +description: "" +sidebar_label: "ChartRestApi.get_list.Tag" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..a794eb41289 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..4218f36a2fe --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get-list-user-1 +title: "ChartRestApi.get_list.User1" +description: "" +sidebar_label: "ChartRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-2.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-2.Schema.json new file mode 100644 index 00000000000..91703af85de --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-2.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User2"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-2.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-2.schema.mdx new file mode 100644 index 00000000000..e907c7d3b21 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-2.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get-list-user-2 +title: "ChartRestApi.get_list.User2" +description: "" +sidebar_label: "ChartRestApi.get_list.User2" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-3.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-3.Schema.json new file mode 100644 index 00000000000..9a758502e58 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-3.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User3"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-3.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-3.schema.mdx new file mode 100644 index 00000000000..3f2c5d42c9c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user-3.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get-list-user-3 +title: "ChartRestApi.get_list.User3" +description: "" +sidebar_label: "ChartRestApi.get_list.User3" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..d9cd2fd161e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..988f7858ecc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get-list-user +title: "ChartRestApi.get_list.User" +description: "" +sidebar_label: "ChartRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list.Schema.json new file mode 100644 index 00000000000..372a50cb794 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_dttm":{"readOnly":true},"changed_on_utc":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User1"},"created_by_name":{"readOnly":true},"created_on_delta_humanized":{"readOnly":true},"dashboards":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object","title":"ChartRestApi.get_list.Dashboard"},"datasource_id":{"nullable":true,"type":"integer"},"datasource_name_text":{"readOnly":true},"datasource_type":{"maxLength":200,"nullable":true,"type":"string"},"datasource_url":{"readOnly":true},"description":{"nullable":true,"type":"string"},"description_markeddown":{"readOnly":true},"edit_url":{"readOnly":true},"form_data":{"readOnly":true},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"last_saved_at":{"format":"date-time","nullable":true,"type":"string"},"last_saved_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User2"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get_list.User3"},"params":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"slice_url":{"readOnly":true},"table":{"properties":{"default_endpoint":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["table_name"],"type":"object","title":"ChartRestApi.get_list.SqlaTable"},"tags":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"ChartRestApi.get_list.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"uuid":{"format":"uuid","nullable":true,"type":"string"},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"ChartRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..6e002117834 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get-list +title: "ChartRestApi.get_list" +description: "" +sidebar_label: "ChartRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":0,"certification_details":"string","certified_by":"string","changed_by":{"first_name":"string","id":0,"last_name":"string"},"created_by":{"first_name":"string","id":0,"last_name":"string"},"dashboards":{"dashboard_title":"string","id":0},"datasource_id":0,"datasource_type":"string","description":"string","id":0,"is_managed_externally":true,"last_saved_at":"2024-07-29T15:51:28.071Z","last_saved_by":{"first_name":"string","id":0,"last_name":"string"},"owners":{"first_name":"string","id":0,"last_name":"string"},"params":"string","slice_name":"string","table":{"default_endpoint":"string","table_name":"string"},"tags":{"id":0,"name":"string"},"uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","viz_type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-tag.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-tag.Schema.json new file mode 100644 index 00000000000..8988032a958 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-tag.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"ChartRestApi.get.Tag"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-tag.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-tag.schema.mdx new file mode 100644 index 00000000000..7491520ecfc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-tag.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get-tag +title: "ChartRestApi.get.Tag" +description: "" +sidebar_label: "ChartRestApi.get.Tag" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-user.Schema.json new file mode 100644 index 00000000000..59ca62e3473 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-user.schema.mdx new file mode 100644 index 00000000000..be170024521 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get-user +title: "ChartRestApi.get.User" +description: "" +sidebar_label: "ChartRestApi.get.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get.Schema.json new file mode 100644 index 00000000000..f77a7e02e4a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"dashboards":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"}},"type":"object","title":"ChartRestApi.get.Dashboard"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ChartRestApi.get.User"},"params":{"nullable":true,"type":"string"},"query_context":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"tags":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"ChartRestApi.get.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"ChartRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get.schema.mdx new file mode 100644 index 00000000000..036a6f6343f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-get +title: "ChartRestApi.get" +description: "" +sidebar_label: "ChartRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":0,"certification_details":"string","certified_by":"string","dashboards":{"dashboard_title":"string","id":0,"json_metadata":"string"},"description":"string","id":0,"is_managed_externally":true,"owners":{"first_name":"string","id":0,"last_name":"string"},"params":"string","query_context":"string","slice_name":"string","tags":{"id":0,"name":"string"},"viz_type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-post.Schema.json new file mode 100644 index 00000000000..91ad604d8ad --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-post.Schema.json @@ -0,0 +1 @@ +{"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"},"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"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-post.schema.mdx new file mode 100644 index 00000000000..95d9ee3c730 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-post +title: "ChartRestApi.post" +description: "" +sidebar_label: "ChartRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":0,"certification_details":"string","certified_by":"string","dashboards":[0],"datasource_id":0,"datasource_name":"string","datasource_type":"table","description":"string","external_url":"string","is_managed_externally":true,"owners":[0],"params":"string","query_context":"string","query_context_generation":true,"slice_name":"string","viz_type":["bar","area","table"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-put.Schema.json new file mode 100644 index 00000000000..cd6e77d709f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-put.Schema.json @@ -0,0 +1 @@ +{"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`.","nullable":true,"type":"integer"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"nullable":true,"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":0,"nullable":true,"type":"string"},"tags":{"items":{"description":"Tags to be associated with the chart","type":"integer"},"type":"array"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"nullable":true,"type":"string"}},"type":"object","title":"ChartRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-put.schema.mdx new file mode 100644 index 00000000000..33d8a2a1be0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartrestapi-put +title: "ChartRestApi.put" +description: "" +sidebar_label: "ChartRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":0,"certification_details":"string","certified_by":"string","dashboards":[0],"datasource_id":0,"datasource_type":"table","description":"string","external_url":"string","is_managed_externally":true,"owners":[0],"params":"string","query_context":"string","query_context_generation":true,"slice_name":"string","tags":[0],"viz_type":["bar","area","table"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..1ecf34ce7ad --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..b9c938442e2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: csstemplaterestapi-get-list-user-1 +title: "CssTemplateRestApi.get_list.User1" +description: "" +sidebar_label: "CssTemplateRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..96245818643 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..7884ab44971 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: csstemplaterestapi-get-list-user +title: "CssTemplateRestApi.get_list.User" +description: "" +sidebar_label: "CssTemplateRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list.Schema.json new file mode 100644 index 00000000000..66b3a3be919 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get_list.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get_list.User1"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"css":{"nullable":true,"type":"string"},"id":{"type":"integer"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"CssTemplateRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list.schema.mdx new file mode 100644 index 00000000000..b8cac07a96b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: csstemplaterestapi-get-list +title: "CssTemplateRestApi.get_list" +description: "" +sidebar_label: "CssTemplateRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_by":{"first_name":"string","id":0,"last_name":"string"},"created_by":{"first_name":"string","id":0,"last_name":"string"},"created_on":"2024-07-29T15:51:28.071Z","css":"string","id":0,"template_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user-1.Schema.json new file mode 100644 index 00000000000..21ebb6282c6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user-1.schema.mdx new file mode 100644 index 00000000000..bd8086b5c58 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: csstemplaterestapi-get-user-1 +title: "CssTemplateRestApi.get.User1" +description: "" +sidebar_label: "CssTemplateRestApi.get.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user.Schema.json new file mode 100644 index 00000000000..967fd6f7d0d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user.schema.mdx new file mode 100644 index 00000000000..1ad2963d969 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: csstemplaterestapi-get-user +title: "CssTemplateRestApi.get.User" +description: "" +sidebar_label: "CssTemplateRestApi.get.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get.Schema.json new file mode 100644 index 00000000000..6e3fd4c09c4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"CssTemplateRestApi.get.User1"},"css":{"nullable":true,"type":"string"},"id":{"type":"integer"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"CssTemplateRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get.schema.mdx new file mode 100644 index 00000000000..b104cc0a32b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: csstemplaterestapi-get +title: "CssTemplateRestApi.get" +description: "" +sidebar_label: "CssTemplateRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_by":{"first_name":"string","id":0,"last_name":"string"},"created_by":{"first_name":"string","id":0,"last_name":"string"},"css":"string","id":0,"template_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-post.Schema.json new file mode 100644 index 00000000000..74799adb85c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"css":{"nullable":true,"type":"string"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"CssTemplateRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-post.schema.mdx new file mode 100644 index 00000000000..6de4a8655ca --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: csstemplaterestapi-post +title: "CssTemplateRestApi.post" +description: "" +sidebar_label: "CssTemplateRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"css":"string","template_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-put.Schema.json new file mode 100644 index 00000000000..e2c8ea3c2d7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"css":{"nullable":true,"type":"string"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"CssTemplateRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-put.schema.mdx new file mode 100644 index 00000000000..0f76b67da73 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/csstemplaterestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: csstemplaterestapi-put +title: "CssTemplateRestApi.put" +description: "" +sidebar_label: "CssTemplateRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"css":"string","template_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcachescreenshotresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcachescreenshotresponseschema.Schema.json new file mode 100644 index 00000000000..395c0eba3a5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcachescreenshotresponseschema.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcachescreenshotresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcachescreenshotresponseschema.schema.mdx new file mode 100644 index 00000000000..510f3d28593 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcachescreenshotresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardcachescreenshotresponseschema +title: "DashboardCacheScreenshotResponseSchema" +description: "" +sidebar_label: "DashboardCacheScreenshotResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_key":"string","dashboard_url":"string","image_url":"string","task_status":"string","task_updated_at":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcolorsconfigupdateschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcolorsconfigupdateschema.Schema.json new file mode 100644 index 00000000000..886e2388533 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcolorsconfigupdateschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"type":"object","properties":{"color_namespace":{"type":"string","nullable":true,"description":"The color namespace."},"color_scheme":{"type":"string","nullable":true,"description":"The color scheme name."},"map_label_colors":{"type":"object","additionalProperties":{"type":"string"},"description":"Mapping of labels to colors."},"shared_label_colors":{"type":"object","additionalProperties":{"type":"string"},"description":"Shared label colors across charts."},"label_colors":{"type":"object","additionalProperties":{"type":"string"},"description":"Label to color mapping."},"color_scheme_domain":{"type":"array","items":{"type":"string"},"description":"Color scheme domain values."}},"title":"DashboardColorsConfigUpdateSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcolorsconfigupdateschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcolorsconfigupdateschema.schema.mdx new file mode 100644 index 00000000000..24c4ae2929f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcolorsconfigupdateschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardcolorsconfigupdateschema +title: "DashboardColorsConfigUpdateSchema" +description: "" +sidebar_label: "DashboardColorsConfigUpdateSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"color_namespace":"string","color_scheme":"string","map_label_colors":{},"shared_label_colors":{},"label_colors":{},"color_scheme_domain":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcopyschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcopyschema.Schema.json new file mode 100644 index 00000000000..099f72a16a6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcopyschema.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcopyschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcopyschema.schema.mdx new file mode 100644 index 00000000000..b3bfb71171d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardcopyschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardcopyschema +title: "DashboardCopySchema" +description: "" +sidebar_label: "DashboardCopySchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"css":"string","dashboard_title":"string","duplicate_slices":true,"json_metadata":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboarddatasetschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboarddatasetschema.Schema.json new file mode 100644 index 00000000000..e328013683e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboarddatasetschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"always_filter_main_dttm":{"type":"boolean"},"cache_timeout":{"type":"integer"},"column_formats":{"type":"object"},"column_names":{"items":{"type":"string"},"type":"array"},"column_types":{"items":{"type":"integer"},"type":"array"},"columns":{"items":{"type":"object"},"type":"array"},"database":{"properties":{"allow_multi_catalog":{"type":"boolean"},"allows_cost_estimate":{"type":"boolean"},"allows_subquery":{"type":"boolean"},"allows_virtual_table_explore":{"type":"boolean"},"backend":{"type":"string"},"disable_data_preview":{"type":"boolean"},"disable_drill_to_detail":{"type":"boolean"},"explore_database_id":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","title":"Database"},"datasource_name":{"type":"string"},"default_endpoint":{"type":"string"},"edit_url":{"type":"string"},"fetch_values_predicate":{"type":"string"},"filter_select":{"type":"boolean"},"filter_select_enabled":{"type":"boolean"},"granularity_sqla":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"health_check_message":{"type":"string"},"id":{"type":"integer"},"is_sqllab_view":{"type":"boolean"},"main_dttm_col":{"type":"string"},"metrics":{"items":{"type":"object"},"type":"array"},"name":{"type":"string"},"normalize_columns":{"type":"boolean"},"offset":{"type":"integer"},"order_by_choices":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"owners":{"items":{"type":"object"},"type":"array"},"params":{"type":"string"},"perm":{"type":"string"},"schema":{"type":"string"},"select_star":{"type":"string"},"sql":{"type":"string"},"table_name":{"type":"string"},"template_params":{"type":"string"},"time_grain_sqla":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"type":{"type":"string"},"uid":{"type":"string"},"verbose_map":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object","title":"DashboardDatasetSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboarddatasetschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboarddatasetschema.schema.mdx new file mode 100644 index 00000000000..7d579983eb9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboarddatasetschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboarddatasetschema +title: "DashboardDatasetSchema" +description: "" +sidebar_label: "DashboardDatasetSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"always_filter_main_dttm":true,"cache_timeout":0,"column_formats":{},"column_names":["string"],"column_types":[0],"columns":[{}],"database":{"allow_multi_catalog":true,"allows_cost_estimate":true,"allows_subquery":true,"allows_virtual_table_explore":true,"backend":"string","disable_data_preview":true,"disable_drill_to_detail":true,"explore_database_id":0,"id":0,"name":"string"},"datasource_name":"string","default_endpoint":"string","edit_url":"string","fetch_values_predicate":"string","filter_select":true,"filter_select_enabled":true,"granularity_sqla":["string"],"health_check_message":"string","id":0,"is_sqllab_view":true,"main_dttm_col":"string","metrics":[{}],"name":"string","normalize_columns":true,"offset":0,"order_by_choices":["string"],"owners":[{}],"params":"string","perm":"string","schema":"string","select_star":"string","sql":"string","table_name":"string","template_params":"string","time_grain_sqla":["string"],"type":"string","uid":"string","verbose_map":{}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardgetresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardgetresponseschema.Schema.json new file mode 100644 index 00000000000..0d9078df16e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardgetresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"certification_details":{"description":"Details of the certification","type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","type":"string"},"changed_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"changed_by_name":{"type":"string"},"changed_on":{"format":"date-time","type":"string"},"changed_on_delta_humanized":{"type":"string"},"charts":{"items":{"description":"The names of the dashboard's charts. Names are used for legacy reasons.","type":"string"},"type":"array"},"created_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"created_on_delta_humanized":{"type":"string"},"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","type":"string"},"id":{"type":"integer"},"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":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"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":{"type":"boolean"},"roles":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","title":"Roles"},"type":"array"},"slug":{"type":"string"},"tags":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"Tag"},"type":"array"},"thumbnail_url":{"nullable":true,"type":"string"},"url":{"type":"string"}},"type":"object","title":"DashboardGetResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardgetresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardgetresponseschema.schema.mdx new file mode 100644 index 00000000000..908e1f3420b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardgetresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardgetresponseschema +title: "DashboardGetResponseSchema" +description: "" +sidebar_label: "DashboardGetResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"certification_details":"string","certified_by":"string","changed_by":{"first_name":"string","id":0,"last_name":"string"},"changed_by_name":"string","changed_on":"2024-07-29T15:51:28.071Z","changed_on_delta_humanized":"string","charts":["string"],"created_by":{"first_name":"string","id":0,"last_name":"string"},"created_on_delta_humanized":"string","css":"string","dashboard_title":"string","id":0,"is_managed_externally":true,"json_metadata":"string","owners":[{"first_name":"string","id":0,"last_name":"string"}],"position_json":"string","published":true,"roles":[{"id":0,"name":"string"}],"slug":"string","tags":[{"id":0,"name":"string"}],"thumbnail_url":"string","url":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardnativefiltersconfigupdateschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardnativefiltersconfigupdateschema.Schema.json new file mode 100644 index 00000000000..891806b014a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardnativefiltersconfigupdateschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"type":"object","properties":{"deleted":{"type":"array","items":{"type":"string"},"description":"List of deleted filter IDs."},"modified":{"type":"array","items":{"type":"object"},"description":"List of modified filter configurations."},"reordered":{"type":"array","items":{"type":"string"},"description":"List of filter IDs in new order."}},"title":"DashboardNativeFiltersConfigUpdateSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardnativefiltersconfigupdateschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardnativefiltersconfigupdateschema.schema.mdx new file mode 100644 index 00000000000..74a2b5dc8df --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardnativefiltersconfigupdateschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardnativefiltersconfigupdateschema +title: "DashboardNativeFiltersConfigUpdateSchema" +description: "" +sidebar_label: "DashboardNativeFiltersConfigUpdateSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"deleted":["string"],"modified":[{}],"reordered":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardpermalinkstateschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardpermalinkstateschema.Schema.json new file mode 100644 index 00000000000..8c62c08d639 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardpermalinkstateschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"activeTabs":{"description":"Current active dashboard tabs","items":{"type":"string"},"nullable":true,"type":"array"},"anchor":{"description":"Optional anchor link added to url hash","nullable":true,"type":"string"},"dataMask":{"description":"Data mask used for native filter state","nullable":true,"type":"object"},"urlParams":{"description":"URL Parameters","items":{"description":"URL Parameter key-value pair","nullable":true},"nullable":true,"type":"array"}},"type":"object","title":"DashboardPermalinkStateSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardpermalinkstateschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardpermalinkstateschema.schema.mdx new file mode 100644 index 00000000000..fdfcf5bd83c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardpermalinkstateschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardpermalinkstateschema +title: "DashboardPermalinkStateSchema" +description: "" +sidebar_label: "DashboardPermalinkStateSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"activeTabs":["string"],"anchor":"string","dataMask":{},"urlParams":[null]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-role.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-role.Schema.json new file mode 100644 index 00000000000..b1c0a94c143 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-role.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"DashboardRestApi.get_list.Role"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-role.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-role.schema.mdx new file mode 100644 index 00000000000..d38cbaf5091 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-role.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardrestapi-get-list-role +title: "DashboardRestApi.get_list.Role" +description: "" +sidebar_label: "DashboardRestApi.get_list.Role" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-tag.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-tag.Schema.json new file mode 100644 index 00000000000..fb70ad2f097 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-tag.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"DashboardRestApi.get_list.Tag"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-tag.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-tag.schema.mdx new file mode 100644 index 00000000000..90d74627b9a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-tag.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardrestapi-get-list-tag +title: "DashboardRestApi.get_list.Tag" +description: "" +sidebar_label: "DashboardRestApi.get_list.Tag" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..089228540de --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DashboardRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..3e1d2e41a2b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardrestapi-get-list-user-1 +title: "DashboardRestApi.get_list.User1" +description: "" +sidebar_label: "DashboardRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-2.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-2.Schema.json new file mode 100644 index 00000000000..effd5c9226e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-2.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DashboardRestApi.get_list.User2"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-2.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-2.schema.mdx new file mode 100644 index 00000000000..f379899f0a1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user-2.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardrestapi-get-list-user-2 +title: "DashboardRestApi.get_list.User2" +description: "" +sidebar_label: "DashboardRestApi.get_list.User2" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..012b50a381f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DashboardRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..0f208e6a111 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardrestapi-get-list-user +title: "DashboardRestApi.get_list.User" +description: "" +sidebar_label: "DashboardRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list.Schema.json new file mode 100644 index 00000000000..43390c6a2c4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DashboardRestApi.get_list.User"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_utc":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DashboardRestApi.get_list.User1"},"created_on_delta_humanized":{"readOnly":true},"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DashboardRestApi.get_list.User2"},"published":{"nullable":true,"type":"boolean"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"DashboardRestApi.get_list.Role"},"slug":{"maxLength":255,"nullable":true,"type":"string"},"status":{"readOnly":true},"tags":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"DashboardRestApi.get_list.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"type":"object","title":"DashboardRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..47b6aeb9c6f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardrestapi-get-list +title: "DashboardRestApi.get_list" +description: "" +sidebar_label: "DashboardRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"certification_details":"string","certified_by":"string","changed_by":{"first_name":"string","id":0,"last_name":"string"},"created_by":{"first_name":"string","id":0,"last_name":"string"},"dashboard_title":"string","id":0,"is_managed_externally":true,"owners":{"first_name":"string","id":0,"last_name":"string"},"published":true,"roles":{"id":0,"name":"string"},"slug":"string","tags":{"id":0,"name":"string"},"uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get.Schema.json new file mode 100644 index 00000000000..63f56e9b4b7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"DashboardRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get.schema.mdx new file mode 100644 index 00000000000..297cc9663c2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardrestapi-get +title: "DashboardRestApi.get" +description: "" +sidebar_label: "DashboardRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-post.Schema.json new file mode 100644 index 00000000000..ea1f2e77065 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-post.Schema.json @@ -0,0 +1 @@ +{"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"}},"type":"object","title":"DashboardRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-post.schema.mdx new file mode 100644 index 00000000000..82f068244ca --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardrestapi-post +title: "DashboardRestApi.post" +description: "" +sidebar_label: "DashboardRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"certification_details":"string","certified_by":"string","css":"string","dashboard_title":"string","external_url":"string","is_managed_externally":true,"json_metadata":"string","owners":[0],"position_json":"string","published":true,"roles":[0],"slug":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-put.Schema.json new file mode 100644 index 00000000000..59fee9165ea --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-put.Schema.json @@ -0,0 +1 @@ +{"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.","nullable":true,"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.","nullable":true,"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.","nullable":true,"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","nullable":true,"type":"string"},"published":{"description":"Determines whether or not this dashboard is visible in the list of all dashboards.","nullable":true,"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.","nullable":true,"type":"integer"},"type":"array"},"slug":{"description":"Unique identifying part for the web address of the dashboard.","maxLength":255,"minLength":0,"nullable":true,"type":"string"},"tags":{"items":{"description":"Tags to be associated with the dashboard","nullable":true,"type":"integer"},"type":"array"}},"type":"object","title":"DashboardRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-put.schema.mdx new file mode 100644 index 00000000000..1857bea13de --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardrestapi-put +title: "DashboardRestApi.put" +description: "" +sidebar_label: "DashboardRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"certification_details":"string","certified_by":"string","css":"string","dashboard_title":"string","external_url":"string","is_managed_externally":true,"json_metadata":"string","owners":[0],"position_json":"string","published":true,"roles":[0],"slug":"string","tags":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardscreenshotpostschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardscreenshotpostschema.Schema.json new file mode 100644 index 00000000000..7d3e7880d58 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardscreenshotpostschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"type":"object","properties":{"dataMask":{"type":"object","description":"An object representing the data mask.","additionalProperties":true},"activeTabs":{"type":"array","items":{"type":"string"},"description":"A list representing active tabs."},"anchor":{"type":"string","description":"A string representing the anchor."},"urlParams":{"type":"array","items":{"type":"array","items":{"type":"string"},"minItems":2,"maxItems":2},"description":"A list of tuples, each containing two strings."}},"title":"DashboardScreenshotPostSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardscreenshotpostschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardscreenshotpostschema.schema.mdx new file mode 100644 index 00000000000..3eba508f25d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardscreenshotpostschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardscreenshotpostschema +title: "DashboardScreenshotPostSchema" +description: "" +sidebar_label: "DashboardScreenshotPostSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"dataMask":{},"activeTabs":["string"],"anchor":"string","urlParams":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-1.Schema.json new file mode 100644 index 00000000000..c419aad4125 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"database_name":{"type":"string"}},"type":"object","title":"Database1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-1.schema.mdx new file mode 100644 index 00000000000..c950a267563 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: database-1 +title: "Database1" +description: "" +sidebar_label: "Database1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"database_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-catalogs-query-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-catalogs-query-schema.Schema.json new file mode 100644 index 00000000000..850c4651f71 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-catalogs-query-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"force":{"type":"boolean"}},"type":"object","title":"database_catalogs_query_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-catalogs-query-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-catalogs-query-schema.schema.mdx new file mode 100644 index 00000000000..a6d1c5ee3d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-catalogs-query-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: database-catalogs-query-schema +title: "database_catalogs_query_schema" +description: "" +sidebar_label: "database_catalogs_query_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"force":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-schemas-query-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-schemas-query-schema.Schema.json new file mode 100644 index 00000000000..056639d7510 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-schemas-query-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog":{"type":"string"},"force":{"type":"boolean"},"upload_allowed":{"type":"boolean"}},"type":"object","title":"database_schemas_query_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-schemas-query-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-schemas-query-schema.schema.mdx new file mode 100644 index 00000000000..799da33b52b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-schemas-query-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: database-schemas-query-schema +title: "database_schemas_query_schema" +description: "" +sidebar_label: "database_schemas_query_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog":"string","force":true,"upload_allowed":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-tables-query-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-tables-query-schema.Schema.json new file mode 100644 index 00000000000..68ca9763b3c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-tables-query-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog_name":{"type":"string"},"force":{"type":"boolean"},"schema_name":{"type":"string"}},"required":["schema_name"],"type":"object","title":"database_tables_query_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-tables-query-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-tables-query-schema.schema.mdx new file mode 100644 index 00000000000..2133972343b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database-tables-query-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: database-tables-query-schema +title: "database_tables_query_schema" +description: "" +sidebar_label: "database_tables_query_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog_name":"string","force":true,"schema_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database.Schema.json new file mode 100644 index 00000000000..2a94efa3e8b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"allow_multi_catalog":{"type":"boolean"},"allows_cost_estimate":{"type":"boolean"},"allows_subquery":{"type":"boolean"},"allows_virtual_table_explore":{"type":"boolean"},"backend":{"type":"string"},"disable_data_preview":{"type":"boolean"},"disable_drill_to_detail":{"type":"boolean"},"explore_database_id":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","title":"Database"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database.schema.mdx new file mode 100644 index 00000000000..b4a96422573 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/database.schema.mdx @@ -0,0 +1,31 @@ +--- +id: database +title: "Database" +description: "" +sidebar_label: "Database" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"allow_multi_catalog":true,"allows_cost_estimate":true,"allows_subquery":true,"allows_virtual_table_explore":true,"backend":"string","disable_data_preview":true,"disable_drill_to_detail":true,"explore_database_id":0,"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseconnectionschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseconnectionschema.Schema.json new file mode 100644 index 00000000000..eb38964ac83 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseconnectionschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"backend":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","type":"string"},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine_information":{"properties":{"disable_ssh_tunneling":{"description":"SSH tunnel is not available to the database","type":"boolean"},"supports_dynamic_catalog":{"description":"The database supports multiple catalogs in a single connection","type":"boolean"},"supports_file_upload":{"description":"Users can upload files to the database","type":"boolean"},"supports_oauth2":{"description":"The database supports OAuth2","type":"boolean"}},"type":"object","title":"EngineInformation"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"id":{"description":"Database ID (for updates)","type":"integer"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"parameters_schema":{"additionalProperties":{},"description":"JSONSchema for configuring the database by parameters instead of SQLAlchemy URI","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"

Refer to the SqlAlchemy docs for more information on how to structure your URI.

","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"type":"object","title":"DatabaseConnectionSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseconnectionschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseconnectionschema.schema.mdx new file mode 100644 index 00000000000..961d2778eb0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseconnectionschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaseconnectionschema +title: "DatabaseConnectionSchema" +description: "" +sidebar_label: "DatabaseConnectionSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"allow_ctas":true,"allow_cvas":true,"allow_dml":true,"allow_file_upload":true,"allow_run_async":true,"backend":"string","cache_timeout":0,"configuration_method":"string","database_name":"string","driver":"string","engine_information":{"disable_ssh_tunneling":true,"supports_dynamic_catalog":true,"supports_file_upload":true,"supports_oauth2":true},"expose_in_sqllab":true,"extra":"string","force_ctas_schema":"string","id":0,"impersonate_user":true,"is_managed_externally":true,"masked_encrypted_extra":"string","parameters":{},"parameters_schema":{},"server_cert":"string","sqlalchemy_uri":"string","ssh_tunnel":{"id":0,"password":"string","private_key":"string","private_key_password":"string","server_address":"string","server_port":0,"username":"string"},"uuid":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasefunctionnamesresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasefunctionnamesresponse.Schema.json new file mode 100644 index 00000000000..1a4d564a906 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasefunctionnamesresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"function_names":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"DatabaseFunctionNamesResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasefunctionnamesresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasefunctionnamesresponse.schema.mdx new file mode 100644 index 00000000000..63c53466de3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasefunctionnamesresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databasefunctionnamesresponse +title: "DatabaseFunctionNamesResponse" +description: "" +sidebar_label: "DatabaseFunctionNamesResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"function_names":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedchart.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedchart.Schema.json new file mode 100644 index 00000000000..c35e194a7c0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedchart.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object","title":"DatabaseRelatedChart"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedchart.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedchart.schema.mdx new file mode 100644 index 00000000000..2577eef04e1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedchart.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaserelatedchart +title: "DatabaseRelatedChart" +description: "" +sidebar_label: "DatabaseRelatedChart" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"slice_name":"string","viz_type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedcharts.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedcharts.Schema.json new file mode 100644 index 00000000000..fb61a12176e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedcharts.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"count":{"description":"Chart count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object","title":"DatabaseRelatedChart"},"type":"array"}},"type":"object","title":"DatabaseRelatedCharts"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedcharts.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedcharts.schema.mdx new file mode 100644 index 00000000000..65f6e931152 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedcharts.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaserelatedcharts +title: "DatabaseRelatedCharts" +description: "" +sidebar_label: "DatabaseRelatedCharts" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"count":0,"result":[{"id":0,"slice_name":"string","viz_type":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboard.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboard.Schema.json new file mode 100644 index 00000000000..8a9c2376d3d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboard.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DatabaseRelatedDashboard"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboard.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboard.schema.mdx new file mode 100644 index 00000000000..5968f0d9274 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboard.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaserelateddashboard +title: "DatabaseRelatedDashboard" +description: "" +sidebar_label: "DatabaseRelatedDashboard" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"json_metadata":{},"slug":"string","title":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboards.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboards.Schema.json new file mode 100644 index 00000000000..f0c2397481c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboards.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"count":{"description":"Dashboard count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DatabaseRelatedDashboard"},"type":"array"}},"type":"object","title":"DatabaseRelatedDashboards"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboards.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboards.schema.mdx new file mode 100644 index 00000000000..82ec4f9d919 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelateddashboards.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaserelateddashboards +title: "DatabaseRelatedDashboards" +description: "" +sidebar_label: "DatabaseRelatedDashboards" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"count":0,"result":[{"id":0,"json_metadata":{},"slug":"string","title":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedobjectsresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedobjectsresponse.Schema.json new file mode 100644 index 00000000000..42d565b2329 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedobjectsresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"charts":{"properties":{"count":{"description":"Chart count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object","title":"DatabaseRelatedChart"},"type":"array"}},"type":"object","title":"DatabaseRelatedCharts"},"dashboards":{"properties":{"count":{"description":"Dashboard count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DatabaseRelatedDashboard"},"type":"array"}},"type":"object","title":"DatabaseRelatedDashboards"}},"type":"object","title":"DatabaseRelatedObjectsResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedobjectsresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedobjectsresponse.schema.mdx new file mode 100644 index 00000000000..54f64731c36 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserelatedobjectsresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaserelatedobjectsresponse +title: "DatabaseRelatedObjectsResponse" +description: "" +sidebar_label: "DatabaseRelatedObjectsResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"charts":{"count":0,"result":[{"id":0,"slice_name":"string","viz_type":"string"}]},"dashboards":{"count":0,"result":[{"id":0,"json_metadata":{},"slug":"string","title":"string"}]}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..001f60fb809 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatabaseRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..bc445e40428 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaserestapi-get-list-user-1 +title: "DatabaseRestApi.get_list.User1" +description: "" +sidebar_label: "DatabaseRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..04c604894fa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatabaseRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..5b3fce3537d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaserestapi-get-list-user +title: "DatabaseRestApi.get_list.User" +description: "" +sidebar_label: "DatabaseRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list.Schema.json new file mode 100644 index 00000000000..82cd427ca9b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"allow_ctas":{"nullable":true,"type":"boolean"},"allow_cvas":{"nullable":true,"type":"boolean"},"allow_dml":{"nullable":true,"type":"boolean"},"allow_file_upload":{"nullable":true,"type":"boolean"},"allow_multi_catalog":{"readOnly":true},"allow_run_async":{"nullable":true,"type":"boolean"},"allows_cost_estimate":{"readOnly":true},"allows_subquery":{"readOnly":true},"allows_virtual_table_explore":{"readOnly":true},"backend":{"readOnly":true},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatabaseRestApi.get_list.User"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatabaseRestApi.get_list.User1"},"database_name":{"maxLength":250,"type":"string"},"disable_data_preview":{"readOnly":true},"disable_drill_to_detail":{"readOnly":true},"engine_information":{"readOnly":true},"explore_database_id":{"readOnly":true},"expose_in_sqllab":{"nullable":true,"type":"boolean"},"extra":{"nullable":true,"type":"string"},"force_ctas_schema":{"maxLength":250,"nullable":true,"type":"string"},"id":{"type":"integer"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["database_name"],"type":"object","title":"DatabaseRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list.schema.mdx new file mode 100644 index 00000000000..ef69305fb44 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaserestapi-get-list +title: "DatabaseRestApi.get_list" +description: "" +sidebar_label: "DatabaseRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"allow_ctas":true,"allow_cvas":true,"allow_dml":true,"allow_file_upload":true,"allow_run_async":true,"changed_by":{"first_name":"string","last_name":"string"},"changed_on":"2024-07-29T15:51:28.071Z","created_by":{"first_name":"string","last_name":"string"},"database_name":"string","expose_in_sqllab":true,"extra":"string","force_ctas_schema":"string","id":0,"uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get.Schema.json new file mode 100644 index 00000000000..c7a4e142a47 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"allow_ctas":{"nullable":true,"type":"boolean"},"allow_cvas":{"nullable":true,"type":"boolean"},"allow_dml":{"nullable":true,"type":"boolean"},"allow_file_upload":{"nullable":true,"type":"boolean"},"allow_run_async":{"nullable":true,"type":"boolean"},"backend":{"readOnly":true},"cache_timeout":{"nullable":true,"type":"integer"},"configuration_method":{"maxLength":255,"nullable":true,"type":"string"},"database_name":{"maxLength":250,"type":"string"},"driver":{"readOnly":true},"engine_information":{"readOnly":true},"expose_in_sqllab":{"nullable":true,"type":"boolean"},"force_ctas_schema":{"maxLength":250,"nullable":true,"type":"string"},"id":{"type":"integer"},"impersonate_user":{"nullable":true,"type":"boolean"},"is_managed_externally":{"type":"boolean"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["database_name"],"type":"object","title":"DatabaseRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get.schema.mdx new file mode 100644 index 00000000000..77ab9596938 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaserestapi-get +title: "DatabaseRestApi.get" +description: "" +sidebar_label: "DatabaseRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"allow_ctas":true,"allow_cvas":true,"allow_dml":true,"allow_file_upload":true,"allow_run_async":true,"cache_timeout":0,"configuration_method":"string","database_name":"string","expose_in_sqllab":true,"force_ctas_schema":"string","id":0,"impersonate_user":true,"is_managed_externally":true,"uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-post.Schema.json new file mode 100644 index 00000000000..f2ee9a6b713 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"

Refer to the SqlAlchemy docs for more information on how to structure your URI.

","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"required":["database_name"],"type":"object","title":"DatabaseRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-post.schema.mdx new file mode 100644 index 00000000000..c3b068ea92f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaserestapi-post +title: "DatabaseRestApi.post" +description: "" +sidebar_label: "DatabaseRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"allow_ctas":true,"allow_cvas":true,"allow_dml":true,"allow_file_upload":true,"allow_run_async":true,"cache_timeout":0,"database_name":"string","driver":"string","engine":"string","expose_in_sqllab":true,"external_url":"string","extra":"string","force_ctas_schema":"string","impersonate_user":true,"is_managed_externally":true,"masked_encrypted_extra":"string","parameters":{},"server_cert":"string","sqlalchemy_uri":"string","ssh_tunnel":{"id":0,"password":"string","private_key":"string","private_key_password":"string","server_address":"string","server_port":0,"username":"string"},"uuid":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-put.Schema.json new file mode 100644 index 00000000000..ce574dbddb5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"

Refer to the SqlAlchemy docs for more information on how to structure your URI.

","maxLength":1024,"minLength":0,"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"type":"object","title":"DatabaseRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-put.schema.mdx new file mode 100644 index 00000000000..17d8d8b3d1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaserestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaserestapi-put +title: "DatabaseRestApi.put" +description: "" +sidebar_label: "DatabaseRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"allow_ctas":true,"allow_cvas":true,"allow_dml":true,"allow_file_upload":true,"allow_run_async":true,"cache_timeout":0,"database_name":"string","driver":"string","engine":"string","expose_in_sqllab":true,"external_url":"string","extra":"string","force_ctas_schema":"string","impersonate_user":true,"is_managed_externally":true,"masked_encrypted_extra":"string","parameters":{},"server_cert":"string","sqlalchemy_uri":"string","ssh_tunnel":{"id":0,"password":"string","private_key":"string","private_key_password":"string","server_address":"string","server_port":0,"username":"string"},"uuid":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseschemaaccessforfileuploadresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseschemaaccessforfileuploadresponse.Schema.json new file mode 100644 index 00000000000..8d70b9294a9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseschemaaccessforfileuploadresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"schemas":{"description":"The list of schemas allowed for the database to upload information","items":{"type":"string"},"type":"array"}},"type":"object","title":"DatabaseSchemaAccessForFileUploadResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseschemaaccessforfileuploadresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseschemaaccessforfileuploadresponse.schema.mdx new file mode 100644 index 00000000000..1904df760d7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databaseschemaaccessforfileuploadresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databaseschemaaccessforfileuploadresponse +title: "DatabaseSchemaAccessForFileUploadResponse" +description: "" +sidebar_label: "DatabaseSchemaAccessForFileUploadResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"schemas":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasesshtunnel.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasesshtunnel.Schema.json new file mode 100644 index 00000000000..88f265a59f6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasesshtunnel.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasesshtunnel.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasesshtunnel.schema.mdx new file mode 100644 index 00000000000..a9b097f1c03 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasesshtunnel.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databasesshtunnel +title: "DatabaseSSHTunnel" +description: "" +sidebar_label: "DatabaseSSHTunnel" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"password":"string","private_key":"string","private_key_password":"string","server_address":"string","server_port":0,"username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetablesresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetablesresponse.Schema.json new file mode 100644 index 00000000000..2760cc003fc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetablesresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"extra":{"description":"Extra data used to specify column metadata","type":"object"},"type":{"description":"table or view","type":"string"},"value":{"description":"The table or view name","type":"string"}},"type":"object","title":"DatabaseTablesResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetablesresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetablesresponse.schema.mdx new file mode 100644 index 00000000000..dd9b0318162 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetablesresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databasetablesresponse +title: "DatabaseTablesResponse" +description: "" +sidebar_label: "DatabaseTablesResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"extra":{},"type":"string","value":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetestconnectionschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetestconnectionschema.Schema.json new file mode 100644 index 00000000000..6f045b8cca3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetestconnectionschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"

Refer to the SqlAlchemy docs for more information on how to structure your URI.

","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true}},"type":"object","title":"DatabaseTestConnectionSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetestconnectionschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetestconnectionschema.schema.mdx new file mode 100644 index 00000000000..207bf5bd665 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasetestconnectionschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databasetestconnectionschema +title: "DatabaseTestConnectionSchema" +description: "" +sidebar_label: "DatabaseTestConnectionSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"database_name":"string","driver":"string","engine":"string","extra":"string","impersonate_user":true,"masked_encrypted_extra":"string","parameters":{},"server_cert":"string","sqlalchemy_uri":"string","ssh_tunnel":{"id":0,"password":"string","private_key":"string","private_key_password":"string","server_address":"string","server_port":0,"username":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasevalidateparametersschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasevalidateparametersschema.Schema.json new file mode 100644 index 00000000000..a1f34aac73e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasevalidateparametersschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog":{"additionalProperties":{"nullable":true},"description":"Gsheets specific column for managing label to sheet urls","type":"object"},"configuration_method":{"description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","type":"string"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"id":{"description":"Database ID (for updates)","nullable":true,"type":"integer"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{"nullable":true},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"}},"required":["configuration_method","engine"],"type":"object","title":"DatabaseValidateParametersSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasevalidateparametersschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasevalidateparametersschema.schema.mdx new file mode 100644 index 00000000000..cd608545ece --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/databasevalidateparametersschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: databasevalidateparametersschema +title: "DatabaseValidateParametersSchema" +description: "" +sidebar_label: "DatabaseValidateParametersSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog":{},"database_name":"string","driver":"string","engine":"string","extra":"string","id":0,"impersonate_user":true,"masked_encrypted_extra":"string","parameters":{},"server_cert":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dataset.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dataset.Schema.json new file mode 100644 index 00000000000..31adc6b9550 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dataset.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this dataset.","type":"integer"},"column_formats":{"description":"Column formats.","type":"object"},"columns":{"description":"Columns metadata.","items":{"type":"object"},"type":"array"},"database":{"description":"Database associated with the dataset.","type":"object"},"datasource_name":{"description":"Dataset name.","type":"string"},"default_endpoint":{"description":"Default endpoint for the dataset.","type":"string"},"description":{"description":"Dataset description.","type":"string"},"edit_url":{"description":"The URL for editing the dataset.","type":"string"},"extra":{"description":"JSON string containing extra configuration elements.","type":"object"},"fetch_values_predicate":{"description":"Predicate used when fetching values from the dataset.","type":"string"},"filter_select":{"description":"SELECT filter applied to the dataset.","type":"boolean"},"filter_select_enabled":{"description":"If the SELECT filter is enabled.","type":"boolean"},"granularity_sqla":{"description":"Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use `granularity` instead.","items":{"items":{"type":"object"},"type":"array"},"type":"array"},"health_check_message":{"description":"Health check message.","type":"string"},"id":{"description":"Dataset ID.","type":"integer"},"is_sqllab_view":{"description":"If the dataset is a SQL Lab view.","type":"boolean"},"main_dttm_col":{"description":"The main temporal column.","type":"string"},"metrics":{"description":"Dataset metrics.","items":{"type":"object"},"type":"array"},"name":{"description":"Dataset name.","type":"string"},"offset":{"description":"Dataset offset.","type":"integer"},"order_by_choices":{"description":"List of order by columns.","items":{"items":{"type":"string"},"type":"array"},"type":"array"},"owners":{"description":"List of owners identifiers","items":{"type":"integer"},"type":"array"},"params":{"description":"Extra params for the dataset.","type":"object"},"perm":{"description":"Permission expression.","type":"string"},"schema":{"description":"Dataset schema.","type":"string"},"select_star":{"description":"Select all clause.","type":"string"},"sql":{"description":"A SQL statement that defines the dataset.","type":"string"},"table_name":{"description":"The name of the table associated with the dataset.","type":"string"},"template_params":{"description":"Table template params.","type":"object"},"time_grain_sqla":{"description":"List of temporal granularities supported by the dataset.","items":{"items":{"type":"string"},"type":"array"},"type":"array"},"type":{"description":"Dataset type.","type":"string"},"uid":{"description":"Dataset unique identifier.","type":"string"},"verbose_map":{"description":"Mapping from raw name to verbose name.","type":"object"}},"type":"object","title":"Dataset"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dataset.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dataset.schema.mdx new file mode 100644 index 00000000000..d4e9aaf3bf1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dataset.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dataset +title: "Dataset" +description: "" +sidebar_label: "Dataset" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":0,"column_formats":{},"columns":[{}],"database":{},"datasource_name":"string","default_endpoint":"string","description":"string","edit_url":"string","extra":{},"fetch_values_predicate":"string","filter_select":true,"filter_select_enabled":true,"granularity_sqla":[{}],"health_check_message":"string","id":0,"is_sqllab_view":true,"main_dttm_col":"string","metrics":[{}],"name":"string","offset":0,"order_by_choices":["string"],"owners":[0],"params":{},"perm":"string","schema":"string","select_star":"string","sql":"string","table_name":"string","template_params":{},"time_grain_sqla":["string"],"type":"string","uid":"string","verbose_map":{}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmuprequestschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmuprequestschema.Schema.json new file mode 100644 index 00000000000..e2305cbc71a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmuprequestschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"dashboard_id":{"description":"The ID of the dashboard to get filters for when warming cache","type":"integer"},"db_name":{"description":"The name of the database where the table is located","type":"string"},"extra_filters":{"description":"Extra filters to apply when warming up cache","type":"string"},"table_name":{"description":"The name of the table to warm up cache for","type":"string"}},"required":["db_name","table_name"],"type":"object","title":"DatasetCacheWarmUpRequestSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmuprequestschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmuprequestschema.schema.mdx new file mode 100644 index 00000000000..f65f0621407 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmuprequestschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetcachewarmuprequestschema +title: "DatasetCacheWarmUpRequestSchema" +description: "" +sidebar_label: "DatasetCacheWarmUpRequestSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"dashboard_id":0,"db_name":"string","extra_filters":"string","table_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponseschema.Schema.json new file mode 100644 index 00000000000..5fc32ba8443 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"result":{"description":"A list of each chart's warmup status and errors if any","items":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object","title":"DatasetCacheWarmUpResponseSingle"},"type":"array"}},"type":"object","title":"DatasetCacheWarmUpResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponseschema.schema.mdx new file mode 100644 index 00000000000..aca03062d25 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetcachewarmupresponseschema +title: "DatasetCacheWarmUpResponseSchema" +description: "" +sidebar_label: "DatasetCacheWarmUpResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"result":[{"chart_id":0,"viz_error":"string","viz_status":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponsesingle.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponsesingle.Schema.json new file mode 100644 index 00000000000..55d4f97b770 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponsesingle.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object","title":"DatasetCacheWarmUpResponseSingle"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponsesingle.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponsesingle.schema.mdx new file mode 100644 index 00000000000..93aaa74cc1e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcachewarmupresponsesingle.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetcachewarmupresponsesingle +title: "DatasetCacheWarmUpResponseSingle" +description: "" +sidebar_label: "DatasetCacheWarmUpResponseSingle" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"chart_id":0,"viz_error":"string","viz_status":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsput.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsput.Schema.json new file mode 100644 index 00000000000..f0373e8ecf9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsput.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"advanced_data_type":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"column_name":{"maxLength":255,"minLength":1,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"filterable":{"type":"boolean"},"groupby":{"type":"boolean"},"id":{"type":"integer"},"is_active":{"nullable":true,"type":"boolean"},"is_dttm":{"nullable":true,"type":"boolean"},"python_date_format":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"}},"required":["column_name"],"type":"object","title":"DatasetColumnsPut"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsput.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsput.schema.mdx new file mode 100644 index 00000000000..87fee5a331c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsput.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetcolumnsput +title: "DatasetColumnsPut" +description: "" +sidebar_label: "DatasetColumnsPut" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"advanced_data_type":"string","column_name":"string","description":"string","expression":"string","extra":"string","filterable":true,"groupby":true,"id":0,"is_active":true,"is_dttm":true,"python_date_format":"string","type":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","verbose_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get-list.Schema.json new file mode 100644 index 00000000000..1129bfea443 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"DatasetColumnsRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..ad3537edced --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetcolumnsrestapi-get-list +title: "DatasetColumnsRestApi.get_list" +description: "" +sidebar_label: "DatasetColumnsRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get.Schema.json new file mode 100644 index 00000000000..d25807a5dc4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"DatasetColumnsRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get.schema.mdx new file mode 100644 index 00000000000..81b7780af9f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetcolumnsrestapi-get +title: "DatasetColumnsRestApi.get" +description: "" +sidebar_label: "DatasetColumnsRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-post.Schema.json new file mode 100644 index 00000000000..b4aa965c783 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"DatasetColumnsRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-post.schema.mdx new file mode 100644 index 00000000000..37742d18440 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetcolumnsrestapi-post +title: "DatasetColumnsRestApi.post" +description: "" +sidebar_label: "DatasetColumnsRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-put.Schema.json new file mode 100644 index 00000000000..9a4b86169a5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"DatasetColumnsRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-put.schema.mdx new file mode 100644 index 00000000000..b689d9eef09 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetcolumnsrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetcolumnsrestapi-put +title: "DatasetColumnsRestApi.put" +description: "" +sidebar_label: "DatasetColumnsRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetduplicateschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetduplicateschema.Schema.json new file mode 100644 index 00000000000..bbaf77db3e8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetduplicateschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"base_model_id":{"type":"integer"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["base_model_id","table_name"],"type":"object","title":"DatasetDuplicateSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetduplicateschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetduplicateschema.schema.mdx new file mode 100644 index 00000000000..e3b34c0a35f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetduplicateschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetduplicateschema +title: "DatasetDuplicateSchema" +description: "" +sidebar_label: "DatasetDuplicateSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"base_model_id":0,"table_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get-list.Schema.json new file mode 100644 index 00000000000..eaa6688e904 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"DatasetMetricRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..3304c9961e1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetmetricrestapi-get-list +title: "DatasetMetricRestApi.get_list" +description: "" +sidebar_label: "DatasetMetricRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get.Schema.json new file mode 100644 index 00000000000..7003228f0c0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"DatasetMetricRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get.schema.mdx new file mode 100644 index 00000000000..3b1caba3401 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetmetricrestapi-get +title: "DatasetMetricRestApi.get" +description: "" +sidebar_label: "DatasetMetricRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-post.Schema.json new file mode 100644 index 00000000000..89cd4ad1823 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"DatasetMetricRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-post.schema.mdx new file mode 100644 index 00000000000..b1da2a10612 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetmetricrestapi-post +title: "DatasetMetricRestApi.post" +description: "" +sidebar_label: "DatasetMetricRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-put.Schema.json new file mode 100644 index 00000000000..fd7b08e3b45 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"DatasetMetricRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-put.schema.mdx new file mode 100644 index 00000000000..8f8d4e36b99 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetmetricrestapi-put +title: "DatasetMetricRestApi.put" +description: "" +sidebar_label: "DatasetMetricRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricsput.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricsput.Schema.json new file mode 100644 index 00000000000..8149799913c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricsput.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"currency":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"d3format":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"type":"string"},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"metric_name":{"maxLength":255,"minLength":1,"type":"string"},"metric_type":{"maxLength":32,"minLength":1,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"},"warning_text":{"nullable":true,"type":"string"}},"required":["expression","metric_name"],"type":"object","title":"DatasetMetricsPut"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricsput.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricsput.schema.mdx new file mode 100644 index 00000000000..36d468fc161 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetricsput.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetmetricsput +title: "DatasetMetricsPut" +description: "" +sidebar_label: "DatasetMetricsPut" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"currency":"string","d3format":"string","description":"string","expression":"string","extra":"string","id":0,"metric_name":"string","metric_type":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","verbose_name":"string","warning_text":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedchart.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedchart.Schema.json new file mode 100644 index 00000000000..7d496c6c138 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedchart.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object","title":"DatasetRelatedChart"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedchart.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedchart.schema.mdx new file mode 100644 index 00000000000..93c286f2bd9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedchart.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrelatedchart +title: "DatasetRelatedChart" +description: "" +sidebar_label: "DatasetRelatedChart" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"slice_name":"string","viz_type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedcharts.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedcharts.Schema.json new file mode 100644 index 00000000000..1df6f841af2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedcharts.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"count":{"description":"Chart count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object","title":"DatasetRelatedChart"},"type":"array"}},"type":"object","title":"DatasetRelatedCharts"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedcharts.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedcharts.schema.mdx new file mode 100644 index 00000000000..8c39757dc9d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedcharts.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrelatedcharts +title: "DatasetRelatedCharts" +description: "" +sidebar_label: "DatasetRelatedCharts" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"count":0,"result":[{"id":0,"slice_name":"string","viz_type":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboard.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboard.Schema.json new file mode 100644 index 00000000000..a98115efb68 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboard.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DatasetRelatedDashboard"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboard.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboard.schema.mdx new file mode 100644 index 00000000000..341e644a7c7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboard.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrelateddashboard +title: "DatasetRelatedDashboard" +description: "" +sidebar_label: "DatasetRelatedDashboard" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"json_metadata":{},"slug":"string","title":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboards.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboards.Schema.json new file mode 100644 index 00000000000..910754ef120 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboards.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"count":{"description":"Dashboard count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DatasetRelatedDashboard"},"type":"array"}},"type":"object","title":"DatasetRelatedDashboards"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboards.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboards.schema.mdx new file mode 100644 index 00000000000..fc5280eb1d5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelateddashboards.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrelateddashboards +title: "DatasetRelatedDashboards" +description: "" +sidebar_label: "DatasetRelatedDashboards" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"count":0,"result":[{"id":0,"json_metadata":{},"slug":"string","title":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedobjectsresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedobjectsresponse.Schema.json new file mode 100644 index 00000000000..9183f049e98 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedobjectsresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"charts":{"properties":{"count":{"description":"Chart count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object","title":"DatasetRelatedChart"},"type":"array"}},"type":"object","title":"DatasetRelatedCharts"},"dashboards":{"properties":{"count":{"description":"Dashboard count","type":"integer"},"result":{"description":"A list of dashboards","items":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DatasetRelatedDashboard"},"type":"array"}},"type":"object","title":"DatasetRelatedDashboards"}},"type":"object","title":"DatasetRelatedObjectsResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedobjectsresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedobjectsresponse.schema.mdx new file mode 100644 index 00000000000..0930d20d50e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrelatedobjectsresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrelatedobjectsresponse +title: "DatasetRelatedObjectsResponse" +description: "" +sidebar_label: "DatasetRelatedObjectsResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"charts":{"count":0,"result":[{"id":0,"slice_name":"string","viz_type":"string"}]},"dashboards":{"count":0,"result":[{"id":0,"json_metadata":{},"slug":"string","title":"string"}]}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-database.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-database.Schema.json new file mode 100644 index 00000000000..01f91fcd52b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-database.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"allow_multi_catalog":{"readOnly":true},"backend":{"readOnly":true},"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"DatasetRestApi.get.Database"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-database.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-database.schema.mdx new file mode 100644 index 00000000000..e94453d7d8d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-database.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-get-database +title: "DatasetRestApi.get.Database" +description: "" +sidebar_label: "DatasetRestApi.get.Database" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"database_name":"string","id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-database.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-database.Schema.json new file mode 100644 index 00000000000..930fcddbd2b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-database.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"DatasetRestApi.get_list.Database"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-database.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-database.schema.mdx new file mode 100644 index 00000000000..5887820dc91 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-database.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-get-list-database +title: "DatasetRestApi.get_list.Database" +description: "" +sidebar_label: "DatasetRestApi.get_list.Database" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"database_name":"string","id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..9bb7d5cea4c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..490ca145e78 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-get-list-user-1 +title: "DatasetRestApi.get_list.User1" +description: "" +sidebar_label: "DatasetRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..11e1e70d665 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..9309ecb3dbc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-get-list-user +title: "DatasetRestApi.get_list.User" +description: "" +sidebar_label: "DatasetRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list.Schema.json new file mode 100644 index 00000000000..4e14375e5cb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get_list.User"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_utc":{"readOnly":true},"database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"DatasetRestApi.get_list.Database"},"datasource_type":{"readOnly":true},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"explore_url":{"readOnly":true},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"kind":{"readOnly":true},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get_list.User1"},"schema":{"maxLength":255,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["database","table_name"],"type":"object","title":"DatasetRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..991b1ee843a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-get-list +title: "DatasetRestApi.get_list" +description: "" +sidebar_label: "DatasetRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog":"string","changed_by":{"first_name":"string","id":0,"last_name":"string"},"database":{"database_name":"string","id":0},"default_endpoint":"string","description":"string","extra":"string","id":0,"owners":{"first_name":"string","id":0,"last_name":"string"},"schema":"string","sql":"string","table_name":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-sqlmetric.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-sqlmetric.Schema.json new file mode 100644 index 00000000000..0fda7b2eea9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-sqlmetric.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"currency":{"nullable":true},"d3format":{"maxLength":128,"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"type":"string"},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"metric_name":{"maxLength":255,"type":"string"},"metric_type":{"maxLength":32,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"maxLength":1024,"nullable":true,"type":"string"},"warning_text":{"nullable":true,"type":"string"}},"required":["expression","metric_name"],"type":"object","title":"DatasetRestApi.get.SqlMetric"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-sqlmetric.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-sqlmetric.schema.mdx new file mode 100644 index 00000000000..28dca4f43c5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-sqlmetric.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-get-sqlmetric +title: "DatasetRestApi.get.SqlMetric" +description: "" +sidebar_label: "DatasetRestApi.get.SqlMetric" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_on":"2024-07-29T15:51:28.071Z","created_on":"2024-07-29T15:51:28.071Z","d3format":"string","description":"string","expression":"string","extra":"string","id":0,"metric_name":"string","metric_type":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","verbose_name":"string","warning_text":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-tablecolumn.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-tablecolumn.Schema.json new file mode 100644 index 00000000000..4f5c88800e6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-tablecolumn.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"advanced_data_type":{"maxLength":255,"nullable":true,"type":"string"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"column_name":{"maxLength":255,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"filterable":{"nullable":true,"type":"boolean"},"groupby":{"nullable":true,"type":"boolean"},"id":{"type":"integer"},"is_active":{"nullable":true,"type":"boolean"},"is_dttm":{"nullable":true,"type":"boolean"},"python_date_format":{"maxLength":255,"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"type_generic":{"readOnly":true},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"maxLength":1024,"nullable":true,"type":"string"}},"required":["column_name"],"type":"object","title":"DatasetRestApi.get.TableColumn"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-tablecolumn.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-tablecolumn.schema.mdx new file mode 100644 index 00000000000..2304dffb6db --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-tablecolumn.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-get-tablecolumn +title: "DatasetRestApi.get.TableColumn" +description: "" +sidebar_label: "DatasetRestApi.get.TableColumn" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"advanced_data_type":"string","changed_on":"2024-07-29T15:51:28.071Z","column_name":"string","created_on":"2024-07-29T15:51:28.071Z","description":"string","expression":"string","extra":"string","filterable":true,"groupby":true,"id":0,"is_active":true,"is_dttm":true,"python_date_format":"string","type":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","verbose_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-1.Schema.json new file mode 100644 index 00000000000..74a377d1527 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-1.schema.mdx new file mode 100644 index 00000000000..6b2ce6fd07b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-get-user-1 +title: "DatasetRestApi.get.User1" +description: "" +sidebar_label: "DatasetRestApi.get.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-2.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-2.Schema.json new file mode 100644 index 00000000000..9ac4d21c6e7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-2.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get.User2"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-2.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-2.schema.mdx new file mode 100644 index 00000000000..81716fdf129 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user-2.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-get-user-2 +title: "DatasetRestApi.get.User2" +description: "" +sidebar_label: "DatasetRestApi.get.User2" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user.Schema.json new file mode 100644 index 00000000000..74bdc928bda --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user.schema.mdx new file mode 100644 index 00000000000..6bd6c41e809 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-get-user +title: "DatasetRestApi.get.User" +description: "" +sidebar_label: "DatasetRestApi.get.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get.Schema.json new file mode 100644 index 00000000000..812c9a91881 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"always_filter_main_dttm":{"nullable":true,"type":"boolean"},"cache_timeout":{"nullable":true,"type":"integer"},"catalog":{"maxLength":256,"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get.User2"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_humanized":{"readOnly":true},"column_formats":{"readOnly":true},"columns":{"properties":{"advanced_data_type":{"maxLength":255,"nullable":true,"type":"string"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"column_name":{"maxLength":255,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"filterable":{"nullable":true,"type":"boolean"},"groupby":{"nullable":true,"type":"boolean"},"id":{"type":"integer"},"is_active":{"nullable":true,"type":"boolean"},"is_dttm":{"nullable":true,"type":"boolean"},"python_date_format":{"maxLength":255,"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"type_generic":{"readOnly":true},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"maxLength":1024,"nullable":true,"type":"string"}},"required":["column_name"],"type":"object","title":"DatasetRestApi.get.TableColumn"},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get.User1"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"created_on_humanized":{"readOnly":true},"database":{"properties":{"allow_multi_catalog":{"readOnly":true},"backend":{"readOnly":true},"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"DatasetRestApi.get.Database"},"datasource_name":{"readOnly":true},"datasource_type":{"readOnly":true},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"fetch_values_predicate":{"nullable":true,"type":"string"},"filter_select_enabled":{"nullable":true,"type":"boolean"},"folders":{"nullable":true},"granularity_sqla":{"readOnly":true},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"is_sqllab_view":{"nullable":true,"type":"boolean"},"kind":{"readOnly":true},"main_dttm_col":{"maxLength":250,"nullable":true,"type":"string"},"metrics":{"properties":{"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"currency":{"nullable":true},"d3format":{"maxLength":128,"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"type":"string"},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"metric_name":{"maxLength":255,"type":"string"},"metric_type":{"maxLength":32,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"maxLength":1024,"nullable":true,"type":"string"},"warning_text":{"nullable":true,"type":"string"}},"required":["expression","metric_name"],"type":"object","title":"DatasetRestApi.get.SqlMetric"},"name":{"readOnly":true},"normalize_columns":{"nullable":true,"type":"boolean"},"offset":{"nullable":true,"type":"integer"},"order_by_choices":{"readOnly":true},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"DatasetRestApi.get.User"},"schema":{"maxLength":255,"nullable":true,"type":"string"},"select_star":{"readOnly":true},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"},"template_params":{"nullable":true,"type":"string"},"time_grain_sqla":{"readOnly":true},"uid":{"readOnly":true},"url":{"readOnly":true},"verbose_map":{"readOnly":true}},"required":["columns","database","metrics","table_name"],"type":"object","title":"DatasetRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get.schema.mdx new file mode 100644 index 00000000000..7e2278cf5b5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-get +title: "DatasetRestApi.get" +description: "" +sidebar_label: "DatasetRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"always_filter_main_dttm":true,"cache_timeout":0,"catalog":"string","changed_by":{"first_name":"string","last_name":"string"},"changed_on":"2024-07-29T15:51:28.071Z","columns":{"advanced_data_type":"string","changed_on":"2024-07-29T15:51:28.071Z","column_name":"string","created_on":"2024-07-29T15:51:28.071Z","description":"string","expression":"string","extra":"string","filterable":true,"groupby":true,"id":0,"is_active":true,"is_dttm":true,"python_date_format":"string","type":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","verbose_name":"string"},"created_by":{"first_name":"string","last_name":"string"},"created_on":"2024-07-29T15:51:28.071Z","database":{"database_name":"string","id":0},"default_endpoint":"string","description":"string","extra":"string","fetch_values_predicate":"string","filter_select_enabled":true,"id":0,"is_managed_externally":true,"is_sqllab_view":true,"main_dttm_col":"string","metrics":{"changed_on":"2024-07-29T15:51:28.071Z","created_on":"2024-07-29T15:51:28.071Z","d3format":"string","description":"string","expression":"string","extra":"string","id":0,"metric_name":"string","metric_type":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","verbose_name":"string","warning_text":"string"},"normalize_columns":true,"offset":0,"owners":{"first_name":"string","id":0,"last_name":"string"},"schema":"string","sql":"string","table_name":"string","template_params":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-post.Schema.json new file mode 100644 index 00000000000..788449052a5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"always_filter_main_dttm":{"default":false,"type":"boolean"},"catalog":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"database":{"type":"integer"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"normalize_columns":{"default":false,"type":"boolean"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["database","table_name"],"type":"object","title":"DatasetRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-post.schema.mdx new file mode 100644 index 00000000000..0aebec02405 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-post +title: "DatasetRestApi.post" +description: "" +sidebar_label: "DatasetRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"always_filter_main_dttm":false,"catalog":"string","database":0,"external_url":"string","is_managed_externally":true,"normalize_columns":false,"owners":[0],"schema":"string","sql":"string","table_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-put.Schema.json new file mode 100644 index 00000000000..7a3c40f389c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"always_filter_main_dttm":{"default":false,"type":"boolean"},"cache_timeout":{"nullable":true,"type":"integer"},"catalog":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"columns":{"items":{"properties":{"advanced_data_type":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"column_name":{"maxLength":255,"minLength":1,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"filterable":{"type":"boolean"},"groupby":{"type":"boolean"},"id":{"type":"integer"},"is_active":{"nullable":true,"type":"boolean"},"is_dttm":{"nullable":true,"type":"boolean"},"python_date_format":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"}},"required":["column_name"],"type":"object","title":"DatasetColumnsPut"},"type":"array"},"database_id":{"type":"integer"},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"fetch_values_predicate":{"maxLength":1000,"minLength":0,"nullable":true,"type":"string"},"filter_select_enabled":{"nullable":true,"type":"boolean"},"folders":{"items":{"properties":{"children":{"items":"circular(Folder)","nullable":true,"type":"array"},"description":{"maxLength":1000,"minLength":0,"nullable":true,"type":"string"},"name":{"maxLength":250,"minLength":1,"type":"string"},"type":{"enum":["metric","column","folder"],"type":"string"},"uuid":{"format":"uuid","type":"string"}},"required":["uuid"],"type":"object","title":"Folder"},"type":"array"},"is_managed_externally":{"nullable":true,"type":"boolean"},"is_sqllab_view":{"nullable":true,"type":"boolean"},"main_dttm_col":{"nullable":true,"type":"string"},"metrics":{"items":{"properties":{"currency":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"d3format":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"type":"string"},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"metric_name":{"maxLength":255,"minLength":1,"type":"string"},"metric_type":{"maxLength":32,"minLength":1,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"},"warning_text":{"nullable":true,"type":"string"}},"required":["expression","metric_name"],"type":"object","title":"DatasetMetricsPut"},"type":"array"},"normalize_columns":{"nullable":true,"type":"boolean"},"offset":{"nullable":true,"type":"integer"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"nullable":true,"type":"string"},"template_params":{"nullable":true,"type":"string"}},"type":"object","title":"DatasetRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-put.schema.mdx new file mode 100644 index 00000000000..8dfeb5757c5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetrestapi-put +title: "DatasetRestApi.put" +description: "" +sidebar_label: "DatasetRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"always_filter_main_dttm":false,"cache_timeout":0,"catalog":"string","columns":[{"advanced_data_type":"string","column_name":"string","description":"string","expression":"string","extra":"string","filterable":true,"groupby":true,"id":0,"is_active":true,"is_dttm":true,"python_date_format":"string","type":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","verbose_name":"string"}],"database_id":0,"default_endpoint":"string","description":"string","external_url":"string","extra":"string","fetch_values_predicate":"string","filter_select_enabled":true,"folders":[{"children":[null],"description":"string","name":"string","type":"metric","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}],"is_managed_externally":true,"is_sqllab_view":true,"main_dttm_col":"string","metrics":[{"currency":"string","d3format":"string","description":"string","expression":"string","extra":"string","id":0,"metric_name":"string","metric_type":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","verbose_name":"string","warning_text":"string"}],"normalize_columns":true,"offset":0,"owners":[0],"schema":"string","sql":"string","table_name":"string","template_params":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasource.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasource.Schema.json new file mode 100644 index 00000000000..7fbe4ac3b3f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasource.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog":{"description":"Datasource catalog","nullable":true,"type":"string"},"database_name":{"description":"Datasource name","type":"string"},"datasource_name":{"description":"The datasource name.","type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"type":"string"},"schema":{"description":"Datasource schema","type":"string"}},"required":["datasource_type"],"type":"object","title":"Datasource"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasource.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasource.schema.mdx new file mode 100644 index 00000000000..01f67e5cbd8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasource.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasource +title: "Datasource" +description: "" +sidebar_label: "Datasource" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog":"string","database_name":"string","datasource_name":"string","datasource_type":"table","schema":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/delete-tags-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/delete-tags-schema.Schema.json new file mode 100644 index 00000000000..7cf23caa11b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/delete-tags-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"items":{"type":"string"},"type":"array","title":"delete_tags_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/delete-tags-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/delete-tags-schema.schema.mdx new file mode 100644 index 00000000000..7fe5d60eea2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/delete-tags-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: delete-tags-schema +title: "delete_tags_schema" +description: "" +sidebar_label: "delete_tags_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: ["string"] +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distincresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distincresponseschema.Schema.json new file mode 100644 index 00000000000..c71e77bc20f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distincresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"count":{"description":"The total number of distinct values","type":"integer"},"result":{"items":{"properties":{"text":{"description":"The distinct item","type":"string"}},"type":"object","title":"DistinctResultResponse"},"type":"array"}},"type":"object","title":"DistincResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distincresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distincresponseschema.schema.mdx new file mode 100644 index 00000000000..d56dafcc52b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distincresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: distincresponseschema +title: "DistincResponseSchema" +description: "" +sidebar_label: "DistincResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"count":0,"result":[{"text":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distinctresultresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distinctresultresponse.Schema.json new file mode 100644 index 00000000000..c4f2af9416d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distinctresultresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"text":{"description":"The distinct item","type":"string"}},"type":"object","title":"DistinctResultResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distinctresultresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distinctresultresponse.schema.mdx new file mode 100644 index 00000000000..a0748304ce2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/distinctresultresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: distinctresultresponse +title: "DistinctResultResponse" +description: "" +sidebar_label: "DistinctResultResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"text":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardconfig.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardconfig.Schema.json new file mode 100644 index 00000000000..2e97b4ad085 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardconfig.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"}},"required":["allowed_domains"],"type":"object","title":"EmbeddedDashboardConfig"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardconfig.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardconfig.schema.mdx new file mode 100644 index 00000000000..8170ba6a3eb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardconfig.schema.mdx @@ -0,0 +1,31 @@ +--- +id: embeddeddashboardconfig +title: "EmbeddedDashboardConfig" +description: "" +sidebar_label: "EmbeddedDashboardConfig" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"allowed_domains":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardresponseschema.Schema.json new file mode 100644 index 00000000000..793e688b2c0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"},"changed_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User1"},"changed_on":{"format":"date-time","type":"string"},"dashboard_id":{"type":"string"},"uuid":{"type":"string"}},"type":"object","title":"EmbeddedDashboardResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardresponseschema.schema.mdx new file mode 100644 index 00000000000..c1bc89b3c2c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: embeddeddashboardresponseschema +title: "EmbeddedDashboardResponseSchema" +description: "" +sidebar_label: "EmbeddedDashboardResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"allowed_domains":["string"],"changed_by":{"first_name":"string","id":0,"last_name":"string","username":"string"},"changed_on":"2024-07-29T15:51:28.071Z","dashboard_id":"string","uuid":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get-list.Schema.json new file mode 100644 index 00000000000..910b706d1ac --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object","title":"EmbeddedDashboardRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..4e2d0dacabf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: embeddeddashboardrestapi-get-list +title: "EmbeddedDashboardRestApi.get_list" +description: "" +sidebar_label: "EmbeddedDashboardRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get.Schema.json new file mode 100644 index 00000000000..02c00d6f328 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object","title":"EmbeddedDashboardRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get.schema.mdx new file mode 100644 index 00000000000..bb0ccfa562d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: embeddeddashboardrestapi-get +title: "EmbeddedDashboardRestApi.get" +description: "" +sidebar_label: "EmbeddedDashboardRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-post.Schema.json new file mode 100644 index 00000000000..a48e7479bcd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object","title":"EmbeddedDashboardRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-post.schema.mdx new file mode 100644 index 00000000000..780a6a2b243 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: embeddeddashboardrestapi-post +title: "EmbeddedDashboardRestApi.post" +description: "" +sidebar_label: "EmbeddedDashboardRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-put.Schema.json new file mode 100644 index 00000000000..e8ac453d4f3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object","title":"EmbeddedDashboardRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-put.schema.mdx new file mode 100644 index 00000000000..4a0e8c81c14 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/embeddeddashboardrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: embeddeddashboardrestapi-put +title: "EmbeddedDashboardRestApi.put" +description: "" +sidebar_label: "EmbeddedDashboardRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/engineinformation.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/engineinformation.Schema.json new file mode 100644 index 00000000000..3ec38777a62 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/engineinformation.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"disable_ssh_tunneling":{"description":"SSH tunnel is not available to the database","type":"boolean"},"supports_dynamic_catalog":{"description":"The database supports multiple catalogs in a single connection","type":"boolean"},"supports_file_upload":{"description":"Users can upload files to the database","type":"boolean"},"supports_oauth2":{"description":"The database supports OAuth2","type":"boolean"}},"type":"object","title":"EngineInformation"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/engineinformation.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/engineinformation.schema.mdx new file mode 100644 index 00000000000..8c31385656d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/engineinformation.schema.mdx @@ -0,0 +1,31 @@ +--- +id: engineinformation +title: "EngineInformation" +description: "" +sidebar_label: "EngineInformation" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"disable_ssh_tunneling":true,"supports_dynamic_catalog":true,"supports_file_upload":true,"supports_oauth2":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/estimatequerycostschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/estimatequerycostschema.Schema.json new file mode 100644 index 00000000000..a4239d23f49 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/estimatequerycostschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog":{"description":"The database catalog","nullable":true,"type":"string"},"database_id":{"description":"The database id","type":"integer"},"schema":{"description":"The database schema","nullable":true,"type":"string"},"sql":{"description":"The SQL query to estimate","type":"string"},"template_params":{"description":"The SQL query template params","type":"object"}},"required":["database_id","sql"],"type":"object","title":"EstimateQueryCostSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/estimatequerycostschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/estimatequerycostschema.schema.mdx new file mode 100644 index 00000000000..6ed7e3e77e8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/estimatequerycostschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: estimatequerycostschema +title: "EstimateQueryCostSchema" +description: "" +sidebar_label: "EstimateQueryCostSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog":"string","database_id":0,"schema":"string","sql":"string","template_params":{}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/executepayloadschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/executepayloadschema.Schema.json new file mode 100644 index 00000000000..cb55b1c7d52 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/executepayloadschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog":{"nullable":true,"type":"string"},"client_id":{"nullable":true,"type":"string"},"ctas_method":{"nullable":true,"type":"string"},"database_id":{"type":"integer"},"expand_data":{"nullable":true,"type":"boolean"},"json":{"nullable":true,"type":"boolean"},"queryLimit":{"nullable":true,"type":"integer"},"runAsync":{"nullable":true,"type":"boolean"},"schema":{"nullable":true,"type":"string"},"select_as_cta":{"nullable":true,"type":"boolean"},"sql":{"type":"string"},"sql_editor_id":{"nullable":true,"type":"string"},"tab":{"nullable":true,"type":"string"},"templateParams":{"nullable":true,"type":"string"},"tmp_table_name":{"nullable":true,"type":"string"}},"required":["database_id","sql"],"type":"object","title":"ExecutePayloadSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/executepayloadschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/executepayloadschema.schema.mdx new file mode 100644 index 00000000000..cd481bd965a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/executepayloadschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: executepayloadschema +title: "ExecutePayloadSchema" +description: "" +sidebar_label: "ExecutePayloadSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog":"string","client_id":"string","ctas_method":"string","database_id":0,"expand_data":true,"json":true,"queryLimit":0,"runAsync":true,"schema":"string","select_as_cta":true,"sql":"string","sql_editor_id":"string","tab":"string","templateParams":"string","tmp_table_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorecontextschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorecontextschema.Schema.json new file mode 100644 index 00000000000..58498c744a1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorecontextschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"dataset":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this dataset.","type":"integer"},"column_formats":{"description":"Column formats.","type":"object"},"columns":{"description":"Columns metadata.","items":{"type":"object"},"type":"array"},"database":{"description":"Database associated with the dataset.","type":"object"},"datasource_name":{"description":"Dataset name.","type":"string"},"default_endpoint":{"description":"Default endpoint for the dataset.","type":"string"},"description":{"description":"Dataset description.","type":"string"},"edit_url":{"description":"The URL for editing the dataset.","type":"string"},"extra":{"description":"JSON string containing extra configuration elements.","type":"object"},"fetch_values_predicate":{"description":"Predicate used when fetching values from the dataset.","type":"string"},"filter_select":{"description":"SELECT filter applied to the dataset.","type":"boolean"},"filter_select_enabled":{"description":"If the SELECT filter is enabled.","type":"boolean"},"granularity_sqla":{"description":"Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use `granularity` instead.","items":{"items":{"type":"object"},"type":"array"},"type":"array"},"health_check_message":{"description":"Health check message.","type":"string"},"id":{"description":"Dataset ID.","type":"integer"},"is_sqllab_view":{"description":"If the dataset is a SQL Lab view.","type":"boolean"},"main_dttm_col":{"description":"The main temporal column.","type":"string"},"metrics":{"description":"Dataset metrics.","items":{"type":"object"},"type":"array"},"name":{"description":"Dataset name.","type":"string"},"offset":{"description":"Dataset offset.","type":"integer"},"order_by_choices":{"description":"List of order by columns.","items":{"items":{"type":"string"},"type":"array"},"type":"array"},"owners":{"description":"List of owners identifiers","items":{"type":"integer"},"type":"array"},"params":{"description":"Extra params for the dataset.","type":"object"},"perm":{"description":"Permission expression.","type":"string"},"schema":{"description":"Dataset schema.","type":"string"},"select_star":{"description":"Select all clause.","type":"string"},"sql":{"description":"A SQL statement that defines the dataset.","type":"string"},"table_name":{"description":"The name of the table associated with the dataset.","type":"string"},"template_params":{"description":"Table template params.","type":"object"},"time_grain_sqla":{"description":"List of temporal granularities supported by the dataset.","items":{"items":{"type":"string"},"type":"array"},"type":"array"},"type":{"description":"Dataset type.","type":"string"},"uid":{"description":"Dataset unique identifier.","type":"string"},"verbose_map":{"description":"Mapping from raw name to verbose name.","type":"object"}},"type":"object","title":"Dataset"},"form_data":{"description":"Form data from the Explore controls used to form the chart's data query.","type":"object"},"message":{"description":"Any message related to the processed request.","type":"string"},"slice":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart.","type":"integer"},"certification_details":{"description":"Details of the certification.","type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard.","type":"string"},"changed_on":{"description":"Timestamp of the last modification.","format":"date-time","type":"string"},"changed_on_humanized":{"description":"Timestamp of the last modification in human readable form.","type":"string"},"datasource":{"description":"Datasource identifier.","type":"string"},"description":{"description":"Slice description.","type":"string"},"description_markeddown":{"description":"Sanitized HTML version of the chart description.","type":"string"},"edit_url":{"description":"The URL for editing the slice.","type":"string"},"form_data":{"description":"Form data associated with the slice.","type":"object"},"is_managed_externally":{"description":"If the chart is managed outside externally.","type":"boolean"},"modified":{"description":"Last modification in human readable form.","type":"string"},"owners":{"description":"Owners identifiers.","items":{"type":"integer"},"type":"array"},"query_context":{"description":"The context associated with the query.","type":"object"},"slice_id":{"description":"The slice ID.","type":"integer"},"slice_name":{"description":"The slice name.","type":"string"},"slice_url":{"description":"The slice URL.","type":"string"}},"type":"object","title":"Slice"}},"type":"object","title":"ExploreContextSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorecontextschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorecontextschema.schema.mdx new file mode 100644 index 00000000000..d094343132d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorecontextschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: explorecontextschema +title: "ExploreContextSchema" +description: "" +sidebar_label: "ExploreContextSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"dataset":{"cache_timeout":0,"column_formats":{},"columns":[{}],"database":{},"datasource_name":"string","default_endpoint":"string","description":"string","edit_url":"string","extra":{},"fetch_values_predicate":"string","filter_select":true,"filter_select_enabled":true,"granularity_sqla":[{}],"health_check_message":"string","id":0,"is_sqllab_view":true,"main_dttm_col":"string","metrics":[{}],"name":"string","offset":0,"order_by_choices":["string"],"owners":[0],"params":{},"perm":"string","schema":"string","select_star":"string","sql":"string","table_name":"string","template_params":{},"time_grain_sqla":["string"],"type":"string","uid":"string","verbose_map":{}},"form_data":{},"message":"string","slice":{"cache_timeout":0,"certification_details":"string","certified_by":"string","changed_on":"2024-07-29T15:51:28.071Z","changed_on_humanized":"string","datasource":"string","description":"string","description_markeddown":"string","edit_url":"string","form_data":{},"is_managed_externally":true,"modified":"string","owners":[0],"query_context":{},"slice_id":0,"slice_name":"string","slice_url":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorepermalinkstateschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorepermalinkstateschema.Schema.json new file mode 100644 index 00000000000..e8eaebf6d70 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorepermalinkstateschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"formData":{"description":"Chart form data","type":"object"},"urlParams":{"description":"URL Parameters","items":{"description":"URL Parameter key-value pair","nullable":true},"nullable":true,"type":"array"}},"required":["formData"],"type":"object","title":"ExplorePermalinkStateSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorepermalinkstateschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorepermalinkstateschema.schema.mdx new file mode 100644 index 00000000000..9219af037b0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/explorepermalinkstateschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: explorepermalinkstateschema +title: "ExplorePermalinkStateSchema" +description: "" +sidebar_label: "ExplorePermalinkStateSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"formData":{},"urlParams":[null]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/folder.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/folder.Schema.json new file mode 100644 index 00000000000..db885883af2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/folder.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"children":{"items":"circular(Folder)","nullable":true,"type":"array"},"description":{"maxLength":1000,"minLength":0,"nullable":true,"type":"string"},"name":{"maxLength":250,"minLength":1,"type":"string"},"type":{"enum":["metric","column","folder"],"type":"string"},"uuid":{"format":"uuid","type":"string"}},"required":["uuid"],"type":"object","title":"Folder"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/folder.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/folder.schema.mdx new file mode 100644 index 00000000000..05e9e2c4e2b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/folder.schema.mdx @@ -0,0 +1,31 @@ +--- +id: folder +title: "Folder" +description: "" +sidebar_label: "Folder" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"children":[null],"description":"string","name":"string","type":"metric","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formatquerypayloadschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formatquerypayloadschema.Schema.json new file mode 100644 index 00000000000..6506ef030e6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formatquerypayloadschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"type":"object","required":["sql"],"properties":{"sql":{"type":"string","description":"The SQL query to format."},"engine":{"type":"string","nullable":true,"description":"The database engine."},"database_id":{"type":"integer","nullable":true,"description":"The database id."},"template_params":{"type":"string","nullable":true,"description":"The SQL query template params as JSON string."}},"title":"FormatQueryPayloadSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formatquerypayloadschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formatquerypayloadschema.schema.mdx new file mode 100644 index 00000000000..37627883769 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formatquerypayloadschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: formatquerypayloadschema +title: "FormatQueryPayloadSchema" +description: "" +sidebar_label: "FormatQueryPayloadSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"sql":"string","engine":"string","database_id":0,"template_params":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdatapostschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdatapostschema.Schema.json new file mode 100644 index 00000000000..e72eac205a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdatapostschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"chart_id":{"description":"The chart ID","type":"integer"},"datasource_id":{"description":"The datasource ID","type":"integer"},"datasource_type":{"description":"The datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"},"form_data":{"description":"Any type of JSON supported text.","type":"string"}},"required":["datasource_id","datasource_type","form_data"],"type":"object","title":"FormDataPostSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdatapostschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdatapostschema.schema.mdx new file mode 100644 index 00000000000..30eda684032 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdatapostschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: formdatapostschema +title: "FormDataPostSchema" +description: "" +sidebar_label: "FormDataPostSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"chart_id":0,"datasource_id":0,"datasource_type":"table","form_data":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdataputschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdataputschema.Schema.json new file mode 100644 index 00000000000..ac27c9ecd9d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdataputschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"chart_id":{"description":"The chart ID","type":"integer"},"datasource_id":{"description":"The datasource ID","type":"integer"},"datasource_type":{"description":"The datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"},"form_data":{"description":"Any type of JSON supported text.","type":"string"}},"required":["datasource_id","datasource_type","form_data"],"type":"object","title":"FormDataPutSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdataputschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdataputschema.schema.mdx new file mode 100644 index 00000000000..bca88e9b9aa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/formdataputschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: formdataputschema +title: "FormDataPutSchema" +description: "" +sidebar_label: "FormDataPutSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"chart_id":0,"datasource_id":0,"datasource_type":"table","form_data":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-delete-ids-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-delete-ids-schema.Schema.json new file mode 100644 index 00000000000..e132abf852a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-delete-ids-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-delete-ids-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-delete-ids-schema.schema.mdx new file mode 100644 index 00000000000..2e289347259 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-delete-ids-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: get-delete-ids-schema +title: "get_delete_ids_schema" +description: "" +sidebar_label: "get_delete_ids_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: [0] +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-export-ids-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-export-ids-schema.Schema.json new file mode 100644 index 00000000000..e0517ab9fdd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-export-ids-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-export-ids-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-export-ids-schema.schema.mdx new file mode 100644 index 00000000000..50582766867 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-export-ids-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: get-export-ids-schema +title: "get_export_ids_schema" +description: "" +sidebar_label: "get_export_ids_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: [0] +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-fav-star-ids-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-fav-star-ids-schema.Schema.json new file mode 100644 index 00000000000..89852a2aecb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-fav-star-ids-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"items":{"type":"integer"},"type":"array","title":"get_fav_star_ids_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-fav-star-ids-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-fav-star-ids-schema.schema.mdx new file mode 100644 index 00000000000..163259b09f9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-fav-star-ids-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: get-fav-star-ids-schema +title: "get_fav_star_ids_schema" +description: "" +sidebar_label: "get_fav_star_ids_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: [0] +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-info-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-info-schema.Schema.json new file mode 100644 index 00000000000..8ca888307aa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-info-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-info-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-info-schema.schema.mdx new file mode 100644 index 00000000000..a7bd755b4af --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-info-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: get-info-schema +title: "get_info_schema" +description: "" +sidebar_label: "get_info_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"add_columns":{},"edit_columns":{},"keys":["add_columns"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-item-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-item-schema.Schema.json new file mode 100644 index 00000000000..97074667d37 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-item-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-item-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-item-schema.schema.mdx new file mode 100644 index 00000000000..2eee8864881 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-item-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: get-item-schema +title: "get_item_schema" +description: "" +sidebar_label: "get_item_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"columns":["string"],"keys":["show_columns"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-list-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-list-schema.Schema.json new file mode 100644 index 00000000000..093a6e17191 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-list-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-list-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-list-schema.schema.mdx new file mode 100644 index 00000000000..b67282defb5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-list-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: get-list-schema +title: "get_list_schema" +description: "" +sidebar_label: "get_list_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"columns":["string"],"filters":[{"col":"string","opr":"string","value":0}],"keys":["list_columns"],"order_column":"string","order_direction":"asc","page":0,"page_size":0,"select_columns":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-recent-activity-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-recent-activity-schema.Schema.json new file mode 100644 index 00000000000..572ae1ea62a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-recent-activity-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"actions":{"items":{"type":"string"},"type":"array"},"distinct":{"type":"boolean"},"page":{"type":"number"},"page_size":{"type":"number"}},"type":"object","title":"get_recent_activity_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-recent-activity-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-recent-activity-schema.schema.mdx new file mode 100644 index 00000000000..598a74c2e0d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-recent-activity-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: get-recent-activity-schema +title: "get_recent_activity_schema" +description: "" +sidebar_label: "get_recent_activity_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"actions":["string"],"distinct":true,"page":0,"page_size":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-related-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-related-schema.Schema.json new file mode 100644 index 00000000000..24df0611a0e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-related-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-related-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-related-schema.schema.mdx new file mode 100644 index 00000000000..7f30cf7d509 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-related-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: get-related-schema +title: "get_related_schema" +description: "" +sidebar_label: "get_related_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"filter":"string","include_ids":[0],"page":0,"page_size":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-slack-channels-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-slack-channels-schema.Schema.json new file mode 100644 index 00000000000..86475b02f79 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-slack-channels-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"type":"object","properties":{"search_string":{"type":"string","description":"String to search for in channel names."},"types":{"type":"array","items":{"type":"string","enum":["public_channel","private_channel"]},"description":"Types of channels to search."},"exact_match":{"type":"boolean","description":"Whether to match channel names exactly."}},"title":"get_slack_channels_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-slack-channels-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-slack-channels-schema.schema.mdx new file mode 100644 index 00000000000..3a23db08d65 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/get-slack-channels-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: get-slack-channels-schema +title: "get_slack_channels_schema" +description: "" +sidebar_label: "get_slack_channels_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"search_string":"string","types":["public_channel"],"exact_match":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getfavstaridsschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getfavstaridsschema.Schema.json new file mode 100644 index 00000000000..6f30de8e281 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getfavstaridsschema.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getfavstaridsschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getfavstaridsschema.schema.mdx new file mode 100644 index 00000000000..901f59dd204 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getfavstaridsschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: getfavstaridsschema +title: "GetFavStarIdsSchema" +description: "" +sidebar_label: "GetFavStarIdsSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"result":[{"id":0,"value":true}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getorcreatedatasetschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getorcreatedatasetschema.Schema.json new file mode 100644 index 00000000000..d47cd24f8a7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getorcreatedatasetschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"always_filter_main_dttm":{"default":false,"type":"boolean"},"catalog":{"description":"The catalog the table belongs to","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"database_id":{"description":"ID of database table belongs to","type":"integer"},"normalize_columns":{"default":false,"type":"boolean"},"schema":{"description":"The schema the table belongs to","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"table_name":{"description":"Name of table","type":"string"},"template_params":{"description":"Template params for the table","type":"string"}},"required":["database_id","table_name"],"type":"object","title":"GetOrCreateDatasetSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getorcreatedatasetschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getorcreatedatasetschema.schema.mdx new file mode 100644 index 00000000000..d34f3729b85 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/getorcreatedatasetschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: getorcreatedatasetschema +title: "GetOrCreateDatasetSchema" +description: "" +sidebar_label: "GetOrCreateDatasetSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"always_filter_main_dttm":false,"catalog":"string","database_id":0,"normalize_columns":false,"schema":"string","table_name":"string","template_params":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/guesttokencreate.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/guesttokencreate.Schema.json new file mode 100644 index 00000000000..2e3dd160f39 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/guesttokencreate.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"resources":{"items":{"properties":{"id":{"type":"string"},"type":{"enum":["dashboard"]}},"required":["id","type"],"type":"object","title":"Resource"},"type":"array"},"rls":{"items":{"properties":{"clause":{"type":"string"},"dataset":{"type":"integer"}},"required":["clause"],"type":"object","title":"RlsRule"},"type":"array"},"user":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User2"}},"required":["resources","rls"],"type":"object","title":"GuestTokenCreate"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/guesttokencreate.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/guesttokencreate.schema.mdx new file mode 100644 index 00000000000..6ada8881dc6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/guesttokencreate.schema.mdx @@ -0,0 +1,31 @@ +--- +id: guesttokencreate +title: "GuestTokenCreate" +description: "" +sidebar_label: "GuestTokenCreate" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"resources":[{"id":"string"}],"rls":[{"clause":"string","dataset":0}],"user":{"first_name":"string","last_name":"string","username":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-database.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-database.Schema.json new file mode 100644 index 00000000000..8165e22f155 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-database.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"allow_csv_upload":{"type":"boolean"},"allow_ctas":{"type":"boolean"},"allow_cvas":{"type":"boolean"},"allow_dml":{"type":"boolean"},"allow_run_async":{"type":"boolean"},"cache_timeout":{"nullable":true,"type":"integer"},"database_name":{"type":"string"},"encrypted_extra":{"nullable":true,"type":"string"},"expose_in_sqllab":{"type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"properties":{"allow_multi_catalog":{"type":"boolean"},"allows_virtual_table_explore":{"type":"boolean"},"cancel_query_on_windows_unload":{"type":"boolean"},"cost_estimate_enabled":{"type":"boolean"},"disable_data_preview":{"type":"boolean"},"disable_drill_to_detail":{"type":"boolean"},"engine_params":{"additionalProperties":{},"type":"object"},"metadata_cache_timeout":{"additionalProperties":{"type":"integer"},"type":"object"},"metadata_params":{"additionalProperties":{},"type":"object"},"schema_options":{"additionalProperties":{},"type":"object"},"schemas_allowed_for_csv_upload":{"items":{"type":"string"},"type":"array"},"version":{"nullable":true,"type":"string"}},"type":"object","title":"ImportV1DatabaseExtra"},"impersonate_user":{"type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"password":{"nullable":true,"type":"string"},"sqlalchemy_uri":{"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true},"uuid":{"format":"uuid","type":"string"},"version":{"type":"string"}},"required":["database_name","sqlalchemy_uri","uuid","version"],"type":"object","title":"ImportV1Database"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-database.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-database.schema.mdx new file mode 100644 index 00000000000..7df69289835 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-database.schema.mdx @@ -0,0 +1,31 @@ +--- +id: importv-1-database +title: "ImportV1Database" +description: "" +sidebar_label: "ImportV1Database" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"allow_csv_upload":true,"allow_ctas":true,"allow_cvas":true,"allow_dml":true,"allow_run_async":true,"cache_timeout":0,"database_name":"string","encrypted_extra":"string","expose_in_sqllab":true,"external_url":"string","extra":{"allow_multi_catalog":true,"allows_virtual_table_explore":true,"cancel_query_on_windows_unload":true,"cost_estimate_enabled":true,"disable_data_preview":true,"disable_drill_to_detail":true,"engine_params":{},"metadata_cache_timeout":{},"metadata_params":{},"schema_options":{},"schemas_allowed_for_csv_upload":["string"],"version":"string"},"impersonate_user":true,"is_managed_externally":true,"password":"string","sqlalchemy_uri":"string","ssh_tunnel":{"id":0,"password":"string","private_key":"string","private_key_password":"string","server_address":"string","server_port":0,"username":"string"},"uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","version":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-databaseextra.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-databaseextra.Schema.json new file mode 100644 index 00000000000..c49aa461904 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-databaseextra.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"allow_multi_catalog":{"type":"boolean"},"allows_virtual_table_explore":{"type":"boolean"},"cancel_query_on_windows_unload":{"type":"boolean"},"cost_estimate_enabled":{"type":"boolean"},"disable_data_preview":{"type":"boolean"},"disable_drill_to_detail":{"type":"boolean"},"engine_params":{"additionalProperties":{},"type":"object"},"metadata_cache_timeout":{"additionalProperties":{"type":"integer"},"type":"object"},"metadata_params":{"additionalProperties":{},"type":"object"},"schema_options":{"additionalProperties":{},"type":"object"},"schemas_allowed_for_csv_upload":{"items":{"type":"string"},"type":"array"},"version":{"nullable":true,"type":"string"}},"type":"object","title":"ImportV1DatabaseExtra"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-databaseextra.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-databaseextra.schema.mdx new file mode 100644 index 00000000000..f94ef246c07 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/importv-1-databaseextra.schema.mdx @@ -0,0 +1,31 @@ +--- +id: importv-1-databaseextra +title: "ImportV1DatabaseExtra" +description: "" +sidebar_label: "ImportV1DatabaseExtra" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"allow_multi_catalog":true,"allows_virtual_table_explore":true,"cancel_query_on_windows_unload":true,"cost_estimate_enabled":true,"disable_data_preview":true,"disable_drill_to_detail":true,"engine_params":{},"metadata_cache_timeout":{},"metadata_params":{},"schema_options":{},"schemas_allowed_for_csv_upload":["string"],"version":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..47b3b1b8385 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"username":{"maxLength":64,"type":"string"}},"required":["username"],"type":"object","title":"LogRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..432d8c33096 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: logrestapi-get-list-user +title: "LogRestApi.get_list.User" +description: "" +sidebar_label: "LogRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list.Schema.json new file mode 100644 index 00000000000..0779941df76 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"action":{"maxLength":512,"nullable":true,"type":"string"},"dashboard_id":{"nullable":true,"type":"integer"},"dttm":{"format":"date-time","nullable":true,"type":"string"},"duration_ms":{"nullable":true,"type":"integer"},"json":{"nullable":true,"type":"string"},"referrer":{"maxLength":1024,"nullable":true,"type":"string"},"slice_id":{"nullable":true,"type":"integer"},"user":{"properties":{"username":{"maxLength":64,"type":"string"}},"required":["username"],"type":"object","title":"LogRestApi.get_list.User"},"user_id":{"nullable":true,"type":"integer"}},"type":"object","title":"LogRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..37e87d79223 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: logrestapi-get-list +title: "LogRestApi.get_list" +description: "" +sidebar_label: "LogRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"action":"string","dashboard_id":0,"dttm":"2024-07-29T15:51:28.071Z","duration_ms":0,"json":"string","referrer":"string","slice_id":0,"user":{"username":"string"},"user_id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-user.Schema.json new file mode 100644 index 00000000000..d511d4b3338 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"username":{"maxLength":64,"type":"string"}},"required":["username"],"type":"object","title":"LogRestApi.get.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-user.schema.mdx new file mode 100644 index 00000000000..d925f65c34e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: logrestapi-get-user +title: "LogRestApi.get.User" +description: "" +sidebar_label: "LogRestApi.get.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get.Schema.json new file mode 100644 index 00000000000..36dea8b87b1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"action":{"maxLength":512,"nullable":true,"type":"string"},"dashboard_id":{"nullable":true,"type":"integer"},"dttm":{"format":"date-time","nullable":true,"type":"string"},"duration_ms":{"nullable":true,"type":"integer"},"json":{"nullable":true,"type":"string"},"referrer":{"maxLength":1024,"nullable":true,"type":"string"},"slice_id":{"nullable":true,"type":"integer"},"user":{"properties":{"username":{"maxLength":64,"type":"string"}},"required":["username"],"type":"object","title":"LogRestApi.get.User"},"user_id":{"nullable":true,"type":"integer"}},"type":"object","title":"LogRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get.schema.mdx new file mode 100644 index 00000000000..fff670628a6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: logrestapi-get +title: "LogRestApi.get" +description: "" +sidebar_label: "LogRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"action":"string","dashboard_id":0,"dttm":"2024-07-29T15:51:28.071Z","duration_ms":0,"json":"string","referrer":"string","slice_id":0,"user":{"username":"string"},"user_id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-post.Schema.json new file mode 100644 index 00000000000..e95880bbb78 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"LogRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-post.schema.mdx new file mode 100644 index 00000000000..65ee5dd7826 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: logrestapi-post +title: "LogRestApi.post" +description: "" +sidebar_label: "LogRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-put.Schema.json new file mode 100644 index 00000000000..73951a3b83f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"action":{"maxLength":512,"nullable":true,"type":"string"},"dttm":{"format":"date-time","nullable":true,"type":"string"},"json":{"nullable":true,"type":"string"},"user":{"nullable":true}},"type":"object","title":"LogRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-put.schema.mdx new file mode 100644 index 00000000000..c2ce9c032fb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/logrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: logrestapi-put +title: "LogRestApi.put" +description: "" +sidebar_label: "LogRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"action":"string","dttm":"2024-07-29T15:51:28.071Z","json":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get-list.Schema.json new file mode 100644 index 00000000000..52bb69596af --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get-list.schema.mdx new file mode 100644 index 00000000000..067e128cf06 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionapi-get-list +title: "PermissionApi.get_list" +description: "" +sidebar_label: "PermissionApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get.Schema.json new file mode 100644 index 00000000000..69ccdf2d6b9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get.schema.mdx new file mode 100644 index 00000000000..1b498d802e6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionapi-get +title: "PermissionApi.get" +description: "" +sidebar_label: "PermissionApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-post.Schema.json new file mode 100644 index 00000000000..c5b547947aa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-post.schema.mdx new file mode 100644 index 00000000000..dc9a1b0332e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionapi-post +title: "PermissionApi.post" +description: "" +sidebar_label: "PermissionApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-put.Schema.json new file mode 100644 index 00000000000..b3efc03ca4c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-put.schema.mdx new file mode 100644 index 00000000000..06ec9bf0f99 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionapi-put +title: "PermissionApi.put" +description: "" +sidebar_label: "PermissionApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-permission.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-permission.Schema.json new file mode 100644 index 00000000000..bf552564030 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-permission.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get_list.Permission"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-permission.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-permission.schema.mdx new file mode 100644 index 00000000000..47f1febadc2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-permission.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionviewmenuapi-get-list-permission +title: "PermissionViewMenuApi.get_list.Permission" +description: "" +sidebar_label: "PermissionViewMenuApi.get_list.Permission" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-viewmenu.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-viewmenu.Schema.json new file mode 100644 index 00000000000..7c15ec8de62 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-viewmenu.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get_list.ViewMenu"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-viewmenu.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-viewmenu.schema.mdx new file mode 100644 index 00000000000..f1e431c1c42 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list-viewmenu.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionviewmenuapi-get-list-viewmenu +title: "PermissionViewMenuApi.get_list.ViewMenu" +description: "" +sidebar_label: "PermissionViewMenuApi.get_list.ViewMenu" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list.Schema.json new file mode 100644 index 00000000000..61f1cedcc4b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"permission":{"properties":{"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get_list.Permission"},"view_menu":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get_list.ViewMenu"}},"type":"object","title":"PermissionViewMenuApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list.schema.mdx new file mode 100644 index 00000000000..7d8e5fdf726 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionviewmenuapi-get-list +title: "PermissionViewMenuApi.get_list" +description: "" +sidebar_label: "PermissionViewMenuApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"permission":{"name":"string"},"view_menu":{"name":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-permission.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-permission.Schema.json new file mode 100644 index 00000000000..8ee6ed890e3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-permission.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get.Permission"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-permission.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-permission.schema.mdx new file mode 100644 index 00000000000..f9018d93af4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-permission.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionviewmenuapi-get-permission +title: "PermissionViewMenuApi.get.Permission" +description: "" +sidebar_label: "PermissionViewMenuApi.get.Permission" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-viewmenu.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-viewmenu.Schema.json new file mode 100644 index 00000000000..97547bb4405 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-viewmenu.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get.ViewMenu"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-viewmenu.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-viewmenu.schema.mdx new file mode 100644 index 00000000000..3b3d593e443 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get-viewmenu.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionviewmenuapi-get-viewmenu +title: "PermissionViewMenuApi.get.ViewMenu" +description: "" +sidebar_label: "PermissionViewMenuApi.get.ViewMenu" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get.Schema.json new file mode 100644 index 00000000000..165044834ae --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"permission":{"properties":{"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get.Permission"},"view_menu":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"PermissionViewMenuApi.get.ViewMenu"}},"type":"object","title":"PermissionViewMenuApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get.schema.mdx new file mode 100644 index 00000000000..338ad83915e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionviewmenuapi-get +title: "PermissionViewMenuApi.get" +description: "" +sidebar_label: "PermissionViewMenuApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"permission":{"name":"string"},"view_menu":{"name":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-post.Schema.json new file mode 100644 index 00000000000..54ff8a3b39e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"permission_id":{"nullable":true,"type":"integer"},"view_menu_id":{"nullable":true,"type":"integer"}},"type":"object","title":"PermissionViewMenuApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-post.schema.mdx new file mode 100644 index 00000000000..98455dd375f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionviewmenuapi-post +title: "PermissionViewMenuApi.post" +description: "" +sidebar_label: "PermissionViewMenuApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"permission_id":0,"view_menu_id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-put.Schema.json new file mode 100644 index 00000000000..7dbe4c36a7b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"permission_id":{"nullable":true,"type":"integer"},"view_menu_id":{"nullable":true,"type":"integer"}},"type":"object","title":"PermissionViewMenuApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-put.schema.mdx new file mode 100644 index 00000000000..47f3620bb22 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/permissionviewmenuapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: permissionviewmenuapi-put +title: "PermissionViewMenuApi.put" +description: "" +sidebar_label: "PermissionViewMenuApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"permission_id":0,"view_menu_id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queries-get-updated-since-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queries-get-updated-since-schema.Schema.json new file mode 100644 index 00000000000..183524f6f4c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queries-get-updated-since-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"last_updated_ms":{"type":"number"}},"required":["last_updated_ms"],"type":"object","title":"queries_get_updated_since_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queries-get-updated-since-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queries-get-updated-since-schema.schema.mdx new file mode 100644 index 00000000000..ff667350e4a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queries-get-updated-since-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: queries-get-updated-since-schema +title: "queries_get_updated_since_schema" +description: "" +sidebar_label: "queries_get_updated_since_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"last_updated_ms":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryexecutionresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryexecutionresponseschema.Schema.json new file mode 100644 index 00000000000..a7bea3f8c8e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryexecutionresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"columns":{"items":{"type":"object"},"type":"array"},"data":{"items":{"type":"object"},"type":"array"},"expanded_columns":{"items":{"type":"object"},"type":"array"},"query":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object","title":"QueryResult"},"query_id":{"type":"integer"},"selected_columns":{"items":{"type":"object"},"type":"array"},"status":{"type":"string"}},"type":"object","title":"QueryExecutionResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryexecutionresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryexecutionresponseschema.schema.mdx new file mode 100644 index 00000000000..18eb74aab53 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryexecutionresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: queryexecutionresponseschema +title: "QueryExecutionResponseSchema" +description: "" +sidebar_label: "QueryExecutionResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"columns":[{}],"data":[{}],"expanded_columns":[{}],"query":{"changed_on":"2024-07-29T15:51:28.071Z","ctas":true,"db":"string","dbId":0,"endDttm":0,"errorMessage":"string","executedSql":"string","extra":{},"id":"string","limit":0,"limitingFactor":"string","progress":0,"queryId":0,"resultsKey":"string","rows":0,"schema":"string","serverId":0,"sql":"string","sqlEditorId":"string","startDttm":0,"state":"string","tab":"string","tempSchema":"string","tempTable":"string","trackingUrl":"string","user":"string","userId":0},"query_id":0,"selected_columns":[{}],"status":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-database.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-database.Schema.json new file mode 100644 index 00000000000..6db280cbc92 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-database.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"QueryRestApi.get.Database"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-database.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-database.schema.mdx new file mode 100644 index 00000000000..eccac539616 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-database.schema.mdx @@ -0,0 +1,31 @@ +--- +id: queryrestapi-get-database +title: "QueryRestApi.get.Database" +description: "" +sidebar_label: "QueryRestApi.get.Database" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-list.Schema.json new file mode 100644 index 00000000000..13b0ebcd838 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_on":{"format":"date-time","type":"string"},"database":{"properties":{"database_name":{"type":"string"}},"type":"object","title":"Database1"},"end_time":{"type":"number"},"executed_sql":{"type":"string"},"id":{"type":"integer"},"rows":{"type":"integer"},"schema":{"type":"string"},"sql":{"type":"string"},"sql_tables":{"readOnly":true},"start_time":{"type":"number"},"status":{"type":"string"},"tab_name":{"type":"string"},"tmp_table_name":{"type":"string"},"tracking_url":{"type":"string"},"user":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"}},"type":"object","title":"QueryRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..e9e51890b88 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: queryrestapi-get-list +title: "QueryRestApi.get_list" +description: "" +sidebar_label: "QueryRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_on":"2024-07-29T15:51:28.071Z","database":{"database_name":"string"},"end_time":0,"executed_sql":"string","id":0,"rows":0,"schema":"string","sql":"string","start_time":0,"status":"string","tab_name":"string","tmp_table_name":"string","tracking_url":"string","user":{"first_name":"string","id":0,"last_name":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get.Schema.json new file mode 100644 index 00000000000..3e749354ef6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_on":{"format":"date-time","nullable":true,"type":"string"},"client_id":{"maxLength":11,"type":"string"},"database":{"properties":{"id":{"type":"integer"}},"type":"object","title":"QueryRestApi.get.Database"},"end_result_backend_time":{"nullable":true,"type":"number"},"end_time":{"nullable":true,"type":"number"},"error_message":{"nullable":true,"type":"string"},"executed_sql":{"nullable":true,"type":"string"},"id":{"type":"integer"},"limit":{"nullable":true,"type":"integer"},"progress":{"nullable":true,"type":"integer"},"results_key":{"maxLength":64,"nullable":true,"type":"string"},"rows":{"nullable":true,"type":"integer"},"schema":{"maxLength":256,"nullable":true,"type":"string"},"select_as_cta":{"nullable":true,"type":"boolean"},"select_as_cta_used":{"nullable":true,"type":"boolean"},"select_sql":{"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_editor_id":{"maxLength":256,"nullable":true,"type":"string"},"start_running_time":{"nullable":true,"type":"number"},"start_time":{"nullable":true,"type":"number"},"status":{"maxLength":16,"nullable":true,"type":"string"},"tab_name":{"maxLength":256,"nullable":true,"type":"string"},"tmp_schema_name":{"maxLength":256,"nullable":true,"type":"string"},"tmp_table_name":{"maxLength":256,"nullable":true,"type":"string"},"tracking_url":{"readOnly":true}},"required":["client_id","database"],"type":"object","title":"QueryRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get.schema.mdx new file mode 100644 index 00000000000..b92137b385d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: queryrestapi-get +title: "QueryRestApi.get" +description: "" +sidebar_label: "QueryRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_on":"2024-07-29T15:51:28.071Z","client_id":"string","database":{"id":0},"end_result_backend_time":0,"end_time":0,"error_message":"string","executed_sql":"string","id":0,"limit":0,"progress":0,"results_key":"string","rows":0,"schema":"string","select_as_cta":true,"select_as_cta_used":true,"select_sql":"string","sql":"string","sql_editor_id":"string","start_running_time":0,"start_time":0,"status":"string","tab_name":"string","tmp_schema_name":"string","tmp_table_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-post.Schema.json new file mode 100644 index 00000000000..6bf83f004c1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"QueryRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-post.schema.mdx new file mode 100644 index 00000000000..04c51a0ad5a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: queryrestapi-post +title: "QueryRestApi.post" +description: "" +sidebar_label: "QueryRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-put.Schema.json new file mode 100644 index 00000000000..4ed93e9e335 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"QueryRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-put.schema.mdx new file mode 100644 index 00000000000..c1e548e14cf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: queryrestapi-put +title: "QueryRestApi.put" +description: "" +sidebar_label: "QueryRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryresult.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryresult.Schema.json new file mode 100644 index 00000000000..e89e441a306 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryresult.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object","title":"QueryResult"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryresult.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryresult.schema.mdx new file mode 100644 index 00000000000..b4f9a261a95 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/queryresult.schema.mdx @@ -0,0 +1,31 @@ +--- +id: queryresult +title: "QueryResult" +description: "" +sidebar_label: "QueryResult" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_on":"2024-07-29T15:51:28.071Z","ctas":true,"db":"string","dbId":0,"endDttm":0,"errorMessage":"string","executedSql":"string","extra":{},"id":"string","limit":0,"limitingFactor":"string","progress":0,"queryId":0,"resultsKey":"string","rows":0,"schema":"string","serverId":0,"sql":"string","sqlEditorId":"string","startDttm":0,"state":"string","tab":"string","tempSchema":"string","tempTable":"string","trackingUrl":"string","user":"string","userId":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivity.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivity.Schema.json new file mode 100644 index 00000000000..a905a99d1b3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivity.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"action":{"description":"Action taken describing type of activity","type":"string"},"item_title":{"description":"Title of item","type":"string"},"item_type":{"description":"Type of item, e.g. slice or dashboard","type":"string"},"item_url":{"description":"URL to item","type":"string"},"time":{"description":"Time of activity, in epoch milliseconds","type":"number"},"time_delta_humanized":{"description":"Human-readable description of how long ago activity took place.","type":"string"}},"type":"object","title":"RecentActivity"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivity.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivity.schema.mdx new file mode 100644 index 00000000000..b12af36d518 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivity.schema.mdx @@ -0,0 +1,31 @@ +--- +id: recentactivity +title: "RecentActivity" +description: "" +sidebar_label: "RecentActivity" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"action":"string","item_title":"string","item_type":"string","item_url":"string","time":0,"time_delta_humanized":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityresponseschema.Schema.json new file mode 100644 index 00000000000..889573aeeaa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"result":{"description":"A list of recent activity objects","items":{"properties":{"action":{"description":"Action taken describing type of activity","type":"string"},"item_title":{"description":"Title of item","type":"string"},"item_type":{"description":"Type of item, e.g. slice or dashboard","type":"string"},"item_url":{"description":"URL to item","type":"string"},"time":{"description":"Time of activity, in epoch milliseconds","type":"number"},"time_delta_humanized":{"description":"Human-readable description of how long ago activity took place.","type":"string"}},"type":"object","title":"RecentActivity"},"type":"array"}},"type":"object","title":"RecentActivityResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityresponseschema.schema.mdx new file mode 100644 index 00000000000..450bf4fe89b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: recentactivityresponseschema +title: "RecentActivityResponseSchema" +description: "" +sidebar_label: "RecentActivityResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"result":[{"action":"string","item_title":"string","item_type":"string","item_url":"string","time":0,"time_delta_humanized":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityschema.Schema.json new file mode 100644 index 00000000000..b14b635c008 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"action":{"description":"Action taken describing type of activity","type":"string"},"item_title":{"description":"Title of item","type":"string"},"item_type":{"description":"Type of item, e.g. slice or dashboard","type":"string"},"item_url":{"description":"URL to item","type":"string"},"time":{"description":"Time of activity, in epoch milliseconds","type":"number"},"time_delta_humanized":{"description":"Human-readable description of how long ago activity took place.","type":"string"}},"type":"object","title":"RecentActivitySchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityschema.schema.mdx new file mode 100644 index 00000000000..8b3df675eaa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/recentactivityschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: recentactivityschema +title: "RecentActivitySchema" +description: "" +sidebar_label: "RecentActivitySchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"action":"string","item_title":"string","item_type":"string","item_url":"string","time":0,"time_delta_humanized":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresponseschema.Schema.json new file mode 100644 index 00000000000..c079daddb8f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresponseschema.schema.mdx new file mode 100644 index 00000000000..f5c3edf8640 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: relatedresponseschema +title: "RelatedResponseSchema" +description: "" +sidebar_label: "RelatedResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"count":0,"result":[{"extra":{},"text":"string","value":0}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresultresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresultresponse.Schema.json new file mode 100644 index 00000000000..31ca4bee586 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresultresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresultresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresultresponse.schema.mdx new file mode 100644 index 00000000000..5ddd34a9117 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/relatedresultresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: relatedresultresponse +title: "RelatedResultResponse" +description: "" +sidebar_label: "RelatedResultResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"extra":{},"text":"string","value":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get-list.Schema.json new file mode 100644 index 00000000000..ad964203c59 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"id":{"type":"integer"},"scheduled_dttm":{"format":"date-time","type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"},"state":{"maxLength":50,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"value":{"nullable":true,"type":"number"},"value_row_json":{"nullable":true,"type":"string"}},"required":["scheduled_dttm","state"],"type":"object","title":"ReportExecutionLogRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..a3e369a48d0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportexecutionlogrestapi-get-list +title: "ReportExecutionLogRestApi.get_list" +description: "" +sidebar_label: "ReportExecutionLogRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"end_dttm":"2024-07-29T15:51:28.071Z","error_message":"string","id":0,"scheduled_dttm":"2024-07-29T15:51:28.071Z","start_dttm":"2024-07-29T15:51:28.071Z","state":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","value":0,"value_row_json":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get.Schema.json new file mode 100644 index 00000000000..1dbf8c1e369 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"id":{"type":"integer"},"scheduled_dttm":{"format":"date-time","type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"},"state":{"maxLength":50,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"value":{"nullable":true,"type":"number"},"value_row_json":{"nullable":true,"type":"string"}},"required":["scheduled_dttm","state"],"type":"object","title":"ReportExecutionLogRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get.schema.mdx new file mode 100644 index 00000000000..718a44e82aa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportexecutionlogrestapi-get +title: "ReportExecutionLogRestApi.get" +description: "" +sidebar_label: "ReportExecutionLogRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"end_dttm":"2024-07-29T15:51:28.071Z","error_message":"string","id":0,"scheduled_dttm":"2024-07-29T15:51:28.071Z","start_dttm":"2024-07-29T15:51:28.071Z","state":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","value":0,"value_row_json":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-post.Schema.json new file mode 100644 index 00000000000..7e7673129ac --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"ReportExecutionLogRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-post.schema.mdx new file mode 100644 index 00000000000..2d0dfacae22 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportexecutionlogrestapi-post +title: "ReportExecutionLogRestApi.post" +description: "" +sidebar_label: "ReportExecutionLogRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-put.Schema.json new file mode 100644 index 00000000000..b19a0cd0a60 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"ReportExecutionLogRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-put.schema.mdx new file mode 100644 index 00000000000..ab92e41d796 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportexecutionlogrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportexecutionlogrestapi-put +title: "ReportExecutionLogRestApi.put" +description: "" +sidebar_label: "ReportExecutionLogRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipient.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipient.Schema.json new file mode 100644 index 00000000000..b41dd4f7282 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipient.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"recipient_config_json":{"properties":{"bccTarget":{"type":"string"},"ccTarget":{"type":"string"},"target":{"type":"string"}},"type":"object","title":"ReportRecipientConfigJSON"},"type":{"description":"The recipient type, check spec for valid options","enum":["Email","Slack","SlackV2"],"type":"string"}},"required":["type"],"type":"object","title":"ReportRecipient"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipient.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipient.schema.mdx new file mode 100644 index 00000000000..32fb2b86eb6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipient.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportrecipient +title: "ReportRecipient" +description: "" +sidebar_label: "ReportRecipient" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"recipient_config_json":{"bccTarget":"string","ccTarget":"string","target":"string"},"type":"Email"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipientconfigjson.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipientconfigjson.Schema.json new file mode 100644 index 00000000000..bed1879e09a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipientconfigjson.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"bccTarget":{"type":"string"},"ccTarget":{"type":"string"},"target":{"type":"string"}},"type":"object","title":"ReportRecipientConfigJSON"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipientconfigjson.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipientconfigjson.schema.mdx new file mode 100644 index 00000000000..24600086060 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportrecipientconfigjson.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportrecipientconfigjson +title: "ReportRecipientConfigJSON" +description: "" +sidebar_label: "ReportRecipientConfigJSON" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"bccTarget":"string","ccTarget":"string","target":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-dashboard.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-dashboard.Schema.json new file mode 100644 index 00000000000..c0bd7bbf4f6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-dashboard.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object","title":"ReportScheduleRestApi.get.Dashboard"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-dashboard.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-dashboard.schema.mdx new file mode 100644 index 00000000000..f001011c475 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-dashboard.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-get-dashboard +title: "ReportScheduleRestApi.get.Dashboard" +description: "" +sidebar_label: "ReportScheduleRestApi.get.Dashboard" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"dashboard_title":"string","id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-database.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-database.Schema.json new file mode 100644 index 00000000000..cb6bc5bf39c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-database.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"ReportScheduleRestApi.get.Database"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-database.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-database.schema.mdx new file mode 100644 index 00000000000..fd08f8ac184 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-database.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-get-database +title: "ReportScheduleRestApi.get.Database" +description: "" +sidebar_label: "ReportScheduleRestApi.get.Database" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"database_name":"string","id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-reportrecipients.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-reportrecipients.Schema.json new file mode 100644 index 00000000000..b42c57565f7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-reportrecipients.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"type":{"maxLength":50,"type":"string"}},"required":["type"],"type":"object","title":"ReportScheduleRestApi.get_list.ReportRecipients"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-reportrecipients.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-reportrecipients.schema.mdx new file mode 100644 index 00000000000..d04d409ae22 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-reportrecipients.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-get-list-reportrecipients +title: "ReportScheduleRestApi.get_list.ReportRecipients" +description: "" +sidebar_label: "ReportScheduleRestApi.get_list.ReportRecipients" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..67997c82f20 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..302288e5351 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-get-list-user-1 +title: "ReportScheduleRestApi.get_list.User1" +description: "" +sidebar_label: "ReportScheduleRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-2.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-2.Schema.json new file mode 100644 index 00000000000..4e208edd4f2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-2.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get_list.User2"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-2.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-2.schema.mdx new file mode 100644 index 00000000000..402fdab1f03 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user-2.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-get-list-user-2 +title: "ReportScheduleRestApi.get_list.User2" +description: "" +sidebar_label: "ReportScheduleRestApi.get_list.User2" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..49d12fae72f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..8ba32d6b601 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-get-list-user +title: "ReportScheduleRestApi.get_list.User" +description: "" +sidebar_label: "ReportScheduleRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list.Schema.json new file mode 100644 index 00000000000..81f1c315a0f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get_list.User"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"chart_id":{"nullable":true,"type":"integer"},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get_list.User1"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"creation_method":{"maxLength":255,"nullable":true,"type":"string"},"crontab":{"maxLength":1000,"type":"string"},"crontab_humanized":{"readOnly":true},"dashboard_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra":{"readOnly":true},"id":{"type":"integer"},"last_eval_dttm":{"format":"date-time","nullable":true,"type":"string"},"last_state":{"maxLength":50,"nullable":true,"type":"string"},"name":{"maxLength":150,"type":"string"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get_list.User2"},"recipients":{"properties":{"id":{"type":"integer"},"type":{"maxLength":50,"type":"string"}},"required":["type"],"type":"object","title":"ReportScheduleRestApi.get_list.ReportRecipients"},"timezone":{"maxLength":100,"type":"string"},"type":{"maxLength":50,"type":"string"}},"required":["crontab","name","recipients","type"],"type":"object","title":"ReportScheduleRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list.schema.mdx new file mode 100644 index 00000000000..eff187bb283 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-get-list +title: "ReportScheduleRestApi.get_list" +description: "" +sidebar_label: "ReportScheduleRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"active":true,"changed_by":{"first_name":"string","last_name":"string"},"changed_on":"2024-07-29T15:51:28.071Z","chart_id":0,"created_by":{"first_name":"string","last_name":"string"},"created_on":"2024-07-29T15:51:28.071Z","creation_method":"string","crontab":"string","dashboard_id":0,"description":"string","id":0,"last_eval_dttm":"2024-07-29T15:51:28.071Z","last_state":"string","name":"string","owners":{"first_name":"string","id":0,"last_name":"string"},"recipients":{"id":0,"type":"string"},"timezone":"string","type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-reportrecipients.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-reportrecipients.Schema.json new file mode 100644 index 00000000000..a5e10c7a2c5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-reportrecipients.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"recipient_config_json":{"nullable":true,"type":"string"},"type":{"maxLength":50,"type":"string"}},"required":["type"],"type":"object","title":"ReportScheduleRestApi.get.ReportRecipients"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-reportrecipients.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-reportrecipients.schema.mdx new file mode 100644 index 00000000000..8a43e401732 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-reportrecipients.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-get-reportrecipients +title: "ReportScheduleRestApi.get.ReportRecipients" +description: "" +sidebar_label: "ReportScheduleRestApi.get.ReportRecipients" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"recipient_config_json":"string","type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-slice.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-slice.Schema.json new file mode 100644 index 00000000000..2e6b3c67ae6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-slice.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"ReportScheduleRestApi.get.Slice"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-slice.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-slice.schema.mdx new file mode 100644 index 00000000000..3d1be20d5a9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-slice.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-get-slice +title: "ReportScheduleRestApi.get.Slice" +description: "" +sidebar_label: "ReportScheduleRestApi.get.Slice" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"slice_name":"string","viz_type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-user.Schema.json new file mode 100644 index 00000000000..5d0cb557159 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-user.schema.mdx new file mode 100644 index 00000000000..1133012af4c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-get-user +title: "ReportScheduleRestApi.get.User" +description: "" +sidebar_label: "ReportScheduleRestApi.get.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get.Schema.json new file mode 100644 index 00000000000..8eace8e8ef0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"active":{"nullable":true,"type":"boolean"},"chart":{"properties":{"id":{"type":"integer"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"ReportScheduleRestApi.get.Slice"},"context_markdown":{"nullable":true,"type":"string"},"creation_method":{"maxLength":255,"nullable":true,"type":"string"},"crontab":{"maxLength":1000,"type":"string"},"custom_width":{"nullable":true,"type":"integer"},"dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object","title":"ReportScheduleRestApi.get.Dashboard"},"database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"ReportScheduleRestApi.get.Database"},"description":{"nullable":true,"type":"string"},"email_subject":{"maxLength":255,"nullable":true,"type":"string"},"extra":{"readOnly":true},"force_screenshot":{"nullable":true,"type":"boolean"},"grace_period":{"nullable":true,"type":"integer"},"id":{"type":"integer"},"last_eval_dttm":{"format":"date-time","nullable":true,"type":"string"},"last_state":{"maxLength":50,"nullable":true,"type":"string"},"last_value":{"nullable":true,"type":"number"},"last_value_row_json":{"nullable":true,"type":"string"},"log_retention":{"nullable":true,"type":"integer"},"name":{"maxLength":150,"type":"string"},"owners":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ReportScheduleRestApi.get.User"},"recipients":{"properties":{"id":{"type":"integer"},"recipient_config_json":{"nullable":true,"type":"string"},"type":{"maxLength":50,"type":"string"}},"required":["type"],"type":"object","title":"ReportScheduleRestApi.get.ReportRecipients"},"report_format":{"maxLength":50,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"timezone":{"maxLength":100,"type":"string"},"type":{"maxLength":50,"type":"string"},"validator_config_json":{"nullable":true,"type":"string"},"validator_type":{"maxLength":100,"nullable":true,"type":"string"},"working_timeout":{"nullable":true,"type":"integer"}},"required":["crontab","name","recipients","type"],"type":"object","title":"ReportScheduleRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get.schema.mdx new file mode 100644 index 00000000000..cb8c86b3c7e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-get +title: "ReportScheduleRestApi.get" +description: "" +sidebar_label: "ReportScheduleRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"active":true,"chart":{"id":0,"slice_name":"string","viz_type":"string"},"context_markdown":"string","creation_method":"string","crontab":"string","custom_width":0,"dashboard":{"dashboard_title":"string","id":0},"database":{"database_name":"string","id":0},"description":"string","email_subject":"string","force_screenshot":true,"grace_period":0,"id":0,"last_eval_dttm":"2024-07-29T15:51:28.071Z","last_state":"string","last_value":0,"last_value_row_json":"string","log_retention":0,"name":"string","owners":{"first_name":"string","id":0,"last_name":"string"},"recipients":{"id":0,"recipient_config_json":"string","type":"string"},"report_format":"string","sql":"string","timezone":"string","type":"string","validator_config_json":"string","validator_type":"string","working_timeout":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-post.Schema.json new file mode 100644 index 00000000000..cf18f554491 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"active":{"type":"boolean"},"chart":{"nullable":true,"type":"integer"},"context_markdown":{"description":"Markdown description","nullable":true,"type":"string"},"creation_method":{"description":"Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.","enum":["charts","dashboards","alerts_reports"]},"crontab":{"description":"A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.","example":"*/5 * * * *","maxLength":1000,"minLength":1,"type":"string"},"custom_width":{"description":"Custom width of the screenshot in pixels","example":1000,"nullable":true,"type":"integer"},"dashboard":{"nullable":true,"type":"integer"},"database":{"type":"integer"},"description":{"description":"Use a nice description to give context to this Alert/Report","example":"Daily sales dashboard to marketing","nullable":true,"type":"string"},"email_subject":{"description":"The report schedule subject line","example":"[Report] Report name: Dashboard or chart name","nullable":true,"type":"string"},"extra":{"type":"object"},"force_screenshot":{"type":"boolean"},"grace_period":{"description":"Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)","example":14400,"minimum":1,"type":"integer"},"log_retention":{"description":"How long to keep the logs around for this report (in days)","example":90,"minimum":1,"type":"integer"},"name":{"description":"The report schedule name.","example":"Daily dashboard email","maxLength":150,"minLength":1,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.","type":"integer"},"type":"array"},"recipients":{"items":{"properties":{"recipient_config_json":{"properties":{"bccTarget":{"type":"string"},"ccTarget":{"type":"string"},"target":{"type":"string"}},"type":"object","title":"ReportRecipientConfigJSON"},"type":{"description":"The recipient type, check spec for valid options","enum":["Email","Slack","SlackV2"],"type":"string"}},"required":["type"],"type":"object","title":"ReportRecipient"},"type":"array"},"report_format":{"enum":["PDF","PNG","CSV","TEXT"],"type":"string"},"selected_tabs":{"items":{"type":"integer"},"nullable":true,"type":"array"},"sql":{"description":"A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.","example":"SELECT value FROM time_series_table","type":"string"},"timezone":{"description":"A timezone string that represents the location of the timezone.","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"type":"string"},"type":{"description":"The report schedule type","enum":["Alert","Report"],"type":"string"},"validator_config_json":{"properties":{"op":{"description":"The operation to compare with a threshold to apply to the SQL output\n","enum":["<","<=",">",">=","==","!="],"type":"string"},"threshold":{"type":"number"}},"type":"object","title":"ValidatorConfigJSON"},"validator_type":{"description":"Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\n- Not Null - When the return value is Not NULL, Empty, or 0\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`
Supports the comparison operators <, <=, >, >=, ==, and !=","enum":["not null","operator"],"type":"string"},"working_timeout":{"description":"If an alert is staled at a working state, how long until it's state is reset to error","example":3600,"minimum":1,"type":"integer"}},"required":["crontab","name","type"],"type":"object","title":"ReportScheduleRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-post.schema.mdx new file mode 100644 index 00000000000..9fc222ba0f3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-post +title: "ReportScheduleRestApi.post" +description: "" +sidebar_label: "ReportScheduleRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"active":true,"chart":0,"context_markdown":"string","crontab":"*/5 * * * *","custom_width":1000,"dashboard":0,"database":0,"description":"Daily sales dashboard to marketing","email_subject":"[Report] Report name: Dashboard or chart name","extra":{},"force_screenshot":true,"grace_period":14400,"log_retention":90,"name":"Daily dashboard email","owners":[0],"recipients":[{"recipient_config_json":{"bccTarget":"string","ccTarget":"string","target":"string"},"type":"Email"}],"report_format":"PDF","selected_tabs":[0],"sql":"SELECT value FROM time_series_table","timezone":"Africa/Abidjan","type":"Alert","validator_config_json":{"op":"<","threshold":0},"validator_type":"not null","working_timeout":3600} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-put.Schema.json new file mode 100644 index 00000000000..7ddd4c4a152 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"active":{"type":"boolean"},"chart":{"nullable":true,"type":"integer"},"context_markdown":{"description":"Markdown description","nullable":true,"type":"string"},"creation_method":{"description":"Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.","enum":["charts","dashboards","alerts_reports"],"nullable":true},"crontab":{"description":"A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.","maxLength":1000,"minLength":1,"type":"string"},"custom_width":{"description":"Custom width of the screenshot in pixels","example":1000,"nullable":true,"type":"integer"},"dashboard":{"nullable":true,"type":"integer"},"database":{"type":"integer"},"description":{"description":"Use a nice description to give context to this Alert/Report","example":"Daily sales dashboard to marketing","nullable":true,"type":"string"},"email_subject":{"description":"The report schedule subject line","example":"[Report] Report name: Dashboard or chart name","nullable":true,"type":"string"},"extra":{"type":"object"},"force_screenshot":{"type":"boolean"},"grace_period":{"description":"Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)","example":14400,"minimum":1,"type":"integer"},"log_retention":{"description":"How long to keep the logs around for this report (in days)","example":90,"minimum":0,"type":"integer"},"name":{"description":"The report schedule name.","maxLength":150,"minLength":1,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.","type":"integer"},"type":"array"},"recipients":{"items":{"properties":{"recipient_config_json":{"properties":{"bccTarget":{"type":"string"},"ccTarget":{"type":"string"},"target":{"type":"string"}},"type":"object","title":"ReportRecipientConfigJSON"},"type":{"description":"The recipient type, check spec for valid options","enum":["Email","Slack","SlackV2"],"type":"string"}},"required":["type"],"type":"object","title":"ReportRecipient"},"type":"array"},"report_format":{"enum":["PDF","PNG","CSV","TEXT"],"type":"string"},"sql":{"description":"A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.","example":"SELECT value FROM time_series_table","nullable":true,"type":"string"},"timezone":{"description":"A timezone string that represents the location of the timezone.","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"type":"string"},"type":{"description":"The report schedule type","enum":["Alert","Report"],"type":"string"},"validator_config_json":{"properties":{"op":{"description":"The operation to compare with a threshold to apply to the SQL output\n","enum":["<","<=",">",">=","==","!="],"type":"string"},"threshold":{"type":"number"}},"type":"object","title":"ValidatorConfigJSON"},"validator_type":{"description":"Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\n- Not Null - When the return value is Not NULL, Empty, or 0\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`
Supports the comparison operators <, <=, >, >=, ==, and !=","enum":["not null","operator"],"nullable":true,"type":"string"},"working_timeout":{"description":"If an alert is staled at a working state, how long until it's state is reset to error","example":3600,"minimum":1,"nullable":true,"type":"integer"}},"type":"object","title":"ReportScheduleRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-put.schema.mdx new file mode 100644 index 00000000000..04ecb1dc5ae --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/reportschedulerestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: reportschedulerestapi-put +title: "ReportScheduleRestApi.put" +description: "" +sidebar_label: "ReportScheduleRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"active":true,"chart":0,"context_markdown":"string","crontab":"string","custom_width":1000,"dashboard":0,"database":0,"description":"Daily sales dashboard to marketing","email_subject":"[Report] Report name: Dashboard or chart name","extra":{},"force_screenshot":true,"grace_period":14400,"log_retention":90,"name":"string","owners":[0],"recipients":[{"recipient_config_json":{"bccTarget":"string","ccTarget":"string","target":"string"},"type":"Email"}],"report_format":"PDF","sql":"SELECT value FROM time_series_table","timezone":"Africa/Abidjan","type":"Alert","validator_config_json":{"op":"<","threshold":0},"validator_type":"not null","working_timeout":3600} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/resource.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/resource.Schema.json new file mode 100644 index 00000000000..4f549da2063 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/resource.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"string"},"type":{"enum":["dashboard"]}},"required":["id","type"],"type":"object","title":"Resource"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/resource.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/resource.schema.mdx new file mode 100644 index 00000000000..6e8d7da5987 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/resource.schema.mdx @@ -0,0 +1,31 @@ +--- +id: resource +title: "Resource" +description: "" +sidebar_label: "Resource" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get-list.Schema.json new file mode 100644 index 00000000000..6a14ac56122 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"changed_on_delta_humanized":{"readOnly":true},"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","type":"string"},"id":{"description":"id_description","type":"integer"},"name":{"description":"name_description","type":"string"},"roles":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","title":"Roles1"},"type":"array"},"tables":{"items":{"properties":{"id":{"type":"integer"},"schema":{"type":"string"},"table_name":{"type":"string"}},"type":"object","title":"Tables"},"type":"array"}},"type":"object","title":"RLSRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..f93b807ee0b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: rlsrestapi-get-list +title: "RLSRestApi.get_list" +description: "" +sidebar_label: "RLSRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_by":{"first_name":"string","id":0,"last_name":"string"},"clause":"string","description":"string","filter_type":"Regular","group_key":"string","id":0,"name":"string","roles":[{"id":0,"name":"string"}],"tables":[{"id":0,"schema":"string","table_name":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get.Schema.json new file mode 100644 index 00000000000..c36a0d76392 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","type":"string"},"id":{"description":"id_description","type":"integer"},"name":{"description":"name_description","type":"string"},"roles":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","title":"Roles1"},"type":"array"},"tables":{"items":{"properties":{"id":{"type":"integer"},"schema":{"type":"string"},"table_name":{"type":"string"}},"type":"object","title":"Tables"},"type":"array"}},"type":"object","title":"RLSRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get.schema.mdx new file mode 100644 index 00000000000..27bd03c5f0e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: rlsrestapi-get +title: "RLSRestApi.get" +description: "" +sidebar_label: "RLSRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"clause":"string","description":"string","filter_type":"Regular","group_key":"string","id":0,"name":"string","roles":[{"id":0,"name":"string"}],"tables":[{"id":0,"schema":"string","table_name":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-post.Schema.json new file mode 100644 index 00000000000..74fd96759e0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","nullable":true,"type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","nullable":true,"type":"string"},"name":{"description":"name_description","maxLength":255,"minLength":1,"type":"string"},"roles":{"description":"roles_description","items":{"type":"integer"},"type":"array"},"tables":{"description":"tables_description","items":{"type":"integer"},"minItems":1,"type":"array"}},"required":["clause","filter_type","name","roles","tables"],"type":"object","title":"RLSRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-post.schema.mdx new file mode 100644 index 00000000000..29bfd137549 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: rlsrestapi-post +title: "RLSRestApi.post" +description: "" +sidebar_label: "RLSRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"clause":"string","description":"string","filter_type":"Regular","group_key":"string","name":"string","roles":[0],"tables":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-put.Schema.json new file mode 100644 index 00000000000..24201ebedaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","nullable":true,"type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","nullable":true,"type":"string"},"name":{"description":"name_description","maxLength":255,"minLength":1,"type":"string"},"roles":{"description":"roles_description","items":{"type":"integer"},"type":"array"},"tables":{"description":"tables_description","items":{"type":"integer"},"type":"array"}},"type":"object","title":"RLSRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-put.schema.mdx new file mode 100644 index 00000000000..62957b1a1c1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: rlsrestapi-put +title: "RLSRestApi.put" +description: "" +sidebar_label: "RLSRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"clause":"string","description":"string","filter_type":"Regular","group_key":"string","name":"string","roles":[0],"tables":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrule.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrule.Schema.json new file mode 100644 index 00000000000..ece207d7d5d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrule.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"clause":{"type":"string"},"dataset":{"type":"integer"}},"required":["clause"],"type":"object","title":"RlsRule"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrule.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrule.schema.mdx new file mode 100644 index 00000000000..40bc1127f8c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rlsrule.schema.mdx @@ -0,0 +1,31 @@ +--- +id: rlsrule +title: "RlsRule" +description: "" +sidebar_label: "RlsRule" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"clause":"string","dataset":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionlistschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionlistschema.Schema.json new file mode 100644 index 00000000000..334fd51f6f3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionlistschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"permission_name":{"type":"string"},"view_menu_name":{"type":"string"}},"type":"object","title":"RolePermissionListSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionlistschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionlistschema.schema.mdx new file mode 100644 index 00000000000..fe4fac872dd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionlistschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: rolepermissionlistschema +title: "RolePermissionListSchema" +description: "" +sidebar_label: "RolePermissionListSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"permission_name":"string","view_menu_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionpostschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionpostschema.Schema.json new file mode 100644 index 00000000000..3c55db5f47c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionpostschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"permission_view_menu_ids":{"description":"List of permission view menu id","items":{"type":"integer"},"type":"array"}},"required":["permission_view_menu_ids"],"type":"object","title":"RolePermissionPostSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionpostschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionpostschema.schema.mdx new file mode 100644 index 00000000000..f325480c4ce --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolepermissionpostschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: rolepermissionpostschema +title: "RolePermissionPostSchema" +description: "" +sidebar_label: "RolePermissionPostSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"permission_view_menu_ids":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleresponseschema.Schema.json new file mode 100644 index 00000000000..b48af0fff95 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"permission_ids":{"items":{"type":"integer"},"type":"array"},"user_ids":{"items":{"type":"integer"},"type":"array"}},"type":"object","title":"RoleResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleresponseschema.schema.mdx new file mode 100644 index 00000000000..5e41738a423 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: roleresponseschema +title: "RoleResponseSchema" +description: "" +sidebar_label: "RoleResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string","permission_ids":[0],"user_ids":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles-1.Schema.json new file mode 100644 index 00000000000..9e9538b2b18 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","title":"Roles1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles-1.schema.mdx new file mode 100644 index 00000000000..8cf39e6e639 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: roles-1 +title: "Roles1" +description: "" +sidebar_label: "Roles1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles.Schema.json new file mode 100644 index 00000000000..d1901bb94e2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","title":"Roles"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles.schema.mdx new file mode 100644 index 00000000000..4ef87308676 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roles.schema.mdx @@ -0,0 +1,31 @@ +--- +id: roles +title: "Roles" +description: "" +sidebar_label: "Roles" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolesresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolesresponseschema.Schema.json new file mode 100644 index 00000000000..56fdbcf12e3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolesresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"count":{"type":"integer"},"ids":{"items":{"type":"integer"},"type":"array"},"result":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"permission_ids":{"items":{"type":"integer"},"type":"array"},"user_ids":{"items":{"type":"integer"},"type":"array"}},"type":"object","title":"RoleResponseSchema"},"type":"array"}},"type":"object","title":"RolesResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolesresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolesresponseschema.schema.mdx new file mode 100644 index 00000000000..b600c0e1244 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolesresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: rolesresponseschema +title: "RolesResponseSchema" +description: "" +sidebar_label: "RolesResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"count":0,"ids":[0],"result":[{"id":0,"name":"string","permission_ids":[0],"user_ids":[0]}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleuserputschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleuserputschema.Schema.json new file mode 100644 index 00000000000..712c6e771af --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleuserputschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"user_ids":{"description":"List of user ids","items":{"type":"integer"},"type":"array"}},"required":["user_ids"],"type":"object","title":"RoleUserPutSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleuserputschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleuserputschema.schema.mdx new file mode 100644 index 00000000000..9e18a35c6b4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/roleuserputschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: roleuserputschema +title: "RoleUserPutSchema" +description: "" +sidebar_label: "RoleUserPutSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"user_ids":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-database.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-database.Schema.json new file mode 100644 index 00000000000..f00dbe7d2c3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-database.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"SavedQueryRestApi.get.Database"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-database.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-database.schema.mdx new file mode 100644 index 00000000000..74f037f6d66 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-database.schema.mdx @@ -0,0 +1,31 @@ +--- +id: savedqueryrestapi-get-database +title: "SavedQueryRestApi.get.Database" +description: "" +sidebar_label: "SavedQueryRestApi.get.Database" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"database_name":"string","id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-database.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-database.Schema.json new file mode 100644 index 00000000000..833ad65456c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-database.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"SavedQueryRestApi.get_list.Database"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-database.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-database.schema.mdx new file mode 100644 index 00000000000..45fcdf19b20 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-database.schema.mdx @@ -0,0 +1,31 @@ +--- +id: savedqueryrestapi-get-list-database +title: "SavedQueryRestApi.get_list.Database" +description: "" +sidebar_label: "SavedQueryRestApi.get_list.Database" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"database_name":"string","id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-tag.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-tag.Schema.json new file mode 100644 index 00000000000..fd292239f42 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-tag.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"SavedQueryRestApi.get_list.Tag"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-tag.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-tag.schema.mdx new file mode 100644 index 00000000000..17cae66ce66 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-tag.schema.mdx @@ -0,0 +1,31 @@ +--- +id: savedqueryrestapi-get-list-tag +title: "SavedQueryRestApi.get_list.Tag" +description: "" +sidebar_label: "SavedQueryRestApi.get_list.Tag" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..895ad350ebc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..a518fa555cd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: savedqueryrestapi-get-list-user-1 +title: "SavedQueryRestApi.get_list.User1" +description: "" +sidebar_label: "SavedQueryRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..73cf9d4ca5e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..a80fb45efc0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: savedqueryrestapi-get-list-user +title: "SavedQueryRestApi.get_list.User" +description: "" +sidebar_label: "SavedQueryRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list.Schema.json new file mode 100644 index 00000000000..2b48b75f75e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get_list.User"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get_list.User1"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"SavedQueryRestApi.get_list.Database"},"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra":{"readOnly":true},"id":{"type":"integer"},"label":{"maxLength":256,"nullable":true,"type":"string"},"last_run_delta_humanized":{"readOnly":true},"rows":{"nullable":true,"type":"integer"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_tables":{"readOnly":true},"tags":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"SavedQueryRestApi.get_list.Tag"}},"type":"object","title":"SavedQueryRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..17eeefaa694 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: savedqueryrestapi-get-list +title: "SavedQueryRestApi.get_list" +description: "" +sidebar_label: "SavedQueryRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog":"string","changed_by":{"first_name":"string","id":0,"last_name":"string"},"changed_on":"2024-07-29T15:51:28.071Z","created_by":{"first_name":"string","id":0,"last_name":"string"},"created_on":"2024-07-29T15:51:28.071Z","database":{"database_name":"string","id":0},"db_id":0,"description":"string","id":0,"label":"string","rows":0,"schema":"string","sql":"string","tags":{"id":0,"name":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user-1.Schema.json new file mode 100644 index 00000000000..669f518d593 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user-1.schema.mdx new file mode 100644 index 00000000000..fff85e45325 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: savedqueryrestapi-get-user-1 +title: "SavedQueryRestApi.get.User1" +description: "" +sidebar_label: "SavedQueryRestApi.get.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user.Schema.json new file mode 100644 index 00000000000..e3733240a57 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user.schema.mdx new file mode 100644 index 00000000000..9ed3bc7c7da --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: savedqueryrestapi-get-user +title: "SavedQueryRestApi.get.User" +description: "" +sidebar_label: "SavedQueryRestApi.get.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get.Schema.json new file mode 100644 index 00000000000..bbadb991eb9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get.User"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"SavedQueryRestApi.get.User1"},"database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object","title":"SavedQueryRestApi.get.Database"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_tables":{"readOnly":true},"template_parameters":{"nullable":true,"type":"string"}},"type":"object","title":"SavedQueryRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get.schema.mdx new file mode 100644 index 00000000000..e85180f5ce2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: savedqueryrestapi-get +title: "SavedQueryRestApi.get" +description: "" +sidebar_label: "SavedQueryRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog":"string","changed_by":{"first_name":"string","id":0,"last_name":"string"},"changed_on":"2024-07-29T15:51:28.071Z","created_by":{"first_name":"string","id":0,"last_name":"string"},"database":{"database_name":"string","id":0},"description":"string","id":0,"label":"string","schema":"string","sql":"string","template_parameters":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-post.Schema.json new file mode 100644 index 00000000000..818ec78a865 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra_json":{"nullable":true,"type":"string"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"template_parameters":{"nullable":true,"type":"string"}},"type":"object","title":"SavedQueryRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-post.schema.mdx new file mode 100644 index 00000000000..23e4f75abe9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: savedqueryrestapi-post +title: "SavedQueryRestApi.post" +description: "" +sidebar_label: "SavedQueryRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog":"string","db_id":0,"description":"string","extra_json":"string","label":"string","schema":"string","sql":"string","template_parameters":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-put.Schema.json new file mode 100644 index 00000000000..f3e2a469460 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra_json":{"nullable":true,"type":"string"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"template_parameters":{"nullable":true,"type":"string"}},"type":"object","title":"SavedQueryRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-put.schema.mdx new file mode 100644 index 00000000000..488457ab506 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/savedqueryrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: savedqueryrestapi-put +title: "SavedQueryRestApi.put" +description: "" +sidebar_label: "SavedQueryRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog":"string","db_id":0,"description":"string","extra_json":"string","label":"string","schema":"string","sql":"string","template_parameters":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/schemasresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/schemasresponseschema.Schema.json new file mode 100644 index 00000000000..dac5149c983 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/schemasresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"result":{"items":{"description":"A database schema name","type":"string"},"type":"array"}},"type":"object","title":"SchemasResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/schemasresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/schemasresponseschema.schema.mdx new file mode 100644 index 00000000000..d15215f63e8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/schemasresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: schemasresponseschema +title: "SchemasResponseSchema" +description: "" +sidebar_label: "SchemasResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"result":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/screenshot-query-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/screenshot-query-schema.Schema.json new file mode 100644 index 00000000000..39b30083d46 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/screenshot-query-schema.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/screenshot-query-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/screenshot-query-schema.schema.mdx new file mode 100644 index 00000000000..508ec470864 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/screenshot-query-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: screenshot-query-schema +title: "screenshot_query_schema" +description: "" +sidebar_label: "screenshot_query_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"force":true,"thumb_size":[0],"window_size":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/selectstarresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/selectstarresponseschema.Schema.json new file mode 100644 index 00000000000..d90ed33d95c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/selectstarresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"result":{"description":"SQL select star","type":"string"}},"type":"object","title":"SelectStarResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/selectstarresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/selectstarresponseschema.schema.mdx new file mode 100644 index 00000000000..84fa666acb2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/selectstarresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: selectstarresponseschema +title: "SelectStarResponseSchema" +description: "" +sidebar_label: "SelectStarResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"result":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/slice.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/slice.Schema.json new file mode 100644 index 00000000000..85045ec3fc6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/slice.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart.","type":"integer"},"certification_details":{"description":"Details of the certification.","type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard.","type":"string"},"changed_on":{"description":"Timestamp of the last modification.","format":"date-time","type":"string"},"changed_on_humanized":{"description":"Timestamp of the last modification in human readable form.","type":"string"},"datasource":{"description":"Datasource identifier.","type":"string"},"description":{"description":"Slice description.","type":"string"},"description_markeddown":{"description":"Sanitized HTML version of the chart description.","type":"string"},"edit_url":{"description":"The URL for editing the slice.","type":"string"},"form_data":{"description":"Form data associated with the slice.","type":"object"},"is_managed_externally":{"description":"If the chart is managed outside externally.","type":"boolean"},"modified":{"description":"Last modification in human readable form.","type":"string"},"owners":{"description":"Owners identifiers.","items":{"type":"integer"},"type":"array"},"query_context":{"description":"The context associated with the query.","type":"object"},"slice_id":{"description":"The slice ID.","type":"integer"},"slice_name":{"description":"The slice name.","type":"string"},"slice_url":{"description":"The slice URL.","type":"string"}},"type":"object","title":"Slice"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/slice.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/slice.schema.mdx new file mode 100644 index 00000000000..547b84c5773 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/slice.schema.mdx @@ -0,0 +1,31 @@ +--- +id: slice +title: "Slice" +description: "" +sidebar_label: "Slice" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":0,"certification_details":"string","certified_by":"string","changed_on":"2024-07-29T15:51:28.071Z","changed_on_humanized":"string","datasource":"string","description":"string","description_markeddown":"string","edit_url":"string","form_data":{},"is_managed_externally":true,"modified":"string","owners":[0],"query_context":{},"slice_id":0,"slice_name":"string","slice_url":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sql-lab-get-results-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sql-lab-get-results-schema.Schema.json new file mode 100644 index 00000000000..de317ef174b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sql-lab-get-results-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"key":{"type":"string"}},"required":["key"],"type":"object","title":"sql_lab_get_results_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sql-lab-get-results-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sql-lab-get-results-schema.schema.mdx new file mode 100644 index 00000000000..551d5a03432 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sql-lab-get-results-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: sql-lab-get-results-schema +title: "sql_lab_get_results_schema" +description: "" +sidebar_label: "sql_lab_get_results_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"key":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabbootstrapschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabbootstrapschema.Schema.json new file mode 100644 index 00000000000..a2e9c713a75 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabbootstrapschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"active_tab":{"properties":{"active":{"type":"boolean"},"autorun":{"type":"boolean"},"database_id":{"type":"integer"},"extra_json":{"type":"object"},"hide_left_bar":{"type":"boolean"},"id":{"type":"string"},"label":{"type":"string"},"latest_query":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object","title":"QueryResult"},"query_limit":{"type":"integer"},"saved_query":{"nullable":true,"type":"object"},"schema":{"type":"string"},"sql":{"type":"string"},"table_schemas":{"items":{"properties":{"database_id":{"type":"integer"},"description":{"type":"string"},"expanded":{"type":"boolean"},"id":{"type":"integer"},"schema":{"type":"string"},"tab_state_id":{"type":"integer"},"table":{"type":"string"}},"type":"object","title":"Table"},"type":"array"},"user_id":{"type":"integer"}},"type":"object","title":"TabState"},"databases":{"additionalProperties":{"properties":{"allow_csv_upload":{"type":"boolean"},"allow_ctas":{"type":"boolean"},"allow_cvas":{"type":"boolean"},"allow_dml":{"type":"boolean"},"allow_run_async":{"type":"boolean"},"cache_timeout":{"nullable":true,"type":"integer"},"database_name":{"type":"string"},"encrypted_extra":{"nullable":true,"type":"string"},"expose_in_sqllab":{"type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"properties":{"allow_multi_catalog":{"type":"boolean"},"allows_virtual_table_explore":{"type":"boolean"},"cancel_query_on_windows_unload":{"type":"boolean"},"cost_estimate_enabled":{"type":"boolean"},"disable_data_preview":{"type":"boolean"},"disable_drill_to_detail":{"type":"boolean"},"engine_params":{"additionalProperties":{},"type":"object"},"metadata_cache_timeout":{"additionalProperties":{"type":"integer"},"type":"object"},"metadata_params":{"additionalProperties":{},"type":"object"},"schema_options":{"additionalProperties":{},"type":"object"},"schemas_allowed_for_csv_upload":{"items":{"type":"string"},"type":"array"},"version":{"nullable":true,"type":"string"}},"type":"object","title":"ImportV1DatabaseExtra"},"impersonate_user":{"type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"password":{"nullable":true,"type":"string"},"sqlalchemy_uri":{"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true},"uuid":{"format":"uuid","type":"string"},"version":{"type":"string"}},"required":["database_name","sqlalchemy_uri","uuid","version"],"type":"object","title":"ImportV1Database"},"type":"object"},"queries":{"additionalProperties":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object","title":"QueryResult"},"type":"object"},"tab_state_ids":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"SQLLabBootstrapSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabbootstrapschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabbootstrapschema.schema.mdx new file mode 100644 index 00000000000..0becbf20bda --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabbootstrapschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: sqllabbootstrapschema +title: "SQLLabBootstrapSchema" +description: "" +sidebar_label: "SQLLabBootstrapSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"active_tab":{"active":true,"autorun":true,"database_id":0,"extra_json":{},"hide_left_bar":true,"id":"string","label":"string","latest_query":{"changed_on":"2024-07-29T15:51:28.071Z","ctas":true,"db":"string","dbId":0,"endDttm":0,"errorMessage":"string","executedSql":"string","extra":{},"id":"string","limit":0,"limitingFactor":"string","progress":0,"queryId":0,"resultsKey":"string","rows":0,"schema":"string","serverId":0,"sql":"string","sqlEditorId":"string","startDttm":0,"state":"string","tab":"string","tempSchema":"string","tempTable":"string","trackingUrl":"string","user":"string","userId":0},"query_limit":0,"saved_query":{},"schema":"string","sql":"string","table_schemas":[{"database_id":0,"description":"string","expanded":true,"id":0,"schema":"string","tab_state_id":0,"table":"string"}],"user_id":0},"databases":{},"queries":{},"tab_state_ids":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabpermalinkschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabpermalinkschema.Schema.json new file mode 100644 index 00000000000..0c58cf0f3a9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabpermalinkschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"autorun":{"type":"boolean"},"catalog":{"description":"The catalog name of the query","nullable":true,"type":"string"},"dbId":{"description":"The id of the database","type":"integer"},"name":{"description":"The label of the editor tab","type":"string"},"schema":{"description":"The schema name of the query","nullable":true,"type":"string"},"sql":{"description":"SQL query text","type":"string"},"templateParams":{"description":"stringfied JSON string for template parameters","nullable":true,"type":"string"}},"required":["dbId","name","sql"],"type":"object","title":"SqlLabPermalinkSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabpermalinkschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabpermalinkschema.schema.mdx new file mode 100644 index 00000000000..2e12ccdf511 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/sqllabpermalinkschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: sqllabpermalinkschema +title: "SqlLabPermalinkSchema" +description: "" +sidebar_label: "SqlLabPermalinkSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"autorun":true,"catalog":"string","dbId":0,"name":"string","schema":"string","sql":"string","templateParams":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/stopqueryschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/stopqueryschema.Schema.json new file mode 100644 index 00000000000..c0008791ca7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/stopqueryschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"client_id":{"type":"string"}},"type":"object","title":"StopQuerySchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/stopqueryschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/stopqueryschema.schema.mdx new file mode 100644 index 00000000000..d5cccdafcce --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/stopqueryschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: stopqueryschema +title: "StopQuerySchema" +description: "" +sidebar_label: "StopQuerySchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"client_id":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get-list.Schema.json new file mode 100644 index 00000000000..16501e2564b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetRoleApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get-list.schema.mdx new file mode 100644 index 00000000000..b31de8d4ad4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetroleapi-get-list +title: "SupersetRoleApi.get_list" +description: "" +sidebar_label: "SupersetRoleApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get.Schema.json new file mode 100644 index 00000000000..427258bf549 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetRoleApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get.schema.mdx new file mode 100644 index 00000000000..45fd65fbc54 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetroleapi-get +title: "SupersetRoleApi.get" +description: "" +sidebar_label: "SupersetRoleApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-post.Schema.json new file mode 100644 index 00000000000..364c4ba9ccc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetRoleApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-post.schema.mdx new file mode 100644 index 00000000000..307bf2a2373 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetroleapi-post +title: "SupersetRoleApi.post" +description: "" +sidebar_label: "SupersetRoleApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-put.Schema.json new file mode 100644 index 00000000000..9f636d4c33d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetRoleApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-put.schema.mdx new file mode 100644 index 00000000000..cdaeb901509 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetroleapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetroleapi-put +title: "SupersetRoleApi.put" +description: "" +sidebar_label: "SupersetRoleApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-role.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-role.Schema.json new file mode 100644 index 00000000000..8931a84947c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-role.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetUserApi.get_list.Role"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-role.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-role.schema.mdx new file mode 100644 index 00000000000..aeeac185540 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-role.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-get-list-role +title: "SupersetUserApi.get_list.Role" +description: "" +sidebar_label: "SupersetUserApi.get_list.Role" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..b04c5014766 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..f6bb63bbc6b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-get-list-user-1 +title: "SupersetUserApi.get_list.User1" +description: "" +sidebar_label: "SupersetUserApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user.Schema.json new file mode 100644 index 00000000000..1c0aa2304c2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..54e9d12a4ad --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-get-list-user +title: "SupersetUserApi.get_list.User" +description: "" +sidebar_label: "SupersetUserApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list.Schema.json new file mode 100644 index 00000000000..f9db09a365b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_by":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get_list.User1"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_by":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"email":{"maxLength":320,"type":"string"},"fail_login_count":{"nullable":true,"type":"integer"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_login":{"format":"date-time","nullable":true,"type":"string"},"last_name":{"maxLength":64,"type":"string"},"login_count":{"nullable":true,"type":"integer"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetUserApi.get_list.Role"},"username":{"maxLength":64,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object","title":"SupersetUserApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list.schema.mdx new file mode 100644 index 00000000000..5579e699a9e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-get-list +title: "SupersetUserApi.get_list" +description: "" +sidebar_label: "SupersetUserApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"active":true,"changed_by":{"id":0},"changed_on":"2024-07-29T15:51:28.071Z","created_by":{"id":0},"created_on":"2024-07-29T15:51:28.071Z","email":"string","fail_login_count":0,"first_name":"string","id":0,"last_login":"2024-07-29T15:51:28.071Z","last_name":"string","login_count":0,"roles":{"id":0,"name":"string"},"username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-role.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-role.Schema.json new file mode 100644 index 00000000000..71087cd558c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-role.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetUserApi.get.Role"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-role.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-role.schema.mdx new file mode 100644 index 00000000000..8662e52dfa9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-role.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-get-role +title: "SupersetUserApi.get.Role" +description: "" +sidebar_label: "SupersetUserApi.get.Role" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user-1.Schema.json new file mode 100644 index 00000000000..82c73f26c80 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user-1.schema.mdx new file mode 100644 index 00000000000..ff0fc5b7684 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-get-user-1 +title: "SupersetUserApi.get.User1" +description: "" +sidebar_label: "SupersetUserApi.get.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user.Schema.json new file mode 100644 index 00000000000..306e7ec7740 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user.schema.mdx new file mode 100644 index 00000000000..4305c623b44 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-get-user +title: "SupersetUserApi.get.User" +description: "" +sidebar_label: "SupersetUserApi.get.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get.Schema.json new file mode 100644 index 00000000000..bbfbe8da1de --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_by":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get.User1"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_by":{"properties":{"id":{"type":"integer"}},"type":"object","title":"SupersetUserApi.get.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"email":{"maxLength":320,"type":"string"},"fail_login_count":{"nullable":true,"type":"integer"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_login":{"format":"date-time","nullable":true,"type":"string"},"last_name":{"maxLength":64,"type":"string"},"login_count":{"nullable":true,"type":"integer"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetUserApi.get.Role"},"username":{"maxLength":64,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object","title":"SupersetUserApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get.schema.mdx new file mode 100644 index 00000000000..2fcc08f4481 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-get +title: "SupersetUserApi.get" +description: "" +sidebar_label: "SupersetUserApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"active":true,"changed_by":{"id":0},"changed_on":"2024-07-29T15:51:28.071Z","created_by":{"id":0},"created_on":"2024-07-29T15:51:28.071Z","email":"string","fail_login_count":0,"first_name":"string","id":0,"last_login":"2024-07-29T15:51:28.071Z","last_name":"string","login_count":0,"roles":{"id":0,"name":"string"},"username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-post.Schema.json new file mode 100644 index 00000000000..f30889366ed --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"active":{"description":"Is user active?It's not a good policy to remove a user, just make it inactive","type":"boolean"},"email":{"description":"The user's email","type":"string"},"first_name":{"description":"The user's first name","type":"string"},"last_name":{"description":"The user's last name","type":"string"},"password":{"description":"The user's password for authentication","type":"string"},"roles":{"description":"The user's roles","items":{"type":"integer"},"minItems":1,"type":"array"},"username":{"description":"The user's username","maxLength":250,"minLength":1,"type":"string"}},"required":["email","first_name","last_name","password","roles","username"],"type":"object","title":"SupersetUserApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-post.schema.mdx new file mode 100644 index 00000000000..5939ac9b54a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-post +title: "SupersetUserApi.post" +description: "" +sidebar_label: "SupersetUserApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"active":true,"email":"string","first_name":"string","last_name":"string","password":"string","roles":[0],"username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-put.Schema.json new file mode 100644 index 00000000000..265735ae084 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"active":{"description":"Is user active?It's not a good policy to remove a user, just make it inactive","type":"boolean"},"email":{"description":"The user's email","type":"string"},"first_name":{"description":"The user's first name","type":"string"},"last_name":{"description":"The user's last name","type":"string"},"password":{"description":"The user's password for authentication","type":"string"},"roles":{"description":"The user's roles","items":{"type":"integer"},"minItems":1,"type":"array"},"username":{"description":"The user's username","maxLength":250,"minLength":1,"type":"string"}},"type":"object","title":"SupersetUserApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-put.schema.mdx new file mode 100644 index 00000000000..53c4e003c7c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-put +title: "SupersetUserApi.put" +description: "" +sidebar_label: "SupersetUserApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"active":true,"email":"string","first_name":"string","last_name":"string","password":"string","roles":[0],"username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tab.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tab.Schema.json new file mode 100644 index 00000000000..981005a35c5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tab.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"children":{"items":"circular(Tab)","type":"array"},"parents":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"value":{"type":"string"}},"type":"object","title":"Tab"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tab.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tab.schema.mdx new file mode 100644 index 00000000000..9fe1f2dd228 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tab.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tab +title: "Tab" +description: "" +sidebar_label: "Tab" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"children":[null],"parents":["string"],"title":"string","value":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/table.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/table.Schema.json new file mode 100644 index 00000000000..7766115bb2c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/table.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"database_id":{"type":"integer"},"description":{"type":"string"},"expanded":{"type":"boolean"},"id":{"type":"integer"},"schema":{"type":"string"},"tab_state_id":{"type":"integer"},"table":{"type":"string"}},"type":"object","title":"Table"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/table.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/table.schema.mdx new file mode 100644 index 00000000000..9a714d164b2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/table.schema.mdx @@ -0,0 +1,31 @@ +--- +id: table +title: "Table" +description: "" +sidebar_label: "Table" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"database_id":0,"description":"string","expanded":true,"id":0,"schema":"string","tab_state_id":0,"table":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tableextrametadataresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tableextrametadataresponseschema.Schema.json new file mode 100644 index 00000000000..628240e828b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tableextrametadataresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"clustering":{"type":"object"},"metadata":{"type":"object"},"partitions":{"type":"object"}},"type":"object","title":"TableExtraMetadataResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tableextrametadataresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tableextrametadataresponseschema.schema.mdx new file mode 100644 index 00000000000..c11c6ca2f7d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tableextrametadataresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tableextrametadataresponseschema +title: "TableExtraMetadataResponseSchema" +description: "" +sidebar_label: "TableExtraMetadataResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"clustering":{},"metadata":{},"partitions":{}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadatacolumnsresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadatacolumnsresponse.Schema.json new file mode 100644 index 00000000000..33f4c99bc1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadatacolumnsresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"duplicates_constraint":{"type":"string"},"keys":{"description":"","items":{"type":"string"},"type":"array"},"longType":{"description":"The actual backend long type for the column","type":"string"},"name":{"description":"The column name","type":"string"},"type":{"description":"The column type","type":"string"}},"type":"object","title":"TableMetadataColumnsResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadatacolumnsresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadatacolumnsresponse.schema.mdx new file mode 100644 index 00000000000..f37247f891d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadatacolumnsresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tablemetadatacolumnsresponse +title: "TableMetadataColumnsResponse" +description: "" +sidebar_label: "TableMetadataColumnsResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"duplicates_constraint":"string","keys":["string"],"longType":"string","name":"string","type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataforeignkeysindexesresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataforeignkeysindexesresponse.Schema.json new file mode 100644 index 00000000000..e649b1156ec --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataforeignkeysindexesresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"column_names":{"items":{"description":"A list of column names that compose the foreign key or index","type":"string"},"type":"array"},"name":{"description":"The name of the foreign key or index","type":"string"},"options":{"properties":{"deferrable":{"type":"boolean"},"initially":{"type":"boolean"},"match":{"type":"boolean"},"ondelete":{"type":"boolean"},"onupdate":{"type":"boolean"}},"type":"object","title":"TableMetadataOptionsResponse"},"referred_columns":{"items":{"type":"string"},"type":"array"},"referred_schema":{"type":"string"},"referred_table":{"type":"string"},"type":{"type":"string"}},"type":"object","title":"TableMetadataForeignKeysIndexesResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataforeignkeysindexesresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataforeignkeysindexesresponse.schema.mdx new file mode 100644 index 00000000000..b235329b86e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataforeignkeysindexesresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tablemetadataforeignkeysindexesresponse +title: "TableMetadataForeignKeysIndexesResponse" +description: "" +sidebar_label: "TableMetadataForeignKeysIndexesResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"column_names":["string"],"name":"string","options":{"deferrable":true,"initially":true,"match":true,"ondelete":true,"onupdate":true},"referred_columns":["string"],"referred_schema":"string","referred_table":"string","type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataoptionsresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataoptionsresponse.Schema.json new file mode 100644 index 00000000000..3f12068c2b3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataoptionsresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"deferrable":{"type":"boolean"},"initially":{"type":"boolean"},"match":{"type":"boolean"},"ondelete":{"type":"boolean"},"onupdate":{"type":"boolean"}},"type":"object","title":"TableMetadataOptionsResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataoptionsresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataoptionsresponse.schema.mdx new file mode 100644 index 00000000000..08401c5c76d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataoptionsresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tablemetadataoptionsresponse +title: "TableMetadataOptionsResponse" +description: "" +sidebar_label: "TableMetadataOptionsResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"deferrable":true,"initially":true,"match":true,"ondelete":true,"onupdate":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataprimarykeyresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataprimarykeyresponse.Schema.json new file mode 100644 index 00000000000..d0ee2f60f25 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataprimarykeyresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"column_names":{"items":{"description":"A list of column names that compose the primary key","type":"string"},"type":"array"},"name":{"description":"The primary key index name","type":"string"},"type":{"type":"string"}},"type":"object","title":"TableMetadataPrimaryKeyResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataprimarykeyresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataprimarykeyresponse.schema.mdx new file mode 100644 index 00000000000..d63fe8f510b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataprimarykeyresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tablemetadataprimarykeyresponse +title: "TableMetadataPrimaryKeyResponse" +description: "" +sidebar_label: "TableMetadataPrimaryKeyResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"column_names":["string"],"name":"string","type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataresponseschema.Schema.json new file mode 100644 index 00000000000..f7cb1fabaf8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"columns":{"description":"A list of columns and their metadata","items":{"properties":{"duplicates_constraint":{"type":"string"},"keys":{"description":"","items":{"type":"string"},"type":"array"},"longType":{"description":"The actual backend long type for the column","type":"string"},"name":{"description":"The column name","type":"string"},"type":{"description":"The column type","type":"string"}},"type":"object","title":"TableMetadataColumnsResponse"},"type":"array"},"foreignKeys":{"description":"A list of foreign keys and their metadata","items":{"properties":{"column_names":{"items":{"description":"A list of column names that compose the foreign key or index","type":"string"},"type":"array"},"name":{"description":"The name of the foreign key or index","type":"string"},"options":{"properties":{"deferrable":{"type":"boolean"},"initially":{"type":"boolean"},"match":{"type":"boolean"},"ondelete":{"type":"boolean"},"onupdate":{"type":"boolean"}},"type":"object","title":"TableMetadataOptionsResponse"},"referred_columns":{"items":{"type":"string"},"type":"array"},"referred_schema":{"type":"string"},"referred_table":{"type":"string"},"type":{"type":"string"}},"type":"object","title":"TableMetadataForeignKeysIndexesResponse"},"type":"array"},"indexes":{"description":"A list of indexes and their metadata","items":{"properties":{"column_names":{"items":{"description":"A list of column names that compose the foreign key or index","type":"string"},"type":"array"},"name":{"description":"The name of the foreign key or index","type":"string"},"options":{"properties":{"deferrable":{"type":"boolean"},"initially":{"type":"boolean"},"match":{"type":"boolean"},"ondelete":{"type":"boolean"},"onupdate":{"type":"boolean"}},"type":"object","title":"TableMetadataOptionsResponse"},"referred_columns":{"items":{"type":"string"},"type":"array"},"referred_schema":{"type":"string"},"referred_table":{"type":"string"},"type":{"type":"string"}},"type":"object","title":"TableMetadataForeignKeysIndexesResponse"},"type":"array"},"name":{"description":"The name of the table","type":"string"},"primaryKey":{"allOf":[{"properties":{"column_names":{"items":{"description":"A list of column names that compose the primary key","type":"string"},"type":"array"},"name":{"description":"The primary key index name","type":"string"},"type":{"type":"string"}},"type":"object","title":"TableMetadataPrimaryKeyResponse"}],"description":"Primary keys metadata"},"selectStar":{"description":"SQL select star","type":"string"}},"type":"object","title":"TableMetadataResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataresponseschema.schema.mdx new file mode 100644 index 00000000000..88efbd4186b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tablemetadataresponseschema +title: "TableMetadataResponseSchema" +description: "" +sidebar_label: "TableMetadataResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"columns":[{"duplicates_constraint":"string","keys":["string"],"longType":"string","name":"string","type":"string"}],"foreignKeys":[{"column_names":["string"],"name":"string","options":{"deferrable":true,"initially":true,"match":true,"ondelete":true,"onupdate":true},"referred_columns":["string"],"referred_schema":"string","referred_table":"string","type":"string"}],"indexes":[{"column_names":["string"],"name":"string","options":{"deferrable":true,"initially":true,"match":true,"ondelete":true,"onupdate":true},"referred_columns":["string"],"referred_schema":"string","referred_table":"string","type":"string"}],"name":"string","primaryKey":{"column_names":["string"],"name":"string","type":"string"},"selectStar":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tables.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tables.Schema.json new file mode 100644 index 00000000000..48571a4c818 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tables.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"schema":{"type":"string"},"table_name":{"type":"string"}},"type":"object","title":"Tables"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tables.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tables.schema.mdx new file mode 100644 index 00000000000..07d9f78173f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tables.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tables +title: "Tables" +description: "" +sidebar_label: "Tables" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"schema":"string","table_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabspayloadschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabspayloadschema.Schema.json new file mode 100644 index 00000000000..caccc4de229 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabspayloadschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"all_tabs":{"additionalProperties":{"type":"string"},"type":"object"},"tab_tree":{"items":{"properties":{"children":{"items":"circular(Tab)","type":"array"},"parents":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"value":{"type":"string"}},"type":"object","title":"Tab"},"type":"array"}},"type":"object","title":"TabsPayloadSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabspayloadschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabspayloadschema.schema.mdx new file mode 100644 index 00000000000..cb803634eb6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabspayloadschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tabspayloadschema +title: "TabsPayloadSchema" +description: "" +sidebar_label: "TabsPayloadSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"all_tabs":{},"tab_tree":[{"children":[null],"parents":["string"],"title":"string","value":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabstate.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabstate.Schema.json new file mode 100644 index 00000000000..e5c75b480b0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabstate.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"active":{"type":"boolean"},"autorun":{"type":"boolean"},"database_id":{"type":"integer"},"extra_json":{"type":"object"},"hide_left_bar":{"type":"boolean"},"id":{"type":"string"},"label":{"type":"string"},"latest_query":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object","title":"QueryResult"},"query_limit":{"type":"integer"},"saved_query":{"nullable":true,"type":"object"},"schema":{"type":"string"},"sql":{"type":"string"},"table_schemas":{"items":{"properties":{"database_id":{"type":"integer"},"description":{"type":"string"},"expanded":{"type":"boolean"},"id":{"type":"integer"},"schema":{"type":"string"},"tab_state_id":{"type":"integer"},"table":{"type":"string"}},"type":"object","title":"Table"},"type":"array"},"user_id":{"type":"integer"}},"type":"object","title":"TabState"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabstate.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabstate.schema.mdx new file mode 100644 index 00000000000..aae7eaa2e3e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tabstate.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tabstate +title: "TabState" +description: "" +sidebar_label: "TabState" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"active":true,"autorun":true,"database_id":0,"extra_json":{},"hide_left_bar":true,"id":"string","label":"string","latest_query":{"changed_on":"2024-07-29T15:51:28.071Z","ctas":true,"db":"string","dbId":0,"endDttm":0,"errorMessage":"string","executedSql":"string","extra":{},"id":"string","limit":0,"limitingFactor":"string","progress":0,"queryId":0,"resultsKey":"string","rows":0,"schema":"string","serverId":0,"sql":"string","sqlEditorId":"string","startDttm":0,"state":"string","tab":"string","tempSchema":"string","tempTable":"string","trackingUrl":"string","user":"string","userId":0},"query_limit":0,"saved_query":{},"schema":"string","sql":"string","table_schemas":[{"database_id":0,"description":"string","expanded":true,"id":0,"schema":"string","tab_state_id":0,"table":"string"}],"user_id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag.Schema.json new file mode 100644 index 00000000000..9289260e450 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"Tag"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag.schema.mdx new file mode 100644 index 00000000000..5b354bca2d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tag +title: "Tag" +description: "" +sidebar_label: "Tag" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggedobjectentityresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggedobjectentityresponseschema.Schema.json new file mode 100644 index 00000000000..ba4e516fbd3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggedobjectentityresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_on":{"format":"date-time","type":"string"},"created_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"creator":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"owners":{"items":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User1"},"type":"array"},"tags":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"}},"type":"object","title":"TagGetResponseSchema"},"type":"array"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object","title":"TaggedObjectEntityResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggedobjectentityresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggedobjectentityresponseschema.schema.mdx new file mode 100644 index 00000000000..b2f1d08f6e2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggedobjectentityresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: taggedobjectentityresponseschema +title: "TaggedObjectEntityResponseSchema" +description: "" +sidebar_label: "TaggedObjectEntityResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_on":"2024-07-29T15:51:28.071Z","created_by":{"first_name":"string","id":0,"last_name":"string"},"creator":"string","id":0,"name":"string","owners":[{"first_name":"string","id":0,"last_name":"string","username":"string"}],"tags":[{"id":0,"name":"string","type":"string"}],"type":"string","url":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggetresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggetresponseschema.Schema.json new file mode 100644 index 00000000000..f7f71eea0d8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggetresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"}},"type":"object","title":"TagGetResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggetresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggetresponseschema.schema.mdx new file mode 100644 index 00000000000..3ae46634ea2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/taggetresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: taggetresponseschema +title: "TagGetResponseSchema" +description: "" +sidebar_label: "TagGetResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string","type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagobject.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagobject.Schema.json new file mode 100644 index 00000000000..e6de7e2eb00 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagobject.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagobject.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagobject.schema.mdx new file mode 100644 index 00000000000..1bbbde6e432 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagobject.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagobject +title: "TagObject" +description: "" +sidebar_label: "TagObject" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"description":"string","name":"string","objects_to_tag":[null]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseobject.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseobject.Schema.json new file mode 100644 index 00000000000..b9da31f0c3a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseobject.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"objects_skipped":{"description":"Objects to tag","items":{},"type":"array"},"objects_tagged":{"description":"Objects to tag","items":{},"type":"array"}},"type":"object","title":"TagPostBulkResponseObject"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseobject.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseobject.schema.mdx new file mode 100644 index 00000000000..3358a50b438 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseobject.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagpostbulkresponseobject +title: "TagPostBulkResponseObject" +description: "" +sidebar_label: "TagPostBulkResponseObject" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"objects_skipped":[null],"objects_tagged":[null]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseschema.Schema.json new file mode 100644 index 00000000000..7f202492219 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseschema.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseschema.schema.mdx new file mode 100644 index 00000000000..79f8a056a1c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagpostbulkresponseschema +title: "TagPostBulkResponseSchema" +description: "" +sidebar_label: "TagPostBulkResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"result":{"objects_skipped":[null],"objects_tagged":[null]}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkschema.Schema.json new file mode 100644 index 00000000000..617ff56c7cd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkschema.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkschema.schema.mdx new file mode 100644 index 00000000000..8e9ce17a150 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagpostbulkschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagpostbulkschema +title: "TagPostBulkSchema" +description: "" +sidebar_label: "TagPostBulkSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"tags":[{"description":"string","name":"string","objects_to_tag":[null]}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..b9b8548b9fd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"TagRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..37003f9ccd4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagrestapi-get-list-user-1 +title: "TagRestApi.get_list.User1" +description: "" +sidebar_label: "TagRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..ad692f9e8dc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"TagRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..6dc0ad37914 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagrestapi-get-list-user +title: "TagRestApi.get_list.User" +description: "" +sidebar_label: "TagRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list.Schema.json new file mode 100644 index 00000000000..b8b95c6cde7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"TagRestApi.get_list.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"TagRestApi.get_list.User1"},"created_on_delta_humanized":{"readOnly":true},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"TagRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..008f5c96ac5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagrestapi-get-list +title: "TagRestApi.get_list" +description: "" +sidebar_label: "TagRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_by":{"first_name":"string","last_name":"string"},"created_by":{"first_name":"string","last_name":"string"},"description":"string","id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user-1.Schema.json new file mode 100644 index 00000000000..a2f5794981d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"email":{"maxLength":320,"type":"string"},"fail_login_count":{"nullable":true,"type":"integer"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_login":{"format":"date-time","nullable":true,"type":"string"},"last_name":{"maxLength":64,"type":"string"},"login_count":{"nullable":true,"type":"integer"},"password":{"maxLength":256,"nullable":true,"type":"string"},"username":{"maxLength":64,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object","title":"TagRestApi.get.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user-1.schema.mdx new file mode 100644 index 00000000000..cfbf5e8dd34 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagrestapi-get-user-1 +title: "TagRestApi.get.User1" +description: "" +sidebar_label: "TagRestApi.get.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"active":true,"changed_on":"2024-07-29T15:51:28.071Z","created_on":"2024-07-29T15:51:28.071Z","email":"string","fail_login_count":0,"first_name":"string","id":0,"last_login":"2024-07-29T15:51:28.071Z","last_name":"string","login_count":0,"password":"string","username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user.Schema.json new file mode 100644 index 00000000000..7514685c6cc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"TagRestApi.get.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user.schema.mdx new file mode 100644 index 00000000000..a6381d684f0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagrestapi-get-user +title: "TagRestApi.get.User" +description: "" +sidebar_label: "TagRestApi.get.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get.Schema.json new file mode 100644 index 00000000000..fed11642f9b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"TagRestApi.get.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"email":{"maxLength":320,"type":"string"},"fail_login_count":{"nullable":true,"type":"integer"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_login":{"format":"date-time","nullable":true,"type":"string"},"last_name":{"maxLength":64,"type":"string"},"login_count":{"nullable":true,"type":"integer"},"password":{"maxLength":256,"nullable":true,"type":"string"},"username":{"maxLength":64,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object","title":"TagRestApi.get.User1"},"created_on_delta_humanized":{"readOnly":true},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"TagRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get.schema.mdx new file mode 100644 index 00000000000..3704eee8843 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagrestapi-get +title: "TagRestApi.get" +description: "" +sidebar_label: "TagRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_by":{"first_name":"string","last_name":"string"},"created_by":{"active":true,"changed_on":"2024-07-29T15:51:28.071Z","created_on":"2024-07-29T15:51:28.071Z","email":"string","fail_login_count":0,"first_name":"string","id":0,"last_login":"2024-07-29T15:51:28.071Z","last_name":"string","login_count":0,"password":"string","username":"string"},"description":"string","id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-post.Schema.json new file mode 100644 index 00000000000..8d012b2158d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"description":{"nullable":true,"type":"string"},"name":{"minLength":1,"type":"string"},"objects_to_tag":{"description":"Objects to tag","items":{},"type":"array"}},"type":"object","title":"TagRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-post.schema.mdx new file mode 100644 index 00000000000..5711fcfb789 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagrestapi-post +title: "TagRestApi.post" +description: "" +sidebar_label: "TagRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"description":"string","name":"string","objects_to_tag":[null]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-put.Schema.json new file mode 100644 index 00000000000..c3dbf749948 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"description":{"nullable":true,"type":"string"},"name":{"minLength":1,"type":"string"},"objects_to_tag":{"description":"Objects to tag","items":{},"type":"array"}},"type":"object","title":"TagRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-put.schema.mdx new file mode 100644 index 00000000000..f0d9a90ea0a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tagrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tagrestapi-put +title: "TagRestApi.put" +description: "" +sidebar_label: "TagRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"description":"string","name":"string","objects_to_tag":[null]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycachepostschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycachepostschema.Schema.json new file mode 100644 index 00000000000..2b52964ec69 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycachepostschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"value":{"description":"Any type of JSON supported text.","type":"string"}},"required":["value"],"type":"object","title":"TemporaryCachePostSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycachepostschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycachepostschema.schema.mdx new file mode 100644 index 00000000000..6225e57aa21 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycachepostschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: temporarycachepostschema +title: "TemporaryCachePostSchema" +description: "" +sidebar_label: "TemporaryCachePostSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"value":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycacheputschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycacheputschema.Schema.json new file mode 100644 index 00000000000..77232bbf514 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycacheputschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"value":{"description":"Any type of JSON supported text.","type":"string"}},"required":["value"],"type":"object","title":"TemporaryCachePutSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycacheputschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycacheputschema.schema.mdx new file mode 100644 index 00000000000..124e65e53f8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/temporarycacheputschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: temporarycacheputschema +title: "TemporaryCachePutSchema" +description: "" +sidebar_label: "TemporaryCachePutSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"value":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/thumbnail-query-schema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/thumbnail-query-schema.Schema.json new file mode 100644 index 00000000000..833c35f377e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/thumbnail-query-schema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"force":{"type":"boolean"}},"type":"object","title":"thumbnail_query_schema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/thumbnail-query-schema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/thumbnail-query-schema.schema.mdx new file mode 100644 index 00000000000..247c141c9ec --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/thumbnail-query-schema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: thumbnail-query-schema +title: "thumbnail_query_schema" +description: "" +sidebar_label: "thumbnail_query_schema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"force":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadata.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadata.Schema.json new file mode 100644 index 00000000000..63997ea1ca8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadata.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"items":{"items":{"properties":{"column_names":{"description":"A list of columns names in the sheet","items":{"type":"string"},"type":"array"},"sheet_name":{"description":"The name of the sheet","type":"string"}},"type":"object","title":"UploadFileMetadataItem"},"type":"array"}},"type":"object","title":"UploadFileMetadata"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadata.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadata.schema.mdx new file mode 100644 index 00000000000..4db1e70acb1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadata.schema.mdx @@ -0,0 +1,31 @@ +--- +id: uploadfilemetadata +title: "UploadFileMetadata" +description: "" +sidebar_label: "UploadFileMetadata" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"items":[{"column_names":["string"],"sheet_name":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadataitem.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadataitem.Schema.json new file mode 100644 index 00000000000..eb4559926fb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadataitem.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"column_names":{"description":"A list of columns names in the sheet","items":{"type":"string"},"type":"array"},"sheet_name":{"description":"The name of the sheet","type":"string"}},"type":"object","title":"UploadFileMetadataItem"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadataitem.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadataitem.schema.mdx new file mode 100644 index 00000000000..f865af4c285 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadataitem.schema.mdx @@ -0,0 +1,31 @@ +--- +id: uploadfilemetadataitem +title: "UploadFileMetadataItem" +description: "" +sidebar_label: "UploadFileMetadataItem" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"column_names":["string"],"sheet_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadatapostschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadatapostschema.Schema.json new file mode 100644 index 00000000000..1615bb30f3b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadatapostschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"delimiter":{"description":"The character used to separate values in the CSV file (e.g., a comma, semicolon, or tab).","type":"string"},"file":{"description":"The file to upload","format":"binary","type":"string"},"header_row":{"description":"Row containing the headers to use as column names(0 is first line of data). Leave empty if there is no header row.","type":"integer"},"type":{"description":"File type to upload","enum":["csv","excel","columnar"]}},"required":["file","type"],"type":"object","title":"UploadFileMetadataPostSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadatapostschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadatapostschema.schema.mdx new file mode 100644 index 00000000000..c0581046f02 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadfilemetadatapostschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: uploadfilemetadatapostschema +title: "UploadFileMetadataPostSchema" +description: "" +sidebar_label: "UploadFileMetadataPostSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"delimiter":"string","file":"string","header_row":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadpostschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadpostschema.Schema.json new file mode 100644 index 00000000000..126ba206688 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadpostschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"already_exists":{"default":"fail","description":"What to do if the table already exists accepts: fail, replace, append","enum":["fail","replace","append"],"type":"string"},"column_data_types":{"description":"[CSV only] A dictionary with column names and their data types if you need to change the defaults. Example: {'user_id':'int'}. Check Python Pandas library for supported data types","type":"string"},"column_dates":{"description":"[CSV and Excel only] A list of column names that should be parsed as dates. Example: date,timestamp","items":{"type":"string"},"type":"array"},"columns_read":{"description":"A List of the column names that should be read","items":{"type":"string"},"type":"array"},"dataframe_index":{"description":"Write dataframe index as a column.","type":"boolean"},"day_first":{"description":"[CSV only] DD/MM format dates, international and European format","type":"boolean"},"decimal_character":{"description":"[CSV and Excel only] Character to recognize as decimal point. Default is '.'","type":"string"},"delimiter":{"description":"[CSV only] The character used to separate values in the CSV file (e.g., a comma, semicolon, or tab).","type":"string"},"file":{"description":"The file to upload","format":"text/csv","type":"string"},"header_row":{"description":"[CSV and Excel only] Row containing the headers to use as column names (0 is first line of data). Leave empty if there is no header row.","type":"integer"},"index_column":{"description":"[CSV and Excel only] Column to use as the row labels of the dataframe. Leave empty if no index column","type":"string"},"index_label":{"description":"Index label for index column.","type":"string"},"null_values":{"description":"[CSV and Excel only] A list of strings that should be treated as null. Examples: '' for empty strings, 'None', 'N/A', Warning: Hive database supports only a single value","items":{"type":"string"},"type":"array"},"rows_to_read":{"description":"[CSV and Excel only] Number of rows to read from the file. If None, reads all rows.","minimum":1,"nullable":true,"type":"integer"},"schema":{"description":"The schema to upload the data file to.","type":"string"},"sheet_name":{"description":"[Excel only]] Strings used for sheet names (default is the first sheet).","type":"string"},"skip_blank_lines":{"description":"[CSV only] Skip blank lines in the CSV file.","type":"boolean"},"skip_initial_space":{"description":"[CSV only] Skip spaces after delimiter.","type":"boolean"},"skip_rows":{"description":"[CSV and Excel only] Number of rows to skip at start of file.","type":"integer"},"table_name":{"description":"The name of the table to be created/appended","maxLength":10000,"minLength":1,"type":"string"},"type":{"description":"File type to upload","enum":["csv","excel","columnar"]}},"required":["file","table_name","type"],"type":"object","title":"UploadPostSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadpostschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadpostschema.schema.mdx new file mode 100644 index 00000000000..84e26c80e44 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/uploadpostschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: uploadpostschema +title: "UploadPostSchema" +description: "" +sidebar_label: "UploadPostSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"already_exists":"fail","column_data_types":"string","column_dates":["string"],"columns_read":["string"],"dataframe_index":true,"day_first":true,"decimal_character":"string","delimiter":"string","file":"string","header_row":0,"index_column":"string","index_label":"string","null_values":["string"],"rows_to_read":0,"schema":"string","sheet_name":"string","skip_blank_lines":true,"skip_initial_space":true,"skip_rows":0,"table_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-1.Schema.json new file mode 100644 index 00000000000..82a150f5fae --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-1.schema.mdx new file mode 100644 index 00000000000..ad4c33b02bb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: user-1 +title: "User1" +description: "" +sidebar_label: "User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string","username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-2.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-2.Schema.json new file mode 100644 index 00000000000..0237e25778f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-2.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User2"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-2.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-2.schema.mdx new file mode 100644 index 00000000000..ebd437e3646 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-2.schema.mdx @@ -0,0 +1,31 @@ +--- +id: user-2 +title: "User2" +description: "" +sidebar_label: "User2" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string","username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user.Schema.json new file mode 100644 index 00000000000..0809ea3eede --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user.schema.mdx new file mode 100644 index 00000000000..582af04383c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: user +title: "User" +description: "" +sidebar_label: "User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userresponseschema.Schema.json new file mode 100644 index 00000000000..b38b374e0b9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"integer"},"is_active":{"type":"boolean"},"is_anonymous":{"type":"boolean"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"UserResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userresponseschema.schema.mdx new file mode 100644 index 00000000000..eeec47e673c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: userresponseschema +title: "UserResponseSchema" +description: "" +sidebar_label: "UserResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"email":"string","first_name":"string","id":0,"is_active":true,"is_anonymous":true,"last_name":"string","username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlrequest.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlrequest.Schema.json new file mode 100644 index 00000000000..879c3153d5b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlrequest.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"catalog":{"nullable":true,"type":"string"},"schema":{"nullable":true,"type":"string"},"sql":{"description":"SQL statement to validate","type":"string"},"template_params":{"nullable":true,"type":"object"}},"required":["sql"],"type":"object","title":"ValidateSQLRequest"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlrequest.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlrequest.schema.mdx new file mode 100644 index 00000000000..c84ff3eb1a2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlrequest.schema.mdx @@ -0,0 +1,31 @@ +--- +id: validatesqlrequest +title: "ValidateSQLRequest" +description: "" +sidebar_label: "ValidateSQLRequest" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"catalog":"string","schema":"string","sql":"string","template_params":{}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlresponse.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlresponse.Schema.json new file mode 100644 index 00000000000..cddda7f9836 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlresponse.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"end_column":{"type":"integer"},"line_number":{"type":"integer"},"message":{"type":"string"},"start_column":{"type":"integer"}},"type":"object","title":"ValidateSQLResponse"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlresponse.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlresponse.schema.mdx new file mode 100644 index 00000000000..16dd92c740b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatesqlresponse.schema.mdx @@ -0,0 +1,31 @@ +--- +id: validatesqlresponse +title: "ValidateSQLResponse" +description: "" +sidebar_label: "ValidateSQLResponse" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"end_column":0,"line_number":0,"message":"string","start_column":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatorconfigjson.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatorconfigjson.Schema.json new file mode 100644 index 00000000000..35704fbd465 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatorconfigjson.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"op":{"description":"The operation to compare with a threshold to apply to the SQL output\n","enum":["<","<=",">",">=","==","!="],"type":"string"},"threshold":{"type":"number"}},"type":"object","title":"ValidatorConfigJSON"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatorconfigjson.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatorconfigjson.schema.mdx new file mode 100644 index 00000000000..b2885d405be --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/validatorconfigjson.schema.mdx @@ -0,0 +1,31 @@ +--- +id: validatorconfigjson +title: "ValidatorConfigJSON" +description: "" +sidebar_label: "ValidatorConfigJSON" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"op":"<","threshold":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get-list.Schema.json new file mode 100644 index 00000000000..b3eac5192fa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"ViewMenuApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get-list.schema.mdx new file mode 100644 index 00000000000..c0465f181d2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: viewmenuapi-get-list +title: "ViewMenuApi.get_list" +description: "" +sidebar_label: "ViewMenuApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get.Schema.json new file mode 100644 index 00000000000..d6fc40943d1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"ViewMenuApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get.schema.mdx new file mode 100644 index 00000000000..8c248f3d525 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: viewmenuapi-get +title: "ViewMenuApi.get" +description: "" +sidebar_label: "ViewMenuApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-post.Schema.json new file mode 100644 index 00000000000..e1eb25b3fff --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"ViewMenuApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-post.schema.mdx new file mode 100644 index 00000000000..5fa06bbd492 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: viewmenuapi-post +title: "ViewMenuApi.post" +description: "" +sidebar_label: "ViewMenuApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-put.Schema.json new file mode 100644 index 00000000000..9727c998881 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"ViewMenuApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-put.schema.mdx new file mode 100644 index 00000000000..76b28c2da8b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/viewmenuapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: viewmenuapi-put +title: "ViewMenuApi.put" +description: "" +sidebar_label: "ViewMenuApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/security-permissions-on-resources-view-menus.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-permissions-on-resources-view-menus.tag.mdx new file mode 100644 index 00000000000..1decc266dd9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-permissions-on-resources-view-menus.tag.mdx @@ -0,0 +1,17 @@ +--- +id: security-permissions-on-resources-view-menus +title: "Security Permissions on Resources (View Menus)" +description: "Security Permissions on Resources (View Menus)" +custom_edit_url: null +--- + +Manage permission-resource mappings. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get security permissions resources](./get-security-permissions-resources) | `/api/v1/security/permissions-resources/` | +| `POST` | [Create security permissions resources](./create-security-permissions-resources) | `/api/v1/security/permissions-resources/` | +| `GET` | [Get security permissions resources info](./get-security-permissions-resources-info) | `/api/v1/security/permissions-resources/_info` | +| `DELETE` | [Delete security permissions resources by pk](./delete-security-permissions-resources-by-pk) | `/api/v1/security/permissions-resources/{pk}` | +| `GET` | [Get security permissions resources by pk](./get-security-permissions-resources-by-pk) | `/api/v1/security/permissions-resources/{pk}` | +| `PUT` | [Update security permissions resources by pk](./update-security-permissions-resources-by-pk) | `/api/v1/security/permissions-resources/{pk}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/security-permissions.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-permissions.tag.mdx new file mode 100644 index 00000000000..07967bd4fc0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-permissions.tag.mdx @@ -0,0 +1,14 @@ +--- +id: security-permissions +title: "Security Permissions" +description: "Security Permissions" +custom_edit_url: null +--- + +View available permissions. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get security permissions](./get-security-permissions) | `/api/v1/security/permissions/` | +| `GET` | [Get security permissions info](./get-security-permissions-info) | `/api/v1/security/permissions/_info` | +| `GET` | [Get security permissions by pk](./get-security-permissions-by-pk) | `/api/v1/security/permissions/{pk}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/security-resources-view-menus.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-resources-view-menus.tag.mdx new file mode 100644 index 00000000000..8df444f2f3e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-resources-view-menus.tag.mdx @@ -0,0 +1,17 @@ +--- +id: security-resources-view-menus +title: "Security Resources (View Menus)" +description: "Security Resources (View Menus)" +custom_edit_url: null +--- + +Manage security resources (view menus). + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get security resources](./get-security-resources) | `/api/v1/security/resources/` | +| `POST` | [Create security resources](./create-security-resources) | `/api/v1/security/resources/` | +| `GET` | [Get security resources info](./get-security-resources-info) | `/api/v1/security/resources/_info` | +| `DELETE` | [Delete security resources by pk](./delete-security-resources-by-pk) | `/api/v1/security/resources/{pk}` | +| `GET` | [Get security resources by pk](./get-security-resources-by-pk) | `/api/v1/security/resources/{pk}` | +| `PUT` | [Update security resources by pk](./update-security-resources-by-pk) | `/api/v1/security/resources/{pk}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/security-roles.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-roles.tag.mdx new file mode 100644 index 00000000000..8faa7f87807 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-roles.tag.mdx @@ -0,0 +1,21 @@ +--- +id: security-roles +title: "Security Roles" +description: "Security Roles" +custom_edit_url: null +--- + +Manage security roles and their permissions. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get security roles](./get-security-roles) | `/api/v1/security/roles/` | +| `POST` | [Create security roles](./create-security-roles) | `/api/v1/security/roles/` | +| `GET` | [Get security roles info](./get-security-roles-info) | `/api/v1/security/roles/_info` | +| `DELETE` | [Delete security roles by pk](./delete-security-roles-by-pk) | `/api/v1/security/roles/{pk}` | +| `GET` | [Get security roles by pk](./get-security-roles-by-pk) | `/api/v1/security/roles/{pk}` | +| `PUT` | [Update security roles by pk](./update-security-roles-by-pk) | `/api/v1/security/roles/{pk}` | +| `POST` | [Create security roles by role_id permissions](./create-security-roles-by-role-id-permissions) | `/api/v1/security/roles/{role_id}/permissions` | +| `GET` | [Get security roles by role_id permissions](./get-security-roles-by-role-id-permissions) | `/api/v1/security/roles/{role_id}/permissions/` | +| `PUT` | [Update security roles by role_id users](./update-security-roles-by-role-id-users) | `/api/v1/security/roles/{role_id}/users` | +| `GET` | [List roles](./list-roles) | `/api/v1/security/roles/search/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/security-users.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-users.tag.mdx new file mode 100644 index 00000000000..fe041e1167a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-users.tag.mdx @@ -0,0 +1,17 @@ +--- +id: security-users +title: "Security Users" +description: "Security Users" +custom_edit_url: null +--- + +Manage user accounts. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get security users](./get-security-users) | `/api/v1/security/users/` | +| `POST` | [Create security users](./create-security-users) | `/api/v1/security/users/` | +| `GET` | [Get security users info](./get-security-users-info) | `/api/v1/security/users/_info` | +| `DELETE` | [Delete security users by pk](./delete-security-users-by-pk) | `/api/v1/security/users/{pk}` | +| `GET` | [Get security users by pk](./get-security-users-by-pk) | `/api/v1/security/users/{pk}` | +| `PUT` | [Update security users by pk](./update-security-users-by-pk) | `/api/v1/security/users/{pk}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/security.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/security.tag.mdx new file mode 100644 index 00000000000..2642a51db8b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/security.tag.mdx @@ -0,0 +1,15 @@ +--- +id: security +title: "Security" +description: "Security" +custom_edit_url: null +--- + +Authentication and token management. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get the CSRF token](./get-the-csrf-token) | `/api/v1/security/csrf_token/` | +| `POST` | [Get a guest token](./get-a-guest-token) | `/api/v1/security/guest_token/` | +| `POST` | [Create security login](./create-security-login) | `/api/v1/security/login` | +| `POST` | [Create security refresh](./create-security-refresh) | `/api/v1/security/refresh` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.ParamsDetails.json new file mode 100644 index 00000000000..74d702d0d05 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.RequestSchema.json new file mode 100644 index 00000000000..261b28be132 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"}},"required":["allowed_domains"],"type":"object","title":"EmbeddedDashboardConfig"},"example":{"allowed_domains":["string"]}}},"description":"The embedded configuration to set","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.StatusCodes.json new file mode 100644 index 00000000000..5c889d31439 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"},"changed_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User1"},"changed_on":{"format":"date-time","type":"string"},"dashboard_id":{"type":"string"},"uuid":{"type":"string"}},"type":"object","title":"EmbeddedDashboardResponseSchema"}},"type":"object"},"example":{"result":{"allowed_domains":[],"changed_on":"2024-01-15T10:30:00Z","dashboard_id":"string","uuid":"string"}}}},"description":"Successfully set the configuration"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.api.mdx new file mode 100644 index 00000000000..48031292721 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-dashboards-embedded-configuration.api.mdx @@ -0,0 +1,68 @@ +--- +id: set-a-dashboards-embedded-configuration +title: "Set a dashboard's embedded configuration" +description: "Set a dashboard's embedded configuration" +sidebar_label: "Set a dashboard's embedded configuration" +hide_title: true +hide_table_of_contents: true +api: eJytV1Fv2zgM/isCccBanNskuw0YPOyh63XYdsNWNCnucHWRKTYTe7MlT5LTeob/+4GS7dhxOuy2PcWRSIr8+JGiKsi54hkaVBr8mwoi1KFKcpNIAT4sYmQR1/FKchWxJGJSMZ0WG/Agof2cmxg8EDxD8CGJllItm32FX4pEYQS+UQV6oMMYMw5+BabMSVoblYgN1PWtE0ZtXsqoJIlQCoPC0CfP8zQJOfkz+aTJqapnKlcyR2US1FY2TeUdRstIZjwRdikxmOkDh3rtAleKl1DXfYdvRpZuO3m5+oShAQ9MYlJauMhWGEUY/dnCdC7FOrFH4D3PchI64NpN68ptTYePYcfGLgutvUJZDJiRTKMZ4Wv917kU2kHxeDr9CSAV6iI1vxRgD8KYiw1Gy1U5NrxOlDZLR6MDppKot5wIgxtUtJ7yb2kVGtUDm/XD+bzWqGZ9fx1Ua6kybsCHiBs8MUmG4I2P7GplOXC551NxcOMb/oz4ddXkee6SN9YdMm+XyzEHb4dRwuPp4ycn09nJ7OliNvX/mPrT6b+wH1XrdBvMLogxkedFGKLW6yJNS+ItMzEOCU3ePpnOfoKsGWrNN9+V5SEynSJcC16YWKrkK0Y+OytMjMI057Ou0A7E11ck609/qux+QSRvhCHSp0yj2qJiqJRUPjsTrBB4n2NoMHKLTIZhoR6I6xU3PHVy9nCNYaESU9or4tOdIe5Q3zZ8Y3tZR07bKu9PQhnh3LrnbpWUiw34EF5fvQMq2xWmu79aFiok58NCpezkH3b5Yb5gAcTG5P5kksqQp7HUxn82ffZswvNksp1NOk5OZpO2VQbAgiAQjJ28ZgGcNZmx2PvsJXKFiv12dn5+MZ8vFx/+ung/VDh3WTtZlDn6bD9xO9mIPaoC+IxlAD4LYMvTAgOoH0HtdZFeliaWohdrt9BFm2S5VIY1V58ORCDaFs5edMunudTmiM5lPwaJ53Rj5BEq/aLaA8bF0IATAPudcVuySyM/o6gbbQLgxaGgA3EciFwlwhy1zp+S8NHxcR+Ot3zL55ZfPUgGizsSSKEJlQ4JfscTw9Zowtji8OMoVC6YDE0sI4qCiLaPkN+KsX0OUeQfWxpVDqaFRemjt1Pps8hhNWaSk27BXcmo9Nnb+Yf3p67ek3V5VLHPWPaQZvUxSRPgzwPhQIq44R1Ae/A3QjLF01Rujkj0+DlQze51aDSM72a8R/qBwQM8cLjR1Cc1pcwOfz6Mga92g2Dd5YBybHuS6wiFIgoczCTs+/iOtlmEW0xlnqEwTXezDHOGqlxJI0OZ1v5kUpGp2q+ovuqRtfNCG5m1JjzYcpXwVepacGuGviNcc3t1WjfBAxRFRt2u+Us/tt8N7b9eLC5ZZ6f2gLwZ2uviHTk3d22b9mh0oXn7zSUZoViGRg5C1ehb6dqO1m3rtuOCC9I28ApWlsqv2sHm7d8LaMZ0qkO3uxtybNC1R8pLhWuFOv5RI2RFS3G1G/ovvm9SplfHWjoYhmNGjsqNxe3Y1Fsizjm57cxBqU3G7U3cPFz+RxEMDu7uaYP3ZpKnPLHzjKVk1dTHDfA8IS9m/UkKPPAHz6WuTG5bwtxAVa24xmuV1jUtfylQlW5qaznrnmyJpu8I/DVPNY587KYROLpqZplj9o2X3cGY2mlelLZk0oL+gUc3wvDlV1OaXC+13jmBflfsGRhNR1TRTuMsDNHeDA/L3vZ6ErVy8GDVvCAzGZGO4nf0VOJ3zllpMXFPHFpz91PhRidnk8hJM10vuR2Jmw+K6iAcVeUk3KVQd+jYq5SAqev/APefTu4= +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"; + + + + + + + + + + +Set a dashboard's embedded configuration + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/sidebar.js b/docs/developer_docs_versioned_docs/version-6.1.0/api/sidebar.js new file mode 100644 index 00000000000..1c552975a80 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/sidebar.js @@ -0,0 +1,3945 @@ +/* eslint-disable @typescript-eslint/ban-ts-comment */ +// @ts-nocheck +/** + * Auto-generated CommonJS sidebar from sidebar.ts + * Do not edit directly - run 'yarn generate:api-docs' to regenerate + */ + +const sidebar = { + "apisidebar": [ + { + "type": "category", + "label": "Advanced Data Type", + "link": { + "type": "doc", + "id": "api/advanced-data-type" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/return-an-advanced-data-type-response", + "label": "Return an AdvancedDataTypeResponse", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/return-a-list-of-available-advanced-data-types", + "label": "Return a list of available advanced data types", + "className": "api-method get" + } + ], + "key": "api-category-advanced-data-type" + }, + { + "type": "category", + "label": "Annotation Layers", + "link": { + "type": "doc", + "id": "api/annotation-layers" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/delete-multiple-annotation-layers-in-a-bulk-operation", + "label": "Delete multiple annotation layers in a bulk operation", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-annotation-layers-annotation-layer", + "label": "Get a list of annotation layers (annotation-layer)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-an-annotation-layer-annotation-layer", + "label": "Create an annotation layer (annotation-layer)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-annotation-layer-info", + "label": "Get metadata information about this API resource (annotation-layer--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-annotation-layer-related-column-name", + "label": "Get related fields data (annotation-layer-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-annotation-layer-annotation-layer-pk", + "label": "Delete annotation layer (annotation-layer-pk)", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-an-annotation-layer-annotation-layer-pk", + "label": "Get an annotation layer (annotation-layer-pk)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-an-annotation-layer-annotation-layer-pk", + "label": "Update an annotation layer (annotation-layer-pk)", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/bulk-delete-annotation-layers", + "label": "Bulk delete annotation layers", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation", + "label": "Get a list of annotation layers (annotation-layer-pk-annotation)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-an-annotation-layer-annotation-layer-pk-annotation", + "label": "Create an annotation layer (annotation-layer-pk-annotation)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id", + "label": "Delete annotation layer (annotation-layer-pk-annotation-annotation-id)", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id", + "label": "Get an annotation layer (annotation-layer-pk-annotation-annotation-id)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id", + "label": "Update an annotation layer (annotation-layer-pk-annotation-annotation-id)", + "className": "api-method put" + } + ], + "key": "api-category-annotation-layers" + }, + { + "type": "category", + "label": "AsyncEventsRestApi", + "link": { + "type": "doc", + "id": "api/async-events-rest-api" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/read-off-of-the-redis-events-stream", + "label": "Read off of the Redis events stream", + "className": "api-method get" + } + ], + "key": "api-category-asynceventsrestapi" + }, + { + "type": "category", + "label": "Available Domains", + "link": { + "type": "doc", + "id": "api/available-domains" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-all-available-domains", + "label": "Get all available domains", + "className": "api-method get" + } + ], + "key": "api-category-available-domains" + }, + { + "type": "category", + "label": "CSS Templates", + "link": { + "type": "doc", + "id": "api/css-templates" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-css-templates", + "label": "Bulk delete CSS templates", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-css-templates", + "label": "Get a list of CSS templates", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-css-template", + "label": "Create a CSS template", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-css-template-info", + "label": "Get metadata information about this API resource (css-template--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-css-template-related-column-name", + "label": "Get related fields data (css-template-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-css-template", + "label": "Delete a CSS template", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-css-template", + "label": "Get a CSS template", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-css-template", + "label": "Update a CSS template", + "className": "api-method put" + } + ], + "key": "api-category-css-templates" + }, + { + "type": "category", + "label": "CacheRestApi", + "link": { + "type": "doc", + "id": "api/cache-rest-api" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/invalidate-cache-records-and-remove-the-database-records", + "label": "Invalidate cache records and remove the database records", + "className": "api-method post" + } + ], + "key": "api-category-cacherestapi" + }, + { + "type": "category", + "label": "Charts", + "link": { + "type": "doc", + "id": "api/charts" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-charts", + "label": "Bulk delete charts", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-charts", + "label": "Get a list of charts", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-chart", + "label": "Create a new chart", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-chart-info", + "label": "Get metadata information about this API resource (chart--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/return-payload-data-response-for-the-given-query-chart-data", + "label": "Return payload data response for the given query (chart-data)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/return-payload-data-response-for-the-given-query-chart-data-cache-key", + "label": "Return payload data response for the given query (chart-data-cache-key)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/download-multiple-charts-as-yaml-files", + "label": "Download multiple charts as YAML files", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/check-favorited-charts-for-current-user", + "label": "Check favorited charts for current user", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/import-chart-s-with-associated-datasets-and-databases", + "label": "Import chart(s) with associated datasets and databases", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-chart-related-column-name", + "label": "Get related fields data (chart-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/warm-up-the-cache-for-the-chart", + "label": "Warm up the cache for the chart", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/delete-a-chart", + "label": "Delete a chart", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-chart-detail-information", + "label": "Get a chart detail information", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-chart", + "label": "Update a chart", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot", + "label": "Compute and cache a screenshot (chart-pk-cache-screenshot)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/return-payload-data-response-for-a-chart", + "label": "Return payload data response for a chart", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/remove-the-chart-from-the-user-favorite-list", + "label": "Remove the chart from the user favorite list", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/mark-the-chart-as-favorite-for-the-current-user", + "label": "Mark the chart as favorite for the current user", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest", + "label": "Get a computed screenshot from cache (chart-pk-screenshot-digest)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-chart-thumbnail", + "label": "Get chart thumbnail", + "className": "api-method get" + } + ], + "key": "api-category-charts" + }, + { + "type": "category", + "label": "Current User", + "link": { + "type": "doc", + "id": "api/current-user" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-the-user-object", + "label": "Get the user object", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-the-user-roles", + "label": "Get the user roles", + "className": "api-method get" + } + ], + "key": "api-category-current-user" + }, + { + "type": "category", + "label": "Dashboard Filter State", + "link": { + "type": "doc", + "id": "api/dashboard-filter-state" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/create-a-dashboards-filter-state", + "label": "Create a dashboard's filter state", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/delete-a-dashboards-filter-state-value", + "label": "Delete a dashboard's filter state value", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-dashboards-filter-state-value", + "label": "Get a dashboard's filter state value", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-dashboards-filter-state-value", + "label": "Update a dashboard's filter state value", + "className": "api-method put" + } + ], + "key": "api-category-dashboard-filter-state" + }, + { + "type": "category", + "label": "Dashboard Permanent Link", + "link": { + "type": "doc", + "id": "api/dashboard-permanent-link" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-dashboards-permanent-link-state", + "label": "Get dashboard's permanent link state", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-dashboards-permanent-link", + "label": "Create a new dashboard's permanent link", + "className": "api-method post" + } + ], + "key": "api-category-dashboard-permanent-link" + }, + { + "type": "category", + "label": "Dashboards", + "link": { + "type": "doc", + "id": "api/dashboards" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-dashboards", + "label": "Bulk delete dashboards", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-dashboards", + "label": "Get a list of dashboards", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-dashboard", + "label": "Create a new dashboard", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-dashboard-info", + "label": "Get metadata information about this API resource (dashboard--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/download-multiple-dashboards-as-yaml-files", + "label": "Download multiple dashboards as YAML files", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/check-favorited-dashboards-for-current-user", + "label": "Check favorited dashboards for current user", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/import-dashboard-s-with-associated-charts-datasets-databases", + "label": "Import dashboard(s) with associated charts/datasets/databases", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-dashboard-related-column-name", + "label": "Get related fields data (dashboard-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-dashboard-detail-information", + "label": "Get a dashboard detail information", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-dashboards-chart-definitions", + "label": "Get a dashboard's chart definitions.", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-copy-of-an-existing-dashboard", + "label": "Create a copy of an existing dashboard", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-dashboards-datasets", + "label": "Get dashboard's datasets", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-dashboards-embedded-configuration", + "label": "Delete a dashboard's embedded configuration", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-the-dashboards-embedded-configuration", + "label": "Get the dashboard's embedded configuration", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/set-a-dashboards-embedded-configuration", + "label": "Set a dashboard's embedded configuration", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/update-dashboard-by-id-or-slug-embedded", + "label": "Update dashboard by id_or_slug embedded", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/get-dashboards-tabs", + "label": "Get dashboard's tabs", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-dashboard", + "label": "Delete a dashboard", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/update-a-dashboard", + "label": "Update a dashboard", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot", + "label": "Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/update-colors-configuration-for-a-dashboard", + "label": "Update colors configuration for a dashboard.", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/remove-the-dashboard-from-the-user-favorite-list", + "label": "Remove the dashboard from the user favorite list", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/mark-the-dashboard-as-favorite-for-the-current-user", + "label": "Mark the dashboard as favorite for the current user", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/update-native-filters-configuration-for-a-dashboard", + "label": "Update native filters configuration for a dashboard.", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest", + "label": "Get a computed screenshot from cache (dashboard-pk-screenshot-digest)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-dashboards-thumbnail", + "label": "Get dashboard's thumbnail", + "className": "api-method get" + } + ], + "key": "api-category-dashboards" + }, + { + "type": "category", + "label": "Database", + "link": { + "type": "doc", + "id": "api/database" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-a-list-of-databases", + "label": "Get a list of databases", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-database", + "label": "Create a new database", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-database-info", + "label": "Get metadata information about this API resource (database--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-names-of-databases-currently-available", + "label": "Get names of databases currently available", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/download-database-s-and-associated-dataset-s-as-a-zip-file", + "label": "Download database(s) and associated dataset(s) as a zip file", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/import-database-s-with-associated-datasets", + "label": "Import database(s) with associated datasets", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/receive-personal-access-tokens-from-o-auth-2", + "label": "Receive personal access tokens from OAuth2", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-database-related-column-name", + "label": "Get related fields data (database-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/test-a-database-connection", + "label": "Test a database connection", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/upload-a-file-and-returns-file-metadata", + "label": "Upload a file and returns file metadata", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/validate-database-connection-parameters", + "label": "Validate database connection parameters", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/delete-a-database", + "label": "Delete a database", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-database", + "label": "Get a database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/change-a-database", + "label": "Change a database", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/get-all-catalogs-from-a-database", + "label": "Get all catalogs from a database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-database-connection-info", + "label": "Get a database connection info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-function-names-supported-by-a-database", + "label": "Get function names supported by a database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-charts-and-dashboards-count-associated-to-a-database", + "label": "Get charts and dashboards count associated to a database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-all-schemas-from-a-database", + "label": "Get all schemas from a database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/the-list-of-the-database-schemas-where-to-upload-information", + "label": "The list of the database schemas where to upload information", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-database-select-star-for-table-database-pk-select-star-table-name", + "label": "Get database select star for table (database-pk-select-star-table-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name", + "label": "Get database select star for table (database-pk-select-star-table-name-schema-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-ssh-tunnel", + "label": "Delete a SSH tunnel", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/re-sync-all-permissions-for-a-database-connection", + "label": "Re-sync all permissions for a database connection", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-database-table-metadata", + "label": "Get database table metadata", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name", + "label": "Get table extra metadata (database-pk-table-extra-table-name-schema-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-table-metadata", + "label": "Get table metadata", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-table-extra-metadata-database-pk-table-metadata-extra", + "label": "Get table extra metadata (database-pk-table-metadata-extra)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-list-of-tables-for-given-database", + "label": "Get a list of tables for given database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/upload-a-file-to-a-database-table", + "label": "Upload a file to a database table", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/validate-arbitrary-sql", + "label": "Validate arbitrary SQL", + "className": "api-method post" + } + ], + "key": "api-category-database" + }, + { + "type": "category", + "label": "Datasets", + "link": { + "type": "doc", + "id": "api/datasets" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-datasets", + "label": "Bulk delete datasets", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-datasets", + "label": "Get a list of datasets", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-dataset", + "label": "Create a new dataset", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-dataset-info", + "label": "Get metadata information about this API resource (dataset--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-distinct-values-from-field-data-dataset-distinct-column-name", + "label": "Get distinct values from field data (dataset-distinct-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/duplicate-a-dataset", + "label": "Duplicate a dataset", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/download-multiple-datasets-as-yaml-files", + "label": "Download multiple datasets as YAML files", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist", + "label": "Retrieve a table by name, or create it if it does not exist", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/import-dataset-s-with-associated-databases", + "label": "Import dataset(s) with associated databases", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-dataset-related-column-name", + "label": "Get related fields data (dataset-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/warm-up-the-cache-for-each-chart-powered-by-the-given-table", + "label": "Warm up the cache for each chart powered by the given table", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/delete-a-dataset", + "label": "Delete a dataset", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-dataset", + "label": "Get a dataset", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-dataset", + "label": "Update a dataset", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/delete-a-dataset-column", + "label": "Delete a dataset column", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/delete-a-dataset-metric", + "label": "Delete a dataset metric", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/refresh-and-update-columns-of-a-dataset", + "label": "Refresh and update columns of a dataset", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/get-charts-and-dashboards-count-associated-to-a-dataset", + "label": "Get charts and dashboards count associated to a dataset", + "className": "api-method get" + } + ], + "key": "api-category-datasets" + }, + { + "type": "category", + "label": "Datasources", + "link": { + "type": "doc", + "id": "api/datasources" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-possible-values-for-a-datasource-column", + "label": "Get possible values for a datasource column", + "className": "api-method get" + } + ], + "key": "api-category-datasources" + }, + { + "type": "category", + "label": "Embedded Dashboard", + "link": { + "type": "doc", + "id": "api/embedded-dashboard" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-a-report-schedule-log-embedded-dashboard-uuid", + "label": "Get a report schedule log (embedded-dashboard-uuid)", + "className": "api-method get" + } + ], + "key": "api-category-embedded-dashboard" + }, + { + "type": "category", + "label": "Explore", + "link": { + "type": "doc", + "id": "api/explore" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/assemble-explore-related-information-in-a-single-endpoint", + "label": "Assemble Explore related information in a single endpoint", + "className": "api-method get" + } + ], + "key": "api-category-explore" + }, + { + "type": "category", + "label": "Explore Form Data", + "link": { + "type": "doc", + "id": "api/explore-form-data" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/create-a-new-form-data", + "label": "Create a new form_data", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/delete-a-form-data", + "label": "Delete a form_data", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-form-data", + "label": "Get a form_data", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-an-existing-form-data", + "label": "Update an existing form_data", + "className": "api-method put" + } + ], + "key": "api-category-explore-form-data" + }, + { + "type": "category", + "label": "Explore Permanent Link", + "link": { + "type": "doc", + "id": "api/explore-permanent-link" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/create-a-new-permanent-link-explore-permalink", + "label": "Create a new permanent link (explore-permalink)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-charts-permanent-link-state", + "label": "Get chart's permanent link state", + "className": "api-method get" + } + ], + "key": "api-category-explore-permanent-link" + }, + { + "type": "category", + "label": "Import/export", + "link": { + "type": "doc", + "id": "api/import-export" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/export-all-assets", + "label": "Export all assets", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/import-multiple-assets", + "label": "Import multiple assets", + "className": "api-method post" + } + ], + "key": "api-category-import/export" + }, + { + "type": "category", + "label": "LogRestApi", + "link": { + "type": "doc", + "id": "api/log-rest-api" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-a-list-of-logs", + "label": "Get a list of logs", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-log", + "label": "Create log", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-recent-activity-data-for-a-user", + "label": "Get recent activity data for a user", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-log-detail-information", + "label": "Get a log detail information", + "className": "api-method get" + } + ], + "key": "api-category-logrestapi" + }, + { + "type": "category", + "label": "Menu", + "link": { + "type": "doc", + "id": "api/menu" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-menu", + "label": "Get menu", + "className": "api-method get" + } + ], + "key": "api-category-menu" + }, + { + "type": "category", + "label": "OpenApi", + "link": { + "type": "doc", + "id": "api/open-api" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-api-by-version-openapi", + "label": "Get api by version openapi", + "className": "api-method get" + } + ], + "key": "api-category-openapi" + }, + { + "type": "category", + "label": "Queries", + "link": { + "type": "doc", + "id": "api/queries" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-a-list-of-queries", + "label": "Get a list of queries", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-distinct-values-from-field-data-query-distinct-column-name", + "label": "Get distinct values from field data (query-distinct-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-query-related-column-name", + "label": "Get related fields data (query-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/manually-stop-a-query-with-client-id", + "label": "Manually stop a query with client_id", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-a-list-of-queries-that-changed-after-last-updated-ms", + "label": "Get a list of queries that changed after last_updated_ms", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-query-detail-information", + "label": "Get query detail information", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/bulk-delete-saved-queries", + "label": "Bulk delete saved queries", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-saved-queries", + "label": "Get a list of saved queries", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-saved-query", + "label": "Create a saved query", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-saved-query-info", + "label": "Get metadata information about this API resource (saved-query--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-distinct-values-from-field-data-saved-query-distinct-column-name", + "label": "Get distinct values from field data (saved-query-distinct-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/download-multiple-saved-queries-as-yaml-files", + "label": "Download multiple saved queries as YAML files", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/import-saved-queries-with-associated-databases", + "label": "Import saved queries with associated databases", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-saved-query-related-column-name", + "label": "Get related fields data (saved-query-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-saved-query", + "label": "Delete a saved query", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-saved-query", + "label": "Get a saved query", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-saved-query", + "label": "Update a saved query", + "className": "api-method put" + } + ], + "key": "api-category-queries" + }, + { + "type": "category", + "label": "Report Schedules", + "link": { + "type": "doc", + "id": "api/report-schedules" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-report-schedules", + "label": "Bulk delete report schedules", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-report-schedules", + "label": "Get a list of report schedules", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-report-schedule", + "label": "Create a report schedule", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-report-info", + "label": "Get metadata information about this API resource (report--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-report-related-column-name", + "label": "Get related fields data (report-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-slack-channels", + "label": "Get slack channels", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-report-schedule", + "label": "Delete a report schedule", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-report-schedule", + "label": "Get a report schedule", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-report-schedule", + "label": "Update a report schedule", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/get-a-list-of-report-schedule-logs", + "label": "Get a list of report schedule logs", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-report-schedule-log-report-pk-log-log-id", + "label": "Get a report schedule log (report-pk-log-log-id)", + "className": "api-method get" + } + ], + "key": "api-category-report-schedules" + }, + { + "type": "category", + "label": "Row Level Security", + "link": { + "type": "doc", + "id": "api/row-level-security" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-rls-rules", + "label": "Bulk delete RLS rules", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-rls", + "label": "Get a list of RLS", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-rls-rule", + "label": "Create a new RLS rule", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info", + "label": "Get metadata information about this API resource (rowlevelsecurity--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-rowlevelsecurity-related-column-name", + "label": "Get related fields data (rowlevelsecurity-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-an-rls", + "label": "Delete an RLS", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-an-rls", + "label": "Get an RLS", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-an-rls-rule", + "label": "Update an RLS rule", + "className": "api-method put" + } + ], + "key": "api-category-row-level-security" + }, + { + "type": "category", + "label": "SQL Lab", + "link": { + "type": "doc", + "id": "api/sql-lab" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-the-bootstrap-data-for-sql-lab-page", + "label": "Get the bootstrap data for SqlLab page", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/estimate-the-sql-query-execution-cost", + "label": "Estimate the SQL query execution cost", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/execute-a-sql-query", + "label": "Execute a SQL query", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/export-the-sql-query-results-to-a-csv", + "label": "Export the SQL query results to a CSV", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/format-sql-code", + "label": "Format SQL code", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-the-result-of-a-sql-query-execution", + "label": "Get the result of a SQL query execution", + "className": "api-method get" + } + ], + "key": "api-category-sql-lab" + }, + { + "type": "category", + "label": "SQL Lab Permanent Link", + "link": { + "type": "doc", + "id": "api/sql-lab-permanent-link" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/create-a-new-permanent-link-sqllab-permalink", + "label": "Create a new permanent link (sqllab-permalink)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-permanent-link-state-for-sql-lab-editor", + "label": "Get permanent link state for SQLLab editor.", + "className": "api-method get" + } + ], + "key": "api-category-sql-lab-permanent-link" + }, + { + "type": "category", + "label": "Security", + "link": { + "type": "doc", + "id": "api/security" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-the-csrf-token", + "label": "Get the CSRF token", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-guest-token", + "label": "Get a guest token", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/create-security-login", + "label": "Create security login", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/create-security-refresh", + "label": "Create security refresh", + "className": "api-method post" + } + ], + "key": "api-category-security" + }, + { + "type": "category", + "label": "Security Permissions", + "link": { + "type": "doc", + "id": "api/security-permissions" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-security-permissions", + "label": "Get security permissions", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-security-permissions-info", + "label": "Get security permissions info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-security-permissions-by-pk", + "label": "Get security permissions by pk", + "className": "api-method get" + } + ], + "key": "api-category-security-permissions" + }, + { + "type": "category", + "label": "Security Permissions on Resources (View Menus)", + "link": { + "type": "doc", + "id": "api/security-permissions-on-resources-view-menus" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-security-permissions-resources", + "label": "Get security permissions resources", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-security-permissions-resources", + "label": "Create security permissions resources", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-security-permissions-resources-info", + "label": "Get security permissions resources info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-security-permissions-resources-by-pk", + "label": "Delete security permissions resources by pk", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-security-permissions-resources-by-pk", + "label": "Get security permissions resources by pk", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-security-permissions-resources-by-pk", + "label": "Update security permissions resources by pk", + "className": "api-method put" + } + ], + "key": "api-category-security-permissions-on-resources-(view-menus)" + }, + { + "type": "category", + "label": "Security Resources (View Menus)", + "link": { + "type": "doc", + "id": "api/security-resources-view-menus" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-security-resources", + "label": "Get security resources", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-security-resources", + "label": "Create security resources", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-security-resources-info", + "label": "Get security resources info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-security-resources-by-pk", + "label": "Delete security resources by pk", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-security-resources-by-pk", + "label": "Get security resources by pk", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-security-resources-by-pk", + "label": "Update security resources by pk", + "className": "api-method put" + } + ], + "key": "api-category-security-resources-(view-menus)" + }, + { + "type": "category", + "label": "Security Roles", + "link": { + "type": "doc", + "id": "api/security-roles" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-security-roles", + "label": "Get security roles", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-security-roles", + "label": "Create security roles", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-security-roles-info", + "label": "Get security roles info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/list-roles", + "label": "List roles", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-security-roles-by-pk", + "label": "Delete security roles by pk", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-security-roles-by-pk", + "label": "Get security roles by pk", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-security-roles-by-pk", + "label": "Update security roles by pk", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/create-security-roles-by-role-id-permissions", + "label": "Create security roles by role_id permissions", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-security-roles-by-role-id-permissions", + "label": "Get security roles by role_id permissions", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-security-roles-by-role-id-users", + "label": "Update security roles by role_id users", + "className": "api-method put" + } + ], + "key": "api-category-security-roles" + }, + { + "type": "category", + "label": "Security Users", + "link": { + "type": "doc", + "id": "api/security-users" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-security-users", + "label": "Get security users", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-security-users", + "label": "Create security users", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-security-users-info", + "label": "Get security users info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-security-users-by-pk", + "label": "Delete security users by pk", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-security-users-by-pk", + "label": "Get security users by pk", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-security-users-by-pk", + "label": "Update security users by pk", + "className": "api-method put" + } + ], + "key": "api-category-security-users" + }, + { + "type": "category", + "label": "Tags", + "link": { + "type": "doc", + "id": "api/tags" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-tags", + "label": "Bulk delete tags", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-tags", + "label": "Get a list of tags", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-tag", + "label": "Create a tag", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-tag-api-endpoints", + "label": "Get metadata information about tag API endpoints", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/bulk-create-tags-and-tagged-objects", + "label": "Bulk create tags and tagged objects", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-tag-favorite-status", + "label": "Get tag favorite status", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-all-objects-associated-with-a-tag", + "label": "Get all objects associated with a tag", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-tag-related-column-name", + "label": "Get related fields data (tag-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/add-tags-to-an-object", + "label": "Add tags to an object", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/delete-a-tagged-object", + "label": "Delete a tagged object", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/delete-a-tag", + "label": "Delete a tag", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-tag-detail-information", + "label": "Get a tag detail information", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-tag", + "label": "Update a tag", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/delete-tag-by-pk-favorites", + "label": "Delete tag by pk favorites", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/create-tag-by-pk-favorites", + "label": "Create tag by pk favorites", + "className": "api-method post" + } + ], + "key": "api-category-tags" + }, + { + "type": "category", + "label": "User", + "link": { + "type": "doc", + "id": "api/user" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-the-user-avatar", + "label": "Get the user avatar", + "className": "api-method get" + } + ], + "key": "api-category-user" + }, + { + "type": "category", + "label": "Schemas", + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/schemas/advanceddatatypeschema", + "label": "AdvancedDataTypeSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayer", + "label": "AnnotationLayer", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-get", + "label": "AnnotationLayerRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-get-list", + "label": "AnnotationLayerRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-get-list-user", + "label": "AnnotationLayerRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-get-list-user-1", + "label": "AnnotationLayerRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-post", + "label": "AnnotationLayerRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-put", + "label": "AnnotationLayerRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-get", + "label": "AnnotationRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-get-annotationlayer", + "label": "AnnotationRestApi.get.AnnotationLayer", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-get-list", + "label": "AnnotationRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-get-list-user", + "label": "AnnotationRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-get-list-user-1", + "label": "AnnotationRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-post", + "label": "AnnotationRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-put", + "label": "AnnotationRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/availabledomainsschema", + "label": "AvailableDomainsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/cacheinvalidationrequestschema", + "label": "CacheInvalidationRequestSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/cacherestapi-get", + "label": "CacheRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/cacherestapi-get-list", + "label": "CacheRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/cacherestapi-post", + "label": "CacheRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/cacherestapi-put", + "label": "CacheRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/catalogsresponseschema", + "label": "CatalogsResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartcachescreenshotresponseschema", + "label": "ChartCacheScreenshotResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartcachewarmuprequestschema", + "label": "ChartCacheWarmUpRequestSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartcachewarmupresponseschema", + "label": "ChartCacheWarmUpResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartcachewarmupresponsesingle", + "label": "ChartCacheWarmUpResponseSingle", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataadhocmetricschema", + "label": "ChartDataAdhocMetricSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataaggregateoptionsschema", + "label": "ChartDataAggregateOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataasyncresponseschema", + "label": "ChartDataAsyncResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataboxplotoptionsschema", + "label": "ChartDataBoxplotOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatacolumn", + "label": "ChartDataColumn", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatacontributionoptionsschema", + "label": "ChartDataContributionOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatadatasource", + "label": "ChartDataDatasource", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataextras", + "label": "ChartDataExtras", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatafilter", + "label": "ChartDataFilter", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatageodeticparseoptionsschema", + "label": "ChartDataGeodeticParseOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatageohashdecodeoptionsschema", + "label": "ChartDataGeohashDecodeOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatageohashencodeoptionsschema", + "label": "ChartDataGeohashEncodeOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatapivotoptionsschema", + "label": "ChartDataPivotOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatapostprocessingoperation", + "label": "ChartDataPostProcessingOperation", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataprophetoptionsschema", + "label": "ChartDataProphetOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataquerycontextschema", + "label": "ChartDataQueryContextSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataqueryobject", + "label": "ChartDataQueryObject", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataresponseresult", + "label": "ChartDataResponseResult", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataresponseschema", + "label": "ChartDataResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get", + "label": "ChartDataRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-dashboard", + "label": "ChartDataRestApi.get.Dashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-tag", + "label": "ChartDataRestApi.get.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-user", + "label": "ChartDataRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list", + "label": "ChartDataRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-dashboard", + "label": "ChartDataRestApi.get_list.Dashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-sqlatable", + "label": "ChartDataRestApi.get_list.SqlaTable", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-tag", + "label": "ChartDataRestApi.get_list.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-user", + "label": "ChartDataRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-user-1", + "label": "ChartDataRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-user-2", + "label": "ChartDataRestApi.get_list.User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-user-3", + "label": "ChartDataRestApi.get_list.User3", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-post", + "label": "ChartDataRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-put", + "label": "ChartDataRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarollingoptionsschema", + "label": "ChartDataRollingOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataselectoptionsschema", + "label": "ChartDataSelectOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatasortoptionsschema", + "label": "ChartDataSortOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartentityresponseschema", + "label": "ChartEntityResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartfavstarresponseresult", + "label": "ChartFavStarResponseResult", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartgetdatasourceobjectdataresponse", + "label": "ChartGetDatasourceObjectDataResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartgetdatasourceobjectresponse", + "label": "ChartGetDatasourceObjectResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartgetdatasourceresponseschema", + "label": "ChartGetDatasourceResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get", + "label": "ChartRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-dashboard", + "label": "ChartRestApi.get.Dashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-tag", + "label": "ChartRestApi.get.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-user", + "label": "ChartRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list", + "label": "ChartRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-dashboard", + "label": "ChartRestApi.get_list.Dashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-sqlatable", + "label": "ChartRestApi.get_list.SqlaTable", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-tag", + "label": "ChartRestApi.get_list.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-user", + "label": "ChartRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-user-1", + "label": "ChartRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-user-2", + "label": "ChartRestApi.get_list.User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-user-3", + "label": "ChartRestApi.get_list.User3", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-post", + "label": "ChartRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-put", + "label": "ChartRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get", + "label": "CssTemplateRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get-user", + "label": "CssTemplateRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get-user-1", + "label": "CssTemplateRestApi.get.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get-list", + "label": "CssTemplateRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get-list-user", + "label": "CssTemplateRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get-list-user-1", + "label": "CssTemplateRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-post", + "label": "CssTemplateRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-put", + "label": "CssTemplateRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardcachescreenshotresponseschema", + "label": "DashboardCacheScreenshotResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardcopyschema", + "label": "DashboardCopySchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboarddatasetschema", + "label": "DashboardDatasetSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardgetresponseschema", + "label": "DashboardGetResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardpermalinkstateschema", + "label": "DashboardPermalinkStateSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get", + "label": "DashboardRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list", + "label": "DashboardRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list-role", + "label": "DashboardRestApi.get_list.Role", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list-tag", + "label": "DashboardRestApi.get_list.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list-user", + "label": "DashboardRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list-user-1", + "label": "DashboardRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list-user-2", + "label": "DashboardRestApi.get_list.User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-post", + "label": "DashboardRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-put", + "label": "DashboardRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/database", + "label": "Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/database-1", + "label": "Database1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaseconnectionschema", + "label": "DatabaseConnectionSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databasefunctionnamesresponse", + "label": "DatabaseFunctionNamesResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserelatedchart", + "label": "DatabaseRelatedChart", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserelatedcharts", + "label": "DatabaseRelatedCharts", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserelateddashboard", + "label": "DatabaseRelatedDashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserelateddashboards", + "label": "DatabaseRelatedDashboards", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserelatedobjectsresponse", + "label": "DatabaseRelatedObjectsResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-get", + "label": "DatabaseRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-get-list", + "label": "DatabaseRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-get-list-user", + "label": "DatabaseRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-get-list-user-1", + "label": "DatabaseRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-post", + "label": "DatabaseRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-put", + "label": "DatabaseRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databasesshtunnel", + "label": "DatabaseSSHTunnel", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaseschemaaccessforfileuploadresponse", + "label": "DatabaseSchemaAccessForFileUploadResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databasetablesresponse", + "label": "DatabaseTablesResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databasetestconnectionschema", + "label": "DatabaseTestConnectionSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databasevalidateparametersschema", + "label": "DatabaseValidateParametersSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dataset", + "label": "Dataset", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcachewarmuprequestschema", + "label": "DatasetCacheWarmUpRequestSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcachewarmupresponseschema", + "label": "DatasetCacheWarmUpResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcachewarmupresponsesingle", + "label": "DatasetCacheWarmUpResponseSingle", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcolumnsput", + "label": "DatasetColumnsPut", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcolumnsrestapi-get", + "label": "DatasetColumnsRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcolumnsrestapi-get-list", + "label": "DatasetColumnsRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcolumnsrestapi-post", + "label": "DatasetColumnsRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcolumnsrestapi-put", + "label": "DatasetColumnsRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetduplicateschema", + "label": "DatasetDuplicateSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetmetricrestapi-get", + "label": "DatasetMetricRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetmetricrestapi-get-list", + "label": "DatasetMetricRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetmetricrestapi-post", + "label": "DatasetMetricRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetmetricrestapi-put", + "label": "DatasetMetricRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetmetricsput", + "label": "DatasetMetricsPut", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrelatedchart", + "label": "DatasetRelatedChart", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrelatedcharts", + "label": "DatasetRelatedCharts", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrelateddashboard", + "label": "DatasetRelatedDashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrelateddashboards", + "label": "DatasetRelatedDashboards", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrelatedobjectsresponse", + "label": "DatasetRelatedObjectsResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get", + "label": "DatasetRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-database", + "label": "DatasetRestApi.get.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-sqlmetric", + "label": "DatasetRestApi.get.SqlMetric", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-tablecolumn", + "label": "DatasetRestApi.get.TableColumn", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-user", + "label": "DatasetRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-user-1", + "label": "DatasetRestApi.get.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-user-2", + "label": "DatasetRestApi.get.User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-list", + "label": "DatasetRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-list-database", + "label": "DatasetRestApi.get_list.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-list-user", + "label": "DatasetRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-list-user-1", + "label": "DatasetRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-post", + "label": "DatasetRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-put", + "label": "DatasetRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasource", + "label": "Datasource", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/distincresponseschema", + "label": "DistincResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/distinctresultresponse", + "label": "DistinctResultResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardconfig", + "label": "EmbeddedDashboardConfig", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardresponseschema", + "label": "EmbeddedDashboardResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardrestapi-get", + "label": "EmbeddedDashboardRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardrestapi-get-list", + "label": "EmbeddedDashboardRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardrestapi-post", + "label": "EmbeddedDashboardRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardrestapi-put", + "label": "EmbeddedDashboardRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/engineinformation", + "label": "EngineInformation", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/estimatequerycostschema", + "label": "EstimateQueryCostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/executepayloadschema", + "label": "ExecutePayloadSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/explorecontextschema", + "label": "ExploreContextSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/explorepermalinkstateschema", + "label": "ExplorePermalinkStateSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/folder", + "label": "Folder", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/formdatapostschema", + "label": "FormDataPostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/formdataputschema", + "label": "FormDataPutSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/getfavstaridsschema", + "label": "GetFavStarIdsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/getorcreatedatasetschema", + "label": "GetOrCreateDatasetSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/guesttokencreate", + "label": "GuestTokenCreate", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/importv-1-database", + "label": "ImportV1Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/importv-1-databaseextra", + "label": "ImportV1DatabaseExtra", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-get", + "label": "LogRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-get-user", + "label": "LogRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-get-list", + "label": "LogRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-get-list-user", + "label": "LogRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-post", + "label": "LogRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-put", + "label": "LogRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionapi-get", + "label": "PermissionApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionapi-get-list", + "label": "PermissionApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionapi-post", + "label": "PermissionApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionapi-put", + "label": "PermissionApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get", + "label": "PermissionViewMenuApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get-permission", + "label": "PermissionViewMenuApi.get.Permission", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get-viewmenu", + "label": "PermissionViewMenuApi.get.ViewMenu", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get-list", + "label": "PermissionViewMenuApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get-list-permission", + "label": "PermissionViewMenuApi.get_list.Permission", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get-list-viewmenu", + "label": "PermissionViewMenuApi.get_list.ViewMenu", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-post", + "label": "PermissionViewMenuApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-put", + "label": "PermissionViewMenuApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryexecutionresponseschema", + "label": "QueryExecutionResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryrestapi-get", + "label": "QueryRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryrestapi-get-database", + "label": "QueryRestApi.get.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryrestapi-get-list", + "label": "QueryRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryrestapi-post", + "label": "QueryRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryrestapi-put", + "label": "QueryRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryresult", + "label": "QueryResult", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rlsrestapi-get", + "label": "RLSRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rlsrestapi-get-list", + "label": "RLSRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rlsrestapi-post", + "label": "RLSRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rlsrestapi-put", + "label": "RLSRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/recentactivity", + "label": "RecentActivity", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/recentactivityresponseschema", + "label": "RecentActivityResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/recentactivityschema", + "label": "RecentActivitySchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/relatedresponseschema", + "label": "RelatedResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/relatedresultresponse", + "label": "RelatedResultResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportexecutionlogrestapi-get", + "label": "ReportExecutionLogRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportexecutionlogrestapi-get-list", + "label": "ReportExecutionLogRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportexecutionlogrestapi-post", + "label": "ReportExecutionLogRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportexecutionlogrestapi-put", + "label": "ReportExecutionLogRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportrecipient", + "label": "ReportRecipient", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportrecipientconfigjson", + "label": "ReportRecipientConfigJSON", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get", + "label": "ReportScheduleRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-dashboard", + "label": "ReportScheduleRestApi.get.Dashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-database", + "label": "ReportScheduleRestApi.get.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-reportrecipients", + "label": "ReportScheduleRestApi.get.ReportRecipients", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-slice", + "label": "ReportScheduleRestApi.get.Slice", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-user", + "label": "ReportScheduleRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-list", + "label": "ReportScheduleRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-list-reportrecipients", + "label": "ReportScheduleRestApi.get_list.ReportRecipients", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-list-user", + "label": "ReportScheduleRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-list-user-1", + "label": "ReportScheduleRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-list-user-2", + "label": "ReportScheduleRestApi.get_list.User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-post", + "label": "ReportScheduleRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-put", + "label": "ReportScheduleRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/resource", + "label": "Resource", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rlsrule", + "label": "RlsRule", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rolepermissionlistschema", + "label": "RolePermissionListSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rolepermissionpostschema", + "label": "RolePermissionPostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/roleresponseschema", + "label": "RoleResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/roleuserputschema", + "label": "RoleUserPutSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/roles", + "label": "Roles", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/roles-1", + "label": "Roles1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rolesresponseschema", + "label": "RolesResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/sqllabbootstrapschema", + "label": "SQLLabBootstrapSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get", + "label": "SavedQueryRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-database", + "label": "SavedQueryRestApi.get.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-user", + "label": "SavedQueryRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-user-1", + "label": "SavedQueryRestApi.get.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-list", + "label": "SavedQueryRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-list-database", + "label": "SavedQueryRestApi.get_list.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-list-tag", + "label": "SavedQueryRestApi.get_list.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-list-user", + "label": "SavedQueryRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-list-user-1", + "label": "SavedQueryRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-post", + "label": "SavedQueryRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-put", + "label": "SavedQueryRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/schemasresponseschema", + "label": "SchemasResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/selectstarresponseschema", + "label": "SelectStarResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/slice", + "label": "Slice", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/sqllabpermalinkschema", + "label": "SqlLabPermalinkSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/stopqueryschema", + "label": "StopQuerySchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetroleapi-get", + "label": "SupersetRoleApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetroleapi-get-list", + "label": "SupersetRoleApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetroleapi-post", + "label": "SupersetRoleApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetroleapi-put", + "label": "SupersetRoleApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get", + "label": "SupersetUserApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-role", + "label": "SupersetUserApi.get.Role", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-user", + "label": "SupersetUserApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-user-1", + "label": "SupersetUserApi.get.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-list", + "label": "SupersetUserApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-list-role", + "label": "SupersetUserApi.get_list.Role", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-list-user", + "label": "SupersetUserApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-list-user-1", + "label": "SupersetUserApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-post", + "label": "SupersetUserApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-put", + "label": "SupersetUserApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tab", + "label": "Tab", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tabstate", + "label": "TabState", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/table", + "label": "Table", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tableextrametadataresponseschema", + "label": "TableExtraMetadataResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tablemetadatacolumnsresponse", + "label": "TableMetadataColumnsResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tablemetadataforeignkeysindexesresponse", + "label": "TableMetadataForeignKeysIndexesResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tablemetadataoptionsresponse", + "label": "TableMetadataOptionsResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tablemetadataprimarykeyresponse", + "label": "TableMetadataPrimaryKeyResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tablemetadataresponseschema", + "label": "TableMetadataResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tables", + "label": "Tables", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tabspayloadschema", + "label": "TabsPayloadSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tag", + "label": "Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/taggetresponseschema", + "label": "TagGetResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagobject", + "label": "TagObject", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagpostbulkresponseobject", + "label": "TagPostBulkResponseObject", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagpostbulkresponseschema", + "label": "TagPostBulkResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagpostbulkschema", + "label": "TagPostBulkSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get", + "label": "TagRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get-user", + "label": "TagRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get-user-1", + "label": "TagRestApi.get.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get-list", + "label": "TagRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get-list-user", + "label": "TagRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get-list-user-1", + "label": "TagRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-post", + "label": "TagRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-put", + "label": "TagRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/taggedobjectentityresponseschema", + "label": "TaggedObjectEntityResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/temporarycachepostschema", + "label": "TemporaryCachePostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/temporarycacheputschema", + "label": "TemporaryCachePutSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/uploadfilemetadata", + "label": "UploadFileMetadata", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/uploadfilemetadataitem", + "label": "UploadFileMetadataItem", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/uploadfilemetadatapostschema", + "label": "UploadFileMetadataPostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/uploadpostschema", + "label": "UploadPostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/user", + "label": "User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/user-1", + "label": "User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/user-2", + "label": "User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/userresponseschema", + "label": "UserResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/validatesqlrequest", + "label": "ValidateSQLRequest", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/validatesqlresponse", + "label": "ValidateSQLResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/validatorconfigjson", + "label": "ValidatorConfigJSON", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/viewmenuapi-get", + "label": "ViewMenuApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/viewmenuapi-get-list", + "label": "ViewMenuApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/viewmenuapi-post", + "label": "ViewMenuApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/viewmenuapi-put", + "label": "ViewMenuApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/advanced-data-type-convert-schema", + "label": "advanced_data_type_convert_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/database-catalogs-query-schema", + "label": "database_catalogs_query_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/database-schemas-query-schema", + "label": "database_schemas_query_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/database-tables-query-schema", + "label": "database_tables_query_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/delete-tags-schema", + "label": "delete_tags_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-delete-ids-schema", + "label": "get_delete_ids_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-export-ids-schema", + "label": "get_export_ids_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-fav-star-ids-schema", + "label": "get_fav_star_ids_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-info-schema", + "label": "get_info_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-item-schema", + "label": "get_item_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-list-schema", + "label": "get_list_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-recent-activity-schema", + "label": "get_recent_activity_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-related-schema", + "label": "get_related_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queries-get-updated-since-schema", + "label": "queries_get_updated_since_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/screenshot-query-schema", + "label": "screenshot_query_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/sql-lab-get-results-schema", + "label": "sql_lab_get_results_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/thumbnail-query-schema", + "label": "thumbnail_query_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardscreenshotpostschema", + "label": "DashboardScreenshotPostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardnativefiltersconfigupdateschema", + "label": "DashboardNativeFiltersConfigUpdateSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardcolorsconfigupdateschema", + "label": "DashboardColorsConfigUpdateSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/formatquerypayloadschema", + "label": "FormatQueryPayloadSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-slack-channels-schema", + "label": "get_slack_channels_schema", + "className": "schema" + } + ], + "key": "api-category-schemas" + } + ] +}; + +module.exports = sidebar.apisidebar; diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/sidebar.ts b/docs/developer_docs_versioned_docs/version-6.1.0/api/sidebar.ts new file mode 100644 index 00000000000..180523555ff --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/sidebar.ts @@ -0,0 +1,3904 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "category", + label: "Advanced Data Type", + link: { + type: "doc", + id: "api/advanced-data-type", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/return-an-advanced-data-type-response", + label: "Return an AdvancedDataTypeResponse", + className: "api-method get", + }, + { + type: "doc", + id: "api/return-a-list-of-available-advanced-data-types", + label: "Return a list of available advanced data types", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Annotation Layers", + link: { + type: "doc", + id: "api/annotation-layers", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/delete-multiple-annotation-layers-in-a-bulk-operation", + label: "Delete multiple annotation layers in a bulk operation", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-list-of-annotation-layers-annotation-layer", + label: "Get a list of annotation layers (annotation-layer)", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-an-annotation-layer-annotation-layer", + label: "Create an annotation layer (annotation-layer)", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-metadata-information-about-this-api-resource-annotation-layer-info", + label: "Get metadata information about this API resource (annotation-layer--info)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-related-fields-data-annotation-layer-related-column-name", + label: "Get related fields data (annotation-layer-related-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-annotation-layer-annotation-layer-pk", + label: "Delete annotation layer (annotation-layer-pk)", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-an-annotation-layer-annotation-layer-pk", + label: "Get an annotation layer (annotation-layer-pk)", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-an-annotation-layer-annotation-layer-pk", + label: "Update an annotation layer (annotation-layer-pk)", + className: "api-method put", + }, + { + type: "doc", + id: "api/bulk-delete-annotation-layers", + label: "Bulk delete annotation layers", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation", + label: "Get a list of annotation layers (annotation-layer-pk-annotation)", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-an-annotation-layer-annotation-layer-pk-annotation", + label: "Create an annotation layer (annotation-layer-pk-annotation)", + className: "api-method post", + }, + { + type: "doc", + id: "api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id", + label: "Delete annotation layer (annotation-layer-pk-annotation-annotation-id)", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id", + label: "Get an annotation layer (annotation-layer-pk-annotation-annotation-id)", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id", + label: "Update an annotation layer (annotation-layer-pk-annotation-annotation-id)", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "AsyncEventsRestApi", + link: { + type: "doc", + id: "api/async-events-rest-api", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/read-off-of-the-redis-events-stream", + label: "Read off of the Redis events stream", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Available Domains", + link: { + type: "doc", + id: "api/available-domains", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-all-available-domains", + label: "Get all available domains", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "CSS Templates", + link: { + type: "doc", + id: "api/css-templates", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/bulk-delete-css-templates", + label: "Bulk delete CSS templates", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-list-of-css-templates", + label: "Get a list of CSS templates", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-a-css-template", + label: "Create a CSS template", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-metadata-information-about-this-api-resource-css-template-info", + label: "Get metadata information about this API resource (css-template--info)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-related-fields-data-css-template-related-column-name", + label: "Get related fields data (css-template-related-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-a-css-template", + label: "Delete a CSS template", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-css-template", + label: "Get a CSS template", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-a-css-template", + label: "Update a CSS template", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "CacheRestApi", + link: { + type: "doc", + id: "api/cache-rest-api", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/invalidate-cache-records-and-remove-the-database-records", + label: "Invalidate cache records and remove the database records", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Charts", + link: { + type: "doc", + id: "api/charts", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/bulk-delete-charts", + label: "Bulk delete charts", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-list-of-charts", + label: "Get a list of charts", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-a-new-chart", + label: "Create a new chart", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-metadata-information-about-this-api-resource-chart-info", + label: "Get metadata information about this API resource (chart--info)", + className: "api-method get", + }, + { + type: "doc", + id: "api/return-payload-data-response-for-the-given-query-chart-data", + label: "Return payload data response for the given query (chart-data)", + className: "api-method post", + }, + { + type: "doc", + id: "api/return-payload-data-response-for-the-given-query-chart-data-cache-key", + label: "Return payload data response for the given query (chart-data-cache-key)", + className: "api-method get", + }, + { + type: "doc", + id: "api/download-multiple-charts-as-yaml-files", + label: "Download multiple charts as YAML files", + className: "api-method get", + }, + { + type: "doc", + id: "api/check-favorited-charts-for-current-user", + label: "Check favorited charts for current user", + className: "api-method get", + }, + { + type: "doc", + id: "api/import-chart-s-with-associated-datasets-and-databases", + label: "Import chart(s) with associated datasets and databases", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-related-fields-data-chart-related-column-name", + label: "Get related fields data (chart-related-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/warm-up-the-cache-for-the-chart", + label: "Warm up the cache for the chart", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-a-chart", + label: "Delete a chart", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-chart-detail-information", + label: "Get a chart detail information", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-a-chart", + label: "Update a chart", + className: "api-method put", + }, + { + type: "doc", + id: "api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot", + label: "Compute and cache a screenshot (chart-pk-cache-screenshot)", + className: "api-method get", + }, + { + type: "doc", + id: "api/return-payload-data-response-for-a-chart", + label: "Return payload data response for a chart", + className: "api-method get", + }, + { + type: "doc", + id: "api/remove-the-chart-from-the-user-favorite-list", + label: "Remove the chart from the user favorite list", + className: "api-method delete", + }, + { + type: "doc", + id: "api/mark-the-chart-as-favorite-for-the-current-user", + label: "Mark the chart as favorite for the current user", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest", + label: "Get a computed screenshot from cache (chart-pk-screenshot-digest)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-chart-thumbnail", + label: "Get chart thumbnail", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Current User", + link: { + type: "doc", + id: "api/current-user", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-the-user-object", + label: "Get the user object", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-the-user-roles", + label: "Get the user roles", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Dashboard Filter State", + link: { + type: "doc", + id: "api/dashboard-filter-state", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/create-a-dashboards-filter-state", + label: "Create a dashboard's filter state", + className: "api-method post", + }, + { + type: "doc", + id: "api/delete-a-dashboards-filter-state-value", + label: "Delete a dashboard's filter state value", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-dashboards-filter-state-value", + label: "Get a dashboard's filter state value", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-a-dashboards-filter-state-value", + label: "Update a dashboard's filter state value", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Dashboard Permanent Link", + link: { + type: "doc", + id: "api/dashboard-permanent-link", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-dashboards-permanent-link-state", + label: "Get dashboard's permanent link state", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-a-new-dashboards-permanent-link", + label: "Create a new dashboard's permanent link", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Dashboards", + link: { + type: "doc", + id: "api/dashboards", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/bulk-delete-dashboards", + label: "Bulk delete dashboards", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-list-of-dashboards", + label: "Get a list of dashboards", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-a-new-dashboard", + label: "Create a new dashboard", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-metadata-information-about-this-api-resource-dashboard-info", + label: "Get metadata information about this API resource (dashboard--info)", + className: "api-method get", + }, + { + type: "doc", + id: "api/download-multiple-dashboards-as-yaml-files", + label: "Download multiple dashboards as YAML files", + className: "api-method get", + }, + { + type: "doc", + id: "api/check-favorited-dashboards-for-current-user", + label: "Check favorited dashboards for current user", + className: "api-method get", + }, + { + type: "doc", + id: "api/import-dashboard-s-with-associated-charts-datasets-databases", + label: "Import dashboard(s) with associated charts/datasets/databases", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-related-fields-data-dashboard-related-column-name", + label: "Get related fields data (dashboard-related-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-a-dashboard-detail-information", + label: "Get a dashboard detail information", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-a-dashboards-chart-definitions", + label: "Get a dashboard's chart definitions.", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-a-copy-of-an-existing-dashboard", + label: "Create a copy of an existing dashboard", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-dashboards-datasets", + label: "Get dashboard's datasets", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-a-dashboards-embedded-configuration", + label: "Delete a dashboard's embedded configuration", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-the-dashboards-embedded-configuration", + label: "Get the dashboard's embedded configuration", + className: "api-method get", + }, + { + type: "doc", + id: "api/set-a-dashboards-embedded-configuration", + label: "Set a dashboard's embedded configuration", + className: "api-method post", + }, + { + type: "doc", + id: "api/update-dashboard-by-id-or-slug-embedded", + label: "Update dashboard by id_or_slug embedded", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-dashboards-tabs", + label: "Get dashboard's tabs", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-a-dashboard", + label: "Delete a dashboard", + className: "api-method delete", + }, + { + type: "doc", + id: "api/update-a-dashboard", + label: "Update a dashboard", + className: "api-method put", + }, + { + type: "doc", + id: "api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot", + label: "Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)", + className: "api-method post", + }, + { + type: "doc", + id: "api/update-colors-configuration-for-a-dashboard", + label: "Update colors configuration for a dashboard.", + className: "api-method put", + }, + { + type: "doc", + id: "api/remove-the-dashboard-from-the-user-favorite-list", + label: "Remove the dashboard from the user favorite list", + className: "api-method delete", + }, + { + type: "doc", + id: "api/mark-the-dashboard-as-favorite-for-the-current-user", + label: "Mark the dashboard as favorite for the current user", + className: "api-method post", + }, + { + type: "doc", + id: "api/update-native-filters-configuration-for-a-dashboard", + label: "Update native filters configuration for a dashboard.", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest", + label: "Get a computed screenshot from cache (dashboard-pk-screenshot-digest)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-dashboards-thumbnail", + label: "Get dashboard's thumbnail", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Database", + link: { + type: "doc", + id: "api/database", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-a-list-of-databases", + label: "Get a list of databases", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-a-new-database", + label: "Create a new database", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-metadata-information-about-this-api-resource-database-info", + label: "Get metadata information about this API resource (database--info)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-names-of-databases-currently-available", + label: "Get names of databases currently available", + className: "api-method get", + }, + { + type: "doc", + id: "api/download-database-s-and-associated-dataset-s-as-a-zip-file", + label: "Download database(s) and associated dataset(s) as a zip file", + className: "api-method get", + }, + { + type: "doc", + id: "api/import-database-s-with-associated-datasets", + label: "Import database(s) with associated datasets", + className: "api-method post", + }, + { + type: "doc", + id: "api/receive-personal-access-tokens-from-o-auth-2", + label: "Receive personal access tokens from OAuth2", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-related-fields-data-database-related-column-name", + label: "Get related fields data (database-related-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/test-a-database-connection", + label: "Test a database connection", + className: "api-method post", + }, + { + type: "doc", + id: "api/upload-a-file-and-returns-file-metadata", + label: "Upload a file and returns file metadata", + className: "api-method post", + }, + { + type: "doc", + id: "api/validate-database-connection-parameters", + label: "Validate database connection parameters", + className: "api-method post", + }, + { + type: "doc", + id: "api/delete-a-database", + label: "Delete a database", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-database", + label: "Get a database", + className: "api-method get", + }, + { + type: "doc", + id: "api/change-a-database", + label: "Change a database", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-all-catalogs-from-a-database", + label: "Get all catalogs from a database", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-a-database-connection-info", + label: "Get a database connection info", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-function-names-supported-by-a-database", + label: "Get function names supported by a database", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-charts-and-dashboards-count-associated-to-a-database", + label: "Get charts and dashboards count associated to a database", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-all-schemas-from-a-database", + label: "Get all schemas from a database", + className: "api-method get", + }, + { + type: "doc", + id: "api/the-list-of-the-database-schemas-where-to-upload-information", + label: "The list of the database schemas where to upload information", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-database-select-star-for-table-database-pk-select-star-table-name", + label: "Get database select star for table (database-pk-select-star-table-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name", + label: "Get database select star for table (database-pk-select-star-table-name-schema-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-a-ssh-tunnel", + label: "Delete a SSH tunnel", + className: "api-method delete", + }, + { + type: "doc", + id: "api/re-sync-all-permissions-for-a-database-connection", + label: "Re-sync all permissions for a database connection", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-database-table-metadata", + label: "Get database table metadata", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name", + label: "Get table extra metadata (database-pk-table-extra-table-name-schema-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-table-metadata", + label: "Get table metadata", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-table-extra-metadata-database-pk-table-metadata-extra", + label: "Get table extra metadata (database-pk-table-metadata-extra)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-a-list-of-tables-for-given-database", + label: "Get a list of tables for given database", + className: "api-method get", + }, + { + type: "doc", + id: "api/upload-a-file-to-a-database-table", + label: "Upload a file to a database table", + className: "api-method post", + }, + { + type: "doc", + id: "api/validate-arbitrary-sql", + label: "Validate arbitrary SQL", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Datasets", + link: { + type: "doc", + id: "api/datasets", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/bulk-delete-datasets", + label: "Bulk delete datasets", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-list-of-datasets", + label: "Get a list of datasets", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-a-new-dataset", + label: "Create a new dataset", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-metadata-information-about-this-api-resource-dataset-info", + label: "Get metadata information about this API resource (dataset--info)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-distinct-values-from-field-data-dataset-distinct-column-name", + label: "Get distinct values from field data (dataset-distinct-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/duplicate-a-dataset", + label: "Duplicate a dataset", + className: "api-method post", + }, + { + type: "doc", + id: "api/download-multiple-datasets-as-yaml-files", + label: "Download multiple datasets as YAML files", + className: "api-method get", + }, + { + type: "doc", + id: "api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist", + label: "Retrieve a table by name, or create it if it does not exist", + className: "api-method post", + }, + { + type: "doc", + id: "api/import-dataset-s-with-associated-databases", + label: "Import dataset(s) with associated databases", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-related-fields-data-dataset-related-column-name", + label: "Get related fields data (dataset-related-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/warm-up-the-cache-for-each-chart-powered-by-the-given-table", + label: "Warm up the cache for each chart powered by the given table", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-a-dataset", + label: "Delete a dataset", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-dataset", + label: "Get a dataset", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-a-dataset", + label: "Update a dataset", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-a-dataset-column", + label: "Delete a dataset column", + className: "api-method delete", + }, + { + type: "doc", + id: "api/delete-a-dataset-metric", + label: "Delete a dataset metric", + className: "api-method delete", + }, + { + type: "doc", + id: "api/refresh-and-update-columns-of-a-dataset", + label: "Refresh and update columns of a dataset", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-charts-and-dashboards-count-associated-to-a-dataset", + label: "Get charts and dashboards count associated to a dataset", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Datasources", + link: { + type: "doc", + id: "api/datasources", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-possible-values-for-a-datasource-column", + label: "Get possible values for a datasource column", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Embedded Dashboard", + link: { + type: "doc", + id: "api/embedded-dashboard", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-a-report-schedule-log-embedded-dashboard-uuid", + label: "Get a report schedule log (embedded-dashboard-uuid)", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Explore", + link: { + type: "doc", + id: "api/explore", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/assemble-explore-related-information-in-a-single-endpoint", + label: "Assemble Explore related information in a single endpoint", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Explore Form Data", + link: { + type: "doc", + id: "api/explore-form-data", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/create-a-new-form-data", + label: "Create a new form_data", + className: "api-method post", + }, + { + type: "doc", + id: "api/delete-a-form-data", + label: "Delete a form_data", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-form-data", + label: "Get a form_data", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-an-existing-form-data", + label: "Update an existing form_data", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Explore Permanent Link", + link: { + type: "doc", + id: "api/explore-permanent-link", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/create-a-new-permanent-link-explore-permalink", + label: "Create a new permanent link (explore-permalink)", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-charts-permanent-link-state", + label: "Get chart's permanent link state", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Import/export", + link: { + type: "doc", + id: "api/import-export", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/export-all-assets", + label: "Export all assets", + className: "api-method get", + }, + { + type: "doc", + id: "api/import-multiple-assets", + label: "Import multiple assets", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "LogRestApi", + link: { + type: "doc", + id: "api/log-rest-api", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-a-list-of-logs", + label: "Get a list of logs", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-log", + label: "Create log", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-recent-activity-data-for-a-user", + label: "Get recent activity data for a user", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-a-log-detail-information", + label: "Get a log detail information", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Menu", + link: { + type: "doc", + id: "api/menu", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-menu", + label: "Get menu", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "OpenApi", + link: { + type: "doc", + id: "api/open-api", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-api-by-version-openapi", + label: "Get api by version openapi", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Queries", + link: { + type: "doc", + id: "api/queries", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-a-list-of-queries", + label: "Get a list of queries", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-distinct-values-from-field-data-query-distinct-column-name", + label: "Get distinct values from field data (query-distinct-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-related-fields-data-query-related-column-name", + label: "Get related fields data (query-related-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/manually-stop-a-query-with-client-id", + label: "Manually stop a query with client_id", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-a-list-of-queries-that-changed-after-last-updated-ms", + label: "Get a list of queries that changed after last_updated_ms", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-query-detail-information", + label: "Get query detail information", + className: "api-method get", + }, + { + type: "doc", + id: "api/bulk-delete-saved-queries", + label: "Bulk delete saved queries", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-list-of-saved-queries", + label: "Get a list of saved queries", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-a-saved-query", + label: "Create a saved query", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-metadata-information-about-this-api-resource-saved-query-info", + label: "Get metadata information about this API resource (saved-query--info)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-distinct-values-from-field-data-saved-query-distinct-column-name", + label: "Get distinct values from field data (saved-query-distinct-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/download-multiple-saved-queries-as-yaml-files", + label: "Download multiple saved queries as YAML files", + className: "api-method get", + }, + { + type: "doc", + id: "api/import-saved-queries-with-associated-databases", + label: "Import saved queries with associated databases", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-related-fields-data-saved-query-related-column-name", + label: "Get related fields data (saved-query-related-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-a-saved-query", + label: "Delete a saved query", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-saved-query", + label: "Get a saved query", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-a-saved-query", + label: "Update a saved query", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Report Schedules", + link: { + type: "doc", + id: "api/report-schedules", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/bulk-delete-report-schedules", + label: "Bulk delete report schedules", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-list-of-report-schedules", + label: "Get a list of report schedules", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-a-report-schedule", + label: "Create a report schedule", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-metadata-information-about-this-api-resource-report-info", + label: "Get metadata information about this API resource (report--info)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-related-fields-data-report-related-column-name", + label: "Get related fields data (report-related-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-slack-channels", + label: "Get slack channels", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-a-report-schedule", + label: "Delete a report schedule", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-report-schedule", + label: "Get a report schedule", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-a-report-schedule", + label: "Update a report schedule", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-a-list-of-report-schedule-logs", + label: "Get a list of report schedule logs", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-a-report-schedule-log-report-pk-log-log-id", + label: "Get a report schedule log (report-pk-log-log-id)", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Row Level Security", + link: { + type: "doc", + id: "api/row-level-security", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/bulk-delete-rls-rules", + label: "Bulk delete RLS rules", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-list-of-rls", + label: "Get a list of RLS", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-a-new-rls-rule", + label: "Create a new RLS rule", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info", + label: "Get metadata information about this API resource (rowlevelsecurity--info)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-related-fields-data-rowlevelsecurity-related-column-name", + label: "Get related fields data (rowlevelsecurity-related-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-an-rls", + label: "Delete an RLS", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-an-rls", + label: "Get an RLS", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-an-rls-rule", + label: "Update an RLS rule", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "SQL Lab", + link: { + type: "doc", + id: "api/sql-lab", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-the-bootstrap-data-for-sql-lab-page", + label: "Get the bootstrap data for SqlLab page", + className: "api-method get", + }, + { + type: "doc", + id: "api/estimate-the-sql-query-execution-cost", + label: "Estimate the SQL query execution cost", + className: "api-method post", + }, + { + type: "doc", + id: "api/execute-a-sql-query", + label: "Execute a SQL query", + className: "api-method post", + }, + { + type: "doc", + id: "api/export-the-sql-query-results-to-a-csv", + label: "Export the SQL query results to a CSV", + className: "api-method get", + }, + { + type: "doc", + id: "api/format-sql-code", + label: "Format SQL code", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-the-result-of-a-sql-query-execution", + label: "Get the result of a SQL query execution", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "SQL Lab Permanent Link", + link: { + type: "doc", + id: "api/sql-lab-permanent-link", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/create-a-new-permanent-link-sqllab-permalink", + label: "Create a new permanent link (sqllab-permalink)", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-permanent-link-state-for-sql-lab-editor", + label: "Get permanent link state for SQLLab editor.", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Security", + link: { + type: "doc", + id: "api/security", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-the-csrf-token", + label: "Get the CSRF token", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-a-guest-token", + label: "Get a guest token", + className: "api-method post", + }, + { + type: "doc", + id: "api/create-security-login", + label: "Create security login", + className: "api-method post", + }, + { + type: "doc", + id: "api/create-security-refresh", + label: "Create security refresh", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Security Permissions", + link: { + type: "doc", + id: "api/security-permissions", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-security-permissions", + label: "Get security permissions", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-security-permissions-info", + label: "Get security permissions info", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-security-permissions-by-pk", + label: "Get security permissions by pk", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Security Permissions on Resources (View Menus)", + link: { + type: "doc", + id: "api/security-permissions-on-resources-view-menus", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-security-permissions-resources", + label: "Get security permissions resources", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-security-permissions-resources", + label: "Create security permissions resources", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-security-permissions-resources-info", + label: "Get security permissions resources info", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-security-permissions-resources-by-pk", + label: "Delete security permissions resources by pk", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-security-permissions-resources-by-pk", + label: "Get security permissions resources by pk", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-security-permissions-resources-by-pk", + label: "Update security permissions resources by pk", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Security Resources (View Menus)", + link: { + type: "doc", + id: "api/security-resources-view-menus", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-security-resources", + label: "Get security resources", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-security-resources", + label: "Create security resources", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-security-resources-info", + label: "Get security resources info", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-security-resources-by-pk", + label: "Delete security resources by pk", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-security-resources-by-pk", + label: "Get security resources by pk", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-security-resources-by-pk", + label: "Update security resources by pk", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Security Roles", + link: { + type: "doc", + id: "api/security-roles", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-security-roles", + label: "Get security roles", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-security-roles", + label: "Create security roles", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-security-roles-info", + label: "Get security roles info", + className: "api-method get", + }, + { + type: "doc", + id: "api/list-roles", + label: "List roles", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-security-roles-by-pk", + label: "Delete security roles by pk", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-security-roles-by-pk", + label: "Get security roles by pk", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-security-roles-by-pk", + label: "Update security roles by pk", + className: "api-method put", + }, + { + type: "doc", + id: "api/create-security-roles-by-role-id-permissions", + label: "Create security roles by role_id permissions", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-security-roles-by-role-id-permissions", + label: "Get security roles by role_id permissions", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-security-roles-by-role-id-users", + label: "Update security roles by role_id users", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Security Users", + link: { + type: "doc", + id: "api/security-users", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-security-users", + label: "Get security users", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-security-users", + label: "Create security users", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-security-users-info", + label: "Get security users info", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-security-users-by-pk", + label: "Delete security users by pk", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-security-users-by-pk", + label: "Get security users by pk", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-security-users-by-pk", + label: "Update security users by pk", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Tags", + link: { + type: "doc", + id: "api/tags", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/bulk-delete-tags", + label: "Bulk delete tags", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-list-of-tags", + label: "Get a list of tags", + className: "api-method get", + }, + { + type: "doc", + id: "api/create-a-tag", + label: "Create a tag", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-metadata-information-about-tag-api-endpoints", + label: "Get metadata information about tag API endpoints", + className: "api-method get", + }, + { + type: "doc", + id: "api/bulk-create-tags-and-tagged-objects", + label: "Bulk create tags and tagged objects", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-tag-favorite-status", + label: "Get tag favorite status", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-all-objects-associated-with-a-tag", + label: "Get all objects associated with a tag", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-related-fields-data-tag-related-column-name", + label: "Get related fields data (tag-related-column-name)", + className: "api-method get", + }, + { + type: "doc", + id: "api/add-tags-to-an-object", + label: "Add tags to an object", + className: "api-method post", + }, + { + type: "doc", + id: "api/delete-a-tagged-object", + label: "Delete a tagged object", + className: "api-method delete", + }, + { + type: "doc", + id: "api/delete-a-tag", + label: "Delete a tag", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-a-tag-detail-information", + label: "Get a tag detail information", + className: "api-method get", + }, + { + type: "doc", + id: "api/update-a-tag", + label: "Update a tag", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-tag-by-pk-favorites", + label: "Delete tag by pk favorites", + className: "api-method delete", + }, + { + type: "doc", + id: "api/create-tag-by-pk-favorites", + label: "Create tag by pk favorites", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "User", + link: { + type: "doc", + id: "api/user", + }, + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/get-the-user-avatar", + label: "Get the user avatar", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Schemas", + collapsible: true, + collapsed: true, + items: [ + { + type: "doc", + id: "api/schemas/advanceddatatypeschema", + label: "AdvancedDataTypeSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationlayer", + label: "AnnotationLayer", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationlayerrestapi-get", + label: "AnnotationLayerRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationlayerrestapi-get-list", + label: "AnnotationLayerRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationlayerrestapi-get-list-user", + label: "AnnotationLayerRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationlayerrestapi-get-list-user-1", + label: "AnnotationLayerRestApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationlayerrestapi-post", + label: "AnnotationLayerRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationlayerrestapi-put", + label: "AnnotationLayerRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationrestapi-get", + label: "AnnotationRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationrestapi-get-annotationlayer", + label: "AnnotationRestApi.get.AnnotationLayer", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationrestapi-get-list", + label: "AnnotationRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationrestapi-get-list-user", + label: "AnnotationRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationrestapi-get-list-user-1", + label: "AnnotationRestApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationrestapi-post", + label: "AnnotationRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/annotationrestapi-put", + label: "AnnotationRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/availabledomainsschema", + label: "AvailableDomainsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/cacheinvalidationrequestschema", + label: "CacheInvalidationRequestSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/cacherestapi-get", + label: "CacheRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/cacherestapi-get-list", + label: "CacheRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/cacherestapi-post", + label: "CacheRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/cacherestapi-put", + label: "CacheRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/catalogsresponseschema", + label: "CatalogsResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartcachescreenshotresponseschema", + label: "ChartCacheScreenshotResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartcachewarmuprequestschema", + label: "ChartCacheWarmUpRequestSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartcachewarmupresponseschema", + label: "ChartCacheWarmUpResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartcachewarmupresponsesingle", + label: "ChartCacheWarmUpResponseSingle", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdataadhocmetricschema", + label: "ChartDataAdhocMetricSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdataaggregateoptionsschema", + label: "ChartDataAggregateOptionsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdataasyncresponseschema", + label: "ChartDataAsyncResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdataboxplotoptionsschema", + label: "ChartDataBoxplotOptionsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatacolumn", + label: "ChartDataColumn", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatacontributionoptionsschema", + label: "ChartDataContributionOptionsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatadatasource", + label: "ChartDataDatasource", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdataextras", + label: "ChartDataExtras", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatafilter", + label: "ChartDataFilter", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatageodeticparseoptionsschema", + label: "ChartDataGeodeticParseOptionsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatageohashdecodeoptionsschema", + label: "ChartDataGeohashDecodeOptionsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatageohashencodeoptionsschema", + label: "ChartDataGeohashEncodeOptionsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatapivotoptionsschema", + label: "ChartDataPivotOptionsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatapostprocessingoperation", + label: "ChartDataPostProcessingOperation", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdataprophetoptionsschema", + label: "ChartDataProphetOptionsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdataquerycontextschema", + label: "ChartDataQueryContextSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdataqueryobject", + label: "ChartDataQueryObject", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdataresponseresult", + label: "ChartDataResponseResult", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdataresponseschema", + label: "ChartDataResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get", + label: "ChartDataRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get-dashboard", + label: "ChartDataRestApi.get.Dashboard", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get-tag", + label: "ChartDataRestApi.get.Tag", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get-user", + label: "ChartDataRestApi.get.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get-list", + label: "ChartDataRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get-list-dashboard", + label: "ChartDataRestApi.get_list.Dashboard", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get-list-sqlatable", + label: "ChartDataRestApi.get_list.SqlaTable", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get-list-tag", + label: "ChartDataRestApi.get_list.Tag", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get-list-user", + label: "ChartDataRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get-list-user-1", + label: "ChartDataRestApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get-list-user-2", + label: "ChartDataRestApi.get_list.User2", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-get-list-user-3", + label: "ChartDataRestApi.get_list.User3", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-post", + label: "ChartDataRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarestapi-put", + label: "ChartDataRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatarollingoptionsschema", + label: "ChartDataRollingOptionsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdataselectoptionsschema", + label: "ChartDataSelectOptionsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartdatasortoptionsschema", + label: "ChartDataSortOptionsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartentityresponseschema", + label: "ChartEntityResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartfavstarresponseresult", + label: "ChartFavStarResponseResult", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartgetdatasourceobjectdataresponse", + label: "ChartGetDatasourceObjectDataResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartgetdatasourceobjectresponse", + label: "ChartGetDatasourceObjectResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartgetdatasourceresponseschema", + label: "ChartGetDatasourceResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get", + label: "ChartRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get-dashboard", + label: "ChartRestApi.get.Dashboard", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get-tag", + label: "ChartRestApi.get.Tag", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get-user", + label: "ChartRestApi.get.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get-list", + label: "ChartRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get-list-dashboard", + label: "ChartRestApi.get_list.Dashboard", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get-list-sqlatable", + label: "ChartRestApi.get_list.SqlaTable", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get-list-tag", + label: "ChartRestApi.get_list.Tag", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get-list-user", + label: "ChartRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get-list-user-1", + label: "ChartRestApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get-list-user-2", + label: "ChartRestApi.get_list.User2", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-get-list-user-3", + label: "ChartRestApi.get_list.User3", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-post", + label: "ChartRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/chartrestapi-put", + label: "ChartRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/csstemplaterestapi-get", + label: "CssTemplateRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/csstemplaterestapi-get-user", + label: "CssTemplateRestApi.get.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/csstemplaterestapi-get-user-1", + label: "CssTemplateRestApi.get.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/csstemplaterestapi-get-list", + label: "CssTemplateRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/csstemplaterestapi-get-list-user", + label: "CssTemplateRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/csstemplaterestapi-get-list-user-1", + label: "CssTemplateRestApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/csstemplaterestapi-post", + label: "CssTemplateRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/csstemplaterestapi-put", + label: "CssTemplateRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardcachescreenshotresponseschema", + label: "DashboardCacheScreenshotResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardcopyschema", + label: "DashboardCopySchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboarddatasetschema", + label: "DashboardDatasetSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardgetresponseschema", + label: "DashboardGetResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardpermalinkstateschema", + label: "DashboardPermalinkStateSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardrestapi-get", + label: "DashboardRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardrestapi-get-list", + label: "DashboardRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardrestapi-get-list-role", + label: "DashboardRestApi.get_list.Role", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardrestapi-get-list-tag", + label: "DashboardRestApi.get_list.Tag", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardrestapi-get-list-user", + label: "DashboardRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardrestapi-get-list-user-1", + label: "DashboardRestApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardrestapi-get-list-user-2", + label: "DashboardRestApi.get_list.User2", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardrestapi-post", + label: "DashboardRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardrestapi-put", + label: "DashboardRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/database", + label: "Database", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/database-1", + label: "Database1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaseconnectionschema", + label: "DatabaseConnectionSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databasefunctionnamesresponse", + label: "DatabaseFunctionNamesResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaserelatedchart", + label: "DatabaseRelatedChart", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaserelatedcharts", + label: "DatabaseRelatedCharts", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaserelateddashboard", + label: "DatabaseRelatedDashboard", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaserelateddashboards", + label: "DatabaseRelatedDashboards", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaserelatedobjectsresponse", + label: "DatabaseRelatedObjectsResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaserestapi-get", + label: "DatabaseRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaserestapi-get-list", + label: "DatabaseRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaserestapi-get-list-user", + label: "DatabaseRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaserestapi-get-list-user-1", + label: "DatabaseRestApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaserestapi-post", + label: "DatabaseRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaserestapi-put", + label: "DatabaseRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databasesshtunnel", + label: "DatabaseSSHTunnel", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databaseschemaaccessforfileuploadresponse", + label: "DatabaseSchemaAccessForFileUploadResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databasetablesresponse", + label: "DatabaseTablesResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databasetestconnectionschema", + label: "DatabaseTestConnectionSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/databasevalidateparametersschema", + label: "DatabaseValidateParametersSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dataset", + label: "Dataset", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetcachewarmuprequestschema", + label: "DatasetCacheWarmUpRequestSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetcachewarmupresponseschema", + label: "DatasetCacheWarmUpResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetcachewarmupresponsesingle", + label: "DatasetCacheWarmUpResponseSingle", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetcolumnsput", + label: "DatasetColumnsPut", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetcolumnsrestapi-get", + label: "DatasetColumnsRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetcolumnsrestapi-get-list", + label: "DatasetColumnsRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetcolumnsrestapi-post", + label: "DatasetColumnsRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetcolumnsrestapi-put", + label: "DatasetColumnsRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetduplicateschema", + label: "DatasetDuplicateSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetmetricrestapi-get", + label: "DatasetMetricRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetmetricrestapi-get-list", + label: "DatasetMetricRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetmetricrestapi-post", + label: "DatasetMetricRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetmetricrestapi-put", + label: "DatasetMetricRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetmetricsput", + label: "DatasetMetricsPut", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrelatedchart", + label: "DatasetRelatedChart", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrelatedcharts", + label: "DatasetRelatedCharts", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrelateddashboard", + label: "DatasetRelatedDashboard", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrelateddashboards", + label: "DatasetRelatedDashboards", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrelatedobjectsresponse", + label: "DatasetRelatedObjectsResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-get", + label: "DatasetRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-get-database", + label: "DatasetRestApi.get.Database", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-get-sqlmetric", + label: "DatasetRestApi.get.SqlMetric", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-get-tablecolumn", + label: "DatasetRestApi.get.TableColumn", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-get-user", + label: "DatasetRestApi.get.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-get-user-1", + label: "DatasetRestApi.get.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-get-user-2", + label: "DatasetRestApi.get.User2", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-get-list", + label: "DatasetRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-get-list-database", + label: "DatasetRestApi.get_list.Database", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-get-list-user", + label: "DatasetRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-get-list-user-1", + label: "DatasetRestApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-post", + label: "DatasetRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasetrestapi-put", + label: "DatasetRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/datasource", + label: "Datasource", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/distincresponseschema", + label: "DistincResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/distinctresultresponse", + label: "DistinctResultResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/embeddeddashboardconfig", + label: "EmbeddedDashboardConfig", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/embeddeddashboardresponseschema", + label: "EmbeddedDashboardResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/embeddeddashboardrestapi-get", + label: "EmbeddedDashboardRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/embeddeddashboardrestapi-get-list", + label: "EmbeddedDashboardRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/embeddeddashboardrestapi-post", + label: "EmbeddedDashboardRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/embeddeddashboardrestapi-put", + label: "EmbeddedDashboardRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/engineinformation", + label: "EngineInformation", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/estimatequerycostschema", + label: "EstimateQueryCostSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/executepayloadschema", + label: "ExecutePayloadSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/explorecontextschema", + label: "ExploreContextSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/explorepermalinkstateschema", + label: "ExplorePermalinkStateSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/folder", + label: "Folder", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/formdatapostschema", + label: "FormDataPostSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/formdataputschema", + label: "FormDataPutSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/getfavstaridsschema", + label: "GetFavStarIdsSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/getorcreatedatasetschema", + label: "GetOrCreateDatasetSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/guesttokencreate", + label: "GuestTokenCreate", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/importv-1-database", + label: "ImportV1Database", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/importv-1-databaseextra", + label: "ImportV1DatabaseExtra", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/logrestapi-get", + label: "LogRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/logrestapi-get-user", + label: "LogRestApi.get.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/logrestapi-get-list", + label: "LogRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/logrestapi-get-list-user", + label: "LogRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/logrestapi-post", + label: "LogRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/logrestapi-put", + label: "LogRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionapi-get", + label: "PermissionApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionapi-get-list", + label: "PermissionApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionapi-post", + label: "PermissionApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionapi-put", + label: "PermissionApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionviewmenuapi-get", + label: "PermissionViewMenuApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionviewmenuapi-get-permission", + label: "PermissionViewMenuApi.get.Permission", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionviewmenuapi-get-viewmenu", + label: "PermissionViewMenuApi.get.ViewMenu", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionviewmenuapi-get-list", + label: "PermissionViewMenuApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionviewmenuapi-get-list-permission", + label: "PermissionViewMenuApi.get_list.Permission", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionviewmenuapi-get-list-viewmenu", + label: "PermissionViewMenuApi.get_list.ViewMenu", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionviewmenuapi-post", + label: "PermissionViewMenuApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/permissionviewmenuapi-put", + label: "PermissionViewMenuApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/queryexecutionresponseschema", + label: "QueryExecutionResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/queryrestapi-get", + label: "QueryRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/queryrestapi-get-database", + label: "QueryRestApi.get.Database", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/queryrestapi-get-list", + label: "QueryRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/queryrestapi-post", + label: "QueryRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/queryrestapi-put", + label: "QueryRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/queryresult", + label: "QueryResult", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/rlsrestapi-get", + label: "RLSRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/rlsrestapi-get-list", + label: "RLSRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/rlsrestapi-post", + label: "RLSRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/rlsrestapi-put", + label: "RLSRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/recentactivity", + label: "RecentActivity", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/recentactivityresponseschema", + label: "RecentActivityResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/recentactivityschema", + label: "RecentActivitySchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/relatedresponseschema", + label: "RelatedResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/relatedresultresponse", + label: "RelatedResultResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportexecutionlogrestapi-get", + label: "ReportExecutionLogRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportexecutionlogrestapi-get-list", + label: "ReportExecutionLogRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportexecutionlogrestapi-post", + label: "ReportExecutionLogRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportexecutionlogrestapi-put", + label: "ReportExecutionLogRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportrecipient", + label: "ReportRecipient", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportrecipientconfigjson", + label: "ReportRecipientConfigJSON", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-get", + label: "ReportScheduleRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-get-dashboard", + label: "ReportScheduleRestApi.get.Dashboard", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-get-database", + label: "ReportScheduleRestApi.get.Database", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-get-reportrecipients", + label: "ReportScheduleRestApi.get.ReportRecipients", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-get-slice", + label: "ReportScheduleRestApi.get.Slice", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-get-user", + label: "ReportScheduleRestApi.get.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-get-list", + label: "ReportScheduleRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-get-list-reportrecipients", + label: "ReportScheduleRestApi.get_list.ReportRecipients", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-get-list-user", + label: "ReportScheduleRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-get-list-user-1", + label: "ReportScheduleRestApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-get-list-user-2", + label: "ReportScheduleRestApi.get_list.User2", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-post", + label: "ReportScheduleRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/reportschedulerestapi-put", + label: "ReportScheduleRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/resource", + label: "Resource", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/rlsrule", + label: "RlsRule", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/rolepermissionlistschema", + label: "RolePermissionListSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/rolepermissionpostschema", + label: "RolePermissionPostSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/roleresponseschema", + label: "RoleResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/roleuserputschema", + label: "RoleUserPutSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/roles", + label: "Roles", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/roles-1", + label: "Roles1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/rolesresponseschema", + label: "RolesResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/sqllabbootstrapschema", + label: "SQLLabBootstrapSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/savedqueryrestapi-get", + label: "SavedQueryRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/savedqueryrestapi-get-database", + label: "SavedQueryRestApi.get.Database", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/savedqueryrestapi-get-user", + label: "SavedQueryRestApi.get.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/savedqueryrestapi-get-user-1", + label: "SavedQueryRestApi.get.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/savedqueryrestapi-get-list", + label: "SavedQueryRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/savedqueryrestapi-get-list-database", + label: "SavedQueryRestApi.get_list.Database", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/savedqueryrestapi-get-list-tag", + label: "SavedQueryRestApi.get_list.Tag", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/savedqueryrestapi-get-list-user", + label: "SavedQueryRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/savedqueryrestapi-get-list-user-1", + label: "SavedQueryRestApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/savedqueryrestapi-post", + label: "SavedQueryRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/savedqueryrestapi-put", + label: "SavedQueryRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/schemasresponseschema", + label: "SchemasResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/selectstarresponseschema", + label: "SelectStarResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/slice", + label: "Slice", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/sqllabpermalinkschema", + label: "SqlLabPermalinkSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/stopqueryschema", + label: "StopQuerySchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetroleapi-get", + label: "SupersetRoleApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetroleapi-get-list", + label: "SupersetRoleApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetroleapi-post", + label: "SupersetRoleApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetroleapi-put", + label: "SupersetRoleApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetuserapi-get", + label: "SupersetUserApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetuserapi-get-role", + label: "SupersetUserApi.get.Role", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetuserapi-get-user", + label: "SupersetUserApi.get.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetuserapi-get-user-1", + label: "SupersetUserApi.get.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetuserapi-get-list", + label: "SupersetUserApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetuserapi-get-list-role", + label: "SupersetUserApi.get_list.Role", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetuserapi-get-list-user", + label: "SupersetUserApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetuserapi-get-list-user-1", + label: "SupersetUserApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetuserapi-post", + label: "SupersetUserApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/supersetuserapi-put", + label: "SupersetUserApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tab", + label: "Tab", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tabstate", + label: "TabState", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/table", + label: "Table", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tableextrametadataresponseschema", + label: "TableExtraMetadataResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tablemetadatacolumnsresponse", + label: "TableMetadataColumnsResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tablemetadataforeignkeysindexesresponse", + label: "TableMetadataForeignKeysIndexesResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tablemetadataoptionsresponse", + label: "TableMetadataOptionsResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tablemetadataprimarykeyresponse", + label: "TableMetadataPrimaryKeyResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tablemetadataresponseschema", + label: "TableMetadataResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tables", + label: "Tables", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tabspayloadschema", + label: "TabsPayloadSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tag", + label: "Tag", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/taggetresponseschema", + label: "TagGetResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagobject", + label: "TagObject", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagpostbulkresponseobject", + label: "TagPostBulkResponseObject", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagpostbulkresponseschema", + label: "TagPostBulkResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagpostbulkschema", + label: "TagPostBulkSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagrestapi-get", + label: "TagRestApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagrestapi-get-user", + label: "TagRestApi.get.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagrestapi-get-user-1", + label: "TagRestApi.get.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagrestapi-get-list", + label: "TagRestApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagrestapi-get-list-user", + label: "TagRestApi.get_list.User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagrestapi-get-list-user-1", + label: "TagRestApi.get_list.User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagrestapi-post", + label: "TagRestApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tagrestapi-put", + label: "TagRestApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/taggedobjectentityresponseschema", + label: "TaggedObjectEntityResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/temporarycachepostschema", + label: "TemporaryCachePostSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/temporarycacheputschema", + label: "TemporaryCachePutSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/uploadfilemetadata", + label: "UploadFileMetadata", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/uploadfilemetadataitem", + label: "UploadFileMetadataItem", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/uploadfilemetadatapostschema", + label: "UploadFileMetadataPostSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/uploadpostschema", + label: "UploadPostSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/user", + label: "User", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/user-1", + label: "User1", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/user-2", + label: "User2", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/userresponseschema", + label: "UserResponseSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/validatesqlrequest", + label: "ValidateSQLRequest", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/validatesqlresponse", + label: "ValidateSQLResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/validatorconfigjson", + label: "ValidatorConfigJSON", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/viewmenuapi-get", + label: "ViewMenuApi.get", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/viewmenuapi-get-list", + label: "ViewMenuApi.get_list", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/viewmenuapi-post", + label: "ViewMenuApi.post", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/viewmenuapi-put", + label: "ViewMenuApi.put", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/advanced-data-type-convert-schema", + label: "advanced_data_type_convert_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/database-catalogs-query-schema", + label: "database_catalogs_query_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/database-schemas-query-schema", + label: "database_schemas_query_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/database-tables-query-schema", + label: "database_tables_query_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/delete-tags-schema", + label: "delete_tags_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/get-delete-ids-schema", + label: "get_delete_ids_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/get-export-ids-schema", + label: "get_export_ids_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/get-fav-star-ids-schema", + label: "get_fav_star_ids_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/get-info-schema", + label: "get_info_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/get-item-schema", + label: "get_item_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/get-list-schema", + label: "get_list_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/get-recent-activity-schema", + label: "get_recent_activity_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/get-related-schema", + label: "get_related_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/queries-get-updated-since-schema", + label: "queries_get_updated_since_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/screenshot-query-schema", + label: "screenshot_query_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/sql-lab-get-results-schema", + label: "sql_lab_get_results_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/thumbnail-query-schema", + label: "thumbnail_query_schema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardscreenshotpostschema", + label: "DashboardScreenshotPostSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardnativefiltersconfigupdateschema", + label: "DashboardNativeFiltersConfigUpdateSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/dashboardcolorsconfigupdateschema", + label: "DashboardColorsConfigUpdateSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/formatquerypayloadschema", + label: "FormatQueryPayloadSchema", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/get-slack-channels-schema", + label: "get_slack_channels_schema", + className: "schema", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab-permanent-link.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab-permanent-link.tag.mdx new file mode 100644 index 00000000000..2dd6fbc6743 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab-permanent-link.tag.mdx @@ -0,0 +1,13 @@ +--- +id: sql-lab-permanent-link +title: "SQL Lab Permanent Link" +description: "SQL Lab Permanent Link" +custom_edit_url: null +--- + +Create and retrieve permanent links to SQL Lab states. + +| Method | Endpoint | Path | +|--------|----------|------| +| `POST` | [Create a new permanent link (sqllab-permalink)](./create-a-new-permanent-link-sqllab-permalink) | `/api/v1/sqllab/permalink` | +| `GET` | [Get permanent link state for SQLLab editor.](./get-permanent-link-state-for-sql-lab-editor) | `/api/v1/sqllab/permalink/{key}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab.tag.mdx new file mode 100644 index 00000000000..9b0e9418c4d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab.tag.mdx @@ -0,0 +1,17 @@ +--- +id: sql-lab +title: "SQL Lab" +description: "SQL Lab" +custom_edit_url: null +--- + +Execute SQL queries and manage SQL Lab sessions. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get the bootstrap data for SqlLab page](./get-the-bootstrap-data-for-sql-lab-page) | `/api/v1/sqllab/` | +| `POST` | [Estimate the SQL query execution cost](./estimate-the-sql-query-execution-cost) | `/api/v1/sqllab/estimate/` | +| `POST` | [Execute a SQL query](./execute-a-sql-query) | `/api/v1/sqllab/execute/` | +| `GET` | [Export the SQL query results to a CSV](./export-the-sql-query-results-to-a-csv) | `/api/v1/sqllab/export/{client_id}/` | +| `POST` | [Format SQL code](./format-sql-code) | `/api/v1/sqllab/format_sql/` | +| `GET` | [Get the result of a SQL query execution](./get-the-result-of-a-sql-query-execution) | `/api/v1/sqllab/results/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/tags.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/tags.tag.mdx new file mode 100644 index 00000000000..b9ba448ee8f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/tags.tag.mdx @@ -0,0 +1,26 @@ +--- +id: tags +title: "Tags" +description: "Tags" +custom_edit_url: null +--- + +Organize assets with tags. + +| Method | Endpoint | Path | +|--------|----------|------| +| `DELETE` | [Bulk delete tags](./bulk-delete-tags) | `/api/v1/tag/` | +| `GET` | [Get a list of tags](./get-a-list-of-tags) | `/api/v1/tag/` | +| `POST` | [Create a tag](./create-a-tag) | `/api/v1/tag/` | +| `GET` | [Get metadata information about tag API endpoints](./get-metadata-information-about-tag-api-endpoints) | `/api/v1/tag/_info` | +| `POST` | [Add tags to an object](./add-tags-to-an-object) | `/api/v1/tag/{object_type}/{object_id}/` | +| `DELETE` | [Delete a tagged object](./delete-a-tagged-object) | `/api/v1/tag/{object_type}/{object_id}/{tag}/` | +| `DELETE` | [Delete a tag](./delete-a-tag) | `/api/v1/tag/{pk}` | +| `GET` | [Get a tag detail information](./get-a-tag-detail-information) | `/api/v1/tag/{pk}` | +| `PUT` | [Update a tag](./update-a-tag) | `/api/v1/tag/{pk}` | +| `DELETE` | [Delete tag by pk favorites](./delete-tag-by-pk-favorites) | `/api/v1/tag/{pk}/favorites/` | +| `POST` | [Create tag by pk favorites](./create-tag-by-pk-favorites) | `/api/v1/tag/{pk}/favorites/` | +| `POST` | [Bulk create tags and tagged objects](./bulk-create-tags-and-tagged-objects) | `/api/v1/tag/bulk_create` | +| `GET` | [Get tag favorite status](./get-tag-favorite-status) | `/api/v1/tag/favorite_status/` | +| `GET` | [Get all objects associated with a tag](./get-all-objects-associated-with-a-tag) | `/api/v1/tag/get_objects/` | +| `GET` | [Get related fields data (tag-related-column-name)](./get-related-fields-data-tag-related-column-name) | `/api/v1/tag/related/{column_name}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/test-a-database-connection.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/test-a-database-connection.RequestSchema.json new file mode 100644 index 00000000000..844a50cb316 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/test-a-database-connection.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"

Refer to the SqlAlchemy docs for more information on how to structure your URI.

","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"DatabaseSSHTunnel"}],"nullable":true}},"type":"object","title":"DatabaseTestConnectionSchema"},"example":{"configuration_method":{},"database_name":"string","driver":"string","engine":"string","extra":"string","impersonate_user":true,"masked_encrypted_extra":"string","parameters":{},"server_cert":"string","sqlalchemy_uri":"string","ssh_tunnel":{}}}},"description":"Database schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/test-a-database-connection.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/test-a-database-connection.StatusCodes.json new file mode 100644 index 00000000000..c981bad450c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/test-a-database-connection.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Database Test Connection"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/test-a-database-connection.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/test-a-database-connection.api.mdx new file mode 100644 index 00000000000..5fdf4d1373b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/test-a-database-connection.api.mdx @@ -0,0 +1,68 @@ +--- +id: test-a-database-connection +title: "Test a database connection" +description: "Test a database connection" +sidebar_label: "Test a database connection" +hide_title: true +hide_table_of_contents: true +api: eJzdWetv2zgS/1cGvAPa4lQ7yXX3Cm0aIEm7aPZy24fTvQPqQEtLY4sNRaokZUdn6H8/DClZ8qOPbT8scN9skjOc+c2bWjODHyu07kJnNYvXLNXKoXL0k5elFCl3QqvxB6sVrdk0x4LTr9LoEo0TaFuyuVhUxp9OCnS5zmg9wzmvpGMxsx8ll0RdJ3NtChaxDG1qREkULGaXBziAsFBZzEArcDnC3HjpMnAahCI2fnnG0ztaXeXocjS0i/el1BlCyQ0v0KGxoP1GafRSZAhayRo4DKSqjBixiKGqCha/PyRvrXgh0vD3tolYxh2fcYuJ4gUGbYcanUN3AOiAFzpD5cS8BpcLC6lWClM6TRcX/P4a1cLlLD754ShihVDd/+OIqUpKPpPIYmcqjJirSyRUnRFqwUgYI5Zo9qWYvLk+D3pAOEJyVBbZV/BEtRDqgGYDnuHIH+F57wzfZ3lanv0yefUrhIMEjeNC0U9PAFsOBiixQOXs6HRmzo5HcJMjnKY6w7MgT+Ltbk/Hfg307AOmDhboLFSqJHfJQCinvfuccsgNzp9NWe5caePxONOpHfUOMNJmMUY1ltyhdeNUGxyHe+wod4X8y+BoapA7TML2lIFB+WzKlNYlKjSgtME5GoNmys4+RXY65meQcikjWOVCYpDSq1Kg4+RVOwp+r2YGZXKcHAXVujv2dAvBP/oXOv6cO/712nUUG8W83U6GdtsolvI0x8SJAnXlOv2EBQ5+B9odsOgcuYdQYDHVKrMw1wY6PjBHl+ag5yHUukgcwaTElCJQOOAWTq0zWi3OpuywAFMWw3rapr39rR+PjiKYMkcef3C3OR23N4zgag6VsuiiVpOVkBKUdjBDQEUsMq+Cz3SV8omBS+HqEZxv1NZzOAKhMkrMaMHl3HmCwFIhBTjel8JgCI6/D0EOatiES6lXmFEmS+ZCYlKVUvNsG21dFBwskqM5zEAK629veYSbLye/WeAGoeXo84DnBU5/GusvyEHYvZ+ysppJkU4ZIZza5WbzdhvTTZKdS77UBjKN1sNqq7LUxrUSU/7nqu7+kY69zDMEnqZoLWYRfKisA4l8GQLPK45F6WrC88kQzyUaK7TqcJsLlFlAr01jNgBAP4lVcMXZAwstJTETFmyuK5mRFL7arYTL4bVB6zQ8v7BgdW9nWyvH78FXD2MwdSTUD0OhvFo2WQrjKi6T4Ju+Hho8IOlMa4lcDUXt6qg2Hke69kWgh1nlnFYUdJM313DNZ2DQVtJZCGqslPe6H4cCZcJ6GULeMrgUuPomQXxctwzgY4VGoA1RNEMwlaLzKgS+R5xu7RNCL/PoHwfFM0LKxOkkQ8eF/BYJPQvyp8CCqFrufWRvMtHTPaMlRSWdSFLuuNSLTTRugl3MtzgEB7aQ5pzKRnCxtuGClkmAxFTKl9IOM64y8BWHFomdRaql4/KMHajYoijRWK2oQFX2UI9xNW/dNSKZvBzdVQNPoTyx0F5QH3F4j2lFqcVnE4S0MgaVkzVIvViEro/ug1WuoaCgzCkmSzSFsBQ9xIfM7nIsyO3GZ1dzeCmW6BXMxRJHFs0Szcko5NdRps+9p7bpNgre0/Lo4bFAdCL1WUFXykXk+DAA4vMCLwXfvr40+r4e+b22b65HPdStXxHWBbd3mCWoUlOXjn790XaJZ5kIlWPQX263Tz5EfeLp+utBYzwgCi126LjIfW1tHRYWpLhDj3PUm11lcCEWbyo0te9a0hwy7aOWrvadeuhJCARqh+OSW7vSJutSmqK7pKyDRLMa+i6zc80vNpd9u+8HmA0Ur4fDSrM7ejy/eBxCWqTDgYFU3sKtt1hoKOnGYOEkReMOWulV2Rrj8jy5ePfr8+sX0I5YlhBZciky8qeXNzevJ9AOY3YEr/x8suTCK0yeRVdwofrw71rQrwVne9Y5KO1bat/g27rHkwONcSfr48pI+4V+cfJRbgYVnVrfK/qOjurO0BW1glyvSErrTJW6yiDUujLw7u1VB8ZgmDo+OnmyO03tY2PzxFVKofSOI+WrOYvf7065IjswC01ewo2nhKvn8JAkrkoyqX30aaMI5XCBJrhsCAPivO/PRiwp7d5h/aX95LOMWjflWWbQ2s8doZZpsD+QtIvcA9TNbmREzAlHarPnrQtMJi8DTKy53cXla+hv0LrLTW6ahHcIP0/yopT4mUeI/Um9k7ufmvuVbuYdrIQU3C/sF8Rg3E8l755yKz/tZo/+2G6kDnaGfto0zX4u67JD+1IT+QceYTBroaYFW2plg0ufHB19x7NPgdbyxVd5xLapNoQ9wadVIdNDb3ti9eTPFvuCZ122juFK+Tw+LB5tOc0OKTag9bqcnPy5urxTpdE0/fhSQy9Uro7ht1Ca/HOLMdoc0uTSzy1U5VsOLTVd9cOfbaIr5ShhSQhRFrSI4VxBpfC+xJR6T78IOvW93EFr/Uyd9AYCitm0MqQj1YcPK8fi97eU0hxfWHo47NyW3Ubs/jH18BMvnPUEkqsFi1n67u01i5jkM4rk7q/VlUlJ9LQyEh7/B16/mtxAqL/xeCx1ymWurYufHj19OualGC+Px11uG9PjVNK3b+Mpg+l0qgAev4QpO69cro34r4c/hgvkBg389fzy8sVkkty8+ueLX7cJLoPhHt/UJcawa7v+bAYP1lN2hzWN7VO25LLCKWsesCbaqPu6drnvnzqFNwsblUXhh/WuA5qqqeoSFTzrG6NSW/eQ7oXvwCUKDHLkGRr7bL2DTlCkRWjK4G/t40Di9B2qpqUmFJ4d0nyqHk1VaYRyDzsNRnT44aNHQ0x+4Us+8X42wGVrsXcHrSxBs4GDr7hwYdL1YHwnFOugUaiYpAr53S5McXcMdr2J1P+9c6h1wOrGQ/V71JMM/SkAtu9T4XSH8ExndQw054xC8It5/XANd1gP4IbmEZ0m1H+aqoCUn/c7lHZs0B7SEkdSLx7S0Uc/+Z5kO+x90eF9t92jRu1l21swckdf16mxZF/Em3UlPySDypDND5pu7/vINW1DhkuUuqTH7zateZcKjNal0U6nWjbxeLwmVk28pqhq9r+2VNbpomMRsSU3grK/bTOxZ7P9AYfEHHwfaf/60YDtoUfjDGz4NBEjabb5bfTdE24S8jXt+Q8n2sDVa9/uarPD5CBULb0/3TRk2i5n+7YxKOkz95rNvNv+7IcLir9/35CN/DGazP1uP/d5pZuIiBODc4M2/1YmxMVq9bb//PaiL2L/n/2qn5+OhiPP4KbhpHNwOTlEtjvX7O0ElzkaTi/DToLmygMzXUWA4XAMGSy1b7csZsvj4JXWFdx3M+0Fn80dW1dtuhuH925cSi58e+vjed2mlfeMl4LuPWb9JEOibScXFjGKwxBo79l6TcfeGdk0tExvW9Sy3Pax7huXiIX07vNRAH+YqH1qkBVJuNe9UeIJFOdpir5iffrs7SBpUnVhEZu1n5wLnRGN4SuaVviKxYxFTHuEfKj6tVA3q9DaBZ5kQF65fADjJtbaH6RVu8VVPZBwvQ4nQp2iBBlU8SWeNbdN0/wP84b6ug== +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"; + + + + + + + + + + +Test a database connection + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.StatusCodes.json new file mode 100644 index 00000000000..eaa0ce8a782 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"schemas":{"description":"The list of schemas allowed for the database to upload information","items":{"type":"string"},"type":"array"}},"type":"object","title":"DatabaseSchemaAccessForFileUploadResponse"},"example":{"schemas":["string"]}}},"description":"The list of the database schemas where to upload information"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.api.mdx new file mode 100644 index 00000000000..c18999b8896 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/the-list-of-the-database-schemas-where-to-upload-information.api.mdx @@ -0,0 +1,68 @@ +--- +id: the-list-of-the-database-schemas-where-to-upload-information +title: "The list of the database schemas where to upload information" +description: "The list of the database schemas where to upload information" +sidebar_label: "The list of the database schemas where to upload information" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1P5DYQ/ivWqB9ADSxUVwnldB8ohbtrT3eIXdRKBHEmmd0YHDtnTxZolP9ejZ2EXRZaqYfUT4nHnvE8z7x4WqilkxUSOg/pRQvKQAq1pBISMLJCXt1CAg6/NcphASm5BhPweYmVhLQFeqj5lDKEC3TQdZd82tfWePR84Ke9Pf7k1hAa4l9Z11rlkpQ1kxtvDcseDdbO1uhIRe0oD78F+typmtUghVmJQitPws5Ff0hIre0dFmJunaASRSFJXkuPgqxoam1lIZSZW1eFuyEBRVj5FRSenDIL6JJBIJ2TD9A9Cuz1DeYECZAizYJf+zumwYfDPEfvT6w7URrPw5VnPRlsFe9lVbPaCrCL4dbLju95GeUaogHyXYnuJXxdAm/29r+D/Aq9lwt8hqANQtbBjYpwbmRDpXXqLyxScdhQiYb6+8WYVc8gX1WMSN78v0g+WxJz25giFRwV9h09YSEcetu4HEVh0QtjSeC98vQcqNEG3/LzdxXGKyD6aAidkVp4dEt0Ap2zLhWHRjQG72vMGV0QCpvnjXshUieSpI7nwuUe88YpeggN5eaOIL245K5AchHSfagYuEzgfie3BU6Dc7EDaWkWkEJ+fvYJEtDyGvXjMhLN68ZpsfOneH88ExmURHU6mWibS11aT+nB3sHBRNZqstyfDCUz2Z/0RXMlQ5Veza27miuNV7F2JhmILMuMEDsfRAaHffqFcKTiF5QOnfjh8OjoeDq9mn35/fhzBtAlo8unD1SGrjI4PQpGt1VVW0dD7vjMZGboleLdKN5dIG2xH+I1sSXRYomyQOfftU8QZpCKDHqUGYgfRW+J7C2aLjPbmamdMrQ1eLzLKbq1vb3KwW9yKachN1Z4WBM+htAaz1SM8OWdVCTmSHkZ0L829naNgHRYi6exZia+DuFuo81ZIOFr1Oj4w4y8zUxEwb6MCJ7w0x+yGne1XWzx0e23wAXxiq0+gQqptAWksECmObzhKWyQ1da33b/xxVEKHSFWZOM4iM/GAp6C+MTbosAlaltXaKjvLSFHoqG2dpZsbnWXTiYtm+rSlsui27B21Hiy1WAigaV0Sl7r2AAHM3E0mMtGU+8mJICmqbjX9Ev+eNig/MNsdipGO10C7M26vRHvhnPT2DR5jyclYZ34eMpGGMu6kWep6vXD6S6MTUPjDKNEBBnaZwvXIRtPQri5oP6YQT+DcSXFXRjbfgDdJax85XDu0Jf/1UiXAKfZ5vg1bWp0HlcnoRUR5048t9yPlHiqZHjP+qnyO7N9zZnxBSS8p0mtpQqzT0i3tq+EC5C1Ys/2WXt4gRJIw3j7zwUBCXDuxOS4gLZl3XOnu47F3xp0/NZdPuZnKJtCef4vIJ1L7XHD5/Hdh62zfg7aFo/8r2MZxlHzEMpAN7yCBG7xIY7o3SWnb2ht4fa4weNo6LqDysaEwXk3to73x5wSPHetkDomRv/D1p91p23jidgru9G78ICwg133N/5vT/c= +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"; + + + + + + + + + + +The list of the database schemas where to upload information + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.RequestSchema.json new file mode 100644 index 00000000000..ffa628409d1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.RequestSchema.json @@ -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`.","nullable":true,"type":"integer"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"nullable":true,"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":0,"nullable":true,"type":"string"},"tags":{"items":{"description":"Tags to be associated with the chart","type":"integer"},"type":"array"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"nullable":true,"type":"string"}},"type":"object","title":"ChartRestApi.put"},"example":{"cache_timeout":1,"certification_details":"string","certified_by":"string","dashboards":[1],"datasource_id":1,"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","tags":[1],"viz_type":["bar","area","table"]}}},"description":"Chart schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.StatusCodes.json new file mode 100644 index 00000000000..e49ece431ce --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"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`.","nullable":true,"type":"integer"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"nullable":true,"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":0,"nullable":true,"type":"string"},"tags":{"items":{"description":"Tags to be associated with the chart","type":"integer"},"type":"array"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"nullable":true,"type":"string"}},"type":"object","title":"ChartRestApi.put"}},"type":"object"},"example":{"id":1,"result":{"cache_timeout":1,"certification_details":"string","certified_by":"string","dashboards":[],"datasource_id":1,"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","tags":[],"viz_type":["bar","area","table"]}}}},"description":"Chart changed"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.api.mdx new file mode 100644 index 00000000000..7841f32796d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-chart.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-a-chart +title: "Update a chart" +description: "Update a chart" +sidebar_label: "Update a chart" +hide_title: true +hide_table_of_contents: true +api: eJztWltvG7sR/isDokBsVLHs9Bwg2IM8OG6Ck9MgMWK5F1iGTC1HWsa75B6SK1kR9r8XQ+5NWslVmzbug5/s5c6Q832cG7las5wbnqFDY1l0s2ZSsYjl3CVswBTPkJ7u2YAZ/L2QBgWLnClwwGycYMZZtGZulZOUVA7naFhZ3gZptO6tFisSibVyqBz9y/M8lTF3UqvhV6sVjbVz5UbnaJxE69V4nODEyQx14ZUF2tjInJRZxP5cGD8PHEkFFmOthD0GPQOXIJCuVHOotGGmDbhEWogTbtwJfNIOw4DAGS9SZ8Fprym441YXJsah49MUmynkDAolcCYVihOip0hTEqgp2SZiwGLCMqvgTgQ6LlO7A0h40Zje1dq/jnVGqnlnGRST6ao/+yUaqxVoA3Ojixxcwh0k3EKj1iHmkOUEt8lUcyM8FOkw24HpHFJpHUFqxYlhqeK0EBX1CpdhWXCaGO0zWI1wY/gqrF1vzkSK/qqjBEGKmkgvjG7YKm0vu5RpCoXFEziHWGd5iq7rACAFqnYvQCEKC3cbRtwBV2JjjGy+O8xBtrR2A6I3gcgenNo+FKDVtmFkAqoiY9EN857MqgWRtvn3As2KDZjlCxST+mkhccluD3GCrpn9ze88N27tGacI1xYfoaddAx8cGsXTSWFSWuRfKkg7ybjicxSTWjddPaI51TpFrkhVL5VPgXsd+jMJADdI/mIsSGGBp6leUvxoEOh9RxvCqea4kWw+zCDFmQPMcreClS6C400RtMKan2DBBluHxYTP4Dssvmwyuzd7jgoNdyhArBTPZEzkwDJBBXEq43ufLRMEcgjCoRdolkY6hGnhnFYglX+PD3mqDQK5ygmMCOZvV58/gZ5+xTgk2lwv0VQ8LRMNGV/BkisKc+CpQwM2x5jiCtryc5BLeD+d+HrysKMkULh4EahEwGBu0KKi/F69lGhDEqRwJpNM4cFpI9DQc81Uk0T8PwtpC57Kbz4VDHzUSwVLmmimTcZdK24TXaSC9tegK8zj9WIPuEllxc4A6+NspbuQlwm6hEDV8vXs0vrt6TiFNqC0A6sDN9KB0Gj9WJELYsMrZFr4fGMdd49FcSe0bCpjnIRmYhcQetNz+4w/fEQ1dwmLXv18OmCZVPXz6QFUOj5/LJhHfO6r0RSBW6tj6SlYSpe0VhwUewv57YDMHVLfhgMRm94r8IFT3aEkPeWGDRg3yGltj+/2O5loTQ7hSRNLR+Lsgoz6gtad5/IkL1zIuJUxvebrbG83U6+13Ye0492G4ebstlfFz3YUwrZibbDazLlZG9rxPSUgkFMneW9EnTZb3a3ksufFRmBWzXDHw1ut4IN+rdZNdu9yWW6X1LA9ULXG2/13SQM218qGTvnV6el39Nmhk6p4V0U2Db5u0Bape27Ln9vy57b8uS1/bsuf2/Lntvy5LX9uy390W94T3mzUqw667db+V537/0Pj/gP79sPa9j19e6g2grbqp+/qzTO0ls+x06Dv9aFNt2gU2VsuoLqQj+CDWvBUik6Cp9q/kIKM7aPp6AYsZ0+L5VrxwiXayG8oIjgvXEKdVlxn2OqMtANIVzEg+dPTInmvzVQKgSqCf+gChFYvqP9fIORoMmktIaLCHMdobehbDIZQ2wWwmS+g++lp0X3SVH4LJSKgjFu5EIoGQlvG8EGSc/URNXN4RK9ePbXn5UbTVvjDJ3mdW0XwVwqm4H1ojDa7cFz4roOgVjNU2rTUz0+dHD6okGvBolmgCSgiOFdQKHzIMaZN84Og47gwe8LrPXc8bSgYMItxYQgjfVP8unSUT+nDYJVbQ5a0VEcfXsZa4JU3LXyCTLmas4jF118+sgFL+RTT9rEKgIjFhUnh5d/h8noEY5Y4l0fDYapjnibauuj16evXQ57L4eJs6Ov88GzMYDweK4CXv8KYnVfpwDMdwVvkBg384fzi4t3V1WT0+S/vPm0qXIQ9ejla5RjB9ja1sgJerMfsHldjFsGYLXha4JiVL1g5aLBdrlziLxFqdM1Ag09muTaujhw7VmNVX/nAm2aYOoQjWhYOJmEQxBPkAo19s96iIlhd0TFm8McqA02cvkdVVtoE+c0umGN1PFa5kcod1eaekPDR8XGXgN/4gl95/+mQsDHYbrRWlnhosPMllw5m6OLEQ/+3gK+D/Rm6RAsy/PJ6tM1JVEvBtp8Q1rvaVdaBmJHn5W7QqnQ9JbDT95YgXdM51WIV+fPaSYhgOVsdreEeVx1uoTwmaaL4l7EKtPhzTU3JFuGVkE7xJNXzIxI9/oVRFG6VxnCO4E1/HcihL/8FPfpfA0Rsk891fl/SLvmsEeI2NHQ796LXDn6k1yBwganOM1Suyj/eR8JE69xop2OdltFwuKapymhNMVH2ZrsorNNZPcWALbiRlKZtlTL9NOEs4C8VKzM7FzHVI/3xWWlz/l9Ho0to5ikHjKzZnK/B2zPuKiRWeheOVAY+XPoLAm22JtlJVaXvpUv/64o6uV5RWQggfYpds6l3zff+3EsB9bcRq36q4Q9//m17gPKgywEpTwzODNrkP52EZrFafWl/9/Fu76eE0//WgeS0fyI5/eEnktMfeCQ5PeRMMmBSzXT/5HtV5GjCJWN91uwMURQHucVZcE7rMu67j8qYXprYumusycYHN8xTLn0jWl0RhhRyw3guaa0z2uFqlii/p4ALEXXD1uspt3ht0rKk4XABGg5jVVD7XCOk78MEi2Y8tdgzpmmo2NGX6lRwDK3TbhpZ3x4of9VKyZZFjA2ouIWfP5XEaigOfvXwopvmO4q9Bo5SWtA4j2P0xW2/7G0n/V5eU+RNqx9RZVqQiuFL+hzEl8FG7SH7HODHQoUtQnMXpqTgpMNPZ5OaIK7+IVA7WVivg0QocmVDim8GiJey/Cf+x29F +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"; + + + + + + + + + + +Update a chart + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.RequestSchema.json new file mode 100644 index 00000000000..7e73e81b3f2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.RequestSchema.json @@ -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.put"},"example":{"css":"string","template_name":"string"}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.StatusCodes.json new file mode 100644 index 00000000000..1b3039cc046 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"css":{"nullable":true,"type":"string"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"CssTemplateRestApi.put"}},"type":"object"},"example":{"result":{"css":"string","template_name":"string"}}}},"description":"Item changed"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.api.mdx new file mode 100644 index 00000000000..2314c66f0d9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-css-template.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-a-css-template +title: "Update a CSS template" +description: "Update a CSS template" +sidebar_label: "Update a CSS template" +hide_title: true +hide_table_of_contents: true +api: eJzVV21v2zYQ/ivEYUATTImToAUKFf2QBi2armuD2NkGREFKS2dLDUWyJOXEE/TfhyMlWX4JtrYfgn2ySd0d73nujaxBc8NLdGgsxNc1FBJi0NzlEIHkJdLqDiIw+K0qDGYQO1NhBDbNseQQ1+CWmqQK6XCOBprmJkijdW9UtiSRVEmH0tFfrrUoUu4KJUdfrZK0t7KljdJoXIHWq1n/Iysh+FRgd3R7oHWmkHNoInBYasEd3gaHayj5w0eUc5dDfPLiKPo3C02/o6ZfMXUQgSscicOZtZPW+iVad6qLQ105OhQfeKkF9n521rbcWR3TRJChTU2hCT7E8LvKULAW/ibHDW1YraQNbJwcHf0ElwZtJdz/iuMtlXXWV4j+M/9bATh3WLI053KOGZl//lMcl2gtn+OgKB5Fvw6lV4Q3PGNt8cTsXC64KDK2KlGmjVoUGTm7DWagG7AcPy2WK8krlytT/I1ZzE4rl6N07fmsz/UdQIaKAcnzp0XySTk2U5XMYjbJsSMZiW6rKpMiyxRaJpVj+FAQ/dugehse0cnJU8dGG5XSciqQUVzcMmZ/ULqF+KAxyuzCcaYqkXmorYVWm4568dTlcy4dGskFs2gWaAKKmJ1KVkl80JhS0PwmU2lamUcS8B13XPQURGAxrQxhpAn59d5BfH1DY87xOU1NOBuPWdfCLNxE8HCQqgzH3sMwVwWXc4ghvbr8CBEIPkWxWoYkonVlBDv4i11cTVgCuXM6Ho2ESrnIlXXxy6OXL0dcF6PF8Si19rbrdKPjBFiSJJKxg/csgdO2fDzvMXuD3KBhv5yenb0dj28nn397+2ld4SxE7GCy1BizzaCtZDP2rE7gDpcJxCyBBRcVJtA8gybqIV4sXa7kAGS/0cMsSq2M6+rIJjKR3ahjr/ttmgJ7dCz7Xi6ioJUjz9DY1/UGI8H5lpUE2K+Mp5TJt07doWxabUL+ehfaRO4nUptCur3O60MS3tvfH/LwgS/42CfVgIu1zVXYlbRER08Bv+eFYzN0ae4Z+BH8dYBRostVRv5fXE02qYk7KbaZNQT5S5c4deBn4un5Eq1UhnkTSNrOnSDdsTpV2TJmH8afPx2G6i5my72a3eFyQDFr9kmamH6VyMBOxh3vmdngvRVSAg+Fmu+R6P4roArdGCw64w4ZZ1SwHWEQQeCIrroVxcVff2PYyW6t7xoKne8vobQrQ5HdGSDY9OAjfWYZLlAoXaJ0bafyiRMM1doop1Ilmng0qslUE9dUL82WtbPKOlV2JiJYcFNQQ7dtc/Vm6H+GM+4vS95NiABlVVLnapf04xvXuv33k8kF6+00EZA36/Z6vFvOjUMLpm90EWPKsPMLMkJY1o3spKrV99KNf1V0bXhMAySA9M24hqlP1HfKlJzsffhzAu0ThcorfIV+iHjQTUTKtwZnBm3+o0bIilXycvXeefvd74IICjlTgZE1AiqNxuLwqjzYovQLcovjwKp1JfcDtrX/WLavndLPWocPbqQFLyRZ86lYt5VwDVwXdOQxRDCsBogg1neUNyExrqGup9zilRFNQ9vfKjQ0NW9WuelLJiv8xSODeMaFxS2f+hsE7F22F8V9tuJ+3dd2k8ulLwFR0Qoiatzh9drcUOr6judPDx+GvWuguHVjocoMGqdpir5xPy57M2gmF1eUQNP2DVyqjFQMv6eXHr8PPioPObzQaC9MjyrcZoJJyjG6Dw9i1edi+4dA7WShroNE6NxNT4ofdMRL0/wDvuyBdw== +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"; + + + + + + + + + + +Update a CSS template + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.RequestSchema.json new file mode 100644 index 00000000000..c3c32fb144e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.RequestSchema.json @@ -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.","nullable":true,"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.","nullable":true,"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.","nullable":true,"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","nullable":true,"type":"string"},"published":{"description":"Determines whether or not this dashboard is visible in the list of all dashboards.","nullable":true,"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.","nullable":true,"type":"integer"},"type":"array"},"slug":{"description":"Unique identifying part for the web address of the dashboard.","maxLength":255,"minLength":0,"nullable":true,"type":"string"},"tags":{"items":{"description":"Tags to be associated with the dashboard","nullable":true,"type":"integer"},"type":"array"}},"type":"object","title":"DashboardRestApi.put"},"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","tags":[1]}}},"description":"Dashboard schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.StatusCodes.json new file mode 100644 index 00000000000..d56f41f51c6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"last_modified_time":{"type":"number"},"result":{"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.","nullable":true,"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.","nullable":true,"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.","nullable":true,"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","nullable":true,"type":"string"},"published":{"description":"Determines whether or not this dashboard is visible in the list of all dashboards.","nullable":true,"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.","nullable":true,"type":"integer"},"type":"array"},"slug":{"description":"Unique identifying part for the web address of the dashboard.","maxLength":255,"minLength":0,"nullable":true,"type":"string"},"tags":{"items":{"description":"Tags to be associated with the dashboard","nullable":true,"type":"integer"},"type":"array"}},"type":"object","title":"DashboardRestApi.put"}},"type":"object"},"example":{"id":1,"last_modified_time":1,"result":{"certification_details":"string","certified_by":"string","css":"string","dashboard_title":"string","external_url":"string","is_managed_externally":true,"json_metadata":"string","owners":[],"position_json":"string","published":true,"roles":[],"slug":"string","tags":[]}}}},"description":"Dashboard changed"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.api.mdx new file mode 100644 index 00000000000..18970b699aa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboard.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-a-dashboard +title: "Update a dashboard" +description: "Update a dashboard" +sidebar_label: "Update a dashboard" +hide_title: true +hide_table_of_contents: true +api: eJztWm1v2zgS/isD4nBNcG5eelug0KIf0myLbbdog9jZvUMceGlxbDGhSJWk7GgN//fDkJIsvySbZj8Ed5cvbUTODOeZd0pesIJbnqNH61hyuWBSs4QV3GesxzTPkZ5uWI9Z/FZKi4Il3pbYYy7NMOcsWTBfFUQltccpWrZcXkVqdP6dERWRpEZ71J7+5EWhZMq9NPrw2hlNaytZhTUFWi/RBTb6c1JTjwR6LlXYEOhSKwtaZgn7KW6AmYDPENa4CEWpFB8rbDSv9XXeSj1ly15zDIrRuNqWfobWGQ3GwtSasgCfcQ8Zd9Cygc+kA8FdNjbcigcd6Xbg+DpDa6VAOO33YWJsQNOKPXiI3JZ65KUnus0zTiBs7Baf89vPqKc+Y8nro6Mey6Vuno8ecDjeerSaq1FpFZ38pwzSjXKu+RTFqOFV1T2cY2MUck2sFDqjHD0X3PNtmAPyyKf+1y9gxteYepAOpqjRco8CRKV5LlM6DeYZakiVTG+kngaTOD5DcreZoZ1b6RHGpfdGg9TrJoOZxPkBfAzS8bYwDgVkaKN1LU7Qok4RuBZhpTBztFA6tA7mmYGcVzDn2oM3wJVHC+AKTCl2YZWVD/K7meuQwAsmPea7YosIgFusz5fCAVfKzCl8DQhU6APqNON6ihshfQAfJ6Bw4gHzwldQmRLmUikYIxiNTeZFLZqnh0RuWzTaFW4tr+i5ME6GvG+qxA4PX4fMjB6O22N04fCGm5xa6zOXYorebbmx8WA3KlaxEuKDi+vS+SZAGkFO/hGd2xzmYFxB6YhOWD6Fv4OwptgdNw/xalGOlXQZFd0dNQ9tLjVSKKHP0JLztPEbniNgM+nkWGGjh5LOk024Uiu6+8Ksk3bWKLwvzM5pn87k8Zh5JtMMBE6CpjxN0TmKtw0HDDJ0CEF4iFGu5rxyEHoFClKcCxFMTMwWyURptLjRQCXAoQeFM1T1ISFitallRgWoUOOmL0jXGZcBd0xEFZkeF7VOldNts1xo+a1EkAK1l5OKAqTg1rdVeI5jQmjJOruyp1OYX71+/d2F2fPpfU4b8GlwyhiBO2dSGQNf+mxdk0cYZLUQs5T1WN2Y2E+N2HN0/qSQB0XpYxfheRFb1x39v0G22bk7626NbKsrrrbWe9Zq/Y7WFFFvNJ8VV1OGL4+vtgrYiqqT1lFenVWBKwbQijj67vL4aknG3CgCbRTXE9TmmEYZi64w2sWsfXV09BfGMSk6454u83H0uOLOj3IjoiO8zHEnmUVXKv885D0Pec9D3vOQ9zzkPQ95z0Pe/+mQt8WwPvbRnHG8e6447s4R/73j4aOmw7uHQ5oN7xkOY7UXZOUf/tIAmKNzfNod75rw+xOPtozsHRdQvxxM4KOecSVFpw9CYc1MClJ2G1GHN2I5flosF5qXPjNW/oEigZOSCo+vz4d2EN8BpMsYkfzzaZF8MHYshUCdwL9NCcLoFzT+zhAKakDO1UW5qe3UfSw6U9oUdwFs5UV0Pzwtui+GinCpRUI9qAkhFC0EEAZd6Kt4Kym4thG1MgKiV6+eOvIKa8gVoaFR1PkqgV8pmWL0obXG7sJxakolAtRaQs1NR71+6uLwUcdSCg7tDG1EkcCJhlLjbYEpOS0sgknT0t6RXh+456o1QY85TEtLGOn7xvXch4p51VbPVaV07KrHbl+mRmA/qBc/iSiuqeqmF+efGbWlMarVY50ECUtLq+Dlv+DsYgBDlnlfJIeHyqRcZcb55M3RmzeHvJCHs+PDtuEcHg8ZDIdDDfDyZxiyk7osBIsn8A65RQt/Ozk9fd/vjwZff3n/ZZ3hNPrq5aAqMIFNd61oBbxYDNkNVkOWwJDNuCpxyJYv2LLX4jurfBbu0g3CdqHFKPPCWN9kkBvqoW7eL8Dbdpma/B4dC99liF5kyZALtO7tYsMcUfPaJEMG/6ir0cibG9TLmptgv90Fdaj3h7qwUvu9RuUDIt7b3+8a4ROf8X6IpY4h1hZXDjfakS1a/HzOpYcJ+jQL8L8b/CJiyNFnRpDyZxeDTbskDRVsxgvh/b0JmUU0ziDY5vfeiqUbMdFC21ETqRuTjo2oknDPPogZLSfV3gJusOrYF5b7RE1m/nGoo2lo/GnNsmH0msgoPFBmukek+z8yysqNVlkI7hH42oAaDURfJkvySPhambBtuy6KmyV5LFSTmMtxjtvpF7Z59mfaBkEXDlPkqH1dl0K8REGLwhpvUqOWyeHhgkQtkwXlyHJL2mnpvMkbET0241ZS+XZ1KQ1i4tw+4WHCDWrSEKrLnOpU/Uj/hUq1Lv/nweAMWjnLHiNt1uW1eLeU68eCS3v00ZeumR/P4gXdbgjZaaqaP1Avwxfgpuj2qV1EkKH0Ltg4hOgHY3NO8j79NmD15+RwDw27rG0ZATS9C5r7kcWJRZc9Vkj9Rul89W36/f/Cu+ajR90mju6+Thxd0Ws7PTHbt8h+WaB12L3idZYoyyLd7Lh+u+NzHqaG+qcEO9N57Yh2evB46w8LxWUYIuu3jTHVLxkvJJ133DU467GkuKHEiJF/yRaLMXd4YdVyScvfSrRVvEg1yRdqgpBhjhIsmXDlcEuhdiBie+f1VL8Pq+BaV7S5Gusq5Lgq6Yn1qCHFn1IsybqxmIfT40a3LHcYtwYwKj2R4yRNMTSku2mvOqXy7IIyZFz/ICM3glgsp1dU9G/Q0QTIIVfDWuyKZRzOokhKIrq8dBzVJlv9B4HaaYXFIlLEprRsjRIaONllufwPmiUa4g== +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"; + + + + + + + + + + +Update a dashboard + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.ParamsDetails.json new file mode 100644 index 00000000000..1962dcb54f2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"key","required":true,"schema":{"type":"string"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.RequestSchema.json new file mode 100644 index 00000000000..a6881dd9b31 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"value":{"description":"Any type of JSON supported text.","type":"string"}},"required":["value"],"type":"object","title":"TemporaryCachePutSchema"},"example":{"value":"string"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.StatusCodes.json new file mode 100644 index 00000000000..7a5553e8fe5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.api.mdx new file mode 100644 index 00000000000..fec598bf23a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dashboards-filter-state-value.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-a-dashboards-filter-state-value +title: "Update a dashboard's filter state value" +description: "Update a dashboard's filter state value" +sidebar_label: "Update a dashboard's filter state value" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/isHYkATTImbogMKFf2QZi3abmiN2tkGREFKi+dItUSyJOVEE/TfhyMlWX5pUazD8sWWqLsjn+de2TDNDS/RobEsvmpYLlnMNHcZi5jkJdLbikXM4JcqNyhY7EyFEbNphiVnccNcrUkqlw5v0bC2jQ5aWWH9PWasM7m8HVn5UqGpN2YcX9zkgn3zANdhH7TupRI1iaRKOpSOHrnWRZ5ylys5+WyVpLWNLW2URuNytPS25kWF9CDQpibXpMRidi5roE1BLeHd7MN7sJXWyjgU4PDenbJoH80I+VVn93oQU4vPmDpSy11BC3MstTLc1Bc8zXBauVk4YRsxvOelLnB0vM0u7S7BfsFqJW0A9OTx4x+gg1y4R8Y8Q1hhDU6BQWdyXCO4DMEf7jAV26i3Mfk9thDtb+dNwx23YJ0yKMBWaYrWLquiqE/J4NMfwlmitfwWD0blNw8/KLKXXEAXgzG8lWte5AI2qQbaqHUuUByCONINWM4eFsul5JXLlMn/RhHDeeUylK7bH4Z4OwBkrBiQPH1YJO+Vg6WqpIiB4qgjGYluqyqTIgiFFqRygPc50b8ParDhET158tC+0UZR7PNFgUB+cXUMf1C4Bf+gMcocwnGhqkJ4qJ2FTpu2+uWh0+etdGgkL8CiWaMJKGI4l1BJvNeYktP8Iqg0rcxXAvA1d7wYKIiYxbQyhJE63ec7x+Kra+oWjt9S92O/cpstFDcCXueFQwMzx50v1PcnqRI480cNjbLg8pbFLL38+DuLWMEXWGxeQzTRe2UKOPkLppdzSFjmnI4nk0KlvMiUdfGzx8+eTbjOJ+uzieg3n5xNln77G0vbT5oV1m3CIEkSCXDyBhJ23uWVd0gML5EbNPDT+cXFq9nsZv7ht1fvtxUugitP5rXGGHa9uZEV8KhJqAgnLIYkdJiEtY8Y9eMO8rR2mZIj0MPCADun9uX6BLOJTGTfh+DFsHyqK3dE28KPchMFKxlygca+aHYYCmA6lhIGPwP3DePGqRXKttMmJl4cQp/I40Rqk0t31KM4JeGj4+MxL+/4ms989I242VrchIWSlugZKOF3PHewRJdmnpH/go8mwCrRZUoQnunlfJequJeC3agiCj71gdUEvuaerk/RRmUcV4G0/dgK0j3LCyXq2I9Np6Es5Mv6qKERYkQ5tMckTcw/T2RgS3DHB6Z2/NAJqQJPC3V7RKLHzxml9k5H0oI7BA4DgY8sBALBExhmCxaxwBpNsRV5zs+yMdvnv9Gr9oALyNm+dIViURmKhYMuZbtn/J0+g8A1FkqXKF1XBH2oBUONNsqpVBVtPJk0ZKqNG8q4ds/aRWWdKnsTEVtzk1OvsF3d9mbCVLfkVeG6Y7KIoaxKKordK/1Ztsfom/l8CoOdNmJ0mm17A969w81CdadvNN6DMvB2SkYIy7aRg1R1+l669XN/X+H9vBxA+jrfsIUP5dfKlJzsvftz3l8iKCHD18206kG3ESnfGFwatNm/NUJWrJIfNzeSV18f4SOWy6Xan7JnlUZjcXxHGC1RnAW59Vmgz7qS+ybdXZu+P/C39h06ON1rJrrguST7PgqbLimuGNc5HeKMtHvzLGKxvziOc4MWacC/7sPkijXNglu8NEXb0nK47VHKiNzPNILFS15YjLqbwXD/65nzWd5H9WHNHUjDWMOOPnbT6zFsvLYNtVvksh7v2Z9Gr3xW/o870m97TXnmC7gHHL6MS/FIc29yowMHjfM0Rd+Xvi57PaqE00uK9kV3pS6VIBXD7+haz+/CIZXH7PPOr4XmWIWpLpikhKB7wSi6hsTpHgjUQRqaJkiERtQOrPg+Try07T8HAciY +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"; + + + + + + + + + + +Update a dashboard's filter state value + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.ParamsDetails.json new file mode 100644 index 00000000000..78674c08973 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"query","name":"override_columns","schema":{"type":"boolean"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.RequestSchema.json new file mode 100644 index 00000000000..100b71324d7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"always_filter_main_dttm":{"default":false,"type":"boolean"},"cache_timeout":{"nullable":true,"type":"integer"},"catalog":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"columns":{"items":{"properties":{"advanced_data_type":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"column_name":{"maxLength":255,"minLength":1,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"filterable":{"type":"boolean"},"groupby":{"type":"boolean"},"id":{"type":"integer"},"is_active":{"nullable":true,"type":"boolean"},"is_dttm":{"nullable":true,"type":"boolean"},"python_date_format":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"}},"required":["column_name"],"type":"object","title":"DatasetColumnsPut"},"type":"array"},"database_id":{"type":"integer"},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"fetch_values_predicate":{"maxLength":1000,"minLength":0,"nullable":true,"type":"string"},"filter_select_enabled":{"nullable":true,"type":"boolean"},"folders":{"items":{"properties":{"children":{"items":"circular(Folder)","nullable":true,"type":"array"},"description":{"maxLength":1000,"minLength":0,"nullable":true,"type":"string"},"name":{"maxLength":250,"minLength":1,"type":"string"},"type":{"enum":["metric","column","folder"],"type":"string"},"uuid":{"format":"uuid","type":"string"}},"required":["uuid"],"type":"object","title":"Folder"},"type":"array"},"is_managed_externally":{"nullable":true,"type":"boolean"},"is_sqllab_view":{"nullable":true,"type":"boolean"},"main_dttm_col":{"nullable":true,"type":"string"},"metrics":{"items":{"properties":{"currency":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"d3format":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"type":"string"},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"metric_name":{"maxLength":255,"minLength":1,"type":"string"},"metric_type":{"maxLength":32,"minLength":1,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"},"warning_text":{"nullable":true,"type":"string"}},"required":["expression","metric_name"],"type":"object","title":"DatasetMetricsPut"},"type":"array"},"normalize_columns":{"nullable":true,"type":"boolean"},"offset":{"nullable":true,"type":"integer"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"nullable":true,"type":"string"},"template_params":{"nullable":true,"type":"string"}},"type":"object","title":"DatasetRestApi.put"},"example":{"always_filter_main_dttm":true,"cache_timeout":1,"catalog":"string","columns":[{}],"database_id":1,"default_endpoint":"string","description":"string","external_url":"string","extra":"string","fetch_values_predicate":"string","filter_select_enabled":true,"folders":[{}],"is_managed_externally":true,"is_sqllab_view":true,"main_dttm_col":"string","metrics":[{}],"normalize_columns":true,"offset":1,"owners":[1],"schema":"string","sql":"string","table_name":"string","template_params":"string"}}},"description":"Dataset schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.StatusCodes.json new file mode 100644 index 00000000000..8b02a551fb1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"always_filter_main_dttm":{"default":false,"type":"boolean"},"cache_timeout":{"nullable":true,"type":"integer"},"catalog":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"columns":{"items":{"properties":{"advanced_data_type":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"column_name":{"maxLength":255,"minLength":1,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"filterable":{"type":"boolean"},"groupby":{"type":"boolean"},"id":{"type":"integer"},"is_active":{"nullable":true,"type":"boolean"},"is_dttm":{"nullable":true,"type":"boolean"},"python_date_format":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"}},"required":["column_name"],"type":"object","title":"DatasetColumnsPut"},"type":"array"},"database_id":{"type":"integer"},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"fetch_values_predicate":{"maxLength":1000,"minLength":0,"nullable":true,"type":"string"},"filter_select_enabled":{"nullable":true,"type":"boolean"},"folders":{"items":{"properties":{"children":{"items":"circular(Folder)","nullable":true,"type":"array"},"description":{"maxLength":1000,"minLength":0,"nullable":true,"type":"string"},"name":{"maxLength":250,"minLength":1,"type":"string"},"type":{"enum":["metric","column","folder"],"type":"string"},"uuid":{"format":"uuid","type":"string"}},"required":["uuid"],"type":"object","title":"Folder"},"type":"array"},"is_managed_externally":{"nullable":true,"type":"boolean"},"is_sqllab_view":{"nullable":true,"type":"boolean"},"main_dttm_col":{"nullable":true,"type":"string"},"metrics":{"items":{"properties":{"currency":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"d3format":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"type":"string"},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"metric_name":{"maxLength":255,"minLength":1,"type":"string"},"metric_type":{"maxLength":32,"minLength":1,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"},"warning_text":{"nullable":true,"type":"string"}},"required":["expression","metric_name"],"type":"object","title":"DatasetMetricsPut"},"type":"array"},"normalize_columns":{"nullable":true,"type":"boolean"},"offset":{"nullable":true,"type":"integer"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"nullable":true,"type":"string"},"template_params":{"nullable":true,"type":"string"}},"type":"object","title":"DatasetRestApi.put"}},"type":"object"},"example":{"id":1,"result":{"always_filter_main_dttm":true,"cache_timeout":1,"catalog":"string","columns":[],"database_id":1,"default_endpoint":"string","description":"string","external_url":"string","extra":"string","fetch_values_predicate":"string","filter_select_enabled":true,"folders":[],"is_managed_externally":true,"is_sqllab_view":true,"main_dttm_col":"string","metrics":[],"normalize_columns":true,"offset":1,"owners":[],"schema":"string","sql":"string","table_name":"string","template_params":"string"}}}},"description":"Dataset changed"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.api.mdx new file mode 100644 index 00000000000..36b459b84bf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-dataset.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-a-dataset +title: "Update a dataset" +description: "Update a dataset" +sidebar_label: "Update a dataset" +hide_title: true +hide_table_of_contents: true +api: eJztWm1v2zgS/isEcUATnNLYSZPNatEPaa7FttfrBk1yL4gDLS2NbTYSqZKUE6+h/74YUm+W5dhp2gsW8KfE1HDIGc7bM+ScpkyxBAwoTf3rOeWC+jRlZkI9KlgC+OuWelTB14wriKhvVAYe1eEEEkb9OTWzFKm4MDAGRfPcK7h8zUDNajZyCkrxCIJQxlkiNO1gMpQyBiZont+4JUGbNzKaIUkohQFh8F+WpjEPmeFS7H/RUuBYzStVMgVlOGhLG9+xmQ5GPDaggoRxEUTGJPgpghHLYkP9EYs1eEub8GjIwgkEhicgM7uyyOKYDWMo1dAWHqcYFssxEifs/iOIsZlQ/+Co59GEi/J3z1vFShvFxdhyKvTkzyk3kOgO2aIpEyFEQcQMCxyD1rJHC8v2N142cKe2jtvS7Ah0qHiKR/OAvmp6uE8VaL05uVFsI0p34I5k2b48OlYyS4ez7o886rJsj3IdsNDwKTywhSYbXdnaeuJ0ZiZS4FFCMJIqYeY7HGZpE2sJs8zJXK7sBjZYYQpqKDVU9rJmQt4MJdcLxnZTEcvhFwgN9ajhBjnRfzDDNJgz5xHnmallo0wpNrOmxwwbMg3BqtMr/D0AEaWSi4cc+ikGbUAJFgeZir+3SYMJJ8GUxRnoIFUQYQxsO2m/13t8qCmio4YYQtQPEkebme1IxpFNHiujVDjhcaRANEhoyFWYxUztvLPTd1dbWn28iwfxVJE741tvbXwrHQpElqABJ2AUD2kZNmmpkIY1r3eyh33EEj3gHE6FXR7BdZAwwcYQBaVZxrONQ5f+ikTBlMPdZnOq5IopfiOLdtp70HgypUCEs/aRH5w8OhZGh51h9ZtYPSnLPSEErAptTpHfmrSL2R0FxOHBo3Xz/8okHr1jSnAxDgzcbxLLW27VOJNF/a3PQ/9yZrsiDwkUPOZ/1JXuRt4jRyMNGxaZ8k60Y+4yUXtfdYX8gHlsEjr118282+DXbptcCrTrmUGSxlgbWcDykE4b573mHD+DNqcpf5m6g4R7lqSuXlyJGtxKLVzQb5T95fKN+v16jnBmoTzpd1Uj9dSF+FIPL9YWC+MYP+qBVZVCg6I74zvxqpzudr4ijTjadqJwo61UUK9bRXzHusNXHIPSG/q1sV/3b2ojrjlaa6x/No2uMdq2ntpK2uG8NA5SLNXGvjaM6FQK7TLUQa/3BHi6ENBFlgyd7yrQFplu0ewWzW7R7BbNbtHsFs1u0ewWzW7R7BbNbtHsFs2uRbNL5Iv4tsCgNcz4voD3rwp3fxjYfSzU/TFIdyXUDSdMjCFCI3n1JDibgNZsDB15YY1BVhPpGxaR4urXJ+/FlMU8IvUtNUmVnPIIN7ssT2Ouk6X/vLJcCZaZiVT8D4h8cpqZCQhTrE+q8N0hSHOik+TweSV5J9WQRxEIn/xPZiSS4oUhEzYFkoJKuM08xEjCwhC0JmbCNVGgZaZC6BKw4ueke/W80n2ShoxkJiKfXE6gNCGIKhFIJEETIQ2Be47GtSxRxcNKdHDw3JaXKolHgUGCoNWZmU/+jc7krA+UkqpLjjOZxZEVteBQzMaljp47OLwXLiQTDWoKyknhk1NBMgH3KYR4aHaQyNBW253u9Q6TV6UCj2oIM4Uy4hOYL3cGIzC2Jw0bYzQu46TGaup+L5QRXNjNuTczMROYB8Orzx+pR2M2hLj+WbiAj7V/TPb+S86vLsmAToxJ/f39WIYsnkht/JPeyck+S/n+tL8fueX2+wNKBoOBIGTvVzKgp0VIsNr2yRtgChT52+nZ2duLi+Dyt3++/bQ44cyd097lLAWftI+qpo3Ii/mA3sJsQH0yoDaRDmj+guJbnkK6c9vQachXDVQS8iSVypTeowdiIMpOKXldDWN9soPLkkeowXMTJsAwU7+et5Th9l0oZEDJ34s4FBh5CyIvZqPQr7sEHYjdgUgVF2an3PBLJN7Z3W2q4AObsgtrRQ01LAzWhy2FRk1U0rM7xg2xhYoV/pGiz50ECZiJjHDr51eXba34JRVp2wpK+3tpLnOnmkurmd+9ekrTWpx+li3GUZcKHcpo5pMPF799euk8mY9mO3NyC7OGdkm+i9So5F8GwikGxauU0lJ5QSRjeBnL8Q6S7v5C7Q3KYopMsblIGCl05eqtiYzwyVqGP+0zNp+2dTpPb3M8KxtBnAe7ArPzRJbK04/4mUQwhVimCQhTxCJrKY7RPFXSyFDGub+/P0dWuT9H38iXuJ1l2sikZOHRKVMcQ3bZPLBsFtr7dptYBRc9m+In/rHxaZH/r5eX56Tik3sUd7PIr5J3aXMXLsjiNywziVTk/bnt7krVYtKpqmK+pc7tm74y0F5ginBC2nA7p0Nrnu9KmP3hP5flA0GLLO3Xurlkhc49nBwoGCnQk29lgly0FJ/r14ZvN7gHLC5ZWriot+4isPOSo025VNOvxEd1H+YhdNS4O3CIo7otKFBNZHfeuA6o0E4TA3a19Bu4oyWKa5zQwxE7ORodv9o7+qn/096ro+ODveHhKNw7CH8+PhwdH7MRO6btbklVF7RxZO8vgiObbeJrBPZLfllxXMJvTo9VJ/YxevyBl7WN1mVD34fLdvA0Wy0OeaEB2N7Pktd8D1Nr99+aJrgWufcayL33I6C7R7kYSRdxFwJsloJyua9sBjWGML05umnfRW1tEuZ6vG7pjhzaagYXukal7Kcx4xavFZdBLr9eU5ZyXK1Pnbc6Pn56i9nIpZtrOp+jE1+pOM9x2L0NR7uKuC6cqAiptzDrfi1u/ZL61J5JmSe7ebSEqPAK3flcgO5dUvvaonBlo1HMmmuW+0pvaX6DadTWXHZ196FZPTUmLuEjrBLcjNMwBFs1rqa9adQ051eYzIbFa/hERjhFsTt8oMDu3B6lFdmmVTvmStfMYSfHEvMd9haaV8VlXiz+QaE6tTCfOwpXO+aVUmyVjXrJ8z8BC7e43Q== +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"; + + + + + + + + + + +Update a dataset + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.ParamsDetails.json new file mode 100644 index 00000000000..44d069f4ff0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The Report Schedule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.RequestSchema.json new file mode 100644 index 00000000000..29c478f4ce1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"active":{"type":"boolean"},"chart":{"nullable":true,"type":"integer"},"context_markdown":{"description":"Markdown description","nullable":true,"type":"string"},"creation_method":{"description":"Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.","enum":["charts","dashboards","alerts_reports"],"nullable":true},"crontab":{"description":"A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.","maxLength":1000,"minLength":1,"type":"string"},"custom_width":{"description":"Custom width of the screenshot in pixels","example":1000,"nullable":true,"type":"integer"},"dashboard":{"nullable":true,"type":"integer"},"database":{"type":"integer"},"description":{"description":"Use a nice description to give context to this Alert/Report","example":"Daily sales dashboard to marketing","nullable":true,"type":"string"},"email_subject":{"description":"The report schedule subject line","example":"[Report] Report name: Dashboard or chart name","nullable":true,"type":"string"},"extra":{"type":"object"},"force_screenshot":{"type":"boolean"},"grace_period":{"description":"Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)","example":14400,"minimum":1,"type":"integer"},"log_retention":{"description":"How long to keep the logs around for this report (in days)","example":90,"minimum":0,"type":"integer"},"name":{"description":"The report schedule name.","maxLength":150,"minLength":1,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.","type":"integer"},"type":"array"},"recipients":{"items":{"properties":{"recipient_config_json":{"properties":{"bccTarget":{"type":"string"},"ccTarget":{"type":"string"},"target":{"type":"string"}},"type":"object","title":"ReportRecipientConfigJSON"},"type":{"description":"The recipient type, check spec for valid options","enum":["Email","Slack","SlackV2"],"type":"string"}},"required":["type"],"type":"object","title":"ReportRecipient"},"type":"array"},"report_format":{"enum":["PDF","PNG","CSV","TEXT"],"type":"string"},"sql":{"description":"A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.","example":"SELECT value FROM time_series_table","nullable":true,"type":"string"},"timezone":{"description":"A timezone string that represents the location of the timezone.","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"type":"string"},"type":{"description":"The report schedule type","enum":["Alert","Report"],"type":"string"},"validator_config_json":{"properties":{"op":{"description":"The operation to compare with a threshold to apply to the SQL output\n","enum":["<","<=",">",">=","==","!="],"type":"string"},"threshold":{"type":"number"}},"type":"object","title":"ValidatorConfigJSON"},"validator_type":{"description":"Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\n- Not Null - When the return value is Not NULL, Empty, or 0\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`
Supports the comparison operators <, <=, >, >=, ==, and !=","enum":["not null","operator"],"nullable":true,"type":"string"},"working_timeout":{"description":"If an alert is staled at a working state, how long until it's state is reset to error","example":3600,"minimum":1,"nullable":true,"type":"integer"}},"type":"object","title":"ReportScheduleRestApi.put"},"example":{"active":true,"chart":1,"context_markdown":"string","creation_method":{},"crontab":"string","custom_width":1000,"dashboard":1,"database":1,"description":"Daily sales dashboard to marketing","email_subject":"[Report] Report name: Dashboard or chart name","extra":{},"force_screenshot":true,"grace_period":14400,"log_retention":90,"name":"string","owners":[1],"recipients":[{}],"report_format":"PDF","sql":"SELECT value FROM time_series_table","timezone":"Africa/Abidjan","type":"Alert","validator_config_json":{"op":"<","threshold":1},"validator_type":"not null","working_timeout":3600}}},"description":"Report Schedule schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.StatusCodes.json new file mode 100644 index 00000000000..9fe3ebc7f75 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"active":{"type":"boolean"},"chart":{"nullable":true,"type":"integer"},"context_markdown":{"description":"Markdown description","nullable":true,"type":"string"},"creation_method":{"description":"Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.","enum":["charts","dashboards","alerts_reports"],"nullable":true},"crontab":{"description":"A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.","maxLength":1000,"minLength":1,"type":"string"},"custom_width":{"description":"Custom width of the screenshot in pixels","example":1000,"nullable":true,"type":"integer"},"dashboard":{"nullable":true,"type":"integer"},"database":{"type":"integer"},"description":{"description":"Use a nice description to give context to this Alert/Report","example":"Daily sales dashboard to marketing","nullable":true,"type":"string"},"email_subject":{"description":"The report schedule subject line","example":"[Report] Report name: Dashboard or chart name","nullable":true,"type":"string"},"extra":{"type":"object"},"force_screenshot":{"type":"boolean"},"grace_period":{"description":"Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)","example":14400,"minimum":1,"type":"integer"},"log_retention":{"description":"How long to keep the logs around for this report (in days)","example":90,"minimum":0,"type":"integer"},"name":{"description":"The report schedule name.","maxLength":150,"minLength":1,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.","type":"integer"},"type":"array"},"recipients":{"items":{"properties":{"recipient_config_json":{"properties":{"bccTarget":{"type":"string"},"ccTarget":{"type":"string"},"target":{"type":"string"}},"type":"object","title":"ReportRecipientConfigJSON"},"type":{"description":"The recipient type, check spec for valid options","enum":["Email","Slack","SlackV2"],"type":"string"}},"required":["type"],"type":"object","title":"ReportRecipient"},"type":"array"},"report_format":{"enum":["PDF","PNG","CSV","TEXT"],"type":"string"},"sql":{"description":"A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.","example":"SELECT value FROM time_series_table","nullable":true,"type":"string"},"timezone":{"description":"A timezone string that represents the location of the timezone.","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"type":"string"},"type":{"description":"The report schedule type","enum":["Alert","Report"],"type":"string"},"validator_config_json":{"properties":{"op":{"description":"The operation to compare with a threshold to apply to the SQL output\n","enum":["<","<=",">",">=","==","!="],"type":"string"},"threshold":{"type":"number"}},"type":"object","title":"ValidatorConfigJSON"},"validator_type":{"description":"Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\n- Not Null - When the return value is Not NULL, Empty, or 0\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`
Supports the comparison operators <, <=, >, >=, ==, and !=","enum":["not null","operator"],"nullable":true,"type":"string"},"working_timeout":{"description":"If an alert is staled at a working state, how long until it's state is reset to error","example":3600,"minimum":1,"nullable":true,"type":"integer"}},"type":"object","title":"ReportScheduleRestApi.put"}},"type":"object"},"example":{"id":1,"result":{"active":true,"chart":1,"context_markdown":"string","creation_method":{},"crontab":"string","custom_width":1000,"dashboard":1,"database":1,"description":"Daily sales dashboard to marketing","email_subject":"[Report] Report name: Dashboard or chart name","extra":{},"force_screenshot":true,"grace_period":14400,"log_retention":90,"name":"string","owners":[],"recipients":[],"report_format":"PDF","sql":"SELECT value FROM time_series_table","timezone":"Africa/Abidjan","type":"Alert","validator_type":"not null","working_timeout":3600}}}},"description":"Report Schedule changed"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.api.mdx new file mode 100644 index 00000000000..b2e96eb15e9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-report-schedule.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-a-report-schedule +title: "Update a report schedule" +description: "Update a report schedule" +sidebar_label: "Update a report schedule" +hide_title: true +hide_table_of_contents: true +api: eJztXXtzGzeS/yrYqauKXUtZdl6b1capkihZkiXKjEjZ61iuSXMGnIGIAcZ4UKZU+u5XDcwDoJjEu1tXubviH5anf3hMd6PRaGDQ0n1Sg4KKGqp0svfhPsmpzhSrDZMi2UumJSWXtJbKkElW0txySupFMkgYltZgymSQCKgoUogr+skyRfNkzyhLB4nOSlpBsnefmFWNtZgwtKAqeXj46GtTbQ5kvsIqmRSGCoOPUNecZYBs7N5o5OU+6KtWsqbKMKpd3cywJQ3eMZOSUxDJwyDJSlCuQ2E5hxmnLWPr7Az82z+btAK1yOWte2WsjVFTQkJ48Ftda6OYKFzPijpJ0oqaUuaPOx42FYivQJgmVtOcGEmYmEtVEVNSMldOPzm5LakpqXKgcqOzC5wqQ25BE/cymhMmXHkOupxJUPmAOF0MiFTE1dYERN601+Tq9FkySKiwVbL3watNJ4Oka46Eb5Y2TZKP66I7UaUwMHss4j4ZXr65IPRzrajWTIpnH4a+Ljm2yn58UhpT673d3aaHZ4VVdvcpqgJISXk9t5woqqVVGSWmBEMyEK6ErKQlmYK5IfDoLckgqeDzORWFKZO9F8+fPx8kFRMdsGm4rDaySm9ZjjUejZUrJa6UyLlTss4UpUKX0qDaa/aZctQX/QxVjcrxr/1jE+y0/WUWm4OBGWi6aXoNYrbXpbjSlAARLKOhMaPBFWxJSTMXkDYl02QfR37Xe4JQsOQQGF8RDZzq3tSwGc4ialCjXzBBaAWMp9rObmhmHjM77eyc6NYLNZUJZ4JGHH3wXH4kreNC97RHDjvmpPIzwRV8EXefjQpdmPRsPgySuVQZTfvR3+yDCgUZTWuq2Ka5/0ZklIDwcxLN3ShWFFTRfEBKeUu4FMUAzUrTTIpcD8iMzqWiZGJrqjRFOQrt5gAUwMQz8qSv/DSywm+/bayfVTjNX2yyKS6LVFF0wxvt5qThCId4QWntzJ/LQhNQ0oqczKXyJtMMGDKTwyrm5O8hG883seHXlC8xBKy5Psu/++NJLm+FW/LuE2ZopTeMC1YgoCi6YqUJyzUBzuWt98s55dTQxphEQUOhn5HTOeF0bgitarNyY3PLOCczSqSgrdfwLLRU0zTZpI0GAaVghbSiGasZFSYWIF4Wu0ppJsWcFWm7jsbVZlk2BVXQ0HgDX/h7hea3inqWm7kySAwzbnr6SXnZ8jZ0rL2evLno5dw86k0DgnVwLaPZguiaZs7ilsBZTqRroYN17AgdSzJIJhyyRfv/269x6XrMch+7fPClH79YjM2DhFVSXL7BKallanz4Khkk44vjZJAMJ2+TQTI9+ud0A0+DRH/im5bSyc/nRBswtHIawcUwp3MmqI5iA+9SdCktz0lBTe9a0G6FNM8I6vaTpWqFnod+rmlmvH0raqwShDLX28XV+bkLHIiw1Yw6hVs37XrHOzk6PxpOfQl5dflmRAyraKqpYlSnxrnYL/C22OhOig12sE/aMuKre8kVxcUeJ0PjjHzY2M6rtk0Y3uzPFctgd3/G8hvAEK4FskxBQOY50+n+DGYhyAuGnqMHdAVRK13RkD6AChYypEVhWUTfWB7QTGuwAc1BmJWiAaLg7g6WjPMQtDe2mtnwzUNgSoakhhkHkYVVqDUhKQUs1KoHDmEBKiRVSnU6AQ5QBfANm0lrAqEOpQUedHzE031gNtD1K0WpwTC7Q45hJpUUgUwnoCAU/LUsQQiqZ1YVAWrD8TmDqo5efYaLvbQBu2esAM5CWugSdNDmHAoZDPE5mym6pu9zWYWUBZGHHdiZrWagSxZiGhZBnRFwmMmQrq2JaE1VYAgjNMRQPSNZQM50GdaRQsklC95ygUYwC9i4yG+goiKswqCiwaBfSAuLrJTG9NgbCwXk0hYyeNtYKiN3LuQy4HoCMp1GupmyamYXJmg3VayW4QhMrWCBvt8xkZeSosfer2gzFyEiRVZKBQWNsMIy7oe+gwwrbIQoKCwwEWMFxjsCJxEVUqf7TFG9scIQDFSgss3Nh7KS+SVbQg7NGGyoonI521z22t7Y1caSc0gvmbzZ3GxERS7vNpddMpkeA+e0sedHFSbAzeamExDpa+vd48bCc8s29zm1ma1+o+GVLi2s6cbG+tBWZH5n3UGGLeQi7tEswkYHULJHdHoAIqcKdFSgZpBHyjignFYxze5Cw0IPnO1MYMYjrg4kpG+ZjtR3IAu5BjAd9bXZwoZQzRTLC5oewCrGa5keKxQkgkVmRQQoyCDu8bGlDmFFhYg7WsUjNSxZBoWMkdJCGc2iIbM55Ggeit6FuFTA0xNQM2lVjK9Z/VBqg0Yd86eoNpGOh5ZB3M6ioCF/hyBws6lLWIoIvtXyMZAOFY0cyyEVS6oiwCjJTIhI3KxEnB7llRQxq0dMWUHrULtHHJfKJeQyfMGR0FRAHnb3CiPFC8pjjh36DlbRiCEInEbz/ZjjDjO2nGOZmxJmESL1o1poWenUqkUErvN3bCGnXNpIumOLESjwtYor+GRd0N1jK4j87QlwNofPEbJcq0JVJTXjPBzpU5EzEN3/uIToDcVnQn7eAI9AUVFs6m/sjj/boGKtcEo5T4fMrDaUvaVL2IgzkeFE28TdOyagguxxyWNx7JKFw3L6CbiNDPM1VBDb5foS8toK6oPJBjijwthssdo9l5bpLqZZLx1JYVhGY/2jYtPTixBRwKnI2U3I5zmkYwi9wjmrQh7P0f+JgvJIPxv5OZe3VKVjhfoMK48go0xGgIB4oUfExm0UK6SJEcME+2RpBBqopJJx0zswPPKTjxfdERXoJ2jUGVUsjysZDgvsLAI/s0yuG9kIGYtXnJEUmVlHDFWKrtaxJcupXAMVBb4GaaoUhDq5gHb30QL0Nn0vI/9wwWpWRGxcNAFfRyopSogRU6aHsJAGF1jLofyt0iFFkX6rFNmZQLxgX1gbsvfmhgkowrePAedcDBSCKWNFEaEKl0w2CxU3LiUVLHQoGPXugN3xZrlWkMp5OqmBiTVcpvuZWq8s07eUl9HbLEX4kmUxKgyk++iWQ7O8BCZW6SWL169LEAsm0lPBaTiweFYxpxFQxGHwJdWSWxPVYTI9UCAibi6lBhXNvgkgf6caZpSvwyoaKoRYHF8gJFO3xq7hMh2DjTzQJJOK6tlKW5GHcMlqJbPQCCYsDhAnJj0AZUqM9VYx/lqWQsfQGTNmDTq3GVvrcFrKCtaqedcfKn5yy+YmHVqlYnxKC5vhTrQOu52WNvKA09JiDLu2bE/ZjY0XzClOOSNjxMjIz7zFgbSxtbxlqoiM9V3JDC2liqLWd0wIVtNwsryHhTWR63iPy8XtQjRmhmOfGeYPHryD6qFDWPrFLoAshlSHV6pbBPqyEWSfLCj2CG5jvADLRlblMgbHwCsvdo9dSjzaghicSGvKdCzXGZis5O1a1amSnMfQW6mNdFbogN1zKYoVBTVbUcelZriRDZ55Bd7nO6pqQnFHCMhXqqM+Ge+UG0LOaEfpsoCZH4iGXpQwg7wDzEr1jQ+gKPO+8ABK1TgrTy6CmqJYeGk8qQT4cypHUqZs99IDpssF7etiJMxaagg8s8bvihxdspCQbAZc95IPSymKT/7LUQNYUSxCQHJZeSeN5CFkGfREBTrzC7+jy+bMxRGMd1wd2hkEhC5B9Ep9BRUUVvdsHsNd94zbm15lJ3SmZE/JdFiydMRE2UOiSM9kz/6JXHb6P1ULa3SnuFNtQMx6Lb/G47eei9ewgro54nM0VVa3iyECZxA0PoMqK8H04p/hJrFkPYmmo3rSlBWI3AZATJcg8lXRdyf5AnrmzhRoIVegenHO8BAwPbdVbfvX2KwMxvLM3gLr7GjU7u1awvZEAXlvJCNYYKCielow3rEysjrrZ8QFy6RmXSEeVy3snaCB3hHTbMYC3t9UwbOCTqvjUsgqHdN+gMcYK4OArvp4hfMeeiF/BtOz+jPufAV00/7n1d2KS5V3DF6CKGRvUpdsBXn3sgm0oZenFiVwFtC4FQbR2deEyt4gJvilquytfsJEAbVUndlPFM0FXUi+CoSfAqv7yTwFnOmiU+50xjjTfTEtVT9KU8rT/SVbdnSJR4EhVZc9KRcr2RMBB1c3VhTpGE9Ye51ecQAxg1CzVxxEegBG9oiy1aeOuSttdi5oP33e4qcb1hypOoBDzpadE0fILXM6IEWg/vd0AYYqJtq9owcVXXod4J4B14H9O9kc97TIAVWV9UPeQkMQ4I/ee6Sm6Vuq/NFPi74CquQasga8BpGOoFl0WnAEOWUqeuUlXS1uoNlltqBfAo+pVAWLak9MekJ5c3LcgyC4X92tNgo4rjjDaUznlAPzUnTggWK6Pc4OQLmgIj1hfmXt8CE6Z+WZ70Grmoiggw5B3frZ0EFHNuNxuxM5A3eNoYfOT05jmomcNqtxD0qVpyfyNn7liHI87FoT5GLyLqZxDxMhY7qO/GzxGgFvZm8Hu/GIkVUu1lQ+BV2BYLGgb1lmpFoD31Edy/4eo8JbJty44qclxnebvUpDHdJ+Q9dAR+B6aaimz+HR1H3SnH4/PHRPgMdIu62t9Ahu8bxLbQDsjirRAyOJWx4WIBf0do43DBr9NOgYMjYPu56AXoDJSnoLQeP3duFm7bBknOJXLsMEFcaz4DDPwWmr/qE/kz5yEh1Nmp/fHTm5jopVjfIeMaelI5PtHo+m/dNfnwfPL8LnqCAq+Togwudvgudvg+fvgufvg+e/Bc8/BM9/7593Ai52XoTPUUFU8nVIfBMSAVM7Ya2wUlgnYHwnYHwnYHwnYHwnYLxjD+/b3LKsbOirYav8q+mwfRK4LdZuhJH+xXJcaY4sXn7Y3a9wtHP3DbOFRC69h2kBnCCL0plRC5mSuq1iQx9QPvcToQcKBc7TdYjy63NLKzBMc1hCiFmt/ZWxFrF4RYlGXdsc6jVEM1HQoPNhyTQTEAg6lDUVJUS1Du0sYumYzRR+BVIBZKkSftPWICeUayYWrEdONad42jEKNRQEsA3yGi8pBR2dYbzCBKopABldhpSSIbliAXXO9EwGbzy/sTN+4zfDLSRFHlWxn2mFTrrosRHkiuUh7b+DdaRitIQq6GXEhIsDWlIKcMciHa0zedvTfdTZAG80D6qPQbFgwMcyL6TyZ7kthF8qA0u6ZEVQeulP3BrKxX0Q0hgAKCZkiCm4ocs1xISanrBqTpWsZTB+k4Wsb8JXyXko1cTIbFFKHsykKXDORKC5KVN+oQ9oHb3kiq9AyGWo36u7spBKBkP0FnJ7F5K45w5eg+FcaAZvGRfMBkp+K3khY8N7B0pDMGq/QKHoLKRrqeRduQrY/8Uq73uOD9yPnWYd8GtA6/9bR9v4rdBnnbj1BPeFC78tPM1os+74bwH43RoExoPMjVeDDsvmWkJHK6aNP4JqIZlFNSQeZff0GVWFxRiuh0ZQ0pDiOVtSHSJWMeP12EEraUzQ6pJa4b/Ynvro/1QrcEeB/ReK11C7orNbuAFOnQM6Z7MVlo3cMjuaND//NnLLrD8W3z2AG8DwicbQxG0pG+CYCuoDiotf3I+d4ck+9nEBS7hBBYwvcWUYT6Y/jF3nTeCwu187a+5Imy2aoWihA2nxXmV7KtXCwxJM6RaQHvHn0C3tQ4oQmIMJuzjCk72ZdUF/i72CBci5DBF2w0LSCpj7uzYtdAwc6sY0eqyasejt+A0PeAbC6SlAQxlOpJDcL5Ut5I5H/VeHFjoDsQYwtJEKIrbOJFpBCARD32IjuLFKRoDCpAAIhRmx/BZCLV2AVSGPF8yGL7qQai75IkJsRcOBHkOBx8uFjDAOYa9jZjJgKmR3LEvhd8M9IqCmEaBMOvLn1AF8CUoaKYqQiQkwPyl6oJJhhSmULNLpFBTcRjWwSwN1yPdURXb4DhY0Irn/0NgC76FGSrZ2L5WxhTOSyzdD9/MMr04GhwX4vdit6T7yuprs7nOMu9tnanFb3VCK3UnRFPWB/9XEzY+d5uNnj/htwNVk9wRugTH/3NTamRi8Vu6xEctKVrSvCTYMV5NgW3A16ZTqg8MwMHy3M7nC/5z7cRHipkuYv3crNb6L7GoG1wzx/iUq0N+b39S3u7iKJxa/f0lX1psZwDrQ3tzPZFXjfeVbZkoCxJSK6lJyd50T82lW/jo/dddHpTW1NdciYPfHZJD8+DIZJD/hP3x4iT/+8nKzVtrug/u//nLo797/fdsKHN/87fWwWduH+Im+am+4OnGby6zNLVfMg8iJnM+bC6hzJaumyN1vfeZzGHR3Ebu/C+v0ZUqqKenYcEOp967FDrmQhlxYzskOeede7Qbe3Y71r2La17k6Px+QI7zx7ZJsnmPjN26ApGob/6o/8dS3Tn1rP2oMr6bItnKn21+x86mylNBnxTPy63fPyY8vyd+++/XHmfppYmufu4Mc9d2QthtNfhyQH18OyE8D8tPLAXn5cuBSfv7yMhh0IQ3BO7nJIGnbPU7s2TD8t1LhkXyK12ul3ZC0cTqPsho0XlrJCWCOTtPWX2HusxyIFYZxwsxX2hcRd6MeUxyMJFQpd67XXTj+5vv1bIY/ypj5w2vpbY7bJdVmv2bPamt8Akjzyj7XzL+gyS57sSl5rNXVpvSvMFEqqBflHfmcoSAj6EWY8PNisD5BviQRZy3P5l/PlWlTYTbmvnidxNkuTc7JWlYJ5n80WYOd9G1CxocXH+MEhw/3PlUwuk3fXKJ39+O/8OZ5f7H88f3vxixah/2bXhn9sPOTgfd7scF9hdPq0UxBw314WM/QStbzLJt0x/WcSpdZoGsptF8avn7+/D/InWSb3Ld7g+Vmm2q5TbXcplpuUy23qZbbVMttquU21XKbarlNtdymWm5TLbeplmybarlNtVwr26ZablMtQ2ybarlNtdymWq6VbFMtH5VuUy23qZYNsE213KZablMtt6mW21TLZJtquU213KZadvQ21XKbarlNtdymWm5TLbeplttUy22q5TbVcptquU213KZablMtt6mW21TLbarlNtVym2q5TbXcplpuUy23qZb/d1MtH7WKky+Zz4Lsk9O22Zj/49mY68mYf14q5pdnVv5haqXPI8nRvL79j9InK6o13oz9gryM2JS7hskBYGag+zuYe+RU+PSK/o9ykhovGefI7GO5grZelhd/rixXAqwppWJ3NN8j+xbPcEzzftLlfGwQJGzoJfnmz5XklVQzludU7JH30pJciq8MKWFJSY2Lo0t4dIt9llGt24wknzK5ScCuPy/dt3+udLiGuhPePeJjK2dCNO+zPnNJNaatEPqZoXE9lqjrw0n09dd/tuXhrRQkZ5wStDqz2iNNBIRj5de0DXIMXcoOitr00LTGV333ZzuHU7yfJYATTdWSKi/FHtkXxIouhciBRGYZ3nvZOL1egQHeqWCQaJrhScPK/cXfm1uDfh2T7A0U6OPX/aXLP/68k8mcThyT/k8Fc/xEuJdkV5fnySDh7kZSRzZTYS/JrOJk559kfDUl1wmmHu/t7mLmEC+lNns/PP/hh12o2e7yxW6TYP3iOiHX19eCkJ0Tcp3sN57BKX2PHFBQVJH/2h8OjyaTdPrm7OgibjD0w7UzXdV0j6yPWF83J1/dXycLurpO9sh14tas6+Thq+Rh0Ak3XpnSbb9b8TqgE5BVTlnNJNLX4lq0CfrkZQdjgPMEX0u+XAsDX7+kkFOlX96v6cKz3ejjOiF/bbxRavDL3kPTGmV+uUnOa/H0WtSKCfOk5fcZVn7y9GmogdewhImzpUALEdgPtRQaFdEJj9tKQ+bUZKWT/V+T/N4L4OM05Hx8NV1Xyl5bi6xbCgr7a2ss914zU6eYXwd9k9BWvHoe24uv3epzJvPVHsHN1DM/ndl89eSeLOgqUC55eIq1Ucf/uBZeLxgudjpZ03hTSXL6jMviCVZ9+o8Ep+TaOlnnGKzD+nYYk3KbcDap3V0h97e595I11d7XiwccMedN/Cy2Cgd047gk668/x2KS0yXlsnYJkb4nZy++o/saz14yyR/2dnfvsauHvXt898Oj3pr0/qYLDPUUQ/fdJti6bvxuZw4u4ndsBjuqhnS/zyB5pKyT6XRMun4eBglyE/fXyfuIuYl3uFiGsTHG3qdj7MSdL0SdbFRV097VfnB/7Lx1uuhVKy+kc733ycxZ6as2nn79Ds9I3Kri0ttdaR8ZO6EfBtg4VXSO29d/txPsRUtx2f8Z9qM/+FU3z/9oc/Wv7qOeh/uo5/9/91HPH/1Wm9/OGg/yxAM9bsDMGtLHFT4b+3/3L855/m/94pxBgr+n5fEhSPs7GoKThgBCd+frLV/4WYxfcxxrzZD9jmtd+/UeDac4CXZrjgehDwPv/e4bt/shgRqPU5cvknYAkkGyVy/QSXkv9CG5v0ejv1L84QFhd3TmN9itI3RWkjMX0+bJ3hy4po+46YLT5Mlls8N66qL69U1vvejHK+a9TacXKz+EFqlkgCEDrieL5OEjek+34jqefEG4dgYNH4XIuDj4FvtZRmvzu3U/BivZ+Ap9GC64LiqWOTZR7hsi/nQ8tr+IAH8LA2I+brE+fPZdopvD7WX4K0Nad9g8oFAbtXB/72v4yOGhU4oLsVAvDw//DbRwj4A= +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"; + + + + + + + + + + +Update a report schedule + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.RequestSchema.json new file mode 100644 index 00000000000..a5ecdb61fc4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra_json":{"nullable":true,"type":"string"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"template_parameters":{"nullable":true,"type":"string"}},"type":"object","title":"SavedQueryRestApi.put"},"example":{"catalog":"string","db_id":1,"description":"string","extra_json":"string","label":"string","schema":"string","sql":"string","template_parameters":"string"}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.StatusCodes.json new file mode 100644 index 00000000000..838f35b4efc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra_json":{"nullable":true,"type":"string"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"template_parameters":{"nullable":true,"type":"string"}},"type":"object","title":"SavedQueryRestApi.put"}},"type":"object"},"example":{"result":{"catalog":"string","db_id":1,"description":"string","extra_json":"string","label":"string","schema":"string","sql":"string","template_parameters":"string"}}}},"description":"Item changed"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.api.mdx new file mode 100644 index 00000000000..cb341e6f4fe --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-saved-query.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-a-saved-query +title: "Update a saved query" +description: "Update a saved query" +sidebar_label: "Update a saved query" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/isEMaAJpsRx0A6Bin5IghZN16VZ7GwDosClpbOlhiIZknLiCfrvw5F680vWLv2QYdgnW9Td8Z7nXnhUSRXTLAcL2tDwuqSZoCFVzKY0oILlgE+3NKAa7opMQ0JDqwsIqIlTyBkNS2qXCqUyYWEOmlbVjZcGY09kskSRWAoLwuJfphTPYmYzKQZfjBS41tlSWirQNgPj1JhlXM7xb84ePoKY25SGh69+CqgoOGdTDo07tRPG6kzMaRXQZDrJEtR8RLJ1N6AJmFhnCl36G4XONDxYzSaN818V52wK/EkYOl56qsPDo29RvePf5JyFXHFmYdJPg6/qVe2KnH6B2NKA2syiOB2xBSS/FqCXl2Dsscr2VWE9ayxXKNKLa2OwDddwLRqdQJ/0brXmtltoKOut3K0IbAXcAVtPB/qLTICT2ux6GVS4YJQUxifs4cHBd6S7BlNw+38Z/IfLYENjtTC6DPg3l8hGjZxZyEmcMjGHBBG9/K4yyMEYNofe0fIo36vstYr0hCWkPoJCciYWjGcJ6dAQpeUiS9DZTTA9XY9l+LxYrgQrbCp19ickITkubArC1vuTth1tAdJX9EhePi+Sc2nJTBYiCck4hYZkQLqNLHQMJJFgiJCWwEOG9G+Cam04RIeHzx0bpWWMj1MOBONilyH5DdPNxwe0lnobjlNZ8MRBrS3U2rjVq+cunzNhQQvGiQG9AO1RhORYkELAg4IYg+YWiYzjQj+SgO+wh7UUBNRAXGjEiHPml3tLw+sbHBYtm+PsSbFdIoibgD7sxTKBkfPNz6WcCeyG8dXlx15Tqx99+uBzoTnZ+4NcXI1JRFNrVTgYcBkznkpjw6ODo6MBU9lgMRwY7NCTO2zRg2FESRRFgpC99ySix3XdOMJDcgJMgyY/HJ+evh2NJuNPP789X1U49aHaGy8VhGQ9Wp1sQl6UEb2FZURDEtEF4wVEtHpBq6BFeLG0qRQ9jO1CizLLldS2KSATiUg0Ywh50y7jibOD25J/SEXglVJgCWjzplwjxPtekxJR8iNhMWbwxMpbEFWtjcDfbAMbid1IKJ0Ju9M4vY/CO7u7fRo+sAUbuWTqUbGy2AVdCoNstAywe5ZZMgMbp46AJ8AvPYocbCoTdP/iarzOTNhIkfWcQcSfm7QpPT1jx87noFPpZ43naDNzvHRD6lQmy5B8GH063/dFnc2WOyW5hWWPYVLtojQS/ToSnpyEWdYSs0Z7LSQ57HM530HR3dcUC3PtPFEJs0AYcXwRxxcNqKcIr4kFRsVdHUO6jdtS3VYYN9dUfFUXGsO6NTp0ff+P+JoksAAuVQ7C1u3JZY03VCotrYwlr8LBoERTVVhirVQb1k4LY2XemAjogukMu7ipO6ozg/8TmDE3lDk3ccwSRY7tqn7EH9ezVu2/H48vSGunCih6s2qvxbvh3Mj3XXyHd3AiNTm7QCOIZdXIVqpqfSdduQt503tHeGp4kK4Dl3Tq0vSd1DlDex9+HzczItaWf0vbk8OBrgJUnmiYaTDpU42gFSPFZfep4O23XBEPnnn+DWgmZtIHYYXzQoE2sHIJ6JYw473cYugDaWzO/M3Jf2V5pLzWbmU1gxYe7EBxlgk05pK/rEvvmjKV4Y5DRNaVHw1oqG4xUX0mXtOynDIDV5pXFS57qfD6pisGV6NJ5sabhIYzxg1suNTOKXTnsh5Hd0kX7FVX60Umlq7meIFPNMBjwn9pqm6wVlyDdbv7F/1W2VPcmIuwFXiN4zgGd0w8LnvTa14XV5ix0/p7VS4TVNHsHq/87N77KB1kf1XHNX9WFX5m8iYxqXHq7oWqTf76D4LaykJZegl/UFQtKe5YRV6q6i8+Z8Yi +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"; + + + + + + + + + + +Update a saved query + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.RequestSchema.json new file mode 100644 index 00000000000..4b10b8fe79a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"description":{"nullable":true,"type":"string"},"name":{"minLength":1,"type":"string"},"objects_to_tag":{"description":"Objects to tag","items":{},"type":"array"}},"type":"object","title":"TagRestApi.put"},"example":{"description":"string","name":"string","objects_to_tag":[]}}},"description":"Chart schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.StatusCodes.json new file mode 100644 index 00000000000..1b8c9a5b65b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"description":{"nullable":true,"type":"string"},"name":{"minLength":1,"type":"string"},"objects_to_tag":{"description":"Objects to tag","items":{},"type":"array"}},"type":"object","title":"TagRestApi.put"}},"type":"object"},"example":{"id":1,"result":{"description":"string","name":"string","objects_to_tag":[]}}}},"description":"Tag changed"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.api.mdx new file mode 100644 index 00000000000..109b9abe168 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-tag.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-a-tag +title: "Update a tag" +description: "Changes a Tag." +sidebar_label: "Update a tag" +hide_title: true +hide_table_of_contents: true +api: eJzdWG1v2zYQ/ivEYUATTInrrgMKFf2QBi3WrmiD2N4LoiClpbPFRiJZknLiCfrvw5GyLFvu3vIhwD4lIo/He5574Z1ryNCmRmgnlIQYznMul2gZZ1O+PIUINDe8RIfGQnxVgyAhzV0OEUheIn3dQgQGv1bCYAaxMxVGYNMcSw5xDW6tSUpIh0s00DTXQRqte62yNYmkSjqUjv7lWhci5WTN6Islk+qeLm2URuMEWvrasbwGWRUFnxe4MaG92Doj5BKajb01lEJ+QLl0OcTjA2Jq/gVTZ2+cunF8ObgIPoV95hSj/QiEw5IMajpl3Bi+hma7EHRCBE44shCmfHmJ1p1pcaorR9fiPS91gcP7Wss6vrvvfUOvrhu6cuBQ41hL4b6fGlqwWkkbGH329OkD/CGynr9lVc7J3f6GqnD/b/cNRHcdSsyM+0w8xMMDF0/5kqU+bzO69/mDnFiitXyJPU9uqP0bjN1BeM0z1mZ4zN7JFS9ExrZ1hGmjViIjY4dYemcDlvHjYplJXrlcGfEHZjE7q1yO0rX3sy6ZDgDpHwxIfnhcJG+VmYssQxmz31XFMiWfOJbzFTKNphTWEiKnGE9TtJa5XFhm0KrKpHgIYKcvoHv+uOg+KscWqpJZzKY5bkIIsw4CyxRaJpVjeC8ouIaIOh0e0bNnjx152ihyBRVFRlHn1jH7hZIpRB8ao8whHOeqKjIPtdXQnqarfnzs4vBOOjSSF8yiWaEJKGJ2Jlkl8V5jSk7zi0ylaWW+kV5vueNFR0EEFtPKEEZqUr7cOV8rryNwfEmNC9VIC9cR3J+kKsOJNyx0NAWXS4ghnV1+gAgKPsdi+9mGfwxpZQp28hu7mE1ZArlzOh6NCpXyIlfWxS+evngx4lqMVuOR48vROAGWJIlk7OQnlsBZWwo8yzF7jdygYd+dnZ+/mUxupp9+fvNx98B58M/JdK0xZvsu2spm7EmdwC2uE4hZAiteVJhA8wSaqEN2sXa5kj1s3UKHTpRaGbfJGpvIRG76AvaqW6an7oiuZf+QgigI58gzNPZVvUdEsLklIwH2fVt7bpy6Rdm0pwnwq0MgE3mcSG2EdEcbY09J+Oj4uA//PV/xiY+cHgU7i1snK2mJhQ45v+PCsQW6NPfA/wXsOlhfostVRmZfzKb7jMQbKbYfI4T08yZM6kDL1LPyOdoe6UdJ4GYYKUF6Q+ZcZeuYvZ98+ngaMlcs1kc1u8V1j1nWHJM0EfwykYGUjDveEbJHdyukCjwt1PKIRI9fAmVfQE8zQuX8LEFNG/TpqvVtQy7wxSAkZGXIQweJhv0y8IG2WYYrLJQuUbq2rPgACIpqbZRTqSqaeDSqSVUT1xTuzUDbeWWdKjcqIlhxI6j62rYSejWhfVtw38l5MyEClFVJZab9pD++3Ozq/2k6vWCdniYCsmZXX4d3YNwk1EvaozaRKcPeXZASwrKr5CBV7Xkv3fgpbFMzJ1TtA0hfOWuY+8h7q0zJSd/7X6fQjnSUJmEXuorvQTcRHb4xuDBo8/+qhLRYJS+38+Gbh49FNFlcNxEIuVBDPZNKo7HY7+57SxSVQW41DmRbV/IwsIR7ZzrjDhlvp4m9qaZ7aIeTdQvc4b0b6YIL30j5mK3bTLkCrgUZMQb/kkEEsb6luAqBcwV1PecWZ6ZoGlr+WqGhJ/B6G7s+pTLhu4gM4gUvLP6FlUeXbU97zL5l4mZIkmufIkVFXxBRgQ6/BjREdihx/vaw0S9WvYOD9oMyN5w4S1P0Bfrbsv0aczGjAJu3vymUKqMjht/R1Mvvgo3KQ/ah7tfCK1GF1iSopBik1r3X5HSx2v5DoA6yUNdBIpTqpiPFP2jES9P8CY7S/Mk= +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"; + + + + + + + + + + +Changes a Tag. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.ParamsDetails.json new file mode 100644 index 00000000000..32e33f67aca --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The annotation pk for this annotation","in":"path","name":"annotation_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.RequestSchema.json new file mode 100644 index 00000000000..87799d55922 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"type":"object","title":"AnnotationRestApi.put"},"example":{"end_dttm":"2024-01-15T10:30:00Z","json_metadata":"string","long_descr":"string","short_descr":"string","start_dttm":"2024-01-15T10:30:00Z"}}},"description":"Annotation schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.StatusCodes.json new file mode 100644 index 00000000000..2ff8831be2d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"type":"object","title":"AnnotationRestApi.put"}},"type":"object"},"example":{"id":1,"result":{"end_dttm":"2024-01-15T10:30:00Z","json_metadata":"string","long_descr":"string","short_descr":"string","start_dttm":"2024-01-15T10:30:00Z"}}}},"description":"Annotation changed"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.api.mdx new file mode 100644 index 00000000000..aba505dd21e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id +title: "Update an annotation layer (annotation-layer-pk-annotation-annotation-id)" +description: "Update an annotation layer (annotation-layer-pk-annotation-annotation-id)" +sidebar_label: "Update an annotation layer (annotation-layer-pk-annotation-annotation-id)" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/ivEYUATTI7trEEzFf3gBi36ErRB7GDDIiOlpbOlRiJVknLiCfrvw5GyLL8ka9YU3Yd+snU8Hu8e3h0fsoScK56hQaXBvywhQh2qJDeJFODDKEbGhZCGk4ClfIGK5ddsKhUzcaJbg+BBQlNybmLwQPAM6esaPFD4pUgURuAbVaAHOowx4+CXYBY5aSXC4AwVVJX3Lx48ZO3V+FUSPcyNsdNGbV7KaEEqoRQGhaG/PM/TJLSGu581eVm2bOVK5qhMgpq+UERXkTEZ/b83MBQRi7hBZpIMwYOpVBk34AMJO7Ww9lMblYgZVB7Q8lcZGh5xw7fXeDf8+IE1wx6IIk35JMUlAlv2UilmV9bGtrEBo1HWFn6FRR1LZe42aYc3bGb89hTFzMTgH/V6HmSJWH73d61gOK3wNSBb1QfDXDUSOfmMoSGNxFDMMGhsn6M2gzw5yAtDTuEtz3JSaacAHPYOn3Z6/U7/aNTv+b/1/F7vL9jaxeXC69uxkq5B2hK3cNi9UkWhbOxACxyXwpt1UpFA51Jol9GHvd431EMStepNFNmEys2uUKTmZ/n8LB8qn60Z6wVFOdRv58z/qsLuK7Ew5mKGEcXz9JvKKEOt+QxbtXQn2uvYNRPhJY9Yfcb57K2Y8zSJ2IoMsFzJeRKRs9shtea6WPo/NpYLwQsTS5X8jZHPBoWJUZh6fda0sx2BtCe6SJ7+2Eg+SMOmshCRz6j4apCR4NayUCGySKJmQhqGtwnBvx1UY4NWOfrRefZWGFSCp0yjmqNiqJRUPhsIVgi8zTGk6KyQyTAs1B079Zobnjo9u7jGsFCJWVjS+vnGgH85Jtpm+IyIbLvqTom1ahh7cNsJZYRD66WjuykXM/AhvDg/pW7AJ5iuPh3i9F2olHX+ZGcXIxZAbEzud7upDHkaS238497xcZfnSXfe77ZIp2XL3baoW65x0ioAFgSBYKzzhgUwqFPRDvvsJXKFiv0yODl5NRxejT6+f/VhfcKJ29TOaJGjzzb3daUbsSdlANe4CMBnAcx5WmAA1RMgul0jcLYwsT0+lhg0ggaFJMvptKlzUgciEEtmwF40Ymrhe7Qse2SoPGc0Rh6h0i/KDcBcbDVoAbBfGQ9D1PrKyGsUVT2bgHmxC4xA7AciV4kwe8ugDkh5b3+/DdM7PudDm5YtqNaEq6SRQhNaDUL8hieGTdGEsQXoO8BTuigzNLGMKLyzi9Emcv5Si23mHCHyaZl2pYNvZNH75K2mtLPOYbideU57CfpERgufEZs6cO0jmS72SnaNi9YOsGqftGkjngfCgUendQPcxrbUSjLFg1TO9kh1/zlQC9ho8bklLFxsX2T3VpKOlXTy605L1vqbRPtErSyudNEsaKvtddOHOzeszK+re/aMksX2RNeKCkW5tDMlYDOoUxpmEc4xlXmGwtTd1aaqM1TmShoZyrTyu92STFV+SQVcbVk7KbSR2dKEB3OuEmKluj4QrBnHDqfcci7rJniAosio29af9GMb7br9N6PRGWvsVB6QN+v2mni3nBu6Y4PG6F7PpGJvz8gIxbJuZCdU9XyrXdmb/fLoGNKh54K0B0gJE5v7r5ek9t0fI6ifCaig3eiK4Nqg6RZxY64UThXq+L8aqe8i56s3h1f3XCCfdQ5/H/WP/KO+f3h80HvW/64Ud8dqFb23TOX2hWFY5Kg0tjl+S0Sp7vTmfbeD2mTcEpD6yeYxi3XNs4a/GLw13TzliSAPbKmUdSFfAs8TcrMPHmwWM3jg28estVcnf/2NabxM7UsoywnXeKHSqiLxlwIVcZXxqrrcc1ui6X8E/pSnGre8bngb7J3XPHafPexVbmfgtZCLha33tKAv8OhcdK929iXuEZx7TLfWwa7G1EnsmWahdDrt06llY4v0UnxuxiAM0Z7cd+uOW63/7ILqeVI/C2YyoimK39DDCb9x7koLke0sVuboQ+EIsTNJJU93j1ZqNq2h/kNB7QSkLJ2GO5urBh/LdAiXqvoH8qGFXw== +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"; + + + + + + + + + + +Update an annotation layer (annotation-layer-pk-annotation-annotation-id) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.ParamsDetails.json new file mode 100644 index 00000000000..a21f8dd40a1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.RequestSchema.json new file mode 100644 index 00000000000..f52f3eaf388 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"descr":{"description":"Give a description for this annotation layer","type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"type":"object","title":"AnnotationLayerRestApi.put"},"example":{"descr":"string","name":"string"}}},"description":"Annotation schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.StatusCodes.json new file mode 100644 index 00000000000..29ca8c0132e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"descr":{"description":"Give a description for this annotation layer","type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"type":"object","title":"AnnotationLayerRestApi.put"}},"type":"object"},"example":{"id":1,"result":{"descr":"string","name":"string"}}}},"description":"Annotation changed"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.api.mdx new file mode 100644 index 00000000000..dbdc671f4b3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-annotation-layer-annotation-layer-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-an-annotation-layer-annotation-layer-pk +title: "Update an annotation layer (annotation-layer-pk)" +description: "Update an annotation layer (annotation-layer-pk)" +sidebar_label: "Update an annotation layer (annotation-layer-pk)" +hide_title: true +hide_table_of_contents: true +api: eJzlV21v2zYQ/ivEYUBjTInjogUKFf3gBu3aLkiD2MEGREFKS2dLtUSyJOXEE/TfhyMlWX7J1qUf+mGfbJ6Ox3uee+GxAsU1L9CiNhDeVJCgiXWmbCYFhDBNkXEhpOUkYDlfo2ZqyeZSM5tmpvcRAshoi+I2hQAEL5BWSwhA47cy05hAaHWJAZg4xYJDWIFdK9LKhMUFaqjrW6+Nxr6VyZpUYiksCkt/uVJ5FrvThl8NOVj1bCktFWqboaGVw9H96QD9lq2QcdYTHsLigULQ+meszsQC6hbWd9HkVAMo+MM5ioVNIXz+8jSAIhPterR3QN1J5OwrxpZcyGxOgnFn/5zMX6GxY5WdqNKSX/jAC5VjD3lrswtFd0Yd7Li/Mc0aOndjVpPAKCmMZ/f56ekPxCZLerEXZTGj0LsTytz+z0O5t207uETdqE/Vv0f7n8Idp1wsMKFDXvxQSAs0hi+wF9dHedgG1G2EtzxhTe2H7KNY8TxL2KY7MaXlKkvI2X1Ivb0ey+jnYrkWvLSp1NlfmIRsXNoUhW3OZ11pHQDS3+iRvPi5SC6kZXNZiiRkVBoNyUh0G1nqGFki0TAhLcOHjOjfB9XZoFNe/uw8+ygsasFzZlCvUDPUWuqQjQUrBT4ojAmdEzIZx6V+JFLvueW513OHG4xLndm1u0W/3lsIb27pOrN8QTdrv+pc1Ru4DeDhOJYJTpyX/v7NuVhACPH11TkEkPMZ5pulZ5zWpc7Z8Z/s8nrKIkitVeFwmMuY56k0Nnx1+urVkKtsuBoNN83szjWz4SgCFkWRYOz4A4tg3OSbUwnZW+QaNftlfHb2bjK5m37+/d3F9oYzH7nj6VphyHaDt9FN2LMqgiWuIwhZBCuelxhB/QzqoIN5ubapGx1aoJ2gg5oVSmrbJp6JRCTaq4i96cTUPI/oWPYUPgK/M0WeoDZvqh1WPICGmQjYr4zHMRpzZ+USRd3sJvRvDiGOxCASSmfCHrWen5Dy0WDQ5+ITX/GJS7AeH1vCTfilMERJRwO/55llc7Rx6lh4KgeVh1KgTWVCGC6vp7v0hK0W280egv2lTaDKczR1FH0JNlv6+eOJ2s8hr90yO5PJOmSfJp8vTny1Z/P1UcWWuO7RzOoBaRPbryPhGUq45R07O9w3SjLHk1wujkh18BqoYnc6skq4pZlgfyw42kiOneRYLQc0Jzj6aPotKWxuIg7hUfIrtawpuq4d+S5Qagr+wRjCroPn9JkluMJcqgKFbRqbyy1vqFJaWhnLvA6Hw4pM1WFFZVXvWTsrjZVFayKAFdcZn+W++7Zm/OAx524GcW5CACjKghpds6Qf1+O27X+YTi9ZZ6cOgLzZttfh3XNu4js2faMxh0nNPl6SEcKybeQgVc1+p127x0bbtSd033iQrndXMHN5/F7qgpO9T39MoXm5UAX6r5ux0oGuA9p8p3Gu0aRPNUJWjBRXm2fQu+8f7ukRNpf7Y+2kVKgN9qfQnojyzuutRp5OYwvuLuLG/hOqYMuB7rq2+GCHKueZoINcelZNhdwAVxl5M4IAdqsEAgjVkvLJJ8wNVNWMG7zWeV2T+FuJmi7f203O+gdtZuh/AuGc5wb3/OoGETi6agazAftv796D0BohF2tXRXlJKwjoevDv4vqWst/1VOeo/9Dvjr2NezMSFbffMY5jdNfD47q3vZ50eU05OGte14VMaIvm9/Tm4/feR+nYcdXgZP6OKv385E1SmtKo2gttl87NHwJ1kIWq8hr+bqg7Utx1SrzU9d+QKrmM +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"; + + + + + + + + + + +Update an annotation layer (annotation-layer-pk) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.ParamsDetails.json new file mode 100644 index 00000000000..23e8648381e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.RequestSchema.json new file mode 100644 index 00000000000..59f73c0882f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"chart_id":{"description":"The chart ID","type":"integer"},"datasource_id":{"description":"The datasource ID","type":"integer"},"datasource_type":{"description":"The datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"},"form_data":{"description":"Any type of JSON supported text.","type":"string"}},"required":["datasource_id","datasource_type","form_data"],"type":"object","title":"FormDataPutSchema"},"example":{"chart_id":1,"datasource_id":1,"datasource_type":"table","form_data":"string"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.StatusCodes.json new file mode 100644 index 00000000000..8d9f5939fe8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the form_data.","type":"string"}},"type":"object"},"example":{"key":"string"}}},"description":"The form_data 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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.api.mdx new file mode 100644 index 00000000000..db157c85eb5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-existing-form-data.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-an-existing-form-data +title: "Update an existing form_data" +description: "Update an existing form_data" +sidebar_label: "Update an existing form_data" +hide_title: true +hide_table_of_contents: true +api: eJzFWFtv2zYU/ivEwYAmmBInRQcUKvqQpimarmiN2tkGREFKS8eWGolUScqJJui/D4fUzZa6bu1DXmyLOhd+37nw0BXkXPEMDSoN/nUFiQAfcm5i8EDwDMGHOyzBA4Vfi0RhBL5RBXqgwxgzDn4FpsxJTBuViA3UtddY+VqgKnszhq9ukwgmNBNhcIMK6vrG+UFtXsmoJJFQCoPC0E+e52kScpNIMfuipaC13lauZI7KJKitWsyVIXd+BRHqUCU56YEPyxiZfcsuX4M32oIHETdcy0KF+E39XuQ/GHEvv2PGCnmAosjAvyauUnq2EmjA68jUfIvRbfu0TfAebrz9EHiwliq7Je2x5zNRWndMrtm7xccPTBd5LpXBiBl8MMcwMlcPo3+9R9AY69B7vze5+oIhITGJSWnhjVTZa274vDALF8XaA3zgWZ7ibghPR0E5nWC4I22AvYdQ72ewXdC5FNplzNOTk5/IN6qRyRjfYcmMZAqNSnCLzMTIug1Oc71L2C4p1s8OqrHLzjy755ppIxVGTBdhiFqvizQtj8nos5/Cm6HWfIOT5f+vADpFeMUj1hS7zy7FlqdJxPpuxHIlt0mE0RTMga7Dcvq4WK4EL0wsVfI3Rj47K0yMwjT+WZd3E0CGig7Js8dF8kEatpaFiHxGudSQjER306oiiZoJaRg+JET/GFRnwyJ6+vSxY5MrSblP7YFRXEzpsz8o3Vx8UCmppnCcyyKNLNTGQqNNrn577PK5FAaV4CnTqLaoHAqfnQlWCHzIMaSg2UUmw7BQ30jAN9zwtKPAA41hoQgjDQNf7g341zd0LBu+oQEBLh7yVCpk1L3Z66bFPxyFMsKF3aUbI1IuNuBDePXpPXiQ8hWm/aNLJHouVMqO/mLzqyULIDYm92ezVIY8jaU2/vOT589nPE9m29MZOr+zrrnNqjss6wBYEASCsaO3LICzppZsEHz2CrlCxX45Oz+/WCxulx9/v/iwq3Duwne0LHP02X4Ee9mIPakCar4B+CyALU8LDKB+AjTsNFjnpYmlGKDtFjq8SUYHbVtUOhCBaM8g9rJbPs4Lc0Bu2Q+T4jn1GHmESr+s9qhxKBp6AmC/Mm5Ph1sj71DUjTZR8HIKdiAOA5GrRJiDdvvHJHxweDgk5B3f8oVNtQEpO4t9IkihiZeOC37PE8PWaMLYUvFTRFQOT4YmlhEBmV8t9znyWym2n0eE/XObSpUjaml5+uz1KsNMcmyNs8lJt/SuZFT6dgI7dsWfrMuDigaGAdesPiRpovxFIBxN9mhvKdoLQCMkUzxO5eaARA9fABXw3rmTR9wg48J18URs+rEBPHBU0U2goDjZ+4AP32GbAmp7kWsBhaJ4T4YN9rfznl6zCLeYyjxDYZquZtPJGapyJY0MZVr7s1lFpmq/onKqR9bOC21k1prwYMtVQs1fN43YmnHj2poXqWm2OZi/m0f60jAi7+1yOWedndoD2s2uvQ7vaHML167pHV2MmFTsck5GCMuukUmqGn0rXdsbU9uy7RTtQNrGXcHKZi21ak723v25bK9fVHTubT+CWtC1R8q3CtcKdfyjRsiKluJTf5e7mBrsT0aD/cn/Hew9SMRajmfvRZGjclen9sIxWKIkdXLbU8e9Nhm3R3ZzW/1Ogew46w5xuj/N8pQngozavK2a4rkGnifk+ZTSzBXQDiQPfBrub9psuoaqWnGNVyqta1p2dz6qrCixs0wE/pqnGr3mVtBdsG3vAB9s3bfJP625h6MbZ+DgUzO1HrI+uLv4mkUuyqHPdjf0Wd9QcdgGa927N8NWOdAczU9U+07jLAzRHhjflr0ZNK35FaXoqvkHIZMRqSh+T/9i8Hu3SWkx22Kxa+7UKtxs5UxSFtN0Pghwl+3NDwI1SUNVOQl3UNQdK/aAJV7q+h9V8Qbg +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"; + + + + + + + + + + +Update an existing form_data + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.ParamsDetails.json new file mode 100644 index 00000000000..ef790456124 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The Rule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.RequestSchema.json new file mode 100644 index 00000000000..c13e8be385f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","nullable":true,"type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","nullable":true,"type":"string"},"name":{"description":"name_description","maxLength":255,"minLength":1,"type":"string"},"roles":{"description":"roles_description","items":{"type":"integer"},"type":"array"},"tables":{"description":"tables_description","items":{"type":"integer"},"type":"array"}},"type":"object","title":"RLSRestApi.put"},"example":{"clause":"string","description":"string","filter_type":"Regular","group_key":"string","name":"string","roles":[1],"tables":[1]}}},"description":"RLS schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.StatusCodes.json new file mode 100644 index 00000000000..73bcf18bb1d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","nullable":true,"type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","nullable":true,"type":"string"},"name":{"description":"name_description","maxLength":255,"minLength":1,"type":"string"},"roles":{"description":"roles_description","items":{"type":"integer"},"type":"array"},"tables":{"description":"tables_description","items":{"type":"integer"},"type":"array"}},"type":"object","title":"RLSRestApi.put"}},"type":"object"},"example":{"id":1,"result":{"clause":"string","description":"string","filter_type":"Regular","group_key":"string","name":"string","roles":[],"tables":[]}}}},"description":"Rule changed"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.api.mdx new file mode 100644 index 00000000000..bb4ddabce96 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-an-rls-rule.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-an-rls-rule +title: "Update an RLS rule" +description: "Update an RLS rule" +sidebar_label: "Update an RLS rule" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/isEMaAJpsRx1gKFin5IghZtF7RB7OwFUZDS0tliQ5EsSTnxBP334UhJlmUXw1Jg2Yd+snk6Hu957o48sqKaGVaAA2NpfF3RDGxquHZcSRrTaQ7kshRA9B2NKEeRZi6nEZWsAByh3MDXkhvIaOxMCRG1aQ4Fo3FF3UqjFpcOFmBoXd8EbbDuVGUrVEmVdCAd/mVaC54yXHv0xaIDVc+WNkqDcRysnyZYaQH/bXoc5Ld9YdS6YZ3hckHraHPO0ERvNLAjSyHYTEALdMvunAsH5jbIh3Z7Hwd2QZYFja/pJSxKwQyN6CmzQG92rLAwqtS3d7Datt99+rdeh1gOzaF0YKlgD+cgFy6n8fGLFxEtuGzH4x12jRIhWJuGvXhgmTso7K6M6cwyY9jKjxHLDrNB/li7a4GafYHUYdZwh6TRy/PJJVh3ovmhLh1OhQdWaAH9PGxhD3JrLd5IjV6kewFdKzfV1Y0bJq/HN2v81+Obuh7mMjpLmpoZFiZGBKxW0gb6jo+OvqMAedajVZbFLLBqwJbC/ajXH/X6v6nXLdXNCsZEHvcT978t6X5FY0FvVzSev2nO5AIydP35d5VtAdayBfQobuP/DzR1E+kpy0hziMfkvVwywTOybiOINmrJM3R2G0xvbsAyflosV5KVLleG/wVZTE5Kl4N0zfqk2z53AOlPDEh+eVokb5WZ8SwDGZM/VUkyJZ85krMlEA2m4NYiIqcIS1OwlricW2LAqtKksAtgZy+ge/606D4qR+aqlFlMsCdtUgiyDgLJFFgilSPwwDG5thF1Njyi4+OnzjxtFIYCi59g1rlVTH7DYgrZB8YoswvHmSpF5qE2FprZuNSLp94c3ksHRjJBLJglmIAiJieSlBIeNKQYNC8kKk1L843yesscEx0FEbWQlgYx4h3ly73zm6XfOhfWn8TqnpzDEgSZtJo3EX04SFUGE+9muN4IJhfYdVxdntOICjYDsR42xRDTtDSCHPxBLq6mJKG5czoejYRKmciVdfHLo5cvR0zz0XI8Mupe4Lqtg6NxQkmSJJKQg3ckoSfNLuEDEJNTYAYM+enk7OzNZHI7/fTrm4+bE85C6A6mKw0xGUZvrZuRZ1VC72CV0JgkdMlECQmtn9E66mBerFzuj9UWaCfooPJCK+PagrKJTGTbJJLXnRgP0j1cljyGjyjMzIFlYOzrasBKANAwk1Dyc7NH3Tp1B7JuZiP617sQJ3I/kdpw6fZazw9ReW9/v8/FB7ZkE59hPT42hOvwK2mRko4Gds+4I3Nwae5ZeCwHVYBSgMtVhhgurqZDeuJWiwyzB2F/bhOoChxNPUWfo/WUfv4EorZzKGi3zM5UtorJh8mnj4eh3Pl8tVeRO1j1aCb1Pmoj268SGRjKmGMdOwPuGyUl4FCoxR6q7r+iWLKDc1RnzAFhkuDNxZQCsG/1BOHzQomB8U8OMf0mvZW+qzF+fscJdV4aDO/OKG31c+f4mWRoUukCpGv2Lp89wVCljXIqVaKOR6MKTdVxhYVTb1k7K61TRWsioktmeNcBt2ZCNzxnvuP0bvZuFc0QfyzdIuzddHpBOjt1RNGbTXsd3i3nJmFTxm/YjxJlyPsLNIJYNo3spKqZ77Vr/5rTBmGCR0oA6bfnis58pr5VpmBo78PvU9o8DWGNha/ru54HXUc4+dbA3IDNH2sErVglL9fvTG+e6r5+1O/uj25qfEObq+270KTUYCz0bzE9EWZ10FuOQ7CsK5g/yZuFd1bR4NLcIHHw4EZaMO4bO5/eVVNh15RpjuuNPYTNKqMRjfUd5mNIuGtaVTNm4cqIukbx1xLMKlxo2pwPL4rctzgZjedMWNjyq+tV6N5l03Dvk82Hx52ut/dBufJVJkoc0YiG0Og7WiPfYVf1joQP/f2xN3GrTcLiDzNO0hT8AfFt3ZvennVxhTk6a543C5XhFMPukVN2H3xUHr2vFi8Lp1QZWqhgEtMYrxi90HXp3vxBUDtZqKqgEU6HuiPFH6jIS13/DfevnLc= +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"; + + + + + + + + + + +Update an RLS rule + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.ParamsDetails.json new file mode 100644 index 00000000000..8a85f27369f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"query","name":"mark_updated","schema":{"description":"Whether to update the dashboard changed_on field","type":"boolean"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.RequestSchema.json new file mode 100644 index 00000000000..ad3cb291a0f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"color_namespace":{"type":"string","nullable":true,"description":"The color namespace."},"color_scheme":{"type":"string","nullable":true,"description":"The color scheme name."},"map_label_colors":{"type":"object","additionalProperties":{"type":"string"},"description":"Mapping of labels to colors."},"shared_label_colors":{"type":"object","additionalProperties":{"type":"string"},"description":"Shared label colors across charts."},"label_colors":{"type":"object","additionalProperties":{"type":"string"},"description":"Label to color mapping."},"color_scheme_domain":{"type":"array","items":{"type":"string"},"description":"Color scheme domain values."}},"title":"DashboardColorsConfigUpdateSchema"},"example":{"color_namespace":"string","color_scheme":"string","map_label_colors":{"key":"value"},"shared_label_colors":{"key":"value"},"label_colors":{"key":"value"},"color_scheme_domain":["string"]}}},"description":"Colors configuration","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.StatusCodes.json new file mode 100644 index 00000000000..985a5804e87 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"array"}},"type":"object"},"example":{"result":[]}}},"description":"Dashboard colors updated"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.api.mdx new file mode 100644 index 00000000000..2bee894489e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-colors-configuration-for-a-dashboard.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-colors-configuration-for-a-dashboard +title: "Update colors configuration for a dashboard." +description: "Update colors configuration for a dashboard." +sidebar_label: "Update colors configuration for a dashboard." +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isHYkATTI2brgMKFf2Qpi3WrmuD2lk3xIFLi2dLjUSyJOXEE/TfhyMlWbbV9W1FPiWmeM/dc2/ksWKaG16gQ2NZfFGxTLKYae5SFjHJC6RfVyxiBj+WmUHBYmdKjJhNUiw4iyvm1pp2ZdLhEg2r66hB+ViiWW9gCm6uZqUW3KFgfQCBNjGZdpkiqXcpuhQNOAVhM7gUQXCbzhU3ApKUyyWKmZKwyDAnqMaCuVI5csnq+jLYi9Y9UWJNOhIlHUpH/3Kt8yzhpG70wZLOap+Nmn/AxLGIaaM0GpehDTC5MjMiZDVPsCdgncnkktiWec7nObaO2mY3SRE8CHQgR6yOGmBvxnehBgQP7nELrmc5n2M+89/tEEUuREZAPD/bIrttQ72r9A+udSaXoBbgNVgKWdDiVduUGxQ/SvvYowfNjVbgiVHWUoYYF2z4Qcpfea0tXSiCJ/YCOROq4JnsAXJjOJVE5rD4EkWn/aAGNFjxvESiV0fMZY5ygj1ty8ML2FMlF9ny3JfPOKR2HTG84YXOcTCPN5m2nYmb9aFMusI1i5k36D8ivrPrM58HHXjR2nFZ18NOspB40qXxlb3XsWpasFpJGyJ8/969r+oL233AoC1ztxdYH5KtFNt2eyt2MUTj6abFBUJtr6wj9uC7rC3QWr4c6Cufs7cTZE+4gKalxvBCrnieCdgcHaCNWmWCjN0n1pMNXI5vl8u55KVLlcn+QRHDSelSlK7RD13WDBDpCwYmv9wuk+fKzDMhUMbwtypBKHnHQcpXCBpNkVlLjJwCniRoLbg0s2DQqtIkOESwwwvsHtwuu9fKwUKVUsRAB1yTQig6CiAUWpDKAd5klFz7jDoMz+j+/dvOPG0UhYKOcqCsc+sY/qRiCtmHxigzxONUlbnwVBuERppU/XrbzeGFdGgkz8GiWaEJLGI4kVBKvNGYUND8IqgkKc0nyus5dzzvXBAxi0lpiCPdSz9ch755GTHHl3RX3TRMyy4jdnM3UQLH3rxwlc25XLKYJedvX7Hm2Nn8bIogZklpcrj7F5ydT2DKUud0PBrlKuF5qqyLH957+HDEdTZaHY+6S+joeBR69JTBdDqVAHd/gyk7abqDd3wMT5AbNPDTyenps/F4Nnnz+7PX2wKnIWR3J2uNMexGbbNXwJ1qSgfllMUwDWfllNV3GN21G5pna5f6c68l2i10VLNCK+PaQrJTOZXtmQiPu+UjXboDUgvf4o8oSKbIBRr7uNrxSiDQeGbK4OemN82cukJZN9LE/vEQ46k8nEptMukOWsuPaPPB4WHfFy/5io99ZvX8sbW4Cb+SllzSuYFf88zBAl2Sei98qw+qQKVAlypBHM7OJ7vuidtdsJs9RPt9m0BV8NHEu+h9tBHp509w1H4Ohd2tZ+dKrGN4OX7z+iiUebZYH1Rwheuem6E+pN3k7UdTGTwkuOOdd3Z832xSOR7lanlAWw8fMSrVnfMzzHPJwH0NFsoA34x5R3Tj9K6jAbT0kxgNpTHbd3ylr+rG9xRZ34NCBygNBX4wfmzvTk+fQeAKc6ULlK7pZj6vAlCljXIqUXkdj0YVQdVxRSVV76GdltapooWI2IqbjJq+bRqwhwnD74L7O6E3k0UMZVlQd2t+0h/f37bxf5tMzqDDqSNG1mzjdXz3jBuHNk3faAQAZeDFGYEQl22QQVc18n537afttlX7YSOQ9A27YnOfw8+VKTjhvXw3aWd/P7L7r5sR3pOuIxKeGVwYtOm3ghCKVfLt5h3g2f89/3xy5Nmfcr5gsIlYJhdq/0FkXGo0FimM7bjXW6JcD/tWxyGE1hXcn/jNu8tXVt2W8u5O4PDGjXRONtdRKIeqqcgLxnVGlhyTdAvFIhb7h6PGBZdtil6wqppzi+cmr2taDs9EVK4i8xcjweIFzy1GzWi483AUJsWY+QbT1tWw/A6X7obEDt421/xD2OTNNsd2sJPrvs7WJn3FagpZaORee/jQb8k9wb0bGXWVIHGSJOjPpE/vvew1w7NzSv55865VKEEihl/TxMuvg43KUw6TKq2Fg7EMt7UASfVB00wvxl0dNf8QqUEvVFXYEQ6kunOKP8PJL3X9L/LKEi8= +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"; + + + + + + + + + + +Update colors configuration for a dashboard. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.ParamsDetails.json new file mode 100644 index 00000000000..74d702d0d05 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.RequestSchema.json new file mode 100644 index 00000000000..261b28be132 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"}},"required":["allowed_domains"],"type":"object","title":"EmbeddedDashboardConfig"},"example":{"allowed_domains":["string"]}}},"description":"The embedded configuration to set","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.StatusCodes.json new file mode 100644 index 00000000000..5c889d31439 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"},"changed_by":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User1"},"changed_on":{"format":"date-time","type":"string"},"dashboard_id":{"type":"string"},"uuid":{"type":"string"}},"type":"object","title":"EmbeddedDashboardResponseSchema"}},"type":"object"},"example":{"result":{"allowed_domains":[],"changed_on":"2024-01-15T10:30:00Z","dashboard_id":"string","uuid":"string"}}}},"description":"Successfully set the configuration"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.api.mdx new file mode 100644 index 00000000000..ab3d8b325e9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-dashboard-by-id-or-slug-embedded.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-dashboard-by-id-or-slug-embedded +title: "Update dashboard by id_or_slug embedded" +description: "Sets a dashboard's embedded configuration." +sidebar_label: "Update dashboard by id_or_slug embedded" +hide_title: true +hide_table_of_contents: true +api: eJytV2Fv2zYQ/SvEYUATTI7trgUKFf2QZinWrmiD2MaGRYFLS2dLrUSqJOVEE/TfhyMlWbacoGv7yTJ5PN57fHc8VhChDlWSm0QK8GGGRjPOIq7jleQqeqIZZiuMIoxYKMU62RSKk+0ZeJBzxTM0qDT4N9WBp3mMOzcsiZhUTKfFBjxIaD7nJgYPBM8QfEiipVTLZl7h1yJRGIFvVIEe6DDGjINfgSlzstZGJWIDdX3rjFGb1zIqySKUwqAw9MnzPE1CG+34s6agqp6rXMkclUlQW9s0lXcYLSOZ8UTYocRgpo9s6rUDXCleQl33A74ZeLrt7OXqM4YGPDCJSWngsmH295amC8swbYH3PMvJ6EhoN20otzVtPqT9+IkxI5lGM+DXxq9zKbSj4ulk8gNEKtRFan4qwR6EMRcbjJarcuh4nShtlk5GR1wlUW84EQY3qGg85Y+tKjSqBybrh89zoVFN+/E6qtZSZdyADxE3ODJJhuANt+xyZbkXci+m4ujEI/EM9HXdnPPMHd5w7b7ydmc51ODtPkp4Onn6bDSZjqbP59OJ/9vEn0z+gUNUbdAtmB2IoZBnRRii1usiTUvSLTMx7guaon02mf6AWDPUmm++6ZT3mekWwkLwwsRSJf9i5LPzwsQoTLM/6xLtCL7+QvL+/IfS7icgeSsMiT5lGtUWFUOlpPLZuWCFwPscQ4ORG2QyDAv1AK433PDU2dnNNYaFSkxpr4jPd4a0Q3Xb8I2tZZ04bakkTBbxW5JHkVPKLHciWpXL3U2xbOsceHA/CmWEMwvL3UYpFxvwIVxcvwdK9xWmu79aFiok0GGhUjb6m10t5iyA2JjcH49TGfI0ltr4LyYvXox5noy303EXxXg6bncOgAVBIBgb/cECOG8O1ALw2WvkChX75fzi4nI2W84//nn5YX/BhTvs0bzM0WeH572zjdiTKoAvWAbgswC2PC0wgPoJ1F4H9Ko0sRQ9qN1ABzbJcqkMa25MHYhAtJWfveqGz/LCnNC27PsY8dzaGHmESr+qDnhxEBpuAmC/Mm4TfWnkFxR1s5rwvzqGORCngchVIsxJG/sZGZ+cnvbZeMe3fGZV2WNkb3AnASk0kdIRwe94YtgaTRhbHr6fhcqBydDEMiIUV4v5IUF+a8UOFUTAP7UiqhxLc0vSJ2+3pK8hR9VQR8665XYlo9Jn72YfP5y5IpGsy5OKfcGyRzSrT8ma+H4ZCMdRxA3v+DlgvzGSKZ6lcnNCpqcvgRLdoaeOrzC2aTQx+DBkr9pldj3upbYrRy6pC0XnePQ44LAQvadpFuEWU5lnKExT2KxMnKMqV9LIUKa1Px5X5Kr2K8qReuDtotBGZq0LD7ZcJXyVuurbuqHvCNfc3po2TPAARZFRoWv+0o8tdfv+/5jPr1jnp/aAotn31+EdBDdzFZvmqGuhVvvtFTkhLPtOjlLVrLfWte2q26ptOwUH0tbuClZWkG/anubdX3NoOnRKJje7628s6NqjxUuFa4U6/l4n5EVLcb3r9y+/rUmmB8daOhr2O4wcleuI246pN0Sac3bbqaNSm4zbS7h5syzs7dR75KxKttMw60l4b9/eHf//nlsNGwbvzThPeWIbICvkqsmqG+B5QrFP+60XeODvva+6yG5bmd1AVa24xoVK65qGvxaoStfmtUp3b7xE03cE/pqnGh+BdnLdND+n7JGn4FFMbfsvSptoaUH/wKPLYP+pWNPhujpqo3MG/YrYczBop6gOuBXnYYj2UnjYtl/IrhYk11Xz4sxkREsUv6OnFb9zsUpLiXsS0Zi7mQrXajmXpGjqAXtNW6f85oNAHWWjqpyFuw/qjhx7iRIvdf0fLlB2Tg== +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"; + + + + + + + + + + +Sets a dashboard's embedded configuration. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.RequestSchema.json new file mode 100644 index 00000000000..9d4fda00f4a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"array","items":{"type":"string"},"description":"List of deleted filter IDs."},"modified":{"type":"array","items":{"type":"object"},"description":"List of modified filter configurations."},"reordered":{"type":"array","items":{"type":"string"},"description":"List of filter IDs in new order."}},"title":"DashboardNativeFiltersConfigUpdateSchema"},"example":{"deleted":["string"],"modified":[{}],"reordered":["string"]}}},"description":"Native filters configuration","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.StatusCodes.json new file mode 100644 index 00000000000..3c9543a8105 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"array"}},"type":"object"},"example":{"result":[]}}},"description":"Dashboard native filters updated"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.api.mdx new file mode 100644 index 00000000000..6e1c59fc66e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-native-filters-configuration-for-a-dashboard.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-native-filters-configuration-for-a-dashboard +title: "Update native filters configuration for a dashboard." +description: "Update native filters configuration for a dashboard." +sidebar_label: "Update native filters configuration for a dashboard." +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/iuHw4AmmBI3XQcUKvohTRssXZEGjbMXREFLi+eYjUSqJOXEE/TfhyMl2Y5dbMsK5JMt6u54z8O7450arIQVJXmyDtPLBpXGFCvhZ5igFiXx0w0maOlrrSxJTL2tKUGXz6gUmDboFxVLKe3pmiy27VWUJudfG7lgkdxoT9rzX1FVhcqFV0aPvjijeW3Dlpl8odxjgpU1FVmvyPFbSQV5dmEQFNaKBSaoPJVuZd15q/Q1tglKcrlVFe+HKb5XzoOZQmcJpqrwZOHkjdtn4dJINVX/aofOxW/u0Jvqt8iNnqrr2gbkcTdLxkqy3wXQEggoDZpuIdjex7ZN0CtfsJE3ws0mRlh5Krya03HQcUfBs4tKCk/n8STaBOlOlBVrrdB+2btxtUrVZRNPfACzFGvbDYfj1p2/bp2WjTALJLnKaBcD4NnTp/8pnNbDx5KrC79BdmDo/qGuwO/VLrfBGSgFvQ6sDnxKtvX8f3ldknPimrbEwj/4PSjiayGhy8gUTvRcFErCMu+hsmauJDu7CXBFN2I5eFwsF1rUfmas+otkCoe1n5H23f4wRM8WIKuKEclPj4vk2NiJkpJ0Cn+aGqTRTzzMxJygIlsq5xiRNyDynJwDP1MOLDlT25y2ARzsRXTPHxfdqfEwNbWWKYxn1IcQyQECSEMOtPFAd4qDa0ut6G0ERM+ePXbkVdbwUYhJQcBR5xcp/MbJFKOPrDV2G44jUxcyQO0sdNq81c+PXRxOtCerRQGO7JxsRJHCoYZa011FOR9aWAST57X9RnodCy+KgYIEHeW1ZYzcVHy5jfXzKkEvrrnRWBZOx7fJ3V5uJJ0H92IfUgh9jSnmFx/fY4KFmFCxfOySIMW8tgXs/QFnF2PIcOZ9lY5GhclFMTPOpy+evngxEpUazQ9Gst9wdDDqinSGkGWZBtj7BTI87MpDYD6F1yQsWfjh8Ojo7fn5p/GHX9+eriscxTPbGy8qSuH+sS1lJTxpMryhRYYpZDgXRU0Ztk+wTQacZws/Cxdgj3RYGLCqsjLW95nkMp3p/nKEV8PyflX7Hd4WHkRIElVnJCRZ96q5R0tE0FGTIfzYVadP3tyQbjtthv9qG+RM72a6skr7nd71fRbe2d1dJeOdmIvzEFsrhKwtLgPAaMecDDyIW6E8TMnns0DDg0loIpaS/MxIBnF2Mb7PT9pLwf34Ydyf+xBqIknjwNHnZKmyGkGRqc0oitI9tRMjFym8O/9wuh8zXU0XOw3c0GKFZ2h3WZrpfpnpSJEUXgz03CO/EzIF7RfmeodFd18iZ+u9KzT0NPc7nbUWDqbGgoCB1n1MMFLIg0QdenoeLlLcPIGmumn7Q+AzDvUoVoPacghsPUncaIn5NUiaU2GqkrTvKluIsGioqazxJjdFm45GDZtq04azq92wdlQ7b8reRIJzYRVfAK4rxsFM7JKnIvSJwU1MkHRdcqXrHvkn1Lp1+7+Mx2cw2GkTZG/W7Q14N5w7jyWb3/GsBsbCyRkbYSzrRrZS1ekH6TYMbn3ZDoNABBmKd4OTEMzHxpaC7b37fYzdFMh5GN/icOkE0G3Cyp8sTS252UONsBVn9MflSPn2u8wmCSo9NdHIGil1RdYRs90PTitLHJJRbn4QmXa+FOGS7sblB2bJmhPDde7pzo+qQqjQ1YXobboMukRRKfbogLV7U5hgGgb2PpGu+pC6xKaZCEcXtmhbXv5ak+X7+WoZ1SHZpAotjsR0KgpHG64NvQrufOwa7l1Yntq6y/2opRcheYqanzDhuyF+Wmj5JGI9DbvHF6uVcUVxozfinI4ah3lO4W74tuzVSi06u+DQm3QfKEojWcWKW55BxW300QTIcXbktXhB1bFviiY5OnmuWDmyIYq7PwxqKwtNEyXivdAOpIS7lHlp278BNa4XKw== +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"; + + + + + + + + + + +Update native filters configuration for a dashboard. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.RequestSchema.json new file mode 100644 index 00000000000..aba12833832 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"permission_id":{"nullable":true,"type":"integer"},"view_menu_id":{"nullable":true,"type":"integer"}},"type":"object","title":"PermissionViewMenuApi.put"},"example":{"permission_id":1,"view_menu_id":1}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.StatusCodes.json new file mode 100644 index 00000000000..4a6f286283a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"permission_id":{"nullable":true,"type":"integer"},"view_menu_id":{"nullable":true,"type":"integer"}},"type":"object","title":"PermissionViewMenuApi.put"}},"type":"object"},"example":{"result":{"permission_id":1,"view_menu_id":1}}}},"description":"Item changed"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.api.mdx new file mode 100644 index 00000000000..e9fabf7fc78 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-permissions-resources-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-security-permissions-resources-by-pk +title: "Update security permissions resources by pk" +description: "Update security permissions resources by pk" +sidebar_label: "Update security permissions resources by pk" +hide_title: true +hide_table_of_contents: true +api: eJzVV21v2zYQ/ivEYUBtTInjYgMKFf2QBi2ari9G7HQDosClpbPNRiJZknLiCfrvw5GyLL8U69YBwT7ZpO6O9zy8N1agueEFOjQW4psKhIQYNHdLiEDyAml1BxEY/FoKgxnEzpQYgU2XWHCIK3BrTVJCOlyggbq+DdJo3UuVrUkkVdKhdPSXa52LlDuh5OCLVZL2tra0URqNE2j9Ck0hrBVKTkVGG7LMcz7LcePE/tERrATeTwuU5Xdq1O2Wmn3B1EEETjiSh1F7+ieB9+9RludanOrS0Tn4wAtNYgdeDvedGNZ0SoY2NUITbojhvcowZw3ufXJr2rBaSRtoeHp29gMkGrRl7v5H5B5o7dLdwfMdxB8wf+mwYOmSywVmZPmXHyK3QGv5AjtpYJ0RcvG3KFpFeMkz1qRLzC7liuciY9ukZNqolcjI2UMwHd2AZfi4WK4lL91SGfEnZjE7L90SpWvOZ22QHwHSVQxIfnlcJB+UY3NVyixmkyVuSEai26rSpMgyhZZJ5Rg+CKL/EFRrwyN6+vSx70YbldJyliOje3HrmH2icAv3g8YocwzHhSrzzENtLDTadNSvj50+l9KhkTxnFs0KTUARs3PJSokPGlO6NL/JVJqW5hsB+Jo7nrcURGAxLQ1hpJ745d5BfHNLjc3xBfVJGDff2baQWaYku2rCw7IeFTZGlc324TYCwu1ZucwghlJn3OF0c8x0W8vsdBNidjpbT33zfThJVYZjDz+06ZzLBcSQXl+9gwhyPsN8uwzqtC5Nzk7+YKPrCUtg6ZyOB4NcpTxfKuviZ2fPng24FoPVcLDxZNDx5KT1ZDBMgCVJIhk7ecMSOG+y1QOK2UvkBg376fzi4tV4PJ18/O3Vh12FixAgJ5O1xpjtx8hWNmNPqgTucJ1AzBJY8bzEBOonUEct6NHaLZXswG43WuCi0Mq4TdraRCZy01LZi3ab+k2PjmU/zk4U7CyRZ2jsi2qPowCn4SkB9jPjKaXS1Kk7lHWjTVy8OIY/kf1EaiOk621wnJJwr9/vMvOWr/jYR3WHnZ3NbWgoaYmglhR+z4Vjc3Tp0nPy3zBSBWAFuqXKCNHoerJPVryRYvuRRSR83gRXFRibeMI+R1uVbmwF2g7jK0hveJ6pbB2zt+OPH05DwRHzda9id7jukM7qPkkT988TGfjKuOMtV3s30QipHE9zteiRaP85UNHY63U+9dmGQNYhsO0uls3WzKd+YI6m8JLuz0/mMXznLVT6rqZL96UxFI7SUEwcvVrY9/QdfWYZrjBXukDpmiLrQy4YqrRRTqUqr+PBoCJTdVxR7tUH1i5K61SxMRHBihtBvcg2fcGbof8Zzrkf8bybEAHKsqCi2yzpx8IBr28mkxFr7dQRkDe79lq8B86NQ/egb/TqYcqwyxEZISy7Ro5S1eh76do/gTZXM6beF0D6PlLBzAf0a2UKTvbe/j6B5j1FiRm+Qtv/POg6IuWpwblBu/y3RsiKVfJq+zh79c1nzNn+NH1WRyDkXAUydrCXGo3F7njf2aLIC3KrYSDUuoL7saB5X/6zhNg5u50bHD64gc65kHSGj82qSZYb4FqQI0Po9PUIjqYMRBDrOwquED03UFUzbvHa5HVN219LNDQV3G4D2OdVJvxglUE857nFAz/bCQl6V80g3GfbC9r1v9nkcu3zJC9pBRH1hfAer28pvn359KeHD91C2FE8mMgofYPGeZqi7wvflr3t1KDRNUXZrHnVFyojFcPv6QnL74OPykMOT0/aC82pDNNaMEmBSPN+5/7agG3+EKijLFRVkAhtoG5J8X2UeKnrvwAg7tqf +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"; + + + + + + + + + + +Update security permissions resources by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.RequestSchema.json new file mode 100644 index 00000000000..9428eade0e6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"ViewMenuApi.put"},"example":{"name":"string"}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.StatusCodes.json new file mode 100644 index 00000000000..5fe712c423d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"name":{"maxLength":250,"type":"string"}},"required":["name"],"type":"object","title":"ViewMenuApi.put"}},"type":"object"},"example":{"result":{"name":"string"}}}},"description":"Item changed"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.api.mdx new file mode 100644 index 00000000000..6b334e84d13 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-resources-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-security-resources-by-pk +title: "Update security resources by pk" +description: "Update security resources by pk" +sidebar_label: "Update security resources by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFV9tu2zgQ/RVisEBtrBInQQsEKvqQBi2abJsGsdNdIApcWhpbSiSSJSknXkH/vhhSkmU77QLpQ55sUjPDOWduZAWKa16gRW0gvKkgExCC4jaFAAQvkFb3EIDGH2WmMYHQ6hIDMHGKBYewArtSJJUJiwvUUNe3XhqNfS+TFYnEUlgUlv5ypfIs5jaTYnRnpKC9tS2lpUJtMzS08udXUPDHzygWNoXw6M1B0J5orM7EAuq6792N17rtpOTsDmMLAdjM5rTxLcOHLyjKE5Xtq9JCHQA+8kLluD5zbbsOIEET60yRyxDCF5lgzhqXt3lxrhglhfEIjg4OfgO/RlPm9sV4qbdlN5lae7fD2Q5pZxYLFqdcLDAhM69/i5cCjeEL7CVfD/KvXO4U4T1PWJOkITsTS55nCVuXAlNaLrOEnN0F09P1WA5fFsu14KVNpc7+xSRkJ6VNUdjmfNZlwBNA+ooeyeuXRXIhLZvLUiQhm6TYkoxEt5GljpElEg0T0jJ8zIj+XVCdDYfo6OilY6O0jGk5y5FRXOwqZN8o3Xx8UGupn8JxKss8cVAbC402HfXmpcvnTFjUgufMoF6i9ihCdiJYKfBRYUxBc5tMxnGpf5KAH7nleUdBAAbjUhNGmkR3DxbCm1saJ5YvaDrBuPnOrpp8MGxAbYtR3zJD6m4E1NFwlkAIpUq4xWlrd9rmkZnOVlM31x73Ypng2GH0EzDnYgEhxNdXnyGAnM8wXy+9Oq1LnbO9f9jl9YRFkFqrwtEolzHPU2lseHxwfDziKhstD0ft6aPu9NFhBCyKIsHY3icWwUlThs7xkL1HrlGzP05OTz+Mx9PJ178+XGwqnPrI701WCkO2Hfy1bMJeVRHc4yqCkEWw5HmJEdSvoA46oJcrm0rRg9ptdGCzQklt23o0kYhEO+bYu26bpsaAjmXPYyTwuinyBLV5V23x4iE03ETA/mQ8prqYWnmPom60Cf+7pzBHYhgJpTNhB63v+yQ8GA77bJzzJR+7FO0xsrG5TgEpDJHSEcEfeGbZHG2cOh6ez0LlwRRoU5kQisvryTZBYSvFtjOIgH9vk6jyLE0cSd+DtUo/hzxVu3nkpVtuZzJZhex8/PVi33eMbL4aVOweVz2iWT0kaeL7bSQ8Rwm3vONni/1GSOa4n8vFgESHb4GqfmtYuVJmLWndSDBstmKulD1bdGEtKU7uEhvCL9iu1H1NAXU9zBd/qSneT4YNtj36TJ9ZgkvMpSpQ2KYbunTyhiqlpZWxzOtwNKrIVB1WVEv1jrXT0lhZtCYCWHKd0dAwTQN3Zuh/gnPuLl7OTQgARVlQd2yW9GNgh79Pk8kl6+zUAZA3m/Y6vDvOjX2bp2902WNSs7NLMkJYNo08SVWj76Rr90JowzGmIeVBuoZfwcwl7kepC072zv+eQPPcoKLzX6EbVA50HZDyVONco0mfa4SsGCmu1m+XDz99FwSQibn0yDeAlgq1wf69urdFaeblloeePWMLLnr2/z/LN87rJrjFRztSOc8E2XXJVzUVcANcZXT4IfQmrHuoeNMQQKjuKWN8StxAVc24wWud1zVt/yhR00y+XWelK5Ykc9eaBMI5zw3u+NbdT2Bw1VxDh2zN+qbPzSYXK5f8eUkrCKiR+zdofUtJ63qfO91/6HexnuLOfYhq0mucxDG6Rv5z2dteM7m8ptSZNS/ZQiakovkDMcgfvI/SQfZvNtrz06T0dyVvkrKLbtu9mHVZ2PwhUE+yUFVewvfwuiPFDT7ipa7/A4nHcAA= +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"; + + + + + + + + + + +Update security resources by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.RequestSchema.json new file mode 100644 index 00000000000..1ef16a987eb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetRoleApi.put"},"example":{"name":"string"}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.StatusCodes.json new file mode 100644 index 00000000000..13ef2612add --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"SupersetRoleApi.put"}},"type":"object"},"example":{"result":{"name":"string"}}}},"description":"Item changed"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.api.mdx new file mode 100644 index 00000000000..1ed087c7eb0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-security-roles-by-pk +title: "Update security roles by pk" +description: "Update security roles by pk" +sidebar_label: "Update security roles by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYUATTImbohsKFf2QBi2arkuD2NkGRIFLS2dLDUWyJOXEE/TfhyMlWX5JgbUf8skmdXe857nj3bEGzQ0v0aGxEN/UUEiIQXOXQwSSl0irO4jA4LeqMJhB7EyFEdg0x5JDXINbaZIqpMMFGmia2yCN1r1V2YpEUiUdSkd/udaiSLkrlBx9tUrS3tqWNkqjcQVaWoXzayj5wyeUC5dD/PvLqDvQOlPIBTTN0LmboHTbS6nZV0wdROAKJ2hjXGk0Ft2VEniqi2NdOWgiwAdeaoHrY9f2mwgytKkpNHkNMfypMhSs9XqbGu+O1UraAOLF8+c/QYFBWwn3lNQ02/KbZK0d3KFth7dzhyVLcy4XmJGZlz9FTYnW8gUOUnAA+3su94rwlmesTdWYncslF0XG1heCaaOWRUbO7oIZ6AYsJ0+L5VryyuXKFP9iFrPTyuUoXXs+67NgD5ChYkDy8mmRXCjH5qqSWcwmOXYkI9FtVWVSZJlCy6RyDB8Kon8XVG/DI3rx4qljo41KaTkTyCgubhWzvyjdQnzQGGX24ThTlcg81NZCq01H/fbU1+dcOjSSC2bRLNEEFDE7layS+KAxpaD5TabStDKPJOB77rjoKYjAYloZwkj96Ou9g/jmlpqK4wvqUTBuvzOqU5YKGuHyqM8ziKHSGXc47cxMDYlNZ6upb2QPR6nKcOzhhJYnuFxADOn11SeIQPAZivUyZBytKyPY0T/s8nrCEsid0/FoJFTKRa6si189f/VqxHUxWp6MupNH/uTRSQIsSRLJ2NEHlsBpe9u8wzF7i9ygYb+cnp29G4+nk89/vLvYVDgLAT6arDTGbDvGa9mMPasTuMNVAjFLYMlFhQk0z6CJepCXK5crOYDZb/RAi1Ir47prZxOZyK6hsTf9NjWHAzqW/X82oqCXI8/Q2Df1FifB/ZaXBNivjKeU+lOn7lA2rTZhf7MPbyIPE6lNId1B5/cxCR8cHg6Z+MiXfOyzcMDGxuY69EpaIqQngd/zwrE5ujT3HPwYA3UAUqLLVUYILq8n2+TEnRTbzhwC/aVLnjowNPEEfYnWKsPcCTTt5k+Q7nidqWwVs4/jzxfHoSAU89VBze5wNSCZNYckTVy/TmTgJ+OO99xsMd8KKYHHQi0OSPTwNdCl3upF/uqyjjDmCWOzFfNXNzBFE2lF8fFTagyPsFzru4aC6EtTuOiVoRjvDRVse/KJPrMMlyiULlG6tsj5FAqGam2UU6kSTTwa1WSqiWu6O82OtbPKOlV2JiJYclNQL7BtXfZm6H+Gc+7nKe8mRICyKqnotUv68SVv0/6HyeSS9XaaCMibTXs93h3nxqF60zea4Zgy7PySjBCWTSN7qWr1vXTjx/8uFGPqPQGkr+M1zHzCvlem5GTv498TaN8SdNHCV+j7jwfdRKQ8NTg3aPMfNUJWrJJX64fJu0cn/ggKOVcB+QbQdj7eMzJTTNHYILc8CexZV3I5sP/97N44q2/KDh/cSAteSLLpE69uM/8GuC7o4BMYNM0IvFmIINZ3lCkhFW6grmfc4rURTUPb3yo01GJv19noL0lW+Cklg3jOhcUdv/pxAw6u2qnykK3Z3vS33eRy5ZNeVLSCiIp2eFg2t5Ssvtb508OHYdUaKO6MN3QXg8ZpmqIv2o/L3g4KyOU1pcysfZ6WKiMVw++JPX4ffFQecniF0V7oHFUYfYJJyioangfx6rOv/UOg9rJQ10Ei1OymJ8U3OeKlaf4DAPRfhg== +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"; + + + + + + + + + + +Update security roles by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.ParamsDetails.json new file mode 100644 index 00000000000..5c0c197a9fc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"role_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.RequestSchema.json new file mode 100644 index 00000000000..7dad5c14a29 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"user_ids":{"description":"List of user ids","items":{"type":"integer"},"type":"array"}},"required":["user_ids"],"type":"object","title":"RoleUserPutSchema"},"example":{"user_ids":[1]}}},"description":"Update role users schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.StatusCodes.json new file mode 100644 index 00000000000..9edbb6b220a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"user_ids":{"description":"List of user ids","items":{"type":"integer"},"type":"array"}},"required":["user_ids"],"type":"object","title":"RoleUserPutSchema"}},"type":"object"},"example":{"result":{"user_ids":[]}}}},"description":"Role users updated"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.api.mdx new file mode 100644 index 00000000000..53dccf3353a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-users.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-security-roles-by-role-id-users +title: "Update security roles by role_id users" +description: "Update security roles by role_id users" +sidebar_label: "Update security roles by role_id users" +hide_title: true +hide_table_of_contents: true +api: eJzVV21v2zYQ/ivEYUATTImTogUKFfmQBi2armiN2N4GRIZLi+eYrUSqJOXEE/TfhyMlWX4pViwDgn2SRB2P9zz3ygoKbniODo2F+LYCqSCGgrslRKB4jhCD0RnOpIAIDH4vpUEBsTMlRmDTJeYc4grcuiBRqRzeoYG6ngZptO6NFmsSSbVyqBy98qLIZMqd1Grw1WpFaxtdhdEFGifR0ldp0cyk8O8CbWpkQfsgho/SOqYXjCQYSUQgHeb2kD1Ru8KN4Wuo6z6Y280h005Qz79i6iACJ11GCzc6w4lFMyzdKNhaR4APPC/od9/Q2/NpTSdsmzspBHfIiE1vsmUN5F1evW220MoGBp6fnT2CP4O2zNz/i9d6V3qb6Q2kHudE+R7nNxuyS0+/IFUvHkVojtbyO+yxYZ2R6u4fze42whsuWJMdMbtWK55JwTaJyAqjV1KQsfuQensDlvOnxTJRvHRLbeRfKGJ2WbolKtecz7pYOJQPvY0ByYunRfJJO7bQpRIxGy+xJRmJbqtLkyITGi1T2jF8kET/PqhOh0f0/PlT+6YwOqXPeYaM/OLWMfudwi34B43R5hCOK11mwkNtNDS76aiXT50+18qhUTxjFs0KTUARs0vFSoUPBabkNL/IdJqW5gcB+I47nnUURGAxLQ1hpD749d75okKFi99RgYFR859RVfEljXB51NcCYggVZtaqmVGlt7N5eJlJMfOFCCJ4OEm1wJFHFrpuxtUdxJBObj5CBBmfY7b5DMFH36XJ2MmfbDgZswSWzhXxYJDplGdLbV386uzVqwEv5GB1PmiNGHgjBlVjQj3wNiTAkiRRjJ28ZwlcNmnokcTsDXKDhv1yeXX1djSajT//9vbT9oar4PmT8brAmO06fyMr2LMqgW+4TiBmCax4VmIC9TOoow7ycO2WWvVAdwsdbJkX2rg2H22iEtX2R3bRLZ8WpTuiY9ljuYmCliVygcZeVDsMBTANSwmwXxlPKUNmTn9DVTe7iYmLQ+gTdZyowkjljloUpyR8dHzc5+UDX/GRD9YeN1uLm7DQyhI9HSX8nkvHFujSpWfkv+CjCrBydEstCM9wMt6lKm6l2G5UEQVf2sCqAl9jT9eXaLOlH1eBtP3YCtIty3Mt1jH7MPr86TRUEblYH1XsG657lLP6mKSJ+deJCmwJ7njH1I4fGiGd4Wmm745I9Pg1UCU4ONC19PnJzrJ5eJlJwdp8D6TRXF2S4/x0HcPP0U+O9lUuFIrSUBwcdCfs2veRfjOBK8x0kaNyTb30YRYUVYXRTqc6q+PBoCJVdVxRttV72q5K63TeqohgxY2ktmKbEu/VhGFywf145s2ECFCVOdXP5pMevnpu638/Hg9Zp6eOgKzZ1tfh3TNuFBoB/aNLC9OGXQ9JCWHZVnKQqma/l6795aX1ih9JA0jfEiqY+zB+p03OSd+HP8bQ3IQoGcNf6FqZB11HtHlmcGHQLv+tEtJitbrZXKveHrx9nE3rCKRa6P3RflQWaCz2x+/eEkVZkFudB/Ksy7nv5s1V8KdDfuvYrtM7fHCDIuNSkXofglWTDrfAC0k2nEOvE0f+8kkK480tNJwxbSPkFqpqzi1OTFbXtPy9RENNfLoJUp87Qvo5SEC84JnFPSO7gQaObpq59ZhtnLBtfHvtUWufC1lJXxBRve9dmWtyRaiO3oTwt1/nerv3pijK07DjMk3RF/0fy057dWY4oXCaNxfvXAt/jef3xCe/D4ZqjztcEWktdJ4yTFhBJUUczeg9D3aR2bwQqINUVFWQCFW+7pjxTZJ4qeu/ASA3tjI= +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"; + + + + + + + + + + +Update security roles by role_id users + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.RequestSchema.json new file mode 100644 index 00000000000..7031ad32579 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"active":{"description":"Is user active?It's not a good policy to remove a user, just make it inactive","type":"boolean"},"email":{"description":"The user's email","type":"string"},"first_name":{"description":"The user's first name","type":"string"},"last_name":{"description":"The user's last name","type":"string"},"password":{"description":"The user's password for authentication","type":"string"},"roles":{"description":"The user's roles","items":{"type":"integer"},"minItems":1,"type":"array"},"username":{"description":"The user's username","maxLength":250,"minLength":1,"type":"string"}},"type":"object","title":"SupersetUserApi.put"},"example":{"active":true,"email":"string","first_name":"string","last_name":"string","password":"string","roles":[1],"username":"string"}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.StatusCodes.json new file mode 100644 index 00000000000..aeb26cc57dd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"active":{"description":"Is user active?It's not a good policy to remove a user, just make it inactive","type":"boolean"},"email":{"description":"The user's email","type":"string"},"first_name":{"description":"The user's first name","type":"string"},"last_name":{"description":"The user's last name","type":"string"},"password":{"description":"The user's password for authentication","type":"string"},"roles":{"description":"The user's roles","items":{"type":"integer"},"minItems":1,"type":"array"},"username":{"description":"The user's username","maxLength":250,"minLength":1,"type":"string"}},"type":"object","title":"SupersetUserApi.put"}},"type":"object"},"example":{"result":{"active":true,"email":"string","first_name":"string","last_name":"string","password":"string","roles":[],"username":"string"}}}},"description":"Item changed"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.api.mdx new file mode 100644 index 00000000000..99b6d46084d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-security-users-by-pk +title: "Update security users by pk" +description: "Update security users by pk" +sidebar_label: "Update security users by pk" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/isHYkASTInjoAUKFcWQBi2armuD2tkGRIFLS2ebiUSqJOVEE/TfhyMlWX5Jt7VAsw/9ZJO8O/J57oVHVSznmmdoURsWXlVMSBaynNsFC5jkGdLolgVM4+dCaExYaHWBATPxAjPOworZMicpIS3OUbO6vvbSaOxLlZQkEitpUVr6y/M8FTG3QsnBjVGS5la2cq1y1FagcbKxFUukfwmaWIuctFjIzg0UBjX49V/O7Z4BqSxwmCuVQK5SEZdgFWjM1BKBO/EAbgpjIeO3CMKCkI35oEUwVSpFLlkdMMy4SLc3Hi/Qmdoz4CU6XWO1kHNSnQlt7MRT9wV9JwZObIeRlP8bGyT1oImcG3OndPJFC60QzJQGXtgFStt4Z5dNrVLvmQcNeomACYuZ2RUdAcuEPPerw24LrjUvaZHM/CPuTihgGb9/h3JuFyw8eXrsjLfj4RaAuptR0xuMLUEUNqWJUZGjNmgvDerTXBzlhXVxcM+zPMV+MPrwbwKkNb3u9tVsz4+ryZVnVnMNs1fD6z4Hq5PXwQYdv6kEU2gyZzM9yVVociWNd9fJ8fE3pKFGU6T2R3r+SM//V3puya8n7Cpsv0/qPpS5W6lL9EK84HKOCZ35yTdlZ4bG8Dn2nPkgn+v8dIrsJU+gubFDOJdLnooEVn0B5FotRUKH3QbT0/VYho+L5VJSnigt/sIkhNO1nIGuSu4A0lf0SJ48LpL3ysJMFTIJgZKrIRmJbqMKHSMkCn1lxXtB9G+D6mw4RCcnj+2bXKuYhtMUgfxiyxB+p3Dz/kGtld6F40wVaeKgNhYabdrq6WOnz7m0lPYpGNRL1B5FCKcSCon3OcbkNDcJKo4L/UAAvuaWpx0FATMYF5owUlt+c2epxFBvbfmcyg0bNetARdGw64ARLof6nApUkSfc4qQ1M6HiZCbTcuL6+fvDWCU4cnB8559yOWchiy8/vnPlb4rpaugjjsaFTuHwT7i4HEPEFtbm4WCQqpinC2Vs+Oz42bMBz8VgORy0Ow/czoNhxCCKIglw+AYidtpkmztwCC+Ra9Tw0+nZ2avRaDL+8Our9+sKZ97Bh+MyxxA2fbySTWCvitgtlhELIWJLnhYYsXqP1UEH8qK0C3eHtjC7iQ6oyHKlbZt2JpKRbHsqeNFN0020T9vCf2cj8HoL5Alq86La4MQfv+ElYvAz8JhCf2LVLcq60SbsL3bhjeRBJHMtpN1vz31EwvsHB30m3vIlH7ko7LGxNrlyvZKGCOlI4HdcWJihjReOg69joPJAMrQLlRCCi8vxJjlhKwWbkUOgP7XBU3mGxo6gT8FKpR87nqbt+PHSLa9TlZQhvB19eH/kC4KYlfsV3GLZIxnqA5Imrp9H0vOTcMs7bjaYb4RUikepmu+T6MFzRkm9cRe51IWWMNdRGZiW4FLXM0UP88K6noTaKfYAy1V+W5MTXWnyiV5o8vFOV7HNk7yjZUhwianKM5S2KXIuhLyhKtfKqlildTgYVGSqDivKnXrL2llhrMpaEwFbci3oLjBNXXZmfG854655c8dkAUNZZFT0miH9uJK3bv/NeHwBnZ06YHSadXsd3q3DjXz1pjXq4UBpOL9wrbrSG0Z2UtXoO+nafQVpXTGiu8eDdHW8YlMXsK+VzjjZe/vHmDWfVNxLx62uOnwHug5IeaJxptEsvtYIWTFKflx9n3n1vZ+4x7sb5YAJOVPbD4u29d/xGqAIQm283HLofWVsxt2N39j/ci6t7dW1ABbv7SBPuXCvTRfmVZNnV4zngjYest4V7RHRyyrMbykufeBdsaqacoOXOq1rmv5coC79W6GNfZeSiXA9UcLCGU8Nbp2ra27Y/semhz2AlW/Xz9s+2mTpUiwtaMQCuiL817z6mlLDVVa3u1/o18ie4lYzRZnvNU7jGN0V8bDsda9cXVxSgE6bb4KZSkhF8zuKDX7nz6gcZP/Zgeb8PVX4RsubpBimVr3nry7Wmz8EaicLVeUl/A1Rd6S4K5V4qeu/ARO4RU8= +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"; + + + + + + + + + + +Update security users by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-and-returns-file-metadata.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-and-returns-file-metadata.RequestSchema.json new file mode 100644 index 00000000000..9dceb7ca0b8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-and-returns-file-metadata.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"multipart/form-data":{"schema":{"properties":{"delimiter":{"description":"The character used to separate values in the CSV file (e.g., a comma, semicolon, or tab).","type":"string"},"file":{"description":"The file to upload","format":"binary","type":"string"},"header_row":{"description":"Row containing the headers to use as column names(0 is first line of data). Leave empty if there is no header row.","type":"integer"},"type":{"description":"File type to upload","enum":["csv","excel","columnar"]}},"required":["file","type"],"type":"object","title":"UploadFileMetadataPostSchema"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-and-returns-file-metadata.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-and-returns-file-metadata.StatusCodes.json new file mode 100644 index 00000000000..7e7600ea45a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-and-returns-file-metadata.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"items":{"items":{"properties":{"column_names":{"description":"A list of columns names in the sheet","items":{"type":"string"},"type":"array"},"sheet_name":{"description":"The name of the sheet","type":"string"}},"type":"object","title":"UploadFileMetadataItem"},"type":"array"}},"type":"object","title":"UploadFileMetadata"}},"type":"object"},"example":{"result":{"items":[]}}}},"description":"Upload response"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-and-returns-file-metadata.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-and-returns-file-metadata.api.mdx new file mode 100644 index 00000000000..d0b9286c9a8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-and-returns-file-metadata.api.mdx @@ -0,0 +1,68 @@ +--- +id: upload-a-file-and-returns-file-metadata +title: "Upload a file and returns file metadata" +description: "Upload a file and returns file metadata" +sidebar_label: "Upload a file and returns file metadata" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/iuHw4A6mGInwwYUKvohzVo0XdcGtbMNiIKUls42G4lUScqJJ+i/D0dKivxSFF0/9JMt6u54z3MPj6caDX2uyLoXOttgXGOqlSPl+G9R5U6WwrjJQpviOBNO8LJNV1T4f6XRJRknyfJTRrkspCMTHmxqZOmkVhjjbEWQroQRqSMDlaUMnAZLpTDCEaxFXpEFqcCtCM6nf8FC5gQjGi/HEQhIdVGICCwVMtW5VhFoA07Mj8YYoduUhDFaZ6RaYhMh+x5OwUd1Gqoy1yLDCBmXcBjjXCphNoeirUhkZG6Nvt+P+UHfA/MlpJJq6ZMP5tbvYgmEhVTnVaFAiYLs6ASkhYU01kEuFYFeANN6NIa3JNYEVJRuA3LBsQyxsdJtTDD6foBXKkdLMpxiWNlN7pUHuym3EZOqCoyvMbVrfnpIKccIQ47C4E3TRF4R0lDGdp7MdoubfnM9/0Sp43XpmGy88vF5yz/JCYZ0qa2bBqU020Gdqcgv2FIrG7Tzy8nJjvhEWeYyFQxm8skyoi8rz5Ctcre/Lh0V23+23wfYt740+wSeQS6t4xIFOxtq2MnUroiYgj72nnTaBWGM2PCz9/C7HZYnv+HthtF3gjbfUoILR8V+Ht8U4oB5w7IRRRkO2SP1LQ/XN42v9za8EBm6mnOQX7+r5AVZK5Z0gPevJNw74gufkG9+MVyotchlBtyRCnJ8hEuj1zKjDA/gGfgGLKc/FsuVEpVbaSP/pSyGs8qtSLl2f+iP3qHCDBwDkl9/LJJ32sFCVyqLgc9ESzJ57ejKpASZJm6LDuhBMv37oPoYvMtvP1pnF8qRUSIHS2ZNBsgYbWI4U1ApeigpZXR+EXSaVuYLlXolnMiDnd/cUloZ6TYYX9f46d75o8ctWiz5GOLvwom5sL5tPxynOqOpT856h1yoJcaYXn14ixHmYk7542Mgmp8rk8PxP3D5fjqDBFfOlfFkkutU5CttXfz05OnTiSjlZH06ydr9JuGuuS3aFjJJEJIkUQDHryHBs1Zunv4YXpAwZOCns/Pzl9Pp7ez9Hy/fbTuch8IdzzYlxbBbu0fbDJ7UCd7RJsEYEvQzRYLNE2yiHu7lxq20GgDuF3rIsii1cZ3ubKIS1XUteN4vj0tt3Yj3he/gJQoB2pnheb3DTgDSMpQg/AwiTcnaW6fvSDWtN7Pw/BDyRB0lqjRSuVGHYMzGo6OjISdvxFpMvc4GvGwtPspBK+tgQIe4F9LBgly68mR8JxV1QFSQW+mMobDudmmKOzPYVRPD/9gJqg5czTxVH6NHl6GeAmH7mgrWHcNznW1ieDN9/24cDr9cbEY13NFmQDc0R2zNrD9LVGCKsfUs7dSgNdI5jXO9HPkp8BnyAT54c4owvArFjdBVRtmw0FGIEQbaMEbWJkZYCrfCGL9KPlfYd6bQGSrDAjhYR9xN7i2/hozWlOuyIOXaHuf1FQLVpdFOpzpv4smk5lBNXPMRa/ainVfW6aILEeFaGCnmOXWTmw8TRqeF8FOHT3Mw1baP/GNxj8rXs9kl9HF4tmeituL1ePeSm4bmze/CnGbg4pKDMJbtIAepav29ddNwnbsG7qfkANK38RrnXsOvuo+TN3/PuEbejL9V/NvH2dCDbiJ2vjW0MGRX/zdIE6FUC70/nk6rkoyl4bA4WGLtBLv1aaDEukL4ezVMu9+g4q19+0vX0YOblLmQiuN7ZdWtwK9RlJKTOGXv7tKLcEfmGCErIpT8Guuaza5M3jS8/LkiwzfpzaPq/H3aff/5k3FHG1bpoH94keYVZ3joY5lPQXA6S1PyvbQz35tBWBH9Cea+hxHO22/yQmfsw4FbKP3fkCTPcAO2+uK2fzj57iNAbQZZ1HWwCF2ST2RI118w2PAo/x/pY48A +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"; + + + + + + + + + + +Upload a file and returns file metadata + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.RequestSchema.json new file mode 100644 index 00000000000..1889ea6f371 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"multipart/form-data":{"schema":{"properties":{"already_exists":{"default":"fail","description":"What to do if the table already exists accepts: fail, replace, append","enum":["fail","replace","append"],"type":"string"},"column_data_types":{"description":"[CSV only] A dictionary with column names and their data types if you need to change the defaults. Example: {'user_id':'int'}. Check Python Pandas library for supported data types","type":"string"},"column_dates":{"description":"[CSV and Excel only] A list of column names that should be parsed as dates. Example: date,timestamp","items":{"type":"string"},"type":"array"},"columns_read":{"description":"A List of the column names that should be read","items":{"type":"string"},"type":"array"},"dataframe_index":{"description":"Write dataframe index as a column.","type":"boolean"},"day_first":{"description":"[CSV only] DD/MM format dates, international and European format","type":"boolean"},"decimal_character":{"description":"[CSV and Excel only] Character to recognize as decimal point. Default is '.'","type":"string"},"delimiter":{"description":"[CSV only] The character used to separate values in the CSV file (e.g., a comma, semicolon, or tab).","type":"string"},"file":{"description":"The file to upload","format":"text/csv","type":"string"},"header_row":{"description":"[CSV and Excel only] Row containing the headers to use as column names (0 is first line of data). Leave empty if there is no header row.","type":"integer"},"index_column":{"description":"[CSV and Excel only] Column to use as the row labels of the dataframe. Leave empty if no index column","type":"string"},"index_label":{"description":"Index label for index column.","type":"string"},"null_values":{"description":"[CSV and Excel only] A list of strings that should be treated as null. Examples: '' for empty strings, 'None', 'N/A', Warning: Hive database supports only a single value","items":{"type":"string"},"type":"array"},"rows_to_read":{"description":"[CSV and Excel only] Number of rows to read from the file. If None, reads all rows.","minimum":1,"nullable":true,"type":"integer"},"schema":{"description":"The schema to upload the data file to.","type":"string"},"sheet_name":{"description":"[Excel only]] Strings used for sheet names (default is the first sheet).","type":"string"},"skip_blank_lines":{"description":"[CSV only] Skip blank lines in the CSV file.","type":"boolean"},"skip_initial_space":{"description":"[CSV only] Skip spaces after delimiter.","type":"boolean"},"skip_rows":{"description":"[CSV and Excel only] Number of rows to skip at start of file.","type":"integer"},"table_name":{"description":"The name of the table to be created/appended","maxLength":10000,"minLength":1,"type":"string"},"type":{"description":"File type to upload","enum":["csv","excel","columnar"]}},"required":["file","table_name","type"],"type":"object","title":"UploadPostSchema"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.StatusCodes.json new file mode 100644 index 00000000000..226e01c4f7c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"CSV upload response"},"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"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.api.mdx new file mode 100644 index 00000000000..7a7d0ea5f80 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/upload-a-file-to-a-database-table.api.mdx @@ -0,0 +1,68 @@ +--- +id: upload-a-file-to-a-database-table +title: "Upload a file to a database table" +description: "Upload a file to a database table" +sidebar_label: "Upload a file to a database table" +hide_title: true +hide_table_of_contents: true +api: eJzFWW1v2zgS/isD4gAnONVOFrtAoUU/pGmLttdtgzrdHhAHXloa22woUktSTryG/vthhpIsvzTX9ks/JZJmhvPMPDMc0htRSicLDOi8SG82QhmRilKGpUiEkQXS051IhMO/K+UwF2lwFSbCZ0sspEg3IqxLklIm4AKdqOvbKI0+PLf5mkQyawKaQP8WlQ6qlC6M5tYVT3IZ2MjWXOlsiS4o9PQktUOZr6f4oHzgNznOZaWDSMVcKi0SkaPPnCqDsuT656UMECzkFtQcwhIhyJlGaAxBNAQyy7AMPgUykoDDUssME5BliSYXiUBTFSK9aRdpBEQiGonbpAXug1NmIepEZFZXhZkSpil9bPztu3dzOf4TrNHrW7iAXGX0Wro13KuwhKgPFHYP0uTkvnJA9oDtEaS1rcAg5gQyW0qzQEbZhMUP4eWDLEqNKWwGlUc3VfkgHSgTBvUQLpeY3cHVOiytgStpculBq5kjF+bWga/K0rqAeW9R8SjSr4Ik/18+ZKg7uFr5AHa+CzNQvvzSVjqHGUIpncccpAe23UNDz0lQBfogi1IkQgUsfI+AW++aF9I5ud5666fEgENvL+Bd4xjF8THnWP97FqYgzqm8psrk+HC49menAkInBixG6GXjyHAb/Zm1GqWJdtfTuXI+PEqwFy9Gf/xBaS1kiOFMgKrUGcm00zFHFRWcNI3g8fUwU4XU02wpncwCum/M+WUrT2R1mNmFUf8gZzdahNIqE4bwIrIXlIfBcHCMcTlqVaivLx0XvKYMdotWPpaJR2pyAWEldUVVZDjVpDZXGuEEh4thwjEvCpmAx0JlVluTgHXUP06Hx1wi3UNvyAW2GixUpbZMmSa2qQj4EEaZXx2zt0SZo5s6e/+N4f1o74Faq1RGmQVjijY8L+450juEPjmjEDN1QCuDxHpi3+kQ3qFcIWBRhnXTOR2SsLGNUXD2vheHrt8nglk7jQt9KzOiV1s3yXln70HLGWrfVmNXGQf+GdsUS7PskXhGt9jgoVdvWJk/cufrGzuabVNpPY0E+u6OF60c9JPgUIbY7ch61+x8CoMBexXhNuoJDN5bgwP6O7oYJPBZOkp8Cq/VKsZqJj22TdyzGyDBK7PQDfm/q305e++nwX6lbx7F/L4qZugIMynHspc5zJ0tOKFUGUN4MwdCkvBHD1JrFqe4F8qogrbe8xhy2rzbmeOQedux4bAI47dtGXaEasvzaJr9EjFM4+RzgLiH9BbGTVK5y/DmSaptoeXbjhZxU8mxxPFm4u9UOZ1pae6mVJiPjw7jO1UCC3MVH3S047sGL6GMCkrqqS9pnPm/i7CYBzmnftr14EfsUx5/mCtkAahEgnRcOHtgepnnqe4reaLs05e2i8QJMFiquSzW3CiOcUjNuZAP79AswlKk52dnZ2dMwu7NkVzFF/urvmJWrcvdzt/OkbHnI8EX7UQinbit6/5sfRM3lR14zXrbgdPOvmDGG7UKVBziEy92ZX0Yx3qod61S9fALX1rjI7d+OTvfm8xlWWqV8Wgw+uKteWwsL9B7ucAjXaTed7Mm1NzWdhS3CvX+CE9caUq2dZms/Hp29nM9fs4O8cEmhTdmJbXKYXt8gtLZlSJKHcHU041YfnL0PxlZhaV16h/MU7iowhJNaNaHjjlHgPQVI5Jffy6S9zbA3FYmT3n6a4KMzB1buQwht0hjTIhnv2OgOhuM6JdffnZuSmczeqS2RXkJ6xT+JLrF/KBz1h2tHJ4sCGpjodGmpX772eXzJh49NHh0K3QRRQoXBiqDDyVmlDR+CTbLKvcVAr6SQeouBInwmFWOMNLtxZf7INKbW7qCCHJBNxriRTMWUQN9eJLZHMdxyGIFLc1CpCL79PGdSEQzK7aPkT/0XDkNT/4LVx/G1zARyxDKdDTSNpN6aX1In549fTqSpRqtzkftGDY6H8UmNpoImEwmBuDJa5iIi6Z8OO4pPEfp0MG/Li4vX47H0+sP/3n5flfhMmbsyfW6xBT2k7aVzWGwmYg7XE9EChPB495E1ANRJx3OePLvIe1edFhVQcNjW0d+Yiam7cLwrHs9LK0PJ7Qu/EhAkqjZnFaebfbCEhE0oZkI+Dff13gaRu/Q1I02wX92DPLEnE5M6ZQJJ63rQxI+OT3tB+OtXMkxM6sXkJ2XWwJY4wP04iDvpQowx5AtOQo/GoNNhFJgWNqcMBDF9uOTtmKwzx/C/VdLoU0M0jXH6K9kq9JnUIzUIYuidBvamc3XKbwdf3g/jHWu5uuTDdzhuhdnqE9JmsL9+8TEEPF83YZnL/iNkNU41HZxwufO3wXV6t4WE/f+bk4HuT3b8FxEMxsHjC4nradM8Y1lKg7ivSnv6jbklFBuPbH0K0f5Ppq2g1vFd/QZclyhtmWBJjRNjOkUDW1KZ4PNrK7T0WhDpup0Q6VUH1i7rHywRWsiESvpFOHyTd9lM7t3neRmb5psHumPFwcBfH19fQWdHbpZsO1VUWuvw3vg3Dh2Z/oWZ2gHb67ICGHZNXI0VI0+S9d8Gdx2aB5OI0ju0xsxY+a+ai9H3n6+Fs2Zjo8W/HU7/TPoOiHlqcO5Q7/8USN8OzC3h0P8uCrReexP171XxJ0otzqPIfGhkLxxNnfl38LdnRW7/ZRvhkotFZ+lmFObhtY3QpaKlj8X8U6R97NEpHwz3x01iAgx0zdisyGZT07XNb3+u0JHO+TtlmxcA7niISMX6Vxqjwe+ddOCOPnYDIWnsA3mrs/t9YFZM6fptiEVIqH+HH9FqG+7Wy5ePX7od6ee4rEfCqjaotIF39/3xA+GGWJe1yWoq4pEzJrfIwqbkw4ZZrvJ9l+aHhJBM24vNx2Jmn/I+aNoN5soEXtw3YHnfYvw1/X/AKqcxkE= +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"; + + + + + + + + + + +Upload a file to a database table + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/user.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/user.tag.mdx new file mode 100644 index 00000000000..f3ec7f344da --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/user.tag.mdx @@ -0,0 +1,12 @@ +--- +id: user +title: "User" +description: "User" +custom_edit_url: null +--- + +User profile and preferences. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get the user avatar](./get-the-user-avatar) | `/api/v1/user/{user_id}/avatar.png` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.RequestSchema.json new file mode 100644 index 00000000000..f4fb7786d8e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"catalog":{"nullable":true,"type":"string"},"schema":{"nullable":true,"type":"string"},"sql":{"description":"SQL statement to validate","type":"string"},"template_params":{"nullable":true,"type":"object"}},"required":["sql"],"type":"object","title":"ValidateSQLRequest"},"example":{"catalog":"string","schema":"string","sql":"string","template_params":{}}}},"description":"Validate SQL request","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.StatusCodes.json new file mode 100644 index 00000000000..d02b67542e5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A List of SQL errors found on the statement","items":{"properties":{"end_column":{"type":"integer"},"line_number":{"type":"integer"},"message":{"type":"string"},"start_column":{"type":"integer"}},"type":"object","title":"ValidateSQLResponse"},"type":"array"}},"type":"object"},"example":{"result":[{}]}}},"description":"Validation 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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.api.mdx new file mode 100644 index 00000000000..38ac50af0b8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-arbitrary-sql.api.mdx @@ -0,0 +1,68 @@ +--- +id: validate-arbitrary-sql +title: "Validate arbitrary SQL" +description: "Validates that arbitrary SQL is acceptable for the given database." +sidebar_label: "Validate arbitrary SQL" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYUATTImboQMKFf2QZi3aLmjT2N0GREFKS+eYjUQq5MmJJ+i/D0dKsvySdmgL9JMt8ni857lX1pChS60qSRkNMfwlc5VJQidoLklIO1VkpV2K8YdToZyQaYolyWmOYmasoDmKa7VALTJJciodHkIEpbSyQELrIL6oQbHiUtIcItCyQP66gQgs3lbKYgYx2QojcOkcCwlxDbQsWUppwmu00DSXQRodvTDZkkVSowk18V9ZlrlKJSMYfXYMox7oKq0p0ZJC549Jkrm55r+6ynMG0l3fXurIKn0NzdCer4ve5iy3ziVT5kgSFqhJkBGLllzYoYGwKHNJeOXJc1+41Uw/Y0rQNEMGL7wJl5tCEZAi1tA7dvzh9DwwybfivSxK3h8w0xm1ImCwwjhXn9tGNw3btTumfAy1btxyv0fjSqNdcNRvjx9/h5stuiqnbZcci1PlSJiZtwWtNdaJmal0Joz20dw7DCJQhMET68pRZ1epyatC74rVCHKl8UpXxRTtboECnZPXONgcRBJJS19Q3/xPFwcqYSUurZXLHefXo6Aj7qJuLh92pTJatJJNBE++y1UPk/EVU/uD8EJmXVzF4o32aSZWRUiU1ixUhhnsQDQ4G7Ac/VwsH7WsaG6s+hezWBxXNEdN7f2iT5kdQIYHA5InPxfJO0MhtWIxmWNHMjLdzlQ2RZEZdEIbEnivmP5tUL0OvuX3nx1nbzSh1TIXDu0CbagfsTjWotJ4X2LK6PyiMGla2Qc89YorbZDzlztMK6to6Zvl5zvOvkvueCSvuYHCH21r5fJ+f5CaDMfeuNBdc6m5aKcfz08hglxOMV99BqL5u7K5OPhHnL0fT0QCc6IyHo1yk8p8bhzFTx8/fTqSpRotjkZdKx8djbqOdeVu81ECIkkSLcTBa5HAcRttnv1YvEBp0Ypfjk9OXo7HV5P3f758t37gJPjtYLIsMRabrlvJZuJRncANLhOIRQILmVeYQPMImqhHe7akudEDvP1Cj1gVpbHUhZ1LdKK7BiOe98uHpXG0x/eKb6clCufnKDO07nm9QU7A0RKUgPjVT1HOXZG5Qd20p5mE57uAJ3o/0aVVmvY6AIcsvLe/P6TkrVzIsY+yAS1ri6tgMNoxMz0b8k4qEjOkdO65+D4m6gCoQJqbjJFw0G2yFHdiYjOWGP2nLpzqQNXEM/UpWh0ZRlPgazuignRH8NRky1i8Hb9/dxgyX82We7W4weWAbdHsszST/izRgSiG25O04YJWyOR4mJvrPRbdfwacvQE+z7rGjzt+AI5hi8O6vGnWaWRX+QITEryy7MmdDoHN0nLK2yLDBeam9GNn0OQDJSiqS2vIpCZv4tGoZlVNXHOqNFvaTipHpuhURLCQVvFA2s1EXk0YsmbSjw3eTIgAdVVw6Wo/+cdx+VrX/3oyORO9niYCtmZdX493y7hxqMG8x48KYax4c8ZKGMu6kp1Utee9dONfGF0dHnMHCSB9Na5h6qPxlbGFZH1v/5500zGnU9hdDfUedBPx4SuLM4tu/q1KWIsz+nz19nn54yf2CJSemR3vl6pE63A4Yg6WOD6D3OIo0O6okL4Ft4+8fu5fe0VuOmLQ0H/M67MlkPCeRmUulWbrfOzXbRJegCwVQzhiY7ruGkHsn6XDXIQIOGxDXF5AXbPkR5s3DS/fVmi5a1+uUsNnbKYc/88gnsnc4RcA7523E92+eMjybnzXy2BbxV8QcZ8ID+nmkjPHV1V/e9gY1sfBwa2JiQtDOHHsyf2i7LCscVGHCKbte7wwGZ+x8o6fdvIuGGk85vAk47XQraowTgWdHH88uQ4Gsz4X2j+MaicNdR0kQntoelZ8YwX/gvkPGDvPzA== +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"; + + + + + + + + + + +Validates that arbitrary SQL is acceptable for the given database. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-database-connection-parameters.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-database-connection-parameters.RequestSchema.json new file mode 100644 index 00000000000..306059b9fc5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-database-connection-parameters.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"catalog":{"additionalProperties":{"nullable":true},"description":"Gsheets specific column for managing label to sheet urls","type":"object"},"configuration_method":{"description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","type":"string"},"extra":{"description":"

JSON string containing extra configuration elements.
1. The engine_params object gets unpacked into the sqlalchemy.create_engine call, while the metadata_params gets unpacked into the sqlalchemy.MetaData call.
2. The metadata_cache_timeout is a cache timeout setting in seconds for metadata fetch of this database. Specify it as \"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.
3. The schemas_allowed_for_file_upload is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as \"schemas_allowed_for_file_upload\": [\"public\", \"csv_upload\"]. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty
4. The version field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct
5. The allows_virtual_table_explore field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.
6. The disable_data_preview field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.7. The disable_drill_to_detail field is a boolean specifying whether or notdrill to detail is disabled for the database.8. The allow_multi_catalog indicates if the database allows changing the default catalog when running queries and creating datasets.

","type":"string"},"id":{"description":"Database ID (for updates)","nullable":true,"type":"integer"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.
If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"masked_encrypted_extra":{"description":"

JSON string containing additional connection configuration.
This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.

","nullable":true,"type":"string"},"parameters":{"additionalProperties":{"nullable":true},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"

Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.

","nullable":true,"type":"string"}},"required":["configuration_method","engine"],"type":"object","title":"DatabaseValidateParametersSchema"},"example":{"catalog":{"key":"value"},"configuration_method":{},"database_name":"string","driver":"string","engine":"string","extra":"string","id":1,"impersonate_user":true,"masked_encrypted_extra":"string","parameters":{"key":"value"},"server_cert":"string"}}},"description":"DB-specific parameters","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-database-connection-parameters.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-database-connection-parameters.StatusCodes.json new file mode 100644 index 00000000000..c981bad450c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-database-connection-parameters.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Database Test Connection"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-database-connection-parameters.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-database-connection-parameters.api.mdx new file mode 100644 index 00000000000..9e38ae0eee7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-database-connection-parameters.api.mdx @@ -0,0 +1,68 @@ +--- +id: validate-database-connection-parameters +title: "Validate database connection parameters" +description: "Validate database connection parameters" +sidebar_label: "Validate database connection parameters" +hide_title: true +hide_table_of_contents: true +api: eJzFWW1zG7cR/is7aGdiT8+k5Maph5E1I8lOrVS1lVBOO2NqGPBuyYOFA84AjtSVw//e2cUd7yjSiRunk29HvCx2n919sAuuhcOPFfpwbrNajNYitSagCfQpy1KrVAZlzfCDt4bGfJpjIemrdLZEFxR63iaD1HbB27JM0R6pr3eWmEprOdMoRsFVuElEhj51qqS1YiT+7nPE4MGXmKq5SiG1uioMzK2DQhq5UGYBWs5QQ7DAi6Fy2otEhLpEMRJ29gHTIDYJGTFXi8qx7tMCQ24zUmH3xIsDq0B5qDxmYA2EHGHuGI+MzlRmbl3BwzOZ3tHoKseQo6NZvC+1zRBK6WSBAZ0HyxOls0uVIVija5DgP2qpCcV6Wjk1EIlAUxVi9F70ZuggkYisNrJQafx5S5DJIGfS49TIAvctOoN2AdACVjpDE9S8hpArD6k1BlNaTQcX8v4KzSLkYvT02VEiCmXa38fJA39tUfbBKbMglDOnluj2tRj/cHUW7YC4hPSoPIrPkIlmocwBy3oy45JO5r6M++DkvoiT8vT78ds3EBcSFEEqQ5+8AXaCBlBjgSb4wcnMnR4P4CZHOElthqfx/Cn72Z8MeQxi7MGCIrgyJYVHBsoEy+FyIiF3OH8xEXkIpR8Nh5lN/aBz+MC6xRDNUMuAPgxT63AYz/GDPBT6T72lqUMZcBqnJwIc6hcTYawt0aADYx3O0Tl0E3H6qW0nQ3kKqdQ6gVWuNEYt2ZQCg6QoemDgl1rmUE+Pp0fRtPaMPdsivQz+iUG+lEF+vnXtjq1h7Lenfb9tDUtlmuM0qAJtFVr7lAcJPAPNDHgMgcJDGfCYWpP5SEaNHJhjSHOw85habeYNYMwMVoMKID2c+OCsWZxOxGEFJmIE60lDrPtT3xwdJTARgbLm4OzmZNicMIDLOVTGY0gaS1ZKazA2wAwBDYnI2ARmtsqkkaZVqAdwtjXbzuEIlMmI+tFDyGXgDVGkQUpovC+Vw5gcf+2DHM3wU6m1XWFGzDWdK43TqtRWZrto26KQ4JECLWAGWnk+vZERT74Y/+RBOoRGIuc9y4JgP431r+hB2L2fiLKaaZVOBCGc+uV28nYX0y2pzrVcWgeZRc+w+qosrQuNxsT30tTtL7Kx03mGINMUvccsgQ+VD6BRLmPiseFYlKEmPL/u47lE55U1LW5zhTqL6DU0Fq/Lmj5JVAzF2Vcemp0kTHnwua10Rlrw7bZSIYdrhz5YeHnuwdvOz742Qd4D3xbOYRpIqWd9pdgsP10qFyqppzE2+f5zeEDTmbUapemr2t6b1jGOdOyruB9mVQjWUNKNf7iCKzkDh77SwUM0Y2U46r7pK5QpzzpE3nK4VLj6TYpwXjcC4GOFTqGPWTRDcJWh9SYmPiNOp3aE0Ok8+NtB9ZzSehrsNMMglf4tGrIIiqcognY10rvM3jLR8z2nTYtKBzVtqrVtNm6TXc13JMQA9pDm0izaEMtwLisdoBESIXGV4au0xUyaDPjGoUES55Hu0mF5eujGVgeqs5etDpcv4RGZVpUZ6fj402WEMgEX6FhiUaLz1tCVV/lDVcrlvEmAhKxky1rle7FHzLOwbDrnMN5jWhFZMT8hpJVzaIKuQdvFItaNdB6scgsFpXlOWV6iK5SnfCQ5FEghx4ICeXh6OYfXaokMWa6WOPDoluieDiJjDzJ7xrHfEHgS47GR0QHugfaplHnGViYklErQA+KXFV4quXt86ex9PeC5ptavB53zmkglrAvp7zCbokldXQb6+l8LsK5l6FWouwUZJz1TWVuh90rr3qZYpMcajqLG1z5g4UGrO2Sck87tJoNztfihQldzHZTmkFnmATqaa/1Y5RAIVFCPSun9yrqsJUlDZ2ldR41mNXR1ahvsv1rydg3DF3RPL8+fbBunXgdCCOzAeKhbig6fpujCQae9LRvfXJxNz9+9eXn1Cpou0RNAS6kVZSa8vrm5HkPTT/oBvOWGZykVK06BRkdIZTp+aWvcz8Nqk3C3qhxm1C8d7PK2LcTtQ0sTEVQg2Vtq+anR/HoL2Di2t9xEyKLU+KC3vcNajMRS6gp/oc/cb9RaE7qmqRtpW57eSMyfboD48fgQqUWYPpWAnYDdGHtgxY7/O7A/M8ZE3ylNbDr0pTU+Ru7To6MveFgo0Hu5YD/sR8NeKPe8tt34Sxa1cXiDPsDFlkVI1Nd/tNrnMmuTaQSXhtOsn9sN+WWHDOvtZVuePv1jbXlnSmep+mUmoBeJUI+gyT9ut52z7pAlF1y3Eic3EprddNSzP9pFlybQxaAhplC0YgRnBiqD9yWmVCnwINiUb96D3vqOCGYLASVkWjmycfR+LT6sghi9v90Qn8mFJ+Jrw5Y47v4J1XBjVs7zBi3NQoxE+u7HK5EIfjHrfnpbuZRUTyun4cm/4frt+AZi9z4aDrVNpc6tD6PnR8+fD2WphsvjYUtmw5bqp10YDicCJpOJAXjyGibirAq5deo/7IIRnKN06ODPZxcXr8bj6c3bf7x6s7vhIjrvyU1d4gge+q9bm8FX6wkxF7Vuk0heE7H5SmySrcnXdcj5imuN3g5szVYFN2ztJTUxE9OSFbzo7q7S+vCIzoUvxCaJQnKUGTr/Yv0AoWhMg9JEwF+aJnEa7B2aTbObkHhxyPqJeTwxpVMmPGqtGNDiR48f93H5Xi7lmOOth83OYBcW1niCZwuJXEkVYsfDgPwOcKyjVfG6JHMoBh9CNWqXwcOoIgh+bgNrHfG6Ybh+Trot/biKoO3HVlzdojyzWT0CqlAHkQjUvH60hjuse5DD5jGtJuS/nZiIFvd+LVIP/NAsshoH2i4e0dLH3wpK5l0KaEuRrjTq1bQ7l21bZQiKUb7a6b1WfJYDRHvZR6aoHAXCQX+Khwpe0TRkuERtS3oZbTiP4ywKWpfOBptavRkNh2sStRmtKd02e9IuKh9s0YpIxFI6RVeDb2iaxcRilJvNRs3eY3nzk18dxR6cVIrCVs4mEaTNrrytvXvKjSOZ0xy/olsHl9dcqVv3QMhBqJr9vHqzIV+3hM7lZTSSaX0tZhzH33HLQkn5rxvyES+jJotnu5qdjd4ktHnqcO7Q579VCEnx1vzY/fvz6lDF+38pZY9+t1L2k9VrIqgRPPA/QkXnYr8b6A01b2ZUHB9Hh/tQSK4iGuM/P093zt2WGAHvw7DUUnGNyXmzblL4vZClIiWORQc658ZeIotEUMzHoH4v1mta+s7pzYaG6UmAaofbLq+4gkhE5FbO/dgD9FkyHlWRlntlFCV53HGWpshXxqfX3vZIiqhdJGLW/LtY2Iz2OLmitkGuxEiIRFhGidOCx+LFVcUaK8qkeJVVyHtQbuO6+SCrmilp6p6G63VcES8JIqNoCt+xYnO72Wz+C4OmPs8= +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"; + + + + + + + + + + +Validate database connection parameters + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-each-chart-powered-by-the-given-table.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-each-chart-powered-by-the-given-table.RequestSchema.json new file mode 100644 index 00000000000..945e96e2c1e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-each-chart-powered-by-the-given-table.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"dashboard_id":{"description":"The ID of the dashboard to get filters for when warming cache","type":"integer"},"db_name":{"description":"The name of the database where the table is located","type":"string"},"extra_filters":{"description":"Extra filters to apply when warming up cache","type":"string"},"table_name":{"description":"The name of the table to warm up cache for","type":"string"}},"required":["db_name","table_name"],"type":"object","title":"DatasetCacheWarmUpRequestSchema"},"example":{"dashboard_id":1,"db_name":"string","extra_filters":"string","table_name":"string"}}},"description":"Identifies the database and table to warm up cache for, and any additional dashboard or filter context to use.","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-each-chart-powered-by-the-given-table.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-each-chart-powered-by-the-given-table.StatusCodes.json new file mode 100644 index 00000000000..b22256ba3dd --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-each-chart-powered-by-the-given-table.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A list of each chart's warmup status and errors if any","items":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object","title":"DatasetCacheWarmUpResponseSingle"},"type":"array"}},"type":"object","title":"DatasetCacheWarmUpResponseSchema"},"example":{"result":[]}}},"description":"Each chart's warmup status"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-each-chart-powered-by-the-given-table.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-each-chart-powered-by-the-given-table.api.mdx new file mode 100644 index 00000000000..85267c89063 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-each-chart-powered-by-the-given-table.api.mdx @@ -0,0 +1,68 @@ +--- +id: warm-up-the-cache-for-each-chart-powered-by-the-given-table +title: "Warm up the cache for each chart powered by the given table" +description: "Warms up the cache for the table. Note for slices a force refresh occurs. In terms of the `extra_filters` these can be obtained from records in the JSON encoded `logs.json` column associated with the `explore_json` action." +sidebar_label: "Warm up the cache for each chart powered by the given table" +hide_title: true +hide_table_of_contents: true +api: eJzdWG1v1DgQ/isj6yRaXdptT5yEgvhQShHlTqVit+KkBm29yezGkNjGdrYNUf77aewk+wrHwUlI96kbe+bxzDMvHrdhGdrUCO2Ekixm77gpLVQaXI6Q8jRHmCvjvxyfFXgMV8qFNVuIFC1w+kgRDM4N2hxUmlbGHsOlBIcEpuZe/Q4fnOHTuSgcGntHa5aOkDBDUDPHhcQM5kaVYDBVJrMgpNd8PX5zBShTlWEGd4Va2OMPVsk7SFVRlRK4tSoV3GEG98Ll/Wm6UAanQZKn5N8xi5jBTxVa91xlNYsblirpUDr6ybUuRMpJcERatGbTHEtOv7RRGo0TaOkr4zafKW6yqcj89waJkxzh8kXv+CALTsECHXQUeBLvc5Rwz00p5CLwzSLmao0sZkI6XKBhbcSy2VTyEvcfRTurwxyfcYsEbHAVNxAWCpUSSasDrDNCLgh/Iza7p1zQ9mC3U0Bc1ZvGV3rb/hW8N+EbPQjmOuWBB1Qiaxe5DfEUBjMW3w4sbRz4ftBSsw+YOtoVrqCFF9xxi+6cDqDEv9FvQ3aMQ9g9MbzUBe7G/HQtKL09OzyuNtYZWJlPkd0g4zJD6cRcoN2MJpfZV4iJ/D6XNfAsEwTFi7W0U6YLHfhsf3AEUlnsyyHQ50yFnk+rlbQhzX87OfmBIjFoq8LtRvwMCmEdxRt5mkOac+MeWe9WpcE67irrPUJjlLEg5uQbi5hwWNrdczzANxSil/O/ujNmWCi5oITeW3RL8XnqTdhTELQMLucu9DtDvWenlH2F+1P3FQXBB0N28cfBwM7wSmZoippwP1Vo6qElL8XnvUXxbxI+hHss5KJAttLlxvD6e8H2lU+fDbfv9+T9xRcTgVAe/1AalmgtX3gb/ompTYsHRfacZ9BdHDFcyiUvRAaaG16i74jaqKXIMNtX0mu6wZfHP9eXK+VgriqZxUDl0ZmGZKRVFd3kmUILUjnAB0FG7/o0YNApv//s6FxKh4ZankWzRBPaRgxnEiqJDxpT8s4vDsW6z6mX3PEiyPnDLaaVEa5m8W3DPtyH1KXbhC8s3TZd/lu6YR6OaDoZe+OsVyi4XLCYpTdv/2QRK/gMi9VnIJq+K1PA0V9wfTOBhOXO6Xg0onu6yJV18ZOTJ09GXIvR8nSUheNGVB3TSk99h0kYJEkiAY5eQcLOKpcrIz575mN4jtyggV/Ozs8vxuPp5M0fF1ebCuchZkeTWmMM22FbyWbwqEnYR6wTFkPClryoMGHtI9ZGg6fXtcuVXPN1WBi8FaVWxvUpZxOZyP66gWfD8rGu3AEdC99JSRSUc+QZGvus2SIm+NCRkzD4FXiaorVTpz6ibDttIuDZPqcTeZhIbYR0B73xfhw9ODxcp+M1X/Kxz641SjYWV0mgpCVWBib4PRcO5ujS3BPxAzQ0wZsSXa4ycuP6ZrLNUNxLwXYOked3fRo1gaaJZ+kuWqmsZ1HgajeTgnRP7kxldezn+uNQ7WJeHzTwEes1pqE9JGki/GkiA0nk6kDQFv2dkCrwuFCLAxI9fMqoYoP3LGa6IuI1dzmL2Vfpo/j4bhKquTIUvr1RYNt95E/ahgyXWChdonRdX/LZEYAabZRTqSraeDRqCKqNG6qNdgftvLJOlT1ExJbcCBoE+znIw4QBYs79BevNpFlUViX1qe6T/vhetYn/ajK5hgGnjRhZs4k3+Ltj3Dg0XNoLI7yBy2sCIV82QfZS1el76balUPVN148QwUnfehs282n4UpmSE97rdxOKkRdjcbe7Goa8021EytPuZfq9IIRilXy7ejhefOlRcPIfPAoiJuRc7RkJK43G4voEtrZEmRrklqchANaV3N+8Hf677tWw+bBfTeCg1T3SHDurvcxCLFGGR8d23NYu+///Pwy6XKB300gXXEii15dx03WSW8a1oBicElGhm7CIbfaT931l3bKmoTfdjSnalpb9SE/Dxaq4/agRsdCffQP6iDU1g7VO63tBUflZfXveok4TNM7SFP1t82XZ9QZ5fUMFMev+OVKqjFQMv6eXIr9nMWMRUz4LwguP1sKVV4VZLEBSzfDK5WtT3VBb3Q9yqn9q+Mddb2DTBIlwz1BDDJ7425m19Hr4G4yUgKg= +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"; + + + + + + + + + + +Warms up the cache for the table. Note for slices a force refresh occurs. In terms of the `extra_filters` these can be obtained from records in the JSON encoded `logs.json` column associated with the `explore_json` action. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-the-chart.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-the-chart.RequestSchema.json new file mode 100644 index 00000000000..31b80a7de6e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-the-chart.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"chart_id":{"description":"The ID of the chart to warm up cache for","type":"integer"},"dashboard_id":{"description":"The ID of the dashboard to get filters for when warming cache","type":"integer"},"extra_filters":{"description":"Extra filters to apply when warming up cache","type":"string"}},"required":["chart_id"],"type":"object","title":"ChartCacheWarmUpRequestSchema"},"example":{"chart_id":1,"dashboard_id":1,"extra_filters":"string"}}},"description":"Identifies the chart to warm up cache for, and any additional dashboard or filter context to use.","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-the-chart.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-the-chart.StatusCodes.json new file mode 100644 index 00000000000..d7318bd7864 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-the-chart.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A list of each chart's warmup status and errors if any","items":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object","title":"ChartCacheWarmUpResponseSingle"},"type":"array"}},"type":"object","title":"ChartCacheWarmUpResponseSchema"},"example":{"result":[]}}},"description":"Each chart's warmup status"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"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"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-the-chart.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-the-chart.api.mdx new file mode 100644 index 00000000000..de02e32cd88 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/warm-up-the-cache-for-the-chart.api.mdx @@ -0,0 +1,68 @@ +--- +id: warm-up-the-cache-for-the-chart +title: "Warm up the cache for the chart" +description: "Warms up the cache for the chart. Note for slices a force refresh occurs. In terms of the `extra_filters` these can be obtained from records in the JSON encoded `logs.json` column associated with the `explore_json` action." +sidebar_label: "Warm up the cache for the chart" +hide_title: true +hide_table_of_contents: true +api: eJzdWG1v2zgM/iuEcMBanNu0hx0weNiHrtdh3R26YkmxA+ohVWwm1iZLniSn9Qz/9wMl23ndC7oPA+5TbJmkyIcPKSoNy9CmRpROaMVi9p6bwkJVgssRUp7mCHNtwlvOjTuGK+3CmpUiRQucXlIEg3ODNgedppWxx3CpwCEZ03OvfocPzvDpXEiHxt7RmqUtFMwQ9MxxoTCDudEFGEy1ySwI5TXfjN9eAapUZ5jBndQLe/zRanUHqZZVoYBbq1PBHWZwL1ze71ZKbXAaJHlK8R2ziBn8XKF1L3VWs7hhqVYOlaNHXpZSpJwER6RFazbNseD0VBpdonECrVcjLKYio+dNACc5wuVffdBeDpyGe24KgnWAlEXM1SWymAnlcIGGtRHLuM1nmpvsB0wPsmR+gQ46ZH1u7nNUfk+hFmHPvfttpGR3wwv6PNh1GgiietN4H9PKvnVGqAVr2wC2MJix+HYF2YdBUs8+YupIUzhJC+ckc07miIc35buQrHHIgneYFyWJrqfgdBu4053IVk4RyhtBXmaonJgLtN/JWARcZcBVDTzLBGlzuZYFbTqkwHPqwRupLPakCzg4U6EHxpZa2UCmP05OfoKKBm0l3W7yzkAK64gtyNM8xPXE+rCqEqzjrrI+IjRGGwtiTrGxiAmHhf1pyufY7zFDqdWC+LOXg0vxZepd2MM/WgaXcxe6iqEK32G2J7zfdZeDwXxwZNf+ODjYOV6pDI2sye7nCk09NL6l+LKX3T/O4pDssVALiWylyY3h9eNM7auIngm3H/bQ/OKrJCArT3+KggVayxfeh++htOnxoMhe8gy61hzDpVpyKTIoueEF+uZTGr0UGWb7KnhNN8Ty9NfGcqUdzHWlshioNDrXkJy0uqKzMtNoQWkH+CDI6d2YBhu0y5+/OjuXyqGhdmfRLNGElhHDmYJK4UOJKUXnF4dC3RfUK+64DHJ+c4tpZYSrWXzbsI/3gbp0PPCFpSPDs9/SgfFwRKf/2LtmvbjkasFilt68+4dFTPIZytVrgJneKyPh6F+4vplAwnLnyng0kjrlMtfWxc9Onj0b8VKMlqcjXxsjqoxpVU59Z0kYJEmiAI5eQ8LOKpdrI7541GN4idyggd/Ozs8vxuPp5O3fF1ebCuchX0eTusQYtlO2ks3gSZOwT1gnLIaELbmsMGHtE9ZGQ5zXtcu1Wot0WBhiFUWpjevpZhOVqP6YgRfD8nFZuQPaFh4FSBRUc+QZGvui2YIlRNBBkzD4HXiaorVTpz+hajttCv/FvpATdZio0gjlDnrX/ah3cHi4DsYbvuRjz6s1QDYWVwTQyhImAw78ngsHc3Rp7mF4NAhNiKVAl+uMgri+mWzjE/dSsM0fivuup1ATQJp4jO6ilco6gwJSuywK0j20M53VsZ+Yj0OVi3l90MAnrNdwhvaQpAnu54kKEGXc8QGeLfA7IS3xWOrFAYkePmdUqSF6FrOyIthL7nIWs2+AR7nxPSRUcWUodXszwLa7xz/0GTJcotRlgcp13cgzIxhqSqOdTrVs49GoIVNt3FBVtDvWzivrdNGbiNiSG8FnEvvJx5sJI8Oc+2PVu8kihqoqqDt1r/Tje9Sm/deTyTUMdtqIkTeb9oZ4d5wbhzZL3xQvkGbLy2syQrFsGtkLVafvpduWEtW3Wj84hCB9w23YzJPwlTYFJ3tv3k8oR16Mxd3X1fjjg24jUp52N77HGiErVqt3qwvZxb7p/mR7uj/5+nQfMaHmes+gV5VoLK5PVmtLxMYgtzwNIFtXcH+mEvrdrfgbl+Jt/NeO6v//hbrLKd14RqXkQhGEvhybrh/cMl4KwvmURawHbLMrfOjr45Y1zYxbvDGybWnZj+I0GKxK1I8JEQs91reRT1hTSa91S1/RsvJT9vasRP0iaJylKfrz4uuy603u+oZoPev+Oih0RiqG39MNj9+zmLGIac+BcDOjtXBoVWGOCiaJ+bxy+dpENlRI90BB9ZcEfynrHWyaIBHOCmprIRJ/vrKWJv//AAEaMC0= +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"; + + + + + + + + + + +Warms up the cache for the chart. Note for slices a force refresh occurs. In terms of the `extra_filters` these can be obtained from records in the JSON encoded `logs.json` column associated with the `explore_json` action. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/TODO.md b/docs/developer_docs_versioned_docs/version-6.1.0/components/TODO.md new file mode 100644 index 00000000000..c3564104795 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/TODO.md @@ -0,0 +1,71 @@ +--- +title: Components TODO +sidebar_class_name: hidden +--- + +# Components TODO + +These components were found but not yet supported for documentation generation. +Future phases will add support for these sources. + +## Summary + +- **Total skipped:** 19 story files +- **Reason:** Import path resolution not yet implemented + +## Skipped by Source + +### App Components + +9 components + +- [ ] `superset-frontend/src/components/AlteredSliceTag/AlteredSliceTag.stories.tsx` +- [ ] `superset-frontend/src/components/Chart/DrillDetail/DrillDetailTableControls.stories.tsx` +- [ ] `superset-frontend/src/components/CopyToClipboard/CopyToClipboard.stories.tsx` +- [ ] `superset-frontend/src/components/ErrorMessage/ErrorAlert.stories.tsx` +- [ ] `superset-frontend/src/components/FacePile/FacePile.stories.tsx` +- [ ] `superset-frontend/src/components/FilterableTable/FilterableTable.stories.tsx` +- [ ] `superset-frontend/src/components/RowCountLabel/RowCountLabel.stories.tsx` +- [ ] `superset-frontend/src/components/Tag/Tag.stories.tsx` +- [ ] `superset-frontend/src/components/TagsList/TagsList.stories.tsx` + +### Dashboard Components + +2 components + +- [ ] `superset-frontend/src/dashboard/components/AnchorLink/AnchorLink.stories.tsx` +- [ ] `superset-frontend/src/dashboard/components/nativeFilters/FilterBar/FilterControls/FilterDivider.stories.tsx` + +### Explore Components + +4 components + +- [ ] `superset-frontend/src/explore/components/ControlHeader.stories.tsx` +- [ ] `superset-frontend/src/explore/components/RunQueryButton/RunQueryButton.stories.tsx` +- [ ] `superset-frontend/src/explore/components/controls/BoundsControl.stories.tsx` +- [ ] `superset-frontend/src/explore/components/controls/SliderControl.stories.tsx` + +### Feature Components + +2 components + +- [ ] `superset-frontend/src/features/datasets/AddDataset/DatasetPanel/DatasetPanel.stories.tsx` +- [ ] `superset-frontend/src/features/home/LanguagePicker.stories.tsx` + +### Filter Components + +2 components + +- [ ] `superset-frontend/src/filters/components/Range/RangeFilterPlugin.stories.tsx` +- [ ] `superset-frontend/src/filters/components/Select/SelectFilterPlugin.stories.tsx` + +## How to Add Support + +1. Determine the correct import path for the source +2. Update `generate-superset-components.mjs` to handle the source +3. Add source to `SUPPORTED_SOURCES` array +4. Re-run the generator + +--- + +*Auto-generated by generate-superset-components.mjs* diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/dropdowncontainer.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/dropdowncontainer.mdx new file mode 100644 index 00000000000..1d6b5e20772 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/dropdowncontainer.mdx @@ -0,0 +1,167 @@ +--- +title: DropdownContainer +sidebar_label: DropdownContainer +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# DropdownContainer + +DropdownContainer arranges items horizontally and moves overflowing items into a dropdown popover. Resize the container to see the overflow behavior. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + const items = Array.from({ length: 6 }, (_, i) => ({ + id: 'item-' + i, + element: React.createElement('div', { + style: { + minWidth: 120, + padding: '4px 12px', + background: '#e6f4ff', + border: '1px solid #91caff', + borderRadius: 4, + }, + }, 'Filter ' + (i + 1)), + })); + return ( +
+ +
+ Drag the right edge to resize and see items overflow into a dropdown +
+
+ ); +} +``` + +## With Select Filters + +```tsx live +function SelectFilters() { + const items = ['Region', 'Category', 'Date Range', 'Status', 'Owner'].map( + (label, i) => ({ + id: 'filter-' + i, + element: React.createElement('div', { + style: { minWidth: 150, padding: '4px 12px', background: '#f5f5f5', border: '1px solid #d9d9d9', borderRadius: 4 }, + }, label + ': All'), + }) + ); + return ( +
+ +
+ ); +} +``` + + + +## Import + +```tsx +import { DropdownContainer } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/DropdownContainer/DropdownContainer.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/flex.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/flex.mdx new file mode 100644 index 00000000000..b74f06c7f4e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/flex.mdx @@ -0,0 +1,197 @@ +--- +title: Flex +sidebar_label: Flex +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Flex + +The Flex component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + {['Item 1', 'Item 2', 'Item 3', 'Item 4', 'Item 5'].map(item => ( +
+ {item} +
+ ))} + + ); +} +``` + +## Vertical Layout + +```tsx live +function VerticalFlex() { + return ( + + + + + + ); +} +``` + +## Justify and Align + +```tsx live +function JustifyAlign() { + const boxStyle = { + width: '100%', + height: 120, + borderRadius: 6, + border: '1px solid #40a9ff', + }; + const itemStyle = { + width: 60, + height: 40, + backgroundColor: '#1677ff', + borderRadius: 4, + }; + return ( +
+ {['flex-start', 'center', 'flex-end', 'space-between', 'space-around'].map(justify => ( +
+ {justify} + +
+
+
+ +
+ ))} +
+ ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `vertical` | `boolean` | `false` | - | +| `wrap` | `string` | `"nowrap"` | - | +| `justify` | `string` | `"normal"` | - | +| `align` | `string` | `"normal"` | - | +| `flex` | `string` | `"normal"` | - | +| `gap` | `string` | `"small"` | - | + +## Import + +```tsx +import { Flex } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Flex/Flex.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/grid.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/grid.mdx new file mode 100644 index 00000000000..a7fea3d3dc1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/grid.mdx @@ -0,0 +1,192 @@ +--- +title: Grid +sidebar_label: Grid +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Grid + +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. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + +
col-12
+ + +
col-12
+ + +
col-8
+ + +
col-8
+ + +
col-8
+ + + ); +} +``` + +## Responsive Grid + +```tsx live +function ResponsiveGrid() { + return ( + + +
+ Responsive +
+ + +
+ Responsive +
+ + +
+ Responsive +
+ + +
+ Responsive +
+ + + ); +} +``` + +## Alignment + +```tsx live +function AlignmentDemo() { + const boxStyle = { background: '#e6f4ff', padding: '16px 0', border: '1px solid #91caff', textAlign: 'center' }; + return ( +
+ +
start
+
start
+ + +
center
+
center
+ + +
end
+
end
+ + +
between
+
between
+ +
+ ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `align` | `string` | `"top"` | Vertical alignment of columns within the row. | +| `justify` | `string` | `"start"` | Horizontal distribution of columns within the row. | +| `wrap` | `boolean` | `true` | Whether columns are allowed to wrap to the next line. | +| `gutter` | `number` | `16` | Spacing between columns in pixels. | + +## Import + +```tsx +import { Grid } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Grid/Grid.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/index.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/index.mdx new file mode 100644 index 00000000000..2f4c4e30e84 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/index.mdx @@ -0,0 +1,38 @@ +--- +title: Layout Components +sidebar_label: Layout Components +sidebar_position: 1 +--- + + + +# Layout Components + +7 components available in this category. + +## Components + +- [DropdownContainer](./dropdowncontainer) +- [Flex](./flex) +- [Grid](./grid) +- [Layout](./layout) +- [MetadataBar](./metadatabar) +- [Space](./space) +- [Table](./table) diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/layout.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/layout.mdx new file mode 100644 index 00000000000..1b0d76e0ad1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/layout.mdx @@ -0,0 +1,139 @@ +--- +title: Layout +sidebar_label: Layout +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Layout + +Ant Design Layout component with configurable Sider, Header, Footer, and Content. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + +
Sidebar
+ + + + Header + + + Content + + + Footer + + + + ); +} +``` + +## Content Only + +```tsx live +function ContentOnly() { + return ( + + + Application Header + + + Main content area without a sidebar + + + Footer Content + + + ); +} +``` + +## Right Sidebar + +```tsx live +function RightSidebar() { + return ( + + + + Header + + + Content with right sidebar + + + +
Right Sidebar
+ + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `hasSider` | `boolean` | `false` | Whether the layout contains a Sider sub-component. | +| `style` | `any` | `{"minHeight":200}` | - | + +## Import + +```tsx +import { Layout } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Layout/Layout.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/metadatabar.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/metadatabar.mdx new file mode 100644 index 00000000000..2f667cfae4e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/metadatabar.mdx @@ -0,0 +1,174 @@ +--- +title: MetadataBar +sidebar_label: MetadataBar +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# MetadataBar + +MetadataBar displays a row of metadata items (SQL info, owners, last modified, tags, dashboards, etc.) that collapse responsively based on available width. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + const items = [ + { type: 'sql', title: 'Click to view query' }, + { + type: 'owner', + createdBy: 'Jane Smith', + owners: ['John Doe', 'Mary Wilson'], + createdOn: 'a week ago', + }, + { + type: 'lastModified', + value: 'a week ago', + modifiedBy: 'Jane Smith', + }, + { type: 'tags', values: ['management', 'research', 'poc'] }, + ]; + return ; +} +``` + +## Minimal Metadata + +```tsx live +function MinimalMetadata() { + const items = [ + { type: 'owner', createdBy: 'Admin', owners: ['Admin'], createdOn: 'yesterday' }, + { type: 'lastModified', value: '2 hours ago', modifiedBy: 'Admin' }, + ]; + return ; +} +``` + +## Full Metadata + +```tsx live +function FullMetadata() { + const items = [ + { type: 'sql', title: 'SELECT * FROM ...' }, + { type: 'owner', createdBy: 'Jane Smith', owners: ['Jane Smith', 'John Doe', 'Bob Wilson'], createdOn: '2 weeks ago' }, + { type: 'lastModified', value: '3 days ago', modifiedBy: 'John Doe' }, + { type: 'tags', values: ['production', 'finance', 'quarterly'] }, + { type: 'dashboards', title: 'Used in 12 dashboards' }, + { type: 'description', value: 'This chart shows quarterly revenue breakdown by region and product line.' }, + { type: 'rows', title: '1.2M rows' }, + { type: 'table', title: 'public.revenue_data' }, + ]; + return ; +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `title` | `string` | `"Added to 3 dashboards"` | - | +| `createdBy` | `string` | `"Jane Smith"` | - | +| `modifiedBy` | `string` | `"Jane Smith"` | - | +| `description` | `string` | `"To preview the list of dashboards go to More settings."` | - | +| `items` | `any` | `[{"type":"sql","title":"Click to view query"},{"type":"owner","createdBy":"Jane Smith","owners":["John Doe","Mary Wilson"],"createdOn":"a week ago"},{"type":"lastModified","value":"a week ago","modifiedBy":"Jane Smith"},{"type":"tags","values":["management","research","poc"]},{"type":"dashboards","title":"Added to 3 dashboards","description":"To preview the list of dashboards go to More settings."}]` | - | + +## Import + +```tsx +import { MetadataBar } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/MetadataBar/MetadataBar.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/space.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/space.mdx new file mode 100644 index 00000000000..264667a9fb0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/space.mdx @@ -0,0 +1,168 @@ +--- +title: Space +sidebar_label: Space +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Space + +The Space component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + {['Item 1', 'Item 2', 'Item 3', 'Item 4', 'Item 5'].map(item => ( +
+ {item} +
+ ))} + + ); +} +``` + +## Vertical Space + +```tsx live +function VerticalSpace() { + return ( + + + + + + ); +} +``` + +## Space Sizes + +```tsx live +function SpaceSizes() { + const items = ['Item 1', 'Item 2', 'Item 3']; + const itemStyle = { + padding: '8px 16px', + background: '#e6f4ff', + border: '1px solid #91caff', + borderRadius: 4, + }; + return ( +
+ {['small', 'middle', 'large'].map(size => ( +
+

{size}

+ + {items.map(item => ( +
{item}
+ ))} + +
+ ))} +
+ ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `direction` | `string` | `"horizontal"` | - | +| `size` | `string` | `"small"` | - | +| `wrap` | `boolean` | `false` | - | + +## Import + +```tsx +import { Space } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Space/Space.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/table.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/table.mdx new file mode 100644 index 00000000000..db0be495173 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/table.mdx @@ -0,0 +1,311 @@ +--- +title: Table +sidebar_label: Table +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Table + +A data table component with sorting, pagination, row selection, resizable columns, reorderable columns, and virtualization for large datasets. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + const data = [ + { key: 1, name: 'PostgreSQL', type: 'Database', status: 'Active' }, + { key: 2, name: 'MySQL', type: 'Database', status: 'Active' }, + { key: 3, name: 'SQLite', type: 'Database', status: 'Inactive' }, + { key: 4, name: 'Presto', type: 'Query Engine', status: 'Active' }, + ]; + const columns = [ + { title: 'Name', dataIndex: 'name', key: 'name', width: 150 }, + { title: 'Type', dataIndex: 'type', key: 'type' }, + { title: 'Status', dataIndex: 'status', key: 'status', width: 100 }, + ]; + return ; +} +``` + +## With Pagination + +```tsx live +function PaginatedTable() { + const data = Array.from({ length: 20 }, (_, i) => ({ + key: i, + name: 'Record ' + (i + 1), + value: Math.round(Math.random() * 1000), + category: ['A', 'B', 'C'][i % 3], + })); + const columns = [ + { title: 'Name', dataIndex: 'name', key: 'name' }, + { title: 'Value', dataIndex: 'value', key: 'value', width: 100 }, + { title: 'Category', dataIndex: 'category', key: 'category', width: 100 }, + ]; + return ( +
+ ); +} +``` + +## Loading State + +```tsx live +function LoadingTable() { + const columns = [ + { title: 'Name', dataIndex: 'name', key: 'name' }, + { title: 'Status', dataIndex: 'status', key: 'status' }, + ]; + return
; +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `size` | `string` | `"small"` | Table size. | +| `bordered` | `boolean` | `false` | Whether to show all table borders. | +| `loading` | `boolean` | `false` | Whether the table is in a loading state. | +| `sticky` | `boolean` | `true` | Whether the table header is sticky. | +| `resizable` | `boolean` | `false` | Whether columns can be resized by dragging column edges. | +| `reorderable` | `boolean` | `false` | EXPERIMENTAL: Whether columns can be reordered by dragging. May not work in all contexts. | +| `usePagination` | `boolean` | `false` | Whether to enable pagination. When enabled, the table displays 5 rows per page. | +| `key` | `number` | `5` | - | +| `name` | `string` | `"1GB USB Flash Drive"` | - | +| `category` | `string` | `"Portable Storage"` | - | +| `price` | `number` | `9.99` | - | +| `height` | `number` | `350` | - | +| `defaultPageSize` | `number` | `5` | - | +| `pageSizeOptions` | `any` | `["5","10"]` | - | +| `data` | `any` | `[{"key":1,"name":"Floppy Disk 10 pack","category":"Disk Storage","price":9.99},{"key":2,"name":"DVD 100 pack","category":"Optical Storage","price":27.99},{"key":3,"name":"128 GB SSD","category":"Harddrive","price":49.99},{"key":4,"name":"4GB 144mhz","category":"Memory","price":19.99},{"key":5,"name":"1GB USB Flash Drive","category":"Portable Storage","price":9.99},{"key":6,"name":"256 GB SSD","category":"Harddrive","price":89.99},{"key":7,"name":"1 TB SSD","category":"Harddrive","price":349.99},{"key":8,"name":"16 GB DDR4","category":"Memory","price":59.99},{"key":9,"name":"32 GB DDR5","category":"Memory","price":129.99},{"key":10,"name":"Blu-ray 50 pack","category":"Optical Storage","price":34.99},{"key":11,"name":"64 GB USB Drive","category":"Portable Storage","price":14.99},{"key":12,"name":"2 TB HDD","category":"Harddrive","price":59.99}]` | - | +| `columns` | `any` | `[{"title":"Name","dataIndex":"name","key":"name","width":200},{"title":"Category","dataIndex":"category","key":"category","width":150},{"title":"Price","dataIndex":"price","key":"price","width":100}]` | - | + +## Import + +```tsx +import { Table } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Table/Table.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/extension/alert.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/extension/alert.mdx new file mode 100644 index 00000000000..45a42c100d0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/extension/alert.mdx @@ -0,0 +1,119 @@ +--- +title: Alert +sidebar_label: Alert +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Alert + +Alert component for displaying important messages to users. Wraps Ant Design Alert with sensible defaults and improved accessibility. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `closable` | `boolean` | `true` | Whether the Alert can be closed with a close button. | +| `type` | `string` | `"info"` | Type of the alert (e.g., info, error, warning, success). | +| `message` | `string` | `"This is a sample alert message."` | - | +| `description` | `string` | `"Sample description for additional context."` | - | +| `showIcon` | `boolean` | `true` | Whether to display an icon in the Alert. | + +## Import + +```tsx +import { Alert } from 'packages/superset-core/src/ui/components/Alert'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-core/src/ui/components/Alert/Alert.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/extension/index.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/extension/index.mdx new file mode 100644 index 00000000000..a53c6980047 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/extension/index.mdx @@ -0,0 +1,32 @@ +--- +title: Extension Components +sidebar_label: Extension Components +sidebar_position: 1 +--- + + + +# Extension Components + +1 components available in this category. + +## Components + +- [Alert](./alert) diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/index.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/index.mdx new file mode 100644 index 00000000000..270e24163c4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/index.mdx @@ -0,0 +1,70 @@ +--- +title: UI Components Overview +sidebar_label: Overview +sidebar_position: 0 +--- + + + +import { ComponentIndex } from '@site/src/components/ui-components'; +import componentData from '@site/static/data/components.json'; + +# UI Components + + + +--- + +## Design System + +A design system is a complete set of standards intended to manage design at scale using reusable components and patterns. + +The Superset Design System uses [Atomic Design](https://bradfrost.com/blog/post/atomic-web-design/) principles with adapted terminology: + +| Atomic Design | Atoms | Molecules | Organisms | Templates | Pages / Screens | +|---|:---:|:---:|:---:|:---:|:---:| +| **Superset Design** | Foundations | Components | Patterns | Templates | Features | + +Atoms = Foundations, Molecules = Components, Organisms = Patterns, Templates = Templates, Pages / Screens = Features + +## Usage + +All components are exported from `@superset-ui/core/components`: + +```tsx +import { Button, Modal, Select } from '@superset-ui/core/components'; +``` + +## Contributing + +This documentation is auto-generated from Storybook stories. To add or update component documentation: + +1. Create or update the component's `.stories.tsx` file +2. Add a descriptive `title` and `description` in the story meta +3. Export an interactive story with `args` for configurable props +4. Run `yarn generate:superset-components` in the `docs/` directory + +:::info Work in Progress +This component library is actively being documented. See the [Components TODO](./TODO) page for a list of components awaiting documentation. +::: + +--- + +*Auto-generated from Storybook stories in the [Design System/Introduction](https://github.com/apache/superset/blob/master/superset-frontend/packages/superset-ui-core/src/components/DesignSystem.stories.tsx) story.* diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/autocomplete.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/autocomplete.mdx new file mode 100644 index 00000000000..789883dbb4c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/autocomplete.mdx @@ -0,0 +1,215 @@ +--- +title: AutoComplete +sidebar_label: AutoComplete +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# AutoComplete + +AutoComplete component for search functionality. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `placeholder` | `string` | `"Type to search..."` | Placeholder text for AutoComplete | +| `options` | `any` | `[{"value":"Dashboard","label":"Dashboard"},{"value":"Chart","label":"Chart"},{"value":"Dataset","label":"Dataset"},{"value":"Database","label":"Database"},{"value":"Query","label":"Query"}]` | The dropdown options | +| `style` | `any` | `{"width":300}` | Custom styles for AutoComplete | +| `filterOption` | `boolean` | `true` | Enable filtering of options based on input | + +## Import + +```tsx +import { AutoComplete } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/AutoComplete/AutoComplete.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/avatar.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/avatar.mdx new file mode 100644 index 00000000000..b2b7458cd4b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/avatar.mdx @@ -0,0 +1,140 @@ +--- +title: Avatar +sidebar_label: Avatar +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Avatar + +The Avatar component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + AB + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `children` | `string` | `"AB"` | Text or initials to display inside the avatar. | +| `alt` | `string` | `""` | - | +| `gap` | `number` | `4` | Letter spacing inside the avatar. | +| `shape` | `string` | `"circle"` | The shape of the avatar. | +| `size` | `string` | `"default"` | The size of the avatar. | +| `src` | `string` | `""` | Image URL for the avatar. If provided, overrides children. | +| `draggable` | `boolean` | `false` | - | + +## Import + +```tsx +import { Avatar } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Avatar/Avatar.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/badge.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/badge.mdx new file mode 100644 index 00000000000..69531a428b1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/badge.mdx @@ -0,0 +1,160 @@ +--- +title: Badge +sidebar_label: Badge +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Badge + +The Badge component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Status Badge + +```tsx live +function StatusBadgeDemo() { + const statuses = ['default', 'success', 'processing', 'warning', 'error']; + return ( +
+ {statuses.map(status => ( + + ))} +
+ ); +} +``` + +## Color Gallery + +```tsx live +function ColorGallery() { + const colors = ['pink', 'red', 'orange', 'green', 'cyan', 'blue', 'purple']; + return ( +
+ {colors.map(color => ( + + ))} +
+ ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `count` | `number` | `5` | Number to show in the badge. | +| `size` | `string` | `"default"` | Size of the badge. | +| `showZero` | `boolean` | `false` | Whether to show badge when count is zero. | +| `overflowCount` | `number` | `99` | Max count to show. Shows count+ when exceeded (e.g., 99+). | + +## Import + +```tsx +import { Badge } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Badge/Badge.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/breadcrumb.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/breadcrumb.mdx new file mode 100644 index 00000000000..5591b2e089f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/breadcrumb.mdx @@ -0,0 +1,93 @@ +--- +title: Breadcrumb +sidebar_label: Breadcrumb +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Breadcrumb + +Breadcrumb component for displaying navigation paths. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + + + +## Import + +```tsx +import { Breadcrumb } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Breadcrumb/Breadcrumb.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/button.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/button.mdx new file mode 100644 index 00000000000..0b704f4b666 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/button.mdx @@ -0,0 +1,142 @@ +--- +title: Button +sidebar_label: Button +--- + + + +import { StoryWithControls, ComponentGallery } from '../../../src/components/StorybookWrapper'; + +# Button + +The Button component from Superset's UI library. + +## All Variants + + + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `buttonStyle` | `string` | `"primary"` | The style variant of the button. | +| `buttonSize` | `string` | `"default"` | The size of the button. | +| `children` | `string` | `"Button!"` | The button text or content. | + +## Import + +```tsx +import { Button } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Button/Button.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/buttongroup.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/buttongroup.mdx new file mode 100644 index 00000000000..233993c4d19 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/buttongroup.mdx @@ -0,0 +1,88 @@ +--- +title: ButtonGroup +sidebar_label: ButtonGroup +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# ButtonGroup + +ButtonGroup is a container that groups multiple Button components together with consistent spacing and styling. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + + + + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `expand` | `boolean` | `false` | When true, buttons expand to fill available width. | + +## Import + +```tsx +import { ButtonGroup } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/ButtonGroup/ButtonGroup.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/cachedlabel.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/cachedlabel.mdx new file mode 100644 index 00000000000..7f115914456 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/cachedlabel.mdx @@ -0,0 +1,79 @@ +--- +title: CachedLabel +sidebar_label: CachedLabel +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# CachedLabel + +The CachedLabel component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + + + +## Import + +```tsx +import { CachedLabel } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/CachedLabel/CachedLabel.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/card.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/card.mdx new file mode 100644 index 00000000000..50bf93dbf6e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/card.mdx @@ -0,0 +1,142 @@ +--- +title: Card +sidebar_label: Card +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Card + +A container component for grouping related content. Supports titles, borders, loading states, and hover effects. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + This card displays a summary of your dashboard metrics and recent activity. + + ); +} +``` + +## Card States + +```tsx live +function CardStates() { + return ( +
+ + Default card content. + + + Hover over this card. + + + This content is hidden while loading. + + + Borderless card. + +
+ ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `padded` | `boolean` | `true` | Whether the card content has padding. | +| `title` | `string` | `"Dashboard Overview"` | Title text displayed at the top of the card. | +| `children` | `string` | `"This card displays a summary of your dashboard metrics and recent activity."` | The content inside the card. | +| `bordered` | `boolean` | `true` | Whether to show a border around the card. | +| `loading` | `boolean` | `false` | Whether to show a loading skeleton. | +| `hoverable` | `boolean` | `false` | Whether the card lifts on hover. | + +## Import + +```tsx +import { Card } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Card/Card.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/checkbox.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/checkbox.mdx new file mode 100644 index 00000000000..13709c36130 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/checkbox.mdx @@ -0,0 +1,141 @@ +--- +title: Checkbox +sidebar_label: Checkbox +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Checkbox + +Checkbox component that supports both regular and indeterminate states, built on top of Ant Design v5 Checkbox. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## All Checkbox States + +```tsx live +function AllStates() { + return ( +
+ Unchecked + Checked + Indeterminate + Disabled unchecked + Disabled checked +
+ ); +} +``` + +## Select All Pattern + +```tsx live +function SelectAllDemo() { + const [selected, setSelected] = React.useState([]); + const options = ['Option A', 'Option B', 'Option C']; + + const allSelected = selected.length === options.length; + const indeterminate = selected.length > 0 && !allSelected; + + return ( +
+ setSelected(e.target.checked ? [...options] : [])} + > + Select All + +
+ {options.map(opt => ( +
+ setSelected(prev => + prev.includes(opt) ? prev.filter(x => x !== opt) : [...prev, opt] + )} + > + {opt} + +
+ ))} +
+
+ ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `checked` | `boolean` | `false` | Whether the checkbox is checked. | +| `indeterminate` | `boolean` | `false` | Whether the checkbox is in indeterminate state (partially selected). | + +## Import + +```tsx +import { Checkbox } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Checkbox/Checkbox.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/collapse.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/collapse.mdx new file mode 100644 index 00000000000..4e35c7b4353 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/collapse.mdx @@ -0,0 +1,106 @@ +--- +title: Collapse +sidebar_label: Collapse +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Collapse + +The Collapse component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `ghost` | `boolean` | `false` | - | +| `bordered` | `boolean` | `true` | - | +| `accordion` | `boolean` | `false` | - | +| `animateArrows` | `boolean` | `false` | - | +| `modalMode` | `boolean` | `false` | - | + +## Import + +```tsx +import { Collapse } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Collapse/Collapse.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/datepicker.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/datepicker.mdx new file mode 100644 index 00000000000..4fc45cb6ecb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/datepicker.mdx @@ -0,0 +1,110 @@ +--- +title: DatePicker +sidebar_label: DatePicker +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# DatePicker + +The DatePicker component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `placeholder` | `string` | `"Select date"` | - | +| `showNow` | `boolean` | `true` | Show "Now" button to select current date and time. | +| `allowClear` | `boolean` | `false` | - | +| `autoFocus` | `boolean` | `true` | - | +| `disabled` | `boolean` | `false` | - | +| `format` | `string` | `"YYYY-MM-DD hh:mm a"` | - | +| `inputReadOnly` | `boolean` | `false` | - | +| `picker` | `string` | `"date"` | - | +| `placement` | `string` | `"bottomLeft"` | - | +| `size` | `string` | `"middle"` | - | +| `showTime` | `any` | `{"format":"hh:mm a","needConfirm":false}` | - | + +## Import + +```tsx +import { DatePicker } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/DatePicker/DatePicker.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/divider.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/divider.mdx new file mode 100644 index 00000000000..0ea8c54bb6e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/divider.mdx @@ -0,0 +1,144 @@ +--- +title: Divider +sidebar_label: Divider +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Divider + +The Divider component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + <> +

Horizontal divider with title (orientationMargin applies here):

+ Left Title + Right Title + Center Title +

Vertical divider (use container gap for spacing):

+
+ Link + + Link + + Link +
+ + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `dashed` | `boolean` | `false` | Whether line is dashed (deprecated, use variant). | +| `variant` | `string` | `"solid"` | Line style of the divider. | +| `orientation` | `string` | `"center"` | Position of title inside divider. | +| `orientationMargin` | `string` | `""` | Margin from divider edge to title. | +| `plain` | `boolean` | `true` | Use plain style without bold title. | +| `type` | `string` | `"horizontal"` | Direction of the divider. | + +## Import + +```tsx +import { Divider } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Divider/Divider.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/editabletitle.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/editabletitle.mdx new file mode 100644 index 00000000000..bea676b0401 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/editabletitle.mdx @@ -0,0 +1,172 @@ +--- +title: EditableTitle +sidebar_label: EditableTitle +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# EditableTitle + +The EditableTitle component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + console.log('Saved:', newTitle)} + /> + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `canEdit` | `boolean` | `true` | Whether the title can be edited. | +| `editing` | `boolean` | `false` | Whether the title is currently in edit mode. | +| `emptyText` | `string` | `"Empty text"` | Text to display when title is empty. | +| `noPermitTooltip` | `string` | `"Not permitted"` | Tooltip shown when user lacks edit permission. | +| `showTooltip` | `boolean` | `true` | Whether to show tooltip on hover. | +| `title` | `string` | `"Title"` | The title text to display. | +| `defaultTitle` | `string` | `"Default title"` | Default title when none is provided. | +| `placeholder` | `string` | `"Placeholder"` | Placeholder text when editing. | +| `certifiedBy` | `string` | `""` | Name of person/team who certified this item. | +| `certificationDetails` | `string` | `""` | Additional certification details or description. | +| `maxWidth` | `number` | `100` | Maximum width of the title in pixels. | +| `autoSize` | `boolean` | `true` | Whether to auto-size based on content. | + +## Import + +```tsx +import { EditableTitle } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/EditableTitle/EditableTitle.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/emptystate.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/emptystate.mdx new file mode 100644 index 00000000000..b0e8171c16d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/emptystate.mdx @@ -0,0 +1,147 @@ +--- +title: EmptyState +sidebar_label: EmptyState +--- + + + +import { StoryWithControls, ComponentGallery } from '../../../src/components/StorybookWrapper'; + +# EmptyState + +The EmptyState component from Superset's UI library. + +## All Variants + + + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + alert('Filters cleared!')} + /> + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `size` | `string` | `"medium"` | Size of the empty state component. | +| `title` | `string` | `"No Data Available"` | Main title text. | +| `description` | `string` | `"There is no data to display at this time."` | Description text below the title. | +| `image` | `string` | `"empty.svg"` | Predefined image to display. | +| `buttonText` | `string` | `""` | Text for optional action button. | + +## Import + +```tsx +import { EmptyState } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/EmptyState/EmptyState.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/favestar.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/favestar.mdx new file mode 100644 index 00000000000..adb610620d8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/favestar.mdx @@ -0,0 +1,96 @@ +--- +title: FaveStar +sidebar_label: FaveStar +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# FaveStar + +FaveStar component for marking items as favorites + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `itemId` | `number` | `1` | Unique identifier for the item | +| `isStarred` | `boolean` | `false` | Whether the item is currently starred. | +| `showTooltip` | `boolean` | `true` | Show tooltip on hover. | + +## Import + +```tsx +import { FaveStar } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/FaveStar/FaveStar.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/iconbutton.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/iconbutton.mdx new file mode 100644 index 00000000000..5cfc6e90f55 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/iconbutton.mdx @@ -0,0 +1,106 @@ +--- +title: IconButton +sidebar_label: IconButton +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# IconButton + +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. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `buttonText` | `string` | `"IconButton"` | The text inside the button. | +| `altText` | `string` | `"Icon button alt text"` | The alt text for the button. If not provided, the button text is used as the alt text by default. | +| `padded` | `boolean` | `true` | Add padding between icon and button text. | +| `icon` | `string` | `"https://superset.apache.org/img/superset-logo-horiz.svg"` | Icon inside the button (URL or path). | + +## Import + +```tsx +import { IconButton } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/IconButton/IconButton.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icons.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icons.mdx new file mode 100644 index 00000000000..ac90f06c7e7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icons.mdx @@ -0,0 +1,252 @@ +--- +title: Icons +sidebar_label: Icons +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Icons + +Icon library for Apache Superset. Contains over 200 icons based on Ant Design icons with consistent sizing and theming support. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( +
+ + + + +
+ ); +} +``` + +## Icon Sizes + +```tsx live +function IconSizes() { + const sizes = ['s', 'm', 'l', 'xl', 'xxl']; + return ( +
+ {sizes.map(size => ( +
+ +
{size}
+
+ ))} +
+ ); +} +``` + +## Icon Gallery + +```tsx live +function IconGallery() { + const Section = ({ title, children }) => ( +
+
{title}
+
{children}
+
+ ); + return ( +
+
+ + + + + + +
+
+ + + + + + + + +
+
+ + + + + + + + + + + + + + +
+
+ + + + + + + + + + +
+
+ + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
+
+ + + + +
+
+ + + + + + + + +
+
+ ); +} +``` + +## Icon with Text + +```tsx live +function IconWithText() { + return ( +
+
+ + Success message +
+
+ + Information message +
+
+ + Warning message +
+
+ + Error message +
+
+ ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `iconSize` | `string` | `"xl"` | Size of the icons: s (12px), m (16px), l (20px), xl (24px), xxl (32px). | + +## Import + +```tsx +import { Icons } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Icons/Icons.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icontooltip.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icontooltip.mdx new file mode 100644 index 00000000000..4d1fdde8699 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icontooltip.mdx @@ -0,0 +1,100 @@ +--- +title: IconTooltip +sidebar_label: IconTooltip +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# IconTooltip + +The IconTooltip component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `tooltip` | `string` | `"Tooltip"` | Text content to display in the tooltip. | + +## Import + +```tsx +import { IconTooltip } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/IconTooltip/IconTooltip.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/index.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/index.mdx new file mode 100644 index 00000000000..2a0d1aa8d41 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/index.mdx @@ -0,0 +1,77 @@ +--- +title: Core Components +sidebar_label: Core Components +sidebar_position: 1 +--- + + + +# Core Components + +46 components available in this category. + +## Components + +- [AutoComplete](./autocomplete) +- [Avatar](./avatar) +- [Badge](./badge) +- [Breadcrumb](./breadcrumb) +- [Button](./button) +- [ButtonGroup](./buttongroup) +- [CachedLabel](./cachedlabel) +- [Card](./card) +- [Checkbox](./checkbox) +- [Collapse](./collapse) +- [DatePicker](./datepicker) +- [Divider](./divider) +- [EditableTitle](./editabletitle) +- [EmptyState](./emptystate) +- [FaveStar](./favestar) +- [IconButton](./iconbutton) +- [Icons](./icons) +- [IconTooltip](./icontooltip) +- [InfoTooltip](./infotooltip) +- [Input](./input) +- [Label](./label) +- [List](./list) +- [ListViewCard](./listviewcard) +- [Loading](./loading) +- [Menu](./menu) +- [Modal](./modal) +- [ModalTrigger](./modaltrigger) +- [Popover](./popover) +- [ProgressBar](./progressbar) +- [Radio](./radio) +- [SafeMarkdown](./safemarkdown) +- [Select](./select) +- [Skeleton](./skeleton) +- [Slider](./slider) +- [Steps](./steps) +- [Switch](./switch) +- [TableCollection](./tablecollection) +- [TableView](./tableview) +- [Tabs](./tabs) +- [Timer](./timer) +- [Tooltip](./tooltip) +- [Tree](./tree) +- [TreeSelect](./treeselect) +- [Typography](./typography) +- [UnsavedChangesModal](./unsavedchangesmodal) +- [Upload](./upload) diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/infotooltip.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/infotooltip.mdx new file mode 100644 index 00000000000..42e6341ea90 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/infotooltip.mdx @@ -0,0 +1,106 @@ +--- +title: InfoTooltip +sidebar_label: InfoTooltip +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# InfoTooltip + +The InfoTooltip component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `tooltip` | `string` | `"This is the text that will display!"` | - | + +## Import + +```tsx +import { InfoTooltip } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/InfoTooltip/InfoTooltip.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/input.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/input.mdx new file mode 100644 index 00000000000..2bc8706fe63 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/input.mdx @@ -0,0 +1,162 @@ +--- +title: Input +sidebar_label: Input +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Input + +The Input component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `allowClear` | `boolean` | `false` | - | +| `disabled` | `boolean` | `false` | - | +| `showCount` | `boolean` | `false` | - | +| `type` | `string` | `"text"` | HTML input type | +| `variant` | `string` | `"outlined"` | Input style variant | + +## Import + +```tsx +import { Input } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Input/Input.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/label.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/label.mdx new file mode 100644 index 00000000000..816d449770f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/label.mdx @@ -0,0 +1,105 @@ +--- +title: Label +sidebar_label: Label +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Label + +The Label component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `type` | `string` | `"default"` | The visual style of the label. | +| `children` | `string` | `"Label text"` | The label text content. | +| `monospace` | `boolean` | `false` | Use monospace font. | + +## Import + +```tsx +import { Label } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Label/Label.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/list.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/list.mdx new file mode 100644 index 00000000000..06a3b028965 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/list.mdx @@ -0,0 +1,117 @@ +--- +title: List +sidebar_label: List +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# List + +The List component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + const data = ['Dashboard Analytics', 'User Management', 'Data Sources']; + return ( + {item}} + /> + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `bordered` | `boolean` | `false` | Whether to show a border around the list. | +| `split` | `boolean` | `true` | Whether to show a divider between items. | +| `size` | `string` | `"default"` | Size of the list. | +| `loading` | `boolean` | `false` | Whether to show a loading indicator. | +| `dataSource` | `any` | `["Dashboard Analytics","User Management","Data Sources"]` | - | + +## Import + +```tsx +import { List } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/List/List.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/listviewcard.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/listviewcard.mdx new file mode 100644 index 00000000000..63af1c14f34 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/listviewcard.mdx @@ -0,0 +1,132 @@ +--- +title: ListViewCard +sidebar_label: ListViewCard +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# ListViewCard + +ListViewCard is a card component used to display items in list views with an image, title, description, and optional cover sections. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `title` | `string` | `"Superset Card Title"` | Title displayed on the card. | +| `loading` | `boolean` | `false` | Whether the card is in loading state. | +| `url` | `string` | `"/superset/dashboard/births/"` | URL the card links to. | +| `imgURL` | `string` | `"https://picsum.photos/seed/superset/300/200"` | Primary image URL for the card. | +| `description` | `string` | `"Lorem ipsum dolor sit amet, consectetur adipiscing elit..."` | Description text displayed on the card. | +| `coverLeft` | `string` | `"Left Section"` | Content for the left section of the cover. | +| `coverRight` | `string` | `"Right Section"` | Content for the right section of the cover. | + +## Import + +```tsx +import { ListViewCard } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/ListViewCard/ListViewCard.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/loading.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/loading.mdx new file mode 100644 index 00000000000..0326c19e90a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/loading.mdx @@ -0,0 +1,187 @@ +--- +title: Loading +sidebar_label: Loading +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Loading + +The Loading component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( +
+ {['normal', 'floating', 'inline'].map(position => ( +
+

{position}

+ +
+ ))} +
+ ); +} +``` + +## Size and Opacity Showcase + +```tsx live +function SizeShowcase() { + const sizes = ['s', 'm', 'l']; + return ( +
+
+
Size
+
Normal
+
Muted
+
Usage
+ {sizes.map(size => ( + +
+ {size.toUpperCase()} ({size === 's' ? '40px' : size === 'm' ? '70px' : '100px'}) +
+
+ +
+
+ +
+
+ {size === 's' && 'Filter bars, inline'} + {size === 'm' && 'Explore pages'} + {size === 'l' && 'Full page loading'} +
+ + ))} +
+
+ ); +} +``` + +## Contextual Examples + +```tsx live +function ContextualDemo() { + return ( +
+

Filter Bar (size="s", muted)

+
+ Filter 1: + + Filter 2: + +
+ +

Dashboard Grid (size="s", muted)

+
+ {[1, 2, 3].map(i => ( +
+ +
+ ))} +
+ +

Main Loading (size="l")

+
+ +
+
+ ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `size` | `string` | `"m"` | Size of the spinner: s (40px), m (70px), or l (100px). | +| `position` | `string` | `"normal"` | Position style: normal (inline flow), floating (overlay), or inline. | +| `muted` | `boolean` | `false` | Whether to show a muted/subtle version of the spinner. | + +## Import + +```tsx +import { Loading } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Loading/Loading.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/menu.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/menu.mdx new file mode 100644 index 00000000000..c088eb538c7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/menu.mdx @@ -0,0 +1,174 @@ +--- +title: Menu +sidebar_label: Menu +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Menu + +Navigation menu component supporting horizontal, vertical, and inline modes. Based on Ant Design Menu with Superset styling. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Vertical Menu + +```tsx live +function VerticalMenu() { + return ( + + ); +} +``` + +## Menu with Icons + +```tsx live +function MenuWithIcons() { + return ( + Dashboards, key: 'dashboards' }, + { label: <> Charts, key: 'charts' }, + { label: <> Datasets, key: 'datasets' }, + { label: <> SQL Lab, key: 'sqllab' }, + ]} + /> + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `mode` | `string` | `"horizontal"` | Menu display mode: horizontal navbar, vertical sidebar, or inline collapsible. | +| `selectable` | `boolean` | `true` | Whether menu items can be selected. | +| `items` | `any` | `[{"label":"Dashboards","key":"dashboards"},{"label":"Charts","key":"charts"},{"label":"Datasets","key":"datasets"},{"label":"SQL Lab","key":"sqllab"}]` | - | + +## Import + +```tsx +import { Menu } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Menu/Menu.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modal.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modal.mdx new file mode 100644 index 00000000000..d1ed9b48234 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modal.mdx @@ -0,0 +1,207 @@ +--- +title: Modal +sidebar_label: Modal +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Modal + +Modal dialog component for displaying content that requires user attention or interaction. Supports customizable buttons, drag/resize, and confirmation dialogs. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function ModalDemo() { + const [isOpen, setIsOpen] = React.useState(false); + return ( + <> + + setIsOpen(false)} + title="Example Modal" + primaryButtonName="Submit" + onHandledPrimaryAction={() => { + alert('Submitted!'); + setIsOpen(false); + }} + > +

This is the modal content. Click Submit or close the modal.

+ + + ); +} +``` + +## Danger Modal + +```tsx live +function DangerModal() { + const [isOpen, setIsOpen] = React.useState(false); + return ( + <> + + setIsOpen(false)} + title="Confirm Delete" + primaryButtonName="Delete" + primaryButtonStyle="danger" + onHandledPrimaryAction={() => { + alert('Deleted!'); + setIsOpen(false); + }} + > +

Are you sure you want to delete this item? This action cannot be undone.

+ + + ); +} +``` + +## Confirmation Dialogs + +```tsx live +function ConfirmationDialogs() { + return ( +
+ + + +
+ ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `disablePrimaryButton` | `boolean` | `false` | Whether the primary button is disabled. | +| `primaryButtonName` | `string` | `"Submit"` | Text for the primary action button. | +| `primaryButtonStyle` | `string` | `"primary"` | The style of the primary action button. | +| `show` | `boolean` | `false` | Whether the modal is visible. Use the "Try It" example below for a working demo. | +| `title` | `string` | `"I'm a modal!"` | Title displayed in the modal header. | +| `resizable` | `boolean` | `false` | Whether the modal can be resized by dragging corners. | +| `draggable` | `boolean` | `false` | Whether the modal can be dragged by its header. | +| `width` | `number` | `500` | Width of the modal in pixels. | + +## Import + +```tsx +import { Modal } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Modal/Modal.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modaltrigger.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modaltrigger.mdx new file mode 100644 index 00000000000..b9f5bd81b7d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modaltrigger.mdx @@ -0,0 +1,192 @@ +--- +title: ModalTrigger +sidebar_label: ModalTrigger +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# ModalTrigger + +A component that renders a trigger element which opens a modal when clicked. Useful for actions that need confirmation or additional input. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + Click to Open} + modalTitle="Example Modal" + modalBody={

This is the modal content. You can put any React elements here.

} + width="500px" + responsive + /> + ); +} +``` + +## With Custom Trigger + +```tsx live +function CustomTrigger() { + return ( + + Add New Item + + } + modalTitle="Add New Item" + modalBody={ +
+

Fill out the form to add a new item.

+ +
+ } + width="400px" + /> + ); +} +``` + +## Draggable & Resizable + +```tsx live +function DraggableModal() { + return ( + Open Draggable Modal} + modalTitle="Draggable & Resizable" + modalBody={

Try dragging the header or resizing from the corners!

} + draggable + resizable + width="500px" + /> + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `isButton` | `boolean` | `true` | Whether to wrap the trigger in a button element. | +| `modalTitle` | `string` | `"Modal Title"` | Title displayed in the modal header. | +| `modalBody` | `string` | `"This is the modal body content."` | Content displayed in the modal body. | +| `tooltip` | `string` | `"Click to open modal"` | Tooltip text shown on hover over the trigger. | +| `width` | `string` | `"600px"` | Width of the modal (e.g., "600px", "80%"). | +| `maxWidth` | `string` | `"1000px"` | Maximum width of the modal. | +| `responsive` | `boolean` | `true` | Whether the modal should be responsive. | +| `draggable` | `boolean` | `false` | Whether the modal can be dragged by its header. | +| `resizable` | `boolean` | `false` | Whether the modal can be resized by dragging corners. | +| `triggerNode` | `string` | `"Click to Open Modal"` | The clickable element that opens the modal when clicked. | + +## Import + +```tsx +import { ModalTrigger } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/ModalTrigger/ModalTrigger.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/popover.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/popover.mdx new file mode 100644 index 00000000000..0a3ad4b2d10 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/popover.mdx @@ -0,0 +1,199 @@ +--- +title: Popover +sidebar_label: Popover +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Popover + +A floating card that appears when hovering or clicking a trigger element. Supports configurable placement, trigger behavior, and custom content. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + + + ); +} +``` + +## Click Trigger + +```tsx live +function ClickPopover() { + return ( + + + + ); +} +``` + +## Placements + +```tsx live +function PlacementsDemo() { + return ( +
+ {['top', 'right', 'bottom', 'left'].map(placement => ( + + + + ))} +
+ ); +} +``` + +## Rich Content + +```tsx live +function RichPopover() { + return ( + +

Created by: Admin

+

Last modified: Jan 2025

+

Charts: 12

+ + } + > + + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `content` | `string` | `"Popover sample content"` | Content displayed inside the popover body. | +| `title` | `string` | `"Popover title"` | Title displayed in the popover header. | +| `arrow` | `boolean` | `true` | Whether to show the popover's arrow pointing to the trigger. | +| `color` | `string` | `"#fff"` | The background color of the popover. | + +## Import + +```tsx +import { Popover } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Popover/Popover.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/progressbar.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/progressbar.mdx new file mode 100644 index 00000000000..4b68653ee11 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/progressbar.mdx @@ -0,0 +1,206 @@ +--- +title: ProgressBar +sidebar_label: ProgressBar +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# ProgressBar + +Progress bar component for displaying completion status. Supports line, circle, and dashboard display types. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## All Progress Types + +```tsx live +function AllTypesDemo() { + return ( +
+
+

Line

+ +
+
+

Circle

+ +
+
+

Dashboard

+ +
+
+ ); +} +``` + +## Status Variants + +```tsx live +function StatusDemo() { + const statuses = ['normal', 'success', 'exception', 'active']; + return ( +
+ {statuses.map(status => ( +
+ {status} + +
+ ))} +
+ ); +} +``` + +## Custom Colors + +```tsx live +function CustomColors() { + return ( +
+ + + + +
+ ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `percent` | `number` | `75` | Completion percentage (0-100). | +| `status` | `string` | `"normal"` | Current status of the progress bar. | +| `type` | `string` | `"line"` | Display type: line, circle, or dashboard gauge. | +| `striped` | `boolean` | `false` | Whether to show striped animation on the bar. | +| `showInfo` | `boolean` | `true` | Whether to show the percentage text. | +| `strokeLinecap` | `string` | `"round"` | Shape of the progress bar endpoints. | + +## Import + +```tsx +import { ProgressBar } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/ProgressBar/ProgressBar.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/radio.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/radio.mdx new file mode 100644 index 00000000000..69cdfcf2c06 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/radio.mdx @@ -0,0 +1,137 @@ +--- +title: Radio +sidebar_label: Radio +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Radio + +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. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + Radio + + ); +} +``` + +## Radio Button Variants + +```tsx live +function RadioButtonDemo() { + const [value, setValue] = React.useState('line'); + return ( + setValue(e.target.value)}> + Line Chart + Bar Chart + Pie Chart + + ); +} +``` + +## Vertical Radio Group + +```tsx live +function VerticalDemo() { + const [value, setValue] = React.useState('option1'); + return ( + setValue(e.target.value)}> +
+ First option + Second option + Third option +
+ + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `value` | `string` | `"radio1"` | The value associated with this radio button. | +| `disabled` | `boolean` | `false` | Whether the radio button is disabled. | +| `checked` | `boolean` | `false` | Whether the radio button is checked (controlled mode). | +| `children` | `string` | `"Radio"` | Label text displayed next to the radio button. | + +## Import + +```tsx +import { Radio } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Radio/Radio.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/safemarkdown.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/safemarkdown.mdx new file mode 100644 index 00000000000..8cb741b962c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/safemarkdown.mdx @@ -0,0 +1,85 @@ +--- +title: SafeMarkdown +sidebar_label: SafeMarkdown +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# SafeMarkdown + +The SafeMarkdown component from Superset's UI library. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( + + ); +} +``` + +## Props + +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `htmlSanitization` | `boolean` | `true` | Enable HTML sanitization (recommended for user input) | + +## Import + +```tsx +import { SafeMarkdown } from '@superset-ui/core/components'; +``` + +--- + +:::tip[Improve this page] +This documentation is auto-generated from the component's Storybook story. +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/SafeMarkdown/SafeMarkdown.stories.tsx). +::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/select.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/select.mdx new file mode 100644 index 00000000000..262196d4ccc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/select.mdx @@ -0,0 +1,308 @@ +--- +title: Select +sidebar_label: Select +--- + + + +import { StoryWithControls } from '../../../src/components/StorybookWrapper'; + +# Select + +A versatile select component supporting single and multi-select modes, search filtering, option creation, and both synchronous and asynchronous data sources. + +## Live Example + + + +## Try It + +Edit the code below to experiment with the component: + +```tsx live +function Demo() { + return ( +
+ +
+ ); +} +``` + +## Allow New Options + +```tsx live +function AllowNewDemo() { + return ( +
+ +
+ ); +} +``` + +## One Line Mode + +```tsx live +function OneLineDemo() { + return ( +
+
+ + + + + + + + +
+ +**I want to contribute code** +1. [Set up development environment](/developer-docs/contributing/development-setup) +2. [Find a good first issue](https://github.com/apache/superset/labels/good%20first%20issue) +3. [Submit your first PR](/developer-docs/contributing/submitting-pr) + + + +**I want to build an extension** +1. [Start with Quick Start](/developer-docs/extensions/quick-start) +2. [Learn extension development](/developer-docs/extensions/development) +3. [Explore architecture](/developer-docs/extensions/architecture) + +
+ +**I found a bug** +1. [Search existing issues](https://github.com/apache/superset/issues) +2. [Report the bug](/developer-docs/contributing/issue-reporting) +3. [Submit a fix](/developer-docs/contributing/submitting-pr) + + + +**I need help** +1. [Check the FAQ](https://superset.apache.org/docs/frequently-asked-questions) +2. [Ask in Slack](https://apache-superset.slack.com) +3. [Start a discussion](https://github.com/apache/superset/discussions) + +
+ +--- + +Welcome to the Apache Superset community! We're excited to have you contribute. diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/sidebars.js b/docs/developer_docs_versioned_docs/version-6.1.0/sidebars.js new file mode 100644 index 00000000000..7926d80cf61 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/sidebars.js @@ -0,0 +1,84 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +module.exports = { + developerPortalSidebar: [ + 'index', + { + type: 'category', + label: 'Contributing', + collapsed: true, + items: [ + 'contributing/overview', + 'guidelines/design-guidelines', + 'guidelines/frontend-style-guidelines', + 'guidelines/backend-style-guidelines', + ], + }, + { + type: 'category', + label: 'Extensions', + collapsed: true, + items: [ + 'extensions/overview', + 'extensions/quick-start', + 'extensions/architecture', + 'extensions/dependencies', + 'extensions/contribution-types', + { + type: 'category', + label: 'Extension Points', + collapsed: true, + items: [ + 'extensions/extension-points/sqllab', + ], + }, + 'extensions/development', + 'extensions/deployment', + 'extensions/mcp', + 'extensions/security', + 'extensions/tasks', + 'extensions/registry', + ], + }, + { + type: 'category', + label: 'Testing', + collapsed: true, + items: [ + 'testing/overview', + ], + }, + { + type: 'category', + label: 'UI Components', + collapsed: true, + link: { + type: 'doc', + id: 'components/index', + }, + items: [ + { + type: 'autogenerated', + dirName: 'components', + }, + ], + }, + ], +}; diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/testing/backend-testing.md b/docs/developer_docs_versioned_docs/version-6.1.0/testing/backend-testing.md new file mode 100644 index 00000000000..e8c8d229fcb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/testing/backend-testing.md @@ -0,0 +1,171 @@ +--- +title: Backend Testing +sidebar_position: 3 +--- + + + +# Backend Testing + +🚧 **Coming Soon** 🚧 + +Complete guide for testing Superset's Python backend, APIs, and database interactions. + +## Topics to be covered: + +- Pytest configuration and fixtures +- Unit testing best practices +- Integration testing with databases +- API endpoint testing +- Mocking strategies and patterns +- Testing async operations with Celery +- Security testing guidelines +- Performance and load testing +- Test database setup and teardown +- Coverage requirements + +## Quick Commands + +```bash +# Run all backend tests +pytest + +# Run specific test file +pytest tests/unit_tests/specific_test.py + +# Run with coverage +pytest --cov=superset + +# Run tests in parallel +pytest -n auto + +# Run only unit tests +pytest tests/unit_tests/ + +# Run only integration tests +pytest tests/integration_tests/ +``` + +## Testing Alerts & Reports with Celery and MailHog + +The Alerts & Reports feature relies on Celery for task scheduling and execution. To test it locally, you need Redis (message broker), Celery Beat (scheduler), a Celery Worker (executor), and an SMTP server to receive email notifications. + +### Prerequisites + +- Redis running on `localhost:6379` +- [MailHog](https://github.com/mailhog/MailHog) installed (a local SMTP server with a web UI for viewing caught emails) + +### superset_config.py + +Your `CeleryConfig` **must** include `beat_schedule`. When you define a custom `CeleryConfig` class in `superset_config.py`, it replaces the default entirely. If you omit `beat_schedule`, Celery Beat will start but never schedule any report tasks. + +```python +from celery.schedules import crontab +from superset.tasks.types import ExecutorType + +REDIS_HOST = "localhost" +REDIS_PORT = "6379" + +class CeleryConfig: + broker_url = f"redis://{REDIS_HOST}:{REDIS_PORT}/0" + result_backend = f"redis://{REDIS_HOST}:{REDIS_PORT}/0" + broker_connection_retry_on_startup = True + imports = ( + "superset.sql_lab", + "superset.tasks.scheduler", + "superset.tasks.thumbnails", + "superset.tasks.cache", + ) + worker_prefetch_multiplier = 10 + task_acks_late = True + beat_schedule = { + "reports.scheduler": { + "task": "reports.scheduler", + "schedule": crontab(minute="*", hour="*"), + }, + "reports.prune_log": { + "task": "reports.prune_log", + "schedule": crontab(minute=0, hour=0), + }, + } + +CELERY_CONFIG = CeleryConfig + +# SMTP settings pointing to MailHog +SMTP_HOST = "localhost" +SMTP_PORT = 1025 +SMTP_STARTTLS = False +SMTP_SSL = False +SMTP_USER = "" +SMTP_PASSWORD = "" +SMTP_MAIL_FROM = "superset@localhost" + +# Must match where your frontend is running +WEBDRIVER_BASEURL = "http://localhost:9000/" + +ALERT_REPORTS_EXECUTE_AS = [ExecutorType.OWNER] + +FEATURE_FLAGS = { + "ALERT_REPORTS": True, + # Recommended for better screenshot support (WebGL/DeckGL charts) + "PLAYWRIGHT_REPORTS_AND_THUMBNAILS": True, +} +``` + +:::note +Do not include `"superset.tasks.async_queries"` in `CeleryConfig.imports` unless you need Global Async Queries. That module accesses `current_app.config` at import time and will crash the worker with a "Working outside of application context" error. +::: + +### Starting the Services + +Start MailHog, then Celery Beat and Worker in separate terminals: + +```bash +# Terminal 1 - MailHog (SMTP on :1025, Web UI on :8025) +MailHog + +# Terminal 2 - Celery Beat (scheduler) +celery --app=superset.tasks.celery_app:app beat --loglevel=info + +# Terminal 3 - Celery Worker (executor) +celery --app=superset.tasks.celery_app:app worker --concurrency=1 --loglevel=info +``` + +Use `--concurrency=1` to limit resource usage on your dev machine. + +### Verifying the Setup + +1. **Beat** should log `Scheduler: Sending due task reports.scheduler (reports.scheduler)` once per minute +2. **Worker** should log `Scheduling alert eta: ` for each active report +3. Create a test report in **Settings > Alerts & Reports** with a `* * * * *` cron schedule +4. Check **http://localhost:8025** (MailHog web UI) for the email within 1-2 minutes + +### Troubleshooting + +| Problem | Solution | +|---|---| +| Beat shows no output | Ensure `beat_schedule` is defined in your `CeleryConfig` and `--loglevel=info` is set | +| "Report Schedule is still working, refusing to re-compute" | Previous executions are stuck. Reset with: `UPDATE report_schedule SET last_state = 'Not triggered' WHERE id = ;` | +| Task backlog overwhelming the worker | Flush Redis: `redis-cli FLUSHDB`, then restart Beat and Worker | +| Screenshot timeout | Ensure your frontend dev server is running and `WEBDRIVER_BASEURL` matches its URL | + +--- + +*This documentation is under active development. Check back soon for updates!* diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/testing/ci-cd.md b/docs/developer_docs_versioned_docs/version-6.1.0/testing/ci-cd.md new file mode 100644 index 00000000000..baefc13cbee --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/testing/ci-cd.md @@ -0,0 +1,70 @@ +--- +title: CI/CD and Automation +sidebar_position: 5 +--- + + + +# CI/CD and Automation + +🚧 **Coming Soon** 🚧 + +Understanding Superset's continuous integration and deployment pipelines. + +## Topics to be covered: + +- GitHub Actions workflows +- Pre-commit hooks configuration +- Automated testing pipelines +- Code quality checks (ESLint, Prettier, Black, MyPy) +- Security scanning (Dependabot, CodeQL) +- Docker image building and publishing +- Release automation +- Performance benchmarking +- Coverage reporting and tracking + +## Pre-commit Hooks + +```bash +# Install pre-commit hooks +pre-commit install + +# Run all hooks on staged files +pre-commit run + +# Run specific hook +pre-commit run mypy + +# Run on all files (not just staged) +pre-commit run --all-files +``` + +## GitHub Actions + +Key workflows: +- `test-frontend.yml` - Frontend tests +- `test-backend.yml` - Backend tests +- `docker.yml` - Docker image builds +- `codeql.yml` - Security analysis +- `release.yml` - Release automation + +--- + +*This documentation is under active development. Check back soon for updates!* diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/testing/e2e-testing.md b/docs/developer_docs_versioned_docs/version-6.1.0/testing/e2e-testing.md new file mode 100644 index 00000000000..a4536123767 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/testing/e2e-testing.md @@ -0,0 +1,227 @@ +--- +title: End-to-End Testing +sidebar_position: 4 +--- + + + +# End-to-End Testing + +Apache Superset uses Playwright for end-to-end testing, migrating from the legacy Cypress tests. + +## Running Tests + +### Playwright (Recommended) + +```bash +cd superset-frontend + +# Run all tests +npm run playwright:test +# or: npx playwright test + +# Run specific test file +npx playwright test tests/auth/login.spec.ts + +# Run with UI mode for debugging +npm run playwright:ui +# or: npx playwright test --ui + +# Run in headed mode (see browser) +npm run playwright:headed +# or: npx playwright test --headed + +# Debug specific test file +npm run playwright:debug tests/auth/login.spec.ts +# or: npx playwright test --debug tests/auth/login.spec.ts +``` + +### Cypress (Deprecated) + +Cypress tests are being migrated to Playwright. For legacy tests: + +```bash +cd superset-frontend/cypress-base +npm run cypress-run-chrome # Headless +npm run cypress-debug # Interactive UI +``` + +## Project Architecture + +``` +superset-frontend/playwright/ +├── components/core/ # Reusable UI components +├── pages/ # Page Object Models +├── tests/ # Test files organized by feature +├── utils/ # Shared constants and utilities +└── playwright.config.ts +``` + +## Design Principles + +We follow **YAGNI** (You Aren't Gonna Need It), **DRY** (Don't Repeat Yourself), and **KISS** (Keep It Simple, Stupid) principles: + +- Build only what's needed now +- Reuse existing patterns and components +- Keep solutions simple and maintainable + +## Page Object Pattern + +Each page object encapsulates: + +- **Actions**: What you can do on the page +- **Queries**: Information you can get from the page +- **Selectors**: Centralized in private static SELECTORS constant +- **NO Assertions**: Keep assertions in test files + +**Example Page Object:** + +```typescript +export class AuthPage { + // Selectors centralized in the page object + private static readonly SELECTORS = { + LOGIN_FORM: '[data-test="login-form"]', + USERNAME_INPUT: '[data-test="username-input"]', + } as const; + + // Actions - what you can do + async loginWithCredentials(username: string, password: string) {} + + // Queries - information you can get + async getCurrentUrl(): Promise {} + + // NO assertions - those belong in tests +} +``` + +**Example Test:** + +```typescript +import { test, expect } from '@playwright/test'; +import { AuthPage } from '../../pages/AuthPage'; +import { LOGIN } from '../../utils/urls'; + +test('should login with correct credentials', async ({ page }) => { + const authPage = new AuthPage(page); + await authPage.goto(); + await authPage.loginWithCredentials('admin', 'general'); + + // Assertions belong in tests, not page objects + expect(await authPage.getCurrentUrl()).not.toContain(LOGIN); +}); +``` + +## Core Components + +Reusable UI interaction classes for common elements (`components/core/`): + +- **Form**: Container with properly scoped child element access +- **Input**: Supports `fill()`, `type()`, and `pressSequentially()` methods +- **Button**: Standard click, hover, focus interactions + +**Usage Example:** + +```typescript +import { Form } from '../components/core'; + +const loginForm = new Form(page, '[data-test="login-form"]'); +const usernameInput = loginForm.getInput('[data-test="username-input"]'); +await usernameInput.fill('admin'); +``` + +## Test Reports + +Playwright generates multiple reports for better visibility: + +```bash +# View interactive HTML report (opens automatically on failure) +npm run playwright:report +# or: npx playwright show-report + +# View test trace for debugging failures +npx playwright show-trace test-results/[test-name]/trace.zip +``` + +### Report Types + +- **List Reporter**: Shows progress and summary table in terminal +- **HTML Report**: Interactive web interface with screenshots, videos, and traces +- **JSON Report**: Machine-readable format in `test-results/results.json` +- **GitHub Actions**: Annotations in CI for failed tests + +### Debugging Failed Tests + +When tests fail, Playwright automatically captures: + +- **Screenshots** at the point of failure +- **Videos** of the entire test run +- **Traces** with timeline and network activity +- **Error context** with detailed debugging information + +All debugging artifacts are available in the HTML report for easy analysis. + +## Configuration + +- **Config**: `playwright.config.ts` - matches Cypress settings +- **Base URL**: `http://localhost:8088` (assumes Superset running) +- **Browsers**: Chrome only for Phase 1 (YAGNI) +- **Retries**: 2 in CI, 0 locally (matches Cypress) + +## Contributing Guidelines + +### Adding New Tests + +1. **Check existing components** before creating new ones +2. **Use page objects** for page interactions +3. **Keep assertions in tests**, not page objects +4. **Follow naming conventions**: `feature.spec.ts` + +### Adding New Components + +1. **Follow YAGNI**: Only build what's immediately needed +2. **Use Locator-based scoping** for proper element isolation +3. **Support both string selectors and Locator objects** via constructor overloads +4. **Add to `components/core/index.ts`** for easy importing + +### Adding New Page Objects + +1. **Centralize selectors** in private static SELECTORS constant +2. **Import shared constants** from `utils/urls.ts` +3. **Actions and queries only** - no assertions +4. **Use existing components** for DOM interactions + +## Migration from Cypress + +When porting Cypress tests: + +1. **Port the logic**, not the implementation +2. **Use page objects** instead of inline selectors +3. **Replace `cy.intercept/cy.wait`** with `page.waitForRequest()` +4. **Use shared constants** from `utils/urls.ts` +5. **Follow the established patterns** shown in `tests/auth/login.spec.ts` + +## Best Practices + +- **Centralize selectors** in page objects +- **Centralize URLs** in `utils/urls.ts` +- **Use meaningful test descriptions** +- **Keep page objects action-focused** +- **Put assertions in tests, not page objects** +- **Follow the existing patterns** for consistency diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/testing/frontend-testing.md b/docs/developer_docs_versioned_docs/version-6.1.0/testing/frontend-testing.md new file mode 100644 index 00000000000..e33bb1095bc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/testing/frontend-testing.md @@ -0,0 +1,61 @@ +--- +title: Frontend Testing +sidebar_position: 2 +--- + + + +# Frontend Testing + +🚧 **Coming Soon** 🚧 + +Comprehensive guide for testing Superset's frontend components and features. + +## Topics to be covered: + +- Jest configuration and setup +- React Testing Library best practices +- Component testing strategies +- Redux store testing +- Async operations and API mocking +- Snapshot testing guidelines +- Coverage requirements and reporting +- Debugging test failures +- Performance testing for UI components + +## Quick Commands + +```bash +# Run all frontend tests +npm run test + +# Run tests in watch mode +npm run test -- --watch + +# Run tests with coverage +npm run test -- --coverage + +# Run specific test file +npm run test -- MyComponent.test.tsx +``` + +--- + +*This documentation is under active development. Check back soon for updates!* diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/testing/overview.md b/docs/developer_docs_versioned_docs/version-6.1.0/testing/overview.md new file mode 100644 index 00000000000..856b3990ae9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/testing/overview.md @@ -0,0 +1,162 @@ +--- +title: Overview +sidebar_position: 1 +--- + + + +# Overview + +Apache Superset follows a comprehensive testing strategy that ensures code quality, reliability, and maintainability. This section covers all aspects of testing in the Superset ecosystem, from unit tests to end-to-end testing workflows. + +## Testing Philosophy + +Superset embraces a testing pyramid approach: + +- **Unit Tests**: Fast, isolated tests for individual components and functions +- **Integration Tests**: Tests that verify component interactions and API endpoints +- **End-to-End Tests**: Full user journey testing in browser environments + +## Testing Documentation + +### Frontend Testing +- **[Frontend Testing](./frontend-testing)** - Jest, React Testing Library, and component testing strategies + +### Backend Testing +- **[Backend Testing](./backend-testing)** - pytest, database testing, and API testing patterns + +### End-to-End Testing +- **[E2E Testing](./e2e-testing)** - Playwright testing for complete user workflows + +### CI/CD Integration +- **[CI/CD](./ci-cd)** - Continuous integration, automated testing, and deployment pipelines + +## Testing Tools & Frameworks + +### Frontend +- **Jest**: JavaScript testing framework for unit and integration tests +- **React Testing Library**: Component testing utilities focused on user behavior +- **Playwright**: Modern end-to-end testing for web applications +- **Storybook**: Component development and visual testing environment + +### Backend +- **pytest**: Python testing framework with powerful fixtures and plugins +- **SQLAlchemy Test Utilities**: Database testing and transaction management +- **Flask Test Client**: API endpoint testing and request simulation + +## Best Practices + +### Writing Effective Tests +1. **Test Behavior, Not Implementation**: Focus on what the code should do, not how it does it +2. **Keep Tests Independent**: Each test should be able to run in isolation +3. **Use Descriptive Names**: Test names should clearly describe what is being tested +4. **Arrange, Act, Assert**: Structure tests with clear setup, execution, and verification phases + +### Test Organization +- **Colocation**: Place test files near the code they test +- **Naming Conventions**: Use consistent naming patterns for test files and functions +- **Test Categories**: Organize tests by type (unit, integration, e2e) +- **Test Data Management**: Use factories and fixtures for consistent test data + +## Running Tests + +### Quick Commands +```bash +# Frontend unit tests +npm run test + +# Backend unit tests +pytest tests/unit_tests/ + +# End-to-end tests +npm run playwright:test + +# All tests with coverage +npm run test:coverage +``` + +### Test Development Workflow +1. **Write Failing Test**: Start with a test that describes the desired behavior +2. **Implement Feature**: Write the minimum code to make the test pass +3. **Refactor**: Improve code quality while keeping tests green +4. **Verify Coverage**: Ensure adequate test coverage for new code + +## Testing in Development + +### Test-Driven Development (TDD) +- Write tests before implementation +- Use tests to guide design decisions +- Maintain fast feedback loops + +### Continuous Testing +- Run tests automatically on code changes +- Integrate testing into development workflow +- Use pre-commit hooks for test validation + +## Getting Started + +1. **Set up Testing Environment**: Follow the development setup guide +2. **Run Existing Tests**: Familiarize yourself with the test suite +3. **Write Your First Test**: Start with a simple unit test +4. **Learn Testing Patterns**: Study existing tests for patterns and conventions + +## Topics to be covered: + +- Testing strategy and pyramid +- Test-driven development (TDD) for plugins +- Continuous integration and automated testing +- Code coverage and quality metrics +- Testing tools and frameworks overview +- Mock data and test fixtures +- Performance testing and benchmarking +- Accessibility testing automation +- Cross-browser and device testing +- Regression testing strategies + +## Testing Levels + +### Unit Testing +- **Component testing** - Individual React components +- **Function testing** - Data transformation and utility functions +- **Hook testing** - Custom React hooks +- **Service testing** - API clients and business logic + +### Integration Testing +- **API integration** - Backend service communication +- **Component integration** - Multi-component workflows +- **Data flow testing** - End-to-end data processing +- **Plugin lifecycle testing** - Installation and activation + +### End-to-End Testing +- **User workflow testing** - Complete user journeys +- **Cross-browser testing** - Browser compatibility +- **Performance testing** - Load and stress testing +- **Accessibility testing** - Screen reader and keyboard navigation + +## Testing Tools + +- **Jest** - Unit and integration testing framework +- **React Testing Library** - Component testing utilities +- **Playwright** - End-to-end testing (replacing Cypress) +- **Storybook** - Component development and testing + +--- + +*This documentation is under active development. Check back soon for updates!* diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/testing/storybook.md b/docs/developer_docs_versioned_docs/version-6.1.0/testing/storybook.md new file mode 100644 index 00000000000..0e190220f15 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/testing/storybook.md @@ -0,0 +1,114 @@ +--- +title: Storybook +sidebar_position: 5 +--- + + + +# Storybook + +Superset uses [Storybook](https://storybook.js.org/) for developing and testing UI components in isolation. Storybook provides a sandbox to build components independently, outside of the main application. + +## Public Storybook + +A public Storybook with components from the `master` branch is available at: + +**[apache-superset.github.io/superset-ui](https://apache-superset.github.io/superset-ui/?path=/story/*)** + +## Running Locally + +### Main Superset Storybook + +To run the main Superset Storybook locally: + +```bash +cd superset-frontend + +# Start Storybook (opens at http://localhost:6006) +npm run storybook + +# Build static Storybook +npm run build-storybook +``` + +### @superset-ui Package Storybook + +The `@superset-ui` packages have a separate Storybook for component library development: + +```bash +cd superset-frontend + +# Install dependencies and bootstrap packages +npm ci && npm run bootstrap + +# Start the @superset-ui Storybook (opens at http://localhost:9001) +cd packages/superset-ui-demo +npm run storybook +``` + +## Adding Stories + +### To an Existing Package + +If stories already exist for the package, extend the `examples` array in the package's story file: + +``` +storybook/stories//index.js +``` + +### To a New Package + +1. Add package dependencies: + + ```bash + npm install + ``` + +2. Create a story folder matching the package name: + + ```bash + mkdir storybook/stories/superset-ui-/ + ``` + +3. Create an `index.js` file with the story configuration: + + ```javascript + export default { + examples: [ + { + storyPath: '@superset-ui/package', + storyName: 'My Story', + renderStory: () => , + }, + ], + }; + ``` + + Use the `|` separator for nested stories: + ```javascript + storyPath: '@superset-ui/package|Category|Subcategory' + ``` + +## Best Practices + +- **Isolate components**: Stories should render components in isolation, without application context +- **Show variations**: Create stories for different states, sizes, and configurations +- **Document props**: Use Storybook's controls to expose configurable props +- **Test edge cases**: Include stories for loading states, error states, and empty states diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/testing/testing-guidelines.md b/docs/developer_docs_versioned_docs/version-6.1.0/testing/testing-guidelines.md new file mode 100644 index 00000000000..5fb8424449a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/testing/testing-guidelines.md @@ -0,0 +1,129 @@ +--- +title: Testing Guidelines and Best Practices +sidebar_position: 1 +--- + + + +# Testing Guidelines and Best Practices + +We feel that tests are an important part of a feature and not an additional or optional effort. That's why we colocate test files with functionality and sometimes write tests upfront to help validate requirements and shape the API of our components. Every new component or file added should have an associated test file with the `.test` extension. + +We use Jest, React Testing Library (RTL), and Cypress to write our unit, integration, and end-to-end tests. For each type, we have a set of best practices/tips described below: + +## Jest + +### Write simple, standalone tests + +The importance of simplicity is often overlooked in test cases. Clear, dumb code should always be preferred over complex ones. The test cases should be pretty much standalone and should not involve any external logic if not absolutely necessary. That's because you want the corpus of the tests to be easy to read and understandable at first sight. + +### Avoid nesting when you're testing + +Avoid the use of `describe` blocks in favor of inlined tests. If your tests start to grow and you feel the need to group tests, prefer to break them into multiple test files. Check this awesome [article](https://kentcdodds.com/blog/avoid-nesting-when-youre-testing) written by [Kent C. Dodds](https://kentcdodds.com/) about this topic. + +### No warnings! + +Your tests shouldn't trigger warnings. This is really common when testing async functionality. It's really difficult to read test results when we have a bunch of warnings. + +### Example + +You can find an example of a test [here](https://github.com/apache/superset/blob/e6c5bf4/superset-frontend/src/common/hooks/useChangeEffect/useChangeEffect.test.ts). + +## React Testing Library (RTL) + +### Keep accessibility in mind when writing your tests + +One of the most important points of RTL is accessibility and this is also a very important point for us. We should try our best to follow the RTL [Priority](https://testing-library.com/docs/queries/about/#priority) when querying for elements in our tests. `getByTestId` is not viewable by the user and should only be used when the element isn't accessible in any other way. + +### Don't use `act` unnecessarily + +`render` and `fireEvent` are already wrapped in `act`, so wrapping them in `act` again is a common mistake. Some solutions to the warnings related to `act` might be found [here](https://kentcdodds.com/blog/fix-the-not-wrapped-in-act-warning). + +### Be specific when using *ByRole + +By using the `name` option we can point to the items by their accessible name. For example: + +```jsx +screen.getByRole('button', { name: /hello world/i }) +``` + +Using the `name` property also avoids breaking the tests in the future if other components with the same role are added. + +### userEvent vs fireEvent + +Prefer the [user-event](https://github.com/testing-library/user-event) library, which provides a more advanced simulation of browser interactions than the built-in [fireEvent](https://testing-library.com/docs/dom-testing-library/api-events/#fireevent) method. + +### Usage of waitFor + +- [Prefer to use `find`](https://kentcdodds.com/blog/common-mistakes-with-react-testing-library#using-waitfor-to-wait-for-elements-that-can-be-queried-with-find) over `waitFor` when you're querying for elements. Even though both achieve the same objective, the `find` version is simpler and you'll get better error messages. +- Prefer to use only [one assertion at a time](https://kentcdodds.com/blog/common-mistakes-with-react-testing-library#having-multiple-assertions-in-a-single-waitfor-callback). If you put multiple assertions inside a `waitFor` we could end up waiting for the whole block timeout before seeing a test failure even if the failure occurred at the first assertion. By putting a single assertion in there, we can improve on test execution time. +- Do not perform [side-effects](https://kentcdodds.com/blog/common-mistakes-with-react-testing-library#performing-side-effects-in-waitfor) inside `waitFor`. The callback can be called a non-deterministic number of times and frequency (it's called both on an interval as well as when there are DOM mutations). So this means that your side-effect could run multiple times. + +### Example + +You can find an example of a test [here](https://github.com/apache/superset/blob/master/superset-frontend/src/dashboard/components/PublishedStatus/PublishedStatus.test.tsx). + +## Cypress + +### Prefer to use Cypress for e2e testing and RTL for integration testing + +Here it's important to make the distinction between e2e and integration testing. This [article](https://www.onpathtesting.com/blog/end-to-end-vs-integration-testing) gives an excellent definition: + +> End-to-end testing verifies that your software works correctly from the beginning to the end of a particular user flow. It replicates expected user behavior and various usage scenarios to ensure that your software works as whole. End-to-end testing uses a production equivalent environment and data to simulate real-world situations and may also involve the integrations your software has with external applications. + +> A typical software project consists of multiple software units, usually coded by different developers. Integration testing combines those software units logically and tests them as a group. +> Essentially, integration testing verifies whether or not the individual modules or services that make up your application work well together. The purpose of this level of testing is to expose defects in the interaction between these software modules when they are integrated. + +Do not use Cypress when RTL can do it better and faster. Many of the Cypress tests that we have right now, fall into the integration testing category and can be ported to RTL which is much faster and gives more immediate feedback. Cypress should be used mainly for end-to-end testing, replicating the user experience, with positive and negative flows. + +### Isolated and standalone tests + +Tests should never rely on other tests to pass. This might be hard when a single user is used for testing as data will be stored in the database. At every new test, we should reset the database. + +### Cleaning state + +Cleaning the state of the application, such as resetting the DB, or in general, any state that might affect consequent tests should always be done in the `beforeEach` hook and never in the `afterEach` one as the `beforeEach` is guaranteed to run, while the test might never reach the point to run the `afterEach` hook. One example would be if you refresh Cypress in the middle of the test. At this point, you will have built up a partial state in the database, and your clean-up function will never get called. You can read more about it [here](https://docs.cypress.io/guides/references/best-practices#Using-after-or-afterEach-hooks). + +### Unnecessary use of `cy.wait` + +- Unnecessary when using `cy.request()` as it will resolve when a response is received from the server +- Unnecessary when using `cy.visit()` as it resolves only when the page fires the load event +- Unnecessary when using `cy.get()`. When the selector should wait for a request to happen, aliases would come in handy: + +```js +cy.intercept('GET', '/users', [{ name: 'Maggy' }, { name: 'Joan' }]).as('getUsers') +cy.get('#fetch').click() +cy.wait('@getUsers') // <--- wait explicitly for this route to finish +cy.get('table tr').should('have.length', 2) +``` + +### Accessibility and Resilience + +The same accessibility principles in the RTL section apply here. Use accessible selectors when querying for elements. Those principles also help to isolate selectors from eventual CSS and JS changes and improve the resilience of your tests. + +## References + +- [Avoid Nesting when you're Testing](https://kentcdodds.com/blog/avoid-nesting-when-youre-testing) +- [RTL - Queries](https://testing-library.com/docs/queries/about/#priority) +- [Fix the "not wrapped in act(...)" warning](https://kentcdodds.com/blog/fix-the-not-wrapped-in-act-warning) +- [Common mistakes with React Testing Library](https://kentcdodds.com/blog/common-mistakes-with-react-testing-library) +- [ARIA Roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles) +- [Cypress - Best Practices](https://docs.cypress.io/guides/references/best-practices) +- [End-to-end vs integration tests: what's the difference?](https://www.onpathtesting.com/blog/end-to-end-vs-integration-testing) diff --git a/docs/developer_docs_versioned_sidebars/version-6.1.0-sidebars.json b/docs/developer_docs_versioned_sidebars/version-6.1.0-sidebars.json new file mode 100644 index 00000000000..715bfd42bc1 --- /dev/null +++ b/docs/developer_docs_versioned_sidebars/version-6.1.0-sidebars.json @@ -0,0 +1,4040 @@ +{ + "DeveloperPortalSidebar": [ + { + "type": "doc", + "label": "Overview", + "id": "index" + }, + { + "type": "category", + "label": "Contributing", + "collapsed": true, + "items": [ + "contributing/overview", + "contributing/development-setup", + "contributing/submitting-pr", + "contributing/guidelines", + "contributing/code-review", + "contributing/issue-reporting", + "contributing/howtos", + "contributing/release-process", + "contributing/resources", + "contributing/pkg-resources-migration", + "guidelines/design-guidelines", + { + "type": "category", + "label": "Frontend Style Guidelines", + "collapsed": true, + "items": [ + "guidelines/frontend-style-guidelines", + "guidelines/frontend/component-style-guidelines", + "guidelines/frontend/emotion-styling-guidelines" + ] + }, + { + "type": "category", + "label": "Backend Style Guidelines", + "collapsed": true, + "items": [ + "guidelines/backend-style-guidelines", + "guidelines/backend/dao-style-guidelines" + ] + } + ] + }, + { + "type": "category", + "label": "Extensions", + "collapsed": true, + "items": [ + "extensions/overview", + "extensions/quick-start", + "extensions/architecture", + "extensions/dependencies", + "extensions/contribution-types", + { + "type": "category", + "label": "Extension Points", + "collapsed": true, + "items": [ + "extensions/extension-points/sqllab", + "extensions/extension-points/editors" + ] + }, + "extensions/development", + "extensions/deployment", + "extensions/mcp", + "extensions/security", + "extensions/tasks", + "extensions/registry" + ] + }, + { + "type": "category", + "label": "Testing", + "collapsed": true, + "items": [ + "testing/overview", + "testing/testing-guidelines", + "testing/frontend-testing", + "testing/backend-testing", + "testing/e2e-testing", + "testing/storybook", + "testing/ci-cd" + ] + }, + { + "type": "category", + "label": "UI Components", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "components" + } + ] + }, + { + "type": "category", + "label": "API Reference", + "link": { + "type": "doc", + "id": "api" + }, + "items": [ + { + "type": "category", + "label": "Advanced Data Type", + "link": { + "type": "doc", + "id": "api/advanced-data-type" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/return-an-advanced-data-type-response", + "label": "Return an AdvancedDataTypeResponse", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/return-a-list-of-available-advanced-data-types", + "label": "Return a list of available advanced data types", + "className": "api-method get" + } + ], + "key": "api-category-advanced-data-type" + }, + { + "type": "category", + "label": "Annotation Layers", + "link": { + "type": "doc", + "id": "api/annotation-layers" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/delete-multiple-annotation-layers-in-a-bulk-operation", + "label": "Delete multiple annotation layers in a bulk operation", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-annotation-layers-annotation-layer", + "label": "Get a list of annotation layers (annotation-layer)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-an-annotation-layer-annotation-layer", + "label": "Create an annotation layer (annotation-layer)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-annotation-layer-info", + "label": "Get metadata information about this API resource (annotation-layer--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-annotation-layer-related-column-name", + "label": "Get related fields data (annotation-layer-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-annotation-layer-annotation-layer-pk", + "label": "Delete annotation layer (annotation-layer-pk)", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-an-annotation-layer-annotation-layer-pk", + "label": "Get an annotation layer (annotation-layer-pk)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-an-annotation-layer-annotation-layer-pk", + "label": "Update an annotation layer (annotation-layer-pk)", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/bulk-delete-annotation-layers", + "label": "Bulk delete annotation layers", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-annotation-layers-annotation-layer-pk-annotation", + "label": "Get a list of annotation layers (annotation-layer-pk-annotation)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-an-annotation-layer-annotation-layer-pk-annotation", + "label": "Create an annotation layer (annotation-layer-pk-annotation)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/delete-annotation-layer-annotation-layer-pk-annotation-annotation-id", + "label": "Delete annotation layer (annotation-layer-pk-annotation-annotation-id)", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id", + "label": "Get an annotation layer (annotation-layer-pk-annotation-annotation-id)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id", + "label": "Update an annotation layer (annotation-layer-pk-annotation-annotation-id)", + "className": "api-method put" + } + ], + "key": "api-category-annotation-layers" + }, + { + "type": "category", + "label": "AsyncEventsRestApi", + "link": { + "type": "doc", + "id": "api/async-events-rest-api" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/read-off-of-the-redis-events-stream", + "label": "Read off of the Redis events stream", + "className": "api-method get" + } + ], + "key": "api-category-asynceventsrestapi" + }, + { + "type": "category", + "label": "Available Domains", + "link": { + "type": "doc", + "id": "api/available-domains" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-all-available-domains", + "label": "Get all available domains", + "className": "api-method get" + } + ], + "key": "api-category-available-domains" + }, + { + "type": "category", + "label": "CSS Templates", + "link": { + "type": "doc", + "id": "api/css-templates" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-css-templates", + "label": "Bulk delete CSS templates", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-css-templates", + "label": "Get a list of CSS templates", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-css-template", + "label": "Create a CSS template", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-css-template-info", + "label": "Get metadata information about this API resource (css-template--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-css-template-related-column-name", + "label": "Get related fields data (css-template-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-css-template", + "label": "Delete a CSS template", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-css-template", + "label": "Get a CSS template", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-css-template", + "label": "Update a CSS template", + "className": "api-method put" + } + ], + "key": "api-category-css-templates" + }, + { + "type": "category", + "label": "CacheRestApi", + "link": { + "type": "doc", + "id": "api/cache-rest-api" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/invalidate-cache-records-and-remove-the-database-records", + "label": "Invalidate cache records and remove the database records", + "className": "api-method post" + } + ], + "key": "api-category-cacherestapi" + }, + { + "type": "category", + "label": "Charts", + "link": { + "type": "doc", + "id": "api/charts" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-charts", + "label": "Bulk delete charts", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-charts", + "label": "Get a list of charts", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-chart", + "label": "Create a new chart", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-chart-info", + "label": "Get metadata information about this API resource (chart--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/return-payload-data-response-for-the-given-query-chart-data", + "label": "Return payload data response for the given query (chart-data)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/return-payload-data-response-for-the-given-query-chart-data-cache-key", + "label": "Return payload data response for the given query (chart-data-cache-key)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/download-multiple-charts-as-yaml-files", + "label": "Download multiple charts as YAML files", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/check-favorited-charts-for-current-user", + "label": "Check favorited charts for current user", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/import-chart-s-with-associated-datasets-and-databases", + "label": "Import chart(s) with associated datasets and databases", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-chart-related-column-name", + "label": "Get related fields data (chart-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/warm-up-the-cache-for-the-chart", + "label": "Warm up the cache for the chart", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/delete-a-chart", + "label": "Delete a chart", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-chart-detail-information", + "label": "Get a chart detail information", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-chart", + "label": "Update a chart", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/compute-and-cache-a-screenshot-chart-pk-cache-screenshot", + "label": "Compute and cache a screenshot (chart-pk-cache-screenshot)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/return-payload-data-response-for-a-chart", + "label": "Return payload data response for a chart", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/remove-the-chart-from-the-user-favorite-list", + "label": "Remove the chart from the user favorite list", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/mark-the-chart-as-favorite-for-the-current-user", + "label": "Mark the chart as favorite for the current user", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest", + "label": "Get a computed screenshot from cache (chart-pk-screenshot-digest)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-chart-thumbnail", + "label": "Get chart thumbnail", + "className": "api-method get" + } + ], + "key": "api-category-charts" + }, + { + "type": "category", + "label": "Current User", + "link": { + "type": "doc", + "id": "api/current-user" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-the-user-object", + "label": "Get the user object", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-the-user-roles", + "label": "Get the user roles", + "className": "api-method get" + } + ], + "key": "api-category-current-user" + }, + { + "type": "category", + "label": "Dashboard Filter State", + "link": { + "type": "doc", + "id": "api/dashboard-filter-state" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/create-a-dashboards-filter-state", + "label": "Create a dashboard's filter state", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/delete-a-dashboards-filter-state-value", + "label": "Delete a dashboard's filter state value", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-dashboards-filter-state-value", + "label": "Get a dashboard's filter state value", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-dashboards-filter-state-value", + "label": "Update a dashboard's filter state value", + "className": "api-method put" + } + ], + "key": "api-category-dashboard-filter-state" + }, + { + "type": "category", + "label": "Dashboard Permanent Link", + "link": { + "type": "doc", + "id": "api/dashboard-permanent-link" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-dashboards-permanent-link-state", + "label": "Get dashboard's permanent link state", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-dashboards-permanent-link", + "label": "Create a new dashboard's permanent link", + "className": "api-method post" + } + ], + "key": "api-category-dashboard-permanent-link" + }, + { + "type": "category", + "label": "Dashboards", + "link": { + "type": "doc", + "id": "api/dashboards" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-dashboards", + "label": "Bulk delete dashboards", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-dashboards", + "label": "Get a list of dashboards", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-dashboard", + "label": "Create a new dashboard", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-dashboard-info", + "label": "Get metadata information about this API resource (dashboard--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/download-multiple-dashboards-as-yaml-files", + "label": "Download multiple dashboards as YAML files", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/check-favorited-dashboards-for-current-user", + "label": "Check favorited dashboards for current user", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/import-dashboard-s-with-associated-charts-datasets-databases", + "label": "Import dashboard(s) with associated charts/datasets/databases", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-dashboard-related-column-name", + "label": "Get related fields data (dashboard-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-dashboard-detail-information", + "label": "Get a dashboard detail information", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-dashboards-chart-definitions", + "label": "Get a dashboard's chart definitions.", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-copy-of-an-existing-dashboard", + "label": "Create a copy of an existing dashboard", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-dashboards-datasets", + "label": "Get dashboard's datasets", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-dashboards-embedded-configuration", + "label": "Delete a dashboard's embedded configuration", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-the-dashboards-embedded-configuration", + "label": "Get the dashboard's embedded configuration", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/set-a-dashboards-embedded-configuration", + "label": "Set a dashboard's embedded configuration", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/update-dashboard-by-id-or-slug-embedded", + "label": "Update dashboard by id_or_slug embedded", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/get-dashboards-tabs", + "label": "Get dashboard's tabs", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-dashboard", + "label": "Delete a dashboard", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/update-a-dashboard", + "label": "Update a dashboard", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot", + "label": "Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/update-colors-configuration-for-a-dashboard", + "label": "Update colors configuration for a dashboard.", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/remove-the-dashboard-from-the-user-favorite-list", + "label": "Remove the dashboard from the user favorite list", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/mark-the-dashboard-as-favorite-for-the-current-user", + "label": "Mark the dashboard as favorite for the current user", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/update-native-filters-configuration-for-a-dashboard", + "label": "Update native filters configuration for a dashboard.", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/get-a-computed-screenshot-from-cache-dashboard-pk-screenshot-digest", + "label": "Get a computed screenshot from cache (dashboard-pk-screenshot-digest)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-dashboards-thumbnail", + "label": "Get dashboard's thumbnail", + "className": "api-method get" + } + ], + "key": "api-category-dashboards" + }, + { + "type": "category", + "label": "Database", + "link": { + "type": "doc", + "id": "api/database" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-a-list-of-databases", + "label": "Get a list of databases", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-database", + "label": "Create a new database", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-database-info", + "label": "Get metadata information about this API resource (database--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-names-of-databases-currently-available", + "label": "Get names of databases currently available", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/download-database-s-and-associated-dataset-s-as-a-zip-file", + "label": "Download database(s) and associated dataset(s) as a zip file", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/import-database-s-with-associated-datasets", + "label": "Import database(s) with associated datasets", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/receive-personal-access-tokens-from-o-auth-2", + "label": "Receive personal access tokens from OAuth2", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-database-related-column-name", + "label": "Get related fields data (database-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/test-a-database-connection", + "label": "Test a database connection", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/upload-a-file-and-returns-file-metadata", + "label": "Upload a file and returns file metadata", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/validate-database-connection-parameters", + "label": "Validate database connection parameters", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/delete-a-database", + "label": "Delete a database", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-database", + "label": "Get a database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/change-a-database", + "label": "Change a database", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/get-all-catalogs-from-a-database", + "label": "Get all catalogs from a database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-database-connection-info", + "label": "Get a database connection info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-function-names-supported-by-a-database", + "label": "Get function names supported by a database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-charts-and-dashboards-count-associated-to-a-database", + "label": "Get charts and dashboards count associated to a database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-all-schemas-from-a-database", + "label": "Get all schemas from a database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/the-list-of-the-database-schemas-where-to-upload-information", + "label": "The list of the database schemas where to upload information", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-database-select-star-for-table-database-pk-select-star-table-name", + "label": "Get database select star for table (database-pk-select-star-table-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-database-select-star-for-table-database-pk-select-star-table-name-schema-name", + "label": "Get database select star for table (database-pk-select-star-table-name-schema-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-ssh-tunnel", + "label": "Delete a SSH tunnel", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/re-sync-all-permissions-for-a-database-connection", + "label": "Re-sync all permissions for a database connection", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-database-table-metadata", + "label": "Get database table metadata", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-table-extra-metadata-database-pk-table-extra-table-name-schema-name", + "label": "Get table extra metadata (database-pk-table-extra-table-name-schema-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-table-metadata", + "label": "Get table metadata", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-table-extra-metadata-database-pk-table-metadata-extra", + "label": "Get table extra metadata (database-pk-table-metadata-extra)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-list-of-tables-for-given-database", + "label": "Get a list of tables for given database", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/upload-a-file-to-a-database-table", + "label": "Upload a file to a database table", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/validate-arbitrary-sql", + "label": "Validate arbitrary SQL", + "className": "api-method post" + } + ], + "key": "api-category-database" + }, + { + "type": "category", + "label": "Datasets", + "link": { + "type": "doc", + "id": "api/datasets" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-datasets", + "label": "Bulk delete datasets", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-datasets", + "label": "Get a list of datasets", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-dataset", + "label": "Create a new dataset", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-dataset-info", + "label": "Get metadata information about this API resource (dataset--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-distinct-values-from-field-data-dataset-distinct-column-name", + "label": "Get distinct values from field data (dataset-distinct-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/duplicate-a-dataset", + "label": "Duplicate a dataset", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/download-multiple-datasets-as-yaml-files", + "label": "Download multiple datasets as YAML files", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/retrieve-a-table-by-name-or-create-it-if-it-does-not-exist", + "label": "Retrieve a table by name, or create it if it does not exist", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/import-dataset-s-with-associated-databases", + "label": "Import dataset(s) with associated databases", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-dataset-related-column-name", + "label": "Get related fields data (dataset-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/warm-up-the-cache-for-each-chart-powered-by-the-given-table", + "label": "Warm up the cache for each chart powered by the given table", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/delete-a-dataset", + "label": "Delete a dataset", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-dataset", + "label": "Get a dataset", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-dataset", + "label": "Update a dataset", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/delete-a-dataset-column", + "label": "Delete a dataset column", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/delete-a-dataset-metric", + "label": "Delete a dataset metric", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/refresh-and-update-columns-of-a-dataset", + "label": "Refresh and update columns of a dataset", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/get-charts-and-dashboards-count-associated-to-a-dataset", + "label": "Get charts and dashboards count associated to a dataset", + "className": "api-method get" + } + ], + "key": "api-category-datasets" + }, + { + "type": "category", + "label": "Datasources", + "link": { + "type": "doc", + "id": "api/datasources" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-possible-values-for-a-datasource-column", + "label": "Get possible values for a datasource column", + "className": "api-method get" + } + ], + "key": "api-category-datasources" + }, + { + "type": "category", + "label": "Embedded Dashboard", + "link": { + "type": "doc", + "id": "api/embedded-dashboard" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-a-report-schedule-log-embedded-dashboard-uuid", + "label": "Get a report schedule log (embedded-dashboard-uuid)", + "className": "api-method get" + } + ], + "key": "api-category-embedded-dashboard" + }, + { + "type": "category", + "label": "Explore", + "link": { + "type": "doc", + "id": "api/explore" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/assemble-explore-related-information-in-a-single-endpoint", + "label": "Assemble Explore related information in a single endpoint", + "className": "api-method get" + } + ], + "key": "api-category-explore" + }, + { + "type": "category", + "label": "Explore Form Data", + "link": { + "type": "doc", + "id": "api/explore-form-data" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/create-a-new-form-data", + "label": "Create a new form_data", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/delete-a-form-data", + "label": "Delete a form_data", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-form-data", + "label": "Get a form_data", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-an-existing-form-data", + "label": "Update an existing form_data", + "className": "api-method put" + } + ], + "key": "api-category-explore-form-data" + }, + { + "type": "category", + "label": "Explore Permanent Link", + "link": { + "type": "doc", + "id": "api/explore-permanent-link" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/create-a-new-permanent-link-explore-permalink", + "label": "Create a new permanent link (explore-permalink)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-charts-permanent-link-state", + "label": "Get chart's permanent link state", + "className": "api-method get" + } + ], + "key": "api-category-explore-permanent-link" + }, + { + "type": "category", + "label": "Import/export", + "link": { + "type": "doc", + "id": "api/import-export" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/export-all-assets", + "label": "Export all assets", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/import-multiple-assets", + "label": "Import multiple assets", + "className": "api-method post" + } + ], + "key": "api-category-import/export" + }, + { + "type": "category", + "label": "LogRestApi", + "link": { + "type": "doc", + "id": "api/log-rest-api" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-a-list-of-logs", + "label": "Get a list of logs", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-log", + "label": "Create log", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-recent-activity-data-for-a-user", + "label": "Get recent activity data for a user", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-log-detail-information", + "label": "Get a log detail information", + "className": "api-method get" + } + ], + "key": "api-category-logrestapi" + }, + { + "type": "category", + "label": "Menu", + "link": { + "type": "doc", + "id": "api/menu" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-menu", + "label": "Get menu", + "className": "api-method get" + } + ], + "key": "api-category-menu" + }, + { + "type": "category", + "label": "OpenApi", + "link": { + "type": "doc", + "id": "api/open-api" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-api-by-version-openapi", + "label": "Get api by version openapi", + "className": "api-method get" + } + ], + "key": "api-category-openapi" + }, + { + "type": "category", + "label": "Queries", + "link": { + "type": "doc", + "id": "api/queries" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-a-list-of-queries", + "label": "Get a list of queries", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-distinct-values-from-field-data-query-distinct-column-name", + "label": "Get distinct values from field data (query-distinct-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-query-related-column-name", + "label": "Get related fields data (query-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/manually-stop-a-query-with-client-id", + "label": "Manually stop a query with client_id", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-a-list-of-queries-that-changed-after-last-updated-ms", + "label": "Get a list of queries that changed after last_updated_ms", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-query-detail-information", + "label": "Get query detail information", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/bulk-delete-saved-queries", + "label": "Bulk delete saved queries", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-saved-queries", + "label": "Get a list of saved queries", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-saved-query", + "label": "Create a saved query", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-saved-query-info", + "label": "Get metadata information about this API resource (saved-query--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-distinct-values-from-field-data-saved-query-distinct-column-name", + "label": "Get distinct values from field data (saved-query-distinct-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/download-multiple-saved-queries-as-yaml-files", + "label": "Download multiple saved queries as YAML files", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/import-saved-queries-with-associated-databases", + "label": "Import saved queries with associated databases", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-saved-query-related-column-name", + "label": "Get related fields data (saved-query-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-saved-query", + "label": "Delete a saved query", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-saved-query", + "label": "Get a saved query", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-saved-query", + "label": "Update a saved query", + "className": "api-method put" + } + ], + "key": "api-category-queries" + }, + { + "type": "category", + "label": "Report Schedules", + "link": { + "type": "doc", + "id": "api/report-schedules" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-report-schedules", + "label": "Bulk delete report schedules", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-report-schedules", + "label": "Get a list of report schedules", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-report-schedule", + "label": "Create a report schedule", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-report-info", + "label": "Get metadata information about this API resource (report--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-report-related-column-name", + "label": "Get related fields data (report-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-slack-channels", + "label": "Get slack channels", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-a-report-schedule", + "label": "Delete a report schedule", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-report-schedule", + "label": "Get a report schedule", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-report-schedule", + "label": "Update a report schedule", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/get-a-list-of-report-schedule-logs", + "label": "Get a list of report schedule logs", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-report-schedule-log-report-pk-log-log-id", + "label": "Get a report schedule log (report-pk-log-log-id)", + "className": "api-method get" + } + ], + "key": "api-category-report-schedules" + }, + { + "type": "category", + "label": "Row Level Security", + "link": { + "type": "doc", + "id": "api/row-level-security" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-rls-rules", + "label": "Bulk delete RLS rules", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-rls", + "label": "Get a list of RLS", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-new-rls-rule", + "label": "Create a new RLS rule", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-this-api-resource-rowlevelsecurity-info", + "label": "Get metadata information about this API resource (rowlevelsecurity--info)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-rowlevelsecurity-related-column-name", + "label": "Get related fields data (rowlevelsecurity-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-an-rls", + "label": "Delete an RLS", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-an-rls", + "label": "Get an RLS", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-an-rls-rule", + "label": "Update an RLS rule", + "className": "api-method put" + } + ], + "key": "api-category-row-level-security" + }, + { + "type": "category", + "label": "SQL Lab", + "link": { + "type": "doc", + "id": "api/sql-lab" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-the-bootstrap-data-for-sql-lab-page", + "label": "Get the bootstrap data for SqlLab page", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/estimate-the-sql-query-execution-cost", + "label": "Estimate the SQL query execution cost", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/execute-a-sql-query", + "label": "Execute a SQL query", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/export-the-sql-query-results-to-a-csv", + "label": "Export the SQL query results to a CSV", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/format-sql-code", + "label": "Format SQL code", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-the-result-of-a-sql-query-execution", + "label": "Get the result of a SQL query execution", + "className": "api-method get" + } + ], + "key": "api-category-sql-lab" + }, + { + "type": "category", + "label": "SQL Lab Permanent Link", + "link": { + "type": "doc", + "id": "api/sql-lab-permanent-link" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/create-a-new-permanent-link-sqllab-permalink", + "label": "Create a new permanent link (sqllab-permalink)", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-permanent-link-state-for-sql-lab-editor", + "label": "Get permanent link state for SQLLab editor.", + "className": "api-method get" + } + ], + "key": "api-category-sql-lab-permanent-link" + }, + { + "type": "category", + "label": "Security", + "link": { + "type": "doc", + "id": "api/security" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-the-csrf-token", + "label": "Get the CSRF token", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-a-guest-token", + "label": "Get a guest token", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/create-security-login", + "label": "Create security login", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/create-security-refresh", + "label": "Create security refresh", + "className": "api-method post" + } + ], + "key": "api-category-security" + }, + { + "type": "category", + "label": "Security Permissions", + "link": { + "type": "doc", + "id": "api/security-permissions" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-security-permissions", + "label": "Get security permissions", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-security-permissions-info", + "label": "Get security permissions info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-security-permissions-by-pk", + "label": "Get security permissions by pk", + "className": "api-method get" + } + ], + "key": "api-category-security-permissions" + }, + { + "type": "category", + "label": "Security Permissions on Resources (View Menus)", + "link": { + "type": "doc", + "id": "api/security-permissions-on-resources-view-menus" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-security-permissions-resources", + "label": "Get security permissions resources", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-security-permissions-resources", + "label": "Create security permissions resources", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-security-permissions-resources-info", + "label": "Get security permissions resources info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-security-permissions-resources-by-pk", + "label": "Delete security permissions resources by pk", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-security-permissions-resources-by-pk", + "label": "Get security permissions resources by pk", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-security-permissions-resources-by-pk", + "label": "Update security permissions resources by pk", + "className": "api-method put" + } + ], + "key": "api-category-security-permissions-on-resources-(view-menus)" + }, + { + "type": "category", + "label": "Security Resources (View Menus)", + "link": { + "type": "doc", + "id": "api/security-resources-view-menus" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-security-resources", + "label": "Get security resources", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-security-resources", + "label": "Create security resources", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-security-resources-info", + "label": "Get security resources info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-security-resources-by-pk", + "label": "Delete security resources by pk", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-security-resources-by-pk", + "label": "Get security resources by pk", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-security-resources-by-pk", + "label": "Update security resources by pk", + "className": "api-method put" + } + ], + "key": "api-category-security-resources-(view-menus)" + }, + { + "type": "category", + "label": "Security Roles", + "link": { + "type": "doc", + "id": "api/security-roles" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-security-roles", + "label": "Get security roles", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-security-roles", + "label": "Create security roles", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-security-roles-info", + "label": "Get security roles info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/list-roles", + "label": "List roles", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-security-roles-by-pk", + "label": "Delete security roles by pk", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-security-roles-by-pk", + "label": "Get security roles by pk", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-security-roles-by-pk", + "label": "Update security roles by pk", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/create-security-roles-by-role-id-permissions", + "label": "Create security roles by role_id permissions", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-security-roles-by-role-id-permissions", + "label": "Get security roles by role_id permissions", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-security-roles-by-role-id-users", + "label": "Update security roles by role_id users", + "className": "api-method put" + } + ], + "key": "api-category-security-roles" + }, + { + "type": "category", + "label": "Security Users", + "link": { + "type": "doc", + "id": "api/security-users" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-security-users", + "label": "Get security users", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-security-users", + "label": "Create security users", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-security-users-info", + "label": "Get security users info", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/delete-security-users-by-pk", + "label": "Delete security users by pk", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-security-users-by-pk", + "label": "Get security users by pk", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-security-users-by-pk", + "label": "Update security users by pk", + "className": "api-method put" + } + ], + "key": "api-category-security-users" + }, + { + "type": "category", + "label": "Tags", + "link": { + "type": "doc", + "id": "api/tags" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/bulk-delete-tags", + "label": "Bulk delete tags", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-list-of-tags", + "label": "Get a list of tags", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/create-a-tag", + "label": "Create a tag", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-metadata-information-about-tag-api-endpoints", + "label": "Get metadata information about tag API endpoints", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/bulk-create-tags-and-tagged-objects", + "label": "Bulk create tags and tagged objects", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/get-tag-favorite-status", + "label": "Get tag favorite status", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-all-objects-associated-with-a-tag", + "label": "Get all objects associated with a tag", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/get-related-fields-data-tag-related-column-name", + "label": "Get related fields data (tag-related-column-name)", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/add-tags-to-an-object", + "label": "Add tags to an object", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/delete-a-tagged-object", + "label": "Delete a tagged object", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/delete-a-tag", + "label": "Delete a tag", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/get-a-tag-detail-information", + "label": "Get a tag detail information", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/update-a-tag", + "label": "Update a tag", + "className": "api-method put" + }, + { + "type": "doc", + "id": "api/delete-tag-by-pk-favorites", + "label": "Delete tag by pk favorites", + "className": "api-method delete" + }, + { + "type": "doc", + "id": "api/create-tag-by-pk-favorites", + "label": "Create tag by pk favorites", + "className": "api-method post" + } + ], + "key": "api-category-tags" + }, + { + "type": "category", + "label": "User", + "link": { + "type": "doc", + "id": "api/user" + }, + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/get-the-user-avatar", + "label": "Get the user avatar", + "className": "api-method get" + } + ], + "key": "api-category-user" + }, + { + "type": "category", + "label": "Schemas", + "collapsible": true, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/schemas/advanceddatatypeschema", + "label": "AdvancedDataTypeSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayer", + "label": "AnnotationLayer", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-get", + "label": "AnnotationLayerRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-get-list", + "label": "AnnotationLayerRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-get-list-user", + "label": "AnnotationLayerRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-get-list-user-1", + "label": "AnnotationLayerRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-post", + "label": "AnnotationLayerRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationlayerrestapi-put", + "label": "AnnotationLayerRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-get", + "label": "AnnotationRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-get-annotationlayer", + "label": "AnnotationRestApi.get.AnnotationLayer", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-get-list", + "label": "AnnotationRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-get-list-user", + "label": "AnnotationRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-get-list-user-1", + "label": "AnnotationRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-post", + "label": "AnnotationRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/annotationrestapi-put", + "label": "AnnotationRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/availabledomainsschema", + "label": "AvailableDomainsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/cacheinvalidationrequestschema", + "label": "CacheInvalidationRequestSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/cacherestapi-get", + "label": "CacheRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/cacherestapi-get-list", + "label": "CacheRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/cacherestapi-post", + "label": "CacheRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/cacherestapi-put", + "label": "CacheRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/catalogsresponseschema", + "label": "CatalogsResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartcachescreenshotresponseschema", + "label": "ChartCacheScreenshotResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartcachewarmuprequestschema", + "label": "ChartCacheWarmUpRequestSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartcachewarmupresponseschema", + "label": "ChartCacheWarmUpResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartcachewarmupresponsesingle", + "label": "ChartCacheWarmUpResponseSingle", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataadhocmetricschema", + "label": "ChartDataAdhocMetricSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataaggregateoptionsschema", + "label": "ChartDataAggregateOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataasyncresponseschema", + "label": "ChartDataAsyncResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataboxplotoptionsschema", + "label": "ChartDataBoxplotOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatacolumn", + "label": "ChartDataColumn", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatacontributionoptionsschema", + "label": "ChartDataContributionOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatadatasource", + "label": "ChartDataDatasource", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataextras", + "label": "ChartDataExtras", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatafilter", + "label": "ChartDataFilter", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatageodeticparseoptionsschema", + "label": "ChartDataGeodeticParseOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatageohashdecodeoptionsschema", + "label": "ChartDataGeohashDecodeOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatageohashencodeoptionsschema", + "label": "ChartDataGeohashEncodeOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatapivotoptionsschema", + "label": "ChartDataPivotOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatapostprocessingoperation", + "label": "ChartDataPostProcessingOperation", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataprophetoptionsschema", + "label": "ChartDataProphetOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataquerycontextschema", + "label": "ChartDataQueryContextSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataqueryobject", + "label": "ChartDataQueryObject", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataresponseresult", + "label": "ChartDataResponseResult", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataresponseschema", + "label": "ChartDataResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get", + "label": "ChartDataRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-dashboard", + "label": "ChartDataRestApi.get.Dashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-tag", + "label": "ChartDataRestApi.get.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-user", + "label": "ChartDataRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list", + "label": "ChartDataRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-dashboard", + "label": "ChartDataRestApi.get_list.Dashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-sqlatable", + "label": "ChartDataRestApi.get_list.SqlaTable", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-tag", + "label": "ChartDataRestApi.get_list.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-user", + "label": "ChartDataRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-user-1", + "label": "ChartDataRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-user-2", + "label": "ChartDataRestApi.get_list.User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-get-list-user-3", + "label": "ChartDataRestApi.get_list.User3", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-post", + "label": "ChartDataRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarestapi-put", + "label": "ChartDataRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatarollingoptionsschema", + "label": "ChartDataRollingOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdataselectoptionsschema", + "label": "ChartDataSelectOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartdatasortoptionsschema", + "label": "ChartDataSortOptionsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartentityresponseschema", + "label": "ChartEntityResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartfavstarresponseresult", + "label": "ChartFavStarResponseResult", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartgetdatasourceobjectdataresponse", + "label": "ChartGetDatasourceObjectDataResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartgetdatasourceobjectresponse", + "label": "ChartGetDatasourceObjectResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartgetdatasourceresponseschema", + "label": "ChartGetDatasourceResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get", + "label": "ChartRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-dashboard", + "label": "ChartRestApi.get.Dashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-tag", + "label": "ChartRestApi.get.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-user", + "label": "ChartRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list", + "label": "ChartRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-dashboard", + "label": "ChartRestApi.get_list.Dashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-sqlatable", + "label": "ChartRestApi.get_list.SqlaTable", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-tag", + "label": "ChartRestApi.get_list.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-user", + "label": "ChartRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-user-1", + "label": "ChartRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-user-2", + "label": "ChartRestApi.get_list.User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-get-list-user-3", + "label": "ChartRestApi.get_list.User3", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-post", + "label": "ChartRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/chartrestapi-put", + "label": "ChartRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get", + "label": "CssTemplateRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get-user", + "label": "CssTemplateRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get-user-1", + "label": "CssTemplateRestApi.get.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get-list", + "label": "CssTemplateRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get-list-user", + "label": "CssTemplateRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-get-list-user-1", + "label": "CssTemplateRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-post", + "label": "CssTemplateRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/csstemplaterestapi-put", + "label": "CssTemplateRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardcachescreenshotresponseschema", + "label": "DashboardCacheScreenshotResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardcopyschema", + "label": "DashboardCopySchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboarddatasetschema", + "label": "DashboardDatasetSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardgetresponseschema", + "label": "DashboardGetResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardpermalinkstateschema", + "label": "DashboardPermalinkStateSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get", + "label": "DashboardRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list", + "label": "DashboardRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list-role", + "label": "DashboardRestApi.get_list.Role", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list-tag", + "label": "DashboardRestApi.get_list.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list-user", + "label": "DashboardRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list-user-1", + "label": "DashboardRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-get-list-user-2", + "label": "DashboardRestApi.get_list.User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-post", + "label": "DashboardRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardrestapi-put", + "label": "DashboardRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/database", + "label": "Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/database-1", + "label": "Database1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaseconnectionschema", + "label": "DatabaseConnectionSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databasefunctionnamesresponse", + "label": "DatabaseFunctionNamesResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserelatedchart", + "label": "DatabaseRelatedChart", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserelatedcharts", + "label": "DatabaseRelatedCharts", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserelateddashboard", + "label": "DatabaseRelatedDashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserelateddashboards", + "label": "DatabaseRelatedDashboards", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserelatedobjectsresponse", + "label": "DatabaseRelatedObjectsResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-get", + "label": "DatabaseRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-get-list", + "label": "DatabaseRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-get-list-user", + "label": "DatabaseRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-get-list-user-1", + "label": "DatabaseRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-post", + "label": "DatabaseRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaserestapi-put", + "label": "DatabaseRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databasesshtunnel", + "label": "DatabaseSSHTunnel", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databaseschemaaccessforfileuploadresponse", + "label": "DatabaseSchemaAccessForFileUploadResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databasetablesresponse", + "label": "DatabaseTablesResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databasetestconnectionschema", + "label": "DatabaseTestConnectionSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/databasevalidateparametersschema", + "label": "DatabaseValidateParametersSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dataset", + "label": "Dataset", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcachewarmuprequestschema", + "label": "DatasetCacheWarmUpRequestSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcachewarmupresponseschema", + "label": "DatasetCacheWarmUpResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcachewarmupresponsesingle", + "label": "DatasetCacheWarmUpResponseSingle", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcolumnsput", + "label": "DatasetColumnsPut", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcolumnsrestapi-get", + "label": "DatasetColumnsRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcolumnsrestapi-get-list", + "label": "DatasetColumnsRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcolumnsrestapi-post", + "label": "DatasetColumnsRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetcolumnsrestapi-put", + "label": "DatasetColumnsRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetduplicateschema", + "label": "DatasetDuplicateSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetmetricrestapi-get", + "label": "DatasetMetricRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetmetricrestapi-get-list", + "label": "DatasetMetricRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetmetricrestapi-post", + "label": "DatasetMetricRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetmetricrestapi-put", + "label": "DatasetMetricRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetmetricsput", + "label": "DatasetMetricsPut", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrelatedchart", + "label": "DatasetRelatedChart", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrelatedcharts", + "label": "DatasetRelatedCharts", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrelateddashboard", + "label": "DatasetRelatedDashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrelateddashboards", + "label": "DatasetRelatedDashboards", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrelatedobjectsresponse", + "label": "DatasetRelatedObjectsResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get", + "label": "DatasetRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-database", + "label": "DatasetRestApi.get.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-sqlmetric", + "label": "DatasetRestApi.get.SqlMetric", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-tablecolumn", + "label": "DatasetRestApi.get.TableColumn", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-user", + "label": "DatasetRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-user-1", + "label": "DatasetRestApi.get.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-user-2", + "label": "DatasetRestApi.get.User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-list", + "label": "DatasetRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-list-database", + "label": "DatasetRestApi.get_list.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-list-user", + "label": "DatasetRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-get-list-user-1", + "label": "DatasetRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-post", + "label": "DatasetRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasetrestapi-put", + "label": "DatasetRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/datasource", + "label": "Datasource", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/distincresponseschema", + "label": "DistincResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/distinctresultresponse", + "label": "DistinctResultResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardconfig", + "label": "EmbeddedDashboardConfig", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardresponseschema", + "label": "EmbeddedDashboardResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardrestapi-get", + "label": "EmbeddedDashboardRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardrestapi-get-list", + "label": "EmbeddedDashboardRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardrestapi-post", + "label": "EmbeddedDashboardRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/embeddeddashboardrestapi-put", + "label": "EmbeddedDashboardRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/engineinformation", + "label": "EngineInformation", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/estimatequerycostschema", + "label": "EstimateQueryCostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/executepayloadschema", + "label": "ExecutePayloadSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/explorecontextschema", + "label": "ExploreContextSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/explorepermalinkstateschema", + "label": "ExplorePermalinkStateSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/folder", + "label": "Folder", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/formdatapostschema", + "label": "FormDataPostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/formdataputschema", + "label": "FormDataPutSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/getfavstaridsschema", + "label": "GetFavStarIdsSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/getorcreatedatasetschema", + "label": "GetOrCreateDatasetSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/guesttokencreate", + "label": "GuestTokenCreate", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/importv-1-database", + "label": "ImportV1Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/importv-1-databaseextra", + "label": "ImportV1DatabaseExtra", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-get", + "label": "LogRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-get-user", + "label": "LogRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-get-list", + "label": "LogRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-get-list-user", + "label": "LogRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-post", + "label": "LogRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/logrestapi-put", + "label": "LogRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionapi-get", + "label": "PermissionApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionapi-get-list", + "label": "PermissionApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionapi-post", + "label": "PermissionApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionapi-put", + "label": "PermissionApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get", + "label": "PermissionViewMenuApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get-permission", + "label": "PermissionViewMenuApi.get.Permission", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get-viewmenu", + "label": "PermissionViewMenuApi.get.ViewMenu", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get-list", + "label": "PermissionViewMenuApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get-list-permission", + "label": "PermissionViewMenuApi.get_list.Permission", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-get-list-viewmenu", + "label": "PermissionViewMenuApi.get_list.ViewMenu", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-post", + "label": "PermissionViewMenuApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/permissionviewmenuapi-put", + "label": "PermissionViewMenuApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryexecutionresponseschema", + "label": "QueryExecutionResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryrestapi-get", + "label": "QueryRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryrestapi-get-database", + "label": "QueryRestApi.get.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryrestapi-get-list", + "label": "QueryRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryrestapi-post", + "label": "QueryRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryrestapi-put", + "label": "QueryRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queryresult", + "label": "QueryResult", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rlsrestapi-get", + "label": "RLSRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rlsrestapi-get-list", + "label": "RLSRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rlsrestapi-post", + "label": "RLSRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rlsrestapi-put", + "label": "RLSRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/recentactivity", + "label": "RecentActivity", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/recentactivityresponseschema", + "label": "RecentActivityResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/recentactivityschema", + "label": "RecentActivitySchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/relatedresponseschema", + "label": "RelatedResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/relatedresultresponse", + "label": "RelatedResultResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportexecutionlogrestapi-get", + "label": "ReportExecutionLogRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportexecutionlogrestapi-get-list", + "label": "ReportExecutionLogRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportexecutionlogrestapi-post", + "label": "ReportExecutionLogRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportexecutionlogrestapi-put", + "label": "ReportExecutionLogRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportrecipient", + "label": "ReportRecipient", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportrecipientconfigjson", + "label": "ReportRecipientConfigJSON", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get", + "label": "ReportScheduleRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-dashboard", + "label": "ReportScheduleRestApi.get.Dashboard", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-database", + "label": "ReportScheduleRestApi.get.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-reportrecipients", + "label": "ReportScheduleRestApi.get.ReportRecipients", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-slice", + "label": "ReportScheduleRestApi.get.Slice", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-user", + "label": "ReportScheduleRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-list", + "label": "ReportScheduleRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-list-reportrecipients", + "label": "ReportScheduleRestApi.get_list.ReportRecipients", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-list-user", + "label": "ReportScheduleRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-list-user-1", + "label": "ReportScheduleRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-get-list-user-2", + "label": "ReportScheduleRestApi.get_list.User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-post", + "label": "ReportScheduleRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/reportschedulerestapi-put", + "label": "ReportScheduleRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/resource", + "label": "Resource", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rlsrule", + "label": "RlsRule", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rolepermissionlistschema", + "label": "RolePermissionListSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rolepermissionpostschema", + "label": "RolePermissionPostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/roleresponseschema", + "label": "RoleResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/roleuserputschema", + "label": "RoleUserPutSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/roles", + "label": "Roles", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/roles-1", + "label": "Roles1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/rolesresponseschema", + "label": "RolesResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/sqllabbootstrapschema", + "label": "SQLLabBootstrapSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get", + "label": "SavedQueryRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-database", + "label": "SavedQueryRestApi.get.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-user", + "label": "SavedQueryRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-user-1", + "label": "SavedQueryRestApi.get.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-list", + "label": "SavedQueryRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-list-database", + "label": "SavedQueryRestApi.get_list.Database", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-list-tag", + "label": "SavedQueryRestApi.get_list.Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-list-user", + "label": "SavedQueryRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-get-list-user-1", + "label": "SavedQueryRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-post", + "label": "SavedQueryRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/savedqueryrestapi-put", + "label": "SavedQueryRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/schemasresponseschema", + "label": "SchemasResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/selectstarresponseschema", + "label": "SelectStarResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/slice", + "label": "Slice", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/sqllabpermalinkschema", + "label": "SqlLabPermalinkSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/stopqueryschema", + "label": "StopQuerySchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetroleapi-get", + "label": "SupersetRoleApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetroleapi-get-list", + "label": "SupersetRoleApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetroleapi-post", + "label": "SupersetRoleApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetroleapi-put", + "label": "SupersetRoleApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get", + "label": "SupersetUserApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-role", + "label": "SupersetUserApi.get.Role", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-user", + "label": "SupersetUserApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-user-1", + "label": "SupersetUserApi.get.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-list", + "label": "SupersetUserApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-list-role", + "label": "SupersetUserApi.get_list.Role", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-list-user", + "label": "SupersetUserApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-get-list-user-1", + "label": "SupersetUserApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-post", + "label": "SupersetUserApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/supersetuserapi-put", + "label": "SupersetUserApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tab", + "label": "Tab", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tabstate", + "label": "TabState", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/table", + "label": "Table", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tableextrametadataresponseschema", + "label": "TableExtraMetadataResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tablemetadatacolumnsresponse", + "label": "TableMetadataColumnsResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tablemetadataforeignkeysindexesresponse", + "label": "TableMetadataForeignKeysIndexesResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tablemetadataoptionsresponse", + "label": "TableMetadataOptionsResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tablemetadataprimarykeyresponse", + "label": "TableMetadataPrimaryKeyResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tablemetadataresponseschema", + "label": "TableMetadataResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tables", + "label": "Tables", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tabspayloadschema", + "label": "TabsPayloadSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tag", + "label": "Tag", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/taggetresponseschema", + "label": "TagGetResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagobject", + "label": "TagObject", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagpostbulkresponseobject", + "label": "TagPostBulkResponseObject", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagpostbulkresponseschema", + "label": "TagPostBulkResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagpostbulkschema", + "label": "TagPostBulkSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get", + "label": "TagRestApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get-user", + "label": "TagRestApi.get.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get-user-1", + "label": "TagRestApi.get.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get-list", + "label": "TagRestApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get-list-user", + "label": "TagRestApi.get_list.User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-get-list-user-1", + "label": "TagRestApi.get_list.User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-post", + "label": "TagRestApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/tagrestapi-put", + "label": "TagRestApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/taggedobjectentityresponseschema", + "label": "TaggedObjectEntityResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/temporarycachepostschema", + "label": "TemporaryCachePostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/temporarycacheputschema", + "label": "TemporaryCachePutSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/uploadfilemetadata", + "label": "UploadFileMetadata", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/uploadfilemetadataitem", + "label": "UploadFileMetadataItem", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/uploadfilemetadatapostschema", + "label": "UploadFileMetadataPostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/uploadpostschema", + "label": "UploadPostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/user", + "label": "User", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/user-1", + "label": "User1", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/user-2", + "label": "User2", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/userresponseschema", + "label": "UserResponseSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/validatesqlrequest", + "label": "ValidateSQLRequest", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/validatesqlresponse", + "label": "ValidateSQLResponse", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/validatorconfigjson", + "label": "ValidatorConfigJSON", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/viewmenuapi-get", + "label": "ViewMenuApi.get", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/viewmenuapi-get-list", + "label": "ViewMenuApi.get_list", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/viewmenuapi-post", + "label": "ViewMenuApi.post", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/viewmenuapi-put", + "label": "ViewMenuApi.put", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/advanced-data-type-convert-schema", + "label": "advanced_data_type_convert_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/database-catalogs-query-schema", + "label": "database_catalogs_query_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/database-schemas-query-schema", + "label": "database_schemas_query_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/database-tables-query-schema", + "label": "database_tables_query_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/delete-tags-schema", + "label": "delete_tags_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-delete-ids-schema", + "label": "get_delete_ids_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-export-ids-schema", + "label": "get_export_ids_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-fav-star-ids-schema", + "label": "get_fav_star_ids_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-info-schema", + "label": "get_info_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-item-schema", + "label": "get_item_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-list-schema", + "label": "get_list_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-recent-activity-schema", + "label": "get_recent_activity_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-related-schema", + "label": "get_related_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/queries-get-updated-since-schema", + "label": "queries_get_updated_since_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/screenshot-query-schema", + "label": "screenshot_query_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/sql-lab-get-results-schema", + "label": "sql_lab_get_results_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/thumbnail-query-schema", + "label": "thumbnail_query_schema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardscreenshotpostschema", + "label": "DashboardScreenshotPostSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardnativefiltersconfigupdateschema", + "label": "DashboardNativeFiltersConfigUpdateSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/dashboardcolorsconfigupdateschema", + "label": "DashboardColorsConfigUpdateSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/formatquerypayloadschema", + "label": "FormatQueryPayloadSchema", + "className": "schema" + }, + { + "type": "doc", + "id": "api/schemas/get-slack-channels-schema", + "label": "get_slack_channels_schema", + "className": "schema" + } + ], + "key": "api-category-schemas" + } + ] + } + ] +} diff --git a/docs/developer_docs_versions.json b/docs/developer_docs_versions.json new file mode 100644 index 00000000000..fc7d70bb315 --- /dev/null +++ b/docs/developer_docs_versions.json @@ -0,0 +1,3 @@ +[ + "6.1.0" +] diff --git a/docs/developer_portal_versions.json b/docs/developer_portal_versions.json deleted file mode 100644 index fe51488c706..00000000000 --- a/docs/developer_portal_versions.json +++ /dev/null @@ -1 +0,0 @@ -[] diff --git a/docs/package.json b/docs/package.json index 86b2188de96..cc9a2e5b200 100644 --- a/docs/package.json +++ b/docs/package.json @@ -33,10 +33,12 @@ "version:add": "node scripts/manage-versions.mjs add", "version:remove": "node scripts/manage-versions.mjs remove", "version:add:docs": "node scripts/manage-versions.mjs add docs", - "version:add:developer_portal": "node scripts/manage-versions.mjs add developer_portal", + "version:add:admin_docs": "node scripts/manage-versions.mjs add admin_docs", + "version:add:developer_docs": "node scripts/manage-versions.mjs add developer_docs", "version:add:components": "node scripts/manage-versions.mjs add components", "version:remove:docs": "node scripts/manage-versions.mjs remove docs", - "version:remove:developer_portal": "node scripts/manage-versions.mjs remove developer_portal", + "version:remove:admin_docs": "node scripts/manage-versions.mjs remove admin_docs", + "version:remove:developer_docs": "node scripts/manage-versions.mjs remove developer_docs", "version:remove:components": "node scripts/manage-versions.mjs remove components" }, "dependencies": { diff --git a/docs/scripts/manage-versions.mjs b/docs/scripts/manage-versions.mjs index d96dfc355a9..060dbe6ef93 100644 --- a/docs/scripts/manage-versions.mjs +++ b/docs/scripts/manage-versions.mjs @@ -32,7 +32,7 @@ const CONFIG_FILE = path.join(__dirname, '..', 'versions-config.json'); // Parse command line arguments const args = process.argv.slice(2); const command = args[0]; // 'add' or 'remove' -const section = args[1]; // 'docs', 'developer_portal', or 'components' +const section = args[1]; // 'docs', 'developer_docs', or 'components' const version = args[2]; // version string like '1.2.0' function loadConfig() { @@ -43,36 +43,41 @@ function saveConfig(config) { fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2) + '\n'); } -function fixVersionedImports(version) { - const versionedDocsPath = path.join(__dirname, '..', 'versioned_docs', `version-${version}`); +function fixVersionedImports(section, version) { + // Versioned content lands one directory deeper than the source content, + // so any `../../src/` or `../../data/` imports in .md/.mdx files need + // an extra `../` to keep reaching docs/src and docs/data. + const versionedDocsDir = section === 'docs' + ? `versioned_docs/version-${version}` + : `${section}_versioned_docs/version-${version}`; + const versionedDocsPath = path.join(__dirname, '..', versionedDocsDir); - // Files that need import path fixes - const filesToFix = [ - 'contributing/resources.mdx', - 'configuration/country-map-tools.mdx' - ]; + if (!fs.existsSync(versionedDocsPath)) { + return; + } - console.log(` Fixing relative imports in versioned docs...`); + console.log(` Fixing relative imports in ${versionedDocsDir}...`); - filesToFix.forEach(filePath => { - const fullPath = path.join(versionedDocsPath, filePath); - if (fs.existsSync(fullPath)) { - let content = fs.readFileSync(fullPath, 'utf8'); - - // Fix imports that go up two directories to go up three instead - content = content.replace( - /from ['"]\.\.\/\.\.\/src\//g, - "from '../../../src/" - ); - content = content.replace( - /from ['"]\.\.\/\.\.\/data\//g, - "from '../../../data/" - ); - - fs.writeFileSync(fullPath, content); - console.log(` Fixed imports in ${filePath}`); + function walk(dir) { + for (const entry of fs.readdirSync(dir, { withFileTypes: true })) { + const fullPath = path.join(dir, entry.name); + if (entry.isDirectory()) { + walk(fullPath); + } else if (entry.isFile() && /\.(md|mdx)$/.test(entry.name)) { + const original = fs.readFileSync(fullPath, 'utf8'); + const updated = original + .replace(/from ['"]\.\.\/\.\.\/src\//g, "from '../../../src/") + .replace(/from ['"]\.\.\/\.\.\/data\//g, "from '../../../data/"); + if (updated !== original) { + fs.writeFileSync(fullPath, updated); + const rel = path.relative(versionedDocsPath, fullPath); + console.log(` Fixed imports in ${rel}`); + } + } } - }); + } + + walk(versionedDocsPath); } function addVersion(section, version) { @@ -103,10 +108,8 @@ function addVersion(section, version) { process.exit(1); } - // Fix relative imports in versioned docs (for main docs section only) - if (section === 'docs') { - fixVersionedImports(version); - } + // Fix relative imports in versioned content + fixVersionedImports(section, version); // Update config // Add to onlyIncludeVersions array (after 'current') @@ -215,12 +218,12 @@ Usage: node scripts/manage-versions.js remove
Where: - - section: 'docs', 'developer_portal', or 'components' + - section: 'docs', 'developer_docs', or 'components' - version: version string (e.g., '1.2.0', '2.0.0') Examples: node scripts/manage-versions.js add docs 2.0.0 - node scripts/manage-versions.js add developer_portal 1.3.0 + node scripts/manage-versions.js add developer_docs 1.3.0 node scripts/manage-versions.js remove components 1.0.0 `); } diff --git a/docs/src/theme/DocVersionBadge/index.js b/docs/src/theme/DocVersionBadge/index.js index a76ced7e254..c5791fb75a5 100644 --- a/docs/src/theme/DocVersionBadge/index.js +++ b/docs/src/theme/DocVersionBadge/index.js @@ -40,8 +40,8 @@ export default function DocVersionBadge() { const isVersioned = [ 'default', // main docs 'components', - 'tutorials', - 'developer_portal', + 'admin_docs', + 'developer_docs', ].includes(pluginId); const { preferredVersion } = useDocsPreferredVersion(pluginId); diff --git a/docs/src/theme/DocVersionBanner/index.js b/docs/src/theme/DocVersionBanner/index.js index 3704128bedc..2a0e91a2dde 100644 --- a/docs/src/theme/DocVersionBanner/index.js +++ b/docs/src/theme/DocVersionBanner/index.js @@ -37,9 +37,8 @@ export default function DocVersionBannerWrapper(props) { const pluginId = activePlugin?.pluginId; const [versionedPath, setVersionedPath] = useState(''); - // Only show version selector for tutorials - // Main docs, components, and developer_portal use the DocVersionBadge component instead - const isVersioned = pluginId && ['tutorials'].includes(pluginId); + // Versioned sections use the DocVersionBadge component instead of this banner + const isVersioned = false; const { preferredVersion } = useDocsPreferredVersion(pluginId); const versions = useVersions(pluginId); diff --git a/docs/tutorials_versions.json b/docs/tutorials_versions.json deleted file mode 100644 index 5e1abcd8a61..00000000000 --- a/docs/tutorials_versions.json +++ /dev/null @@ -1,3 +0,0 @@ -[ - "1.0.0" -] diff --git a/docs/versioned_docs/version-6.1.0/databases/_category_.json b/docs/versioned_docs/version-6.1.0/databases/_category_.json new file mode 100644 index 00000000000..6276c6d10fd --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Databases", + "position": 1, + "link": { + "type": "doc", + "id": "databases/index" + } +} diff --git a/docs/versioned_docs/version-6.1.0/databases/index.mdx b/docs/versioned_docs/version-6.1.0/databases/index.mdx new file mode 100644 index 00000000000..26b1d64af1f --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/index.mdx @@ -0,0 +1,93 @@ +--- +title: Connecting to Databases +sidebar_label: Overview +sidebar_position: 1 +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabaseIndex } from '@site/src/components/databases'; +import databaseData from '@site/src/data/databases.json'; + +# Connecting to Databases + +Superset does not ship bundled with connectivity to databases. The main step in connecting +Superset to a database is to **install the proper database driver(s)** in your environment. + +:::note +You'll need to install the required packages for the database you want to use as your metadata database +as well as the packages needed to connect to the databases you want to access through Superset. +For information about setting up Superset's metadata database, please refer to +installation documentations ([Docker Compose](/admin-docs/installation/docker-compose), [Kubernetes](/admin-docs/installation/kubernetes)) +::: + +## Supported Databases + +Superset supports **80 databases** with varying levels of feature support. +Click on any database name to see detailed documentation including connection strings, +authentication methods, and configuration options. + + + +## Installing Database Drivers + +Superset requires a Python [DB-API database driver](https://peps.python.org/pep-0249/) +and a [SQLAlchemy dialect](https://docs.sqlalchemy.org/en/20/dialects/) to be installed for +each database engine you want to connect to. + +### Installing Drivers in Docker + +For Docker deployments, create a `requirements-local.txt` file in the `docker` directory: + +```bash +# Create the requirements file +touch ./docker/requirements-local.txt + +# Add your driver (e.g., for PostgreSQL) +echo "psycopg2-binary" >> ./docker/requirements-local.txt +``` + +Then restart your containers. The drivers will be installed automatically. + +### Installing Drivers with pip + +For non-Docker installations: + +```bash +pip install +``` + +See individual database pages for the specific driver packages needed. + +## Connecting Through the UI + +1. Go to **Settings → Data: Database Connections** +2. Click **+ DATABASE** +3. Select your database type or enter a SQLAlchemy URI +4. Click **Test Connection** to verify +5. Click **Connect** to save + +## Contributing + +To add or update database documentation, add a `metadata` attribute to your engine spec class in +`superset/db_engine_specs/`. Documentation is auto-generated from these metadata attributes. + +See [METADATA_STATUS.md](https://github.com/apache/superset/blob/master/superset/db_engine_specs/METADATA_STATUS.md) +for the current status of database documentation and the [README](https://github.com/apache/superset/blob/master/superset/db_engine_specs/README.md) for the metadata schema. diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/_category_.json b/docs/versioned_docs/version-6.1.0/databases/supported/_category_.json new file mode 100644 index 00000000000..77f16461c1b --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "Supported Databases", + "position": 2, + "collapsed": true, + "collapsible": true +} diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/amazon-athena.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-athena.mdx new file mode 100644 index 00000000000..f35c2b9f003 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-athena.mdx @@ -0,0 +1,31 @@ +--- +title: Amazon Athena +sidebar_label: Amazon Athena +description: "Amazon Athena is an interactive query service for analyzing data in S3 using SQL." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.athena","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":false,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":30,"max_score":201,"documentation":{"description":"Amazon Athena is an interactive query service for analyzing data in S3 using SQL.","logo":"amazon-athena.jpg","homepage_url":"https://aws.amazon.com/athena/","categories":["Cloud - AWS","Query Engines","Proprietary"],"pypi_packages":["pyathena[pandas]"],"connection_string":"awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","drivers":[{"name":"PyAthena (REST)","pypi_package":"pyathena[pandas]","connection_string":"awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","is_recommended":true,"notes":"No Java required. URL-encode special characters (e.g., s3:// -> s3%3A//)."},{"name":"PyAthenaJDBC","pypi_package":"PyAthenaJDBC","connection_string":"awsathena+jdbc://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","is_recommended":false,"notes":"Requires Amazon Athena JDBC driver."}],"engine_parameters":[{"name":"IAM Role Assumption","description":"Assume a specific IAM role for queries","json":{"connect_args":{"role_arn":""}}}],"notes":"URL-encode special characters in s3_staging_dir (e.g., s3:// becomes s3%3A//).","category":"Cloud - AWS","custom_errors":[{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"awsathena","engine_name":"Amazon Athena","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/amazon-dynamodb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-dynamodb.mdx new file mode 100644 index 00000000000..8801bdfdedb --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-dynamodb.mdx @@ -0,0 +1,31 @@ +--- +title: Amazon DynamoDB +sidebar_label: Amazon DynamoDB +description: "Amazon DynamoDB is a serverless NoSQL database with SQL via PartiQL." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.dynamodb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":32,"max_score":201,"documentation":{"description":"Amazon DynamoDB is a serverless NoSQL database with SQL via PartiQL.","logo":"aws.png","homepage_url":"https://aws.amazon.com/dynamodb/","categories":["Cloud - AWS","Search & NoSQL","Proprietary"],"pypi_packages":["pydynamodb"],"connection_string":"dynamodb://{aws_access_key_id}:{aws_secret_access_key}@dynamodb.{region}.amazonaws.com:443?connector=superset","parameters":{"aws_access_key_id":"AWS access key ID","aws_secret_access_key":"AWS secret access key","region":"AWS region (e.g., us-east-1)"},"notes":"Uses PartiQL for SQL queries. Requires connector=superset parameter.","docs_url":"https://github.com/passren/PyDynamoDB","category":"Cloud - AWS"},"engine":"dynamodb","engine_name":"Amazon DynamoDB","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/amazon-redshift.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-redshift.mdx new file mode 100644 index 00000000000..fc8e603dcd7 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-redshift.mdx @@ -0,0 +1,31 @@ +--- +title: Amazon Redshift +sidebar_label: Amazon Redshift +description: "Amazon Redshift is a fully managed data warehouse service." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.redshift","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":127,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":44,"max_score":201,"documentation":{"description":"Amazon Redshift is a fully managed data warehouse service.","logo":"redshift.png","homepage_url":"https://aws.amazon.com/redshift/","categories":["Cloud - AWS","Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-redshift"],"connection_string":"redshift+psycopg2://{username}:{password}@{host}:5439/{database}","default_port":5439,"parameters":{"username":"Database username","password":"Database password","host":"AWS Endpoint","port":"Default 5439","database":"Database name"},"drivers":[{"name":"psycopg2","pypi_package":"psycopg2","connection_string":"redshift+psycopg2://{username}:{password}@{host}:5439/{database}","is_recommended":true},{"name":"redshift_connector","pypi_package":"redshift_connector","connection_string":"redshift+redshift_connector://{username}:{password}@{host}:5439/{database}","is_recommended":false,"notes":"Supports IAM-based credentials for clusters and serverless."}],"authentication_methods":[{"name":"IAM Credentials (Cluster)","description":"Use IAM-based temporary database credentials for Redshift clusters","requirements":"IAM role must have redshift:GetClusterCredentials permission","connection_string":"redshift+redshift_connector://","engine_parameters":{"connect_args":{"iam":true,"database":"","cluster_identifier":"","db_user":""}}},{"name":"IAM Role (Serverless)","description":"Authenticate using the IAM role attached to the environment (EC2 instance profile, ECS task role, etc.). No credentials needed.","requirements":"The attached IAM role must have redshift-serverless:GetCredentials and redshift-serverless:GetWorkgroup permissions.","connection_string":"redshift+redshift_connector://","engine_parameters":{"connect_args":{"iam":true,"is_serverless":true,"serverless_acct_id":"","serverless_work_group":"","database":"","user":"IAMR:"}}},{"name":"IAM Access Key (Serverless)","description":"Authenticate using explicit AWS access key and secret. Suitable for local development or CI environments without an attached IAM role.","requirements":"The IAM user must have redshift-serverless:GetCredentials and redshift-serverless:GetWorkgroup permissions.","connection_string":"redshift+redshift_connector://","engine_parameters":{"connect_args":{"iam":true,"is_serverless":true,"serverless_acct_id":"","serverless_work_group":"","database":"","host":"","port":5439,"region":"","access_key_id":"","secret_access_key":""}}}],"category":"Cloud - AWS","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"We were unable to connect to your database named \"%(database)s\". Please verify your database name and try again.","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]}]},"engine":"redshift","engine_name":"Amazon Redshift","engine_aliases":[],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-doris.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-doris.mdx new file mode 100644 index 00000000000..0a247898693 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-doris.mdx @@ -0,0 +1,31 @@ +--- +title: Apache Doris +sidebar_label: Apache Doris +description: "Apache Doris is a high-performance real-time analytical database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.doris","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":79,"max_score":201,"documentation":{"description":"Apache Doris is a high-performance real-time analytical database.","logo":"doris.png","homepage_url":"https://doris.apache.org/","categories":["Apache Projects","Analytical Databases","Open Source"],"pypi_packages":["pydoris"],"connection_string":"doris://{username}:{password}@{host}:{port}/{catalog}.{database}","default_port":9030,"parameters":{"username":"User name","password":"Password","host":"Doris FE Host","port":"Doris FE port","catalog":"Catalog name","database":"Database name"},"category":"Apache Projects","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown Doris server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"pydoris","engine_name":"Apache Doris","engine_aliases":["doris"],"default_driver":"pydoris","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-drill.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-drill.mdx new file mode 100644 index 00000000000..0add8712554 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-drill.mdx @@ -0,0 +1,31 @@ +--- +title: Apache Drill +sidebar_label: Apache Drill +description: "Apache Drill is a schema-free SQL query engine for Hadoop and NoSQL." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.drill","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":50,"max_score":201,"documentation":{"description":"Apache Drill is a schema-free SQL query engine for Hadoop and NoSQL.","logo":"apache-drill.png","homepage_url":"https://drill.apache.org/","categories":["Apache Projects","Query Engines","Open Source"],"pypi_packages":["sqlalchemy-drill"],"connection_string":"drill+sadrill://{username}:{password}@{host}:{port}/{storage_plugin}?use_ssl=True","default_port":8047,"drivers":[{"name":"SQLAlchemy (REST)","pypi_package":"sqlalchemy-drill","connection_string":"drill+sadrill://{username}:{password}@{host}:{port}/{storage_plugin}?use_ssl=True","is_recommended":true},{"name":"JDBC","pypi_package":"sqlalchemy-drill","connection_string":"drill+jdbc://{username}:{password}@{host}:{port}","is_recommended":false,"notes":"Requires Drill JDBC Driver installation.","docs_url":"https://drill.apache.org/docs/using-the-jdbc-driver/"},{"name":"ODBC","pypi_package":"sqlalchemy-drill","is_recommended":false,"notes":"See Apache Drill documentation for ODBC setup.","docs_url":"https://drill.apache.org/docs/installing-the-driver-on-linux/"}],"connection_examples":[{"description":"Local embedded mode","connection_string":"drill+sadrill://localhost:8047/dfs?use_ssl=False"}],"category":"Apache Projects"},"engine":"drill","engine_name":"Apache Drill","engine_aliases":[],"default_driver":"sadrill","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-druid.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-druid.mdx new file mode 100644 index 00000000000..022c0a95267 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-druid.mdx @@ -0,0 +1,31 @@ +--- +title: Apache Druid +sidebar_label: Apache Druid +description: "Apache Druid is a high performance real-time analytics database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.druid","limit_method":1,"limit_clause":true,"joins":false,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":47,"max_score":201,"documentation":{"description":"Apache Druid is a high performance real-time analytics database.","logo":"druid.png","homepage_url":"https://druid.apache.org/","categories":["Apache Projects","Time Series Databases","Open Source"],"pypi_packages":["pydruid"],"connection_string":"druid://{username}:{password}@{host}:{port}/druid/v2/sql","default_port":9088,"parameters":{"username":"Database username","password":"Database password","host":"IP address or URL of the host","port":"Default 9088"},"ssl_configuration":{"custom_certificate":"Add certificate in Root Certificate field. pydruid will automatically use https.","disable_ssl_verification":{"engine_params":{"connect_args":{"scheme":"https","ssl_verify_cert":false}}}},"advanced_features":{"aggregations":"Define common aggregations in datasource edit view under List Druid Column tab.","post_aggregations":"Create metrics with postagg as Metric Type and provide valid JSON post-aggregation definition."},"notes":"A native Druid connector ships with Superset (behind DRUID_IS_ACTIVE flag) but SQLAlchemy connector via pydruid is preferred.","compatible_databases":[{"name":"Imply","description":"Imply is a fully-managed cloud platform and enterprise distribution built on Apache Druid. It provides real-time analytics with enterprise security and support.","logo":"imply.png","homepage_url":"https://imply.io/","categories":["Time Series Databases","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["pydruid"],"connection_string":"druid://{username}:{password}@{host}/druid/v2/sql","docs_url":"https://docs.imply.io/"}],"category":"Apache Projects"},"engine":"druid","engine_name":"Apache Druid","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-hive.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-hive.mdx new file mode 100644 index 00000000000..a23e84d1d98 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-hive.mdx @@ -0,0 +1,31 @@ +--- +title: Apache Hive +sidebar_label: Apache Hive +description: "Apache Hive is a data warehouse infrastructure built on Hadoop." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.hive","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":false,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":767,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":true,"expand_data":true,"query_cost_estimation":true,"sql_validation":false,"score":140,"max_score":201,"documentation":{"description":"Apache Hive is a data warehouse infrastructure built on Hadoop.","logo":"apache-hive.svg","homepage_url":"https://hive.apache.org/","categories":["Apache Projects","Query Engines","Open Source"],"pypi_packages":["pyhive"],"connection_string":"hive://hive@{hostname}:{port}/{database}","default_port":10000,"category":"Apache Projects"},"engine":"hive","engine_name":"Apache Hive","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-impala.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-impala.mdx new file mode 100644 index 00000000000..cf2ca004342 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-impala.mdx @@ -0,0 +1,31 @@ +--- +title: Apache Impala +sidebar_label: Apache Impala +description: "Apache Impala is an open-source massively parallel processing SQL query engine." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.impala","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":37,"max_score":201,"documentation":{"description":"Apache Impala is an open-source massively parallel processing SQL query engine.","logo":"apache-impala.png","homepage_url":"https://impala.apache.org/","categories":["Apache Projects","Query Engines","Open Source"],"pypi_packages":["impyla"],"connection_string":"impala://{hostname}:{port}/{database}","default_port":21050,"category":"Apache Projects"},"engine":"impala","engine_name":"Apache Impala","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-iotdb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-iotdb.mdx new file mode 100644 index 00000000000..875b0af119d --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-iotdb.mdx @@ -0,0 +1,31 @@ +--- +title: Apache IoTDB +sidebar_label: Apache IoTDB +description: "Apache IoTDB is a time series database designed for IoT data, with efficient storage and query capabilities for massive time series data." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":false,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":false,"SIX_HOURS":false,"DAY":false,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":false,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":false},"module":"superset.db_engine_specs.iotdb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":20,"max_score":201,"documentation":{"description":"Apache IoTDB is a time series database designed for IoT data, with efficient storage and query capabilities for massive time series data.","logo":"apache-iotdb.svg","homepage_url":"https://iotdb.apache.org/","categories":["Apache Projects","Time Series Databases","Open Source"],"pypi_packages":["apache-iotdb"],"connection_string":"iotdb://{username}:{password}@{hostname}:{port}","default_port":6667,"parameters":{"username":"Database username (default: root)","password":"Database password (default: root)","hostname":"IP address or hostname","port":"Default 6667"},"notes":"The IoTDB SQLAlchemy dialect was written to integrate with Apache Superset. IoTDB uses a hierarchical data model, which is reorganized into a relational model for SQL queries.","category":"Apache Projects"},"engine":"iotdb","engine_name":"Apache IoTDB","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-kylin.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-kylin.mdx new file mode 100644 index 00000000000..e2ca814d8e7 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-kylin.mdx @@ -0,0 +1,31 @@ +--- +title: Apache Kylin +sidebar_label: Apache Kylin +description: "Apache Kylin is an open-source OLAP engine for big data." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.kylin","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Apache Kylin is an open-source OLAP engine for big data.","logo":"apache-kylin.png","homepage_url":"https://kylin.apache.org/","categories":["Apache Projects","Analytical Databases","Open Source"],"pypi_packages":["kylinpy"],"connection_string":"kylin://{username}:{password}@{hostname}:{port}/{project}?{param1}={value1}&{param2}={value2}","default_port":7070,"category":"Apache Projects"},"engine":"kylin","engine_name":"Apache Kylin","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-phoenix.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-phoenix.mdx new file mode 100644 index 00000000000..bb97d9a89fd --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-phoenix.mdx @@ -0,0 +1,31 @@ +--- +title: Apache Phoenix +sidebar_label: Apache Phoenix +description: "Apache Phoenix is a relational database layer over Apache HBase, providing low-latency SQL queries over HBase data." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.phoenix","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Apache Phoenix is a relational database layer over Apache HBase, providing low-latency SQL queries over HBase data.","logo":"apache-phoenix.png","homepage_url":"https://phoenix.apache.org/","categories":["Apache Projects","Analytical Databases","Open Source"],"pypi_packages":["phoenixdb"],"connection_string":"phoenix://{hostname}:{port}/","default_port":8765,"notes":"Phoenix provides a SQL interface to Apache HBase. The phoenixdb driver connects via the Phoenix Query Server and supports a subset of SQLAlchemy.","category":"Apache Projects"},"engine":"phoenix","engine_name":"Apache Phoenix","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-pinot.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-pinot.mdx new file mode 100644 index 00000000000..e486d1d72cd --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-pinot.mdx @@ -0,0 +1,31 @@ +--- +title: Apache Pinot +sidebar_label: Apache Pinot +description: "Apache Pinot is a real-time distributed OLAP datastore." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.pinot","limit_method":1,"limit_clause":true,"joins":false,"subqueries":false,"alias_in_select":false,"alias_in_orderby":false,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":32,"max_score":201,"documentation":{"description":"Apache Pinot is a real-time distributed OLAP datastore.","logo":"apache-pinot.svg","homepage_url":"https://pinot.apache.org/","categories":["Apache Projects","Time Series Databases","Open Source"],"pypi_packages":["pinotdb"],"connection_string":"pinot+http://{broker_host}:{broker_port}/query?controller=http://{controller_host}:{controller_port}/","default_port":8099,"connection_examples":[{"description":"With authentication","connection_string":"pinot://{username}:{password}@{broker_host}:{broker_port}/query/sql?controller=http://{controller_host}:{controller_port}/verify_ssl=true"}],"engine_parameters":[{"name":"Multi-stage Query Engine","description":"Enable for Explore view, joins, window functions","json":{"connect_args":{"use_multistage_engine":"true"}},"docs_url":"https://docs.pinot.apache.org/reference/multi-stage-engine"}],"category":"Apache Projects"},"engine":"pinot","engine_name":"Apache Pinot","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-solr.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-solr.mdx new file mode 100644 index 00000000000..8f4b67c67a3 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-solr.mdx @@ -0,0 +1,31 @@ +--- +title: Apache Solr +sidebar_label: Apache Solr +description: "Apache Solr is an open-source enterprise search platform." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":false,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":false,"SIX_HOURS":false,"DAY":false,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":false,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":false},"module":"superset.db_engine_specs.solr","limit_method":1,"limit_clause":true,"joins":false,"subqueries":false,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":20,"max_score":201,"documentation":{"description":"Apache Solr is an open-source enterprise search platform.","logo":"apache-solr.png","homepage_url":"https://solr.apache.org/","categories":["Apache Projects","Search & NoSQL","Open Source"],"pypi_packages":["sqlalchemy-solr"],"connection_string":"solr://{username}:{password}@{host}:{port}/{server_path}/{collection}[/?use_ssl=true|false]","default_port":8983,"category":"Apache Projects"},"engine":"solr","engine_name":"Apache Solr","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-spark-sql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-spark-sql.mdx new file mode 100644 index 00000000000..cac43db726c --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-spark-sql.mdx @@ -0,0 +1,31 @@ +--- +title: Apache Spark SQL +sidebar_label: Apache Spark SQL +description: "Apache Spark SQL is a module for structured data processing." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.spark","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":false,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":767,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":true,"expand_data":true,"query_cost_estimation":true,"sql_validation":false,"score":140,"max_score":201,"documentation":{"description":"Apache Spark SQL is a module for structured data processing.","logo":"apache-spark.png","homepage_url":"https://spark.apache.org/sql/","categories":["Apache Projects","Query Engines","Open Source"],"pypi_packages":["pyhive"],"connection_string":"hive://hive@{hostname}:{port}/{database}","default_port":10000,"category":"Apache Projects"},"engine":"hive","engine_name":"Apache Spark SQL","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/arc.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/arc.mdx new file mode 100644 index 00000000000..a76acda681f --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/arc.mdx @@ -0,0 +1,31 @@ +--- +title: Arc +sidebar_label: Arc +description: "Arc is a data platform with multiple connection options." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.arc","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Arc is a data platform with multiple connection options.","categories":["Other Databases","Proprietary"],"pypi_packages":["arc-superset-arrow"],"connection_string":"arc+arrow://{api_key}@{hostname}:{port}/{database}","parameters":{"api_key":"Arc API key","hostname":"Arc hostname","port":"Arc port","database":"Database name"},"drivers":[{"name":"Apache Arrow (Recommended)","pypi_package":"arc-superset-arrow","connection_string":"arc+arrow://{api_key}@{hostname}:{port}/{database}","is_recommended":true,"notes":"Recommended for production. Provides 3-5x better performance using Apache Arrow IPC."},{"name":"JSON","pypi_package":"arc-superset-dialect","connection_string":"arc+json://{api_key}@{hostname}:{port}/{database}","is_recommended":false}],"notes":"Arc supports multiple databases (schemas) within a single instance. Each Arc database appears as a schema in SQL Lab.","category":"Other Databases"},"engine":"arc","engine_name":"Arc","engine_aliases":[],"default_driver":"arrow","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ascend.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ascend.mdx new file mode 100644 index 00000000000..b86844bda29 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ascend.mdx @@ -0,0 +1,31 @@ +--- +title: Ascend +sidebar_label: Ascend +description: "Ascend.io is a data automation platform for building data pipelines." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.ascend","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":38,"max_score":201,"documentation":{"description":"Ascend.io is a data automation platform for building data pipelines.","logo":"ascend.webp","homepage_url":"https://www.ascend.io/","categories":["Cloud Data Warehouses","Analytical Databases","Hosted Open Source"],"pypi_packages":["impyla"],"connection_string":"ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true","category":"Other Databases"},"engine":"ascend","engine_name":"Ascend","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql-data-api.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql-data-api.mdx new file mode 100644 index 00000000000..cc67ad0cbc6 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql-data-api.mdx @@ -0,0 +1,31 @@ +--- +title: Aurora MySQL (Data API) +sidebar_label: Aurora MySQL (Data API) +description: "MySQL is a popular open-source relational database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.aurora","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":59,"max_score":201,"documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"compatible_databases":[{"name":"MariaDB","description":"MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","categories":["Open Source"]},{"name":"Amazon Aurora MySQL","description":"Amazon Aurora MySQL is a fully managed, MySQL-compatible relational database with up to 5x the throughput of standard MySQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"mysql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard MySQL connections also work with mysqlclient.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS"},"engine":"mysql","engine_name":"Aurora MySQL (Data API)","engine_aliases":[],"default_driver":"auroradataapi","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql.mdx new file mode 100644 index 00000000000..c3e0aab3404 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql.mdx @@ -0,0 +1,31 @@ +--- +title: Aurora MySQL +sidebar_label: Aurora MySQL +description: "MySQL is a popular open-source relational database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.aurora","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":59,"max_score":201,"documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"compatible_databases":[{"name":"MariaDB","description":"MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","categories":["Open Source"]},{"name":"Amazon Aurora MySQL","description":"Amazon Aurora MySQL is a fully managed, MySQL-compatible relational database with up to 5x the throughput of standard MySQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"mysql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard MySQL connections also work with mysqlclient.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS"},"engine":"mysql","engine_name":"Aurora MySQL","engine_aliases":[],"default_driver":"mysqldb","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql-data-api.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql-data-api.mdx new file mode 100644 index 00000000000..8e3df32833d --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql-data-api.mdx @@ -0,0 +1,31 @@ +--- +title: Aurora PostgreSQL (Data API) +sidebar_label: Aurora PostgreSQL (Data API) +description: "PostgreSQL is an advanced open-source relational database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.aurora","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":true,"score":104,"max_score":201,"documentation":{"description":"PostgreSQL is an advanced open-source relational database.","logo":"postgresql.svg","homepage_url":"https://www.postgresql.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://www.postgresql.org/docs/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","compatible_databases":[{"name":"Hologres","description":"Alibaba Cloud real-time interactive analytics service, fully compatible with PostgreSQL 11.","logo":"hologres.png","homepage_url":"https://www.alibabacloud.com/product/hologres","pypi_packages":["psycopg2"],"connection_string":"postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"AccessKey ID of your Alibaba Cloud account","password":"AccessKey secret of your Alibaba Cloud account","host":"Public endpoint of the Hologres instance","port":"Port number of the Hologres instance","database":"Name of the Hologres database"},"categories":["Proprietary"]},{"name":"TimescaleDB","description":"Open-source relational database for time-series and analytics, built on PostgreSQL.","logo":"timescale.png","homepage_url":"https://www.timescale.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Timescale Cloud (SSL required)","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://docs.timescale.com/","categories":["Open Source"]},{"name":"YugabyteDB","description":"Distributed SQL database built on top of PostgreSQL.","logo":"yugabyte.png","homepage_url":"https://www.yugabyte.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://www.yugabyte.com/","categories":["Open Source"]},{"name":"Supabase","description":"Open-source Firebase alternative built on top of PostgreSQL, providing a full backend-as-a-service with a hosted Postgres database.","logo":"supabase.svg","homepage_url":"https://supabase.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Supabase project (connection pooler)","connection_string":"postgresql://{username}.{project_ref}:{password}@aws-0-{region}.pooler.supabase.com:6543/{database}"}],"parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"Supabase project host (from project settings)","port":"Default 5432 (direct) or 6543 (pooler)","database":"Database name (default: postgres)","project_ref":"Supabase project reference (from project settings)","region":"Supabase project region (e.g., us-east-1)"},"notes":"Find connection details in your Supabase project dashboard under Settings > Database. Use the connection pooler (port 6543) for better connection management.","docs_url":"https://supabase.com/docs/guides/database/connecting-to-postgres","categories":["Hosted Open Source"]},{"name":"Google AlloyDB","description":"Google Cloud's PostgreSQL-compatible database service for demanding transactional and analytical workloads.","logo":"alloydb.png","homepage_url":"https://cloud.google.com/alloydb","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"AlloyDB instance IP or Auth Proxy address","port":"Default 5432","database":"Database name"},"notes":"For public IP connections, use the AlloyDB Auth Proxy for secure access. Private IP connections can connect directly.","docs_url":"https://cloud.google.com/alloydb/docs","categories":["Cloud - Google","Hosted Open Source"]},{"name":"Neon","description":"Serverless PostgreSQL with branching, scale-to-zero, and bottomless storage.","logo":"neon.png","homepage_url":"https://neon.tech/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}/{database}?sslmode=require","parameters":{"username":"Neon role name","password":"Neon role password","host":"Neon hostname (e.g., ep-cool-name-123456.us-east-2.aws.neon.tech)","database":"Database name (default: neondb)"},"notes":"SSL is required for all connections. Find connection details in the Neon console under Connection Details.","docs_url":"https://neon.tech/docs/connect/connect-from-any-app","categories":["Hosted Open Source"]},{"name":"Amazon Aurora PostgreSQL","description":"Amazon Aurora PostgreSQL is a fully managed, PostgreSQL-compatible relational database with up to 5x the throughput of standard PostgreSQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"postgresql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard PostgreSQL connections also work with psycopg2.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS"},"engine":"postgresql","engine_name":"Aurora PostgreSQL (Data API)","engine_aliases":["postgres"],"default_driver":"auroradataapi","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql.mdx new file mode 100644 index 00000000000..68d194d08ab --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql.mdx @@ -0,0 +1,31 @@ +--- +title: Aurora PostgreSQL +sidebar_label: Aurora PostgreSQL +description: "PostgreSQL is an advanced open-source relational database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.aurora","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":true,"score":104,"max_score":201,"documentation":{"description":"PostgreSQL is an advanced open-source relational database.","logo":"postgresql.svg","homepage_url":"https://www.postgresql.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://www.postgresql.org/docs/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","compatible_databases":[{"name":"Hologres","description":"Alibaba Cloud real-time interactive analytics service, fully compatible with PostgreSQL 11.","logo":"hologres.png","homepage_url":"https://www.alibabacloud.com/product/hologres","pypi_packages":["psycopg2"],"connection_string":"postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"AccessKey ID of your Alibaba Cloud account","password":"AccessKey secret of your Alibaba Cloud account","host":"Public endpoint of the Hologres instance","port":"Port number of the Hologres instance","database":"Name of the Hologres database"},"categories":["Proprietary"]},{"name":"TimescaleDB","description":"Open-source relational database for time-series and analytics, built on PostgreSQL.","logo":"timescale.png","homepage_url":"https://www.timescale.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Timescale Cloud (SSL required)","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://docs.timescale.com/","categories":["Open Source"]},{"name":"YugabyteDB","description":"Distributed SQL database built on top of PostgreSQL.","logo":"yugabyte.png","homepage_url":"https://www.yugabyte.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://www.yugabyte.com/","categories":["Open Source"]},{"name":"Supabase","description":"Open-source Firebase alternative built on top of PostgreSQL, providing a full backend-as-a-service with a hosted Postgres database.","logo":"supabase.svg","homepage_url":"https://supabase.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Supabase project (connection pooler)","connection_string":"postgresql://{username}.{project_ref}:{password}@aws-0-{region}.pooler.supabase.com:6543/{database}"}],"parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"Supabase project host (from project settings)","port":"Default 5432 (direct) or 6543 (pooler)","database":"Database name (default: postgres)","project_ref":"Supabase project reference (from project settings)","region":"Supabase project region (e.g., us-east-1)"},"notes":"Find connection details in your Supabase project dashboard under Settings > Database. Use the connection pooler (port 6543) for better connection management.","docs_url":"https://supabase.com/docs/guides/database/connecting-to-postgres","categories":["Hosted Open Source"]},{"name":"Google AlloyDB","description":"Google Cloud's PostgreSQL-compatible database service for demanding transactional and analytical workloads.","logo":"alloydb.png","homepage_url":"https://cloud.google.com/alloydb","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"AlloyDB instance IP or Auth Proxy address","port":"Default 5432","database":"Database name"},"notes":"For public IP connections, use the AlloyDB Auth Proxy for secure access. Private IP connections can connect directly.","docs_url":"https://cloud.google.com/alloydb/docs","categories":["Cloud - Google","Hosted Open Source"]},{"name":"Neon","description":"Serverless PostgreSQL with branching, scale-to-zero, and bottomless storage.","logo":"neon.png","homepage_url":"https://neon.tech/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}/{database}?sslmode=require","parameters":{"username":"Neon role name","password":"Neon role password","host":"Neon hostname (e.g., ep-cool-name-123456.us-east-2.aws.neon.tech)","database":"Database name (default: neondb)"},"notes":"SSL is required for all connections. Find connection details in the Neon console under Connection Details.","docs_url":"https://neon.tech/docs/connect/connect-from-any-app","categories":["Hosted Open Source"]},{"name":"Amazon Aurora PostgreSQL","description":"Amazon Aurora PostgreSQL is a fully managed, PostgreSQL-compatible relational database with up to 5x the throughput of standard PostgreSQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"postgresql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard PostgreSQL connections also work with psycopg2.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS"},"engine":"postgresql","engine_name":"Aurora PostgreSQL","engine_aliases":["postgres"],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer-kql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer-kql.mdx new file mode 100644 index 00000000000..9baa0e25a09 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer-kql.mdx @@ -0,0 +1,31 @@ +--- +title: Azure Data Explorer (KQL) +sidebar_label: Azure Data Explorer (KQL) +description: "Documentation for Azure Data Explorer (KQL) database connection." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.kusto","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":false,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":40,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Cloud - Azure"},"engine":"kustokql","engine_name":"Azure Data Explorer (KQL)","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer.mdx new file mode 100644 index 00000000000..c19d81cb611 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer.mdx @@ -0,0 +1,31 @@ +--- +title: Azure Data Explorer +sidebar_label: Azure Data Explorer +description: "Azure Data Explorer (Kusto) is a fast, fully managed data analytics service from Microsoft Azure. Query data using SQL or native KQL syntax." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.kusto","limit_method":2,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":false,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":54,"max_score":201,"documentation":{"description":"Azure Data Explorer (Kusto) is a fast, fully managed data analytics service from Microsoft Azure. Query data using SQL or native KQL syntax.","logo":"kusto.png","homepage_url":"https://azure.microsoft.com/en-us/products/data-explorer/","categories":["Cloud - Azure","Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-kusto"],"connection_string":"kustosql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","parameters":{"cluster":"Azure Data Explorer cluster name","database":"Database name","client_id":"Azure AD application (client) ID","client_secret":"Azure AD application secret","tenant_id":"Azure AD tenant ID"},"drivers":[{"name":"SQL Interface (Recommended)","pypi_package":"sqlalchemy-kusto","connection_string":"kustosql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","is_recommended":true,"notes":"Use familiar SQL syntax to query Azure Data Explorer."},{"name":"KQL (Kusto Query Language)","pypi_package":"sqlalchemy-kusto","connection_string":"kustokql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","is_recommended":false,"notes":"Use native Kusto Query Language for advanced analytics."}],"category":"Cloud - Azure"},"engine":"kustosql","engine_name":"Azure Data Explorer","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/azure-synapse.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/azure-synapse.mdx new file mode 100644 index 00000000000..d4af047b3e2 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/azure-synapse.mdx @@ -0,0 +1,31 @@ +--- +title: Azure Synapse +sidebar_label: Azure Synapse +description: "Azure Synapse Analytics is a cloud-based enterprise data warehouse from Microsoft that combines big data and data warehousing." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.mssql","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":false,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":44,"max_score":201,"documentation":{"description":"Azure Synapse Analytics is a cloud-based enterprise data warehouse from Microsoft that combines big data and data warehousing.","logo":"azure.svg","homepage_url":"https://azure.microsoft.com/en-us/products/synapse-analytics/","categories":["Cloud Data Warehouses","Analytical Databases","Proprietary"],"pypi_packages":["pymssql"],"connection_string":"mssql+pymssql://{username}@{server}:{password}@{server}.database.windows.net:1433/{database}","category":"Cloud - Azure","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\", password, or database name \"%(database)s\" is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]}]},"engine":"mssql","engine_name":"Azure Synapse","engine_aliases":[],"default_driver":"pyodbc","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/base.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/base.mdx new file mode 100644 index 00000000000..7dd1c23b108 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/base.mdx @@ -0,0 +1,31 @@ +--- +title: base +sidebar_label: base +description: "Documentation for base database connection." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.presto","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":true,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":109,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Other Databases","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table_name)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema_name)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_ERROR","message_template":"Unable to connect to catalog named \"%(catalog_name)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015]}]},"engine":"base","engine_name":"base","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse-sqlalchemy.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse-sqlalchemy.mdx new file mode 100644 index 00000000000..5efc6accf42 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse-sqlalchemy.mdx @@ -0,0 +1,31 @@ +--- +title: ClickHouse (sqlalchemy) +sidebar_label: ClickHouse (sqlalchemy) +description: "Documentation for ClickHouse (sqlalchemy) database connection." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.clickhouse","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":51,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Analytical Databases"},"engine":"clickhouse","engine_name":"ClickHouse (sqlalchemy)","engine_aliases":[],"default_driver":null,"supports_file_upload":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse.mdx new file mode 100644 index 00000000000..5e458213981 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse.mdx @@ -0,0 +1,31 @@ +--- +title: ClickHouse +sidebar_label: ClickHouse +description: "ClickHouse is an open-source column-oriented database for real-time analytics using SQL. It's known for extremely fast query performance on large datasets." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.clickhouse","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":61,"max_score":201,"documentation":{"description":"ClickHouse is an open-source column-oriented database for real-time analytics using SQL. It's known for extremely fast query performance on large datasets.","logo":"clickhouse.png","homepage_url":"https://clickhouse.com/","categories":["Analytical Databases","Open Source"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}:{port}/{database}","default_port":8123,"drivers":[{"name":"clickhouse-connect (Recommended)","pypi_package":"clickhouse-connect>=0.13.0","connection_string":"clickhousedb://{username}:{password}@{host}:{port}/{database}","is_recommended":true,"notes":"Official ClickHouse Python driver with native protocol support."},{"name":"clickhouse-sqlalchemy (Legacy)","pypi_package":"clickhouse-sqlalchemy","connection_string":"clickhouse://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"Older driver using HTTP interface. Use clickhouse-connect for new deployments."}],"connection_examples":[{"description":"Altinity Cloud","connection_string":"clickhousedb://demo:demo@github.demo.trial.altinity.cloud/default?secure=true"},{"description":"Local (no auth, no SSL)","connection_string":"clickhousedb://localhost/default"}],"install_instructions":"echo \"clickhouse-connect>=0.13.0\" >> ./docker/requirements-local.txt","compatible_databases":[{"name":"ClickHouse Cloud","description":"ClickHouse Cloud is the official fully-managed cloud service for ClickHouse. It provides automatic scaling, built-in backups, and enterprise security features.","logo":"clickhouse.png","homepage_url":"https://clickhouse.cloud/","categories":["Analytical Databases","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}:8443/{database}?secure=true","parameters":{"username":"ClickHouse Cloud username","password":"ClickHouse Cloud password","host":"Your ClickHouse Cloud hostname","database":"Database name (default)"},"docs_url":"https://clickhouse.com/docs/en/cloud"},{"name":"Altinity.Cloud","description":"Altinity.Cloud is a managed ClickHouse service providing Kubernetes-native deployments with enterprise support.","logo":"altinity.png","homepage_url":"https://altinity.cloud/","categories":["Analytical Databases","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}/{database}?secure=true","docs_url":"https://docs.altinity.com/"}],"category":"Analytical Databases"},"engine":"clickhousedb","engine_name":"ClickHouse","engine_aliases":[],"default_driver":"connect","supports_file_upload":false,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/cloudflare-d1.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/cloudflare-d1.mdx new file mode 100644 index 00000000000..bf9b4d450df --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/cloudflare-d1.mdx @@ -0,0 +1,31 @@ +--- +title: Cloudflare D1 +sidebar_label: Cloudflare D1 +description: "Cloudflare D1 is a serverless SQLite database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.d1","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":41,"max_score":201,"documentation":{"description":"Cloudflare D1 is a serverless SQLite database.","logo":"cloudflare.png","homepage_url":"https://developers.cloudflare.com/d1/","categories":["Cloud Data Warehouses","Traditional RDBMS","Hosted Open Source"],"pypi_packages":["superset-engine-d1"],"connection_string":"d1://{cloudflare_account_id}:{cloudflare_api_token}@{cloudflare_d1_database_id}","parameters":{"cloudflare_account_id":"Cloudflare account ID","cloudflare_api_token":"Cloudflare API token","cloudflare_d1_database_id":"D1 database ID"},"install_instructions":"pip install superset-engine-d1","category":"Other Databases"},"engine":"d1","engine_name":"Cloudflare D1","engine_aliases":[],"default_driver":"d1","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/cockroachdb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/cockroachdb.mdx new file mode 100644 index 00000000000..5fee945bc0c --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/cockroachdb.mdx @@ -0,0 +1,31 @@ +--- +title: CockroachDB +sidebar_label: CockroachDB +description: "CockroachDB is a distributed SQL database built for cloud applications." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.cockroachdb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":94,"max_score":201,"documentation":{"description":"CockroachDB is a distributed SQL database built for cloud applications.","logo":"cockroachdb.png","homepage_url":"https://www.cockroachlabs.com/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["cockroachdb"],"connection_string":"cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable","default_port":26257,"docs_url":"https://github.com/cockroachdb/sqlalchemy-cockroachdb","category":"Other Databases"},"engine":"cockroachdb","engine_name":"CockroachDB","engine_aliases":["postgres"],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/couchbase.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/couchbase.mdx new file mode 100644 index 00000000000..764261b52d5 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/couchbase.mdx @@ -0,0 +1,31 @@ +--- +title: Couchbase +sidebar_label: Couchbase +description: "Couchbase is a distributed NoSQL document database with SQL++ support." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.couchbase","limit_method":1,"limit_clause":true,"joins":false,"subqueries":false,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":27,"max_score":201,"documentation":{"description":"Couchbase is a distributed NoSQL document database with SQL++ support.","logo":"couchbase.svg","homepage_url":"https://www.couchbase.com/","categories":["Search & NoSQL","Open Source"],"pypi_packages":["couchbase-sqlalchemy"],"connection_string":"couchbase://{username}:{password}@{host}:{port}?ssl=true","default_port":8091,"parameters":{"username":"Couchbase username","password":"Couchbase password","host":"Couchbase host or connection string for cloud","port":"Couchbase port (default 8091)","database":"Couchbase database/bucket name"},"drivers":[{"name":"couchbase-sqlalchemy","pypi_package":"couchbase-sqlalchemy","connection_string":"couchbase://{username}:{password}@{host}:{port}?ssl=true","is_recommended":true}],"category":"Search & NoSQL"},"engine":"couchbase","engine_name":"Couchbase","engine_aliases":["couchbasedb"],"default_driver":"couchbase","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/cratedb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/cratedb.mdx new file mode 100644 index 00000000000..92796e4282a --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/cratedb.mdx @@ -0,0 +1,31 @@ +--- +title: CrateDB +sidebar_label: CrateDB +description: "CrateDB is a distributed SQL database for machine data and IoT workloads." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.crate","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"CrateDB is a distributed SQL database for machine data and IoT workloads.","logo":"cratedb.svg","homepage_url":"https://cratedb.com","categories":["Time Series Databases","Open Source"],"pypi_packages":["crate","sqlalchemy-cratedb"],"connection_string":"crate://{host}:{port}","default_port":4200,"parameters":{"host":"CrateDB host","port":"CrateDB HTTP port (default 4200)"},"drivers":[{"name":"crate","pypi_package":"crate[sqlalchemy]","connection_string":"crate://{host}:{port}","is_recommended":true}],"category":"Other Databases"},"engine":"crate","engine_name":"CrateDB","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databend-legacy.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databend-legacy.mdx new file mode 100644 index 00000000000..8c143916849 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/databend-legacy.mdx @@ -0,0 +1,31 @@ +--- +title: Databend (legacy) +sidebar_label: Databend (legacy) +description: "Documentation for Databend (legacy) database connection." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databend","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":51,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Other Databases"},"engine":"databend","engine_name":"Databend (legacy)","engine_aliases":[],"default_driver":null,"supports_file_upload":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databend.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databend.mdx new file mode 100644 index 00000000000..68aa4f82d83 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/databend.mdx @@ -0,0 +1,31 @@ +--- +title: Databend +sidebar_label: Databend +description: "Databend is a modern cloud-native data warehouse with instant elasticity and pay-as-you-go pricing. Built in Rust for high performance." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databend","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":51,"max_score":201,"documentation":{"description":"Databend is a modern cloud-native data warehouse with instant elasticity and pay-as-you-go pricing. Built in Rust for high performance.","logo":"databend.png","homepage_url":"https://www.databend.com/","categories":["Cloud Data Warehouses","Analytical Databases","Proprietary"],"pypi_packages":["databend-sqlalchemy"],"connection_string":"databend://{username}:{password}@{host}:{port}/{database}?secure=true","default_port":443,"parameters":{"username":"Database username","password":"Database password","host":"Databend host","port":"Databend port (default 443 for HTTPS)","database":"Database name"},"category":"Other Databases"},"engine":"databend","engine_name":"Databend","engine_aliases":[],"default_driver":"databend","supports_file_upload":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databricks-interactive-cluster.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databricks-interactive-cluster.mdx new file mode 100644 index 00000000000..e70445bcf74 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/databricks-interactive-cluster.mdx @@ -0,0 +1,31 @@ +--- +title: Databricks Interactive Cluster +sidebar_label: Databricks Interactive Cluster +description: "Apache Hive is a data warehouse infrastructure built on Hadoop." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databricks","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":false,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":767,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":true,"expand_data":true,"query_cost_estimation":true,"sql_validation":false,"score":140,"max_score":201,"documentation":{"description":"Apache Hive is a data warehouse infrastructure built on Hadoop.","logo":"apache-hive.svg","homepage_url":"https://hive.apache.org/","categories":["Apache Projects","Query Engines","Open Source"],"pypi_packages":["pyhive"],"connection_string":"hive://hive@{hostname}:{port}/{database}","default_port":10000,"category":"Cloud Data Warehouses"},"engine":"databricks","engine_name":"Databricks Interactive Cluster","engine_aliases":[],"default_driver":"pyhive","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databricks-legacy.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databricks-legacy.mdx new file mode 100644 index 00000000000..940b9c9704e --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/databricks-legacy.mdx @@ -0,0 +1,31 @@ +--- +title: Databricks (legacy) +sidebar_label: Databricks (legacy) +description: "Documentation for Databricks (legacy) database connection." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databricks","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":true,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":70,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"databricks+connector://token:{access_token}@{host}:{port}/{database_name}","category":"Cloud Data Warehouses"},"engine":"databricks","engine_name":"Databricks (legacy)","engine_aliases":[],"default_driver":"connector","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databricks-sql-endpoint.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databricks-sql-endpoint.mdx new file mode 100644 index 00000000000..392ba1453c0 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/databricks-sql-endpoint.mdx @@ -0,0 +1,31 @@ +--- +title: Databricks SQL Endpoint +sidebar_label: Databricks SQL Endpoint +description: "Documentation for Databricks SQL Endpoint database connection." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databricks","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":30,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Cloud Data Warehouses"},"engine":"databricks","engine_name":"Databricks SQL Endpoint","engine_aliases":[],"default_driver":"pyodbc","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databricks.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databricks.mdx new file mode 100644 index 00000000000..09540730e6c --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/databricks.mdx @@ -0,0 +1,31 @@ +--- +title: Databricks +sidebar_label: Databricks +description: "Databricks is a unified analytics platform built on Apache Spark, providing data engineering, data science, and machine learning capabilities in the cloud. Use " +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databricks","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":true,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":70,"max_score":201,"documentation":{"description":"Databricks is a unified analytics platform built on Apache Spark, providing data engineering, data science, and machine learning capabilities in the cloud. Use the Python Connector for SQL warehouses and clusters.","logo":"databricks.png","homepage_url":"https://www.databricks.com/","categories":["Cloud Data Warehouses","Analytical Databases","Hosted Open Source"],"pypi_packages":["apache-superset[databricks]"],"install_instructions":"pip install apache-superset[databricks]","connection_string":"databricks://token:{access_token}@{host}:{port}?http_path={http_path}&catalog={catalog}&schema={schema}","parameters":{"access_token":"Personal access token from Settings > User Settings","host":"Server hostname from cluster JDBC/ODBC settings","port":"Port (default 443)","http_path":"HTTP path from cluster JDBC/ODBC settings"},"drivers":[{"name":"Databricks Python Connector (Recommended)","pypi_package":"databricks-sql-connector","connection_string":"databricks://token:{access_token}@{host}:{port}?http_path={http_path}&catalog={catalog}&schema={schema}","is_recommended":true,"notes":"Official Databricks connector. Best for SQL warehouses and clusters."},{"name":"Hive Connector (Interactive Clusters)","pypi_package":"databricks-dbapi[sqlalchemy]","connection_string":"databricks+pyhive://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"For Interactive Clusters. Requires http_path in engine parameters."},{"name":"ODBC (SQL Endpoints)","pypi_package":"pyodbc","connection_string":"databricks+pyodbc://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"Requires ODBC driver. For serverless SQL warehouses."},{"name":"databricks-dbapi (Legacy)","pypi_package":"databricks-dbapi[sqlalchemy]","connection_string":"databricks+connector://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"Legacy connector. Use Python Connector for new deployments."}],"category":"Cloud Data Warehouses"},"engine":"databricks","engine_name":"Databricks","engine_aliases":[],"default_driver":"databricks-sql-python","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/denodo.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/denodo.mdx new file mode 100644 index 00000000000..736cd375f91 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/denodo.mdx @@ -0,0 +1,31 @@ +--- +title: Denodo +sidebar_label: Denodo +description: "Denodo is a data virtualization platform for logical data management." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.denodo","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":27,"max_score":201,"documentation":{"description":"Denodo is a data virtualization platform for logical data management.","logo":"denodo.png","homepage_url":"https://www.denodo.com/","categories":["Query Engines","Proprietary"],"pypi_packages":["psycopg2"],"connection_string":"denodo://{username}:{password}@{host}:{port}/{database}","default_port":9996,"parameters":{"username":"Denodo username","password":"Denodo password","host":"Denodo VDP server hostname","port":"ODBC port (default 9996)","database":"Virtual database name"},"drivers":[{"name":"psycopg2","pypi_package":"psycopg2","connection_string":"denodo://{username}:{password}@{host}:{port}/{database}","is_recommended":true,"notes":"Uses PostgreSQL wire protocol."}],"category":"Other Databases","custom_errors":[{"message_template":"Incorrect username or password.","error_type":"CONNECTION_INVALID_USERNAME_ERROR","category":"Authentication","description":"Invalid username","issue_codes":[1012],"invalid_fields":["username","password"]},{"message_template":"Please enter a password.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["password"]},{"message_template":"Hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"message_template":"Server refused the connection: check hostname and port.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008],"invalid_fields":["host","port"]},{"message_template":"Unable to connect to database \"%(database)s\"","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"message_template":"Unable to connect to database \"%(database)s\": database does not exist or insufficient permissions","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017],"invalid_fields":["database"]},{"message_template":"Please check your query for syntax errors at or near \"%(err)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"message_template":"Column \"%(column)s\" not found in \"%(view)s\".","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"message_template":"Invalid aggregation expression.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"message_template":"\"%(exp)s\" is neither an aggregation function nor appears in the GROUP BY clause.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"denodo","engine_name":"Denodo","engine_aliases":[],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/dremio.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/dremio.mdx new file mode 100644 index 00000000000..e3b0545e1b3 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/dremio.mdx @@ -0,0 +1,31 @@ +--- +title: Dremio +sidebar_label: Dremio +description: "Dremio is a data lakehouse platform for fast, self-service analytics." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.dremio","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Dremio is a data lakehouse platform for fast, self-service analytics.","logo":"dremio.png","homepage_url":"https://www.dremio.com/","categories":["Query Engines","Proprietary"],"pypi_packages":["sqlalchemy_dremio"],"connection_string":"dremio+flight://data.dremio.cloud:443/?Token={token}&UseEncryption=true","parameters":{"token":"Personal Access Token (PAT) or API token"},"drivers":[{"name":"Arrow Flight (Recommended)","pypi_package":"sqlalchemy_dremio","connection_string":"dremio+flight://data.dremio.cloud:443/?Token={token}&UseEncryption=true","is_recommended":true},{"name":"ODBC","pypi_package":"sqlalchemy_dremio","connection_string":"dremio+pyodbc://{token}@{host}:31010/dremio","is_recommended":false,"notes":"Requires Dremio ODBC drivers installed."}],"category":"Other Databases"},"engine":"dremio","engine_name":"Dremio","engine_aliases":["dremio+flight"],"default_driver":"flight","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/duckdb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/duckdb.mdx new file mode 100644 index 00000000000..9cbb6a209d4 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/duckdb.mdx @@ -0,0 +1,31 @@ +--- +title: DuckDB +sidebar_label: DuckDB +description: "DuckDB is an in-process OLAP database designed for fast analytical queries on local data. Supports CSV, Parquet, JSON, and many other file formats." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.duckdb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":38,"max_score":201,"documentation":{"description":"DuckDB is an in-process OLAP database designed for fast analytical queries on local data. Supports CSV, Parquet, JSON, and many other file formats.","logo":"duckdb.png","homepage_url":"https://duckdb.org/","categories":["Analytical Databases","Open Source"],"pypi_packages":["duckdb-engine"],"connection_string":"duckdb:////path/to/duck.db","drivers":[{"name":"duckdb-engine","pypi_package":"duckdb-engine","connection_string":"duckdb:////path/to/duck.db","is_recommended":true}],"notes":"DuckDB supports both local file and in-memory databases. Use `:memory:` for in-memory database.","compatible_databases":[{"name":"MotherDuck","description":"MotherDuck is a serverless cloud analytics platform built on DuckDB, offering collaborative data sharing and cloud-native scalability.","logo":"motherduck.png","homepage_url":"https://motherduck.com/","pypi_packages":["duckdb","duckdb-engine"],"connection_string":"duckdb:///md:{database}?motherduck_token={token}","parameters":{"database":"MotherDuck database name","motherduck_token":"Service token from MotherDuck dashboard"},"notes":"Cloud-hosted DuckDB with collaboration features.","categories":["Hosted Open Source"]}],"category":"Other Databases","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"engine":"duckdb","engine_name":"DuckDB","engine_aliases":[],"default_driver":"duckdb_engine","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/elasticsearch.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/elasticsearch.mdx new file mode 100644 index 00000000000..8f591e04b73 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/elasticsearch.mdx @@ -0,0 +1,31 @@ +--- +title: Elasticsearch +sidebar_label: Elasticsearch +description: "Elasticsearch is a distributed search and analytics engine. Query data using Elasticsearch SQL or OpenSearch SQL syntax." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.elasticsearch","limit_method":1,"limit_clause":true,"joins":false,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":false,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":37,"max_score":201,"documentation":{"description":"Elasticsearch is a distributed search and analytics engine. Query data using Elasticsearch SQL or OpenSearch SQL syntax.","logo":"elasticsearch.png","homepage_url":"https://www.elastic.co/elasticsearch/","categories":["Search & NoSQL","Open Source"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"elasticsearch+https://{user}:{password}@{host}:9243/","default_port":9243,"parameters":{"user":"Elasticsearch username","password":"Elasticsearch password","host":"Elasticsearch host"},"drivers":[{"name":"Elasticsearch SQL API (Recommended)","pypi_package":"elasticsearch-dbapi","connection_string":"elasticsearch+https://{user}:{password}@{host}:9243/","is_recommended":true,"notes":"For Elastic Cloud and self-hosted Elasticsearch with SQL enabled."},{"name":"OpenDistro / OpenSearch SQL","pypi_package":"elasticsearch-dbapi","connection_string":"odelasticsearch+https://{user}:{password}@{host}:9200/","is_recommended":false,"notes":"For OpenDistro Elasticsearch or Amazon OpenSearch Service."}],"compatible_databases":[{"name":"Elastic Cloud","description":"Elastic Cloud is the official managed Elasticsearch service from Elastic. It includes Elasticsearch, Kibana, and enterprise features with automatic scaling.","logo":"elasticsearch.png","homepage_url":"https://www.elastic.co/cloud/","categories":["Search & NoSQL","Hosted Open Source"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"elasticsearch+https://{user}:{password}@{deployment}.{region}.cloud.es.io:9243/","docs_url":"https://www.elastic.co/guide/en/cloud/current/"},{"name":"Amazon OpenSearch Service","description":"Amazon OpenSearch Service (successor to Amazon Elasticsearch Service) is a managed search and analytics service on AWS.","logo":"elasticsearch.png","homepage_url":"https://aws.amazon.com/opensearch-service/","categories":["Search & NoSQL","Cloud - AWS","Hosted Open Source"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"odelasticsearch+https://{user}:{password}@{host}:443/","docs_url":"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/"}],"category":"Search & NoSQL"},"engine":"elasticsearch","engine_name":"Elasticsearch","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/exasol.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/exasol.mdx new file mode 100644 index 00000000000..273bdc1fce2 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/exasol.mdx @@ -0,0 +1,31 @@ +--- +title: Exasol +sidebar_label: Exasol +description: "Exasol is a high-performance, in-memory, MPP analytical database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.exasol","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Exasol is a high-performance, in-memory, MPP analytical database.","logo":"exasol.png","homepage_url":"https://www.exasol.com/","categories":["Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-exasol"],"connection_string":"exa+pyodbc://{username}:{password}@{dsn}","default_port":8563,"parameters":{"username":"Database username","password":"Database password","dsn":"DSN name configured in odbc.ini"},"drivers":[{"name":"pyodbc","pypi_package":"sqlalchemy-exasol","connection_string":"exa+pyodbc://{username}:{password}@{dsn}","is_recommended":true,"notes":"Requires ODBC driver and DSN configuration."},{"name":"turbodbc","pypi_package":"sqlalchemy-exasol[turbodbc]","connection_string":"exa+turbodbc://{username}:{password}@{dsn}","is_recommended":false,"notes":"Faster but requires additional dependencies."},{"name":"websocket","pypi_package":"sqlalchemy-exasol[websocket]","connection_string":"exa+websocket://{username}:{password}@{host}:{port}/{schema}","is_recommended":false,"notes":"Pure Python, no ODBC required."}],"category":"Other Databases"},"engine":"exa","engine_name":"Exasol","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/firebird.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/firebird.mdx new file mode 100644 index 00000000000..0ad0a5e194a --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/firebird.mdx @@ -0,0 +1,31 @@ +--- +title: Firebird +sidebar_label: Firebird +description: "Firebird is an open-source relational database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.firebird","limit_method":3,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":26,"max_score":201,"documentation":{"description":"Firebird is an open-source relational database.","logo":"firebird.png","homepage_url":"https://firebirdsql.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["sqlalchemy-firebird"],"version_requirements":"sqlalchemy-firebird>=0.7.0,<0.8","connection_string":"firebird+fdb://{username}:{password}@{host}:{port}//{path_to_db_file}","default_port":3050,"connection_examples":[{"description":"Local database","connection_string":"firebird+fdb://SYSDBA:masterkey@192.168.86.38:3050//Library/Frameworks/Firebird.framework/Versions/A/Resources/examples/empbuild/employee.fdb"}],"category":"Other Databases"},"engine":"firebird","engine_name":"Firebird","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/firebolt.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/firebolt.mdx new file mode 100644 index 00000000000..1e5f08d3243 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/firebolt.mdx @@ -0,0 +1,31 @@ +--- +title: Firebolt +sidebar_label: Firebolt +description: "Firebolt is a cloud data warehouse designed for high-performance analytics." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.firebolt","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Firebolt is a cloud data warehouse designed for high-performance analytics.","logo":"firebolt.png","homepage_url":"https://www.firebolt.io/","categories":["Cloud Data Warehouses","Analytical Databases","Proprietary"],"pypi_packages":["firebolt-sqlalchemy"],"connection_string":"firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={account_name}","parameters":{"client_id":"Service account client ID","client_secret":"Service account client secret","database":"Database name","engine_name":"Engine name","account_name":"Account name"},"drivers":[{"name":"firebolt-sqlalchemy","pypi_package":"firebolt-sqlalchemy","connection_string":"firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={account_name}","is_recommended":true}],"category":"Other Databases"},"engine":"firebolt","engine_name":"Firebolt","engine_aliases":[],"default_driver":"firebolt","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/google-bigquery.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/google-bigquery.mdx new file mode 100644 index 00000000000..ad4eecce9f0 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/google-bigquery.mdx @@ -0,0 +1,31 @@ +--- +title: Google BigQuery +sidebar_label: Google BigQuery +description: "Google BigQuery is a serverless, highly scalable data warehouse." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.bigquery","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":true,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":true,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":83,"max_score":201,"documentation":{"description":"Google BigQuery is a serverless, highly scalable data warehouse.","logo":"google-big-query.svg","homepage_url":"https://cloud.google.com/bigquery/","categories":["Cloud - Google","Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-bigquery"],"connection_string":"bigquery://{project_id}","install_instructions":"echo \"sqlalchemy-bigquery\" >> ./docker/requirements-local.txt","authentication_methods":[{"name":"Service Account JSON","description":"Upload service account credentials JSON or paste in Secure Extra","secure_extra":{"credentials_info":{"type":"service_account","project_id":"...","private_key_id":"...","private_key":"...","client_email":"...","client_id":"...","auth_uri":"...","token_uri":"..."}}}],"notes":"Create a Service Account via GCP console with access to BigQuery datasets. For CSV/Excel uploads, also install pandas_gbq.","warnings":["Google BigQuery Python SDK is not compatible with gevent. Use a worker type other than gevent when deploying with gunicorn."],"docs_url":"https://github.com/googleapis/python-bigquery-sqlalchemy","category":"Cloud - Google","custom_errors":[{"regex_name":"CONNECTION_DATABASE_PERMISSIONS_REGEX","message_template":"Unable to connect. Verify that the following roles are set on the service account: \"BigQuery Data Viewer\", \"BigQuery Metadata Viewer\", \"BigQuery Job User\" and the following permissions are set \"bigquery.readsessions.create\", \"bigquery.readsessions.getData\"","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve column \"%(column)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"bigquery","engine_name":"Google BigQuery","engine_aliases":[],"default_driver":"bigquery","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/google-datastore.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/google-datastore.mdx new file mode 100644 index 00000000000..1027dd9ccd2 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/google-datastore.mdx @@ -0,0 +1,31 @@ +--- +title: Google Datastore +sidebar_label: Google Datastore +description: "Google Cloud Datastore is a highly scalable NoSQL database for your applications." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.datastore","limit_method":3,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":true,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":73,"max_score":201,"documentation":{"description":"Google Cloud Datastore is a highly scalable NoSQL database for your applications.","logo":"datastore.png","homepage_url":"https://cloud.google.com/datastore/","categories":["Cloud - Google","Search & NoSQL","Proprietary"],"pypi_packages":["python-datastore-sqlalchemy"],"connection_string":"datastore://{project_id}/?database={database_id}","authentication_methods":[{"name":"Service Account JSON","description":"Upload service account credentials JSON or paste in Secure Extra","secure_extra":{"credentials_info":{"type":"service_account","project_id":"...","private_key_id":"...","private_key":"...","client_email":"...","client_id":"...","auth_uri":"...","token_uri":"..."}}}],"notes":"Create a Service Account via GCP console with access to datastore datasets.","docs_url":"https://github.com/splasky/Python-datastore-sqlalchemy","category":"Cloud - Google","custom_errors":[{"regex_name":"CONNECTION_DATABASE_PERMISSIONS_REGEX","message_template":"Unable to connect. Verify that the following roles are set on the service account: \"Cloud Datastore Viewer\", \"Cloud Datastore User\", \"Cloud Datastore Creator\"","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve column \"%(column)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"datastore","engine_name":"Google Datastore","engine_aliases":[],"default_driver":"datastore","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/google-sheets.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/google-sheets.mdx new file mode 100644 index 00000000000..e34ef97bb45 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/google-sheets.mdx @@ -0,0 +1,31 @@ +--- +title: Google Sheets +sidebar_label: Google Sheets +description: "Google Sheets allows querying spreadsheets as SQL tables via shillelagh." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.gsheets","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":61,"max_score":201,"documentation":{"description":"Google Sheets allows querying spreadsheets as SQL tables via shillelagh.","logo":"google-sheets.svg","homepage_url":"https://www.google.com/sheets/about/","categories":["Cloud - Google","Hosted Open Source"],"pypi_packages":["shillelagh[gsheetsapi]"],"install_instructions":"pip install \"apache-superset[gsheets]\"","connection_string":"gsheets://","notes":"Requires Google service account credentials or OAuth2 authentication. See docs for setup instructions.","category":"Cloud - Google","custom_errors":[{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"gsheets","engine_name":"Google Sheets","engine_aliases":[],"default_driver":"apsw","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/greenplum.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/greenplum.mdx new file mode 100644 index 00000000000..2c24c1dfdbe --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/greenplum.mdx @@ -0,0 +1,31 @@ +--- +title: Greenplum +sidebar_label: Greenplum +description: "VMware Greenplum is a massively parallel processing (MPP) database built on PostgreSQL." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.greenplum","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":94,"max_score":201,"documentation":{"description":"VMware Greenplum is a massively parallel processing (MPP) database built on PostgreSQL.","logo":"greenplum.png","homepage_url":"https://greenplum.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["sqlalchemy-greenplum","psycopg2"],"connection_string":"greenplum://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"Greenplum coordinator host","port":"Default 5432","database":"Database name"},"docs_url":"https://docs.vmware.com/en/VMware-Greenplum/","category":"Other Databases"},"engine":"greenplum","engine_name":"Greenplum","engine_aliases":["postgres"],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/hologres.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/hologres.mdx new file mode 100644 index 00000000000..158fc5fdac3 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/hologres.mdx @@ -0,0 +1,31 @@ +--- +title: Hologres +sidebar_label: Hologres +description: "Alibaba Cloud Hologres is a real-time interactive analytics service, fully compatible with PostgreSQL 11." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.hologres","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":34,"max_score":201,"documentation":{"description":"Alibaba Cloud Hologres is a real-time interactive analytics service, fully compatible with PostgreSQL 11.","logo":"hologres.png","homepage_url":"https://www.alibabacloud.com/product/hologres","categories":["Cloud Data Warehouses","Analytical Databases","Proprietary"],"pypi_packages":["psycopg2"],"connection_string":"postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"AccessKey ID of your Alibaba Cloud account","password":"AccessKey secret of your Alibaba Cloud account","host":"Public endpoint of the Hologres instance","port":"Port number of the Hologres instance","database":"Name of the Hologres database"},"default_port":80,"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.","category":"Other Databases"},"engine":"hologres","engine_name":"Hologres","engine_aliases":[],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2-for-i.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2-for-i.mdx new file mode 100644 index 00000000000..25fbbe29998 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2-for-i.mdx @@ -0,0 +1,31 @@ +--- +title: IBM Db2 for i +sidebar_label: IBM Db2 for i +description: "IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.ibmi","limit_method":2,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":38,"max_score":201,"documentation":{"description":"IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/db2","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["ibm_db_sa"],"connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","default_port":50000,"drivers":[{"name":"ibm_db_sa (with LIMIT)","connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","is_recommended":true},{"name":"ibm_db_sa (without LIMIT syntax)","connection_string":"ibm_db_sa://{username}:{password}@{hostname}:{port}/{database}","is_recommended":false,"notes":"Use for older DB2 versions without LIMIT [n] syntax. Recommended for SQL Lab."}],"compatible_databases":[{"name":"IBM Db2 for i (AS/400)","description":"Db2 for i is a fully integrated database engine on IBM i (AS/400) systems. Uses a different SQLAlchemy driver optimized for IBM i.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/products/db2-for-i","pypi_packages":["sqlalchemy-ibmi"],"connection_string":"ibmi://{username}:{password}@{host}/{database}","parameters":{"username":"IBM i username","password":"IBM i password","host":"IBM i system host","database":"Library/schema name"},"docs_url":"https://github.com/IBM/sqlalchemy-ibmi","categories":["Proprietary"]}],"docs_url":"https://github.com/ibmdb/python-ibmdbsa","category":"Other Databases"},"engine":"ibmi","engine_name":"IBM Db2 for i","engine_aliases":["ibm_db_sa"],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2.mdx new file mode 100644 index 00000000000..a9974a35d57 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2.mdx @@ -0,0 +1,31 @@ +--- +title: IBM Db2 +sidebar_label: IBM Db2 +description: "IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.db2","limit_method":2,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":30,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":38,"max_score":201,"documentation":{"description":"IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/db2","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["ibm_db_sa"],"connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","default_port":50000,"drivers":[{"name":"ibm_db_sa (with LIMIT)","connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","is_recommended":true},{"name":"ibm_db_sa (without LIMIT syntax)","connection_string":"ibm_db_sa://{username}:{password}@{hostname}:{port}/{database}","is_recommended":false,"notes":"Use for older DB2 versions without LIMIT [n] syntax. Recommended for SQL Lab."}],"compatible_databases":[{"name":"IBM Db2 for i (AS/400)","description":"Db2 for i is a fully integrated database engine on IBM i (AS/400) systems. Uses a different SQLAlchemy driver optimized for IBM i.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/products/db2-for-i","pypi_packages":["sqlalchemy-ibmi"],"connection_string":"ibmi://{username}:{password}@{host}/{database}","parameters":{"username":"IBM i username","password":"IBM i password","host":"IBM i system host","database":"Library/schema name"},"docs_url":"https://github.com/IBM/sqlalchemy-ibmi","categories":["Proprietary"]}],"docs_url":"https://github.com/ibmdb/python-ibmdbsa","category":"Other Databases"},"engine":"db2","engine_name":"IBM Db2","engine_aliases":["ibm_db_sa"],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ibm-netezza-performance-server.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-netezza-performance-server.mdx new file mode 100644 index 00000000000..4e3c561313a --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-netezza-performance-server.mdx @@ -0,0 +1,31 @@ +--- +title: IBM Netezza Performance Server +sidebar_label: IBM Netezza Performance Server +description: "IBM Netezza Performance Server is a data warehouse appliance." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.netezza","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"IBM Netezza Performance Server is a data warehouse appliance.","logo":"netezza.png","homepage_url":"https://www.ibm.com/products/netezza","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["nzalchemy"],"connection_string":"netezza+nzpy://{username}:{password}@{hostname}:{port}/{database}","default_port":5480,"category":"Other Databases"},"engine":"netezza","engine_name":"IBM Netezza Performance Server","engine_aliases":[],"default_driver":"nzpy","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/mariadb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/mariadb.mdx new file mode 100644 index 00000000000..1638d663180 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/mariadb.mdx @@ -0,0 +1,31 @@ +--- +title: MariaDB +sidebar_label: MariaDB +description: "MariaDB is a community-developed fork of MySQL." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.mariadb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":59,"max_score":201,"documentation":{"description":"MariaDB is a community-developed fork of MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"notes":"Uses the MySQL driver. Fully compatible with MySQL connector.","category":"Traditional RDBMS"},"engine":"mariadb","engine_name":"MariaDB","engine_aliases":[],"default_driver":"mysqldb","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/microsoft-sql-server.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/microsoft-sql-server.mdx new file mode 100644 index 00000000000..5b91b3c3c66 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/microsoft-sql-server.mdx @@ -0,0 +1,31 @@ +--- +title: Microsoft SQL Server +sidebar_label: Microsoft SQL Server +description: "Microsoft SQL Server is a relational database management system." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.mssql","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":false,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":44,"max_score":201,"documentation":{"description":"Microsoft SQL Server is a relational database management system.","logo":"msql.png","homepage_url":"https://www.microsoft.com/en-us/sql-server","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["pymssql"],"connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","default_port":1433,"drivers":[{"name":"pymssql","pypi_package":"pymssql","connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","is_recommended":true},{"name":"pyodbc","pypi_package":"pyodbc","connection_string":"mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3C{host}%3E%2C1433%3BDatabase%3D{database}%3BUid%3D{username}%3BPwd%3D{password}%3BEncrypt%3Dyes%3BConnection+Timeout%3D30","is_recommended":false,"notes":"Connection string must be URL-encoded. Special characters like @ need encoding."}],"docs_url":"https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords","category":"Cloud - Azure","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\", password, or database name \"%(database)s\" is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]}]},"engine":"mssql","engine_name":"Microsoft SQL Server","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/monetdb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/monetdb.mdx new file mode 100644 index 00000000000..96ec45a1237 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/monetdb.mdx @@ -0,0 +1,31 @@ +--- +title: MonetDB +sidebar_label: MonetDB +description: "MonetDB is an open-source column-oriented relational database for high-performance analytics." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.monetdb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":26,"max_score":201,"documentation":{"description":"MonetDB is an open-source column-oriented relational database for high-performance analytics.","logo":"monet-db.png","homepage_url":"https://www.monetdb.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["sqlalchemy-monetdb","pymonetdb"],"connection_string":"monetdb://{username}:{password}@{host}:{port}/{database}","default_port":50000,"parameters":{"username":"Database username (default: monetdb)","password":"Database password (default: monetdb)","host":"MonetDB server host","port":"Default 50000","database":"Database name"},"docs_url":"https://www.monetdb.org/documentation/","category":"Other Databases"},"engine":"monetdb","engine_name":"MonetDB","engine_aliases":[],"default_driver":"pymonetdb","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/mongodb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/mongodb.mdx new file mode 100644 index 00000000000..43cd0747e5e --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/mongodb.mdx @@ -0,0 +1,31 @@ +--- +title: MongoDB +sidebar_label: MongoDB +description: "MongoDB is a document-oriented, operational NoSQL database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.mongodb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":32,"max_score":201,"documentation":{"description":"MongoDB is a document-oriented, operational NoSQL database.","logo":"mongodb.png","homepage_url":"https://www.mongodb.com/","categories":["Search & NoSQL","Proprietary"],"pypi_packages":["pymongosql"],"connection_string":"mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset","parameters":{"username":"Username for MongoDB","password":"Password for MongoDB","host":"MongoDB host","port":"MongoDB port","database":"Database name"},"drivers":[{"name":"MongoDB Atlas Cloud","pypi_package":"pymongosql","connection_string":"mongodb+srv://{username}:{password}@{host}/{database}?mode=superset","notes":"For MongoDB Atlas cloud service.","is_recommended":true},{"name":"MongoDB Cluster","pypi_package":"pymongosql","connection_string":"mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset","is_recommended":false,"notes":"For self-hosted MongoDB instances."}],"notes":"Uses PartiQL for SQL queries. Requires mode=superset parameter.","docs_url":"https://github.com/passren/PyMongoSQL","category":"Other Databases"},"engine":"mongodb","engine_name":"MongoDB","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/motherduck.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/motherduck.mdx new file mode 100644 index 00000000000..b870c8306c3 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/motherduck.mdx @@ -0,0 +1,31 @@ +--- +title: MotherDuck +sidebar_label: MotherDuck +description: "MotherDuck is a serverless cloud analytics platform built on DuckDB. It combines the simplicity of DuckDB with cloud-scale data sharing and collaboration." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.duckdb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":58,"max_score":201,"documentation":{"description":"MotherDuck is a serverless cloud analytics platform built on DuckDB. It combines the simplicity of DuckDB with cloud-scale data sharing and collaboration.","logo":"motherduck.png","homepage_url":"https://motherduck.com/","categories":["Analytical Databases","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["duckdb","duckdb-engine"],"connection_string":"duckdb:///md:{database}?motherduck_token={token}","parameters":{"database":"MotherDuck database name","token":"Service token from MotherDuck dashboard"},"docs_url":"https://motherduck.com/docs/getting-started/","drivers":[{"name":"duckdb-engine","pypi_package":"duckdb-engine","connection_string":"duckdb:///md:{database}?motherduck_token={token}","is_recommended":true}],"category":"Other Databases","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"engine":"motherduck","engine_name":"MotherDuck","engine_aliases":["duckdb"],"default_driver":"duckdb_engine","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/mysql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/mysql.mdx new file mode 100644 index 00000000000..b4d904f7b04 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/mysql.mdx @@ -0,0 +1,31 @@ +--- +title: MySQL +sidebar_label: MySQL +description: "MySQL is a popular open-source relational database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.mysql","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":59,"max_score":201,"documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"compatible_databases":[{"name":"MariaDB","description":"MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","categories":["Open Source"]},{"name":"Amazon Aurora MySQL","description":"Amazon Aurora MySQL is a fully managed, MySQL-compatible relational database with up to 5x the throughput of standard MySQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"mysql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard MySQL connections also work with mysqlclient.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown MySQL server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"mysql","engine_name":"MySQL","engine_aliases":[],"default_driver":"mysqldb","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/oceanbase.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/oceanbase.mdx new file mode 100644 index 00000000000..38feb42cf61 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/oceanbase.mdx @@ -0,0 +1,31 @@ +--- +title: OceanBase +sidebar_label: OceanBase +description: "OceanBase is a distributed relational database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.oceanbase","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":59,"max_score":201,"documentation":{"description":"OceanBase is a distributed relational database.","logo":"oceanbase.svg","homepage_url":"https://www.oceanbase.com/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["oceanbase_py"],"connection_string":"oceanbase://{username}:{password}@{host}:{port}/{database}","category":"Other Databases","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown OceanBase server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"oceanbase","engine_name":"OceanBase","engine_aliases":["oceanbase","oceanbase_py"],"default_driver":"oceanbase","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ocient.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ocient.mdx new file mode 100644 index 00000000000..fffad0f2ba3 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ocient.mdx @@ -0,0 +1,31 @@ +--- +title: Ocient +sidebar_label: Ocient +description: "Ocient is a hyperscale data analytics database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.ocient","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":false,"max_column_name":30,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":38,"max_score":201,"documentation":{"description":"Ocient is a hyperscale data analytics database.","categories":["Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-ocient"],"connection_string":"ocient://{username}:{password}@{host}:{port}/{database}","install_instructions":"pip install sqlalchemy-ocient","category":"Other Databases","custom_errors":[{"regex_name":"CONNECTION_INVALID_USERNAME_REGEX","message_template":"The username \"%(username)s\" does not exist.","error_type":"CONNECTION_INVALID_USERNAME_ERROR","category":"Authentication","description":"Invalid username","issue_codes":[1012]},{"regex_name":"CONNECTION_INVALID_PASSWORD_REGEX","message_template":"The user/password combination is not valid (Incorrect password for user).","error_type":"CONNECTION_INVALID_PASSWORD_ERROR","category":"Authentication","description":"Invalid password","issue_codes":[1013]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Could not connect to database: \"%(database)s\"","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Could not resolve hostname: \"%(host)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_INVALID_PORT_ERROR","message_template":"Port out of range 0-65535","error_type":"CONNECTION_INVALID_PORT_ERROR"},{"regex_name":"INVALID_CONNECTION_STRING_REGEX","message_template":"Invalid Connection String: Expecting String of the form 'ocient://user:pass@host:port/database'.","error_type":"GENERIC_DB_ENGINE_ERROR","category":"General","description":"Database engine error","issue_codes":[1002]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Syntax Error: %(qualifier)s input \"%(input)s\" expecting \"%(expected)s","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"Table or View \"%(table)s\" does not exist.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"Invalid reference to column: \"%(column)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"engine":"ocient","engine_name":"Ocient","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/opensearch-opendistro.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/opensearch-opendistro.mdx new file mode 100644 index 00000000000..5fe70bbb58c --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/opensearch-opendistro.mdx @@ -0,0 +1,31 @@ +--- +title: OpenSearch (OpenDistro) +sidebar_label: OpenSearch (OpenDistro) +description: "Documentation for OpenSearch (OpenDistro) database connection." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.elasticsearch","limit_method":1,"limit_clause":true,"joins":false,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":false,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":26,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Other Databases"},"engine":"odelasticsearch","engine_name":"OpenSearch (OpenDistro)","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/oracle.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/oracle.mdx new file mode 100644 index 00000000000..0205c133e2b --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/oracle.mdx @@ -0,0 +1,31 @@ +--- +title: Oracle +sidebar_label: Oracle +description: "Oracle Database is a multi-model database management system." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.oracle","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Oracle Database is a multi-model database management system.","logo":"oraclelogo.png","homepage_url":"https://www.oracle.com/database/","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["oracledb"],"connection_string":"oracle://{username}:{password}@{hostname}:{port}","default_port":1521,"notes":"Previously used cx_Oracle, now uses oracledb.","docs_url":"https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html","category":"Other Databases"},"engine":"oracle","engine_name":"Oracle","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/parseable.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/parseable.mdx new file mode 100644 index 00000000000..f1e63991d9d --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/parseable.mdx @@ -0,0 +1,31 @@ +--- +title: Parseable +sidebar_label: Parseable +description: "Parseable is a distributed log analytics database with SQL-like query interface." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.parseable","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Parseable is a distributed log analytics database with SQL-like query interface.","categories":["Search & NoSQL","Open Source"],"pypi_packages":["sqlalchemy-parseable"],"connection_string":"parseable://{username}:{password}@{hostname}:{port}/{stream_name}","connection_examples":[{"description":"Example connection","connection_string":"parseable://admin:admin@demo.parseable.com:443/ingress-nginx"}],"notes":"Stream name in URI represents the Parseable logstream to query. Supports HTTP (80) and HTTPS (443).","docs_url":"https://www.parseable.io","category":"Other Databases"},"engine":"parseable","engine_name":"Parseable","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/postgresql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/postgresql.mdx new file mode 100644 index 00000000000..b4028907eac --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/postgresql.mdx @@ -0,0 +1,31 @@ +--- +title: PostgreSQL +sidebar_label: PostgreSQL +description: "PostgreSQL is an advanced open-source relational database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.postgres","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":true,"score":104,"max_score":201,"documentation":{"description":"PostgreSQL is an advanced open-source relational database.","logo":"postgresql.svg","homepage_url":"https://www.postgresql.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://www.postgresql.org/docs/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","compatible_databases":[{"name":"Hologres","description":"Alibaba Cloud real-time interactive analytics service, fully compatible with PostgreSQL 11.","logo":"hologres.png","homepage_url":"https://www.alibabacloud.com/product/hologres","pypi_packages":["psycopg2"],"connection_string":"postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"AccessKey ID of your Alibaba Cloud account","password":"AccessKey secret of your Alibaba Cloud account","host":"Public endpoint of the Hologres instance","port":"Port number of the Hologres instance","database":"Name of the Hologres database"},"categories":["Proprietary"]},{"name":"TimescaleDB","description":"Open-source relational database for time-series and analytics, built on PostgreSQL.","logo":"timescale.png","homepage_url":"https://www.timescale.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Timescale Cloud (SSL required)","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://docs.timescale.com/","categories":["Open Source"]},{"name":"YugabyteDB","description":"Distributed SQL database built on top of PostgreSQL.","logo":"yugabyte.png","homepage_url":"https://www.yugabyte.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://www.yugabyte.com/","categories":["Open Source"]},{"name":"Supabase","description":"Open-source Firebase alternative built on top of PostgreSQL, providing a full backend-as-a-service with a hosted Postgres database.","logo":"supabase.svg","homepage_url":"https://supabase.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Supabase project (connection pooler)","connection_string":"postgresql://{username}.{project_ref}:{password}@aws-0-{region}.pooler.supabase.com:6543/{database}"}],"parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"Supabase project host (from project settings)","port":"Default 5432 (direct) or 6543 (pooler)","database":"Database name (default: postgres)","project_ref":"Supabase project reference (from project settings)","region":"Supabase project region (e.g., us-east-1)"},"notes":"Find connection details in your Supabase project dashboard under Settings > Database. Use the connection pooler (port 6543) for better connection management.","docs_url":"https://supabase.com/docs/guides/database/connecting-to-postgres","categories":["Hosted Open Source"]},{"name":"Google AlloyDB","description":"Google Cloud's PostgreSQL-compatible database service for demanding transactional and analytical workloads.","logo":"alloydb.png","homepage_url":"https://cloud.google.com/alloydb","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"AlloyDB instance IP or Auth Proxy address","port":"Default 5432","database":"Database name"},"notes":"For public IP connections, use the AlloyDB Auth Proxy for secure access. Private IP connections can connect directly.","docs_url":"https://cloud.google.com/alloydb/docs","categories":["Cloud - Google","Hosted Open Source"]},{"name":"Neon","description":"Serverless PostgreSQL with branching, scale-to-zero, and bottomless storage.","logo":"neon.png","homepage_url":"https://neon.tech/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}/{database}?sslmode=require","parameters":{"username":"Neon role name","password":"Neon role password","host":"Neon hostname (e.g., ep-cool-name-123456.us-east-2.aws.neon.tech)","database":"Database name (default: neondb)"},"notes":"SSL is required for all connections. Find connection details in the Neon console under Connection Details.","docs_url":"https://neon.tech/docs/connect/connect-from-any-app","categories":["Hosted Open Source"]},{"name":"Amazon Aurora PostgreSQL","description":"Amazon Aurora PostgreSQL is a fully managed, PostgreSQL-compatible relational database with up to 5x the throughput of standard PostgreSQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"postgresql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard PostgreSQL connections also work with psycopg2.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS","custom_errors":[{"regex_name":"CONNECTION_INVALID_USERNAME_REGEX","message_template":"The username \"%(username)s\" does not exist.","error_type":"CONNECTION_INVALID_USERNAME_ERROR","category":"Authentication","description":"Invalid username","issue_codes":[1012],"invalid_fields":["username"]},{"regex_name":"CONNECTION_INVALID_PASSWORD_REGEX","message_template":"The password provided for username \"%(username)s\" is incorrect.","error_type":"CONNECTION_INVALID_PASSWORD_ERROR","category":"Authentication","description":"Invalid password","issue_codes":[1013],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_PASSWORD_NEEDED_REGEX","message_template":"Please re-enter the password.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"postgresql","engine_name":"PostgreSQL","engine_aliases":["postgres"],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/presto.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/presto.mdx new file mode 100644 index 00000000000..38d86c2d48e --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/presto.mdx @@ -0,0 +1,31 @@ +--- +title: Presto +sidebar_label: Presto +description: "Presto is a distributed SQL query engine for big data." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.presto","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":true,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":true,"expand_data":true,"query_cost_estimation":true,"sql_validation":true,"score":159,"max_score":201,"documentation":{"description":"Presto is a distributed SQL query engine for big data.","logo":"presto-og.png","homepage_url":"https://prestodb.io/","categories":["Query Engines","Open Source"],"pypi_packages":["pyhive"],"install_instructions":"pip install \"apache-superset[presto]\"","connection_string":"presto://{hostname}:{port}/{database}","default_port":8080,"parameters":{"hostname":"Presto coordinator hostname","port":"Presto coordinator port (default 8080)","database":"Catalog name"},"drivers":[{"name":"PyHive","pypi_package":"pyhive","connection_string":"presto://{hostname}:{port}/{database}","is_recommended":true}],"category":"Query Engines","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table_name)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema_name)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_ERROR","message_template":"Unable to connect to catalog named \"%(catalog_name)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015]}]},"engine":"presto","engine_name":"Presto","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/risingwave.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/risingwave.mdx new file mode 100644 index 00000000000..359e50a492c --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/risingwave.mdx @@ -0,0 +1,31 @@ +--- +title: RisingWave +sidebar_label: RisingWave +description: "RisingWave is a distributed streaming database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.risingwave","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":94,"max_score":201,"documentation":{"description":"RisingWave is a distributed streaming database.","logo":"risingwave.svg","homepage_url":"https://risingwave.com/","categories":["Analytical Databases","Open Source"],"pypi_packages":["sqlalchemy-risingwave"],"connection_string":"risingwave://root@{hostname}:{port}/{database}?sslmode=disable","default_port":4566,"docs_url":"https://github.com/risingwavelabs/sqlalchemy-risingwave","category":"Other Databases"},"engine":"risingwave","engine_name":"RisingWave","engine_aliases":["postgres"],"default_driver":"","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/sap-hana.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/sap-hana.mdx new file mode 100644 index 00000000000..cb688b87c55 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/sap-hana.mdx @@ -0,0 +1,31 @@ +--- +title: SAP HANA +sidebar_label: SAP HANA +description: "SAP HANA is an in-memory relational database and application platform." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.hana","limit_method":2,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":30,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":27,"max_score":201,"documentation":{"description":"SAP HANA is an in-memory relational database and application platform.","logo":"sap-hana.png","homepage_url":"https://www.sap.com/products/technology-platform/hana.html","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["hdbcli","sqlalchemy-hana"],"install_instructions":"pip install apache_superset[hana]","connection_string":"hana://{username}:{password}@{host}:{port}","default_port":30015,"docs_url":"https://github.com/SAP/sqlalchemy-hana","category":"Other Databases"},"engine":"hana","engine_name":"SAP HANA","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/sap-sybase.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/sap-sybase.mdx new file mode 100644 index 00000000000..ca90dee5341 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/sap-sybase.mdx @@ -0,0 +1,31 @@ +--- +title: SAP Sybase +sidebar_label: SAP Sybase +description: "SAP ASE (formerly Sybase) is an enterprise relational database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.sybase","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":false,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":44,"max_score":201,"documentation":{"description":"SAP ASE (formerly Sybase) is an enterprise relational database.","logo":"sybase.png","homepage_url":"https://www.sap.com/products/technology-platform/sybase-ase.html","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["sqlalchemy-sybase","pyodbc"],"connection_string":"sybase+pyodbc://{username}:{password}@{dsn}","parameters":{"username":"Database username","password":"Database password","dsn":"ODBC Data Source Name configured for SAP ASE"},"notes":"Requires SAP ASE ODBC driver installed and configured as a DSN.","docs_url":"https://help.sap.com/docs/SAP_ASE","category":"Other Databases"},"engine":"sybase","engine_name":"SAP Sybase","engine_aliases":["sybase_sqlany"],"default_driver":"pyodbc","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/shillelagh.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/shillelagh.mdx new file mode 100644 index 00000000000..cb04e812786 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/shillelagh.mdx @@ -0,0 +1,31 @@ +--- +title: Shillelagh +sidebar_label: Shillelagh +description: "Shillelagh is a Python library that allows querying many data sources using SQL, including Google Sheets, CSV files, and APIs." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.shillelagh","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":41,"max_score":201,"documentation":{"description":"Shillelagh is a Python library that allows querying many data sources using SQL, including Google Sheets, CSV files, and APIs.","logo":"shillelagh.png","homepage_url":"https://shillelagh.readthedocs.io/","categories":["Other Databases","Open Source"],"pypi_packages":["shillelagh[gsheetsapi]"],"connection_string":"shillelagh://","notes":"Shillelagh uses virtual tables to query external data sources. Google Sheets requires OAuth credentials configured.","category":"Other Databases"},"engine":"shillelagh","engine_name":"Shillelagh","engine_aliases":[],"default_driver":"apsw","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/singlestore.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/singlestore.mdx new file mode 100644 index 00000000000..73e8586c3d6 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/singlestore.mdx @@ -0,0 +1,31 @@ +--- +title: SingleStore +sidebar_label: SingleStore +description: "SingleStore is a distributed SQL database for real-time analytics and transactions." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.singlestore","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":256,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":68,"max_score":201,"documentation":{"description":"SingleStore is a distributed SQL database for real-time analytics and transactions.","logo":"singlestore.png","homepage_url":"https://www.singlestore.com/","categories":["Analytical Databases","Proprietary"],"pypi_packages":["singlestoredb"],"connection_string":"singlestoredb://{username}:{password}@{host}:{port}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"SingleStore host","port":"SingleStore port (default 3306)","database":"Database name"},"drivers":[{"name":"singlestoredb","pypi_package":"singlestoredb","connection_string":"singlestoredb://{username}:{password}@{host}:{port}/{database}","is_recommended":true}],"category":"Other Databases"},"engine":"singlestoredb","engine_name":"SingleStore","engine_aliases":[],"default_driver":"singlestoredb","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/snowflake.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/snowflake.mdx new file mode 100644 index 00000000000..b29da4433c3 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/snowflake.mdx @@ -0,0 +1,31 @@ +--- +title: Snowflake +sidebar_label: Snowflake +description: "Snowflake is a cloud-native data warehouse." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.snowflake","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":256,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":72,"max_score":201,"documentation":{"description":"Snowflake is a cloud-native data warehouse.","logo":"snowflake.svg","homepage_url":"https://www.snowflake.com/","categories":["Cloud Data Warehouses","Analytical Databases","Proprietary"],"pypi_packages":["snowflake-sqlalchemy"],"connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}","install_instructions":"echo \"snowflake-sqlalchemy\" >> ./docker/requirements-local.txt","connection_examples":[{"description":"With role and warehouse","connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}"},{"description":"With defaults (role/warehouse optional)","connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}"}],"authentication_methods":[{"name":"Key Pair Authentication","description":"Use RSA key pair instead of password","requirements":"Key pair must be generated and public key registered in Snowflake","notes":"Merge multi-line private key to one line with \\n between lines."}],"notes":"Schema is not required in connection string. Ensure user has privileges for all databases/schemas/tables/views/warehouses.","docs_url":"https://docs.snowflake.com/en/user-guide/key-pair-auth.html","category":"Cloud Data Warehouses","custom_errors":[{"regex_name":"OBJECT_DOES_NOT_EXIST_REGEX","message_template":"%(object)s does not exist in this database.","error_type":"OBJECT_DOES_NOT_EXIST_ERROR","category":"Query","description":"Object not found","issue_codes":[1029]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"snowflake","engine_name":"Snowflake","engine_aliases":[],"default_driver":"snowflake","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/sqlite.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/sqlite.mdx new file mode 100644 index 00000000000..00712bd53c4 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/sqlite.mdx @@ -0,0 +1,31 @@ +--- +title: SQLite +sidebar_label: SQLite +description: "SQLite is a self-contained, serverless SQL database engine." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.sqlite","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":41,"max_score":201,"documentation":{"description":"SQLite is a self-contained, serverless SQL database engine.","logo":"sqlite.png","homepage_url":"https://www.sqlite.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":[],"connection_string":"sqlite:///path/to/file.db?check_same_thread=false","notes":"No additional library needed. SQLite is bundled with Python.","category":"Traditional RDBMS","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"engine":"sqlite","engine_name":"SQLite","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/starrocks.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/starrocks.mdx new file mode 100644 index 00000000000..33c76bf749f --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/starrocks.mdx @@ -0,0 +1,31 @@ +--- +title: StarRocks +sidebar_label: StarRocks +description: "StarRocks is a high-performance analytical database for real-time analytics." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.starrocks","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":89,"max_score":201,"documentation":{"description":"StarRocks is a high-performance analytical database for real-time analytics.","logo":"starrocks.png","homepage_url":"https://www.starrocks.io/","categories":["Analytical Databases","Open Source"],"pypi_packages":["starrocks"],"connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","default_port":9030,"parameters":{"username":"Database username","password":"Database password","host":"StarRocks FE host","port":"Query port (default 9030)","catalog":"Catalog name","database":"Database name"},"drivers":[{"name":"starrocks","pypi_package":"starrocks","connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","is_recommended":true},{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"MySQL-compatible driver for StarRocks."},{"name":"PyMySQL","pypi_package":"pymysql","connection_string":"mysql+pymysql://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"Pure Python MySQL driver, no compilation required."}],"compatible_databases":[{"name":"CelerData","description":"CelerData is a fully-managed cloud analytics service built on StarRocks. It provides instant elasticity, automatic scaling, and enterprise features.","logo":"celerdata.png","homepage_url":"https://celerdata.com/","categories":["Analytical Databases","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["starrocks"],"connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","parameters":{"username":"CelerData username","password":"CelerData password","host":"CelerData cluster endpoint","port":"Query port (default 9030)","catalog":"Catalog name","database":"Database name"},"docs_url":"https://docs.celerdata.com/"}],"category":"Analytical Databases","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]}]},"engine":"starrocks","engine_name":"StarRocks","engine_aliases":[],"default_driver":"starrocks","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/superset-meta-database.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/superset-meta-database.mdx new file mode 100644 index 00000000000..911cf2a096b --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/superset-meta-database.mdx @@ -0,0 +1,31 @@ +--- +title: Superset meta database +sidebar_label: Superset meta database +description: "Superset meta database is an experimental feature that enables querying across multiple configured databases using a single connection." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.superset","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":31,"max_score":201,"documentation":{"description":"Superset meta database is an experimental feature that enables querying across multiple configured databases using a single connection.","logo":"superset.svg","homepage_url":"https://superset.apache.org/","categories":["Other Databases"],"pypi_packages":[],"connection_string":"superset://","notes":"This is an internal Superset feature. Enable with ENABLE_SUPERSET_META_DB feature flag. Allows cross-database queries using virtual tables.","category":"Other Databases"},"engine":"superset","engine_name":"Superset meta database","engine_aliases":[],"default_driver":"","supports_file_upload":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/tdengine.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/tdengine.mdx new file mode 100644 index 00000000000..ff417a50b9c --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/tdengine.mdx @@ -0,0 +1,31 @@ +--- +title: TDengine +sidebar_label: TDengine +description: "TDengine is a high-performance time-series database for IoT." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":false,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":false},"module":"superset.db_engine_specs.tdengine","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":25,"max_score":201,"documentation":{"description":"TDengine is a high-performance time-series database for IoT.","logo":"tdengine.png","homepage_url":"https://tdengine.com/","categories":["Time Series Databases","Open Source"],"pypi_packages":["taospy","taos-ws-py"],"connection_string":"taosws://{user}:{password}@{host}:{port}","default_port":6041,"connection_examples":[{"description":"Local connection","connection_string":"taosws://root:taosdata@127.0.0.1:6041"}],"docs_url":"https://www.tdengine.com","category":"Other Databases"},"engine":"taosws","engine_name":"TDengine","engine_aliases":[],"default_driver":"taosws","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/teradata.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/teradata.mdx new file mode 100644 index 00000000000..c4d918f85fb --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/teradata.mdx @@ -0,0 +1,31 @@ +--- +title: Teradata +sidebar_label: Teradata +description: "Teradata is an enterprise data warehouse platform." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.teradata","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":30,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":27,"max_score":201,"documentation":{"description":"Teradata is an enterprise data warehouse platform.","logo":"teradata.png","homepage_url":"https://www.teradata.com/","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["teradatasqlalchemy"],"connection_string":"teradatasql://{user}:{password}@{host}","default_port":1025,"drivers":[{"name":"teradatasqlalchemy (Recommended)","pypi_package":"teradatasqlalchemy","connection_string":"teradatasql://{user}:{password}@{host}","is_recommended":true,"notes":"No ODBC drivers required."},{"name":"sqlalchemy-teradata (ODBC)","pypi_package":"sqlalchemy-teradata","is_recommended":false,"notes":"Requires ODBC driver installation.","docs_url":"https://downloads.teradata.com/download/connectivity/odbc-driver/linux"}],"category":"Other Databases"},"engine":"teradatasql","engine_name":"Teradata","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/timescaledb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/timescaledb.mdx new file mode 100644 index 00000000000..8ab7804864f --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/timescaledb.mdx @@ -0,0 +1,31 @@ +--- +title: TimescaleDB +sidebar_label: TimescaleDB +description: "TimescaleDB is an open-source relational database for time-series and analytics, built on PostgreSQL." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.timescaledb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":34,"max_score":201,"documentation":{"description":"TimescaleDB is an open-source relational database for time-series and analytics, built on PostgreSQL.","logo":"timescale.png","homepage_url":"https://www.timescale.com/","categories":["Analytical Databases","Open Source"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"connection_examples":[{"description":"Timescale Cloud (SSL required)","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.","docs_url":"https://docs.timescale.com/","category":"Other Databases"},"engine":"timescaledb","engine_name":"TimescaleDB","engine_aliases":[],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/trino.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/trino.mdx new file mode 100644 index 00000000000..ff360c2be4a --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/trino.mdx @@ -0,0 +1,31 @@ +--- +title: Trino +sidebar_label: Trino +description: "Trino is a distributed SQL query engine for big data analytics." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.trino","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":true,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":true,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":149,"max_score":201,"documentation":{"description":"Trino is a distributed SQL query engine for big data analytics.","logo":"trino.png","homepage_url":"https://trino.io/","categories":["Query Engines","Open Source"],"pypi_packages":["trino"],"install_instructions":"pip install \"apache-superset[trino]\"","connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","default_port":8080,"parameters":{"username":"Trino username","password":"Trino password (if authentication is enabled)","hostname":"Trino coordinator hostname","port":"Trino coordinator port (default 8080)","catalog":"Catalog name"},"drivers":[{"name":"trino","pypi_package":"trino","connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","is_recommended":true}],"compatible_databases":[{"name":"Starburst Galaxy","description":"Starburst Galaxy is a fully-managed cloud analytics platform built on Trino. It provides data lake analytics with enterprise security and governance.","logo":"starburst.png","homepage_url":"https://www.starburst.io/platform/starburst-galaxy/","categories":["Query Engines","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["trino"],"connection_string":"trino://{username}:{password}@{host}:{port}/{catalog}","parameters":{"username":"Starburst Galaxy username (email/role)","password":"Starburst Galaxy password or token","host":"Your Galaxy cluster hostname","port":"Port (default 443)","catalog":"Catalog name"},"docs_url":"https://docs.starburst.io/starburst-galaxy/"},{"name":"Starburst Enterprise","description":"Starburst Enterprise is a self-managed Trino distribution with enterprise features, security, and support.","logo":"starburst.png","homepage_url":"https://www.starburst.io/platform/starburst-enterprise/","categories":["Query Engines","Hosted Open Source"],"pypi_packages":["trino"],"connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","docs_url":"https://docs.starburst.io/"}],"category":"Query Engines"},"engine":"trino","engine_name":"Trino","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/vertica.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/vertica.mdx new file mode 100644 index 00000000000..8cd1b4433db --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/vertica.mdx @@ -0,0 +1,31 @@ +--- +title: Vertica +sidebar_label: Vertica +description: "Vertica is a column-oriented analytics database." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.vertica","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":34,"max_score":201,"documentation":{"description":"Vertica is a column-oriented analytics database.","logo":"vertica.png","homepage_url":"https://www.vertica.com/","categories":["Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-vertica-python"],"connection_string":"vertica+vertica_python://{username}:{password}@{host}/{database}","default_port":5433,"parameters":{"username":"Database username","password":"Database password","host":"localhost, IP address, or hostname (cloud or on-prem)","database":"Database name","port":"Default 5433"},"notes":"Supports load balancer backup host configuration.","docs_url":"http://www.vertica.com/","category":"Analytical Databases"},"engine":"vertica","engine_name":"Vertica","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ydb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ydb.mdx new file mode 100644 index 00000000000..7ea11a19ee8 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ydb.mdx @@ -0,0 +1,31 @@ +--- +title: YDB +sidebar_label: YDB +description: "YDB is a distributed SQL database by Yandex." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.ydb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":23,"max_score":201,"documentation":{"description":"YDB is a distributed SQL database by Yandex.","logo":"ydb.svg","homepage_url":"https://ydb.tech/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["ydb-sqlalchemy"],"connection_string":"ydb://{host}:{port}/{database_name}","default_port":2135,"engine_parameters":[{"name":"Protocol","description":"Specify connection protocol (default: grpc)","secure_extra":{"protocol":"grpcs"}}],"authentication_methods":[{"name":"Static Credentials","description":"Username/password authentication","secure_extra":{"credentials":{"username":"...","password":"..."}}},{"name":"Access Token","description":"Token-based authentication","secure_extra":{"credentials":{"token":"..."}}},{"name":"Service Account","description":"Service account JSON credentials","secure_extra":{"credentials":{"service_account_json":{"id":"...","service_account_id":"...","private_key":"..."}}}}],"category":"Other Databases"},"engine":"yql","engine_name":"YDB","engine_aliases":["yql+ydb","ydb"],"default_driver":"ydb","supports_file_upload":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/yugabytedb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/yugabytedb.mdx new file mode 100644 index 00000000000..36b56dac527 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/databases/supported/yugabytedb.mdx @@ -0,0 +1,31 @@ +--- +title: YugabyteDB +sidebar_label: YugabyteDB +description: "YugabyteDB is a distributed SQL database built on top of PostgreSQL." +hide_title: true +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +import { DatabasePage } from '@site/src/components/databases'; + +export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.yugabytedb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":34,"max_score":201,"documentation":{"description":"YugabyteDB is a distributed SQL database built on top of PostgreSQL.","logo":"yugabyte.png","homepage_url":"https://www.yugabyte.com/","categories":["Cloud Data Warehouses","Traditional RDBMS","Open Source"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5433,"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.","docs_url":"https://docs.yugabyte.com/","category":"Other Databases"},"engine":"yugabytedb","engine_name":"YugabyteDB","engine_aliases":[],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; + + diff --git a/docs/versioned_docs/version-6.1.0/faq.mdx b/docs/versioned_docs/version-6.1.0/faq.mdx new file mode 100644 index 00000000000..2e6ff2fefa8 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/faq.mdx @@ -0,0 +1,341 @@ +--- +sidebar_position: 9 +title: Frequently Asked Questions +description: Common questions about Apache Superset including performance, database support, visualizations, and configuration. +keywords: [superset faq, superset questions, superset help, data visualization faq] +--- + +import FAQSchema from '@site/src/components/FAQSchema'; + + + +# FAQ + +## How big of a dataset can Superset handle? + +Superset can work with even gigantic databases! Superset acts as a thin layer above your underlying +databases or data engines, which do all the processing. Superset simply visualizes the results of +the query. + +The key to achieving acceptable performance in Superset is whether your database can execute queries +and return results at a speed that is acceptable to your users. If you experience slow performance with +Superset, benchmark and tune your data warehouse. + +## What are the computing specifications required to run Superset? + +The specs of your Superset installation depend on how many users you have and what their activity is, not +on the size of your data. Superset admins in the community have reported 8GB RAM, 2vCPUs as adequate to +run a moderately-sized instance. To develop Superset, e.g., compile code or build images, you may +need more power. + +Monitor your resource usage and increase or decrease as needed. Note that Superset usage has a tendency +to occur in spikes, e.g., if everyone in a meeting loads the same dashboard at once. + +Superset's application metadata does not require a very large database to store it, though +the log file grows over time. + +## Can I join / query multiple tables at one time? + +Not in the Explore or Visualization UI. A Superset SQLAlchemy datasource can only be a single table +or a view. + +When working with tables, the solution would be to create a table that contains all the fields +needed for your analysis, most likely through some scheduled batch process. + +A view is a simple logical layer that abstracts an arbitrary SQL query as a virtual table. This can +allow you to join and union multiple tables and to apply some transformation using arbitrary SQL +expressions. The limitation there is your database performance, as Superset effectively will run a +query on top of your query (view). A good practice may be to limit yourself to joining your main +large table to one or many small tables only, and avoid using _GROUP BY_ where possible as Superset +will do its own _GROUP BY_ and doing the work twice might slow down performance. + +Whether you use a table or a view, performance depends on how fast your database can deliver +the result to users interacting with Superset. + +However, if you are using SQL Lab, there is no such limitation. You can write SQL queries to join +multiple tables as long as your database account has access to the tables. + +## How do I create my own visualization? + +We recommend reading the instructions in +[Creating Visualization Plugins](/developer-docs/contributing/howtos#creating-visualization-plugins). + +## Can I upload and visualize CSV data? + +Absolutely! Read the instructions [here](/user-docs/using-superset/exploring-data) to learn +how to enable and use CSV upload. + +## Why are my queries timing out? + +There are many possible causes for why a long-running query might time out. + +For running long query from Sql Lab, by default Superset allows it run as long as 6 hours before it +being killed by celery. If you want to increase the time for running query, you can specify the +timeout in configuration. For example: + +```python +SQLLAB_ASYNC_TIME_LIMIT_SEC = 60 * 60 * 6 +``` + +If you are seeing timeouts (504 Gateway Time-out) when loading dashboard or explore slice, you are +probably behind gateway or proxy server (such as Nginx). If it did not receive a timely response +from Superset server (which is processing long queries), these web servers will send 504 status code +to clients directly. Superset has a client-side timeout limit to address this issue. If query didn’t +come back within client-side timeout (60 seconds by default), Superset will display warning message +to avoid gateway timeout message. If you have a longer gateway timeout limit, you can change the +timeout settings in **superset_config.py**: + +```python +SUPERSET_WEBSERVER_TIMEOUT = 60 +``` + +## Why is the map not visible in the geospatial visualization? + +You need to register a free account at [Mapbox.com](https://www.mapbox.com), obtain an API key, and add it +to **.env** at the key MAPBOX_API_KEY: + +```python +MAPBOX_API_KEY = "longstringofalphanumer1c" +``` + +## How to limit the timed refresh on a dashboard? + +By default, the dashboard timed refresh feature allows you to automatically re-query every slice on +a dashboard according to a set schedule. Sometimes, however, you won’t want all of the slices to be +refreshed - especially if some data is slow moving, or run heavy queries. To exclude specific slices +from the timed refresh process, add the `timed_refresh_immune_slices` key to the dashboard JSON +Metadata field: + +```json +{ + "filter_immune_slices": [], + "expanded_slices": {}, + "filter_immune_slice_fields": {}, + "timed_refresh_immune_slices": [324] +} +``` + +In the example above, if a timed refresh is set for the dashboard, then every slice except 324 will +be automatically re-queried on schedule. + +Slice refresh will also be staggered over the specified period. You can turn off this staggering by +setting the `stagger_refresh` to false and modify the stagger period by setting `stagger_time` to a +value in milliseconds in the JSON Metadata field: + +```json +{ + "stagger_refresh": false, + "stagger_time": 2500 +} +``` + +Here, the entire dashboard will refresh at once if periodic refresh is on. The stagger time of 2.5 +seconds is ignored. + +**Why does ‘flask fab’ or superset freeze/hang/not responding when started (my home directory is +NFS mounted)?** + +By default, Superset creates and uses an SQLite database at `~/.superset/superset.db`. SQLite is +known to [not work well if used on NFS](https://www.sqlite.org/lockingv3.html) due to broken file +locking implementation on NFS. + +You can override this path using the **SUPERSET_HOME** environment variable. + +Another workaround is to change where superset stores the sqlite database by adding the following in +`superset_config.py`: + +```python +SQLALCHEMY_DATABASE_URI = 'sqlite:////new/location/superset.db?check_same_thread=false' +``` + +You can read more about customizing Superset using the configuration file +[here](/admin-docs/configuration/configuring-superset). + +## What if the table schema changed? + +Table schemas evolve, and Superset needs to reflect that. It’s pretty common in the life cycle of a +dashboard to want to add a new dimension or metric. To get Superset to discover your new columns, +all you have to do is to go to **Data -> Datasets**, click the edit icon next to the dataset +whose schema has changed, and hit **Sync columns from source** from the **Columns** tab. +Behind the scene, the new columns will get merged. Following this, you may want to re-edit the +table afterwards to configure the Columns tab, check the appropriate boxes and save again. + +## What database engine can I use as a backend for Superset? + +To clarify, the database backend is an OLTP database used by Superset to store its internal +information like your list of users and dashboard definitions. While Superset supports a +[variety of databases as data _sources_](/user-docs/databases/#installing-database-drivers), +only a few database engines are supported for use as the OLTP backend / metadata store. + +Superset is tested using MySQL, PostgreSQL, and SQLite backends. It’s recommended you install +Superset on one of these database servers for production. Installation on other OLTP databases +may work but isn’t tested. It has been reported that [Microsoft SQL Server does _not_ +work as a Superset backend](https://github.com/apache/superset/issues/18961). Column-store, +non-OLTP databases are not designed for this type of workload. + +## How can I configure OAuth authentication and authorization? + +You can take a look at this Flask-AppBuilder +[configuration example](https://github.com/dpgaspar/Flask-AppBuilder/blob/master/examples/oauth/config.py). + +## Is there a way to force the dashboard to use specific colors? + +It is possible on a per-dashboard basis by providing a mapping of labels to colors in the JSON +Metadata attribute using the `label_colors` key. You can use either the full hex color, a named color, +like `red`, `coral` or `lightblue`, or the index in the current color palette (0 for first color, 1 for +second etc). Example: + +```json +{ + "label_colors": { + "foo": "#FF69B4", + "bar": "lightblue", + "baz": 0 + } +} +``` + +## Does Superset work with [insert database engine here]? + +The [Connecting to Databases section](/user-docs/databases/) provides the best +overview for supported databases. Database engines not listed on that page may work too. We rely on +the community to contribute to this knowledge base. + +For a database engine to be supported in Superset through the SQLAlchemy connector, it requires +having a Python compliant [SQLAlchemy dialect](https://docs.sqlalchemy.org/en/13/dialects/) as well +as a [DBAPI driver](https://www.python.org/dev/peps/pep-0249/) defined. Database that have limited +SQL support may work as well. For instance it’s possible to connect to Druid through the SQLAlchemy +connector even though Druid does not support joins and subqueries. Another key element for a +database to be supported is through the Superset Database Engine Specification interface. This +interface allows for defining database-specific configurations and logic that go beyond the +SQLAlchemy and DBAPI scope. This includes features like: + +- date-related SQL function that allow Superset to fetch different time granularities when running + time-series queries +- whether the engine supports subqueries. If false, Superset may run 2-phase queries to compensate + for the limitation +- methods around processing logs and inferring the percentage of completion of a query +- technicalities as to how to handle cursors and connections if the driver is not standard DBAPI + +Beyond the SQLAlchemy connector, it’s also possible, though much more involved, to extend Superset +and write your own connector. The only example of this at the moment is the Druid connector, which +is getting superseded by Druid’s growing SQL support and the recent availability of a DBAPI and +SQLAlchemy driver. If the database you are considering integrating has any kind of SQL support, +it’s probably preferable to go the SQLAlchemy route. Note that for a native connector to be possible +the database needs to have support for running OLAP-type queries and should be able to do things that +are typical in basic SQL: + +- aggregate data +- apply filters +- apply HAVING-type filters +- be schema-aware, expose columns and types + +## Does Superset offer a public API? + +Yes, a public REST API, and the surface of that API formal is expanding steadily. You can read more about this API and +interact with it using Swagger [here](/developer-docs/api). + +Some of the +original vision for the collection of endpoints under **/api/v1** was originally specified in +[SIP-17](https://github.com/apache/superset/issues/7259) and constant progress has been +made to cover more and more use cases. + +The API available is documented using [Swagger](https://swagger.io/) and the documentation can be +made available under **/swagger/v1** by enabling the following flag in `superset_config.py`: + +```python +FAB_API_SWAGGER_UI = True +``` + +There are other undocumented [private] ways to interact with Superset programmatically that offer no +guarantees and are not recommended but may fit your use case temporarily: + +- using the ORM (SQLAlchemy) directly +- using the internal FAB ModelView API (to be deprecated in Superset) +- altering the source code in your fork + +## How can I see usage statistics (e.g., monthly active users)? + +This functionality is not included with Superset, but you can extract and analyze Superset's application +metadata to see what actions have occurred. By default, user activities are logged in the `logs` table +in Superset's metadata database. One company has published a write-up of [how they analyzed Superset +usage, including example queries](https://engineering.hometogo.com/monitor-superset-usage-via-superset-c7f9fba79525). + +## What Does Hours Offset in the Edit Dataset view do? + +In the Edit Dataset view, you can specify a time offset. This field lets you configure the +number of hours to be added or subtracted from the time column. +This can be used, for example, to convert UTC time to local time. + +## Does Superset collect any telemetry data? + +Superset uses [Scarf](https://about.scarf.sh/) by default to collect basic telemetry data upon installing and/or running Superset. This data helps the maintainers of Superset better understand which versions of Superset are being used, in order to prioritize patch/minor releases and security fixes. +We use the [Scarf Gateway](https://docs.scarf.sh/gateway/) to sit in front of container registries, the [scarf-js](https://about.scarf.sh/package-sdks) package to track `npm` installations, and a Scarf pixel to gather anonymous analytics on Superset page views. +Scarf purges PII and provides aggregated statistics. Superset users can easily opt out of analytics in various ways documented [here](https://docs.scarf.sh/gateway/#do-not-track) and [here](https://docs.scarf.sh/package-analytics/#as-a-user-of-a-package-using-scarf-js-how-can-i-opt-out-of-analytics). +Superset maintainers can also opt out of telemetry data collection by setting the `SCARF_ANALYTICS` environment variable to `false` in the Superset container (or anywhere Superset/webpack are run). +Additional opt-out instructions for Docker users are available on the [Docker Installation](/admin-docs/installation/docker-compose) page. + +## Does Superset have an archive panel or trash bin from which a user can recover deleted assets? + +No. Currently, there is no way to recover a deleted Superset dashboard/chart/dataset/database from the UI. However, there is an [ongoing discussion](https://github.com/apache/superset/discussions/18386) about implementing such a feature. + +Hence, it is recommended to take periodic backups of the metadata database. For recovery, you can launch a recovery instance of a Superset server with the backed-up copy of the DB attached and use the Export Dashboard button in the Superset UI (or the `superset export-dashboards` CLI command). Then, take the .zip file and import it into the current Superset instance. + +Alternatively, you can programmatically take regular exports of the assets as a backup. + +## I ran a security scan of the Superset container image and it showed dozens of "high" and "critical" vulnerabilities! Can you release a version of Superset without these? + +You are talking about dependency CVEs: identified vulnerabilities in software that Superset uses. Most of these CVEs are in the Linux kernel or Python, both of which have many other people working on their security. + +We address these dependency CVEs as best we can by regularly updating our dependencies to newer versions. We use bots to assist with that and cheerfully welcome pull requests from humans that fix dependency CVEs. + +The Superset [security team](https://superset.apache.org/docs/security/#reporting-security-vulnerabilities) focuses primarily on vulnerabilities _in Superset itself_. See our [CVEs page](https://superset.apache.org/docs/security/cves) for a list of past Superset CVEs. diff --git a/docs/versioned_docs/version-6.1.0/index.mdx b/docs/versioned_docs/version-6.1.0/index.mdx new file mode 100644 index 00000000000..681acd6d2d5 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/index.mdx @@ -0,0 +1,269 @@ +--- +hide_title: true +sidebar_position: 1 +--- + +import DatabaseLogoWall from '@site/src/components/databases/DatabaseLogoWall'; + + + +# Superset + +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/license/apache-2-0) +[![Latest Release on Github](https://img.shields.io/github/v/release/apache/superset?sort=semver)](https://github.com/apache/superset/releases/latest) +[![Build Status](https://github.com/apache/superset/actions/workflows/superset-python-unittest.yml/badge.svg)](https://github.com/apache/superset/actions) +[![PyPI version](https://badge.fury.io/py/apache_superset.svg)](https://badge.fury.io/py/apache_superset) +[![PyPI](https://img.shields.io/pypi/pyversions/apache_superset.svg?maxAge=2592000)](https://pypi.python.org/pypi/apache_superset) +[![GitHub Stars](https://img.shields.io/github/stars/apache/superset?style=social)](https://github.com/apache/superset/stargazers) +[![Contributors](https://img.shields.io/github/contributors/apache/superset)](https://github.com/apache/superset/graphs/contributors) +[![Last Commit](https://img.shields.io/github/last-commit/apache/superset)](https://github.com/apache/superset/commits/master) +[![Open Issues](https://img.shields.io/github/issues/apache/superset)](https://github.com/apache/superset/issues) +[![Open PRs](https://img.shields.io/github/issues-pr/apache/superset)](https://github.com/apache/superset/pulls) +[![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](http://bit.ly/join-superset-slack) +[![Documentation](https://img.shields.io/badge/docs-apache.org-blue.svg)](https://superset.apache.org) + + + + Superset logo (light) + + +A modern, enterprise-ready business intelligence web application. + +[**Why Superset?**](#why-superset) | +[**Supported Databases**](#supported-databases) | +[**Installation and Configuration**](#installation-and-configuration) | +[**Release Notes**](https://github.com/apache/superset/blob/master/RELEASING/README.md#release-notes-for-recent-releases) | +[**Get Involved**](#get-involved) | +[**Contributor Guide**](#contributor-guide) | +[**Resources**](#resources) | +[**Organizations Using Superset**](https://superset.apache.org/inTheWild) + +## Why Superset? + +Superset is a modern data exploration and data visualization platform. Superset can replace or augment proprietary business intelligence tools for many teams. Superset integrates well with a variety of data sources. + +Superset provides: + +- A **no-code interface** for building charts quickly +- A powerful, web-based **SQL Editor** for advanced querying +- A **lightweight semantic layer** for quickly defining custom dimensions and metrics +- Out of the box support for **nearly any SQL** database or data engine +- A wide array of **beautiful visualizations** to showcase your data, ranging from simple bar charts to geospatial visualizations +- Lightweight, configurable **caching layer** to help ease database load +- Highly extensible **security roles and authentication** options +- An **API** for programmatic customization +- A **cloud-native architecture** designed from the ground up for scale + +## Screenshots & Gifs + +**Video Overview** + + + +[superset-video-1080p.webm](https://github.com/user-attachments/assets/b37388f7-a971-409c-96a7-90c4e31322e6) + +
+ +**Large Gallery of Visualizations** + +
+ +**Craft Beautiful, Dynamic Dashboards** + +
+ +**No-Code Chart Builder** + +
+ +**Powerful SQL Editor** + +
+ +## Supported Databases + +Superset can query data from any SQL-speaking datastore or data engine (Presto, Trino, Athena, [and more](/user-docs/databases/)) that has a Python DB-API driver and a SQLAlchemy dialect. + +Here are some of the major database solutions that are supported: + + + + + + + +**A more comprehensive list of supported databases** along with the configuration instructions can be found [here](/user-docs/databases/). + +Want to add support for your datastore or data engine? Read more [here](/user-docs/faq#does-superset-work-with-insert-database-engine-here) about the technical requirements. + +## Installation and Configuration + +Try out Superset's [quickstart](/user-docs/quickstart) guide or learn about [the options for production deployments](/admin-docs/installation/installation-methods). + +## Get Involved + +- Ask and answer questions on [StackOverflow](https://stackoverflow.com/questions/tagged/apache-superset) using the **apache-superset** tag +- [Join our community's Slack](http://bit.ly/join-superset-slack) + and please read our [Slack Community Guidelines](https://github.com/apache/superset/blob/master/CODE_OF_CONDUCT.md#slack-community-guidelines) +- [Join our dev@superset.apache.org Mailing list](https://lists.apache.org/list.html?dev@superset.apache.org). To join, simply send an email to [dev-subscribe@superset.apache.org](mailto:dev-subscribe@superset.apache.org) +- If you want to help troubleshoot GitHub Issues involving the numerous database drivers that Superset supports, please consider adding your name and the databases you have access to on the [Superset Database Familiarity Rolodex](https://docs.google.com/spreadsheets/d/1U1qxiLvOX0kBTUGME1AHHi6Ywel6ECF8xk_Qy-V9R8c/edit#gid=0) +- Join Superset's Town Hall and [Operational Model](https://preset.io/blog/the-superset-operational-model-wants-you/) recurring meetings. Meeting info is available on the [Superset Community Calendar](https://superset.apache.org/community) + +## Contributor Guide + +Interested in contributing? Check out our +[Developer Docs](https://superset.apache.org/developer-docs/) +to find resources around contributing along with a detailed guide on +how to set up a development environment. + +## Resources + +- [Superset "In the Wild"](https://superset.apache.org/inTheWild) - see who's using Superset, and [add your organization](https://github.com/apache/superset/edit/master/RESOURCES/INTHEWILD.yaml) to the list! +- [Feature Flags](/admin-docs/configuration/feature-flags) - the status of Superset's Feature Flags. +- [Standard Roles](https://github.com/apache/superset/blob/master/RESOURCES/STANDARD_ROLES.md) - How RBAC permissions map to roles. +- [Superset Wiki](https://github.com/apache/superset/wiki) - Tons of additional community resources: best practices, community content and other information. +- [Superset SIPs](https://github.com/orgs/apache/projects/170) - The status of Superset's SIPs (Superset Improvement Proposals) for both consensus and implementation status. + +Understanding the Superset Points of View + +- [The Case for Dataset-Centric Visualization](https://preset.io/blog/dataset-centric-visualization/) +- [Understanding the Superset Semantic Layer](https://preset.io/blog/understanding-superset-semantic-layer/) + +- Getting Started with Superset + - [Superset in 2 Minutes using Docker Compose](/admin-docs/installation/docker-compose#installing-superset-locally-using-docker-compose) + - [Installing Database Drivers](/admin-docs/configuration/configuring-superset#installing-database-drivers) + - [Building New Database Connectors](https://preset.io/blog/building-database-connector/) + - [Create Your First Dashboard](/user-docs/using-superset/creating-your-first-dashboard) + - [Comprehensive Tutorial for Contributing Code to Apache Superset + ](https://preset.io/blog/tutorial-contributing-code-to-apache-superset/) +- [Resources to master Superset by Preset](https://preset.io/resources/) + +- Deploying Superset + + - [Official Docker image](https://hub.docker.com/r/apache/superset) + - [Helm Chart](https://github.com/apache/superset/tree/master/helm/superset) + +- Recordings of Past [Superset Community Events](https://preset.io/events) + + - [Mixed Time Series Charts](https://preset.io/events/mixed-time-series-visualization-in-superset-workshop/) + - [How the Bing Team Customized Superset for the Internal Self-Serve Data & Analytics Platform](https://preset.io/events/how-the-bing-team-heavily-customized-superset-for-their-internal-data/) + - [Live Demo: Visualizing MongoDB and Pinot Data using Trino](https://preset.io/events/2021-04-13-visualizing-mongodb-and-pinot-data-using-trino/) + - [Introduction to the Superset API](https://preset.io/events/introduction-to-the-superset-api/) + - [Building a Database Connector for Superset](https://preset.io/events/2021-02-16-building-a-database-connector-for-superset/) + +- Visualizations + + - [Creating Viz Plugins](https://superset.apache.org/developer-docs/contributing/howtos#creating-visualization-plugins) + - [Managing and Deploying Custom Viz Plugins](https://medium.com/nmc-techblog/apache-superset-manage-custom-viz-plugins-in-production-9fde1a708e55) + - [Why Apache Superset is Betting on Apache ECharts](https://preset.io/blog/2021-4-1-why-echarts/) + +- [Superset API](/developer-docs/api) + +## Repo Activity + + + + + Performance Stats of apache/superset - Last 28 days + + + + + + + diff --git a/docs/versioned_docs/version-6.1.0/intro.md b/docs/versioned_docs/version-6.1.0/intro.md new file mode 100644 index 00000000000..9388518130e --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/intro.md @@ -0,0 +1,261 @@ +--- +hide_title: true +sidebar_position: 1 +--- + + +# Superset + +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/license/apache-2-0) +[![Latest Release on Github](https://img.shields.io/github/v/release/apache/superset?sort=semver)](https://github.com/apache/superset/releases/latest) +[![Build Status](https://github.com/apache/superset/actions/workflows/superset-python-unittest.yml/badge.svg)](https://github.com/apache/superset/actions) +[![PyPI version](https://badge.fury.io/py/apache_superset.svg)](https://badge.fury.io/py/apache_superset) +[![PyPI](https://img.shields.io/pypi/pyversions/apache_superset.svg?maxAge=2592000)](https://pypi.python.org/pypi/apache_superset) +[![GitHub Stars](https://img.shields.io/github/stars/apache/superset?style=social)](https://github.com/apache/superset/stargazers) +[![Contributors](https://img.shields.io/github/contributors/apache/superset)](https://github.com/apache/superset/graphs/contributors) +[![Last Commit](https://img.shields.io/github/last-commit/apache/superset)](https://github.com/apache/superset/commits/master) +[![Open Issues](https://img.shields.io/github/issues/apache/superset)](https://github.com/apache/superset/issues) +[![Open PRs](https://img.shields.io/github/issues-pr/apache/superset)](https://github.com/apache/superset/pulls) +[![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](http://bit.ly/join-superset-slack) +[![Documentation](https://img.shields.io/badge/docs-apache.org-blue.svg)](https://superset.apache.org) + + + + Superset logo (light) + + +A modern, enterprise-ready business intelligence web application. + +### Documentation + +- **[User Guide](https://superset.apache.org/user-docs/)** — For analysts and business users. Explore data, build charts, create dashboards, and connect databases. +- **[Administrator Guide](https://superset.apache.org/admin-docs/)** — Install, configure, and operate Superset. Covers security, scaling, and database drivers. +- **[Developer Guide](https://superset.apache.org/developer-docs/)** — Contribute to Superset or build on its REST API and extension framework. + +[**Why Superset?**](#why-superset) | +[**Supported Databases**](#supported-databases) | +[**Release Notes**](https://github.com/apache/superset/blob/master/RELEASING/README.md#release-notes-for-recent-releases) | +[**Get Involved**](#get-involved) | +[**Resources**](#resources) | +[**Organizations Using Superset**](https://superset.apache.org/inTheWild) + +## Why Superset? + +Superset is a modern data exploration and data visualization platform. Superset can replace or augment proprietary business intelligence tools for many teams. Superset integrates well with a variety of data sources. + +Superset provides: + +- A **no-code interface** for building charts quickly +- A powerful, web-based **SQL Editor** for advanced querying +- A **lightweight semantic layer** for quickly defining custom dimensions and metrics +- Out of the box support for **nearly any SQL** database or data engine +- A wide array of **beautiful visualizations** to showcase your data, ranging from simple bar charts to geospatial visualizations +- Lightweight, configurable **caching layer** to help ease database load +- Highly extensible **security roles and authentication** options +- An **API** for programmatic customization +- A **cloud-native architecture** designed from the ground up for scale + +## Screenshots & Gifs + +**Video Overview** + + + +[superset-video-1080p.webm](https://github.com/user-attachments/assets/b37388f7-a971-409c-96a7-90c4e31322e6) + +
+ +**Large Gallery of Visualizations** + +
+ +**Craft Beautiful, Dynamic Dashboards** + +
+ +**No-Code Chart Builder** + +
+ +**Powerful SQL Editor** + +
+ +## Supported Databases + +Superset can query data from any SQL-speaking datastore or data engine (Presto, Trino, Athena, [and more](https://superset.apache.org/docs/databases)) that has a Python DB-API driver and a SQLAlchemy dialect. + +Here are some of the major database solutions that are supported: + + +

+ Amazon Athena   + Amazon DynamoDB   + Amazon Redshift   + Apache Doris   + Apache Drill   + Apache Druid   + Apache Hive   + Apache Impala   + Apache Kylin   + Apache Pinot   + Apache Solr   + Apache Spark SQL   + Ascend   + Aurora MySQL (Data API)   + Aurora PostgreSQL (Data API)   + Azure Data Explorer   + Azure Synapse   + ClickHouse   + Cloudflare D1   + CockroachDB   + Couchbase   + CrateDB   + Databend   + Databricks   + Denodo   + Dremio   + DuckDB   + Elasticsearch   + Exasol   + Firebird   + Firebolt   + Google BigQuery   + Google Sheets   + Greenplum   + Hologres   + IBM Db2   + IBM Netezza Performance Server   + MariaDB   + Microsoft SQL Server   + MonetDB   + MongoDB   + MotherDuck   + OceanBase   + Oracle   + Presto   + RisingWave   + SAP HANA   + SAP Sybase   + Shillelagh   + SingleStore   + Snowflake   + SQLite   + StarRocks   + Superset meta database   + TDengine   + Teradata   + TimescaleDB   + Trino   + Vertica   + YDB   + YugabyteDB +

+ + +**A more comprehensive list of supported databases** along with the configuration instructions can be found [here](https://superset.apache.org/docs/databases). + +Want to add support for your datastore or data engine? Read more [here](https://superset.apache.org/docs/frequently-asked-questions#does-superset-work-with-insert-database-engine-here) about the technical requirements. + +## Installation and Configuration + +Try out Superset's [quickstart](https://superset.apache.org/docs/quickstart/) guide or learn about [the options for production deployments](https://superset.apache.org/docs/installation/architecture/). + +## Get Involved + +- Ask and answer questions on [StackOverflow](https://stackoverflow.com/questions/tagged/apache-superset) using the **apache-superset** tag +- [Join our community's Slack](http://bit.ly/join-superset-slack) + and please read our [Slack Community Guidelines](https://github.com/apache/superset/blob/master/CODE_OF_CONDUCT.md#slack-community-guidelines) +- [Join our dev@superset.apache.org Mailing list](https://lists.apache.org/list.html?dev@superset.apache.org). To join, simply send an email to [dev-subscribe@superset.apache.org](mailto:dev-subscribe@superset.apache.org) +- If you want to help troubleshoot GitHub Issues involving the numerous database drivers that Superset supports, please consider adding your name and the databases you have access to on the [Superset Database Familiarity Rolodex](https://docs.google.com/spreadsheets/d/1U1qxiLvOX0kBTUGME1AHHi6Ywel6ECF8xk_Qy-V9R8c/edit#gid=0) +- Join Superset's Town Hall and [Operational Model](https://preset.io/blog/the-superset-operational-model-wants-you/) recurring meetings. Meeting info is available on the [Superset Community Calendar](https://superset.apache.org/community) + +## Contributor Guide + +Interested in contributing? Check out our +[Developer Guide](https://superset.apache.org/developer-docs/) +to find resources around contributing along with a detailed guide on +how to set up a development environment. + +## Resources + +- [Superset "In the Wild"](https://superset.apache.org/inTheWild) - see who's using Superset, and [add your organization](https://github.com/apache/superset/edit/master/RESOURCES/INTHEWILD.yaml) to the list! +- [Feature Flags](https://superset.apache.org/docs/configuration/feature-flags) - the status of Superset's Feature Flags. +- [Standard Roles](https://github.com/apache/superset/blob/master/RESOURCES/STANDARD_ROLES.md) - How RBAC permissions map to roles. +- [Superset Wiki](https://github.com/apache/superset/wiki) - Tons of additional community resources: best practices, community content and other information. +- [Superset SIPs](https://github.com/orgs/apache/projects/170) - The status of Superset's SIPs (Superset Improvement Proposals) for both consensus and implementation status. + +Understanding the Superset Points of View + +- [The Case for Dataset-Centric Visualization](https://preset.io/blog/dataset-centric-visualization/) +- [Understanding the Superset Semantic Layer](https://preset.io/blog/understanding-superset-semantic-layer/) + +- Getting Started with Superset + - [Superset in 2 Minutes using Docker Compose](https://superset.apache.org/docs/installation/docker-compose#installing-superset-locally-using-docker-compose) + - [Installing Database Drivers](https://superset.apache.org/docs/configuration/databases#installing-database-drivers) + - [Building New Database Connectors](https://preset.io/blog/building-database-connector/) + - [Create Your First Dashboard](https://superset.apache.org/docs/using-superset/creating-your-first-dashboard/) + - [Comprehensive Tutorial for Contributing Code to Apache Superset + ](https://preset.io/blog/tutorial-contributing-code-to-apache-superset/) +- [Resources to master Superset by Preset](https://preset.io/resources/) + +- Deploying Superset + + - [Official Docker image](https://hub.docker.com/r/apache/superset) + - [Helm Chart](https://github.com/apache/superset/tree/master/helm/superset) + +- Recordings of Past [Superset Community Events](https://preset.io/events) + + - [Mixed Time Series Charts](https://preset.io/events/mixed-time-series-visualization-in-superset-workshop/) + - [How the Bing Team Customized Superset for the Internal Self-Serve Data & Analytics Platform](https://preset.io/events/how-the-bing-team-heavily-customized-superset-for-their-internal-data/) + - [Live Demo: Visualizing MongoDB and Pinot Data using Trino](https://preset.io/events/2021-04-13-visualizing-mongodb-and-pinot-data-using-trino/) + - [Introduction to the Superset API](https://preset.io/events/introduction-to-the-superset-api/) + - [Building a Database Connector for Superset](https://preset.io/events/2021-02-16-building-a-database-connector-for-superset/) + +- Visualizations + + - [Creating Viz Plugins](https://superset.apache.org/docs/contributing/creating-viz-plugins/) + - [Managing and Deploying Custom Viz Plugins](https://medium.com/nmc-techblog/apache-superset-manage-custom-viz-plugins-in-production-9fde1a708e55) + - [Why Apache Superset is Betting on Apache ECharts](https://preset.io/blog/2021-4-1-why-echarts/) + +- [Superset API](https://superset.apache.org/docs/rest-api) + +## Repo Activity + + + + + Performance Stats of apache/superset - Last 28 days + + + + + + + diff --git a/docs/versioned_docs/version-6.1.0/quickstart.mdx b/docs/versioned_docs/version-6.1.0/quickstart.mdx new file mode 100644 index 00000000000..2eee4d09eca --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/quickstart.mdx @@ -0,0 +1,88 @@ +--- +title: Quickstart +hide_title: false +sidebar_position: 2 +--- + +**Ready to try Apache Superset?** This quickstart guide will help you +get up and running on your local machine in **3 simple steps**. Note that +it assumes that you have [Docker](https://www.docker.com), +[Docker Compose](https://docs.docker.com/compose/), and +[Git](https://git-scm.com/) installed. + +:::caution +Although we recommend using `Docker Compose` for a quick start in a sandbox-type +environment and for other development-type use cases, **we +do not recommend this setup for production**. For this purpose please +refer to our +[Installing on Kubernetes](/admin-docs/installation/kubernetes) +page. +::: + +### 1. Get Superset + +```bash +git clone https://github.com/apache/superset +``` + +### 2. Start the latest official release of Superset + +```bash +# Enter the repository you just cloned +$ cd superset + +# Set the repo to the state associated with the latest official version +$ git checkout tags/6.0.0 + +# Fire up Superset using Docker Compose +$ docker compose -f docker-compose-image-tag.yml up +``` + +This may take a moment as Docker Compose will fetch the underlying +container images and will load up some examples. Once all containers +are downloaded and the output settles, you're ready to log in. + +⚠️ If you get an error message like `validating superset\docker-compose-image-tag.yml: services.superset-worker-beat.env_file.0 must be a string`, you need to update your version of `docker-compose`. +Note that `docker-compose` is on the path to deprecation and you should now use `docker compose` instead. + +### 3. Log into Superset + +Now head over to [http://localhost:8088](http://localhost:8088) and log in with the default created account: + +```bash +username: admin +password: admin +``` + +#### 🎉 Congratulations! Superset is now up and running on your machine! 🎉 + +### Wrapping Up + +Once you're done with Superset, you can stop and delete just like any other container environment: + +```bash +docker compose down +``` + +:::tip +You can use the same environment more than once, as Superset will persist data locally. However, make sure to properly stop all +processes by running Docker Compose `stop` command. By doing so, you can avoid data corruption and/or loss of data. +::: + +## What's next? + +From this point on, you can head on to: + +- [Create your first Dashboard](/user-docs/using-superset/creating-your-first-dashboard) +- [Connect to a Database](/user-docs/databases/) +- [Using Docker Compose](/admin-docs/installation/docker-compose) +- [Configure Superset](/admin-docs/configuration/configuring-superset) +- [Installing on Kubernetes](/admin-docs/installation/kubernetes) + +Or just explore our [Documentation](https://superset.apache.org/docs/intro)! + +:::resources +- [Video: Superset in 2 Minutes](https://www.youtube.com/watch?v=AqousXQ7YHw) +- [Video: Superset 101](https://www.youtube.com/watch?v=mAIH3hUoxEE) +- [Tutorial: Creating Your First Dashboard](/user-docs/using-superset/creating-your-first-dashboard) +::: diff --git a/docs/versioned_docs/version-6.1.0/security/granular-export-controls.mdx b/docs/versioned_docs/version-6.1.0/security/granular-export-controls.mdx new file mode 100644 index 00000000000..806e21e02cf --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/security/granular-export-controls.mdx @@ -0,0 +1,78 @@ +--- +title: Granular Export Controls +sidebar_position: 4 +--- + +# Granular Export Controls + +Superset provides granular, permission-based controls for data export, image export, and clipboard operations. These replace the legacy `can_csv` permission with three fine-grained permissions that can be assigned independently to roles. + +## Feature Flag + +Granular export controls are gated behind the `GRANULAR_EXPORT_CONTROLS` feature flag. When the flag is disabled, the legacy `can_csv` permission behavior is preserved. + +```python +FEATURE_FLAGS = { + "GRANULAR_EXPORT_CONTROLS": True, +} +``` + +## Permissions + +| Permission | Resource | Controls | +| -------------------- | ---------- | ---------------------------------------------------------------------- | +| `can_export_data` | `Superset` | CSV, Excel, and JSON data exports from charts, dashboards, and SQL Lab | +| `can_export_image` | `Superset` | Screenshot (JPEG/PNG) and PDF exports from charts and dashboards | +| `can_copy_clipboard` | `Superset` | Copy-to-clipboard operations in SQL Lab and the Explore data pane | + +## Default Role Assignments + +The migration grants all three new permissions (`can_export_data`, `can_export_image`, `can_copy_clipboard`) to every role that currently has `can_csv`. This preserves existing behavior — no role loses access during the upgrade. + +After the migration, admins can selectively revoke individual export permissions from any role to restrict access. For example, to prevent Gamma users from exporting data or images while still allowing clipboard operations, revoke `can_export_data` and `can_export_image` from the Gamma role. + +## Configuration Steps + +1. **Enable the feature flag** in `superset_config.py`: + + ```python + FEATURE_FLAGS = { + "GRANULAR_EXPORT_CONTROLS": True, + } + ``` + +2. **Run the database migration** to register the new permissions: + + ```bash + superset db upgrade + ``` + +3. **Initialize permissions** so roles are populated: + + ```bash + superset init + ``` + +4. **Verify role assignments** in **Settings > List Roles**. Confirm that each role has the expected permissions from the table above. + +5. **Customize as needed**: Grant or revoke individual export permissions on any role through the role editor. + +## User Experience + +When a user lacks a required export permission: + +- **Menu items** (CSV, Excel, JSON, screenshot) appear **disabled** with an info tooltip icon explaining the restriction +- **Buttons** (SQL Lab download, clipboard copy) appear **disabled** with a tooltip on hover +- **API endpoints** return **403 Forbidden** when the corresponding permission is missing + +## API Enforcement + +The following API endpoints enforce granular export permissions when the feature flag is enabled: + +| Endpoint | Required Permission | +| --------------------------------------------------------- | ------------------- | +| `GET /api/v1/chart/{id}/data/` (CSV/Excel format) | `can_export_data` | +| `GET /api/v1/chart/{id}/cache_screenshot/` | `can_export_image` | +| `POST /api/v1/dashboard/{id}/cache_dashboard_screenshot/` | `can_export_image` | +| `GET /api/v1/sqllab/export/{client_id}/` | `can_export_data` | +| `POST /api/v1/sqllab/export_streaming/` | `can_export_data` | diff --git a/docs/versioned_docs/version-6.1.0/using-superset/creating-your-first-dashboard.mdx b/docs/versioned_docs/version-6.1.0/using-superset/creating-your-first-dashboard.mdx new file mode 100644 index 00000000000..f83982385c4 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/using-superset/creating-your-first-dashboard.mdx @@ -0,0 +1,368 @@ +--- +title: Creating Your First Dashboard +hide_title: true +sidebar_position: 1 +version: 1 +--- + +import useBaseUrl from "@docusaurus/useBaseUrl"; + +## Creating Your First Dashboard + +This section is focused on documentation for end-users who will be using Superset +for the data analysis and exploration workflow + (data analysts, business analysts, data +scientists, etc). + +:::tip +In addition to this site, [Preset.io](http://preset.io/) maintains an updated set of end-user +documentation at [docs.preset.io](https://docs.preset.io/). +::: + +This tutorial targets someone who wants to create charts and dashboards in Superset. We’ll show you +how to connect Superset to a new database and configure a table in that database for analysis. +You’ll also explore the data you’ve exposed and add a visualization to a dashboard so that you get a +feel for the end-to-end user experience. + +### Connecting to a new database + +Superset itself doesn't have a storage layer to store your data but instead pairs with +your existing SQL-speaking database or data store. + +First things first, we need to add the connection credentials to your database to be able +to query and visualize data from it. If you're using Superset locally via +[Docker compose](/admin-docs/installation/docker-compose), you can +skip this step because a Postgres database, named **examples**, is included and +pre-configured in Superset for you. + +Under the **+** menu in the top right, select Data, and then the _Connect Database_ option: + +{" "}

+ +Then select your database type in the resulting modal: + +{" "}

+ +Once you've selected a database, you can configure a number of advanced options in this window, +or for the purposes of this walkthrough, you can click the link below all these fields: + +{" "}

+ +Please note, if you are trying to connect to another locally running database (whether on host or another container), and you get the message `The port is closed.`, then you need to adjust the HOST to `host.docker.internal` + +Once you've clicked that link you only need to specify two things (the database name and SQLAlchemy URI): + +{" "}

+ +As noted in the text below the form, you should refer to the SQLAlchemy documentation on +[creating new connection URIs](https://docs.sqlalchemy.org/en/12/core/engines.html#database-urls) +for your target database. + +Click the **Test Connection** button to confirm things work end to end. If the connection looks good, save the configuration +by clicking the **Connect** button in the bottom right corner of the modal window: + +Congratulations, you've just added a new data source in Superset! + +### Sharing a Database Connection + +When adding a new database, you can share the connection with other Superset users. Shared connections appear in other users' database lists, making it easier to collaborate on the same data without requiring each user to configure the same connection separately. + +To share a connection, enable the **Share connection with other users** option in the **Advanced** tab of the database connection modal before saving. You can change sharing settings later by editing the database connection. + +### Registering a new table + +Now that you’ve configured a data source, you can select specific tables (called **Datasets** in Superset) +that you want exposed in Superset for querying. + +Navigate to **Data ‣ Datasets** and select the **+ Dataset** button in the top right corner. + + + +A modal window should pop up in front of you. Select your **Database**, +**Schema**, and **Table** using the drop downs that appear. In the following example, +we register the **cleaned_sales_data** table from the **examples** database. + + + +To finish, click the **Add** button in the bottom right corner. You should now see your dataset in the list of datasets. + +### Organizing Datasets into Folders + +The Datasets list view supports **folders** for organizing datasets into groups. To create and manage folders: + +1. In the **Datasets** list, click the **Folders** panel on the left sidebar. +2. Click **+ New Folder** to create a top-level folder, or drag an existing folder to nest it. +3. Drag dataset rows onto a folder to move them in, or right-click a dataset and select **Move to folder**. + +Folders are per-user organizational aids — they do not affect dataset access permissions or how other users see the datasets. + +### Uploading Files via the OS File Manager (PWA) + +When Superset is installed as a **Progressive Web App (PWA)** from your browser, your operating system will offer Superset as an option when opening CSV, Excel (`.xls`/`.xlsx`), and Parquet files. Double-clicking or right-clicking a supported file and selecting "Open with Superset" navigates directly to the upload workflow for that file. + +To install Superset as a PWA, look for the install icon in your browser's address bar (Chrome, Edge) when visiting your Superset instance over HTTPS. PWA installation requires HTTPS and a valid manifest — your admin needs to confirm the app manifest is served correctly. + +### Customizing column properties + +Now that you've registered your dataset, you can configure column properties + for how the column should be treated in the Explore workflow: + +- Is the column temporal? (should it be used for slicing & dicing in time series charts?) +- Should the column be filterable? +- Is the column dimensional? +- If it's a datetime column, how should Superset parse +the datetime format? (using the [ISO-8601 string pattern](https://en.wikipedia.org/wiki/ISO_8601)) + + + +### Superset semantic layer + +Superset has a thin semantic layer that adds many quality of life improvements for analysts. +The Superset semantic layer can store 2 types of computed data: + +1. Virtual metrics: you can write SQL queries that aggregate values +from multiple column (e.g. `SUM(recovered) / SUM(confirmed)`) and make them +available as columns for (e.g. `recovery_rate`) visualization in Explore. +Aggregate functions are allowed and encouraged for metrics. + + + +You can also certify metrics if you'd like for your team in this view. + +1. Virtual calculated columns: you can write SQL queries that +customize the appearance and behavior +of a specific column (e.g. `CAST(recovery_rate as float)`). +Aggregate functions aren't allowed in calculated columns. + + + +:::resources +- [Using Metrics and Calculated Columns](https://docs.preset.io/docs/using-metrics-and-calculated-columns) - In-depth guide to the semantic layer +- [Blog: Understanding the Superset Semantic Layer](https://preset.io/blog/understanding-superset-semantic-layer/) +- [Blog: Unlocking the Power of Virtual Datasets](https://preset.io/blog/unlocking-the-power-of-virtual-datasets-in-apache-superset/) +::: + +### Creating charts in Explore view + +Superset has 2 main interfaces for exploring data: + +- **Explore**: no-code viz builder. Select your dataset, select the chart, +customize the appearance, and publish. +- **SQL Lab**: SQL IDE for cleaning, joining, and preparing data for Explore workflow + +We'll focus on the Explore view for creating charts right now. +To start the Explore workflow from the **Datasets** tab, start by clicking the name +of the dataset that will be powering your chart. + +

+ +You're now presented with a powerful workflow for exploring data and iterating on charts. + +- The **Dataset** view on the left-hand side has a list of columns and metrics, +scoped to the current dataset you selected. +- The **Data** preview below the chart area also gives you helpful data context. +- Using the **Data** tab and **Customize** tabs, you can change the visualization type, +select the temporal column, select the metric to group by, and customize +the aesthetics of the chart. + +As you customize your chart using drop-down menus, make sure to click the **Run** button +to get visual feedback. + + + +In the following screenshot, we craft a grouped Time-series Bar Chart to visualize +our quarterly sales data by product line just by clicking options in drop-down menus. + + + +### Creating a slice and dashboard + +To save your chart, first click the **Save** button. You can either: + +- Save your chart and add it to an existing dashboard +- Save your chart and add it to a new dashboard + +In the following screenshot, we save the chart to a new "Superset Duper Sales Dashboard": + + + +To publish, click **Save and goto Dashboard**. + +Behind the scenes, Superset will create a slice and store all the information needed +to create your chart in its thin data layer + (the query, chart type, options selected, name, etc). + + + + To resize the chart, start by clicking the Edit Dashboard button in the top right corner. + + + +Then, click and drag the bottom right corner of the chart until the chart layout snaps +into a position you like onto the underlying grid. + + + + Click **Save** to persist the changes. + +Congrats! You’ve successfully linked, analyzed, and visualized data in Superset. There are a wealth +of other table configuration and visualization options, so please start exploring and creating +slices and dashboards of your own. + +### Manage access to Dashboards + +Access to dashboards is managed via owners and permissions. Non-owner access can be controlled +through dataset permissions or dashboard-level roles (using the `DASHBOARD_RBAC` feature flag). + +For detailed information on configuring dashboard access, see the +[Dashboard Access Control](/admin-docs/security/#dashboard-access-control) section in the +Security documentation. + + + +### Publishing a Dashboard + +If you would like to make your dashboard available to other users, click on the `Draft` button next to the +title of your dashboard. + + + +:::warning +Draft dashboards are only visible to the dashboard owners and admins. Published dashboards are visible to all users with access to the underlying datasets or if RBAC is enabled, to the roles that have been granted access to the dashboard. +::: + +### Mark a Dashboard as Favorite + +You can mark a dashboard as a favorite by clicking on the star icon next to the title of your dashboard. This makes it easier to find it in the list of dashboards or on the home page. + +### Customizing dashboard + +The following URL parameters can be used to modify how the dashboard is rendered: + +- `standalone`: + - `0` (default): dashboard is displayed normally + - `1`: Top Navigation is hidden + - `2`: Top Navigation + title is hidden + - `3`: Top Navigation + title + top level tabs are hidden +- `show_filters`: + - `0`: render dashboard without Filter Bar + - `1` (default): render dashboard with Filter Bar if native filters are enabled +- `expand_filters`: + - (default): render dashboard with Filter Bar expanded if there are native filters + - `0`: render dashboard with Filter Bar collapsed + - `1`: render dashboard with Filter Bar expanded + +For example, when running the local development build, the following will disable the +Top Nav and remove the Filter Bar: +`http://localhost:8088/superset/dashboard/my-dashboard/?standalone=1&show_filters=0` + +### Table Chart Features + +The **Table** chart type has several advanced capabilities worth knowing: + +#### Conditional Formatting + +Conditional formatting rules highlight cells based on their values. Rules can be applied to: +- **Numeric columns** — color cells above/below a threshold, or use a gradient across a range +- **String columns** — highlight cells matching specific text values or patterns +- **Boolean columns** — color cells that are `true` or `false`, or `null`/`not null` + +Each rule has a **"Use gradient"** toggle: enabled applies a varying opacity (lighter = further from threshold), disabled applies a solid fill at full opacity regardless of value. + +#### HTML Rendering in Table Cells + +Table chart cells can render raw HTML, enabling rich formatting such as hyperlinks, colored badges, and icons directly in the data. Enable this per-column in the chart's **Column Configuration** panel by toggling **Render HTML**. + +:::caution +Only enable HTML rendering for columns sourced from data you control. Rendering untrusted HTML can expose users to cross-site scripting (XSS) risks. +::: + +#### Column Header Tooltips + +Column headers display a tooltip with the column's **Description** from the dataset editor when the user hovers over them. Keep dataset column descriptions up to date to improve chart discoverability. + +#### Display Controls + +In dashboard view mode (without entering Edit mode), charts with configurable display options expose a **Display Controls** panel accessible from the chart's context menu. This surfaces controls such as Time Grain, Time Column, and layer visibility for applicable chart types — making it easy to adjust a chart's view without going to Explore. +### AG Grid Interactive Table + +The **AG Grid Interactive Table** chart type is Superset's fully-featured data grid, suitable for large paginated datasets where the standard Table chart is not enough. + +#### Server-Side Column Filters + +AG Grid supports server-side column filters that query the full dataset — not just the loaded page. Filters are applied before data is sent to the browser, so results are correct even across millions of rows. + +**Available filter types:** + +| Column type | Filter options | +|---|---| +| Text | Contains, equals, starts with, ends with | +| Number | Equals, not equal, less than, greater than, between | +| Date | Before, after, between, blank | +| Set | Select from a list of distinct values | + +**AND / OR logic:** Each column supports combining multiple conditions with AND or OR. Filters from different columns are always combined with AND. + +**Interaction with pagination:** Server-side filters run as WHERE clauses in the underlying SQL query, so pagination always operates over the already-filtered result set. + +#### Time Shift (Time Comparison) + +AG Grid Interactive Table supports **Time Shift** (time comparison), matching the behavior of the standard Table chart. In the **Advanced Analytics** → **Time Comparison** section of the chart configuration, enter a shift expression (e.g., `1 year ago`, `minus 7 days`) to add comparison columns showing values from the offset period. Dashboard-level time range overrides apply to both the base and comparison periods. + +### Dynamic Currency Formatting + +Chart metric values can display currencies dynamically rather than using a fixed currency code. To enable: + +1. Open the dataset editor for your dataset (**Datasets → Edit**). +2. In the **Advanced** tab, set **Currency Code Column** to the name of a column in your dataset that contains ISO 4217 currency codes (e.g., `USD`, `EUR`, `GBP`). +3. In the Explore chart configuration, open the metric's **Number format** section and select **Auto-detect** for currency. + +When Auto-detect is active, each row uses the currency code from the designated column, so a single chart can display values in multiple currencies — each formatted correctly for its currency. + +### ECharts Option Editor + +For ECharts-based chart types (line, bar, area, scatter, pie, and others), Explore includes an advanced **ECharts Option Editor** that accepts raw JSON overrides for the underlying ECharts configuration. + +Access it via the **Customize** tab → **ECharts Options** section at the bottom of the panel. The JSON you enter is deep-merged on top of Superset's generated ECharts config, so you can override specific options without rewriting the entire config. + +**Example:** override the legend position and add a custom title: + +```json +{ + "legend": { "orient": "vertical", "right": "5%", "top": "middle" }, + "title": { "text": "My Custom Title", "left": "center" } +} +``` + +:::caution +ECharts option overrides bypass Superset's validation layer. Invalid option keys are silently ignored by ECharts. Overrides that conflict with Superset-generated options (e.g., `series`) may produce unexpected results. +::: + +### Table Chart: Exporting Filtered Data + +When the **Search Box** is visible in a Table chart, the **Download** action exports only the rows currently visible after the search filter is applied — not the full underlying dataset. This matches the visual output and is intentional. To export the full dataset regardless of search state, use the **Download as CSV** option from the chart's three-dot menu in the dashboard or from the Explore chart toolbar before applying a search filter. + +### Sharing a Specific Tab + +When a dashboard has tabs, each tab gets its own shareable URL. Navigate to the tab you want to share and copy the URL from your browser's address bar — the tab anchor is encoded in the URL so that anyone opening the link lands directly on that tab. + +### Auto-Refresh + +Dashboards can be configured to refresh automatically at a fixed interval without user interaction. Open a dashboard, click the **⋮** (more options) menu in the top-right, and select **Set auto-refresh interval**. Choose an interval (e.g., every 10 seconds, 1 minute, or 10 minutes). The setting is per-session and resets when you close the tab. + +:::note +Auto-refresh triggers a full data reload for all charts on the dashboard. For dashboards with expensive queries, choose longer intervals to avoid overloading your database. +::: + +### Last Queried Timestamp + +Charts can display a "Last queried at" timestamp showing when the chart data was last fetched. This is useful on auto-refreshing dashboards to confirm data freshness. Enable it in **Dashboard Properties → Styling → Show last queried time**. + +### Saving a Chart to a Specific Tab + +When saving or adding a chart to a dashboard from Explore, you can select which tab it should land on using the tab tree-select dropdown in the "Add to dashboard" modal. + +:::resources +- [Dashboard Customization](https://docs.preset.io/docs/dashboard-customization) - Advanced dashboard styling and layout options +- [Blog: BI Dashboard Best Practices](https://preset.io/blog/bi-dashboard-best-practices/) +::: diff --git a/docs/versioned_docs/version-6.1.0/using-superset/embedding.mdx b/docs/versioned_docs/version-6.1.0/using-superset/embedding.mdx new file mode 100644 index 00000000000..f03c931e331 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/using-superset/embedding.mdx @@ -0,0 +1,131 @@ +--- +title: Embedding Superset +sidebar_position: 6 +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + + +# Embedding Superset + +Superset dashboards can be embedded directly in host applications using the `@superset-ui/embedded-sdk` package. + +:::info Prerequisites +- The `EMBEDDED_SUPERSET` feature flag must be enabled. +- The embedding domain and allowed origins must be configured by an admin. +::: + +## Quick Start + +Install the SDK: + +```bash +npm install @superset-ui/embedded-sdk +``` + +Embed a dashboard: + +```javascript +import { embedDashboard } from '@superset-ui/embedded-sdk'; + +embedDashboard({ + id: 'dashboard-uuid-here', // from Dashboard → Embed + supersetDomain: 'https://superset.example.com', + mountPoint: document.getElementById('superset-container'), + fetchGuestToken: () => fetchTokenFromYourBackend(), + dashboardUiConfig: { + hideTitle: true, + filters: { expanded: false }, + }, +}); +``` + +`fetchGuestToken` must return a **guest token** obtained from your server by calling Superset's `/api/v1/security/guest_token/` endpoint with a service account. Do not call this endpoint from client-side code. + +--- + +## Callbacks + +### `resolvePermalinkUrl` + +When a user copies a permalink from an embedded dashboard, Superset generates a URL on its own domain. In an embedded context this URL is usually not meaningful to the host application's users — the dashboard is rendered inside the host app, not at the Superset URL. + +The `resolvePermalinkUrl` callback lets the host app intercept permalink generation and return a URL on the host domain instead: + +```javascript +embedDashboard({ + id: 'my-dashboard-uuid', + supersetDomain: 'https://superset.example.com', + mountPoint: document.getElementById('superset-container'), + fetchGuestToken: () => fetchGuestToken(), + /** + * Called when Superset generates a permalink. + * @param {Object} args - { key: string } — the permalink key + * @returns {string | null} - your host URL, or null to use Superset's default + */ + resolvePermalinkUrl: ({ key }) => { + return `https://myapp.example.com/dashboard?permalink=${key}`; + }, +}); +``` + +If the callback returns `null` or is not provided, Superset uses its own permalink URL as a fallback. + +--- + +## Feature Flags for Embedded Mode + +### `DISABLE_EMBEDDED_SUPERSET_LOGOUT` + +Hides the logout button when Superset is embedded in a host application. This is useful when the host application manages the session lifecycle and you do not want users to accidentally log out of the embedded Superset session: + +```python +# superset_config.py +FEATURE_FLAGS = { + "EMBEDDED_SUPERSET": True, + "DISABLE_EMBEDDED_SUPERSET_LOGOUT": True, +} +``` + +When enabled, the **Logout** menu item is removed from the user avatar dropdown in the embedded view. The session can still be invalidated server-side by revoking the guest token. + +### `EMBEDDED_SUPERSET` + +Must be `True` to enable the embedded SDK and the guest token endpoint. Without this flag, `embedDashboard` will fail to load. + +--- + +## URL Parameters + +The following URL parameters can be passed through the `urlParams` option in `dashboardUiConfig` or appended to the embedded iframe URL: + +| Parameter | Values | Effect | +|-----------|--------|--------| +| `standalone` | `0`, `1`, `2`, `3` | `0`: normal; `1`: hide nav; `2`: hide nav + title; `3`: hide nav + title + tabs | +| `show_filters` | `0`, `1` | Show or hide the native filter bar | +| `expand_filters` | `0`, `1` | Start with filter bar expanded or collapsed | + +--- + +## Security Notes + +- **Guest tokens expire** — their lifetime is controlled by the `GUEST_TOKEN_JWT_EXP_SECONDS` config (default: 5 minutes). Refresh tokens before they expire using a token refresh mechanism in your host app. +- **Row-level security** — pass `rls` rules in the guest token request to restrict which rows are visible to the embedded user. +- **Allowed domains** — restrict which host origins can embed a dashboard by setting **Allowed Domains** per-dashboard in the *Embed* settings modal. Superset checks the request's `Referer` header against this list before serving the embedded view; an empty list allows any origin, so configure this explicitly for production. diff --git a/docs/versioned_docs/version-6.1.0/using-superset/exploring-data.mdx b/docs/versioned_docs/version-6.1.0/using-superset/exploring-data.mdx new file mode 100644 index 00000000000..8d83a0c2c63 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/using-superset/exploring-data.mdx @@ -0,0 +1,360 @@ +--- +title: Exploring Data in Superset +hide_title: true +sidebar_position: 2 +version: 1 +--- + +import useBaseUrl from "@docusaurus/useBaseUrl"; + +## Exploring Data in Superset + +Apache Superset enables users to explore data interactively through SQL queries, visual query builders, and rich visualizations, making it easier to understand datasets before building charts and dashboards. + +In this tutorial, we will introduce key concepts in Apache Superset through the exploration of a real dataset which contains the flights made by employees of a UK-based organization in 2011. + +The following information about each flight is given: + +- The traveler’s department. For the purposes of this tutorial the departments have been renamed + Orange, Yellow and Purple. +- The cost of the ticket. +- The travel class (Economy, Premium Economy, Business and First Class). +- Whether the ticket was a single or return. +- The date of travel. +- Information about the origin and destination. +- The distance between the origin and destination, in kilometers (km). + +### Enabling Data Upload Functionality + +You may need to enable the functionality to upload a CSV or Excel file to your database. The following section +explains how to enable this functionality for the examples database. + +In the top menu, select **Settings ‣ Data ‣ Database Connections**. Find the **examples** database in the list and +select the **Edit** button. + + + +In the resulting modal window, switch to the **Advanced** tab and open **Security** section. +Then, tick the checkbox for **Allow file uploads to database**. End by clicking the **Finish** button. + + + +### Loading CSV Data + +Download the CSV dataset to your computer from +[GitHub](https://raw.githubusercontent.com/apache-superset/examples-data/master/tutorial_flights.csv). +In the top menu, select **Settings ‣ Data ‣ Database Connections**. Then, **Upload file to database ‣ Upload CSV**. + + + +Then, select select the CSV file from your computer, select **Database** and **Schema**, and enter the **Table Name** +as _tutorial_flights_. + + + +Next enter the text _Travel Date_ into the **File settings ‣ Columns to be parsed as dates** field. + + + +Leaving all the other options in their default settings, select **Upload** at the bottom of the page. + +### Table Visualization + +You should now see _tutorial_flights_ as a dataset in the **Datasets** tab. Click on the entry to +launch an Explore workflow using this dataset. + +In this section, we'll create a table visualization +to show the number of flights and cost per travel class. + +By default, Apache Superset only shows the last week of data. In our example, we want to visualize all +of the data in the dataset. Click the **Time ‣ Time Range** section and change +the **Range Type** to **No Filter**. + + + +Click **Apply** to save. + +Now, we want to specify the rows in our table by using the **Group by** option. Since in this +example, we want to understand different Travel Classes, we select **Travel Class** in this menu. + +Next, we can specify the metrics we would like to see in our table with the **Metrics** option. + +- `COUNT(*)`, which represents the number of rows in the table +(in this case, quantity of flights in each Travel Class) +- `SUM(Cost)`, which represents the total cost spent by each Travel Class + + + +Finally, select **Run Query** to see the results of the table. + + + +To save the visualization, click on **Save** in the top left of the screen. In the following modal, + +- Select the **Save as** +option and enter the chart name as Tutorial Table (you will be able to find it again through the +**Charts** screen, accessible in the top menu). +- Select **Add To Dashboard** and enter +Tutorial Dashboard. Finally, select **Save & Go To Dashboard**. + + + +### Dashboard Basics + +Next, we are going to explore the dashboard interface. If you’ve followed the previous section, you +should already have the dashboard open. Otherwise, you can navigate to the dashboard by selecting +Dashboards on the top menu, then Tutorial dashboard from the list of dashboards. + +On this dashboard you should see the table you created in the previous section. Select **Edit +dashboard** and then hover over the table. By selecting the bottom right hand corner of the table +(the cursor will change too), you can resize it by dragging and dropping. + + + +Finally, save your changes by selecting Save changes in the top right. + +### Pivot Table + +In this section, we will extend our analysis using a more complex visualization, Pivot Table. By the +end of this section, you will have created a table that shows the monthly spend on flights for the +first six months, by department, by travel class. + +Create a new chart by selecting **+ ‣ Chart** from the top right corner. Choose +tutorial_flights again as a datasource, then click on the visualization type to get to the +visualization menu. Select the **Pivot Table** visualization (you can filter by entering text in the +search box) and then **Create New Chart**. + + + +In the **Time** section, keep the Time Column as Travel Date (this is selected automatically as we +only have one time column in our dataset). Then select Time Grain to be month as having daily data +would be too granular to see patterns from. Then select the time range to be the first six months of +2011 by click on Last week in the Time Range section, then in Custom selecting a Start / end of 1st +January 2011 and 30th June 2011 respectively by either entering directly the dates or using the +calendar widget (by selecting the month name and then the year, you can move more quickly to far +away dates). + + + +Next, within the **Query** section, remove the default COUNT(\*) and add Cost, keeping the default +SUM aggregate. Note that Apache Superset will indicate the type of the metric by the symbol on the +left hand column of the list (ABC for string, # for number, a clock face for time, etc.). + +In **Group by**, select **Time**: this will automatically use the Time Column and Time Grain +selections we defined in the Time section. + +Within **Columns**, first select Department and then Travel Class. All set – let’s **Run Query** to +see some data! + + + +You should see months in the rows and Department and Travel Class in the columns. Publish this chart +to your existing Tutorial Dashboard you created earlier. + +### Line Chart + +In this section, we are going to create a line chart to understand the average price of a ticket by +month across the entire dataset. + +In the Time section, as before, keep the Time Column as Travel Date and Time Grain as month but this +time for the Time range select No filter as we want to look at entire dataset. + +Within Metrics, remove the default `COUNT(*)` metric and instead add `AVG(Cost)`, to show the mean value. + + + +Next, select **Run Query** to show the data on the chart. + +How does this look? Well, we can see that the average cost goes up in December. However, perhaps it +doesn’t make sense to combine both single and return tickets, but rather show two separate lines for +each ticket type. + +Let’s do this by selecting Ticket Single or Return in the Group by box, and the selecting **Run +Query** again. Nice! We can see that on average single tickets are cheaper than returns and that the +big spike in December is caused by return tickets. + +Our chart is looking pretty good already, but let’s customize some more by going to the Customize +tab on the left hand pane. Within this pane, try changing the Color Scheme, removing the range +filter by selecting No in the Show Range Filter drop down and adding some labels using X Axis Label +and Y Axis Label. + + + +Once you’re done, publish the chart in your Tutorial Dashboard. + +### Markup + +In this section, we will add some text to our dashboard. If you’re there already, you can navigate +to the dashboard by selecting Dashboards on the top menu, then Tutorial dashboard from the list of +dashboards. Got into edit mode by selecting **Edit dashboard**. + +Within the Insert components pane, drag and drop a Markdown box on the dashboard. Look for the blue +lines which indicate the anchor where the box will go. + + + +Now, to edit the text, select the box. You can enter text, in markdown format (see +[this Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) for +more information about this format). You can toggle between Edit and Preview using the menu on the +top of the box. + + + +To exit, select any other part of the dashboard. Finally, don’t forget to keep your changes using +**Save changes**. + +### Publishing Your Dashboard + +If you have followed all of the steps outlined in the previous section, you should have a dashboard +that looks like the below. If you would like, you can rearrange the elements of the dashboard by +selecting **Edit dashboard** and dragging and dropping. + +If you would like to make your dashboard available to other users, simply select Draft next to the +title of your dashboard on the top left to change your dashboard to be in Published state. You can +also favorite this dashboard by selecting the star. + + + +### Annotations + +Annotations allow you to add additional context to your chart. In this section, we will add an +annotation to the Tutorial Line Chart we made in a previous section. Specifically, we will add the +dates when some flights were cancelled by the UK’s Civil Aviation Authority in response to the +eruption of the Grímsvötn volcano in Iceland (23-25 May 2011). + +First, add an annotation layer by navigating to Manage ‣ Annotation Layers. Add a new annotation +layer by selecting the green plus sign to add a new record. Enter the name Volcanic Eruptions and +save. We can use this layer to refer to a number of different annotations. + +Next, add an annotation by navigating to Manage ‣ Annotations and then create a new annotation by +selecting the green plus sign. Then, select the Volcanic Eruptions layer, add a short description +Grímsvötn and the eruption dates (23-25 May 2011) before finally saving. + + + +Then, navigate to the line chart by going to Charts then selecting Tutorial Line Chart from the +list. Next, go to the Annotations and Layers section and select Add Annotation Layer. Within this +dialogue: + +- Name the layer as Volcanic Eruptions +- Change the Annotation Layer Type to Event +- Set the Annotation Source as Superset annotation +- Specify the Annotation Layer as Volcanic Eruptions + + + +Select **Apply** to see your annotation shown on the chart. + + + +If you wish, you can change how your annotation looks by changing the settings in the Display +configuration section. Otherwise, select **OK** and finally **Save** to save your chart. If you keep +the default selection to overwrite the chart, your annotation will be saved to the chart and also +appear automatically in the Tutorial Dashboard. + +### Advanced Analytics + +In this section, we are going to explore the Advanced Analytics feature of Apache Superset that +allows you to apply additional transformations to your data. The three types of transformation are: + +**Setting up the base chart** + +In this section, we’re going to set up a base chart which we can then apply the different **Advanced +Analytics** features to. Start off by creating a new chart using the same _tutorial_flights_ +datasource and the **Line Chart** visualization type. Within the Time section, set the Time Range as +1st October 2011 and 31st October 2011. + +Next, in the query section, change the Metrics to the sum of Cost. Select **Run Query** to show the +chart. You should see the total cost per day for each month in October 2011. + + + +Finally, save the visualization as Tutorial Advanced Analytics Base, adding it to the Tutorial +Dashboard. + +### Rolling Mean + +There is quite a lot of variation in the data, which makes it difficult to identify any trend. One +approach we can take is to show instead a rolling average of the time series. To do this, in the +**Moving Average** subsection of **Advanced Analytics**, select mean in the **Rolling** box and +enter 7 into both Periods and Min Periods. The period is the length of the rolling period expressed +as a multiple of the Time Grain. In our example, the Time Grain is day, so the rolling period is 7 +days, such that on the 7th October 2011 the value shown would correspond to the first seven days of +October 2011. Lastly, by specifying Min Periods as 7, we ensure that our mean is always calculated +on 7 days and we avoid any ramp up period. + +After displaying the chart by selecting **Run Query** you will see that the data is less variable +and that the series starts later as the ramp up period is excluded. + + + +Save the chart as Tutorial Rolling Mean and add it to the Tutorial Dashboard. + +### Time Comparison + +In this section, we will compare values in our time series to the value a week before. Start off by +opening the Tutorial Advanced Analytics Base chart, by going to **Charts** in the top menu and then +selecting the visualization name in the list (alternatively, find the chart in the Tutorial +Dashboard and select Explore chart from the menu for that visualization). + +Next, in the Time Comparison subsection of **Advanced Analytics**, enter the Time Shift by typing in +“minus 1 week” (note this box accepts input in natural language). Run Query to see the new chart, +which has an additional series with the same values, shifted a week back in time. + + + +Then, change the **Calculation type** to Absolute difference and select **Run Query**. We can now +see only one series again, this time showing the difference between the two series we saw +previously. + + + +Save the chart as Tutorial Time Comparison and add it to the Tutorial Dashboard. + +### Resampling the data + +In this section, we’ll resample the data so that rather than having daily data we have weekly data. +As in the previous section, reopen the Tutorial Advanced Analytics Base chart. + +Next, in the Python Functions subsection of **Advanced Analytics**, enter 7D, corresponding to seven +days, in the Rule and median as the Method and show the chart by selecting **Run Query**. + + + +Note that now we have a single data point every 7 days. In our case, the value showed corresponds to +the median value within the seven daily data points. For more information on the meaning of the +various options in this section, refer to the +[Pandas documentation](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.resample.html). + +Lastly, save your chart as Tutorial Resample and add it to the Tutorial Dashboard. Go to the +tutorial dashboard to see the four charts side by side and compare the different outputs. + +### SQL Lab Tips + +**Schema and table browser**: The left-side table browser uses a collapsible treeview — click a schema to expand its tables, and click a table to see its columns and sample data inline. This makes navigating large schemas much faster than the previous flat list. + +**Find in editor**: Press **Ctrl+F** (or **Cmd+F** on Mac) to open the Monaco find/replace widget inside the SQL editor without leaving the editor. + +**Resizable panels**: The dividers between the SQL editor, schema browser, and results pane are draggable. Adjust them to match your workflow and screen size. + +**Dialect-aware Format SQL**: The **Format SQL** button applies the SQL dialect of the currently selected database — Trino, Presto, MySQL, PostgreSQL, etc. — rather than a generic formatter. Switch to a different database in the toolbar and re-format to get dialect-specific output. Jinja template syntax (`{{ }}`, `{% %}`) is preserved during formatting and will not cause format errors. + +### Time Range Natural Language Expressions + +The **Custom** time range picker accepts natural language expressions alongside specific dates: + +- **Relative**: `Last 7 days`, `Last month`, `Last quarter`, `Last year` +- **Anchored**: `previous calendar week`, `previous calendar month` +- **"First of" expressions**: `first day of this week`, `first day of this month`, `first day of this quarter`, `first day of this year`, `first week of this year` +- **Offsets**: `30 days ago`, `1 year ago`, `next week` + +These expressions are evaluated at query time, so saved charts always display data relative to the current date. + +:::resources +- [Chart Walkthroughs](https://docs.preset.io/docs/chart-walkthroughs) - Detailed guides for most chart types +- [Blog: Why Apache ECharts is the Future of Apache Superset](https://preset.io/blog/2021-4-1-why-echarts/) +- [Blog: ECharts Time-Series Visualizations in Superset](https://preset.io/blog/echarts-time-series-visualizations-in-superset/) +- [Blog: Finding New Insights with Drill By](https://preset.io/blog/drill-by/) +- [Blog: From Drill Down to Drill By](https://preset.io/blog/drill-down-and-drill-by/) +- [Blog: Cross-Filtering in Apache Superset](https://preset.io/blog/cross-filtering-in-Superset-and-Preset/) +::: diff --git a/docs/versioned_docs/version-6.1.0/using-superset/issue-codes.mdx b/docs/versioned_docs/version-6.1.0/using-superset/issue-codes.mdx new file mode 100644 index 00000000000..59b7fdaa224 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/using-superset/issue-codes.mdx @@ -0,0 +1,334 @@ +--- +title: Issue Codes +sidebar_position: 5 +version: 1 +--- + +# Issue Code Reference + +This page lists issue codes that may be displayed in +Superset and provides additional context. + +## Issue 1000 + +``` +The datasource is too large to query. +``` + +It's likely your datasource has grown too large to run the current +query, and is timing out. You can resolve this by reducing the +size of your datasource or by modifying your query to only process a +subset of your data. + +## Issue 1001 + +``` +The database is under an unusual load. +``` + +Your query may have timed out because of unusually high load on the +database engine. You can make your query simpler, or wait until the +database is under less load and try again. + +## Issue 1002 + +``` +The database returned an unexpected error. +``` + +Your query failed because of an error that occurred on the database. +This may be due to a syntax error, a bug in your query, or some other +internal failure within the database. This is usually not an +issue within Superset, but instead a problem with the underlying +database that serves your query. + +## Issue 1003 + +``` +There is a syntax error in the SQL query. Perhaps there was a misspelling or a typo. +``` + +Your query failed because of a syntax error within the underlying query. Please +validate that all columns or tables referenced within the query exist and are spelled +correctly. + +## Issue 1004 + +``` +The column was deleted or renamed in the database. +``` + +Your query failed because it is referencing a column that no longer exists in +the underlying datasource. You should modify the query to reference the +replacement column, or remove this column from your query. + +## Issue 1005 + +``` +The table was deleted or renamed in the database. +``` + +Your query failed because it is referencing a table that no longer exists in +the underlying database. You should modify your query to reference the correct +table. + +## Issue 1006 + +``` +One or more parameters specified in the query are missing. +``` + +Your query was not submitted to the database because it's missing one or more +parameters. You should define all the parameters referenced in the query in a +valid JSON document. Check that the parameters are spelled correctly and that +the document has a valid syntax. + +## Issue 1007 + +``` +The hostname provided can't be resolved. +``` + +The hostname provided when adding a new database is invalid and cannot be +resolved. Please check that there are no typos in the hostname. + +## Issue 1008 + +``` +The port is closed. +``` + +The port provided when adding a new database is not open. Please check that +the port number is correct, and that the database is running and listening on +that port. + +## Issue 1009 + +``` +The host might be down, and cannot be reached on the provided port. +``` + +The host provided when adding a new database doesn't seem to be up. +Additionally, it cannot be reached on the provided port. Please check that +there are no firewall rules preventing access to the host. + +## Issue 1010 + +``` +Superset encountered an error while running a command. +``` + +Something unexpected happened, and Superset encountered an error while +running a command. Please reach out to your administrator. + +## Issue 1011 + +``` +Superset encountered an unexpected error. +``` + +Something unexpected happened in the Superset backend. Please reach out +to your administrator. + +## Issue 1012 + +``` +The username provided when connecting to a database is not valid. +``` + +The user provided a username that doesn't exist in the database. Please check +that the username is typed correctly and exists in the database. + +## Issue 1013 + +``` +The password provided when connecting to a database is not valid. +``` + +The user provided a password that is incorrect. Please check that the +password is typed correctly. + +## Issue 1014 + +``` +Either the username or the password used are incorrect. +``` + +Either the username provided does not exist or the password was written incorrectly. Please +check that the username and password were typed correctly. + +## Issue 1015 + +``` +Either the database is spelled incorrectly or does not exist. +``` + +Either the database was written incorrectly or it does not exist. Check that it was typed correctly. + +## Issue 1016 + +``` +The schema was deleted or renamed in the database. +``` + +The schema was either removed or renamed. Check that the schema is typed correctly and exists. + +## Issue 1017 + +``` +The user doesn't have the proper permissions to connect to the database +``` + +We were unable to connect to your database. Please confirm that your service account has the Viewer and Job User roles on the project. + +## Issue 1018 + +``` +One or more parameters needed to configure a database are missing. +``` + +Not all parameters required to test, create, or edit a database were present. Please double check which parameters are needed, and that they are present. + +## Issue 1019 + +``` +The submitted payload has the incorrect format. +``` + +Please check that the request payload has the correct format (eg, JSON). + +## Issue 1020 + +``` +The submitted payload has the incorrect schema. +``` + +Please check that the request payload has the expected schema. + +## Issue 1021 + +``` +Results backend needed for asynchronous queries is not configured. +``` + +Your instance of Superset doesn't have a results backend configured, which is needed for asynchronous queries. Please contact an administrator for further assistance. + +## Issue 1022 + +``` +Database does not allow data manipulation. +``` + +Only `SELECT` statements are allowed against this database. Please contact an administrator if you need to run DML (data manipulation language) on this database. + +## Issue 1023 + +``` +CTAS (create table as select) doesn't have a SELECT statement at the end. +``` + +The last statement in a query run as CTAS (create table as select) MUST be a SELECT statement. Please make sure the last statement in the query is a SELECT. + +## Issue 1024 + +``` +CVAS (create view as select) query has more than one statement. +``` + +When running a CVAS (create view as select) the query should have a single statement. Please make sure the query has a single statement, and no extra semi-colons other than the last one. + +## Issue 1025 + +``` +CVAS (create view as select) query is not a SELECT statement. +``` + +When running a CVAS (create view as select) the query should be a SELECT statement. Please make sure the query has a single statement and it's a SELECT statement. + +## Issue 1026 + +``` +Query is too complex and takes too long to run. +``` + +The submitted query might be too complex to run under the time limit defined by your Superset administrator. Please double check your query and verify if it can be optimized. Alternatively, contact your administrator to increase the timeout period. + +## Issue 1027 + +``` +The database is currently running too many queries. +``` + +The database might be under heavy load, running too many queries. Please try again later, or contact an administrator for further assistance. + +## Issue 1028 + +``` +One or more parameters specified in the query are malformed. +``` + +The query contains one or more malformed template parameters. Please check your query and confirm that all template parameters are surround by double braces, for example, "\{\{ ds \}\}". Then, try running your query again. + +## Issue 1029 + +``` +The object does not exist in this database. +``` + +Either the schema, column, or table do not exist in the database. + +## Issue 1030 + +``` +The query potentially has a syntax error. +``` + +The query might have a syntax error. Please check and run again. + +## Issue 1031 + +``` +The results backend no longer has the data from the query. +``` + +The results from the query might have been deleted from the results backend after some period. Please re-run your query. + +## Issue 1032 + +``` +The query associated with the results was deleted. +``` + +The query associated with the stored results no longer exists. Please re-run your query. + +## Issue 1033 + +``` +The results stored in the backend were stored in a different format, and no longer can be deserialized. +``` + +The query results were stored in a format that is no longer supported. Please re-run your query. + +## Issue 1034 + +``` +The database port provided is invalid. +``` + +Please check that the provided database port is an integer between 0 and 65535 (inclusive). + +## Issue 1035 + +``` +Failed to start remote query on a worker. +``` + +The query was not started by an asynchronous worker. Please reach out to your administrator for further assistance. + +## Issue 1036 + +``` +The database was deleted. +``` + +The operation failed because the database referenced no longer exists. Please reach out to your administrator for further assistance. diff --git a/docs/versioned_docs/version-6.1.0/using-superset/sql-templating.mdx b/docs/versioned_docs/version-6.1.0/using-superset/sql-templating.mdx new file mode 100644 index 00000000000..44566604565 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/using-superset/sql-templating.mdx @@ -0,0 +1,274 @@ +--- +title: SQL Templating +sidebar_position: 4 +description: Use Jinja templates in SQL Lab and virtual datasets to create dynamic queries +keywords: [sql templating, jinja, sql lab, virtual datasets, dynamic queries] +--- + +{/* +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +*/} + +# SQL Templating + +Superset supports [Jinja templating](https://jinja.palletsprojects.com/) in SQL Lab queries and virtual datasets. This allows you to write dynamic SQL that responds to filters, user context, and URL parameters. + +:::note +SQL templating must be enabled by your administrator via the `ENABLE_TEMPLATE_PROCESSING` feature flag. +For advanced configuration options, see the [SQL Templating Configuration Guide](/admin-docs/configuration/sql-templating). +::: + +## Using Jinja in Calculated Columns + +Jinja template macros are available in calculated column expressions in the dataset editor — not just in SQL Lab queries and virtual datasets. This allows column expressions to reference the current user or dynamic context. + +**Example: User-scoped calculated column** + +```sql +CASE WHEN sales_rep = '{{ current_username() }}' THEN amount ELSE 0 END +``` + +**Example: Conditional display based on role** + +Because `current_user_roles()` returns a Python list, test role membership with a Jinja +conditional at template time rather than matching against the list's string representation: + +```sql +{% if 'Finance' in current_user_roles() %}revenue{% else %}NULL{% endif %} AS finance_revenue +``` + +:::note +The `ENABLE_TEMPLATE_PROCESSING` feature flag must be enabled by your administrator for Jinja in calculated columns to work. +::: + +## Basic Usage + +Jinja templates use double curly braces `{{ }}` for expressions and `{% %}` for logic blocks. + +### Using Parameters + +You can define parameters in SQL Lab via the **Parameters** menu as JSON: + +```json +{ + "my_table": "sales", + "start_date": "2024-01-01" +} +``` + +Then reference them in your query: + +```sql +SELECT * +FROM {{ my_table }} +WHERE order_date >= '{{ start_date }}' +``` + +### Conditional Logic + +Use Jinja's logic blocks for conditional SQL: + +```sql +SELECT * +FROM orders +WHERE 1 = 1 +{% if start_date %} + AND order_date >= '{{ start_date }}' +{% endif %} +{% if end_date %} + AND order_date < '{{ end_date }}' +{% endif %} +``` + +## Available Macros + +Superset provides built-in macros for common use cases. + +### User Context + +| Macro | Description | +|-------|-------------| +| `{{ current_username() }}` | Returns the logged-in user's username | +| `{{ current_user_id() }}` | Returns the logged-in user's account ID | +| `{{ current_user_email() }}` | Returns the logged-in user's email | +| `{{ current_user_roles() }}` | Returns an array of the user's roles | + +**Example: Row-level filtering by user** + +```sql +SELECT * +FROM sales_data +WHERE sales_rep = '{{ current_username() }}' +``` + +**Example: Role-based access** + +```sql +SELECT * +FROM users +WHERE role IN {{ current_user_roles()|where_in }} +``` + +### Filter Values + +Access dashboard and chart filter values in your queries: + +| Macro | Description | +|-------|-------------| +| `{{ filter_values('column') }}` | Returns filter values as a list | +| `{{ get_filters('column') }}` | Returns filters with operators | + +**Example: Using filter values** + +```sql +SELECT product, SUM(revenue) as total +FROM sales +WHERE region IN {{ filter_values('region')|where_in }} +GROUP BY product +``` + +The `where_in` filter converts the list to SQL format: `('value1', 'value2', 'value3')` + +### Time Filters + +For charts with time range filters: + +| Macro | Description | +|-------|-------------| +| `{{ get_time_filter('column') }}` | Returns time filter with `from_expr` and `to_expr` | + +**Example: Time-filtered virtual dataset** + +```sql +{% set time_filter = get_time_filter("order_date", default="Last 7 days") %} +SELECT * +FROM orders +WHERE order_date >= {{ time_filter.from_expr }} + AND order_date < {{ time_filter.to_expr }} +``` + +### URL Parameters + +Pass custom values via URL query strings: + +```sql +SELECT * +FROM orders +WHERE country = '{{ url_param('country') }}' +``` + +Access via: `superset.example.com/sqllab?country=US` + +### Reusing Dataset Definitions + +Query existing datasets by ID: + +```sql +-- Query a dataset (ID 42) as a table +SELECT * FROM {{ dataset(42) }} LIMIT 100 + +-- Include computed metrics +SELECT * FROM {{ dataset(42, include_metrics=True) }} +``` + +Reuse metric definitions across queries: + +```sql +SELECT + category, + {{ metric('total_revenue') }} as revenue +FROM sales +GROUP BY category +``` + +## Testing Templates in SQL Lab + +Some variables like `from_dttm` and `filter_values()` only work when filters are applied from dashboards or charts. To test in SQL Lab: + +**Option 1: Use defaults** + +```sql +SELECT * +FROM orders +WHERE date >= '{{ from_dttm | default("2024-01-01", true) }}' +``` + +**Option 2: Set test parameters** + +Add to the Parameters menu: + +```json +{ + "_filters": [ + {"col": "region", "op": "IN", "val": ["US", "EU"]} + ] +} +``` + +**Option 3: Use `{% set %}`** + +```sql +{% set start_date = "2024-01-01" %} +SELECT * FROM orders WHERE date >= '{{ start_date }}' +``` + +## Common Patterns + +### Dynamic Table Selection + +```sql +{% set table_name = url_param('table') or 'default_table' %} +SELECT * FROM {{ table_name }} +``` + +### User-Specific Data Access + +```sql +SELECT * +FROM sensitive_data +WHERE department IN ( + SELECT department + FROM user_permissions + WHERE username = '{{ current_username() }}' +) +``` + +### Time-Based Partitioning + +```sql +{% set time_filter = get_time_filter("event_date", remove_filter=True) %} +SELECT * +FROM events +WHERE event_date >= {{ time_filter.from_expr }} + AND event_date < {{ time_filter.to_expr }} +``` + +Using `remove_filter=True` applies the filter in the inner query for better performance. + +## Tips + +- Use `|where_in` filter to convert lists to SQL `IN` clauses +- Use `|tojson` to serialize arrays as JSON strings +- Test queries with explicit parameter values before relying on filter context +- For complex templating needs, ask your administrator about custom Jinja macros +- **Format SQL is Jinja-aware**: The "Format SQL" button in SQL Lab correctly preserves `{{ }}` and `{% %}` template syntax and applies your selected database's SQL dialect when formatting. + +:::resources +- [Admin Guide: SQL Templating Configuration](/admin-docs/configuration/sql-templating) +- [Blog: Intro to Jinja Templating in Apache Superset](https://preset.io/blog/intro-jinja-templating-apache-superset/) +::: diff --git a/docs/versioned_docs/version-6.1.0/using-superset/using-ai-with-superset.mdx b/docs/versioned_docs/version-6.1.0/using-superset/using-ai-with-superset.mdx new file mode 100644 index 00000000000..b419ccc9269 --- /dev/null +++ b/docs/versioned_docs/version-6.1.0/using-superset/using-ai-with-superset.mdx @@ -0,0 +1,312 @@ +--- +title: Using AI with Superset +hide_title: true +sidebar_position: 5 +version: 1 +--- + + + +# Using AI with Superset + +Superset supports AI assistants through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/). Connect Claude, ChatGPT, or other MCP-compatible clients to explore your data, build charts, create dashboards, and run SQL -- all through natural language. + +:::info +Requires Superset 5.0+. Your admin must enable and deploy the MCP server before you can connect. +See the **[MCP Server admin guide](/admin-docs/configuration/mcp-server)** for setup instructions. +::: + +--- + +## What Can AI Do with Superset? + +### Explore Your Data + +Ask your AI assistant to browse what's available in your Superset instance: + +- **List datasets** -- see all datasets you have access to, with filtering and search +- **Get dataset details** -- column names, types, available metrics, and filters +- **List charts and dashboards** -- find existing visualizations by name or keyword +- **Get chart and dashboard details** -- understand what a chart shows, its query, and configuration + +**Example prompts:** +> "What datasets are available?" +> "Show me the columns in the sales_orders dataset" +> "Find dashboards related to revenue" + +### Build Charts + +Describe the visualization you want and AI creates it for you: + +- **Preview-first workflow** -- by default AI generates an Explore link so you can review the chart before it is saved. Say "save it" to commit permanently +- **Create charts from natural language** -- describe what you want to see and AI picks the right chart type, metrics, and dimensions +- **Preview before saving** -- `generate_chart` defaults to `save_chart=False`, showing the chart in Explore before it's committed. Ask AI to save once you're satisfied. +- **Modify existing charts** -- `update_chart` also supports preview mode so you can review changes before saving (update filters, change chart types, add metrics) +- **Get Explore links** -- open any chart in Superset's Explore view for further refinement + +**Example prompts:** +> "Create a bar chart showing monthly revenue by region from the sales dataset" +> "Update chart 42 to use a line chart instead" +> "Give me a link to explore this chart further" + +:::tip Preview-first workflow +Charts are **not saved by default**. The workflow is intentionally iterative: + +1. **Explore** — AI generates an Explore link so you can see the chart before it exists in Superset +2. **Iterate** — ask the AI to adjust the chart; changes are previewed without touching the database +3. **Save** — when you're happy, say "save it" and the chart is permanently stored + +To skip the preview and save immediately, include "and save it" in your prompt. +::: + +### Create Dashboards + +Build dashboards from a collection of charts: + +- **Generate dashboards** -- create a new dashboard with a set of charts, automatically laid out +- **Add charts to existing dashboards** -- place a chart on an existing dashboard with automatic positioning + +**Example prompts:** +> "Create a dashboard called 'Q4 Sales Overview' with charts 10, 15, and 22" +> "Add the revenue trend chart to the executive dashboard" + +### Browse Databases + +Discover what database connections are configured in your Superset instance: + +- **List databases** -- see all database connections you have access to +- **Get database details** -- name, backend type (PostgreSQL, Snowflake, etc.), and connection status + +**Example prompts:** +> "What databases are connected to Superset?" +> "Show me details about the data warehouse connection" + +### Create Virtual Datasets + +Build ad-hoc SQL datasets that can be used as the basis for charts: + +- **Create virtual datasets** -- write a SQL query and save it as a reusable dataset +- **Use immediately in charts** -- the returned dataset ID can be passed directly to chart creation + +**Example prompts:** +> "Create a dataset from: SELECT region, SUM(revenue) as total_revenue FROM orders GROUP BY region" +> "Make a virtual dataset called 'monthly_signups' from the users table filtered to last 12 months" + +### Run SQL Queries + +Execute SQL directly through your AI assistant: + +- **Run queries** -- execute SQL with full Superset RBAC enforcement (you can only query data your roles allow) +- **Open SQL Lab** -- get a link to SQL Lab pre-populated with a query, ready to run and explore +- **Save queries** -- save a SQL query to SQL Lab's Saved Queries for later reuse + +**Example prompts:** +> "Run this query: SELECT region, SUM(revenue) FROM sales GROUP BY region" +> "Open SQL Lab with a query to show the top 10 customers by order count" +> "Save this query as 'Weekly Revenue Report'" + +### Analyze Chart Data + +Pull the raw data behind any chart: + +- **Get chart data** -- retrieve the data a chart displays, with support for JSON, CSV, and Excel export formats +- **Inspect results** -- useful for verifying what a visualization shows or feeding data into other tools + +**Example prompts:** +> "Get the data behind chart 42" +> "Export chart 15 data as CSV" + +### Check Instance Status + +- **Health check** -- verify your Superset instance is up and the MCP connection is working +- **Instance info** -- get high-level statistics about your Superset instance (number of datasets, charts, dashboards) + +**Example prompts:** +> "Is Superset healthy?" +> "How many dashboards are in this instance?" + +--- + +## Connecting Your AI Client + +Once your admin has deployed the MCP server, connect your AI client using the instructions below. + +### Claude Desktop + +Edit your Claude Desktop config file: + +- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json` +- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json` +- **Linux**: `~/.config/Claude/claude_desktop_config.json` + +```json +{ + "mcpServers": { + "superset": { + "url": "http://localhost:5008/mcp" + } + } +} +``` + +Restart Claude Desktop. The hammer icon in the chat bar confirms the connection. + +If your admin has enabled JWT authentication, you may need to include a token: + +```json +{ + "mcpServers": { + "superset": { + "command": "npx", + "args": [ + "-y", + "mcp-remote@latest", + "http://your-superset-host:5008/mcp", + "--header", + "Authorization: Bearer YOUR_TOKEN" + ] + } + } +} +``` + +### Claude Code (CLI) + +Add to your project's `.mcp.json`: + +```json +{ + "mcpServers": { + "superset": { + "type": "url", + "url": "http://localhost:5008/mcp" + } + } +} +``` + +### ChatGPT + +1. Click your profile icon > **Settings** > **Apps and Connectors** +2. Enable **Developer Mode** in Advanced Settings +3. In the chat composer, press **+** > **Add sources** > **App** > **Connect more** > **Create app** +4. Enter a name and your MCP server URL +5. Click **I understand and continue** + +:::info +ChatGPT MCP connectors require a Pro, Team, Enterprise, or Edu plan. +::: + +Ask your admin for the MCP server URL and any authentication tokens you need. + +--- + +## Tips for Best Results + +- **Be specific** -- "Create a bar chart of monthly revenue by region from the sales dataset" works better than "Make me a chart" +- **Start with exploration** -- ask what datasets and charts exist before creating new ones +- **Review AI-generated content** -- always check chart configurations and SQL before saving or sharing +- **Use Explore for refinement** -- ask AI for an Explore link, then fine-tune interactively in the Superset UI +- **Check permissions if you get errors** -- AI respects Superset's RBAC, so you can only access data your roles allow + +--- + +## Available Tools Reference + +### Exploration & Discovery + +| Tool | Description | +|------|-------------| +| `health_check` | Verify the MCP server is running and connected | +| `get_instance_info` | Get instance statistics (dataset, chart, dashboard counts) | +| `get_schema` | Discover available charts, datasets, and dashboards with schema info | + +### Datasets + +| Tool | Description | +|------|-------------| +| `list_datasets` | List datasets with filtering and search | +| `get_dataset_info` | Get dataset metadata (columns, metrics, filters) | +| `create_virtual_dataset` | Create a virtual dataset from a SQL query | + +### Charts + +| Tool | Description | +|------|-------------| +| `list_charts` | List charts with filtering and search | +| `get_chart_info` | Get chart metadata and configuration | +| `get_chart_data` | Retrieve chart data (JSON, CSV, or Excel) | +| `get_chart_preview` | Generate a chart preview (URL, ASCII, table, or Vega-Lite) | +| `get_chart_type_schema` | Get the configuration schema for a chart type | +| `generate_chart` | Create a new chart from a specification (defaults to preview mode — review before saving) | +| `update_chart` | Modify an existing chart's configuration (pass `generate_preview=False` to persist immediately instead of returning a preview URL) | +| `update_chart_preview` | Update a cached chart preview without saving | +| `generate_explore_link` | Generate an Explore URL for interactive visualization | + +### Dashboards + +| Tool | Description | +|------|-------------| +| `list_dashboards` | List dashboards with filtering and search | +| `get_dashboard_info` | Get dashboard metadata and layout | +| `generate_dashboard` | Create a new dashboard with specified charts | +| `add_chart_to_existing_dashboard` | Add a chart to an existing dashboard | + +### SQL + +| Tool | Description | +|------|-------------| +| `execute_sql` | Run a SQL query with RBAC enforcement | +| `save_sql_query` | Persist a SQL query to SQL Lab's saved queries | +| `open_sql_lab_with_context` | Open SQL Lab with a pre-populated query | + +### Databases + +| Tool | Description | +|------|-------------| +| `list_databases` | List configured database connections | +| `get_database_info` | Get details about a specific database connection | + +--- + +## Troubleshooting + +### "Connection refused" or "Cannot connect" + +- Confirm the MCP server URL with your admin +- For Claude Desktop: fully quit the app (not just close the window) and restart after config changes +- Check that the URL path ends with `/mcp` (e.g., `http://localhost:5008/mcp`) + +### "Permission denied" or missing data + +- Superset's RBAC controls what you can access through AI, just like in the Superset UI +- Ask your admin to verify your roles and permissions +- Try accessing the same data through the Superset web UI to confirm your access + +### "Response too large" + +- Ask for smaller result sets: use filters, reduce `page_size`, or request specific columns +- Example: "Show me the top 10 rows from the sales dataset" instead of "Show me all sales data" + +### AI doesn't see Superset tools + +- Verify the connection in your AI client (e.g., the hammer icon in Claude Desktop) +- Ask the AI "What Superset tools are available?" to confirm the connection +- Restart your AI client if you recently changed the configuration diff --git a/docs/versioned_sidebars/version-6.1.0-sidebars.json b/docs/versioned_sidebars/version-6.1.0-sidebars.json new file mode 100644 index 00000000000..95948a380a6 --- /dev/null +++ b/docs/versioned_sidebars/version-6.1.0-sidebars.json @@ -0,0 +1,45 @@ +{ + "CustomSidebar": [ + { + "type": "doc", + "label": "Overview", + "id": "index" + }, + { + "type": "doc", + "label": "Quickstart", + "id": "quickstart" + }, + { + "type": "category", + "label": "Using Superset", + "collapsed": false, + "items": [ + { + "type": "autogenerated", + "dirName": "using-superset" + } + ] + }, + { + "type": "category", + "label": "Connecting to Databases", + "collapsed": true, + "link": { + "type": "doc", + "id": "databases/index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "databases" + } + ] + }, + { + "type": "doc", + "label": "FAQ", + "id": "faq" + } + ] +} diff --git a/docs/versions-config.json b/docs/versions-config.json index 985b075e669..f6c9885fbb7 100644 --- a/docs/versions-config.json +++ b/docs/versions-config.json @@ -5,18 +5,24 @@ "includeCurrentVersion": true, "onlyIncludeVersions": [ "current", + "6.1.0", "6.0.0" ], "versions": { "current": { "label": "Next", "path": "", - "banner": "none" + "banner": "unreleased" }, "6.0.0": { "label": "6.0.0", "path": "6.0.0", "banner": "none" + }, + "6.1.0": { + "label": "6.1.0", + "path": "6.1.0", + "banner": "none" } } }, @@ -25,12 +31,18 @@ "lastVersion": "current", "includeCurrentVersion": true, "onlyIncludeVersions": [ - "current" + "current", + "6.1.0" ], "versions": { "current": { "label": "Next", "path": "", + "banner": "unreleased" + }, + "6.1.0": { + "label": "6.1.0", + "path": "6.1.0", "banner": "none" } } @@ -41,28 +53,40 @@ "lastVersion": "current", "includeCurrentVersion": true, "onlyIncludeVersions": [ - "current" + "current", + "6.1.0" ], "versions": { "current": { "label": "Next", "path": "", "banner": "unreleased" + }, + "6.1.0": { + "label": "6.1.0", + "path": "6.1.0", + "banner": "none" } } }, "components": { - "disabled": true, + "disabled": false, "lastVersion": "current", "includeCurrentVersion": true, "onlyIncludeVersions": [ - "current" + "current", + "6.1.0" ], "versions": { "current": { "label": "Next", "path": "", "banner": "unreleased" + }, + "6.1.0": { + "label": "6.1.0", + "path": "6.1.0", + "banner": "none" } } } diff --git a/docs/versions.json b/docs/versions.json index 6c0b5f905ca..83bf437d4a0 100644 --- a/docs/versions.json +++ b/docs/versions.json @@ -1,3 +1,4 @@ [ + "6.1.0", "6.0.0" ]