diff --git a/docs/.claude/instructions.md b/docs/.claude/instructions.md index 4e3b5ccd538..0a87d2c61bc 100644 --- a/docs/.claude/instructions.md +++ b/docs/.claude/instructions.md @@ -9,11 +9,13 @@ When working on the Storybook-to-MDX documentation system: ## Why This Matters The generator (`scripts/generate-superset-components.mjs`) should be lightweight - it extracts data from stories and passes it through. When you add special cases to the generator: + - It becomes harder to maintain - Stories diverge from their docs representation - Future stories need to know about generator quirks When you fix stories to match the expected patterns: + - Stories work identically in Storybook and Docs - The generator stays simple and predictable - Patterns are consistent and learnable @@ -21,6 +23,7 @@ When you fix stories to match the expected patterns: ## Story Patterns for Docs Generation ### Required Structure + ```tsx // Use inline export default (NOT const meta = ...; export default meta) export default { @@ -45,6 +48,7 @@ export const InteractiveMyComponent: Story = { ``` ### For Components with Variants (size Γ— style grids) + ```tsx const sizes = ['small', 'medium', 'large']; const variants = ['primary', 'secondary', 'danger']; @@ -63,16 +67,20 @@ InteractiveButton.parameters = { ``` ### For Components Requiring Children + ```tsx InteractiveIconTooltip.parameters = { docs: { // Component descriptors with dot notation for nested components - sampleChildren: [{ component: 'Icons.InfoCircleOutlined', props: { iconSize: 'l' } }], + sampleChildren: [ + { component: 'Icons.InfoCircleOutlined', props: { iconSize: 'l' } }, + ], }, }; ``` ### For Custom Live Code Examples + ```tsx InteractiveMyComponent.parameters = { docs: { @@ -84,6 +92,7 @@ InteractiveMyComponent.parameters = { ``` ### For Complex Props (objects, arrays) + ```tsx InteractiveMenu.parameters = { docs: { @@ -99,13 +108,13 @@ InteractiveMenu.parameters = { ## Common Issues and How to Fix Them (in the Story) -| Issue | Wrong Approach | Right Approach | -|-------|---------------|----------------| -| Component not generated | Add pattern to generator | Change story to use inline `export default` | +| Issue | Wrong Approach | Right Approach | +| --------------------------------------- | ----------------------------- | ------------------------------------------------- | +| Component not generated | Add pattern to generator | Change story to use inline `export default` | | Control shows as text instead of select | Add special case in generator | Add `argTypes` with `control: { type: 'select' }` | -| Missing children/content | Modify StorybookWrapper | Add `parameters.docs.sampleChildren` | -| Gallery not showing | Add to generator output | Add `parameters.docs.gallery` config | -| Wrong live example | Hardcode in generator | Add `parameters.docs.liveExample` | +| Missing children/content | Modify StorybookWrapper | Add `parameters.docs.sampleChildren` | +| Gallery not showing | Add to generator output | Add `parameters.docs.gallery` config | +| Wrong live example | Hardcode in generator | Add `parameters.docs.liveExample` | ## Files diff --git a/docs/.oxfmtrc.json b/docs/.oxfmtrc.json new file mode 100644 index 00000000000..167baf27086 --- /dev/null +++ b/docs/.oxfmtrc.json @@ -0,0 +1,9 @@ +{ + "$schema": "./node_modules/oxfmt/configuration_schema.json", + "singleQuote": true, + "trailingComma": "all", + "arrowParens": "avoid", + "printWidth": 80, + "sortPackageJson": false, + "ignorePatterns": [] +} diff --git a/docs/DOCS_CLAUDE.md b/docs/DOCS_CLAUDE.md index 576f334d258..daeaefc6246 100644 --- a/docs/DOCS_CLAUDE.md +++ b/docs/DOCS_CLAUDE.md @@ -69,6 +69,7 @@ yarn eslint # Lint TypeScript/JavaScript files ## πŸ“ Documentation Structure ### Main Documentation (`/docs`) + The primary documentation lives in `/docs` with this structure: ``` @@ -104,54 +105,57 @@ docs/ ``` ### Admin Docs (`/admin_docs`) + Admin-focused content: installation, configuration, security. ### 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 ### File Types + - **`.md` files**: Basic Markdown documents - **`.mdx` files**: Markdown with JSX - can include React components - **`.tsx` files in `/src`**: Custom React components and pages ### Frontmatter Structure + Every documentation page should have frontmatter: ```yaml --- title: Page Title description: Brief description for SEO -sidebar_position: 1 # Optional: controls order in sidebar +sidebar_position: 1 # Optional: controls order in sidebar --- ``` ### MDX Component Usage + MDX files can import and use React components: -```mdx +````mdx import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; - ```bash - npm install superset - ``` + ```bash npm install superset ``` - ```bash - yarn add superset - ``` + ```bash yarn add superset ``` -``` +```` ### Code Blocks + Use triple backticks with language identifiers: ````markdown @@ -171,6 +175,7 @@ pip install apache-superset ```` ### Admonitions + Docusaurus supports various admonition types: ```markdown @@ -198,20 +203,21 @@ This is an info box ## πŸ”„ Version Management ### Version Configuration + Versions are managed through `versions-config.json`: ```json { "docs": { "disabled": false, - "lastVersion": "6.0.0", // Default version shown - "includeCurrentVersion": true, // Show "Next" version + "lastVersion": "6.0.0", // Default version shown + "includeCurrentVersion": true, // Show "Next" version "onlyIncludeVersions": ["current", "6.0.0"], "versions": { "current": { "label": "Next", "path": "", - "banner": "unreleased" // Shows warning banner + "banner": "unreleased" // Shows warning banner }, "6.0.0": { "label": "6.0.0", @@ -224,6 +230,7 @@ Versions are managed through `versions-config.json`: ``` ### Creating New Versions + **IMPORTANT**: Always use the custom scripts, NOT native Docusaurus commands: ```bash @@ -235,8 +242,10 @@ yarn docusaurus docs:version 6.1.0 ``` ### Version Files Created + When versioning, these files are created (per section, with the section's plugin id as prefix): + - `
_versioned_docs/version-X.X.X/` - Snapshot of current docs - `
_versioned_sidebars/version-X.X.X-sidebars.json` - Sidebar config - `
_versions.json` - List of all versions @@ -246,6 +255,7 @@ Section plugin ids: `user_docs`, `admin_docs`, `developer_docs`, `components`. ## 🎨 Styling and Theming ### Custom CSS + Add custom styles in `/src/css/custom.css`: ```css @@ -256,13 +266,14 @@ Add custom styles in `/src/css/custom.css`: ``` ### Custom Components + Create React components in `/src/components/`: ```tsx // src/components/FeatureCard.tsx import React from 'react'; -export default function FeatureCard({title, description}) { +export default function FeatureCard({ title, description }) { return (

{title}

@@ -277,10 +288,7 @@ Use in MDX: ```mdx import FeatureCard from '@site/src/components/FeatureCard'; - + ``` ## πŸ“¦ Key Dependencies @@ -295,6 +303,7 @@ import FeatureCard from '@site/src/components/FeatureCard'; ## πŸ”— Linking Strategies ### Internal Links + Use relative paths for internal documentation: ```markdown @@ -303,6 +312,7 @@ Use relative paths for internal documentation: ``` ### External Links + Always use full URLs: ```markdown @@ -310,6 +320,7 @@ Always use full URLs: ``` ### Linking to Code + Reference code in the main repository: ```markdown @@ -319,21 +330,24 @@ See the [main configuration file](https://github.com/apache/superset/blob/master ## πŸ› οΈ Common Documentation Tasks ### Adding a New Guide + 1. Create the `.mdx` file in the appropriate directory 2. Add frontmatter with title and description 3. Update sidebar if needed (for manual sidebar configs) ### Adding API Documentation + The API docs use Swagger UI embedded in `/docs/api.mdx`: ```mdx -import SwaggerUI from "swagger-ui-react"; -import "swagger-ui-react/swagger-ui.css"; +import SwaggerUI from 'swagger-ui-react'; +import 'swagger-ui-react/swagger-ui.css'; ``` ### Adding Interactive Examples + Use MDX to create interactive documentation: ```mdx @@ -360,6 +374,7 @@ When creating or updating documentation: ## πŸ” Searching and Navigation ### Sidebar Configuration + Sidebars are configured in `/sidebars.js`: ```javascript @@ -385,6 +400,7 @@ module.exports = { ``` ### Search + Docusaurus includes Algolia DocSearch integration configured in `docusaurus.config.ts`. ## 🚫 Common Pitfalls to Avoid @@ -398,6 +414,7 @@ Docusaurus includes Algolia DocSearch integration configured in `docusaurus.conf ## πŸ”§ Troubleshooting ### Dev Server Issues + ```bash yarn stop # Kill any running servers yarn clear # Clear cache @@ -405,6 +422,7 @@ yarn start # Restart ``` ### Build Failures + ```bash # Check for broken links yarn build @@ -417,7 +435,9 @@ yarn eslint ``` ### Version Issues + If versions don't appear in dropdown: + 1. Check `versions-config.json` includes the version 2. Verify version files exist in `
_versioned_docs/` 3. Restart dev server @@ -432,9 +452,10 @@ If versions don't appear in dropdown: ## πŸ“– Real Examples and Patterns ### Example: Configuration Documentation Pattern + From `docs/configuration/configuring-superset.mdx`: -```mdx +````mdx --- title: Configuring Superset hide_title: true @@ -452,7 +473,9 @@ Superset exposes hundreds of configurable parameters through its ```bash export SUPERSET_CONFIG_PATH=/app/superset_config.py ``` -``` +```` + +```` **Key patterns:** - Links to source code for reference @@ -476,9 +499,10 @@ documentation at [docs.preset.io](https://docs.preset.io/). ### Connecting to a new database -``` +```` **Key patterns:** + - Import Docusaurus hooks for dynamic URLs - Use of admonitions (:::tip) for helpful information - Screenshots with useBaseUrl for proper path resolution @@ -486,11 +510,12 @@ documentation at [docs.preset.io](https://docs.preset.io/). - Step-by-step visual guides ### Example: API Documentation Pattern + From `docs/api.mdx`: ```mdx -import SwaggerUI from "swagger-ui-react"; -import "swagger-ui-react/swagger-ui.css"; +import SwaggerUI from 'swagger-ui-react'; +import 'swagger-ui-react/swagger-ui.css'; ## API Documentation @@ -498,6 +523,7 @@ import "swagger-ui-react/swagger-ui.css"; ``` **Key patterns:** + - Embedding interactive Swagger UI - Importing necessary CSS - Direct API spec integration @@ -508,49 +534,39 @@ import "swagger-ui-react/swagger-ui.css"; // For images in static folder import useBaseUrl from "@docusaurus/useBaseUrl"; - + // With caption +
- Dashboard view + Dashboard view
Superset Dashboard Interface
``` ### Multi-Tab Code Examples -```mdx +````mdx import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; - - ```bash - docker-compose up - ``` - - - ```bash - kubectl apply -f superset.yaml - ``` - - - ```bash - pip install apache-superset - ``` - + { label: 'Docker', value: 'docker' }, + { label: 'Kubernetes', value: 'k8s' }, + { label: 'PyPI', value: 'pypi' }, + ]} +> + ```bash docker-compose up ``` + ```bash kubectl apply -f superset.yaml ``` + ```bash pip install apache-superset ``` -``` +```` ### Configuration File Examples -```mdx +````mdx ```python title="superset_config.py" # Database connection example SQLALCHEMY_DATABASE_URI = 'postgresql://user:password@localhost/superset' @@ -565,7 +581,9 @@ FEATURE_FLAGS = { 'DASHBOARD_NATIVE_FILTERS': True, } ``` -``` +```` + +```` ### Cross-Referencing Pattern @@ -578,11 +596,11 @@ For detailed configuration options, see: External resources: - [SQLAlchemy Documentation](https://docs.sqlalchemy.org/) - [Flask Configuration](https://flask.palletsprojects.com/config/) -``` +```` ### Writing Installation Guides -```mdx +````mdx ## Prerequisites :::warning @@ -596,8 +614,10 @@ Ensure you have Python 3.9+ and Node.js 16+ installed before proceeding. git clone https://github.com/apache/superset.git cd superset ``` +```` 2. **Install Python dependencies** + ```bash pip install -e . ``` @@ -611,7 +631,8 @@ Ensure you have Python 3.9+ and Node.js 16+ installed before proceeding. :::tip Success Check Navigate to http://localhost:8088 and login with admin/admin ::: -``` + +```` ### Documenting API Endpoints @@ -630,9 +651,10 @@ Returns a list of charts. ```bash curl -X GET "http://localhost:8088/api/v1/chart/" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -``` +```` **Example Response:** + ```json { "count": 42, @@ -645,8 +667,10 @@ curl -X GET "http://localhost:8088/api/v1/chart/" \ ] } ``` + ``` --- **Note**: This documentation site serves as the primary resource for Superset users, administrators, and contributors. Always prioritize clarity, accuracy, and completeness when creating or updating documentation. +``` diff --git a/docs/README.md b/docs/README.md index 634799d4bc6..677ad3e2b52 100644 --- a/docs/README.md +++ b/docs/README.md @@ -66,6 +66,7 @@ yarn version:add:components 1.2.0 ``` What the script does: + 1. Refreshes auto-generated content via `generate:smart` (database pages, API reference, component pages). 2. Calls `yarn docusaurus docs:version` (or the per-section equivalent) to snapshot the section. 3. Freezes any data-file imports (`@site/static/*.json`, `../../data/*.json`) into a snapshot-local `_versioned_data/` dir so the historical version doesn't silently mutate when the source files change. @@ -73,6 +74,7 @@ What the script does: 5. Updates `versions-config.json` and `
_versions.json`. **Do NOT use** the native Docusaurus commands directly (`yarn docusaurus docs:version`), as they will: + - ❌ Create version files but NOT update `versions-config.json` - ❌ Skip auto-gen refresh, freezing whatever was on disk - ❌ Skip data-import freezing, leaving the snapshot pointed at live data @@ -82,9 +84,11 @@ What the script does: ### Managing Versions #### With Automated Scripts + The automated scripts handle all configuration updates automatically. No manual editing required! #### Manual Configuration + If creating versions manually, you'll need to: 1. **Update `versions-config.json`** (or `docusaurus.config.ts` if not using dynamic config): @@ -109,6 +113,7 @@ If creating versions manually, you'll need to: ### Removing a Version #### Using Automated Scripts (Recommended) + ```bash # Main Documentation yarn version:remove:user_docs 1.0.0 @@ -124,6 +129,7 @@ yarn version:remove:components 1.0.0 ``` #### Manual Removal + To manually remove a version: 1. **Delete the version folder** from the appropriate location: @@ -153,6 +159,7 @@ To manually remove a version: ### Version Configuration Examples #### Main Documentation (default plugin) + ```typescript docs: { includeCurrentVersion: true, @@ -174,6 +181,7 @@ docs: { ``` #### Developer Docs & Components (custom plugins) + ```typescript { id: 'developer_docs', @@ -210,23 +218,28 @@ docs: { #### Version Not Showing After Creation If you accidentally used `yarn docusaurus docs:version` instead of `yarn version:add`: + 1. **Problem**: The version files were created but `versions-config.json` wasn't updated 2. **Solution**: Either: - Revert the changes: `git restore user_docs_versions.json && rm -rf user_docs_versioned_docs/ user_docs_versioned_sidebars/` - Then use the correct command: `yarn version:add:user_docs ` For other issues: + - **Restart the server**: Changes to version configuration require a server restart - **Check config file**: Ensure `versions-config.json` includes the new version - **Verify files exist**: Check that versioned docs folder was created #### 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_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 To fix broken links: + 1. Use `type: 'doc'` with `docId` for version-aware navigation in navbar 2. Use relative paths within the same documentation section 3. Test all versions after creation to identify broken links diff --git a/docs/admin_docs/configuration/alerts-reports.mdx b/docs/admin_docs/configuration/alerts-reports.mdx index bedc88ac4c9..fbc0d11aa5e 100644 --- a/docs/admin_docs/configuration/alerts-reports.mdx +++ b/docs/admin_docs/configuration/alerts-reports.mdx @@ -9,8 +9,8 @@ version: 2 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_ 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. @@ -26,16 +26,17 @@ Alerts and reports are disabled by default. To turn them on, you'll need to chan - 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. + - 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). +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 Chromium: this is the recommended approach as of version 4.1.x or greater. Playwright always uses Chromium β€” the `WEBDRIVER_TYPE` config setting has no effect when Playwright is active. 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. Enable the `PLAYWRIGHT_REPORTS_AND_THUMBNAILS` feature flag in your config to activate it. - Use Firefox (Selenium): you'll need to install geckodriver and Firefox. Set `WEBDRIVER_TYPE` to `"firefox"` in your `superset_config.py`. - Use Chrome (Selenium): you'll need to install Chrome. Set `WEBDRIVER_TYPE` to `"chrome"` in your `superset_config.py`. @@ -204,7 +205,7 @@ You need to replace default values with your custom Redis, Slack and/or SMTP con 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. +- 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. @@ -313,7 +314,7 @@ Please refer to `ExecutorType` in the codebase for other executor types. It's also possible to specify a minimum interval between each report's execution through the config file: -``` python +```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()) @@ -322,7 +323,7 @@ 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 +```python def alert_dynamic_minimal_interval(**kwargs) -> int: """ Define logic here to retrieve the value dynamically @@ -335,7 +336,7 @@ ALERT_MINIMUM_INTERVAL = alert_dynamic_minimal_interval 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. +site. Internal links (matching your configured base URL) are not affected. ```python # Disable external link redirection entirely (default: True) @@ -347,17 +348,17 @@ 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. +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. +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`. +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 @@ -369,7 +370,7 @@ If you are handling the installation of the headless browser on your own, do you 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. +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: @@ -395,16 +396,16 @@ 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. +- 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. +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`. +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 @@ -512,6 +513,7 @@ schedule the queries that have `schedule_info` in their JSON metadata. For sched 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/configuration/async-queries-celery.mdx b/docs/admin_docs/configuration/async-queries-celery.mdx index ee2d2c28624..5c960f89433 100644 --- a/docs/admin_docs/configuration/async-queries-celery.mdx +++ b/docs/admin_docs/configuration/async-queries-celery.mdx @@ -104,5 +104,6 @@ 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/configuration/aws-iam.mdx b/docs/admin_docs/configuration/aws-iam.mdx index 1202efdd8fc..0c83205313f 100644 --- a/docs/admin_docs/configuration/aws-iam.mdx +++ b/docs/admin_docs/configuration/aws-iam.mdx @@ -13,7 +13,7 @@ Cross-account IAM role assumption via STS `AssumeRole` is supported, allowing a ## 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."* +- 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, @@ -48,14 +48,14 @@ IAM authentication is configured via the **encrypted_extra** field of the databa } ``` -| 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`) | +| 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) diff --git a/docs/admin_docs/configuration/cache.mdx b/docs/admin_docs/configuration/cache.mdx index d4a5f36d087..7ecfc420f85 100644 --- a/docs/admin_docs/configuration/cache.mdx +++ b/docs/admin_docs/configuration/cache.mdx @@ -308,6 +308,7 @@ While database-backed operations work reliably, the Redis backend is recommended 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/configuration/configuring-superset.mdx b/docs/admin_docs/configuration/configuring-superset.mdx index b915ba43cf0..fe4be60e663 100644 --- a/docs/admin_docs/configuration/configuring-superset.mdx +++ b/docs/admin_docs/configuration/configuring-superset.mdx @@ -225,7 +225,7 @@ RequestHeader set X-Forwarded-Proto "https" ## Configuring the application root -*Please be advised that this feature is in BETA.* +_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: @@ -312,10 +312,13 @@ 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 ``` @@ -568,5 +571,6 @@ SUPERSET_DASHBOARD_POSITION_DATA_LIMIT = 131072 # double the default Alternatively, split a very large dashboard into several smaller ones. Note that this check is enforced when saving layout edits in the UI; a dashboard imported from a ZIP with an oversized layout will load and render, but cannot be edited and re-saved until the limit is raised. :::resources + - [Blog: Feature Flags in Apache Superset](https://preset.io/blog/feature-flags-in-apache-superset-and-preset/) -::: + ::: diff --git a/docs/admin_docs/configuration/country-map-tools.mdx b/docs/admin_docs/configuration/country-map-tools.mdx index ae128ed3b7c..c01e3e6ee7f 100644 --- a/docs/admin_docs/configuration/country-map-tools.mdx +++ b/docs/admin_docs/configuration/country-map-tools.mdx @@ -22,10 +22,10 @@ The current list of countries can be found in the src The Country Maps visualization already ships with the maps for the following countries: -
    -{countriesData.countries.map((country, index) => ( -
  • {country}
    • -))} +
      + {countriesData.countries.map((country, index) => ( +
    • {country}
      • + ))}
    ## Adding a New Country diff --git a/docs/admin_docs/configuration/feature-flags.mdx b/docs/admin_docs/configuration/feature-flags.mdx index b573b07d326..27ed49b3b5f 100644 --- a/docs/admin_docs/configuration/feature-flags.mdx +++ b/docs/admin_docs/configuration/feature-flags.mdx @@ -7,7 +7,7 @@ version: 1 import featureFlags from '@site/static/feature-flags.json'; -export const FlagTable = ({flags}) => ( +export const FlagTable = ({ flags }) => ( @@ -17,14 +17,21 @@ export const FlagTable = ({flags}) => ( - {flags.map((flag) => ( + {flags.map(flag => ( - - + + @@ -50,12 +57,12 @@ FEATURE_FLAGS = { Feature flags progress through lifecycle stages: -| Stage | Description | -|-------|-------------| +| 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. | +| **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. | --- diff --git a/docs/admin_docs/configuration/importing-exporting-datasources.mdx b/docs/admin_docs/configuration/importing-exporting-datasources.mdx index 6fc7ceea9ff..a954f2adfd1 100644 --- a/docs/admin_docs/configuration/importing-exporting-datasources.mdx +++ b/docs/admin_docs/configuration/importing-exporting-datasources.mdx @@ -148,10 +148,10 @@ datasets by saving the following YAML to file and then running the **import_data ```yaml databases: -- database_name: main - tables: - - table_name: random_time_series - columns: - - column_name: ds - verbose_name: datetime + - database_name: main + tables: + - table_name: random_time_series + columns: + - column_name: ds + verbose_name: datetime ``` diff --git a/docs/admin_docs/configuration/map-tiles.mdx b/docs/admin_docs/configuration/map-tiles.mdx index 15c383132d0..922f1536456 100644 --- a/docs/admin_docs/configuration/map-tiles.mdx +++ b/docs/admin_docs/configuration/map-tiles.mdx @@ -18,7 +18,9 @@ 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'] @@ -53,6 +55,7 @@ DECKGL_BASE_MAP = [ ``` Default values are: + ```python DECKGL_BASE_MAP = [ ['https://tile.openstreetmap.org/{z}/{x}/{y}.png', 'Streets (OSM)'], @@ -73,6 +76,7 @@ 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. diff --git a/docs/admin_docs/configuration/mcp-server.mdx b/docs/admin_docs/configuration/mcp-server.mdx index f0f33c8e785..75e73474bfc 100644 --- a/docs/admin_docs/configuration/mcp-server.mdx +++ b/docs/admin_docs/configuration/mcp-server.mdx @@ -55,11 +55,11 @@ The MCP server runs as a separate process alongside Superset: 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 | +| 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`. @@ -193,22 +193,24 @@ 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 | +| 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 @@ -435,7 +437,7 @@ services: superset: image: apache/superset:latest ports: - - "8088:8088" + - '8088:8088' volumes: - ./superset_config.py:/app/superset_config.py environment: @@ -443,9 +445,9 @@ services: mcp: image: apache/superset:latest - command: ["superset", "mcp", "run", "--host", "0.0.0.0", "--port", "5008"] + command: ['superset', 'mcp', 'run', '--host', '0.0.0.0', '--port', '5008'] ports: - - "5008:5008" + - '5008:5008' volumes: - ./superset_config.py:/app/superset_config.py environment: @@ -494,31 +496,31 @@ All MCP settings go in `superset_config.py`. Defaults are defined in `superset/m ### 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. | -| `MCP_DISABLED_TOOLS` | `set()` | Set of tool names to remove from the MCP server at startup. Disabled tools are never advertised to AI clients during tool discovery. Useful when a custom extension tool should replace a built-in Superset tool. See [Disabling built-in tools](#disabling-built-in-tools). | +| 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. | +| `MCP_DISABLED_TOOLS` | `set()` | Set of tool names to remove from the MCP server at startup. Disabled tools are never advertised to AI clients during tool discovery. Useful when a custom extension tool should replace a built-in Superset tool. See [Disabling built-in tools](#disabling-built-in-tools). | ### 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. | +| 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 @@ -539,13 +541,13 @@ MCP_RESPONSE_SIZE_CONFIG = { } ``` -| 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 | -| `max_list_items` | `100` | Cap on list-field length (e.g. `charts`, `native_filters`) applied to the `get_*_info` tools before falling back to more aggressive truncation. Raised from a hardcoded 30 in earlier versions; the higher default only keeps more data before the same token-budget fallback kicks in, so it's not a breaking change, but tenants that tuned workflows around the old 30-item cap should lower this value explicitly. | -| `excluded_tools` | See above | Tools exempt from size checking (e.g., tools that return URLs, not data) | +| 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 | +| `max_list_items` | `100` | Cap on list-field length (e.g. `charts`, `native_filters`) applied to the `get_*_info` tools before falling back to more aggressive truncation. Raised from a hardcoded 30 in earlier versions; the higher default only keeps more data before the same token-budget fallback kicks in, so it's not a breaking change, but tenants that tuned workflows around the old 30-item cap should lower this value explicitly. | +| `excluded_tools` | See above | Tools exempt from size checking (e.g., tools that return URLs, not data) | ### Caching @@ -571,18 +573,18 @@ MCP_CACHE_CONFIG = { } ``` -| 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) | +| 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) @@ -597,12 +599,12 @@ MCP_STORE_CONFIG = { } ``` -| 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 | +| 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 @@ -625,15 +627,15 @@ MCP_TOOL_SEARCH_CONFIG = { } ``` -| 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. | +| 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. @@ -670,16 +672,16 @@ The MCP server respects Superset's full role-based access control (RBAC). Every 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) | +| 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: @@ -706,13 +708,13 @@ This makes MCP activity fully auditable alongside regular Superset activity. The 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`) | +| 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. diff --git a/docs/admin_docs/configuration/networking-settings.mdx b/docs/admin_docs/configuration/networking-settings.mdx index e6b3f814f28..88dfa2274a3 100644 --- a/docs/admin_docs/configuration/networking-settings.mdx +++ b/docs/admin_docs/configuration/networking-settings.mdx @@ -8,12 +8,10 @@ version: 1 ## 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 @@ -54,11 +52,13 @@ Restart Superset for this configuration change to take effect. 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 `'ENABLE_VIEWERS': True` [Feature Flag](/admin-docs/configuration/feature-flags) 3. Edit each dashboard's properties and add the "Public" role subject as a viewer @@ -75,7 +75,7 @@ Now anybody can directly access the dashboard's URL. You can embed it in an ifra width="600" height="400" seamless - frameBorder="0" + frameborder="0" scrolling="no" src="https://superset.my-domain.com/superset/dashboard/10/?standalone=1&height=400" > @@ -123,17 +123,17 @@ running a custom auth postback endpoint), you can add the endpoints to `WTF_CSRF ## 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 + - 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. + - 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. + - Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing. ## Domain Sharding diff --git a/docs/admin_docs/configuration/sql-templating.mdx b/docs/admin_docs/configuration/sql-templating.mdx index a0059667591..f55bd46846d 100644 --- a/docs/admin_docs/configuration/sql-templating.mdx +++ b/docs/admin_docs/configuration/sql-templating.mdx @@ -90,7 +90,7 @@ In the UI you can assign a set of parameters as JSON 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. +There is a special `_filters` parameter which can be used to test filters used in the jinja template. ```json { @@ -111,7 +111,7 @@ 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. +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 @@ -245,16 +245,19 @@ cache key by adding the following parameter to your Jinja code: ``` 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') ``` @@ -280,6 +283,7 @@ Always treat `url_param()` values as untrusted input. Escaping behaviour varies {% if cc not in ('US', 'ES', 'FR') %}{% set cc = 'US' %}{% endif %} WHERE country_code = '{{ cc }}' ``` + ::: Here's a concrete example: @@ -364,6 +368,7 @@ This is useful if: AND full_name LIKE '{{ filter.get('val') | replace("'", "''") }}' {%- endif -%} ``` + ::: Here's a concrete example: @@ -431,7 +436,7 @@ 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 +- `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. @@ -537,6 +542,7 @@ The parameter can be used in SQL Lab, or when fetching a metric from another dat 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): ``` @@ -556,6 +562,7 @@ Dashboard filter without any value applied ### 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 %} @@ -567,5 +574,6 @@ Loads a string as a `datetime` object. This is useful when performing date opera ``` :::resources + - [Blog: Intro to Jinja Templating in Apache Superset](https://preset.io/blog/intro-jinja-templating-apache-superset/) -::: + ::: diff --git a/docs/admin_docs/configuration/theming.mdx b/docs/admin_docs/configuration/theming.mdx index 92e4fcd8e59..46e30e58b16 100644 --- a/docs/admin_docs/configuration/theming.mdx +++ b/docs/admin_docs/configuration/theming.mdx @@ -4,6 +4,7 @@ hide_title: true sidebar_position: 12 version: 1 --- + # Theming Superset :::note @@ -34,11 +35,13 @@ You can also extend with Superset-specific tokens (documented in the default the 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 @@ -46,6 +49,7 @@ When `ENABLE_UI_THEME_ADMINISTRATION = True` is configured, administrators can m ### 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 @@ -127,6 +131,7 @@ When `ENABLE_UI_THEME_ADMINISTRATION = True`: Superset validates theme JSON when it is saved, either through the UI or via configuration. If a theme contains invalid tokens or an unrecognized structure, Superset logs a warning and falls back to the built-in default theme rather than applying a broken configuration. This prevents a bad theme from rendering the application unusable. The fallback order is: + 1. **UI-configured system theme** (highest priority, if `ENABLE_UI_THEME_ADMINISTRATION = True`) 2. **`THEME_DEFAULT` / `THEME_DARK`** from `superset_config.py` 3. **Built-in Superset default theme** (always present as a safety net) @@ -455,9 +460,10 @@ For programmatic theme management, Superset provides REST endpoints: 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/installation/architecture.mdx b/docs/admin_docs/installation/architecture.mdx index e531b30017e..4560f21b5b0 100644 --- a/docs/admin_docs/installation/architecture.mdx +++ b/docs/admin_docs/installation/architecture.mdx @@ -5,7 +5,7 @@ sidebar_position: 1 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +import useBaseUrl from '@docusaurus/useBaseUrl'; # Architecture diff --git a/docs/admin_docs/installation/docker-builds.mdx b/docs/admin_docs/installation/docker-builds.mdx index ffd523b906d..81e4009e76f 100644 --- a/docs/admin_docs/installation/docker-builds.mdx +++ b/docs/admin_docs/installation/docker-builds.mdx @@ -11,8 +11,7 @@ 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. +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 diff --git a/docs/admin_docs/installation/docker-compose.mdx b/docs/admin_docs/installation/docker-compose.mdx index 9ec86e3c060..a153847cdf1 100644 --- a/docs/admin_docs/installation/docker-compose.mdx +++ b/docs/admin_docs/installation/docker-compose.mdx @@ -5,12 +5,13 @@ sidebar_position: 5 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +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** @@ -29,23 +30,23 @@ 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 + 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 + 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 + 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. + `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. @@ -92,7 +93,7 @@ like to try out Superset without making any code changes follow the steps docume :::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 +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. @@ -121,6 +122,7 @@ 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 @@ -165,7 +167,7 @@ looking to fire up. :::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 +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. @@ -174,7 +176,7 @@ 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 +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 @@ -259,24 +261,24 @@ Superset (which is running in its docker container). Other databases may have sl 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. + 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. + (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 diff --git a/docs/admin_docs/installation/installation-methods.mdx b/docs/admin_docs/installation/installation-methods.mdx index 0e8f11b7d57..828ed2d56ae 100644 --- a/docs/admin_docs/installation/installation-methods.mdx +++ b/docs/admin_docs/installation/installation-methods.mdx @@ -5,7 +5,7 @@ sidebar_position: 2 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +import useBaseUrl from '@docusaurus/useBaseUrl'; # Installation Methods diff --git a/docs/admin_docs/installation/kubernetes.mdx b/docs/admin_docs/installation/kubernetes.mdx index 6433564f8bd..a374338e4c9 100644 --- a/docs/admin_docs/installation/kubernetes.mdx +++ b/docs/admin_docs/installation/kubernetes.mdx @@ -1,16 +1,17 @@ --- -title: Kubernetes +title: Kubernetes hide_title: true sidebar_position: 3 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +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). @@ -134,7 +135,7 @@ init: ``` :::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. +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. There are two independent telemetry channels: @@ -143,11 +144,11 @@ There are two independent telemetry channels: ```yaml extraEnv: - SCARF_ANALYTICS: "false" + SCARF_ANALYTICS: 'false' ``` This is read at runtime, so it takes effect on the pre-built images without rebuilding the frontend. -::: + ::: ### Dependencies @@ -205,7 +206,7 @@ Those can be passed as key/values either with `extraEnv` or `extraSecretEnv` if extraEnv: SMTP_HOST: smtp.gmail.com SMTP_USER: user@gmail.com - SMTP_PORT: "587" + SMTP_PORT: '587' SMTP_MAIL_FROM: user@gmail.com extraSecretEnv: @@ -366,7 +367,7 @@ supersetCeleryBeat: extraEnv: SMTP_HOST: smtp.gmail.com SMTP_USER: user@gmail.com - SMTP_PORT: "587" + SMTP_PORT: '587' SMTP_MAIL_FROM: user@gmail.com extraSecretEnv: @@ -456,6 +457,7 @@ init: ``` :::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/installation/pypi.mdx b/docs/admin_docs/installation/pypi.mdx index 7658b27174d..cd0c7a61a61 100644 --- a/docs/admin_docs/installation/pypi.mdx +++ b/docs/admin_docs/installation/pypi.mdx @@ -5,12 +5,13 @@ sidebar_position: 4 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +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/). @@ -126,6 +127,7 @@ 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 diff --git a/docs/admin_docs/installation/upgrading-superset.mdx b/docs/admin_docs/installation/upgrading-superset.mdx index 0cf092a5a06..9c13320fa94 100644 --- a/docs/admin_docs/installation/upgrading-superset.mdx +++ b/docs/admin_docs/installation/upgrading-superset.mdx @@ -55,6 +55,7 @@ For a detailed list of breaking changes and migration notes for each version, se This file documents backwards-incompatible changes and provides guidance for migrating between major versions, including: + - Configuration changes - API changes - Database migrations diff --git a/docs/admin_docs/security/cves.mdx b/docs/admin_docs/security/cves.mdx index a8c2cbb95c2..55b1189566c 100644 --- a/docs/admin_docs/security/cves.mdx +++ b/docs/admin_docs/security/cves.mdx @@ -2,41 +2,42 @@ 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 | +| 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 | +| 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 | +| 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 | +| 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 | @@ -44,84 +45,84 @@ sidebar_position: 2 #### Version 4.0.2 -| CVE | Title | Affected | -|:---------------|:----------------------------|---------:| -| CVE-2024-39887 | Improper SQL authorization | < 4.0.1 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | @@ -129,8 +130,8 @@ sidebar_position: 2 #### Version 2.0.1 -| CVE | Title | Affected | -|:---------------|:------------------------------------------------------------|------------------: | +| 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 | diff --git a/docs/admin_docs/security/securing_superset.mdx b/docs/admin_docs/security/securing_superset.mdx index a0cb8b5acfc..91887b7064e 100644 --- a/docs/admin_docs/security/securing_superset.mdx +++ b/docs/admin_docs/security/securing_superset.mdx @@ -3,7 +3,7 @@ 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.* +> _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. @@ -13,25 +13,25 @@ This guide provides a comprehensive checklist of essential security configuratio 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. +- **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') - ``` +- **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 > @@ -75,7 +75,7 @@ SESSION_USE_SIGNER = True #### **Configure Session Lifetime and Cookie Security Flags** -This is mandatory for *all* deployments, whether stateless or server-side. +This is mandatory for _all_ deployments, whether stateless or server-side. ```python # superset_config.py @@ -92,7 +92,8 @@ 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'`. +> +> 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' @@ -102,9 +103,9 @@ Setting SameSite to 'None' requires that SESSION_COOKIE_SECURE is also set to Tr 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. +- **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** @@ -122,48 +123,48 @@ Here's the documentation section how how to set up Talisman: https://superset.ap > > 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. +- **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. +- **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. +- **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. +- [ ] 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. - - [ ] Rotate the other security-critical secrets (guest-token and async-query JWT secrets, SMTP and database credentials) on the cadence in Appendix C, 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. +- [ ] 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. +- [ ] Rotate the other security-critical secrets (guest-token and async-query JWT secrets, SMTP and database credentials) on the cadence in Appendix C, 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** @@ -178,13 +179,13 @@ https://superset.apache.org/admin-docs/configuration/configuring-superset/#rotat `SUPERSET_SECRET_KEY` is not the only security-critical secret in a Superset deployment. Maintain an inventory of all such secrets, store each in a secrets manager (not in `superset_config.py` or version control), assign a responsible maintainer, and rotate them on a defined cadence as well as after any suspected compromise. -| Secret | Purpose | Risk if leaked | Suggested rotation | -|---|---|---|---| -| `SUPERSET_SECRET_KEY` | Signs session cookies; key material for encrypting stored DB credentials (Fernet/AES) | Forged sessions (auth bypass / privilege escalation); decryption of exfiltrated metadata-DB secrets | Quarterly + post-incident | -| `GUEST_TOKEN_JWT_SECRET` | Signs embedded-dashboard guest tokens | Forged guest tokens β†’ unauthorized dashboard/data access | Quarterly + post-incident | -| `GLOBAL_ASYNC_QUERIES_JWT_SECRET` | Signs the async-query channel JWT | Forged async-query tokens | Quarterly + post-incident | -| SMTP password | Outbound email for alerts & reports | Email relay abuse / spoofing | Per organizational policy + post-incident | -| Database connection passwords | Access to analytical databases and the metadata DB | Direct database access | Per organizational policy + post-incident | +| Secret | Purpose | Risk if leaked | Suggested rotation | +| --------------------------------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| `SUPERSET_SECRET_KEY` | Signs session cookies; key material for encrypting stored DB credentials (Fernet/AES) | Forged sessions (auth bypass / privilege escalation); decryption of exfiltrated metadata-DB secrets | Quarterly + post-incident | +| `GUEST_TOKEN_JWT_SECRET` | Signs embedded-dashboard guest tokens | Forged guest tokens β†’ unauthorized dashboard/data access | Quarterly + post-incident | +| `GLOBAL_ASYNC_QUERIES_JWT_SECRET` | Signs the async-query channel JWT | Forged async-query tokens | Quarterly + post-incident | +| SMTP password | Outbound email for alerts & reports | Email relay abuse / spoofing | Per organizational policy + post-incident | +| Database connection passwords | Access to analytical databases and the metadata DB | Direct database access | Per organizational policy + post-incident | Notes: @@ -193,6 +194,7 @@ Notes: - Keep the register under change control so new secrets introduced by future features are added to the rotation schedule. :::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/security/security.mdx b/docs/admin_docs/security/security.mdx index e6c11a7ae85..d1ef70f3048 100644 --- a/docs/admin_docs/security/security.mdx +++ b/docs/admin_docs/security/security.mdx @@ -24,13 +24,13 @@ A table with the permissions for these roles can be found at [/RESOURCES/STANDAR 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 +> #### 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. +> 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. +> 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. +> 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 @@ -54,10 +54,10 @@ to all databases by default, both **Alpha** and **Gamma** users need to be given 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 | +| 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. @@ -73,6 +73,7 @@ users who need to view dashboards. It provides minimal read-only access for: - Viewing annotations on charts The Public role explicitly excludes: + - Any write permissions on dashboards, charts, or datasets - SQL Lab access - Share functionality @@ -236,6 +237,7 @@ viewers returns the resource to the dataset-based fallback. Explicit Viewers are going forward; the implicit fallback may be deprecated and removed in a later major version. **Important considerations:** + - Viewer access uses normal dataset checks unless `VIEWER_PROMISCUOUS_MODE` is enabled - With `VIEWER_PROMISCUOUS_MODE`, dashboard viewer access can bypass dataset-level checks for charts and datasets in that dashboard @@ -243,6 +245,7 @@ going forward; the implicit fallback may be deprecated and removed in a later ma - 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 permissions @@ -260,10 +263,11 @@ However, it is crucial to understand the following: **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. + +- **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. @@ -419,11 +423,11 @@ rules are: For example, if a dataset has three filters: -| Filter | Clause | Group Key | -|--------|--------|-----------| -| F1 | `department = 'Finance'` | `department` | -| F2 | `department = 'Marketing'` | `department` | -| F3 | `region = 'Europe'` | `region` | +| Filter | Clause | Group Key | +| ------ | -------------------------- | ------------ | +| F1 | `department = 'Finance'` | `department` | +| F2 | `department = 'Marketing'` | `department` | +| F3 | `region = 'Europe'` | `region` | The resulting WHERE clause would be: @@ -507,7 +511,7 @@ 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 `subjects`. +`group_key`, assigned `tables` (with id, schema, and table_name), and assigned `subjects`. :::tip Auditing RLS for virtual datasets To find all RLS rules that could affect a particular virtual dataset, query the list @@ -553,13 +557,13 @@ 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 +```python SESSION_SERVER_SIDE = True ``` Flask-Session offers multiple backend session interfaces for Flask, here's an example for Redis: -``` python +```python from redis import Redis SESSION_TYPE = "redis" @@ -588,8 +592,8 @@ It's extremely important to correctly configure a Content Security Policy when d 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. +- `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 @@ -605,12 +609,12 @@ this warning using the `CONTENT_SECURITY_POLICY_WARNING` key in `config.py`. ``` - 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()`. + 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 ``` @@ -628,7 +632,7 @@ You can get current nonce value by calling jinja macro `csp_nonce()`. ``` - 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`. + 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. @@ -639,12 +643,12 @@ In order to adjust provided CSP configuration to your needs, follow the instruct 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*. +[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., +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: 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 index f5c4efc42ed..135c3e8b184 100644 --- 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 @@ -9,8 +9,8 @@ version: 2 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_ 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. @@ -26,16 +26,17 @@ Alerts and reports are disabled by default. To turn them on, you'll need to chan - 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. + - 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). +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`. @@ -189,7 +190,7 @@ You need to replace default values with your custom Redis, Slack and/or SMTP con 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. +- 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. @@ -296,7 +297,7 @@ Please refer to `ExecutorType` in the codebase for other executor types. It's also possible to specify a minimum interval between each report's execution through the config file: -``` python +```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()) @@ -305,7 +306,7 @@ 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 +```python def alert_dynamic_minimal_interval(**kwargs) -> int: """ Define logic here to retrieve the value dynamically @@ -318,7 +319,7 @@ ALERT_MINIMUM_INTERVAL = alert_dynamic_minimal_interval 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. +site. Internal links (matching your configured base URL) are not affected. ```python # Disable external link redirection entirely (default: True) @@ -330,17 +331,17 @@ 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. +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. +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`. +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 @@ -352,7 +353,7 @@ If you are handling the installation of the headless browser on your own, do you 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. +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: @@ -378,16 +379,16 @@ 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. +- 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. +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`. +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 @@ -495,6 +496,7 @@ schedule the queries that have `schedule_info` in their JSON metadata. For sched 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 index ee2d2c28624..5c960f89433 100644 --- 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 @@ -104,5 +104,6 @@ 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 index e3fac57508f..670d3c90d5d 100644 --- 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 @@ -1,26 +1,28 @@ -{/* +{/\* Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file +or more contributor license agreements. See the NOTICE file distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file +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 +with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 +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 +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 @@ -31,7 +33,7 @@ Cross-account IAM role assumption via STS `AssumeRole` is supported, allowing a ## 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."* +- 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, @@ -66,14 +68,14 @@ IAM authentication is configured via the **encrypted_extra** field of the databa } ``` -| 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`) | +| 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) 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 index ef3fbe1161c..88749860405 100644 --- 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 @@ -271,6 +271,7 @@ While database-backed operations work reliably, the Redis backend is recommended 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 index daf92b1c943..129e6f100bb 100644 --- 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 @@ -225,7 +225,7 @@ RequestHeader set X-Forwarded-Proto "https" ## Configuring the application root -*Please be advised that this feature is in BETA.* +_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: @@ -312,10 +312,13 @@ 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 ``` @@ -505,5 +508,6 @@ CELERY_BEAT_SCHEDULE = { Adjust `retention_period_days` to control how long query rows are kept. Companion opt-in tasks (`prune_logs`, `prune_tasks`) exist for pruning the logs and tasks tables; see the commented-out examples in `superset/config.py`. Without enabling these tasks, the metadata database will grow unbounded over time. :::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 index 1f18d08cce5..7476280ecf7 100644 --- 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 @@ -22,10 +22,10 @@ The current list of countries can be found in the src The Country Maps visualization already ships with the maps for the following countries: -
      -{countriesData.countries.map((country, index) => ( -
    • {country}
      • -))} +
        + {countriesData.countries.map((country, index) => ( +
      • {country}
        • + ))}
      ## Adding a New Country 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 index a5d78df7f52..2086d108130 100644 --- 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 @@ -7,7 +7,7 @@ version: 1 import featureFlags from '../_versioned_data/static/feature-flags.json'; -export const FlagTable = ({flags}) => ( +export const FlagTable = ({ flags }) => (
    {flag.name}{flag.default ? 'True' : 'False'} + {flag.name} + + {flag.default ? 'True' : 'False'} + {flag.description} {flag.docs && ( - <> (docs) + <> + {' '} + (docs) + )}
    @@ -17,14 +17,21 @@ export const FlagTable = ({flags}) => ( - {flags.map((flag) => ( + {flags.map(flag => ( - - + + @@ -50,12 +57,12 @@ FEATURE_FLAGS = { Feature flags progress through lifecycle stages: -| Stage | Description | -|-------|-------------| +| 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. | +| **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. | --- 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 index 6fc7ceea9ff..a954f2adfd1 100644 --- 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 @@ -148,10 +148,10 @@ datasets by saving the following YAML to file and then running the **import_data ```yaml databases: -- database_name: main - tables: - - table_name: random_time_series - columns: - - column_name: ds - verbose_name: datetime + - 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 index e83608c38bb..ceac0f45880 100644 --- 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 @@ -18,7 +18,9 @@ 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'] @@ -26,6 +28,7 @@ DECKGL_BASE_MAP = [ ``` Default values are: + ```python DECKGL_BASE_MAP = [ ['https://tile.openstreetmap.org/{z}/{x}/{y}.png', 'Streets (OSM)'], @@ -46,6 +49,7 @@ 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. 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 index df299acaf8d..92410b5fe52 100644 --- 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 @@ -55,11 +55,11 @@ The MCP server runs as a separate process alongside Superset: 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 | +| 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`. @@ -193,22 +193,24 @@ 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 | +| 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 @@ -435,7 +437,7 @@ services: superset: image: apache/superset:latest ports: - - "8088:8088" + - '8088:8088' volumes: - ./superset_config.py:/app/superset_config.py environment: @@ -443,9 +445,9 @@ services: mcp: image: apache/superset:latest - command: ["superset", "mcp", "run", "--host", "0.0.0.0", "--port", "5008"] + command: ['superset', 'mcp', 'run', '--host', '0.0.0.0', '--port', '5008'] ports: - - "5008:5008" + - '5008:5008' volumes: - ./superset_config.py:/app/superset_config.py environment: @@ -494,30 +496,30 @@ All MCP settings go in `superset_config.py`. Defaults are defined in `superset/m ### 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. | +| 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. | +| 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 @@ -537,12 +539,12 @@ MCP_RESPONSE_SIZE_CONFIG = { } ``` -| 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) | +| 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 @@ -568,18 +570,18 @@ MCP_CACHE_CONFIG = { } ``` -| 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) | +| 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) @@ -594,12 +596,12 @@ MCP_STORE_CONFIG = { } ``` -| 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 | +| 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 @@ -622,15 +624,15 @@ MCP_TOOL_SEARCH_CONFIG = { } ``` -| 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. | +| 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. @@ -667,16 +669,16 @@ The MCP server respects Superset's full role-based access control (RBAC). Every 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) | +| 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: @@ -703,13 +705,13 @@ This makes MCP activity fully auditable alongside regular Superset activity. The 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`) | +| 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. 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 index b37d93bedcc..71c65d63d92 100644 --- 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 @@ -8,12 +8,10 @@ version: 1 ## 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 @@ -54,11 +52,13 @@ Restart Superset for this configuration change to take effect. 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 @@ -75,7 +75,7 @@ Now anybody can directly access the dashboard's URL. You can embed it in an ifra width="600" height="400" seamless - frameBorder="0" + frameborder="0" scrolling="no" src="https://superset.my-domain.com/superset/dashboard/10/?standalone=1&height=400" > @@ -123,17 +123,17 @@ running a custom auth postback endpoint), you can add the endpoints to `WTF_CSRF ## 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 + - 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. + - 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. + - Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing. ## Domain Sharding 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 index f2c21bcef79..9046e854c14 100644 --- 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 @@ -106,6 +106,7 @@ WHERE dttm_col > '{{ from_dttm | default("2024-01-01", true) }}' **Option 2: Use SQL Lab Parameters** Set parameters in the SQL Lab UI (Parameters menu): + ```json { "from_dttm": "2024-01-01", @@ -151,7 +152,7 @@ In the UI you can assign a set of parameters as JSON 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. +There is a special `_filters` parameter which can be used to test filters used in the jinja template. ```json { @@ -172,7 +173,7 @@ 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. +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 @@ -306,16 +307,19 @@ cache key by adding the following parameter to your Jinja code: ``` 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') ``` @@ -341,6 +345,7 @@ Always treat `url_param()` values as untrusted input. Escaping behaviour varies {% if cc not in ('US', 'ES', 'FR') %}{% set cc = 'US' %}{% endif %} WHERE country_code = '{{ cc }}' ``` + ::: Here's a concrete example: @@ -425,6 +430,7 @@ This is useful if: AND full_name LIKE '{{ filter.get('val') | replace("'", "''") }}' {%- endif -%} ``` + ::: Here's a concrete example: @@ -489,7 +495,7 @@ 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 +- `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. @@ -595,6 +601,7 @@ The parameter can be used in SQL Lab, or when fetching a metric from another dat 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): ``` @@ -614,6 +621,7 @@ Dashboard filter without any value applied ### 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 %} @@ -625,5 +633,6 @@ Loads a string as a `datetime` object. This is useful when performing date opera ``` :::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 index 92e4fcd8e59..46e30e58b16 100644 --- 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 @@ -4,6 +4,7 @@ hide_title: true sidebar_position: 12 version: 1 --- + # Theming Superset :::note @@ -34,11 +35,13 @@ You can also extend with Superset-specific tokens (documented in the default the 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 @@ -46,6 +49,7 @@ When `ENABLE_UI_THEME_ADMINISTRATION = True` is configured, administrators can m ### 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 @@ -127,6 +131,7 @@ When `ENABLE_UI_THEME_ADMINISTRATION = True`: Superset validates theme JSON when it is saved, either through the UI or via configuration. If a theme contains invalid tokens or an unrecognized structure, Superset logs a warning and falls back to the built-in default theme rather than applying a broken configuration. This prevents a bad theme from rendering the application unusable. The fallback order is: + 1. **UI-configured system theme** (highest priority, if `ENABLE_UI_THEME_ADMINISTRATION = True`) 2. **`THEME_DEFAULT` / `THEME_DARK`** from `superset_config.py` 3. **Built-in Superset default theme** (always present as a safety net) @@ -455,9 +460,10 @@ For programmatic theme management, Superset provides REST endpoints: 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/installation/architecture.mdx b/docs/admin_docs_versioned_docs/version-6.1.0/installation/architecture.mdx index e531b30017e..4560f21b5b0 100644 --- 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 @@ -5,7 +5,7 @@ sidebar_position: 1 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +import useBaseUrl from '@docusaurus/useBaseUrl'; # Architecture 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 index ffd523b906d..81e4009e76f 100644 --- 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 @@ -11,8 +11,7 @@ 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. +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 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 index 04d14915860..908ce1f92b8 100644 --- 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 @@ -5,12 +5,13 @@ sidebar_position: 5 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +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** @@ -29,23 +30,23 @@ 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 + 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 + 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 + 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. + `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. @@ -92,7 +93,7 @@ like to try out Superset without making any code changes follow the steps docume :::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 +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. @@ -121,6 +122,7 @@ 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 @@ -165,7 +167,7 @@ looking to fire up. :::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 +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. @@ -174,7 +176,7 @@ 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 +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 @@ -258,24 +260,24 @@ Superset (which is running in its docker container). Other databases may have sl 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. + 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. + (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 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 index 0e8f11b7d57..828ed2d56ae 100644 --- 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 @@ -5,7 +5,7 @@ sidebar_position: 2 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +import useBaseUrl from '@docusaurus/useBaseUrl'; # Installation Methods 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 index c18bf803f92..ad94deb734f 100644 --- 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 @@ -1,16 +1,17 @@ --- -title: Kubernetes +title: Kubernetes hide_title: true sidebar_position: 3 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +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). @@ -134,7 +135,7 @@ init: ``` :::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. +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. ::: @@ -195,7 +196,7 @@ Those can be passed as key/values either with `extraEnv` or `extraSecretEnv` if extraEnv: SMTP_HOST: smtp.gmail.com SMTP_USER: user@gmail.com - SMTP_PORT: "587" + SMTP_PORT: '587' SMTP_MAIL_FROM: user@gmail.com extraSecretEnv: @@ -356,7 +357,7 @@ supersetCeleryBeat: extraEnv: SMTP_HOST: smtp.gmail.com SMTP_USER: user@gmail.com - SMTP_PORT: "587" + SMTP_PORT: '587' SMTP_MAIL_FROM: user@gmail.com extraSecretEnv: @@ -446,6 +447,7 @@ init: ``` :::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 index 7dd5b4b8e79..027006adf5e 100644 --- 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 @@ -5,12 +5,13 @@ sidebar_position: 4 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +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/). @@ -23,6 +24,7 @@ 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 @@ -133,6 +135,7 @@ 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 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 index 0cf092a5a06..9c13320fa94 100644 --- 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 @@ -55,6 +55,7 @@ For a detailed list of breaking changes and migration notes for each version, se This file documents backwards-incompatible changes and provides guidance for migrating between major versions, including: + - Configuration changes - API changes - Database migrations 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 index a8c2cbb95c2..55b1189566c 100644 --- 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 @@ -2,41 +2,42 @@ 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 | +| 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 | +| 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 | +| 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 | +| 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 | @@ -44,84 +45,84 @@ sidebar_position: 2 #### Version 4.0.2 -| CVE | Title | Affected | -|:---------------|:----------------------------|---------:| -| CVE-2024-39887 | Improper SQL authorization | < 4.0.1 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | @@ -129,8 +130,8 @@ sidebar_position: 2 #### Version 2.0.1 -| CVE | Title | Affected | -|:---------------|:------------------------------------------------------------|------------------: | +| 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 | 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 index 92d42e385e0..8ed4357d144 100644 --- 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 @@ -3,7 +3,7 @@ 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.* +> _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. @@ -13,25 +13,25 @@ This guide provides a comprehensive checklist of essential security configuratio 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. +- **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') - ``` +- **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 > @@ -75,7 +75,7 @@ SESSION_USE_SIGNER = True #### **Configure Session Lifetime and Cookie Security Flags** -This is mandatory for *all* deployments, whether stateless or server-side. +This is mandatory for _all_ deployments, whether stateless or server-side. ```python # superset_config.py @@ -92,7 +92,8 @@ 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'`. +> +> 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' @@ -102,9 +103,9 @@ Setting SameSite to 'None' requires that SESSION_COOKIE_SECURE is also set to Tr 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. +- **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** @@ -122,47 +123,47 @@ Here's the documentation section how how to set up Talisman: https://superset.ap > > 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. +- **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. +- **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. +- **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. +- [ ] 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. +- [ ] 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** @@ -174,6 +175,7 @@ The procedure for safely rotating the SECRET_KEY must be followed precisely to a 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 index 6190925d8ab..5bf9e5bf48b 100644 --- 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 @@ -24,13 +24,13 @@ A table with the permissions for these roles can be found at [/RESOURCES/STANDAR 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 +> #### 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. +> 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. +> 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. +> 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 @@ -54,10 +54,10 @@ to all databases by default, both **Alpha** and **Gamma** users need to be given 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 | +| 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. @@ -73,6 +73,7 @@ users who need to view dashboards. It provides minimal read-only access for: - Viewing annotations on charts The Public role explicitly excludes: + - Any write permissions on dashboards, charts, or datasets - SQL Lab access - Share functionality @@ -161,12 +162,14 @@ With this enabled, you can assign specific roles to each dashboard in its proper 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 @@ -184,10 +187,11 @@ However, it is crucial to understand the following: **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. + +- **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. @@ -341,11 +345,11 @@ rules are: For example, if a dataset has three filters: -| Filter | Clause | Group Key | -|--------|--------|-----------| -| F1 | `department = 'Finance'` | `department` | -| F2 | `department = 'Marketing'` | `department` | -| F3 | `region = 'Europe'` | `region` | +| Filter | Clause | Group Key | +| ------ | -------------------------- | ------------ | +| F1 | `department = 'Finance'` | `department` | +| F2 | `department = 'Marketing'` | `department` | +| F3 | `region = 'Europe'` | `region` | The resulting WHERE clause would be: @@ -429,7 +433,7 @@ 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` +`group_key`, assigned `tables` (with id, schema, and table_name), and assigned `roles` (with id and name). :::tip Auditing RLS for virtual datasets @@ -476,13 +480,13 @@ 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 +```python SESSION_SERVER_SIDE = True ``` Flask-Session offers multiple backend session interfaces for Flask, here's an example for Redis: -``` python +```python from redis import Redis SESSION_TYPE = "redis" @@ -511,8 +515,8 @@ It's extremely important to correctly configure a Content Security Policy when d 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. +- `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 @@ -528,12 +532,12 @@ this warning using the `CONTENT_SECURITY_POLICY_WARNING` key in `config.py`. ``` - 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()`. + 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 ``` @@ -551,7 +555,7 @@ You can get current nonce value by calling jinja macro `csp_nonce()`. ``` - 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`. + 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. @@ -562,12 +566,12 @@ In order to adjust provided CSP configuration to your needs, follow the instruct 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*. +[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., +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: diff --git a/docs/admin_docs_versions.json b/docs/admin_docs_versions.json index fc7d70bb315..99672c9707c 100644 --- a/docs/admin_docs_versions.json +++ b/docs/admin_docs_versions.json @@ -1,3 +1 @@ -[ - "6.1.0" -] +["6.1.0"] diff --git a/docs/components/chart-components/bar-chart.md b/docs/components/chart-components/bar-chart.md index 2b8e336e6ea..dde6e75a538 100644 --- a/docs/components/chart-components/bar-chart.md +++ b/docs/components/chart-components/bar-chart.md @@ -16,7 +16,9 @@ specific language governing permissions and limitations under the License. --> + --- + title: Bar Chart sidebar_position: 1 --- @@ -27,18 +29,18 @@ The Bar Chart component is used to visualize categorical data with rectangular b ## 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' | +| 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 diff --git a/docs/components/index.md b/docs/components/index.md index 77fb2a9cca9..ac914973dc8 100644 --- a/docs/components/index.md +++ b/docs/components/index.md @@ -16,7 +16,9 @@ specific language governing permissions and limitations under the License. --> + --- + title: Component Library sidebar_position: 1 --- diff --git a/docs/components/layout-components/grid.md b/docs/components/layout-components/grid.md index a0980d2bdcf..89c8ac5597e 100644 --- a/docs/components/layout-components/grid.md +++ b/docs/components/layout-components/grid.md @@ -16,7 +16,9 @@ specific language governing permissions and limitations under the License. --> + --- + title: Grid sidebar_position: 1 --- @@ -27,29 +29,29 @@ The Grid component provides a flexible layout system for arranging content in ro ## 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 | +| 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 | +| 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 | +| 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 diff --git a/docs/components/test.mdx b/docs/components/test.mdx index d5f842ad631..7376b698b93 100644 --- a/docs/components/test.mdx +++ b/docs/components/test.mdx @@ -16,9 +16,10 @@ specific language governing permissions and limitations under the License. --> + --- -title: Test ---- + +## title: Test import { StoryExample } from '../src/components/StorybookWrapper'; @@ -28,7 +29,9 @@ This is a test using our custom StorybookWrapper component. ( -
    +
    This is a simple example component
    )} diff --git a/docs/components/ui-components/button.mdx b/docs/components/ui-components/button.mdx index 2102d146efe..bb532e11050 100644 --- a/docs/components/ui-components/button.mdx +++ b/docs/components/ui-components/button.mdx @@ -16,12 +16,18 @@ specific language governing permissions and limitations under the License. --> ---- -title: Button Component -sidebar_position: 1 + --- -import { StoryExample, StoryWithControls } from '../../src/components/StorybookWrapper'; +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 @@ -31,6 +37,7 @@ The Button component is a fundamental UI element used throughout Superset for us ## Basic Usage The default button with primary styling: + ( ); 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 index 2b8e336e6ea..dde6e75a538 100644 --- 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 @@ -16,7 +16,9 @@ specific language governing permissions and limitations under the License. --> + --- + title: Bar Chart sidebar_position: 1 --- @@ -27,18 +29,18 @@ The Bar Chart component is used to visualize categorical data with rectangular b ## 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' | +| 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 diff --git a/docs/components_versioned_docs/version-6.1.0/index.md b/docs/components_versioned_docs/version-6.1.0/index.md index 77fb2a9cca9..ac914973dc8 100644 --- a/docs/components_versioned_docs/version-6.1.0/index.md +++ b/docs/components_versioned_docs/version-6.1.0/index.md @@ -16,7 +16,9 @@ specific language governing permissions and limitations under the License. --> + --- + title: Component Library sidebar_position: 1 --- 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 index a0980d2bdcf..89c8ac5597e 100644 --- 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 @@ -16,7 +16,9 @@ specific language governing permissions and limitations under the License. --> + --- + title: Grid sidebar_position: 1 --- @@ -27,29 +29,29 @@ The Grid component provides a flexible layout system for arranging content in ro ## 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 | +| 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 | +| 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 | +| 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 diff --git a/docs/components_versioned_docs/version-6.1.0/test.mdx b/docs/components_versioned_docs/version-6.1.0/test.mdx index 915b072b09d..fca5344c856 100644 --- a/docs/components_versioned_docs/version-6.1.0/test.mdx +++ b/docs/components_versioned_docs/version-6.1.0/test.mdx @@ -16,9 +16,10 @@ specific language governing permissions and limitations under the License. --> + --- -title: Test ---- + +## title: Test import { StoryExample } from '../../src/components/StorybookWrapper'; @@ -28,7 +29,9 @@ 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 index ea3eb374265..f4351228e05 100644 --- 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 @@ -16,12 +16,18 @@ specific language governing permissions and limitations under the License. --> ---- -title: Button Component -sidebar_position: 1 + --- -import { StoryExample, StoryWithControls } from '../../../src/components/StorybookWrapper'; +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 @@ -31,6 +37,7 @@ The Button component is a fundamental UI element used throughout Superset for us ## Basic Usage The default button with primary styling: + ( ); diff --git a/docs/components_versions.json b/docs/components_versions.json index fc7d70bb315..99672c9707c 100644 --- a/docs/components_versions.json +++ b/docs/components_versions.json @@ -1,3 +1 @@ -[ - "6.1.0" -] +["6.1.0"] diff --git a/docs/developer_docs/api.mdx b/docs/developer_docs/api.mdx index 64f1b28b885..043ed18a688 100644 --- a/docs/developer_docs/api.mdx +++ b/docs/developer_docs/api.mdx @@ -17,8 +17,10 @@ You can use this API to programmatically interact with Superset for automation, message="Code Samples & Schema Documentation" description={ - Each endpoint includes ready-to-use code samples in cURL, Python, and JavaScript. - The sidebar includes Schema definitions for detailed data model documentation. + 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' }} @@ -45,12 +47,12 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ #### 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` | +| 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` | --- @@ -61,129 +63,129 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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}` | +| 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` | +| 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` | +| 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/` | +| 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/` |
    @@ -192,69 +194,69 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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/` | +| 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}` | +| 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/` | +| 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` | +| 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` |
    @@ -263,61 +265,61 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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}` | +| 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}` | +| 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}` | +| 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}` |
    @@ -326,63 +328,63 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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}` | +| 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}` | +| 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}` | +| 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}` | +| 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` | +| 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}` | +| `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}` | +| 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}` |
    @@ -391,19 +393,19 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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/` |
    @@ -412,88 +414,88 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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}` | +| 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}` | +| 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}` | +| 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}` | +| 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}` | +| 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}` |
    @@ -502,9 +504,9 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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/` |
    @@ -512,8 +514,8 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    CacheRestApi (1 endpoints) β€” Cache management and invalidation operations. -| Method | Endpoint | Description | -|--------|----------|-------------| +| 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` |
    @@ -521,12 +523,12 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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/` |
    @@ -535,56 +537,56 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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` | +| 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/` | +| 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/` | +| 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/` | +| 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` | +| Method | Endpoint | Description | +| ------ | ---------------------------------------------------------------------------- | ------------------------- | +| `GET` | [Get api by version openapi](/developer-docs/api/get-api-by-version-openapi) | `/api/{version}/_openapi` |
    @@ -593,52 +595,52 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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}` | +| 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` | +| 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}` | +| 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}` |
    diff --git a/docs/developer_docs/contributing/code-review.md b/docs/developer_docs/contributing/code-review.md index f002c78d7ca..f9250c6ed3e 100644 --- a/docs/developer_docs/contributing/code-review.md +++ b/docs/developer_docs/contributing/code-review.md @@ -35,6 +35,7 @@ Code review is a critical part of maintaining code quality and sharing knowledge ### Preparing for Review #### Before Requesting Review + - [ ] Self-review your changes - [ ] Ensure CI checks pass - [ ] Add comprehensive tests @@ -43,6 +44,7 @@ Code review is a critical part of maintaining code quality and sharing knowledge - [ ] Add screenshots for UI changes #### Self-Review Checklist + ```bash # View your changes git diff upstream/master @@ -59,18 +61,23 @@ git diff upstream/master ### Requesting Review #### Auto-Assignment + GitHub will automatically request reviews based on CODEOWNERS file. #### Manual Assignment + For specific expertise, request additional reviewers: + - Frontend changes: Tag frontend experts - Backend changes: Tag backend experts - Security changes: Tag security team - Database changes: Tag database experts #### Review Request Message + ```markdown @reviewer This PR implements [feature]. Could you please review: + 1. The approach taken in [file] 2. Performance implications of [change] 3. Security considerations for [feature] @@ -81,23 +88,29 @@ Thanks! ### Responding to Feedback #### Best Practices + - **Be receptive**: Reviews improve code quality - **Ask questions**: Clarify if feedback is unclear - **Explain decisions**: Share context for your choices - **Update promptly**: Address feedback in timely manner #### Comment Responses + ```markdown # Acknowledging + "Good catch! Fixed in [commit hash]" # Explaining + "I chose this approach because [reason]. Would you prefer [alternative]?" # Questioning + "Could you elaborate on [concern]? I'm not sure I understand the issue." # Disagreeing respectfully + "I see your point, but I think [current approach] because [reason]. What do you think?" ``` @@ -106,6 +119,7 @@ Thanks! ### Review Responsibilities #### What to Review + 1. **Correctness**: Does the code do what it claims? 2. **Design**: Is the approach appropriate? 3. **Clarity**: Is the code readable and maintainable? @@ -117,12 +131,14 @@ Thanks! ### Review Checklist #### Functionality + - [ ] Feature works as described - [ ] Edge cases are handled - [ ] Error handling is appropriate - [ ] Backwards compatibility maintained #### Code Quality + - [ ] Follows project conventions - [ ] No code duplication - [ ] Clear variable/function names @@ -130,6 +146,7 @@ Thanks! - [ ] SOLID principles followed #### Testing + - [ ] Unit tests for business logic - [ ] Integration tests for APIs - [ ] E2E tests for critical paths @@ -137,6 +154,7 @@ Thanks! - [ ] Good test coverage #### Security + - [ ] Input validation - [ ] SQL injection prevention - [ ] XSS prevention @@ -145,6 +163,7 @@ Thanks! - [ ] No sensitive data in logs #### Performance + - [ ] Database queries optimized - [ ] No N+1 queries - [ ] Appropriate caching @@ -176,11 +195,13 @@ re-renders when dependencies haven't changed." #### Comment Types **Use GitHub's comment types:** + - **Comment**: General feedback or questions - **Approve**: Changes look good - **Request Changes**: Must be addressed before merge **Prefix conventions:** + - `nit:` Minor issue (non-blocking) - `suggestion:` Recommended improvement - `question:` Seeking clarification @@ -206,12 +227,15 @@ praise: Excellent test coverage! πŸ‘ ### Timeline #### Expected Response Times + - **Initial review**: Within 2-3 business days - **Follow-up review**: Within 1-2 business days - **Critical fixes**: ASAP (tag in Slack) #### Escalation + If no response after 3 days: + 1. Ping reviewer in PR comments 2. Ask in #development Slack channel 3. Tag @apache/superset-committers @@ -219,11 +243,13 @@ If no response after 3 days: ### Approval Requirements #### Minimum Requirements + - **1 approval** from a committer for minor changes - **2 approvals** for significant features - **3 approvals** for breaking changes #### Special Cases + - **Security changes**: Require security team review - **API changes**: Require API team review - **Database migrations**: Require database expert review @@ -232,16 +258,19 @@ If no response after 3 days: ### Merge Process #### Who Can Merge + - Committers with write access - After all requirements met - CI checks must pass #### Merge Methods + - **Squash and merge**: Default for feature PRs - **Rebase and merge**: For clean history - **Create merge commit**: Rarely used #### Merge Checklist + - [ ] All CI checks green - [ ] Required approvals obtained - [ ] No unresolved conversations @@ -251,6 +280,7 @@ If no response after 3 days: ## Review Etiquette ### Do's + - βœ… Be kind and constructive - βœ… Acknowledge time and effort - βœ… Provide specific examples @@ -260,6 +290,7 @@ If no response after 3 days: - βœ… Focus on the code, not the person ### Don'ts + - ❌ Use harsh or dismissive language - ❌ Bikeshed on minor preferences - ❌ Review when tired or frustrated @@ -270,6 +301,7 @@ If no response after 3 days: ## Becoming a Reviewer ### Path to Reviewer + 1. **Contribute regularly**: Submit quality PRs 2. **Participate in discussions**: Share knowledge 3. **Review others' code**: Start with comments @@ -277,6 +309,7 @@ If no response after 3 days: 5. **Get nominated**: By existing committers ### Reviewer Expectations + - Review PRs in your area of expertise - Respond within reasonable time - Mentor new contributors @@ -288,6 +321,7 @@ If no response after 3 days: ### Reviewing Large PRs #### Strategy + 1. **Request splitting**: Ask to break into smaller PRs 2. **Review in phases**: - Architecture/approach first @@ -298,6 +332,7 @@ If no response after 3 days: ### Cross-Team Reviews #### When Needed + - Changes affecting multiple teams - Shared components/libraries - API contract changes @@ -306,6 +341,7 @@ If no response after 3 days: ### Performance Reviews #### Tools + ```python # Backend performance import cProfile @@ -327,11 +363,13 @@ stats.sort_stats('cumulative').print_stats(10) ## Resources ### Internal + - [Coding Guidelines](../guidelines/design-guidelines.md) - [Testing Guide](../testing/overview.md) - [Extension Architecture](../extensions/architecture.md) ### External + - [Google's Code Review Guide](https://google.github.io/eng-practices/review/) - [Best Practices for Code Review](https://smartbear.com/learn/code-review/best-practices-for-peer-code-review/) - [The Art of Readable Code](https://www.oreilly.com/library/view/the-art-of/9781449318482/) diff --git a/docs/developer_docs/contributing/development-setup.md b/docs/developer_docs/contributing/development-setup.md index 1b6227b2597..b7d402df84b 100644 --- a/docs/developer_docs/contributing/development-setup.md +++ b/docs/developer_docs/contributing/development-setup.md @@ -150,6 +150,7 @@ make up ``` This automatically: + - Generates a unique project name from your directory name - Finds available ports (incrementing from 8088, 9000, etc. if already in use) - Displays the assigned URLs before starting @@ -158,16 +159,16 @@ Each clone gets isolated containers and volumes, so you can run them side-by-sid Available commands (run from repo root): -| Command | Description | -|---------|-------------| -| `make up` | Start services (foreground) | -| `make up-detached` | Start services (background) | -| `make down` | Stop all services | -| `make ps` | Show running containers | -| `make logs` | Follow container logs | -| `make ports` | Show assigned URLs and ports | -| `make open` | Open browser to dev server | -| `make nuke` | Stop, remove volumes & local images | +| Command | Description | +| ------------------ | ----------------------------------- | +| `make up` | Start services (foreground) | +| `make up-detached` | Start services (background) | +| `make down` | Stop all services | +| `make ps` | Show running containers | +| `make logs` | Follow container logs | +| `make ports` | Show assigned URLs and ports | +| `make open` | Open browser to dev server | +| `make nuke` | Stop, remove volumes & local images | From a subdirectory, use: `make -C $(git rev-parse --show-toplevel) up` @@ -178,6 +179,7 @@ Always use these commands instead of plain `docker compose down`, which won't kn ## GitHub Codespaces (Cloud Development) GitHub Codespaces provides a complete, pre-configured development environment in the cloud. This is ideal for: + - Quick contributions without local setup - Consistent development environments across team members - Working from devices that can't run Docker locally @@ -324,17 +326,21 @@ You can also run the pre-commit checks manually in various ways: ## Working with LLMs ### Environment Setup + Ensure Docker Compose is running before starting LLM sessions: + ```bash docker compose up ``` Validate your environment: + ```bash curl -f http://localhost:8088/health && echo "βœ… Superset ready" ``` ### LLM Session Best Practices + - Always validate environment setup first using the health checks above - Use focused validation commands: `pre-commit run` (not `--all-files`) - **Read [LLMS.md](https://github.com/apache/superset/blob/master/LLMS.md) first** - Contains comprehensive development guidelines, coding standards, and critical refactor information @@ -346,6 +352,7 @@ curl -f http://localhost:8088/health && echo "βœ… Superset ready" - Follow the TypeScript migration guidelines and avoid deprecated patterns listed in LLMS.md ### Key Development Commands + ```bash # Frontend development cd superset-frontend @@ -646,7 +653,7 @@ If you want to use the same flag in the client code, also add it to the FeatureF ```typescript export enum FeatureFlag { - SCOPED_FILTER = "SCOPED_FILTER", + SCOPED_FILTER = 'SCOPED_FILTER', } ``` @@ -815,6 +822,7 @@ If Jest tests hang with "Jest did not exit one second after the test run has com **To verify if still needed**: Remove the MessageChannel mocking lines and run `npm test -- --shard=4/8`. If tests hang, the workaround is still required. **Future removal conditions**: This workaround can be removed when: + - rc-overflow updates to properly clean up MessagePorts in test environments - Jest updates to handle MessageChannel/MessagePort cleanup better - Ant Design switches away from rc-overflow @@ -959,9 +967,9 @@ VSCode will not stop on breakpoints right away. We've attached to PID 6 however To debug Flask running in POD inside a kubernetes cluster, you'll need to make sure the pod runs as root and is granted the SYS_TRACE capability.These settings should not be used in production environments. ```yaml - securityContext: - capabilities: - add: ["SYS_PTRACE"] +securityContext: + capabilities: + add: ['SYS_PTRACE'] ``` See [set capabilities for a container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container) for more details. diff --git a/docs/developer_docs/contributing/guidelines.md b/docs/developer_docs/contributing/guidelines.md index c62b6d4eca8..e217c66fd40 100644 --- a/docs/developer_docs/contributing/guidelines.md +++ b/docs/developer_docs/contributing/guidelines.md @@ -130,8 +130,8 @@ Triaging goals First, add **Category labels (a.k.a. hash labels)**. Every issue/PR must have one hash label (except spam entry). Labels that begin with `#` defines issue/PR type: -| Label | for Issue | for PR | -| --------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| Label | for Issue | for PR | +| --------------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | `#bug` | Bug report | Bug fix | | `#code-quality` | Describe problem with code, architecture or productivity | Refactor, tests, tooling | | `#feature` | New feature request | New feature implementation | @@ -175,12 +175,14 @@ Should you decide that reverting is desirable, it is the responsibility of the C - **Put the revert through code review:** The revert must be approved by another committer. **Revert liberally to keep `master` stable**: + - Build failures - Test failures - Critical bugs in production - Security vulnerabilities **How to revert**: + 1. Use GitHub's revert button when possible 2. Create a PR with clear explanation 3. Tag the original author @@ -211,11 +213,13 @@ Sentence case: "A dog takes a walk in Paris" - It's the easiest form to distinguish between common and proper nouns **Good examples:** + - "Select a database" - "Create new chart" - "View all dashboards" **Bad examples:** + - "Select a Database" - "Create New Chart" - "View All Dashboards" @@ -240,6 +244,7 @@ Often a product page will have the same title as the objects it contains. In thi - Create custom queries in SQL Lab then create dashboards When writing about UI elements: + - Use **bold** for clickable elements: "Click **Save**" - Use quotes for text fields: 'Enter "My Dashboard" in the name field' - Be specific about element types: button, link, dropdown, etc. @@ -247,6 +252,7 @@ When writing about UI elements: #### **Exceptions to sentence case Only use title case for: + - Product names (Apache Superset) - Proper nouns - Acronyms (SQL, API, CSV) @@ -258,10 +264,12 @@ Only use title case for: ### Python We use: + - **[Ruff](https://docs.astral.sh/ruff/)** for linting and formatting - **[Mypy](http://mypy-lang.org/)** for type checking Python code should: + - Follow PEP 8 - Use type hints for all new code - Use descriptive variable names @@ -336,6 +344,7 @@ def process_data( ``` Use `mypy` to check types: + ```bash mypy superset ``` @@ -343,8 +352,9 @@ mypy superset ### TypeScript We use: + - **ESLint** for linting -- **Prettier** for formatting +- **Oxfmt** for formatting - **TypeScript** strict mode TypeScript is fully supported and is the recommended language for writing all new frontend @@ -353,6 +363,7 @@ appreciated, but not required. Examples of migrating functions/components to Typ found in [#9162](https://github.com/apache/superset/pull/9162) and [#9180](https://github.com/apache/superset/pull/9180). TypeScript code should: + - Avoid `any` types - use proper TypeScript types - Use functional components with hooks for React - Include JSDoc comments for complex functions @@ -360,6 +371,7 @@ TypeScript code should: - Handle errors appropriately Example: + ```typescript interface User { id: number; @@ -411,5 +423,6 @@ Bad: "Fixed stuff" ## Questions? If you have questions about these guidelines, ask in: + - [Slack #development](https://apache-superset.slack.com) - [GitHub Discussions](https://github.com/apache/superset/discussions) diff --git a/docs/developer_docs/contributing/howtos.md b/docs/developer_docs/contributing/howtos.md index 3fc44b50a15..3b4e9639c6c 100644 --- a/docs/developer_docs/contributing/howtos.md +++ b/docs/developer_docs/contributing/howtos.md @@ -68,11 +68,13 @@ Visualization plugins allow you to add custom chart types to Superset. They are ### Creating a simple Hello World viz plugin 1. **Install the Superset Yeoman generator**: + ```bash npm install -g @superset-ui/generator-superset ``` 2. **Create a new plugin**: + ```bash mkdir superset-plugin-chart-hello-world cd superset-plugin-chart-hello-world @@ -80,19 +82,22 @@ yo @superset-ui/superset ``` 3. **Follow the prompts**: + - Package name: `superset-plugin-chart-hello-world` - Chart type: Choose your preferred type - Include storybook: Yes (recommended for development) 4. **Develop your plugin**: -The generator creates a complete plugin structure with TypeScript, React components, and build configuration. + The generator creates a complete plugin structure with TypeScript, React components, and build configuration. 5. **Test your plugin locally**: + ```bash npm run dev ``` 6. **Link to your local Superset**: + ```bash npm link # In your Superset frontend directory: @@ -100,7 +105,7 @@ npm link superset-plugin-chart-hello-world ``` 7. **Import and register in Superset**: -Edit `superset-frontend/src/visualizations/presets/MainPreset.ts` to include your plugin. + Edit `superset-frontend/src/visualizations/presets/MainPreset.ts` to include your plugin. ## Testing @@ -121,7 +126,7 @@ pytest --cov=superset # Run only unit tests pytest tests/unit_tests -# Run only integration tests +# Run only integration tests pytest tests/integration_tests ``` @@ -234,6 +239,7 @@ For debugging the Flask backend: #### Using VS Code 1. Add to `.vscode/launch.json`: + ```json { "version": "0.2.0", @@ -261,9 +267,9 @@ For debugging the Flask backend: To debug Flask running in a POD inside a kubernetes cluster, you'll need to make sure the pod runs as root and is granted the `SYS_PTRACE` capability. These settings should not be used in production environments. ```yaml - securityContext: - capabilities: - add: ["SYS_PTRACE"] +securityContext: + capabilities: + add: ['SYS_PTRACE'] ``` See [set capabilities for a container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container) for more details. @@ -349,7 +355,7 @@ uses Claude AI to generate draft translations for any missing entries. All AI-generated strings are marked `#, fuzzy` and tagged with an attribution comment so that human reviewers know they need to be checked. -Note that `#, fuzzy` marks a translation as *needing review*, not as *withheld*: +Note that `#, fuzzy` marks a translation as _needing review_, not as _withheld_: both the frontend and backend builds serve fuzzy entries (see [Applying translations](#applying-translations) above), so an AI-generated string is shown in the UI as soon as it is built and deployed. Reviewers should verify each @@ -395,6 +401,7 @@ python scripts/translations/backfill_po.py --lang fr --limit 20 --dry-run ``` Output shows each string, its translation, and a context tag: + - No tag β€” 3+ reference languages available (high confidence) - `[ctx:N]` β€” only N other languages have this string (lower confidence) - `[ctx:0]` β€” no other language has this string yet; English alone used @@ -407,15 +414,15 @@ python scripts/translations/backfill_po.py --lang fr Options: -| Flag | Default | Description | -|------|---------|-------------| -| `--lang LANG` | required | ISO language code (`fr`, `de`, `ja`, …) | -| `--batch-size N` | 50 | Strings per Claude request | -| `--limit N` | unlimited | Stop after N entries | -| `--min-context N` | 0 | Skip entries with fewer than N reference translations | -| `--model MODEL` | `claude-sonnet-4-6` | Claude model to use | -| `--dry-run` | off | Print without writing | -| `--no-fuzzy` | off | Don't mark entries as fuzzy | +| Flag | Default | Description | +| ----------------- | ------------------- | ----------------------------------------------------- | +| `--lang LANG` | required | ISO language code (`fr`, `de`, `ja`, …) | +| `--batch-size N` | 50 | Strings per Claude request | +| `--limit N` | unlimited | Stop after N entries | +| `--min-context N` | 0 | Skip entries with fewer than N reference translations | +| `--model MODEL` | `claude-sonnet-4-6` | Claude model to use | +| `--dry-run` | off | Print without writing | +| `--no-fuzzy` | off | Don't mark entries as fuzzy | Use `--min-context 2` to skip strings that have fewer than 2 reference translations in other languages. Those strings are more likely to be ambiguous @@ -488,8 +495,8 @@ npm run check:custom-rules # Run tsc (typescript) checks npm run type -# Format with Prettier -npm run prettier +# Format with Oxfmt +npm run format ``` #### Architecture @@ -519,6 +526,7 @@ The linting system consists of two components: **"Plugin 'basic-custom-plugin' not found" Error** Ensure you're using the explicit config: + ```bash npx oxlint --config oxlint.json ``` @@ -526,6 +534,7 @@ npx oxlint --config oxlint.json **Custom Rules Not Running** Verify the AST parsing dependencies are installed: + ```bash npm ls @babel/parser @babel/traverse glob ``` @@ -544,6 +553,7 @@ For every PR, an ephemeral environment is automatically deployed for testing. Access pattern: `https://pr-{PR_NUMBER}.superset.apache.org` Features: + - Automatically deployed on PR creation/update - Includes sample data - Destroyed when PR is closed @@ -573,6 +583,7 @@ docker compose up **Frontend**: Webpack dev server provides hot module replacement automatically. **Backend**: Use Flask debug mode: + ```bash FLASK_ENV=development superset run -p 8088 --with-threads --reload ``` @@ -580,12 +591,14 @@ FLASK_ENV=development superset run -p 8088 --with-threads --reload ### Performance Profiling For Python profiling: + ```python # In superset_config.py PROFILING = True ``` For React profiling: + - Use React DevTools Profiler - Enable performance marks in Chrome DevTools @@ -683,6 +696,7 @@ To do this, you'll need to: ``` Note that: + - for changes that affect the worker logic, you'll have to restart the `celery worker` process for the changes to be reflected. - The message queue used is a `sqlite` database using the `SQLAlchemy` experimental broker. Ok for testing, but not recommended in production - In some cases, you may want to create a context that is more aligned to your production environment, and use the similar broker as well as results backend configuration diff --git a/docs/developer_docs/contributing/issue-reporting.md b/docs/developer_docs/contributing/issue-reporting.md index 969a1b14757..fdce147379f 100644 --- a/docs/developer_docs/contributing/issue-reporting.md +++ b/docs/developer_docs/contributing/issue-reporting.md @@ -31,6 +31,7 @@ Learn how to effectively report bugs and request features for Apache Superset. ### Pre-Issue Checklist 1. **Search Existing Issues** + ``` Search: https://github.com/apache/superset/issues - Use keywords from your error message @@ -44,6 +45,7 @@ Learn how to effectively report bugs and request features for Apache Superset. - [Configuration Guide](https://superset.apache.org/docs/configuration/configuring-superset) 3. **Verify Version** + ```bash # Check Superset version superset version @@ -63,24 +65,30 @@ Learn how to effectively report bugs and request features for Apache Superset. ```markdown ### Bug Description + A clear and concise description of the bug. ### How to Reproduce + 1. Go to '...' 2. Click on '...' 3. Scroll down to '...' 4. See error ### Expected Behavior + What you expected to happen. ### Actual Behavior + What actually happened. Include error messages. ### Screenshots/Videos + If applicable, add screenshots or recordings. ### Environment + - Superset version: [e.g., 3.0.0] - Python version: [e.g., 3.11.7] - Node version: [e.g., 18.17.0] @@ -89,6 +97,7 @@ If applicable, add screenshots or recordings. - OS: [e.g., Ubuntu 22.04] ### Additional Context + - Using Docker: Yes/No - Configuration overrides: - Feature flags enabled: @@ -98,12 +107,15 @@ If applicable, add screenshots or recordings. ### What Makes a Good Bug Report #### βœ… Good Example + ```markdown ### Bug Description + When filtering a dashboard with a date range filter, charts using SQL Lab datasets don't update, while charts using regular datasets do. ### How to Reproduce + 1. Create a dashboard with 2 charts: - Chart A: Uses a SQL Lab virtual dataset - Chart B: Uses a regular table dataset @@ -112,18 +124,22 @@ SQL Lab datasets don't update, while charts using regular datasets do. 4. Chart B updates, Chart A shows no change ### Expected Behavior + Both charts should filter to show last 30 days of data. ### Actual Behavior + Only Chart B updates. Chart A still shows all data. No error messages in browser console or server logs. ### Screenshots + [Dashboard before filter]: attachment1.png [Dashboard after filter]: attachment2.png [Network tab showing requests]: attachment3.png ### Environment + - Superset version: 3.0.0 - Python version: 3.11.16 - Database: PostgreSQL 14.9 @@ -132,6 +148,7 @@ No error messages in browser console or server logs. ``` #### ❌ Poor Example + ```markdown Dashboard filters don't work. Please fix. ``` @@ -139,6 +156,7 @@ Dashboard filters don't work. Please fix. ### Required Information #### Error Messages + ```python # Include full error traceback Traceback (most recent call last): @@ -148,6 +166,7 @@ SupersetException: Detailed error message ``` #### Logs + ```bash # Backend logs docker logs superset_app 2>&1 | tail -100 @@ -157,6 +176,7 @@ tail -f ~/.superset/superset.log ``` #### Browser Console + ```javascript // Include JavaScript errors // Chrome: F12 β†’ Console tab @@ -165,6 +185,7 @@ tail -f ~/.superset/superset.log ``` #### Configuration + ```python # Relevant config from superset_config.py FEATURE_FLAGS = { @@ -179,18 +200,23 @@ FEATURE_FLAGS = { ```markdown ### Is your feature request related to a problem? + A clear description of the problem you're trying to solve. ### Describe the solution you'd like + A clear description of what you want to happen. ### Describe alternatives you've considered + Other solutions or features you've considered. ### Additional context + Any other context, mockups, or examples. ### Are you willing to contribute? + - [ ] Yes, I can implement this feature - [ ] Yes, I can help test - [ ] No, but I can provide feedback @@ -199,6 +225,7 @@ Any other context, mockups, or examples. ### Good Feature Requests Include 1. **Clear Use Case** + ```markdown As a [type of user], I want [feature] so that [benefit]. @@ -224,6 +251,7 @@ Any other context, mockups, or examples. **DO NOT** create public issues for security vulnerabilities! Instead: + 1. Email: security@apache.org 2. Subject: `[Superset] Security Vulnerability` 3. Include: @@ -238,9 +266,11 @@ Instead: Send to: security@apache.org ### Vulnerability Description + [Describe the security issue] ### Type + - [ ] SQL Injection - [ ] XSS - [ ] CSRF @@ -249,27 +279,33 @@ Send to: security@apache.org - [ ] Other: [specify] ### Affected Versions + [List affected versions] ### Steps to Reproduce + [Detailed steps - be specific] ### Impact + [What can an attacker do?] ### Suggested Fix + [If you have suggestions] ``` ## Issue Labels ### Priority Labels + - `P0`: Critical - System unusable - `P1`: High - Major feature broken - `P2`: Medium - Important but workaround exists - `P3`: Low - Nice to have ### Type Labels + - `bug`: Something isn't working - `feature`: New feature request - `enhancement`: Improvement to existing feature @@ -277,6 +313,7 @@ Send to: security@apache.org - `question`: Question about usage ### Component Labels + - `dashboard`: Dashboard functionality - `sqllab`: SQL Lab - `explore`: Chart builder @@ -285,6 +322,7 @@ Send to: security@apache.org - `security`: Security related ### Status Labels + - `needs-triage`: Awaiting review - `confirmed`: Bug confirmed - `in-progress`: Being worked on @@ -294,25 +332,30 @@ Send to: security@apache.org ## Issue Lifecycle ### 1. Creation + - User creates issue with template - Auto-labeled as `needs-triage` ### 2. Triage + - Maintainer reviews within 7 days - Labels applied (priority, type, component) - Questions asked if needed ### 3. Confirmation + - Bug reproduced or feature discussed - Label changed to `confirmed` - Assigned to milestone if applicable ### 4. Development + - Contributor claims issue - Label changed to `in-progress` - PR linked to issue ### 5. Resolution + - PR merged - Issue auto-closed - Or manually closed with explanation @@ -322,6 +365,7 @@ Send to: security@apache.org ### If No Response After 7 days without response: + ```markdown @apache/superset-committers This issue hasn't been triaged yet. Could someone please take a look? @@ -343,6 +387,7 @@ Here's additional debugging information: [details] ## Tips for Success ### Do's + - βœ… Search before creating - βœ… Use templates - βœ… Provide complete information @@ -352,6 +397,7 @@ Here's additional debugging information: [details] - βœ… One issue per report ### Don'ts + - ❌ "+1" or "me too" comments (use reactions) - ❌ Multiple issues in one report - ❌ Vague descriptions @@ -410,6 +456,7 @@ with app.app_context(): ### Issue Not a Bug? Consider: + - **Feature Request**: Use feature request template - **Question**: Use GitHub Discussions - **Configuration Help**: Ask in Slack diff --git a/docs/developer_docs/contributing/overview.md b/docs/developer_docs/contributing/overview.md index d0e6c5ba659..465f26d5295 100644 --- a/docs/developer_docs/contributing/overview.md +++ b/docs/developer_docs/contributing/overview.md @@ -146,7 +146,7 @@ Security team members must: - Have an [ICLA](https://www.apache.org/licenses/contributor-agreements.html) signed with Apache Software Foundation. - Not reveal information about pending and unfixed security issues to anyone (including their employers) unless specifically authorised by the security team members, e.g., if the security team agrees that diagnosing and solving an issue requires the involvement of external experts. -A release manager, the contributor overseeing the release of a specific version of Apache Superset, is by default a member of the security team. However, they are not expected to be active in assessing, discussing, and fixing security issues. +A release manager, the contributor overseeing the release of a specific version of Apache Superset, is by default a member of the security team. However, they are not expected to be active in assessing, discussing, and fixing security issues. Security team members should also follow these general expectations: diff --git a/docs/developer_docs/contributing/pkg-resources-migration.md b/docs/developer_docs/contributing/pkg-resources-migration.md index 7300b14bc42..bcbe8d36a97 100644 --- a/docs/developer_docs/contributing/pkg-resources-migration.md +++ b/docs/developer_docs/contributing/pkg-resources-migration.md @@ -61,6 +61,7 @@ Update all dependencies to use `importlib.metadata` instead of `pkg_resources`: #### Migration Example **Old (deprecated):** + ```python import pkg_resources @@ -69,6 +70,7 @@ entry_points = pkg_resources.iter_entry_points("group_name") ``` **New (recommended):** + ```python from importlib.metadata import version, entry_points @@ -79,11 +81,13 @@ eps = entry_points(group="group_name") ## Action Items ### For Superset Maintainers + 1. The Superset codebase already uses `importlib.metadata` 2. Monitor third-party dependencies for updates 3. Update setuptools pin once the ecosystem is ready ### For Extension Developers + 1. **Update your packages** to use `importlib.metadata` instead of `pkg_resources` 2. **Test with setuptools >= 81.0.0** once all packages are migrated diff --git a/docs/developer_docs/contributing/release-process.md b/docs/developer_docs/contributing/release-process.md index c0664cb0140..dfa1bd6f740 100644 --- a/docs/developer_docs/contributing/release-process.md +++ b/docs/developer_docs/contributing/release-process.md @@ -29,6 +29,7 @@ Understand Apache Superset's release process, versioning strategy, and how to pa ## Release Cadence ### Schedule + - **Major releases (X.0.0)**: Annually (approximately) - **Minor releases (X.Y.0)**: Quarterly - **Patch releases (X.Y.Z)**: As needed for critical fixes @@ -46,6 +47,7 @@ MAJOR.MINOR.PATCH ``` ### Examples + - `3.0.0`: Major release with breaking changes - `3.1.0`: Minor release with new features - `3.1.1`: Patch release with bug fixes @@ -55,12 +57,14 @@ MAJOR.MINOR.PATCH ### Major Releases (X.0.0) #### Includes + - Breaking API changes - Deprecated feature removals - Major architectural changes - Database migration requirements #### Process + - 2-3 month preparation period - Multiple release candidates (RC) - Extensive testing period @@ -69,12 +73,14 @@ MAJOR.MINOR.PATCH ### Minor Releases (X.Y.0) #### Includes + - New features - Performance improvements - Non-breaking API additions - Minor UI/UX updates #### Process + - 1 month preparation - 1-2 release candidates - Standard testing period @@ -82,12 +88,14 @@ MAJOR.MINOR.PATCH ### Patch Releases (X.Y.Z) #### Includes + - Bug fixes - Security patches - Documentation fixes - Dependency updates (security) #### Process + - Fast track for critical issues - May skip RC for urgent security fixes - Minimal testing requirements @@ -97,6 +105,7 @@ MAJOR.MINOR.PATCH ### 1. Pre-Release Preparation #### Feature Freeze + ```bash # Create release branch git checkout -b release-X.Y @@ -108,40 +117,49 @@ VERSION = "X.Y.0rc1" ``` #### Update Documentation + - CHANGELOG.md - UPDATING.md (for breaking changes) - Documentation version #### Release Notes Template + ```markdown # Apache Superset X.Y.0 ## πŸŽ‰ Highlights + - Major feature 1 - Major feature 2 ## πŸš€ New Features + - Feature 1 (#PR) - Feature 2 (#PR) ## πŸ› Bug Fixes + - Fix 1 (#PR) - Fix 2 (#PR) ## ⚠️ Breaking Changes + - Breaking change 1 - Migration required for X ## πŸ“ Documentation + - Doc update 1 (#PR) ## πŸ™ Thank You + Thanks to all contributors! ``` ### 2. Create Release Candidate #### Build RC + ```bash # Tag release candidate git tag -a vX.Y.Zrc1 -m "Apache Superset X.Y.Z RC1" @@ -158,6 +176,7 @@ gpg --armor --detach-sig dist/apache-superset-X.Y.Zrc1.tar.gz ``` #### Upload to staging + ```bash # Upload to Apache staging svn co https://dist.apache.org/repos/dist/dev/superset @@ -202,11 +221,13 @@ Thanks, ``` #### Voting Rules + - **Duration**: Minimum 72 hours - **Required**: 3 +1 votes from PMC members - **Veto**: Any -1 vote must be addressed #### Testing Checklist + ```markdown - [ ] Source builds successfully - [ ] Docker image builds @@ -219,6 +240,7 @@ Thanks, ### 4. Release Approval #### Tally Votes + ``` Subject: [RESULT][VOTE] Release Apache Superset X.Y.Z RC1 @@ -245,6 +267,7 @@ Thank you to everyone who tested and voted! ### 5. Perform Release #### Promote RC to Release + ```bash # Tag final release git tag -a vX.Y.Z -m "Apache Superset X.Y.Z" @@ -256,12 +279,14 @@ svn mv https://dist.apache.org/repos/dist/dev/superset/X.Y.Zrc1 \ ``` #### Publish to PyPI + ```bash # Upload to PyPI python -m twine upload dist/*X.Y.Z* ``` #### Build Docker Images + ```bash # Build and push Docker images docker build -t apache/superset:X.Y.Z . @@ -273,6 +298,7 @@ docker push apache/superset:latest ### 6. Post-Release Tasks #### Update Documentation + ```bash # Update docs version cd docs @@ -310,6 +336,7 @@ The Apache Superset Team ``` #### Update GitHub Release + ```bash # Create GitHub release gh release create vX.Y.Z \ @@ -322,12 +349,14 @@ gh release create vX.Y.Z \ ### During Feature Freeze #### What's Allowed + - βœ… Bug fixes - βœ… Documentation updates - βœ… Test improvements - βœ… Security fixes #### What's Not Allowed + - ❌ New features - ❌ Major refactoring - ❌ Breaking changes @@ -336,6 +365,7 @@ gh release create vX.Y.Z \ ### Testing RCs #### How to Test + ```bash # Install RC from staging pip install https://dist.apache.org/repos/dist/dev/superset/X.Y.Zrc1/apache-superset-X.Y.Zrc1.tar.gz @@ -345,6 +375,7 @@ docker pull apache/superset:X.Y.Zrc1 ``` #### What to Test + - Your use cases - New features mentioned in release notes - Upgrade from previous version @@ -352,8 +383,10 @@ docker pull apache/superset:X.Y.Zrc1 - Critical workflows #### Reporting Issues + ```markdown Found issue in RC1: + - Description: [what's wrong] - Steps to reproduce: [how to trigger] - Impact: [blocker/major/minor] @@ -363,21 +396,26 @@ Found issue in RC1: ### CHANGELOG Maintenance #### Format + ```markdown ## X.Y.Z (YYYY-MM-DD) ### Features + - feat: Description (#PR_NUMBER) ### Fixes + - fix: Description (#PR_NUMBER) ### Breaking Changes + - BREAKING: Description (#PR_NUMBER) Migration: Steps to migrate ``` #### Generating CHANGELOG + ```bash # Use git log to generate initial list git log --oneline vX.Y-1.Z..vX.Y.Z | grep -E "^[a-f0-9]+ (feat|fix|perf|refactor|docs)" @@ -390,31 +428,38 @@ git log --oneline vX.Y-1.Z..vX.Y.Z | grep -E "^[a-f0-9]+ (feat|fix|perf|refactor ### Documentation Required #### UPDATING.md Entry -```markdown + +````markdown # X.Y.Z ## Breaking Change: [Title] ### Description + What changed and why. ### Before + ```python # Old way old_function(param1, param2) ``` +```` ### After + ```python # New way new_function(param1, param2, param3) ``` ### Migration Steps + 1. Update your code to... 2. Run migration script... 3. Test that... -``` + +```` ### Deprecation Process @@ -423,7 +468,7 @@ new_function(param1, param2, param3) @deprecated(version="3.0.0", remove_in="4.0.0") def old_function(): warnings.warn("Use new_function instead", DeprecationWarning) - ``` +```` 2. **Version N+1**: Keep deprecated with warnings @@ -432,12 +477,14 @@ new_function(param1, param2, param3) ## Security Releases ### Expedited Process + - No RC required for critical security fixes - Coordinate with security@apache.org - Embargo period may apply - CVE assignment through ASF security team ### Security Advisory Template + ```markdown CVE-YYYY-XXXXX: [Title] @@ -458,11 +505,13 @@ Credit: ## Resources ### Internal + - [Apache Release Policy](https://www.apache.org/legal/release-policy.html) - [Superset Release History](https://github.com/apache/superset/releases) - [Version Strategy Discussion](https://github.com/apache/superset/discussions) ### Tools + - [Release Scripts](https://github.com/apache/superset/tree/master/scripts/release) - [Superset Repository Scripts](https://github.com/apache/superset/tree/master/scripts) diff --git a/docs/developer_docs/contributing/resources.md b/docs/developer_docs/contributing/resources.md index bd159c984f0..ffd9380b0cb 100644 --- a/docs/developer_docs/contributing/resources.md +++ b/docs/developer_docs/contributing/resources.md @@ -117,16 +117,19 @@ You can also [download the .svg](https://github.com/apache/superset/tree/master/ ## Additional Resources ### Official Documentation + - [Apache Superset Documentation](https://superset.apache.org/docs/intro) - [API Documentation](https://superset.apache.org/docs/api) - [Configuration Guide](https://superset.apache.org/admin-docs/configuration/configuring-superset) ### Community Resources + - [Apache Superset Blog](https://preset.io/blog/) - [YouTube Channel](https://www.youtube.com/channel/UCMuwrvBsg_jjI2gLcm04R0g) - [Twitter/X](https://twitter.com/ApacheSuperset) ### Development Tools + - [GitHub Repository](https://github.com/apache/superset) - [PyPI Package](https://pypi.org/project/apache-superset/) - [Docker Hub](https://hub.docker.com/r/apache/superset) diff --git a/docs/developer_docs/contributing/submitting-pr.md b/docs/developer_docs/contributing/submitting-pr.md index 4836aa47f63..4cba6bef9ea 100644 --- a/docs/developer_docs/contributing/submitting-pr.md +++ b/docs/developer_docs/contributing/submitting-pr.md @@ -29,12 +29,14 @@ Learn how to create and submit high-quality pull requests to Apache Superset. ## Before You Start ### Prerequisites + - [ ] Development environment is set up - [ ] You've forked and cloned the repository - [ ] You've read the [contributing overview](./overview.md) - [ ] You've found or created an issue to work on ### PR Readiness Checklist + - [ ] Code follows [coding guidelines](../guidelines/design-guidelines.md) - [ ] Tests are passing locally - [ ] Linting passes (`pre-commit run --all-files`) @@ -82,6 +84,7 @@ type(scope): description ``` **Types:** + - `feat`: New feature - `fix`: Bug fix - `docs`: Documentation only @@ -95,6 +98,7 @@ type(scope): description - `revert`: Reverting changes **Scopes:** + - `dashboard`: Dashboard functionality - `sqllab`: SQL Lab features - `explore`: Chart explorer @@ -105,6 +109,7 @@ type(scope): description - `config`: Configuration **Examples:** + ``` feat(sqllab): add query cost estimation fix(dashboard): resolve filter cascading issue @@ -119,23 +124,28 @@ Use the template from `.github/PULL_REQUEST_TEMPLATE.md`: ```markdown ### SUMMARY + Brief description of changes and motivation. ### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF + [Required for UI changes] ### TESTING INSTRUCTIONS + 1. Step-by-step instructions 2. How to verify the fix/feature 3. Any specific test scenarios ### ADDITIONAL INFORMATION + - [ ] Has associated issue: #12345 - [ ] Required feature flags: - [ ] API changes: - [ ] DB migration required: ### CHECKLIST + - [ ] CI checks pass - [ ] Tests added/updated - [ ] Documentation updated @@ -158,11 +168,13 @@ gh pr create --title "feat(sqllab): add query cost estimation" \ ## PR Best Practices ### Keep PRs Focused + - One feature/fix per PR - Break large changes into smaller PRs - Separate refactoring from feature changes ### Write Good Commit Messages + ```bash # Good git commit -m "fix(dashboard): prevent duplicate API calls when filters change" @@ -173,6 +185,7 @@ git commit -m "updates" ``` ### Include Tests + ```python # Backend test example def test_new_feature(): @@ -190,15 +203,19 @@ test('renders new component', () => { ``` ### Add Screenshots for UI Changes + ```markdown ### Before + ![Before](link-to-before-screenshot) -### After +### After + ![After](link-to-after-screenshot) ``` ### Update Documentation + - Update relevant docs in `/docs` directory - Add docstrings to new functions/classes - Update UPDATING.md for breaking changes @@ -206,7 +223,9 @@ test('renders new component', () => { ## CI Checks ### Required Checks + All PRs must pass: + - `Python Tests` - Backend unit/integration tests - `Frontend Tests` - JavaScript/TypeScript tests - `Linting` - Code style checks @@ -217,6 +236,7 @@ All PRs must pass: ### Common CI Failures #### Python Test Failures + ```bash # Run locally to debug pytest tests/unit_tests/ -v @@ -224,12 +244,14 @@ pytest tests/integration_tests/ -v ``` #### Frontend Test Failures + ```bash cd superset-frontend npm run test -- --coverage ``` #### Linting Failures + ```bash # Auto-fix many issues pre-commit run --all-files @@ -243,6 +265,7 @@ pre-commit run --all-files ## Responding to Reviews ### Address Feedback Promptly + ```bash # Make requested changes edit files... @@ -254,11 +277,13 @@ git push origin feature/your-feature-name ``` ### Request Re-review + - Click "Re-request review" after addressing feedback - Comment on resolved discussions - Thank reviewers for their time ### Handling Conflicts + ```bash # Update your branch git fetch upstream @@ -276,6 +301,7 @@ git push --force-with-lease origin feature/your-feature-name ## After Merge ### Clean Up + ```bash # Delete local branch git checkout master @@ -291,6 +317,7 @@ git push origin master ``` ### Follow Up + - Monitor for any issues reported - Help with documentation if needed - Consider related improvements @@ -298,6 +325,7 @@ git push origin master ## Tips for Success ### Do + - βœ… Keep PRs small and focused - βœ… Write descriptive PR titles and descriptions - βœ… Include tests for new functionality @@ -306,6 +334,7 @@ git push origin master - βœ… Be patient with the review process ### Don't + - ❌ Submit PRs with failing tests - ❌ Include unrelated changes - ❌ Force push to master diff --git a/docs/developer_docs/extensions/architecture.md b/docs/developer_docs/extensions/architecture.md index d665f436332..bbaae5519ec 100644 --- a/docs/developer_docs/extensions/architecture.md +++ b/docs/developer_docs/extensions/architecture.md @@ -177,14 +177,14 @@ plugins: [ '@apache-superset/core': { singleton: true, import: false }, }, }), -] +]; ``` This configuration does several important things: **`exposes`** - Declares which modules are available to the host application. Superset always loads extensions by requesting the `./index` module from the remote container β€” this is a fixed convention, not a configurable value. Extensions must expose exactly `'./index': './src/index.tsx'` and place all API registrations (views, commands, menus, editors, event listeners) in that file. The module is executed as a side effect when the extension loads, so any call to `views.registerView`, `commands.registerCommand`, etc. made at the top level of `index.tsx` will run automatically. -**`shared`** - Prevents duplication of common libraries like React and Ant Design, and, for `@apache-superset/core`, is the mechanism that gives each extension an isolated context (see below). The `singleton: true` setting ensures only one *logical* instance of each library exists β€” for `react`/`react-dom`/`antd` that means the host's actual instance is reused; for `@apache-superset/core` it means the extension's container defers to whatever module the host's loader supplies for it at init time, which is not the same object for every extension (see [Runtime Resolution](#runtime-resolution)). +**`shared`** - Prevents duplication of common libraries like React and Ant Design, and, for `@apache-superset/core`, is the mechanism that gives each extension an isolated context (see below). The `singleton: true` setting ensures only one _logical_ instance of each library exists β€” for `react`/`react-dom`/`antd` that means the host's actual instance is reused; for `@apache-superset/core` it means the extension's container defers to whatever module the host's loader supplies for it at init time, which is not the same object for every extension (see [Runtime Resolution](#runtime-resolution)). ### Runtime Resolution diff --git a/docs/developer_docs/extensions/components/alert.mdx b/docs/developer_docs/extensions/components/alert.mdx index 8c42c821160..296a6f120f1 100644 --- a/docs/developer_docs/extensions/components/alert.mdx +++ b/docs/developer_docs/extensions/components/alert.mdx @@ -34,45 +34,40 @@ Alert component for displaying important messages to users. Wraps Ant Design Ale ## Try It @@ -95,13 +90,13 @@ function Demo() { ## 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."` | Message | -| `description` | `string` | `"Sample description for additional context."` | Description | -| `showIcon` | `boolean` | `true` | Whether to display an icon in the Alert. | +| 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."` | Message | +| `description` | `string` | `"Sample description for additional context."` | Description | +| `showIcon` | `boolean` | `true` | Whether to display an icon in the Alert. | ## Usage in Extensions @@ -112,11 +107,7 @@ import { Alert } from '@apache-superset/core/components'; function MyExtension() { return ( - + ); } ``` @@ -128,4 +119,4 @@ function MyExtension() { --- -*This page was auto-generated from the component's Storybook story.* +_This page was auto-generated from the component's Storybook story._ diff --git a/docs/developer_docs/extensions/components/index.mdx b/docs/developer_docs/extensions/components/index.mdx index 0786fd0c801..715e8dd4fbb 100644 --- a/docs/developer_docs/extensions/components/index.mdx +++ b/docs/developer_docs/extensions/components/index.mdx @@ -39,11 +39,7 @@ All components are exported from the `@apache-superset/core/components` package: import { Alert } from '@apache-superset/core/components'; export function MyExtensionPanel() { - return ( - - Welcome to my extension! - - ); + return Welcome to my extension!; } ``` @@ -68,7 +64,7 @@ export default { }, }; -export const InteractiveMyComponent = (args) => ; +export const InteractiveMyComponent = args => ; InteractiveMyComponent.args = { variant: 'primary', diff --git a/docs/developer_docs/extensions/contribution-types.md b/docs/developer_docs/extensions/contribution-types.md index f339fc01949..e143c570dbd 100644 --- a/docs/developer_docs/extensions/contribution-types.md +++ b/docs/developer_docs/extensions/contribution-types.md @@ -169,6 +169,7 @@ from .api import MyExtensionAPI - **Host context**: `/api/v1/` with original ID For an extension with publisher `my-org` and name `dataset-tools`, the endpoint above would be accessible at: + ``` /extensions/my-org/dataset-tools/hello ``` diff --git a/docs/developer_docs/extensions/dependencies.md b/docs/developer_docs/extensions/dependencies.md index a061028f8d7..43eddcbec8e 100644 --- a/docs/developer_docs/extensions/dependencies.md +++ b/docs/developer_docs/extensions/dependencies.md @@ -34,10 +34,10 @@ Extensions run in the same context as Superset during runtime. This means extens The core packages follow [semantic versioning](https://semver.org/) and provide stable, documented APIs: -| Package | Language | Description | -|---------|----------|-------------| +| Package | Language | Description | +| ----------------------- | --------------------- | -------------------------------------------------- | | `@apache-superset/core` | JavaScript/TypeScript | Frontend APIs, UI components, hooks, and utilities | -| `apache-superset-core` | Python | Backend APIs, models, DAOs, and utilities | +| `apache-superset-core` | Python | Backend APIs, models, DAOs, and utilities | **Benefits of using core packages:** @@ -116,12 +116,14 @@ Abstracting libraries like React or SQLAlchemy would: Extension developers should depend on and use core libraries directly: **Frontend (examples):** + - [React](https://react.dev/) - UI framework - [Ant Design](https://ant.design/) - UI component library (prefer Superset components from `@apache-superset/core/components` when available to preserve visual consistency) - [Emotion](https://emotion.sh/) - CSS-in-JS styling - ... **Backend (examples):** + - [SQLAlchemy](https://www.sqlalchemy.org/) - Database toolkit - [Flask](https://flask.palletsprojects.com/) - Web framework - [Flask-AppBuilder](https://flask-appbuilder.readthedocs.io/) - Application framework diff --git a/docs/developer_docs/extensions/deployment.md b/docs/developer_docs/extensions/deployment.md index 7718777266f..30e962d6eb4 100644 --- a/docs/developer_docs/extensions/deployment.md +++ b/docs/developer_docs/extensions/deployment.md @@ -35,7 +35,7 @@ Packaging is handled by the `superset-extensions bundle` command, which: To deploy an extension, place the `.supx` file in the extensions directory configured via `EXTENSIONS_PATH` in your `superset_config.py`: -``` python +```python EXTENSIONS_PATH = "/path/to/extensions" ``` diff --git a/docs/developer_docs/extensions/development.md b/docs/developer_docs/extensions/development.md index 939b1f2d846..b71fc5334f4 100644 --- a/docs/developer_docs/extensions/development.md +++ b/docs/developer_docs/extensions/development.md @@ -80,6 +80,7 @@ dataset-references/ ``` **Note**: With publisher `my-org` and name `dataset-references`, the technical names are: + - Directory name: `dataset-references` (kebab-case) - Backend Python namespace: `my_org.dataset_references` - Backend distribution package: `my_org-dataset_references` diff --git a/docs/developer_docs/extensions/extension-points/chat.md b/docs/developer_docs/extensions/extension-points/chat.md index e99b7979d78..6faf493d2a2 100644 --- a/docs/developer_docs/extensions/extension-points/chat.md +++ b/docs/developer_docs/extensions/extension-points/chat.md @@ -30,19 +30,19 @@ Extensions can add a chat interface to Superset by registering a trigger and a p A chat registration consists of two React components: -| Component | Role | -|-----------|------| +| Component | Role | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | **Trigger** | Always-visible entry point (e.g., a floating button). Rendered in the bottom-right corner in floating mode, or as a fixed overlay in panel mode. | -| **Panel** | The chat UI itself (message list, input, etc.). Mounted by the host in the active display mode. | +| **Panel** | The chat UI itself (message list, input, etc.). Mounted by the host in the active display mode. | ## Display Modes The host supports two display modes, switchable by the user or the extension at runtime: -| Mode | Behavior | -|------|----------| -| `floating` | Panel floats above page content, anchored to the bottom-right corner. | -| `panel` | Panel is docked to the right side of the application as a resizable sidebar, sitting beside the page content. | +| Mode | Behavior | +| ---------- | ------------------------------------------------------------------------------------------------------------- | +| `floating` | Panel floats above page content, anchored to the bottom-right corner. | +| `panel` | Panel is docked to the right side of the application as a resizable sidebar, sitting beside the page content. | The user's last selected mode and open/closed state are persisted across page reloads. @@ -107,7 +107,11 @@ export default function ChatPanel() { return (
    - {/* message list and input */} @@ -120,20 +124,20 @@ export default function ChatPanel() { All methods are available on the `chat` namespace from `@apache-superset/core`: -| Method / Event | Description | -|----------------|-------------| -| `registerChat(descriptor, trigger, panel)` | Register a chat extension. Returns a `Disposable` to unregister. | -| `open()` | Open the chat panel. No-op if already open or no registration. | -| `close()` | Close the chat panel. | -| `isOpen()` | Returns `true` if the panel is currently open. | -| `getDisplayMode()` | Returns the current display mode (`'floating'` or `'panel'`). | -| `setDisplayMode(mode)` | Switch between `'floating'` and `'panel'` mode. | -| `onDidOpen(listener)` | Subscribe to panel open events. Returns a `Disposable`. | -| `onDidClose(listener)` | Subscribe to panel close events. Returns a `Disposable`. | -| `onDidChangeDisplayMode(listener)` | Subscribe to display mode changes. Returns a `Disposable`. | -| `onDidRegisterChat(listener)` | Subscribe to registration events. | -| `onDidUnregisterChat(listener)` | Subscribe to unregistration events. | -| `onDidResizePanel(listener)` | Subscribe to panel resize events (panel mode only). Not all hosts provide a resizer β€” do not rely on this firing. Returns a `Disposable`. | +| Method / Event | Description | +| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `registerChat(descriptor, trigger, panel)` | Register a chat extension. Returns a `Disposable` to unregister. | +| `open()` | Open the chat panel. No-op if already open or no registration. | +| `close()` | Close the chat panel. | +| `isOpen()` | Returns `true` if the panel is currently open. | +| `getDisplayMode()` | Returns the current display mode (`'floating'` or `'panel'`). | +| `setDisplayMode(mode)` | Switch between `'floating'` and `'panel'` mode. | +| `onDidOpen(listener)` | Subscribe to panel open events. Returns a `Disposable`. | +| `onDidClose(listener)` | Subscribe to panel close events. Returns a `Disposable`. | +| `onDidChangeDisplayMode(listener)` | Subscribe to display mode changes. Returns a `Disposable`. | +| `onDidRegisterChat(listener)` | Subscribe to registration events. | +| `onDidUnregisterChat(listener)` | Subscribe to unregistration events. | +| `onDidResizePanel(listener)` | Subscribe to panel resize events (panel mode only). Not all hosts provide a resizer β€” do not rely on this firing. Returns a `Disposable`. | ## Next Steps diff --git a/docs/developer_docs/extensions/extension-points/editors.md b/docs/developer_docs/extensions/extension-points/editors.md index aff1156b3ff..0aecfd4ee9f 100644 --- a/docs/developer_docs/extensions/extension-points/editors.md +++ b/docs/developer_docs/extensions/extension-points/editors.md @@ -30,16 +30,16 @@ Extensions can replace Superset's default text editors with custom implementatio Superset uses text editors in various places throughout the application: -| Language | Locations | -|----------|-----------| -| `sql` | SQL Lab, Metric/Filter Popovers | -| `json` | Dashboard Properties, Annotation Modal, Theme Modal | -| `css` | Dashboard Properties, CSS Template Modal | -| `markdown` | Dashboard Markdown component | -| `yaml` | Template Params Editor | -| `javascript` | Custom JavaScript editor contexts | -| `python` | Custom Python editor contexts | -| `text` | Plain text editor contexts | +| Language | Locations | +| ------------ | --------------------------------------------------- | +| `sql` | SQL Lab, Metric/Filter Popovers | +| `json` | Dashboard Properties, Annotation Modal, Theme Modal | +| `css` | Dashboard Properties, CSS Template Modal | +| `markdown` | Dashboard Markdown component | +| `yaml` | Template Params Editor | +| `javascript` | Custom JavaScript editor contexts | +| `python` | Custom Python editor contexts | +| `text` | Plain text editor contexts | By registering an editor for a language, your extension replaces the default Ace editor in **all** locations that use that language. @@ -170,7 +170,7 @@ Superset passes keyboard shortcuts via the `hotkeys` prop. Each hotkey includes ```typescript interface EditorHotkey { name: string; - key: string; // e.g., "Ctrl-Enter", "Alt-Shift-F" + key: string; // e.g., "Ctrl-Enter", "Alt-Shift-F" description?: string; exec: (handle: EditorHandle) => void; } @@ -185,9 +185,9 @@ Superset passes static autocomplete suggestions via the `keywords` prop. These i ```typescript interface EditorKeyword { name: string; - value?: string; // Text to insert (defaults to name) - meta?: string; // Category like "table", "column", "function" - score?: number; // Sorting priority + value?: string; // Text to insert (defaults to name) + meta?: string; // Category like "table", "column", "function" + score?: number; // Sorting priority } ``` diff --git a/docs/developer_docs/extensions/extension-points/sqllab.md b/docs/developer_docs/extensions/extension-points/sqllab.md index 959e89fa3ae..ae6405d58c9 100644 --- a/docs/developer_docs/extensions/extension-points/sqllab.md +++ b/docs/developer_docs/extensions/extension-points/sqllab.md @@ -106,7 +106,11 @@ This example adds primary, secondary, and context actions to the editor: import { commands, menus, sqlLab } from '@apache-superset/core'; commands.registerCommand( - { id: 'my-extension.format', title: 'Format Query', icon: 'FormatPainterOutlined' }, + { + id: 'my-extension.format', + title: 'Format Query', + icon: 'FormatPainterOutlined', + }, async () => { const tab = sqlLab.getCurrentTab(); if (tab) { diff --git a/docs/developer_docs/extensions/mcp.md b/docs/developer_docs/extensions/mcp.md index 5fa7e6b41a0..ef422b9ce05 100644 --- a/docs/developer_docs/extensions/mcp.md +++ b/docs/developer_docs/extensions/mcp.md @@ -33,9 +33,11 @@ Model Context Protocol (MCP) integration allows extensions to register custom AI MCP enables extensions to extend Superset's AI capabilities in two ways: ### MCP Tools + Tools are Python functions that AI agents can call to perform specific tasks. They provide executable functionality that extends Superset's capabilities. **Examples of MCP tools:** + - Data processing and transformation functions - Custom analytics calculations - Integration with external APIs @@ -43,9 +45,11 @@ Tools are Python functions that AI agents can call to perform specific tasks. Th - Business-specific operations ### MCP Prompts + Prompts provide interactive guidance and context to AI agents. They help agents understand how to better assist users with specific workflows or domain knowledge. **Examples of MCP prompts:** + - Step-by-step workflow guidance - Domain-specific context and knowledge - Interactive troubleshooting assistance @@ -76,6 +80,7 @@ This creates a tool that AI agents can call by name. The tool name defaults to t The `@tool` decorator accepts several optional parameters: **Parameter details:** + - **`name`**: Tool identifier (AI agents use this to call your tool) - **`description`**: Explains what the tool does (helps AI agents decide when to use it) - **`tags`**: Categories for organization and discovery @@ -213,6 +218,7 @@ Agent: I generated the number 42 for you. ``` The AI agent sees your tool's: + - **Name**: How to call it - **Description**: What it does and when to use it - **Parameters**: What inputs it expects (from Pydantic schema) @@ -377,18 +383,21 @@ async def troubleshoot_charts(ctx: Context) -> str: ### Prompt Best Practices #### Content Structure + - **Use clear headings** and sections for easy navigation - **Provide actionable steps** rather than just theory - **Include examples** relevant to the user's domain - **Offer next steps** to continue the workflow #### Interactive Design + - **Ask questions** to engage the user - **Provide options** for different scenarios - **Reference specific Superset features** by name - **Link to related tools** when appropriate #### Context Awareness + ```python @prompt("analytics_extension.context_aware_guide") async def context_aware_guide(ctx: Context) -> str: diff --git a/docs/developer_docs/extensions/registry.md b/docs/developer_docs/extensions/registry.md index 9fbdb0f2074..0909698a43f 100644 --- a/docs/developer_docs/extensions/registry.md +++ b/docs/developer_docs/extensions/registry.md @@ -36,9 +36,9 @@ This page serves as a registry of community-created Superset extensions. These e | [SQL Lab Export to Parquet](https://github.com/rusackas/superset-extensions/tree/main/sqllab_parquet) | Export SQL Lab query results directly to Apache Parquet format with Snappy compression. | Evan Rusackas | SQL Lab Export to Parquet | | [SQL Lab Query Comparison](https://github.com/michael-s-molina/superset-extensions/tree/main/query-comparison) | A SQL Lab extension that enables side-by-side comparison of query results across different tabs, with GitHub-style diff visualization showing added/removed rows and columns. | Michael S. Molina | Query Comparison | | [SQL Lab Result Stats](https://github.com/michael-s-molina/superset-extensions/tree/main/result-stats) | A SQL Lab extension that automatically computes statistics for query results, providing type-aware analysis including numeric metrics (min, max, mean, median, std dev), string analysis (length, empty counts), and date range information. | Michael S. Molina | Result Stats | -| [Editor Snippets](https://github.com/michael-s-molina/superset-extensions/tree/main/editor-snippets) | A SQL Lab extension for managing and inserting reusable code snippets into the editor, with server-side persistence per user. | Michael S. Molina | Editor Snippets | +| [Editor Snippets](https://github.com/michael-s-molina/superset-extensions/tree/main/editor-snippets) | A SQL Lab extension for managing and inserting reusable code snippets into the editor, with server-side persistence per user. | Michael S. Molina | Editor Snippets | | [SQL Lab Query Estimator](https://github.com/michael-s-molina/superset-extensions/tree/main/query-estimator) | A SQL Lab panel that analyzes query execution plans to estimate resource impact, detect performance issues like Cartesian products and high-cost operations, and visualize the query plan tree. | Michael S. Molina | Query Estimator | -| [Editors Bundle](https://github.com/michael-s-molina/superset-extensions/tree/main/editors-bundle) | A Superset extension that demonstrates how to provide custom code editors for different languages. This extension showcases the editor contribution system by registering alternative editors that can replace Superset's default Ace editor. | Michael S. Molina | Editors Bundle | +| [Editors Bundle](https://github.com/michael-s-molina/superset-extensions/tree/main/editors-bundle) | A Superset extension that demonstrates how to provide custom code editors for different languages. This extension showcases the editor contribution system by registering alternative editors that can replace Superset's default Ace editor. | Michael S. Molina | Editors Bundle | ## How to Add Your Extension diff --git a/docs/developer_docs/extensions/storage.md b/docs/developer_docs/extensions/storage.md index fdd70160c4d..93c13b07ff0 100644 --- a/docs/developer_docs/extensions/storage.md +++ b/docs/developer_docs/extensions/storage.md @@ -117,7 +117,11 @@ import { extensions } from '@apache-superset/core'; const ctx = extensions.getContext(); // Store with a 5-minute TTL -await ctx.storage.ephemeral.set('job_progress', { pct: 42, status: 'running' }, { ttl: 300 }); +await ctx.storage.ephemeral.set( + 'job_progress', + { pct: 42, status: 'running' }, + { ttl: 300 }, +); // Retrieve const progress = await ctx.storage.ephemeral.get('job_progress'); @@ -155,7 +159,11 @@ import { extensions } from '@apache-superset/core'; const ctx = extensions.getContext(); -await ctx.storage.ephemeral.shared.set('shared_result', { data: [1, 2, 3] }, { ttl: 3600 }); +await ctx.storage.ephemeral.shared.set( + 'shared_result', + { data: [1, 2, 3] }, + { ttl: 3600 }, +); const result = await ctx.storage.ephemeral.shared.get('shared_result'); ``` @@ -198,7 +206,9 @@ import { extensions } from '@apache-superset/core'; const ctx = extensions.getContext(); // Store a saved SQL snippet -await ctx.storage.persistent.set('snippet:top_customers', { sql: 'SELECT ...' }); +await ctx.storage.persistent.set('snippet:top_customers', { + sql: 'SELECT ...', +}); // Retrieve const snippet = await ctx.storage.persistent.get('snippet:top_customers'); @@ -268,7 +278,10 @@ result.entries.forEach(entry => { console.log(result.count); // total matching entries across all pages // Shared (global) scope -const shared = await ctx.storage.persistent.shared.list({ page: 0, pageSize: 10 }); +const shared = await ctx.storage.persistent.shared.list({ + page: 0, + pageSize: 10, +}); ``` ```python diff --git a/docs/developer_docs/extensions/tasks.md b/docs/developer_docs/extensions/tasks.md index c36fa9aaba1..58c00cb2408 100644 --- a/docs/developer_docs/extensions/tasks.md +++ b/docs/developer_docs/extensions/tasks.md @@ -37,6 +37,7 @@ FEATURE_FLAGS = { ``` When GTF is disabled: + - The Task List UI menu item is hidden - The `/api/v1/task/*` endpoints return 404 - Calling or scheduling a `@task`-decorated function raises `GlobalTaskFrameworkDisabledError` @@ -79,10 +80,10 @@ print(task.status) # "success" ### Async vs Sync Execution -| Method | When to Use | -|--------|-------------| -| `.schedule()` | Long-running operations, background processing, when you need to return immediately | -| Direct call | Short operations, when deduplication matters, when you need the result before responding | +| Method | When to Use | +| ------------- | ---------------------------------------------------------------------------------------- | +| `.schedule()` | Long-running operations, background processing, when you need to return immediately | +| Direct call | Short operations, when deduplication matters, when you need the result before responding | Both execution modes provide the same task features: deduplication, progress tracking, cancellation, and visibility in the Task List UI. The difference is whether execution happens in a Celery worker (async) or inline (sync). @@ -100,15 +101,15 @@ PENDING ──→ IN_PROGRESS ────→ SUCCESS └─────────────┴──────────→ ABORTED (user cancel) ``` -| Status | Description | -|--------|-------------| -| `PENDING` | Queued, awaiting execution | -| `IN_PROGRESS` | Executing | -| `ABORTING` | Abort/timeout triggered, abort handlers running | -| `SUCCESS` | Completed successfully | -| `FAILURE` | Failed with error or abort/cleanup handler exception | -| `ABORTED` | Cancelled by user/admin | -| `TIMED_OUT` | Exceeded configured timeout | +| Status | Description | +| ------------- | ---------------------------------------------------- | +| `PENDING` | Queued, awaiting execution | +| `IN_PROGRESS` | Executing | +| `ABORTING` | Abort/timeout triggered, abort handlers running | +| `SUCCESS` | Completed successfully | +| `FAILURE` | Failed with error or abort/cleanup handler exception | +| `ABORTED` | Cancelled by user/admin | +| `TIMED_OUT` | Exceeded configured timeout | ## Context API @@ -139,11 +140,11 @@ Call `update_task()` once per iteration for best performance. Frequent DB writes The `progress` parameter accepts three formats: -| Format | Example | Display | -|--------|---------|---------| +| Format | Example | Display | +| ----------------- | ------------------- | ---------------------- | | `tuple[int, int]` | `progress=(3, 100)` | 3 of 100 (3%) with ETA | -| `float` (0.0-1.0) | `progress=0.5` | 50% with ETA | -| `int` | `progress=42` | 42 processed | +| `float` (0.0-1.0) | `progress=0.5` | 50% with ETA | +| `int` | `progress=42` | 42 processed | :::tip Use the tuple format `(current, total)` whenever possible. It provides the richest information to users: showing both the count and percentage, while still computing ETA automatically. @@ -159,10 +160,10 @@ In the Task List UI, when a payload is defined, an info icon appears in the **De Register handlers to run cleanup logic or respond to abort requests: -| Handler | When it runs | Use case | -|---------|--------------|----------| -| `on_cleanup` | Always (success, failure, abort) | Release resources, close connections | -| `on_abort` | When task is aborted | Set stop flag, cancel external operations | +| Handler | When it runs | Use case | +| ------------ | -------------------------------- | ----------------------------------------- | +| `on_cleanup` | Always (success, failure, abort) | Release resources, close connections | +| `on_abort` | When task is aborted | Set stop flag, cancel external operations | ```python @task @@ -187,6 +188,7 @@ Multiple handlers of the same type execute in LIFO order (last registered runs f **All registered handlers will always be attempted, even if one fails.** This ensures that a failure in one handler doesn't prevent other handlers from running their cleanup logic. For example, if you have three cleanup handlers and the second one throws an exception: + 1. Handler 3 runs βœ“ 2. Handler 2 throws an exception βœ— (logged, but execution continues) 3. Handler 1 runs βœ“ @@ -200,6 +202,7 @@ Write handlers to be independent and self-contained. Don't assume previous handl ## Making Tasks Abortable When users click **Cancel** in the Task List, the system decides whether to **abort** (stop) the task or **unsubscribe** (remove the user from a shared task). Abort occurs when: + - It's a private or system task - It's a shared task and the user is the last subscriber - An admin checks **Force abort** to stop the task for all subscribers @@ -229,6 +232,7 @@ def abortable_task(items: list[str]) -> None: ``` **Key points:** + - Registering `on_abort` marks the task as abortable and starts the abort listener - The abort handler fires automatically when abort is triggered - Use a flag pattern to gracefully stop processing at safe points @@ -283,11 +287,11 @@ The timeout timer starts when the task begins executing (status changes to `IN_P ### Timeout Precedence -| Source | Priority | Example | -|--------|----------|---------| -| `TaskOptions.timeout` | Highest | `options=TaskOptions(timeout=600)` | -| `@task(timeout=...)` | Default | `@task(timeout=300)` | -| Not set | No timeout | Task runs indefinitely | +| Source | Priority | Example | +| --------------------- | ---------- | ---------------------------------- | +| `TaskOptions.timeout` | Highest | `options=TaskOptions(timeout=600)` | +| `@task(timeout=...)` | Default | `@task(timeout=300)` | +| Not set | No timeout | Task runs indefinitely | Call-time options always override decorator defaults, allowing tasks to have sensible defaults while permitting callers to extend or shorten the timeout for specific use cases. @@ -345,11 +349,11 @@ def shared_task(): ... def system_task(): ... ``` -| Scope | Visibility | Cancel Behavior | -|-------|------------|-----------------| -| `PRIVATE` | Creator only | Cancels immediately | -| `SHARED` | All subscribers | Last subscriber cancels; others unsubscribe | -| `SYSTEM` | Admins only | Admin cancels | +| Scope | Visibility | Cancel Behavior | +| --------- | --------------- | ------------------------------------------- | +| `PRIVATE` | Creator only | Cancels immediately | +| `SHARED` | All subscribers | Last subscriber cancels; others unsubscribe | +| `SYSTEM` | Admins only | Admin cancels | ## Task Cleanup @@ -393,11 +397,11 @@ By default, abort detection and sync join-and-wait use database polling. Configu ### TaskContext Methods -| Method | Description | -|--------|-------------| -| `update_task(progress, payload)` | Update progress and/or custom payload | -| `on_cleanup(handler)` | Register cleanup handler | -| `on_abort(handler)` | Register abort handler (makes task abortable) | +| Method | Description | +| -------------------------------- | --------------------------------------------- | +| `update_task(progress, payload)` | Update progress and/or custom payload | +| `on_cleanup(handler)` | Register cleanup handler | +| `on_abort(handler)` | Register abort handler (makes task abortable) | ### TaskOptions @@ -429,6 +433,7 @@ def risky_task() -> None: ``` On failure, the framework records: + - `error_message`: Exception message - `exception_type`: Exception class name - `stack_trace`: Full traceback (visible when `SHOW_STACKTRACE=True`) diff --git a/docs/developer_docs/guidelines/design-guidelines.md b/docs/developer_docs/guidelines/design-guidelines.md index 7bf96b1cca4..93ffceaef8d 100644 --- a/docs/developer_docs/guidelines/design-guidelines.md +++ b/docs/developer_docs/guidelines/design-guidelines.md @@ -40,6 +40,7 @@ Sentence case is predominantly lowercase. Capitalize only the initial character - User input that is reflected in the UI. E.g. a user-named a dashboard tab **Sentence case vs. Title case:** + - Title case: "A Dog Takes a Walk in Paris" - Sentence case: "A dog takes a walk in Paris" @@ -110,12 +111,12 @@ Primary buttons have a fourth style: dropdown. **Purpose:** -| Button Type | Description | -|------------|-------------| -| Primary | Main call to action, just 1 per page not including modals or main headers | -| Secondary | Secondary actions, always in conjunction with a primary | -| Tertiary | For less prominent actions; can be used in isolation or paired with a primary button | -| Destructive | For actions that could have destructive effects on the user's data | +| Button Type | Description | +| ----------- | ------------------------------------------------------------------------------------ | +| Primary | Main call to action, just 1 per page not including modals or main headers | +| Secondary | Secondary actions, always in conjunction with a primary | +| Tertiary | For less prominent actions; can be used in isolation or paired with a primary button | +| Destructive | For actions that could have destructive effects on the user's data | ### Format @@ -173,9 +174,9 @@ In all cases, encountering errors increases user friction and frustration while Select one pattern per error (e.g. do not implement an inline and banner pattern for the same error). -| When the error... | Use... | -|------------------|--------| -| Is directly related to a UI control | Inline error | +| When the error... | Use... | +| --------------------------------------- | ------------ | +| Is directly related to a UI control | Inline error | | Is not directly related to a UI control | Banner error | #### Inline diff --git a/docs/developer_docs/guidelines/frontend-style-guidelines.md b/docs/developer_docs/guidelines/frontend-style-guidelines.md index fa4b43146e9..cb10ff6eef8 100644 --- a/docs/developer_docs/guidelines/frontend-style-guidelines.md +++ b/docs/developer_docs/guidelines/frontend-style-guidelines.md @@ -43,7 +43,7 @@ This is a list of statements that describe how we do frontend development in Sup - We organize our repo so similar files live near each other, and tests are co-located with the files they test. - See: [SIP-61](https://github.com/apache/superset/issues/12098) - We prefer small, easily testable files and components. -- We use OXC (oxlint) and Prettier to automatically fix lint errors and format the code. +- We use OXC (oxlint and oxfmt) to automatically fix lint errors and format the code. - We do not debate code formatting style in PRs, instead relying on automated tooling to enforce it. - If there's not a linting rule, we don't have a rule! - See: [Linting How-Tos](../contributing/howtos.md#typescript--javascript) diff --git a/docs/developer_docs/guidelines/frontend/component-style-guidelines.md b/docs/developer_docs/guidelines/frontend/component-style-guidelines.md index 59b422a0496..aaf05c6cee4 100644 --- a/docs/developer_docs/guidelines/frontend/component-style-guidelines.md +++ b/docs/developer_docs/guidelines/frontend/component-style-guidelines.md @@ -58,21 +58,25 @@ superset-frontend/src/components **Reference naming:** Use `PascalCase` for React components and `camelCase` for component instances **BAD:** + ```jsx import mainNav from './MainNav'; ``` **GOOD:** + ```jsx import MainNav from './MainNav'; ``` **BAD:** + ```jsx const NavItem = ; ``` **GOOD:** + ```jsx const navItem = ; ``` @@ -80,11 +84,13 @@ const navItem = ; **Component naming:** Use the file name as the component name **BAD:** + ```jsx import MainNav from './MainNav/index'; ``` **GOOD:** + ```jsx import MainNav from './MainNav'; ``` @@ -92,11 +98,13 @@ import MainNav from './MainNav'; **Props naming:** Do not use DOM related props for different purposes **BAD:** + ```jsx ``` **GOOD:** + ```jsx ``` @@ -104,23 +112,27 @@ import MainNav from './MainNav'; **Importing dependencies:** Only import what you need **BAD:** + ```jsx -import * as React from "react"; +import * as React from 'react'; ``` **GOOD:** + ```jsx -import React, { useState } from "react"; +import React, { useState } from 'react'; ``` **Default VS named exports:** As recommended by [TypeScript](https://www.typescriptlang.org/docs/handbook/modules.html), "If a module's primary purpose is to house one specific export, then you should consider exporting it as a default export. This makes both importing and actually using the import a little easier". If you're exporting multiple objects, use named exports instead. _As a default export_ + ```jsx import MainNav from './MainNav'; ``` _As a named export_ + ```jsx import { MainNav, SecondaryNav } from './Navbars'; ``` @@ -138,10 +150,10 @@ Validate all props with the correct types. This replaces the need for a run-time ```tsx type HeadingProps = { param: string; -} +}; export default function Heading({ children }: HeadingProps) { - return

    {children}

    + return

    {children}

    ; } ``` @@ -152,7 +164,8 @@ Use `type` for your component props and state. Use `interface` when you want to In order to improve the readability of your code and reduce assumptions, always add default values for non required props, when applicable, for example: ```tsx -const applyDiscount = (price: number, discount = 0.05) => price * (1 - discount); +const applyDiscount = (price: number, discount = 0.05) => + price * (1 - discount); ``` ## Functional components and Hooks diff --git a/docs/developer_docs/guidelines/frontend/emotion-styling-guidelines.md b/docs/developer_docs/guidelines/frontend/emotion-styling-guidelines.md index 7a2352aeb52..388004fd2b5 100644 --- a/docs/developer_docs/guidelines/frontend/emotion-styling-guidelines.md +++ b/docs/developer_docs/guidelines/frontend/emotion-styling-guidelines.md @@ -60,21 +60,21 @@ const StatusThing = styled.div` export const InfoThing = styled(StatusThing)` background: blue; &::before { - content: "ℹ️"; + content: 'ℹ️'; } `; export const WarningThing = styled(StatusThing)` background: orange; &::before { - content: "⚠️"; + content: '⚠️'; } `; export const TerribleThing = styled(StatusThing)` background: red; &::before { - content: "πŸ”₯"; + content: 'πŸ”₯'; } `; ``` @@ -138,14 +138,20 @@ function FakeGlobalNav(props) { const menuItemStyles = css` display: block; border-bottom: 1px solid cadetblue; - font-family: "Comic Sans", cursive; + font-family: 'Comic Sans', cursive; `; return ( ); } @@ -158,21 +164,29 @@ function FakeGlobalNav(props) { By default the `css` prop uses the object syntax with JS style definitions, like so: ```jsx -
    Howdy
    +
    + Howdy +
    ``` But you can use the `css` interpolator as well to get away from icky JS styling syntax. Doesn't this look cleaner? ```jsx -
    Howdy
    +
    + Howdy +
    ``` You might say "whatever… I can read and write JS syntax just fine." Well, that's great. But… let's say you're migrating in some of our legacy LESS styles… now it's copy/paste! Or if you want to migrate to or from `styled` syntax… also copy/paste! @@ -261,9 +275,7 @@ AntD uses a cool trick called compound components. For example, the `Menu` compo Let's say you want to override an AntD component called `Foo`, and have `Foo.Bar` display some custom CSS for the `Bar` compound component. You can do it effectively like so: ```jsx -import { - Foo as AntdFoo, -} from 'antd'; +import { Foo as AntdFoo } from 'antd'; export const StyledBar = styled(AntdFoo.Bar)` border-radius: ${({ theme }) => theme.borderRadius}px; diff --git a/docs/developer_docs/index.md b/docs/developer_docs/index.md index de1a5f39f9d..f7391d24b4a 100644 --- a/docs/developer_docs/index.md +++ b/docs/developer_docs/index.md @@ -29,11 +29,13 @@ Welcome to the Apache Superset Developer Docs - your comprehensive resource for ## Quick Start ### New Contributors + - [Contributing Overview](/developer-docs/contributing/overview) - [Development Setup](/developer-docs/contributing/development-setup) - [Your First PR](/developer-docs/contributing/submitting-pr) ### Extension Development + - [Extension Development](/developer-docs/extensions/development) - [Extension Architecture](/developer-docs/extensions/architecture) - [Quick Start](/developer-docs/extensions/quick-start) @@ -41,17 +43,21 @@ Welcome to the Apache Superset Developer Docs - your comprehensive resource for ## Documentation Sections ### Extensions + Learn how to build powerful extensions that enhance Superset's capabilities. This section covers the extension architecture, development patterns, and deployment strategies. You'll find comprehensive guides on creating frontend contributions, managing extension lifecycles, and understanding security implications. ### Testing + Comprehensive testing strategies for Superset development. This section covers frontend testing with Jest and React Testing Library, backend testing with pytest, end-to-end testing with Playwright, and CI/CD pipeline best practices. ### Contributing to Superset + Everything you need to contribute to the Apache Superset project. This section includes community guidelines, development environment setup, pull request processes, code review workflows, issue reporting guidelines, and Apache release procedures. You'll also find style guidelines for both frontend and backend development. ## Development Resources ### Prerequisites + - **Python**: 3.11 or 3.12 - **Node.js**: 18.x or 20.x - **npm**: 9.x or 10.x @@ -60,6 +66,7 @@ Everything you need to contribute to the Apache Superset project. This section i - **Flask/SQLAlchemy**: For backend development ### Key Technologies + - **Frontend**: React, TypeScript, Ant Design, Redux - **Backend**: Flask, SQLAlchemy, Celery, Redis - **Build Tools**: Webpack, Babel, npm/yarn @@ -69,11 +76,13 @@ Everything you need to contribute to the Apache Superset project. This section i ## Community ### Get Help + - **[Slack](https://apache-superset.slack.com)** - Join #development, #troubleshooting, or #beginners - **[GitHub Discussions](https://github.com/apache/superset/discussions)** - Ask questions and share ideas - **[Mailing Lists](https://lists.apache.org/list.html?dev@superset.apache.org)** - Development discussions ### Contribute + - **[Good First Issues](https://github.com/apache/superset/labels/good%20first%20issue)** - Start here! - **[Help Wanted](https://github.com/apache/superset/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)** - Issues needing help - **[Roadmap](https://github.com/orgs/apache/projects/180)** - See what's planned @@ -81,11 +90,13 @@ Everything you need to contribute to the Apache Superset project. This section i ## Additional Resources ### External Documentation + - **[User Documentation](https://superset.apache.org/docs/intro)** - Using Superset - **[API Documentation](/developer-docs/api)** - REST API reference - **[Configuration Guide](https://superset.apache.org/admin-docs/configuration/configuring-superset)** - Setup and configuration ### Important Files + - **[CLAUDE.md](https://github.com/apache/superset/blob/master/CLAUDE.md)** - LLM development guide - **[UPDATING.md](https://github.com/apache/superset/blob/master/UPDATING.md)** - Breaking changes log @@ -96,6 +107,7 @@ Everything you need to contribute to the Apache Superset project. This section i
    -
    col-12
    +
    + col-12 +
    -
    col-12
    +
    + col-12 +
    -
    col-8
    +
    + col-8 +
    -
    col-8
    +
    + col-8 +
    -
    col-8
    +
    + col-8 +
    ); @@ -117,22 +192,50 @@ function ResponsiveGrid() { return ( -
    +
    Responsive
    -
    +
    Responsive
    -
    +
    Responsive
    -
    +
    Responsive
    @@ -145,24 +248,45 @@ function ResponsiveGrid() { ```tsx live function AlignmentDemo() { - const boxStyle = { background: '#e6f4ff', padding: '16px 0', border: '1px solid #91caff', textAlign: 'center' }; + const boxStyle = { + background: '#e6f4ff', + padding: '16px 0', + border: '1px solid #91caff', + textAlign: 'center', + }; return (
    -
    start
    -
    start
    + +
    start
    + + +
    start
    + -
    center
    -
    center
    + +
    center
    + + +
    center
    + -
    end
    -
    end
    + +
    end
    + + +
    end
    + -
    between
    -
    between
    + +
    between
    + + +
    between
    + ); @@ -171,12 +295,12 @@ function AlignmentDemo() { ## 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. | +| 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 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 index bda28ca5dc1..814de9f92ee 100644 --- 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 @@ -33,20 +33,47 @@ Ant Design Layout component with configurable Sider, Header, Footer, and Content ## Try It @@ -64,12 +91,12 @@ function Demo() { Header - + Content - - Footer - + Footer ); @@ -82,10 +109,19 @@ function Demo() { function ContentOnly() { return ( - + Application Header - + Main content area without a sidebar @@ -120,10 +156,10 @@ function RightSidebar() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `hasSider` | `boolean` | `false` | Whether the layout contains a Sider sub-component. | -| `style` | `any` | `{"minHeight":200}` | - | +| Prop | Type | Default | Description | +| ---------- | --------- | ------------------- | -------------------------------------------------- | +| `hasSider` | `boolean` | `false` | Whether the layout contains a Sider sub-component. | +| `style` | `any` | `{"minHeight":200}` | - | ## Import 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 index 847f3cff2e0..d0614359b9b 100644 --- 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 @@ -33,66 +33,59 @@ MetadataBar displays a row of metadata items (SQL info, owners, last modified, t ## Try It @@ -125,7 +118,12 @@ function Demo() { ```tsx live function MinimalMetadata() { const items = [ - { type: 'owner', createdBy: 'Admin', owners: ['Admin'], createdOn: 'yesterday' }, + { + type: 'owner', + createdBy: 'Admin', + owners: ['Admin'], + createdOn: 'yesterday', + }, { type: 'lastModified', value: '2 hours ago', modifiedBy: 'Admin' }, ]; return ; @@ -138,11 +136,20 @@ function MinimalMetadata() { 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: '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: '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' }, ]; @@ -152,13 +159,13 @@ function FullMetadata() { ## 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."}]` | - | +| 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 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 index 44af004f961..86951dfa051 100644 --- 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 @@ -33,49 +33,42 @@ The Space component from Superset's UI library. ## Try It @@ -136,7 +129,9 @@ function SpaceSizes() {

    {size}

    {items.map(item => ( -
    {item}
    +
    + {item} +
    ))}     @@ -148,11 +143,11 @@ function SpaceSizes() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `direction` | `string` | `"horizontal"` | - | -| `size` | `string` | `"small"` | - | -| `wrap` | `boolean` | `false` | - | +| Prop | Type | Default | Description | +| ----------- | --------- | -------------- | ----------- | +| `direction` | `string` | `"horizontal"` | - | +| `size` | `string` | `"small"` | - | +| `wrap` | `boolean` | `false` | - | ## Import 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 index 18f0ecd0041..abcf3206f4c 100644 --- 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 @@ -33,187 +33,182 @@ A data table component with sorting, pagination, row selection, resizable column ## Try It @@ -278,24 +273,24 @@ function LoadingTable() { ## 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}]` | - | +| 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 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 index 8c9c32f37d6..41cdeac5a63 100644 --- 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 @@ -33,48 +33,43 @@ Alert component for displaying important messages to users. Wraps Ant Design Ale ## Try It @@ -97,13 +92,13 @@ function Demo() { ## 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. | +| 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 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 index 142af25d4f3..4ec029a445e 100644 --- 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 @@ -38,11 +38,15 @@ A design system is a complete set of standards intended to manage design at scal 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 | +| 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 +Atoms = Foundations, Molecules = Components, Organisms = Patterns, Templates = Templates, Pages / Screens = Features ## Usage @@ -67,4 +71,4 @@ This component library is actively being documented. See the [Components TODO](. --- -*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.* +_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 index 2ffde8f0526..16b45ae890e 100644 --- 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 @@ -33,146 +33,135 @@ AutoComplete component for search functionality. ## Try It @@ -184,8 +173,14 @@ function Demo() { return ( ); @@ -194,12 +189,12 @@ function Demo() { ## 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 | +| 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 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 index 579f9922f14..30c0c11316b 100644 --- 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 @@ -33,65 +33,58 @@ The Avatar component from Superset's UI library. ## Try It @@ -101,13 +94,7 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { return ( - + AB ); @@ -116,15 +103,15 @@ function Demo() { ## 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` | - | +| 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 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 index d381fbdf614..d51bc142d58 100644 --- 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 @@ -33,62 +33,59 @@ The Badge component from Superset's UI library. ## Try It @@ -97,13 +94,7 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { - return ( - - ); + return ; } ``` @@ -139,12 +130,12 @@ function ColorGallery() { ## 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+). | +| 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 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 index 3d9fcfcb022..c96e0b0e445 100644 --- 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 @@ -33,29 +33,29 @@ Breadcrumb component for displaying navigation paths. ## Try It @@ -77,8 +77,6 @@ function Demo() { } ``` - - ## Import ```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 index b3d7afa3db5..1e96ba9e8bb 100644 --- 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 @@ -22,7 +22,10 @@ sidebar_label: Button under the License. --> -import { StoryWithControls, ComponentGallery } from '../../../../src/components/StorybookWrapper'; +import { + StoryWithControls, + ComponentGallery, +} from '../../../../src/components/StorybookWrapper'; # Button @@ -32,8 +35,8 @@ The Button component from Superset's UI library. @@ -43,64 +46,54 @@ The Button component from Superset's UI library. ## Try It @@ -110,10 +103,7 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { return ( - ); @@ -122,11 +112,11 @@ function Demo() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| +| 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. | +| `buttonSize` | `string` | `"default"` | The size of the button. | +| `children` | `string` | `"Button!"` | The button text or content. | ## Import 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 index 4064536f3b6..9b80048f67b 100644 --- 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 @@ -33,23 +33,36 @@ ButtonGroup is a container that groups multiple Button components together with ## Try It @@ -70,8 +83,8 @@ function Demo() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| +| Prop | Type | Default | Description | +| -------- | --------- | ------- | -------------------------------------------------- | | `expand` | `boolean` | `false` | When true, buttons expand to fill available width. | ## Import 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 index 56a9a0fcd95..5658fada46b 100644 --- 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 @@ -34,19 +34,19 @@ The CachedLabel component from Superset's UI library. component="CachedLabel" props={{}} controls={[ - { - name: "cachedTimestamp", - label: "Cached Timestamp", - type: "text", - description: "ISO timestamp of when the data was cached" - }, - { - name: "className", - label: "Class Name", - type: "text", - description: "Additional CSS class for the label" - } -]} + { + name: 'cachedTimestamp', + label: 'Cached Timestamp', + type: 'text', + description: 'ISO timestamp of when the data was cached', + }, + { + name: 'className', + label: 'Class Name', + type: 'text', + description: 'Additional CSS class for the label', + }, + ]} /> ## Try It @@ -57,14 +57,12 @@ Edit the code below to experiment with the component: function Demo() { return ( ); } ``` - - ## Import ```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 index b324d8c6342..6a540a48c69 100644 --- 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 @@ -33,51 +33,52 @@ A container component for grouping related content. Supports titles, borders, lo ## Try It @@ -88,7 +89,8 @@ Edit the code below to experiment with the component: function Demo() { return ( - This card displays a summary of your dashboard metrics and recent activity. + This card displays a summary of your dashboard metrics and recent + activity. ); } @@ -119,14 +121,14 @@ function CardStates() { ## 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. | +| 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 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 index ba79181b173..4b904e50329 100644 --- 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 @@ -33,23 +33,24 @@ Checkbox component that supports both regular and indeterminate states, built on ## Try It @@ -60,7 +61,7 @@ Edit the code below to experiment with the component: function Demo() { return ( ); } @@ -76,7 +77,9 @@ function AllStates() { Checked Indeterminate Disabled unchecked - Disabled checked + + Disabled checked + ); } @@ -97,7 +100,7 @@ function SelectAllDemo() { setSelected(e.target.checked ? [...options] : [])} + onChange={e => setSelected(e.target.checked ? [...options] : [])} > Select All @@ -106,9 +109,13 @@ function SelectAllDemo() {
    setSelected(prev => - prev.includes(opt) ? prev.filter(x => x !== opt) : [...prev, opt] - )} + onChange={() => + setSelected(prev => + prev.includes(opt) + ? prev.filter(x => x !== opt) + : [...prev, opt], + ) + } > {opt} @@ -122,9 +129,9 @@ function SelectAllDemo() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `checked` | `boolean` | `false` | Whether the checkbox is checked. | +| 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 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 index 297abaf7827..02912a29581 100644 --- 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 @@ -33,39 +33,39 @@ The Collapse component from Superset's UI library. ## Try It @@ -74,23 +74,19 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { - return ( - - ); + return ; } ``` ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `ghost` | `boolean` | `false` | - | -| `bordered` | `boolean` | `true` | - | -| `accordion` | `boolean` | `false` | - | -| `animateArrows` | `boolean` | `false` | - | -| `modalMode` | `boolean` | `false` | - | +| Prop | Type | Default | Description | +| --------------- | --------- | ------- | ----------- | +| `ghost` | `boolean` | `false` | - | +| `bordered` | `boolean` | `true` | - | +| `accordion` | `boolean` | `false` | - | +| `animateArrows` | `boolean` | `false` | - | +| `modalMode` | `boolean` | `false` | - | ## Import 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 index db7d3455460..249895c91ae 100644 --- 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 @@ -33,34 +33,34 @@ The DatePicker component from Superset's UI library. ## Try It @@ -82,19 +82,19 @@ function Demo() { ## 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}` | - | +| 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 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 index 1374885a02b..ce0d592cef6 100644 --- 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 @@ -33,65 +33,54 @@ The Divider component from Superset's UI library. ## Try It @@ -103,8 +92,12 @@ function Demo() { return ( <>

    Horizontal divider with title (orientationMargin applies here):

    - Left Title - Right Title + + Left Title + + + Right Title + Center Title

    Vertical divider (use container gap for spacing):

    @@ -121,14 +114,14 @@ function Demo() { ## 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. | +| 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 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 index b64661df40e..53f72f91153 100644 --- 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 @@ -33,93 +33,93 @@ The EditableTitle component from Superset's UI library. ## Try It @@ -135,7 +135,7 @@ function Demo() { showTooltip certifiedBy="Data Team" certificationDetails="Verified Q1 2024" - onSaveTitle={(newTitle) => console.log('Saved:', newTitle)} + onSaveTitle={newTitle => console.log('Saved:', newTitle)} /> ); } @@ -143,20 +143,20 @@ function Demo() { ## 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. | +| 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 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 index 56fb8fc9c1b..a5855edcf14 100644 --- 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 @@ -22,7 +22,10 @@ sidebar_label: EmptyState under the License. --> -import { StoryWithControls, ComponentGallery } from '../../../../src/components/StorybookWrapper'; +import { + StoryWithControls, + ComponentGallery, +} from '../../../../src/components/StorybookWrapper'; # EmptyState @@ -32,8 +35,23 @@ The EmptyState component from Superset's UI library. @@ -43,65 +61,61 @@ The EmptyState component from Superset's UI library. ## Try It @@ -125,13 +139,13 @@ function Demo() { ## 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. | +| 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 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 index 2943c6c5f62..e9350af9dd7 100644 --- 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 @@ -33,30 +33,30 @@ FaveStar component for marking items as favorites ## Try It @@ -65,22 +65,17 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { - return ( - - ); + 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. | +| 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 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 index 6bd7d859868..d358ca4ca02 100644 --- 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 @@ -33,37 +33,38 @@ The IconButton component is a versatile button that allows you to combine an ico ## Try It @@ -85,12 +86,12 @@ function Demo() { ## 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). | +| 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 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 index 5a7dd9605bf..c4bc1eeae73 100644 --- 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 @@ -34,33 +34,28 @@ Icon library for Apache Superset. Contains over 200 icons based on Ant Design ic component="Icons" renderComponent="Icons.InfoCircleOutlined" props={{ - iconSize: "xl" -}} + iconSize: 'xl', + }} controls={[ - { - name: "iconSize", - label: "Icon Size", - type: "inline-radio", - options: [ - "s", - "m", - "l", - "xl", - "xxl" - ], - description: "Size of the icons: s (12px), m (16px), l (20px), xl (24px), xxl (32px)." - }, - { - name: "showNames", - label: "Show Names", - type: "boolean" - }, - { - name: "iconColor", - label: "Icon Color", - type: "select" - } -]} + { + name: 'iconSize', + label: 'Icon Size', + type: 'inline-radio', + options: ['s', 'm', 'l', 'xl', 'xxl'], + description: + 'Size of the icons: s (12px), m (16px), l (20px), xl (24px), xxl (32px).', + }, + { + name: 'showNames', + label: 'Show Names', + type: 'boolean', + }, + { + name: 'iconColor', + label: 'Icon Color', + type: 'select', + }, + ]} /> ## Try It @@ -90,7 +85,9 @@ function IconSizes() { {sizes.map(size => (
    -
    {size}
    +
    + {size} +
    ))}
    @@ -104,8 +101,12 @@ function IconSizes() { function IconGallery() { const Section = ({ title, children }) => (
    -
    {title}
    -
    {children}
    +
    + {title} +
    +
    + {children} +
    ); return ( @@ -234,9 +235,9 @@ function IconWithText() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `iconSize` | `string` | `"xl"` | Size of the icons: s (12px), m (16px), l (20px), xl (24px), xxl (32px). | +| Prop | Type | Default | Description | +| ---------- | -------- | ------- | ----------------------------------------------------------------------- | +| `iconSize` | `string` | `"xl"` | Size of the icons: s (12px), m (16px), l (20px), xl (24px), xxl (32px). | ## Import 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 index eb9851dfd93..d3467b8d736 100644 --- 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 @@ -33,37 +33,39 @@ The IconTooltip component from Superset's UI library. ## Try It @@ -82,8 +84,8 @@ function Demo() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| +| Prop | Type | Default | Description | +| --------- | -------- | ----------- | --------------------------------------- | | `tooltip` | `string` | `"Tooltip"` | Text content to display in the tooltip. | ## Import 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 index c1304b25b7d..b0556fab076 100644 --- 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 @@ -33,43 +33,40 @@ The InfoTooltip component from Superset's UI library. ## Try It @@ -78,19 +75,15 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { - return ( - - ); + return ; } ``` ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `tooltip` | `string` | `"This is the text that will display!"` | - | +| Prop | Type | Default | Description | +| --------- | -------- | --------------------------------------- | ----------- | +| `tooltip` | `string` | `"This is the text that will display!"` | - | ## Import 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 index 731f4148dec..4009ea78218 100644 --- 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 @@ -33,94 +33,75 @@ The Input component from Superset's UI library. ## Try It @@ -129,24 +110,19 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { - return ( - - ); + 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 | +| 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 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 index 3316de122e9..f0135a3e0a4 100644 --- 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 @@ -33,38 +33,31 @@ The Label component from Superset's UI library. ## Try It @@ -73,23 +66,17 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { - return ( - - ); + 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. | +| 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 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 index 813450dcc46..10f10d1ed61 100644 --- 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 @@ -33,47 +33,39 @@ The List component from Superset's UI library. ## Try It @@ -87,7 +79,7 @@ function Demo() { {item}} + renderItem={item => {item}} /> ); } @@ -95,13 +87,13 @@ function Demo() { ## 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"]` | - | +| 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 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 index 17312e3bf0f..b1d8c692dfe 100644 --- 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 @@ -33,58 +33,58 @@ ListViewCard is a card component used to display items in list views with an ima ## Try It @@ -108,15 +108,15 @@ function Demo() { ## 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. | +| 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 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 index 0eb7cc4c4f1..988fae2ee5e 100644 --- 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 @@ -33,40 +33,33 @@ The Loading component from Superset's UI library. ## Try It @@ -104,20 +97,48 @@ function SizeShowcase() { const sizes = ['s', 'm', 'l']; return (
    -
    -
    Size
    -
    Normal
    -
    Muted
    -
    Usage
    +
    +
    + Size +
    +
    + Normal +
    +
    + Muted +
    +
    + Usage +
    {sizes.map(size => (
    - {size.toUpperCase()} ({size === 's' ? '40px' : size === 'm' ? '70px' : '100px'}) + {size.toUpperCase()} ( + {size === 's' ? '40px' : size === 'm' ? '70px' : '100px'})
    -
    +
    -
    +
    @@ -140,7 +161,17 @@ function ContextualDemo() { return (

    Filter Bar (size="s", muted)

    -
    +
    Filter 1: Filter 2: @@ -148,16 +179,41 @@ function ContextualDemo() {

    Dashboard Grid (size="s", muted)

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

    Main Loading (size="l")

    -
    +
    @@ -167,11 +223,11 @@ function ContextualDemo() { ## 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. | +| 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 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 index b7e909d137e..5918e716d01 100644 --- 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 @@ -33,58 +33,56 @@ Navigation menu component supporting horizontal, vertical, and inline modes. Bas ## Try It @@ -142,10 +140,38 @@ function MenuWithIcons() { Dashboards, key: 'dashboards' }, - { label: <> Charts, key: 'charts' }, - { label: <> Datasets, key: 'datasets' }, - { label: <> SQL Lab, key: 'sqllab' }, + { + label: ( + <> + Dashboards + + ), + key: 'dashboards', + }, + { + label: ( + <> + Charts + + ), + key: 'charts', + }, + { + label: ( + <> + Datasets + + ), + key: 'datasets', + }, + { + label: ( + <> + SQL Lab + + ), + key: 'sqllab', + }, ]} /> ); @@ -154,11 +180,11 @@ function MenuWithIcons() { ## 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"}]` | - | +| 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 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 index 7e33d443dcd..b26a56e75d1 100644 --- 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 @@ -33,72 +33,67 @@ Modal dialog component for displaying content that requires user attention or in @@ -137,7 +132,9 @@ function DangerModal() { const [isOpen, setIsOpen] = React.useState(false); return ( <> - + setIsOpen(false)} @@ -149,7 +146,10 @@ function DangerModal() { setIsOpen(false); }} > -

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

    +

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

    ); @@ -162,19 +162,37 @@ function DangerModal() { function ConfirmationDialogs() { return (
    - - - + + +
    ); } @@ -182,16 +200,16 @@ function ConfirmationDialogs() { ## 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. | +| 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 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 index bf8ffe869f6..0daab19285b 100644 --- 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 @@ -33,73 +33,73 @@ A component that renders a trigger element which opens a modal when clicked. Use ## Try It @@ -113,7 +113,9 @@ function Demo() { isButton triggerNode={Click to Open} modalTitle="Example Modal" - modalBody={

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

    } + modalBody={ +

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

    + } width="500px" responsive /> @@ -165,18 +167,18 @@ function DraggableModal() { ## 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. | +| 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 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 index 4b37a011f1e..d1996fbb77c 100644 --- 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 @@ -33,69 +33,66 @@ A floating card that appears when hovering or clicking a trigger element. Suppor ## Try It @@ -105,11 +102,7 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { return ( - + ); @@ -137,7 +130,15 @@ function ClickPopover() { ```tsx live function PlacementsDemo() { return ( -
    +
    {['top', 'right', 'bottom', 'left'].map(placement => ( -

    Created by: Admin

    -

    Last modified: Jan 2025

    -

    Charts: 12

    +

    + Created by: Admin +

    +

    + Last modified: Jan 2025 +

    +

    + Charts: 12 +

    } > @@ -178,12 +185,12 @@ function RichPopover() { ## 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. | +| 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 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 index 2b1ee6b299a..5f6736d2bd6 100644 --- 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 @@ -33,79 +33,66 @@ Progress bar component for displaying completion status. Supports line, circle, ## Try It @@ -114,14 +101,7 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { - return ( - - ); + return ; } ``` @@ -156,9 +136,17 @@ function StatusDemo() { return (
    {statuses.map(status => ( -
    +
    {status} - +
    ))}
    @@ -183,14 +171,14 @@ function CustomColors() { ## 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. | +| 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 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 index cfc8643592c..32e5f80195b 100644 --- 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 @@ -33,37 +33,37 @@ Radio button component for selecting one option from a set. Supports standalone ## Try It @@ -72,13 +72,7 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { - return ( - - Radio - - ); + return Radio; } ``` @@ -116,12 +110,12 @@ function VerticalDemo() { ## 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. | +| 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 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 index 3157466e7f8..0681047c0c7 100644 --- 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 @@ -33,22 +33,22 @@ The SafeMarkdown component from Superset's UI library. ## Try It @@ -57,19 +57,15 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { - return ( - - ); + return ; } ``` ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `htmlSanitization` | `boolean` | `true` | Enable HTML sanitization (recommended for user input) | +| Prop | Type | Default | Description | +| ------------------ | --------- | ------- | ----------------------------------------------------- | +| `htmlSanitization` | `boolean` | `true` | Enable HTML sanitization (recommended for user input) | ## Import 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 index 4aa9efae083..004c73bdcd1 100644 --- 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 @@ -33,129 +33,130 @@ A versatile select component supporting single and multi-select modes, search fi ## Try It @@ -280,19 +281,19 @@ function OneLineDemo() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `mode` | `string` | `"single"` | Whether to allow selection of a single option or multiple. | -| `placeholder` | `string` | `"Select ..."` | Placeholder text when no option is selected. | -| `showSearch` | `boolean` | `true` | Whether to show a search input for filtering. | -| `allowNewOptions` | `boolean` | `false` | Whether users can create new options by typing a value not in the list. | -| `allowClear` | `boolean` | `false` | Whether to show a clear button to reset the selection. | -| `allowSelectAll` | `boolean` | `true` | Whether to show a "Select All" option in multiple mode. | -| `disabled` | `boolean` | `false` | Whether the select is disabled. | -| `invertSelection` | `boolean` | `false` | Shows a stop icon instead of a checkmark on selected options, indicating deselection on click. | -| `oneLine` | `boolean` | `false` | Forces tags onto one line with overflow count. Requires multiple mode. | -| `maxTagCount` | `number` | `4` | Maximum number of tags to display in multiple mode before showing an overflow count. | -| `options` | `any` | `[{"label":"Such an incredibly awesome long long label","value":"long-label-1"},{"label":"Another incredibly awesome long long label","value":"long-label-2"},{"label":"Option A","value":"A"},{"label":"Option B","value":"B"},{"label":"Option C","value":"C"},{"label":"Option D","value":"D"},{"label":"Option E","value":"E"},{"label":"Option F","value":"F"},{"label":"Option G","value":"G"},{"label":"Option H","value":"H"},{"label":"Option I","value":"I"}]` | - | +| Prop | Type | Default | Description | +| ----------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | +| `mode` | `string` | `"single"` | Whether to allow selection of a single option or multiple. | +| `placeholder` | `string` | `"Select ..."` | Placeholder text when no option is selected. | +| `showSearch` | `boolean` | `true` | Whether to show a search input for filtering. | +| `allowNewOptions` | `boolean` | `false` | Whether users can create new options by typing a value not in the list. | +| `allowClear` | `boolean` | `false` | Whether to show a clear button to reset the selection. | +| `allowSelectAll` | `boolean` | `true` | Whether to show a "Select All" option in multiple mode. | +| `disabled` | `boolean` | `false` | Whether the select is disabled. | +| `invertSelection` | `boolean` | `false` | Shows a stop icon instead of a checkmark on selected options, indicating deselection on click. | +| `oneLine` | `boolean` | `false` | Forces tags onto one line with overflow count. Requires multiple mode. | +| `maxTagCount` | `number` | `4` | Maximum number of tags to display in multiple mode before showing an overflow count. | +| `options` | `any` | `[{"label":"Such an incredibly awesome long long label","value":"long-label-1"},{"label":"Another incredibly awesome long long label","value":"long-label-2"},{"label":"Option A","value":"A"},{"label":"Option B","value":"B"},{"label":"Option C","value":"C"},{"label":"Option D","value":"D"},{"label":"Option E","value":"E"},{"label":"Option F","value":"F"},{"label":"Option G","value":"G"},{"label":"Option H","value":"H"},{"label":"Option I","value":"I"}]` | - | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/skeleton.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/skeleton.mdx index a1437807dee..bc60b2efae2 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/skeleton.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/skeleton.mdx @@ -33,67 +33,60 @@ Skeleton loading component with support for avatar, title, paragraph, button, an ## Try It @@ -102,29 +95,21 @@ Edit the code below to experiment with the component: ```tsx live function Demo() { - return ( - - ); + return ; } ``` ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `active` | `boolean` | `true` | Show animation effect. | -| `avatar` | `boolean` | `false` | Show avatar placeholder. | -| `loading` | `boolean` | `true` | Display the skeleton when true. | -| `title` | `boolean` | `true` | Show title placeholder. | -| `shape` | `string` | `"circle"` | Shape of the avatar/button skeleton. | -| `size` | `string` | `"default"` | Size of the skeleton elements. | -| `block` | `boolean` | `false` | Option to fit button width to its parent width. | +| Prop | Type | Default | Description | +| --------- | --------- | ----------- | ----------------------------------------------- | +| `active` | `boolean` | `true` | Show animation effect. | +| `avatar` | `boolean` | `false` | Show avatar placeholder. | +| `loading` | `boolean` | `true` | Display the skeleton when true. | +| `title` | `boolean` | `true` | Show title placeholder. | +| `shape` | `string` | `"circle"` | Shape of the avatar/button skeleton. | +| `size` | `string` | `"default"` | Size of the skeleton elements. | +| `block` | `boolean` | `false` | Option to fit button width to its parent width. | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/slider.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/slider.mdx index 36126afc6f5..e04e57aacaa 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/slider.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/slider.mdx @@ -33,105 +33,106 @@ A slider input for selecting a value or range from a continuous or stepped inter ## Try It @@ -142,12 +143,7 @@ Edit the code below to experiment with the component: function Demo() { return (
    - +
    ); } @@ -163,7 +159,12 @@ function RangeSliderDemo() {

    Draggable Track

    - +
    ); } @@ -202,8 +203,14 @@ function SteppedDemo() {

    Step = 25

    - +
    ); } @@ -217,8 +224,13 @@ function VerticalDemo() {
    - +
    ); } @@ -226,18 +238,18 @@ function VerticalDemo() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `min` | `number` | `0` | Minimum value of the slider. | -| `max` | `number` | `100` | Maximum value of the slider. | -| `defaultValue` | `number` | `70` | Initial value of the slider. | -| `step` | `number` | `1` | Step increment between values. Use null for marks-only mode. | -| `disabled` | `boolean` | `false` | Whether the slider is disabled. | -| `reverse` | `boolean` | `false` | Whether to reverse the slider direction. | -| `vertical` | `boolean` | `false` | Whether to display the slider vertically. | -| `keyboard` | `boolean` | `true` | Whether keyboard arrow keys can control the slider. | -| `dots` | `boolean` | `false` | Whether to show dots at each step mark. | -| `included` | `boolean` | `true` | Whether to highlight the filled portion of the track. | +| Prop | Type | Default | Description | +| -------------- | --------- | ------- | ------------------------------------------------------------ | +| `min` | `number` | `0` | Minimum value of the slider. | +| `max` | `number` | `100` | Maximum value of the slider. | +| `defaultValue` | `number` | `70` | Initial value of the slider. | +| `step` | `number` | `1` | Step increment between values. Use null for marks-only mode. | +| `disabled` | `boolean` | `false` | Whether the slider is disabled. | +| `reverse` | `boolean` | `false` | Whether to reverse the slider direction. | +| `vertical` | `boolean` | `false` | Whether to display the slider vertically. | +| `keyboard` | `boolean` | `true` | Whether keyboard arrow keys can control the slider. | +| `dots` | `boolean` | `false` | Whether to show dots at each step mark. | +| `included` | `boolean` | `true` | Whether to highlight the filled portion of the track. | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/steps.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/steps.mdx index 07df1e601f9..d0da519480a 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/steps.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/steps.mdx @@ -33,107 +33,90 @@ A navigation component for guiding users through multi-step workflows. Supports ## Try It @@ -164,7 +147,10 @@ function VerticalSteps() { direction="vertical" current={1} items={[ - { title: 'Upload CSV', description: 'Select a file from your computer' }, + { + title: 'Upload CSV', + description: 'Select a file from your computer', + }, { title: 'Configure Columns', description: 'Set data types and names' }, { title: 'Review', description: 'Verify the data looks correct' }, { title: 'Import', description: 'Save the dataset' }, @@ -231,11 +217,7 @@ function DotAndSmall() {
    @@ -245,18 +227,18 @@ function DotAndSmall() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `direction` | `string` | `"horizontal"` | Layout direction of the steps. | -| `current` | `number` | `1` | Index of the current step (zero-based). | -| `labelPlacement` | `string` | `"horizontal"` | Position of step labels relative to the step icon. | -| `progressDot` | `boolean` | `false` | Whether to use a dot style instead of numbered icons. | -| `size` | `string` | `"default"` | Size of the step icons and text. | -| `status` | `string` | `"process"` | Status of the current step. | -| `type` | `string` | `"default"` | Visual style: default numbered, navigation breadcrumb, or inline compact. | -| `title` | `string` | `"Step 3"` | - | -| `description` | `string` | `"Description 3"` | - | -| `items` | `any` | `[{"title":"Connect Database","description":"Configure the connection"},{"title":"Create Dataset","description":"Select tables and columns"},{"title":"Build Chart","description":"Choose visualization type"}]` | - | +| Prop | Type | Default | Description | +| ---------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `direction` | `string` | `"horizontal"` | Layout direction of the steps. | +| `current` | `number` | `1` | Index of the current step (zero-based). | +| `labelPlacement` | `string` | `"horizontal"` | Position of step labels relative to the step icon. | +| `progressDot` | `boolean` | `false` | Whether to use a dot style instead of numbered icons. | +| `size` | `string` | `"default"` | Size of the step icons and text. | +| `status` | `string` | `"process"` | Status of the current step. | +| `type` | `string` | `"default"` | Visual style: default numbered, navigation breadcrumb, or inline compact. | +| `title` | `string` | `"Step 3"` | - | +| `description` | `string` | `"Description 3"` | - | +| `items` | `any` | `[{"title":"Connect Database","description":"Configure the connection"},{"title":"Create Dataset","description":"Select tables and columns"},{"title":"Build Chart","description":"Choose visualization type"}]` | - | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/switch.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/switch.mdx index ecdffbce753..7af3a849c12 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/switch.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/switch.mdx @@ -33,46 +33,44 @@ A toggle switch for boolean on/off states. Supports loading indicators, sizing, ## Try It @@ -84,13 +82,11 @@ function Demo() { const [checked, setChecked] = React.useState(true); return (
    - + {checked ? 'On' : 'Off'} - (hover the switch to see the title tooltip) + + (hover the switch to see the title tooltip) +
    ); } @@ -154,14 +150,45 @@ function SettingsPanel() { const [darkMode, setDarkMode] = React.useState(false); const [autoRefresh, setAutoRefresh] = React.useState(true); return ( -
    +

    Dashboard Settings

    {[ - { label: 'Email notifications', checked: notifications, onChange: setNotifications, title: 'Toggle email notifications' }, - { label: 'Dark mode', checked: darkMode, onChange: setDarkMode, title: 'Toggle dark mode' }, - { label: 'Auto-refresh data', checked: autoRefresh, onChange: setAutoRefresh, title: 'Toggle auto-refresh' }, + { + label: 'Email notifications', + checked: notifications, + onChange: setNotifications, + title: 'Toggle email notifications', + }, + { + label: 'Dark mode', + checked: darkMode, + onChange: setDarkMode, + title: 'Toggle dark mode', + }, + { + label: 'Auto-refresh data', + checked: autoRefresh, + onChange: setAutoRefresh, + title: 'Toggle auto-refresh', + }, ].map(({ label, checked, onChange, title }) => ( -
    +
    {label}
    @@ -173,11 +200,11 @@ function SettingsPanel() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `disabled` | `boolean` | `false` | Whether the switch is disabled. | -| `loading` | `boolean` | `false` | Whether to show a loading spinner inside the switch. | -| `title` | `string` | `"Toggle feature"` | HTML title attribute shown as a browser tooltip on hover. Useful for accessibility. | +| Prop | Type | Default | Description | +| ---------- | --------- | ------------------ | ----------------------------------------------------------------------------------- | +| `disabled` | `boolean` | `false` | Whether the switch is disabled. | +| `loading` | `boolean` | `false` | Whether to show a loading spinner inside the switch. | +| `title` | `string` | `"Toggle feature"` | HTML title attribute shown as a browser tooltip on hover. Useful for accessibility. | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tablecollection.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tablecollection.mdx index d86373d8458..86ced212690 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tablecollection.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tablecollection.mdx @@ -30,11 +30,7 @@ The TableCollection component from Superset's UI library. ## Live Example - + ## Try It @@ -44,14 +40,12 @@ Edit the code below to experiment with the component: function Demo() { return ( ); } ``` - - --- :::tip[Improve this page] diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tableview.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tableview.mdx index c83cbd66191..01329aba8e7 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tableview.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tableview.mdx @@ -33,141 +33,144 @@ A data table component with sorting, pagination, text wrapping, and empty state ## Try It @@ -185,9 +188,24 @@ function Demo() { { accessor: 'summary', Header: 'Summary', id: 'summary' }, ]} data={[ - { id: 123, age: 27, name: 'Emily', summary: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.' }, - { id: 321, age: 10, name: 'Kate', summary: 'Nam id porta neque, a vehicula orci.' }, - { id: 456, age: 10, name: 'John Smith', summary: 'Maecenas rhoncus elit sit amet purus convallis placerat.' }, + { + id: 123, + age: 27, + name: 'Emily', + summary: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', + }, + { + id: 321, + age: 10, + name: 'Kate', + summary: 'Nam id porta neque, a vehicula orci.', + }, + { + id: 456, + age: 10, + name: 'John Smith', + summary: 'Maecenas rhoncus elit sit amet purus convallis placerat.', + }, ]} initialSortBy={[{ id: 'name', desc: true }]} pageSize={2} @@ -263,22 +281,22 @@ function SortingDemo() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `accessor` | `string` | `"summary"` | - | -| `Header` | `string` | `"Summary"` | - | -| `sortable` | `boolean` | `true` | - | -| `id` | `number` | `456` | - | -| `age` | `number` | `10` | - | -| `name` | `string` | `"John Smith"` | - | -| `summary` | `string` | `"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam id porta neque, a vehicula orci. Maecenas rhoncus elit sit amet purus convallis placerat in at nunc. Nulla nec viverra augue."` | - | -| `noDataText` | `string` | `"No data here"` | Text displayed when the table has no data. | -| `pageSize` | `number` | `2` | Number of rows displayed per page. | -| `showRowCount` | `boolean` | `true` | Whether to display the total row count alongside pagination. | -| `withPagination` | `boolean` | `true` | Whether to show pagination controls below the table. | -| `scrollTopOnPagination` | `boolean` | `false` | Whether to scroll to the top of the table when changing pages. | -| `columns` | `any` | `[{"accessor":"id","Header":"ID","sortable":true,"id":"id"},{"accessor":"age","Header":"Age","id":"age"},{"accessor":"name","Header":"Name","id":"name"},{"accessor":"summary","Header":"Summary","id":"summary"}]` | - | -| `data` | `any` | `[{"id":123,"age":27,"name":"Emily","summary":"Lorem ipsum dolor sit amet, consectetur adipiscing elit."},{"id":321,"age":10,"name":"Kate","summary":"Nam id porta neque, a vehicula orci."},{"id":456,"age":10,"name":"John Smith","summary":"Maecenas rhoncus elit sit amet purus convallis placerat."}]` | - | +| Prop | Type | Default | Description | +| ----------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | +| `accessor` | `string` | `"summary"` | - | +| `Header` | `string` | `"Summary"` | - | +| `sortable` | `boolean` | `true` | - | +| `id` | `number` | `456` | - | +| `age` | `number` | `10` | - | +| `name` | `string` | `"John Smith"` | - | +| `summary` | `string` | `"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam id porta neque, a vehicula orci. Maecenas rhoncus elit sit amet purus convallis placerat in at nunc. Nulla nec viverra augue."` | - | +| `noDataText` | `string` | `"No data here"` | Text displayed when the table has no data. | +| `pageSize` | `number` | `2` | Number of rows displayed per page. | +| `showRowCount` | `boolean` | `true` | Whether to display the total row count alongside pagination. | +| `withPagination` | `boolean` | `true` | Whether to show pagination controls below the table. | +| `scrollTopOnPagination` | `boolean` | `false` | Whether to scroll to the top of the table when changing pages. | +| `columns` | `any` | `[{"accessor":"id","Header":"ID","sortable":true,"id":"id"},{"accessor":"age","Header":"Age","id":"age"},{"accessor":"name","Header":"Name","id":"name"},{"accessor":"summary","Header":"Summary","id":"summary"}]` | - | +| `data` | `any` | `[{"id":123,"age":27,"name":"Emily","summary":"Lorem ipsum dolor sit amet, consectetur adipiscing elit."},{"id":321,"age":10,"name":"Kate","summary":"Nam id porta neque, a vehicula orci."},{"id":456,"age":10,"name":"John Smith","summary":"Maecenas rhoncus elit sit amet purus convallis placerat."}]` | - | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tabs.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tabs.mdx index a1aad6336ee..80c01692e42 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tabs.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tabs.mdx @@ -33,90 +33,77 @@ A tabs component for switching between different views or content sections. Supp ## Try It @@ -147,9 +134,17 @@ function CardTabs() { type="card" defaultActiveKey="1" items={[ - { key: '1', label: 'Dashboards', children: 'View and manage your dashboards.' }, + { + key: '1', + label: 'Dashboards', + children: 'View and manage your dashboards.', + }, { key: '2', label: 'Charts', children: 'Browse all saved charts.' }, - { key: '3', label: 'Datasets', children: 'Explore available datasets.' }, + { + key: '3', + label: 'Datasets', + children: 'Explore available datasets.', + }, ]} /> ); @@ -186,10 +181,42 @@ function IconTabs() { Dashboards, children: 'Dashboard content here.' }, - { key: '2', label: <> Charts, children: 'Chart content here.' }, - { key: '3', label: <> Datasets, children: 'Dataset content here.' }, - { key: '4', label: <> SQL Lab, children: 'SQL Lab content here.' }, + { + key: '1', + label: ( + <> + Dashboards + + ), + children: 'Dashboard content here.', + }, + { + key: '2', + label: ( + <> + Charts + + ), + children: 'Chart content here.', + }, + { + key: '3', + label: ( + <> + Datasets + + ), + children: 'Dataset content here.', + }, + { + key: '4', + label: ( + <> + SQL Lab + + ), + children: 'SQL Lab content here.', + }, ]} /> ); @@ -198,16 +225,16 @@ function IconTabs() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `defaultActiveKey` | `string` | `"1"` | - | -| `type` | `string` | `"line"` | The style of tabs. Options: line, card, editable-card. | -| `tabPosition` | `string` | `"top"` | Position of tabs. Options: top, bottom, left, right. | -| `size` | `string` | `"middle"` | Size of the tabs. | -| `animated` | `boolean` | `true` | Whether to animate tab transitions. | -| `centered` | `boolean` | `false` | Whether to center the tabs. | -| `tabBarGutter` | `number` | `8` | The gap between tabs. | -| `items` | `any` | `[{"key":"1","label":"Tab 1","children":"Content of Tab Pane 1"},{"key":"2","label":"Tab 2","children":"Content of Tab Pane 2"},{"key":"3","label":"Tab 3","children":"Content of Tab Pane 3"}]` | - | +| Prop | Type | Default | Description | +| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | +| `defaultActiveKey` | `string` | `"1"` | - | +| `type` | `string` | `"line"` | The style of tabs. Options: line, card, editable-card. | +| `tabPosition` | `string` | `"top"` | Position of tabs. Options: top, bottom, left, right. | +| `size` | `string` | `"middle"` | Size of the tabs. | +| `animated` | `boolean` | `true` | Whether to animate tab transitions. | +| `centered` | `boolean` | `false` | Whether to center the tabs. | +| `tabBarGutter` | `number` | `8` | The gap between tabs. | +| `items` | `any` | `[{"key":"1","label":"Tab 1","children":"Content of Tab Pane 1"},{"key":"2","label":"Tab 2","children":"Content of Tab Pane 2"},{"key":"3","label":"Tab 3","children":"Content of Tab Pane 3"}]` | - | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/timer.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/timer.mdx index 3fcc13fb02a..e945c6efda0 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/timer.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/timer.mdx @@ -33,33 +33,34 @@ A live elapsed-time display that counts up from a given start time. Used to show ## Try It @@ -72,11 +73,7 @@ function Demo() { const [startTime] = React.useState(Date.now()); return (
    - + @@ -92,8 +89,19 @@ function StatusVariants() { const [startTime] = React.useState(Date.now()); return (
    - {['success', 'warning', 'danger', 'info', 'default', 'primary', 'secondary'].map(status => ( -
    + {[ + 'success', + 'warning', + 'danger', + 'info', + 'default', + 'primary', + 'secondary', + ].map(status => ( +
    {status}
    @@ -152,11 +160,11 @@ function StartStop() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `isRunning` | `boolean` | `true` | Whether the timer is actively counting. Toggle to start/stop. | -| `status` | `string` | `"success"` | Visual status of the timer badge. | -| `startTime` | `number` | `1737936000000` | - | +| Prop | Type | Default | Description | +| ----------- | --------- | --------------- | ------------------------------------------------------------- | +| `isRunning` | `boolean` | `true` | Whether the timer is actively counting. Toggle to start/stop. | +| `status` | `string` | `"success"` | Visual status of the timer badge. | +| `startTime` | `number` | `1737936000000` | - | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tooltip.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tooltip.mdx index a04a20a9464..b59197bb64c 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tooltip.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tooltip.mdx @@ -33,69 +33,65 @@ The Tooltip component from Superset's UI library. ## Try It @@ -116,7 +112,16 @@ function Demo() { ```tsx live function Placements() { - const placements = ['top', 'bottom', 'left', 'right', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight']; + const placements = [ + 'top', + 'bottom', + 'left', + 'right', + 'topLeft', + 'topRight', + 'bottomLeft', + 'bottomRight', + ]; return (
    {placements.map(placement => ( @@ -151,11 +156,11 @@ function Triggers() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `title` | `string` | `"Simple tooltip text"` | Text or content shown in the tooltip. | -| `mouseEnterDelay` | `number` | `0.1` | Delay in seconds before showing the tooltip on hover. | -| `mouseLeaveDelay` | `number` | `0.1` | Delay in seconds before hiding the tooltip after mouse leave. | +| Prop | Type | Default | Description | +| ----------------- | -------- | ----------------------- | ------------------------------------------------------------- | +| `title` | `string` | `"Simple tooltip text"` | Text or content shown in the tooltip. | +| `mouseEnterDelay` | `number` | `0.1` | Delay in seconds before showing the tooltip on hover. | +| `mouseLeaveDelay` | `number` | `0.1` | Delay in seconds before hiding the tooltip after mouse leave. | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tree.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tree.mdx index 9920238ae34..dfdd6db55a5 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tree.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tree.mdx @@ -33,119 +33,116 @@ The Tree component is used to display hierarchical data in a tree structure. It ## Try It @@ -241,18 +238,18 @@ function LinesAndIcons() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `checkable` | `boolean` | `false` | Add a Checkbox before the treeNodes | -| `defaultExpandAll` | `boolean` | `false` | Whether to expand all treeNodes by default | -| `disabled` | `boolean` | `false` | Whether disabled the tree | -| `draggable` | `boolean` | `false` | Specifies whether this Tree or the node is draggable | -| `multiple` | `boolean` | `false` | Allows selecting multiple treeNodes | -| `selectable` | `boolean` | `true` | Whether can be selected | -| `showIcon` | `boolean` | `false` | Controls whether to display the icon node | -| `showLine` | `boolean` | `false` | Shows a connecting line | -| `treeData` | `any` | `[{"title":"parent 1","key":"0-0","children":[{"title":"parent 1-0","key":"0-0-0","children":[{"title":"leaf","key":"0-0-0-0"},{"title":"leaf","key":"0-0-0-1"},{"title":"leaf","key":"0-0-0-2"}]},{"title":"parent 1-1","key":"0-0-1","children":[{"title":"leaf","key":"0-0-1-0"}]},{"title":"parent 1-2","key":"0-0-2","children":[{"title":"leaf","key":"0-0-2-0"},{"title":"leaf","key":"0-0-2-1"}]}]}]` | - | -| `defaultExpandedKeys` | `any` | `["0-0","0-0-0"]` | - | +| Prop | Type | Default | Description | +| --------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| `checkable` | `boolean` | `false` | Add a Checkbox before the treeNodes | +| `defaultExpandAll` | `boolean` | `false` | Whether to expand all treeNodes by default | +| `disabled` | `boolean` | `false` | Whether disabled the tree | +| `draggable` | `boolean` | `false` | Specifies whether this Tree or the node is draggable | +| `multiple` | `boolean` | `false` | Allows selecting multiple treeNodes | +| `selectable` | `boolean` | `true` | Whether can be selected | +| `showIcon` | `boolean` | `false` | Controls whether to display the icon node | +| `showLine` | `boolean` | `false` | Shows a connecting line | +| `treeData` | `any` | `[{"title":"parent 1","key":"0-0","children":[{"title":"parent 1-0","key":"0-0-0","children":[{"title":"leaf","key":"0-0-0-0"},{"title":"leaf","key":"0-0-0-1"},{"title":"leaf","key":"0-0-0-2"}]},{"title":"parent 1-1","key":"0-0-1","children":[{"title":"leaf","key":"0-0-1-0"}]},{"title":"parent 1-2","key":"0-0-2","children":[{"title":"leaf","key":"0-0-2-0"},{"title":"leaf","key":"0-0-2-1"}]}]}]` | - | +| `defaultExpandedKeys` | `any` | `["0-0","0-0-0"]` | - | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/treeselect.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/treeselect.mdx index 613e4cbd24c..5c28e2bf020 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/treeselect.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/treeselect.mdx @@ -33,115 +33,107 @@ TreeSelect is a select component that allows users to select from a tree structu ## Try It @@ -258,19 +250,19 @@ function TreeLinesDemo() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `allowClear` | `boolean` | `true` | Whether to allow clearing the selected value. | -| `disabled` | `boolean` | `false` | Whether the component is disabled. | -| `multiple` | `boolean` | `false` | Whether to allow multiple selections. | -| `placeholder` | `string` | `"Please select"` | Placeholder text for the input field. | -| `showSearch` | `boolean` | `true` | Whether to show the search input. | -| `size` | `string` | `"middle"` | Size of the component. | -| `treeCheckable` | `boolean` | `false` | Whether to show checkable tree nodes. | -| `treeDefaultExpandAll` | `boolean` | `true` | Whether to expand all tree nodes by default. | -| `treeLine` | `boolean` | `false` | Whether to show tree lines. | -| `variant` | `string` | `"outlined"` | Variant of the component. | -| `treeData` | `any` | `[{"title":"Node1","value":"0-0","children":[{"title":"Child Node1","value":"0-0-0"},{"title":"Child Node2","value":"0-0-1"}]},{"title":"Node2","value":"0-1","children":[{"title":"Child Node3","value":"0-1-0"}]}]` | - | +| Prop | Type | Default | Description | +| ---------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | +| `allowClear` | `boolean` | `true` | Whether to allow clearing the selected value. | +| `disabled` | `boolean` | `false` | Whether the component is disabled. | +| `multiple` | `boolean` | `false` | Whether to allow multiple selections. | +| `placeholder` | `string` | `"Please select"` | Placeholder text for the input field. | +| `showSearch` | `boolean` | `true` | Whether to show the search input. | +| `size` | `string` | `"middle"` | Size of the component. | +| `treeCheckable` | `boolean` | `false` | Whether to show checkable tree nodes. | +| `treeDefaultExpandAll` | `boolean` | `true` | Whether to expand all tree nodes by default. | +| `treeLine` | `boolean` | `false` | Whether to show tree lines. | +| `variant` | `string` | `"outlined"` | Variant of the component. | +| `treeData` | `any` | `[{"title":"Node1","value":"0-0","children":[{"title":"Child Node1","value":"0-0-0"},{"title":"Child Node2","value":"0-0-1"}]},{"title":"Node2","value":"0-1","children":[{"title":"Child Node3","value":"0-1-0"}]}]` | - | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/typography.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/typography.mdx index 3b645dbf6e4..7ab391db238 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/typography.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/typography.mdx @@ -34,98 +34,93 @@ Typography is a component for displaying text with various styles and formats. I component="Typography" renderComponent="Typography.Text" props={{ - children: "Sample Text", - code: false, - copyable: false, - delete: false, - disabled: false, - ellipsis: false, - keyboard: false, - mark: false, - italic: false, - underline: false, - strong: false -}} + children: 'Sample Text', + code: false, + copyable: false, + delete: false, + disabled: false, + ellipsis: false, + keyboard: false, + mark: false, + italic: false, + underline: false, + strong: false, + }} controls={[ - { - name: "children", - label: "Children", - type: "text", - description: "The text content." - }, - { - name: "code", - label: "Code", - type: "boolean", - description: "Code style." - }, - { - name: "copyable", - label: "Copyable", - type: "boolean", - description: "Whether the text is copyable." - }, - { - name: "delete", - label: "Delete", - type: "boolean", - description: "Deleted line style." - }, - { - name: "disabled", - label: "Disabled", - type: "boolean", - description: "Disabled content." - }, - { - name: "ellipsis", - label: "Ellipsis", - type: "boolean", - description: "Display ellipsis when text overflows." - }, - { - name: "keyboard", - label: "Keyboard", - type: "boolean", - description: "Keyboard style." - }, - { - name: "mark", - label: "Mark", - type: "boolean", - description: "Marked/highlighted style." - }, - { - name: "italic", - label: "Italic", - type: "boolean", - description: "Italic style." - }, - { - name: "underline", - label: "Underline", - type: "boolean", - description: "Underlined style." - }, - { - name: "strong", - label: "Strong", - type: "boolean", - description: "Bold style." - }, - { - name: "type", - label: "Type", - type: "select", - options: [ - "secondary", - "success", - "warning", - "danger" - ], - description: "Text type for semantic coloring." - } -]} + { + name: 'children', + label: 'Children', + type: 'text', + description: 'The text content.', + }, + { + name: 'code', + label: 'Code', + type: 'boolean', + description: 'Code style.', + }, + { + name: 'copyable', + label: 'Copyable', + type: 'boolean', + description: 'Whether the text is copyable.', + }, + { + name: 'delete', + label: 'Delete', + type: 'boolean', + description: 'Deleted line style.', + }, + { + name: 'disabled', + label: 'Disabled', + type: 'boolean', + description: 'Disabled content.', + }, + { + name: 'ellipsis', + label: 'Ellipsis', + type: 'boolean', + description: 'Display ellipsis when text overflows.', + }, + { + name: 'keyboard', + label: 'Keyboard', + type: 'boolean', + description: 'Keyboard style.', + }, + { + name: 'mark', + label: 'Mark', + type: 'boolean', + description: 'Marked/highlighted style.', + }, + { + name: 'italic', + label: 'Italic', + type: 'boolean', + description: 'Italic style.', + }, + { + name: 'underline', + label: 'Underline', + type: 'boolean', + description: 'Underlined style.', + }, + { + name: 'strong', + label: 'Strong', + type: 'boolean', + description: 'Bold style.', + }, + { + name: 'type', + label: 'Type', + type: 'select', + options: ['secondary', 'success', 'warning', 'danger'], + description: 'Text type for semantic coloring.', + }, + ]} /> ## Try It @@ -172,8 +167,9 @@ function AllSubcomponents() {
    Typography Components - The Typography component includes several subcomponents for different text needs. - Use Title for headings, + The Typography component includes several subcomponents for different + text needs. Use Title for + headings, Text for inline text styling, and Paragraph for block content. @@ -208,19 +204,19 @@ function TextStyles() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `children` | `string` | `"Sample Text"` | The text content. | -| `code` | `boolean` | `false` | Code style. | -| `copyable` | `boolean` | `false` | Whether the text is copyable. | -| `delete` | `boolean` | `false` | Deleted line style. | -| `disabled` | `boolean` | `false` | Disabled content. | -| `ellipsis` | `boolean` | `false` | Display ellipsis when text overflows. | -| `keyboard` | `boolean` | `false` | Keyboard style. | -| `mark` | `boolean` | `false` | Marked/highlighted style. | -| `italic` | `boolean` | `false` | Italic style. | -| `underline` | `boolean` | `false` | Underlined style. | -| `strong` | `boolean` | `false` | Bold style. | +| Prop | Type | Default | Description | +| ----------- | --------- | --------------- | ------------------------------------- | +| `children` | `string` | `"Sample Text"` | The text content. | +| `code` | `boolean` | `false` | Code style. | +| `copyable` | `boolean` | `false` | Whether the text is copyable. | +| `delete` | `boolean` | `false` | Deleted line style. | +| `disabled` | `boolean` | `false` | Disabled content. | +| `ellipsis` | `boolean` | `false` | Display ellipsis when text overflows. | +| `keyboard` | `boolean` | `false` | Keyboard style. | +| `mark` | `boolean` | `false` | Marked/highlighted style. | +| `italic` | `boolean` | `false` | Italic style. | +| `underline` | `boolean` | `false` | Underlined style. | +| `strong` | `boolean` | `false` | Bold style. | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/unsavedchangesmodal.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/unsavedchangesmodal.mdx index 493c20b310e..242a6fdb57c 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/unsavedchangesmodal.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/unsavedchangesmodal.mdx @@ -33,23 +33,23 @@ The UnsavedChangesModal component from Superset's UI library. @@ -69,8 +69,14 @@ function Demo() { setShow(false)} - handleSave={() => { alert('Saved!'); setShow(false); }} - onConfirmNavigation={() => { alert('Discarded changes'); setShow(false); }} + handleSave={() => { + alert('Saved!'); + setShow(false); + }} + onConfirmNavigation={() => { + alert('Discarded changes'); + setShow(false); + }} title="Unsaved Changes" > If you don't save, changes will be lost. @@ -87,9 +93,7 @@ function CustomTitle() { const [show, setShow] = React.useState(false); return (
    - + setShow(false)} @@ -97,8 +101,8 @@ function CustomTitle() { onConfirmNavigation={() => setShow(false)} title="You have unsaved dashboard changes" > - Your dashboard layout and filter changes have not been saved. - Do you want to save before leaving? + Your dashboard layout and filter changes have not been saved. Do you + want to save before leaving?
    ); @@ -107,10 +111,10 @@ function CustomTitle() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `showModal` | `boolean` | `false` | Whether the modal is visible. | -| `title` | `string` | `"Unsaved Changes"` | Title text displayed in the modal header. | +| Prop | Type | Default | Description | +| ----------- | --------- | ------------------- | ----------------------------------------- | +| `showModal` | `boolean` | `false` | Whether the modal is visible. | +| `title` | `string` | `"Unsaved Changes"` | Title text displayed in the modal header. | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/upload.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/upload.mdx index 1f4e72e0466..26470701317 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/upload.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/upload.mdx @@ -33,44 +33,41 @@ Upload component for file selection and uploading. Supports drag-and-drop, multi ## Try It @@ -91,11 +88,7 @@ function Demo() { ```tsx live function PictureCard() { - return ( - - + Upload - - ); + return + Upload; } ``` @@ -115,12 +108,12 @@ function DragDrop() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `multiple` | `boolean` | `false` | Support multiple file selection. | -| `disabled` | `boolean` | `false` | Disable the upload button. | -| `listType` | `string` | `"text"` | Built-in style for the file list display. | -| `showUploadList` | `boolean` | `true` | Whether to show the upload file list. | +| Prop | Type | Default | Description | +| ---------------- | --------- | -------- | ----------------------------------------- | +| `multiple` | `boolean` | `false` | Support multiple file selection. | +| `disabled` | `boolean` | `false` | Disable the upload button. | +| `listType` | `string` | `"text"` | Built-in style for the file list display. | +| `showUploadList` | `boolean` | `true` | Whether to show the upload file list. | ## Import diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/code-review.md b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/code-review.md index f002c78d7ca..f9250c6ed3e 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/code-review.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/code-review.md @@ -35,6 +35,7 @@ Code review is a critical part of maintaining code quality and sharing knowledge ### Preparing for Review #### Before Requesting Review + - [ ] Self-review your changes - [ ] Ensure CI checks pass - [ ] Add comprehensive tests @@ -43,6 +44,7 @@ Code review is a critical part of maintaining code quality and sharing knowledge - [ ] Add screenshots for UI changes #### Self-Review Checklist + ```bash # View your changes git diff upstream/master @@ -59,18 +61,23 @@ git diff upstream/master ### Requesting Review #### Auto-Assignment + GitHub will automatically request reviews based on CODEOWNERS file. #### Manual Assignment + For specific expertise, request additional reviewers: + - Frontend changes: Tag frontend experts - Backend changes: Tag backend experts - Security changes: Tag security team - Database changes: Tag database experts #### Review Request Message + ```markdown @reviewer This PR implements [feature]. Could you please review: + 1. The approach taken in [file] 2. Performance implications of [change] 3. Security considerations for [feature] @@ -81,23 +88,29 @@ Thanks! ### Responding to Feedback #### Best Practices + - **Be receptive**: Reviews improve code quality - **Ask questions**: Clarify if feedback is unclear - **Explain decisions**: Share context for your choices - **Update promptly**: Address feedback in timely manner #### Comment Responses + ```markdown # Acknowledging + "Good catch! Fixed in [commit hash]" # Explaining + "I chose this approach because [reason]. Would you prefer [alternative]?" # Questioning + "Could you elaborate on [concern]? I'm not sure I understand the issue." # Disagreeing respectfully + "I see your point, but I think [current approach] because [reason]. What do you think?" ``` @@ -106,6 +119,7 @@ Thanks! ### Review Responsibilities #### What to Review + 1. **Correctness**: Does the code do what it claims? 2. **Design**: Is the approach appropriate? 3. **Clarity**: Is the code readable and maintainable? @@ -117,12 +131,14 @@ Thanks! ### Review Checklist #### Functionality + - [ ] Feature works as described - [ ] Edge cases are handled - [ ] Error handling is appropriate - [ ] Backwards compatibility maintained #### Code Quality + - [ ] Follows project conventions - [ ] No code duplication - [ ] Clear variable/function names @@ -130,6 +146,7 @@ Thanks! - [ ] SOLID principles followed #### Testing + - [ ] Unit tests for business logic - [ ] Integration tests for APIs - [ ] E2E tests for critical paths @@ -137,6 +154,7 @@ Thanks! - [ ] Good test coverage #### Security + - [ ] Input validation - [ ] SQL injection prevention - [ ] XSS prevention @@ -145,6 +163,7 @@ Thanks! - [ ] No sensitive data in logs #### Performance + - [ ] Database queries optimized - [ ] No N+1 queries - [ ] Appropriate caching @@ -176,11 +195,13 @@ re-renders when dependencies haven't changed." #### Comment Types **Use GitHub's comment types:** + - **Comment**: General feedback or questions - **Approve**: Changes look good - **Request Changes**: Must be addressed before merge **Prefix conventions:** + - `nit:` Minor issue (non-blocking) - `suggestion:` Recommended improvement - `question:` Seeking clarification @@ -206,12 +227,15 @@ praise: Excellent test coverage! πŸ‘ ### Timeline #### Expected Response Times + - **Initial review**: Within 2-3 business days - **Follow-up review**: Within 1-2 business days - **Critical fixes**: ASAP (tag in Slack) #### Escalation + If no response after 3 days: + 1. Ping reviewer in PR comments 2. Ask in #development Slack channel 3. Tag @apache/superset-committers @@ -219,11 +243,13 @@ If no response after 3 days: ### Approval Requirements #### Minimum Requirements + - **1 approval** from a committer for minor changes - **2 approvals** for significant features - **3 approvals** for breaking changes #### Special Cases + - **Security changes**: Require security team review - **API changes**: Require API team review - **Database migrations**: Require database expert review @@ -232,16 +258,19 @@ If no response after 3 days: ### Merge Process #### Who Can Merge + - Committers with write access - After all requirements met - CI checks must pass #### Merge Methods + - **Squash and merge**: Default for feature PRs - **Rebase and merge**: For clean history - **Create merge commit**: Rarely used #### Merge Checklist + - [ ] All CI checks green - [ ] Required approvals obtained - [ ] No unresolved conversations @@ -251,6 +280,7 @@ If no response after 3 days: ## Review Etiquette ### Do's + - βœ… Be kind and constructive - βœ… Acknowledge time and effort - βœ… Provide specific examples @@ -260,6 +290,7 @@ If no response after 3 days: - βœ… Focus on the code, not the person ### Don'ts + - ❌ Use harsh or dismissive language - ❌ Bikeshed on minor preferences - ❌ Review when tired or frustrated @@ -270,6 +301,7 @@ If no response after 3 days: ## Becoming a Reviewer ### Path to Reviewer + 1. **Contribute regularly**: Submit quality PRs 2. **Participate in discussions**: Share knowledge 3. **Review others' code**: Start with comments @@ -277,6 +309,7 @@ If no response after 3 days: 5. **Get nominated**: By existing committers ### Reviewer Expectations + - Review PRs in your area of expertise - Respond within reasonable time - Mentor new contributors @@ -288,6 +321,7 @@ If no response after 3 days: ### Reviewing Large PRs #### Strategy + 1. **Request splitting**: Ask to break into smaller PRs 2. **Review in phases**: - Architecture/approach first @@ -298,6 +332,7 @@ If no response after 3 days: ### Cross-Team Reviews #### When Needed + - Changes affecting multiple teams - Shared components/libraries - API contract changes @@ -306,6 +341,7 @@ If no response after 3 days: ### Performance Reviews #### Tools + ```python # Backend performance import cProfile @@ -327,11 +363,13 @@ stats.sort_stats('cumulative').print_stats(10) ## Resources ### Internal + - [Coding Guidelines](../guidelines/design-guidelines.md) - [Testing Guide](../testing/overview.md) - [Extension Architecture](../extensions/architecture.md) ### External + - [Google's Code Review Guide](https://google.github.io/eng-practices/review/) - [Best Practices for Code Review](https://smartbear.com/learn/code-review/best-practices-for-peer-code-review/) - [The Art of Readable Code](https://www.oreilly.com/library/view/the-art-of/9781449318482/) diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/development-setup.md b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/development-setup.md index 6a8bca85fd2..34afcc32185 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/development-setup.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/development-setup.md @@ -149,6 +149,7 @@ make up ``` This automatically: + - Generates a unique project name from your directory name - Finds available ports (incrementing from 8088, 9000, etc. if already in use) - Displays the assigned URLs before starting @@ -157,16 +158,16 @@ Each clone gets isolated containers and volumes, so you can run them side-by-sid Available commands (run from repo root): -| Command | Description | -|---------|-------------| -| `make up` | Start services (foreground) | -| `make up-detached` | Start services (background) | -| `make down` | Stop all services | -| `make ps` | Show running containers | -| `make logs` | Follow container logs | -| `make ports` | Show assigned URLs and ports | -| `make open` | Open browser to dev server | -| `make nuke` | Stop, remove volumes & local images | +| Command | Description | +| ------------------ | ----------------------------------- | +| `make up` | Start services (foreground) | +| `make up-detached` | Start services (background) | +| `make down` | Stop all services | +| `make ps` | Show running containers | +| `make logs` | Follow container logs | +| `make ports` | Show assigned URLs and ports | +| `make open` | Open browser to dev server | +| `make nuke` | Stop, remove volumes & local images | From a subdirectory, use: `make -C $(git rev-parse --show-toplevel) up` @@ -177,6 +178,7 @@ Always use these commands instead of plain `docker compose down`, which won't kn ## GitHub Codespaces (Cloud Development) GitHub Codespaces provides a complete, pre-configured development environment in the cloud. This is ideal for: + - Quick contributions without local setup - Consistent development environments across team members - Working from devices that can't run Docker locally @@ -323,17 +325,21 @@ You can also run the pre-commit checks manually in various ways: ## Working with LLMs ### Environment Setup + Ensure Docker Compose is running before starting LLM sessions: + ```bash docker compose up ``` Validate your environment: + ```bash curl -f http://localhost:8088/health && echo "βœ… Superset ready" ``` ### LLM Session Best Practices + - Always validate environment setup first using the health checks above - Use focused validation commands: `pre-commit run` (not `--all-files`) - **Read [LLMS.md](https://github.com/apache/superset/blob/master/LLMS.md) first** - Contains comprehensive development guidelines, coding standards, and critical refactor information @@ -345,6 +351,7 @@ curl -f http://localhost:8088/health && echo "βœ… Superset ready" - Follow the TypeScript migration guidelines and avoid deprecated patterns listed in LLMS.md ### Key Development Commands + ```bash # Frontend development cd superset-frontend @@ -645,7 +652,7 @@ If you want to use the same flag in the client code, also add it to the FeatureF ```typescript export enum FeatureFlag { - SCOPED_FILTER = "SCOPED_FILTER", + SCOPED_FILTER = 'SCOPED_FILTER', } ``` @@ -814,6 +821,7 @@ If Jest tests hang with "Jest did not exit one second after the test run has com **To verify if still needed**: Remove the MessageChannel mocking lines and run `npm test -- --shard=4/8`. If tests hang, the workaround is still required. **Future removal conditions**: This workaround can be removed when: + - rc-overflow updates to properly clean up MessagePorts in test environments - Jest updates to handle MessageChannel/MessagePort cleanup better - Ant Design switches away from rc-overflow @@ -958,9 +966,9 @@ VSCode will not stop on breakpoints right away. We've attached to PID 6 however To debug Flask running in POD inside a kubernetes cluster, you'll need to make sure the pod runs as root and is granted the SYS_TRACE capability.These settings should not be used in production environments. ```yaml - securityContext: - capabilities: - add: ["SYS_PTRACE"] +securityContext: + capabilities: + add: ['SYS_PTRACE'] ``` See [set capabilities for a container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container) for more details. diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/guidelines.md b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/guidelines.md index c62b6d4eca8..36b20f5be3c 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/guidelines.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/guidelines.md @@ -130,8 +130,8 @@ Triaging goals First, add **Category labels (a.k.a. hash labels)**. Every issue/PR must have one hash label (except spam entry). Labels that begin with `#` defines issue/PR type: -| Label | for Issue | for PR | -| --------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| Label | for Issue | for PR | +| --------------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | `#bug` | Bug report | Bug fix | | `#code-quality` | Describe problem with code, architecture or productivity | Refactor, tests, tooling | | `#feature` | New feature request | New feature implementation | @@ -175,12 +175,14 @@ Should you decide that reverting is desirable, it is the responsibility of the C - **Put the revert through code review:** The revert must be approved by another committer. **Revert liberally to keep `master` stable**: + - Build failures - Test failures - Critical bugs in production - Security vulnerabilities **How to revert**: + 1. Use GitHub's revert button when possible 2. Create a PR with clear explanation 3. Tag the original author @@ -211,11 +213,13 @@ Sentence case: "A dog takes a walk in Paris" - It's the easiest form to distinguish between common and proper nouns **Good examples:** + - "Select a database" - "Create new chart" - "View all dashboards" **Bad examples:** + - "Select a Database" - "Create New Chart" - "View All Dashboards" @@ -240,6 +244,7 @@ Often a product page will have the same title as the objects it contains. In thi - Create custom queries in SQL Lab then create dashboards When writing about UI elements: + - Use **bold** for clickable elements: "Click **Save**" - Use quotes for text fields: 'Enter "My Dashboard" in the name field' - Be specific about element types: button, link, dropdown, etc. @@ -247,6 +252,7 @@ When writing about UI elements: #### **Exceptions to sentence case Only use title case for: + - Product names (Apache Superset) - Proper nouns - Acronyms (SQL, API, CSV) @@ -258,10 +264,12 @@ Only use title case for: ### Python We use: + - **[Ruff](https://docs.astral.sh/ruff/)** for linting and formatting - **[Mypy](http://mypy-lang.org/)** for type checking Python code should: + - Follow PEP 8 - Use type hints for all new code - Use descriptive variable names @@ -336,6 +344,7 @@ def process_data( ``` Use `mypy` to check types: + ```bash mypy superset ``` @@ -343,8 +352,9 @@ mypy superset ### TypeScript We use: + - **ESLint** for linting -- **Prettier** for formatting +- **Prettier** for formatting - **TypeScript** strict mode TypeScript is fully supported and is the recommended language for writing all new frontend @@ -353,6 +363,7 @@ appreciated, but not required. Examples of migrating functions/components to Typ found in [#9162](https://github.com/apache/superset/pull/9162) and [#9180](https://github.com/apache/superset/pull/9180). TypeScript code should: + - Avoid `any` types - use proper TypeScript types - Use functional components with hooks for React - Include JSDoc comments for complex functions @@ -360,6 +371,7 @@ TypeScript code should: - Handle errors appropriately Example: + ```typescript interface User { id: number; @@ -411,5 +423,6 @@ Bad: "Fixed stuff" ## Questions? If you have questions about these guidelines, ask in: + - [Slack #development](https://apache-superset.slack.com) - [GitHub Discussions](https://github.com/apache/superset/discussions) diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/howtos.md b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/howtos.md index 40ae473183f..0c9360e2eb7 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/howtos.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/howtos.md @@ -68,11 +68,13 @@ Visualization plugins allow you to add custom chart types to Superset. They are ### Creating a simple Hello World viz plugin 1. **Install the Superset Yeoman generator**: + ```bash npm install -g @superset-ui/generator-superset ``` 2. **Create a new plugin**: + ```bash mkdir superset-plugin-chart-hello-world cd superset-plugin-chart-hello-world @@ -80,19 +82,22 @@ yo @superset-ui/superset ``` 3. **Follow the prompts**: + - Package name: `superset-plugin-chart-hello-world` - Chart type: Choose your preferred type - Include storybook: Yes (recommended for development) 4. **Develop your plugin**: -The generator creates a complete plugin structure with TypeScript, React components, and build configuration. + The generator creates a complete plugin structure with TypeScript, React components, and build configuration. 5. **Test your plugin locally**: + ```bash npm run dev ``` 6. **Link to your local Superset**: + ```bash npm link # In your Superset frontend directory: @@ -100,7 +105,7 @@ npm link superset-plugin-chart-hello-world ``` 7. **Import and register in Superset**: -Edit `superset-frontend/src/visualizations/presets/MainPreset.ts` to include your plugin. + Edit `superset-frontend/src/visualizations/presets/MainPreset.ts` to include your plugin. ## Testing @@ -121,7 +126,7 @@ pytest --cov=superset # Run only unit tests pytest tests/unit_tests -# Run only integration tests +# Run only integration tests pytest tests/integration_tests ``` @@ -234,6 +239,7 @@ For debugging the Flask backend: #### Using VS Code 1. Add to `.vscode/launch.json`: + ```json { "version": "0.2.0", @@ -261,9 +267,9 @@ For debugging the Flask backend: To debug Flask running in a POD inside a kubernetes cluster, you'll need to make sure the pod runs as root and is granted the `SYS_PTRACE` capability. These settings should not be used in production environments. ```yaml - securityContext: - capabilities: - add: ["SYS_PTRACE"] +securityContext: + capabilities: + add: ['SYS_PTRACE'] ``` See [set capabilities for a container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container) for more details. @@ -409,6 +415,7 @@ The linting system consists of two components: **"Plugin 'basic-custom-plugin' not found" Error** Ensure you're using the explicit config: + ```bash npx oxlint --config oxlint.json ``` @@ -416,6 +423,7 @@ npx oxlint --config oxlint.json **Custom Rules Not Running** Verify the AST parsing dependencies are installed: + ```bash npm ls @babel/parser @babel/traverse glob ``` @@ -434,6 +442,7 @@ For every PR, an ephemeral environment is automatically deployed for testing. Access pattern: `https://pr-{PR_NUMBER}.superset.apache.org` Features: + - Automatically deployed on PR creation/update - Includes sample data - Destroyed when PR is closed @@ -463,6 +472,7 @@ docker compose up **Frontend**: Webpack dev server provides hot module replacement automatically. **Backend**: Use Flask debug mode: + ```bash FLASK_ENV=development superset run -p 8088 --with-threads --reload ``` @@ -470,12 +480,14 @@ FLASK_ENV=development superset run -p 8088 --with-threads --reload ### Performance Profiling For Python profiling: + ```python # In superset_config.py PROFILING = True ``` For React profiling: + - Use React DevTools Profiler - Enable performance marks in Chrome DevTools @@ -573,6 +585,7 @@ To do this, you'll need to: ``` Note that: + - for changes that affect the worker logic, you'll have to restart the `celery worker` process for the changes to be reflected. - The message queue used is a `sqlite` database using the `SQLAlchemy` experimental broker. Ok for testing, but not recommended in production - In some cases, you may want to create a context that is more aligned to your production environment, and use the similar broker as well as results backend configuration diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/issue-reporting.md b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/issue-reporting.md index 3bf1de8dc90..807b0de86f9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/issue-reporting.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/issue-reporting.md @@ -31,6 +31,7 @@ Learn how to effectively report bugs and request features for Apache Superset. ### Pre-Issue Checklist 1. **Search Existing Issues** + ``` Search: https://github.com/apache/superset/issues - Use keywords from your error message @@ -44,6 +45,7 @@ Learn how to effectively report bugs and request features for Apache Superset. - [Configuration Guide](https://superset.apache.org/docs/configuration/configuring-superset) 3. **Verify Version** + ```bash # Check Superset version superset version @@ -63,24 +65,30 @@ Learn how to effectively report bugs and request features for Apache Superset. ```markdown ### Bug Description + A clear and concise description of the bug. ### How to Reproduce + 1. Go to '...' 2. Click on '...' 3. Scroll down to '...' 4. See error ### Expected Behavior + What you expected to happen. ### Actual Behavior + What actually happened. Include error messages. ### Screenshots/Videos + If applicable, add screenshots or recordings. ### Environment + - Superset version: [e.g., 3.0.0] - Python version: [e.g., 3.9.7] - Node version: [e.g., 18.17.0] @@ -89,6 +97,7 @@ If applicable, add screenshots or recordings. - OS: [e.g., Ubuntu 22.04] ### Additional Context + - Using Docker: Yes/No - Configuration overrides: - Feature flags enabled: @@ -98,12 +107,15 @@ If applicable, add screenshots or recordings. ### What Makes a Good Bug Report #### βœ… Good Example + ```markdown ### Bug Description + When filtering a dashboard with a date range filter, charts using SQL Lab datasets don't update, while charts using regular datasets do. ### How to Reproduce + 1. Create a dashboard with 2 charts: - Chart A: Uses a SQL Lab virtual dataset - Chart B: Uses a regular table dataset @@ -112,18 +124,22 @@ SQL Lab datasets don't update, while charts using regular datasets do. 4. Chart B updates, Chart A shows no change ### Expected Behavior + Both charts should filter to show last 30 days of data. ### Actual Behavior + Only Chart B updates. Chart A still shows all data. No error messages in browser console or server logs. ### Screenshots + [Dashboard before filter]: attachment1.png [Dashboard after filter]: attachment2.png [Network tab showing requests]: attachment3.png ### Environment + - Superset version: 3.0.0 - Python version: 3.9.16 - Database: PostgreSQL 14.9 @@ -132,6 +148,7 @@ No error messages in browser console or server logs. ``` #### ❌ Poor Example + ```markdown Dashboard filters don't work. Please fix. ``` @@ -139,6 +156,7 @@ Dashboard filters don't work. Please fix. ### Required Information #### Error Messages + ```python # Include full error traceback Traceback (most recent call last): @@ -148,6 +166,7 @@ SupersetException: Detailed error message ``` #### Logs + ```bash # Backend logs docker logs superset_app 2>&1 | tail -100 @@ -157,6 +176,7 @@ tail -f ~/.superset/superset.log ``` #### Browser Console + ```javascript // Include JavaScript errors // Chrome: F12 β†’ Console tab @@ -165,6 +185,7 @@ tail -f ~/.superset/superset.log ``` #### Configuration + ```python # Relevant config from superset_config.py FEATURE_FLAGS = { @@ -179,18 +200,23 @@ FEATURE_FLAGS = { ```markdown ### Is your feature request related to a problem? + A clear description of the problem you're trying to solve. ### Describe the solution you'd like + A clear description of what you want to happen. ### Describe alternatives you've considered + Other solutions or features you've considered. ### Additional context + Any other context, mockups, or examples. ### Are you willing to contribute? + - [ ] Yes, I can implement this feature - [ ] Yes, I can help test - [ ] No, but I can provide feedback @@ -199,6 +225,7 @@ Any other context, mockups, or examples. ### Good Feature Requests Include 1. **Clear Use Case** + ```markdown As a [type of user], I want [feature] so that [benefit]. @@ -224,6 +251,7 @@ Any other context, mockups, or examples. **DO NOT** create public issues for security vulnerabilities! Instead: + 1. Email: security@apache.org 2. Subject: `[Superset] Security Vulnerability` 3. Include: @@ -238,9 +266,11 @@ Instead: Send to: security@apache.org ### Vulnerability Description + [Describe the security issue] ### Type + - [ ] SQL Injection - [ ] XSS - [ ] CSRF @@ -249,27 +279,33 @@ Send to: security@apache.org - [ ] Other: [specify] ### Affected Versions + [List affected versions] ### Steps to Reproduce + [Detailed steps - be specific] ### Impact + [What can an attacker do?] ### Suggested Fix + [If you have suggestions] ``` ## Issue Labels ### Priority Labels + - `P0`: Critical - System unusable - `P1`: High - Major feature broken - `P2`: Medium - Important but workaround exists - `P3`: Low - Nice to have ### Type Labels + - `bug`: Something isn't working - `feature`: New feature request - `enhancement`: Improvement to existing feature @@ -277,6 +313,7 @@ Send to: security@apache.org - `question`: Question about usage ### Component Labels + - `dashboard`: Dashboard functionality - `sqllab`: SQL Lab - `explore`: Chart builder @@ -285,6 +322,7 @@ Send to: security@apache.org - `security`: Security related ### Status Labels + - `needs-triage`: Awaiting review - `confirmed`: Bug confirmed - `in-progress`: Being worked on @@ -294,25 +332,30 @@ Send to: security@apache.org ## Issue Lifecycle ### 1. Creation + - User creates issue with template - Auto-labeled as `needs-triage` ### 2. Triage + - Maintainer reviews within 7 days - Labels applied (priority, type, component) - Questions asked if needed ### 3. Confirmation + - Bug reproduced or feature discussed - Label changed to `confirmed` - Assigned to milestone if applicable ### 4. Development + - Contributor claims issue - Label changed to `in-progress` - PR linked to issue ### 5. Resolution + - PR merged - Issue auto-closed - Or manually closed with explanation @@ -322,6 +365,7 @@ Send to: security@apache.org ### If No Response After 7 days without response: + ```markdown @apache/superset-committers This issue hasn't been triaged yet. Could someone please take a look? @@ -343,6 +387,7 @@ Here's additional debugging information: [details] ## Tips for Success ### Do's + - βœ… Search before creating - βœ… Use templates - βœ… Provide complete information @@ -352,6 +397,7 @@ Here's additional debugging information: [details] - βœ… One issue per report ### Don'ts + - ❌ "+1" or "me too" comments (use reactions) - ❌ Multiple issues in one report - ❌ Vague descriptions @@ -410,6 +456,7 @@ with app.app_context(): ### Issue Not a Bug? Consider: + - **Feature Request**: Use feature request template - **Question**: Use GitHub Discussions - **Configuration Help**: Ask in Slack diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/overview.md b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/overview.md index d0e6c5ba659..465f26d5295 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/overview.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/overview.md @@ -146,7 +146,7 @@ Security team members must: - Have an [ICLA](https://www.apache.org/licenses/contributor-agreements.html) signed with Apache Software Foundation. - Not reveal information about pending and unfixed security issues to anyone (including their employers) unless specifically authorised by the security team members, e.g., if the security team agrees that diagnosing and solving an issue requires the involvement of external experts. -A release manager, the contributor overseeing the release of a specific version of Apache Superset, is by default a member of the security team. However, they are not expected to be active in assessing, discussing, and fixing security issues. +A release manager, the contributor overseeing the release of a specific version of Apache Superset, is by default a member of the security team. However, they are not expected to be active in assessing, discussing, and fixing security issues. Security team members should also follow these general expectations: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/pkg-resources-migration.md b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/pkg-resources-migration.md index 7300b14bc42..bcbe8d36a97 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/pkg-resources-migration.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/pkg-resources-migration.md @@ -61,6 +61,7 @@ Update all dependencies to use `importlib.metadata` instead of `pkg_resources`: #### Migration Example **Old (deprecated):** + ```python import pkg_resources @@ -69,6 +70,7 @@ entry_points = pkg_resources.iter_entry_points("group_name") ``` **New (recommended):** + ```python from importlib.metadata import version, entry_points @@ -79,11 +81,13 @@ eps = entry_points(group="group_name") ## Action Items ### For Superset Maintainers + 1. The Superset codebase already uses `importlib.metadata` 2. Monitor third-party dependencies for updates 3. Update setuptools pin once the ecosystem is ready ### For Extension Developers + 1. **Update your packages** to use `importlib.metadata` instead of `pkg_resources` 2. **Test with setuptools >= 81.0.0** once all packages are migrated diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/release-process.md b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/release-process.md index c0664cb0140..dfa1bd6f740 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/release-process.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/release-process.md @@ -29,6 +29,7 @@ Understand Apache Superset's release process, versioning strategy, and how to pa ## Release Cadence ### Schedule + - **Major releases (X.0.0)**: Annually (approximately) - **Minor releases (X.Y.0)**: Quarterly - **Patch releases (X.Y.Z)**: As needed for critical fixes @@ -46,6 +47,7 @@ MAJOR.MINOR.PATCH ``` ### Examples + - `3.0.0`: Major release with breaking changes - `3.1.0`: Minor release with new features - `3.1.1`: Patch release with bug fixes @@ -55,12 +57,14 @@ MAJOR.MINOR.PATCH ### Major Releases (X.0.0) #### Includes + - Breaking API changes - Deprecated feature removals - Major architectural changes - Database migration requirements #### Process + - 2-3 month preparation period - Multiple release candidates (RC) - Extensive testing period @@ -69,12 +73,14 @@ MAJOR.MINOR.PATCH ### Minor Releases (X.Y.0) #### Includes + - New features - Performance improvements - Non-breaking API additions - Minor UI/UX updates #### Process + - 1 month preparation - 1-2 release candidates - Standard testing period @@ -82,12 +88,14 @@ MAJOR.MINOR.PATCH ### Patch Releases (X.Y.Z) #### Includes + - Bug fixes - Security patches - Documentation fixes - Dependency updates (security) #### Process + - Fast track for critical issues - May skip RC for urgent security fixes - Minimal testing requirements @@ -97,6 +105,7 @@ MAJOR.MINOR.PATCH ### 1. Pre-Release Preparation #### Feature Freeze + ```bash # Create release branch git checkout -b release-X.Y @@ -108,40 +117,49 @@ VERSION = "X.Y.0rc1" ``` #### Update Documentation + - CHANGELOG.md - UPDATING.md (for breaking changes) - Documentation version #### Release Notes Template + ```markdown # Apache Superset X.Y.0 ## πŸŽ‰ Highlights + - Major feature 1 - Major feature 2 ## πŸš€ New Features + - Feature 1 (#PR) - Feature 2 (#PR) ## πŸ› Bug Fixes + - Fix 1 (#PR) - Fix 2 (#PR) ## ⚠️ Breaking Changes + - Breaking change 1 - Migration required for X ## πŸ“ Documentation + - Doc update 1 (#PR) ## πŸ™ Thank You + Thanks to all contributors! ``` ### 2. Create Release Candidate #### Build RC + ```bash # Tag release candidate git tag -a vX.Y.Zrc1 -m "Apache Superset X.Y.Z RC1" @@ -158,6 +176,7 @@ gpg --armor --detach-sig dist/apache-superset-X.Y.Zrc1.tar.gz ``` #### Upload to staging + ```bash # Upload to Apache staging svn co https://dist.apache.org/repos/dist/dev/superset @@ -202,11 +221,13 @@ Thanks, ``` #### Voting Rules + - **Duration**: Minimum 72 hours - **Required**: 3 +1 votes from PMC members - **Veto**: Any -1 vote must be addressed #### Testing Checklist + ```markdown - [ ] Source builds successfully - [ ] Docker image builds @@ -219,6 +240,7 @@ Thanks, ### 4. Release Approval #### Tally Votes + ``` Subject: [RESULT][VOTE] Release Apache Superset X.Y.Z RC1 @@ -245,6 +267,7 @@ Thank you to everyone who tested and voted! ### 5. Perform Release #### Promote RC to Release + ```bash # Tag final release git tag -a vX.Y.Z -m "Apache Superset X.Y.Z" @@ -256,12 +279,14 @@ svn mv https://dist.apache.org/repos/dist/dev/superset/X.Y.Zrc1 \ ``` #### Publish to PyPI + ```bash # Upload to PyPI python -m twine upload dist/*X.Y.Z* ``` #### Build Docker Images + ```bash # Build and push Docker images docker build -t apache/superset:X.Y.Z . @@ -273,6 +298,7 @@ docker push apache/superset:latest ### 6. Post-Release Tasks #### Update Documentation + ```bash # Update docs version cd docs @@ -310,6 +336,7 @@ The Apache Superset Team ``` #### Update GitHub Release + ```bash # Create GitHub release gh release create vX.Y.Z \ @@ -322,12 +349,14 @@ gh release create vX.Y.Z \ ### During Feature Freeze #### What's Allowed + - βœ… Bug fixes - βœ… Documentation updates - βœ… Test improvements - βœ… Security fixes #### What's Not Allowed + - ❌ New features - ❌ Major refactoring - ❌ Breaking changes @@ -336,6 +365,7 @@ gh release create vX.Y.Z \ ### Testing RCs #### How to Test + ```bash # Install RC from staging pip install https://dist.apache.org/repos/dist/dev/superset/X.Y.Zrc1/apache-superset-X.Y.Zrc1.tar.gz @@ -345,6 +375,7 @@ docker pull apache/superset:X.Y.Zrc1 ``` #### What to Test + - Your use cases - New features mentioned in release notes - Upgrade from previous version @@ -352,8 +383,10 @@ docker pull apache/superset:X.Y.Zrc1 - Critical workflows #### Reporting Issues + ```markdown Found issue in RC1: + - Description: [what's wrong] - Steps to reproduce: [how to trigger] - Impact: [blocker/major/minor] @@ -363,21 +396,26 @@ Found issue in RC1: ### CHANGELOG Maintenance #### Format + ```markdown ## X.Y.Z (YYYY-MM-DD) ### Features + - feat: Description (#PR_NUMBER) ### Fixes + - fix: Description (#PR_NUMBER) ### Breaking Changes + - BREAKING: Description (#PR_NUMBER) Migration: Steps to migrate ``` #### Generating CHANGELOG + ```bash # Use git log to generate initial list git log --oneline vX.Y-1.Z..vX.Y.Z | grep -E "^[a-f0-9]+ (feat|fix|perf|refactor|docs)" @@ -390,31 +428,38 @@ git log --oneline vX.Y-1.Z..vX.Y.Z | grep -E "^[a-f0-9]+ (feat|fix|perf|refactor ### Documentation Required #### UPDATING.md Entry -```markdown + +````markdown # X.Y.Z ## Breaking Change: [Title] ### Description + What changed and why. ### Before + ```python # Old way old_function(param1, param2) ``` +```` ### After + ```python # New way new_function(param1, param2, param3) ``` ### Migration Steps + 1. Update your code to... 2. Run migration script... 3. Test that... -``` + +```` ### Deprecation Process @@ -423,7 +468,7 @@ new_function(param1, param2, param3) @deprecated(version="3.0.0", remove_in="4.0.0") def old_function(): warnings.warn("Use new_function instead", DeprecationWarning) - ``` +```` 2. **Version N+1**: Keep deprecated with warnings @@ -432,12 +477,14 @@ new_function(param1, param2, param3) ## Security Releases ### Expedited Process + - No RC required for critical security fixes - Coordinate with security@apache.org - Embargo period may apply - CVE assignment through ASF security team ### Security Advisory Template + ```markdown CVE-YYYY-XXXXX: [Title] @@ -458,11 +505,13 @@ Credit: ## Resources ### Internal + - [Apache Release Policy](https://www.apache.org/legal/release-policy.html) - [Superset Release History](https://github.com/apache/superset/releases) - [Version Strategy Discussion](https://github.com/apache/superset/discussions) ### Tools + - [Release Scripts](https://github.com/apache/superset/tree/master/scripts/release) - [Superset Repository Scripts](https://github.com/apache/superset/tree/master/scripts) diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/resources.md b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/resources.md index bd159c984f0..ffd9380b0cb 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/resources.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/resources.md @@ -117,16 +117,19 @@ You can also [download the .svg](https://github.com/apache/superset/tree/master/ ## Additional Resources ### Official Documentation + - [Apache Superset Documentation](https://superset.apache.org/docs/intro) - [API Documentation](https://superset.apache.org/docs/api) - [Configuration Guide](https://superset.apache.org/admin-docs/configuration/configuring-superset) ### Community Resources + - [Apache Superset Blog](https://preset.io/blog/) - [YouTube Channel](https://www.youtube.com/channel/UCMuwrvBsg_jjI2gLcm04R0g) - [Twitter/X](https://twitter.com/ApacheSuperset) ### Development Tools + - [GitHub Repository](https://github.com/apache/superset) - [PyPI Package](https://pypi.org/project/apache-superset/) - [Docker Hub](https://hub.docker.com/r/apache/superset) diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/submitting-pr.md b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/submitting-pr.md index 4836aa47f63..4cba6bef9ea 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/contributing/submitting-pr.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/contributing/submitting-pr.md @@ -29,12 +29,14 @@ Learn how to create and submit high-quality pull requests to Apache Superset. ## Before You Start ### Prerequisites + - [ ] Development environment is set up - [ ] You've forked and cloned the repository - [ ] You've read the [contributing overview](./overview.md) - [ ] You've found or created an issue to work on ### PR Readiness Checklist + - [ ] Code follows [coding guidelines](../guidelines/design-guidelines.md) - [ ] Tests are passing locally - [ ] Linting passes (`pre-commit run --all-files`) @@ -82,6 +84,7 @@ type(scope): description ``` **Types:** + - `feat`: New feature - `fix`: Bug fix - `docs`: Documentation only @@ -95,6 +98,7 @@ type(scope): description - `revert`: Reverting changes **Scopes:** + - `dashboard`: Dashboard functionality - `sqllab`: SQL Lab features - `explore`: Chart explorer @@ -105,6 +109,7 @@ type(scope): description - `config`: Configuration **Examples:** + ``` feat(sqllab): add query cost estimation fix(dashboard): resolve filter cascading issue @@ -119,23 +124,28 @@ Use the template from `.github/PULL_REQUEST_TEMPLATE.md`: ```markdown ### SUMMARY + Brief description of changes and motivation. ### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF + [Required for UI changes] ### TESTING INSTRUCTIONS + 1. Step-by-step instructions 2. How to verify the fix/feature 3. Any specific test scenarios ### ADDITIONAL INFORMATION + - [ ] Has associated issue: #12345 - [ ] Required feature flags: - [ ] API changes: - [ ] DB migration required: ### CHECKLIST + - [ ] CI checks pass - [ ] Tests added/updated - [ ] Documentation updated @@ -158,11 +168,13 @@ gh pr create --title "feat(sqllab): add query cost estimation" \ ## PR Best Practices ### Keep PRs Focused + - One feature/fix per PR - Break large changes into smaller PRs - Separate refactoring from feature changes ### Write Good Commit Messages + ```bash # Good git commit -m "fix(dashboard): prevent duplicate API calls when filters change" @@ -173,6 +185,7 @@ git commit -m "updates" ``` ### Include Tests + ```python # Backend test example def test_new_feature(): @@ -190,15 +203,19 @@ test('renders new component', () => { ``` ### Add Screenshots for UI Changes + ```markdown ### Before + ![Before](link-to-before-screenshot) -### After +### After + ![After](link-to-after-screenshot) ``` ### Update Documentation + - Update relevant docs in `/docs` directory - Add docstrings to new functions/classes - Update UPDATING.md for breaking changes @@ -206,7 +223,9 @@ test('renders new component', () => { ## CI Checks ### Required Checks + All PRs must pass: + - `Python Tests` - Backend unit/integration tests - `Frontend Tests` - JavaScript/TypeScript tests - `Linting` - Code style checks @@ -217,6 +236,7 @@ All PRs must pass: ### Common CI Failures #### Python Test Failures + ```bash # Run locally to debug pytest tests/unit_tests/ -v @@ -224,12 +244,14 @@ pytest tests/integration_tests/ -v ``` #### Frontend Test Failures + ```bash cd superset-frontend npm run test -- --coverage ``` #### Linting Failures + ```bash # Auto-fix many issues pre-commit run --all-files @@ -243,6 +265,7 @@ pre-commit run --all-files ## Responding to Reviews ### Address Feedback Promptly + ```bash # Make requested changes edit files... @@ -254,11 +277,13 @@ git push origin feature/your-feature-name ``` ### Request Re-review + - Click "Re-request review" after addressing feedback - Comment on resolved discussions - Thank reviewers for their time ### Handling Conflicts + ```bash # Update your branch git fetch upstream @@ -276,6 +301,7 @@ git push --force-with-lease origin feature/your-feature-name ## After Merge ### Clean Up + ```bash # Delete local branch git checkout master @@ -291,6 +317,7 @@ git push origin master ``` ### Follow Up + - Monitor for any issues reported - Help with documentation if needed - Consider related improvements @@ -298,6 +325,7 @@ git push origin master ## Tips for Success ### Do + - βœ… Keep PRs small and focused - βœ… Write descriptive PR titles and descriptions - βœ… Include tests for new functionality @@ -306,6 +334,7 @@ git push origin master - βœ… Be patient with the review process ### Don't + - ❌ Submit PRs with failing tests - ❌ Include unrelated changes - ❌ Force push to master diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/alert.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/alert.mdx index 335032ea82b..b249254e48b 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/alert.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/alert.mdx @@ -34,45 +34,40 @@ Alert component for displaying important messages to users. Wraps Ant Design Ale ## Try It @@ -95,13 +90,13 @@ function Demo() { ## 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."` | Message | -| `description` | `string` | `"Sample description for additional context."` | Description | -| `showIcon` | `boolean` | `true` | Whether to display an icon in the Alert. | +| 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."` | Message | +| `description` | `string` | `"Sample description for additional context."` | Description | +| `showIcon` | `boolean` | `true` | Whether to display an icon in the Alert. | ## Usage in Extensions @@ -112,11 +107,7 @@ import { Alert } from '@apache-superset/core/components'; function MyExtension() { return ( - + ); } ``` @@ -128,4 +119,4 @@ function MyExtension() { --- -*This page was auto-generated from the component's Storybook story.* +_This page was auto-generated from the component's Storybook story._ diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/index.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/index.mdx index 0786fd0c801..715e8dd4fbb 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/index.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/index.mdx @@ -39,11 +39,7 @@ All components are exported from the `@apache-superset/core/components` package: import { Alert } from '@apache-superset/core/components'; export function MyExtensionPanel() { - return ( - - Welcome to my extension! - - ); + return Welcome to my extension!; } ``` @@ -68,7 +64,7 @@ export default { }, }; -export const InteractiveMyComponent = (args) => ; +export const InteractiveMyComponent = args => ; InteractiveMyComponent.args = { variant: 'primary', diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/contribution-types.md b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/contribution-types.md index e765c5009c4..380b6e6283e 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/contribution-types.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/contribution-types.md @@ -152,6 +152,7 @@ from .api import MyExtensionAPI - **Host context**: `/api/v1/` with original ID For an extension with publisher `my-org` and name `dataset-tools`, the endpoint above would be accessible at: + ``` /extensions/my-org/dataset-tools/hello ``` diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/dependencies.md b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/dependencies.md index a061028f8d7..43eddcbec8e 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/dependencies.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/dependencies.md @@ -34,10 +34,10 @@ Extensions run in the same context as Superset during runtime. This means extens The core packages follow [semantic versioning](https://semver.org/) and provide stable, documented APIs: -| Package | Language | Description | -|---------|----------|-------------| +| Package | Language | Description | +| ----------------------- | --------------------- | -------------------------------------------------- | | `@apache-superset/core` | JavaScript/TypeScript | Frontend APIs, UI components, hooks, and utilities | -| `apache-superset-core` | Python | Backend APIs, models, DAOs, and utilities | +| `apache-superset-core` | Python | Backend APIs, models, DAOs, and utilities | **Benefits of using core packages:** @@ -116,12 +116,14 @@ Abstracting libraries like React or SQLAlchemy would: Extension developers should depend on and use core libraries directly: **Frontend (examples):** + - [React](https://react.dev/) - UI framework - [Ant Design](https://ant.design/) - UI component library (prefer Superset components from `@apache-superset/core/components` when available to preserve visual consistency) - [Emotion](https://emotion.sh/) - CSS-in-JS styling - ... **Backend (examples):** + - [SQLAlchemy](https://www.sqlalchemy.org/) - Database toolkit - [Flask](https://flask.palletsprojects.com/) - Web framework - [Flask-AppBuilder](https://flask-appbuilder.readthedocs.io/) - Application framework diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/deployment.md b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/deployment.md index 7718777266f..30e962d6eb4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/deployment.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/deployment.md @@ -35,7 +35,7 @@ Packaging is handled by the `superset-extensions bundle` command, which: To deploy an extension, place the `.supx` file in the extensions directory configured via `EXTENSIONS_PATH` in your `superset_config.py`: -``` python +```python EXTENSIONS_PATH = "/path/to/extensions" ``` diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/development.md b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/development.md index 939b1f2d846..b71fc5334f4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/development.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/development.md @@ -80,6 +80,7 @@ dataset-references/ ``` **Note**: With publisher `my-org` and name `dataset-references`, the technical names are: + - Directory name: `dataset-references` (kebab-case) - Backend Python namespace: `my_org.dataset_references` - Backend distribution package: `my_org-dataset_references` diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/extension-points/editors.md b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/extension-points/editors.md index aff1156b3ff..0aecfd4ee9f 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/extension-points/editors.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/extension-points/editors.md @@ -30,16 +30,16 @@ Extensions can replace Superset's default text editors with custom implementatio Superset uses text editors in various places throughout the application: -| Language | Locations | -|----------|-----------| -| `sql` | SQL Lab, Metric/Filter Popovers | -| `json` | Dashboard Properties, Annotation Modal, Theme Modal | -| `css` | Dashboard Properties, CSS Template Modal | -| `markdown` | Dashboard Markdown component | -| `yaml` | Template Params Editor | -| `javascript` | Custom JavaScript editor contexts | -| `python` | Custom Python editor contexts | -| `text` | Plain text editor contexts | +| Language | Locations | +| ------------ | --------------------------------------------------- | +| `sql` | SQL Lab, Metric/Filter Popovers | +| `json` | Dashboard Properties, Annotation Modal, Theme Modal | +| `css` | Dashboard Properties, CSS Template Modal | +| `markdown` | Dashboard Markdown component | +| `yaml` | Template Params Editor | +| `javascript` | Custom JavaScript editor contexts | +| `python` | Custom Python editor contexts | +| `text` | Plain text editor contexts | By registering an editor for a language, your extension replaces the default Ace editor in **all** locations that use that language. @@ -170,7 +170,7 @@ Superset passes keyboard shortcuts via the `hotkeys` prop. Each hotkey includes ```typescript interface EditorHotkey { name: string; - key: string; // e.g., "Ctrl-Enter", "Alt-Shift-F" + key: string; // e.g., "Ctrl-Enter", "Alt-Shift-F" description?: string; exec: (handle: EditorHandle) => void; } @@ -185,9 +185,9 @@ Superset passes static autocomplete suggestions via the `keywords` prop. These i ```typescript interface EditorKeyword { name: string; - value?: string; // Text to insert (defaults to name) - meta?: string; // Category like "table", "column", "function" - score?: number; // Sorting priority + value?: string; // Text to insert (defaults to name) + meta?: string; // Category like "table", "column", "function" + score?: number; // Sorting priority } ``` diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/extension-points/sqllab.md b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/extension-points/sqllab.md index 959e89fa3ae..ae6405d58c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/extension-points/sqllab.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/extension-points/sqllab.md @@ -106,7 +106,11 @@ This example adds primary, secondary, and context actions to the editor: import { commands, menus, sqlLab } from '@apache-superset/core'; commands.registerCommand( - { id: 'my-extension.format', title: 'Format Query', icon: 'FormatPainterOutlined' }, + { + id: 'my-extension.format', + title: 'Format Query', + icon: 'FormatPainterOutlined', + }, async () => { const tab = sqlLab.getCurrentTab(); if (tab) { diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/mcp.md b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/mcp.md index 5fa7e6b41a0..ef422b9ce05 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/mcp.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/mcp.md @@ -33,9 +33,11 @@ Model Context Protocol (MCP) integration allows extensions to register custom AI MCP enables extensions to extend Superset's AI capabilities in two ways: ### MCP Tools + Tools are Python functions that AI agents can call to perform specific tasks. They provide executable functionality that extends Superset's capabilities. **Examples of MCP tools:** + - Data processing and transformation functions - Custom analytics calculations - Integration with external APIs @@ -43,9 +45,11 @@ Tools are Python functions that AI agents can call to perform specific tasks. Th - Business-specific operations ### MCP Prompts + Prompts provide interactive guidance and context to AI agents. They help agents understand how to better assist users with specific workflows or domain knowledge. **Examples of MCP prompts:** + - Step-by-step workflow guidance - Domain-specific context and knowledge - Interactive troubleshooting assistance @@ -76,6 +80,7 @@ This creates a tool that AI agents can call by name. The tool name defaults to t The `@tool` decorator accepts several optional parameters: **Parameter details:** + - **`name`**: Tool identifier (AI agents use this to call your tool) - **`description`**: Explains what the tool does (helps AI agents decide when to use it) - **`tags`**: Categories for organization and discovery @@ -213,6 +218,7 @@ Agent: I generated the number 42 for you. ``` The AI agent sees your tool's: + - **Name**: How to call it - **Description**: What it does and when to use it - **Parameters**: What inputs it expects (from Pydantic schema) @@ -377,18 +383,21 @@ async def troubleshoot_charts(ctx: Context) -> str: ### Prompt Best Practices #### Content Structure + - **Use clear headings** and sections for easy navigation - **Provide actionable steps** rather than just theory - **Include examples** relevant to the user's domain - **Offer next steps** to continue the workflow #### Interactive Design + - **Ask questions** to engage the user - **Provide options** for different scenarios - **Reference specific Superset features** by name - **Link to related tools** when appropriate #### Context Awareness + ```python @prompt("analytics_extension.context_aware_guide") async def context_aware_guide(ctx: Context) -> str: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/registry.md b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/registry.md index 9fbdb0f2074..0909698a43f 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/registry.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/registry.md @@ -36,9 +36,9 @@ This page serves as a registry of community-created Superset extensions. These e | [SQL Lab Export to Parquet](https://github.com/rusackas/superset-extensions/tree/main/sqllab_parquet) | Export SQL Lab query results directly to Apache Parquet format with Snappy compression. | Evan Rusackas | SQL Lab Export to Parquet | | [SQL Lab Query Comparison](https://github.com/michael-s-molina/superset-extensions/tree/main/query-comparison) | A SQL Lab extension that enables side-by-side comparison of query results across different tabs, with GitHub-style diff visualization showing added/removed rows and columns. | Michael S. Molina | Query Comparison | | [SQL Lab Result Stats](https://github.com/michael-s-molina/superset-extensions/tree/main/result-stats) | A SQL Lab extension that automatically computes statistics for query results, providing type-aware analysis including numeric metrics (min, max, mean, median, std dev), string analysis (length, empty counts), and date range information. | Michael S. Molina | Result Stats | -| [Editor Snippets](https://github.com/michael-s-molina/superset-extensions/tree/main/editor-snippets) | A SQL Lab extension for managing and inserting reusable code snippets into the editor, with server-side persistence per user. | Michael S. Molina | Editor Snippets | +| [Editor Snippets](https://github.com/michael-s-molina/superset-extensions/tree/main/editor-snippets) | A SQL Lab extension for managing and inserting reusable code snippets into the editor, with server-side persistence per user. | Michael S. Molina | Editor Snippets | | [SQL Lab Query Estimator](https://github.com/michael-s-molina/superset-extensions/tree/main/query-estimator) | A SQL Lab panel that analyzes query execution plans to estimate resource impact, detect performance issues like Cartesian products and high-cost operations, and visualize the query plan tree. | Michael S. Molina | Query Estimator | -| [Editors Bundle](https://github.com/michael-s-molina/superset-extensions/tree/main/editors-bundle) | A Superset extension that demonstrates how to provide custom code editors for different languages. This extension showcases the editor contribution system by registering alternative editors that can replace Superset's default Ace editor. | Michael S. Molina | Editors Bundle | +| [Editors Bundle](https://github.com/michael-s-molina/superset-extensions/tree/main/editors-bundle) | A Superset extension that demonstrates how to provide custom code editors for different languages. This extension showcases the editor contribution system by registering alternative editors that can replace Superset's default Ace editor. | Michael S. Molina | Editors Bundle | ## How to Add Your Extension diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/tasks.md b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/tasks.md index c36fa9aaba1..58c00cb2408 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/tasks.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/tasks.md @@ -37,6 +37,7 @@ FEATURE_FLAGS = { ``` When GTF is disabled: + - The Task List UI menu item is hidden - The `/api/v1/task/*` endpoints return 404 - Calling or scheduling a `@task`-decorated function raises `GlobalTaskFrameworkDisabledError` @@ -79,10 +80,10 @@ print(task.status) # "success" ### Async vs Sync Execution -| Method | When to Use | -|--------|-------------| -| `.schedule()` | Long-running operations, background processing, when you need to return immediately | -| Direct call | Short operations, when deduplication matters, when you need the result before responding | +| Method | When to Use | +| ------------- | ---------------------------------------------------------------------------------------- | +| `.schedule()` | Long-running operations, background processing, when you need to return immediately | +| Direct call | Short operations, when deduplication matters, when you need the result before responding | Both execution modes provide the same task features: deduplication, progress tracking, cancellation, and visibility in the Task List UI. The difference is whether execution happens in a Celery worker (async) or inline (sync). @@ -100,15 +101,15 @@ PENDING ──→ IN_PROGRESS ────→ SUCCESS └─────────────┴──────────→ ABORTED (user cancel) ``` -| Status | Description | -|--------|-------------| -| `PENDING` | Queued, awaiting execution | -| `IN_PROGRESS` | Executing | -| `ABORTING` | Abort/timeout triggered, abort handlers running | -| `SUCCESS` | Completed successfully | -| `FAILURE` | Failed with error or abort/cleanup handler exception | -| `ABORTED` | Cancelled by user/admin | -| `TIMED_OUT` | Exceeded configured timeout | +| Status | Description | +| ------------- | ---------------------------------------------------- | +| `PENDING` | Queued, awaiting execution | +| `IN_PROGRESS` | Executing | +| `ABORTING` | Abort/timeout triggered, abort handlers running | +| `SUCCESS` | Completed successfully | +| `FAILURE` | Failed with error or abort/cleanup handler exception | +| `ABORTED` | Cancelled by user/admin | +| `TIMED_OUT` | Exceeded configured timeout | ## Context API @@ -139,11 +140,11 @@ Call `update_task()` once per iteration for best performance. Frequent DB writes The `progress` parameter accepts three formats: -| Format | Example | Display | -|--------|---------|---------| +| Format | Example | Display | +| ----------------- | ------------------- | ---------------------- | | `tuple[int, int]` | `progress=(3, 100)` | 3 of 100 (3%) with ETA | -| `float` (0.0-1.0) | `progress=0.5` | 50% with ETA | -| `int` | `progress=42` | 42 processed | +| `float` (0.0-1.0) | `progress=0.5` | 50% with ETA | +| `int` | `progress=42` | 42 processed | :::tip Use the tuple format `(current, total)` whenever possible. It provides the richest information to users: showing both the count and percentage, while still computing ETA automatically. @@ -159,10 +160,10 @@ In the Task List UI, when a payload is defined, an info icon appears in the **De Register handlers to run cleanup logic or respond to abort requests: -| Handler | When it runs | Use case | -|---------|--------------|----------| -| `on_cleanup` | Always (success, failure, abort) | Release resources, close connections | -| `on_abort` | When task is aborted | Set stop flag, cancel external operations | +| Handler | When it runs | Use case | +| ------------ | -------------------------------- | ----------------------------------------- | +| `on_cleanup` | Always (success, failure, abort) | Release resources, close connections | +| `on_abort` | When task is aborted | Set stop flag, cancel external operations | ```python @task @@ -187,6 +188,7 @@ Multiple handlers of the same type execute in LIFO order (last registered runs f **All registered handlers will always be attempted, even if one fails.** This ensures that a failure in one handler doesn't prevent other handlers from running their cleanup logic. For example, if you have three cleanup handlers and the second one throws an exception: + 1. Handler 3 runs βœ“ 2. Handler 2 throws an exception βœ— (logged, but execution continues) 3. Handler 1 runs βœ“ @@ -200,6 +202,7 @@ Write handlers to be independent and self-contained. Don't assume previous handl ## Making Tasks Abortable When users click **Cancel** in the Task List, the system decides whether to **abort** (stop) the task or **unsubscribe** (remove the user from a shared task). Abort occurs when: + - It's a private or system task - It's a shared task and the user is the last subscriber - An admin checks **Force abort** to stop the task for all subscribers @@ -229,6 +232,7 @@ def abortable_task(items: list[str]) -> None: ``` **Key points:** + - Registering `on_abort` marks the task as abortable and starts the abort listener - The abort handler fires automatically when abort is triggered - Use a flag pattern to gracefully stop processing at safe points @@ -283,11 +287,11 @@ The timeout timer starts when the task begins executing (status changes to `IN_P ### Timeout Precedence -| Source | Priority | Example | -|--------|----------|---------| -| `TaskOptions.timeout` | Highest | `options=TaskOptions(timeout=600)` | -| `@task(timeout=...)` | Default | `@task(timeout=300)` | -| Not set | No timeout | Task runs indefinitely | +| Source | Priority | Example | +| --------------------- | ---------- | ---------------------------------- | +| `TaskOptions.timeout` | Highest | `options=TaskOptions(timeout=600)` | +| `@task(timeout=...)` | Default | `@task(timeout=300)` | +| Not set | No timeout | Task runs indefinitely | Call-time options always override decorator defaults, allowing tasks to have sensible defaults while permitting callers to extend or shorten the timeout for specific use cases. @@ -345,11 +349,11 @@ def shared_task(): ... def system_task(): ... ``` -| Scope | Visibility | Cancel Behavior | -|-------|------------|-----------------| -| `PRIVATE` | Creator only | Cancels immediately | -| `SHARED` | All subscribers | Last subscriber cancels; others unsubscribe | -| `SYSTEM` | Admins only | Admin cancels | +| Scope | Visibility | Cancel Behavior | +| --------- | --------------- | ------------------------------------------- | +| `PRIVATE` | Creator only | Cancels immediately | +| `SHARED` | All subscribers | Last subscriber cancels; others unsubscribe | +| `SYSTEM` | Admins only | Admin cancels | ## Task Cleanup @@ -393,11 +397,11 @@ By default, abort detection and sync join-and-wait use database polling. Configu ### TaskContext Methods -| Method | Description | -|--------|-------------| -| `update_task(progress, payload)` | Update progress and/or custom payload | -| `on_cleanup(handler)` | Register cleanup handler | -| `on_abort(handler)` | Register abort handler (makes task abortable) | +| Method | Description | +| -------------------------------- | --------------------------------------------- | +| `update_task(progress, payload)` | Update progress and/or custom payload | +| `on_cleanup(handler)` | Register cleanup handler | +| `on_abort(handler)` | Register abort handler (makes task abortable) | ### TaskOptions @@ -429,6 +433,7 @@ def risky_task() -> None: ``` On failure, the framework records: + - `error_message`: Exception message - `exception_type`: Exception class name - `stack_trace`: Full traceback (visible when `SHOW_STACKTRACE=True`) diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/design-guidelines.md b/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/design-guidelines.md index 7bf96b1cca4..93ffceaef8d 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/design-guidelines.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/design-guidelines.md @@ -40,6 +40,7 @@ Sentence case is predominantly lowercase. Capitalize only the initial character - User input that is reflected in the UI. E.g. a user-named a dashboard tab **Sentence case vs. Title case:** + - Title case: "A Dog Takes a Walk in Paris" - Sentence case: "A dog takes a walk in Paris" @@ -110,12 +111,12 @@ Primary buttons have a fourth style: dropdown. **Purpose:** -| Button Type | Description | -|------------|-------------| -| Primary | Main call to action, just 1 per page not including modals or main headers | -| Secondary | Secondary actions, always in conjunction with a primary | -| Tertiary | For less prominent actions; can be used in isolation or paired with a primary button | -| Destructive | For actions that could have destructive effects on the user's data | +| Button Type | Description | +| ----------- | ------------------------------------------------------------------------------------ | +| Primary | Main call to action, just 1 per page not including modals or main headers | +| Secondary | Secondary actions, always in conjunction with a primary | +| Tertiary | For less prominent actions; can be used in isolation or paired with a primary button | +| Destructive | For actions that could have destructive effects on the user's data | ### Format @@ -173,9 +174,9 @@ In all cases, encountering errors increases user friction and frustration while Select one pattern per error (e.g. do not implement an inline and banner pattern for the same error). -| When the error... | Use... | -|------------------|--------| -| Is directly related to a UI control | Inline error | +| When the error... | Use... | +| --------------------------------------- | ------------ | +| Is directly related to a UI control | Inline error | | Is not directly related to a UI control | Banner error | #### Inline diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/frontend/component-style-guidelines.md b/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/frontend/component-style-guidelines.md index 59b422a0496..aaf05c6cee4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/frontend/component-style-guidelines.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/frontend/component-style-guidelines.md @@ -58,21 +58,25 @@ superset-frontend/src/components **Reference naming:** Use `PascalCase` for React components and `camelCase` for component instances **BAD:** + ```jsx import mainNav from './MainNav'; ``` **GOOD:** + ```jsx import MainNav from './MainNav'; ``` **BAD:** + ```jsx const NavItem = ; ``` **GOOD:** + ```jsx const navItem = ; ``` @@ -80,11 +84,13 @@ const navItem = ; **Component naming:** Use the file name as the component name **BAD:** + ```jsx import MainNav from './MainNav/index'; ``` **GOOD:** + ```jsx import MainNav from './MainNav'; ``` @@ -92,11 +98,13 @@ import MainNav from './MainNav'; **Props naming:** Do not use DOM related props for different purposes **BAD:** + ```jsx ``` **GOOD:** + ```jsx ``` @@ -104,23 +112,27 @@ import MainNav from './MainNav'; **Importing dependencies:** Only import what you need **BAD:** + ```jsx -import * as React from "react"; +import * as React from 'react'; ``` **GOOD:** + ```jsx -import React, { useState } from "react"; +import React, { useState } from 'react'; ``` **Default VS named exports:** As recommended by [TypeScript](https://www.typescriptlang.org/docs/handbook/modules.html), "If a module's primary purpose is to house one specific export, then you should consider exporting it as a default export. This makes both importing and actually using the import a little easier". If you're exporting multiple objects, use named exports instead. _As a default export_ + ```jsx import MainNav from './MainNav'; ``` _As a named export_ + ```jsx import { MainNav, SecondaryNav } from './Navbars'; ``` @@ -138,10 +150,10 @@ Validate all props with the correct types. This replaces the need for a run-time ```tsx type HeadingProps = { param: string; -} +}; export default function Heading({ children }: HeadingProps) { - return

    {children}

    + return

    {children}

    ; } ``` @@ -152,7 +164,8 @@ Use `type` for your component props and state. Use `interface` when you want to In order to improve the readability of your code and reduce assumptions, always add default values for non required props, when applicable, for example: ```tsx -const applyDiscount = (price: number, discount = 0.05) => price * (1 - discount); +const applyDiscount = (price: number, discount = 0.05) => + price * (1 - discount); ``` ## Functional components and Hooks diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/frontend/emotion-styling-guidelines.md b/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/frontend/emotion-styling-guidelines.md index 7a2352aeb52..388004fd2b5 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/frontend/emotion-styling-guidelines.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/guidelines/frontend/emotion-styling-guidelines.md @@ -60,21 +60,21 @@ const StatusThing = styled.div` export const InfoThing = styled(StatusThing)` background: blue; &::before { - content: "ℹ️"; + content: 'ℹ️'; } `; export const WarningThing = styled(StatusThing)` background: orange; &::before { - content: "⚠️"; + content: '⚠️'; } `; export const TerribleThing = styled(StatusThing)` background: red; &::before { - content: "πŸ”₯"; + content: 'πŸ”₯'; } `; ``` @@ -138,14 +138,20 @@ function FakeGlobalNav(props) { const menuItemStyles = css` display: block; border-bottom: 1px solid cadetblue; - font-family: "Comic Sans", cursive; + font-family: 'Comic Sans', cursive; `; return ( ); } @@ -158,21 +164,29 @@ function FakeGlobalNav(props) { By default the `css` prop uses the object syntax with JS style definitions, like so: ```jsx -
    Howdy
    +
    + Howdy +
    ``` But you can use the `css` interpolator as well to get away from icky JS styling syntax. Doesn't this look cleaner? ```jsx -
    Howdy
    +
    + Howdy +
    ``` You might say "whatever… I can read and write JS syntax just fine." Well, that's great. But… let's say you're migrating in some of our legacy LESS styles… now it's copy/paste! Or if you want to migrate to or from `styled` syntax… also copy/paste! @@ -261,9 +275,7 @@ AntD uses a cool trick called compound components. For example, the `Menu` compo Let's say you want to override an AntD component called `Foo`, and have `Foo.Bar` display some custom CSS for the `Bar` compound component. You can do it effectively like so: ```jsx -import { - Foo as AntdFoo, -} from 'antd'; +import { Foo as AntdFoo } from 'antd'; export const StyledBar = styled(AntdFoo.Bar)` border-radius: ${({ theme }) => theme.borderRadius}px; diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/index.md b/docs/developer_docs_versioned_docs/version-6.1.0/index.md index 2bfc2bba9ca..0e8428d3d83 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/index.md +++ b/docs/developer_docs_versioned_docs/version-6.1.0/index.md @@ -29,11 +29,13 @@ Welcome to the Apache Superset Developer Docs - your comprehensive resource for ## Quick Start ### New Contributors + - [Contributing Overview](/developer-docs/contributing/overview) - [Development Setup](/developer-docs/contributing/development-setup) - [Your First PR](/developer-docs/contributing/submitting-pr) ### Extension Development + - [Extension Development](/developer-docs/extensions/development) - [Extension Architecture](/developer-docs/extensions/architecture) - [Quick Start](/developer-docs/extensions/quick-start) @@ -41,17 +43,21 @@ Welcome to the Apache Superset Developer Docs - your comprehensive resource for ## Documentation Sections ### Extensions + Learn how to build powerful extensions that enhance Superset's capabilities. This section covers the extension architecture, development patterns, and deployment strategies. You'll find comprehensive guides on creating frontend contributions, managing extension lifecycles, and understanding security implications. ### Testing + Comprehensive testing strategies for Superset development. This section covers frontend testing with Jest and React Testing Library, backend testing with pytest, end-to-end testing with Playwright, and CI/CD pipeline best practices. ### Contributing to Superset + Everything you need to contribute to the Apache Superset project. This section includes community guidelines, development environment setup, pull request processes, code review workflows, issue reporting guidelines, and Apache release procedures. You'll also find style guidelines for both frontend and backend development. ## Development Resources ### Prerequisites + - **Python**: 3.9, 3.10, or 3.11 - **Node.js**: 18.x or 20.x - **npm**: 9.x or 10.x @@ -60,6 +66,7 @@ Everything you need to contribute to the Apache Superset project. This section i - **Flask/SQLAlchemy**: For backend development ### Key Technologies + - **Frontend**: React, TypeScript, Ant Design, Redux - **Backend**: Flask, SQLAlchemy, Celery, Redis - **Build Tools**: Webpack, Babel, npm/yarn @@ -69,11 +76,13 @@ Everything you need to contribute to the Apache Superset project. This section i ## Community ### Get Help + - **[Slack](https://apache-superset.slack.com)** - Join #development, #troubleshooting, or #beginners - **[GitHub Discussions](https://github.com/apache/superset/discussions)** - Ask questions and share ideas - **[Mailing Lists](https://lists.apache.org/list.html?dev@superset.apache.org)** - Development discussions ### Contribute + - **[Good First Issues](https://github.com/apache/superset/labels/good%20first%20issue)** - Start here! - **[Help Wanted](https://github.com/apache/superset/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)** - Issues needing help - **[Roadmap](https://github.com/orgs/apache/projects/180)** - See what's planned @@ -81,11 +90,13 @@ Everything you need to contribute to the Apache Superset project. This section i ## Additional Resources ### External Documentation + - **[User Documentation](https://superset.apache.org/docs/intro)** - Using Superset - **[API Documentation](/developer-docs/api)** - REST API reference - **[Configuration Guide](https://superset.apache.org/admin-docs/configuration/configuring-superset)** - Setup and configuration ### Important Files + - **[CLAUDE.md](https://github.com/apache/superset/blob/master/CLAUDE.md)** - LLM development guide - **[UPDATING.md](https://github.com/apache/superset/blob/master/UPDATING.md)** - Breaking changes log @@ -96,6 +107,7 @@ Everything you need to contribute to the Apache Superset project. This section i
    {flag.name}{flag.default ? 'True' : 'False'} + {flag.name} + + {flag.default ? 'True' : 'False'} + {flag.description} {flag.docs && ( - <> (docs) + <> + {' '} + (docs) + )}
    **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) @@ -104,6 +116,7 @@ Everything you need to contribute to the Apache Superset project. This section i **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) @@ -114,6 +127,7 @@ Everything you need to contribute to the Apache Superset project. This section i **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) @@ -122,6 +136,7 @@ Everything you need to contribute to the Apache Superset project. This section i **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) diff --git a/docs/developer_docs/sidebars.js b/docs/developer_docs/sidebars.js index fe03dac7b8f..6838f5f6a76 100644 --- a/docs/developer_docs/sidebars.js +++ b/docs/developer_docs/sidebars.js @@ -63,9 +63,7 @@ module.exports = { type: 'category', label: 'Testing', collapsed: true, - items: [ - 'testing/overview', - ], + items: ['testing/overview'], }, { type: 'category', diff --git a/docs/developer_docs/testing/backend-testing.md b/docs/developer_docs/testing/backend-testing.md index feec0461242..700b8fd5814 100644 --- a/docs/developer_docs/testing/backend-testing.md +++ b/docs/developer_docs/testing/backend-testing.md @@ -159,13 +159,13 @@ Use `--concurrency=1` to limit resource usage on your dev machine. ### Troubleshooting -| Problem | Solution | -|---|---| -| Beat shows no output | Ensure `beat_schedule` is defined in your `CeleryConfig` and `--loglevel=info` is set | +| 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 | +| 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!* +_This documentation is under active development. Check back soon for updates!_ diff --git a/docs/developer_docs/testing/ci-cd.md b/docs/developer_docs/testing/ci-cd.md index baefc13cbee..eae05687ea7 100644 --- a/docs/developer_docs/testing/ci-cd.md +++ b/docs/developer_docs/testing/ci-cd.md @@ -59,6 +59,7 @@ pre-commit run --all-files ## GitHub Actions Key workflows: + - `test-frontend.yml` - Frontend tests - `test-backend.yml` - Backend tests - `docker.yml` - Docker image builds @@ -67,4 +68,4 @@ Key workflows: --- -*This documentation is under active development. Check back soon for updates!* +_This documentation is under active development. Check back soon for updates!_ diff --git a/docs/developer_docs/testing/frontend-testing.md b/docs/developer_docs/testing/frontend-testing.md index e33bb1095bc..9ae784aaf16 100644 --- a/docs/developer_docs/testing/frontend-testing.md +++ b/docs/developer_docs/testing/frontend-testing.md @@ -58,4 +58,4 @@ npm run test -- MyComponent.test.tsx --- -*This documentation is under active development. Check back soon for updates!* +_This documentation is under active development. Check back soon for updates!_ diff --git a/docs/developer_docs/testing/overview.md b/docs/developer_docs/testing/overview.md index 0fc04399958..eb01ff64f5e 100644 --- a/docs/developer_docs/testing/overview.md +++ b/docs/developer_docs/testing/overview.md @@ -37,26 +37,32 @@ Superset embraces a testing pyramid approach: ## Testing Documentation ### Frontend Testing + - **[Frontend Testing](./frontend-testing.md)** - Jest, React Testing Library, and component testing strategies -### Backend Testing +### Backend Testing + - **[Backend Testing](./backend-testing.md)** - pytest, database testing, and API testing patterns ### End-to-End Testing + - **[E2E Testing](./e2e-testing.md)** - Playwright testing for complete user workflows ### CI/CD Integration + - **[CI/CD](./ci-cd.md)** - 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 @@ -64,12 +70,14 @@ Superset embraces a testing pyramid approach: ## 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) @@ -78,11 +86,12 @@ Superset embraces a testing pyramid approach: ## Running Tests ### Quick Commands + ```bash # Frontend unit tests npm run test -# Backend unit tests +# Backend unit tests pytest tests/unit_tests/ # End-to-end tests @@ -93,6 +102,7 @@ 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 @@ -101,11 +111,13 @@ npm run test:coverage ## 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 @@ -133,18 +145,21 @@ npm run test:coverage ## 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 @@ -159,4 +174,4 @@ npm run test:coverage --- -*This documentation is under active development. Check back soon for updates!* +_This documentation is under active development. Check back soon for updates!_ diff --git a/docs/developer_docs/testing/storybook.md b/docs/developer_docs/testing/storybook.md index 0e190220f15..6435d0716e2 100644 --- a/docs/developer_docs/testing/storybook.md +++ b/docs/developer_docs/testing/storybook.md @@ -102,8 +102,9 @@ storybook/stories//index.js ``` Use the `|` separator for nested stories: + ```javascript - storyPath: '@superset-ui/package|Category|Subcategory' + storyPath: '@superset-ui/package|Category|Subcategory'; ``` ## Best Practices diff --git a/docs/developer_docs/testing/testing-guidelines.md b/docs/developer_docs/testing/testing-guidelines.md index 5fb8424449a..ec8b5d0d43b 100644 --- a/docs/developer_docs/testing/testing-guidelines.md +++ b/docs/developer_docs/testing/testing-guidelines.md @@ -61,7 +61,7 @@ One of the most important points of RTL is accessibility and this is also a very 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 }) +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. @@ -108,10 +108,12 @@ Cleaning the state of the application, such as resetting the DB, or in general, - 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) +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 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 index 64f1b28b885..043ed18a688 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api.mdx @@ -17,8 +17,10 @@ You can use this API to programmatically interact with Superset for automation, message="Code Samples & Schema Documentation" description={ - Each endpoint includes ready-to-use code samples in cURL, Python, and JavaScript. - The sidebar includes Schema definitions for detailed data model documentation. + 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' }} @@ -45,12 +47,12 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ #### 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` | +| 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` | --- @@ -61,129 +63,129 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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}` | +| 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` | +| 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` | +| 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/` | +| 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/` |
    @@ -192,69 +194,69 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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/` | +| 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}` | +| 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/` | +| 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` | +| 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` |
    @@ -263,61 +265,61 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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}` | +| 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}` | +| 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}` | +| 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}` |
    @@ -326,63 +328,63 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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}` | +| 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}` | +| 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}` | +| 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}` | +| 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` | +| 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}` | +| `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}` | +| 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}` |
    @@ -391,19 +393,19 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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/` |
    @@ -412,88 +414,88 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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}` | +| 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}` | +| 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}` | +| 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}` | +| 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}` | +| 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}` |
    @@ -502,9 +504,9 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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/` |
    @@ -512,8 +514,8 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    CacheRestApi (1 endpoints) β€” Cache management and invalidation operations. -| Method | Endpoint | Description | -|--------|----------|-------------| +| 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` |
    @@ -521,12 +523,12 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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/` |
    @@ -535,56 +537,56 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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/` | +| 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` | +| 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/` | +| 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/` | +| 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/` | +| 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` | +| Method | Endpoint | Description | +| ------ | ---------------------------------------------------------------------------- | ------------------------- | +| `GET` | [Get api by version openapi](/developer-docs/api/get-api-by-version-openapi) | `/api/{version}/_openapi` |
    @@ -593,52 +595,52 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    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}` | +| 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` | +| 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}` | +| 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}` |
    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 index 75c60b0cf27..2c29b4b8e5b 100644 --- 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 @@ -1 +1,16 @@ -{"parameters":[{"in":"path","name":"object_type","required":true,"schema":{"type":"integer"}},{"in":"path","name":"object_id","required":true,"schema":{"type":"integer"}}]} +{ + "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 index b93e6ea09ca..e28259376fc 100644 --- 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 @@ -1 +1,22 @@ -{"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}} +{ + "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 index 81a6f8b517b..956363a2112 100644 --- 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 @@ -1 +1,58 @@ -{"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"}}} +{ + "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 index 6bae388f49f..13659702cbc 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +title: 'Add tags to an object' +description: 'Adds tags to an object. Creates new tags if they do not already exist.' +sidebar_label: 'Add tags to an object' hide_title: true hide_table_of_contents: true api: eJzFV21v2zYQ/iuHw4AmmBInXQcUKvohDVq0XZcGsYsNiIKUEc8WG5lUScqNJ+i/D0dK8uu6lw7oJ5nk3fGeh8eH5wYludyqyiujMcUzKR14MXPgDQgN5u4T5f4Yzi0JTw40fYnLagq+oCVIA9p4EKUlIZdAD8r5Y0ywElbMyZN1mF43qDh4JXyBCWoxJ0wxhr71y4owQUufa2VJYuptTQm6vKC5wLTBYJCi0p5mZLFtk6+FU/LfBbuJ1uT8CyOXbJIb7Ul7/imqqlS5YG5GnxwT1KzFqqypyHpFLkQWs/Dd5LNUzoOZMmfAiUZepeRPzBgTVJ7mbi07563SM2yTfkJYK5aMvJ/oXNsE6UHMq5JWGVz37jctO2ymMxEz6ABss9TyhKuMdhHP45PTXTjsL6QkyVv/dPJ41+KKpLKU+wDUFwR5bS1pD1LNyIWUn5ycfAPPc3JOzGgPXX9Dz+CIL4SE7tBTeKMXolQSVgULlTULFUDuMrjmG7Gcfl8sH7SofWGs+oNkCme1L0j7bn8YTngPkHXHiOTJ90VyYTxMTa1lCpOCepKJ6XamtjmBNKxAxkeV2QdqiMG7/Py96+yN9mS1KMGRXZAFstbYFM401JoeKsoZXZgEk4d7svekXgkvymgXNneU11b5ZRDWT188ptc3rGP9/Z/w9ybBh6PcSBqHxKIKl0LPMMX8w9U7TLAUd1SuhpFkHte2hKPf4fL9eAIZFt5X6WhUmlyUhXE+fXry9OlIVGq0OB15MRs1a0reDiMl21GGkGWZBjh6DRmedfUW+E/hBQlLFn44Oz9/OR7fTt7/8vJi0+E8ntzRZFlRCtuHt7KV8KjJ8J6WGaaQ4UKUNWXYPkJ+KjrMl0tfGL2GepgYcKt5ZazvC89lOtO9IsLzYfq4Ms4f8L7wreQkMUpBQpJ1z5stiiKajqYM4UcQeU7O3XpzT7rtvJmK5/vgZ/ow05VV2h/0MI7Z+ODwcJ2Yt2IhxqHa1sjZmFwVhtGO+Rk4EV+E8jAlnxeBkf+DjybCmpMvjGQ8XIbbXKW9GWzXFXPwsS+tJhI2CXx9TFYu65UVWdutrmjd03xn5DKFt+P3F8dRB9R0edDAPS3XOIf2kK2Z+meZjnRJ4cVA1dZBdEampOPSzA7Y9PAZ8l2O8LnJMc6HdsoXmOI/Y5LPLChOvPW15SPdezK4rTXveBkkLag01Zzf7RgpVEwM1FTWeJObsk1Ho4ZDtWnDN6fdiXZeO2/mfYgEF8IqcVdGge3DxB5iKurSd2ligqTrOWtZN+RP0LTN+K8nk0sY4rQJcjab8Qa8O8mNoyjzGndmYCy8ueQgjGUzyF6qOv9g3YZGshfmMT8pEWSQ5wbvQkG+MnYuON7b3ybYdaV8r+IqDs9KAN0m7HxraWrJFf81CEdxRl+tWtyXX2kYE1R6anabunFdkXXEHHrl2Xl9igst2i1OI3/Oz0V4XLvePP57CE3w3RKqe5iKhbHKk9tmde25xl+FvXehh2RH4QYvmBq70VvWbh25pwc/qkqhNGcTirbpLtA1ikpxyqcY3ktMMK3uMcH1hLjOYiFdY9PcCUcfbNm2PP25Jsvv7s2qlsMVk8rxb4npVJSOvgLq4KrryQ7hrzLum369DFemrHmECSs8C8I9tnxSUQnD7nHhLM8p6HXvstPtbAgLyyomyE3gWo8zVFH3g8PvzadpokXU1nZIL7xNnGHb/gm5yu7H -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Add tags to an object'} +> - - 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 index d9d1c2eb179..ceb86acd728 100644 --- 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 @@ -1,13 +1,13 @@ --- id: advanced-data-type -title: "Advanced Data Type" -description: "Advanced Data Type" +title: 'Advanced Data Type' +description: 'Advanced Data Type' custom_edit_url: null --- Advanced data type operations and conversions. -| Method | Endpoint | Path | -|--------|----------|------| -| `GET` | [Return an AdvancedDataTypeResponse](./return-an-advanced-data-type-response) | `/api/v1/advanced_data_type/convert` | -| `GET` | [Return a list of available advanced data types](./return-a-list-of-available-advanced-data-types) | `/api/v1/advanced_data_type/types` | +| 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 index 1b62caa685a..3d663944614 100644 --- 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 @@ -1,25 +1,25 @@ --- id: annotation-layers -title: "Annotation Layers" -description: "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}` | +| 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 index b27517b453d..57717242daa 100644 --- 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 @@ -1 +1,9 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 82ab93e0c76..732bbc2897d 100644 --- 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 @@ -1 +1,306 @@ -{"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"}}} +{ + "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 index 41bb9bea3d7..f68bef00aab 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Assemble Explore related information in a single endpoint'} +>     - - 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 index 30637a3ef7c..57dc88afc4d 100644 --- 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 @@ -1,12 +1,12 @@ --- id: async-events-rest-api -title: "AsyncEventsRestApi" -description: "AsyncEventsRestApi" +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/` | +| 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 index e7cd33172eb..cc87f13abbb 100644 --- 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 @@ -1,12 +1,12 @@ --- id: available-domains -title: "Available Domains" -description: "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/` | +| 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 index fa2a316cc3b..219ece680d5 100644 --- 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 @@ -1 +1,34 @@ -{"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}} +{ + "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 index a4323ba4bda..ae9227212af 100644 --- 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 @@ -1 +1,87 @@ -{"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"}}} +{ + "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 index 9948a9efde3..db2ee59473e 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Bulk create tags and tagged objects'} +> - - 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 index 13d35164553..36c861b14ed 100644 --- 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 @@ -1 +1,24 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 3b8705da636..2435d1b55a4 100644 --- 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 @@ -1 +1,68 @@ -{"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"}}} +{ + "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 index 2af17d15a28..2d07f964e0c 100644 --- 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 @@ -1,33 +1,32 @@ --- id: bulk-delete-annotation-layers -title: "Bulk delete annotation layers" -description: "Bulk delete annotation layers" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Bulk delete annotation layers'} +> - - 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 index 992981fc7d3..cb7a672fedd 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 41f86a9e504..740bf042782 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 822e298940d..577c4e2a0b9 100644 --- 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 @@ -1,33 +1,32 @@ --- id: bulk-delete-charts -title: "Bulk delete charts" -description: "Bulk delete charts" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Bulk delete charts'} +> - - 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 index 992981fc7d3..cb7a672fedd 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index d3cf7057895..cceb1a5aa4e 100644 --- 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 @@ -1 +1,68 @@ -{"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"}}} +{ + "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 index 7bede99c3ed..b1d298446bc 100644 --- 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 @@ -1,33 +1,32 @@ --- id: bulk-delete-css-templates -title: "Bulk delete CSS templates" -description: "Bulk delete CSS templates" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Bulk delete CSS templates'} +> - - 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 index 992981fc7d3..cb7a672fedd 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 535ffe78e96..2b99f7d70e2 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index b5af911087d..0ffbd5e12ac 100644 --- 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 @@ -1,33 +1,32 @@ --- id: bulk-delete-dashboards -title: "Bulk delete dashboards" -description: "Bulk delete dashboards" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Bulk delete dashboards'} +> - - 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 index 992981fc7d3..cb7a672fedd 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 62a6bad24d2..540b9908619 100644 --- 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 @@ -1 +1,94 @@ -{"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"}}} +{ + "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 index b5bbdb4d3ff..15576e10755 100644 --- 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 @@ -1,33 +1,32 @@ --- id: bulk-delete-datasets -title: "Bulk delete datasets" -description: "Bulk delete datasets" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Bulk delete datasets'} +> - - 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 index 992981fc7d3..cb7a672fedd 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index eb533bc3460..7c482ef25b3 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index a99f961a1bc..79a7b944acd 100644 --- 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 @@ -1,33 +1,32 @@ --- id: bulk-delete-report-schedules -title: "Bulk delete report schedules" -description: "Bulk delete report schedules" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Bulk delete report schedules'} +> - - 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 index 992981fc7d3..cb7a672fedd 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index ea320f5587a..24ef408dd91 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 845115f0f27..cc325278103 100644 --- 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 @@ -1,33 +1,32 @@ --- id: bulk-delete-rls-rules -title: "Bulk delete RLS rules" -description: "Bulk delete RLS rules" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Bulk delete RLS rules'} +> - - 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 index 992981fc7d3..cb7a672fedd 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 9487fc8839c..2ea7782224f 100644 --- 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 @@ -1 +1,68 @@ -{"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"}}} +{ + "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 index 1bf063feeba..f513ba6cdb8 100644 --- 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 @@ -1,33 +1,32 @@ --- id: bulk-delete-saved-queries -title: "Bulk delete saved queries" -description: "Bulk delete saved queries" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Bulk delete saved queries'} +> - - 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 index 55d5b6143f8..e8c75b3e85e 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"delete_tags_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 01e848f7ae2..9742516e55f 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 7c8d9d294e1..81844b0b3ac 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Bulk delete tags'} +> - - 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/bulk-delete-themes.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.ParamsDetails.json index 992981fc7d3..cb7a672fedd 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.ParamsDetails.json @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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-themes.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.StatusCodes.json index 1ffc33fea3f..adfdb5ebd74 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.StatusCodes.json @@ -1 +1,68 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Themes bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { "message": "string" } + } + }, + "description": "Themes bulk delete" + }, + "401": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { "message": "Unauthorized: Authentication required" } + } + }, + "description": "Unauthorized" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { + "message": "Not found: The requested resource does not exist" + } + } + }, + "description": "Not found" + }, + "422": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { "message": "Unprocessable entity: Validation error" } + } + }, + "description": "Could not process entity" + }, + "500": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { + "message": "Internal server error: An unexpected error occurred" + } + } + }, + "description": "Fatal error" + } + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.api.mdx index 2fa7692c19f..31a536fab43 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.api.mdx @@ -1,33 +1,32 @@ --- id: bulk-delete-themes -title: "Bulk delete themes" -description: "Bulk delete themes" -sidebar_label: "Bulk delete themes" +title: 'Bulk delete themes' +description: 'Bulk delete themes' +sidebar_label: 'Bulk delete themes' hide_title: true hide_table_of_contents: true api: eJzFVttu3DYQ/RVi0IcYlb22kQKGgjw4roMkNRKju24LWMaGK41XsilSIUcbbwX+ezGkVnvxFkj74idJFOfMOXMjO2iklTUSWgfpbQe50YSaIO1ANo2qckmV0aMHZzSvubzEWvJbRVg7fqFlg5BCpQnnaMEnqxVprVxCAlSR4u850rRAhYTTqnDTHsp7n0ClIYVvLVrer2XN27+Bv0vAomuMdhhcnR4f8+OHOTbWNGipitY1OifnuMHZka30HPyas5k9YE4sAp9k3SjcMlwb+AQKdLmtGnYNKUxKrNGJWaseRRTJIK+PT16W8I2WLZXGVn9jkYrzlkrU1PsXFr+1lcVin55Nw6jk9csq+WxI3JtWF6mYlBi4oyMshEVnWpujKAw6oQ0JfKoc7RM1YARFp6cvnZvGmpw/ZwoF54WWqfhDqqqI+UFrjd2n48K0qghSe4Teml398tI98lETWi2VcGgXaKOKVJxr0Wp8ajDnpIVFYfK8tf9SgO8lSTWEIAGHeWtZI0+ph+8E6e0dDwiSc55cfQPCXQJPh7kpcByoxaGmpJ5DCvnN71eQgJIzVOvPWD383VolDv8Sv15eXU4uRQYlUZOORsrkUpXGUXp2fHY2kk01WpyMiP2NMhBZlmkhDj+IDM77lgmxTsU7lBat+On84uJyPJ5Ovvx2+TkD8MnA6HpJpdEbnIaFgVVVN8bSqt5dpjO9moni7bB8FGfOK6YifpR6EneXKAu07m23IyCDVGTQi8hA/CxkzsU2JfOI2mf6INONrTS9WhE6ciSpdVOO/8Gmzk9yIcchuRtatxbXWTDasdxBovwuKxL3SHkZ5P0XcV1UWCOVpmA1Mbe70tPVRrGbRI7B11Ueu6h/EuR/jRaeHxyLN5lm6kbhkTLz3ZAcvAmn2XaJv1sfFoJi+SYQuUIK/SmSQCOphBS2BXLIQn/FCm8tR3RvYGDX7RX/FgUuUJmmRk19p4aERaCusYZMbpRPR6OOoXzacR36Z2gXrSNTryASWEhb8UBz/XAJMPxe4L1sFfU0IQHUbc2d23/yI/TvNv6HyeRaDDg+AWazjTfofUZuHEcQ/+NbhTBWfLxmENayDbI3VL192O09Z3A1hsZ5TFjaD6MOZqFK3htbS8b79OeEcxS2Qdr/hWGIBtE+YeOpxXuLrvy/IOH+dG+inC32bYPWIW3cwTaWuHbivsVJDImjWobTob+B7a3PLRfDKUH4RKNGyUozVCiiri/cW5BNxf5OmEdQkgDnOSbyFrpuJh3eWOU9L8drIBf1jqvhSIN1BLb9PuIyXBy5ClXL/0PXrUoyHBkJxKYPHqLBeZ5jGEIrq2cnJqMMjRlnCCTAN6SNGAzZ6V/YweoqrJcb8F0Xd8RBwi0VeYS5Cv7Oe/8P7HX75w== -sidebar_class_name: "delete api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Bulk delete themes'} +> - - Bulk delete themes - + 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 index cfcd6a9119d..e64f40aeb13 100644 --- 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 @@ -1,12 +1,12 @@ --- id: cache-rest-api -title: "CacheRestApi" -description: "CacheRestApi" +title: 'CacheRestApi' +description: 'CacheRestApi' custom_edit_url: null --- Cache management and invalidation operations. -| Method | Endpoint | Path | -|--------|----------|------| +| 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 0ecb63ee172..8f90505de1e 100644 --- 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 @@ -1 +1,153 @@ -{"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}} +{ + "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 index 27e75e294c9..71b234fca3d 100644 --- 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 @@ -1 +1,243 @@ -{"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"}}} +{ + "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 index f28da7b3e98..1db90b03890 100644 --- 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 @@ -1,33 +1,32 @@ --- id: change-a-database -title: "Change a database" -description: "Change a database" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Change a database'} +>     - - 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 index d5c057f083b..76356188441 100644 --- 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 @@ -1,31 +1,31 @@ --- id: charts -title: "Charts" -description: "Charts" +title: 'Charts' +description: 'Charts' custom_edit_url: null --- Create, read, update, and delete charts (slices). -| Method | Endpoint | Path | -|--------|----------|------| -| `DELETE` | [Bulk delete charts](./bulk-delete-charts) | `/api/v1/chart/` | -| `GET` | [Get a list of charts](./get-a-list-of-charts) | `/api/v1/chart/` | -| `POST` | [Create a new chart](./create-a-new-chart) | `/api/v1/chart/` | -| `GET` | [Get metadata information about this API resource (chart--info)](./get-metadata-information-about-this-api-resource-chart-info) | `/api/v1/chart/_info` | -| `GET` | [Get a chart detail information](./get-a-chart-detail-information) | `/api/v1/chart/{id_or_uuid}` | -| `DELETE` | [Delete a chart](./delete-a-chart) | `/api/v1/chart/{pk}` | -| `PUT` | [Update a chart](./update-a-chart) | `/api/v1/chart/{pk}` | -| `GET` | [Compute and cache a screenshot (chart-pk-cache-screenshot)](./compute-and-cache-a-screenshot-chart-pk-cache-screenshot) | `/api/v1/chart/{pk}/cache_screenshot/` | -| `GET` | [Return payload data response for a chart](./return-payload-data-response-for-a-chart) | `/api/v1/chart/{pk}/data/` | -| `DELETE` | [Remove the chart from the user favorite list](./remove-the-chart-from-the-user-favorite-list) | `/api/v1/chart/{pk}/favorites/` | -| `POST` | [Mark the chart as favorite for the current user](./mark-the-chart-as-favorite-for-the-current-user) | `/api/v1/chart/{pk}/favorites/` | -| `GET` | [Get a computed screenshot from cache (chart-pk-screenshot-digest)](./get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest) | `/api/v1/chart/{pk}/screenshot/{digest}/` | -| `GET` | [Get chart thumbnail](./get-chart-thumbnail) | `/api/v1/chart/{pk}/thumbnail/{digest}/` | -| `POST` | [Return payload data response for the given query (chart-data)](./return-payload-data-response-for-the-given-query-chart-data) | `/api/v1/chart/data` | -| `GET` | [Return payload data response for the given query (chart-data-cache-key)](./return-payload-data-response-for-the-given-query-chart-data-cache-key) | `/api/v1/chart/data/{cache_key}` | -| `GET` | [Download multiple charts as YAML files](./download-multiple-charts-as-yaml-files) | `/api/v1/chart/export/` | -| `GET` | [Check favorited charts for current user](./check-favorited-charts-for-current-user) | `/api/v1/chart/favorite_status/` | -| `POST` | [Import chart(s) with associated datasets and databases](./import-chart-s-with-associated-datasets-and-databases) | `/api/v1/chart/import/` | -| `GET` | [Get related fields data (chart-related-column-name)](./get-related-fields-data-chart-related-column-name) | `/api/v1/chart/related/{column_name}` | -| `PUT` | [Warm up the cache for the chart](./warm-up-the-cache-for-the-chart) | `/api/v1/chart/warm_up_cache` | +| Method | Endpoint | Path | +| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| `DELETE` | [Bulk delete charts](./bulk-delete-charts) | `/api/v1/chart/` | +| `GET` | [Get a list of charts](./get-a-list-of-charts) | `/api/v1/chart/` | +| `POST` | [Create a new chart](./create-a-new-chart) | `/api/v1/chart/` | +| `GET` | [Get metadata information about this API resource (chart--info)](./get-metadata-information-about-this-api-resource-chart-info) | `/api/v1/chart/_info` | +| `GET` | [Get a chart detail information](./get-a-chart-detail-information) | `/api/v1/chart/{id_or_uuid}` | +| `DELETE` | [Delete a chart](./delete-a-chart) | `/api/v1/chart/{pk}` | +| `PUT` | [Update a chart](./update-a-chart) | `/api/v1/chart/{pk}` | +| `GET` | [Compute and cache a screenshot (chart-pk-cache-screenshot)](./compute-and-cache-a-screenshot-chart-pk-cache-screenshot) | `/api/v1/chart/{pk}/cache_screenshot/` | +| `GET` | [Return payload data response for a chart](./return-payload-data-response-for-a-chart) | `/api/v1/chart/{pk}/data/` | +| `DELETE` | [Remove the chart from the user favorite list](./remove-the-chart-from-the-user-favorite-list) | `/api/v1/chart/{pk}/favorites/` | +| `POST` | [Mark the chart as favorite for the current user](./mark-the-chart-as-favorite-for-the-current-user) | `/api/v1/chart/{pk}/favorites/` | +| `GET` | [Get a computed screenshot from cache (chart-pk-screenshot-digest)](./get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest) | `/api/v1/chart/{pk}/screenshot/{digest}/` | +| `GET` | [Get chart thumbnail](./get-chart-thumbnail) | `/api/v1/chart/{pk}/thumbnail/{digest}/` | +| `POST` | [Return payload data response for the given query (chart-data)](./return-payload-data-response-for-the-given-query-chart-data) | `/api/v1/chart/data` | +| `GET` | [Return payload data response for the given query (chart-data-cache-key)](./return-payload-data-response-for-the-given-query-chart-data-cache-key) | `/api/v1/chart/data/{cache_key}` | +| `GET` | [Download multiple charts as YAML files](./download-multiple-charts-as-yaml-files) | `/api/v1/chart/export/` | +| `GET` | [Check favorited charts for current user](./check-favorited-charts-for-current-user) | `/api/v1/chart/favorite_status/` | +| `POST` | [Import chart(s) with associated datasets and databases](./import-chart-s-with-associated-datasets-and-databases) | `/api/v1/chart/import/` | +| `GET` | [Get related fields data (chart-related-column-name)](./get-related-fields-data-chart-related-column-name) | `/api/v1/chart/related/{column_name}` | +| `PUT` | [Warm up the cache for the chart](./warm-up-the-cache-for-the-chart) | `/api/v1/chart/warm_up_cache` | 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 index 93d7fe662b7..33f96812ce7 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_fav_star_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index f696a006165..cc6fdb942d6 100644 --- 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 @@ -1 +1,85 @@ -{"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"}}} +{ + "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 index 60b51a4abb5..b64fe6a877c 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Check favorited charts for current user'} +> - - 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 index 93d7fe662b7..33f96812ce7 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_fav_star_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index f696a006165..cc6fdb942d6 100644 --- 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 @@ -1 +1,85 @@ -{"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"}}} +{ + "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 index c0af7bfad44..8b8421e5934 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Check favorited dashboards for current user'} +> - - Check favorited dashboards for current user - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.StatusCodes.json index d0849a9c672..29166a61cf5 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.StatusCodes.json @@ -1 +1,56 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"},"example":{"result":"string"}}},"description":"System dark theme cleared"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { "result": { "type": "string" } }, + "type": "object" + }, + "example": { "result": "string" } + } + }, + "description": "System dark theme cleared" + }, + "401": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { "message": "Unauthorized: Authentication required" } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { + "message": "Forbidden: You don't have permission to access this resource" + } + } + }, + "description": "Forbidden" + }, + "500": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { + "message": "Internal server error: An unexpected error occurred" + } + } + }, + "description": "Fatal error" + } + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.api.mdx index d85f40a6455..a735cab430c 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.api.mdx @@ -1,33 +1,32 @@ --- id: clear-the-system-dark-theme -title: "Clear the system dark theme" -description: "Clear the system dark theme" -sidebar_label: "Clear the system dark theme" +title: 'Clear the system dark theme' +description: 'Clear the system dark theme' +sidebar_label: 'Clear the system dark theme' hide_title: true hide_table_of_contents: true api: eJzFVm1v2zYQ/ivEYcAaTImTvQABi37wMgdtF2zB7GAbIsOlqUukRCJV8uTGE/TfhyNlxXYyFGsG7JNo8u74PPfy0C049LU1Hj3IFr49PuaPtobQEC9VXZeFVlRYM7rz1vCe1zlWile1szU6KqK3Q9+UwYvWNYIET64wt9B1yWbHLu9QE3QJ4IOq6hK3/R7tuwQy9NoVNV8MEqZrT1iJTLl7QTlWKHSJymHGob4/PnkB6gq9V7f472EPjnBlVEO5dcVfmEkxbihHQ/39wuHHpghIn9LadoxMvvt/mZxbtyyyDI0Uf9pGZNZ8TSJXKxQ1uqrwnhmRFUpr9F5QXnjh0NvGaXyO4BCPb/zhRd31H7B7ZwidUaXw6FboBDpnnRRjIxqDDzVqwixuCqt14/6haueKVBntwuUedeMKWoO8buHuE4G8nnfzBEjdepDXMOOG9TBP4OFQ2wynAZoP5qUytyBBX/12AQmUaonl488+rxJ040px+If4aXIxmU1ECjlRLUej0mpV5taTPD0+PR2puhitTkZhQEaN8UgLHwZnwYOTgkjT1Ahx+FakMO4bLyRfih95mpz4anx2NplOF7Nff578kgJ0yQDxck25NVsgh40BZlHV1lHoePTkU5OajbyIN8P2UYYlEr5iKOKLuSTRPUeVofNv2j1GKUiRQs8qBfFN37ILsvdoutQcpKZ2haFXG4RHnhQ1fsEVOtgm/l6t1DSUf4v8zuZjnazxzH/grD6pgsQNks4D3xexbSPlCim3GdOL7bCfC7kxFPtl5qR82FS6jQmZhXx8iB4dfzg5r1PDXGyJR6W93c/RwWvg/t6dijMWZBZn4ffFGhKIoEFCLD4kUCvKQcJnqHN2w7DGcWkcJ//ZHMI+oAs+FhmusLR1hYb6sQ+1jYHa2lmy2padHI1aDtXJlnu4exLtrPFkq02IBFbKFWpZRm3ahOF1hjcqPmcMExJA01QsA/1P/gQx2I3/dja7FEOcLgFGsxtv4PsE3DTqGZ8ZVaGwTry75CDMZTfIs6nq/YN113FtN5o21VG8ZK9sLSxD/5xbVymO9/73GdcomIHsT2FQ5EC6S9h54fDGoc+/NEiXQGFubKSzg76p0XnktFBBLPrbW9w70W51ElPiqVLhqeFcfbZzd+4a3h7CBxrVpSrCyxa6qe1b+hpUXfDFJwyoj/K0seebEl9D2y6VxytXdh1vf2zQ8WMyf+yy8KQkECc8TMI9rkHCWGsMErRSZcO4nryoXMxh+KJgQAL8t2OLzZDwfsEX9EfKrLfCt220iKrBUxJxBFWFbt513d/O2JHE -sidebar_class_name: "delete api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Clear the system dark theme'} +> - - Clear the system dark theme diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.StatusCodes.json index a15e5453cf5..85d76b4e861 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.StatusCodes.json @@ -1 +1,56 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"},"example":{"result":"string"}}},"description":"System default theme cleared"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { "result": { "type": "string" } }, + "type": "object" + }, + "example": { "result": "string" } + } + }, + "description": "System default theme cleared" + }, + "401": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { "message": "Unauthorized: Authentication required" } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { + "message": "Forbidden: You don't have permission to access this resource" + } + } + }, + "description": "Forbidden" + }, + "500": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { + "message": "Internal server error: An unexpected error occurred" + } + } + }, + "description": "Fatal error" + } + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.api.mdx index 15c7ec85cde..4cf12812b50 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.api.mdx @@ -1,33 +1,32 @@ --- id: clear-the-system-default-theme -title: "Clear the system default theme" -description: "Clear the system default theme" -sidebar_label: "Clear the system default theme" +title: 'Clear the system default theme' +description: 'Clear the system default theme' +sidebar_label: 'Clear the system default theme' hide_title: true hide_table_of_contents: true api: eJzFVmtv2zYU/SvExYA1mBInewABi37IsgRtF3TB7GAbIsOlpZtILUWq5JUbT+B/Hy4pK3aSYY8M2CfRfByecx+H7sGhb63x6EH28PXhIX8KawgN8VC1ra4LRbU1kw/eGp7zRYWN4lHrbIuO6nTaoe90PEXrFkGCJ1ebWwgh28zY5QcsCEIGeKeaVuP2ufv9IYMSfeHqli8GCdO1J2xEiTeq0ySowgZFoVE5LBnt28OjZxBv0Ht1i/+c+XgQrozqqLKu/h1LKU46qtDQcL9w+KmrI9PHyrYPJiXf/L9Kzq1b1mWJRorfbCdKa74kUakVihZdU3vPisgKVRTovaCq9sKht50r8CmBIx7f+N2zCuw/UPfGEDqjtPDoVugEOmedFCdGdAbvWiwIyzQpbFF07k+ydq5I6bQvXu6x6FxNa5DXPXz4TCCv52GeAalbD/IaZlywHuYZ3O0XtsRppObjdq3MLUgorn6+gAy0WqK+/znEVULROS32fxU/nF2czc5EDhVRKycTbQulK+tJHh8eH09UW09WR5PYIJPOeKSFj72zGHonB5HnuRFi/7XI4WSovRh/Kb7nhnLii5PT07PpdDH76cezdzlAyEaWl2uqrNniOU6MTOumtY5i0aMnn5vcbExGvBqnD0rUSPiCqYjnyMkSQoWqROdf9Q9E5SBFDoOwHMRXQ+EuyH5EE3Kzl5vW1YZebEgeeFLU+QXnaW9b+1u1UtNYBFv6dybvs2WN5xCMstVnVZO4QSqqKPm5gvukukGqbMkKU108DIfcbBQPk81xeb/Jd59iMosheZ9OBP5wfF7mhuVYjQfa3j4M095L4ELfbY9TdmZ2aeGfMG7IIPEGCakKIINWUQUS/joAHObYu6l7OsdZeDKY8JDWBS+LEleobdugocEFYpITUN86S7awOsjJpGeoIHuu5/AI7bTzZJsNRAYr5Wq11MmqNjA83hBPNCEDNF3DrjD85E/0hl3817PZpRhxQgbMZhdv1PuI3DTZG68Z1aCwTry5ZBDWsgvyZKiG83F3CJzhjcVNi+RlcjC6Hpaxis6taxTjvf1lxjmK20AOqzAadBQdMj68cHjj0Ff/FiRkUJsbm+TssO9adB45LFQTvwHbU1w7ad/qKIXEU6Piy8Ox+jv1u3Pd+BoR3tGk1aqOb10sqH4o7GtQbc13HzGnAeXJ8p5vEn0Nfb9UHq+cDoGnP3Xo+IWZ39dafGcySN0e++EjrkHCSVFgdKSV0h1Te/TMckrHLkzmARnwf5EtQWPYhwFfMCwps96C7/u0IzkI90riEU0WwjyE8AdoS5vc -sidebar_class_name: "delete api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Clear the system default theme'} +> - - Clear the system default theme 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 index 9ab8ada76b1..e955c28721d 100644 --- 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 @@ -1 +1,27 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 2f96284074c..24ff429b742 100644 --- 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 @@ -1 +1,130 @@ -{"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"}}} +{ + "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 index 667daabac26..506fc9e589d 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Compute and cache a screenshot (chart-pk-cache-screenshot)'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 0586bdc674d..e09de9d9e58 100644 --- 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 @@ -1 +1,40 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"activeTabs":{"description":"A list representing active tabs.","items":{"type":"string"},"type":"array"},"anchor":{"description":"A string representing the anchor.","type":"string"},"dataMask":{"additionalProperties":{},"description":"An object representing the data mask.","type":"object"},"urlParams":{"description":"A list of tuples, each containing two strings.","items":{},"type":"array"}},"type":"object","title":"DashboardScreenshotPostSchema"},"example":{"activeTabs":["string"],"anchor":"string","dataMask":{},"urlParams":[]}}}}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "activeTabs": { + "description": "A list representing active tabs.", + "items": { "type": "string" }, + "type": "array" + }, + "anchor": { + "description": "A string representing the anchor.", + "type": "string" + }, + "dataMask": { + "additionalProperties": {}, + "description": "An object representing the data mask.", + "type": "object" + }, + "urlParams": { + "description": "A list of tuples, each containing two strings.", + "items": {}, + "type": "array" + } + }, + "type": "object", + "title": "DashboardScreenshotPostSchema" + }, + "example": { + "activeTabs": ["string"], + "anchor": "string", + "dataMask": {}, + "urlParams": [] + } + } + } + } +} 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 index 7b3d2f3a589..11617d56cdc 100644 --- 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 @@ -1 +1,93 @@ -{"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"}}} +{ + "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 index 31334ccfcd2..aa9622cd122 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +title: 'Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)' +description: 'Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)' +sidebar_label: 'Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)' hide_title: true hide_table_of_contents: true api: eJzFWG1v2zYQ/isEMaAJpsRJ0QGFin5IsxZtt7VB7GIDoiA9SxeLtUSyJOXEE/TfhyNlvdjOVqwB+skmeXfkPffw7qiaazBQokNjeXxVcyF5zDW4nEdcQok0WvKIG/xaCYMZj52pMOI2zbEEHtfcrTVJCelwgYY3zXWQRuteqWxNIqmSDqWjv6B1IVJwQsnJF6skzfW2tFEajRNovWzqxApnMPejDG1qhCZNHvMzVgjrmEFt0KJ0Qi5YkGcO5vaYR1w4LO3ghNYZIRe8iTYTYAysaQwyzZXZt0nQGW/jcmRBg3bZMZ6Bgz/ALr0HWSbIFhQXQ89IaryRZGr+BVO3uxOZYyXY5WCzIEubVaa4oAA+jJC6Za7SBdqIIaQ5o1iAkN78nWodHOG1A1CzvXHEnXAFTfwKNp8rMNk0NYjS5spdKOumIaJNxPEeSk2i43BebQC77tHfTI0gHPt4dd00dByDVitpA02enjz9DpKlkOZ4s8T1LoKzHJlfZrS8N9St9zeVKfbrV6ZgTjGDMkPTBrRV2mdRlLDA/7R2iy7NvTHbwb7PmgO7vLEOXLWHH2QvrHmOEKntWqbfYrLSGTjMbsDtN+tEidZBqTeWC7COpTnIBTIh2213zX8L0c4pID3bLlsm7GXcILZDco2C1i8MsO8nRxBuTQ9h6H3Yudzd0VuADdqq8Lf32cnJdzC3RGthgXsy3A6OY1g6Rf4KMtbm6pi9kysoRMb6isC0USuRYbbPrYFu8OX0x/rySULlcmXE35jF7KxyOWXRsD/rytceR4aKwZNnP9aTD8qxW1XJLGZ0m1qQkeC2qjIpskyhZVI5hveC4N91qrNBu/zyo3n2Tjo0Egpm0azQMDRGmZidSVZJvNeYknd+kqk0rcwDkXoDDoog5ze3mFZGuLXvXL7cOV8grul2LnyN6W6epTpzf5SqDKf+eKHZKUAueMzTT5e/84gXMMeiHwaoaUxZ9+gvdvFxOmMJz53T8WRSqBSKXFkXPz95/nwCWkxWp5MuuUxOJyH79OmmT6yThLMkSSRjR29Zws9a+vlwxOwVgkHDfjo7P389nd7MPv72+sNY4TwE8mi21hiz7Vj2shl7Uid8ieuExyzhKygqTHjzhDdR5/zF2uVKDtzvJjoARKmVcRse2kQmclOA2ctu+lgr6w5oX/ZoKEXBXI6QobEv6y2sglstXglnPzNIU7T2xqklyqbVJkxe7sMhkYeJ1EZId7Dx55iEDw4Phwi9hxVMPQsHKI0me6oo6ZvSDhy4A+FCvfbQPCowdfCvRJerjBwjhm6DFm/E2DbTCIzPG7LVAbmZB+5z1KsMuRbg2+VbkN7gPVfZOmbvpx8/HIdEIW7XBzX1UAPwWXNI0hSDF4kMuPlWd4PZVkRaIVXgcaEWByR6+ILTZR+niHNV6spRg561vRsMOhp20OF5pJdHXuCon+oFD3nEA670AFKWouxfRTHfjVWtl82/hYsY4vNeyDqhw9jLA77tzu+0zDJcYaF0idK1GdTzMxiqtVFOpapo4smkJlNNXNOFbXasnVfWqXJjIuIrMALmRUjzGzOhpbsF6lHCMXnEUVYlZdR2SD8+p47tv53NLlhnp4k4nWZsr/N353DTUBpojR6eTBn27oKMkC9jI3uhavW9dONfoZvy4HvD4KQvEjWfe9a/Uab0vdv7P2e8fdLSLQ6rfXvqnW4iUr4xeGvQ5v/XCFmxSl727+PXj/tAklVRXNNDQt6q3eZ8Wmk0FoeN9WCKGBrkVqcBeOtK8L1B+yngEW/X6GBdZ+Hw3k10AUK2r1vPTH/xrjhoQac8HTbxPOKx/0Dx8P3jEScUAxeveF3PweInUzQNTX+t0FADcd1fB39LM2Hpf8bjWygs7hy4a6b4wWXbXB6yPtxjRzbvabn2t66oaMQjHp4meskbilnI2H73sDDMvQPFneaNkkHQOEtT9CXpYdnrQWajgsEjPm+/05QqIx0Dd/TFB+7CIZX32V8fPxcKYxU6u2CTeE1N9CCSHf/bP+TVXhjqOkiE0tN0qPgaTsA0zT/bp3gi -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)' + } +> - - 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 index 74d702d0d05..9e47ade133e 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} +{ + "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 index c1f43f2dc07..361d2447048 100644 --- 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 @@ -1 +1,42 @@ -{"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}} +{ + "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 index dc0f000d393..18421c1303e 100644 --- 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 @@ -1 +1,85 @@ -{"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"}}} +{ + "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 index a97aab65a1e..589c2ffcd95 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a copy of an existing dashboard'} +> - - 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 index df9c665d2a2..03fcc54acaf 100644 --- 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 @@ -1 +1,24 @@ -{"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}} +{ + "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 index 4167d2c3a2d..e6fdc6f697e 100644 --- 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 @@ -1 +1,83 @@ -{"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"}}} +{ + "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 index afcc93b0c4d..0f9099f97e2 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-a-css-template -title: "Create a CSS template" -description: "Create a CSS template" -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a CSS template'} +> - - 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 index c7b01c489be..035243c837f 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}]} +{ + "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 index 936e4a7a9a0..649a1b5fa0f 100644 --- 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 @@ -1 +1,90 @@ -{"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}} +{ + "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 index 4ce99f6bda8..04e1dde4656 100644 --- 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 @@ -1 +1,71 @@ -{"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"}}} +{ + "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 index 3146f187b00..1e1f9d13b43 100644 --- 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 @@ -6,28 +6,27 @@ 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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index bc4fda7ee83..cff1d2a2696 100644 --- 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 @@ -1 +1,116 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_id` and `datasource_type`.","type":"integer"},"datasource_name":{"description":"The datasource name.","nullable":true,"type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":1,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"type":"string"}},"required":["datasource_id","datasource_type","slice_name"],"type":"object","title":"ChartRestApi.post"},"example":{"cache_timeout":1,"certification_details":"string","certified_by":"string","dashboards":[1],"datasource_id":1,"datasource_name":"string","datasource_type":"table","description":"string","external_url":"string","is_managed_externally":true,"owners":[1],"params":"string","query_context":"string","query_context_generation":true,"slice_name":"string","uuid":"550e8400-e29b-41d4-a716-446655440000","viz_type":["bar","area","table"]}}},"description":"Chart schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "cache_timeout": { + "description": "Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.", + "nullable": true, + "type": "integer" + }, + "certification_details": { + "description": "Details of the certification", + "nullable": true, + "type": "string" + }, + "certified_by": { + "description": "Person or group that has certified this chart", + "nullable": true, + "type": "string" + }, + "dashboards": { + "items": { + "description": "A list of dashboards to include this new chart to.", + "type": "integer" + }, + "type": "array" + }, + "datasource_id": { + "description": "The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_id` and `datasource_type`.", + "type": "integer" + }, + "datasource_name": { + "description": "The datasource name.", + "nullable": true, + "type": "string" + }, + "datasource_type": { + "description": "The type of dataset/datasource identified on `datasource_id`.", + "enum": ["table", "dataset", "query", "saved_query", "view"], + "type": "string" + }, + "description": { + "description": "A description of the chart propose.", + "nullable": true, + "type": "string" + }, + "external_url": { "nullable": true, "type": "string" }, + "is_managed_externally": { "nullable": true, "type": "boolean" }, + "owners": { + "items": { + "description": "Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.", + "type": "integer" + }, + "type": "array" + }, + "params": { + "description": "Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.", + "nullable": true, + "type": "string" + }, + "query_context": { + "description": "The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.", + "nullable": true, + "type": "string" + }, + "query_context_generation": { + "description": "The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.", + "nullable": true, + "type": "boolean" + }, + "slice_name": { + "description": "The name of the chart.", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "uuid": { "format": "uuid", "nullable": true, "type": "string" }, + "viz_type": { + "description": "The type of chart visualization used.", + "example": ["bar", "area", "table"], + "maxLength": 250, + "minLength": 0, + "type": "string" + } + }, + "required": ["datasource_id", "datasource_type", "slice_name"], + "type": "object", + "title": "ChartRestApi.post" + }, + "example": { + "cache_timeout": 1, + "certification_details": "string", + "certified_by": "string", + "dashboards": [1], + "datasource_id": 1, + "datasource_name": "string", + "datasource_type": "table", + "description": "string", + "external_url": "string", + "is_managed_externally": true, + "owners": [1], + "params": "string", + "query_context": "string", + "query_context_generation": true, + "slice_name": "string", + "uuid": "550e8400-e29b-41d4-a716-446655440000", + "viz_type": ["bar", "area", "table"] + } + } + }, + "description": "Chart schema", + "required": true + } +} 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 index 0ca732ef6fd..f6f61fa71fe 100644 --- 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 @@ -1 +1,202 @@ -{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_id` and `datasource_type`.","type":"integer"},"datasource_name":{"description":"The datasource name.","nullable":true,"type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":1,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"type":"string"}},"required":["datasource_id","datasource_type","slice_name"],"type":"object","title":"ChartRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"cache_timeout":1,"certification_details":"string","certified_by":"string","dashboards":[],"datasource_id":1,"datasource_name":"string","datasource_type":"table","description":"string","external_url":"string","is_managed_externally":true,"owners":[],"params":"string","query_context":"string","query_context_generation":true,"slice_name":"string","uuid":"550e8400-e29b-41d4-a716-446655440000","viz_type":["bar","area","table"]}}}},"description":"Chart added"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "id": { "type": "number" }, + "result": { + "properties": { + "cache_timeout": { + "description": "Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.", + "nullable": true, + "type": "integer" + }, + "certification_details": { + "description": "Details of the certification", + "nullable": true, + "type": "string" + }, + "certified_by": { + "description": "Person or group that has certified this chart", + "nullable": true, + "type": "string" + }, + "dashboards": { + "items": { + "description": "A list of dashboards to include this new chart to.", + "type": "integer" + }, + "type": "array" + }, + "datasource_id": { + "description": "The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_id` and `datasource_type`.", + "type": "integer" + }, + "datasource_name": { + "description": "The datasource name.", + "nullable": true, + "type": "string" + }, + "datasource_type": { + "description": "The type of dataset/datasource identified on `datasource_id`.", + "enum": [ + "table", + "dataset", + "query", + "saved_query", + "view" + ], + "type": "string" + }, + "description": { + "description": "A description of the chart propose.", + "nullable": true, + "type": "string" + }, + "external_url": { "nullable": true, "type": "string" }, + "is_managed_externally": { + "nullable": true, + "type": "boolean" + }, + "owners": { + "items": { + "description": "Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.", + "type": "integer" + }, + "type": "array" + }, + "params": { + "description": "Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.", + "nullable": true, + "type": "string" + }, + "query_context": { + "description": "The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.", + "nullable": true, + "type": "string" + }, + "query_context_generation": { + "description": "The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.", + "nullable": true, + "type": "boolean" + }, + "slice_name": { + "description": "The name of the chart.", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "uuid": { + "format": "uuid", + "nullable": true, + "type": "string" + }, + "viz_type": { + "description": "The type of chart visualization used.", + "example": ["bar", "area", "table"], + "maxLength": 250, + "minLength": 0, + "type": "string" + } + }, + "required": ["datasource_id", "datasource_type", "slice_name"], + "type": "object", + "title": "ChartRestApi.post" + } + }, + "type": "object" + }, + "example": { + "id": 1, + "result": { + "cache_timeout": 1, + "certification_details": "string", + "certified_by": "string", + "dashboards": [], + "datasource_id": 1, + "datasource_name": "string", + "datasource_type": "table", + "description": "string", + "external_url": "string", + "is_managed_externally": true, + "owners": [], + "params": "string", + "query_context": "string", + "query_context_generation": true, + "slice_name": "string", + "uuid": "550e8400-e29b-41d4-a716-446655440000", + "viz_type": ["bar", "area", "table"] + } + } + } + }, + "description": "Chart added" + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { "message": "Bad request: Invalid parameters provided" } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { "message": "Unauthorized: Authentication required" } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { + "message": "Forbidden: You don't have permission to access this resource" + } + } + }, + "description": "Forbidden" + }, + "422": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { "message": "Unprocessable entity: Validation error" } + } + }, + "description": "Could not process entity" + }, + "500": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { + "message": "Internal server error: An unexpected error occurred" + } + } + }, + "description": "Fatal error" + } + } +} 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 index 6a7394315db..e8d86cfa602 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-a-new-chart -title: "Create a new chart" -description: "Create a new chart" -sidebar_label: "Create a new chart" +title: 'Create a new chart' +description: 'Create a new chart' +sidebar_label: 'Create a new chart' hide_title: true hide_table_of_contents: true api: eJztWm1vG7kR/isDokBsVLIkx3Z8e8gHx01wyQWJETttD1YgU8uRlgmX3CO5khVB/70YcldavdjnNtcmBfzJEndmOM9w5pnhynNm8fcSnX9hxIwlc5Ya7VF7+siLQsmUe2l057MzmtZcmmHO6VNhTYHWS3RBjacZDrzM0ZRBWaBLrSxImSXsb6UNdmBPanCYGi3cPpgR+AyBdKUeQ6UNI2PBZ9JBmnHrD+Cd8RgXBI54qbwDb4Km4J47U9oUO54PFS5NyBGUWuBIahQHrMV0qRQJsMTbElvMzwpkCZPa4xgtW7RYSlhGFdyBQM+lcjuAxAdL15tad+/jvJV63NgGxWA427Z+gdYZDcbC2JqyAJ9xDxl3sFRrBOYh2wnusqHhVgQo0mO+A9MZKOk8QVqJU4SlTlUpqtBrnMZtwRuK6HYEqxVuLZ/FvevDGUixvetVhiBFHcggjL6zUtrcdiqVgtLhAZxBavJCoW8mAEiBenUWoBGFg5s1J26Aa7G2Rj7f7IbTkNI8x90AGvuT0D2p1jyTte13G6Yn8US24lIDRQFGbyIkD1CXOUuuWSgJVm2IlC+/l2hnrMUcn6AY1N8mEqfs0y5Pm25tZ03j+7IewlERNRj3sGjgrUeruRqUVtEmf6gg3SDnmo9RDGpdNbtHc2iMQq5J1Uw12vsq4T0JALdIiWYdSOGAK2WmVHgGBIakM5Zw6jGusdTrESgcecC88DOYmTJm7BDBaKzjEz1Yi9bDiqnglu/y+ILW0ZNRcnuMGi33KEDMNM9lSsGBaYYaUiXTL4FmMwRKAMJhJminVnqEYem90SB1eI63hTIWgVLjAK4I5pvL9+/ADD9jGhm6MFO0VZymmYGcz2DKNfEDcOXRgiswpYKEYunkg1Ii5OUgNKLbHb2EyiOIQCUCFguLDjU1huqhRBfZk3iAXLJlAGesQEvf60gt2Sd8mEhXciW/Bg5pBbqQGqZkaGRszv1K3GWmVILO16Iv7f2N5g5wg8qLnQW2jXMl3YQ8zdBnBKqWr61LF46nkRTGgjYenImxkR6EQRfWykJQNIJCbkTgF+e5v6+KG6XllLyXKOnJVtrn/PYt6rHPWHJ43G2xXOr6e29H6Moy9pF4EiyJCw+I+UR+fQDVRu5aywAKRzhWvOXUcYhVh9yyFuMWORVu2PfTvVC6Wx4tWmHqkhYFWVxvlNsNYi26K56OtUhOSE+usXMC8AGdPyvkQWGcj/xaeb41o/XuHHpqRzfHldV6c6647n3aava9Hf2zqb3RAVetau10lgrrTWK1fkcviGlQs33wr+bPle4Gy9zxYK1Co91mqq+0YnKy4+Munh51u208/GnYPuqJozZ/1jtpHx2dnBwfHx11u90ua2bk7oRaLDbbbzxdqObvZgKRVyGjXGG0i+P4Ybf3DcN8LLPqaHSZD2NPsuhK5R9n/8fZ/3H2f5z9H2f/x9n/cfZ/nP0fZ/8fdPZfbEqv3waqMX011P23rgc/+O3g//JycMftgAuBgs75qNv9hvk/R+f4GBuXgEb23pdTS0X2gguofllI4LWecCVFoxfQmDCRwdltLA3diOVb7jJ/ApaPmpc+M1Z+RZHAWekzGsLSmoyrYt4BpKkYkTz9vkheGTuUQqBO4DdTgjD6Cd0xJggF2lw6R4ioh6cpOhdHHIuxGHcBXNoL6A4Pv/c5FdaQ4+E6SGfkZwn8nVIvnhVaa+wuHOehnVMrrCxU2rTV8fcupdc6chc4tBO0EUUCZxpKjbcFptTdwyKYNC3tHcn4inuuliFoMYdpaQljcj1nn6eeqHBBHYaPiRYjozjqObft1Ai8DK65IK64HrOEpR8/vGUtpvgQ1eprlS4JS0uroP1PuHh/eQV9lnlfJJ2OMilXmXE+Oe2ennZ4ITuTXic04E6fQb/f1wDtX6DPzqriCZFO4AVyixb+cnZ+/vLycnD1/teX79YVzuMZta9mBSaweUwrWQFP5n32BWd9lkCfTbgqsc8WT9iitcR2MfNZuNbX6JYLS3wyL4z1NVW5vu7r+iUMPF8uh268R/vCQ4PQitIZcoHWPZ9vhCJ6XYWjz+CvVb0OvPmCelFpE+Tnu2D29X5fF1Zqv1e7e0DCe/v7zQC84RN+GfKnEYS1xdVBG+0oDkvsfMqlhxH6NAvI/x3c8+h+jj4zgvym9NmMSVKLwWaeENabOlXmMTBXIS43rZVKM1NidLazJUrX4RwaMUvCReggVrAczfbm8AVnjdjCYp+kKcQ/93UMS7gw1CHZCHglZBQeKDPeI9H9nxlV4QY/WaQBna9eidAEHSLEEhbGPZpiaOJk60GlYwq0EQs3Tkg7D2NrvnpLj0HgBJUpctS+IqCQJNHQvLDGm9SoRdLpzMnUIplTUSy2rJ2Xzpu8NtFiE24l8bSrODOYiUN6eM9Xudl4pVF9pT+Bltbt/3J1dQFLO4sWI2/W7S3xbjl3GZmVnsXLioXXF+HqbeyGkZ2hqvSD9GJB51ez6yX1hQgycOycDUNuvqrvMW/+cUVnFMToWhWerl4LBNCLFikPLI4suuw/NUJWnNEfVv/v8fLO3wa6f9bw392e/rs/0vTf/R+O/09H/PR4dHLUPn7We9Y+Oj45bA+fjtL2YfrTydPRyQkf8ZOHjP8tJvXIbF9oL8sCbXzZV18LG0vEAVFu0oup7XzOw/BS+buTZTbeA9Zngre+Uyguw+RXvb6LBHTNeCFpvx7lSGWF6jUW5DWbz4fc4UerFgtajm8iwz2s5oQwirRY5PrAW19wFsa0FWsHClFleFG2OY8RQUWNszTF0Kvulv3UYFJqNazFhtX/QuVGkI7lU/rBhU9ZwliLmRCMUNJhLXbMMg5r0SbVGo3+jYgta7L6QKjqF3161vBwPo8SsWkRkUYoobmzBd3+/gW6FDTV -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a new chart'} +> - - 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 index 2cbcc60d3e7..f321e144ede 100644 --- 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 @@ -1 +1,95 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","nullable":true,"type":"string"},"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this dashboard. If left empty you will be one of the owners of the dashboard.","type":"integer"},"type":"array"},"position_json":{"description":"This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view","type":"string"},"published":{"description":"Determines whether or not this dashboard is visible in the list of all dashboards.","type":"boolean"},"roles":{"items":{"description":"Roles is a list which defines access to the dashboard. These roles are always applied in addition to restrictions on dataset level access. If no roles defined then the dashboard is available to all roles.","type":"integer"},"type":"array"},"slug":{"description":"Unique identifying part for the web address of the dashboard.","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"theme_id":{"description":"Theme ID for the dashboard","nullable":true,"type":"integer"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"type":"object","title":"DashboardRestApi.post"},"example":{"certification_details":"string","certified_by":"string","css":"string","dashboard_title":"string","external_url":"string","is_managed_externally":true,"json_metadata":"string","owners":[1],"position_json":"string","published":true,"roles":[1],"slug":"string","theme_id":1,"uuid":"550e8400-e29b-41d4-a716-446655440000"}}},"description":"Dashboard schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "certification_details": { + "description": "Details of the certification", + "nullable": true, + "type": "string" + }, + "certified_by": { + "description": "Person or group that has certified this dashboard", + "nullable": true, + "type": "string" + }, + "css": { + "description": "Override CSS for the dashboard.", + "type": "string" + }, + "dashboard_title": { + "description": "A title for the dashboard.", + "maxLength": 500, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "external_url": { "nullable": true, "type": "string" }, + "is_managed_externally": { "nullable": true, "type": "boolean" }, + "json_metadata": { + "description": "This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.", + "type": "string" + }, + "owners": { + "items": { + "description": "Owner are users ids allowed to delete or change this dashboard. If left empty you will be one of the owners of the dashboard.", + "type": "integer" + }, + "type": "array" + }, + "position_json": { + "description": "This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view", + "type": "string" + }, + "published": { + "description": "Determines whether or not this dashboard is visible in the list of all dashboards.", + "type": "boolean" + }, + "roles": { + "items": { + "description": "Roles is a list which defines access to the dashboard. These roles are always applied in addition to restrictions on dataset level access. If no roles defined then the dashboard is available to all roles.", + "type": "integer" + }, + "type": "array" + }, + "slug": { + "description": "Unique identifying part for the web address of the dashboard.", + "maxLength": 255, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "theme_id": { + "description": "Theme ID for the dashboard", + "nullable": true, + "type": "integer" + }, + "uuid": { "format": "uuid", "nullable": true, "type": "string" } + }, + "type": "object", + "title": "DashboardRestApi.post" + }, + "example": { + "certification_details": "string", + "certified_by": "string", + "css": "string", + "dashboard_title": "string", + "external_url": "string", + "is_managed_externally": true, + "json_metadata": "string", + "owners": [1], + "position_json": "string", + "published": true, + "roles": [1], + "slug": "string", + "theme_id": 1, + "uuid": "550e8400-e29b-41d4-a716-446655440000" + } + } + }, + "description": "Dashboard schema", + "required": true + } +} 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 index 369783b94d4..442adfd57a5 100644 --- 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 @@ -1 +1,163 @@ -{"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"},"theme_id":{"description":"Theme ID for the dashboard","nullable":true,"type":"integer"},"uuid":{"format":"uuid","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","theme_id":1,"uuid":"550e8400-e29b-41d4-a716-446655440000"}}}},"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"}}} +{ + "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" + }, + "theme_id": { + "description": "Theme ID for the dashboard", + "nullable": true, + "type": "integer" + }, + "uuid": { + "format": "uuid", + "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", + "theme_id": 1, + "uuid": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + }, + "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 index 2f8347ec242..45021dbb476 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-a-new-dashboard -title: "Create a new dashboard" -description: "Create a new dashboard" -sidebar_label: "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: eJztWW1v2zgS/isD4nDb4OzEae20q0U/pGkXm17RBnWKO6AuvLQ4tthQpEpSdrSG//thSMmWX5Lttgss9pAvrUVxZjjPvD1UlszilxKdf2FExZIlS432qD395EWhZMq9NPrkszOa1lyaYc7pV2FNgdZLdEGMfk7r3WOBnksVXgh0qZUFLbOEvYwvwEzBZwhbUqzDdKkUnyhkibcldpivCmQJc95KPWOrTmMGxXhS7Wu/QuuMBmNhZk1ZgM+4h4w7WIuBz6QDwV02MdyKrzLpDvjxbo7WSoFwMRzC1NjgzVrtMTugZ/127KUne7s6zyG8OKwu57dvUM98xpJBr9dhudTNc+8rnMBbj1ZzNS6tIsu/KyDdOOeaz1CMG1lV3SM5MUYh1yRKqTLO0XPBPd9385oi8Hr47i2YyWdMPUgHM9RouUcBotI8lylZg0WGGlIl0xupZwESx+dI4TVztAsrPcKk9N5okHobMphLXBzDZdCOt4VxKCBDG9G1OEWLOkXgWoSVwizQQunQOlhkBnJewYJrD94AVx4tgCswpVyFglueo0frDsbZLDTakDLSY34od2gDcIu1PSkccKXMgtLTgECFPniZZlzPcCdlj+FyCgqnHjAvfAWVKWEhlYIJgtHYVFY8RfN0KDOl9jhDS0euV7i1vKLnwjgZ6rip+gMR/BwqLUYwvp6gC8YaaQpabX8hxQy92wtTE6F21De5EOLPxefS+SYBGkVO/haD1xhzMKmgdLRPWD6Df4KwpjicF4eiVpQTJV2G4mDPQptLjZQa6DO0FBxt/E5kyJG5dHKisLGrpPOEAVdqs6+dNq2ysUbhfWnznt6TDR7VLjKZZiBwGk7G0xSdo/zZAfg6Q4cQlIec42rBKweht6Ogg3IhAoQkbJEgSSOiRgOVsEMPCueoaiMhA7WpdcYDUGPFXazprHMuQ7uIhaSi0NdloVPlbB+GD1p+KRGkQO3ltKKAF9z6dddc4IQ8soTGoexvNdLHg8FWIz39ikbqM8xxLA+kyTW9gcuX+/377inT8r4so9KpsTn3LIkLv3uiDW6xFgnZOF7Yy8b+e3T+vJDHhXE+DgOeF3EC3TG2G/W7A7e17ra27Q23zavt0bNZv2PCRC93ZshGqumuH08/7fWpza5WNUd9dXEFqZhXm82bkJ42YWCDQQ+f9Xu9Lj7+cdLtn4p+lz89Pev2+2dng0G/3+v1emxF6O/0inXy10SpE/iVtM1RqNDRFUa7WOyPe6ffwbpiytQJoMt8EnPJoiuVfyBpDyTtgaQ9kLQHkvZA0h5I2t+LpO1JbNO2mqxs5vzfl8d9E437k1ncPTSOC4GC0O/3et9B1HJ0js+wxdbuzI3tSK8F2QsuoP5Wl8ClnnMlRWvMQWHNXIbD7vvTko2+fA/p/BN8+aB56TNj5W8oEjgvqS/52j6sCfMBR9qC0ZP+X+vJW0NdrdQioSbegIwEtzOlTRGEQRcGEd7KUNp7Tq11kJXBX51nlzoWMTi0c7SA1hqbwLmGUuNtgSl5FxbBpGlp74jUz9xzFfcF4w7T0kpfseTjkn1eeKri1acO83xGFb0pOcc+ddhtNzUCh+F4Logorqne0w/v37AOU3yCavMYoabn0iro/heu3g2vYcQy74vk5ESZlKvMOJ886z17dsILeTI/PVn3upMRg9FopAG6v8CIndcZFhBP4AVyixb+cX5x8Wo4HF+/+/ert9sCFzFW3euqwAR2w7XZK+CH5YjdYDViCYzYnKsSR2z1A1t11v5dVT4Lt6zGw/XC2keZF8b6JtXcSI90c6WE5+vlMEgekV34I0B0okSGXKB1z5c7cMST15CMGPyrphtjb25Qr2ppcvv5IVdH+mikCyu1f9Qc+Zg2Pzo6aoPwms/5MORSC4itxU3AjXaExdp/vuDSwxR9mgXv/6jvy+hCjj4zgs5OqbSLS9Jsg918IX9/bVJmGcG5Dtj82tmItDMmIrSfNXF3A+nEiCoJN7LjWNFyWj1awg1WLXxhdUS7CeafRjpCQ4N3DcsO6PUmo/BYmdkj2nr0E6Oq3K7lC4vcI3DQuNhiTBEllrDAWjqs4ETR2D64FLLQTmIxRwpxMDBs1/gbeg2CuK0pctS+bkwhYaKiZWGNN6lRq+TkZEmqVsmSimS1p+2idN7kjYoOm3Mribm5upcGNZE3TnkgV+GYxH90mVOjqh/pv9CqtvX/cn19BWs9qw6j02zrW/u7d7hh7Lj0TvM8XC8vr+Jdz+4oOQhVLR92r1YUx6brDmleRCdD712yScjRnxsi+/o/1xSjsI2uPOHt5gYQnKbPBgs/tji16LJvVVJ/fHi/+bPjq/+H75G9byKyvXuZbG/NZJ9M+bPB9KzfHTw9fdrtD84edydPpmn3cfrj2ZPp2Rmf8rPwRUhPzf6tZ1gWaB227x2tJarKuG9+Wn9Y8DkPNIOy8L763zKzphweb/1JobgMV+b6Y1ZsDR8ZLyTZPG0HiXUYVVIslY9suZxwhx+sWq1o+UuJtoqkv6nWQB46LHbj0FFukNKh3VdDcasy3FZ3GRS1jihxnqYYJsrdez+1+hwNA9Zhk/qP5bkRJGM5fa6gfxNGOREACcUW1uJcKyO9ijqpCojJtlBbV0v9g7xqbtu6ap1wuYw74lihFhddCSOYrT6tVqv/AW+fFfQ= -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a new dashboard'} +> - - 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 index 929229370aa..1f548b9c5e2 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"string"}}]} +{ + "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 index b39d1a8ea92..7d42e6d868c 100644 --- 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 @@ -1 +1,126 @@ -{"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"},"chartStates":{"description":"Chart-level state for stateful tables (column order, sorting, filtering)","nullable":true,"type":"object"},"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","chartStates":{},"dataMask":{},"urlParams":[{}]}}},"required":true}} +{ + "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" + }, + "chartStates": { + "description": "Chart-level state for stateful tables (column order, sorting, filtering)", + "nullable": true, + "type": "object" + }, + "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", + "chartStates": {}, + "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 index e498778f061..2d30848feb3 100644 --- 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 @@ -1 +1,72 @@ -{"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"}}} +{ + "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 index 8163850449e..942a1ac695a 100644 --- 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 @@ -6,28 +6,27 @@ sidebar_label: "Create a new dashboard's permanent link" hide_title: true hide_table_of_contents: true api: eJzFWA1vGzcS/SvE4IDYuLUl+a7X3LY+wLGd1jk3MSwlOZxkqPTuSNqIS25IrmxV2P9+GHK/JK2TNOmhQBCvyJnhvDfD4ZAbyLjmKVrUBsLxBhIJIWTcLiAAyVOkX0sIQOPHPNEYQ2h1jgGYaIEph3ADdp2RlLE6kXMoijsvjMa+UPGaJCIlLUpLnzzLRBJxmyjZ+2CUpDF85Gkm0NC3zFPUScTFVHM5x+ksERY1zZg8TbleQwivKxl2SzLspZcJYMVFjiQbc8t/4WbprVvNXyqdXnDr/PUmPdpICQjB/jZVs5lBCwGoDEL416m3BuF40O/374rgSdEfG9ETJ3pXBOUSQ8utc0fweyRlssV+PGWP9N9Jv9+47JYJvIEAkphQno2u3l1OX15djy5vp1cXUBRFADZJcTrXPJGd1IySFNlPNP17WWkZNh8FhxBuBu97g39+3z/qD476fxv1+6H79194GuB7xCVDGSdyzobc5jrm6xbIp01+CeqnE8Kh/qpcaAxDCBdno8uzi4sD+ju6+uXyYAIn/ZPvyNnBP2pnJ3AYsKPvAxbz9SELWYdIB0OlO3/sGp9hLFIiTz+RJ+du/vdSNtdc5oLrxK6rTFE6Rj2NCeqTyMdtqc+E26l0+v2OZr59w2vkYuqqW7mLr17XuxheqYVkF4q87NjLNZyW2CfAFO1KmWmVobaJL3U8sskKR/ze/YrRRDrJqDBCCOe51igt8zIs5mZxr7iOmSXxABKLqekovgHIXAh+L7Cq06UA15qvaZ7LaKH0/opv3AcXzAswkcgl43GMMbOK5VqwBTfuUOheoPEgWnBtHV9dwGjySOAKBTMkw2ZK+69ZLgieQMMOfOoylzIBM0rbRM4D5mORyPnh046o+w8YWXKknRTbXlBmsJSbJcsNxs4FyR3TfgXv0JeskWtxQwdoB9S3t9fspjlcW0H7hBxb4vrI5RjLeKL3XPhshItdJ6kWWOFqT5VFN6hTTgF2URr6/CyC6iDeTc5xFdy7Jn2qod1wb9O+TdB4U9y5HbHdS7gBkylpfMKc9Adf0DQ8tauWuN6neLRAIpYyWaPVCa6Q2QWyjIiQtNFcupPnx9CR0rkW+0a3lTv09kKxTbHztOHRrdHoEpF7GHb8feCGGas0xszkUYTGzHIh1se00N/7/W9gMUVj+By72rtPg6oV4QWPWdkHhuxKrrhIYtY0myzTapXEGHdhbel6LN+SEX8AlreS53ahdPIbxiE7y+0CpS3XZ3U2dwBpKzokJyd/NpJMK8oUqiCMUNh1yN5RcDwa1FrpLijnKhcxk8qy0kKpTUt992cn25W0qOn0MqhXqD2KkJ1Jlkt8zDCyGPtBpqKIDtfOcL3klouaggAMRjk1Oq51+PBgIRzf0f3G8rmri3VFZTf1zrxO5JIq5eNRpGIcVlebMXXJcg4hRG9vryGoe+byp1G5jghKRGft0X/YzZvhiE1gYW0W9npCRVwslLHh8/7z5z2eJb3VoFf3Bb1BL6uK+gTYZDKRjB39zCZwVuafC0XIXiDXqNlfzs7PL4fD6ejNvy9fbyuc+yAejdYZhmw3jo1szJ5tJlTEJhCyie+LJlA8A7oslVBv1nahZAtsPVDDTdJMaVvtdjORE1mdBuy0Hj7OlLEHtC77Sk4Cr7xAHqM2p5sdZjyIkp0JsL8y7grq1KolyqLUJgZOu1BP5OFEZjqR9qDy/piEDw4P23y84is+dPnW4mRrsEkDJQ3RUlPBH3hi2QxttHBEfAMNG48mRbtQMcGgXNulKKzE2G4WEfRfq0TaeJ5GjqZfg0alnUeerP1c8tIVu/cqXofs1fDN62NfAJLZ+mBDB3eLalYckjQx/sNEepbo3K4Z2uG/FFICj4WaH5Do4Q9Am3invGmkbpQziQ9Nv/3M7Jy5EICnjRoAZShk7rEkhH3iN9myaLin4Lri5IuBP+47Qwi7vl3TNIupaVZZSq54Sy61vKFNppVVkRJF2OttyFQRbmhnFXvWznNjVVqZoGuPTlzbXVZmZ8a3OzOeC1u6CQGgzFMqe+VP+mNgj8mfR6MbVtspAiBvtu3VePecG/r6TXN0P2NKs6sbMkJYto10UlXqO+nCvUVVNdy1uR6kq+QbuHcpTDdFTvZevR9BeVujDehnm67OgS4CUp5qnGk0i681QlaMkrfNK9nl/7nzpjuDu6fKmdrvZId5htq/aVV3hdYQpayXWw18JIxNuTvRywfCL987W+vWx73FR9vLBE9kq9n222oMPEvIiQFpV6YhgNC9Sja7667KszFsNvfc4FstioKGP+ZIbwfjuybV3Q6ME9cExRDOuDC451zdzcDBbdniHbImlNtOV5cw2XrvAgjKJj9bgntL8KXVre4n2kWypbjXPdFG9xpnUYTupHha9q5Vo6iyQwD35UtsqmLS0fyBnnT5g3dSOcxua7gxf17lvrXyNilnqZVtRa3O7fKDUHXSsNl4CX9GFDUr7mgFdyf8HzPzpCM= -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index 59f66b9df37..8a808b9d24e 100644 --- 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 @@ -1 +1,153 @@ -{"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}} +{ + "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 index c178dba40e4..c840843ca4d 100644 --- 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 @@ -1 +1,217 @@ -{"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"}}} +{ + "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 index c71bc8af868..82df58e11b3 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-a-new-database -title: "Create a new database" -description: "Create a new database" -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a new database'} +>     - - 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 index 70c7bb29a72..b6dc3299efb 100644 --- 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 @@ -1 +1,58 @@ -{"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"},"template_params":{"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"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","template_params":"string","uuid":"550e8400-e29b-41d4-a716-446655440000"}}},"description":"Dataset schema","required":true}} +{ + "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" + }, + "template_params": { "nullable": true, "type": "string" }, + "uuid": { "format": "uuid", "nullable": true, "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", + "template_params": "string", + "uuid": "550e8400-e29b-41d4-a716-446655440000" + } + } + }, + "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 index 333d08c408a..68334e0f465 100644 --- 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 @@ -1 +1,127 @@ -{"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"},"template_params":{"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"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","template_params":"string","uuid":"550e8400-e29b-41d4-a716-446655440000"}}}},"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"}}} +{ + "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" + }, + "template_params": { "nullable": true, "type": "string" }, + "uuid": { + "format": "uuid", + "nullable": true, + "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", + "template_params": "string", + "uuid": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + }, + "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 index ffd5edc3d31..b62a6af6bf4 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-a-new-dataset -title: "Create a new dataset" -description: "Create a new dataset" -sidebar_label: "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/isEMaAJJsd2arupin5IsxZNV7RBnW4DosClpbOthiJVknLiCvrvw5F6s+O8bOnQAusnW+Td8Z57eXRUThV8yUCbFzJaUT+noRQGhMG/LE15HDITS9H9rKXANR0uIGH4L1UyBWVi0FaWX7KVnsxibkBNEhaLSWRMglsRzFjGDfVnjGvwqFmlQH06lZIDE7TwaMgM43KOwgm7egtibhbU3x/2PJrEonrueVRknLMpB+oblTWmtFGxmKOliBk2ZRrQVLkZCwNzULgLVwaUYHySKY4Sd5qL9SRhgs0hmlS6fHWLZguTkCphPP4Kk1DyLBH6fqGQlwKUlY0NJHo7jnKFKcVW+Nwk5YHh01/uFxeDuxPBErjj0P42ZUhSzgxMUqaYg3jngVkWRyg4w6ga6ruFOxEVni3vWEFE/bOmOtYQnNdqcvoZQoO7sUGb9DdmmAbzAbQ5TOO9VGrj6oglKYdb6975U1d25VK7RPubFdkI3VB4zuiW0nIbVfGc9c+bomiM2uw2j+0ktlY3s9NsuSTQ4bAHB4NerwP7T6edQT8adNiT/qgzGIxGw+Fg0Ov1erTA2EegQxWnSCBNMEnpWDs16L7NlU6l0I5R9nv9B/CRK5cyryJLpq5zFGjbfz/p6yd9/U/pq9iUXyc0dLTfbpQfk+F+BIK7keFYFEGEcR30eg/gsAS0ZvM2GbQK47Yc1or0BYtIOeD55FgsGY8jYoGDAaVJquQyts5eR9PSdVgewsffAMtHwTKzkCr+CpFPDjOzAGHK80ndJ1uAtBUtkv39740kVTLExykHgijMyid/YHIcGlBKqm1QjmTGIyKkIaWFUhuPGn7vYjsWro+JBrUE5VD45FCQTMBVCqGByC0SGYaZuiFdr5BR6hB4VEOYKcTon+X086XB7i+Q9dgcmaDqOo1MeNUJZQRj65y2CpwJJKfw44e31KOcTYE3j1pmKkTXw0xx0vmLnLwfn5KALoxJ/W6Xy5DxhdTGP+gdHHRZGneX/W7kzusGlARBIAjpvCYBPSxLzEbbJy+AKVDkl8Ojo5fj8eT0/e8v360rHLk8dU5XKfhkM1WNbEQe5QG9gFVAfRLQJeMZBLR4RAuvRneyMgspWvjqhRphnKRSmaqhdSACUY1b5Hm9bN8RO3guuX8YPCe/ABaB0s/zjWA4v8uABJT8SliIpTsx8gJEUWoj6OfbgAZiNxCpioXZqRzeQ+Gd3d12CN6wJRvbKmqFYW2xSbYUGiNRo2eXLDZkBiZcWOz/DHnuACRgFjJCz7GINqPiV2Jks1YQ7aeqXHIXmlMbmU9eo9KuFhef6xXjpKuATmW08smb8ft3e66T49lqJycXsGpFlxS7KI1BfhYIFxiEVwdlI+SlkOSwx+V8B0V3n1Hsxg2eUsAMEEYEXJIyXtSjLkbUp3YU8WjKcMqim4HFZFkKcS3sJoetKaGbB7/FbRLBErhMExCmJCNbKs5QnippZCh54Xe7OZoq/Bybo7hm7SjTRiaVCY8umYqRs3XJn9bM2mRs3aQeBZElSE7lI/5Yglq3//r09ITUdgqPojfr9mq815wbO5bFPZxxiFTk+ASNIJZ1I1tDVepb6aLAHFZMO8Z3hANp+TanU1ufr6rx9c2fp7QcwOwFwO7S+j1hQRceKk8UzBToxb81gla0FB+aj1Qv73H5Lu8nt86mvW83m5bH1cNp77+cTh/P2MFwNhp0hk/6TzqD4Wi/M308Czv74dPR49loxGZsZC9/YiZdFawlPUtBuWasbgmtJWw5J7fsu0rSJmF2bigdvaGx1w6pJwgDV6abchbbu2F5a3U9f0ZZGuOJ/TIpzg62iOuBM5rnmKiPihcFLn/JQK3c5F+1oZ0EPOoo1lLFBazslNSQpe1antkL5+Y4hJzgNA7DEOxL4mbZ8xZ9IcNTj07Lb6aJjFBHsUv8qsEuqU+pR6UNh+0iu+ZeVZmblZxNLG+cTVsxq9ug/IOoqguzWLU8zHMn4d4VyF0Oin2r0uK8KIq/ARlfgck= -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a new dataset'} +> - - 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 index 5e4888401a0..836431eaf3f 100644 --- 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 @@ -1 +1,5 @@ -{"parameters":[{"in":"query","name":"tab_id","schema":{"type":"integer"}}]} +{ + "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 index afbc36e6219..69bb92e2583 100644 --- 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 @@ -1 +1,37 @@ -{"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}} +{ + "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 index f481dc28551..f38244072a9 100644 --- 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 @@ -1 +1,71 @@ -{"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"}}} +{ + "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 index 9609c6e94ff..2fed2af78ff 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a new form_data'} +> - - 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 index fccb93729cb..642b7568d9a 100644 --- 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 @@ -1 +1,28 @@ -{"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}} +{ + "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 index e498778f061..2d30848feb3 100644 --- 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 @@ -1 +1,72 @@ -{"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"}}} +{ + "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 index 94bd12459ae..ce9b66c6f0c 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a new permanent link (explore-permalink)'} +> - - 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 index fccb93729cb..642b7568d9a 100644 --- 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 @@ -1 +1,28 @@ -{"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}} +{ + "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 index e498778f061..2d30848feb3 100644 --- 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 @@ -1 +1,72 @@ -{"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"}}} +{ + "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 index c8f9c119f2b..0d44ba425af 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a new permanent link (sqllab-permalink)'} +> - - 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 index eca3f99a355..66033849cc6 100644 --- 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 @@ -1 +1,60 @@ -{"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}} +{ + "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 index f831a0c46b8..9cb14e0455e 100644 --- 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 @@ -1 +1,142 @@ -{"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"}}} +{ + "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 index fd68c5d1eb8..b85be6e85bf 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a new RLS rule'} +> - - 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 index 65254d09350..8e83e69880f 100644 --- 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 @@ -1 +1,780 @@ -{"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","Webhook"],"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/Coyhaique","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}} +{ + "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", "Webhook"], + "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/Coyhaique", + "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 index 2dd6cd9e346..47d129a8f39 100644 --- 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 @@ -1 +1,852 @@ -{"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","Webhook"],"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/Coyhaique","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"}}} +{ + "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", "Webhook"], + "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/Coyhaique", + "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 index 1616fbdbb59..2562fb0fdc1 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-a-report-schedule -title: "Create a report schedule" -description: "Create a report schedule" -sidebar_label: "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+moQUApWSCuasZpRYeIOxAtox5RmUsxZkbYrbsw2y7IpqIKG5h14y18rNJ8q6kVuZtMgMcy44fPT9qqVbehEezN5e9n3c7NdNBUI8uCqR7MF0TXNnE0ugbOcSFdDByvecWMcEw7Zov335qtkkLyjs1LKRfL+mW04/X6wTNEcm3Cl7z+7Q5uHC1lSXPLBqasVb3z0Ohkk48uTZJAMJzfJIJke/+d0g0yDRFNOM0Pz1MAsHvUN02uzz+vk0R/4pqV98sMF0QYMrZyecXHO6ZwJqqPYxLsyXUrLc1JQ07s0nA1CmhcER+yDpWqFHo9+rJ3kOGsUNVYJQplr7fL64sIFLkTYakbdMNq16T45vjgeTn0JeX31dkQMq2iqqWJUozI4TTaoC5kepNhgTQekLSOe3fdUUQw2cEo1Ts+Hqe3sbOuE4dTBXLEMdg9mLL8DDBlbIMsUBGSeM50ezGAWgrxg6H96QFcQ1dIVDelDqGAhQ1oUlkX0neUBzbQGG9AchFkpGiAKHh5gyTgPQXtnq5kN3zwEpmRIaphxEFnIQq0JSSlgoVY9cAQLUCGpUqrTCXCAKoDv2ExaE3TqSFrgQcPHPD0AZgNdv1aUGgzrO+QEZlJJEfTpFBSEHX8jSxCC6plVRYDacHzOoaqjV59jUCFtIO45K4CzkBa6BB3UuYBCBkN8wWaKrun7QlYhZUHkYQN2ZqsZ6JKFmIZFwDMCDjMZ0rU1Ea2pCgxhhIYYqmckC8iZLkMeKZRcsuAtl2gEs0CMy/wOKipCFgYVDQb9UlpYZKU0psfeWiggl7aQwdvGUhm5cymXgdQTkOk00s2UVTO7MEG9qWK1DEdgagUL9P2OibyUFP3+QUWbuQgRKbJSKihohBWWcT/0HWRYYSNEQWGBiRgrMK4SOImokDo9YIrqjQxDMFCByjZXH8pK5ldsCTk0Y7CBReVytrnsjb2zq40lF5BeMXm3udqIilw+bC67YjI9Ac5pY8/PGCbAzeaqExDpG+vd48bCC8s2tzm1ma0+UfFalxbWdGNjfWgrMr+T7yDDFnIRt2gWYaVDKNkzOj0EkVMFOipQM8gjZRxSTquYZg+hYaEHznYmMOORVIcS0humI/UdykKuAUxHbW22sCFUM8XygqaHsIrxWqYnCjsSwSKzIgIUZBC3+NxSh7CiQsQNreKRGpYsg0LGSGmhjGbRkNkccjQPRR9CXCrg6SmombQqxtesfii1QaOO5ZOrEtgHG0moqDaR3oeWQdyWxc6HMh+BwI2uLmEpIvhey+dAOlQ0cjZHVCypigCjJDMhInGjFEl/nFdSxKIeM2UFrcP+HHNcPpeQy/AFx0JTAXnY3GuMPC8pjyV26DtYRaOIIHAa+YATjrvb2JpOZG5KmEWI1M+40NrSqVWLCFyX78RCTrm0Ue9OLEahwNcYV/DBunC+x1YQ+eBT4GwOHyNkucZCVSU14zwc6TORMxDdv7is6A3F50J+3ACPQFFRbGpvTA1VXaCxVjilnKdDZlYbym7oEjbiTGQ4+TZJ944JqCB7XvK8O3bJwmE5+wDcRob5BiqI7XJ9WXljBfUBZgOcU2FstljtXkjLdBfnrJeOpDAso7H+UbHp2WWIKOBU5OwulPMC0jGEnuKCVaGMF+gTRUF5pJ+N8lzIe6rSsUJ9hswjyCiTESAgXvwRsXEdxQppYsQwseaDRuhLpZJx1QcwPPKdzxfiERXoJ2jUGFUsj5kMhwU2FoEfWSbXjWyEgsWr0EiKzKwjhipFV+vYkuVUroGKAl+DNFUKQp1cQrsjaQF6n/4oI/9wyWpWRGJcNkFgRyopSogRU6ZHsJAGF13LofxU6ZBilz5ViuJMIF7EL60NxXt7xwQU4dvHgHMuBgrBlLGiiFCFyyibhYobl5IKFjoUjIR3wO54s1wrSOU8ndTAxBou04NMrTPL9IbyMnqbpQhfsSxGhYH0AN1yaJZXwMQqvWLx+nUFYsFEeiY4DQcWzz7mNAKKODS+olpyayIeJtNDBSKS5kpqUNHsmwDKd6ZhRvk6rKKhQojFMQdCMnVr7Bou0zHYyANNMqmonq20FXkIl6xWMguNYMLioHFi0kNQpsT4bxXjb2QpdAydM2PWoAubsbUGp6WsYI3Nu/5Q8ZN7Njfp0CoV41Na2Ax3p3XY7LS0kQeclhbj2rVle8rubLxgTnHKGRkjRkZ+5gYH0sbWcsNUERnru5IZWkoVRbLvmBCspuFk+REW1kSu40dcLu4XojEzHPvMMH8Y4R1UDx3B0i92AWQxpDq6Vt0i0JeNIPtgQbFncBvjBVg2siqXMTgGXvlu99iVxOMtiMGJtKZMx3JdgMlK3q+xTpXkPIZupDbSWaEDdi+kKFYU1GxFnZSa4eY2eOYVeJ/vqKoJzx0hIF+pjvpgvFNuCDmjHaXLAmZ+IBp6UcIM8g4wK9VXPoSizPvCQyhV46w8uQg4RbHwvfGkEuDPrhxJmbLdSw+ZLhe058VImLXUEHhmjd8pObpkISHZDLjuez4spSg++K9WDWBFsQgByWXlnTSSR5Bl0BMV6Mwv/I4um3MYRzDeSXVkZxAQugTRK/U1VFBY3Yt5Ag/dM255epWd0pmSPSXTYcnSERNlD4kiPZe9+Kdy2en/TC2s0Z3izrQBMeu1/AaP5Hop3sAK6ubYz9FUWd0uhgicQ1D5HKqsBNN3/xw3jiXrSTQd1ZOmrEDkNgBiugSRr4q+OckX0At3rkALuQLVd+ccDwbTC1vVtn+NzcpgLM/tPbDOjkbt3q4lbE8UkPdGMoIFBiqqpwXjnSgjq7N+RlyyTGrWFeIR1sI+CBroHTHNZiyQ/W0VPCvotDouhazSMe0HeIyxMgjo2McrnPfQd/IHML2oP+BuWEA37X9YPay4VHkn4BWIQvYmdcVWkHcvm0AbenlqUQJnAY1bYRCdfU2o7A1igt/Ayt7qJ0wUUEvVmf1E0VzQheSroPNTYHU/maeAM110yp3OGGe6L6al6kdpSnl6sGTLji7xeDCk6rIn5WIleyKQ4PrOiiId46lrr9NrDiBmEGr2moNID8HIHlG2+tAJd63NziXtp88NfgpizTGrAzjkbNk5cYTcMqcDUgTq/5EuwFDFRLt39KCiS68D3DPgOnDwIJsjoBY5pKqyfshbaAgC/HF8j9Q0vaHKHwe16GugSq4ha8AbEOkImkWnBUeQU6aiV17R1eIOml1mC/ol8IRKVbCIe2LSU8qb0+QeBMH96m61UcBxxRlOYzqnHJjvRQceKqbbI+4AlAsq0lPmV9YOH6JzVl74HrSqiQg66AjUvZ8NHXRsMx7XO5UzcFcoeuji9Cymmchpsxr3oFR5eirv41eOKMcDsLWOXE7exTTuYSJkTNeRHyxeYeDN7O1gNx4xssrFmsqnoCsQLO7oDcuMVGvgO6rjvv+IUeE9E25c8XMT47vNXqWhjmi/oWugY3CtNFTT5vB46j6RTv86PHJPgMdIu62t9Ahu8bxLbQBsjirRAyOJWx4WIJf0fo63Gxr9NOgYMjYPm56AXoDJSnoPQeUf7cLN2mHJOMUvX4YJKowXwWFegrNW/UN/Tn3senQ8af5+c+z6dVysauzvMXNaOjbZ7slo2j/9eS94fhk+RwVRyVcBET7/JXj+Onj+Jnj+a/D8t+D52+D57/3zTiDFzsvwOSqISr4Kib+ERCDUTsgVMoU8geA7geA7geA7geA7geCdeHjX555lZUNfD1vlX0+H7ZPAbbF2I4z0T5bjSnNs8VrF7kGFo52775otJHLpPUwL4ARZlM6MWsiU1G0VG/qQ8rmfCD1QKHCerkOUX59bWoFhmsMSQsxq7a+rtYjF61E0atrmUK8hmomCBo0PS6aZgKCjQ1lTUULEdWRnkUgnbKbwy5AKIEuV8Ju2BjmlXDOxYD1ypjnF045RqKEggG2QN3hBKmjoHOMVJlBNAcjoMqSUDMkVC6gLpmcyeOPFnZ3xO78ZbiEp8ojFfqQVOumix0aQK5aHtP821pGK0RKqoJUREy4OaEkpwB2LdLTO5H1P91FnA7zVPGAfg2LBgI9lXkjlz3JbCL9eBpZ0xYqg9MqfuDWUi/sgpDEAUEzIEFNwR5driAk1PWHVnCpZy2D8JgtZ34WvkvOwVxMjs0UpeTCTpsA5E4Hmpkz5hT6gdfSSa74CIZehfq8fykIqGQzRDeT2ISRxzx28BsO50AxuGBfMBkq+kbyQseG9A6UhGLWfoFB0FtK1VPKhXAXi/2SV9z0nh+7PTrMO+DWg9f+to238VuizTt16gvvChd8WnmW0WXf8twD8lg0C40HmxqtBh2VzVaGjFdPGH0G1kMwiDolH2T19TlVhMYbroRGUNKR4zpZUh4hVzHg9dtBKGhPUuqJW+K+4Zz76P9MK3FFg/4XiDdSu6Pwe7oBT54Au2GyFZSO3zI4mzd+/jdwy64/Fdw/hDjB8ojE0cVvKBjihgvqA4vIn92dneHqAbVzCEu5QAeMrXBnGk+m3Y9d4EzjsHtTOmjvSZotmKFroUFq809meSrXwsARTugWkR/w5dEv7kCIE5mDCJo7xZG9mXdDfYq9hAXIuQ4TdsZC0Aub+/k0LnQCHujGNHqtmLHo7fsMDnoFwegrQsA+nUkjul8oWcsej/qtDC52DWAMY2kgFkVjnEq0gBIKhb7ER3FklI0BhYgKEnRmx/B5CLV2CVaGMl8yGL7qUai75IkJsRcOBHkOBx8uFjDAOYatjZjJgKhR3LEvhd8M9IqCmEaBMOvLn1AF8BUoaKYpQiAkwPyl6oJIhwxRKFul0CgruIw5s0kAdyj1VkR2+gwWNSO4/NLbAj1AjJVu7l8rYwhnJ1duh+3uOlzKDwwL8XuzWdB95XU92DzjG3e0ztbitbijFHqRoivrA/3ri5sdO8/GzR/w24Hqyewr3wJh/brh2JgavtHtsxLKSFe1rgg3D9STYFlxPOqX64DAMDN/tTK7xH+d+XIS46VLnr913je9BO87g6iHewUQF+jv7m9p2V2LxxOLXr//KerMAyANt1kAmqxpvQt8zUxIgplRUl5K7K52Y07PyqQTUXSGV1tTW3IpA3O+SQfLdq2SQfI//x4dX+OcPrzZrpW0+uN3qL4j+6s3im7bD8Z3iXg+btX2En+ir9par625zobW56Yo5GDmR83lzCXWuZNUUuTuuL3z+hO6uePf3YZ2+TEk1JZ0Ybij1/q3YIZfSkEvLOdkh79yr3cC7G7L+VUx7nuuLiwE5xrvkLtFnDyu/dQMkVVv5F/2Bp7526mv7UWN4NUW2zJ1uf8HGp8pSQl8UL8gv3+yR716Rv33zy3cz9f3E1j5/CCXqmyFtM5p8NyDfvRqQ7wfk+1cD8urVwKUd/eFVMOhCGoI3kZNB0tbbONz3UuERfIpXbKXdkCByNo8yKDReUskJYJ5QU9dfW+4zKogVhnHCzB+1LyLubj6mUxhJqFLuHK+7ZPyXv/5W5sTanfA2P6rJZBh85iXxSTObr6g2BzV7UUttfApKI0if9eYvbjd5bi83pbG1GtyUiBamcK2lS8XpTz51KUhMehnmHb0crM+Vz8kHWkv3+edTdtqMnI0pOF4xcdJNk/qyltyCaSg+0eSTOSNtEsjPL9/HSRU/Pz69f3Zvv7muv3YT39V1N+o/9656dzX9+Q3yxn5a9/5JH45e23nVwFe+3ODswkn4bJ6h2T89reeSNbZKJl0ulk/QDGcADoKbErqWQvuF5Ku9l/9Gtifb5OzdGyw32+TQbXLoNjl0mxy6TQ7dJoduk0O3yaHb5NBtcug2OXSbHLpNDt0mh26TQzewbJNDt8mh2+TQbXLoNjl0mxy6TQ5tyW1y6DY5dJscuk0O7aFtcmiHbpNDt8mh2+TQbXLoNjl0mxy6TQ7dJoduk0O3yaHb5NBtcug2OXSbHLpNDt0mh26TQ7fJodvk0G1y6DY5dJscuk0O3SaHbpNDt8mh2+TQ//Hk0GcmHaeLMp+y2afJbfNHf5f80fX00c9OHv3fyB39/FTQT+WCdisN5DnN0Qa/3tv7N7I9K6o1Xqz9jOSQ2N67iskhYCKj+w+N7pMz4XM8arxJ4W5VkRrvKDthn/cqqOv78u9krv439OVagDWlVOyB5vvkwOJxj2neTzrXsqEjYUXfk69/357gguSOS/eJD1Sckmnep3XmkmrMAyH0I3MO7lmnujZcj7766vceG7zigeSMU4LjYlb7pAkncHz8grGhH0OXA4NdbVpoauOrvvm9p88ZXnYSwImmakmV78U+ORDEii4nx4FEZhleItlogK/BAO9UgO4tw237CjPok7t7gx4OM+kNFOjt1nPLNS6LH3cymdOJE9Kl3iccv7ftJ9n11UUySLi73tOR3o6QtoqTnf8k47eTKblNMLl4f3cXc3N4KbXZ/3bv2293oWa7y5e7Tcr0bUJub28FITun5DY5aOaOU/o+OaSgqCL/cTAcHk8m6fTt+fFlXGHoh2tnuqrpPlkfsZ43J398vE0WdHWb7JPbxPn02+Tpj8nToOvceGVKt5dtu9cBXQdZ5ZTVTCJ9K25Fm3FPXnWwCxS+wPeSz9bCwLOXFHKq9KvHNV14sRt93CbkzwQyNODU4Geyp6Y29vnVpn7eii9vRa2YMF+08r5A5i++/DLUwBtYwsTZUqCFCOyHWgqNiug6j3s0Q+bUZKXr+j/V8Ucvv492UHC0oHWl7LdsZN1SsLO/tMby6DUzdYr5ZdBXCW3Fq+e5vXjuVp8zma/2Ce5MXvjpzOarLx7Jgq4C5ZKnL5EbdfyPW+H1ggFXp5M1jTdMktMXXBZfIOuX/0hwSm74OQLMC1/bW2LubBMVJi4iHSQ1YOSXrOnWxTboSvwUtgpHc+OgJOvvvsBiktMl5bJ26YW+JWcsvqHHGk8xMsmf9nd3H7Gpp/1HfO/Ts9aaJP2mCYyDFEPf3SbBumb8PmIOLmp2YgZ7k4Z0v1aQPNPU6XQ6Jl07T4MEpYnb6/r7TLiJ97ZYhqElhq5nY2zE7dSjRjaqqqnvuJ+ecBhbj4sutfKddH73MZk5E33dxp9v3uFpg1tSXJK6K+3DRtfppwFWThWd40bwX20EW9FSXPX/Gfjj3/iBm73f2qD8S3uRvXAvsvf/Zi+y9+y3bD6d7R3kdwfq3oCZNaQPNHwW9ef/XM7e/5Gfy9n7l34uZ5Dgr7M8P4Zof5Eh2NYHELpFz7d86Wc7fj9xojWj+iv+d+3HPBpJcbLs1hyPHp8G3ks+Nq755wRqPMBcvkzaQUkGCXoy76p+Th4fcVJcK/70hLA7qfKb0dZbusBtkPjF0NkQnrzuR8ua17h12ePr0Su6bl/jIMtobX6V932wyOBanAwSXAxdxCpzrKPcxzL8u5+4IyOfy48/ZICYjymsD219m+iFcHMU/i5H662aB+xVm/0uVoGEj4+ew6/quMT4rrjwJ3l6//T09F83mGBg -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a report schedule'} +>     - - 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 index 34bb82018d8..3be71c9c492 100644 --- 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 @@ -1 +1,35 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"db_id":{},"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":{},"description":"string","extra_json":"string","label":"string","schema":"string","sql":"string","template_parameters":"string"}}},"description":"Model schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "catalog": { "maxLength": 256, "nullable": true, "type": "string" }, + "db_id": {}, + "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": {}, + "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 index 1265d30a9be..819650d57a2 100644 --- 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 @@ -1 +1,106 @@ -{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"db_id":{},"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":{},"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"}}} +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "id": { "type": "string" }, + "result": { + "properties": { + "catalog": { + "maxLength": 256, + "nullable": true, + "type": "string" + }, + "db_id": {}, + "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": {}, + "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 index faa2fb8b109..b18ceccfedb 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-a-saved-query -title: "Create a saved query" -description: "Create a saved query" -sidebar_label: "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/ivEYUATTImTYB0CFfmQBi2ari9Z7WwDosClpUushiIZknLiCfrvw5GyJL8EfcmArsA+mTrdHe957oWUKzB4W6J1z1U2h7iCVEmH0tGSay3ylLtcycEnqyTJbDrFgtNKG6XRuBytN+OOC3VNy4Lfv0F57aYQHzz9NQJZCsEnAiF2psQI3FwjxGCdyeU11BFkk3GeQVzREm1qck1bkqvPmuK9M3y8CO6z6oJPUHxTjB3unun+weGXmN6KLwrOYaEFdzjW3PACHRr7BXZ1K1GTT5g6iMDljtRhyGeY/V6imX9A6451vquVdYE2XmjS6SVu4fHhfHQafdo7acNuJ1iQ1pPcLilshNxBWwvgrcpQsMZt5Es3N5gFamoSWK2kDSV5sLf/iIL2DKwnyaAthfu//n/k+l8zWe4IykVXol3C/9OdshbBqcOC5dKicZgRwl/29h7RDgVay69xQ098hs3WEJ7zjDWHTcxO5YyLPGMdHKaNmuUZBbuOpmcbsDymtf8FLOeSl26qTP43ZjE7Lt0UpWv2Z+1Y2gCkb+iRHBx8byTaqJQeJwIZoXDzmP1ByQlo0BhlNkE5UaXImFSONR4aa9rq6fcutlPp0EgumEUzQxNQxOxYslLivcbUYRaETKVpaR5I10vq+ZaCCCympSGM8UUFn+4cxBeX9WUEjl9biC+Apg2BuIzgfidVGQ59bNbrCy5peqTnH970ZkDzaFVpUoo8LY1gO3+xs/fDEUtg6pyOBwOhUi6myrr4cO/wcMB1PpjtDyxNuPEtjbhBAixJEsnYziuWwHFTZZ7wmD1HbtCwn45PTl4Mh+PR+99evFs2OAmp2hnNNcZsNVudbsaeVAnc4DyBmCUw46LEBOonUEctwrO5myrZw9gKWpR5oZVxi562iUzk4vBmR63YD+wt2pd9HRVRsJkiz9DYo2qFkBB7Q0oC7GfGU6rgsVM3KOvGmoAfbQKbyO1EapNLt7UIepeUt7a3+zS85jM+9MXUo2JJ2CVdSUtstAzwO547doUunXr8X4++CiAKdFOVUfRUUKvMxAs1tlozhPjjomyqQM/Is/Mx6kz6VRM4Wq+coL0gdaKyecxeD9+/2w1NnV/Ntyp2g/Mew6zeJm0i+lkiAzkZd7wlZoX2RkkJ3BXqeotUt58BNebKyDLIHTLOPF/M8wURBI4gBn8/iEBzut3AJnIpaX6ihJYuDeV0Y2pgdfM39JplOEOhdIHSNbPJl0xwVGmjnEqVqOPBoCJXdVxRo9Rr3k5K61SxcBHBjJucRrhtxql3Q+sMr7i/wfgw6Uoiy4JmVfNIP35gLft/NRqdsdZPHQFFs+yvxbsW3DAMXXoneYFMGXZ6Rk4Iy7KTjVQ19l67rimPi8E7pCMjgPTjt4KJr9GXyhSc/L3+c7S4T1FjhbfQHhsedB2R8djglUE7/VYn5MUq+aH7fn7xQ3xWRZDLKxWysER6qdFYXLpBdyIq+aA32w+ZtK7g4bODe5YeaK6VT5qGQof3bqAFzyU589VfNX13AVzntOM+Iet6DyKgMg11eAFVNeEWz42oaxIHlfjismsFfzhHEEadb9cbnPuLSze0fOeIkkJau6FQXwaL4zRFP7Af1r3sjRGatBDBpPlLpVAZ2Rh+R98T/A5igAiUp8RXspeFY6MM15fgk0qMros93tpSbBaEqnnF5bwXYVUFjTCzaX4EKP6Eg/qyrut/AFlZMcg= -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a saved query'} +> - - 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 index fb3ba1b81e9..ef3fc223b47 100644 --- 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 @@ -1 +1,29 @@ -{"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}} +{ + "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 index 76da10551a7..4fdf241eefe 100644 --- 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 @@ -1 +1,88 @@ -{"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"}}} +{ + "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 index eddba5be2a7..0bb6aa510e5 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-a-tag -title: "Create a tag" -description: "Create a new Tag" -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a tag'} +> - - Create a new Tag - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.RequestSchema.json index b237893fd52..7bf890b3153 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.RequestSchema.json @@ -1 +1,21 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"json_data":{"type":"string"},"theme_name":{"type":"string"}},"required":["json_data","theme_name"],"type":"object","title":"ThemeRestApi.post"},"example":{"json_data":"string","theme_name":"string"}}},"description":"Theme schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "json_data": { "type": "string" }, + "theme_name": { "type": "string" } + }, + "required": ["json_data", "theme_name"], + "type": "object", + "title": "ThemeRestApi.post" + }, + "example": { "json_data": "string", "theme_name": "string" } + } + }, + "description": "Theme schema", + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.StatusCodes.json index 22bc1b75fd7..cf0c37a9643 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.StatusCodes.json @@ -1 +1,80 @@ -{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"json_data":{"type":"string"},"theme_name":{"type":"string"}},"required":["json_data","theme_name"],"type":"object","title":"ThemeRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"json_data":"string","theme_name":"string"}}}},"description":"Theme 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"},"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"}}} +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "id": { "type": "number" }, + "result": { + "properties": { + "json_data": { "type": "string" }, + "theme_name": { "type": "string" } + }, + "required": ["json_data", "theme_name"], + "type": "object", + "title": "ThemeRestApi.post" + } + }, + "type": "object" + }, + "example": { + "id": 1, + "result": { "json_data": "string", "theme_name": "string" } + } + } + }, + "description": "Theme 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" + }, + "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-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.api.mdx index 36397c751aa..b48b33fd9f1 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.api.mdx @@ -1,33 +1,32 @@ --- id: create-a-theme -title: "Create a theme" -description: "Create a theme" -sidebar_label: "Create a theme" +title: 'Create a theme' +description: 'Create a theme' +sidebar_label: 'Create a theme' hide_title: true hide_table_of_contents: true api: eJzNV21P5DYQ/ivWqNKBGlhArYR84sOCOB30dCB2aSsRxHmTgQQS22c7C9so/70aO5vNvlD1jkrXT+vYM+N5nnk89tZg8GuF1h2rdAa8hkRJh9LRUGhd5IlwuZKDR6skzdkkw1LQSBul0bgcLX3R+l0qnF9yM43AwTqTywdoInAZlngnRYkblpvI55AbTIHf9CIt+d1Gcz81ecTE0WruCpoYk9UVWjfU+a5W1tGW+CJKXeBKbvNNl1NapNJEkKJNTK4J9Tw2a1H3E3WmQp+51UraQMLB3v4bKMzTHjmyKidoIOxQFe5/z3izar1cAwK33wfzLUV5pSqJQeEwpZ1+2dt7A/MlWiseXmHqn1B1jnAsUtaeJM7O5FQUecq0MKJEh8YybdQ0TynZdTQ934DlLSr6D7BcS1G5TJn8L0w5G1YuQ+na/VknnA1A+o4eycHBj0aijUroc1IgIxRuxtnvVJyABo1RZhOUE1UVKZPKsTZC601b/fqjxXYmHRopCmbRTNEEFJwNJaskvmhMHKZhkqkkqcwr5fognCg6CiKwmFSGMPKbGh6fHfCb24a6gHiw1Cf8qbPUF152EpXiyKdmvXkh5ANwSK6vPkEEhZhgsfi0qjIJJZ5UpmA7f7LLi9GYxZA5p/lgUKhEFJmyjh/uHR4OhM4H0/2B7wWDGFgcx5KxnY8shmErL880Z8coDBr20/Dk5HQ0uhtf/Hb6ednhJNRoZzzTyNlqmRa2KXtXx/CEsxg4i2EqigpjaN5BE3XYLmcuU7KHrpvo8OWlVsbND7ONZSznFwQ76qZ9x9yifdm/JSEK1hmKFI09qleoCFm3dMTAfmYiIdHeOfWEsmm9CfLRJpix3I6lNrl0W/N0d8l4a3u7T8C5mIqR10+PhKXJRaGVtMRDh108i9yxe3RJ5pF/C+46pF+iy1RKeZN8VjnhczO2qhPC+mUulToQM/a8fIkWLn2lBHbW1RKs53ROVDrj7Hx08Xk3nOD8frZVsyec9bhlzTZZE8XvYxlooVuvo2SF8NZIFbhbqIctMt1+D3QKV/qTv/uYYJ4piCCwAxz8dRyBFi4DDsuEUol8ywiHtjJUwY2FgNUNP9EyS3GKhdIlStc2Hy+QEKjWRjmVqKLhg0FNoRpe04Fo1qKdVNapch4igqkwOfVo2/ZLH4bGKd4L/2LwaUIEKKuSmlH7ST++JS3H/zgeX7IuThMBZbMcr8O7ltwodFVao6cIU4adXVIQwrIcZCNVrb+3bhqq3byzjpLQQnnbX2uYeF1+UKYUFO/8jzHVyJsBb1ehuxc86CYi5zuD9wZt9r1BKIpV8mrx+j/9nhdzBLm8V4GUJQ4qjcZi/9HYmyIFBrvpfiDWulL4a7ONv6bvpfDd1enwxQ10IXJJYbwM61b6NyB0Tnvtz3OHCEgpQQo3UNcTYfHaFE1D018rNHT13S7U6C/ACEKH8SfmCWf+cbDoFV68RUXJrL0C6GgEj2GSoO+Qr9ve9s4wNTiIYNL+JytVSj5GPNNfEPEMHCAC5cnwYvJzoU9X4YkQYlKV6UnWY6xTQzsgVO2SkLNehnUdLEKrpCMcoPgrBZrbpmn+Bt1z4xA= -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create a theme'} +> - - Create a theme - + 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 index a21f8dd40a1..72e71f5b2c8 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index cb2e4093eef..2db38a2aea4 100644 --- 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 @@ -1 +1,51 @@ -{"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}} +{ + "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 index ff4829f957d..2d9702feee9 100644 --- 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 @@ -1 +1,112 @@ -{"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"}}} +{ + "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 index d3a675d64f6..67a3df8c5ec 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create an annotation layer (annotation-layer-pk-annotation)'} +> - - 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 index 232b0e6f057..35cdcd5dbbd 100644 --- 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 @@ -1 +1,30 @@ -{"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}} +{ + "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 index 27bcb1948a0..956704da722 100644 --- 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 @@ -1 +1,91 @@ -{"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"}}} +{ + "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 index 12d99754e2c..cb60f24e222 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create an annotation layer (annotation-layer)'} +> - - 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 index 0d971beca60..bbc126198cd 100644 --- 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 @@ -1 +1,17 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"LogRestApi.post"},"example":{"id":1}}},"description":"Model schema","required":true}} +{ + "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 index 63460d51ee7..ba156105e6d 100644 --- 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 @@ -1 +1,73 @@ -{"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"}}} +{ + "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 index 8bc0d755ffc..f0d2fe580b1 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-log -title: "Create log" -description: "Create log" -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create log'} +> - - Create log - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.RequestSchema.json index db3999ad724..5d214d91bf7 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.RequestSchema.json @@ -1 +1,55 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"required":["name"],"type":"object","title":"GroupPostSchema"},"example":{"description":"string","label":"string","name":"string","roles":[1],"users":[1]}}},"description":"Model schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "Group description", + "maxLength": 512, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "label": { + "description": "Group label", + "maxLength": 150, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "name": { + "description": "Group name", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "roles": { + "description": "Group roles", + "items": { "type": "integer" }, + "type": "array" + }, + "users": { + "description": "Group users", + "items": { "type": "integer" }, + "type": "array" + } + }, + "required": ["name"], + "type": "object", + "title": "GroupPostSchema" + }, + "example": { + "description": "string", + "label": "string", + "name": "string", + "roles": [1], + "users": [1] + } + } + }, + "description": "Model schema", + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.StatusCodes.json index ce598f08d73..f7f29f2cc50 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.StatusCodes.json @@ -1 +1,112 @@ -{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"required":["name"],"type":"object","title":"GroupPostSchema"}},"type":"object"},"example":{"result":{"description":"string","label":"string","name":"string","roles":[],"users":[]}}}},"description":"Group 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"},"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"}}} +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "description": { + "description": "Group description", + "maxLength": 512, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "label": { + "description": "Group label", + "maxLength": 150, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "name": { + "description": "Group name", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "roles": { + "description": "Group roles", + "items": { "type": "integer" }, + "type": "array" + }, + "users": { + "description": "Group users", + "items": { "type": "integer" }, + "type": "array" + } + }, + "required": ["name"], + "type": "object", + "title": "GroupPostSchema" + } + }, + "type": "object" + }, + "example": { + "result": { + "description": "string", + "label": "string", + "name": "string", + "roles": [], + "users": [] + } + } + } + }, + "description": "Group 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" + }, + "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-groups.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.api.mdx index 3d5152a6bde..fec531158cb 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.api.mdx @@ -1,33 +1,32 @@ --- id: create-security-groups -title: "Create security groups" -description: "Create security groups" -sidebar_label: "Create security groups" +title: 'Create security groups' +description: 'Create security groups' +sidebar_label: 'Create security groups' hide_title: true hide_table_of_contents: true api: eJztWFtv2zYU/ivEwYAmmBLbwQIUKvqQBOmarmuC2t0GREFKSye2GopUSMqJJui/D4eUZPmGoU2BvvQpJnku/L5z4VEq0PhQoLGnKikhrCBW0qK09JPnuUhjblMlB1+MkrRn4jlmnH7lWuWobYqGVgmaWKc5yW4s4Xetipz19wLI+NN7lDM7h/B4dBRAlsp2PQxAFkLwqUAIrS4wAFvmCCEYq1M5gzoAwacodnnyhys+RsfDr/YheYa7XLizVQ/DVQ+jLRa1Elvoakz6wwBSi5kTatRTaXGGmvSbHa41L2ldGNQ77fnDr7BHF8SHItWYQHjt4d90Qmr6BWMLAdjUEmney5Uyduxzog4An3iWiy2kNRR0cVtueJKX64ai69FNB+96dFPT5VZN/qkSFKzJx/7NKZoOismVNJ7vo+HoGcmt0RTC/kz6n0m/mfT1uuxqGSxT57kF0asHKoeNevD4Y43cYkK3+G04fEbOZ2gMn2GPwjai/4O4U4RTnrDmdQnZhVxwkSYs55pnaFEblmu1SBO67Caanq7H8pz6/Q5YPkle2LnS6b+YhOyksHOUtvHPugTaAqSv6JAcHf1oJLlWMS2nAhmhsGXI/qLgeDSotdLboJypQiRMKssaC402uTr+0cl2IS1qyQUzqBeoPYqQnUhWSHzKMbaY+E2m4rjQO8L1hlsuOgoCMBgXmjCG1xV8ebSu+qg/8BlVIoybc+bKz1DrIGAO9kUCIfiCvG3t3M68XABPB7FKcOygGGdecDkjjU8f3/caQ7M0qtAxAY0LLdjBP+zqcjxhEcytzcPBQKiYi7kyNnw5fPlywPN0sBgNWq8D73UQAYuiSDJ28JZFcNIkprtsyE6Ra9Tsl5Ozs/Px+HZy+cf5h1WFMx/dg0mZY8jWA7yUTdiLKoJ7LCMIWQQLLgqMoH4BddChvCrt3L2JLc5uo0OaZrnStm0DJpKRbB919rrbPsyVsXvkl309HYHXmyNPUJvX1Rop/v4NMRGwXxmPKfFvrbpHWTfaBP71NsCR3I9krlNp99qLH5Lw3v5+n4p3fMHHLgd7dKxsLoOvpCFGOhb4I08tu0Mbzx0H38ZA5YFkaOcqIQSUXOvshK0YW88dQv25TZ/KUzRxDH0Olir97PE8bWaQl26JnaqkDNm78eWHQ98P0rtyr2L3WPZYZvU+SRPZryLpCUq45R05a9Q3QkrgoVCzPRLdfwVU02vdzhUuaxljXeF6liAESjwIIOc0+cAuiil8riX5Ii80RXdrkGD9Cu/pmCW4QKHyDKVtmptLHm+oyrWyKlaiDgeDikzVYUVlU29YOyuMVVlrIoAF1ym9Aabpx86Mn1TuuBta3DUhAJRFRs2uWdIf1+lW7b+dTK5YZ6cOgG6zaq/Du3G5se/adEYDEFOaXVyREcKyamQrVY2+k65rimYbBzeoeZCuf1cwdZn6RumMk713f08oRk4MwuYUunfHga4DUr7VeKfRzL/VCFkxSn5cfnGff78PpmFvQBze1AGk8k5tGh4XOWqD/Zm2t0Vp6uUWI8++sRl3b3fjd2dZrH0MNcAtPtlBLngq3eiuXYL5irkGnqfkcwS9dzaAziKlmM+ha6iqKTf4SYu6pu2HAnXph+I2jd3LHIBvVq7U7rF0U8uy7bisF4Ub/9fHE6opr3ESx+ja7m7Zm14boF4JAUybf6BkKiEdzR8pOPwRQgAaCkjbf03Snm/+hZ9dvE1KD5oVe+x1adT8IFTt54ssezesKi/huy7Vvofi3imo6YPhP1evJ8Y= -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create security groups'} +> - - Create security groups - + 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 index 8df812ab7ce..872bb4fc5f9 100644 --- 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 @@ -1 +1,42 @@ -{"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}} +{ + "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 index 7d8ac1f014c..83baf3c872d 100644 --- 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 @@ -1 +1,57 @@ -{"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"}}} +{ + "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 index 9dd7b50447f..59cba4d3d83 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-security-login -title: "Create security login" -description: "Authenticate and get a JWT access and refresh token" -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create security login'} +> - - 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 index 704a9504fc3..5e053f42d50 100644 --- 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 @@ -1 +1,17 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"permission_id":{},"view_menu_id":{}},"type":"object","title":"PermissionViewMenuApi.post"},"example":{"permission_id":{},"view_menu_id":{}}}},"description":"Model schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { "permission_id": {}, "view_menu_id": {} }, + "type": "object", + "title": "PermissionViewMenuApi.post" + }, + "example": { "permission_id": {}, "view_menu_id": {} } + } + }, + "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 index 3e37c307a13..837367c190a 100644 --- 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 @@ -1 +1,76 @@ -{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"properties":{"permission_id":{},"view_menu_id":{}},"type":"object","title":"PermissionViewMenuApi.post"}},"type":"object"},"example":{"id":"string","result":{"permission_id":{},"view_menu_id":{}}}}},"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"}}} +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "id": { "type": "string" }, + "result": { + "properties": { "permission_id": {}, "view_menu_id": {} }, + "type": "object", + "title": "PermissionViewMenuApi.post" + } + }, + "type": "object" + }, + "example": { + "id": "string", + "result": { "permission_id": {}, "view_menu_id": {} } + } + } + }, + "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 index 026906d1e73..0129ff3f010 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-security-permissions-resources -title: "Create security permissions resources" -description: "Create security permissions resources" -sidebar_label: "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: eJzFV21v2zYQ/ivEYUATTImTYgMKFv2QBi2arm2C2u0GRIFLS5eYjUSyJOXEE/TfhyMlWX4p1i7F+skSdXe85+Fzx3MNFr9U6PxznS+B15Bp5VF5ehTGFDITXmo1+uy0ojWXzbEU9GSsNmi9RBfe0JbSOanVVObA6yaBhcS7aYmqaleaBPzSIHDQs8+YeUjAS1/QwkXv/VHi3VtU1YmRh0Y7D00CeC9KQ3bftg1tlKPLrDSUOnB4q3MsWJt6EhBLizlwbytsaMEZrVxE8vjo+AE8hBw6nM5bqW4g7lAV/v+kbcttnUiK3eW3lt43EbzF8JnHkknl0HrMaavfjo4ewGKJzokb3EHlv8DqHeG5yFkrbc7O1EIUMmdGWFGiR+uYsXohc0p2G83AN2J5iCJ+AJYPSlR+rq38G3POTio/R+Xb/Vmv5h1Aho4ByePHPxuJsTqj11mBjFD4JWcf6XAiGrRW211QTnVV5Expz9oIrTdt9fvPFtuZ8miVKJhDu0AbUXB2olil8N5g5jGPi0xnWWW/clwvhRdFT0ECDrPKEkZ+WcPnOw/88qq5SsCLGwf8Esbtd7ZqBI5pxd6j05XN0LE9agyMOoPbh6sECHdg5YzqP7MoPE67baar4ndT28WABO4PMp3jOAB3IZlCqBsK8OH9G0igEDMsVq/Rkd4rW7CDv9jF+XjCUph7b/hoVOhMFHPtPH9y9OTJSBg5WhyPuiRGgyQO+iRGKbA0TRVjB69YCietqgMUzp6jsGjZLyenpy/G4+nk/I8X79YdTqM0DiZLg5xtqmNlm7NHdQq3uEyBsxQWoqgwheYRNEkP+mLp51oNYPcLPXBZGm1910NcqlLV3THsWb8cOvUe7csezE4Sw8xR5Gjds3qDowin5SkF9isTGRXR1OtbVE3rTVw824U/VfupMlYqv9fhOCTjvf39ITOvxUKMg54H7KwtrqShlSOCelLEnZCeXaPP5oGSH0JIHXGV6Oc6J0CkxE2yeGfGNpVFJHzqxFVHxiaBsE/JymWorUjbtr6idcfzTOdLzl6Pz98dxlYjr5d7NbvF5YB01uyTNXH/NFWRr1x40XO1cRKtkS7wsNA3e2S6/xSoXWw00lD0rCOQDQhkw6KPpAGHME8kYISfA4dvPAA669ALY7+oLElh54nCZoJv6DPLcYGFNiUq33bVoLQYqDZWe53pouGjUU2hGl5TyTVb0U4r53XZhUhgIayky8e1F0EIQ885XoswBIU0IQFUVUldtn2lHwdbdL6aTC5YH6dJgLJZj9fj3UpuHK8L+qZEiUxbdnZBQQjLepCdVLX+wbpp6Ky7YxnTZRdBhoujhlnQ8UttS0HxXv85oTMKZsDbr9BfeAF0k5Dz1OK1RTf/r0EoitPq/ep/xovvG+gTkOpaRzrW0FcGrcPhRDxYIu1Fu8VxpNT5UoRJgLj+jkpY27UfEjze+5EphFQUPeiybovkEoSRlMIxDC7xBHaWCiRAqoqyuYS6ngmHH2zRNLT8pUJL9//VSrlhCkggdq9QXbe4DBPSqg8FoRcV5bk1ClEZRY+TLMPQlr9uezVoBNQ8IYFZ+0+x1Dn5WHFH/yDEHXAAmjDIOwgvrMXLoYpzUoxJJ0pz6YDMXjntA6FqPwm1HGRY19EitmEq9wgl3GPQXDVN8w8RXSvW -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create security permissions resources'} +> - - 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index f18ddde0790..d0ddc904d33 100644 --- 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 @@ -1 +1,47 @@ -{"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"}}} +{ + "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 index d44faf70403..f6503a7c49d 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create security refresh'} +> - - 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 index c7da9454640..b182247dce5 100644 --- 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 @@ -1 +1,18 @@ -{"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}} +{ + "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 index 639ddbf0e86..e23650cd654 100644 --- 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 @@ -1 +1,76 @@ -{"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"}}} +{ + "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 index f51712858bd..f885772ce84 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-security-resources -title: "Create security resources" -description: "Create security resources" -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create security resources'} +> - - 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 index 5c0c197a9fc..1d541341e82 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"role_id","required":true,"schema":{"type":"integer"}}]} +{ + "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 index b21ddd94de4..5933c227067 100644 --- 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 @@ -1 +1,24 @@ -{"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}} +{ + "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 index ecd27a73bc9..add969cf090 100644 --- 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 @@ -1 +1,93 @@ -{"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"}}} +{ + "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 index 6c138a6ecd1..9cce3b613c0 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create security roles by role_id permissions'} +> - - 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 index 131674ef874..c5f18b785b4 100644 --- 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 @@ -1 +1,18 @@ -{"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}} +{ + "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 index 4a4fc522433..6c0d3709a98 100644 --- 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 @@ -1 +1,74 @@ -{"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"}}} +{ + "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 index e741f439402..b1c0d2ade9c 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-security-roles -title: "Create security roles" -description: "Create security roles" -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create security roles'} +> - - Create security roles - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.RequestSchema.json index 493a46f2ae9..7c96ca5be79 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.RequestSchema.json @@ -1 +1,17 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.post"},"example":{"id":1}}},"description":"Model schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { "id": { "type": "integer" } }, + "type": "object", + "title": "UserRegistrationsRestAPI.post" + }, + "example": { "id": 1 } + } + }, + "description": "Model schema", + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.StatusCodes.json index 2c155d2b7c9..a3ebeadf1ac 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.StatusCodes.json @@ -1 +1,73 @@ -{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.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"}}} +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "id": { "type": "string" }, + "result": { + "properties": { "id": { "type": "integer" } }, + "type": "object", + "title": "UserRegistrationsRestAPI.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-security-user-registrations.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.api.mdx index 792e0fe8d18..fd95dd0b0e3 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.api.mdx @@ -1,33 +1,32 @@ --- id: create-security-user-registrations -title: "Create security user registrations" -description: "Create security user registrations" -sidebar_label: "Create security user registrations" +title: 'Create security user registrations' +description: 'Create security user registrations' +sidebar_label: 'Create security user registrations' hide_title: true hide_table_of_contents: true api: eJzFV21P4zgQ/ivW6KQFXaCA7iTkFR8KYrXl9hZEy91JpOq6ydAGEjtrO4VelP9+GjtJ0xd0q2NP+wWSycx4nsePZ9wSNH4t0NhzFS+BlxApaVFaehR5niaRsImSvUejJNlMNMdM0FOuVY7aJmjoLYnpr13mCBwSaXGGGqoqaExq+oiRhQBsYlMy3BnUtzhLjNVuBXOLxvZvBoe5MhaqAPBFZDm5+uTHFWWL0UQ6ySkAOPyuYkxZXVLgkCQaY+BWF1iRweRKGl/hydHx98JnrE7kDPwKRWr/fzq2IrcJaqrqFtUQt8XcwGLGEmlQW4wp2S9HR29gJ0NjxAx3UPQvhbeBcC5iVkuRs4FciDSJWS60yNCiNizXapHEVOw2mk6sx/KWnf4OWO6kKOxc6eRvjDnrF3aO0tbrs1alO4B0Ax2Sk5MfjSTXKqLXaYqMUNglZ3/Q5ng0qLXSu6BcqCKNmVSW1RnqaFrq1x8ttoG0qKVImUG9QO1RcNaXrJD4kmNkMfZGpqKo0K9s1wdhRdpSEIDBqNCEkd+X8Phsgd+Pq3EAVswM8PtXDzmMAyCEzjigsxxpFBYnTcJJYVBPdDcUAng5iFSMQ4fPuDVTIWcUfXf7CQJIxRTT1atRhY4IfVTolB38xW6uhyMWwtzanPd6qYpEOlfG8tOj09OeyJPe4rjXVNDbrqAXAgvDUDJ28JGF0K+V6z5ydo5Co2Y/9S8uLofDyej6t8vP6wEXfvsPRsscOdtUwMo3Zu/KEJ5wGQJnISxEWmAI1TuoghbxzdLOlexgbg0t6iTLlbZNnzChDGUzH9hZa3b9do/WZW+jJvA55ihi1Oas3CDIY6lJCoH9zEREp2Ri1RPKqo4mIs52gQ/lfihznUi714A4JOe9/f0uLVdiIYZOsB1q1owrUShpiJ2WEfEsEsse0EZzx8fb2Sg9qAztXMWEhgS4yRRv3NimpoiBL42sSk/XyLH1JViFdFXlOdtWlvduSJ6qeMnZ1fD686FvJMnDcq9kT7jsMM6qffIm4t+H0pMVCytaoja2oXZSKR6marZHrvvvgZrBRpt0B5017DFij20edM8YcHCXgQByYefA4Vuopy12Pc43iEKTAnZuJGyW9ok+sxgXmKo8Q2nrbukE5hOVuVZWRSqteK9XUqqKl3TMqq1sF4WxKmtSBLAQOqGhYuoG79LQc4wPwl1fXJkQAMoio+5Zv9I/A1tEfhyNblibpwqAqlnP1+LdKm7oxwB9kyJDpjQb3FASwrKeZCdVdbzzrira5WZPhjTEPEg3EEqYOgV/UDoTlO/qzxHtkXMDXn+FdpA50FVAwRONDxrN/L8moSxGydvVff9y/QZ5VAWQyAflAa/hK3LUBrsX1o6J1OX9FseeNGMz4WY4sfmtKl9bsp3tFl9sL09FIim1k11ZH4B7EHlC6x9DZ/YGsHNYkmK8JO6hLKfC4J1Oq4rMXwvUNLPHK1W6yR2A70nu5Dzh0t1qVt3FiTgtqMit6wsdER/RjyJ0nfZ133HnhFNLhACm9a+xTMUUo8Uz3evFM3AAuit4VLz0Nt/vC3+38Tlpt+ku2WGyVUX9QKjqT0IuOxWWpffwzZWOsofiRhNU46qq/gF7kO0v -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create security user registrations'} +> - - Create security user registrations - + 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 index a7ed2651126..14517634b45 100644 --- 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 @@ -1 +1,67 @@ -{"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"},"groups":{"description":"The user's roles","items":{"type":"integer"},"type":"array"},"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"},"type":"array"},"username":{"description":"The user's username","maxLength":250,"minLength":1,"type":"string"}},"required":["email","first_name","last_name","password","username"],"type":"object","title":"SupersetUserApi.post"},"example":{"active":true,"email":"string","first_name":"string","groups":[1],"last_name":"string","password":"string","roles":[1],"username":"string"}}},"description":"Model schema","required":true}} +{ + "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" + }, + "groups": { + "description": "The user's roles", + "items": { "type": "integer" }, + "type": "array" + }, + "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" }, + "type": "array" + }, + "username": { + "description": "The user's username", + "maxLength": 250, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "email", + "first_name", + "last_name", + "password", + "username" + ], + "type": "object", + "title": "SupersetUserApi.post" + }, + "example": { + "active": true, + "email": "string", + "first_name": "string", + "groups": [1], + "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 index b811881507e..aadac0d221f 100644 --- 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 @@ -1 +1,141 @@ -{"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"},"groups":{"description":"The user's roles","items":{"type":"integer"},"type":"array"},"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"},"type":"array"},"username":{"description":"The user's username","maxLength":250,"minLength":1,"type":"string"}},"required":["email","first_name","last_name","password","username"],"type":"object","title":"SupersetUserApi.post"}},"type":"object"},"example":{"result":{"active":true,"email":"string","first_name":"string","groups":[],"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"}}} +{ + "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" + }, + "groups": { + "description": "The user's roles", + "items": { "type": "integer" }, + "type": "array" + }, + "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" }, + "type": "array" + }, + "username": { + "description": "The user's username", + "maxLength": 250, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "email", + "first_name", + "last_name", + "password", + "username" + ], + "type": "object", + "title": "SupersetUserApi.post" + } + }, + "type": "object" + }, + "example": { + "result": { + "active": true, + "email": "string", + "first_name": "string", + "groups": [], + "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 index 301ff4213b0..32a0cb4541a 100644 --- 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 @@ -1,33 +1,32 @@ --- id: create-security-users -title: "Create security users" -description: "Create security users" -sidebar_label: "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/isHYkASTImdYAUKFcWQBi2armuD2tkGREFKS2ebiUSqJOVEE/TfhyMlWX7rtqRAv/RTLOrudM9zdw/JVEzjlwKNfaWSkoUVi5W0KC395HmeiphboeTg1ihJayaeY8bpV65VjtoKNM42tmKB9CtBE2uRkxcL2bmBwqAG//7Xc7tnQCoLHGZKJZCrVMQlWAUaM7VA4M48gNvCWMj4HYKwIGQTPmC2zJGFbKJUilyyOmCYcZFufng8Rxdqz4C36HyN1ULOyHUqtLE3kmdbEu/5OzNwZluCzLQqcvPVAFqlaFjAhMXMWTZBhLQ4Q01RmhWuNS/pOeX/JTOy2plYzo25Vzr5aoTWCKZKAy/sHKVtar4tpkfyjbGS579C7YwClvGH9yhnds7Ck2fDgGVCts/HGzlT0vilEBoTFl6xthd6pe+T3WOtl9d1F1VNbjG2xIywKS2Mihy1QXtpUJ/m4ihXxrqufOBZnmJ/NKwusGvXNr/VJlyutl11dXy90gxLi2V5l2tNeZzTktUlF3WwRvDvKsEUmqHuM0XJOupMrqTxNT8ZHj9BITSaIrU/lOOHcvxQjt3KUa87rGrJcoiepiqPEZVdmrIhKucWM4jnXM4wofx/GQ6foBsZGsNn2GuIXoG+xlXnyF7xBJpjTgjncsFTkUDONc/QojaQa7UQCSW7Cabn67E8RQO/AZZLSbOmtPgbkxBOV+YOun7dAqTv6JH88n2RfFAWpqqQSQg0rQ3JSHQbVegYIVHoNR8fhBuODVBdDIfo5OR71ybXKqbHSYpAdbFlCH9Qu/n6oNZKb8Nxpoo0cVCbCI03ferZ9x6fc2lp7FMwqBeoPYoQTiUUEh9yjKlobhFUHBd6RwO+4ZanHQUBMxgXmjCGVxW7vbckMTUJJp+R3LBR8x5IIQ1JKeFyqM9JoGKN3OJNG+amcGYBeziMVYIjB8S44CmXM3K4/PTeafYE0+Wj7zV6LnQKh3/BxcfRGCI2tzYPB4NUxTydK2PD58Pnzwc8F4PF8aD96MB9dBAxiKJIAhy+hYidNnPmUg3hFXKNGn46PTt7PRrdjD/+9vrDqsOZL+3huMwxhPXqLm0T2KsidodlxEKI2IKnBUas3mN10IG8KO3c7cAtzG6hAyqyXGnbDpyJZCTbcx687JbdhrRP34X/zUbg3ebIE9TmZbXGiU+/4SVi8DPwmJr+xqo7lHXjTdhfbsMbyYNI5lpIu9/mfUTG+wcHfSbe8QUfuf7rsbGyuCy9koYI6Ujg91xYmKKN546CRxFQeRwZ2rlKCAB11jo5YWsG651DoD+3zVN5hsaOoM/B0qXfO56mzf7x1i2vE5WUIbwbffxw5KVATMv9Cu6w7JEM9QFZE9cvIun5SbjlHTdrzDdGKsWjVM32yfTgBaNxXhM6N7TQEgbt0HqSWMjcMYgOInQoYzsIpto5LfLzXWgq7dYKsfUE3tNrSHCBqcozlLZRNdc5PlCVa2VVrNI6HAwqClWHFY1MvRHtrDBWZW2IgC24FiT+phFiF8afTqfcndxcmixgKIuMVK55pD9O41bjvx2PL6CLUweMslmN1+HdSG7k5Zre0aENlIbzC3e+V3otyFaqGn9nXddUy7YMI9psPEgn3BWbuD59o3TGKd67P8dUI2dGly73dnktcKDrgJxvNE41mvljg1AUo+Sn5X+xXn+rq/fwMafk4fZjcsCEnKrNe0p7C9hyMaB2Qm283eLYF87YjLv9vom/a55WvtJt/RYf7CBPuXD3X9ftVTNqV4zngj55zHpbs8dCAak3ffNdsaqacIOXOq1rWv5SoC79BaHtf7eXB8xrnJvROyzdOWepVm5c0sJd6NYPNDSM3uM0jtGJ9W7b6558kMSygE2a/2ZmKiEfze+pRPyehYzROYK8/X8laM1vGYU/7fiY1Fd0Xu6R1/Vf84NQtRdSWfYyrCpv4cWaRMNDcbsbq6/ruv4HAmdqUw== -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create security users'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 4de62cbbfd6..76c0e2f70eb 100644 --- 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 @@ -1 +1,68 @@ -{"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"}}} +{ + "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 index 2a61d55dcce..0beade0b728 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzFVm1v2zYQ/ivEYR8STImSoAMCFf2QBS2arGuC2d0GVIFLS2dLsURy5MmNJ+i/D0fKiuwaGNYO6CeJ1N2je557IVvI0WW2NFRqBQn8Ku3KCSpQkFwK6cRCrrUtCcVCW7+fNdaiItE4tBCBkVbWSGgdJB9bKBnESCogAiVr5NUKIrD4V1NazCEh22AELiuwlpC0QBvDVqUiXKKFrntga2e0cujY4OLsjB+ZVoSK+FUaU5WZ5JDjR8dxtyNAY7VBS2XwtuiaikY/0vNHzAi6LtrfiQCfZG0q3PHrOjbdVWnK2uQ55oL0oJBjhBdn598QbI3OySWOonVkS7X812gHR/igZEOFtuXfmCfiqqECFfX/F0MWDnAaOwYmL74vk/eaxEI3Kk/EtEAfOzrCXFh0urEZilyjE0qTwKfS0SFSA4ZndHHxvXNjrM54Oa9QcF5ok4jfZVXmIT9orbaHeFzrpso91R6h9+Zf/fRN/fE/0LpRhFbJSji0a7SBRSKulGgUPhnMOGl+U+jMj4+DBfhGkqwGCSJwmDWWOfJcefxMkHx84OFAcsmzhpvQwUMEzMZzvckhgcyiJJyRXM7mm5lZzZ7bM4Knk0znOPEcwryqpFqy14ff3kEElZxj9bwMZcbrxlbi5E9xfzeZihQKIpPEcaUzWRXaUXJ5dnkZS1PG6/OY5DI+j4e/ximINE2VECdvRQpXfY/5gBPxM0qLVvxwdX39ejKZTe9+ef0+BeiiIbL7DRVajWIbNoboytpoS9sGcalK1XaAilfD9qnRjo44EPHfKUTBr0CZo3Wv2j0iKSQihZ5MCuJHITOu0hnpFaqu9+ZSZNcVboLDWlYNptCl6jhVxpaKjraBn7Lx0fHxWIpbuZYTXzAjOXY2nxOmlWNFBhXkZ1mSWCBlhdfg6xRoA5EaqdA5M+CC2Fcn2ZqJ/Xwz60/blLdBoqlX6FP07HIdGvlkujEYdNrv5xSC9VbYuc43ibid3L0/Dc1bLjZHrVjhZqSy6I7ZmsV+maogUC5JDuLsSd8b6QpPK708YtPjl8ANGOjzya4d+SsAFZDAWLvWrLqRfJwaPxtC0zWWM3cwAbA/Fd7xZ5HjGittar54BCRfGAGoNVaTznTVJXHcMlSXtNwS3Rdo140jXW8hIlhLW/Iwdv1g9DD8nuNC+vPfhwkRoGpqnjr9kh9++uziv51O78WA00XA0eziDXy/CG4Sxid/46uT0Fbc3DMIc9kFOShV7++tO3+P2o7QCQ//QNIP0hbmvgrfaFtLxrv9Ywr9pYzbJ3yF4QDwpLuInWcWFxZd8bUgXQSlWuhAZyf6xqB1yLJQSXzGjLe4doLd+hy67h/KwLFv -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Create tag by pk favorites'} +> - - 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 index d8ec2c84d76..8d5688f2373 100644 --- 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 @@ -1,19 +1,19 @@ --- id: css-templates -title: "CSS Templates" -description: "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}` | +| 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 index 29d55aba159..4cbb63a66a4 100644 --- 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 @@ -1,14 +1,14 @@ --- id: current-user -title: "Current User" -description: "Current User" +title: 'Current User' +description: 'Current User' custom_edit_url: null --- Get information about the authenticated user. -| Method | Endpoint | Path | -|--------|----------|------| -| `GET` | [Get the user object](./get-the-user-object) | `/api/v1/me/` | -| `PUT` | [Update the current user](./update-the-current-user) | `/api/v1/me/` | -| `GET` | [Get the user roles](./get-the-user-roles) | `/api/v1/me/roles/` | +| Method | Endpoint | Path | +| ------ | ---------------------------------------------------- | ------------------- | +| `GET` | [Get the user object](./get-the-user-object) | `/api/v1/me/` | +| `PUT` | [Update the current user](./update-the-current-user) | `/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 index bdf49500926..7245e5eabc6 100644 --- 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 @@ -1,15 +1,15 @@ --- id: dashboard-filter-state -title: "Dashboard Filter State" -description: "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` | +| 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}` | +| `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 index 6b29a581400..ceab430973b 100644 --- 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 @@ -1,13 +1,13 @@ --- id: dashboard-permanent-link -title: "Dashboard Permanent Link" -description: "Dashboard Permanent Link" +title: 'Dashboard Permanent Link' +description: 'Dashboard Permanent Link' custom_edit_url: null --- 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}` | +| 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 index 3583da4f0fa..dc3f8aa1421 100644 --- 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 @@ -1,39 +1,39 @@ --- id: dashboards -title: "Dashboards" -description: "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 chart customizations configuration for a dashboard.](./update-chart-customizations-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/chart_customizations` | -| `PUT` | [Update colors configuration for a dashboard.](./update-colors-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/colors` | -| `GET` | [Export dashboard as example bundle](./export-dashboard-as-example-bundle) | `/api/v1/dashboard/{pk}/export_as_example/` | -| `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}` | +| 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 chart customizations configuration for a dashboard.](./update-chart-customizations-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/chart_customizations` | +| `PUT` | [Update colors configuration for a dashboard.](./update-colors-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/colors` | +| `GET` | [Export dashboard as example bundle](./export-dashboard-as-example-bundle) | `/api/v1/dashboard/{pk}/export_as_example/` | +| `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 index 5bcda1717e3..fb2dceaffa0 100644 --- 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 @@ -1,41 +1,41 @@ --- id: database -title: "Database" -description: "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}/` | -| `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/` | +| 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}/` | +| `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 index 7cedc6b3c1a..8eaf31db52e 100644 --- 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 @@ -1,30 +1,30 @@ --- id: datasets -title: "Datasets" -description: "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` | -| `GET` | [Get a dataset](./get-a-dataset) | `/api/v1/dataset/{id_or_uuid}` | -| `GET` | [Get charts and dashboards count associated to a dataset](./get-charts-and-dashboards-count-associated-to-a-dataset) | `/api/v1/dataset/{id_or_uuid}/related_objects` | -| `DELETE` | [Delete a dataset](./delete-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}` | -| `GET` | [Get dataset drill info](./get-dataset-drill-info) | `/api/v1/dataset/{pk}/drill_info/` | -| `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 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` | +| 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` | +| `GET` | [Get a dataset](./get-a-dataset) | `/api/v1/dataset/{id_or_uuid}` | +| `GET` | [Get charts and dashboards count associated to a dataset](./get-charts-and-dashboards-count-associated-to-a-dataset) | `/api/v1/dataset/{id_or_uuid}/related_objects` | +| `DELETE` | [Delete a dataset](./delete-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}` | +| `GET` | [Get dataset drill info](./get-dataset-drill-info) | `/api/v1/dataset/{pk}/drill_info/` | +| `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 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 index e42211cbbc3..4c7b8fe12e4 100644 --- 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 @@ -1,13 +1,13 @@ --- id: datasources -title: "Datasources" -description: "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/` | -| `POST` | [Validate a SQL expression against a datasource](./validate-a-sql-expression-against-a-datasource) | `/api/v1/datasource/{datasource_type}/{datasource_id}/validate_expression/` | +| 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/` | +| `POST` | [Validate a SQL expression against a datasource](./validate-a-sql-expression-against-a-datasource) | `/api/v1/datasource/{datasource_type}/{datasource_id}/validate_expression/` | 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 4688364905b..594cf2f3654 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 82cd06d403d..c8c878cb2f6 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-chart -title: "Delete a chart" -description: "Delete a chart" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a chart'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bc30330cbaf..7eecd1658e1 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index 41a20ca07a5..c09fa3a3579 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-css-template -title: "Delete a CSS template" -description: "Delete a CSS template" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a CSS template'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 641f0757a7b..486fe3611f4 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 64652a4c800..ec71a194028 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-dashboard -title: "Delete a dashboard" -description: "Delete a dashboard" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a dashboard'} +> - - 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 index 74d702d0d05..9e47ade133e 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index e0fd53d13ce..733979f67dc 100644 --- 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 @@ -1 +1,42 @@ -{"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"}}} +{ + "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 index b75851f1f18..99c754ad4c2 100644 --- 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 @@ -6,28 +6,27 @@ 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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index 6cee950ed81..1459b6cd561 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The value key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 6c4a32ce88d..5933047eb92 100644 --- 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 @@ -1 +1,85 @@ -{"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"}}} +{ + "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 index ebacbb523c3..5421e6466a1 100644 --- 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 @@ -6,28 +6,27 @@ 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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index a7c0ba507c6..3064d27d532 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 76963cb96e3..1b8d2dc25cf 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-database -title: "Delete a database" -description: "Delete a database" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a database'} +> - - 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 index 48b355eb663..6712d53b2bd 100644 --- 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 @@ -1 +1,18 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 2906336fe36..9acae8b42ed 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index f60f4611146..3f8c0943616 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-dataset-column -title: "Delete a dataset column" -description: "Delete a dataset column" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a dataset column'} +> - - 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 index 1b32f1d0630..f83e160fcd6 100644 --- 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 @@ -1 +1,18 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 237298dbe6e..3c96310b31e 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 8f99df07529..12bbd9d7c8f 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-dataset-metric -title: "Delete a dataset metric" -description: "Delete a dataset metric" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a dataset metric'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index e3987fc23f7..e279961074b 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index ca74144b9ae..ce501815fbb 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-dataset -title: "Delete a dataset" -description: "Delete a dataset" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a dataset'} +> - - 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 index 3bd4599a740..39c7736f06b 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The form_data key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index e52f3adc900..fd3c868cc35 100644 --- 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 @@ -1 +1,85 @@ -{"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"}}} +{ + "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 index 40dae9e6994..b0c7162b132 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-form-data -title: "Delete a form_data" -description: "Delete a form_data" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a form_data'} +> - - 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 index f57c10b0276..7912b6b10b1 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The report schedule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index d7efdcde69b..70292fe4011 100644 --- 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 @@ -1 +1,70 @@ -{"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"}}} +{ + "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 index 1defa7119a7..a4ec81e396b 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-report-schedule -title: "Delete a report schedule" -description: "Delete a report schedule" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a report schedule'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bc30330cbaf..7eecd1658e1 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index a8a2d1eba97..b77fb70ce9d 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-saved-query -title: "Delete a saved query" -description: "Delete a saved query" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a saved query'} +> - - Delete a saved query - + 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bc30330cbaf..7eecd1658e1 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index a7b878c777c..a82ed06b6eb 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-tag -title: "Delete a tag" -description: "Delete a tag" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a tag'} +> - - 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 index cff15ab98e6..6c88b273b7f 100644 --- 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 @@ -1 +1,22 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 4688364905b..594cf2f3654 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 9eecc2fbd24..7966b5144da 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-a-tagged-object -title: "Delete a tagged object" -description: "Delete a tagged object" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a tagged object'} +> - - Delete a tagged object - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.ParamsDetails.json index fd77b4c69a4..622893f11e4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.StatusCodes.json index 02e9d275535..69076da97bb 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.StatusCodes.json @@ -1 +1,82 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Theme 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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { "message": "string" } + } + }, + "description": "Theme 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-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.api.mdx index f5e6eb013ac..5cc8ef1c8dd 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.api.mdx @@ -1,33 +1,32 @@ --- id: delete-a-theme -title: "Delete a theme" -description: "Delete a theme" -sidebar_label: "Delete a theme" +title: 'Delete a theme' +description: 'Delete a theme' +sidebar_label: 'Delete a theme' hide_title: true hide_table_of_contents: true api: eJzFVu9P5DYQ/VesUaWCGli4XiXk032gHOjuiq7odukPEcSZZCCGxPbZkz1olP+9Gjub3YWt1PYLn5I4nvF7M8/P7sAprxok9AHkRQfagASnqIIMjGqQv+4hA49fW+2xBEm+xQxCUWGjQHZAj45naUN4ix76/pJnB2dNwMATXu3t8aOwhtAQvyrnal0o0tZM7oI1PLZM6Lx16Emn6AZDULe4slIgr80t9H22GLHXd1gQ9Bngg2pcjWuBy4A+gxJD4bXjpUHCrMIGRYk1EpYc/3pv/2WxnhvVUmW9/gtLKQ5bqtDQsL4Ym7CBympgYvLjyzI5sf5alyUaKf60rSit+Z5EpeYoHPpGh8CMyApVFBiCoEoH4THY1he4ieCYL7F7/bLsPlkSN7Y1pRSzCmNnMBCWIwVRWgzCWBL4oANtYjTmiIxevXpp5TlvuRXqukbBqqNHKX5TtS6T+tB76zfxOLJtXUaqQ4Yhmpf66aU3/wdD6I2qRUA/R59YSHFoRGvwwWHBTYuDwhZF6/9he50oUvVYggwCFq1njmyad98I5MUlOx+pWzbS5CwBLjN42ClsidMILXlsrcwtSCjOP59CBrW6xnr5OWwACUXra7Hzh3h3fHo8OxY5VEROTia1LVRd2UDyYO/gYKKcnsz3J8TrTfZzEHmeGyF23oscDgdHiMWW4mdUHr347vDo6Hg6vZr9+svxpxygz0ZIZ49UWbMCahwYYenGWU8LwYfc5Gbh9uLtOLybPHWLoYh/jT1L0ytUJfrwtnvCIAcpchhY5CB+GLzjiuw9mj4327lxXhvaWiDaDaSoDVfcge1Voh/VXE1je1fIrg0u+2BNYL4jR/VNaRI3SEUV+f0ndl2i2CBVtmQ6qb1PucvFRPG0jVyEL4tOdqkAs8j/S4ro+cHFeJMbxm5r3K3t7dOabL8B1uu6yt/FrgklImjIIOEECamfkKW7gYR1dp2777lmcYslkbeeS7qxMvB02VP+LUqcY21dg4aGzRo7lhJ1zluyha17OZl0nKqXHSuxf5btqA1km0WKDObKa/a0MPhLTMPvJd6otqYBJmSApm148w6f/IhbeD3/+9nsTIx5+gwYzXq+ke8zcNPkQvyPr1fCevHhjJMwl/UkG0s1xMfZfbxrLZxoWiTLkYMfdXAdVXJifaM438ffZzBc3FjX6S+MPhpJ9xkHX3m88Riq/5ukz0CbG5vorKFvHfqAXBbSxFa9OsTaSfPm+6kkgRoVD4jhKvpMn2vpx0OC8IEmrlY63hWigLpBuBegnOa19hnDkEW6e25z6uMFdN21Cnju677n4a8tevb5y6WUosJLHY/KEuSNqgM+AzOeebD1ebi4bYtlqdZBDoPKPEbF1i1/QQb3+Jiu4P0lKy26Q1w9/TgsCox2tQh5drqyRMZdnMwGMuC74krBxjYOL7zARkRdl2Ykx+lHgNGBGWPf/w1ytTvf -sidebar_class_name: "delete api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete a theme'} +> - - Delete a theme - + 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bc30330cbaf..7eecd1658e1 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index d13f4b88eec..0f26eb07a89 100644 --- 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 @@ -1,33 +1,32 @@ --- id: delete-an-rls -title: "Delete an RLS" -description: "Delete an RLS" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete an RLS'} +> - - 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 index 32e33f67aca..fe23a883303 100644 --- 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 @@ -1 +1,18 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bc30330cbaf..7eecd1658e1 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index 740afa5eb76..0435e7abf14 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Delete annotation layer (annotation-layer-pk-annotation-annotation-id)' + } +> - - 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 index a21f8dd40a1..72e71f5b2c8 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bc30330cbaf..7eecd1658e1 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index 5701ba0f39e..c82490c69f2 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete annotation layer (annotation-layer-pk)'} +> - - 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 index 992981fc7d3..cb7a672fedd 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index d3cf7057895..cceb1a5aa4e 100644 --- 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 @@ -1 +1,68 @@ -{"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"}}} +{ + "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 index e64590aa33e..609f26f73c4 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete multiple annotation layers in a bulk operation'} +> - - Delete multiple annotation layers in a bulk operation - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.ParamsDetails.json index fd77b4c69a4..622893f11e4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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-groups-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.StatusCodes.json index bc30330cbaf..7eecd1658e1 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.StatusCodes.json @@ -1 +1,56 @@ -{"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"}}} +{ + "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-groups-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.api.mdx index 6a42ff05b48..d7c3af8674d 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.api.mdx @@ -1,33 +1,32 @@ --- id: delete-security-groups-by-pk -title: "Delete security groups by pk" -description: "Delete security groups by pk" -sidebar_label: "Delete security groups by pk" +title: 'Delete security groups by pk' +description: 'Delete security groups by pk' +sidebar_label: 'Delete security groups by pk' hide_title: true hide_table_of_contents: true api: eJzFVt9v2zYQ/leIwx4STImToAMCFX3I0nRNF3RB7XQDosClpbOlhCJZknLjCfzfiyMl2U48DMhLniT+uOP33X13ZAuaG16jQ2MhvW2hkpCC5q6EBCSvkUYPkIDB701lsIDUmQYTsHmJNYe0BbfStKuSDhdowPs72m21khYtbTg5OqJPrqRD6eiXay2qnLtKydG9VZLm1g61URqNq6J1jdbyBW6cZJ2p5AK8T/oZNbvH3IFPAB95rQVuGa4NfAIF2txUmo6GFC4d1qxAgQ4LMn9z9OZ1oX5Wjs1VI4uUTUpkFHW0Dgtm0KrG5MgKhZZJ5Rg+VtbtIjX4CIxOTl6X0Y3URuU0nAlkKF3lVin7ykVVBAwMjVFmF49z1YgiUO08dNZ01G+vralL6dBILphFs0QTWaTsTLJG4qPGnJIWJpnK88ZQ6ezg+IE7LoYQJGAxbwxxpFq8/+Egvb2jgnJ8QfUJ426d/WFUoy3cJUDEAu3LAlKIYp72fqaLsG86W01DGT8e5KrAcSAUC15wuYAU8psvV5CA4DMU62HUHI0bI9jBP+z9xdXF5IJlUDqn09FIqJyLUlmXnh6dno64rkbL41F/+iiePjrOgGVZJhk7+MgyOGtcqUz1b0Cdst+RGzTsl7Pz84vxeDr568+LzxmATwZw1ytXKrkBb5gYAFa1Vsb1BWMzmcm+CbF3w/RhDM8eQWEvYJFEwxJ5gca+a59wySBlGXR8MmC/Mp6TcKdOPaD0mdzPpDaVdHs9tkPruGvslLKyv0n5E1/ycRDKBu2tyXVulLTEfGDLf/DKsTm6vAxMX8izjWRrdKUqiFhM/tMopP1G9jS1FI5vfXbbGIpJiMS3aOHpQ2F5m0lioQQeCrV4Gp39t0A1sF0570MmWQ+eRfBstmJB6BH1UBCQxEsthf9i3eoHT1EN5RxLozEU9J2xg6dwrmiZFbhEoXSN0nWNIeQ0Omq1UU7lSvh0NGrJlU9bUq1/5u28sU7VvYsEltxU1D9t18uCG/ovcM4b4TqYkADKpqZG0Q3pE7rEtv+Pk8k1G/z4BAjNtr+B7zNw49jxaI1eCEwZdnlNTojLtpOdoersw24fngt9LsbUryPJ0PtamAX1fFCm5uTv098T6N4epPy4CkPPDqR9QsZTg3ODtnypE59AJecq0tlC32g0FiksrnJ0LWxOkXbivuVxDIl1NQ+XUfea+h/dbh02XE8OH91IC15Jchrk1HaCvgWuKzr5GDaujwSiX0gg1Q8kgJjhW2jbGbd4Y4T3NP29QUO3zd1aZEH7RRUu7ALSORcWnwEbbl7Y+9I9DffZOojbgLtJLldBy6KhESTwgKv4vvR3pMHQT8LpceEszzG0ut7k2R1P4hkqPbYnSIA3rtwI3pDg7ocO2ImobeOO2KP8ADB0b8Lo/U+D4Nne -sidebar_class_name: "delete api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete security groups by pk'} +> - - Delete security groups by pk - + 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bc30330cbaf..7eecd1658e1 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index fdb7640658f..06957e6e659 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete security permissions resources by pk'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bc30330cbaf..7eecd1658e1 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index 47df04fa134..5a96e6a2c54 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete security resources by pk'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bc30330cbaf..7eecd1658e1 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index e4dc1250c00..7e4f0e5336d 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete security roles by pk'} +> - - Delete security roles by pk - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.ParamsDetails.json index fd77b4c69a4..622893f11e4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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-user-registrations-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.StatusCodes.json index bc30330cbaf..7eecd1658e1 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.StatusCodes.json @@ -1 +1,56 @@ -{"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"}}} +{ + "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-user-registrations-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.api.mdx index 6de8db61888..0ae20bb0c8b 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.api.mdx @@ -1,33 +1,32 @@ --- id: delete-security-user-registrations-by-pk -title: "Delete security user registrations by pk" -description: "Delete security user registrations by pk" -sidebar_label: "Delete security user registrations by pk" +title: 'Delete security user registrations by pk' +description: 'Delete security user registrations by pk' +sidebar_label: 'Delete security user registrations by pk' hide_title: true hide_table_of_contents: true api: eJzFVl1v2zYU/SvExR4STImToAMCFX3I0hRNV3RB7GwDosClpWtLiUSq5JUbT+B/Hy4pyXbsh30BeZJ4SV6ec+4H2UItjayQ0FiI71soFMRQS8ohAiUr5NETRGDwW1MYzCAm02AENs2xkhC3QKuaVxWKcIEGnHvg1bbWyqLlBWcnJ/xJtSJUxL+yrssilVRoNXq0WrFt7bA2ukZDRdhdobVygRsnWTKFWoBzUW/Rs0dMCVwE+CyrusStjesNLoIMbWqKmo+GGK4JK5FhiYQZb39z8uZ1oX7RJOa6UVksJjkKVh0tYSYMWt2YFEWm0QqlSeBzYWkfqcGHZ3R29rqM7lRtdMrDWYkCFRW0isVvsiwyj0GgMdrs43GpmzLzVDsP3W4+6qfXzqlrRWiULIVFs0QTWMTiQolG4XONKQfNG4VO08Zw6ezh+EGSLAcJIrCYNoY5ci0+fieI7x+4oEguuD7hzqK5xUVhyXiq9hYtXdxcw0MEzNAbrzOIIWT1tHc4bSyaqdncOp2tpr62n49SneHYswxdoJRqATGkd7efIYJSzrBcD0Mi8rgxpTj6Q7y/+nw1uRIJ5ER1PBqVOpVlri3F5yfn5yNZF6Pl6ahHMtpFMjpNQCRJooQ4+igSuGgo16b408/G4meUBo344eLy8mo8nk5+/eXqSwLgogHozYpyrTagDoYBbFHV2lBfUTZRieq7lHg3mI+DbAcMRfxHRlFwkqPM0Nh37QteCcQigY5bAuJHIVPO8inpJ1QuUYeJqk2h6KDHeWxJUmOnHK3DTfqf5FKOfVZtSLBlXMdMK8sqDMzld1mQmCOluWf9P3BuA/EKKdcZkwwJ8lKRuF8oXoacpfnaR70Nsky8Kl/DDscfluhtopiRLvG41IuXSh2+BS6e7ZJ77yMseiKCiYgtImK2Er4wAoOhmCAKN2MMf0eNtn5yrLzvD6GsGsOB2asvvIT5madFhkssdV2hoq7T+LgHR21tNOlUly4ejVp25eKWs9zteLtsLOmqdxHBUpqCG7LtmqN3w/8ZzmVTUgcTIkDVVNx5uiF/LOyI+nEyuRGDHxcBo9n2N/DdATcOLZTn+MkhtBHXN+yEuWw72StVt9+vdv790cdlzBdAIOmbaQszn1UftKkk+/v0+wS6xwxXR5iF4RLwpF3Em6cG5wZt/m+duAgKNdeBzhb6pkZjkWWhgvie2TRx7oR1y9MgiaVK+tute579g3zeOni4+wifaVSXslB8gE+ttkv0e5B1wShOYeNuimA33SGCuH7ixAiRv4e2nUmLd6Z0js3fGjR8rT2sk8/XRFb4l0EG8VyWFndADlc8HNx2b9BDsRZ3G3xnlGrlc7xseAQRPOEqPGTdA+em7z/+9DBxkabo22S/ZecxwUk1dIPQziAC2VC+IeQQ+O6HD9iLqG3DitDT3ADQd37G6Nxf5DIFXA== -sidebar_class_name: "delete api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete security user registrations by pk'} +> - - Delete security user registrations 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bc30330cbaf..7eecd1658e1 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index 4efa2ca10ca..2c27a26b249 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete security users by pk'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 7da8a07ea37..8d417a219bf 100644 --- 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 @@ -1 +1,68 @@ -{"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"}}} +{ + "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 index 487b9923a5b..8de897a8637 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Delete tag by pk favorites'} +> - - 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 index 724c921ddcf..1617b32d65c 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index b047f269e63..8c101a53b4f 100644 --- 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 @@ -1 +1,52 @@ -{"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"}}} +{ + "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 index 8376ef27475..67163da96a5 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Download database(s) and associated dataset(s) as a zip file'} +> - - 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 index 724c921ddcf..1617b32d65c 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index b3350aaba3d..de5298ed5b3 100644 --- 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 @@ -1 +1,64 @@ -{"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"}}} +{ + "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 index 0cf4bcf268d..9bae3aeafe1 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Download multiple charts as YAML files'} +> - - 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 index 724c921ddcf..1617b32d65c 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 596ebe80964..7080549058f 100644 --- 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 @@ -1 +1,72 @@ -{"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"}}} +{ + "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 index 37c7a663369..4b00331299f 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Download multiple dashboards as YAML files'} +> - - 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 index 724c921ddcf..1617b32d65c 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index df353b5058b..5fc90cb0195 100644 --- 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 @@ -1 +1,60 @@ -{"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"}}} +{ + "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 index d6e3a73d6ad..4146ca6a263 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Download multiple datasets as YAML files'} +> - - 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 index 724c921ddcf..1617b32d65c 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 8bbabecdb59..4eb4d6a3a10 100644 --- 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 @@ -1 +1,64 @@ -{"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"}}} +{ + "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 index 62ad674f178..fa95004bafb 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Download multiple saved queries as YAML files'} +> - - Download multiple saved queries as YAML files - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.ParamsDetails.json index 724c921ddcf..1617b32d65c 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.ParamsDetails.json @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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-themes-as-yaml-files.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.StatusCodes.json index 9db01363d19..99e8caa4af6 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.StatusCodes.json @@ -1 +1,76 @@ -{"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"Theme 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"}}} +{ + "responses": { + "200": { + "content": { + "application/zip": { + "schema": { "format": "binary", "type": "string" } + } + }, + "description": "Theme 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-themes-as-yaml-files.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.api.mdx index e805b098be8..2386e5da0b2 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.api.mdx @@ -1,33 +1,32 @@ --- id: download-multiple-themes-as-yaml-files -title: "Download multiple themes as YAML files" -description: "Download multiple themes as YAML files" -sidebar_label: "Download multiple themes as YAML files" +title: 'Download multiple themes as YAML files' +description: 'Download multiple themes as YAML files' +sidebar_label: 'Download multiple themes as YAML files' hide_title: true hide_table_of_contents: true api: eJzFVm1v2zYQ/ivEYR8STImToAMCFf3gZmmbLuuCxdkLoiClpbPFlCIZknLiCvrvw5GSYjvusPVLPkl8ubvnuTdeA4ZbXqFH6yC9biDXyqPykDbAjZEi515oNbpzWtGey0usOP0Jj5WjH780CCkI5XGOFtqk3+HW8iUk4IWXtJ6jv8VHo62/FYW77VS1bZuAUJDCfY2W7ite0fV7aG8SsOiMVg6DqaODA/p8A+NXYdYhzrStuIcUpkLxoLpD5rwVah5NF+hyKwxpgBQmJVbIIkqi8upfLT73irHaoPUi4q3QOT7HFS8NlgcsenqHebCFj7wyEtcE4S0vmMX7Gp1P2ZlacCkK9hQzZqxeiAKLbWRWZCOXw5flcqV47UttxVcsUjaufYnKd/YDUGG3E1kVjExevSyTT9qzma5VkbJJib2TkdztdG1zZIVGx5T2DB8Fuf85qUFHYHR09NKxMVbntJxKZBQXv0zZH5RuMT5orbbbeJzoWhaBaqehkyZTP710+Zwpj1ZxyRzaBdrIImVjxWqFjwZzClrYZDrPa/uNBHzHPZeDCxJwmNeWOFLLvHvwkF7fULfyfE5tNLYRBzcJPO7lusDLAC12WMnVHFLIr34/hwQkn6J8WsbsoXVtJdv7i70/nbAMSu9NOhpJnXNZaufT44Pj4xE3YrQ4HHkyNoo9a5QBy7JMMbb3gWUw7som+Dtlb5FbtOyH8cnJ6eXl7eS3X04/ZQBtMqC6WPpSqxVcw8aATFRkqM95l6lM9U2avRm29+fodwgH+5/wkyhUIi/QujfNBokMUpZBRyQD9iPjOSXdrddfULWZ2s2UsUL5nR7UPqXZzu7uKs2PfMEvQ3xXqK5tPgVCK0dsB4b8gQvPZujzMhD8DnrNGse0X7PNiBHZz33Qmkh0Enh+jhItfYj060xFoAX3fAC54YLukpa4L/V8h67uvg6v7Hq2/6wflNS8YFUtvTASWSDhGHfs7/Gv52wmKJkTqNCXuohPOyRguC8hha3MyaWhBGMR1JY8vtVxsAnnnI5ZgQuU2lSofFfMIaBRUWOs9jrXsk1Ho4ZUtWlDdttn2k5q53XVq0hgwa2gnue6/hPU0H+BM15L38GEBFDVFRV3t6RPKPF1/R8mkws26GkTIDTr+ga+z8Bdxi5FZzQFMW3Z2QUpCfPImpKtrurk4/TSUmT7TnWZx5aUdv2qgWnIq3f9jPTxzwnFKFyjkSmcPo1MgXSbkPCtxZlFV36vkjDvzXSks4a+NmhdSKV+ZlzZotyJ9xaH0SXOVzw8IN3E+J/zds3s8Lh4fPQjI7lQpD4kVtPl9DVwIwjDIWEL7OjBCX5OgJIgRvkammbKHV5Z2ba0HWdayvgNm8OTCE/uWQfwBZdhCqYUlTWdh1Lt8zU8OQnEHhIsRIFxnmPoYL3U5ohMSobCfX9KAaPpasURQ9i6H1Lez/RquaK6aeKN2JOo1iKG0IuhvWnb9h/7akS1 -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Download multiple themes as YAML files'} +> - - Download multiple themes 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 index ce202cadb7b..5cf49a76179 100644 --- 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 @@ -1 +1,21 @@ -{"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}} +{ + "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 index 26236545f12..6156152efbd 100644 --- 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 @@ -1 +1,112 @@ -{"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"}}} +{ + "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 index 303a8c17557..e753634a2ca 100644 --- 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 @@ -1,33 +1,32 @@ --- id: duplicate-a-dataset -title: "Duplicate a dataset" -description: "Duplicate a dataset" -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Duplicate a dataset'} +> - - 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 index 26d2bd28645..bfbcca9a0f4 100644 --- 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 @@ -1,12 +1,12 @@ --- id: embedded-dashboard -title: "Embedded Dashboard" -description: "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}` | +| 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 index 5f22952aa91..e3e9d9db8e3 100644 --- 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 @@ -1 +1,47 @@ -{"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}} +{ + "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 index b243f006ab4..b8f985160d1 100644 --- 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 @@ -1 +1,68 @@ -{"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"}}} +{ + "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 index 8c1cf7ed40b..0ba041b887b 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Estimate the SQL query execution cost'} +> - - 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 index 930e2817b41..71f26ab9440 100644 --- 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 @@ -1 +1,48 @@ -{"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"},"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,"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}} +{ + "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" }, + "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, + "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 index 064893f34db..6f390b585e7 100644 --- 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 @@ -1 +1,204 @@ -{"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"}}} +{ + "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 index 1cd9de1174f..335bc720397 100644 --- 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 @@ -1,33 +1,32 @@ --- id: execute-a-sql-query -title: "Execute a SQL query" -description: "Execute a SQL query" -sidebar_label: "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/isEMaAJptRJ1wGFij6kWYqmzdq0drENceDS0sVmQ5EKeXLiGfrvw5GSLDty67YYigJ5ikLeHXnf3X080gtu4boAh89NOufxgidGI2ikT5HnSiYCpdG9T85oGnPJFDJBX7k1OViU4LyaQKHMhD51oZQYK+Ax2gIijvMceMwdWqknvIx4oiRoHMl0O2kUbpQBTs128qlAMRYOKvvVvNQIE7AkALe50OmI5D5jcGyMAqFJ4boAOz+VmcTPyLcWsIU+dHOdbGd9iegXXXOgIMGRcKNk2727a9VCoWXqWo0glWjstnFAMd5ODrJcCYQzYUXmtlPJ8hGSxEiLDLZQIZDhupAWUh6fr4Q8uHzRqJjxJ0iQRxwlkj1+fAtJQdubKyPSfkDfp4XIcgUryVwvuJKzrcF2ai6HVzLwYC3hgj/tlDpoZ0yYrnNiaXMt9JUYBbclsxrT5YQPXevftQi1ZtYCsQScCgtcYmVOdMBj3n93yrwXTOiU5cFUOyy0RR8nlxvtAks82t//Ho4xqsi0/5QIIbdWo1w2YRfWinlNB1+nEcIF6eib1vOYdOx9KvQE0lHw8NLYTCCPaXewhzIDvoH5Wmu2qjoddxZ1Oj7ZxHk6/QMxa03qIhtXc9Ya+yc4Jybb1B4B5Cso7W/gFrhFKzrBWqHkpYKqufXuxv2U1JMXIkFjO7VzayYWnOs24OOxCRYLrlDoXsO807I1NxusLlO0g6TtDOymFT/Dx8e+dE+6IXIoLG4MoUOB0KlXsXYnS/e3P3lIfBAktpG2IrmSevLBqq3kCwfdoaWJbiTLzQT/jiL+3ke2SYCNzUDg1W8tdsK9cB1b/9L2wiEkjX5f0WP3OVTv6XxRXtRUFr7vklQYr+lnxfGDLj+DfO3BZ5jeb5hBvWNmG2gf7T+6p/N7Or+n83s6v6fzn5vOo6qZdyiVYrbQuorZ4+9q2bMlD30J0lWsGkX+XKSseqOI2YmeCSWr+wYgWMdya2YyhbTL15Zu8OXgx/ryQYsCp8bKfyGN2WGBU9BYrc+aq1OHI23F4MlvP9aTF8aOZZqCjtk/pmCp0Q+QTcUMWA42k86RR2iYSBJwjuFUOso0U9gEuhxs7AXvHv9Y794YZJem0GnMBlOoUwjSxgWWGnBMG2RwKym57nrU2KBVfv/RVXSiEawWioXzjPkuIWaHmhUabnNPJmGQmSQp7IY8fEEvI0HOL+4gKazEOfEP/3SDPD6/IB5CMSFO8q8Ep2JM7zG3e4lJoe/35vmKK6HpjSX58P6UR1yJMajlv1WqxDwprGJ7f7Ozt/0BG/IpYh73esokQk2Nw/jJ/pMnPZHL3uyg567paOpVHU1vyNlwONSM7b1kQ35YVZDHPGbPQViw7JfDo6Pjfn80ePv6+M2qwlGI1t5gnkPM1gO2lE3Zg8WQX8F8yGM25DOhChjy8gEvo8bJszlOjW652Qw0jsosNxbrZHNDPdT14wl71gw/zI3DHVqXfTUaUVCbgkjBumeLNUzC9itchpz9WlXvCM0V6LLSJt+fdfk71LtDnVupcafe90MS3tndbSPxSsxE36dUC42VwWXojXYESAOCuBES2SVgMvUQfBMAi+BHeLcjByiz1sGJazG2njnk9Mc6eRYBoYEH6GO0VGnnToDpbv4E6RrXsUnnMXvVf/vmYahueTnfWbArmLdAZuUuSRPWT4c64EN9RIPNGvKVkFHwUJnJDonuPuW++1ip6+pRlAnWvOvxiDdPm5RzPOK5wCmP+QZ4ed0sh+ouqFvsjg9fX/6UplkKM1Amz0BjRVM+b4KhRW4NmsSoMu71FmSqjBdUMOUda0eFQ5PVJiI+E1ZSw+oqZvVm6DuFS0FtZdgmp3tVkRFtVf/SH8fvgPVyMDhjjZ0y4rSbVXuNv3c21w/8S3P0xsqMZSdn/t5j7JqRTqgqfS9dlr7nqzjY95zBSc/ECz72Wfqivp2++mvAq7uOv4D62eVN1TtdRqQ8snBpwU2/1QhZcdQNNz8tHf8/r+v7X3xd3/8JXtcjLvWlCcFfiXWRg3XQvm60hqjSgtzsICSQw0z4RqKy313VK2s0HQXCLfZyJaTvwIpw1QsFf85FLmnBgwCDEmPePBvwiFOFhBI454sFxeaDVWXJl/eX84tlFfoWIeKBZz1TXNF9fYUxfdGqwl/O1vskooSgcZgk4A+MzbIXLRIjmucRH1c/dGYmJR0rbuhnC3HDY84jbjwuvoj8WDi2itBEBZuU3dSNt99y6iqoPsir+nKp560dLhZBIhwYRF3BFX/C8vKiLMv/AG8pOoE= -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Execute a SQL query'} +> - - 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 index 252da1d576d..85863ed322c 100644 --- 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 @@ -1,15 +1,15 @@ --- id: explore-form-data -title: "Explore Form Data" -description: "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}` | +| 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 index 5f9e6245ac1..1c2f71995a5 100644 --- 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 @@ -1,13 +1,13 @@ --- id: explore-permanent-link -title: "Explore Permanent Link" -description: "Explore Permanent Link" +title: 'Explore Permanent Link' +description: 'Explore Permanent Link' custom_edit_url: null --- 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}` | +| 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 index 0f4413ebcfb..03072d732d2 100644 --- 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 @@ -1,12 +1,12 @@ --- id: explore -title: "Explore" -description: "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/` | +| 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index b61948eba2f..8a098925f7e 100644 --- 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 @@ -1 +1,52 @@ -{"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"}}} +{ + "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 index 57472b9edb8..3799f576fac 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Export all assets'} +> - - 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-dashboard-as-example-bundle.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.ParamsDetails.json index 2bdb6e98289..5fe078ab88f 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.ParamsDetails.json @@ -1 +1,23 @@ -{"parameters":[{"description":"The dashboard id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Whether to include Parquet data files","in":"query","name":"export_data","schema":{"default":true,"type":"boolean"}},{"description":"Limit data export to this many rows per dataset","in":"query","name":"sample_rows","schema":{"type":"integer"}}]} +{ + "parameters": [ + { + "description": "The dashboard id", + "in": "path", + "name": "pk", + "required": true, + "schema": { "type": "integer" } + }, + { + "description": "Whether to include Parquet data files", + "in": "query", + "name": "export_data", + "schema": { "default": true, "type": "boolean" } + }, + { + "description": "Limit data export to this many rows per dataset", + "in": "query", + "name": "sample_rows", + "schema": { "type": "integer" } + } + ] +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.StatusCodes.json index acd03970118..b1a3f994ec7 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.StatusCodes.json @@ -1 +1,66 @@ -{"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"Example bundle ZIP file"},"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"}}} +{ + "responses": { + "200": { + "content": { + "application/zip": { + "schema": { "format": "binary", "type": "string" } + } + }, + "description": "Example bundle ZIP file" + }, + "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-dashboard-as-example-bundle.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.api.mdx index 6e99b758d85..c54d606f97a 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.api.mdx @@ -1,33 +1,32 @@ --- id: export-dashboard-as-example-bundle -title: "Export dashboard as example bundle" -description: "Exports a dashboard with its charts and datasets in the example format used by the Superset example loading system. The export includes Parquet data files and YAML configuration files." -sidebar_label: "Export dashboard as example bundle" +title: 'Export dashboard as example bundle' +description: 'Exports a dashboard with its charts and datasets in the example format used by the Superset example loading system. The export includes Parquet data files and YAML configuration files.' +sidebar_label: 'Export dashboard as example bundle' hide_title: true hide_table_of_contents: true api: eJzVV21v2zYQ/iuHw4AlmBonWwcUKvoh69LXrAtqF10XBSktnS02EqmSlBNX0H8fjpTkl7hBuw0r9skWX+6e53h3fNhgRjY1snJSK4zx5KbSxlkQkAmbT7UwGVxLl4N0FtJc+DmVQSacsOQsSAUuJ6AbUVYFwUybUjioLWUwXfqpcV2RseSGNYUWmVRzsEvrqDyAid/PfkGqtKgzsnAmzMeanPcDM1lQcPvu+LdTSLWayXltBGMOkwcYYSWMKMmRsRifN1u82MeKkcwwQsnjlXA5RqhESfx1hREa+lhLQxnGztQUoU1zKgXGDbplxaukcjQng20bbbt5m5PLyYDTPZUdTHrfH2syy5XzEIJLXofrXjOaibpwPZwOxFTrgoTaBeJUlrLz14XVaXC5tFAKtQSjry1UZPoz/Awc6w/rklfjnUG44JDZSitLlhf8eHjIP6lWjpTjv6KqCpn64xp9khUPreyFjGFGUgkPoPNgnZFqjm3bRreSNCTStFZZQfDn8zMfWGwjvH94dIfzD5b3r3uvjK7IOBmgl2StmNMazQHEAEtPP1Dq2FeXzxsb8Y0Stcu1kZ8oi+G4djkp1/mHIbV2kFrfGJj89G2ZPNFmKrOMVAzvdA2ZVt87yMWCOHlKaS0zchpEmpK1IcEMWV2blHYRHOwFdve/LbtX2sFM1yqLff/hkyHrKBsoQKbJgtLct6R1uxgNNtjLz3em/X/A6LlyZJQowJJZkAEyRpsYjhXUim4qSpmdHwSdprX5TB4+EU4UYZ13bimtjXRL31Q/XDuMzy+45p2Yc6PFX/uuavEiwpt7qc5o7OGFPlwINccY0zevTzHCQkypWH122RJjWpsC7v0BT08mkGDuXBWPRoVORZFr6+IHhw8ejEQlR4uj0dDGR0ejrmcKe9mFZJQgJEmiAO49gwSPu5LyhxDDLyQMGfju+PHjk/H4cvL7y5NXCSK30A7m2dLlWq0BHQYGqLL0PbXLGJuoRPX9Dx4NwwdzcnuMA/4pnyhYyUlkZOyjZotVgjEk2DFLEH7oCvLS6StSbaL2E1UZqdxej/KAk3Fvf3+d9wuxEGOfBWvcNwZXR6WVZfoDZXEtpIMZuTT3jP8Nvs0G6bj/hu0zZfbv+2NtAvOJJ/4+7Gj5h6PwMFEBub8Ye9RbMekW6YIOCj3f46X7D5HTvSSX6wxjnPsb0+uGGG9zaqqrdgctDqAvy1AUteH47gwTbhfkKU9DRgsqdFWScl2B++MLhprKaKdTXbTxaNSwqTZuGEJ7y9rj2jpd9iYiXAgjxbQIXag3syE7PEyMkFRdcsF3n/zjS37T/rPJ5AwGO22EjGbT3sD3Frhx6Fw8xyoEtIHnZ2yEuWwa2Rmqbr9f3Xpl0nevMffdQNL3sAanPmme9OrjxdtJL3O8vPKzKzHiSbcRb740NDNk879rpGW9NdOBzgb6TijzBum4va8Pce6EdYujEBLrSuEvlU6xBe2+JnOFHTR3kErbAVu7rv7Pyr8Lr6MbN6oKIb3C8JXRdIV6jqKSHMQjDkHPDyOMveS/Va8YIad2yN1zbJqpsPTGFG3Lw0Ep+0eGtFw8GcYzUVi6I7xf+jLYyeWKlrceCAtR1LzSt4Evx/H1j4M7EG2+EVaILlZ95SvDtPe6k8j7sOPJthNKNyjUch1DD7G6wvaC25C/STyaMHGcpuQvtn7L9itlo+s/PeHKZoW+JtGG+u7+sPGdaJomrAg3UzuA81c042vbvwA/ZGS5 -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Export dashboard as example bundle'} +> - - Exports a dashboard with its charts and datasets in the example format used by the Superset example loading system. The export includes Parquet data files and YAML configuration files. - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.RequestSchema.json index 014028969fb..b731e00653a 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.RequestSchema.json @@ -1 +1,28 @@ -{"title":"Body","body":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"client_id":{"description":"The SQL query result identifier","type":"string"},"expected_rows":{"description":"Optional expected row count for progress tracking","type":"integer"},"filename":{"description":"Optional filename for the export","type":"string"}},"type":"object"}}},"description":"Export parameters","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "client_id": { + "description": "The SQL query result identifier", + "type": "string" + }, + "expected_rows": { + "description": "Optional expected row count for progress tracking", + "type": "integer" + }, + "filename": { + "description": "Optional filename for the export", + "type": "string" + } + }, + "type": "object" + } + } + }, + "description": "Export parameters", + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.StatusCodes.json index 82d96ec5388..9232fff7933 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.StatusCodes.json @@ -1 +1,74 @@ -{"responses":{"200":{"content":{"text/csv":{"schema":{"type":"string"}}},"description":"Streaming CSV 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"},"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"}}} +{ + "responses": { + "200": { + "content": { "text/csv": { "schema": { "type": "string" } } }, + "description": "Streaming CSV 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" + }, + "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-sql-query-results-to-csv-with-streaming.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.api.mdx index e612531903a..31da9bf96ac 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.api.mdx @@ -1,33 +1,32 @@ --- id: export-sql-query-results-to-csv-with-streaming -title: "Export SQL query results to CSV with streaming" -description: "Export SQL query results to CSV with streaming" -sidebar_label: "Export SQL query results to CSV with streaming" +title: 'Export SQL query results to CSV with streaming' +description: 'Export SQL query results to CSV with streaming' +sidebar_label: 'Export SQL query results to CSV with streaming' hide_title: true hide_table_of_contents: true api: eJzFV21v2zYQ/iuHw4AmmBw3WwcUKvohDVqsXdBks7sXREFKS2eLjUSqJGXHE/TfhyNlRX7pinUf8skydTze89xzx1ODhj7XZN0rna0xbjDVypFy/CiqqpCpcFKr8f1otVqN5tqUo9oUpFKdUcZGNs2pFPxUGV2RcZKs91NIUu5WeqOMbGpkxZ4wxmlOMPn1Aj7XZNZgyNaFA5mRcnIuyWCEbl0RxmidkWqBbYR0X1HqKLs1emX3PV76B1HAxg6MXkGqa+Vgrg1URi8MWQvOiPSOffZnSOVoQYYPmcuClCjpX/xvTLxXlxMfqI3bD7ntV/TsE6UOW17a9vra74VKGFGSI2Mx8tmQhql1pqaWF2yllQ2k/vD06U6OHN27cWqX26nYDWbv6IkzJEqpFnA++X0Doo3w2d4BQxF8srz5yzkvyVqxoEMR7NHBORVlVdDWRnwlMugUGcNbtRSFzAYMcSaXkqV3ANRgb8By+rhYPihRu1wb+TdlMZzVLmeJh/OhT/QBIMONAcmPj4vkjTYzmWWkYvhL15Bp9cRBLpYEFZlSWsuInAaRpr7Kcmm5rnVtUjoEsPcX0D17XHTvNXeJWmUxcGvqJMRNpIMAmSYLSjuge2kP1nLvg0/56bGr6K1yZLhfWTJLMkDGaBPDmYJa9S3SL4JO09p8QYdvhOOeynb+cEtpbaRbY3zd4KeVw/j6pr2J0ImFxfgaualfiBneRHg/4hti4mOz3r4QaoExph9+u8AICzGj4uFvJ5UY09oUMPoTri4nU0gwd66Kx+NCp6LItXXx86fPn49FJcfL07H9XBRiNg7d69ZuWto4QUiSRAGMfoYEz7pS8uTH8IqEIQPfnZ2fv55MbqeXv7x+v73hPKRtNF1XFMNu5h5sM3jSJHhH6wRjSHApipoSbJ9gG/Vor9Yu12qAt1/oEcvS3wKd6myiErXp+fCyXz6ptHVHfC58Oy1R2J+TyMjYl80OOQFHR1CC8H1Xz7dO35Fqu91MwstDwBN1nKjKSOWONgBO2Pjo+HhIyTuxFBMvsgEtW4sPYtDKMjM9G2IlpIM5uTT3XPw/JpoAqCSX64yRsOh2WYo3ZrCrJUb/cSOnJlA19Ux9jB62DNUU+NpXVLDeEDzT2TqGd5PL9yeh8OV8fdTAHa0HbEN7zNZM+otEBaIy4URP0k4KOiNd0EmhF0dsevwCuXgPziS745nl7s6jwkq6HHomMcLAHsbIAsUIK+FyjPFrKeA0+94UmkNtWAUHk4m7IV7wa8hoSYWuSlKu63JeZMFRUxntdKqLNh6PG3bVxg1H0O55O6+t0+XGRYRLYaSYFaEVb9yEiXAu6sJ1YWKEpOqSu173l38s7hH683R6Bb2fNkKOZttfj3cvuElo3/zOT53awNsrduLntS0nB6nq9ofpruVsb1r4hC+fANI38gZnXslvtCkF+3v3x5Rz5M0w7t4+zLkedBvx5ltDc0M2/1YnbYRSzfX+1D2pKzKW/HQtHd9xwyXWTrBbngZKrCuFv1nDEP/ftbx1fH/7+hG7KoT004oXWNPJ/BpFJTmWU4bppY7+Y2VL7Bgh6yIk/hqbZiYsfTBF2/KyD41v0gft+Xs1wtCBfH3c0Zq1OuglXqpFzQF+/TuNKyO4OEtT8k12s7n/gGB19MXMnRAjnHUfhaXO2HbgMRr+CeHyzDqgrU9298AwuldCrQcRNE2wCL2TKzSE6m8dbG/atv0H1AwSiw== -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Export SQL query results to CSV with streaming'} +> - - Export SQL query results to CSV with streaming - + Request 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 index 44d1d1bbab0..12b10bb915b 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The SQL query result identifier","in":"path","name":"client_id","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 569a6285260..d055088f26d 100644 --- 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 @@ -1 +1,74 @@ -{"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"}}} +{ + "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 index bcd96f4d733..85a114fd8bb 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Export the SQL query results to a CSV'} +> - - 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 index 98f0c0b7aa6..f68198ca801 100644 --- 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 @@ -1 +1,36 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"database_id":{"description":"The database id","nullable":true,"type":"integer"},"engine":{"nullable":true,"type":"string"},"sql":{"type":"string"},"template_params":{"description":"The SQL query template params as JSON string","nullable":true,"type":"string"}},"required":["sql"],"type":"object","title":"FormatQueryPayloadSchema"},"example":{"database_id":1,"engine":"string","sql":"string","template_params":"string"}}},"description":"SQL query","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "database_id": { + "description": "The database id", + "nullable": true, + "type": "integer" + }, + "engine": { "nullable": true, "type": "string" }, + "sql": { "type": "string" }, + "template_params": { + "description": "The SQL query template params as JSON string", + "nullable": true, + "type": "string" + } + }, + "required": ["sql"], + "type": "object", + "title": "FormatQueryPayloadSchema" + }, + "example": { + "database_id": 1, + "engine": "string", + "sql": "string", + "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 index f02329ada24..dc1f464c76b 100644 --- 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 @@ -1 +1,68 @@ -{"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"}}} +{ + "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 index 7ef9c6e1351..8a4cdc0bbf3 100644 --- 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 @@ -1,33 +1,32 @@ --- id: format-sql-code -title: "Format SQL code" -description: "Format SQL code" -sidebar_label: "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/ivEYUATTImTvQAFi35IgxZtFzRp7WAboiClpYvFhiIVknLiCfrvw5GyrPhlwNIP/WSLOh7vee6546kBi/c1Ov/G5AvgDWRGe9Se/oqqUjITXho9+uaMpjWXFVgK+ldZU6H1Eh095cKLqXB4I/PwiC6zsqKtwGFSIFsaMJlDArpWSkwVAve2xgT8okLgILXHGVpoE0A9kxrJ1w5b563UMzJ194rsNtY9lpUSHm8qYUXptsc1/nzG7mu0C7Y0Z9GcCcc+js8/sc7hzqCXB7ZJ4FJazIFfhaiueyMz/YaZhwS89OQB3hlbCv+ZTr4QC2VEPo7UEvZHUVYKN3g9XtECfVQB/epxA/QqvjZZw99jh2HoBC5gcZXRLqb3l6Oj7xCHRVcrvyVH7To/T8Ev9/0HhEhjyGJn3Sbw23dFW6JzYob/P9x+I7wROevqirMPei6UzKOs0KN1rLJmLnPMtyEa7I1Yjn8slkstal8YK//BnLOT2heofXc+61WzBchwY0Ty649F8s7Yqcxz1Jz9bWqWG/3Cs0LMkVVoS+kcIfKGiSxD55gvpCNRmdpmuEN70R+d+PuP1twH7dFqoZhDO0fL0FpjOTvRrNb4WGHmMY+LzGRZbXdk7Z3wQkW7cLjDrLbSL4BfNfDtwQO/um6pr4mZozZHlXcmptTqHg8yk+M4xOaCvRJ6Bhyyyy9nkIASU1Srx45YDlltFTv4i12cjycshcL7io9GymRCFcZ5/vLo5cuRqORofjxy99SDR7eh7G/cvRqlwNI01YwdvGcpnHSSC7Rz9gaFRct+Ojk9fTse30zO/3j76emG05iwg8miQs7Wc7ayzdmLJoU7XKTAWQpzoWpMoX0BbdLjvFj4wugB0n6hxyrLyli/LHCX6lQvGy173S8fVsb5PTqXPYeQJO4sUORo3etmjZaIoKMmBfZzp/gbb+5Qt91ugv96G+RU76e6slL7vWXoh2S8t78/JOOjmItxENaAkCeLKwEY7YiTngfxIKRnt+izIrDwXA6aCKVEX5icMJDE1vnhSzO2rh/C/XUpoSaSNAkcfU1WW4YKikxtqihaL6mdmnzBw3BxGMtc3i72GnaHiwHPrN0na6L7VaojRTQN9PSskd8ZGYWHysz2yHT/FVCp7rwxqVwhgUgPcCDVQQKV8AVw2M0u5S40mVjltaXUbs0QrJ9+Rq9ZjnNUpipR+65dBeVER01ljTeZUS0fjRpy1fKGqqbd8HZaO2/KpYsE5sJKmtBc12GDmzj33Yo4SlCYQHNUXVL76h7px8EGV+8nkwvW+2kToGie+uvxbgQ3jn2Y3mlRIjOWfbggJ4TlqZOtVHX7g3XbUiKXvThMihFk6MgNTINIY2qpzP6cUI6CGfDuLfQ3SQDdJrT5xuKtRVc81wl5cUZ/WX1EvN0xvB591/CagNS3ZnOEH9cVWofDyXqwRBKNdvPjyLzzpQg3MaVkazU88d9fxx4f/ahSQobLPgi16QrlCkQl6bDjCEiJKSSwKhdIgJQVpXMFTUOUXFrVtrQc529+db1Sb7hiE4jtKVTYHS5I7YNGE8SuagptY86gUoo7TrIMQ6vdbXs9qH/qjpDAtPsULIkQDlY80PeBeAAOkIAJ1MS5ntZiw6/jEBJ9kipo9hvw16un+0OouldCLwYRNk20iH2WSj5CCXcTtNdt2/4LyisNlQ== -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Format SQL code'} +> - - 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 index 52f2875b855..9f067559efe 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"Either the id of the chart, or its uuid","in":"path","name":"id_or_uuid","required":true,"schema":{"type":"string"}}]} +{ + "parameters": [ + { + "description": "Either the id of the chart, or its uuid", + "in": "path", + "name": "id_or_uuid", + "required": true, + "schema": { "type": "string" } + } + ] +} 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 548b5fa99b5..95503f67951 100644 --- 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 @@ -1 +1,145 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"cache_timeout":{"type":"string"},"certification_details":{"type":"string"},"certified_by":{"type":"string"},"changed_on_delta_humanized":{"type":"string"},"dashboards":{"items":{"properties":{"dashboard_title":{"type":"string"},"id":{"type":"integer"},"json_metadata":{"type":"string"}},"type":"object","title":"Dashboard"},"type":"array"},"datasource_id":{"type":"integer"},"datasource_name_text":{"readOnly":true},"datasource_type":{"type":"string"},"datasource_url":{"readOnly":true},"datasource_uuid":{"format":"uuid","type":"string"},"description":{"type":"string"},"id":{"description":"The id of the chart.","type":"integer"},"is_managed_externally":{"type":"boolean"},"owners":{"items":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"type":"array"},"params":{"type":"string"},"query_context":{"type":"string"},"slice_name":{"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":{"type":"string"},"url":{"type":"string"},"uuid":{"format":"uuid","type":"string"},"viz_type":{"type":"string"}},"type":"object","title":"ChartGetResponseSchema"}},"type":"object"},"example":{"result":{"cache_timeout":"string","certification_details":"string","certified_by":"string","changed_on_delta_humanized":"string","dashboards":[],"datasource_id":1,"datasource_name_text":{},"datasource_type":"string","datasource_url":{},"datasource_uuid":"550e8400-e29b-41d4-a716-446655440000","description":"string","id":1,"is_managed_externally":true,"owners":[],"params":"string","query_context":"string","slice_name":"string","tags":[],"thumbnail_url":"string","url":"string","uuid":"550e8400-e29b-41d4-a716-446655440000","viz_type":"string"}}}},"description":"Chart"},"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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "cache_timeout": { "type": "string" }, + "certification_details": { "type": "string" }, + "certified_by": { "type": "string" }, + "changed_on_delta_humanized": { "type": "string" }, + "dashboards": { + "items": { + "properties": { + "dashboard_title": { "type": "string" }, + "id": { "type": "integer" }, + "json_metadata": { "type": "string" } + }, + "type": "object", + "title": "Dashboard" + }, + "type": "array" + }, + "datasource_id": { "type": "integer" }, + "datasource_name_text": { "readOnly": true }, + "datasource_type": { "type": "string" }, + "datasource_url": { "readOnly": true }, + "datasource_uuid": { "format": "uuid", "type": "string" }, + "description": { "type": "string" }, + "id": { + "description": "The id of the chart.", + "type": "integer" + }, + "is_managed_externally": { "type": "boolean" }, + "owners": { + "items": { + "properties": { + "first_name": { "type": "string" }, + "id": { "type": "integer" }, + "last_name": { "type": "string" } + }, + "type": "object", + "title": "User" + }, + "type": "array" + }, + "params": { "type": "string" }, + "query_context": { "type": "string" }, + "slice_name": { "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": { "type": "string" }, + "url": { "type": "string" }, + "uuid": { "format": "uuid", "type": "string" }, + "viz_type": { "type": "string" } + }, + "type": "object", + "title": "ChartGetResponseSchema" + } + }, + "type": "object" + }, + "example": { + "result": { + "cache_timeout": "string", + "certification_details": "string", + "certified_by": "string", + "changed_on_delta_humanized": "string", + "dashboards": [], + "datasource_id": 1, + "datasource_name_text": {}, + "datasource_type": "string", + "datasource_url": {}, + "datasource_uuid": "550e8400-e29b-41d4-a716-446655440000", + "description": "string", + "id": 1, + "is_managed_externally": true, + "owners": [], + "params": "string", + "query_context": "string", + "slice_name": "string", + "tags": [], + "thumbnail_url": "string", + "url": "string", + "uuid": "550e8400-e29b-41d4-a716-446655440000", + "viz_type": "string" + } + } + } + }, + "description": "Chart" + }, + "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" + } + } +} 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 index c793ca6a54a..2c145847078 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-a-chart-detail-information -title: "Get a chart detail information" -description: "Get a chart" -sidebar_label: "Get a chart detail information" +title: 'Get a chart detail information' +description: 'Get a chart' +sidebar_label: 'Get a chart detail information' hide_title: true hide_table_of_contents: true api: eJzFWG1v2zYQ/isEsQ8JpsR26nSZin5Is6wvK9oicbABcaDS0tliK5EqSTlxBf334UjJkiU5a7sP/SSJPB7vOT73QhU0Ah0qnhkuBfXpSzCEkTBmylCPZkyxFAwoTf3boiN6yU0MipgYCI+IXNo3u9IjUhFuNMlzHlGPchTPmImpRwVLgfqUR4FUQTWv4EvOFUTUNyoHj+owhpRRv6Bmk6G0NoqLFS3LOxTWmRQaNM6fjMf4CKUwIAy+sixLeMjQxtEnjYYWLX2Zkhkow91qBTpPTH88ZGEMgeEpyNwMmOHREIWX1T5BBIbxRD8mCVGw2AwLxEysIAqsnsSwIM5TJvhXdMeAeMR0vJBMRXY7biDVfQBbocBwk8CgIt7Wz4WBFSgcR6cFKRgWMTN4Bl49IhefIESaVJvQP+ptaSPElGIbZ7hhWuYqhGDf1i0RpElg4MG4c2LRe5FsHD92BZ2WQUdtZXKV/Jcay0S/oEupUmaoTytq9tW2Y2CvW3cjZdYPkeNGd8sBXAcpEwzpAA8GlGBJ0mbNQsoEmEBReS9sWO7lwJIrbQIXbt9x/Anbv+qRo7/Rbnn31G0GGY6MLzmoTWBD92E4ynTCKyoMThu2eswB+xDu11dRCUSeUv924p14T7zp3WOwZ2w1hNrEeboQjCc19Xp77R3/Vh6u+dd93H/E3gvk3kswV1USvXaZsb+k9Cg8sDRzyaNJlJ3UWO+5NyP2BKpE2Bp/JP81Uu20d3vXyyaTvcljKFu01XaSxFBWoKenYzibjsdHcPL74mg6iaZH7LfJ06Pp9OnT09PpdDwej2knNTR7VPbtiW1X8epoRmh1yDQaOpHSTLQDpBl1cYGqOjxsRLqf34WzoV5DubKbGh3VkEdPxif9lHgFEVcQGk2MdFkxVwqEIRFfgbbrpv+rtqegNVt9U3jscn27kL5gEcHWBLTxyWuxZgmPSNMSkUzJNY8gogPoW2sdlsnPxXIjWG5iqTCufHKemxiEqfYn2/5rAEh7oUMy/blI3klDljIXkU+wrlZOBnS3i1oSSdBESEPggaP7+6C2Ouy+GsJccbOxPe6ne4Oxg51mFUeOyZreefThKJQRXFurXEucMLGiPg1vrt5SLJ4LSJpPZw9+5yohR/+Ql5czMqexMZk/GiUyZEkstfHPxmdnI5bx0Xoyst3BqGj643JOyXw+F4QcvSJzel6dhvW3T14AU6DIL+cXF5fX18Hs/V+X7+aUlt7WtA8bE0vRMm47sDWPp5lUpnalnou5qLts8nw7fLwCc4B2kB/B4LmVMbAIlH5edJDMqU/mtEIzp+RXwsIQtA6M/AyinIvDucgUF+agtuwYuXZweNjG+oat2bU95xbencHmSKTQCHkLk90zbsgSTBhblD+KsdgB6tffpHt2iPhjfXyFQzuzYD+6FSU+EPmzuXDWYmXaWtrxQyUkEzhO5OoARQ+fUaRxCiaWmN5X4O50JqY+3Y8DvQRqXV/6XKkY9EWv5r3FaRLBGhKZpZjOnSZ7Rk5RkSlpZCiT0h+NClRV+gXSr+xpu8i1kWmtwqNrpjhbJFD3elaNKy1LZvsTayb16g6u/sSHjd9d/a9msw9kq6f0KFqzq2+Lt2fctbWK4BzWX7zxvv5gO16pOkoGXVWtt9KlvdjWacj2ZA6kTUYFXViW/Fm3hG/+ntHqkmwvBXa26REtaLzI3ZtAwVKBjn9UCd4TxFL2y/d1noHS0G4tW0PIHSe3njiXaJMyWxiqXqX1m4G4XpHgRmgbt7mpc83alpvOD4rKWuyLRlnCuGj11o7ot5RlHG2auF7TLvNbvx/u6nO/pUWxYBpuVFKWOGzbLtdI1dRzv0G4xveI+kuWaHjE2IOrqrIekm//WzKIqb5hiI0NhCTHL+rRz7DZ/ZtS3iGRbfKxxjqB8zAEm//qpb2ivZMpXl4iObDwty+fNUWqF9Q+aFZROAmXzcqtlTaVo4Fl+S+lSlxQ -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a chart detail information'} +> - - Get a chart - + 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 index d61a43745de..7ecdbe1109c 100644 --- 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 @@ -1 +1,16 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"digest","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 30de2de2f9a..5cf267453f0 100644 --- 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 @@ -1 +1,62 @@ -{"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"}}} +{ + "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 index d24e6feb735..1ba6487c1e9 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a computed screenshot from cache (chart-pk-screenshot-digest)'} +> - - 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 index 395d5c98f92..7038efeb5bd 100644 --- 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 @@ -1 +1,21 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 4beeba52627..05e2b3e069b 100644 --- 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 @@ -1 +1,62 @@ -{"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"}}} +{ + "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 index 752b46af063..31f7ef3ba40 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get a computed screenshot from cache (dashboard-pk-screenshot-digest)' + } +> - - 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index b5f9b1cc89a..952ca57c6ef 100644 --- 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 @@ -1 +1,160 @@ -{"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"}}} +{ + "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 index dac194110e1..98f8ba05863 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-a-css-template -title: "Get a CSS template" -description: "Get an item model" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a CSS template'} +> - - 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 index 20033d43cea..4fb53c70740 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"Either the id of the dashboard, or its slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index de1cefe5300..dc1b4fe69e3 100644 --- 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 @@ -1 +1,229 @@ -{"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":"User1"},"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":"User1"},"created_on_delta_humanized":{"type":"string"},"css":{"description":"Override CSS for the dashboard.","type":"string"},"custom_tags":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"Tag1"},"type":"array"},"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":"User1"},"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":"Tag1"},"type":"array"},"theme":{"allOf":[{"properties":{"id":{"type":"integer"},"json_data":{"type":"string"},"theme_name":{"type":"string"}},"type":"object","title":"Theme"}],"nullable":true},"thumbnail_url":{"nullable":true,"type":"string"},"url":{"type":"string"},"uuid":{"format":"uuid","nullable":true,"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","custom_tags":[],"dashboard_title":"string","id":1,"is_managed_externally":true,"json_metadata":"string","owners":[],"position_json":"string","published":true,"roles":[],"slug":"string","tags":[],"theme":{},"thumbnail_url":"string","url":"string","uuid":"550e8400-e29b-41d4-a716-446655440000"}}}},"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"}}} +{ + "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": "User1" + }, + "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": "User1" + }, + "created_on_delta_humanized": { "type": "string" }, + "css": { + "description": "Override CSS for the dashboard.", + "type": "string" + }, + "custom_tags": { + "items": { + "properties": { + "id": { "type": "integer" }, + "name": { "type": "string" }, + "type": { "enum": [1, 2, 3, 4] } + }, + "type": "object", + "title": "Tag1" + }, + "type": "array" + }, + "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": "User1" + }, + "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": "Tag1" + }, + "type": "array" + }, + "theme": { + "allOf": [ + { + "properties": { + "id": { "type": "integer" }, + "json_data": { "type": "string" }, + "theme_name": { "type": "string" } + }, + "type": "object", + "title": "Theme" + } + ], + "nullable": true + }, + "thumbnail_url": { "nullable": true, "type": "string" }, + "url": { "type": "string" }, + "uuid": { + "format": "uuid", + "nullable": true, + "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", + "custom_tags": [], + "dashboard_title": "string", + "id": 1, + "is_managed_externally": true, + "json_metadata": "string", + "owners": [], + "position_json": "string", + "published": true, + "roles": [], + "slug": "string", + "tags": [], + "theme": {}, + "thumbnail_url": "string", + "url": "string", + "uuid": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + }, + "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 index 2b223cbd1f3..c230d116e36 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzNWG2P2zYS/isD4nDdoPLa3nhzORX9sE23aXJFEsQO7mW9cGlpbHEjkSpJ2esa+u+HISVZsrWLTe+A9JNlkjN8npnhzJB7lnPNM7SoDQtv9ixGE2mRW6EkC9m1sAlqsAmCiEGt3FfMTbJUXMcBKA3CGjBpsWYBEySSc5uwgEmeIQuZiBdKL6p5jb8VQmPMQqsLDJiJEsw4C/fM7nJabawWcs3K8pYWm1xJg4bmL0Yj+omUtCgtffI8T0XECefwzhDYfUtfrlWO2govrdEUqT0dj+hzVWlZxGi5SN1E1wg/+omafkeKBcfYg1otxovl7lTbB9RGSbLcWqsiB5twCwk30IiBTYQ5WLl3i4TLdbNBl9VKaGMX3v4nlg2YiFvDQlpco6bxlD8sVTYQ1PIOI0uQhE1p4JNBPe5Cenjveo1310rpjFsWsphbHFiR4WNUnYdSyxdJkXEpfsf4oS20dXYQFrMeb84SBAJoTsL5GwNe+hzeuQVcIxQGY1gpDSmuebQDjdwoac77oFYDXGu+c1g0cvsn81IF6anWND0WfL9BrUWM8Go6dabpWLHXMlFhrMoWlq+7runa5CHSD1rJD+wZyiJj4c04uAieB5Pbxywx4+txn68a/Itq5THrK3ATTyT8EBVhFhmXnAIa7y1qydPURYcs0pQvaWOfGyvRpVIpckmilOUWGVoec8v74loYeDt9/w48ZxAG1ihRk78h3kmeiYh2g22CEqJURJ+FXDsuhm+QMpLaoN5qYRGWhbVKgpBdrrARuD2HN0473ueKTkeC2ptF4wo1ygiBS39ocrVFTWdIG9gmCjK+gy2XFqwCnlrUACbHiNIpHApRr0XVVroa9WD0fKUTdRxIuTLC1ZO6KvW46c5VAO8mP71E4yxdS5Nnqvy0FfEarTnxRe2GtmsPDndO5vFdYWzt5VqREb97D9WbGVjuoDC0LtZ8DX+FWKu83/l9rsmLZSpM0skhrcDVKsX/47F/xCkf3U49TnENSG8G+fNmJJug34Sn6fuVa86eBs4lijpJnCIktX8g4GcODnVm3VTlVBbZUnKRLgqdPpLMDiCqdafjhSfVtAZu4HjLE4WPwP6xjt7XaD9WLeXU94mnYmXA8J5nuc//h7bxgUax3v+45WuNHzdFp1MuK1yMLiaD0XgwvpyNR+HzUTga/Yc93vt0NLmW5+b28frekjBd9O3qTFpOiuFhLfln/GAd8945qlQH4TqH0x5HefKwqJVNvLoqf5CQP8eHtQfI9Wk5DcfD6uO/LtjY5eUIX05GowFe/H05mIzjyYD/bfxiMJm8eHF5OZmMRqMRK0uKlqN7QdOhlwGb/E83lAyN4esnnchujDaC7AceA12w0NgQ3sgNT0XcqqmQa7URMcash0lL1nMZf10unyQvbKI0xW0IV4VNUNpqf2hukT1E2oKeyfOvy+QnpZcijlGG8G9VQKzkN3Tb2yDkqDNhDDGiZiiK0Bh/89NoVKEj7CPY6PPsJl+X3TtlYaUKGYdA16oqhDBuKECs0IBUFvBeUHCdMmp0uH0NRoUWdufK3d3W0uGmmlMd9MOZM+w2YPeDSMU4dcj880XKJSWI6NPHXxj1dktMD38rs4YsKnQKg3/B6+sZzFlibR4Oh6mKeJooY8OXo5cvhzwXw8142KTC4XjOYD6fS4DBzzBnV1WgOWOH8ANyjRr+cvXq1fV0upi9/8f1uzljZdBg+rCziXswqFE1Aw0ukeVK29qOZi7nsn4Gge+b4fM12jPCAV8EPvAiCfIYtfl+f0RhzkKYs4rGnMG3VUwurPqMspzLZ3OZayHtWQ3pnCLs7NmzNsm3fMOnzrstop3BgxOUNMS14ce3XFhYoY0SR++Lye07DMP6Pxx7i6j+Wjts72nOHMtfvURJP0T5u7n0MKmSNRCPDFAtUimep2p9Rkuffec6pW6kv0YLvNVO+z4ChPTdjn9NytAmisrSGsla7jUtZKec94eXtZKsinpTP+H5MtdrO3aM6Reahhg3mKo8Q2nBa3I+9Yr2uVZWRSotw+FwT6rKcE9xWp5oe+UaiVpFwDZcC2rb6s7aqfF3ohV3vZWDyYK6X67/0o874V39P89mH6DRUwaM0HT1NXxPwE0dKqA56sXovvvmg7+x6SMlvaaq5N3q0j1R1snK9ZOepEtZe7Z0wfVT3cW+/eeMVc+d7m7kZg83KUeaGvetXWhcaTTJH1VCF125Uqf3zmmRozbYbo1bQxQ7ft1mXF1ibcZd+aj61icFb2fLpqxYvLfDPOVCtlp/H9g3jOeC9h+zVtfJAha2Ho5vaz/fsP1+yQ1+0mlZ0vBvBeqd7//qUPOP2MLQd8zCFU8NngBrKiY7+1h1E8/gy966e7nVVzi5c8GfFvSPBewz7rpv4eUtBa/LUw6wX3AVRehyZC16Us4p6poM8fqaAoIanva9uw6L6oO098La7/0Kn/jKBqVL9wSwLP8Lyz5Vag== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a dashboard detail information'} +> - - 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 index d6b6943ed6f..b126e0e93b1 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 9e9502edf88..7aedef7cbe3 100644 --- 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 @@ -1 +1,119 @@ -{"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"}}} +{ + "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 index 6f42c7fb8b0..cf16f901011 100644 --- 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 @@ -6,28 +6,27 @@ 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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index 5e7ca7ceed3..b74845b07be 100644 --- 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 @@ -1 +1,16 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"key","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index c4bb1f53ee4..25597ebbcc3 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 9f42ffe1f0a..94b3921597f 100644 --- 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 @@ -6,28 +6,27 @@ 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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index 194d0eaad92..ab56492841a 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 39fef5e3ce9..3a691acb9cd 100644 --- 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 @@ -1 +1,234 @@ -{"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"}}} +{ + "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 index fb66e62671f..baf5b72c468 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a database connection info'} +>     - - 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 index 194d0eaad92..ab56492841a 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index ee233bc70d2..5ffe2ff811b 100644 --- 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 @@ -1 +1,58 @@ -{"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"}}} +{ + "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 index aa093d4788c..0a1156b662a 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-a-database -title: "Get a database" -description: "Get a database" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a database'} +> - - 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 index d5fca1bca50..192f717eff5 100644 --- 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 @@ -1 +1,45 @@ -{"parameters":[{"description":"Either the id of the dataset, or its uuid","in":"path","name":"id_or_uuid","required":true,"schema":{"type":"string"}},{"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"}}]} +{ + "parameters": [ + { + "description": "Either the id of the dataset, or its uuid", + "in": "path", + "name": "id_or_uuid", + "required": true, + "schema": { "type": "string" } + }, + { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 6252afbdc4a..8b1ab75191a 100644 --- 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 @@ -1 +1,326 @@ -{"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":{"readOnly":true},"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},"currency_code_column":{"maxLength":250,"nullable":true,"type":"string"},"database":{"properties":{"allow_multi_catalog":{"readOnly":true},"backend":{"readOnly":true},"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"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},"uuid":{"format":"uuid","nullable":true,"type":"string"},"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":{},"catalog":"string","changed_on":"2024-01-15T10:30:00Z","changed_on_humanized":{},"column_formats":{},"created_on":"2024-01-15T10:30:00Z","created_on_humanized":{},"currency_code_column":"string","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":{},"uuid":"550e8400-e29b-41d4-a716-446655440000","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"}}} +{ + "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": { "readOnly": true }, + "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 }, + "currency_code_column": { + "maxLength": 250, + "nullable": true, + "type": "string" + }, + "database": { + "properties": { + "allow_multi_catalog": { "readOnly": true }, + "backend": { "readOnly": true }, + "database_name": { "maxLength": 250, "type": "string" }, + "id": { "type": "integer" }, + "uuid": { + "format": "uuid", + "nullable": true, + "type": "string" + } + }, + "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 }, + "uuid": { + "format": "uuid", + "nullable": true, + "type": "string" + }, + "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": {}, + "catalog": "string", + "changed_on": "2024-01-15T10:30:00Z", + "changed_on_humanized": {}, + "column_formats": {}, + "created_on": "2024-01-15T10:30:00Z", + "created_on_humanized": {}, + "currency_code_column": "string", + "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": {}, + "uuid": "550e8400-e29b-41d4-a716-446655440000", + "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 index ce3477f9ce7..ce91c247e96 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-a-dataset -title: "Get a dataset" -description: "Get a dataset by ID" -sidebar_label: "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: eJzdWl9z27gR/yoYTB+SqWxLipz6eHMPPseXS5r2MrHTdmp5eBC5EpGAAA2AsnUafvebBUiRkiBbdpJJpy+2CCyW+/e3C4BLmoJJNC8sV5JG9DVYwkjKLDNgyWRB3ryiPVowzXKwoA2NrpYbS865zUATmwHhKVFT96vm0CNKE24NKUue0h7luKBgNqM9KlkONKI8jZWO63kNNyXXkNLI6hJ61CQZ5IxGS2oXBVIbq7mc0arqLWmipAVpcZYVheAJQ4mOPhkUa9lZW2hVgLYcDD4lSpS5dD+5hdwEuPeaAaY1W+DzZ1isrwBZ5jS6oiZTt3HDstc1TWdUsAmIzrNbZLkVgHZQEuh17yEZ2gE1+QSJpT3qOUR0BjZGweJa5QqJnalvStCL1tY3FO227r6LTJUiJW+5/MRIzhKtDJlqlRNzI3okB6t5YgiTKanlJxMgGmQKGlI3zmUiyhTwh/O9BlMoaYCGhajJ44ZHbG4EDbh6opQAJmlVXWNgeJ7O9sN+3zvySf7nKf5dN8IlBq+FnLgo3PKEBlMKu82KiVu2MPGUCws6zhmXcWptjlOyFIJN0D0+kjeV6tGEJRnEluegSsdbA0t/k2LhlzgKy4Sa4VzO7t6BnNmMRsPjl71d7FuRk4zJGaTxZLEt9pRrY2PvjjXWL0cBToLtTVx1M/iq+54um+vdkfzKw8YHMPa04IczsIcfDehhVyPv3anSObM0oimzcIBWpI+wipJxVuZM8j8gDZvexXrs32LuITGBqEjnTCaQxgiCsZdhw4PHj5L1C/T1agS852TYptfA7Be+cy2zdiZCSw93hQZj9ie3mu1F6dPSk+yTkDOtysLny8PEHkXqcS4tzEC7cROzxPL5nu/k5hGIUSxspiSGFcSNb54QWE1E7kUYz0CC5kkwBVzV7gZKXcYf5DwHPVEGQoE56A9HD3LYAJpumD8OXS7xJWdueTf+/y9Qc/C1Mrrl8RBqllqDTBZxolKo+52tEO3vgyHMsgkzECq5Qt3GeSksjzv1cUuUCUs+gwyL2XAP42I/IM+ubH9iAmx4fF2exzn6VWOpWi+jSp20mgV1r2kaHNimgSkrhY1BpoXivsP6BrC/N46DTbJ4zkQJJi40pNjp7YdgdWdmQECC+iBxuh/YTpVI3YZnk9hVCiZLwTS3C+xeWdCK91SInEmGpR3uLGjJhFiE+l5Ham7w3fGcw+1+cn/mO6J+1Z5iYj4pK+vNQGBL9TVala8BVDX+BJ2WvgjWzMHw5Js3NV8Q/LuiyPti/86upg90oy+Ge+j/3Sp9j94yLbmcxRbu9kGiDWztOGLdaI+D2Ysb8Q+3GCXaCa4SrSP4HxB3NgcPp6yaTg3cp1vH70qnoOPJIk4yxRMIb03Urayh60tamF2h9z/Q2qAY7f7+0R1wXQ+MZTpoPzyR2KtBxtn9uwgLeSGweXfnafcFR2cNzyGeacTunZWmzs3tcS2+TduesyLAONiUu0OxpkdpS8ia7R7l/8BJmANUlhd+o4e6NTJ3j252HtZ4ZTePY7rnLy27bqWjw/5wdNAfHAyOLwf96EU/6vf/S3ceMoROFTbq3k6O4QZ8Z8fdyrvdEgZ7wGDT1+Gydli2Gq6rWDuwq1PrUIQbMu+CtuUK91g1Jg129lCezWbX5Efrvmi7EWqFay0UAHLPpYHqQRCJO6jUcl0HmwZd2vkuiHRGN7GiM7UFCSsMWCX9Ksvp8XEfTkb9/gEMf5gcjAbp6ID9bfDyYDR6+fL4eDTq9/t9upnaVeXOkNf9Xuci8VlHMoZHwSCJBltqCekhJuLoi85mczCGzSB44H9v0q8W0p9ZShCGwNiIvJFzJnhK2gsMUmg15ymkNKBhZ63XZfB9dfkoWWkzpTHfI3Ja2gykrd9PVlgbUKS70GkyHH5vTQqtEnycCCCohV1E5F/oHK8NaK10SJUzdz0hlSU1h3o1vur4ewfbG+nBhxjQc9Bei4icSlJKuCsgsZD6QaISh9VBd/2ChWZlAoSMpETgc7dtn24tja6u8RbEshnewDWZaLBy3h0g9F844fz1nGASa1by8cO75u6pffS4j8+lFuTgP+T1+SUZ08zaIjo6EiphIlPGRif9k5MjVvCj+eCovsw7WrZ3ddWYkvF4LAk5+JWM6Wkdbc7wEfkZmAZN/nJ6dnZ+cRFf/vb383+Oqbt8qoV7744yO+KtBlYC8rxQ2jb5aMZyLJtbIPLTahhbgmcoB3maFj2/NgOGpeen5YYuYxqRMa31GVPyV8ISDMLYqs8gq7F8PpaF5tI+a2Q7xLB79vx5V9u3bM4unL87Gq8Ntm5R0ljSUZTdMm6Jq6xOz6druVxTNWqeyab/UOffGxcuvb6XTt3f/YoK/6HuP46llxffupJ1wxI1kRJwKNTsGZI+/5FiOOdgM5X6C0x3y4ytM71PE1dOMdN8pLtaF7bHVtfyDqdJCnMQqshB2jpnnZ88o2WhlVWJElV0dLREVlW0xCCstridlcbiHaln0aNzpjlCW7Ppcmz8PaNrq2oxsWmqL47rR/zn8nid/6+Xl+/Jik/VoyjNOr+VvlvCXXgwwjlsK/AO/s17d4Gg9AaToKnq9Y66ctevDSBdIJR6JR0sLenExckvzU7i7b8vm7tct8l1s+2VqlO66uHiWMNUg8meysRdcU8V3brLvSgL0Aa6u4jOEMaOp5sPvEmMzZk/1PEt2NonEJu26RSbHd9K1ELiacVRIRh3O/x6J+Yj/IqygqMog6ZBd++JOl9CXDcOv6LLJW6dPmpRVTjsL9O3vsLoyrVLiM+wcN8AYLSKEuf95wDc1F34lAkD9yj8TT8VuEfkHV8MtFpctwnoTbO3Ss8+1F3Uc/KY71iCwjbfa8hFV7iVEq13q2tMaAfDTlxPcJok4GpBs3Srl1nDzNfnmCTY5nXPjptUqX8g96BYy6Wn8LheraR0ZQ0FrKo/AV5xkF0= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a dataset'} +> - - 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 index eccdacad2de..a8f00f72fcb 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 3e4375bbca8..2b972bc89c4 100644 --- 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 @@ -1 +1,85 @@ -{"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"}}} +{ + "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 index 3e09776bb2e..e809e5d74e3 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-a-form-data -title: "Get a form_data" -description: "Get a form_data" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a form_data'} +> - - 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 index 37078d10035..17d764f44b6 100644 --- 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 @@ -1 +1,60 @@ -{"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":"User3"}},"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}} +{ + "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": "User3" + } + }, + "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 index e47f61b5cec..ae4cfe72535 100644 --- 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 @@ -1 +1,54 @@ -{"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"}}} +{ + "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 index e8010202cc3..f68e43bc3bc 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-a-guest-token -title: "Get a guest token" -description: "Get a guest token" -sidebar_label: "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: eJzFV1lv2zgQ/ivEYIEmWCVO9gAKFX1Ig55bNEHsYBeIjJSWxjYbilRJyolX0H9fDKnLR4KiXaAvtkTODOf75uCoAoNfS7Tulc7WEFeQauVQOXrkRSFFyp3QavTFakVrNl1izumpMLpA4wRaejNodWnS8CIc5nZXRmT069YFQgzWGaEWUEfNQgWoyhziG8i4Xc40NxlM6zry/gmDGW2JDBr5aasHevYFU0frwklauGpc6W0DN4av6d3IpxxMJS8t7nUy445bdIM9oRwu0MC2j42RpxyU9qqUe/0rLZpdv+bCWHereL7fN8mf2iWTj2zWj/t4bdH8voOtj3Kg8gmQbympJvoO1blB7jxafOB5IXErX26qetpEJjy2JAxhtz5voO0Xe5A9OHI+Q5saUVAKQwyX3PAcHRrL5towt0S2IDeZIz9hiNWZEj14W2hlQxh+Ozn5gQoJZ3xDEDaJatQGsLZRXaEtpWPkFhfK7sCqI/jjhzzP0Vq++KYE2vS9U4RXPGNNo4nZe7XiUmSs6MNRGL0SGWb78A10A5bTn4vlWvHSLbUR/2IWs7PSLVG55nzWZdAeIENFsv7nz47Ke+WobCSzaFZoGBqjTczOFCsVPhSYOszCItNpWppHcL3hjssg5w+3mJZGuDXVM3y5dxDfTKmuHV9QjcO43Z9G8HCU6gzH3jnfAEBytYAY0uurj77aZyj716azx5CWRrKjf9jlxXjCElg6V8SjkdQpl0ttXfz85PnzES/EaHU6av0Z+aq49VUxSoAlSaIYO3rHEjhrAuOpj9kr5AYN++Xs/Pz1eHw7ufjr9adNhfMQtKPJusCYbcetl83YsyqBO1wnELMEVlyWmED9DOqog3q5dkutBmC7hQ6uyAttXFsGNlGJalsTe9ktHxfaugM6l30nJ1FQXiLP0NiX1RYzAUTDTgLsV8bTFK0N+nWjTQy83Ic6UYeJKoxQ7qD1/piEDw4Ph3x84Cs+9vk14GRjsU8DrSzR0lHB77lwbI4uXXoifoCGKqDJ0S11RjAo17Ypilsxtp1FBP1zm0hV4Mnfh/XnqFcZ5lEgazeXgnTL7kxn65h9GF98Og4FL+brg4rd4XpANasPSZoYf5GowBKNMB1DW/w3QlrisdSLAxI9fAFUtJul/hYd41uXZiAIYqDsgwgK7pYQw5MUUwx9zwk1XxoK8d5IwbYLH2mbZbhCqYsclWu6l8+gYKgqjHY61bKOR6OKTNVxRQVU71g7L63TeWsighU3gs8kttOhN0PPGc55KV3jJkTduNq80p8fiDbtv5tMLllnp46AvNm01+HdcW4c2jLt0XDDtGHvL8kIYdk0speqRt9L1zVFsw3GmC6VANI36ApmPlPfaJNzsvfh7wnFyItB3OxCd7F40HVEyrcG5wbt8nuNkBWr1VX/GfL6kTHRf0B0t1w/M3Zzez8PduP6yf84UEYg1FwH3jdoLgs0dFo//Q6WKMmD3Oo0xM66nPurvTlgX1FtnNDd8A4f3KiQXPipzid71dTbDfBC0HGnMLiBIxhUHURACRoy8AaqasYtXhtZ17T8tURDV/a0LwJ/cUcQWp1n+g7XVDSDpuVrRpb+K2Z7eqGKDBpnaYq+cz8uOx10Euq0EMGs+SbNdUY6ht/TjM7vIQaIQHt2wtcnrYX7owyjTbBJMaOZa0Bhl4TNA6Fqv8LUeuBhVQWJ0LOpcwQozVA9rev6P/JPPd8= -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a guest token'} +> - - 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 index e6f075beb22..8abea9e9f5b 100644 --- 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 @@ -1 +1,76 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index a098be6e5f7..6faf6c569de 100644 --- 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 @@ -1 +1,122 @@ -{"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"}}} +{ + "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 index 80f29d85ec0..452b71835a8 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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/isEsQ8JpsRJ0Q6Fin5IgzRNFzRFXrYBceDS0tliQ5EqeXLjCvrvw5GSLL91bTOg2ydb5PH4PMe74x0rnoJLrCxQGs1jfgromGBKOmRmwoTWBgXNMSXmYF3ESgfsUjqjmbHs7dXFO/apBDtnhbAiBwTr2MRYNpEKwUo9jZgzFv2fQkylDtqETr2YAwUJzTJXQCInMmGJUWWunRfJAUUqUOzziC824PFttYL7OoM1sEyGPTCTrjfJIy5pSSEw4xHXIgf6uucRt/CplBZSHqMtIeIuySAXPK44zguSkhphCpbXdVTxxGgEjTQtikLJxKsffHSEqOotLqwpwKIER18NP/orEXLXU++QLMbrqB0Q1oo5fQdzLi9aU7tRkynsxvGZUCV47Hp+MfEmbWR0mY+JY7S+qhsZG6NAaD/UAXqcprs12nd13T+TW88xMGrx33VrzPgjJLjJdvcwXzYc6DIndeTlo/Y4Im5sCrb3rcQYVO+753F9KVKCEhWQMxndx7T9PPt7bT42L5BKS+ERHKqFLVzSoNm4VSGmsMllw8zIyS9bpkMsjn7AP+vVU4h4sEjMp4Ajb6ImHGoS9vHn08YiAD/x+o5O2xVGu+DSTw4Ogmf/YJyVYdF6pkCDQjELibEp83LMaIYZsLFI7kGnPFpzYS5Tt67taFOqJMnoO4LbgivVFqhhjk2syT3AKWDYsjXftnSQCT2FdDSer89NpHU4CnaveC4ezkFPMePxb083+JNMNyfApcjsqVwLyYUzHHU2ugSHR4Xcb91j/8YFK7e4jR6loFCMsjIXWn4Bj8KCSC+0mocETeIWBP7PaB7SdqDTUYqYe6DG5gJ5zFOBsIcy96mkVEqMSV+4i74RcMSV0dORdySa/0c1LjMWF/I9Mz07OPgGGA4FrX8Ela9kj+2W/IYkRFZ+EHmhoJcODptAvm23v1vE321FV04drYThGUVYiMAFHkfqnz4qQeXg3HKu3mqRZSrdQv5KpIz8ExzG7EzPhJJpvxIrrJnJFFK+gVZvbeBy+HO53GhRYmYsxXrMjkrMQGOzP+uCcAOR/kLP5MmTn82ksCahz7ECRixwHrM/6HACG7DW2E1Ujk2pUqYNskZDs5q2evazne1MI1gtFHNgZ2ADi5gdaVZqeCggQUjDIDNJUtotx/Va0OXbmoDKjqS0xJEKx4+fKQ7vqBRAMfVxuog5du57EArZh73EpHDlUYZ+QAk95TFPbi7P29pt8elMaRPikJRWsb2/2OnJNRvyDLGIBwNlEqEy4zB+fvD8+UAUcjA7HCwu9JFvJwb9ocGQs+FwqBnbe8OG/KhxQD8Xs1cgLFj2y9Hx8cnV1ej64veTd0Puq94G5vs5Zr4VaYF2Ax1UmRfGYhuibqiHuq2O2MtumBLiDuFgj+UTBS0ZiBSse1mtsBrymA15w2zI2a9MJOShIzT3oOuh3h3qwkqNOy3KffLJnd3dPu+3YiauvDP0uC8NLo7KaEf0O8ris5DIJoBJ5hn/G3yrJdJx+81Wz5TYf2iPtQrMrz3xD2FFTT9khRdDHZBT39qhXrFJI2QU7Csz3SHR3Re+AM4BM5OGwtk3vXQT862cquK+7tMiA/roDEFRWrLvRjPx1bg8p2mWwgyUKXLQ2MS5P76gqCqsQZMYVceDQUWq6rgiL63XtB2XDk3eqqB2zUpKh22p6tWEknci/O3rYfKoa3OaT/rxIb+s/8319XvW6akjTmiW9XV818BdhQRGc1TL0UvG2XvfIRm7omSjqZr1Xrqu6djaJHZF6TeQ9Kms4mPvNK/buujtn9e8eVjw3a+fXbQbnnQd0eKRhYkFl/2oEt9nTcx6W3FVFmAd9Ous3hD5TpCbHQaTOMyFv1uaTu0U8GtPRGxnMbTnh/aK+73F2O6qOXt32n/5/akxLsIDDgolJD1+hLiomjC95aKQZMJDHvHVUOURj/0j09JLFDl28NxbXlVj4eDGqrqm4dDgrT119a21DdU9zH1H3b3ycJ9b2hgMSqUvT1IeT4Ry8JUz2blsiq9d9n3PbBuxtUW7nvfhtZiL+/AQFBKyBxomjpIE/P3QLlkrfpay5+kJRQjVhb2Kp4uT5k/vpWoZTlUFiZDh6w6dv+r8u1T9N3F6YLU= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of annotation layers (annotation-layer-pk-annotation)'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index c07f153ff7e..5a8447424fd 100644 --- 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 @@ -1 +1,168 @@ -{"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"}}} +{ + "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 index 80797f244a2..36c0bcf0532 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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/isHYsASTImboh0KDf3gFl1fljVFk24D4sCjpbPNhiJVkkriCvrvw5GSLNlymqYDOuyTLZJ3vOdeniNZshRtYkTuhFYsZi/RWeAghXWg58CV0o7THEi+QmMjKCzCe2G1Am3gzenJW/hUoFlBzg3P0KGxMNcG5kI6NEItIrDaOP8n5wuhgjauUr/MosSEZsHmmIi5SCDRssiU9UsydDzljh+yiK03YPF5yRKtHCrH4pLxPJci8YpHHy3hKJlNlphx+pcbnaNxAi191drpr3CY+T9ulSOLmXVkL6uiZoAbw1f0HcD0hbbUDmrSuRkcv+KyQG+7Wp3MPaB6jSqyGRpWRdtS7chMa4lc+aHWoG/TdLEF+6KqImbwUyEMpiw+9xgDosb+i1ZGzz5i4oZ8d4mrvuNQFRmpoxybNuGImDYpms635DOUne9OnnZXkRInnEQWMaVV16bd8ezuNRw2vyAVhpIzJFRjNrdJbc3gVjlfYEelUA4XPgh+ZmrF5x3ToRKm98jPajMKEQseidkC3dS7qC6HihYLKnRftOQzntHCT6y6oGjbXCsbUvrhgwchs+9ZZ0UQ6vPL2RLBacclGEy0ScGvA63ALRFmPLlElbJoK4UHw7+juKcB09DWnRFPP7RpEAISOoQ/hZQwQ3CGKyu5wxRmK5hRLrKI4Q3Pcu/YMbwVyW362FZubIWJQpHabUPHLf1SBoBIA+vOCwnXS1Sw0gWkWv3o4FLp6y4GQa67O631S+zrvenl/xU/Dmm6mwd7LHKLK9eU8RX+WZPLgGY/AU6DQZWiuTvmYzLptbdigED6PHgLIi6lvsa07ZdO+077VQgN2kLuKNMwB3OjMx+VBbqwd0Mdu1rhkqsFptPZantuLox1bUZl/OYY1cItWfzzowFXSH7nxRutqrNPV81Wv1oz5bg96RzTQec9WjfOxWFDoIcfLJojMqqBF+hvrk3GHYtZyh0eOOE3VIWUfEZqnSlwANhaxzRF6fh0WWRcic9kfMkM8vREyVUQp+UGKZv+hx5lHXTf4lCfvST+xZUiHW6/A055+PjBF7e+pfd+Af8d+njVYY22ox7t7IU9vr5Dh2r6z3mD5mKgJQwqHaTrLTLu6e1QaZ8AN/iuK9Sw03lJh9H+IYDFzGsI/PS7TlGSBY++6dCSobX989ttracTm1aQPeMpUN2gdTG8VldcirR7N8qNvhIppmwAUEc2YDn6vlg+KF64pTZETDGMC7dE5er9oSWHASBdQY/k4cPvjSQ3OqHPmUQgFG4Vwx8UnIAGjdFmCMpzXcgUlHZQa6ilaavH3zvZXiuHRnEJFs0VmoAihrGCQuFNjgmdQfwg6CQpzI5w/crpQN64gK4iSWEII10mP15TBV7Q9cDxha/QNbOBpzZLxXpzkOgUT72V4YYuuVqwmCUf3h8397n1p9WFSQhDUhgJB3/ByxdnMGFL5/J4NJI64XKprYufPHjyZMRzMbo6Gq1fI6b+NWI0YTCZTBTAwSuYsHGdc35FDM+QGzTww/j58xenp9Ozk99evJ0wf/mtLXu3ckutOra1A611Isu1cU1V2omaqOaSBE/bYSL1PbID7gEhCoJL5Cka+7TcADJhMUxYDWbC4CfgCeXh1OlLVNVE7U9UboRye41hh5R5e/v7Xahv+BU/9SHvwO0NrgOilSXELUp+zYWDObpk6UHeE2LZwxk337AZOQL8dxO8MoA981j/DhIV/RDwXyYqGEtPRK2hG26oF2mJh1Iv9mjp/i/+tpuhW+o03JL9+xI1fbYTBvnIl1nI7sKQCwc9wTYL7JimIcUrlDrPULm6YH2EgqIyN9rpRMsqHo1KUlXFJeVetaXteWGdzhoV9BZjBPFacxb3asKZfs59A/Vm0h2kfsOoP+nH125f/6uzs3fQ6qkiRtb09bV4t4w7DUxEc3RmoEfC1+/88wfdTXpKBl1Vy/vVVUVhatjolHg0gPScVLKZT5JfmxPjmz/PKEZ+GT1t+dn1FcuDriISnhqcG7TL+yrxjyhzvX1vOi1yNBa7x8DOEOVOWHd1FFxiXcZ9k6jPVy/R3fb6CnvroQM/tL/pwE47+i8/5tbudHjjRrnkwh8ffSWUdSGeM54LctoRi9hmMbKIUd6GxDxnZTnjFj8YWVU0HC6oVKQ7XbPLhEtc+dew9oWWeapoSsx3wogFDvM7BIFxkqBn0UZq6yDQI5yXLyjJ6IzU6f5tqtV/Oi+5XK06ussyrAikSPwQjPANwb/bVv8AUTVM1g== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of annotation layers (annotation-layer)'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index aec9ca0e21a..1d2403b4f95 100644 --- 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 @@ -1 +1,259 @@ -{"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"}}} +{ + "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 index 91aa5e35dc6..08b70e83dbe 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzdWW2P2zYS/isEUaAJqqx3t8khUNEP2700TZomQey0B6wXKi2NLWYpUiEp7zqG/vthSEmmbNnxpgfkkE+2yJnhPPNGcrimGZhU89JyJWlMn4M1hBHBjSVqTtKcaWsiUhkg77hRkihNXo7fvCYfK9ArUjLNCrCgDZkrTeZcWNBcLiJilLbuT8kWXDIUT5jMiKMzICDFaWJKSPmcpyRVoiqkcTQFWJYxy05oRDcr0PhqTVMlLUhL4zVlZSl46iSPPhjUfk1NmkPB8F+pVQnacjD41UjHv9xC4f7YVQk0psaiwrSO2gGmNVvht0fTZ9oROyhJlXpwfMlEBU53uXozd4AaGlkVM9C0jna5upGZUgKYdEOdQv9M0vUO7Ou6jqiGjxXXkNH4ymH0iFr9rzseNfsAqR2y3Q2s+oYDWRUoDiMrad0RUaUz0MG3YDMQwXcQnSEVCrHcCqARlUqGOu33Z7jWsNscQcY1BqcPqFZtZtJGm8GlSraAQCSXFhbOCW4mMfzTnmmfCckXxGe97YWIeovEdAE2cSZq0qFGYo7p7bIWbcYKJPxI62v0timVND6kz09PfWR/YZ5VnqlfVSY5EKssE0RDqnRGHB1RktgcyIylNyAzGu2E8KD79yR34jENLR2MuPKDi3omgkwn5C8uBJkBsZpJI5iFjMxWZIaxSCMKd6wonWEvyGueHpJHd2Jjx03oiszsKnrRFV2MAMIzX3bnlSC3OUiyUhXJlPzekhupbkMMHE13fFnrp9j9ren4/yd2HJJ0nAV7VeSAKTcl4x722RSXAcluglhFNMgM9PGYX6FKL5wWAwWkXwcPIGJCqFvIuv3SKrfV3guhBlOJPWnq58hcq8J5ZQHWr92Wjn1bIUtzSCwvQFVOtKyEYDOEbnUF0UDtS5F73pSWJAPLuDAHWDeAGk7IktnqOIacyUVH3td8zrWxXbwX7O4VyIXNafyvxwOSeDZcyAU7WsjWBhusH4rZ2WU39f0ST2XvwNiLkp+0xf7kvWnM2mHt9NHAsjdSrLx9Ahpnd2FZklcFk/wTZJ8lt7b4HE1l02ESDZgf37wXzmgP7AE3NDRHuiFjJp8pprOB/OvmNqUrwP/k9DT6fJYMW/XAQWPYBP9uVXE7OLPMqEqnkHjxn68LAQtaLrFwZ/fYoyP0UnqYz4/CHMiotBheJiySRxSb8NBSMH0DWaZu5aBoyLjdu+5c6SJB/QZn96UAN0nBJMNUhDsLWjIhVgHp5hbhw9ywJWQJcxbGFfEfWgUeYTGnR5gwEPOtZ/a526tvZXMt/HaB/ujvLpoVx+3IRvAmXbez8MkxWejZ9yWC9bw7JQ/mrBI2AZmVistDp47gLISzexU9bOCA995GHX8UbOI0c0osBuJnX0R8sVXbothcYs+i8+jH6PH1/Sv6hHl5eVXMJONir6f2jlceXFdg3MAREJb802BtPwL/fVEeccWugwN9d9k923tN7V2ljrg8tlfDqxbD9cBtbVDo4E1q557Ukxvccvp3k62rSMjUXhyu1tgn2t4aqZPgrw5/qAwEavD4H/UTCjCm31o5dCsMfNMx0l9YRjCJwdiYvJBLJngW9i1LrZY8g4wOAAp4PZazr4vlvWSVzZXGE2JMLiqbg7TN+qSrVANAQkaH5Pz8ayMptUrxcyaAIAq7ismf6ByPBrRWegjKpapERqSypJHQcONST752sL2Q/sRFDOglaI8iJheSVBLuSkixPeAGiUrTSu9x168Me2WtCbBLmFYaMWKf98MtZuA1du78PnLl65nBDL17lKoMxk413zEXTC5oTNP37161/dXNpz/54nelBXn0H/L82YRMaW5tGY9GQqVM5MrY+Onp06cjVvLR8mzk3gRGU0qm06kk5NFvZEovmuhyho7JL8A0aPLdxeXls/E4mbz5/dnrKXUd6EadtyubKxko1A10KvGiVNq2+WemcirbTiX5uRvG8v0A9SDH6h156hxYBtr8vN7SfkpjMqUNgiklPxCWYpglVt2ArKfy4VSWmkv7oNXmBAPrwcOHIb6XbMnGzqMBxt7gxvRKGoTZQWO3jFsyB5vmDtl9cK174OL2m2z7CFH+3bpp7RFOHMC/PUeNP4j2p6n0GuJNpNNuC3tDpAScCLV4gKQPf3LN5QJsrjLflHbPObh9077uaA2XLz5i3SFiGDPdzpRXOE0yWIJQZQHSNpnnfOEFrUutrEqVqOPRaI2i6niNoVXvSLusjFVFKwLfOzTHAtUe1pyY4OjZqIl9vuadoPnEH5ePffm/TSZvSSenjihq05fX4d1RbuxLCs7h5o8vcS/eumM69v96QgZN1fA76rpG37RlZYwF0YN0xWVNZy4yfm1Pay//mqCPHBleId3spo3pQNcRMica5hpM/qVC3EPFXO32JsdVCdpAeIoLhjB2PN3yzJvE2IL567o/KD0Hu/OuuW2iYOf4/3sIbcyEzZBRKRh357vmvO2z6oqykqMxzqhrx7muMAahj7Irul7PmIH3WtQ1DvuOLmbcXivsW/cGVu75qHvSpC7Z23xx+1NEfRVyK3iGizQFV/xarp3tuVcynj/DiMGTS9i/aOOm+RM8fTK5CmSv157ClzVMdq+Eq+PuobP+L9aiyWc= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of charts'} +> +Gets a list of charts, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. - -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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 694eb8d780f..9413d8ba5fc 100644 --- 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 @@ -1 +1,165 @@ -{"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"}}} +{ + "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 index 8dc4b1051ea..3e2261cea54 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzlWG1vEzkQ/isj66QrutC0CE5oER9KBQWuB4iE46SmCs7uJDH12ovtTRtW+99PY+9ud5NNaeEkTrpPydqe8Tzz8oztgiVoYyMyJ7RiETtBZ4GDFNaBnsPxaAQO00xyh3YAuUV4L6xWoA28Hr19A19yNGvIuOEpOjQW5trAXEiHRqjFAKw2zv/J+EIoTrsAV4lfZlFiTLNgM4zFXMQQa5mnyvolKTqecMf32YBdb8Cis4LFWjlUjkUF41kmRewVDz9bwlAwGy8x5fQvMzpD4wRa+qq001/hMPV/3DpDFjHryF5WDuoBbgxf03cA0xXaUturSWemd3zFZY7edrV+O/eAqjUqT2doWDnYlmpGZlpL5MoPNQb9mKbzLdjnZTlgBr/kwmDCojOPMSCq7T9vZPTsM8auz3cXuO46DlWekjrKr2kdjgHTJkHT+pZ8hrL13crR9ipS4oSTyAZMadW2aXc823v1h80vSISh5AwJVZvNbVxZ07tVxhfYUimUw4UPgp+ZWvF1x3SohOl35Ge5GYUBCx6J2ALd1LuoKoeSFgsqcl+05DOe0sIvrDynaNtMKxtS+sHBQcjs76yzPAh1uWW8RHDacQkGY20S8OtAK3BLhBmPL1AlbLCVwr3h31Hc04Cpb+vWiKcf2jQIAQntw0chJcwQnOHKEuMlMFvDjHKRDRhe8TTzjj2CNyK+SR/byo2tMFEoErtt6FFDvZQBIJLAuvNcwuUSFax1DolWvzq4UPqyjUGQ625Pa90Su7s3vfy/4sc+TbfzYIdFbnDlNWXcwT/X5NKj2U+A02BQJWhuj/mUTHrlreghkC4P3oCIS6kvMWn6pdO+094JoUGbyx1lGuZgbnTqo7JAF/auqWNXK1xytcBkOltvz82Fsa7JqJRfnaJauCWLfn/Y4wqR9FOl5LdWstHCWvu31Wz1sWsGPbZ2XB1+3qN1R5nYr0l1/4MN9tSItZomKB2fLvOUK/EVvf0GefJWyTWLnMmRlhuk5PifOOiQtSCHnjHXJuWORSzhDu874TdTuZR8RirJTT1gY+s99M11u5xSn2H7HPPg0cE3Lbihzd7gg1u067JFDk3jPNzZ8jq0fItGVLeZsxrJeQ/z9yrtZeUtzu3obTFml+c2aK0tVJPQWUFnzm6vZxHzGgIN/akTlGTBwx86m6RobfeYdlOHacWmEWTPeAJUN2hdBK/UikuRtK9AmdErkWDCegC1ZAOWw5+L5YPiuVtqQ4QVwVHulqhctT805NADpC3okTx48LORZEbH9DmTCITCrSP4i4IT0KAx2vRBOda5TEBpB5WGSpq2evSzk+2VcmgUl2DRrNAEFBEcKcgVXmUY01HDD4KO49zsCNcLTufu2gV044hzQxjpzvj5kirwnG4Bji98hdLFv6Y1S4V6dT/WCY68heESLrlasIjFH96f1le260+rcxOT/XFuJNz/G06ej2HCls5l0XAodczlUlsXPT54/HjIMzFcHQ5ja6c1UQ8nDCaTiQK4/xIm7KjKNe/2CJ4hN2jgl6Pj4+ej0XT89o/nbybM320rq96t3VKrll3NQGOZSDNtXF2NdqImqr4DwdNmmMh8j+yAO5o/CEJL5Aka+7TYADFhEUxYBWTC4DfgMeXe1OkLVOVE3ZuozAjl9mqj9inb9u7da8N8zVd85MPcgtoZvA6EVpbQNgj5JRcO5ujipQf4HfCKDsao/obNiBHYT3XQigB07HF+ChIl/RDoJxMVDKWXn8bIDRdUi7TEfakXe7T03hN/iU3RLXUSLr/+2YgaPOuFQL7xJRWyOTfkul4PsM1iOqVpSHCFUmcpKlcVp49MUFRkRjsda1lGw2FBqsqooHwrt7Qd59bptFZBzytGEIfVx2uvJhzT59w3S28mXSuqZ4nqk358rXb1vxyP30Gjpxwwsqarr8G7ZdwosA7N0fmA3v1evfMvGnTd6CjpdVUl71eXJYWoZp4RcWYA6fmnYDOfIC/qA+Lrj2OKkV9Gr1V+9vrW5EGXAxKeGpwbtMvvVeLfReZ6+yo0yjM0FtvHvdYQ5U5YtzoMLrEu5b4hVGepE3S7HlM3PdXqMf/VR9jKZw6v3DCTXPjzoE/3oqq0M8YzQZ45ZP7M3lQbGzBKzJB5Z6woZtziByPLkobDpZKqcKdLdm1/gWv/gtW8qjLPA3UN+bY2YIGg/A5B4CiO0dNjLbXV1TtscvKcsogOPK1W3uRS9af1+srVuqW7KMKKwHhEAMEIz/T+rbX8B5CFK2Q= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of CSS templates'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 97e136baccb..568a83aa33a 100644 --- 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 @@ -1 +1,70 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"ids":{"items":{"type":"integer"},"type":"array"},"result":{"items":{"type":"object"},"type":"array"}},"type":"object"},"example":{"count":1,"ids":[1],"result":[{}]}}},"description":"Dashboards"},"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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "count": { "type": "integer" }, + "ids": { "items": { "type": "integer" }, "type": "array" }, + "result": { "items": { "type": "object" }, "type": "array" } + }, + "type": "object" + }, + "example": { "count": 1, "ids": [1], "result": [{}] } + } + }, + "description": "Dashboards" + }, + "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 index 6e26b202908..a993cac0028 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzNV99v2zYQ/lcIYg8JpsZ1sQGBij6kWZomK9qiTrcBkeHS1NlmQpEsSblxBf3vw5GSItsyhrYP3ZNE6u74ffeLp4rm4LgVxgutaEovwTvCiBTOE70gOXOruWY2dwkpHZAPwmlFtCXXk3dvyecS7IYYZlkBHqwjC23JQkgPVqhlQpy2PrwYthSK4RGEqZwEOQcSOH4mzgAXC8EJ17IslAsyBXiWM89OaEIfT6DpbUW5Vh6Up2lFmTFS8GB5dOeQQUUdX0HB8M1YbcB6AQ5XjXV8FR6K8OI3BmhKnUfAtE7aDWYt2+A6stlW2jM7aEkbO7i/ZrKEgF1t3i0CoUZGlcUcLK2Tfa1uZ661BKbCVgfoxyxN92hP6zqhFj6XwkJO09vAMTJq8U87HT2/A+6HfHcPm23HgSoLNIfZNWvDkVBtc7C9tWRzkL11L0P7UmjECy+BJlRp1cd0OJ79s4bDFgRyYTE5Y0K1sJnjDZrBowxbQs+kUB6WIQjhy8yJrwc+x0qYfUd+1rtRSGj0SEqX4GfBRU051CgssMRD1aLPWIGCn2k9xWg7o5WLKf3s6dOY2d9ZZ2VU2mcq8kF6PYndeFlwpfRDSofybs8ndULhgRVGQg/duAFzO54+HnJbYerXyU5P/KNrgmjrtx9yTgHObedJG9v/wN0p0pcsJ1ic4HxKrtSaSZH3m7Cxei1yyOkAlZ5u5DL+uVw+Klb6lbbiK+QpOSv9CpRvziddBxog0lcMTJ49+9lMjNUcl3MJBFn4TUr+wuBENmCttkNUznUpc6K0J42FRhuP+v1nJ9uV8mAVk8SBXYONLFJypkip4MEA95DHTaI5L+2BcL1insnOBdjyeGmRI15ad1+w9qbYhjxbYlH2S26a0IcnXOcwCfDiCCCZWtKU8o8f3rQXxuPS6dJyBM9LK8mTf8jlxQ3J6Mp7k45GUnMmV9r59PTp6emIGTFaj0fdoDPKKMmyTBHy5DXJ6FmTZcHhKXkJzIIlv5ydn19MJrObd39evM1ouFYbSO83fqVVD1S30cEShdHWt3XoMpWptv2SF932yRL8EeIg34I9iRorYDlY96LaYZDRlGS0YZFR8ithHFNu5vU9qDpTx5kyVih/1CI6wSQ7Oj7uc7xmazYJ0e3x3Np8DIFWDql29NgXJjxZgOerwO5buVVbBNN2TXZjhUw/teGqIsubQPJT1KjxgYyfZyqixHGzQ7jDvxHSEk6kXh6h6PHzcHMW4Fc6jzdumFX9iqZ0Hz96JdRQzODSotMGudPd6nmDn0kOa5DaFKB8U40hJtFQZaz2mmtZp6NRhabqtMI0q/esnZfO66I1gQOdFdi02tk2mMH3HBYs3IsBJk26QahZ4iPU57b91zc370lnp04ootm21/HdAzeJbQa/4XyCvxpX78MMpe2OkUFXNfpBuq4xPm2rmWCTjCRDw6noPGTHK20Lhvau/77BGAUxnI/DV9o1ykC6TlB5ZmFhwa2+10iYxBY60tlCXxqwDvpzXG8LcyfKrcfRJc4XLNwAzSx3CX7w523XTb0b5f/5x9e4y8ODHxnJBP7wxEyvmgq7pcwIdMoYybWgaUIxIWPG3dKqmjMHH62sa9yOky9W30FvHDr7HjZhVu7+32go/rZ2wv2V0NiVwglR4YxzCA2x1dq7vrdayOUFZg9ONr07u8uh5qX3n8fUpme7qqJEbHNY+BFE6O3hr67+FwQIf9U= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of dashboards'} +> +Gets a list of dashboards, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. - -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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 922430deb3d..2ade9c0045c 100644 --- 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 @@ -1 +1,193 @@ -{"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},"configuration_method":{"maxLength":255,"nullable":true,"type":"string"},"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"}}} +{ + "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 }, + "configuration_method": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "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 index 44241282322..42cc2023ec9 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzdWW1v2zgS/isEccC1ODVugu2h0GI/ZHvdbru9tmjS2wPiQEtLY5sNRarkyIlX0H8/DCnJkiVn4+4BPdwnm+TMcJ5545CqeAYutbJAaTSP+StAxwRT0iEzS5YJFAvhwEWsdMA+Smc0M5a9uXj/jn0pwW5ZIazIAcE6tjSWLaVCsFKvIuaMRf+nECupBe3AhM6Yp3OgIKVl5gpI5VKmLDWqzLXzNDmgoM1PeMR3O/D4quKp0QgaeVxxURRKpl7y7LMjABV36RpyQf8KawqwKMHRqJFOfyVC7v/gtgAec4ekMK+jdkJYK7Y0DmiGTCOxk5JMYSfnN0KV4HXX2/dLD6ih0WW+AMvraMzVzSyMUSC0n+oU+nOSrkewr+s64ha+lNJCxuMrjzEgavW/7njM4jOkOGW7G9gODQe6zEkcBVfSuiPixmZge2MlFqB6416A9qlICEpUwCOuje7rdNif/b2m3eYJMmkpOENAtWoLlzbaTG5ViBX0REqNsPJO8CuJk78fWA6ZkHxFfNb7Xoh4sEjMV4CJN1GTDjURS8pwn7VkM5ET4RdeX5O3XWG0CyF99vRpiOyvzLMyMA0Ly+UaGBoUillIjc2Yp2NGM1wDW4j0BnTGo1EIT7r/QHInAdPU1r0ZX35o08DEiOmE/SqVYgtgaIV2SiBkbLFlC4pFHnG4E3nhDXvO3sn0Pnl8FBsjN5ErMjdW9LyruxQBTGah7C5LxW7XoNnWlCwz+q/IbrS57WOQZLqHl7Vhih1vTc//X7HjlKSHWXBQRe4x5a5kHGGfXXGZkOwXGBpmQWdgH475Lan02msxUUCGdfAeREIpcwtZd16i8UftUQgtuFIdSNOwxpbW5N4rK8Cwd1s6DhyFXq8kReFHulRKLAg32hKi8QnW0m+Oo89ydQz5UipIykIZkR3DlpcKZZIKFMqsiNGCyN5rtQ2MHZ0tdSLcVqdHCHdJahwm4FDmAuGwdJe4chGMfg/NRloshUqQtk7grlDGTgttq+zUWroWegVZstiOHbuU1mFXDnJx9xb0Ctc8/vt3E3GsxIOJ9/qM3j59MaNmY3fM/aPpTz+Cw/NCnrTH3sknF06PFlY4s5bG5gJ5zDOB8ASl3+iA13aAdjKSDBSKZF3mQsvf4YAljV7KVWn9cZnkgGuT7Zni7Nmzh+xrgWrJ/5NLTv2J3lBMaXT27OmE/pl0PriJMyksbCTcTtq+I7RSqQRNkgEKqSZpQa+khkTqEBVNtzcmCwmVdFrLabfDXWFoVSfuCzn2YQUB7tCKe0h3Nlgam4Kvrsmu9dq33B9KCcqPm9CyDCtdhviJPxS4Fy1Dz35FkDygx617J2rXbZ4e7BMHvcwDure2N7tqMV5PtEuTQidbmVGjMpDbazOGzcFeL9Bnak/uq4ouasMGmcfcSwhn9z9NBoo0+O5PNfQ5ODe829zXlvV80zHyH0XGKE7AYcxe641QMus/HBTWbGQGGZ8A1OMNWE6/LZZPWpS4Npbqf8zOS1yDxmZ/1iXDBJA+o0dydvatkRTWpDRcKGCEArcx+xc5J6ABa42dgvLClCpj2iBrJDTctNWzbx1srzWC1UIxB3YDNqCI2blmpYa7AlLqz/0kM2la2gPu+ol6v84EdE1PS0sY6aHl8y1l4DVdnVGsfIa2JY1y9O5JajK48MqFRysl9IrHPP308W37xLEbOlPalFRPS6vYk3+zVy8v2ZyvEYt4NlMmFWptHMbPnz5/PhOFnG1OZ22pnc05m8/nmrEnP7M5P29CzFs7Zj+CsGDZX85fvHh5cZFcvv/l5bs59+9AjUYftrg2uqdTN9FpJfPCWGyT0M31XLfvBeyHbppq+CPSgx2hehQY1iAysO6Hag/AnMdszhsQc87+xkRK4ZaguQFdz/XjuS6s1PioVeiEAuzR48d9iG/ERlx4z/ZgDiZ3DjDaEdIOnbgVEtkSMF17cEdCqwb44nbM9j1FQH9rnVUFkJce42+Bo6YfAvz9XAclaatOwT34DZFRcKLM6hGRPv7eP/S07Sg9EPmnVWod+Eh9sonPnhC9pSWTTSLn+3nzlpZZBhtQpshBY5OH3iNBUFVYgyY1qo5ns4pE1XFFMVaPpL0oHZq8FUHPj1ZSuWqvn15MuMYuhT8XvZp07W6e7Zoh/TjKzaH8ny8vP7BOTh1x0mYor8M7Uu4iFBhao1aAHsZff/AvfnQdHwiZNFXD76nrmtzTFpkLKo8BpC81FV/44Pipbc/e/HpJPvJk1FH61d2rggddR8ScWFhacOuvFeLfDZdm/FRwURZgHfTbut4UxU6g25wGkzjMha/9Tdv0CnDqS8O+lXpHyf/k14nGWAh3OCuUkL7n83FeNel1xUUhySSnfHf54RGnaAzhdsWriiY/WVXXNN1c+q+qw7Y4tPUNbP2zbvepgfvEbxPHH1sRDxXJ7xAYztMUfC1suUan9qB8vHpJoUMNTe+o7gKo+dP7JCH0tie7qgJFKHGU9UEJX9b9B4j6P81SRuA= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of databases'} +> +Gets a list of databases, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. - -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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 011f07c6947..91d13ebb47a 100644 --- 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 @@ -1 +1,194 @@ -{"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"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"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"}}} +{ + "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" }, + "uuid": { + "format": "uuid", + "nullable": true, + "type": "string" + } + }, + "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 index f8a4841c4ae..92cea396ecf 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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/D0dKimTLrdMN6LBPEsnj8Z574/HWIkOfOlWQskYk4hmSBwlaeQI7h0yS9Eh+BKVHeKu8NWAdvDh5/Qo+luhWUEgncyR0HubWwVxpQqfMYgTeOgo/hVwoI/kAkCaDQOdRY8rL4AtM1VylkFpd5sYHmhxJ8tkHYiRuThDJ2Vqk1hAaEslayKLQKg2cxx88y78WPl1iLvmvcLZARwo9j2ru/KsI8/BDqwJFIjyxwKIaNRPSObnicUTT37TFdpCTLdzg/KXUJQbZzer1PACqaUyZz9CJarS9q52ZWatRmjDVCvTPOJ1vwT6vqpFw+LFUDjORnAWMEVEj/3m7x84+YEpDurvAVV9xaMqc2bFvTRtzjIR1GbrOWMsZ6s64459dKmZCijSKkTDWdGXabc/uWcNmCwSZcuyc0aEasaVPa2kGjyrkAjsslSFcBCOElalXf+1YjpEw/QL/rDatMBJRI4lYIE2DiupwqJhYcYCHqGWdyZwJP4rqnK3tC2t8dOmj+/ejZ39hnJVxUz+vnC4RyJLU4DC1LoNAB9YALRFmMr1Ak4nRlgsPmn9HcE8jpqGjOzMh/fChcRPwpgN4r7SGGQI5abyWhBnMVjBjXxQjgdcyL4Jij+GVSj/FT2z5xpaZ2BSZ3xb0uE277AGgsph256WGqyUaWNkSMmu+Jbgw9qqLQbHq9k9r/RC7vTbD/n9Fj0Oc9tNgL4t8QpU3KeMW+rlJLgOcwwKQBYcmQ7c/5pcs0vMgxUAC6efBTyCSWtsrzNr7kmy4am+F0KEv9Y4wjWswdzYPVlkgxbOb1LHrKpQktV3wby6vX6JZ0FIkRw8ejoQptZYzVgK5EgfAp0tpFphNZ6ttvnPlPLXe2GH98PsBTiobTrNa7s1k4/rrnN9ls3UH3mTfn2LV9BY9HRfqoEnGB+98lOUGbSuRQ5m9NnoVNdShsWaaoSY5XZa5NOovzD5HXlI6SML11Ex63NZwszKkn6MH92+h5bKMK3PrckkiiROfdYANjffl+QJF/9RArWF7W7oUp5HNkGpwLktNUzRZYVW8vz7rs73I2YMerwttHU5LpweFwGtyci9Ou7R/ocywd9grU5ex/+fQOgzlVFuX9Jz4wR5JyH/Ue6mfeHX/WPl3Y0L0zr+9pvYoI6vOpdUWdIc7S7FeubBHgdSUP2cN1POBimSQ6WC1sFUL9Ph2bvL+/btx3XY3NZfj2ZrfQpuRLgKHeD3+ZjPULMH3/6hmztH7/vPhU5VPxzbtRvGjzIDdBT0l8NxcSq2y7tu8cPZSZZiJAUCdvRHL4dfF8s7IkpbW8WWXwHFJSzRUnw9tTAwA6W4MSI6OvjaSwtmUhzONwCholcDvbJyIBp2zbgjKE1vqDIwlqDnUu/moB1/b2Z4bQmekBo/uEl1EkcCxgdLgdYEpl8BhEmyalm6HuX7mgrFVAb+E09IxRu5lfLjiCDzn1ynJRYjQOqN5jtHre6nN8CQIF/tCWpqFSET67u3LpotwM4wFAI9Lp+HeH/Ds6SlMxJKoSMZjbVOpl9ZT8uj+o0djWajx5eG47n2NJwImk4kBuPcLTMRx7WFB2Qn8iNKhg2+Onzx5enIyPX3969NXExE6LbVAb1a0tKYjUjvRCqXywjpqYtBPzMQ0L3J43E5zCr/DcsD+ko8i/RJlhs4/Xm/IPxEJTESNYSLgO5ApO9uU7AWaamLuTkzhlKE7jTwH7F537t7tInwhL+VJsGsHZW/yRv3WeAbagpNXUhHMkdJlwHY7ZOsevKQZw6adGOefjanWEeNpgPhn3FHxh/H+MDFRRj6plW8DfU1kNR5ou7jDpHd/CI2UHGlps9iACa1LLgvEpvSskRA50XNDQTiMW2zGzEtehgwvUdsiR0N1DAZ7REbrwlmyqdVVMh6vmVWVrNnBqi1uT0pPNm9YcHfPKU5VTakY2MRXYiiQazH5VVt3xeohf0Jc9vn/cnr6Blo+1UiwNH1+Ld4t4U5icuE1LgO47/z8TWio8Wu3x2RQVfX+QF1VbJ0mwZxwaowgQ5pZi1nwjZ+bCu3F+1NRl5KhWRpWbx7tAXQ14s1Th3OHfvmlTEJbbm63X+InZYHOY7ei60yx70S6y8OoEk+5jO+QWDI9Qxro428qqXOL/Bdb/7WqCK9pXGipQrVXv59ibJ0JWShWyKGon3pBP+yK0dfOxHrNdfM7p6uKp2MXg+NupyZ2nXyBq9Aybdv4IgR9EzXhvhqJmI3CCXHDcZpiSIPNrq3rupc6nj1lv+FKpnNHt95T/3Ta/dKsOrzX60gR0xuHfBQiZPTQ3K/+BsgXAnI= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of datasets'} +> +Gets a list of datasets, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. - -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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index ed4913e6f96..d57d576b970 100644 --- 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 @@ -1 +1,162 @@ -{"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":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"},"username":{"maxLength":128,"type":"string"}},"required":["first_name","last_name","username"],"type":"object","title":"LogRestApi.get_list.User"},"user_id":{}},"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"}}} +{ + "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": { + "first_name": { "maxLength": 64, "type": "string" }, + "last_name": { "maxLength": 64, "type": "string" }, + "username": { "maxLength": 128, "type": "string" } + }, + "required": ["first_name", "last_name", "username"], + "type": "object", + "title": "LogRestApi.get_list.User" + }, + "user_id": {} + }, + "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 index 97aeba54f3f..ef24865013a 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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/isHYsASzI2ToB0KFf2QBm2XLmuLJlkHxIFLS2ebDUWqJJXEFfTfhyMlWbLl1GkHdJ9s8eV4z708d2TBErSxEZkTWrGIvUZngYMU1oGegtQzO4DcInwQVivQBt6cvXsLX3I0C8i44Sk6NBam2sBUSIdGqNkArDbO/8n4TChOwoGrBPw6ixJjmgabYSymIoZYyzxV1q9J0fGEO77HBmx5AosuCxZr5VA5FhWMZ5kUsZc8/GxJ94LZeI4pp3+Z0RkaJ9DSVyWd/gqHqf/jFhmyiFlHCrNyUA9wY/iCvgOa7qY1sb2SdGZ6x2+4zNHrrhbvph5QtUbl6QQNKwfru5qRidYSufJDjUI/JulqDfZVWQ6YwS+5MJiw6NJjDIhq/a+aPXryGWPXZ7trXHQNhypPSRzF1bh2x4Bpk6BpfUs+Qdn6bsVmexUJccJJZAOmtGrrtNmf7bP63eYXJMJQcIaAqtXmNq606T0q4zNsiRTK4cw7wc+Mrfi6YTpkwvg74rNc9cKABYtEbIZu7E1UpUNJiwUlt89ashlPaeEXVl6Rt22mlQ0hfbi/HyL7O/MsD5u6nHI+R3DacQkGY20S8OtAK3BzhAmPr1ElbLAWwr3u35Dc44Cp7+jWiKcfOjRsAtq0Bx+FlDBBcIYrK7nDBCYLmFAssgHDO55m3rBH8FbE98lja7Gx5iZyRWLXFT1qKJciAEQSaHeaS7ido4KFziHR6lcH10rftjEIMt32tNZNsYdb0+//T+zYJ2k7C3ZY5B5TLinjAfZZkkuPZD8BToNBlaDZHvMpqXTiteghkC4P3oOIS6lvMWnqpdO+1D4IoUGbyw1pGuZganTqvTJDF86uqWNDKeQNZab87hTVzM1Z9OTgcMBULiWfkA2cybEHe8LtfKK5ScYiIQEbNrRYM3EupZVTbVLuWMQS7vCRE6mvB988LzeezcYBx7ePq1nvm5INTtEYNCtmONg/fLyFXlaKGLe2QW7DOV03TIWxrknelg6/P+45UfIHLKYDe9YeHD7tS9l2C9FSqn1mS+RaS7EsZqd69gGtO8rEXl3X9i7s0gbBYPeVwx4JW5TTspW8TWE72FiSOrS5RaGoy8BlbbSrHmbuFdrLmmuc2JHbYrQuD63QTntTTRKXBfWE3VrMIuYlBJr4SycoSYPHP9Q7pGhtt426rwK0fNNsZC94AhR4aF0EJ+qGS5G07yiZ0TciwYT1AGrtDVgOfi6WC8VzN9dGfMUkgqPczVG56nxosqsHSHujR3J4+LORZEbH9DmRCITCLSL4m5wT0KAx2vRBOda5TEBpB5WEajcd9eRnB9uJcsReEiyaGzQBRQRHCnKFdxnG1Ar4QdBxnJsN7nrFqS+uTUA3gjg3hJHudJ9vKQOvqEt3fOYzdMlmlKV3j2Kd4JlXL9yQJVczFrH44sNpfZ9aflqdm5iUj3Mj4dE/8PrlOYzY3LksGg6ljrmca+uip/tPnw55JoY3B0OpZ8MRg9FopAAe/QEjdlTFlzd1BC+QGzTwy9Hx8cuzs/H5uz9fvh0xf9+slHm/cHOtWuo0A41CIs20cXUG2pEaqfpeAs+bYSLwHdIDttN6ENbOkSdo7PNiRfcRi2DEKv1HDH4DHlOYjZ2+RlWO1O5IZUYot1PrskeBtbO720b3ht/wM+/RFsLO4NLsWlkC2QDjt1w4mKKL5x7X9qiKDrSo/oZV/xDGT7WLioDv3MP7FHaU9ENYn41U0I/eXhrdVpBXi7TEPalnO7R095m/Rqbo5joJ10//cEPdAWtrTpbwuRIiNTdkqF68bDVLTmkaErxBqbMUlauyzvshCCoyo52OtSyj4bAgUWVUUFCVa9KOc+t0Wougdw0jiJzqvtaLCf3xlPsq6NWkfr56D6g+6cdSHnbl/3F+/h4aOeWAkTZdeQ3eNeXOAp3QHBV+enE7ee+fEqjP7wjpNVW1368uS/JMTSlnRIYBpCeWgk18XLyq2+g3H8/JR34ZPRP52eV1xYOmfvjWjQ1ODdr59wrxDxJTvX4HOcszNBbb/VtriGInrLs5CCaxLuWhOQ9N0mt0K6+XqwZq1Yz/22NnZSKHd26YSS58X+eju6jy6ZLxTJAhDohr9IwNGIVfiK9LVhQTbvHCyLKk4XBno1zbaIFNp17jwj8QNY+WzCd5nSm+Kg1YYB9/QthwFMfoKa/etVaUO1Tx+iXFCvUrrUrcREz1p/W4ydWiJbsowopAZ5TmQQnP3v4ps/wXRKvqxg== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of logs'} +> +Gets a list of logs, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. - -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 index ad384af5708..085f2366f87 100644 --- 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 @@ -1 +1,18 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index f6ed85c127b..7da14f69fa2 100644 --- 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 @@ -1 +1,150 @@ -{"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"}}} +{ + "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 index 3f3dadd142d..badaa6a613e 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of queries that changed after last_updated_ms'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 16bca413c22..6133b66d75d 100644 --- 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 @@ -1 +1,159 @@ -{"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":"User1"}},"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"}}} +{ + "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": "User1" + } + }, + "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 index 8970a57ebe9..8d020274a0d 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzNWG9v2zYT/yoH4gHW4lHjptiAQsNeZH26rl3Xdk26DYgDj5bONhuKVMhTEs/Qdx+OlBQpkrO0G9DnlS3y7ni/+0/uRI4+c6okZY1IxQskDxK08gR2BRcVOoU+gcojvFfeGrAOXh2/fRO2tlBKJwskdB5W1sFKaUKnzDoBbx2FP6VcKyNZPkiTQ6DzqDHjbfAlZmqlMsisrgrjA02BJHNJ8kAk4uYEkZ7uRGYNoSGR7oQsS62yIHn20bP6O+GzDRaS/5XOluhIoeevRjr/VYRF+EPbEkUqPLHCok7aBemc3PJ3RDNkGomdlGRLN7l+KXWFQXezfbsKgBoaUxVLdKJOxlzdytJajdKEpU6hfybpbAT7rK4T4fCiUg5zkZ4GjBFRq/9Zx2OXHzGjKdud43ZoODRVweI4tBatOxJhXY6u963lEnXvuxeefSoWQoo0ikQYa/o67fdn/6xptwWCXDkOzhhQrdrSZ402k0eVco09kcoQroMTws7Cqz/3bMdMWHxGfNa3vZCIaJFUrJEWwURNOtRMrDi/Q9ayzWTBhBeiPmNv+9IaH0P6yePHMbI/M8+qyDQsKycbBLIkNTjMrMsh0IE1QBuEpczO0eQiGYXwpPv3JPciYpo6urcSyg8fGpmAmQ7gN6U1LBHISeO1JMxhuYUlx6JIBF7LogyGPYI3KrtLnhjFxshN7IrcjxU96qouRwCoPJbdVaXhaoMGtraC3JqvCM6NvepjUGy6+5e1YYp9ujUD/79ixylJ97PgoIrcYcqbkvEJ9rkpLhOSwwaQBYcmR3d/zK9ZpZdBi4kCMqyDdyCSWtsrzLt+STa02k9C6NBXek+axj1YOVsEr6yR4tlt6djXCjfSrDFfxPqwsq6QJFKRS8JHpAqcAs09fik9jqW1O10Y/l1M3BS//zWsh3wCmnwRTk/H/VHgNWYVYb7wF9NtXOXTRdvZKz+9c1MXR8L2HeIv9ILkUkfgDmX+1uitSMlVyNskHe3H4ElStcfrcrnPfImgooyn3kHiZHauzHpRuWnNK49u7LqVcp72S91nUy33c93h7Q8e3eGdFL9w3L5HT0elOmg74z3aad1L3q6xHe5tSYOyeY9G0baB0xbl2URlnhQ6WTVHNXEgt1fRhnXoVtnpM7VF4nTHM+GwF4tUBAmxTPxsc9Sswdf/aHYo0PvhGHVXB+j5pmMU38sceHZFTym8NJdSq7x/RymdvVQ55mICUI83Yjn8slg+GFnRxjr1J+YpHFW0QUPN+dAN6BNA+owByZMnXxpJ6WzGn0uNwChom8Kv7JyIBp2zbgrKM1vpHIwlaCQ03HzUN1862F4aQmekBo/uEl1EkcKRgcrgdYkZjwJhEWyWVW6Pu36QPBe3JuAbQVY5xsh3uo9XnIFnPKWTXIcM/SXeyTlFrx9lNsfjoFu8Hmtp1iIV2Yf3r9vL1M2nt5XLWPOschoe/Q4vnp/AXGyIynQ20zaTemM9pU8fP306k6WaXR7OQtefzQXM53MD8OhHmIujJryCpVP4HqVDB/85evbs+fHx4uTtT8/fzEW4bjbqvNvSxpqeQt1Cp5IqSuuoTUA/N3PTXkvgu26Z6/cD1gPuq3cSqTcoc3T+u90t7ecihbloEMwF/BdkxnG2IHuOpp6bh3NTOmXoQavNAUfWg4cP+/heyUt5HFzawzhYvDG9NZ5hdtDklVQEK6RsE5B9Cq7dAFzafsNtHzHKP1o37SLCkwDwj8hR8w+j/XZuooY8gHXa3cLeEFmNB9quHzDpw2/DTbJA2tg83kDD2w1tRCqGurM1QsLEiA3DxTRmcTtVXvM25HiJ2pYFGmpSL/giCtqVzpLNrK7T2WzHoup0x6FVj6Q9qzzZohXBjxtOdXNYKyYOySsZWmFQk4f65lGg+eSfkI9D+T+enLyDTk6dCNZmKK/DO1LuONYU3uPuz89uL9+F9wQe9gdCJk3V8AfqumbftHXlmCtiBBmqy04sQ2T80I7sr347Ec0kG96Kwu7N+B5A1wkzLxyuHPrN5woJrxIrO76IHFclOo/9Ma63xLET6S4Po0k8FTKU+2ZSeoE0fsW8baNe7/g/fPdsDEV4TbNSSxVGvGYSj3l1KmSp2ByHIukedjgMY5ydit2O70EfnK5rXo4knHN7zbDv3HPchtei7gVThHRvMya0qETEOhROiAxHWYah/LVcow49KBovnnPM8PDSa8td5DR/ei+d0mx7sne7SBELG6d7VCJU8vCuWf8FYj7zeA== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of queries'} +> +Gets a list of queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. - -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 index 7bcdc8bede8..9dcdf18c709 100644 --- 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 @@ -1 +1,76 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index ce04e8fb6a0..406b5b65c11 100644 --- 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 @@ -1 +1,111 @@ -{"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"}}} +{ + "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 index c177579cb02..5613d66571f 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzNWE1v2zgQ/SsEsYcEq8RJsQUKFT2kQZqmG7RFnO4uEAcuLY1tNhSpkiM3rqD/XgwpybJlN2166J5s8WP43vDNcMiSp+ASK3OURvOYnwM6JpiSDpmZMgu5schcMoe0UMCUmbmIFQ7YlXRGM2PZm+G7t+xzAXbJcmFFBgjWsamxbCoVgpV6FjFnLPo/uZhJLWgxJnTqhzlQkFAvczkkcioTlhhVZNr5IRmgSAWKQx7x1QI8vik3oF/PoYdXhiVwDi6A5xGXNDgXOOcR1yID+rrjEbfwuZAWUh6jLSDiZCQTPC45LnMaJTXCDCyvqqjkidEIGqlb5LmSiSc1+OQIS9mZnFuTg0UJjr5qZvRXImSuY94h+YpXUdMgrBVL+g6OXJ/UM7vVksnt1vaFUAV47Hr5buqdWY/RRTYhjlF/VtsyMUaB0L6pBfRrlm57tG+rqrsnN55jYNTgv23nmMknSHCb7+5gue440EVG5kji42Y7Im5sCrbzrcQEVOe7o7XuKDKCEhWQmIzuYtq9n921tm+bH5BKS4ERBNXAFi6p0WxdKhcz2CbZ0DN28uuO7hCF40fos9rchYgHj8R8Bjj2LqrDoaLBPv58wlgF4Gde3dJuu9xoFyT95OgoKPuRcVaESf0cgQaFYhYSY1PmxzGjKUWwiUjuQKc86kmYy9T1rZ20eVKZGaMh0U9EtQVXqB0YQx+bWpN5ZDPAsFbjtx15AHQ6ThEz+j81NhPIY54KhAOUmddooZSY0OaEJNdDCdYaO87AuVpJD86Q6Q5F1Un4AUQ9ew6FxV9k4VCgR5+J+0vQM5zz+OnRloFFEeC3y/iGH1ihzaA7Rq6k40eOrfkybkT7gPGNvLfhx4ZcL/mtwu7Kn4Jn95AUpKlLM7sChye5PGwC8geimLRwL7JcQSeejutIuGnA3q50fFNSzq6iDTlfkFKDkv0BXEX8r18K7Y42+477Hod2In8pUkYuBocxu9ALoWTarV5yaxYyhZRv4dOZG7gc/14uH7QocG6s/AppzE4KnIPGen3W6mgLke5Ez+TJk9/NJLcmoc+JAkYscBmzf2hzAhufm7ZROTWFSpk2yGoL9Wxa6unvFtuFRrBaKObALsAGFjE70azQcJ9DgpCGRmaSpLA7tuuVoGOrcQEd2ElhiSOVXJ++UADe0iGKYuYDNCQBNqyzh6NQvT9ITApDDzKU0EroGY958uHqsil6Vp/OFDYhCklhFTv4j52fXbMRnyPm8WCgTCLU3DiMnx09ezYQuRwsjgehAh8cD5SZDUacjUYjzdjBazbiJ7XcvOdj9hKEBcv+ODk9PRsOx9fv/j57O+K+OqxRvV/i3OgOrrahRSYzz7IOSDfSI91UEexF20x5b49wsJ+EH4VJcxApWPei3CAx4jEb8ZrIiLM/mUhIfmM0d6Crkd4f6dxKjXsNqEMS3N7+fpfmG7EQQ7/THaprjauNMNoR25ah+CIksilgMvcEH0GvXOMYN99sc8eI7Mdm08pA9Nrz/BhmVPRDpJ+PdABK97YW5IYL6kFGwaEysz0auv/cl4EZ4NykoXz0lz46vfkGhTK/qzwLco8PrCDowpL3tjqBb4bUJXWzFBagTJ6BxjpE/eYEQ2VuDZrEqCoeDEoyVcUlAah61k4LhyZrTNC5byVlsqZM82ZCuTcV/sT0MHnU1vb1J/34cF23//r6+j1r7VQRJzTr9lq+PXDDkHuoj0puurhfvPfXAmM3jGx1VT3fj64q2qUm/1CCyQJJn4VKPvEaedVUVG/+veb1bdpf+XzvqvDzpKuIJo8tTC24+WON+MvF1PRL6mGRg3XQrZE6TaSdMG5xHFziMBOhUgvXk3PABx5FNh3WOXD+528qtQcR7nGQKyG1L4utV2oIvRsuckl+OvavJF4DEY/9o4kyMx5xEmtQ4w0vy4lw8MGqqqLmcGHpvdZ0/bMLxB0s/dWwLba5Tw9NXAWj0lcLKY+nQjn4zi7sXdW10D770Zeiraiaslkvu8AatPldeMsI2dRDDB0nSQI+lzdTelXIWuo7PyO9U4HWKT1a1dd/Oo8t63DKMowI6blq0fljyT+tVN8Aj6Dm+A== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of report schedule logs'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index fabec4e77e3..f93a9678c46 100644 --- 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 @@ -1 +1,207 @@ -{"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":{},"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":{},"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"}}} +{ + "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": {}, + "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": {}, + "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 index e58b976c061..174e8d90e7e 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzdWW1v2zgS/isEccC1ODVOgs2iULEf0qLbba/bFkm6u0AcuLQ0ttlQpEqOnLiC/vthSEmWbDnnJAd0cZ9svsxwnnnjcFTyFFxiZY7SaB7zN4COCaakQ2ZmzEJuLDKXLCAtFLiIFQ7YmXRGM2PZu/OPH9i3AuyK5cKKDBCsYzNj2UwqBCv1PGLOWPR/cjGXWtBBTOjUb3OgIKFV5nJI5EwmLDGqyLTzWzJAkQoUBzzi6wN4fFnyxGgEjTwuuchzJRPPePTVEYySk8SZoH+5NTlYlOBoVHOnvxIh839wlQOPuUOSl1dRMyGsFSsaBzB9oi22g5xMbgfnl0IV4GXXq48zD6jeo4tsCpZX0TZVOzM1RoHQfqoV6HGcrrZgX1VVxC18K6SFlMeXHmNA1Mh/1dKY6VdIcEh317DqKw50kRE7crFJY46IG5uC7YyVmILqjDtu2t1FTFCiAh5xbXRXpt327J41bDa/IZWWnDM4VCO2cEktzeBRuZhDh6XUCHNvBL8ycfL7juUQCZMH+Ge1aYWIB43EfA448Sqqw6GizZLi3Act6UxktPEbr67I2i432gWXPj48DJ79wDgrAlE/vVwsgKFBoZiFxNiU+X3MaIYLYFORXINOebTlwoPm3xHck4Bp6OjOjE8/dGggYkR0wP6USrEpMLRCOyUQUjZdsSn5Io843Ios94o9ZR9kchc/vuUbW2YiU6RuW9DTNvuSBzCZhqw7KxS7WYBmK1Ow1Oh/IrvW5qaLQZLq9k9r/RC7vzY9/f9Ej0Oc9tNgL4vcocp1yriHftbJZYCzX2BomAWdgt0f83sS6a2XYiCB9PPgHYiEUuYG0va+RONv2nshtOAKtSNMwxqbWZN5q8wBw9lN6thxFYoE5dJrTBdKiSlhRltAtH178WQh9BzSyXS1zWcmrcPW+zJx+x70HBc8/vmnAbUpsffmjWutc06Xzdbdts6qZ74oOq9rojNweJrLgybXHnx2IWU14EKinBmbCeQxTwXCM5T+uB0aWsNa85ikoFBMFkUmtPxOopfcgkg/arUK5GG7xYmkRRpZIC/8/9PuEe+ge5R6iQddKRngwqQb6I5PTvbiYTSK6Qbt0eHh4e7N/8WMqXCLqRE2bU3ZC8+dkbU+B27RikHenuNA/eFtA0uhJili9nCVej4OBW76ysnhHtQDPnZ0MqRIc6Privwxfn2nMv4+/n4ccnUicwkaB1DvwhFmtsxwNwS/+nCBw/LZWlqSQ2bwnarzrSDZWa3fU+gmCmsX6qkreiSkPUruqnPBt8Xv0c6ytVda7VFMNqXiZQP/aqB6G2Q6WFlt1U09vp2qp1+rbJQmXaKmkLgs6d24mbC45xBKid9NCook+OlR74sMnOs/te6qEju2aQn5S5EyciFwGLO3eimUTLttjNyapUwh5QOAOrQBy9GPxfJZiwIXxtKVErPTAhegsT6ftXEyAKRL6JEcH/9oJLk1CQ2nChihwFXM/iDjBDRgrbFDUF6ZQqVMG2Q1h5qajjr50c72ViNYLRRzYJdgA4qYnWpWaLjNIaHngp9kJkkKu8Ncvwp6OzcqoK5BUljCSH2frzcUgVf0kkcx9xEaEhtrMpujWL19lpgUzr2QoZemhJ7zmCefz943nZf10JnCJgQhKaxiz/5ib15fsDFfIObxaKRMItTCOIyfHz5/PhK5HC2PRqFtOBpzNh6PNWPPfmNjflo7mtd5zF6CsGDZP05fvXp9fj65+Pjv1x/G3Denank+rXBhdEeidqKVSWYeXx2KbqzHumlisF/aacrkT0gOtrfgUdi+AJGCdb+UG+KPeczGvIYw5uxfTCTkchM016CrsX461rmVGp804hyQkz15+rQL8J1YinNv3Q7I3uRa+UY7wtliEzdCIpsBJgsP7V7Ayh66uBmzTSsRzC+NocoA8cIj/BIoKvohuC/GOohI7dpWvA3w9Saj4ECZ+RPa+vSF7zw19Td1rHyvl259viE86cNHT/DawpK6BlHzzbh5T8sshSUok2egsY5Db43AqMytQZMYVcWjUUmsqrikc6stbq8KhyZrWFA31EpKV01l5tmEV/VM+HvRi0ldgLqLWA/px8dkn/9vFxefWMunijhJ0+fX4t0S7jwkGFqjUoDa9G8/+QYkdQd6TAZVVdP73VVFxmmSDGWRLID0qabkU+8avzYPhXd/XpCN/DZ66PvVdZPDg64iIp5YmFlwi4cy8W3MmdnuXJwXOVgH3eKuM0W+E/Ytj4JKHGYiPKlC2fQG8I7PH5vK6twof+MvJ7XmEG5xlCshfQHonb6sI+2Si1ySfo585ZyHPhI5ZvC8S16WU+Hgs1VVRdOhB0RRuFMfuw6+hpVvOLcfQbjPAE0M+Rss4iE1+RMCwWmSgE+JDdXWBd7LI29ekxdRbdO5tVtfqv90PpYIverwLsuwI+Q6SgBBCJ/d/aeR6j9jV3Vm -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of report schedules'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 6af41c94e1d..d876efbaea1 100644 --- 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 @@ -1 +1,190 @@ -{"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":"User1"},"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"}}} +{ + "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": "User1" + }, + "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 index d5ccbf07920..4917ee9acdc 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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/isHYsBSTI2bYgMKFf2QBunbsraIk3VAHLi0dLbZUKRCUkldQf99OFJSJFtOk3RA90niyx3vuXeyZCnaxIjcCa1YzF6js8BBCutAz+H4aBxBYRGOhdUKtIF34w/v4bJAs4KcG56hQ2Nhrg3MhXRohFpEYLVx/ifnC6E48QauUr/NosSEVsHmmIi5SCDRssiU9VsydDzlju+yiN0cwOKzkiVaOVSOxSXjeS5F4hmPvliSvGQ2WWLG6S83OkfjBFoa1dzpVzjM/I9b5chiZh3Jy6qomeDG8BWNA5g+0QbbQU46N4PzV1wW6GVXqw9zD6jeo4pshoZV0SZVOzPTWiJXfqoV6Mc4nW/APq+qiBm8LITBlMVnHmNA1Mh/3tLo2RdM3JDuLnDVVxyqIiN25FXTxhwR0yZF0xlLPkPZGXc8s7uLmDjhJLKIKa26Mm23Z/esYbP5Dakw5JzBoRqxuU1qaQaPyvkCOyyFcrjwRvArUyu+bVkOkTB9gH9W61aIWNBIzBbopl5FdThUtFlQaPugJZ3xjDZesuqcrG1zrWxw6adPngTPfmCcFYGon1FOlghOOy7BYKJNCn4faAVuiTDjyQWqlEUbLjxo/i3BPQ2Yho7uzPj0Q4cGIiCiXfgkpIQZgjNcWckdpjBbwYx8kUUMv/Is94rdh/ciuY0f2/CNDTORKVK7Keh+m3DJA0Ck1mfdeSHheokKVrqAVKtfHVwofd3FIEh1d09r/RC7vzY9/X+ixyFOd9NgL4vcosqblHEP/dwklwHOfgGcBoMqRXN3zEck0lsvxUAC6efBWxBxKfU1pm29dNpX2nshNGgLuSVMwxrMjc68VRbowtlN6thWCpdcLTCdzlaba3NhrGs9akM8kQ7nRsm3U92S/U4tmj2ib0TSapqidHy6LDKuxDf05xnk6QclVyx2pkDaLnlhB2we5qfdyQED9mjWWXTT2Hf4hKZjGubX+XQW1/g0deoYF4XkVKtfcjtcFhdGF/n0Aleb/Nul70kZTNYnFukwVceiw0mFZr93oNESb+vEtvnQ/d3nmE7aGwobx2cPE+KmWm6GJvF8gJOfBFnu0xUcH42P0br9XOw2DcId6KtODmvr+97WytyrHneol001PGtAnw8UqEGmg8VjozT0+HYSez8dr2XfLlGTK89Kao3XA515DiFb/qVTlCTB7z/UQmVobb+bvK0QdmzTErKXPAVq4dG6GN6qKy5F2r2p5UZfiRRTNgCoQxuw7P1cLKeKF26pDaXtGPYLt0Tl6vOhvacMAOkSeiRPn/5sJLnRCQ1nEoFQuFUMf5NxAho0RpshKAe6kCko7aDmUFPTUX/8bGd7qxwaxSVYNFdoAooY9hUUCr/mmFBH5CdBJ0lhtpjrFafrQaMCuhglhSGMdLX9ck0ReE6XFccXPkKP9TUc4RVKGDc7zyP29XGiUxx7McODgeRqQUX89PiouV7eDK0uTEIgksJIePwPvD48gQlbOpfHo5HUCZdLbV387MmzZyOei9HV3sjoa0nnNgKOJgwmk4kCePwGJmy/djqv/xheIjdo4Jf9g4PD8Xh68uHPw/cT5u/itWQfV27pa14jWzvRSieyXBvXhKWdqIlq7mzwop2mrL5DcsADIESBcIk8RWNflGtAJiyGCavBTBj8BjwhR5w6fYGqmqhHE5UbodxOI9guud7Oo0ddqO/4FR97m3fg9iZvDKKVJcQtSn7NhYM5umTpQT4QYtnDGTdjWLccAf7cGK8MYE881s+BoqIPAX8+UUFYerFqBV1TQ71JS9yVerFDWx8995fvDN1Sp+HS7p+73JLFbCsM0pGPs+DdhSEVDmqCrUfYES1DSux0nqFydcR6CwVGZW6004mWVTwalcSqikvyvWqD20Fhnc4aFvQ0ZETbHzVsQq83576CejE7rWo9pI+l2O3zf3Ny8hFaPlXESJo+vxbvhnDjkIpojZoGerN8+9G/xtBVqcdkUFU1vd9dVWSmxgBjSqQBpE9KJZt5J3mlTcaJ37tPJ6zu+PxLm1+96Wg96Coi4qnBuUG7fCgT/6Yz15v99LjI0Vjs9n6dKfKdsO9qL6jEuoz7KlE3WK/R9Z9/1/XTKTf/r8fiWj8Ov7pRLrnwDaF37bKOrDPGc0Fa2GN0qehHF4sYOWLwtDNWljNu8dTIqqLpcAGmqNuqjG0i+MsWu2xfUGPmY7+JGV/bIhaSkj8hEOwnCfq02FBtlPZeBnl9SF5DXU+nnre+U/90Xoq5WnV4l2XYEbIcBXwQwmd4/y5c/QuIZ2e2 -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of RLS'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 9204bc057ed..cd70b70e66a 100644 --- 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 @@ -1 +1,208 @@ -{"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":{},"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"}}} +{ + "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": {}, + "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 index d27b84c72e3..fc734b63623 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzlWW1v2zYQ/isHYsBaTI2brB0KFfuQdV3Xruub021AHHi0dLbZUKRCUk48Qf99OFJSJFvOnHRAB+yTJYp3vOe5Fx7pkqVoEyNyJ7RiMXuBzgIHKawDPQfLV5jCRYFGoI2gsAgfhNUKtIFX47dv/Kc15NzwDB0aC3NtYC6kQyPUIgKrjfMPOV8IxWkV4Cr10yxKTOgr2BwTMRcJJFoWmbJ+SoaOp9zxAxax6wVYfFqyRCuHyrG4ZDzPpUi84tEnSxhKZpMlZpyecqNzNE6gpbdaOz0Kh5l/cOscWcysI3tZFTUD3Bi+pvcApi+0pXZQk87N4PiKywK97Wr9du4B1XNUkc3QsCralmpHZlpL5MoPtQZ9nqazLdhnVRUxgxeFMJiy+NRjDIga+89aGT37hIkb4u4c133iUBUZqaP4mjbuiJg2KZrOu+QzlJ33Tox2Z5ESJ5xEFjGlVdem3f7srjXsNj8hFYaCMwRUYza3SW3N4FI5X2BHpVAOF94J/svUir92fA6ZML1DfFabXohYYCRmC3RTT1GdDhVNFpTkPmmJM57RxAtWnZG3ba6VDSF99PBhiOw75lkRhPq15WSJ4LTjEgwm2qTg54FW4JYIM56co0pZtBXCg+7fkdzTgGlo6c6ILz+0aBACEjqA34WUMENwhisrucMUZmuYUSyyiOEVz3JP7DG8EclN+thWbGy5iVyR2m1Dj9vSSxEAIg1Vd15IuFyigrUuINXqawfnSl92MQiibv+y1k+x27Pp5f8VHoc07cdgr4rcQOV1ybgFP9fFZUCz/wBOg0GVotkf82sy6aW3YqCA9OvgDYi4lPoS03a/dNrvtLdCaNAWckeahm8wNzrzXlmgC2s3pWPXVsgdl3pBjxm/eo1q4ZYsPnr8XcRUISWfEQnOFDgAPllytcB0Oltv650LY10bjR3V3z0a0CTS4TIr+d5KNra/zvpdNVt74HX1HVPn9J7Y+oDWHefioKnHBx9tMKcBHIrpXJuMOxazlDt84IRfam/StJqmKB2fLouMK/EXegoM8vStkusgTtMNUmz+Pzg+ZB3En0MydaEzbnGbs+bLEOKjxw/35m2Dir7auzHwY2M0AZhN/br9vZQM+UfseOUMH4yl3RFARe8uFcA73RT7hbLRl/YGBN3uqm1TOhYdHj3ZwyJ7IfdiyV7IqaMZdtBWxxcDxXIXgbti6R+tCANtu3oYHUXfRo/ObmoSbwigEz607e4jukebWnU2xbZhPNzZ6vXakT0asKa9Om3YORvoeAaVDnYjW71GT2+nU+jv7xvbeVeo2XxPSzprbeYl8xrC9vurTlGSBY8+qyfP0Nr+8eSmzqrjm1aQ/cBToCqF1sXwUq24FGn36J8bvRIppmwAUEc2YDn8slg+Kl64pTZUXmI4LtwSlavXh7YUDwDpCnokR0dfGkludEKvM4lAKNw6ht/IOQENGqPNEJRnupApKO2g1lBL01KPv3SwvVQOjeISLJoVmoAihmMFhcKrHBNqsf0g6CQpzA53/UQNaUsBnbSTwhBGuiv5dEkZeEan31ChT9n7cNVFKXr1INEpjr1t4dpJcrVgMUs+fnjN2n2uebW6MAlZnhRGwoM/4MXzE5iwpXN5PBpJnXC51NbFTx4+eTLiuRitDkf+em3qe+rRhMFkMlEAD36GCTuug8zzHcMPyA0a+Or42bPn4/H05O0vz99MmL/MqY16t3ZLrTpmtQOtYSLLtXFNGtqJmqjm0A/ft8NUxe+RHXA766Mgs0SeorHflxsYJiyGCatxTBh8AzyhmJs6fY6qmqj7E5Ubody9xqYDirJ79+93Ub7iKz727u0g7Q1eu0ErS2BbgPySCwdzdMnS47s9urIHMW7eYdNfhPXPxmVlwHniYf4ZJCr6IcxPJyrYSR1fa+MGA/UkLfFA6sU9mnr/qb+zydAtdRruevwtKfUKbAgBMeMTKURyYYi4QfxsM4Ve02dIcYVS5xkqV6ek90tQVOZGO51oWcWjUUmqqrikYKu2tD0rrNNZo4IuE41oG6dGTTiUzrnfIr2ZdIiuL+HqV/rxedrX//PJyTto9VQRI2v6+lq8W8aNQ62hb9QV0C33y3f+/o4O1z0lg1TV8n52VZGHmnozpkoZQPqqU7KZj4+fmgPJq99PWN2q+rtZ//X6jsCDriISnhqcG7TLuyrxt4BzvX3wHxc5Gou9Hu96iGInzFsdBkqsy3g4RIQO6gW6XX8dbDLV2Vn+q3851Jw5vHKjXHLhu0Af7mWdaKeM54KYOSTSr5ONRYziMgTeKStLOoZ9NLKqaDhMoSTcyciu1c9x7a9r278QmK8CTQr5vSxioTz5FYLAcZKgr42N1NZW3qslL55TEFGX09m/21CqHzp/NXC17uguyzAj1DvK/2CEL/P+j4Xqb/tFLzQ= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of saved queries'} +> - - 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 index 40deeb0739f..309192927b0 100644 --- 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 @@ -1 +1,29 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index dc416613f60..b28eaea97d1 100644 --- 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 @@ -1 +1,104 @@ -{"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"}}} +{ + "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 index 3f4398845ac..1e38a978bf9 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of tables for given database'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index deef9a5a4d4..71a02ed0604 100644 --- 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 @@ -1 +1,160 @@ -{"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"}}} +{ + "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 index 04b0b16d9a0..e7044bf5b8f 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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/isHYsBSTI2brB0KFf2QBn1d1haNuw6IA5eWzjYbilRJKokr6L8PR0qKZMuZ2w7osE+2yOPxnnt5jmTJUrSJEbkTWrGYPUcHHKSwDvQcHF/YCAqL8E5YrUAbeHX65jV8LtCsIOeGZ+jQWJhrA3MhHRqhFhFYbZz/k/OFUJx0A1cpeDmLEhOaBptjIuYigUTLIlPWy2ToeMod32cRu9mBxWclS7RyqByLS8bzXIrEax59smR6yWyyxIzTv9zoHI0TaOmr1k5/hcPM/3GrHFnMrCODWRU1A9wYvqLvgKa/aEPtoCadm8HxSy4L9Lar1Zu5B1TLqCKboWFVtLmqHZlpLZErP9Qa9H2azjdgn1dVxAx+LoTBlMVnHmNA1Nh/3q7Rs0+YuCHfXeCq7zhURUbqKK+mTTgipk2KpvMt+Qxl57uTml0pUuKEk8giprTq2rQ9nt29hsPmBVJhKDlDQjVmc5vU1gxulfMFdlQK5XDhg+BnplZ82TIdKmH6DflZrUchYsEjMVugm3oX1eVQkbCg2vZVSz7jGQl+ZtU5RdvmWtmQ0of37oXM/sY6K8KiPqWMlwhOOy7BYKJNCl4OtAK3RJjx5AJVyqKNFB4M/5bingZMQ1t3Rjz90KZhEdCiffggpIQZgjNcWckdpjBbwYxykUUMr3mWe8cewWuR3KaPbeTGRpgoFKndNPSopVzKABBpoN15IeFqiQpWuoBUq58dXCh91cUgyHW701q/xL7em379v+LHIU27ebDHIre48oYyvsI/N+QyoNlPgNNgUKVodsd8Qia99FYMEEifB29BxKXUV5i2/dJp32q/CqFBW8gtZRrmYG505qOyQBf2bqhjWytccrXAdDpbbc7NhbGuzaiMX5+gWrgli3+7P+AKyXcWXmtVnX26ajb61Q1TjvniHVp3lIv9hjT339vAPQ0iraYpSsenyyLjSnyhvUpmkKdvlFyx2JkCSdwgBf9/4oAD1oG0owd6yVQyVUjJZ7QLzQ/gFOlwTxyAfvjgXvTPCsNA27QPosPo1+j++W2tcgD/Dq226hR22/QOtrarHqXu0ESaFnHWYDsfYO1BpYOMusGXPb0dtutz1BoldRc1BHJW0nlxPfTMawgU8odOUZIF97/rXJGhtf0j1m3doRObdiF7wlOgWkHrYnipLrkUaff+kht9KVJM2QCgztqA5eDHYnmveOGW2lApxnBUuCUqV+8PLSEMAOku9EgOD380ktzohD5nEoFQuFUMf1JwAho0RpshKMe6kCko7aDWUK+mrR786GR7qRwaxSVYNJdoAooYjhQUCq9zTOiY4AdBJ0lhtoTrGaczc+MCui0khSGMdN/7dEUVeE4neLqkU4WO6fc8Ytd3E53iqTcs3JslVwsWs+T9u5PmlnXzaXVhEjI7KYyEu3/B86djmLClc3k8GkmdcLnU1sUP7z18OOK5GF0ejBxfjCYMJpOJArj7AibsqM4s7+QYniA3aOCno+Pjp6en0/Gb35++njB/C62NebtyS6065rQDrUEiy7VxTe3ZiZqo5rYCj9thou49sgN2szoKskvkKRr7uFyzfcJimLDa/gmDX4AnlGBTpy9QVRN1Z6JyI5Tba2zZp5Tau3Oni+4Vv+SnPpYdhL3BG7drZQlkC4xfceFgji5Zely7oyp70OLmG9bjQxg/NiEqA76xh/cxrKjoh7A+mqhgH73ItLatIa+FtMR9qRd7JHrnkb9cZuiWOg2XUv+cQ+2cdS0nT/gqCZlaGHLUIF62Xh8nNA0pXqLUeYbK1fXm4xAUlbnRTidaVvFoVJKqKi4pqaoNbceFdTprVNBrhxFES81p16sJp+Y59/3Pm0mn/PqVoP6kH1+Hff0vxuO30OqpIkbW9PW1eDeMOw1EQnPU8ukd7uVb/8BAp/+ekkFX1eu9dFVRZBoyOSUaDCA9pZRs5vPimTYZJ32vPowpRl6MHo/87M0lxoOuIlo8NTg3aJffqsQ/U8z15s3ktMjRWOye3DpDlDtB7vIguMS6jIdDaDgebb5prjuo0y3+Yy+gtYccXrtRLrnwBzqf3GVdTmeM54L8cMB8L2ARo+wL6XXGynLGLb43sqpoOFzkqNS2OmDbrhe48q9G7Usm8zXeFIpvRxEL5ON3CAuOkgQ94zWrNrpxjymeP6VUoYNKpwW3CVP/6bx4crXq6C7LIBHYjKo8GOHJ279vVn8DkNTzBw== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of tags'} +> +Get a list of tags, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. - -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-list-of-themes.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.ParamsDetails.json index 5917115e126..c85fdd981cb 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.ParamsDetails.json @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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-themes.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.StatusCodes.json index b1b9da28cce..85645135c85 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.StatusCodes.json @@ -1 +1,174 @@ -{"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":"ThemeRestApi.get_list.User"},"changed_by_name":{"readOnly":true},"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":"ThemeRestApi.get_list.User1"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"is_system":{"type":"boolean"},"is_system_dark":{"type":"boolean"},"is_system_default":{"type":"boolean"},"json_data":{"nullable":true,"type":"string"},"theme_name":{"maxLength":250,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"type":"object","title":"ThemeRestApi.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"}}} +{ + "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": "ThemeRestApi.get_list.User" + }, + "changed_by_name": { "readOnly": true }, + "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": "ThemeRestApi.get_list.User1" + }, + "created_on": { + "format": "date-time", + "nullable": true, + "type": "string" + }, + "id": { "type": "integer" }, + "is_system": { "type": "boolean" }, + "is_system_dark": { "type": "boolean" }, + "is_system_default": { "type": "boolean" }, + "json_data": { "nullable": true, "type": "string" }, + "theme_name": { + "maxLength": 250, + "nullable": true, + "type": "string" + }, + "uuid": { + "format": "uuid", + "nullable": true, + "type": "string" + } + }, + "type": "object", + "title": "ThemeRestApi.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-themes.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.api.mdx index f328f4dbbdc..28836136cf4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.api.mdx @@ -1,33 +1,32 @@ --- id: get-a-list-of-themes -title: "Get a list of themes" -description: "Gets a list of themes, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." -sidebar_label: "Get a list of themes" +title: 'Get a list of themes' +description: 'Gets a list of themes, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.' +sidebar_label: 'Get a list of themes' hide_title: true hide_table_of_contents: true api: eJzdWG1v2zYQ/isHYsASzImToB0KFf2QFmmaLmuKJlkHxIFLS2ebDUWqJJXEFfTfhyMlWYrlNGkHdNgnW3w53nMvzx1ZsARtbETmhFYsYofoLHCQwjrQU3BzTNEOILcIH4TVCrSBt6cn7+BLjmYBGTc8RYfGwlQbmArp0Ag1G4DVxvk/GZ8JxUk8cJX4ZRYlxjQLNsNYTEUMsZZ5qqxfkqLjCXd8mw3Y8gAWXRQs1sqhciwqGM8yKWIvePjZkvIFs/EcU07/MqMzNE6gpa9KOv0VDlP/xy0yZBGzjvRl5aAe4MbwBX0HMN1NK2J7JenM9I5fc5mj110tTqYeULVG5ekEDSsHq7uakYnWErnyQ41CPybpcgX2ZVkOmMEvuTCYsOjCYwyIav0vmz168hlj12e7K1x0DYcqT0kcBda4dseAaZOgaX1LPkHZ+m4FZ3sVCXHCSWQDprRq67Ten+2z+t3mFyTCUHCGgKrV5jautOk9KuMzbIkUyuHMO8HPjK34umY6ZML4O+KzvOuFAQsWidgM3dibqEqHkhYLym6ftGQzntLCL6y8JG/bTCsbQnpvZydE9nfmWR42dUnlbI7gtOMSDMbaJODXgVbELzDh8RWqhA1WQrjX/WuSexww9R3dGvH0Q4eGTUCbtuGjkBImCM5wZSV3mMBkAROKRTZgeMvTzBt2H96J+D55bCU2VtxErkjsqqL7DedSBIBIAutOcwk3c1Sw0DkkWv3q4ErpmzYGQaZ7OK11U+zx1vT7/xU79kl6mAU7LHKPKZeU8Qj7LMmlR7KfAKfBoErQPBzzMal05LXoIZAuD96DiEupbzBp6qXTvtI+CqFBm8s1aRrmYGp06r0yQxfOrqljXSmcczXDZDxZrM5NhbGuiaiU3x6jmrk5i35/0mMKkfRTpeQPFnKnhLXOb4tZqWNLBj2jtucDWrefie2aTrfPbdBkibXRxyBPTpRcsMiZHFtrtBonKB0fz/OUK/EVk/7lBil0/vfm22UtsKGWTLVJuWMRS7jDLSf8MSqXkk9IGBnoETCFHduFdZi2ppeN03J6nHBz9c01OOVVpqwuo1o4pjaVpr+pr2+k++y/93TnAXDzPABujOUHvrnxniah10cPaDPKFqk1BX93banulJMHFNC6PF7UGC57Klav0N5qslIrOnJbTN/l5zt03N5Uk+dFQb1yt0dhEfMSAn3+qROUpMGTH+qpUrS2217eVxlbvmk2spc8AcpotC6CI3XNpUjaV7fM6GuRYMJ6ALX2Biy7PxfLueK5m2tDVBrBfu7mqFx1PjS01QOkvdEj2dv72Ugyo2P6nEgEQuEWEfxFzglo0Bht+qC80rlMQGkHlYRqNx319GcH25FyaBSXYNFcowkoIthXkCu8zTCmFskPgo7j3Kxx12tO94XaBHRTinNDGOmu+/mGMvCSbi+Oz3yGej6zlKG3W7FO8NSrFl4NJFczFrH4/MNxfcdcflqdm5gUj3MjYetvODw4gxGbO5dFw6HUMZdzbV30bOfZsyHPxPB6d+jZfDhiMBqNFMDWGxix/Sq6vKEjeIncoIFf9l+9Ojg9HZ+d/HHwbsT8LbxS5/3CzbVqKdQMNCqJNNPG1flnR2qk6tsavGiGib43SA94qN6DsHqOPEFjXxR3tB+xCEasQjBi8BvwmMJs7PQVqnKkNkcqM0K5jVqbbQqsjc3NNr63/Jqfeo+2MHYGl6bXyhLMBhq/4cLBFF0898geg6vogIvqb7jrI0L5qXZTERCeeYCfwo6Sfgjt85EKGlK5b7S7g71apCVuSz3boKWbz/0FO0U310m4mPsnLar7rKs7WcPnS4jY3JCxejGzu5lyTNOQ4DVKnaWoXJV53hdBUJEZ7XSsZRkNhwWJKqOCQqtckfYqt06ntQh68zGCCKru+b2YcHeomiOvJt11qreS6pN+fD525b85O3sPjZxywEibrrwG74pyp4FSaI6KPz1GHr33zyx0B+oI6TVVtd+vLkvyTU0rp3Hgj6gil4JNfGS8rhuutx/PyEd+GTWCfnZ5lfOgqSu8cWODU4N2/r1C/GPNVK/ez07zDI3FdhfXGqLYCeuud4NJrEu5Z/uqUTpEt/K0e9dErcrxn3sLrqzk8NYNM8mFb+98gBdVUl0wngmyxS6rWm42YBSDIcguWFFMuMVzI8uShsOllhJurRHWnXuFC/+C1rzqMp/rdbr48jRggYT8CWHDfhyj575610p17jDG4QEFDDUu7UtIHTbVn9brL1eLluyiCCsCq1GuByU8jfu33vIf+YZTpg== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a list of themes'} +> - - Gets a list of themes, 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index b8ca7f5a33c..2f1d8065359 100644 --- 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 @@ -1 +1,166 @@ -{"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":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"},"username":{"maxLength":128,"type":"string"}},"required":["first_name","last_name","username"],"type":"object","title":"LogRestApi.get.User"},"user_id":{}},"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":{}},"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"}}} +{ + "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": { + "first_name": { "maxLength": 64, "type": "string" }, + "last_name": { "maxLength": 64, "type": "string" }, + "username": { "maxLength": 128, "type": "string" } + }, + "required": ["first_name", "last_name", "username"], + "type": "object", + "title": "LogRestApi.get.User" + }, + "user_id": {} + }, + "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": {} + }, + "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 index 8192f012fdf..4ef1f306e2a 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-a-log-detail-information -title: "Get a log detail information" -description: "Get an item model" -sidebar_label: "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/isEsQ8JpsQvS4dART+4WfqyZV1RO+uwOHBp6WypoUiVpJx4gv77cKQkS7bcuN2AfLL5dnye493Do3Iagg5UnJpYCurT12AIEyQ2kJBEhsCpR1OmWAIGlKb+TU5jnJcyE1GPCpYAtu6oRxV8yWIFIfWNysCjOoggYdTPqVmnOCsWBpagaFF4OQ2kMCAMDrM05XHAEEHvs0YYeWNxqmQKysSgsRVIniXC/kWMumFeGxWLJS28qoMpxdbYvoN1ewWILKH+DdWRvJ9VJr2mKxq9nM2BN9p2kYkNB3SAFEBvvccwbDrk/DMEhnrUWfDpEswMgc1KygVOtj7+koFab5z8hRa36GWdSqGdN4b9vnPKd/myi+4eh88chnwrWiYRkEYPWUhFTATELSK46JR8jDkncyBGMaE5MxCS+ZrM0avUo/DAktQ6YkTexcHX7NEdN++4FV0XduO0IR2Hu0a2T/jbXWDX/y/kuywdRluBzrjZBc8CBzSnCXu4ArE0EfWfDYYeFRnnbI67u3zdcUvIdDSXTIUz59M9C+q09mhoTIIzF1IlzFCfhszAiYkTmyqP7pcpG7gzl6SPb1cF+KOWFSxAKVBbbhj0h2cH4NI8DuBgH2Ta7dM+hkWstKlDqIHh57POgPyGybhhx9zB8LwrcDYqfdME1dyzYfJ2v25dyeUH0GaUxqdLMKfXekPf+eprotdebJ3clOKdLBsRHmtD5IJsdPhw/W8ododlO0CMJApECOrwnB1H8p68RVn5BQyLuT4sU2sDexW4JTgH6GKpetWuHYLWabFTbFpSUonHxnJbEwZVytNhf3h20h+cDJ5NBn3/p77f7/9Nt1J6UGXsxtwmMTd9m3QbbIdTO0huqjW37SPuOBh7qbYP3o4vlEzI77bOKTx69p+u0wS0ZkvoiMhHoqBeSF+ykGCCgjY+eStWjMch2ZRfJFVyFYcQdvFprHVcBk/L5VqwzERSxf9A6JNRZiIQptyf1CrUQaS50DE5e1om76QhC5mJ0Cd425dOBnS3lpnC3JSgiZCGwEOM7t8lVduwjIbDpz6bVMkAm3MOBM/FrH3yJ4abOx9QSqouHhcy46GlWlooV+NWz546fd4Kg/cWJxrUCpRj4ZORIJmAhxQCPDTbSWQQZGpPAL5ihvHaBR7VEGQKOeLr5/O9of7NLZbihi2tCm0uM1Sih5NAhjC28NyDiTOxpD4Nrj9cVdq8aboIwnamODn5i7y+nJApjYxJ/V6Py4DxSGrjn/fPz3ssjXurQY/LZW8wpWQ6nQpCTt6QKR2VKWN97ZOXwBQo8sPo4uJyPJ5N/vjt8t2UUnx4lWjer00kRQNP3VEjipNUKlPFu56KqaheH+RF3Y0X+BHiIAfC9tzkCFgISr/It8BPqU+mtCQwpeRHwgIMtJmRdyCKqTieilTFwhxVYE4xtI6Oj5v0fmUrNrZn2qDY6tw4XgqNLGtm7J7FhizABJEl9g208hY3v2qT7RNCkp+qQ8odwYnl98mtKPAHyT6fCgcwZIbV4Laol5Mkh1Mul0c49fi5fS4mYCIZumemfcpjaUib0PP0rkB32JRxAZsp9FYnabqdLFc4TEJYAZdpAsKUyWcPwxnKUyWNDCQv/F4vR1OFn2NoFTvWLjJtZFKZ8OiKqRg1qnqVWTOuclowW6RYmFiWlU/6sok/GtOxbf/NZPKe1HYKjyKatr2a7w64sVMVHMNCikhF3r5HI8ilbaTTVeV6O7so8HQqZRmjJjqSVl9yOrex8ap6R/36cULLLyoYsm50U25a0vggujczBQsFOvpeI/bjw0LuFsrjLAWloVnFN7owdty81cC5RJuEudeZKzrtlyXC5ZKEtigjuA0ii63qtDZrXCKdX6RKxAYeTC/lLLZlqw22vAzxG8rSGHENMP8l1pV+eocB4U78hub5nGm4VrwosNt9bMHo34tk38Z3sLafZzBceYbjNvWq2HVGY3vXhtRfMK7hK3yPPpS10THZt2H1vhHr5p4VkPSOFrcY2laE7O5uYBQEYKWvWrJzPbcU4/UlhgvWYo07uQ6a8g9a74ST526GU7WiRmdVHAEWxb+Elw0Z -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a log detail information'} +> - - 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 index 3bb55a3ad8c..0e27b56ed62 100644 --- 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 @@ -1 +1,41 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 24c474027d7..62b01d59af1 100644 --- 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 @@ -1 +1,88 @@ -{"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":"User2"},"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"}}} +{ + "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": "User2" + }, + "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 index 3671bcdb183..3372463f7fd 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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/isEsQcbk2M7a4FCRR+yLL2tyILYwYZFgUtLxxYbilRJyokn6L8Ph7rYslU3dQbsyTYv53zfufEc5zRlmiVgQRvq3+Y0AhNqnlquJPXpNAYCyRyiCCISKrngy0wz3CRZxiPqUY7HUmZj6lHJEqA+rXY0fM24hoj6VmfgURPGkDDq59SuUzxnrOZySYvC61Kb8UohUYsNhoiZeK6YjkhPudNM9E9qGF8z0OstHPzcCaAdumWWzEF36Z7E6oEsuECLPEGJidXDrDrepWiulAAmuzRdPKZMRj+gC9yFI7VdMstX0Gi7hzWxirA0Fet68eQJGKQTU2OY3cO6C8e3XXsFOmGCy/ujEaS1hO8qv8MgNKmSBgzun45G+BEqaUFa/IrKeegCevjFIMB8S16qVQra8vK2BpMJu7/OhFAPEM0ilTAu3RK3kJgORF69wLRma/wdxkwuIZrN1/uCF1wbOytZd4ji0dYylxaWGNAeFezQrcyA/sbmBp6af4HQUo9abgUu3BjQp9t4S1MtlE6YpT6NmIWB5QlQb19lk7OzFuQtTFnnxgE8F1U9+K0WfV35eVI6b/9u4VF4ZEkqoO3LPe/d3rVZ0tPR6YvBaDwYv5yOR/4vI380+pvusqpB12Q2JBAJPNphbBPRDq9dumiqVq5cO5RYBi1iI3a7Gm8qYasuI9EXo/Ez4jwBY9jySQHSNmpzkd5IltlYaf4PRD45y2wM0lb6SfMudDDevlgyefH/MrlUlixUJiOf4KOE2MFYiIgGozIdAokUGCKVJfDIje0i1chALS+fVYP+A0YfpMUKIIgBvQJNQGulfXImSSbhMYUQ2blFosIw09/w1FtmmSjPOeUGwkxzu3ZNxJcHi4mEBdiyJSZVk7GkSVl659HHQagimDiYZf8hmFxSn4Y3158o1rI5iM3P0uT4O9OCDP4i7y6mJKCxtak/HAoVMhErY/1Xo1evhizlw9V4WCfMrEmYYY45WgSUBEEgCRm8JwE9q+LO+cEnvwLToMlPZ+fnF5PJbPrH7xeXAaX4nlUIr9Y2VnILY7PQoORJqrStg8YEMpD1e0TeNMsnS7A9xEGeQcUrBcTAItDmTb5DKKA+CWhFKqDkZ8LCEIyZWXUPsghkP5Cp5tL2aoAnGIq9fn+b8ke2YhMXA1u0W4sbBylpkHnDlj0wbskCbBg7ss+kmrf4+vVvsutJJP65dmZekp46zp/LGwV+oAFeB7IEHTHLGsA75qgOKQEnQi17eLT/mmKct7PjHVjCiAbnf0zmKBNAhFqSXs1s0DAbILE+9WgCNlb4eCwBjem6ap9+1yRod5fLZQZlGt3SaV26i/MTbpMIViBUmoC0VVVwXi8F5alWVoVKFP5wmKOows+RV7En7TwzViW1CI+umOZsLsrSVYvB7xEsmHt/HUzqUZBZglWi+okfhu5Z9f10ekUaOYVHEU1bXsN3D9ykLHe4h/0PUZp8uEIhyKUtpNNU1X13unC9ZV3yXM9RknSFL6dzF3Bv6+7o45/Tuk91Tbrb3XRKjnTh4eWZhoUGEx8rBNtCuVAlnRb6LAVtYLuH2lrC2CnPrcalSYxNmHuJqqb7uIBuYWieLNcOpYJx16y4KMurYL+lLOUIaIxBsRfw1KO+66/uat/f0jyfMwM3WhQFLpfDgptkucHgi6i/YMLAHprmCT5i3OxkguNIa+pcMZHhMZdNT4dzYAI9oHdnED1S98GZ9ID2vdH0SP1HTKkHUHUOq0ci+7HB9QCo3fl1g+duUzJ/MIJ711VT3Sff/8umE1s9mMoWpCao8WZxhyXXvbgOXrl1Fobg3v760l4/i7yap+3dBZYx7PK3/7aoi1n1BaV3Asrz8kT5hBcNPtfGIMCi+BdjNICX -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a report schedule log (embedded-dashboard-uuid)'} +> - - 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 index 833ec79d401..b4a8e8d1aff 100644 --- 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 @@ -1 +1,46 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index afc7b1f6813..1f603305a3d 100644 --- 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 @@ -1 +1,123 @@ -{"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"}}} +{ + "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 index 1dc86559dc3..b8a38fe20f2 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a report schedule log (report-pk-log-log-id)'} +> - - 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 32a35542965..11a5214c967 100644 --- 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 @@ -1 +1,265 @@ -{"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"}}} +{ + "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 index c015c546ba8..38ed96f178b 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-a-report-schedule -title: "Get a report schedule" -description: "Get an item model" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a report schedule'} +> - - 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 191f16d03e0..7eef6317e5d 100644 --- 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 @@ -1 +1,193 @@ -{"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"}}} +{ + "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 index d8ce0945cdd..17838fc45fb 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-a-saved-query -title: "Get a saved query" -description: "Get an item model" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a saved query'} +> - - 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 82987a840ec..3dbe119cd52 100644 --- 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 @@ -1 +1,162 @@ -{"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":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"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"}}} +{ + "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": { + "first_name": { "maxLength": 64, "type": "string" }, + "last_name": { "maxLength": 64, "type": "string" } + }, + "required": ["first_name", "last_name"], + "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 index 5431885d270..82fa5360839 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-a-tag-detail-information -title: "Get a tag detail information" -description: "Get an item model" -sidebar_label: "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: eJzVWG1v2zYQ/isEsQ8JpsZxlg6Fin5ws7RN17VF7awDIsOlpbOlhiJVknLiCfrvw5GSLNlK4nYDgn2y+XZ8nrvjw6MKGoEOVZKZRArq09dgCBMkMZCSVEbAqUczplgKBpSm/lVBE5yXMRNTjwqWArauqUcVfMsTBRH1jcrBozqMIWXUL6hZZzgrEQaWoGhZegUNpTAgDA6zLONJyBDB4KtGGEVrcaZkBsokoLEVSp6nwv5FjLplXhuViCUtvbqDKcXW2L6GdXcFiDyl/hXVsbyZ1Sa9titavZzNgbfadpFJDAd0gBRAp95DGDYdcv4VQkM96iz4dAlmhsBmFeUSJ1sff8tBrTdO/kbLKXpZZ1Jo542T42PnlB/yZR/dOxw+cxiKrWyZxEBaPWQhFTExELeI4KIj8jnhnMyBGMWE5sxAROZrMkevUo/CLUsz64gReZ+E99mjO27ecSu6LurHaVM6iXaNbEf4+11g1/8n5Pss7Udbgc656QEfM7GEaDZf744tEqVNwytlt+9ALE1M/V9Pe7209+SyrQZX7X3aZqZ3H4oJW34CbUZZcrQEc3SpUTa8howUswi4YbM4T5lI/gYbcwUs+iD42gkQTleAHv//cx/SFps9yXfStKAi55zNcQOnzjsU3bnZlupafTqsT54eew8bdB2N2A69E+8X73R6nxZ2qaORjkLvHL4R4Yk2RC7IRp73vxZaQt5j2Q4QI4kCEYHa/yiPY3lDLlBtfgPDEq73O8CNgTuFuaNDe8hlFdR61x6d67XYq0Edhbn3GD6UqdupuYGHYIfNddd0V3lU7mTDVT1n2o1lTwTspdrd1o4vlEzJH7bOKT16+q+u0xS0ZkvoSb0Hwt0spC9ZRFA8QBufXIgV40lENuUXyZRcJRFEfXxaax2X4eNyuRQsN7FUGHafjHITgzDV/qRRyB4i7YWOyenjMnkvDVnIXEQ+wdu+cjKgu7XMFR5CCZoIaQjcJuj+XVKNDcvo5OSxY5MpGWJzzoFgXMzaJ39iurn4gFJS9fE4kzmPLNXKQrUat3r62MfnQhhQgnGiQa1AORY+GQmSC7jNIMSg2U4iwzBXdyTgK2YYb1zgUQ1hrpAjvn6+3hjqX02xFDdsaVVogr9Tj94+CWUEYwvMPZU4E0vq0/Dy07tafjdNlzvYzhUnT/4ir88nJKCxMZk/GHAZMh5Lbfxnx8+eDViWDFbDgWHLwTCgJAgCQciTNySgo+qwWC/75CUwBYr8NDo7Ox+PZ5MPv5+/DyjFJ1eF5uPaxFK08DQdDaIkzaQydabrQASifneQF0033tEHiIPsCdtzk2NgESj9otgCH1CfBLQiEFDyM2EhptjMyGsQZSAOA5GpRJiDGswRJtXB4WGb3lu2YmMbzRbFTufG8VJoZNkwYzcsMWQBJowtse+gVXS4+XWbbEcISX6pg1Q4ghPL74tbUeIPkn0eCAcwYoY14LaoV5MkhyMulwc49fC5fSimYGIZuQemfcRj5Ubb0IvsukR32MPiEjZX6K1e0nT7mLzDYRLBCrjMUhCmOnY2GM5QkSlpZCh56Q8GBZoq/QJTq9yxdpZrI9PahEdXTCWoTvV7zJpxxdGC2TrEwsTKq3rMV038scexa//NZPKRNHZKjyKarr2G7w64sdMTHMPqhEhFLj6iEeTSNdLrqmq9nV2WGJ1aU8aoho6kVZaCzm1uvJIqZWjv7ecJrb6lYMq60U1FaUmXHi6eKVgo0PGPGrGfHRZytxYe5xkoDe1CvdWFuePmrYbOJdqkzL05XCVnvykRw5YksuUYwW0QWWJVZ+uh0lwfvd+iKsQGbs0g4yyxlalNtqJK8SvKsgRxDamVaOpRP7vGhHARv6JFMWcaLhUvS+x2n1kw++9EctfG17C2H2YwXXmO4/bo1bnrjCb2lo2ov2Bcwz18Dz5VVdEhuWvD+gkj1u09ayDZNS2nmNpWhOzubmAUhmClr16yczF3FOP1OaYLVmGt27hJmuoPWu+FUxRuhlO1skFnVRwBluU/iSsSNw== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a tag detail information'} +> - - Get an item model - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.ParamsDetails.json index 6e30d8d423b..df51d27cef4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.ParamsDetails.json @@ -1 +1,38 @@ -{"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"}]} +{ + "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-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.StatusCodes.json index bb81105d79f..c163fbdd9e6 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.StatusCodes.json @@ -1 +1,172 @@ -{"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":"ThemeRestApi.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":"ThemeRestApi.get.User1"},"id":{"type":"integer"},"is_system":{"type":"boolean"},"is_system_dark":{"type":"boolean"},"is_system_default":{"type":"boolean"},"json_data":{"nullable":true,"type":"string"},"theme_name":{"maxLength":250,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"type":"object","title":"ThemeRestApi.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":{},"id":1,"is_system":true,"is_system_dark":true,"is_system_default":true,"json_data":"string","theme_name":"string","uuid":"550e8400-e29b-41d4-a716-446655440000"},"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"}}} +{ + "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": "ThemeRestApi.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": "ThemeRestApi.get.User1" + }, + "id": { "type": "integer" }, + "is_system": { "type": "boolean" }, + "is_system_dark": { "type": "boolean" }, + "is_system_default": { "type": "boolean" }, + "json_data": { "nullable": true, "type": "string" }, + "theme_name": { + "maxLength": 250, + "nullable": true, + "type": "string" + }, + "uuid": { + "format": "uuid", + "nullable": true, + "type": "string" + } + }, + "type": "object", + "title": "ThemeRestApi.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": {}, + "id": 1, + "is_system": true, + "is_system_dark": true, + "is_system_default": true, + "json_data": "string", + "theme_name": "string", + "uuid": "550e8400-e29b-41d4-a716-446655440000" + }, + "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-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.api.mdx index dfc6ad6e458..6dcc433b836 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.api.mdx @@ -1,33 +1,32 @@ --- id: get-a-theme -title: "Get a theme" -description: "Get an item model" -sidebar_label: "Get a theme" +title: 'Get a theme' +description: 'Get an item model' +sidebar_label: 'Get a theme' hide_title: true hide_table_of_contents: true api: eJzdWG1v2zYQ/isEsQ8JpsR24GSZin5ws7RN17VF7awD4sClpbOlmiIVknLiCfrvw5GSLdnKS7sBAfbJ5ssd7zk+fHhUTkPQgYpTE0tBffoGDGGCxAYSksgQOPVoyhRLwIDS1L/KaYzzUmYi6lHBEsDWgnpUwU0WKwipb1QGHtVBBAmjfk7NKsVZsTAwB0WLwstpIIUBYXCYpSmPA4YRdL5pDCOvGadKpqBMDBpbgeRZIuxfjFHX3GujYjGnhVd1MKXYCtsLWDUtQGQJ9a+ojuTtpHLp1VNR6+VsCrzWtkYmNhwwAVIAvfYei2HTIaffIDDUo86DT+dgJhjYpIRc4GSb45sM1GqT5BtaXGOWdSqFdtk46nZdUn4ol21w70n4xMWQb7FlFAGp9ZCZVMREQJwRQaND8iXmnEyBGMWE5sxASKYrMsWsUo/CHUtSm4gB+RAHD/mjO2neSSumLmyP01I6DnedbO/w96fA2v8n4Ns8PQ22Ap1x0xJ8xMQcwsl0tTs2i5U2a1wJu3sPYm4i6p/0W7LkErt9ljF7T3ZS1FXiqr5+3c31/YdlFEECn0GbQRofzsEcXmoXRAVTikkI3LBJlCVMxH+DDVoBCz8KvnLShNMV4F78n7PSeyi6WE/0ShtIasNTKTkw0RiehEwtHp0DM1Zyb3caitAkZMbqj8g4Z1OM2V0Ru6qJSNrSdnTc9R43zzIHeCZVwgz1Xcejhg+o83ZqcZXGrbEjCAPCY22InJHNlfH0q6p2ubR4tgPESKJAhKCeLi/DSN6SC1TA38CwmOunicrawb2XRUMbnyDhJSerVVu0t9Vjqy42VO9BAShX7TWI76iwTfWd3orcbqBG5w2GOms3vY6M9Pi4C6f9bvcAjn6dHvR7Yf+A/dI7Oej3T06Oj/v9brfb3WXVVeXnusmJlp20BUOTKXZ8pmRC/rA1XOHR/r8qFRLQms2hhcKP0GZtSF+xkKDMgTY+uRBLxuOQbEpLkiq5jEMI2/DUbB2W3vNiuRQsM5FUSC+fDDITgTDl+mSt5S1A6oYOSf95kXyQhsxkJkKfYCVTJhkw3VpmCg+zBE2ENATuYkz/Lqi1D4vo6Oi59yZVMsDmlAPBfTErn/yJdHP7A0pJ1YbjTGY8tFBLD6U1LnX83MfnQhhQgnGiQS1BORQ+GQiSCbhLIcBNs51EBkGm7iHga2YYX6fAoxqCTCFGfNl9uzXUv7rGZ4Zhc6tC9v7TqEJ3B4EMYWhDcw9BzsSc+jS4/Py+EvJN07EH25ni5OAv8uZ8RMY0Mib1Ox0uA8YjqY1/2j097bA07ix7Haujnd6YkvF4LAg5eEvGdFAeGJtpn7wCpkCRnwZnZ+fD4WT08ffzD2NK8UlZxvNpZSIpahGtO9YxxUkqlanYrsdiLKp3FXm57sb7fg/jIE8O3HPTI2AhKP0y3wp/TH0ypiWEMSU/ExYg0SZGLkAUY7E/FqmKhdmrwjlEau3t79cBvmNLNrR7WgPZ6NwkXwqNONfY2C2LDZmBCSIL7buA5Q10ftUm27uEML9WG5U7iCOL8KuzKPAH4b4YCxciXqnr8LbAl5Mkh0Mu53s4df+FfQwnYCIZuke0/VCBpSJtBp+niwJTYo+NI26mMGOtwOn2gXmPwySEJXCZJiBMeQDthjhHeaqkkYHkhd/p5Oiq8HMkWLHj7SzTRiaVC48umYpRp6pXp3Xjyq2y7LBhYi1XfrIom/hjj2XT/9vR6BNZ+yk8itE0/a3x7gQ3dMqCY1jLEKnIxSd0gliaTlpTVdrb2UWB+1OpyzBwMuKXGpPTqWXH66pOf/dlRMsvRvb9YEc3NaoFjY+JWzNRMFOgox91Yj+uzORudT3MUlAa6sV/rQu54+Ytey4l2iTMin5Z99kvZ8RybjsztXuj9QNbGaCBO9NJOYttaWu5lZecvqIsjTGMXlVuUo/66QIZ4Lb4iub5lGm4VLwosNt9PUK63xvLfUsvYGW/NyE/eYbj9rRVZHVOY3vBhtSfMa7hAcR7n8uCaJ/ct2D1ChKr+ppVIOmCFtfIZas7dnU3MAgCsHpXmezcyQ2ReHOO/MACrP5UrVhS/kHvreHkuZvhhKxYR2elGwMsin8AfSdZMg== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get a theme'} +> - - 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 72fd49951b0..b5268a26141 100644 --- 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 @@ -1 +1,50 @@ -{"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"}}} +{ + "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 index 310c570648c..8f03446a7e5 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-all-available-domains -title: "Get all available domains" -description: "Get all available domains" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get all available domains'} +> - - 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 index 96c579d7663..fdd7bb6f4ef 100644 --- 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 @@ -1 +1,24 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 11461c53d49..e6cc739a698 100644 --- 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 @@ -1 +1,77 @@ -{"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"}}} +{ + "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 index 997f0f0be38..27d13b5bfa6 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get all catalogs from a database'} +> - - 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 index 7c5698d51de..3d06b151d05 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"tag_id","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index d79340fcb09..095a58e6340 100644 --- 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 @@ -1 +1,119 @@ -{"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":"User1"},"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":"User2"},"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"}}} +{ + "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": "User1" + }, + "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": "User2" + }, + "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 index 0c30c54ad56..3d94a741fe0 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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+pEYTauJXWdelSiUpo0dfnNG8tzJYW1OjJRW0Lbqm9FqKsHLbAmkhdY7ZNJiZGVtJghgySXhAqkKIeoiOrNI5dBGkFiVhNr1ebNubKetoGvi326oq20U6glLer9UNEMz1F0yJISkqeePCoT0aIBn7oDPvBWlutA/qvU77H0hG0Di0j/PAU1gJSGvlwq9l/j0KD3ZK2HgItInMT5HOl8k8Dhm6C+luyxE0tnzwiTlmn/z2iSZFi387fctYFwHeyqoucf36XLbdVcfCGbrUqprvHsTwQTkSZibInyuCCSekcyZVfEXEjaJCSDGRntBvh0/Z6qaRc8yU9XpkBBUo0sZa1CQylaPziJ79pxpQoXMy/6HgbbIfFOGVzATXMHQUi3d6LkuViVX9E7U1c5VhBjuctKYbuBz9XC4XWjZUGKv+xiwWxw0VqGl5vhgK9Q4i64qBybOfy+SjITEzjc5iMSmwdzKyu51pbIoiM+iENiTwVrH7t0kNNviU3392nr3TxEWwFA7tHK1Aa42NxbEWjcbbGlNm5zeFSf092RmpN5JkGeT84Q7Txipa+D795YYv9BU32lAjL7luOLiK4PYgNRmOPbDQ1Eupc4ghvTj/AFzAr7FcLYOTed3YUhz8JU5PJiKBgqiOR6PSpLIsjKP4+eHz5yNZq9H8aEQyH+VI02WtGCUgkiTRQhy8FQkcLxPMOzwWr1BatOKX49evT8bj6eTTHycfE4AuGoCdLagweg3asDGAU1VtLPXZ4RKd6H7AEC+H7Sc50h7jEA9nEAW9AmWG1r1s7/BIIBYJLLkkIH4VMk3RuSmZr6i7RO8nurZK016P6wmn2t7+/jrT93Iuxz7Ga2w3NlfhMNox4YGkvJGKxAwpLTzHxzFsN2jG/VrcjRvz/dyHrg1cJ57q56DR8YN5v0h0wJpJkgPOO15YCpkSn5Qm32PR/RfA6buZ9KdIQpbld7oQyRwiqJAKk0EMObLX/MQaw33c2a/+Lob74Fvybu/BVnfkzyLDOZamrrijBUs+qsFQW1tDJjVlF49GLZvq4pbTtduy9rpxZKreRARzaZW8LrGfbbyZ0F1n0jdtDxMiQN1UfMuXS374275p/+1kciYGO10EjGbT3sB3C9w4lCv+xgOUMFa8O2MjzGXTyE5XLfW9dOf/AfqS5QeXQNIXrhaufWa96Sf1939OYPlDwbkfvq6mdk+6i1h5anFm0RWPNcKTrZ6Z7Qlm3NRoHa5PYmtbnDtBbn4UXOKokr6TLH+TfjRzN04dmgzhLY3qUiq9NjOGrL4EWSuGcAS+2EMEa7kNEXAahDhfQtteS4cXtuw63v7WoOWGcbVKNX8DMuX4PYN4JkuHW6iG5gl758thYl+sXLmJth9G9cJndNnwCiL4iovV72N3xdnoq45HED4epyn6sterbbVqTqPhsp+ecIR5gFlz3RDn5Qtb3wmpbYNEKGPdCiGvwc/G/wAXQS4j -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get all objects associated with a tag'} +> - - 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 index fbd3d4edd37..f4f252055e9 100644 --- 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 @@ -1 +1,28 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 5471ccb4891..3537d9e6c32 100644 --- 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 @@ -1 +1,77 @@ -{"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"}}} +{ + "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 index 9e10d328efd..a24dad20a6c 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get all schemas from a database'} +> - - 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 index 42979d8698c..66878c4365c 100644 --- 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 @@ -1 +1,46 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 3cf7d625652..3d1c586b813 100644 --- 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 @@ -1 +1,129 @@ -{"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"}}} +{ + "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 index 351553a73af..d4c4221d4c2 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get an annotation layer (annotation-layer-pk-annotation-annotation-id)' + } +> - - 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 15d74c7d48b..022db9a96f9 100644 --- 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 @@ -1 +1,134 @@ -{"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"}}} +{ + "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 index 1204381ac5a..f97b1992a29 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get an annotation layer (annotation-layer-pk)'} +> - - 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index f277ed4a6b7..143be2ec42f 100644 --- 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 @@ -1 +1,181 @@ -{"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"}}} +{ + "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 index 6ee49ac5f74..67e2b37c0a0 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-an-rls -title: "Get an RLS" -description: "Get an item model" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get an RLS'} +> - - 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 index e653b382431..968819c883e 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"version","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index b6b7d584c52..b00b6a43f04 100644 --- 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 @@ -1 +1,36 @@ -{"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"}}} +{ + "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 index 176a6c63cdb..95744668bfe 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get api by version openapi'} +> - - 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 index a379640172f..7b351d78900 100644 --- 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 @@ -1 +1,17 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 889228c0287..0d5fe162a3b 100644 --- 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 @@ -1 +1,63 @@ -{"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"}}} +{ + "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 index d3449f4c8af..2a0e1e18109 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-chart-thumbnail -title: "Get chart thumbnail" -description: "Compute or get already computed chart thumbnail from cache." -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get chart thumbnail'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 3c87c657dd1..b9f42dd8017 100644 --- 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 @@ -1 +1,102 @@ -{"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"}}} +{ + "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 index 8e407fab5c8..983a8171c5c 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get charts and dashboards count associated to a database'} +> - - 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 index 12697c26997..bac3264d732 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"id_or_uuid","required":true,"schema":{"type":"string"}}]} +{ + "parameters": [ + { + "in": "path", + "name": "id_or_uuid", + "required": true, + "schema": { "type": "string" } + } + ] +} 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index dbc813faa23..c382bdb4b99 100644 --- 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 @@ -1 +1,102 @@ -{"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"}}} +{ + "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 index 25ee4155655..e16d7fba5d5 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzFV9tu2zgQ/RVisA8JVomTRRcIVPQhm6S3Ldo0drELRIHLSGOLrUSq5MiJK+jfF0NKsh17gV4C9EkSL8NzzgxnRg1U0soSCa2D+LoBpSGGSlIOEWhZIsSgsqmx07pWGURg8UutLGYQk60xApfmWEqIG6BlxasdWaXn0LY3vNhVRjt0PP/H0RE/UqMJNfGrrKpCpZKU0aNPzmgeW9mrrKnQkgq701xacjvGTR2MZehSqyo2BjGc8XIRJqMemtKEc7TQemR1sWPfqSiUI2FmIpMuvzXSZg4iUITljsNVtkZ8zborVIrTIN+WMBEs1NdpGNxWbQBrbj9h6sErKnjgXJJ0SFdYSMLME4TVcmmtXH7vfscG1oh+q7rn/ZZfpjCHy7REkpmk9ejrWHsf1POd6nd6/Lj0A/ufkP98xf3bN73z0+6qu1V8PN7Lsgp0hhvy0Kdty0dseuF9jXYpOh+1ETw5Ov6Jy1mic3L+TaJuYh42wgcta8qNVV8xi8VpTTlq6s4XQ9LZwWR9Y2Dy5NcyeWtIzEyts1hMcvTY0RFmrLapbYoiM+iENiTwXjnaRWqwwaf8+VOJ8xEYvdKEVstCOLQLtAKtNTYWp1rUGu8rTJmdHxQmTWv7P556LkkWYZ0/3GFaW0VLX3c+3RHE1zdcNUjOuRb1we/gJoL7g9RkOPbgQqEqpJ5DDOmHqzcQQSFvsVh9BqH5u7aFOPhXvLiYiARyoioejQqTyiI3juKTo5OTkazUaHE8ysJxo2ZV79qRDTdvGhRyCYgkSbQQBy9FAqdd4HlHxOIvlBat+O307OxiPJ5O3v198TYBaKMB7OWScqPX4A4DA2BVVsZSHzUu0Ynuq6h4NgwfzpH2GId4HFZRsJWjzNC6Z80DbgnEIoGOXwLidyHTFJ2bkvmMuk30fqIrqzTt9VgPOSz39vfX2b+WCzn28bCmwMbgym1GOxZhIC7vpCIxQ0pzz/vxWDcb1OP+Wzz0L2vwsXdxE/hPPP2PYUfLD9biaaIDfkYxYH+gTLfIFHhYmPkeL91/Chz+m5fmBZIImV1Ina3VzFB6hXTOpIp5CTJCio45RFAi5SaDGOb+0/d0MXyPQuwRf+PDjastO2yn7vAQ9hueFhkusDBViZq63OHjIRhqKmvIpKZo49GoYVNt3HDwt1vWzmpHpuxNRLCQVsnbAvuGwZsJrcZM+q7Dw4QIUNcl55Lukx8+n2zafzmZXIrBThsBo9m0N/DdAjcOSZHnuOMTxopXl2yEuWwa2SlVt9+vbn3b3CfGMaf0QNKnxwZuffw9N7aUbO/1PxPoWnC+NWF21Y150tws3dHU4syiy3/USBuB0jOz3c6N6wptCLi+aVkb4tgJ6xbHQRJHpfT1qvu5+PH43sAxFDfCexpVhVSaz/OR1nSxfw2yUgzqmHcPduIH/zebV+CmD4ZraJpb6fCDLdqWh79wC8U1axWP/ppkyvF7BvFMFg63gA51HPauur5mX6z03iTQt5d66cO+qPkLIviMy80/s/aGw9YnMY8iLDhNU/SZtd+61TlwvA2Z4sUFhwL3U2uKDgHRvbD1nbCaJqwIWbEdUPoiwQDb9j8EhwND -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get charts and dashboards count associated to a dataset'} +> - - 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 index eccdacad2de..a8f00f72fcb 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index a3c84540baf..a6e65d314c1 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 98bb0377e10..60a04f5f02b 100644 --- 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 @@ -6,28 +6,27 @@ 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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index 20033d43cea..4fb53c70740 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"Either the id of the dashboard, or its slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 02a6a0ad47b..55907b882a8 100644 --- 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 @@ -1 +1,165 @@ -{"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"},"currency_code_column":{"type":"string"},"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"}}} +{ + "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" + }, + "currency_code_column": { "type": "string" }, + "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 index b36c5d50057..d51dee35fbb 100644 --- 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 @@ -6,28 +6,27 @@ 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+61fYQKhO1NEIR9gWkuZKbIJbaIHhRSG2FQixGyBbOGZCWNwnPZJaDQF2Aq3Akoi3CCnwUcaYqrGiXJIxk3OIDZDgSITeFLWQ7rkj6Aem93Iw0aXhSc4RjWnVS6xrZnlLlPdhsIzKnQLQmJoFSdC5kgCn/GnclisqgFplEadxq2rdRMIjMBRQQUBcS4UbJUC0+VeA3NwqttcdKGoFyYUDA59I4f8DsQmYfwappfjpEA8RTlB7WGq6mrQySXhsj0AkFKLWZFu7wiN59Qqvp1Tw03m61/U2U7KxtwlGjoYGn/Up1qxZc5TMQBwwlXMFSVgYFWFU6bXFSCJRGUXkzObkEzHKxlqaCQL5TtHenf9btwgCGQE+6bEtEgCVnq2nRlZe2MtJr3Ijwycit2P/nm273OwdpMBdZDtlHUVC6XU2zObiYgeAYuRCHw2hIRLTrJq0XgF5nX7mhDy6zpXxl9Jd+l4dpWG65DHAg8zmvwIvFRmS509lOgvp2d7srGw+or6EZD7bp35Xgi8mJgydSwrtgCyj99Pyn6SVqk85BnyMUpZEI4ga4dNaIlado+A9DuP2eUKz0dP5bg1+4AKKQZUzqSmk6fqV5s5XsDwHpV+rGvNRVFk/bQuesXY498PtGKY3KojQwPu8v6uayaWL+Ghc1w1+GekrBUttIJpCpe/+q2jicDf4G9qDIH0vFqFiCgCl7adfSaMWuCzVWerfWChSfYDfSbbnc/b5c3llZYe68/gIqZY8qzMFi9382VIQTRMaKLZOfvy+TZ84vtFJgU/anq5hy9hayXK6BUT7RIRAjdExmVH8zzHVgHtqzdYrgYK9ld+/7snvtkC1dZVXKznPoQwjUQIEpB4FZhww+awqufUaDjfjfAFlF527sKz5c0Ya8pMoe5Yp6jet9GPhlwj/fpvryLCJrWxEj7YqnPHv39hVPuJELMNefnVtTKk8Nu/0He356zuY8RyzT2cy4TJrcBUzv37l/fyZLPVvfnQ2Ny4ze285qztl8PreM3X7B5vxRF3HR6yl7DNKDZz88evLk9OxMnP/26+nrOedNMoB7s8Hc2RG8YWAAqIvSeewdGuZ2bvvehj0chk9WgEeEg30bi6TVzUEq8OFhvcNlzlM25x2fOWc/dlEq0H0E28zt8dyWXls86rGdUMwdHR+P2f4i1/IsrveI8dbg9bI4G4j0QFReSY0s1oGR57ezrLeopv03210/4vy+X8K65Xse6b5vNRp6EPcHc9vipT8NWHc80Qk5AyfGrY5I9PgBp4AuAHOneMpXgLGjxpynfJ9Jfd0NNwMpchr4dd9/xwJ62jV8d7u9ommmYA3GlQVYZK2luGStobr0Dl3mTJPOZjWZatKa4rHZs/akCuiK3kTC19Jrql36fjmaofeuG+hg8oSDrQra0N0nPeKW3rb/4vz8DRvsUA3tAm7bG/jugTuLqBjNUSlFFw8v38RSzvkdI5Ou6vSjdBPvF/rsFGuMlmTMUTVfxJB5Fpt3iu/fz3lXGcZCOM7yIa1G0k1CysLD0kPIv9UItQV26Vo6W+irEnyAcak0GqLYaeXWd1uXBCxkPC+6W5jnVONMXCvtuml0/vwfrqY65yB8xllppI4HZddhtpvsgstSkwvuEpXeCE94unXxNPC97KPugtc1dcDvvGkaGu5uES4urwO/vQ9rW3nF06U0AW5w2NHbrpg5Zl93bTZJsy947SZuRVPRF0/4R9hsX6s1l207qsBHwK3AoyyDmJB71b1qYitxPT+l8KR6a9zy9UHavZD1SVh13Uq0ybUZUMazhcca/C+DeFAO -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index eccdacad2de..a8f00f72fcb 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index cf4255d5277..1f468583145 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 759224ac69e..47758cc0230 100644 --- 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 @@ -6,28 +6,27 @@ 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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index 20033d43cea..4fb53c70740 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"Either the id of the dashboard, or its slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bf2824a96dc..2129fad869a 100644 --- 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 @@ -1 +1,101 @@ -{"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"}}} +{ + "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 index c8a86786063..26b5758ffe0 100644 --- 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 @@ -6,28 +6,27 @@ 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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index f7194104764..fc577e1f0e3 100644 --- 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 @@ -1 +1,17 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 95d3dad363d..6e8d122efb2 100644 --- 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 @@ -1 +1,75 @@ -{"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"}}} +{ + "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 index 04d0a559c49..91b54e445ac 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-dashboards-thumbnail title: "Get dashboard's thumbnail" -description: "Computes async or get already computed dashboard thumbnail from cache." +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index 0d1f3566c3c..9ec79e8ae9f 100644 --- 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 @@ -1 +1,25 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index f23fffb91f9..8c88488cecd 100644 --- 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 @@ -1 +1,83 @@ -{"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"}}} +{ + "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 index 7a74476d71c..a096df1209d 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + '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) - + 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 index 0d1f3566c3c..9ec79e8ae9f 100644 --- 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 @@ -1 +1,25 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index f23fffb91f9..8c88488cecd 100644 --- 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 @@ -1 +1,83 @@ -{"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"}}} +{ + "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 index c230061f7e9..1809e5d8492 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get database select star for table (database-pk-select-star-table-name)' + } +> - - 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 index 0d1f3566c3c..9ec79e8ae9f 100644 --- 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 @@ -1 +1,25 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 4434213df1c..9f2af2e147c 100644 --- 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 @@ -1 +1,226 @@ -{"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"}}} +{ + "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 index ff343b9be00..7fa8deaf244 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-database-table-metadata -title: "Get database table metadata" -description: "Get database table metadata" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get database table metadata'} +> - - Get database table metadata - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.ParamsDetails.json index 2c6ff23b941..dc929edf74f 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"description":"The dataset ID","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "parameters": [ + { + "description": "The dataset ID", + "in": "path", + "name": "pk", + "required": true, + "schema": { "type": "integer" } + } + ] +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.StatusCodes.json index d733fd1d8d4..66ad0bb9686 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.StatusCodes.json @@ -1 +1,82 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"},"example":{"result":{}}}},"description":"Dataset drill info"},"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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { "result": { "type": "object" } }, + "type": "object" + }, + "example": { "result": {} } + } + }, + "description": "Dataset drill info" + }, + "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-dataset-drill-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.api.mdx index 79768351b29..1d88a2a006c 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.api.mdx @@ -1,33 +1,32 @@ --- id: get-dataset-drill-info -title: "Get dataset drill info" -description: "Get dataset drill info" -sidebar_label: "Get dataset drill info" +title: 'Get dataset drill info' +description: 'Get dataset drill info' +sidebar_label: 'Get dataset drill info' hide_title: true hide_table_of_contents: true api: eJzFVm1P3EYQ/iurUaWCajDQVEKO8oESIKRRinJHX4QR2bPnzgv2rrM7vkAt//dqdn3m7rioUqjEJ9vrndnnmZdnp4VaWlkhoXWQXLWQo8usqkkZDQmMCxS5JOmQxPlbiEDxai2pgAi0rJC/7iACi18aZTGHhGyDEbiswEpC0gI91LxLacIZWui6a97taqMdOt5wsLfHj8xoQk38Kuu6VJlkDPGtYyDtksPamhotqWBt0TUlLR1kJreYEXRdtL4SAd7Lqi5xxa7reOsq7bc95dyqshRKTw1bv9rbfwbQCp2TM1xC6sgqPftPpIMhXGrZUGGs+gfzRBw1VKCm/nwxZGADn2XDwOTnl2VyauxE5TnqRPxtGpEb/SOJQs5R1Ggr5RwzIiNklqFzggrlhEVnGpvhJoKDv8Du1cuy+2hITE2j80RwA3Fm0BHmAwWRG3RCGxJ4rxxtYjT48IwODl668mprOBVyUqLgqqOHRPwhS5WH6kNrjd3E49g0Ze6p9h56az7ql2d1/v9A61wTWi1L4dDO0QYWiTjSotF4X2PGSfOLwmRZY7/RXqeSZDmEIAKHWWOZIwvq7VeC5OqaZY/kjEV2IS8OriO438lMjiMPLihwKfUMEsguP32ACEo5wfLxs2+BBLLGlmLnL3F2MhYpFER1EselyWRZGEfJ4d7hYSxrFc/3417A4/3Y69kN61mcgkjTVAux806kcNTLg498In5FadGKH46Oj09Go5vx77+dfEwBumhAd/FAhdFL+IaFAaGqamNpUf0u1ale6L54MyzvzpC2GIf4ThpRMC5Q5mjdm3aNTAqJSKEnlIL4qdeUGzJ3qLtUb6e6tkrT1gLcLhfe1vb2Mt33ci5HPuNLlFcWHxNjtGPWA1P5VSoSU6Ss8ESfQbNd4ZosvsV6Bpn050US20B47Pl+DhYdP5j861QHwHzsAHYtFP0mU+JuaWZbvHX7NXBFr/bBGdIwLSxdnRFUSIXJIYEZcqz8/JDAOuO2vuuWSXNUfV+GvmgsB31j7GAdyQf+LXKcY2nqCjX1He5zGhy1tTVkMlN2SRy37KpLWq7Y7om348aRqRYuIphLq1gIXS9K3g2/5ziVfqrwMCEC1E3FHd9/8sN3/ar/d+PxhRj8dBEwmlV/A98n4EZBuvgfD2TCWHF+wU6Yy6qTjaHq7f3uzk9nC/kasfAGkl7EWpj4kjo1tpLs7/2fY+hHPa788BcG8fWku4iNbyxOLbrie510PHlOTaCzgr6p0TpfVaSI9X15iWsn7Jvvh5A4qqS/Vfrh9Zslu3LMcMMQ3lNcl1L5QcMXUtuX8xXIWvGZ+2wdXEIEiR+PH6saIuACCBm+gradSIeXtuw6Xv7SoOVr4/qxyMJUrvzNm0MylaXDJ/CGKxS2PvVz4LZ4MrxvJNEvSv3gK7ts+AsiuMOHMNx311yRXnI8lvDjKMvQC9/C5MnVzaU0NP7ZCWeZp9ClaA657l/Y+0Y4bRt2BA3rBnRewxlg1/0LMVlnnA== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get dataset drill info'} +> - - Get dataset drill info - + 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 5454dd1d7e7..69cb1ee1d60 100644 --- 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 @@ -1 +1,87 @@ -{"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"}}} +{ + "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 index 38e5a8183aa..50d644bb109 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get distinct values from field data (dataset-distinct-column-name)' + } +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 5454dd1d7e7..69cb1ee1d60 100644 --- 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 @@ -1 +1,87 @@ -{"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"}}} +{ + "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 index bc523b4a233..a3e6185a0ed 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get distinct values from field data (query-distinct-column-name)'} +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 5454dd1d7e7..69cb1ee1d60 100644 --- 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 @@ -1 +1,87 @@ -{"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"}}} +{ + "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 index 08244d0dd2d..41ff38a9a3f 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get distinct values from field data (saved-query-distinct-column-name)' + } +> - - 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-distinct-values-from-field-data-security-user-registrations-distinct-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.ParamsDetails.json index 1eb4bf53a1a..d28dad357e2 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.ParamsDetails.json @@ -1 +1,31 @@ -{"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"}]} +{ + "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-security-user-registrations-distinct-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.StatusCodes.json index 5454dd1d7e7..69cb1ee1d60 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.StatusCodes.json @@ -1 +1,87 @@ -{"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"}}} +{ + "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-security-user-registrations-distinct-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.api.mdx index a3270a22d3a..28a0f88e733 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.api.mdx @@ -1,33 +1,34 @@ --- id: get-distinct-values-from-field-data-security-user-registrations-distinct-column-name -title: "Get distinct values from field data (security-user-registrations-distinct-column-name)" -description: "Get distinct values from field data (security-user-registrations-distinct-column-name)" -sidebar_label: "Get distinct values from field data (security-user-registrations-distinct-column-name)" +title: 'Get distinct values from field data (security-user-registrations-distinct-column-name)' +description: 'Get distinct values from field data (security-user-registrations-distinct-column-name)' +sidebar_label: 'Get distinct values from field data (security-user-registrations-distinct-column-name)' hide_title: true hide_table_of_contents: true api: eJzFV21v2zYQ/ivEYR8STI6ToQMCFf2QZmmarugC28EGRIHLSGebKUWqJOXGFfTfhyMlWX4JBmQI8snmyx3vee5VFRTc8BwdGgvxbQVCQQwFdwuIQPEcIYZUyzJXU7+KwOD3UhjMIHamxAhsusCcQ1yBWxV03Toj1BzqOqog1cqhcnTKi0KKlDuh1fDBakV7a9nC6AKNE2hpNRPSodmjMwKhUllmOBWZvykc5rZ3USiHczR0s9nhxvAVrQs+x/036WRqxc+9x2tN+v4BUwcROOEkbczRTQ1K7jCbNlDq2tsIMXwv0azWJH6H+o7Is4VWNqD87fiYfp7JUarLIJShTY0oSAhimCyQOe24ZKrM79EwPWOZsE6o1LEllyVaiPZwYNCW0m1Quvmew8cnnuvUk+Ra+ToOniTwj0Zy5B8fNeTsOu+/VbSy48YNEeAjzwuJPapO1ihv77yjNrG01rCZQJmxjDuv6M3/clOO1m4G3pO8bBrdCcJ7njHKOrQuZldqyaXI2DptWWH0UmSYwR5MPdmA5eR1sdwoXrqFNuInZjE7K90ClWveZ11p2QOkLxiQvHldJF+0YzNdqixmlAQNyUh0W12aFFmm0TKlHcNHQfTvgup00Cu/v3acXSmHRnHJLJolGobGaBOzM8VKhY8FpoTObzKdpqV5wlMfOFUff88/bjEtjXAr314efoTsu4vA8Tm1HLixaEY4F9YZD9WO0Lqz6yu4i+BxkOoMx97Y0J8kV3PqSTejzxCB5Pco18tAPK1LI9ngH3Z5MWEJLJwr4uFQ6pTLhbYuPj0+PR3yQgyXJ8PWvGFp0UxN35BhW9mGVa8H1gmwJEkUY4OPLIGzJiy9SMzeIzdo2C9n5+cX4/F08tefF18SAGqGjenXK7fQqmd8t9GZL/JCG9fGlE1UotrOwd5120dzdAdkB3sJjFHQvECeobHvqi2kCcQsgQZtAuxXxtMUrZ06/Q1VnajDRBVGKHfQWn5EIXxweNjn4hNf8rGPnR4fG5trl2pliZKOBv6DC8dm6NKFZ+GlOKg2iIjbNdv2PTHytXV/FdiYeDK+BomafoiZt4kKaKjFdEi2eGouaYlHUs8P6OrhWz9EbKbbJbrtBs9mRue9LsYOWvADAj/YAD9ohQcB+4CwH0IEObqFzsKYA1GYCWN4Pp3kTF9YQiKXhny912WwjfEzHbMMlyh1kaNyTYnyoRQUVYXRTqda1vFwWJGqOq4oi+odbeeldTpvVUSw5Ebwe4nt0OPVhFFnxv244M2ECFCVOZWsZkk/FnY88nEyuWadnjoCsmZTX4d3x7hxqL10RqwxbdjVtR9StdlSspeqRt7frmsKl9ZTfjQKIH0VruDeB+sHbXJO+j79PYFmnqeEC6frec6DriMSnhqcGbSL5yrxM/JM746T47JAY7E/4PW2KHbCveVJoMS6nPu22EzZL5YMG2Z2LZZm4mEhuVBkjg/EqkmUW+CFIJtPoNcCI9hNF9LevAoRxP2vrbs2dm6hqu65xRsj65q2w9cF5dGWZd34AGvSN838hiv/PUKBL0s691WlzYKgVFj6n0E849LiDv71KwejZmg7ZE892M7yatV/szWkj7e+o2zxhdabEW6cpSn6XtDK7sxFZH9Xri4vKAJpWux5qovD5g9p32tXVYUboXLXnZm+rZGBdf0vJMpPZw== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get distinct values from field data (security-user-registrations-distinct-column-name)' + } +> - - Get distinct values from field data (security-user-registrations-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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index f060b1aa8f9..bbf5d050399 100644 --- 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 @@ -1 +1,62 @@ -{"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"}}} +{ + "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 index b9ee3fbd216..106994e44bf 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get function names supported by a database'} +> - - 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index f07ec8f629a..236688a0c19 100644 --- 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 @@ -1 +1,68 @@ -{"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"}}} +{ + "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 index 003b0fcdc4b..779887a6d30 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get menu'} +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index c823d25841f..8c75385b763 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get metadata information about tag API endpoints'} +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index 410c6ada3f4..2aa60d81278 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get metadata information about this API resource (annotation-layer--info)' + } +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index 7f59ee69387..4a4cc958762 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get metadata information about this API resource (chart--info)'} +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index dd78a0bf3e6..39639859591 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get metadata information about this API resource (css-template--info)' + } +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index 14a8dadf6cf..d8d57cd260e 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get metadata information about this API resource (dashboard--info)' + } +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index ff601913ab5..4488448fea6 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get metadata information about this API resource (database--info)'} +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index 41880bc931c..955fbbf8aa7 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get metadata information about this API resource (dataset--info)'} +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index 7415777fbef..7a0a0889e1f 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get metadata information about this API resource (report--info)'} +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index 064f1dc9f90..7171e6938f7 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get metadata information about this API resource (rowlevelsecurity--info)' + } +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index 119c3086154..63a163df67d 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get metadata information about this API resource (saved-query--info)' + } +> - - 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-theme-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.ParamsDetails.json index beb41857879..3d1c6a5cb18 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.ParamsDetails.json @@ -1 +1,53 @@ -{"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"}]} +{ + "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-theme-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.StatusCodes.json index da2fced086e..33661b3603b 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.StatusCodes.json @@ -1 +1,100 @@ -{"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"}}} +{ + "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-theme-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.api.mdx index 86e77e217a4..e441bbef86c 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.api.mdx @@ -1,33 +1,32 @@ --- id: get-metadata-information-about-this-api-resource-theme-info -title: "Get metadata information about this API resource (theme--info)" -description: "Get metadata information about this API resource" -sidebar_label: "Get metadata information about this API resource (theme--info)" +title: 'Get metadata information about this API resource (theme--info)' +description: 'Get metadata information about this API resource' +sidebar_label: 'Get metadata information about this API resource (theme--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/oevB8bUvyVmOBVq6me5OUp3h1EMLQ4fkas1ilr794xcWMekbaf/ZNpuYpZWRcPIXvL6cQcJy58p4MpE65TLX1sXPnjx7NuGlmGzOJo4Om/hbLGGQJIkCOHkDCTtvU8x7O4aXyA0a+O784uJyOl3Mfv/58reEsSbqMV1vXa7VAFW/0OMSRamN64rQJipR3Z0IL/rl0zW6I8IBjwIfBZUceYbGvqh3KCQshoS1NBIG3wNPKeEWTt+iahJ1nKjSCOWOOkinlGJHx8dDkj/xDZ/62A6Ijhbvg6CVJa49P/6JCwcrdGnu6T2aXD1iGHffsBstovq+C1gdaM48y/dBo6EHUX6eqADTj8EdxB0HtEJa4qnU6yMSPX7uB5oCXa6zMAj5AdnlLGYHCJBffA2FLK4Mue0ge7ZbPb/QNmS4QanLApVrq9FHJRiqS6OdTrVs4smkJlNNXFOmNXvWLirrdNGZiNiGG0FNqxtxvJlw1a94JV0Lk0bHdgZtP+nha3Rs/81sdg29nSZihGZsr+e7B24a2gzt0ZUN2sDVtR9DtNkxctBVrb6XbhoKUNdqpmnoKXHbcGq29Onxyv/2UAq/m1GMvBiL2937KcqTbiJSXhhcGbT51xrxE/JK749T06pEY3E4Xw+WKHeC3OYsuMS6gqv7WfTRf3Rw5BP05IRkj3edObh3vuZfsaXs8M5NSsmFIsw+W+u2TOaMl4KInZG4d1nEQrHcdGkzZ3W95BbfGtk0tBx+K6iEHgT70OG3uPU/IpTzsqJ9X8JdAfhLKGKht/gTgsJ5mqLva53W3h08agSvLykFaDwZXLx9IrQvZL2betV2YLuug0RoVlS9AYRv0ayhIfVv1D56Ag== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get metadata information about this API resource (theme--info)'} +> - - 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 19cc9fbdc83..1f4058808dd 100644 --- 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 @@ -1 +1,103 @@ -{"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"}}} +{ + "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 index d8e409a1266..178cac13dc9 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get names of databases currently available'} +> - - 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 index eccdacad2de..a8f00f72fcb 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index a3c84540baf..a6e65d314c1 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 467e8484a8f..64584db5d2e 100644 --- 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 @@ -1,33 +1,32 @@ --- 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." +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get permanent link state for SQLLab editor.'} +> - - 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 index 90f11632978..1d580ca9227 100644 --- 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 @@ -1 +1,25 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 4ae492932a6..9b1fc4746a3 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index 58d2db9fdfc..2425a709200 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get possible values for a datasource column'} +> - - 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index ca8268fed08..22a74569b26 100644 --- 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 @@ -1 +1,217 @@ -{"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"}}} +{ + "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 index 47eed0b84a4..32840fbb2c2 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-query-detail-information -title: "Get query detail information" -description: "Get an item model" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get query detail information'} +> - - 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 index 12b1e3d5613..73d9d4d47cf 100644 --- 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 @@ -1 +1,29 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 5955b3ccc16..0008b824213 100644 --- 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 @@ -1 +1,104 @@ -{"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"}}} +{ + "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 index 0fb6535a5f9..9a8e033d915 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get recent activity data for a user'} +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 703e57e2ade..8b460fb7f6f 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index 075deac0f02..e17229c2571 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (annotation-layer-related-column-name)'} +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 703e57e2ade..8b460fb7f6f 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index 38ea1e1f247..9a0d0889ecc 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (chart-related-column-name)'} +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 703e57e2ade..8b460fb7f6f 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index 6e3c2b70425..9c05c0a7cee 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (css-template-related-column-name)'} +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 703e57e2ade..8b460fb7f6f 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index 085927bd1ec..0dec70ebef8 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (dashboard-related-column-name)'} +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 703e57e2ade..8b460fb7f6f 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index 7bab2b3d979..a0ecf748ee5 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (database-related-column-name)'} +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 703e57e2ade..8b460fb7f6f 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index 0fcc8114f1a..c191589266a 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (dataset-related-column-name)'} +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 703e57e2ade..8b460fb7f6f 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index b6b716dffad..d6d656dbe68 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (query-related-column-name)'} +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 703e57e2ade..8b460fb7f6f 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index 5f0c13e0b67..086b0bf6668 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (report-related-column-name)'} +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 703e57e2ade..8b460fb7f6f 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index 350920d6d45..4919d1393c1 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (rowlevelsecurity-related-column-name)'} +> - - 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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 703e57e2ade..8b460fb7f6f 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index c63d6088b65..16f798bf37c 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (saved-query-related-column-name)'} +> - - 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-security-user-registrations-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.ParamsDetails.json index 1eb4bf53a1a..d28dad357e2 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.ParamsDetails.json @@ -1 +1,31 @@ -{"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"}]} +{ + "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-security-user-registrations-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.StatusCodes.json index 703e57e2ade..8b460fb7f6f 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.StatusCodes.json @@ -1 +1,95 @@ -{"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"}}} +{ + "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-security-user-registrations-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.api.mdx index 10c552d0a55..d9df33c66f0 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.api.mdx @@ -1,33 +1,34 @@ --- id: get-related-fields-data-security-user-registrations-related-column-name -title: "Get related fields data (security-user-registrations-related-column-name)" -description: "Get related fields data (security-user-registrations-related-column-name)" -sidebar_label: "Get related fields data (security-user-registrations-related-column-name)" +title: 'Get related fields data (security-user-registrations-related-column-name)' +description: 'Get related fields data (security-user-registrations-related-column-name)' +sidebar_label: 'Get related fields data (security-user-registrations-related-column-name)' hide_title: true hide_table_of_contents: true api: eJzFV21v00gQ/iur0X1odQ6hJ06qjPhQUIFyiKuSVHdSXYWtPUkW7F0zuw4Nlv/7aXZtx3nhhLhDfEr2ZWbneebVNZSSZIEOyUJ8W4PSEEMp3Qoi0LJAiCE1eVXouV9FQPipUoQZxI4qjMCmKywkxDW4TcnXrSOll9A0UQ2p0Q6141NZlrlKpVNGjz9Yo3lvK1uSKZGcQsurhcod0hGdESid5lWGc5X5m8phYQcXlXa4ROKb7Y4kkhtel3KJx2/yydyqL0ePt5rM/QdMHUTglMt5Y4luTphLh9m8hdI03kaI4VOFtNmS+AmaOybPlkbbgPK3x4/55zs5Sk0VhDK0KamShSCG2QqFM07mQlfFPZIwC9HaKNYyr9BCdIQCQlvlbofR3efwwZE8/pw/EgU6mUknxcJQ/yIrg30CmVF8+IrtQ0kR3C4IS0KL2nlmtvq2UeGRfYNClaF2aqGQjrDwL56eBCUTz9KkdeJhkH2TBi87bcMlAnyQRZnjwKVnW3fc3vmA2kXVqhIhLwWTzoqe/KdwKtDa3QTZ5vGh/wZG94LwXGaCqwNaF4srvZa5ysS2vIiSzFplmMERTAPZgOXs52K50bJyK0PqC2axuKjcigMnvC/6EngEyFAwIHnyc5G8M04sTKWzWIR08CQj021NRSmKzKAV2jiBD4rpPwTV6+BXfv/ZcXalHZKWubBIaySBRIZicaFFpfGhxJTR+U1h0rSir3jqpeQq6e/5xy2mFSm38W3ww+eQfXcROLnk1gg3FmmCS2Udeah2gtZdXF/BXQQPo9RkOPXGhj6aS73k3nkzeQsR5PIe8+0yEM/rinIx+lu8upyJBFbOlfF4nJtU5itjXXz++Px8LEs1Xp+NO/PGlUWa09CQcVvjxvWgVTcJiCRJtBCj1yKBizYqvUQsnqMkJPHLxYsXl9PpfPbnH5fvEgDu2a3l1xu38sW2s73f6K1XRWnIdSFlE53orsGJZ/32oyW6E7ZD/ACIUVC8Qpkh2Wf1HtAEYpFACzYB8auQaYrWzp35iLpJ9GmiS1LanXSGP+IAPjk9HVLxRq7l1EfOgI6dza1DjbbMSM+C/CyVEwt06cqT8IMoqHd4iLu12Pc8E/K+c34dyJh5Lt4HiYZ/mJiniQ5gfFPvgOzR1F4yOT7KzfKEr54+9ZPObq69Qtc34oXCPLNB7UmHd8R4Rzt4R63AKMAdMdxTiKBAtzJZGL8gCrNqDN9NIHvP15GQtxWxc4/6CPZRveVjkeEac1MWqF1bkXzsBEV1ScaZ1ORNPB7XrKqJa86a5kDbi8o6U3QqeKYhJe9z7IYxrybMOAvppwNvJkSAuiq4QrVL/rFw4IPXs9m16PU0EbA1u/p6vAfGTUOp5TNmTRgSV9d+dja0p+QoVa28v900HCCdo/wkFED6olvDvQ/Pl4YKyfre/DWD9jODMyycbsc3D7qJWHhOuCC0q+9V4kf3hTmcI6dViWRxOM8Ntjh2wr31WaDEukL6LtgO//9n+O9Y1jdRHqjHZS6VZgt87NVtatyCLBWbeQaDJhfBYYL4rzv/KEQQDz/77rpouYW6vpcWbyhvGt4OnzmcOXuG9fMBbGnetfIjbvyHUT++g68cXdwHpcry/wzihcwtHsDfvnIyaaeyU/G1B7thXW+Gb3aGDPE2d5wfvph6M8KNizRFX+472YPBh+3v69OrS445HgcHjuojr/3D2o/aVdfhRqjOTW+m71xsYNP8AzuVfkY= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get related fields data (security-user-registrations-related-column-name)' + } +> - - Get related fields data (security-user-registrations-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 index 1eb4bf53a1a..d28dad357e2 100644 --- 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 @@ -1 +1,31 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 703e57e2ade..8b460fb7f6f 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index d64e8858c8b..529d5a5ea70 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (tag-related-column-name)'} +> - - Get related fields data (tag-related-column-name) - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.ParamsDetails.json index 1eb4bf53a1a..d28dad357e2 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.ParamsDetails.json @@ -1 +1,31 @@ -{"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"}]} +{ + "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-theme-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.StatusCodes.json index 703e57e2ade..8b460fb7f6f 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.StatusCodes.json @@ -1 +1,95 @@ -{"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"}}} +{ + "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-theme-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.api.mdx index 2e2c7c6023b..3d533f1450d 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.api.mdx @@ -1,33 +1,32 @@ --- id: get-related-fields-data-theme-related-column-name -title: "Get related fields data (theme-related-column-name)" -description: "Get related fields data (theme-related-column-name)" -sidebar_label: "Get related fields data (theme-related-column-name)" +title: 'Get related fields data (theme-related-column-name)' +description: 'Get related fields data (theme-related-column-name)' +sidebar_label: 'Get related fields data (theme-related-column-name)' hide_title: true hide_table_of_contents: true api: eJzFV9tu2zgQ/RVisA8JVqmbRRcIVPQhLdLbFt0idrELRIHLSGObLUWq5MiNK+jfF0NKsnzpomgf+mTzdnjOzHBm1EAlnSyR0HlIbxpQBlKoJK0gASNLhBRyq+vSzMMoAYefa+WwgJRcjQn4fIWlhLQB2lS83ZNTZgltmzSQW0NoiFdlVWmVS1LWTD56a3hue7ZytkJHCj2PFkoTuiOYCSiT67rAuSrCTkVY+tFGZQiX6HhnNyOdkxseV3KJx3fyytyrr0eXt0j27iPmBAmQIs0TS6S5Qy0Ji3knpW0DR0jhc41uszXiZ2hv2Xi+ssZHlX88fMg/P2ij3NbxUIE+d6riQ5DCbIWCLEktTF3eoRN2ITqOYi11jR6SIyZw6GtNOxbdvQ7vycnj14UlUSLJQpIUC+uGGxkM9g3IFsX7b3AfnxTR7cJh5dCjoWCZLd42KoKy7wBUBRpSC4XuiBX+x9PXEeQ6WOm6c+JhkH0XQjg77cIlAbyXZaVx5NLzrTtubkNA7arqoER8l4KNzkCPfiqcSvR+94Fs3/Gh/0akh4PwVBaCswN6SsUrs5ZaFWKbXkTl7FoVWMARTaOzUcv5r9Xy3siaVtapr1ik4rKmFQdOvF8MKfCIkPHBqOTRr1Xy1pJY2NoUqYjPIRgZ2dze1i5HUVj0wlgSeK/Y/IeiBgy+5c9fHWevDKEzUguPbo1OoHPWpeLSiNrgfYU5qwuTwuZ57b7hqeeSs2TYFy73mNdO0SaUwY9f4uu7TYDkkksjJ5MSPdwmcH+W2wKngVqsmlqaJVfK99dvIAEt71Bvh9HMPK6dFmf/ihdXM5HBiqhKJxNtc6lX1lN68fDiYiIrNVmfT4gvm3S5a9KMSnCbgciyzAhx9lJkcNlFW7B+Kp6idOjEb5fPnl1Np/PZ339dvc0AuBZ3HN9taBWSaM9ymBh4qrKyjvpQ8ZnJTF+4xJNh+sES6YR5iJ8Sk0SIFcoCnX/S7EnKIBUZdLIyEL8Lmefo/ZzsJzRtZk4zUzll6KSn+IBD8OT0dCz6tVzLafD9SPjO5NZJ1njWPuiVX6QisUDKV0HuT4ttdhSn/Vjse5Olf+gd2kTZs6D6QzzR8g+b4HFmIu1QgHvKewbpNlmND7RdnvDW08ehK9l9Fy+QhqK5UKgLH2FPgrKzbuksCjtjYaeQQIm0skVsiiCJHWQK32EUtn14x/El1Y5dc9TCsM/0DS+LAteobVWioS4jBM9HoKZylmxudZtOJg1DtWnD0d0eoD2rPdmyh+Cewil5p7FvhgJM7DEWMlTnQBMSQFOXnCG6If+EPLGL/3I2eycGnDYBZrOLN+g9IDeNqY7X2GrCOvHqXehdrdsDOWqq7nzY3bbs9D7dhU4kigxJr4G7EHLPrSsl473+ZwZdm8/vI65u26cguk348NzhwqFf/ShIaJ0X9rCPm9YVOo/jfmo0xbET963Po0k8lTJUoa75/rGQ3uEwlCtuXSeVlsrwXSHKmi7cb0BWigmdM9EglVu5AA4JpOMPqdve/zfQNHfS43un25an44cDv4U9AkPFha3hdtl8wk341BgaYgjvu4/kCKo8/y8gXUjt8UDm9paT667PORXfurBvf81mfGdPZKy3veWIDykv0Ig7LvMcQ/rtzx60Esx/yC0vrjiKuMEaOWSIpe4Pox/l1TRxR8yh7UAzVBIm2Lb/AQHFNo4= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get related fields data (theme-related-column-name)'} +> - - Get related fields data (theme-related-column-name) - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.ParamsDetails.json index 6e30d8d423b..df51d27cef4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.ParamsDetails.json @@ -1 +1,38 @@ -{"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"}]} +{ + "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-groups-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.StatusCodes.json index 5bb59253c14..1e926fe2539 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.StatusCodes.json @@ -1 +1,163 @@ -{"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":{"description":{"maxLength":512,"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":150,"nullable":true,"type":"string"},"name":{"maxLength":100,"type":"string"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"GroupApi.get.Role"},"users":{"properties":{"id":{"type":"integer"},"username":{"maxLength":128,"type":"string"}},"required":["username"],"type":"object","title":"GroupApi.get.User"}},"required":["name"],"type":"object","title":"GroupApi.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":{"description":"string","id":1,"label":"string","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"}}} +{ + "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": { + "description": { + "maxLength": 512, + "nullable": true, + "type": "string" + }, + "id": { "type": "integer" }, + "label": { + "maxLength": 150, + "nullable": true, + "type": "string" + }, + "name": { "maxLength": 100, "type": "string" }, + "roles": { + "properties": { + "id": { "type": "integer" }, + "name": { "maxLength": 64, "type": "string" } + }, + "required": ["name"], + "type": "object", + "title": "GroupApi.get.Role" + }, + "users": { + "properties": { + "id": { "type": "integer" }, + "username": { "maxLength": 128, "type": "string" } + }, + "required": ["username"], + "type": "object", + "title": "GroupApi.get.User" + } + }, + "required": ["name"], + "type": "object", + "title": "GroupApi.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": { + "description": "string", + "id": 1, + "label": "string", + "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-groups-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.api.mdx index 2b8c2865023..3f2ee8913d4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.api.mdx @@ -1,33 +1,32 @@ --- id: get-security-groups-by-pk -title: "Get security groups by pk" -description: "Get an item model" -sidebar_label: "Get security groups by pk" +title: 'Get security groups by pk' +description: 'Get an item model' +sidebar_label: 'Get security groups by pk' hide_title: true hide_table_of_contents: true api: eJzFWG1v2zYQ/isHYh8STI3joB0CFf3gZmmaruuKOlkHxIFLS2dbDUWqJOXEE/TfhyMlWbbl1ssG5JPNlzs+z73xqILFaCKdZDZRkoXsAi1wCYnFFFIVo2ABy7jmKVrUhoU3BUtoX8btnAVM8hRpdMcCpvFbnmiMWWh1jgEz0RxTzsKC2WVGuxJpcYaalWVQsEhJi9LSMs8ykUScEPS+GoJRtIQzrTLUNkFDo0iJPJXuL2E0LfXG6kTOWBnUE1xrvqTxHS7XJVDmKQtvmJmr+3GtMmibojUr+ARFa+yEbGIFkgGURHYb/AjDakJNvmJkWcC8hpDN0I4J2LiiXNJmZ+NvOerlysjfWHlLVjaZksZb4+T42BvlUbbsorvD4GOPodiIlqs5QmsGpkqDnSN4ISChI/icCAETBKu5NIJbjGGyhAlZlQUMH3iaOUMM4EMSfU8f2zLzllnJdHE3ThfSSbytZNPD/94ETv5/Id+laT/aGk0u7HedTMOUP7xHObNzFr7onwRM5kLwCUHwSbtlG2/OzQyubLahsf/ieA+NtR3bgsfHHRu1Etjhjl2IOvT+8rzLdqtCdeOFbndn54VWeTbIkqMZ2qNPSiCdlBtXC/cFRtu7SJ+c/ghdI7kvwmvj6+ujORLetaq4FfADEImxoKawKon7l+JW8ezQ7BbAKtAoY9T7p89wru7hkjL8V7Q8EWa/pGkU7CyGa7m/R4mqMqY+taO2dGrszPu1rF43VaOeDus32biar9SvHLHu1Jt65XbdJR2GdPfR+ulufapVCr+7FqEM2PP/dBOlaAyfYUcE/cBrjSB7zWOgoEdjQ7iUCy6SGFadC2RaLZIY4y4+LVnPpf+0XK4lz+1c6eRvjEMY5HaO0lbnQ5PZHUTagp7J86dl8kFZmKpcxiHQRVkZGcncRuWackmhAaks4ENC5t8m1ehwjE5Onto3mVYRDScCgfxilyH8SeHm/YNaK93F40zlInZUKw2VNB314qnT51JaumoEGNQL1J5FCAMJucSHDCNympsEFUW53hGAb7jlojFBwAxGuSaO9HD4em9ZeHNLXazlM1eFhtU6uDvIUDkiYo72ZVx1x7WS8cxtGk+WY/fgeHgWqRiHjo1/mgguZyxk0fWn92xVFKuhDzga51rAs7/g4vwKRmxubRb2ekJFXMyVseHp8elpj2dJb9Hv1Uf3/NG9/ojBaDSSAM/ewogNqmxzeEN4jVyjhp8GZ2fnw+H46o/fzj+MGKPnToXs49LOlWxhayYadEmaKW3rVDEjOZJ1zw+vmmm6qw8IBzyCQuAF58hj1OZVsUFkxEIYsYrMiMHPwCOK17FVdyjLkTwcyUwn0h7UwI4oQg8OD9tU3/EFH7rQaNFdm1w5RElDjBuW/J4nFqZoo7kj+UiKxRrPsB7DpueI8JfaeYUne+W4fvESJf0Q8Zcj6cHG3PIG6IYZqk1K4JFQswPaevjSPd5StHNVhbV7WFMfyHbRKLK7kszkMtIHeK7Jip3GYJu5+J6WIcYFCpWlKG2V285JXlGRaWVVpEQZ9noFqSrDgsKv3NJ2lhur0lpFwBZcJ1QC6z7YqfGNypS7nsXBpC6temxXQ/pxib6u/+3V1Udo9JQBIzTr+hq+W+CGvmjRGjU+oDRcfiQlxGVdSaepKnm3uyzJU7UvhlRyPUlXvgo2cXHyRumUk753n69Y9a2DQtmvrrpPR7oMSHiscarRzB+rxH0WmKrtZnCYZ6gNtlv61hTFjt+36HuTGJtyd59UTSJ986n5go896rJdjd14PjYXVOeHogquxQfbywRPXAvrIq2oYv2G8SwhUH3WuhwC5k9lAQuzO4oN7/wbVhQTbvBai7Kkaf9FhBJhJ65dMO5w6b6hUOSKnNZdRtZh7JUm7laPWTjlwuB32B98qrqwQ9h1YP3ykcv2mTWQ7I6VtxTlrja50/3CIIrQVcdaZKsRWCskF+cUOdT1tW7/Jn6qP6S9E05R+B2+2JUNOlfoCWBZ/gN3jPOT -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security groups by pk'} +> - - Get an item model - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.ParamsDetails.json index beb41857879..3d1c6a5cb18 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.ParamsDetails.json @@ -1 +1,53 @@ -{"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"}]} +{ + "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-groups-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.StatusCodes.json index da2fced086e..33661b3603b 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.StatusCodes.json @@ -1 +1,100 @@ -{"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"}}} +{ + "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-groups-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.api.mdx index 66287ed15c1..d0b68697025 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.api.mdx @@ -1,33 +1,32 @@ --- id: get-security-groups-info -title: "Get security groups info" -description: "Get metadata information about this API resource" -sidebar_label: "Get security groups info" +title: 'Get security groups info' +description: 'Get metadata information about this API resource' +sidebar_label: 'Get security groups info' hide_title: true hide_table_of_contents: true api: eJzNV21v2zYQ/iuHwz4kmBo3xQYUKvohDdI0ew3mdB0QBy4tnW02FKmSlBtX0H8fjpQcyXYyrB3QfZJE3h2f5954qjEnl1lZemk0pnhOHgryIhdegNRzYwvBWyBmpvLgl9LByeUFWHKmshlhgqWwoiBP1mF6XWNmtCftMa1RlKWSWdAffXBsv0aXLakQ/FZaU5L1klyQzfNpZlRV6O5Tsp5QlwOxoVIpFsRPvy4JU5Ta04IsNknYmTr5ee92k3RLZvaBMo/7FiiX/v+F6JbW4QzpqQgvpKsC0+uB77aAJziXKsQmwZJsIZ2TJqyzkpdeUafSfWijCW825ztvpV70AAlrxXoP5ASjhRQX5KecO9M22A0LS06vjxXZNZ8hChb8iM1NgpZcabSLDnz29Ck//pss+seg7gh03tqxHJWmEXgvBkOpbntYVFdLgmgYWOAI3kmlYEbgrdBOCU85zNYwEzNSuMfxfILwxj5qOQpxqd7SGryByhEYDUo6D/dJsGX8kcR7KM7NMJP2YqocWehJwdzYvc1j48d/m20czDtRlIp2474b6GFkB7G8rpubbUrXHY6bkLpDfheeCphbU8CvJifFSH74qqQtyLlh23gsOj3WG0V8JXKw9LEi51O40CuhZA73jRlKa1Yypxz38OnpRi7H35bLWy0qvzRWfqY8hZPKL0n79vwAVNr9RPqKgcmzZ9+aSWlNxp8zRcAs/DqFPzk4kQ1Za+w+KqemUjlo46G10GrzUT9+62S70J6sFgoc2RXZyCKFEw2VpruSMu5nYRFMllX2gXC9Fl6ojQsSdJRVljnyFPHhk8f0+oavBy8WoSTH7T6cW1OVjq+oTc+7yNtrpzMyXQShabiHMMG7J5nJaRzYxDlFCb3AFLO3f/yCCarQezefbX9KMausgid/wfnZFUxw6X2ZjkbKZEItjfPp86fPn49EKUer41F39CgePQpHTxAmk4kGePIGJnjS5mfAnMIrEpYsfHdyeno2Hk+vfv/57LcJYpNs0F2u/dLoHr7NwgahLEpjfVfBbqInurtQ4eVm+WhB/oBxwBfSSKLykkRO1r2st8hMMIUJtoQmCN+DyDhvp97ckm4m+nCiSyu1P+jAHXGmHhwe9un+JFZiHFKkR3mweB8Yox2z3jAVn4T0MCefLQPRr6BZD7im3TdsR5BJv++CWEfCV4Hv+6jR8IPJv5joCDjM1R3YLVe0QkbRkTKLAxY9fBEmpIL80rQpHiZuv8QUH6XCvgrlGbO9suzKvR7B7cL8hbchpxUpUxakfVvoIVLRUF1a401mVJOORjWbatKa87DZsXZaOW+KzkSCK2El98Nuegpm4hQxF5XyLUyeStvxtv3kR6j6of03V1eXsLHTJMhohvY2fHfAjWMH4z2eBsBYuLgME46xW0b2uqrVD9JNw6HqgjHm/htJhl5W4ywkyuvwR8Vp/e6KYxTEMG137we0QLpJWHlqaW7JLb/USBi+52Z3UhtXJVlH/dG9t8S5E+VWx9ElzhdC34+54Wex4wsx+QDa5Buc1LutvuQPs2Xj6c6PSiWkZjghEeu2Fq5RlJIxH2PvIkkwgsIEY03cdNlxjXU9E47eWtU0vBx/TLhSHgT+EJBbWodfGU5tVfF+qNkuz8M1lmBsJuGEqHCSZRRaWqe1c4sPKv/8jCPNA07v6t7Eu31h693crNc923UdJWJ34iKNIEJ3xobH3L8BX6WVww== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security groups info'} +> - - Get metadata information about this API resource - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.ParamsDetails.json index 5917115e126..c85fdd981cb 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.ParamsDetails.json @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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-groups.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.StatusCodes.json index a0c8cd60714..6cd1827ffeb 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.StatusCodes.json @@ -1 +1,163 @@ -{"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":{"description":{"maxLength":512,"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":150,"nullable":true,"type":"string"},"name":{"maxLength":100,"type":"string"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"GroupApi.get_list.Role"},"users":{"properties":{"id":{"type":"integer"},"username":{"maxLength":128,"type":"string"}},"required":["username"],"type":"object","title":"GroupApi.get_list.User"}},"required":["name"],"type":"object","title":"GroupApi.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"}}} +{ + "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": { + "description": { + "maxLength": 512, + "nullable": true, + "type": "string" + }, + "id": { "type": "integer" }, + "label": { + "maxLength": 150, + "nullable": true, + "type": "string" + }, + "name": { "maxLength": 100, "type": "string" }, + "roles": { + "properties": { + "id": { "type": "integer" }, + "name": { "maxLength": 64, "type": "string" } + }, + "required": ["name"], + "type": "object", + "title": "GroupApi.get_list.Role" + }, + "users": { + "properties": { + "id": { "type": "integer" }, + "username": { "maxLength": 128, "type": "string" } + }, + "required": ["username"], + "type": "object", + "title": "GroupApi.get_list.User" + } + }, + "required": ["name"], + "type": "object", + "title": "GroupApi.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-groups.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.api.mdx index 4f3f765059d..940b4f888dd 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.api.mdx @@ -1,33 +1,32 @@ --- id: get-security-groups -title: "Get security groups" -description: "Get a list of models" -sidebar_label: "Get security groups" +title: 'Get security groups' +description: 'Get a list of models' +sidebar_label: 'Get security groups' hide_title: true hide_table_of_contents: true api: eJzFWG1v2zYQ/isHYsASTI2TYB0CFf2QBmmaLmuLOlkHxIFLS2dbDUWqJOXEFfTfhyMlWbLlLGkH9JMtkne8514eHlmwGE2kk8wmSrKQnaEFDiIxFtQUUhWjMCxgGdc8RYvasPC6YJGSFqVlYcF4lokk4iQ++GJIR8FMNMeU079Mqwy1TdDQV6REnkr3N7GYuj92mSELmbE6kTNWBvUA15ov6XuaCL9vS2hDba8mlene8QUXOTrb5fL91AGq1sg8naBmZbAp1YxMlBLIpRtqDPoxTTcbsG/KMmAav+aJxpiF1w6jR1Tbf9PIqMkXjGyf725x2XUcyjwldRTgcR2OgCkdo259Cz5B0fpu5Uh7FSmxiRXIAiaVbNu0PZ7tvfrD5hbEicbIJ+XKbG6iyprerTI+w5bKRFqcuSC4mbFJvm2ZNigwWjnkCflZrkchYN4jIZuhHTsXVeVQ0uKEiuxrjnpJPuMpLfzKyhuKtsmUND6lD/f3fWZ/Z53lXqhb25dzBKssF6AxUjoGtw6UBDtHmPDoFmXMgo0U7g3/luIee0x9W7dGYKq029QLAQntwadECJggWM2lEdxiDJMlTCgXWcDwnqeZc+wxvEuih/SxjdzYCBOFIjabhh433EcZAElsAsgNTnMBd3OUsFQ5xEr+auFWqrs2hoRc93ha65bY073p5P8XP/ZpepwHOyzygCtXlPEE/6zIpUezmwCrQKOMUT8e8wWZdO6s6CGQLg8+gIgLoe4wrpGRJUZp+ySEGk0utpSpn4OpVqmLygyt37umji1HYUdTwVJ+f4FyZucsfH5wGDCZC8En5Airc+xxQBL3E6TLkTWNB8/3H6GxzuC24P5+z0KtBPYg2mZRj94/fu/L2vYp6oQ2Ds4VZZ9plWfHWbJXc/feRyWQtstN1YM8zjpa3of88Oi/TGwkn2TmlaF9fxTtI463slVMzUFzsPWI6NDYI4i7puXr2j03PUzZq7SXxTY4qqO3xTBdXlijgbZQXbTXBfVo3bORhcxp8GX7F/XOZMHvP3SWp2hMt615iJFbsWkE2SseA+UFGhvCuVxwkcSw6ugh02qRxBizHkAtWY/l4OdiuZI8t3Olk28Yh3Cc2zlKW+0PTfL3AGkLOiSHhz8bSaZVRJ8TgUAo7DKEvyk4Hg1qrXQflBOVixikslBpqKRpq+c/O9nOpSUCE2BQL1B7FCEcS8gl3mcY0dHsBkFFUa63hOs1pz61dgF16FGuCSPdsb7cUQXeUNds+cxV6LCaB0dqhkqVgDnY53HVjddKxjO/KGD3zyIV49Dh8FdbweWMhSy6+njBmnOv/jQq1xGhjHIt4Nk/cHZ6CSM2tzYLBwOhIi7mytjwaP/oaMCzZLA4GNSbDvymgxGD0WgkAZ69gRE7rpLSGRrCK+QaNfxyfHJyOhyOL9//efpuxNylsTLsw9LOlWyZ1gw0xiVpprSty9aM5EjWlwt42QwT6++QHfB0BIGXmyOPUZuXxRqOEQthxCosIwa/AY8oT8dW3aIsR3J3JDOdSLtT27VHmbmzu9tG+pYv+NClRAttZ3AVDiUNAW5A8jueWJiijeYO4/chLDoww/ob1uNGeD/XoSs81ksH9bOXKOmHcL8YSW9rzC1v7FzzQrVICdwTarZDS3dfuDtiinauqmx2rzLUVLBtKMhDrgh9ZueaHNjrB7Zefhc0DTEuUKgsRWmrcnbx8YqKTCurIiXKcDAoSFUZFpR45Ya2k9xYldYq6AFDJ8R6dUPl1Pj2dcrd8erMpMa9uvhXn/Tjarur/83l5Qdo9JQBI2u6+hq8G8YNPU/RHHUUoDScf3BvBtTQd5T0uqqSd6vLkqJUx2FILOtBOsYq2MTlyGulU0763n66pBi5ZfQe5GZX9xIHugxIeKxxqtHMv1eJe3mYqs3LxjDPUBtst4WtIcodv25x4F1ibMrdEVJ1X/ReWOOFhlbXriHNabTtebGy1eK9HWSCJ65zc2lWVEl+zXiWkEUHrHUYBKzZkrLCh/2aFcWEG7zSoixp2N+ZqAS22rXNhltcugea5tGQuTqsE9idQgHzBOF28ALHUYSOoWqpjUO4U81npxRC6k9aJ28TyOpP63GRy2VLd1H4FZ5xqPq8EY5s3VNi+S/VWJQk -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security groups'} +> - - Get a list of models - + 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index de3f23619c2..71d2ffdfaa6 100644 --- 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 @@ -1 +1,130 @@ -{"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"}}} +{ + "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 index 65ae3e576fe..2c60f131b6b 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-permissions-by-pk -title: "Get security permissions by pk" -description: "Get an item model" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security permissions by pk'} +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index ad4cbe38877..1aef13bc24b 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-permissions-info -title: "Get security permissions info" -description: "Get metadata information about this API resource" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security permissions info'} +> - - 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bee995032a1..38da89c49d7 100644 --- 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 @@ -1 +1,144 @@ -{"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"}}} +{ + "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 index ecf1774159e..4af36928aa8 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security permissions resources by pk'} +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index a6605cab956..552a9d18581 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security permissions resources info'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 51d8204b03f..66a8706cfa5 100644 --- 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 @@ -1 +1,149 @@ -{"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"}}} +{ + "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 index 0ba4fa25c65..0202a7f000b 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-permissions-resources -title: "Get security permissions resources" -description: "Get a list of models" -sidebar_label: "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: eJzFWG1P3DgQ/isj66QD3cICukpVqn6giLb0aIsKbU9i0dabzO66OHZqOwvbKP/9NHaSTdgsgranftqN7RnPMy+Pxy5YgjY2InNCKxaxV+iAgxTWgZ5CqhOUlg1Yxg1P0aGxLLosWKyVQ+VYVDCeZVLEnMSHXy3pKJiN55hy+pcZnaFxAi19xVrmqfJ/hcPU/3HLDFnErDNCzVg5qAe4MXxJ31Mhw74toTW1vZp0ZnrHF1zm6G1Xy/dTD6hao/J0goaVg3WpZmSitUSu/FBj0M9pulqDfVWWA2bwWy4MJiy69BgDotr+q0ZGT75i7Pp8d43LruNQ5SmpowCP63AMmDYJmta35BOUre9WjrRXkRInnEQ2YEqrtk2b49neqz9sfkEiDMYhKVdmcxtX1vRulfEZtlQK5XDmg+BnxlZ83zBtUWK8csgj8rO8G4UBCx6J2Azd2LuoKoeSFgsqsm85miX5jKe08BsrryjaNtPKhpQ+2NsLmf2DdZYHoW5tX8wRnHZcgsFYmwT8OtAK3BxhwuNrVAkbrKVwb/g3FPc4YOrbujUCU238pkEISGgXPgspYYLgDFdWcocJTJYwoVxkA4a3PM28Yw/hnYjv08fWcmMtTBSKxK4bethwH2UAiMQOILc4zSXczFHBUueQaPWng2ulb9oYBLnu4bTWLbHHe9PL/xI/9ml6mAc7LHKPK1eU8Qj/rMilR7OfAKfBoErQPBzzKZl04q3oIZAuD96DiEupbzCpkZElVhv3KIQGbS43lGmYg6nRqY/KDF3Yu6aODUehSDbwH5pUWFvRaVemzrGU356imrk5i/b39voSoH0geam1M2jFfmfNjp8E3rxFlR9mYrfmxN3VtD+RBd6MU1T5g6w7ePJ/W1cP3svv9+t4wFFRthKzIe39jXTboYQHkGBNcZe1k656WKdXaS8jrNV7R2+rWrs1dqek2kJ1AVwW1O90zxkWMa8hlMBb6kPJgr9/6lxM0dpui3Afu7Vi0wiyFzwBSjS0LoITteBSJLDqjiEzeiESTFgPoJZswLL/e7F8VDx3c23Ed0wiOMzdHJWr9oemmnqAtAU9koOD340kMzqmz4lEIBRuGcEnCk5Ag8Zo0wflSOcyAaUdVBoqadrqye9OthPl0CguwaJZoAkoIjhUkCu8zTCmY84Pgo7j3GwI10tOPV/tAup249wQRrqvfL2hCryiDtTxma/Q82oeVgxnqUv8gFbnJkYLW8R4QJRnt6mSCbf3yklSNb71HuPVyWPHplbABux2J9YJnnvU4VIpuZqxiMUfP5zWV5DVZxCk79xI2PkXXh1fwIjNncui4VDqmMu5ti56uvf06ZBnYrjYH9Y2DFs27DQ2DEcMRqORAth5DSN2WGW0hxHBC+QGDfxxeHR0fH4+vnj/z/G7EfO3t8rOs6Wba9WytBlobBVppo2ra96O1EjVXT48b4bpyNgiO+CnAQ2CmjnyBI19XtyBNWIRjFgFbcTgL+Ax5fzY6WtU5Uhtj1RmhHJbtZm7lOVb29tt4G/4gp/79GqB7wyugqWVJfwNZn7DhYMpunjuIf8SwEUHdVR/w92oEvwvdWCLAP3CI/8SJEr6ITc8G6lgesIdb8y+45RqkZa4K/Vsi5ZuP/NXuRTdXFeV4B9PqGthDwRF/vPlHqoiN+TeXi+xu4V+StOQ4AKlzlJUriIOH72gqMiMdjrWsoyGw4JUlVFBWVquaTvKrdNprYKeHYwgfq3bTq8mtK9T7g9ybya129V1vfqkH0s00dX/+uLiDBo95YCRNV19Dd41484DI9Ic9S6gDZyc+U6X2vCOkl5XVfJ+dVlS0OqwnBOfB5CeGws28SnzUpuUk743ny8oRn4ZveL42dVtwoMuByQ8Njg1aOc/qsS/F0z1+hXhPM/QWGx3o60hyp2wbrEfXGJdytWqm/avfDVeaKUhtBm6s2XrGNz0RliZ7vDWDTPJhW8ZfdYVVQlcMp4JMnCftU6h9u2kVQhswChnQlJcsqKYcIsfjSxLGg73ICqQjWZuMukal/7RpXkIZL5o6/T2p+GABTbxOwSBwzhGz2611Foz0Cn9V8cUYOqTWh1AE+bqT+vBkKtlS3dRhBWBnqg2gxGeqP3zYPkfqTCR0g== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security permissions resources'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 6967236bb32..8be1c06b82d 100644 --- 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 @@ -1 +1,135 @@ -{"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"}}} +{ + "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 index e16e0a0b28a..245bf79013e 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-permissions -title: "Get security permissions" -description: "Get a list of models" -sidebar_label: "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/isHYsASTI2TYgMKFf2QBmmbrmuDOV0HxIFLS2ebDUWqJOXEFfTfhyMlWYrlIGkH9JPNlzvec/fc8aiSpWgTI3IntGIxe40OOEhhHeg5ZDpFaVnEcm54hg6NZfFlyRKtHCrH4pLxPJci4SQ++mJJR8lsssSM07/c6ByNE2hplGhZZMr/FQ4z/8etc2Qxs84ItWBV1ExwY/iaxnMhw7kdoS21g5p0bgbnV1wW6G1X6w9zD6jeo4pshoZV0bZUOzPTWiJXfqo16Mc0XW3BvqqqiBn8WgiDKYsvPcaAqLH/qpXRsy+YuCHfXeO67zhURUbqKMDTJhwR0yZF0xlLPkPZGXc40t1FSpxwElnElFZdm3bHs3vWcNj8hlQYTAIpN2Zzm9TWDB6V8wV2VArlcOGD4FemVnzbsWxRYrJxyCP4Wd2NQsSCR2K2QDf1LqrToaLNgpLsa4FmTT7jGW38yqorirbNtbKB0k8PDwOzvzPPiiDUz+2LJYLTjkswmGiTgt8HWoFbIsx4co0qZdEWhQfDvyO5pwHT0NGdGZhr4w8NQkBCB/BJSAkzBGe4spI7TGG2hhlxkUUMb3mWe8cew3uR3KePbXFjK0wUitRuG3rc1j5iAIjURlBYnBcSbpaoYK0LSLX61cG10jddDIJc9/Cy1k+xx3vTy/8vfhzS9DAP9qrIPa7clIxH+GdTXAY0+wVwGgyqFM3DMb8jk868FQMFpF8H70HEpdQ3mDbIyBKrjXsUQoO2kDvSNKzB3OjMR2WBLpzdlI4dV6FIhwtcw6OM375DtXBLFh8dHg4FuXvpeKmte2ZT4c7RZMJaodVxLg6aeveAIll1QtKWq6OdhaaXDA9I/ya5LxtgVwP5Nqh0MBe2mN7T2+Fpn113yNQVakJ/WdJN36+wLGZeQwj+X9SBkQW//9CNkKG1/cvxvrzuxKYVZC95CkQOtC6GM7XiUqSw6QshN3olUkzZAKCObMBy9HOxfFS8cEttxDdMYzgu3BKVq8+HNgMGgHQFPZKnT382ktzohIYziUAo3DqGfyg4AQ0ao80QlBNdyBSUdlBrqKXpqD9+NtnOlEOjuASLZoUmoIjhWEGh8DbHhAq8nwSdJIXZEa5XnLqdxgXU5yWFIYzUqX+5oQy8ot7L8YXP0HG9DpvKZilfCZ3HfpbWjV2jaZp3dkbs9kmiUxx7ROGpJLlasJglH/9+1zTWm6HVhUkIb1IYCU/+hdenFzBhS+fyeDSSOuFyqa2Lnx0+ezbiuRitjkbNyaPOyaMJg8lkogCevIEJO6456k2O4SVygwZ+OT45OR2Ppxcf/jx9P2H+JVJbd752S6069rUTrYUiy7VxTRbbiZqopmOFF+00XQJ7ZAd8J4woCC+Rp2jsi/IOmAmLYcJqQBMGvwFPiLtTp69RVRO1P1G5EcrtNcYdEFv39ve7cN/yFR97mnQg9yY3gdHKEuoWKb/hwsEcXbL0QH8AZtnDGjdjuBtBAv25CWIZAF94vJ+DREU/BP75RAWDU+54a+wdV9SbtMQDqRd7tHX/uX+CZOiWuma4f/RTn8DuhUK+8ika2F4YcuWgR9jd5HxHy5DiCqXOM1SuTnYfqaCozI12OtGyikejklRVcUk8rLa0nRTW6axRQY9kI6gmNk2SVxOarTn3l683k5rD+nFZD+nHJ31f/5uLi3No9VQRI2v6+lq8W8aNQxWjNeo3QBs4O/fvUmoae0oGXVXL+91VRaFqgjGmGhxA+npWspknyittMk763n66oBj5bfTNwa9uel8PuopIeGpwbtAuv1eJf93O9XZDOy5yNBa7nWNnirgT9q2Ogkusy7i/YOrejL5JNXihX297B3UurF3fsWqDHd66US658M2d51pZ0/2S8VyQWUesc19ErH8u8SMQ4JKV5Yxb/GhkVdF06NApGXYat8uQa1z7zwHtJyrm07Khsr+tIhbqhT8hCBwnCfqq1UhtXda95H59SsGkPqZzQ7chrf90PmVxte7oLsuwIxQgysNghC/A/sNV9R8XpQ6l -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security permissions'} +> - - 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index f6642d93a45..4cf10ccc981 100644 --- 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 @@ -1 +1,130 @@ -{"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"}}} +{ + "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 index b57437ae3a5..3c64ba879f6 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-resources-by-pk -title: "Get security resources by pk" -description: "Get an item model" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security resources by pk'} +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index a6d6412063b..42c5895e65a 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-resources-info -title: "Get security resources info" -description: "Get metadata information about this API resource" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security resources info'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 2337cd4fec9..eae1f3017ec 100644 --- 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 @@ -1 +1,135 @@ -{"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"}}} +{ + "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 index 94cf7c18dc9..7c9f51f896b 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-resources -title: "Get security resources" -description: "Get a list of models" -sidebar_label: "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/iuEcMC1uKxpixsweNiHrui27roXLN12QFNkis0kWmXJk+S0meH/fqBkO3bjFG13wD4leiHFh3xIUS5YgjY2InNCKxax1+iAgxTWgZ5BqhOUlg1Yxg1P0aGxLLooWKyVQ+VYVDCeZVLEnMSH3y3pKJiNF5hy+pcZnaFxAi2NYi3zVPm/wmHq/7hVhixi1hmh5qwc1BPcGL6i8UzIcG5LaENtryadmd75JZc5etvV6sPMA6r2qDydomHlYFOqmZlqLZErP9UY9GuaLjdgX5blgBn8kQuDCYsuPMaAqLb/spHR0+8Yuz7fXeGq6zhUeUrqKMCTOhwDpk2CpjWWfIqyNW5xpL2LlDjhJLIBU1q1bdoez/ZZ/WHzGxJhMA6kXJvNbVxZ03tUxufYUimUw7kPgl+ZWPFzy7JFifHaIQ/gZ3k7CgMWPBKxObqJd1GVDiVtFpRkP3I0K/IZT2njD1ZeUrRtppUNlD7c3w/MfmSe5UGom9vnCwSnHZdgMNYmAb8PtAK3QJjy+ApVwgYbFO4N/5bkngRMfUe3ZmCmjT80CAEJ7cFXISVMEZzhykruMIHpCqbERTZgeMPTzDv2CN6L+C59bIMbG2GiUCR209CjpvYRA0AkdgC5xVku4XqBClY6h0SrPx1cKX3dxiDIdfcva90Ue7g3vfz/4sc+TffzYKeK3OHKdcl4gH/WxaVHs18Ap8GgStDcH/MZmXTqregpIN06eAciLqW+xqRGRpZYbdyDEBq0udySpmENZkanPipzdOHsunRsuQpF0l/gah6l/OYM1dwtWHT4dL8vyO1Lx0tt3DPrCvdF4PU7VPlRJvbqanePElm2AtIUq4OtZaaTCvdI/jq1L2pYlz3Z1qu0NxM2eN7R22Jpl1u3qNQWqgN/UdA9362vLGJeQwj9O+q/yIK/f+k+SNHa7tV4V1a3YtMIspc8AaIGWhfBqVpyKRJYd4WQGb0UCSasB1BLNmA5+L1YPiueu4U24icmERzlboHKVedDw/8eIG1Bj+Tw8HcjyYyOaTiVCITCrSL4QsEJaNAYbfqgHOtcJqC0g0pDJU1HPf3dZDtVDo3iEiyaJZqAIoIjBbnCmwxjKu9+EnQc52ZLuF5x6nVqF1CXF+eGMFKf/v2aMvCSOi/H5z5DR9U6fEKrcxOjhR0qcUA1zu5S6hJQ74bTpOrwaqUTUwuxAbt5EusERx5aeDFJruYsYvHnT2d1f70eBkEa50bCk3/h9ck5jNnCuSwaDqWOuVxo66Jn+8+eDXkmhsuDYX3usDl3OGYwHo8VwJM3MGZHFVW9uRG8RG7QwB9Hx8cno9Hk/MM/J+/HzD9HKts+rtxCq5Z1zURjn0gzbVydzHasxqpuW+FFM013wQ7ZAY8CMQiiC+QJGvuiuAVlzCIYswrOmMFfwGMi8MTpK1TlWO2OVWaEcju1aXtE2Z3d3TbYt3zJR54rLcCdyXVQtLKEucHJr7lwMEMXLzzMR4MsOkijegy3o0eQv9UBLALcc4/2W5Ao6YegPx+rYG7CHW9MveWIapOWuCf1fIe27j73b5AU3UJXzPavfmoU2B1AyE8+RwPLc0Nu7PUGu52dZ7QMCS5R6ixF5aps91EKiorMaKdjLctoOCxIVRkVxMByQ9txbp1OaxX0RjaCimLdI3k1odeacX/7ejOpN6zeltWQfiylelf/m/Pzj9DoKQeMrOnqa/BuGDcKZYzWqOEAbeD0o3+WUs/YUdLrqkre7y5LClQdihEV4QDSF7SCTT1NXmmTctL39us5xchvo08OfnXd+nrQ5YCEJwZnBu3isUr843amN/vZUZ6hsdhuHFtTxJ2wb3kQXGJdyv0NUzVn9EmqxgvtKts5pnVfbfuIVZnr8MYNM8mF7+0804qK6heMZ4KMOmCt68J3bM2pxI0Q/AtWFFNu8bORZUnToTmnRNhq2jYzrnDlvwQ0X6eYT8iaxv6qGrBQKfwJQeAojtFXq1pq46bupPXrEwokNTGt67kJZ/Wn9RWLq1VLd1GEHaH0UA4GI3zh9d+syv8AiJkK3g== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security resources'} +> - - 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index b6932ecbf13..991346a69f2 100644 --- 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 @@ -1 +1,130 @@ -{"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"}}} +{ + "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 index ef18864c82d..e2ff9fe7c5d 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-roles-by-pk -title: "Get security roles by pk" -description: "Get an item model" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security roles by pk'} +> - - 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 index 5c0c197a9fc..1d541341e82 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"role_id","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 2598ac18161..9f94d54074e 100644 --- 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 @@ -1 +1,93 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"id":{"type":"integer"},"permission_name":{"type":"string"},"view_menu_name":{"type":"string"}},"type":"object","title":"RolePermissionListSchema"},"type":"array"}},"type":"object"},"example":{"result":[{}]}}},"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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "items": { + "properties": { + "id": { "type": "integer" }, + "permission_name": { "type": "string" }, + "view_menu_name": { "type": "string" } + }, + "type": "object", + "title": "RolePermissionListSchema" + }, + "type": "array" + } + }, + "type": "object" + }, + "example": { "result": [{}] } + } + }, + "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 index 564f6650e57..a1678899aae 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzFV21v2zYQ/ivEYR8STImSoAMCFf2QBmmarmiD2NkGRIFLS2ebKUWqJOXEE/TfhyMlWY5dYN0K5JP4cne85+7h8VRDyQ0v0KGxkNzVIBQkUHK3gAgULxASMFriROQQgcFvlTCYQ+JMhRHYbIEFh6QGtypJVCiHczTQNPckbUutLFoSODk6ok+mlUPlaMjLUoqMO6FV/GC1orW1wdLoEo0TQdugraTXEg4Luy0g8l1eRFCiKYS1QqtJQNMLWWeEmpPMUuDjpEBVfU+kiboVPX3AzEEETjhJCzda4nV/xkdh3ShAWOtwY/hqh5EmAnziRSlxiPCubu4bEs7RZkaUFB5IgCwzPWNrPJYMvPpfUS3QWj7/V4g3ne0V4S3PGbECrUvYlVpyKXK2phQrjV6KHHPYgWmgG7AcvyyWW8Urt9BG/I15ws4qt0Dl2vNZT/0dQIaKAcmrl0XySTs205XKEzZeYBdkpHBbXZkMWa7RMqUdwydB4d8G1dvwiE5OXjo3pdEZTacSGeXFrRL2B9Et5AeN0WYXjnNdydxDbS202nTUby99fa6UQ6O4ZBbNEk1AkbAzxSqFTyVmlDS/yHSWVeY7BHzHHZd9CCKwmFWGMFJFf3iksnJPFdnxOVV5GLX7jMqXhfsICJdHfZVDAnN0k87GhMq/nUzDYCLyybAGRfB0kOkcRx5ceEIkV3NIILu9+QgRSD5FuZ4G/tG8MpId/MUuL8YshYVzZRLHUmdcLrR1yenR6WnMSxEvj+POldi7EtetI0088CROgaVpqhg7eM9SOGsvpMeUsLfIDRr2y9n5+cVoNBl//v3iUwrQRL231yu30Grgb7/QeyyKUhvX3SabqlR1Txx70y8fztHtkR/sJ8GKgrEF8hyNfVM/A5dCwlJoAabAfmU8I5pPnP6KqknVfqpKI5Tb65w9JGLv7e8P4X/gSz7yjBqEYGNxnTitLEWhR84fuXBshi5beOA/EXa9gT3p5ux5hikIX7ok1yEAY4//S9Bo6EPBeJ2qACDnjvfOPwtNK6QlHko93yPR/ddAN2jz3l2iYx0c5uGwaRhM6BncuCcFuoVuLxdEocVK4IeCQlnwdSLcs8pQknbGGrb6B9pmOS5R6rJA5dqK4zkQDNWl0U5nWjZJHNdkqklqYnyzZe28sk4XnYkIltwIKsxdY+bN0DjHGfdtjXcTIkBVFVSB2il9fP3ZtP9+PL5mvZ0mAvJm016Pd8u5USiltEf9HNOGXV37XlCbZ0Z2hqrV99KNb2S75PjWLoD0RbWGqafcO20KTvY+/DmGtiummxJ2oX8MPOgmIuWJwZlBu/ivRpoIhJrpAGfD+6pEY3HYow6WiDtBbnkcQmJdwf0r1zb7P0LpjZP7R9Dhk4tLyYWiEzy36pbud8BLQW4cw+CRivwfBhlM1r8amycRRQIH7qCup9zirZFNQ8vfKjT00N2vaehvRy58r5BDMuPS4pa3/aMPezdtb7fP1mHeRNG18mrl2S4rmkEEX3E1+EFq7omqvlZ5F8LuWZahr6Cd3laPQRzry8PlBaWfGspBTHsStAOyvtOnug4Sofg1vYv+MQD/a/EPed/cfg== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security roles by role_id permissions'} +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index 95265f4801f..da270fc824c 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-roles-info -title: "Get security roles info" -description: "Get metadata information about this API resource" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security roles info'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 82cf06a0741..0eeddf507a5 100644 --- 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 @@ -1 +1,135 @@ -{"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"}}} +{ + "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 index 95b5251c4aa..14253ec5af4 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-roles -title: "Get security roles" -description: "Get a list of models" -sidebar_label: "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/isHYsASTI2bYhsKFf3gBmmbLmuL2l0HRIFLS2dbDUWqJOXEFfTfhyMlWYrlIGkH9JPNlzvec8/d8aiSJWhineY2VZKF7BVa4CBSY0EtIFMJCsMClnPNM7SoDQsvShYraVFaFpaM57lIY07ioy+GdJTMxCvMOP3LtcpR2xQNjWIliky6v6nFzP2xmxxZyIzVqVyyKmgmuNZ8Q+NFKvy5HaEdtYOaVK4H59dcFOhsl5t3Cweo3iOLbI6aVcGuVDszV0ogl26qNejHNF3uwL6sqoBp/FqkGhMWXjiMHlFj/2Uro+ZfMLZDvrvCTd9xKIuM1BHBs4aOgCmdoO6MBZ+j6Iw7MdLdRUpsagWygEkluzbt57N71jBtbkOSaox9UG7N5iaurRk8KudL7KhMpcWlI8GtzEz6bc+yQYHx1iEPiM/qNgsB8x4J2RLtzLmoToeKNqeUZF8L1BvyGc9o41dWXRLbJlfS+JB+8vixj+zvzLPCC/Vze7pCsMpyARpjpRNw+0BJsCuEOY+vUCYs2AnhQfr3JPfMYxo6ujMDC6XdoV4ISOgIPqVCwBzBai6N4BYTmG9gTrHIAoY3PMudY8fwNo3v0sd2YmOHJqIiMbuGjtvaRxEAaWICKAwuCgHXK5SwUQUkSv5q4Uqq6y6GlFx3/7LWT7GHe9PJ/y9+HNJ0Pw/2qsgdrtyWjAf4Z1tcBjS7BbAKNMoE9f0xn5NJZ86KgQLSr4N3IOJCqGtMGmRkiVHaPgihRlOIPWnq12ChVeZYWaL1ZzelY89VmCbDBa6Jo4zfnKNc2hUL//x9iOPuneOEdq6ZbYGbFDlqg/aDEjjO06Om4N2jSlYdTtp6dby30vSy4R7532T3RQPtciDhBpUOJsNOqPf0dgK1H163oqkr1HB/UdJV3y+xLGROg2f/b2rByILff+hKyNCY/u14V2J3uGkF2QueAIUHGhvCmVxzkSawbQwh12qdJpiwAUAdWY/l+Odi+Sh5YVdKp98wCWFc2BVKW58PbQ4MAOkKOiRPnvxsJLlWMQ3nAoFQ2E0I/xA5Hg1qrfQQlBNViASkslBrqKXpqD9+drCdSYtacgEG9Rq1RxHCWEIh8SbHmCq8mwQVx4XeQ9dLTu1O4wJq9OJCE0Zq1b9cUwZeUvNl+dJl6KReB6pphjKVcDnUZ0nd0zU6ZtrtCdjNo1glOHEo/PtIcLlkIYs/fjhvuunt0KhCx4QxLrSAR//Cq9MpRGxlbR6ORkLFXKyUseHTx0+fjniejtbHo+bMkTtzFDGIokgCPHoNERvXEenMDOEFco0afhmfnJxOJrPpu79O30bMPTxqu95v7ErJjmXtRGtbmuVK2yZnTSQj2TSo8LydppJ/QHbAgwEEXmyFPEFtnpe3YEQshIjVUCIGvwGPKUZnVl2hrCJ5GMlcp9IeNGYdUVQeHB52gb7haz5x4dAB25vckqGkIbwtRn7NUwsLtPHKQfwugGUPZdiM4TZrBPdzQ1zpoU4d0s9eoqIfgv0skt7UhFvemnnLCfUmJfBIqOUBbT185l4ZGdqVqiPZveupFWB7QJB/XPr5qC40uW/QC+x24p3TMiS4RqHyDKWtE9mx4xWVuVZWxUpU4WhUkqoqLCnqqh1tJ4WxKmtU0AtYp1Tvmg7IqfGd1IK7i9WZSZ1f/XKsh/Tj0rqv//V0+h5aPVXAyJq+vhbvjnETX6FojXoJUBrO3rtHJ3WEPSWDrqrl3e6qIpIaGiZUXz1IV6tKNnch8lLpjJO+N5+mxJHbRh8U3Oq2sXWgq4CEZxoXGs3qe5W4p+tC7XarTRM40BcSUaiN37c+9i4xNuPu8qj7Lvrg1OCFpqL2juhcQ/s+T9WmWryxo1zw1LVsLsrKOsQvGM9TMuiYdW6BgDUnUkx40i9YWc65wY9aVBVN+5abEmCvWftMuMKNe9+335yYS8ImfN3tEzBfHdwJXmAcx+iqUyO1c/n2UvnVKRFIfUnnxm1prP90vk1xuenoLku/w5cbyj1vhCu07ktU9R9x2vp7 -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security roles'} +> - - Get a list of models - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.ParamsDetails.json index 6e30d8d423b..df51d27cef4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.ParamsDetails.json @@ -1 +1,38 @@ -{"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"}]} +{ + "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-user-registrations-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.StatusCodes.json index 1d6d78009dc..59768dfc6ef 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.StatusCodes.json @@ -1 +1,126 @@ -{"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"}},"type":"object","title":"UserRegistrationsRestAPI.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"}}} +{ + "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" } }, + "type": "object", + "title": "UserRegistrationsRestAPI.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-user-registrations-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.api.mdx index 9f3d3e3856b..eecb9d3ea5e 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.api.mdx @@ -1,33 +1,32 @@ --- id: get-security-user-registrations-by-pk -title: "Get security user registrations by pk" -description: "Get an item model" -sidebar_label: "Get security user registrations by pk" +title: 'Get security user registrations by pk' +description: 'Get an item model' +sidebar_label: 'Get security user registrations by pk' hide_title: true hide_table_of_contents: true api: eJzFWG1v2zYQ/isHYh8STI2bogMKFf3gZmmbruuC2FkHRIFLS2dLNUUqJOXEE/TfhyMlW47lNmsL5FPClzve8/C548kVS9DEOitspiQL2Vu0wCVkFnPIVYKCBazgmudoURsWXlUso30FtykLmOQ50mjBAqbxpsw0Jiy0usSAmTjFnLOwYnZV0K5MWpyjZnUdVCxW0qK0tMyLQmQxpwgGXwyFUXWMC60K1DZDQ6NYiTKX7l+K0XTcG6szOWd10E5wrfmKxgtcbVugLHMWXjGTqttJ6zLoUtGZFXyKojN2RjazAokAJZFdB9+KYTOhpl8wtixg3kPI5mgnFNikgVzTZsfxTYl6tSH5htXXxLIplDSejWdPn3pSvovLPrh7CJ/4GKp7ahmnCJ0ZmCkNNkXwRkBGR/ApEwKmCFZzaQS3mMB0BVNilQUM73heOCKG8DGLv+aP7dC8QytRl/TH6SSdJbtO7t/w/6fA2f8U8H2eHgZboymF3Q3e07GbgXv1eGlQX+A8M1Y7GZkLNHZ4fnY0R3fQVs7s0DEEkRkLagabhHl4onZSq8ezWwCrQKNMUD+c3FGqbuGM7v93tDwT5mGUrh3sTZUtZTxAwI0821N7lNfrsVcVW3dOXo93LueqPeh6m9oeQlzV2Sbcrc+0yuFP9xDUAXv+Q/UmR2P4HHuU8A3214bsNU+A3hk0NoQzueQiS2DzPkGh1TJLMOnD07H1WI4fF8ul5KVNlc7+xSSEYWlTlLY5H9aPaQ+QrqFH8vxxkXxUFmaqlEkIVA4bkpHoNqrUlBMKDUhlAe8yon8X1NqHQ/Ts2WPfTaFVTMOpQKB7sasQ/ia5+ftBrZXuw3GiSpE4qI2HxpqO+u2x0+dMWtSSCzCol6g9ihCGEkqJdwXGdGluElQcl3qPAN9wy8WagoAZjEtNGKk9/HJrWXh1Tb2K5XNXhfY9KVSXCKGbPEuaZqj1NikN6onu2k2mq4nrNe+exCrBkYPou1LB5ZyFLL68+NDW1c3Qq5DGpRbw5B94ezqGiKXWFuFgIFTMRaqMDV88ffFiwItssDwetGEMdsMYHEcMoiiSAE/eQcSGTTq61RBeI9eo4ZfhycnpaDQZ//XH6ceIMep6myjPVzZVshPnemIdaZYXSts2l0wkI9m2fvBqPU2P8gHFAT8IJ/BOUuQJavOqugcqYiFErAEWMfgVeEzinli1QFlH8jCShc6kPWiDPCI5HxwedmG/50s+cjrqQN+a3FyUkobQrxHzW55ZmKGNUwf4J8CttjCH7Rju3yiB/9xeauWBjx3uz96ipj9EwstI+sATbvk66HuUNJuUwCOh5ge09fCl6+1ztKlq0sB9d9mUhewhkKpiURN9Lq19QpSa2O0lid1P6A+0DAkuUagiR2mbAuEuzzuqCq2sipWow8GgIld1WJFE6x1vJ6WxKm9dBGzJdUZ1tG2tnRvfVc24a2BcmNSyNd9lzZD+GCoS2/7fjcfnsPZTB4yi2fa3xrsT3MhXPlqjJguUhrNzckJYtp30UtXYu911TbfW3suI6rYH6WpgxaZOM2+Uzjn5e/9pzJrPYpK4X920og50HZDxRONMo0m/14n7gpyp3SZ6VBaoDXb7/c4UacfvWx57SozNuXuUmoaUfh5o8QLpELZ0SO23q89bp3ZevN7fF5rQLd7ZQSF45npbp7qqyYErxouMAjxmndcmYLuZwAIWFgvSjBfFFauqKTd4qUVd07T/qKYE2RvjvpAWuHKf4aRoUdK6y9pW3t5p5lqGhIUzLgx+hYmDi6bFO4R9B7afR3LVPbMNpFiw+prU7+qXO90vDOMYXTVtTXa6jK1i8/aUFEUtZae1WOuq+Ye894ZTVX6HL4j1Ojr3MFCAdf0ffVdlkQ== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security user registrations by pk'} +> - - Get an item model - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.ParamsDetails.json index beb41857879..3d1c6a5cb18 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.ParamsDetails.json @@ -1 +1,53 @@ -{"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"}]} +{ + "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-user-registrations-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.StatusCodes.json index da2fced086e..33661b3603b 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.StatusCodes.json @@ -1 +1,100 @@ -{"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"}}} +{ + "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-user-registrations-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.api.mdx index 2c36d7818c5..a261c374de2 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.api.mdx @@ -1,33 +1,32 @@ --- id: get-security-user-registrations-info -title: "Get security user registrations info" -description: "Get metadata information about this API resource" -sidebar_label: "Get security user registrations info" +title: 'Get security user registrations info' +description: 'Get metadata information about this API resource' +sidebar_label: 'Get security user registrations info' hide_title: true hide_table_of_contents: true api: eJzNV21v2zYQ/isHYh8STI2bYgMKFf3gBmnrvQa1sw6wApeWzjYbilRJyo0r6L8PR0qKZDvd1hXoPkki747Pc288VSxDmxpROKEVi9krdJCj4xl3HIRaaZNz2gK+1KUDtxEWxlcTMGh1aVJkESu44Tk6NJbF84qlWjlUjsUV40UhRer1R+8t2a+YTTeYc3orjC7QOIHWy2bZItWyzFX7KUiPy6uB2FCp4Gukp9sVyGImlMM1GlZHfmdhxaej23XULunle0wdO7aAmXD/L0S3uPNnCIe5f0FV5iyeD3y3BzxiKyF9bCJWoMmFtUL7dVJywklsVdoPpRWym+5864xQ6x4gbgzfHYEcsWAhZmt0C8qdRRPsmoQFpdeHEs2OzuA5CX5g9U3EDNpCKxsc+OTxY3p8nSz626AeCLTeOrAclBYBeC8GQ6l2e1hUsw1CMAwkcAZvhZSwRHCGKyu5wwyWO1jyJUp2xPF0AnfafNZyEKJSvcUdOA2lRdAKpLAO7pNgz/hnEu+hONfDTDqKqbRooCcFK22ONo/Oj/822yiYdzwvJB7G/TDQw8gOYjmv6pt9SvMWx41P3SG/icMcVkbn8KvOUBKSH/5T0uZo7bBtfC46PdadInvBMzD4oUTrYpioLZcig/vGDIXRW5Fhxo7w6ekGLufflsu14qXbaCM+YRbDuHQbVK453wMV5jiRvqJn8uTJt2ZSGJ3S51IiEAu3i+EPCk5gg8Zoc4zKhS5lBko7aCw02nTUj9862SbKoVFcgkWzRRNYxDBWUCq8KzClfuYXQadpaR4I10vuuOxcEDGLaWmII00R7z86Fs9v6HpwfO1L8tqieYNrYV3oc/YNWje+mtBd1TW/SdbcP621BbWihenrLfzlxCJ29yjVGU49xTC8SK7WLGbp9ZtfWMSkb8jdZ9O0YpaWRsKjP+HV5QwStnGuiEcjqVMuN9q6+Onjp09HvBCj7fmohTE6hDHyMBIGSZIogEevIWHjJoG9RAwvkBs08N344uJyOl3Mfv/58reEsTrqkF7t3EarHtZuoUMr8kIb15a4TVSi2hsXnnfLZ2t0J4QDvgKlKBjaIM/Q2OfVHrGExZCwhlzC4HvgKSX5wulbVHWiThNVGKHcSQv0jNL65PS0T/0nvuVTn089+oPF+4BpZckDHWv+kQsHK3TpxpP+SpSrAe+4/Yb9yJID3rXBrQL5mef+LmjU9CBHPEtUAO8H8hb4nlsaIS3xTOr1CYmePvOjVY5uo5uS8KO627CY/WNa5ENf46E6SkMuPuoptl/dv9A2ZLhFqYsclWu6hY9gMFQVRjudalnHo1FFpuq4olytD6xdlNbpvDURsS03gppqO4J5M2EUWfFSugYmjbbNjNx80sNSxxjafz2bXUFnp44YoRna6/gegJuGNkh7NFKANjC58mOSNntGjrqq0ffSdU1hawMzpSYeSPqGWLGlT5qX/reM0v3tjGLkxVjc7N5PeZ50HZHywuDKoN18qRE/wa/04bg3LQs0Fvvzf2+JcifIbc+DS6zLubqflf0fZ8s3zI2DRARoEnFwau/6+5Jf1oaZwzs3KiQXiqD5pKyaGpkzXgjCf856N1PEDiuFRSzUyk2bNXNWVUtu8drIuqbl8NdDFfQgiYdA3eLO/ydRysuS9n1dt/nv78iIhYbjTwgK4zRF3wJbrYMRYdAdXl1SBtD01JsLujxoXsh6O5SrXc92VQWJ0MGoeAMI381ZTTP0X5CzvGU= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security user registrations info'} +> - - Get metadata information about this API resource - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.ParamsDetails.json index 5917115e126..c85fdd981cb 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.ParamsDetails.json @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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-user-registrations.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.StatusCodes.json index 989cea1028d..3010e90d7df 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.StatusCodes.json @@ -1 +1,148 @@ -{"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":{"email":{"maxLength":320,"type":"string"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"},"registration_date":{"format":"date-time","nullable":true,"type":"string"},"registration_hash":{"maxLength":256,"nullable":true,"type":"string"},"username":{"maxLength":128,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object","title":"UserRegistrationsRestAPI.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"}}} +{ + "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": { + "email": { "maxLength": 320, "type": "string" }, + "first_name": { "maxLength": 64, "type": "string" }, + "id": { "type": "integer" }, + "last_name": { "maxLength": 64, "type": "string" }, + "registration_date": { + "format": "date-time", + "nullable": true, + "type": "string" + }, + "registration_hash": { + "maxLength": 256, + "nullable": true, + "type": "string" + }, + "username": { "maxLength": 128, "type": "string" } + }, + "required": ["email", "first_name", "last_name", "username"], + "type": "object", + "title": "UserRegistrationsRestAPI.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-user-registrations.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.api.mdx index af4fb6aa289..12addce780a 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.api.mdx @@ -1,33 +1,32 @@ --- id: get-security-user-registrations -title: "Get security user registrations" -description: "Get a list of models" -sidebar_label: "Get security user registrations" +title: 'Get security user registrations' +description: 'Get a list of models' +sidebar_label: 'Get security user registrations' hide_title: true hide_table_of_contents: true api: eJzFWG1PGzkQ/iuWddKBLhDg2gpt1Q8poi0t16IC15MISp3dSeLitbe2N5Cu9r+fxt7deJMNB+WkfkrWL+N55uWZsQuagIk1zyxXkkb0LVjCiODGEjUhqUpAGNqjGdMsBQva0OiqoLGSFqSlUUFZlgkeM9ze/2ZQRkFNPIOU4b9Mqwy05WDwK1YiT6X7yy2k7o9dZEAjaqzmckrLXj3AtGYL/J5w4c8NNq2J7ZSkMt05PmciB6e7XHyaOEDVGpmnY9C07K3vakbGSglg0g01Cj1N0vUa7Ouy7FEN33OuIaHRlcPoEdX6Xzd71PgbxLbLdjewaBsOZJ6iOHTwqHZHjyqdgA6+BRuDCL6DGAlXoRDLrQDao1LJUKfN/gzP6nabW5BwDbEPyqXazMSVNp1HZWwKgUguLUydE9zMyPAfG6YNCIiXBnlEfJarXuhRb5GITsGOnImqdChxMcck+56DXqDNWIoLv9PyGr1tMiWND+mDvT0f2T+ZZ7nf1M7tixkQqywTREOsdELcOqIksTMgYxbfgExoby2EO92/IblHHlPX0cEImSjtDvWbCG7aJV+4EGQMxGomjWAWEjJekDHGIu1RuGNp5gw7IB95fJ88uhYba25CVyRmXdFBw30YAYQnpkdyA5NckNsZSLJQOUmU/N2SG6luQwwcTfdwWmun2OOt6fb/L3bskvQwC7ZY5B5TLinjEfZZkkuHZDdBrCIaZAL64ZhPUaUTp0UHgbR58B5ETAh1C0mNDDUxSttHIdRgcrEhTf0cmWiVOq9Mwfqza+rYUAohZdwVw5TdnYKc2hmN/jzY64A64drYJr6C5S+edazmSTdxCvYIIRqm3FjtOGyUMOs2TZROmaURxYEdy1NXTHIh2BgdZnUO/yVqxsxs5fyD5y8eICU3oDuU3z847Ar/sBx7O7esGBojEL1WppcF4tKA/hwAMZ/B2MHZyW5dOR5QbsoguBvi399I2S1aeQCR1jR5VRviuoO5OoV2ssoaZ7TkBhnfztOVtAw31Ul0VWDP1K5VNKJOgk+jv7CXRQ2ePam2pmBMu824jyED3zQb6WuWEAwmMDYiJ3LOBE/IssMmmVZznkBCOwAFez2W/V+L5VKy3M6U5j8gicggtzOQtjqfNBnTASTc6JAcHPxqJJlWMX6OBRBEYRcR+Rud49GA1kp3QTlSuUiIVJZUEqrdeNTzXx1sJ9IiEwliQM9BexQRGUiSS7jLIMZS6QaJiuNcb3DXG4Z9Y20C7JjjXCNGvPN8u8UMvMYu1rKpy9BN3IY5iwjd4ElStcm1tBHS5igkd0z/u51YJXDuwPn7p2BySiMaX34+rW8ry0+jch0j9DjXguz8Q94eX5AhnVmbRf2+UDETM2VsdLh3eNhnGe/P9/u1Av11BfpDSobDoSRk5x0Z0kEVtW4yIq+BadDkt8HR0fH5+eji04fjj0PqbnmVkmcLO1MyULMZaBTlaaa0rfPaDOVQ1rcB8qoZxrKwhXqQp6HpeRkzYAlo86pYwTSkERnSCteQkj8IizGoR1bdgCyHcnsoM82l3ap13MUw3treDlG/Z3N27uInQN4aXLpJSYPgG8DslnFLJmDjmcP7dLRFC3JUf5NVfyL2r7VLC4/7wsH+6neU+IM2eDmUXu+EWdbovGKRapESsCvUdAuXbr90l70U7ExV0e+eV7DvoA9BhJZzmewzIddo2E770NUcPsVpksAchMpSkLbiBOc3L6jItLIqVqKM+v0CRZVRgcFZrkk7yo1VaS0CXyU0R+qsu1Inxne3E+ZqtFMTu/HqNl994o9BXmjLf3dxcUYaOWWPojZteQ3eNeXOPdnhHLYlRGlycuYeArBLbwnpNFW1360uS/RY7ZNzpGoP0tFeQccuXt7Ufez7LxfoI7cMH3nc7PKy4UCXPdw80jDR4HvXnxHinhMmav0GcZ5noA2EvWYwhLHj1833vUmMTZmrQ1ULh4+ANV68/WqySsmt84Lytun9sNLbwp3tZ4Jx1wq6kCuq4L+iLOOo3T4NqotvpNcqAkaLD4crWhRjZuBSi7LEYX9BwtTYqOMmfW5g4V5jmhdC6nK1DmxX4nrUk4g7wW8YxDE4Rqt3rVX4Vsa/PUbXYvMTlPXGwdWf4CWRyUUguyj8Cs9KmJVeCUfO7t2w/BcEkpbh -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security user registrations'} +> - - 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 index 6e30d8d423b..df51d27cef4 100644 --- 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 @@ -1 +1,38 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index ae1b5a8d7e3..bef6c0a53bb 100644 --- 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 @@ -1 +1,201 @@ -{"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"},"groups":{"properties":{"description":{"maxLength":512,"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":150,"nullable":true,"type":"string"},"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"SupersetUserApi.get.Group"},"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":128,"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"}}} +{ + "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" }, + "groups": { + "properties": { + "description": { + "maxLength": 512, + "nullable": true, + "type": "string" + }, + "id": { "type": "integer" }, + "label": { + "maxLength": 150, + "nullable": true, + "type": "string" + }, + "name": { "maxLength": 100, "type": "string" } + }, + "required": ["name"], + "type": "object", + "title": "SupersetUserApi.get.Group" + }, + "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": 128, "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 index ff4cbf0db28..3e5e0addaef 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-users-by-pk -title: "Get security users by pk" -description: "Get an item model" -sidebar_label: "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: eJzFWG1v2zYQ/isEsQ8JpsR22gyFin5Is75k67qiTtZhceDS0tliQ5EqSbnxBP334UhJlmy5ddoO/WSLL8d77p57IQsag4k0zyxXkob0BVjCJOEWUpKqGAQNaMY0S8GCNjS8LijHdRmzCQ2oZCng1y0NqIaPOdcQ09DqHAJqogRSRsOC2lWGq7i0sABNyzIoaKSkBWlxmmWZ4BFDDQYfDKpRtDZnWmWgLQeDX5ESeSrdX9TRtMQbq7lc0DKoB5jWbIXft7Dq7gCZpzS8piZRn6a1yKBtitaoYDMQrW+3yXIrAA2gJNCb4Es6rAfU7ANElgbUSwjpAuwUFZtWkEtc7Gz8MQe9Whv5Iy1v0MomU9J4a5wMh94oX2XLPrg7DD71OhQbbLlMgLRGyFxpYhMgfhPBTcfkHReCzIBYzaQRzEJMZisyQ6vSgMIdSzNniDPymkefk0e3zLxlVjRd3K+nozSPt4Vsevj+JnD7vwv4Pkn7wdZgcmG3lWeR5Uunt8yFYDM8zcdnJWKmlAAmUUaUMLmAeDpbbcvxZt2O5J28HucZaAP2yoA+y/jxAuwx/h+1T/IEnSudMktDGjMLR5anLrL61V17LdKA9vx/tW0f9C3KQsq4wO0pu3sFcmETGj44GfasnDMupkItOAZl7qN6h/gGWEDnXBvbULR1yC8Pe85YaJVnPUzvULsj5nR0sgfKfrNXAbYhcXQ63ENiD6LRcNtsZbv8XPtdN/fz9gu0yedBGOsd8/U0cDL29dK9SaCVgB6v7gK0nx7fwbRvlQA8MDeg+xx68uhLp/rw6dC8bcyW6Puphlp1moCt/H5GBDeWqDlZdwD7dx6tXqFHspsgVhENMga9f7UYJ+oTucCC9itYxoXZr0Y0AnbW/k6p26MiV+FSn9pTSnsl9pa5ThGry5anertc0JPhycOj4ehodHo5GoYPhuFw+A/tZulda6osvFZ3O9mOurl0vRRxjrpZYNcxrShvWWbjlHUwtPjT5eJ1PXPTZVKP/13X2OWXm59rlZI/XCNfBvThN/WLKRjDFtBD/C+QrdlIn7KYYFyDsSG5kEsmeEzW9wuSabXkMcR9eFp7PZbRj8VyJVluE6X5vxCH5Cy3CUhbnU+a5NUDpL3RI3n4Y5G8VpbMVS7jkGA7WxkZ0NxG5RpTgAJDpLIE7jiafxtUI8MhOjn50b7JtIrwcyaAoF/sKiR/Id28f0BrpftwnKtcxA5qJaHajUed/ujwuZAWk4YgBvQStEcRkjNJcgl3GUToNDdIVBTlegcBnzPLRGOCgBqIco0Y8Xr/4ZOl4fUN3jUtW7gsNK7mCVZOg9kIcTnUF3F1ha1lTDGvmelsNXWPAndHkYph7LD45wPB5IKGNLp6+4o2nWH96emG37kW5Ohv8uLZJZnQxNosHAyEiphIlLHho+GjRwOW8cFyNKhPHriTB6MJJZPJRBJy9JJM6FkVak7bkDwFpkGTn87Oz5+Nx9PLP39/9npCKb5IVIq9WdlEyZZqzUCjHE8zpW0dJ2YiJ7K+lpMnzTD2FweoB7k/gsDvS4DFoM2TYgPHhIZkQissE0p+JixCrk6tugVZTuThRGaaS3tQ63WM7Dw4PGwj/Y0t2djRooW2M7h2h5IGATcg2SfGLZmDjRKH8esQFh2YYf1NNv2GeN/Xris81ksH9b3fUeIP4n48kV7XmFnW6LlhhWqREnAs1OIAlx4+dq8rKdhEVZR2L1/Yn9IdKIrstkQjuVj05M412rDXFHQzCl/hNIlhCUJlKUhbRbVzkRdUZFpZFSlRhoNBgaLKsEDulVvSznNjVVqLCOiSaY7Jr74PODG+85sz12Q5NbEpqh7Dqk/8cTHelf/y8vINaeSUAUVtuvIavFvKjX26wjlseYjS5OINCkEsXSG9pqr2u9VliY6qXTHGZOtBusRV0JmjyfP6evbbu0tavUW61w43u26XHegywM1TDXMNJvlaIe7Zbq62G/363tFzFUFHgTZ+3XLkTWJsylwlqdpDfJOt8RJHPbwVuPS6cWFvKlPvO26lrYU7O8gE467ldkQrKqZfU5Zx1GlEW1XB96p4xwizW2SGd/01LYoZM3ClRVnisH+vxDDYqdYuLW5h5V44kbcix3kXjjWJvVDuqnlMwzkTBj4D/uBt1X0dkl0H1hc1uWqfWSuS3dLyBjnuEpM73U+cRRG4zFhv2WoAOlnkxTPkDXZ7rarfsKf6g9J71SkKv8JnurLRziV5VLAs/wOf6yug -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security users by pk'} +> - - 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 index beb41857879..3d1c6a5cb18 100644 --- 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 @@ -1 +1,53 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index da2fced086e..33661b3603b 100644 --- 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 @@ -1 +1,100 @@ -{"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"}}} +{ + "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 index c9360bd38f0..66e6d311421 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-users-info -title: "Get security users info" -description: "Get metadata information about this API resource" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security users info'} +> - - 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 index 5917115e126..c85fdd981cb 100644 --- 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 @@ -1 +1,69 @@ -{"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"},{"items":{"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"}]} +{ + "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" }, + { + "items": { + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 12f7bcaada9..63719bed3bd 100644 --- 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 @@ -1 +1,194 @@ -{"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"},"groups":{"properties":{"description":{"maxLength":512,"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":150,"nullable":true,"type":"string"},"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"SupersetUserApi.get_list.Group"},"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":128,"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"}}} +{ + "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" }, + "groups": { + "properties": { + "description": { + "maxLength": 512, + "nullable": true, + "type": "string" + }, + "id": { "type": "integer" }, + "label": { + "maxLength": 150, + "nullable": true, + "type": "string" + }, + "name": { "maxLength": 100, "type": "string" } + }, + "required": ["name"], + "type": "object", + "title": "SupersetUserApi.get_list.Group" + }, + "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": 128, "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 index 6652553422a..1c60f7ce539 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-security-users -title: "Get security users" -description: "Get a list of models" -sidebar_label: "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/isEMWAJpsRx1g6Bij6kQZqmy9qiTtYBceDS0rHNhiJVknLiCvrvwyElWbLlzEmL9ckWyXP5zp3MaQwm0jy1XEka0jOwhBHBjSVqQhIVgzA0oCnTLAEL2tDwOqeRkhakpWFOWZoKHjEk730xyCOnJppBwvBfqlUK2nIw+BUpkSXS/eUWEvfHLlKgITVWczmlRVAtMK3ZAr8nXHi5DaI1tp2cVKo71+dMZOB0l4v3EweoPCOzZAyaFsE6Vb0yVkoAk26pVuj7ON2swb4pioBq+JpxDTENrx1Gj6jS/6amUeMvENku293Com04kFmC7NDBo8odAVU6Bt34FmwMovHdiJHmKWRiuRVAAyqVbOq02Z9NWd1ucwdiriHyQblUm5mo1KZTVMqm0GDJpYWpc4LbGRn+bcO2AQHR0iCPiM9i1QsB9RYJ6RTsyJmoTIcCD3NMsq8Z6AXajCV48CstbtDbJlXS+JA+PDjwkf3EPMs8UTu3L2dArLJMEA2R0jFx54iSxM6AjFl0CzKmwVoId7p/Q3KPPKYu0Y0VMlHaCfVEBIn2yScuBBkDsZpJI5iFmIwXZIyxSAMK9yxJnWGPyTsePcSPrsXGmpvQFbFZV/S4rn0YAYTHJiCZgUkmyN0MJFmojMRK/mrJrVR3TQwcTbd9WWun2OOt6eh/iB27OG1nwVYVecCUy5LxCPssi0sHZ7dBrCIaZAx6e8wXqNK506KjgLTr4AOImBDqDuIKGWpilLaPQqjBZGJDmvo9MtEqcV6ZgvWyq9KxoRWyyPK5s5jMhGBjxGx1BsF696LRjMkpxKPxYp0Pj7sK5QPFbpCloA3YKwP6OOX7VfHbx4V+U5wvXROlE2ZpSGNmYc/yxPWQbp2XJow0oGv/B5Wb0r5HY0gYd9NJwu4vQE7tjIa/Hx50nJwwLkZCTTnW2LJ+b2Df6FwTro2ty0RDyB/POmRMtcrSjrBpBWCLzfP+4RYou21fFrkVjv3nB1tw7EDUP1g328qU5KjWBqMtXH6GhnkYibHeO0+PBcdjW1c9OhK0EtDh2k2AttPjR9n3oxKAUjMDusu1h0f/JdonUivgmxZtsH6CflvMdUWji9QTVn/jbNTq31tMLNU8cl3hv+kYETqZdrbvtebc4ttore2GuNL/mkRVt7rO8XLSHgppSB0H36/+wksjavDsu4bYBIxpz/MPjSIN39SE9BWLCcYQGBuSczlngsdkeZUlqVZzHkNMOwA1aD2W/s/FciVZZmdK828Qh+Q4szOQtpRP6kTpANIkdEgOD382klSrCD/HAgiisIuQ/I3O8WhAa6W7oJyoTMREKktKDiU1inr+s4PtXFosQIIY0HPQHkVIjiXJJNynEOFM6haJiqJMb3DXa4YXtMoEeDWNMo0Y8XHhyx1m4A1eFy2bugwdlPsEa5rBTEVcDvV5XN5CKx6jzJ0J6P1epGIYOBT+RUcwOaUhja4+XtC6b1efRmU6QoxRpgXZ+4ecnV6SIZ1Zm4a9nlAREzNlbHh0cHTUYynvzfu9SmbPyewNKRkOh5KQvTdkSI/LiHRqhuQVMA2a/HJ8cnI6GIwu3/95+m5I3VNJqdeHhZ0p2dCsXqh140mqtK1y1gzlUFZXavKyXsaSv4N6kEcDCDzZDFgM2rzMV2AMaUiGtIQypOQ3wiKM0ZFVtyCLodwdylRzaXcqtfYxKnd2d5tA37I5G7hwaIBtLS6doaRBvDVGdse4JROw0cxBfBLAvIUyrL7JqtcQ7ufKcbmHeumQfvYUBf4g7BdD6VWNmWW1mitGKA8pAftCTXfw6O4L9y6SgJ2pMpLdSyQODHQDCLSPSz8f1ZlG83Vaga4m3gVukxjmIFSagLRlIjvveEZ5qpVVkRJF2OvlyKoIc4y6Yo3bSWasSioW+GanOda7akJzbPzoPWGusTo18a5avnWVn/jj0rrN/83l5QdS8ykCitq0+dV415Qb+AqFezhLEKXJ+Qf3TIZ32BaTTlOV9O50UaCTKjcMsL56kK5W5XTsQuR1NTC//XSJPnLH8DrqdpdXcQe6CJB4pGGiwcyeysQ9tk3U+v26GgI75kJ0FGjjz8373iTGJsw1j3LuwifyCi+pKurKDapuQ5se1EtVLdzbXioYdyObi7K8DPFrylKOCvVpowv4ORc5YEx4p1/TPB8zA1daFAUu+0cCTICNam1S4RYW7kWyfiWnLgmr8HXdJ6C+OjgJnuA4isBVp4pqrfm2UvnsFB2Ic0mj49ZuLP80XtOZXDR457k/4csN5p5XwhVa93Ze/AulmZpe -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get security users'} +> - - 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 index 280fa66944b..5e5596f520e 100644 --- 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 @@ -1 +1,34 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 74faf9dfe89..7530c9ca744 100644 --- 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 @@ -1 +1,93 @@ -{"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"}}} +{ + "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 index e95c35ea195..5bccee5d82e 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-slack-channels -title: "Get slack channels" -description: "Get slack channels" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get slack channels'} +> - - 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 index 0d1f3566c3c..9ec79e8ae9f 100644 --- 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 @@ -1 +1,25 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 00d6098abd1..fc45948f614 100644 --- 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 @@ -1 +1,85 @@ -{"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"}}} +{ + "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 index 3294e8ce3cb..e2db88a3e2c 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Get table extra metadata (database-pk-table-extra-table-name-schema-name)' + } +> - - 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 index 56c845107bc..bb3a7f27af9 100644 --- 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 @@ -1 +1,30 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 55b71756adb..5e9f608d3de 100644 --- 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 @@ -1 +1,61 @@ -{"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"}}} +{ + "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 index 70eec151b89..bf6f98adc04 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get table extra metadata (database-pk-table-metadata-extra)'} +> - - 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 index 5f63de0ed67..8e6425434ae 100644 --- 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 @@ -1 +1,30 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 6f0dacefaca..819b19c6af3 100644 --- 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 @@ -1 +1,61 @@ -{"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"}}} +{ + "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 index c280c5b263c..6f621a372b5 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-table-metadata -title: "Get table metadata" -description: "Metadata associated with the table (columns, indexes, etc.)" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get table metadata'} +> - - 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 index 93d7fe662b7..33f96812ce7 100644 --- 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 @@ -1 +1,17 @@ -{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_fav_star_ids_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index f696a006165..cc6fdb942d6 100644 --- 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 @@ -1 +1,85 @@ -{"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"}}} +{ + "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 index 6da4a60e783..181e723f67e 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-tag-favorite-status -title: "Get tag favorite status" -description: "Get favorited tags for current user" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get tag favorite status'} +> - - 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 7b9b8a42f63..2bcb9d05aa2 100644 --- 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 @@ -1 +1,277 @@ -{"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"},"configuration_method":{"default":"sqlalchemy_form","enum":["sqlalchemy_form","dynamic_form",null],"nullable":true},"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"},"per_user_caching":{"type":"boolean"},"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"}}} +{ + "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" }, + "configuration_method": { + "default": "sqlalchemy_form", + "enum": ["sqlalchemy_form", "dynamic_form", null], + "nullable": true + }, + "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" + }, + "per_user_caching": { "type": "boolean" }, + "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 index bf69c109df2..60220965ea6 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-the-bootstrap-data-for-sql-lab-page -title: "Get the bootstrap data for SqlLab 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" +sidebar_label: 'Get the bootstrap data for SqlLab page' hide_title: true hide_table_of_contents: true api: eJztWd1v2zgS/1cI4oBNcG7c3AdQaLEPaZu22c3dtnV6H4gDLi2NbbYUqZAjJz7D//thSMmWZclx9x56D32yLA6H8/mbGWrFM/CpUwUqa3jCL7yHfKLBs9GH62s5YRNr0aOTBcskSnYiU1QLECgng/BmIj34AbsvwSl6QDkRHiWCUJk/ZcowybwyMw0MTFZYZfCM3cwhskulYRNgsjo1Y1Nnc4ZzYGnpHBhkpQf3g2cqO+MD7sAX1njwPFnxPz1/Tj+pNQgG6VEWhVapJFWGnz3ps+I+nUMu6alwtgCHKu7e6tG3Rk+4LIAnfGKtBmn4esBlidaVpnuxNohQWYNAGYQZOCKAR3RS1LJV63byGVKk5bnKQGiYophI133EDmePTpkZvdZyArpnBcGjIAct91VN59LMIBNRoKl1uUSekCLwDFUOfLDPMUXpe/SfdIqQTa767GGy14h5Y9GU+aRac866v4H3chZ8YUqt5UQDT9CV0CEXPEJaImSj+25LBON32r3PqCpX2C14WFJm9kamaF3n7sLZmQPvuxkEf/SZxYEvNfpfYNnJ2dmHHq7baN/b5MEtwPWd6Hts5u/1ZabQ7m5srKN02OvCAASd+6q8238PeTHaKPGky4n8JlIcQ+1k+kWZ2Senj6In7OmUkha6LbketKJrwFEhncE/kMc/Bs9uAkAcCDEvF5Bt87ZH2m0QH/J9j3eRGIq4MUSUQsj9Pko8iWs7RaQz9QppMmju7sO046K5WWa6N2MdFq29BzwUI2lLIJ2Ty9rfPQcdZjcKCdCoDLG+ZJkiU0n9fsfMrSqktX0QqV+IstBW9tiuouqF5Gp9cXg9y/WhZVcaIf3SpN1EqUznIKhc2BIPxGrDO6k1UzUrXSjWIgec26BgBlNJCZJQzEpNAbAUVJY4FYsy58ltx0q2NDJXafWXTr8btIRoVmcj825UApO6ZYGQiU2tOKLqFJYywwh/T6TdJoJHBGekFuWR2LMRoCso8lKjEqlEqe3sgOO8WCiHpdQiZjo8Ftq6ns4mlSYFHQFHWCMelMmIRWn6oy+1HgV4VDmlIhg6pYc0Uz7IQF4QhYOFgocnKJ3SWqAVGaBUPQEKZqYMiEI6mR9Krr08XQ94DiiDOHsB3JehHTDTy/R3iVSAEwFtSCQKhU6lIzAKGwD3a4+o4F6ECIGMkqaFMpsqsA+7LWBcgPMV5j8R0Qdw8iovrMN/nL+u8vMyhD7VhbwA562h2GrV4mb18CKXRs5i1oYs04cqZmNrIb1/sC47KiMbsFM61V1n/VxgaUxsxaXWv055ctvOYVUhXXPuGo3esZuwk129ZidT61hZUBfuT3kbyrrwtKlJRyeqFmTDLz39ZGNdHGQUe0ghs6zV2O6RkEe7E4Yc2QPAB2Kkjo3R6F00E193QXxZRuNuBpnwosOZjcDdF8LBfakcAdltq2jsRcGgPqFmeHd8nHfCRzVIH98mfJ/gvk9w3ye4bzHB7QXhzt3X1xTSA2fGa7iX9S1cZdmQCzIvotl27rLaw0YAfb6QuoQWvrRWWtLf1tLerdftCY9/BCyd8eGmThmFSur2TSGVsNG9vpYTYv6X/+myLt9iyFMlY9cym438pcwY4Tp4TNiVWUitMhZaNEBwnhXOLhRNqB3aNvZGXc6/rS6fjCxxbp36D2QJuyhxDgar89mmeHUo0twYNfnzt9XkjXUTlWVgEvZvW7LMmh+QzeUCWAEuV55KKkPLZJqCp3BTnjnwtnQpdCm44Ucn/vVbx9yVie0oi8jNQj1M2IVhpYHHAlKELL5kNg0X3p1ee0NzXqQLh3tIS6dwGVrLzw/Ik9s76oZQzkLejj5cM0q7uwF/fJbaDEZBNh/otaShgqefPl7zzbVx/bcybMLT0mn27F/s7eUNG/M5YpEMh9qmUs+tx+TF8xcvhrJQw8X5ME69wzFn4/HYMPbsHRvziyrMgqkT9hKkA8f+cPHq1eVoJG5+/eXy72PO14ONPO+XOLemIdHmxUYmFdqnOhH92IxN/T2A/bR5fTYDPCE52NGCDyL5HGQGzv+0aok/5gkb80qFMWd/rKJRoP0CZj02p2NTOGXwpBbnjGLr5PS0qeDPciFHwakNJXdebo1vjSc9N7rJB6mQTQHTeVDtqxRb7WiX1P9Z20uk5m+1o1ZRxZug4W9xx5p+SN0fxyaKGHC+Fq+lfEVkNZxpOzsh0tMfQ9NeX/bwGZDahcQ5T3hLeF63OzFqw61Jt9a8nS7XtMwyWIC2RU7fkCKn4I3IaFU4iza1ep0MhytitU5WFF3rPW6vSo82r1kM+EI6RS1H3YkHNrs3VyRm47qq+ks/nnJyl/+7m5v3bMOHvgFZj7v8NvruCTeKuEJrNJ4w69jV+9C5VuPXlkmnqar9gXq9JufU2BL6jKhkQJgVn4TQeFPPFz//84ZX3WoYIcLqdtYISq8HtFk4mDrw89/LhLp7M7UdM3NJ1wOw0y1tX20mPL44jybxmMt4VRHGT/4WMDQwvY0LKwjH9263NwXl//xraWVFhEccFlqqUBSr+8eYdbdcFjTDLs7jZEvXlwNOQRqj8JavViTyJ6fXa3pdfY24vdsmQqg+Ax7xJSRr7Csv0hQCrsUGM9kvvjtg8PaSQoHak+ZgWgdE9UDc687ZLBu8V6tIEQGLsjgKESCar6mF/S94j8fc -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get the bootstrap data for SqlLab page'} +> - - 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index b384ebd6f81..355a0350167 100644 --- 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 @@ -1 +1,42 @@ -{"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"}}} +{ + "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 index 298e14acc79..ef6ea62ca8c 100644 --- 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 @@ -1,33 +1,32 @@ --- id: get-the-csrf-token -title: "Get the CSRF token" -description: "Get the CSRF token" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get the CSRF token'} +> - - 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 index 74d702d0d05..9e47ade133e 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 9b4a26b0b7b..fe142933b3a 100644 --- 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 @@ -1 +1,73 @@ -{"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":"User2"},"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"}}} +{ + "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": "User2" + }, + "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 index 8d3b73e3cf6..0b964aceb3b 100644 --- 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 @@ -6,28 +6,27 @@ sidebar_label: "Get the dashboard's embedded configuration" hide_title: true hide_table_of_contents: true api: eJytVm1v2zYQ/ivEYcASTIntrAUCFf2QZWn6hi2IHWxYFLi0dLbYSqRKUk48Qf99OFKSpdgNtnSfJB7J4/PcPTxeBQXXPEeL2kB4W0GCJtaisEJJCGGWIku4SReK64SJhCnNTFauIABB8wW3KQQgeY4QgkjmSs+beY1fS6ExgdDqEgMwcYo5h7ACuylotbFayBXU9R0tNoWSBg3Nn4zH9ImVtCgt/fKiyETMCdTosyFkVc9foVWB2gq/W6MpM7tr51mm7jGZJyrnQjqTsJibPYiC1sC15hsaxymXK0zmi82u46XQxs59CPa4EknPLKTFFWqyZ/ypXaVB/Y3JLTy1+IyxhQCssBkZbgzqkz5eH6ql0jm3EELCLR5ZkSMEu0d2eZ4PIPcwlXsnnsBzkS8wSTD5tXV93eR56pO3u7cOAB94XmQ4zOVO9m7vhizhZHzy4mg8OZq8nE3G4c/jcDz+Cx6zakG3ZLYkCMpQ+9fucEYypCOZTZFhQ6h3KWIll8LF58V48h26zdEYvvpXCR8GqdsIN5KXNlVa/I1JyM5Km6K0zfmsu497qPY3kveX33UD/wcm76Ql/WfMoF6jZqi10iE7k6yU+FBgbDHxRqbiuNTf4PWGW575de5wg3Gphd24Svf53pKMqPxYviJJQadTA3cBPBzFKsGpg+eLY8blCkKIb64/At3gBWbboVGljgl8XOqMHf3JLi9mLILU2iIcjTIV8yxVxoan49PTES/EaD0ZdTIaTUattiJgURRJxo7esgjOmsS40IfsF+QaNfvh7Pz8Yjqdz37/cPFbBFAHHbirjU2V7MHrDB1AkRdKW6cINNZEMpJtAWavO/PxCu0B4WDPYxH4vSnyBLV5XT3iEkHIImj4RMB+YjyO0Zi5VV9Q1pE8jGShhbQHLbZjEt7B4WGf7Xu+5lOX8R7jgXGbFiUNke6I8nsuLFuijVPH8/ksqwHVsB2zx/kjzp/aFFae78zR/eR31PQh7q8i6fEm3PIO66NINItUhseZWh3Q0sNXQIIeXoNLtK56dQx+NNtK5utXqR1ACCBHmyoqjSuk8LkXPoTdIFTb177u4kHxdjfW35dSUzr2RhUeg/xI0yzBNWaqyFHa5u67bHtHVaGVVbHK6nA0qshVHVYk5XrH23lprMpbFwGsuRZ8kfkC1bqh/wSX3L0xDiYEgLLMqRY0Q/q4ajD0/3Y2u2KdnzoAQjP01/HdATf1RY3m6I2npurdFTkhLkMne0PV7Hera9c/tYXNvauepCtvFSyc2t60HcD7P2bQ9GJ0J/zsthtwpOuANs81LjWa9LlOqPWRS+XpDNCXBWqD/T6hZyLt+HXriQ+JsTl3703TZf4nNQ+O7t4jiw92VGRcSNfXaKcEr/Rb4IUgHJN+8wABhIPuthP8XZv6W6iqBTd4o7O6JvPXEvXGNyqt+nyHLQz9JxAueWZwB2P36sLBdfNmH7InGvG9nNoGVm6c+LOSRhDAF9wMG/X6jsTrCpdD5xecxTG66tlu3Xn/SXVdqbi8IEFQD9ELcieL5oe874VVVX6Fr4R1h9I9BASwrv8B+qtZzA== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index 0cc13bf0501..e33dbc4ce81 100644 --- 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 @@ -1 +1,18 @@ -{"parameters":[{"content":{"application/json":{"schema":{"properties":{"key":{"type":"string"}},"required":["key"],"type":"object","title":"sql_lab_get_results_schema"}}},"in":"query","name":"q"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 25e3f34ecd0..e98e1e40d5e 100644 --- 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 @@ -1 +1,223 @@ -{"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"}}} +{ + "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 index e9848dd92c4..752403135bb 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get the result of a SQL query execution'} +> - - 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 index 3bd8889b85e..9fd9262eccc 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The ID of the user","in":"path","name":"user_id","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index eb4e69c9447..e19e024a719 100644 --- 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 @@ -1 +1,31 @@ -{"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"}}} +{ + "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 index 17f78f57933..9d5e373c2e2 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get the user avatar'} +> - - 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 9786a04a8a9..1f321e0364b 100644 --- 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 @@ -1 +1,54 @@ -{"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"},"login_count":{"type":"integer"},"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","login_count":1,"username":"string"}}}},"description":"The current user"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"}}} +{ + "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" }, + "login_count": { "type": "integer" }, + "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", + "login_count": 1, + "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 index 8b0182a67fc..beca39d913e 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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+yIEvXFVtQO9iAKHBp6WwxkUiVPLnxBP334UjJluxsCLaHPUk6Ho/f993xTg1k6FKrKlJGQww3SE5QjqJ2aIVZPmJKIjXWoquMzpReCzLeQa5Rkyjlk7flKCx+rdFRJIwVFqm22gkp3lxMBVprrFCrfWDlRK1lTTlqUqkkzM4hgnCIQwdxAz9cXPAjNZpQE7/KqirYWRk9eXQMtwGX5lhKfqusqdCSCrsturqgYzuWUhX8QtsKIQZHVuk1tBGslHW00LLEF5dVNjArTbhG6+1uIVNSm+GupTEFSt0va6O3pandyx6F/KdjC7NWepGaOkhwfD7L+Te726i3hDxCBKSoYMOdQ/u5U3sWJDx2byPAZ1lWBY4V7TTszxlLt7eyYtORQGRrPJQk2AYi7AOMuE+HVPcUGfW4guc5irS2lquTdzCNNxfT/1BLJTon169SeCzZbiPc+WI3Vv2JWSwu94WvjPYXR1nM4AU2w43+PIdpbRVtIb5v4PEbQXz/0D5EQHLtIL6Hq446ZxgeIng+S02GM4/J+U2F1GuIIb37/IlFlkss9p/O1DZlxGltC3H2h7i5nosEcqIqnkwKk8oiN47itxdv305kpSab6aTESQIiSRItxNkHkcBlB9nTi8WPKC1a8d3l1dX1bLaY//bL9a8JQBvtsNxuKTd6gGZn2OFRZWUs9U3GJTrRfbsQ73fm8zXSCeMQrwIdBdccZYbWvW8OoCcQiwQ6+AmI74VMU3RuQeYJdZvo00RXVmk66aGccy2dnJ4OyX2UGznzKR0QHBn3ohvtmOOOl/wmFYkVUpp7Wq8m1YyYxf23OMwOU/zSJ6gJ9Oae3Zewo+UHU32X6AAvkyR30A6Id06mwPPCrE/Y9fQdcH2WSLnJIIY1MuVKUg4xDICzDmg3aEOV1pZlepEtHF6ST7wsMtxgYaqSqz9E8lkIgZrKGjKpKdp4Mmk4VBs3XFHtUbSr2pEp+xARbKRVclmEXtCH4fcMV9K3RA8TIkBdl3wHu09+OL6D4/gf5vNbsYvTRsBoxvF2fI/AzTwqwWvcCnnW/nzLQZjLOMiLUnX7vXfbcmL6huLHQCDp20oDS18WPxlbSo738fc558i78Qjzq7DrgJ50G/HmhcWVRZf/2yA8N/XKBDoj9HWF1uFwkg1MXDvBbzMNkjgqpW/t3di4QTr8uTlUaDAl/t+foU4RwmeaVIVU/mfBF3PT3Z57kJVi3lPg+wURcLGFarqHpllKh3e2aFs2f63R8tB42Be0Hx0RhB7hL90TbiGGyzRF35c2sqgZw9GwHF3om2tOKeMf/uD0ie1eOHq3JPV2ELtpgkdoOnwbAwjfYqF9aNv2L4XLpww= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get the user object'} +> - - 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 9786a04a8a9..1f321e0364b 100644 --- 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 @@ -1 +1,54 @@ -{"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"},"login_count":{"type":"integer"},"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","login_count":1,"username":"string"}}}},"description":"The current user"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"}}} +{ + "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" }, + "login_count": { "type": "integer" }, + "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", + "login_count": 1, + "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 index 097a00a43b7..772c431c8b6 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzFVt9v2zYQ/leIwx4STInioQ+Fij5kQZauK7agdrABUeDS0lliIpEqeXLjCvrfh6MkW7KzYd0e9iTqyDt+3/1kAym6xKqKlNEQwQ2SE5SjqB1aYU2BTiTGWnSV0anSmSDj92WGmkQpn7wsR2Hxc42OAmGssEi11U5I8epiJtBaY4Va7+0qJ2ota8pRk0okYXoOAXSXOHQQNfDDxQV/EqMJNfFSVlXBh5XR4aNjtA24JMdS8qqypkJLqtO26OqCjuVYSlXwgrYVQgSOrNIZtAGslXW01LLEF7dVOhIrTZih9XK3lAmpzVhrZUyBUg/b2uhtaWr38olC/t21hcmUXiam7lxwfD+78y+022CQmNUjJgQBkKKCBXcO7cfe2/POhcfH2wDwWZZVgVOP9j4c7pm6bi9lj80mDiJb46FLOtnICXsDE+6zMdU9RUY9TeBFjiKpreXsZA2m8epi9h9yqUTnZPaPPDx12U4R7nyyG6u+YhqJy33iK6N94SiLKbzAZqzo73OY1FbRFqL7Bh6/EET3D+1DACQzB9E9XPXUOcLwEMDzWWJSnHtMzisVUmcQQXL38QM7Wa6w2P86U9uEESe1LcTZH+LmeiFiyImqKAwLk8giN46i1xevX4eyUuFmFpYY+j4RxiDiONZCnL0TMVz2wD3JSPyI0qIV311eXV3P58vFb79c/xoDtMEO0e2WcqNHmHaCHSpVVsbS0GpcrGM9NA3xdic+z5BOGIf4BuhBp5CjTNG6t80BgRgiEUNPIgbxvZBJgs4tyTyhbmN9GuvKKk0nA6BzzquT09MxxfdyI+c+vCOaE+E+AEY7ZrpjJ79IRWKNlOSe3DdSayb8ouFfHEaKiX4agtV0JBee46dOo+UPE34T6w5kKknuAB7Q7w+ZAs8Lk53w0dM3wBlbIuUmhQgyZOKVpBwiOILPPkG7Qdtlb23ZZS8yh8Pi+cDbIsUNFqYquSo6Sz4inaGmsoZMYoo2CsOGTbVRwznWHlm7qh2ZcjARwEZaJVdF1yMGM7xOcS19q/QwIQDUdcm12f/yx3FtTu2/Wyxuxc5OGwCjmdrb8T0CN/eoBO9xi+QZ/PMtG2EuUyMvuqrX96fblsMzNBo/HjqSvt00sPLJ8ZOxpWR7739fcIz8MR5tfhd2ndGTbgNWXlpcW3T5vzXC81SvTUdngr6u0DocT7iRiHOnO7eZdS5xVErf8vtxcoN08OY5dNBoePyvT6TeH4TPFFaFVP4J4VO56SvoHmSlmPUMuMb4WdUT4pTrcuoemmYlHd7Zom1Z/LlGyyPlYZ/WfrAE0PULX3pPuIUILpMEfafayKJmLEejdFLcN9ccWOYxfv4M4e0XbL3fkno7st003YmuAXFNdiB804X2oW3bPwFVPbH7 -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Get the user roles'} +> - - 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 index bfce4beffd3..1c152467682 100644 --- 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 @@ -1 +1,40 @@ -{"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}} +{ + "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 index ec8f40024c1..9d2556e5d1d 100644 --- 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 @@ -1 +1,66 @@ -{"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"}}} +{ + "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 index 36d2857b0cc..da5b3d9ed1a 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Import chart(s) with associated datasets and databases'} +> - - 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 index e37e9ae83d9..cf7a56cbebb 100644 --- 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 @@ -1 +1,40 @@ -{"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}} +{ + "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 index 7692ed4a255..98af82c301b 100644 --- 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 @@ -1 +1,66 @@ -{"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"}}} +{ + "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 index 060dc734273..86c293bf79a 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Import dashboard(s) with associated charts/datasets/databases'} +> - - 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 index 400a83ef831..a2ab789f621 100644 --- 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 @@ -1 +1,40 @@ -{"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}} +{ + "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 index 126f4f7a972..85e4ea6590b 100644 --- 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 @@ -1 +1,66 @@ -{"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"}}} +{ + "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 index 580b133c54b..3db505c5d3f 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Import database(s) with associated datasets'} +> - - 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 index 5b9f8c7f350..ffe9fe1e652 100644 --- 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 @@ -1 +1,48 @@ -{"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}} +{ + "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 index 803ede4cf18..08a402354f0 100644 --- 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 @@ -1 +1,66 @@ -{"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"}}} +{ + "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 index d88978b9ab5..12fc45d5978 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Import dataset(s) with associated databases'} +> - - 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 index d3a77271f14..2ecce3649c1 100644 --- 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 @@ -1,13 +1,13 @@ --- id: import-export -title: "Import/export" -description: "Import/export" +title: 'Import/export' +description: 'Import/export' custom_edit_url: null --- Import and export Superset assets. -| Method | Endpoint | Path | -|--------|----------|------| -| `GET` | [Export all assets](./export-all-assets) | `/api/v1/assets/export/` | +| 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 index 90230f1924b..1ea7029a9ce 100644 --- 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 @@ -1 +1,40 @@ -{"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}} +{ + "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 index 4dade005a51..06f2299f4a4 100644 --- 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 @@ -1 +1,66 @@ -{"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"}}} +{ + "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 index 744735c9a57..d7604a74414 100644 --- 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 @@ -1,33 +1,32 @@ --- id: import-multiple-assets -title: "Import multiple assets" -description: "Import multiple assets" -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Import multiple assets'} +> - - 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 index b6193130e6b..2d64a509a10 100644 --- 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 @@ -1 +1,40 @@ -{"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}} +{ + "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 index 2f1c57b6b7b..ffc78c75e0f 100644 --- 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 @@ -1 +1,66 @@ -{"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"}}} +{ + "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 index bd2c0df0bc1..ecd644ccc49 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Import saved queries with associated databases'} +> - - Import saved queries with associated databases - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.RequestSchema.json index 75ba9da0b05..e3fdefbf343 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.RequestSchema.json @@ -1 +1,17 @@ -{"title":"Body","body":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"format":"binary","type":"string"},"overwrite":{"type":"string"}},"type":"object"}}},"required":true}} +{ + "title": "Body", + "body": { + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "formData": { "format": "binary", "type": "string" }, + "overwrite": { "type": "string" } + }, + "type": "object" + } + } + }, + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.StatusCodes.json index 8144869c29c..de7b9c08681 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.StatusCodes.json @@ -1 +1,66 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Theme imported"},"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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "example": { "message": "string" } + } + }, + "description": "Theme imported" + }, + "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-themes-from-a-zip-file.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.api.mdx index c0783de61f6..102a00d58cf 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.api.mdx @@ -1,33 +1,32 @@ --- id: import-themes-from-a-zip-file -title: "Import themes from a ZIP file" -description: "Import themes from a ZIP file" -sidebar_label: "Import themes from a ZIP file" +title: 'Import themes from a ZIP file' +description: 'Import themes from a ZIP file' +sidebar_label: 'Import themes from a ZIP file' hide_title: true hide_table_of_contents: true api: eJzFV21P5DYQ/ivWqNKBGlg4tRLyiQ9A73TQ04G6S1uVIM6bzJKAY/tsZyGN8t+rsbPZF7bV9b7waR17Zvw8z4zH3hYsfq3R+VOdN8BbyLTyqDwNq1r60gjrRzNtq71ceEHTLiuwCiNjtUHrS3T0RUa/9DY0Fh44TEslbAMJ+MYgcHDeluoeugT0HO2TLT2S/cZqN9jr6QNmHjqaIqSlxRy4tzWGCWe0cnH7twcHG/iFMbLMhC+1Gj04rf4LfIXOiftvw5IAPovKSFxzXDp0CeToMlsa2ho4TAqskJWV0dZjTgF+em2wpyJnfeY5O1dzIcucGWFFhR6tY8bqeZkT2Jd0Vnwjl8PX5XKtRO0Lbcu/MefspPYFKt/vz4ai2UJk1TEwefv2tZkYqzP6nEpkxMI3nP1OyYls0Fptt1E507XMmdKe9RF6b9rq59cutnPl0SohmUM7RxtZcHaiWK3w2WDmMY+TTGdZbf8lXR+EF3KQIAGHWW2JI79p4eHJA7+57W4T8OLeAb+Jx87BbQLPe5nOcRyguWAuhboHDtn1b58gASmmKJefTtc2I+BZbSXb+5NdXY4nLIXCe8NHI6kzIQvtPD86ODoaCVOO5ocjT7uN4iEfpcDSNFWM7X1kKZz0VRYE5+wUhUXLfjg5O3s/Ht9NLn99/3nd4Symam/SGORsM1tL25y9aVN4xCYFzlKYC1ljCt0b6JKB4lXjC61WSA4TA80IenGmXapStWit7HiY3jfa+R3al/1PLZLoVKDI0brjdkORCL5XJQX2IxMZlfCd14+out6bmB9vY5uq3VQZWyq/s0C9T8Y7u7urOlyIuRiHalrRYm1ymXatHMkxSCCeROnZDH1WBAG+g34bWVToC50TfKqpTWn4woxtVg1R/rIonDbqMwnyfEmWLqt1E0V6WTvReqHqVOcNZxfjy8/78ViXs2anZY/YrEjMul2yJqXfpSqqQ6+BQZkN3XsjLXFf6vsdMt19B3Q01w/0eay7IJdjM6srJthf51dsVkqEBKJYwIEqDxIwwhfAYavMlL/QXeL5ri2ld2uWYBPGJ1pmOc5RalOh8n2fCtUTA7XGaq8zLTs+GrUUquMt7du9iHZWO6+rRYgE5sKW1M5d31pDGBrnOBO19D1MSABVXVHf6j/pJ3Sv9fgfJ5MrNsTpEiA06/EGvi/AjWMDpjUlKmTasvMrCkJc1oNslar3D9ZdRxldNOFxFrst71txC9NQrR8WL8GLPyaUo2BGD8OwunwYBtJdQs53FmcWXfG9QboESjXTkc4a+tqgdUiy+NLTLbU6RbUT7eaHURLnKxHuRtLqG+p1bbfhuvT47EdGilJR1FBPbV/KNyBMSVsfEqRAKum7MSRAuY/JvYG2nQqH11Z2HU1/rdHSvXe7rK9w+yUQO0k4A4/YhJfBsieEcpQ1odr2uKd6j04nWYahJy7MX7wYKPfD+aReBglM+/8Qlc7JhwKHuMlyGEHSs2tFoSGN/YDA90tCNSso2jZaxM5HZy/CDRcFdLdd1/0DL/JmaA== -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Import themes from a ZIP file'} +> - - Import themes from a ZIP file - + 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 index 1349268ad50..89eefa11994 100644 --- 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 @@ -1 +1,62 @@ -{"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}} +{ + "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 index 7293178251c..de52af4cbb9 100644 --- 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 @@ -1 +1,31 @@ -{"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"}}} +{ + "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 index ee9345f06fb..a74d47387b5 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Invalidate cache records and remove the database records'} +> - - 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 index 6f651b11f2f..0eccd344c02 100644 --- 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 @@ -1 +1,38 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 292bd6c40bf..53307d5fd97 100644 --- 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 @@ -1 +1,63 @@ -{"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"}}} +{ + "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 index 81e64aaf5f5..290b6fbf527 100644 --- 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 @@ -1,33 +1,32 @@ --- id: list-roles -title: "List roles" -description: "Fetch a paginated list of roles with user and permission IDs." -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'List roles'} +> - - 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 index b696bdb148d..4245b4552ca 100644 --- 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 @@ -1,15 +1,15 @@ --- id: log-rest-api -title: "LogRestApi" -description: "LogRestApi" +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/` | +| 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 index 433cf12ddaf..0d521535b3b 100644 --- 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 @@ -1 +1,17 @@ -{"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}} +{ + "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 index 627e8a5a87c..6f9dae6dba3 100644 --- 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 @@ -1 +1,68 @@ -{"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"}}} +{ + "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 index 381a3c2385a..3f37a12dc10 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Manually stop a query with client_id'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index bde035b8224..01b3ece33e2 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index ead02b1160e..791079f3843 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Mark the chart as favorite for the current user'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index dec39d31680..013bb4a67f1 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index 98480c437c3..a2709d56809 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Mark the dashboard as favorite for the current user'} +> - - 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 index 8b87fac326c..38e05b95349 100644 --- 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 @@ -1,12 +1,12 @@ --- id: menu -title: "Menu" -description: "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/` | +| 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 index e89635adf8b..8bc4433dafc 100644 --- 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 @@ -1,12 +1,12 @@ --- id: open-api -title: "OpenApi" -description: "OpenApi" +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` | +| 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 index f10d90fa60f..33fa6777586 100644 --- 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 @@ -1,28 +1,28 @@ --- id: queries -title: "Queries" -description: "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}` | +| 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 index 995b1752157..da3e44c1d02 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The database connection ID","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 39a9f2bda6e..044aa72ce71 100644 --- 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 @@ -1 +1,68 @@ -{"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"}}} +{ + "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 index 75c1c832b15..cadd2de0a67 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Re-sync all permissions for a database connection'} +> - - 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 index eb93b6e0897..bb78c970258 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"description":"Last ID received by the client","in":"query","name":"last_id","schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index e131d7d10b8..f5b8c0dcc6d 100644 --- 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 @@ -1 +1,73 @@ -{"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"}}} +{ + "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 index 9eb6c0c16ae..810593dd7fc 100644 --- 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 @@ -1,33 +1,32 @@ --- id: read-off-of-the-redis-events-stream -title: "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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Read off of the Redis events stream'} +> - - 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 index 7b843360b67..29d687c549b 100644 --- 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 @@ -1 +1,8 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 189c0e10c53..354fa184d6f 100644 --- 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 @@ -1 +1,48 @@ -{"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"}}} +{ + "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 index 82ec8e53dd5..7c4438fd303 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Receive personal access tokens from OAuth2'} +> - - -> 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index e3987fc23f7..e279961074b 100644 --- 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 @@ -1 +1,82 @@ -{"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"}}} +{ + "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 index 571a114938d..c47134f0e2b 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Refresh and update columns of a dataset'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index ae188c143b1..29f960ed2c5 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index 09e545f4fe5..d5918b0e4da 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Remove the chart from the user favorite list'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index e753aec7674..7a2830ea360 100644 --- 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 @@ -1 +1,56 @@ -{"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"}}} +{ + "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 index f66b4ac3ef8..1bb3945fcc5 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Remove the dashboard from the user favorite list'} +> - - 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 index 00b7c2917c2..6d17a4aae59 100644 --- 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 @@ -1,22 +1,22 @@ --- id: report-schedules -title: "Report Schedules" -description: "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/` | +| 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 index 7dc7c8a93f2..99e7b549f58 100644 --- 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 @@ -1 +1,51 @@ -{"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}} +{ + "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 index 8504b3c8a5d..d94f32786e3 100644 --- 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 @@ -1 +1,71 @@ -{"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"}}} +{ + "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 index 90c172b7676..f40022159d9 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'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 - + 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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index 0c7ab7bfcd8..9ace371b2de 100644 --- 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 @@ -1 +1,72 @@ -{"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"}}} +{ + "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 index e206396380a..3639ea69088 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Return a list of available advanced data types'} +> - - 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 index 3cc2fd1ba6c..107f6270678 100644 --- 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 @@ -1 +1,25 @@ -{"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"}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index d6bec92af2c..b34df3d20a1 100644 --- 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 @@ -1 +1,105 @@ -{"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"}}} +{ + "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 index 4139d8f498d..7f8fedb2625 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Return an AdvancedDataTypeResponse'} +> - - 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 index b81014de5fc..9428ca2ea7e 100644 --- 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 @@ -1 +1,29 @@ -{"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"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index c880cf215e2..a4f7220a32d 100644 --- 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 @@ -1 +1,220 @@ -{"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"},"detected_currency":{"default":null,"description":"Detected ISO 4217 currency code when AUTO mode is used. Returns the currency code if all filtered data contains a single currency or null if multiple currencies are present.","nullable":true,"type":"string"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"queried_dttm":{"description":"UTC timestamp when the query was executed (ISO 8601 format)","nullable":true,"type":"string"},"query":{"description":"The executed query statement. May be absent when validation errors occur.","nullable":true,"type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","queried_dttm"],"type":"object","title":"ChartDataResponseResult"},"type":"array"}},"type":"object","title":"ChartDataResponseSchema"},"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"}}} +{ + "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" + }, + "detected_currency": { + "default": null, + "description": "Detected ISO 4217 currency code when AUTO mode is used. Returns the currency code if all filtered data contains a single currency or null if multiple currencies are present.", + "nullable": true, + "type": "string" + }, + "error": { + "description": "Error", + "nullable": true, + "type": "string" + }, + "from_dttm": { + "description": "Start timestamp of time range", + "nullable": true, + "type": "integer" + }, + "is_cached": { + "description": "Is the result cached", + "type": "boolean" + }, + "queried_dttm": { + "description": "UTC timestamp when the query was executed (ISO 8601 format)", + "nullable": true, + "type": "string" + }, + "query": { + "description": "The executed query statement. May be absent when validation errors occur.", + "nullable": true, + "type": "string" + }, + "rejected_filters": { + "description": "A list with rejected filters", + "items": { "type": "object" }, + "type": "array" + }, + "rowcount": { + "description": "Amount of rows in result set", + "type": "integer" + }, + "stacktrace": { + "description": "Stacktrace if there was an error", + "nullable": true, + "type": "string" + }, + "status": { + "description": "Status of the query", + "enum": [ + "stopped", + "failed", + "pending", + "running", + "scheduled", + "success", + "timed_out" + ], + "type": "string" + }, + "to_dttm": { + "description": "End timestamp of time range", + "nullable": true, + "type": "integer" + } + }, + "required": [ + "cache_key", + "cache_timeout", + "cached_dttm", + "is_cached", + "queried_dttm" + ], + "type": "object", + "title": "ChartDataResponseResult" + }, + "type": "array" + } + }, + "type": "object", + "title": "ChartDataResponseSchema" + }, + "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 index 30a1d5e95c1..a00a962fd29 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzFWW1vI7cR/isE0Q82qrPsQ9oeNsgHx+ckTq69qyWjBSxDobgjLW0uuUdyJavC/vdiSO6LpJVq+4Dmk7V8mXnmfTje0BQsN6JwQiua0DF7AksY4Rkzjtx8JEylpLRgicuAfC3BrAnXysGzI9ZpAylZZaD8brizYpZYtoSUOE0MuNIoUrC11CwlKXOMGLCFVhbO6IAWzLAcHBhLk/vNLpaG5s1HOqAC1wrmMjqgiuWAX090QA18LYWBlCbOlDCglmeQM5psqFsXeEooBwswtKoGfSzm2uTMEaHIKhM886J4oDbTpUzJDKIYkNYovB5aGIEC7WFtnRFqcYgzHvoWvp7Jq7iOAunalgIssplrw4O9vJXmRuf+iNWl4XBYaN7Lfaa1BKZoVT2gcYKxLR54f36Of7z/KIc/WVFIwRmiGz5ahLjpECyMLsA4EW4bsKX0t7ZluiRSWEf0nIQTFuUhwHhGuDYBQCrUInqvCM6KXgPWoRMKB7nd58eU0s5Dm6JZehhLWZOBlLTHvRW7dFmaCtxg8ssWhx1zDeoFPXsE7nBBlVKymYTat+MBZgxb477XH6TTuZAhiA4oZyVcRuJhUh/uINxjvMuIM57B9AnW+yzulPhaAvEnyBOsvfqDriO9g3K0kgf6TuSgyx4bX3nicRtNONdS6hVaVZsUTEJ4aR26bTgy8DYI/tuuBYgpzFkpXWdZq7lYNOu8y+vsMPgmrUT06TR1Lj+G3TqWFy/ShpYYZYftqeeEa1nmioRz+6bcc6rWlFri0lHiC1BgBA/5yJ/G1RhTyLeHY0cfuywPxE/HN2PovsonU3DAHaRTXhoDikff9FakCSp5sMPxY7xBbkafyXfvL/5G6quE6xRCKbu8G38mOX4Ki6UvPSO3Pg+HGrh9Q8wJkzKGFMQKhwmOCYV11Aq1kJ1L2hAEhvfyUjpRtJuYjJkBUhiwoI55XmtbMEabfc1e++UX3MdUf8BtRw4rb+O2aH/8IIapBbwoKoSdhsDYJ35jYxK2TcRhkdutIAMaqtSh0LobX3UQNo1ISD7YiMAz8BINfoIW//DX84tY7k9fop1Q8fa4YuluCAde1jEHOVqN/J2tsaayGRoxYFoyKdJQGrzBLNGcl+ZFFjbwGJz8RSm+Pv2mHG/0iutS9ZXYHNd9idUri/k3Ws6Co32mt47xJ2cYh17HinsYBS4DA95WLGrnJVpBfZc9uhj5de+rtR/QAQVV5jS5p9bpovCONmdC+h8F+N4A28hSqfALG5C0DPu25Bws6hH9LJ1idXroAeT0ARe9Vuk3BFHVbW/vO1V4t2Ju16Bu7O3E0MNul4GSOURAr7DX/sgcu41N223ouPZcZa9TOUJjFLo5zFXPLC8kdFu5+4eqqnaT9D99RJmG9/vz99/QNfKMKQVyKnqyUOxcLFiLscnsWnESL4Q3x56dH/XsGKlA4lHPDlwPUk1LIw+SiJF1d/vJN1JzcDzDPieQDukmNpivDYslk6Xv9lucfVRKC6ZXyNvQ7CIaPBNk/B+x+hJfuUQ0Rx2ma8WadGuMdqWr33a1Vku70ojY4tzzw8vGlik4JqRFTN990xMmB2vZAnqfavv5uSN/c5H+yNL60ZGQG+VLC2mf0aQweilSSPsk6twNslz8sbLcKVa6TBvxH0gTclm6DJSL/EmT93oE6V5E6n/5o61yoxwYxSSxYJZgQiFLyKUipYLnItRkvxhK/wG5fmKOyVgFcdcCL41waz8ceVyFjIkZnC1wYBIiyGJOf36H7ejIQwuzFMnUgiaU391+ogMq2Qxk+xlf9gnlpZHk3b/Jz9djMqGZc0UyHErNmcy0dcmH8w8fhqwQw+XF0I9ihhdDTD7DCSWTyUQR8u4XMqGX0Rpe3wn5EZgBQ/50eXV1PRpNx59/u/7HhFIcR0RUX9Yu06qDq1lokIm80MbV/monaqLqYQL5oVk+W4A7QRzklfAH4VIGLAVjf9jsCDGhCZnQKMiEkj8T5huBqdNPoKqJOp2owgjlTppxFrrZyelpV8xf2ZKNvH07om4ttobQyjrSkZCtmHAh/XsB3yDeZkvGpP4muxZDYX+vjbYJgo69nL+HGxX+QaG/n6gA1L9zapA7KoiHtIQzqRcnePT0e4p+m4PLNGbdhe8b/TAvodsibIqnKkiB6vHhFBw6JPVeJdDdQPqE2ySFJUhdYF8eA9MbJxDaFEY7zbWskuFwg6SqZIMuV+1RuwqzhUhiQJfMCCx59dDIk9l6fHqYnc4zfuIfH67b9H8Zj7+Qhk41oIhmm14j7x64Ucg4uIezAHxh3nxBIijLNpFeVcX7/nTlZ3Z11vGVOAjpc8+GzryP/BTGnQn99V/jegDon21+t+0ovNDYM63c1MDcgM3eSgRfk2quezqbsgATXyGxregsoe+Ec8uLoBLrcuaLQZxi3h4ZUIdOKYygd9XWKTb/75l5VAySGxaSCf9Ojh1liKh7ygqB4l/guyDCT/ywPHaO6IPBye7pZjNjFu6MrCpcjo9enMYLi16e0mTOpIVjGnj1GL1XCD9ebKfpvl2lSSgcrwPzmsn6EShxwP5GIG8cth9XDd8G9NBmo1fa7OQ2NlinZOcfLb0A6hegWnf518CKJ1o9YOLypcYjCRuXnEPRNeZeY7ZVF36+xmSAzV33Hwp1Sog/kHovnM0mnAi1q2rQ+ZqNAKvqv78dXJU= -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Return payload data response for a chart'} +> - - 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 index 2778da0e092..31eb25065ed 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"cache_key","required":true,"schema":{"type":"string"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index d82cc84b6d8..75abeeff6ad 100644 --- 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 @@ -1 +1,205 @@ -{"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"},"detected_currency":{"default":null,"description":"Detected ISO 4217 currency code when AUTO mode is used. Returns the currency code if all filtered data contains a single currency or null if multiple currencies are present.","nullable":true,"type":"string"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"queried_dttm":{"description":"UTC timestamp when the query was executed (ISO 8601 format)","nullable":true,"type":"string"},"query":{"description":"The executed query statement. May be absent when validation errors occur.","nullable":true,"type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","queried_dttm"],"type":"object","title":"ChartDataResponseResult"},"type":"array"}},"type":"object","title":"ChartDataResponseSchema"},"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"}}} +{ + "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" + }, + "detected_currency": { + "default": null, + "description": "Detected ISO 4217 currency code when AUTO mode is used. Returns the currency code if all filtered data contains a single currency or null if multiple currencies are present.", + "nullable": true, + "type": "string" + }, + "error": { + "description": "Error", + "nullable": true, + "type": "string" + }, + "from_dttm": { + "description": "Start timestamp of time range", + "nullable": true, + "type": "integer" + }, + "is_cached": { + "description": "Is the result cached", + "type": "boolean" + }, + "queried_dttm": { + "description": "UTC timestamp when the query was executed (ISO 8601 format)", + "nullable": true, + "type": "string" + }, + "query": { + "description": "The executed query statement. May be absent when validation errors occur.", + "nullable": true, + "type": "string" + }, + "rejected_filters": { + "description": "A list with rejected filters", + "items": { "type": "object" }, + "type": "array" + }, + "rowcount": { + "description": "Amount of rows in result set", + "type": "integer" + }, + "stacktrace": { + "description": "Stacktrace if there was an error", + "nullable": true, + "type": "string" + }, + "status": { + "description": "Status of the query", + "enum": [ + "stopped", + "failed", + "pending", + "running", + "scheduled", + "success", + "timed_out" + ], + "type": "string" + }, + "to_dttm": { + "description": "End timestamp of time range", + "nullable": true, + "type": "integer" + } + }, + "required": [ + "cache_key", + "cache_timeout", + "cached_dttm", + "is_cached", + "queried_dttm" + ], + "type": "object", + "title": "ChartDataResponseResult" + }, + "type": "array" + } + }, + "type": "object", + "title": "ChartDataResponseSchema" + }, + "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 index ebb1cf2e631..94b5b2ac2c1 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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: eJzFWNtuIzcS/ZUCsQ82IlvjwWwy6CAPjuMkzm0mlry7gGUodLOk5phN9pBs2YrQ/74okt1q3QzvDBbzJDUvVXXqxkOumECXW1l5aTTL2Jg/oAMOH2u0S8iN9vjkIed5gfCAS+BagEVfW+2g4ktluADBPQeLrjLaIcyMBV8gzOUCdZRzygas4paX6NE6lt2umCRlFfcFGzDNS2QZC0qmD7hkA2bxYy0tCpZ5W+OAubzAkrNsxfyyosXOW6nnrGnuaHFU7Wj+9atX9BMs157+8qpSMucEcPjBEcpVT15lTYXWy7jboqtV2LXplnNQ0nkwM4grXICJPC8gNzYaIKSeJ79JHVxAKNB5gi89lm5XH9fa+GDalLy4R7FSrRgUsF4enN6Xy4WQNMHV+w0NW/4atAPm/gPmngZ0rRS/V9j6Oi3g1vIlzQf/oZjOpIrhO+CcR+kLSIuhXdyzcEfxtqJ1AuyouNHyY429PCT3R18neQdxrJFH+V6WaOo9Mb4IwtM0hXBmlDKPFFVjBdoM8tp5U7ZLBiEGztQ2x/VYNFHgjNfK94aNnsl5N573dZ0eNl5qj3O0nfViKrwvn7PdeV5WL/KGUVR4h+NpZpAbVZca4rrdUO4k1TqURtHQs8LnqNHKPLaPsJpGU02R3j0ae/7YVnmgfnq5mUr3f8pJgR5zj2Ka19aizlNuhiiyjJw82NL4Q9oBV6N38Ob12TfQboXcCITHAjWc34zfQUmf0kHtUJzCdeqq1Dg2d8gZcKVSSWHqt9TguNTUq53Uc9XbZCyQYbSvrJWX1XpSUnO3CJVFh/q5zFvHFq01dtezl2H4Bftn1pQH0nbkufXrtKX40wdYruf4oqqQbhoLY1f4lUtN2HUVJ1gn494YhVyTDOoj8mBp3YwvehaG6JHY2HweuQN8wrymgB9RxN9+/eqMulPJ/fFLvBPk7GodF7gWHHU5zz2WFDX4nS/hHoHfUxCjTQuupIhHQwiYA5PntX1RhC1+iEn+ohbfrv6kHm/NY25qve+ILWk8HLHm0VH/TZFz6Nm+0DvP8wdveY57EyvNURX4Ai2GWPHknZd4hfxd7/HFKIyHXG3zgA0Y6rpk2S1z3lRVSLQZlyr8qTBwA6I1tdbxHxEQUcd5V+c5OvIj5ZmY0ul0t8cgbw6k6KUWn1FETZ9u3W7QsM0Tc/MM6tfeVg3dbbMMQubJAnZRcOt/4J5fJ9J2HRnXTqrsMJVnZIwim6Ne9cTLSmGfyt3eNU2z3aT/DBVlO91vPos1lugcn+M+erqHb/Vs7Day77loeV4GVzpUM6w5M1TWLKRAwfaA6e2NWM6+LJYbzWtfGCv/RpHBee0L1D7phy7V9gDpb4xI3nxZJH8YDzNTa5HBeM3nkdydeJ8w6EAbD/gkyf27oDoZAdHr1186NpU11G2oIwDFxS8z+NfW4bEPx4WplQhQk4S0m1T980uXz5X2aDVX4NAu0EYUGZxrqDU+VfG8CoPxWDyQgD9yz1XnggFzmNeWMNKV9cNj7CbU3ficrrGxEznqd08nRNVGwbR4w1Vcz+lWe3P9Gxswxe9RrT9j9tB3bRWc/Ad+uhzDhBXeV9lwqEzOVWGcz96+evt2yCs5XJwNc1I2JPI3XHVNupkwmEwmGuDkZ5iw81Q/wfEZfI/cooV/nF9cXI5G0/G7Xy//mDDWDDrz3i99YXTPwG6gM1GWlbG+TX430RPdXfa/64ZP5+iPyA74VByDuLtALtC671ZbaCYsgwlLiCYMvgIejs2pNw+om4k+nujKSu2PWutOKfGOjo/7eH/hCz4KEe9h3hhch8Zo56EHlT9y6WGGPi8C0s/BudoAm7XfsB1DQv1XG8ZVRDwOgP+KOxr6IfTfTnS0OFwPWmu3fJEWGYWnysyPaOnxt4xSukRfGMEyNg90KzzNZOx5LOStUG8x42tLztzrE7Zdab/RNAhcoDIVkdpUuSFWUdCqssab3KgmGw5XJKrJVpSKzY60i3gxTyIGbMGtpAbXvrgEMRs3t2Bmj7alT/oJ9bwp/+fx+D10cpoBI2s25XV4d4wbxZZEc3SRpuvZ1XsSQlg2hex1VdofVjfhwattS4H3RJChOa3YfciUH8P1gxL73+PENcMLW5xdk+kAuhnQ5qnFmUVXfKoQuorpmdnDlusKbaLwib/1hih34rrFWXSJ8yUPp0V6FYzX4pe/NcJRyNUTWngSUvXkAZfH217tHVb/vzfP5CESN6wUl+G2GZJ7lQrslvFKkh/OiF2T4Sy9ZAxYtmbid23G3bLV6p47vLGqaWg4XR9v79ZJH2pRyHDCC5bNuHL4DPqj68TIjuGQyS0z18tQW6qmLzZg4amud2Fo7qg0QksLRsT58zzH0FnbnTvcYKP//HRJ6UZEsEcIuqRLf0j6XqtWq7gi9simMzIcEmRg0/wXEq0Dkg== -sidebar_class_name: "get api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Return payload data response for the given query (chart-data-cache-key)' + } +> - - 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 index 6683438a437..f5681d2299f 100644 --- 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 @@ -1 +1,549 @@ -{"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 or uuid"},"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",null],"nullable":true,"type":"string"},"overrides":{"additionalProperties":{"nullable":true},"description":"which properties should be overridable","nullable":true,"type":"object"},"show":{"description":"Should the layer be shown","type":"boolean"},"showLabel":{"description":"Should the label always be shown","nullable":true,"type":"boolean"},"showMarkers":{"description":"Should markers be shown. Only applies to line annotations.","type":"boolean"},"sourceType":{"description":"Type of source for annotation data","enum":["","line","NATIVE","table"],"type":"string"},"style":{"description":"Line style. Only applies to time-series annotations","enum":["dashed","dotted","solid","longDashed"],"type":"string"},"timeColumn":{"description":"Column with event date or interval start date","nullable":true,"type":"string"},"titleColumn":{"description":"Column with title","nullable":true,"type":"string"},"value":{"description":"For formula annotations, this contains the formula. For other types, this is the primary key of the source object."},"width":{"description":"Width of annotation line","minimum":0,"type":"number"}},"required":["name","show","showMarkers","value"],"type":"object","title":"AnnotationLayer"},"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 or uuid"},"type":{"description":"Datasource type","enum":["table","dataset","query","saved_query","view"],"type":"string"}},"required":["id"],"type":"object","title":"ChartDataDatasource"}],"nullable":true},"extras":{"allOf":[{"properties":{"column_order":{"description":"Ordered list of column names for result ordering. Used to preserve user's column reordering (including mixed dimension columns and metrics)","items":{"type":"string"},"nullable":true,"type":"array"},"having":{"description":"HAVING clause to be added to aggregate queries using AND operator.","type":"string"},"instant_time_comparison_range":{"description":"This is only set using the new time comparison controls that is made available in some plugins behind the experimental feature flag.","nullable":true,"type":"string"},"relative_end":{"description":"End time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"relative_start":{"description":"Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`","enum":["today","now"],"type":"string"},"time_grain_sqla":{"description":"To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z",null],"example":"P1D","nullable":true,"type":"string"},"transpile_to_dialect":{"description":"If true, WHERE/HAVING clauses will be transpiled to the target database dialect using SQLGlot.","nullable":true,"type":"boolean"},"where":{"description":"WHERE clause to be added to queries using AND operator.","type":"string"}},"type":"object","title":"ChartDataExtras"}],"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","NOT ILIKE","IS NULL","IS NOT NULL","IN","NOT IN","IS TRUE","IS FALSE","TEMPORAL_RANGE"],"example":"IN","type":"string"},"val":{"description":"The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.","example":["China","France","Japan"],"nullable":true}},"required":["col","op"],"type":"object","title":"ChartDataFilter"},"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"},"group_others_when_limit_reached":{"default":false,"description":"When true, groups remaining series into an 'Others' category when series limit is reached. Prevents incomplete data.","nullable":true,"type":"boolean"},"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",null],"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}} +{ + "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 or uuid" }, + "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", + null + ], + "nullable": true, + "type": "string" + }, + "overrides": { + "additionalProperties": { "nullable": true }, + "description": "which properties should be overridable", + "nullable": true, + "type": "object" + }, + "show": { + "description": "Should the layer be shown", + "type": "boolean" + }, + "showLabel": { + "description": "Should the label always be shown", + "nullable": true, + "type": "boolean" + }, + "showMarkers": { + "description": "Should markers be shown. Only applies to line annotations.", + "type": "boolean" + }, + "sourceType": { + "description": "Type of source for annotation data", + "enum": ["", "line", "NATIVE", "table"], + "type": "string" + }, + "style": { + "description": "Line style. Only applies to time-series annotations", + "enum": ["dashed", "dotted", "solid", "longDashed"], + "type": "string" + }, + "timeColumn": { + "description": "Column with event date or interval start date", + "nullable": true, + "type": "string" + }, + "titleColumn": { + "description": "Column with title", + "nullable": true, + "type": "string" + }, + "value": { + "description": "For formula annotations, this contains the formula. For other types, this is the primary key of the source object." + }, + "width": { + "description": "Width of annotation line", + "minimum": 0, + "type": "number" + } + }, + "required": ["name", "show", "showMarkers", "value"], + "type": "object", + "title": "AnnotationLayer" + }, + "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 or uuid" }, + "type": { + "description": "Datasource type", + "enum": [ + "table", + "dataset", + "query", + "saved_query", + "view" + ], + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "ChartDataDatasource" + } + ], + "nullable": true + }, + "extras": { + "allOf": [ + { + "properties": { + "column_order": { + "description": "Ordered list of column names for result ordering. Used to preserve user's column reordering (including mixed dimension columns and metrics)", + "items": { "type": "string" }, + "nullable": true, + "type": "array" + }, + "having": { + "description": "HAVING clause to be added to aggregate queries using AND operator.", + "type": "string" + }, + "instant_time_comparison_range": { + "description": "This is only set using the new time comparison controls that is made available in some plugins behind the experimental feature flag.", + "nullable": true, + "type": "string" + }, + "relative_end": { + "description": "End time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`", + "enum": ["today", "now"], + "type": "string" + }, + "relative_start": { + "description": "Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`", + "enum": ["today", "now"], + "type": "string" + }, + "time_grain_sqla": { + "description": "To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.", + "enum": [ + "PT1S", + "PT5S", + "PT30S", + "PT1M", + "PT5M", + "PT10M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "P1D", + "P1W", + "P1M", + "P3M", + "P1Y", + "1969-12-28T00:00:00Z/P1W", + "1969-12-29T00:00:00Z/P1W", + "P1W/1970-01-03T00:00:00Z", + "P1W/1970-01-04T00:00:00Z", + null + ], + "example": "P1D", + "nullable": true, + "type": "string" + }, + "transpile_to_dialect": { + "description": "If true, WHERE/HAVING clauses will be transpiled to the target database dialect using SQLGlot.", + "nullable": true, + "type": "boolean" + }, + "where": { + "description": "WHERE clause to be added to queries using AND operator.", + "type": "string" + } + }, + "type": "object", + "title": "ChartDataExtras" + } + ], + "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", + "NOT ILIKE", + "IS NULL", + "IS NOT NULL", + "IN", + "NOT IN", + "IS TRUE", + "IS FALSE", + "TEMPORAL_RANGE" + ], + "example": "IN", + "type": "string" + }, + "val": { + "description": "The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.", + "example": ["China", "France", "Japan"], + "nullable": true + } + }, + "required": ["col", "op"], + "type": "object", + "title": "ChartDataFilter" + }, + "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" + }, + "group_others_when_limit_reached": { + "default": false, + "description": "When true, groups remaining series into an 'Others' category when series limit is reached. Prevents incomplete data.", + "nullable": true, + "type": "boolean" + }, + "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", + null + ], + "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 index c880cf215e2..a4f7220a32d 100644 --- 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 @@ -1 +1,220 @@ -{"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"},"detected_currency":{"default":null,"description":"Detected ISO 4217 currency code when AUTO mode is used. Returns the currency code if all filtered data contains a single currency or null if multiple currencies are present.","nullable":true,"type":"string"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"queried_dttm":{"description":"UTC timestamp when the query was executed (ISO 8601 format)","nullable":true,"type":"string"},"query":{"description":"The executed query statement. May be absent when validation errors occur.","nullable":true,"type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","queried_dttm"],"type":"object","title":"ChartDataResponseResult"},"type":"array"}},"type":"object","title":"ChartDataResponseSchema"},"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"}}} +{ + "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" + }, + "detected_currency": { + "default": null, + "description": "Detected ISO 4217 currency code when AUTO mode is used. Returns the currency code if all filtered data contains a single currency or null if multiple currencies are present.", + "nullable": true, + "type": "string" + }, + "error": { + "description": "Error", + "nullable": true, + "type": "string" + }, + "from_dttm": { + "description": "Start timestamp of time range", + "nullable": true, + "type": "integer" + }, + "is_cached": { + "description": "Is the result cached", + "type": "boolean" + }, + "queried_dttm": { + "description": "UTC timestamp when the query was executed (ISO 8601 format)", + "nullable": true, + "type": "string" + }, + "query": { + "description": "The executed query statement. May be absent when validation errors occur.", + "nullable": true, + "type": "string" + }, + "rejected_filters": { + "description": "A list with rejected filters", + "items": { "type": "object" }, + "type": "array" + }, + "rowcount": { + "description": "Amount of rows in result set", + "type": "integer" + }, + "stacktrace": { + "description": "Stacktrace if there was an error", + "nullable": true, + "type": "string" + }, + "status": { + "description": "Status of the query", + "enum": [ + "stopped", + "failed", + "pending", + "running", + "scheduled", + "success", + "timed_out" + ], + "type": "string" + }, + "to_dttm": { + "description": "End timestamp of time range", + "nullable": true, + "type": "integer" + } + }, + "required": [ + "cache_key", + "cache_timeout", + "cached_dttm", + "is_cached", + "queried_dttm" + ], + "type": "object", + "title": "ChartDataResponseResult" + }, + "type": "array" + } + }, + "type": "object", + "title": "ChartDataResponseSchema" + }, + "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 index 1ad88a57108..b042de96b9c 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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: eJzlXI1z27aS/1dwuJupPSdLdvrxWr2Xm3ETp3GfY7u23PTO9sgQCYlISIABQMs6j/73m10AJChRtty+e72Zm8nEIoiPxWKx+9vFgo805SbRorRCSTqkI/aZG8LIl4rrBUmUtPzBwl9jdZVYnhIhic04SXLBpSVMpkRzW2lpSMkWuWIpSZllRHNTKmk4mSqNDWbinkvXb5/2qOZfKm7sjypd0OEjxZGkhZ+sLHORMCBo8MkAVY/UJBkvGPwqtSq5toIbbFYZq4pxwpKMj60ouKqwj/akzu651iLlSEfKp6zKLcE2JLTpUVnlOZvknA6trniP2kXJ6ZAKafmMa7rsUZiXUZVO+DohIl0f9m1dn4iUKE2qSqTQkev6iepYoUe5rAo6vKYW6fIEcCAW2Uh71LB7no7D073gc3pbk26sFnJGl0vHbaF5Cr2JNKqjJp94Aj1aYWHu9E3GtAVSGnKA5Kny027TfJmpKk+Rr0CE4IZMcMkTnhKrCMrDVKsCq7ju+uStW4IhuZuy3PC7zdyfKJVzJj0FxRg4AFS0qy8dQ8JSWF6Y9RViUiqLUjXO2YJrsz6bw7oKcVVgCiCOC/iRAGdo7/n+R53LC6VETQlbGSRa53dnFx+uTg5pjx6fjo4ufj08oT169OvR6Yj26Oj4w9H48uji+OiyY417NFG50uvDnsAYxL3cyOaml6jxG5VXhexgk38BPKkMJ8z4fVXX6ZPjKZFKcsI0J6VW9yLlaY+wPCdzkecgIyZTc9mP2blGiy9gWrMFPGci5SdCbhbDXEgOfWciTbnskzOZL3D9QC5BGuF9w3+zldyBAtD3LD+SqZv4JoagtmRCCjkjXKaw1qHtOinhjRe0bZZGsqJj6qesQLEKsrTWTJUsEXbRoRXdi7hxEERaNztR8+bhA09FVTTP78Usoz0g/HYL+pXXwm63pKkAOlh+3tpFaxu7TfM8E0lGmo0HYgQrP+HEd+9V5QZqvLpb9ijI35P6DHlSSyrtEg14c8ImPH+mownPCcvnbGHi/p4XPaj5genPncrKj1C4982Welbq+91zQd38tOry1gkseqTFUCe3ZAdGpD16ejg6/vUIRsNpdiktYxd5x4Cwywm+W58OWOw942xNey8HClJmMp6CvVTW4g+jcgF/cyVnb93bLmqg62f2+FzYjPB7gD4psxyser2VjWXaFW+zndHgbjOas8xb9HjP8qqDme+UhiUrqpzFDOsRmwkTlJbT4b5an0AbZTOuEYqEusLVKrUomF6QzxyVR2PZidtefSBmLlKbrRPzEYpXzaATl0JIUcAK7tdzk1UxAey1gmBQE/ot3N4lgQlPAJzGyKNpRM3azdna8DjpSxFgjvmD1awLPJCClSUof+AJL0qlWU5cbWIzZknG7sE8cenFGRFSgE6A3/gDK0q3H8ZuMM3kDEg5IAvONGEzRYZEqvkTVDcqDpHLeMptko2RLWZcap4Ctu4Qk8M0JViXuLqkrkt25hnXAPlZZfguUO3cAzEFNC2k8woieLyNckuegxdO11tFDM95YoPjUXsQAThssYBt5M7y/GxKh9f/vzD8molegsAFWd7EE7dKY6VT3gEuz6CYA/AyFsTe1SawPw2aCc0N+FrYXMhZn1wZJ/al5obrew4IUn9lQkvNQ1WyI2SSVyn8LMQDT0kqCi4NKAwvOuh8FtxqkZjdJ5Hkc/KRsXuouTa/94e/Hp/+5AUfyJ5wwtLUTYHNZprPYH8E16cyQO3h6VsCLGRW6X4XIhPSWCat2+GJKkqmhVEybPY16+tVrwJDaLj1w8BekHyO9pA0vaBC1yr3OkcYUrCUE3bPBLIAtpFRBSdlXs1A7094JqRDKvyh5Bq4bFlOppzZSnMyzdmsv4350TxnVtzzMZcdG+kIxgBSnVi4qq4k5bllJnYLEyWnYnZ9Q98evTu8OhmNL45OEEyML0eHF6Mx+EI39PYu3l8qZbB/QDl22faaOrTSHXAKjfefSSGKw0wzIcfmS846BEGROaxpzu95DtttppmscqYBxZsGcNbGx28qENogq2mfXFZlqbQ15Pr48ox8/93+we1OZm1phoMBl/25+CxKngrWV3o2gKfB8eXZGOr969tKO/CwS9Lwsx9N8Xx0cEl79Hz0rfvz9b77e/DBlbo/B/v+r3/+Ojy/xz/f4Z+Dt/j/R/wf33+N/x/8J+3Rgx+++2Hv4NXeq+9H+/tD/PdfA1e5fvXD2qvzg4+Dgx/+sr+3f7C3/3XzevXVN/Er793UptlT9jy800yaUuR8bNU4FQxM2PqSHk8Jticf3x9dHA1a+sbUvnLdV40YLNMzjliTTZjhxA/gVcPlLyc/5co+sWsjO4y2vQOoAUEbNN+L9N1yCzt15OwQ2KgVrQEvSMk0K7gNAZm0DZzWpwnRIpFb7zZtiNckqsNtG0Fk0+0aq4jrhEwWffKG4T7iAkExI252ZKfMFkYkLAdogIYclKjmBuzULkFHyaNissPSTCW++90Y7tFEVdJqNEWoALqcdectO32ElVxkNez1MOGWqLqNt26ADPK1QxylQ3wGoB06BI4DGTMeuKIITBaEhVdgeZTEULAhqiyVN/ATDvzBtbPBS1BazARMol63dXFU5aZVqS1cLGxB87x+TXv0X+C//6A9+jf4Cw9/g/9Ojv8OXujp2Yj4n8dRUfh9fElOr05O/K+zUf10Giqeunejiytf/93hySX8HB19OD+7ODwZXxye/nREW+oCW3W5at3TROwNcuNBOMQdceagw8FPs7UsBiHsER+j7pGUJ6JgeY+cQvBNaQRmUFxyiUhKOQzd4mAg9Zq+yYQEV/6dZhJR/M+sZJKuI8cVNApbCVduG0z6DuVmG1QWmbfNca9VY1eB/OHOQFOOgyHy3EZpRyNGNrjUHDZFGpr9IUKw6PKXk8hdMn2CGG8qeJ4CYmuG7GGE9S6i646AEHCWboXJZlpV5Rg9eTOeZ1yOc1EIO9YcTj88TENMQ4cYi1+d3ceMS2+isC9DNC98kNMHYYQEpSzJV2c4zFcEKJ8pvSAwYKiF48Lk/NB9cq4xjgIdgIjn3HJkynZmC6mZdAhGcB8ni8aDxMqRxXiO397BaPH6Be5m7E48LTx/3MHYOBX0jprwaMmM18x3zuu720qAhBlrNUf79GSQM1QKqp4ltgqKHoZ3Z4QYjNsi5G7QNzL1kc6KlXJhqDvsfOw0zR1hpGmznQh517EjFFIzvjHmpk8+uPokcfrXcxRMo7IZ0XzKNZeJU9rN7g4eKtlxXDW7PcQF6R6gAf/SSSpo+RBQQW8P4n9x2CME2Mgl5+SuVqmHACwcdZd4UHpXn7q6Y1vw4yDm1hrzhUKNjvkYGLXOsAt+z7Xhzs//ned72LZrQx89lDyxcCgdwgzwF+JDEJRyKEUbS3jOwXUNUcooFhGFkpS2ZLLo4eZA/vBEyTRuy4gnqm0cr2mxGCcqHx/QHs7qtlcXvaI9mNXt7YsYWipjx6VWCQhYV/ThXBlLmgp+z4MsBk3RDiP6YIvhtk/OmrqIHTbVxHAAHMVLKxDFwgLGsZRNgaGamBfQvRoTqxUc7dGJeihzBYjB4x38Ja0Wkwr77dEEz55SMZ1CHyZhJR8bDs6BxcPNac6s5VBzxlXKrUjGJdOGu4KMmWyc8kSlcQGXviATxqqZZjBEKe6REphxhrE6zeRnTFrwoWfNjROMHtUqz2H5etTFKfG4AQ+KK7lGZAsaxtPvOLZzxxobPAFDTMkTMV0AgzM1x5ga1xDAjxAensWe5xxcRNRPkQDApoIAR7lxtRwJxOVeGHco4KnvRdoHlvu8bl8LnqfzzhOKpzc4ssONvndTaypkekR3Ox5e88oJ5YyPC9AbdYQS2ckRhTrDSIe08JoFan85eLpuyXUCeyB35TXvv9Dhfv/Vt8tlDDmua4cNBElCaPR2zc1dBcnNhtkGJW9gancY9zlN47b7OISsw/YLEfgenVZ5HkWkXX2DsWlYAENddArdTniIVZc7adMiz8cpt0zkG06EgQ41d/hzXao/sAc4/AEcQRyQ2Nl/nQoD7dPdzsjbxdnH8cnxh+ORj7PF50fPJ/MALWo6hVD8um+Bx05gabSao7I1n0UZE7H/8gEdMhk/e+zhsyoQOyOzIqiNnOmTwzyvY+BFZSyiEQioy/qUpIGwXm0v+uTCSaMhd54W7P4ObWGraOwQwp03M2BQXoYV4s42r7Ws2exR2xqFW9O2NfvjPjoow3LnuuHJOfgsDaxscpw6uNlB65NEhoivE8J2pOrFBxjxYeH6wSR6oJrNeC8EsDyudfCVYXoQ4AA0UzwN0a07I2TCyZBUoBnvALZmVcHgmIZhogWZas7B5vTJrywX6O8WzDql7lp7tvgemOZDciP3SAg9w+/fSMoWZgAnnGaQqUqbQcoW+DyYc/7ZbFUJDke3q4j5aFLNb+SNPKzzUPJFz5+B57mao6fuJxcAP4jFEBrtkRNmIPq6qH9Dz/VDoaTN6qcvFdOW6/oZKIGH0xBgrN/85uGoGRRCVpZH9BtH+wC79rPDTiA988XtWlHCmv7tshYKPjaZmHbs60MnHXu1dEAqxACFz3WwjkWuAaBBNajVHEPMhM2qST9RxWAC64YwLlTbJalKKjylQnwCsuYsD5yRQeBMpD58tpWL2+zv7Y1TiOu09cKzcYW2cgjBhRWz8rwuW6X4H6LPXkB6rYM3hqKWPVrpfIyB+yfzvTZGQKeR11vH/7uA8oY4+UpLEwVAGIEMoYliGk/0j8Dx0JwQPHrfIq8iOjF5OrrzO89Q/jcjOtucxvwCrDurp7sBTTpV38KT5p72KKZs9+hDbh4QFf+Tweft9lN847LbXciELlv+Rndi+cFqKgmmjDQDuiSPJl3aLUGcuRynKl8/AppfZecay5bofKyq2vUEfQyKQJQnDj6hravDHy6/B/PzQZb8IUHB5KIVXzIhQd/5LgG9+4x+3Lev9vf/QNq+m2CXBQkhHi8FqGghYEwSpR0BeI7h849k7VJy08Kom3O/Qwb5ysB5HrrBfbaa3NiEQzbosU3Jy43W2DbJLDq57GQO5gSGeE5z6reKHdXG/etk+jPvCLVdSfGl4v5qBKT3AftjydjGnj5zGeNNfO+C4DFmAFwYfRoSt/dClV4sznWZIzHc5WiK0TnsvuOxnZ+ATdJxam3xFO3GsqLcihsqx3Sop4Q9Tpt6UUZ8onLMz3yq8xmXHEAA7nqsDaV+T2E4ZH3EGGt0pNI9LZuNAt9eJlNuOdwuGieVhiD6onUyBUxe1YBvfQv0JL55dfAXEpoSiOg5//nwanRGCngUBlEQuG3ushKGiFstxBQvKLgtxf01pjo9lhEw1HnUSGkChEG7osqtKJuXmJusa6d8KxjKte66v3GExVu0B02/QWyb3CYUWwRXziWUsyeSNSMpEMaZwo7ErmMTh5R9ra4Av7N7m7bW1ehNRCGuXgMA58wQ/sCTChZ8J/iO3tvc3YY7Dl10As66YzeWscziYUCffGB4dsUmGFlBmtC7cKYBF8wQlSSV3jJB7pMT8q1UfKj9u3T85jO7wyIc02FsS8joMIB2Bk4sSz5bzTqvf9XvfMKI5rhWzHNnG64Av6uu+w1Y3nIEoqMDY1VZoqBNGSRGAS50OQ4AXSopfUgepLFy702VAGT0cDIdg3XqzMNTG0Q0pDD+vk20mjNRW+FVi9m2QfHeW9lD28SRLzxou3CIa01UtgHLoY9OoByg3PVtB0xFmO0FDNq92n/1B1BjkjEpeT7uytP2yMW4w1rCzEImxDcgx2+7HMdPavJUV66LT2qyobkH6ZXuyOTxXfiddXVxgkAK0TdmRWHXTt14gPnSbeG8ZLyJE+js6gWyqzsneeHALlADddwc/wG+4yFQ86TAxKsYum4WoymJ+duUBrY0JfUUGzrX3aV6LX2gCGj65g+5MAU3hrlw63Nsas+/bkh/ZGlwOobkWLrAVRyx8Bcnu2YUtXVzOfhz53IlWWUzpcV/83RIDiubwWmaG78+8+uaSNwQev/2z16VY7jOBREkvJ+gnSEbkkNJKskxFQGSPKHQmf4N83rHIIneWcElnj8klctku36kn+ZOY4IGZzPjcu+YtgZ0+sMewNFLH/yA6jmD9ACaXF1AQmLubhyGxxCMoEmlc7L3Gzk/uxyRGwqx1OFgkKuE5Zkydvj9/vffD1gpBvcHA7zLPADdc0PJzc2NJGTvPbmhh34tkNtD8iNnmmvyb4dv3hxdXo5HZ38/Om03eOPWaQ+uCA7J6lI1dVPy1eMN/cwXN3RIbtwtrRu6/Ioue/X8zhc2w9hRmGFdUM9RQI6dDZJvIBhff2jgdV3chxDRDoxLXsKInmuRcZZybV4/rrDDUe5ZckPJvxOGgGJs1Wcul741TPt111Rv5O6NLLWQdieQ3IfKO7u7MRN+ZvfsEuUoYkSrsFlw+CoDiebP5kxYZ2Zw9i+d+6ObQsFtplKgHURplS/DUI2sygvM9y6IzKNjzgh5c9drmsQS4zi0LjWudmDpRKWLIfn58uy073azmC52HiE+EfGXLHehNrD5rzfSsQY9uMCWFab7Sirn/VzNdqDq7l/xeN1NH3IClMEsEAYXGek61zDlA3SE26XOUnVynK5qhxN4TVK4yKFKzDxyPaEkuI4eS62sSlS+HA4Gj9DVcvgI0r9c6+2NC5j4LiC7WAuw4yESht20PGokM4LT/hHPX+haFv770eic1P1AgiNwptVfPd814i6dGoV3mIulNDk+d/lPeqWTTlb59lh7uYQFCqoU4YWbJCrURzpB4XvnQ6n0548j7wMU6Ivi2wYm4aQBCM4hIXaqucl+bydLF/e+aD5qcvRcLHl/NZb8ZAw5Chp3fcniev37E9HXJPynIRrM1PWVh+vw+jb+0oIbveMbCE1n7rsEzXP9wQH8jEB06b++de86jW7PNwX1dXdfFN1Kp7S+L95c8Y6vbDcktO5WN8X+TvI+CNGGO71b3Lt9+lqto7vO8rj2uTBPL3Uzfvu+ZWtNfFJxM51n7hHGUDq+mVdfRFu9Ele/WLuJ5i89dd9pcjP2h2JxQCpEOa79ZZs4a8rdcgk3VOoLKa4vuAPiLk7gPYnNFxNgIVu3BJo5P5v57tPdm6Quv1KtjGcv/u18ZFdYZw+HhnGCrJ9HSGndNnt0LSX0upVo2coYjJLU/u8nx+FBV5P9td/Ov9pfz44KTG0fzO+v5szEG6S1ceOkhjhnIdYRq8f++yuH1svlLd7WnaoON7wqIeM59oGjIsAErt79QUj1LdyKeG3pwtDbfzKL7CDu2EOcsmojI3fpn/cBr6DD+IMdlDlsZ3foj5gDIdM1ZaUAbhyADfJfT0LgdBsgxDV9fIQLjFc6Xy6h2Mdpr28bFIOeUo86+IlbAs+uWkCy/vDDcN1dBEjlWhwmCUcIvblujP8A/WJmsvtEGZwj0CHVbI4JwXNv4JrtgGUOyFfOl3R9wvYAJzfS/DWK8D9gViEwJxcRhY+ProbD0QD93FTQ56BLCLr9D3mPNLU= -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Return payload data response for the given query (chart-data)'} +> - - 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 index 1eb5d89976c..09741e542f9 100644 --- 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 @@ -1,19 +1,19 @@ --- id: row-level-security -title: "Row Level Security" -description: "Row Level Security" +title: 'Row Level Security' +description: 'Row Level Security' custom_edit_url: null --- Manage row-level security rules for data access. -| 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}` | +| 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 index 8dc1c265b8a..9b0248359a3 100644 --- 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 @@ -1 +1,16 @@ -{"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"} +{ + "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 index 5569717e5b8..0c7ae4ac9a3 100644 --- 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 @@ -1,28 +1,23 @@ --- id: advanced-data-type-convert-schema -title: "advanced_data_type_convert_schema" -description: "" -sidebar_label: "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]} +sample: { 'type': 'port', 'values': [null] } custom_edit_url: null --- -import Schema from "@theme/Schema"; -import Heading from "@theme/Heading"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'advanced_data_type_convert_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AdvancedDataTypeSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationLayer'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationLayerRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationLayerRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationLayerRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationLayerRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationLayerRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationLayerRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationRestApi.get.AnnotationLayer'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AnnotationRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'AvailableDomainsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CacheInvalidationRequestSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CacheRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CacheRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CacheRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CacheRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CatalogsResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartCacheScreenshotResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartCacheWarmUpRequestSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartCacheWarmUpResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartCacheWarmUpResponseSingle'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataAdhocMetricSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataAggregateOptionsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataAsyncResponseSchema'} +> = 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"} +{ + "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 index 68b843d2c3f..a31753ac6b4 100644 --- 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 @@ -1,28 +1,29 @@ --- id: chartdataboxplotoptionsschema -title: "ChartDataBoxplotOptionsSchema" -description: "" -sidebar_label: "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"} +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"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataBoxplotOptionsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataColumn'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataContributionOptionsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataDatasource'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataExtras'} +> ","<",">=","<=","LIKE","NOT LIKE","ILIKE","NOT ILIKE","IS NULL","IS NOT NULL","IN","NOT IN","IS TRUE","IS FALSE","TEMPORAL_RANGE"],"example":"IN","type":"string"},"val":{"description":"The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.","example":["China","France","Japan"],"nullable":true}},"required":["col","op"],"type":"object","title":"ChartDataFilter"},"schemaType":"response"} +{ + "schema": { + "properties": { + "col": { + "description": "The column to filter by. Can be either a string (physical or saved expression) or an object (adhoc column)", + "example": "country" + }, + "grain": { + "description": "Optional time grain for temporal filters", + "example": "PT1M", + "type": "string" + }, + "isExtra": { + "description": "Indicates if the filter has been added by a filter component as opposed to being a part of the original query.", + "type": "boolean" + }, + "op": { + "description": "The comparison operator.", + "enum": [ + "==", + "!=", + ">", + "<", + ">=", + "<=", + "LIKE", + "NOT LIKE", + "ILIKE", + "NOT ILIKE", + "IS NULL", + "IS NOT NULL", + "IN", + "NOT IN", + "IS TRUE", + "IS FALSE", + "TEMPORAL_RANGE" + ], + "example": "IN", + "type": "string" + }, + "val": { + "description": "The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.", + "example": ["China", "France", "Japan"], + "nullable": true + } + }, + "required": ["col", "op"], + "type": "object", + "title": "ChartDataFilter" + }, + "schemaType": "response" +} 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 index 757fd446807..ca74d468f40 100644 --- 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 @@ -1,28 +1,30 @@ --- id: chartdatafilter -title: "ChartDataFilter" -description: "" -sidebar_label: "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"]} +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"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataFilter'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataGeodeticParseOptionsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataGeohashDecodeOptionsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataGeohashEncodeOptionsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataPivotOptionsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataPostProcessingOperation'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataProphetOptionsSchema'} +> ","<",">=","<=","LIKE","NOT LIKE","ILIKE","NOT ILIKE","IS NULL","IS NOT NULL","IN","NOT IN","IS TRUE","IS FALSE","TEMPORAL_RANGE"],"example":"IN","type":"string"},"val":{"description":"The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.","example":["China","France","Japan"],"nullable":true}},"required":["col","op"],"type":"object","title":"ChartDataFilter"},"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"},"group_others_when_limit_reached":{"default":false,"description":"When true, groups remaining series into an 'Others' category when series limit is reached. Prevents incomplete data.","nullable":true,"type":"boolean"},"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",null],"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"} +{ + "schema": { + "properties": { + "custom_cache_timeout": { + "description": "Override the default cache timeout", + "nullable": true, + "type": "integer" + }, + "datasource": { + "properties": { + "id": { "description": "Datasource id or uuid" }, + "type": { + "description": "Datasource type", + "enum": ["table", "dataset", "query", "saved_query", "view"], + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "ChartDataDatasource" + }, + "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", + null + ], + "nullable": true, + "type": "string" + }, + "overrides": { + "additionalProperties": { "nullable": true }, + "description": "which properties should be overridable", + "nullable": true, + "type": "object" + }, + "show": { + "description": "Should the layer be shown", + "type": "boolean" + }, + "showLabel": { + "description": "Should the label always be shown", + "nullable": true, + "type": "boolean" + }, + "showMarkers": { + "description": "Should markers be shown. Only applies to line annotations.", + "type": "boolean" + }, + "sourceType": { + "description": "Type of source for annotation data", + "enum": ["", "line", "NATIVE", "table"], + "type": "string" + }, + "style": { + "description": "Line style. Only applies to time-series annotations", + "enum": ["dashed", "dotted", "solid", "longDashed"], + "type": "string" + }, + "timeColumn": { + "description": "Column with event date or interval start date", + "nullable": true, + "type": "string" + }, + "titleColumn": { + "description": "Column with title", + "nullable": true, + "type": "string" + }, + "value": { + "description": "For formula annotations, this contains the formula. For other types, this is the primary key of the source object." + }, + "width": { + "description": "Width of annotation line", + "minimum": 0, + "type": "number" + } + }, + "required": ["name", "show", "showMarkers", "value"], + "type": "object", + "title": "AnnotationLayer" + }, + "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 or uuid" }, + "type": { + "description": "Datasource type", + "enum": [ + "table", + "dataset", + "query", + "saved_query", + "view" + ], + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "ChartDataDatasource" + } + ], + "nullable": true + }, + "extras": { + "allOf": [ + { + "properties": { + "column_order": { + "description": "Ordered list of column names for result ordering. Used to preserve user's column reordering (including mixed dimension columns and metrics)", + "items": { "type": "string" }, + "nullable": true, + "type": "array" + }, + "having": { + "description": "HAVING clause to be added to aggregate queries using AND operator.", + "type": "string" + }, + "instant_time_comparison_range": { + "description": "This is only set using the new time comparison controls that is made available in some plugins behind the experimental feature flag.", + "nullable": true, + "type": "string" + }, + "relative_end": { + "description": "End time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`", + "enum": ["today", "now"], + "type": "string" + }, + "relative_start": { + "description": "Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`", + "enum": ["today", "now"], + "type": "string" + }, + "time_grain_sqla": { + "description": "To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.", + "enum": [ + "PT1S", + "PT5S", + "PT30S", + "PT1M", + "PT5M", + "PT10M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "P1D", + "P1W", + "P1M", + "P3M", + "P1Y", + "1969-12-28T00:00:00Z/P1W", + "1969-12-29T00:00:00Z/P1W", + "P1W/1970-01-03T00:00:00Z", + "P1W/1970-01-04T00:00:00Z", + null + ], + "example": "P1D", + "nullable": true, + "type": "string" + }, + "transpile_to_dialect": { + "description": "If true, WHERE/HAVING clauses will be transpiled to the target database dialect using SQLGlot.", + "nullable": true, + "type": "boolean" + }, + "where": { + "description": "WHERE clause to be added to queries using AND operator.", + "type": "string" + } + }, + "type": "object", + "title": "ChartDataExtras" + } + ], + "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", + "NOT ILIKE", + "IS NULL", + "IS NOT NULL", + "IN", + "NOT IN", + "IS TRUE", + "IS FALSE", + "TEMPORAL_RANGE" + ], + "example": "IN", + "type": "string" + }, + "val": { + "description": "The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.", + "example": ["China", "France", "Japan"], + "nullable": true + } + }, + "required": ["col", "op"], + "type": "object", + "title": "ChartDataFilter" + }, + "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" + }, + "group_others_when_limit_reached": { + "default": false, + "description": "When true, groups remaining series into an 'Others' category when series limit is reached. Prevents incomplete data.", + "nullable": true, + "type": "boolean" + }, + "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", + null + ], + "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 index ff98d6e0ed9..390bc83d413 100644 --- 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 @@ -1,28 +1,116 @@ --- id: chartdataquerycontextschema -title: "ChartDataQueryContextSchema" -description: "" -sidebar_label: "ChartDataQueryContextSchema" +title: 'ChartDataQueryContextSchema' +description: '' +sidebar_label: 'ChartDataQueryContextSchema' hide_title: true hide_table_of_contents: true schema: true -sample: {"custom_cache_timeout":0,"datasource":{"type":"table"},"force":true,"queries":[{"annotation_layers":[{"annotationType":"FORMULA","color":"string","descriptionColumns":["string"],"hideLine":true,"intervalEndColumn":"string","name":"string","opacity":"","overrides":{},"show":true,"showLabel":true,"showMarkers":true,"sourceType":"","style":"dashed","timeColumn":"string","titleColumn":"string","width":0}],"applied_time_extras":{"__time_range":"1 year ago : now"},"apply_fetch_values_predicate":true,"columns":[null],"datasource":{"type":"table"},"extras":{"column_order":["string"],"having":"string","instant_time_comparison_range":"string","relative_end":"today","relative_start":"today","time_grain_sqla":"P1D","transpile_to_dialect":true,"where":"string"},"filters":[{"col":"country","grain":"PT1M","isExtra":true,"op":"IN","val":["China","France","Japan"]}],"granularity":"string","group_others_when_limit_reached":false,"groupby":[null],"is_rowcount":true,"is_timeseries":true,"metrics":[null],"order_desc":true,"orderby":[["my_col_1",false],["my_col_2",true]],"post_processing":[{"operation":"aggregate","options":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]}}],"row_limit":0,"row_offset":0,"series_columns":[null],"series_limit":0,"time_offsets":["string"],"time_range":"Last week","time_shift":"string","timeseries_limit":0,"url_params":{}}]} +sample: + { + 'custom_cache_timeout': 0, + 'datasource': { 'type': 'table' }, + 'force': true, + 'queries': + [ + { + 'annotation_layers': + [ + { + 'annotationType': 'FORMULA', + 'color': 'string', + 'descriptionColumns': ['string'], + 'hideLine': true, + 'intervalEndColumn': 'string', + 'name': 'string', + 'opacity': '', + 'overrides': {}, + 'show': true, + 'showLabel': true, + 'showMarkers': true, + 'sourceType': '', + 'style': 'dashed', + 'timeColumn': 'string', + 'titleColumn': 'string', + 'width': 0, + }, + ], + 'applied_time_extras': { '__time_range': '1 year ago : now' }, + 'apply_fetch_values_predicate': true, + 'columns': [null], + 'datasource': { 'type': 'table' }, + 'extras': + { + 'column_order': ['string'], + 'having': 'string', + 'instant_time_comparison_range': 'string', + 'relative_end': 'today', + 'relative_start': 'today', + 'time_grain_sqla': 'P1D', + 'transpile_to_dialect': true, + 'where': 'string', + }, + 'filters': + [ + { + 'col': 'country', + 'grain': 'PT1M', + 'isExtra': true, + 'op': 'IN', + 'val': ['China', 'France', 'Japan'], + }, + ], + 'granularity': 'string', + 'group_others_when_limit_reached': false, + 'groupby': [null], + 'is_rowcount': true, + 'is_timeseries': true, + 'metrics': [null], + 'order_desc': true, + 'orderby': [['my_col_1', false], ['my_col_2', true]], + 'post_processing': + [ + { + 'operation': 'aggregate', + 'options': + { + 'aggregates': + { + 'age_mean': { 'column': 'age', 'operator': 'mean' }, + 'age_q1': + { + 'column': 'age', + 'operator': 'percentile', + 'options': { 'q': 0.25 }, + }, + }, + 'groupby': ['country', 'gender'], + }, + }, + ], + 'row_limit': 0, + 'row_offset': 0, + 'series_columns': [null], + 'series_limit': 0, + 'time_offsets': ['string'], + 'time_range': 'Last week', + 'time_shift': 'string', + 'timeseries_limit': 0, + 'url_params': {}, + }, + ], + } custom_edit_url: null --- -import Schema from "@theme/Schema"; -import Heading from "@theme/Heading"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataQueryContextSchema'} +> ","<",">=","<=","LIKE","NOT LIKE","ILIKE","NOT ILIKE","IS NULL","IS NOT NULL","IN","NOT IN","IS TRUE","IS FALSE","TEMPORAL_RANGE"],"example":"IN","type":"string"},"val":{"description":"The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.","example":["China","France","Japan"],"nullable":true}},"required":["col","op"],"type":"object","title":"ChartDataFilter"},"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"},"group_others_when_limit_reached":{"default":false,"description":"When true, groups remaining series into an 'Others' category when series limit is reached. Prevents incomplete data.","nullable":true,"type":"boolean"},"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",null],"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"} +{ + "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", null], + "nullable": true, + "type": "string" + }, + "overrides": { + "additionalProperties": { "nullable": true }, + "description": "which properties should be overridable", + "nullable": true, + "type": "object" + }, + "show": { + "description": "Should the layer be shown", + "type": "boolean" + }, + "showLabel": { + "description": "Should the label always be shown", + "nullable": true, + "type": "boolean" + }, + "showMarkers": { + "description": "Should markers be shown. Only applies to line annotations.", + "type": "boolean" + }, + "sourceType": { + "description": "Type of source for annotation data", + "enum": ["", "line", "NATIVE", "table"], + "type": "string" + }, + "style": { + "description": "Line style. Only applies to time-series annotations", + "enum": ["dashed", "dotted", "solid", "longDashed"], + "type": "string" + }, + "timeColumn": { + "description": "Column with event date or interval start date", + "nullable": true, + "type": "string" + }, + "titleColumn": { + "description": "Column with title", + "nullable": true, + "type": "string" + }, + "value": { + "description": "For formula annotations, this contains the formula. For other types, this is the primary key of the source object." + }, + "width": { + "description": "Width of annotation line", + "minimum": 0, + "type": "number" + } + }, + "required": ["name", "show", "showMarkers", "value"], + "type": "object", + "title": "AnnotationLayer" + }, + "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 or uuid" }, + "type": { + "description": "Datasource type", + "enum": ["table", "dataset", "query", "saved_query", "view"], + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "ChartDataDatasource" + } + ], + "nullable": true + }, + "extras": { + "allOf": [ + { + "properties": { + "column_order": { + "description": "Ordered list of column names for result ordering. Used to preserve user's column reordering (including mixed dimension columns and metrics)", + "items": { "type": "string" }, + "nullable": true, + "type": "array" + }, + "having": { + "description": "HAVING clause to be added to aggregate queries using AND operator.", + "type": "string" + }, + "instant_time_comparison_range": { + "description": "This is only set using the new time comparison controls that is made available in some plugins behind the experimental feature flag.", + "nullable": true, + "type": "string" + }, + "relative_end": { + "description": "End time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`", + "enum": ["today", "now"], + "type": "string" + }, + "relative_start": { + "description": "Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`", + "enum": ["today", "now"], + "type": "string" + }, + "time_grain_sqla": { + "description": "To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.", + "enum": [ + "PT1S", + "PT5S", + "PT30S", + "PT1M", + "PT5M", + "PT10M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "P1D", + "P1W", + "P1M", + "P3M", + "P1Y", + "1969-12-28T00:00:00Z/P1W", + "1969-12-29T00:00:00Z/P1W", + "P1W/1970-01-03T00:00:00Z", + "P1W/1970-01-04T00:00:00Z", + null + ], + "example": "P1D", + "nullable": true, + "type": "string" + }, + "transpile_to_dialect": { + "description": "If true, WHERE/HAVING clauses will be transpiled to the target database dialect using SQLGlot.", + "nullable": true, + "type": "boolean" + }, + "where": { + "description": "WHERE clause to be added to queries using AND operator.", + "type": "string" + } + }, + "type": "object", + "title": "ChartDataExtras" + } + ], + "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", + "NOT ILIKE", + "IS NULL", + "IS NOT NULL", + "IN", + "NOT IN", + "IS TRUE", + "IS FALSE", + "TEMPORAL_RANGE" + ], + "example": "IN", + "type": "string" + }, + "val": { + "description": "The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.", + "example": ["China", "France", "Japan"], + "nullable": true + } + }, + "required": ["col", "op"], + "type": "object", + "title": "ChartDataFilter" + }, + "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" + }, + "group_others_when_limit_reached": { + "default": false, + "description": "When true, groups remaining series into an 'Others' category when series limit is reached. Prevents incomplete data.", + "nullable": true, + "type": "boolean" + }, + "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", + null + ], + "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 index de4c8a0faa6..67b41424f55 100644 --- 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 @@ -1,28 +1,108 @@ --- id: chartdataqueryobject -title: "ChartDataQueryObject" -description: "" -sidebar_label: "ChartDataQueryObject" +title: 'ChartDataQueryObject' +description: '' +sidebar_label: 'ChartDataQueryObject' hide_title: true hide_table_of_contents: true schema: true -sample: {"annotation_layers":[{"annotationType":"FORMULA","color":"string","descriptionColumns":["string"],"hideLine":true,"intervalEndColumn":"string","name":"string","opacity":"","overrides":{},"show":true,"showLabel":true,"showMarkers":true,"sourceType":"","style":"dashed","timeColumn":"string","titleColumn":"string","width":0}],"applied_time_extras":{"__time_range":"1 year ago : now"},"apply_fetch_values_predicate":true,"columns":[null],"datasource":{"type":"table"},"extras":{"column_order":["string"],"having":"string","instant_time_comparison_range":"string","relative_end":"today","relative_start":"today","time_grain_sqla":"P1D","transpile_to_dialect":true,"where":"string"},"filters":[{"col":"country","grain":"PT1M","isExtra":true,"op":"IN","val":["China","France","Japan"]}],"granularity":"string","group_others_when_limit_reached":false,"groupby":[null],"is_rowcount":true,"is_timeseries":true,"metrics":[null],"order_desc":true,"orderby":[["my_col_1",false],["my_col_2",true]],"post_processing":[{"operation":"aggregate","options":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]}}],"row_limit":0,"row_offset":0,"series_columns":[null],"series_limit":0,"time_offsets":["string"],"time_range":"Last week","time_shift":"string","timeseries_limit":0,"url_params":{}} +sample: + { + 'annotation_layers': + [ + { + 'annotationType': 'FORMULA', + 'color': 'string', + 'descriptionColumns': ['string'], + 'hideLine': true, + 'intervalEndColumn': 'string', + 'name': 'string', + 'opacity': '', + 'overrides': {}, + 'show': true, + 'showLabel': true, + 'showMarkers': true, + 'sourceType': '', + 'style': 'dashed', + 'timeColumn': 'string', + 'titleColumn': 'string', + 'width': 0, + }, + ], + 'applied_time_extras': { '__time_range': '1 year ago : now' }, + 'apply_fetch_values_predicate': true, + 'columns': [null], + 'datasource': { 'type': 'table' }, + 'extras': + { + 'column_order': ['string'], + 'having': 'string', + 'instant_time_comparison_range': 'string', + 'relative_end': 'today', + 'relative_start': 'today', + 'time_grain_sqla': 'P1D', + 'transpile_to_dialect': true, + 'where': 'string', + }, + 'filters': + [ + { + 'col': 'country', + 'grain': 'PT1M', + 'isExtra': true, + 'op': 'IN', + 'val': ['China', 'France', 'Japan'], + }, + ], + 'granularity': 'string', + 'group_others_when_limit_reached': false, + 'groupby': [null], + 'is_rowcount': true, + 'is_timeseries': true, + 'metrics': [null], + 'order_desc': true, + 'orderby': [['my_col_1', false], ['my_col_2', true]], + 'post_processing': + [ + { + 'operation': 'aggregate', + 'options': + { + 'aggregates': + { + 'age_mean': { 'column': 'age', 'operator': 'mean' }, + 'age_q1': + { + 'column': 'age', + 'operator': 'percentile', + 'options': { 'q': 0.25 }, + }, + }, + 'groupby': ['country', 'gender'], + }, + }, + ], + 'row_limit': 0, + 'row_offset': 0, + 'series_columns': [null], + 'series_limit': 0, + 'time_offsets': ['string'], + 'time_range': 'Last week', + 'time_shift': 'string', + 'timeseries_limit': 0, + 'url_params': {}, + } custom_edit_url: null --- -import Schema from "@theme/Schema"; -import Heading from "@theme/Heading"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataQueryObject'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataResponseResult'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRestApi.get_list.Dashboard'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRestApi.get_list.SqlaTable'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRestApi.get_list.Tag'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRestApi.get_list.User2'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRestApi.get_list.User3'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataRollingOptionsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataSelectOptionsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartDataSortOptionsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartEntityResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartFavStarResponseResult'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartGetDatasourceObjectDataResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartGetDatasourceObjectResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartGetDatasourceResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartGetResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartRestApi.get_list.Dashboard'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartRestApi.get_list.SqlaTable'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartRestApi.get_list.Tag'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartRestApi.get_list.User2'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartRestApi.get_list.User3'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ChartRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CssTemplateRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CssTemplateRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CssTemplateRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CssTemplateRestApi.get.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CssTemplateRestApi.get.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CssTemplateRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CssTemplateRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CssTemplateRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'CurrentUserPutSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'Dashboard'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardCacheScreenshotResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardChartCustomizationsConfigUpdateSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardColorsConfigUpdateSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardCopySchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardDatasetSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardGetResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardNativeFiltersConfigUpdateSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardPermalinkStateSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardRestApi.get_list.Role'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardRestApi.get_list.Tag'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardRestApi.get_list.User2'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DashboardScreenshotPostSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'Database1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'database_catalogs_query_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'database_schemas_query_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'database_tables_query_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'Database'} +> 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"} +{ + "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 index 961d2778eb0..a28f85ca9c1 100644 --- 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 @@ -1,28 +1,64 @@ --- id: databaseconnectionschema -title: "DatabaseConnectionSchema" -description: "" -sidebar_label: "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"} +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"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseConnectionSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseFunctionNamesResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseRelatedChart'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseRelatedCharts'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseRelatedDashboard'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseRelatedDashboards'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseRelatedObjectsResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseRestApi.get'} +> 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"} +{ + "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 index c3b068ea92f..a51aa462594 100644 --- 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 @@ -1,28 +1,55 @@ --- id: databaserestapi-post -title: "DatabaseRestApi.post" -description: "" -sidebar_label: "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"} +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"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseRestApi.post'} +> 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"} +{ + "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 index 17d8d8b3d1a..755c172b45b 100644 --- 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 @@ -1,28 +1,55 @@ --- id: databaserestapi-put -title: "DatabaseRestApi.put" -description: "" -sidebar_label: "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"} +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"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseSchemaAccessForFileUploadResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseSSHTunnel'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseTablesResponse'} +> 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"} +{ + "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 index 207bf5bd665..65efbbefaba 100644 --- 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 @@ -1,28 +1,44 @@ --- id: databasetestconnectionschema -title: "DatabaseTestConnectionSchema" -description: "" -sidebar_label: "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"}} +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"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseTestConnectionSchema'} +> 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"} +{ + "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 index cd608545ece..0cb24975da4 100644 --- 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 @@ -1,28 +1,35 @@ --- id: databasevalidateparametersschema -title: "DatabaseValidateParametersSchema" -description: "" -sidebar_label: "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"} +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"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatabaseValidateParametersSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'Dataset'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetCacheWarmUpRequestSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetCacheWarmUpResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetCacheWarmUpResponseSingle'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetColumnsPut'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetColumnsRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetColumnsRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetColumnsRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetColumnsRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetDuplicateSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetMetricCurrencyPut'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetMetricRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetMetricRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetMetricRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetMetricRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetMetricsPut'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRelatedChart'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRelatedCharts'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRelatedDashboard'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRelatedDashboards'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRelatedObjectsResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.get.Database'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.get_list.Database'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.get.SqlMetric'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.get.TableColumn'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.get.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.get.User2'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.get.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DatasetRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'Datasource'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'delete_tags_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DistincResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'DistinctResultResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'EmbeddedDashboardConfig'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'EmbeddedDashboardResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'EmbeddedDashboardRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'EmbeddedDashboardRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'EmbeddedDashboardRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'EmbeddedDashboardRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'EngineInformation'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'EstimateQueryCostSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ExecutePayloadSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ExploreContextSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ExplorePermalinkStateSchema'} +> - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - - + as={'h1'} + className={'openapi__heading'} + children={'FormatQueryPayloadSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'FormDataPostSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'FormDataPutSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'get_delete_ids_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'get_export_ids_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'get_fav_star_ids_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'get_info_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'get_item_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'get_list_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'get_recent_activity_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'get_related_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'get_slack_channels_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GetFavStarIdsSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GetOrCreateDatasetSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GroupApi.get_list.Role'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GroupApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GroupApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GroupApi.get.Role'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GroupApi.get.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GroupApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GroupApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GroupApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GroupPostSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GroupPutSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'GuestTokenCreate'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ImportV1Database'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ImportV1DatabaseExtra'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'LogRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'LogRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'LogRestApi.get.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'LogRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'LogRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'LogRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionViewMenuApi.get_list.Permission'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionViewMenuApi.get_list.ViewMenu'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionViewMenuApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionViewMenuApi.get.Permission'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionViewMenuApi.get.ViewMenu'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionViewMenuApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionViewMenuApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'PermissionViewMenuApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'queries_get_updated_since_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'QueryExecutionResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'QueryRestApi.get.Database'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'QueryRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'QueryRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'QueryRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'QueryRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'QueryResult'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RecentActivity'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RecentActivityResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RecentActivitySchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RelatedResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RelatedResultResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportExecutionLogRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportExecutionLogRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportExecutionLogRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportExecutionLogRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportRecipient'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportRecipientConfigJSON'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.get.Dashboard'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.get.Database'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.get_list.ReportRecipients'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.get_list.User2'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.get.ReportRecipients'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.get.Slice'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.get.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.get'} +> ",">=","==","!="],"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"} +{ + "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", "Webhook"], + "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/Coyhaique", + "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 index 9fc222ba0f3..a4fe5fb569b 100644 --- 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 @@ -1,28 +1,56 @@ --- id: reportschedulerestapi-post -title: "ReportScheduleRestApi.post" -description: "" -sidebar_label: "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} +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"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.post'} +> ",">=","==","!="],"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",null],"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"} +{ + "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", null], + "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", "Webhook"], + "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/Coyhaique", + "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", null], + "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 index 04ecb1dc5ae..0b5ca6bac44 100644 --- 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 @@ -1,28 +1,55 @@ --- id: reportschedulerestapi-put -title: "ReportScheduleRestApi.put" -description: "" -sidebar_label: "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} +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"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ReportScheduleRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'Resource'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RLSRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RLSRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RLSRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RLSRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RlsRule'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RoleGroupPutSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RolePermissionListSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RolePermissionPostSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RoleResponseSchema'} +> - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RolesResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'RoleUserPutSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SavedQueryRestApi.get.Database'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SavedQueryRestApi.get_list.Database'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SavedQueryRestApi.get_list.Tag'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SavedQueryRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SavedQueryRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SavedQueryRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SavedQueryRestApi.get.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SavedQueryRestApi.get.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SavedQueryRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SavedQueryRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SavedQueryRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SchemasResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'screenshot_query_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SelectStarResponseSchema'} +> - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - - + as={'h1'} + className={'openapi__heading'} + children={'sql_lab_get_results_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SQLLabBootstrapSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SqlLabPermalinkSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'StopQuerySchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetRoleApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetRoleApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetRoleApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetRoleApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.get.Group'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.get_list.Group'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.get_list.Role'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.get.Role'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.get.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.get.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'SupersetUserApi.put'} +> - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TableExtraMetadataResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TableMetadataColumnsResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TableMetadataForeignKeysIndexesResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TableMetadataOptionsResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TableMetadataPrimaryKeyResponse'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TableMetadataResponseSchema'} +> - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TabsPayloadSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TabState'} +> - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TaggedObjectEntityResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagGetResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagObject'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagPostBulkResponseObject'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagPostBulkResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagPostBulkSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagRestApi.get.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagRestApi.get.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TagRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TemporaryCachePostSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'TemporaryCachePutSchema'} +> - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ThemeRestApi.get_list.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ThemeRestApi.get_list.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ThemeRestApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ThemeRestApi.get.User1'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ThemeRestApi.get.User'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ThemeRestApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ThemeRestApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ThemeRestApi.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'thumbnail_query_schema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'UploadFileMetadata'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'UploadFileMetadataItem'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'UploadFileMetadataPostSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'UploadPostSchema'} +> - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; + - - - - - + as={'h1'} + className={'openapi__heading'} + children={'UserRegistrationsRestAPI.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'UserRegistrationsRestAPI.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'UserRegistrationsRestAPI.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'UserRegistrationsRestAPI.put'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'UserResponseSchema'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ValidateSQLRequest'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ValidateSQLResponse'} +> ",">=","==","!="],"type":"string"},"threshold":{"type":"number"}},"type":"object","title":"ValidatorConfigJSON"},"schemaType":"response"} +{ + "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 index b2885d405be..9f7fa68fcdf 100644 --- 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 @@ -1,28 +1,23 @@ --- id: validatorconfigjson -title: "ValidatorConfigJSON" -description: "" -sidebar_label: "ValidatorConfigJSON" +title: 'ValidatorConfigJSON' +description: '' +sidebar_label: 'ValidatorConfigJSON' hide_title: true hide_table_of_contents: true schema: true -sample: {"op":"<","threshold":0} +sample: { 'op': '<', 'threshold': 0 } custom_edit_url: null --- -import Schema from "@theme/Schema"; -import Heading from "@theme/Heading"; +import Schema from '@theme/Schema'; +import Heading from '@theme/Heading'; - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ValidatorConfigJSON'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ViewMenuApi.get_list'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ViewMenuApi.get'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ViewMenuApi.post'} +> - - - - - + as={'h1'} + className={'openapi__heading'} + children={'ViewMenuApi.put'} +> - +> - - Set a dashboard's embedded configuration - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.ParamsDetails.json index 0b5dc554ec8..c43c2cc7489 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"description":"The theme id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "parameters": [ + { + "description": "The theme id", + "in": "path", + "name": "pk", + "required": true, + "schema": { "type": "integer" } + } + ] +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.StatusCodes.json index 69feef1b086..2cc3fcf21c3 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.StatusCodes.json @@ -1 +1,97 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer"},"result":{"type":"string"}},"type":"object"},"example":{"id":1,"result":"string"}}},"description":"Theme successfully set as system dark"},"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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "id": { "type": "integer" }, + "result": { "type": "string" } + }, + "type": "object" + }, + "example": { "id": 1, "result": "string" } + } + }, + "description": "Theme successfully set as system dark" + }, + "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/set-a-theme-as-the-system-dark-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.api.mdx index 751a1f3ab20..c5d50508242 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.api.mdx @@ -1,33 +1,32 @@ --- id: set-a-theme-as-the-system-dark-theme -title: "Set a theme as the system dark theme" -description: "Set a theme as the system dark theme" -sidebar_label: "Set a theme as the system dark theme" +title: 'Set a theme as the system dark theme' +description: 'Set a theme as the system dark theme' +sidebar_label: 'Set a theme as the system dark theme' hide_title: true hide_table_of_contents: true api: eJzFV21v2zYQ/iuHw4AlmBI3WQsEKvohDVq0WZEGtbMXREFKS+eIjUSyJOXGE/TfhyNl+SUesLUf8skWeXe657lXtWiEFTV5sg7T6xYLcrmVxkutMMVJSeBLqglkgQlKPjPCl5igEjXx0z0maOlrIy0VmHrbUIIuL6kWmLboF4alpPJ0Rxa77oalndHKkWOB42fP+CfXypPy/FcYU8lcsAejL47daNcMGqsNWS+jtix2vSS8oqn82p3zVqo77LpkeaKnXyj3LEwPojYVLe0drdRXal3ymJmawDV5Ts7NmqpagCMPwoFbOE81FMLes/XnPwSwJufEHf1/JIMivhYFcIDI+RTeq7moZAGrqIOxei4LKnahXNONWI6eFsuVEo0vtZV/U5HCaeNLUr5/PwxZuAPIumJE8uvTInmr7VQWBakU/tINFFr97KEUcwJDtpbOMSKvQYQEA19KB5acbmxOuwAO9iK650+L7kJ7mOlGFSlwC+lTiIoBAhSaHCjtgR4kJ9djRIONgOj4+Kkzz1jNoRDTioCzzi9S+J2LKWYfWavtLhxnuqmKALW30Gvzq148dXN4rzxZJSpwZOdkI4oUThU0ih4M5Ry0cAg6zxv7L+X1VnhRDRQk6ChvLGPkkfLlm8f0+oZbvxd3PGZi93R4k+DDQa4LGgfX4gSqhLrDFPOrTx8wwUpMqVo99gWQYt7YCg7+hMurCWRYem/S0ajSuahK7Xx68uzkZCSMHM2PRmGAjY5GjvxtbM633JwzhCzLFMDBO8jwtG8PgfkUXpOwZOGn07OzN+Px7eTjb28uMsQuGfy7XPhSqzUPh4PBR1kbbf0y+12mMrWcffBqOD40jd9jP+C7gSRRvSRRkHWv2i04GaaQYQ8pQ/il7yq3Xt+T6nptzjZWvadFVJiLqqEMu0ztZ8pYqfze0v1DFt7b318n5FzMxTjkxBopG4er4GnlmJeBC/FNSA8z8nkZqPghItqIpyZf6oKBXF5NtjlKl1KwHXvG/nkZ/jYSNQk8fU5WKmexYg8mC0ORre3CzTBKL+md6mKRwvn448VhrFI5W+y1cE+LNa6h22dppvxlpiJNhfBioGgrAL2Qruiw0nd7LLr/ErnSNutzzKtJv8kJnia0vqbEC0wwUsZbXcPxCpteipust+a+2yaeYxv6R6zgxnLod0YQtz37wNdQ0JwqbWpSvu9EIbOiodZY7XWuqy4djVo21aUtV1b3yNpZ47yulyYSnAsruWG7vnkGM/y/oJmIKx67iQmSamruTP0j/4T+tGn/3WRyCYOdLkH2ZtPegPeRc+PYYvmOl2fQFt5fshHGsmlkJ1W9fpDuwia9bLPjPPbTtG+2LU5DAr/VthZs7/yPCfZrOddfvMVhSATQXcLKt5Zmllz5vUY6/kqY6Qhnw/vGkHXEtHjpeQ6tH3HuRLn5UaTE+VqE6dd/aPzHFN546TAXPT34kamEDOtRSKu2T+9rFEayB0fsWW8lNTGnN7P8Zhnva2zbqXB0Zauu4+OvDVkedjerlItfUzLsCwWmM1E5euTeMPhx71O/ve7D1kfXTgj9oVCLkOVVw0+YcPOOH2XdDWdnaHbBk3hxmucUWvFS5dG6wWk1tIHLK444b85rXA5x7/+w9Z3utG2UiN2zG7wLU4cd7Lp/ACPD/qs= -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Set a theme as the system dark theme'} +> - - Set a theme as the system dark theme - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.ParamsDetails.json index 0b5dc554ec8..c43c2cc7489 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"description":"The theme id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "parameters": [ + { + "description": "The theme id", + "in": "path", + "name": "pk", + "required": true, + "schema": { "type": "integer" } + } + ] +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.RequestSchema.json index 188a349c40f..e9fcb6db7c9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} +{ "title": "Body" } diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.StatusCodes.json index 8060db9789d..5d25b28cc0a 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.StatusCodes.json @@ -1 +1,97 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer"},"result":{"type":"string"}},"type":"object"},"example":{"id":1,"result":"string"}}},"description":"Theme successfully set as system default"},"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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "id": { "type": "integer" }, + "result": { "type": "string" } + }, + "type": "object" + }, + "example": { "id": 1, "result": "string" } + } + }, + "description": "Theme successfully set as system default" + }, + "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/set-a-theme-as-the-system-default-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.api.mdx index 2fd3d333c37..ea9d935c661 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.api.mdx @@ -1,33 +1,32 @@ --- id: set-a-theme-as-the-system-default-theme -title: "Set a theme as the system default theme" -description: "Set a theme as the system default theme" -sidebar_label: "Set a theme as the system default theme" +title: 'Set a theme as the system default theme' +description: 'Set a theme as the system default theme' +sidebar_label: 'Set a theme as the system default theme' hide_title: true hide_table_of_contents: true api: eJzFV21v2zYQ/iuHw4AlmBI3XQcUKvohDVq0XZEGtbMXREFKS+eIjUSyJOXGE/TfhyMl+SUesK0f8skWdXe657lXtmiEFTV5sg7TqxYLcrmVxkutMMVZSeBLqglkgQlKPjPCl5igEjXx0x0maOlrIy0VmHrbUIIuL6kWmLboV4alpPJ0Sxa77pqlndHKkWOBp0+e8E+ulSfl+a8wppK5YA8mXxy70W4YNFYbsl5GbVns+0j4RFP5jXfOW6luseuS4UTPv1DuWZjuRW0qGuydrNXXal3ykJmawDV5Ts4tmqpagSMPwoFbOU81FLQQbKRL8Nl3YazJOXFL/x3MqIivRAEcI3I+hXdqKSpZwDrwYKxeyoKKfUA3dCOWk8fFcqlE40tt5V9UpHDa+JKU778PYyLuAbKpGJH8/LhI3mg7l0VBKoU/dQOFVj96KMWSwJCtpXOMyGsQIcfAl9KBJacbm9M+gKO9iO7Z46I71x4WulFFCtxF+hSiYoQAhSYHSnuge8nJ9RDRaCMgevr0sTPPWM2hEPOKgLPOr1L4jYspZh9Zq+0+HGe6qYoAtbfQa/Onfnns5vBOebJKVODILslGFCmcKmgU3RvKOWjhEHSeN/YfyuuN8KIaKUjQUd5YxshT5cs3j+nVNXd/L2550sQG6vA6wfujXBc0Da7FIVQJdYsp5pefPmCClZhTtX7sCyDFvLEVHP0BF5czyLD03qSTSaVzUZXa+fT5k+fPJ8LIyfJkEmbY5GTiyN/E/nzT9+cMIcsyBXD0FjI87TtEID+FVyQsWfjh9Ozs9XR6M/v46+vzDLFLRhcvVr7UasPJ8WB0U9ZGWz8UgMtUpoYJCC/H42PT+AP2A74HSxItlCQKsu5lu4MowxQy7FFlCD/1veXG6ztSXa/NOceqd7SKCktRNZRhl6nDTBkrlT8YEByz8MHh4SYn78VSTENmbPCydbgOoVaOqRnpEN+E9LAgn5eBje/loo2QavKlLhjLxeVsl6Z0kILdDGD4n4ckaCNXs0DV52StchZL92i2MhQJ263gDKP0wPBcF6sU3k8/nh/HcpWL1UELd7TaoBu6Q5Zm1l9kKjJVCC9GlnZi0Avpio4rfXvAoocvkEtuu1CnvKb0W53gsUI7K0t8hwlG1njJazhqYfFLcZv71tx1e+jnIId2Egu6sZwDe0OJu/594NdQ0JIqbWpSvm9MIcWiodZY7XWuqy6dTFo21aUtV1n3wNpZ47yuBxMJLoWV3L9d30uDGf4/OB7dxARJNTU3qv6Rf0K72rb/dja7gNFOlyB7s21vxPvAuWnsuPyO12nQFt5dsBHGsm1kL1W9fpDuwm49dN1pHttr2vfeFuchjd9oWwu29/73GfaLOhdifIvjzAigu4SVbywtLLny/xrp+N6w0BHOlveNIeuIafHS81jaPOLciXLLk0iJ87UIw7C/evz7RN767jgpPd37iamEDAtTyKy2T/IrFEayEyfsXG8lDXedPbl+PUT9Ctt2Lhxd2qrr+PhrQ5Yn4PU68eItS4YlosB0ISpHDzwctwE8+NSvtIewcxnbi6I/FGoVcr1q+AkT7uXxstZdc46Gxhc8iS9O85xCZx5UHuwgnFxjP7i45LjzOr1B5xj9/g9b3+tO20aJ2Em70bswhNjBrvsbSfUI0g== -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Set a theme as the system default theme'} +> - - Set a theme as the system default theme - + 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 index f49e29290d9..c42cfcab170 100644 --- 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 @@ -6,4345 +6,4375 @@ */ const sidebar = { - "apisidebar": [ + apisidebar: [ { - "type": "category", - "label": "Advanced Data Type", - "link": { - "type": "doc", - "id": "api/advanced-data-type" + type: 'category', + label: 'Advanced Data Type', + link: { + type: 'doc', + id: 'api/advanced-data-type', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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-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: '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" + key: 'api-category-advanced-data-type', }, { - "type": "category", - "label": "Annotation Layers", - "link": { - "type": "doc", - "id": "api/annotation-layers" + type: 'category', + label: 'Annotation Layers', + link: { + type: 'doc', + id: 'api/annotation-layers', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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/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/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-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/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/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/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/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/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/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/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/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/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: '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" + key: 'api-category-annotation-layers', }, { - "type": "category", - "label": "AsyncEventsRestApi", - "link": { - "type": "doc", - "id": "api/async-events-rest-api" + type: 'category', + label: 'AsyncEventsRestApi', + link: { + type: 'doc', + id: 'api/async-events-rest-api', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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: '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" + key: 'api-category-asynceventsrestapi', }, { - "type": "category", - "label": "Available Domains", - "link": { - "type": "doc", - "id": "api/available-domains" + type: 'category', + label: 'Available Domains', + link: { + type: 'doc', + id: 'api/available-domains', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/get-all-available-domains", - "label": "Get all available domains", - "className": "api-method get" - } + type: 'doc', + id: 'api/get-all-available-domains', + label: 'Get all available domains', + className: 'api-method get', + }, ], - "key": "api-category-available-domains" + key: 'api-category-available-domains', }, { - "type": "category", - "label": "CSS Templates", - "link": { - "type": "doc", - "id": "api/css-templates" + type: 'category', + label: 'CSS Templates', + link: { + type: 'doc', + id: 'api/css-templates', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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/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/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-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/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/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/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: 'doc', + id: 'api/update-a-css-template', + label: 'Update a CSS template', + className: 'api-method put', + }, ], - "key": "api-category-css-templates" + key: 'api-category-css-templates', }, { - "type": "category", - "label": "CacheRestApi", - "link": { - "type": "doc", - "id": "api/cache-rest-api" + type: 'category', + label: 'CacheRestApi', + link: { + type: 'doc', + id: 'api/cache-rest-api', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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: '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" + key: 'api-category-cacherestapi', }, { - "type": "category", - "label": "Charts", - "link": { - "type": "doc", - "id": "api/charts" + type: 'category', + label: 'Charts', + link: { + type: 'doc', + id: 'api/charts', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/bulk-delete-charts", - "label": "Bulk delete charts", - "className": "api-method delete" + 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/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/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/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', + 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/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/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/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/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/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/warm-up-the-cache-for-the-chart', + label: 'Warm up the cache for the chart', + className: 'api-method put', }, { - "type": "doc", - "id": "api/get-a-chart-detail-information", - "label": "Get a chart detail information", - "className": "api-method get" + type: 'doc', + id: 'api/get-a-chart-detail-information', + label: 'Get a chart detail information', + className: 'api-method get', }, { - "type": "doc", - "id": "api/delete-a-chart", - "label": "Delete a chart", - "className": "api-method delete" + type: 'doc', + id: 'api/delete-a-chart', + label: 'Delete a chart', + className: 'api-method delete', }, { - "type": "doc", - "id": "api/update-a-chart", - "label": "Update a chart", - "className": "api-method put" + 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/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/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/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/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-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: 'doc', + id: 'api/get-chart-thumbnail', + label: 'Get chart thumbnail', + className: 'api-method get', + }, ], - "key": "api-category-charts" + key: 'api-category-charts', }, { - "type": "category", - "label": "Current User", - "link": { - "type": "doc", - "id": "api/current-user" + type: 'category', + label: 'Current User', + link: { + type: 'doc', + id: 'api/current-user', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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-object', + label: 'Get the user object', + className: 'api-method get', }, { - "type": "doc", - "id": "api/update-the-current-user", - "label": "Update the current user", - "className": "api-method put" + type: 'doc', + id: 'api/update-the-current-user', + label: 'Update the current user', + className: 'api-method put', }, { - "type": "doc", - "id": "api/get-the-user-roles", - "label": "Get the user roles", - "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" + key: 'api-category-current-user', }, { - "type": "category", - "label": "Dashboard Filter State", - "link": { - "type": "doc", - "id": "api/dashboard-filter-state" + type: 'category', + label: 'Dashboard Filter State', + link: { + type: 'doc', + id: 'api/dashboard-filter-state', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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/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/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: '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" + key: 'api-category-dashboard-filter-state', }, { - "type": "category", - "label": "Dashboard Permanent Link", - "link": { - "type": "doc", - "id": "api/dashboard-permanent-link" + type: 'category', + label: 'Dashboard Permanent Link', + link: { + type: 'doc', + id: 'api/dashboard-permanent-link', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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: '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" + key: 'api-category-dashboard-permanent-link', }, { - "type": "category", - "label": "Dashboards", - "link": { - "type": "doc", - "id": "api/dashboards" + type: 'category', + label: 'Dashboards', + link: { + type: 'doc', + id: 'api/dashboards', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/bulk-delete-dashboards", - "label": "Bulk delete dashboards", - "className": "api-method delete" + 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/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/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/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/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/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/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-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-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/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/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/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/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/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/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/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/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/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/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/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-chart-customizations-configuration-for-a-dashboard", - "label": "Update chart customizations configuration for a dashboard.", - "className": "api-method put" + type: 'doc', + id: 'api/update-chart-customizations-configuration-for-a-dashboard', + label: 'Update chart customizations configuration for a dashboard.', + className: 'api-method put', }, { - "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/update-colors-configuration-for-a-dashboard', + label: 'Update colors configuration for a dashboard.', + className: 'api-method put', }, { - "type": "doc", - "id": "api/export-dashboard-as-example-bundle", - "label": "Export dashboard as example bundle", - "className": "api-method get" + type: 'doc', + id: 'api/export-dashboard-as-example-bundle', + label: 'Export dashboard as example bundle', + className: 'api-method get', }, { - "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/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/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/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-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: 'doc', + id: 'api/get-dashboards-thumbnail', + label: "Get dashboard's thumbnail", + className: 'api-method get', + }, ], - "key": "api-category-dashboards" + key: 'api-category-dashboards', }, { - "type": "category", - "label": "Database", - "link": { - "type": "doc", - "id": "api/database" + type: 'category', + label: 'Database', + link: { + type: 'doc', + id: 'api/database', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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/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-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/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/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/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/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/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/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/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/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/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/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/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-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-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-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-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/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/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', + 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/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/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/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-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-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-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-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/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/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: 'doc', + id: 'api/validate-arbitrary-sql', + label: 'Validate arbitrary SQL', + className: 'api-method post', + }, ], - "key": "api-category-database" + key: 'api-category-database', }, { - "type": "category", - "label": "Datasets", - "link": { - "type": "doc", - "id": "api/datasets" + type: 'category', + label: 'Datasets', + link: { + type: 'doc', + id: 'api/datasets', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/bulk-delete-datasets", - "label": "Bulk delete datasets", - "className": "api-method delete" + 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/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/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-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/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/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/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/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/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/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/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/get-a-dataset", - "label": "Get a dataset", - "className": "api-method get" + type: 'doc', + id: 'api/get-a-dataset', + label: 'Get a dataset', + className: 'api-method get', }, { - "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: '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": "doc", - "id": "api/delete-a-dataset", - "label": "Delete a dataset", - "className": "api-method delete" + type: 'doc', + id: 'api/delete-a-dataset', + label: 'Delete a dataset', + className: 'api-method delete', }, { - "type": "doc", - "id": "api/update-a-dataset", - "label": "Update a dataset", - "className": "api-method put" + 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-column', + label: 'Delete a dataset column', + className: 'api-method delete', }, { - "type": "doc", - "id": "api/get-dataset-drill-info", - "label": "Get dataset drill info", - "className": "api-method get" + type: 'doc', + id: 'api/get-dataset-drill-info', + label: 'Get dataset drill info', + className: 'api-method get', }, { - "type": "doc", - "id": "api/delete-a-dataset-metric", - "label": "Delete a dataset metric", - "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/refresh-and-update-columns-of-a-dataset', + label: 'Refresh and update columns of a dataset', + className: 'api-method put', + }, ], - "key": "api-category-datasets" + key: 'api-category-datasets', }, { - "type": "category", - "label": "Datasources", - "link": { - "type": "doc", - "id": "api/datasources" + type: 'category', + label: 'Datasources', + link: { + type: 'doc', + id: 'api/datasources', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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: 'doc', + id: 'api/get-possible-values-for-a-datasource-column', + label: 'Get possible values for a datasource column', + className: 'api-method get', }, { - "type": "doc", - "id": "api/validate-a-sql-expression-against-a-datasource", - "label": "Validate a SQL expression against a datasource", - "className": "api-method post" - } + type: 'doc', + id: 'api/validate-a-sql-expression-against-a-datasource', + label: 'Validate a SQL expression against a datasource', + className: 'api-method post', + }, ], - "key": "api-category-datasources" + key: 'api-category-datasources', }, { - "type": "category", - "label": "Embedded Dashboard", - "link": { - "type": "doc", - "id": "api/embedded-dashboard" + type: 'category', + label: 'Embedded Dashboard', + link: { + type: 'doc', + id: 'api/embedded-dashboard', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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: '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" + key: 'api-category-embedded-dashboard', }, { - "type": "category", - "label": "Explore", - "link": { - "type": "doc", - "id": "api/explore" + type: 'category', + label: 'Explore', + link: { + type: 'doc', + id: 'api/explore', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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: '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" + key: 'api-category-explore', }, { - "type": "category", - "label": "Explore Form Data", - "link": { - "type": "doc", - "id": "api/explore-form-data" + type: 'category', + label: 'Explore Form Data', + link: { + type: 'doc', + id: 'api/explore-form-data', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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/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/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: 'doc', + id: 'api/update-an-existing-form-data', + label: 'Update an existing form_data', + className: 'api-method put', + }, ], - "key": "api-category-explore-form-data" + key: 'api-category-explore-form-data', }, { - "type": "category", - "label": "Explore Permanent Link", - "link": { - "type": "doc", - "id": "api/explore-permanent-link" + type: 'category', + label: 'Explore Permanent Link', + link: { + type: 'doc', + id: 'api/explore-permanent-link', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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: '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" + key: 'api-category-explore-permanent-link', }, { - "type": "category", - "label": "Import/export", - "link": { - "type": "doc", - "id": "api/import-export" + type: 'category', + label: 'Import/export', + link: { + type: 'doc', + id: 'api/import-export', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/export-all-assets", - "label": "Export all assets", - "className": "api-method get" + 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: 'doc', + id: 'api/import-multiple-assets', + label: 'Import multiple assets', + className: 'api-method post', + }, ], - "key": "api-category-import/export" + key: 'api-category-import/export', }, { - "type": "category", - "label": "LogRestApi", - "link": { - "type": "doc", - "id": "api/log-rest-api" + type: 'category', + label: 'LogRestApi', + link: { + type: 'doc', + id: 'api/log-rest-api', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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/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-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: 'doc', + id: 'api/get-a-log-detail-information', + label: 'Get a log detail information', + className: 'api-method get', + }, ], - "key": "api-category-logrestapi" + key: 'api-category-logrestapi', }, { - "type": "category", - "label": "Menu", - "link": { - "type": "doc", - "id": "api/menu" + type: 'category', + label: 'Menu', + link: { + type: 'doc', + id: 'api/menu', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/get-menu", - "label": "Get menu", - "className": "api-method get" - } + type: 'doc', + id: 'api/get-menu', + label: 'Get menu', + className: 'api-method get', + }, ], - "key": "api-category-menu" + key: 'api-category-menu', }, { - "type": "category", - "label": "OpenApi", - "link": { - "type": "doc", - "id": "api/open-api" + type: 'category', + label: 'OpenApi', + link: { + type: 'doc', + id: 'api/open-api', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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: 'doc', + id: 'api/get-api-by-version-openapi', + label: 'Get api by version openapi', + className: 'api-method get', + }, ], - "key": "api-category-openapi" + key: 'api-category-openapi', }, { - "type": "category", - "label": "Queries", - "link": { - "type": "doc", - "id": "api/queries" + type: 'category', + label: 'Queries', + link: { + type: 'doc', + id: 'api/queries', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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-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-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/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/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-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/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/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/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/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-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/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/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/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/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/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/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: 'doc', + id: 'api/update-a-saved-query', + label: 'Update a saved query', + className: 'api-method put', + }, ], - "key": "api-category-queries" + key: 'api-category-queries', }, { - "type": "category", - "label": "Report Schedules", - "link": { - "type": "doc", - "id": "api/report-schedules" + type: 'category', + label: 'Report Schedules', + link: { + type: 'doc', + id: 'api/report-schedules', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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/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/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-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-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/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/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/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/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-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: '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" + key: 'api-category-report-schedules', }, { - "type": "category", - "label": "Row Level Security", - "link": { - "type": "doc", - "id": "api/row-level-security" + type: 'category', + label: 'Row Level Security', + link: { + type: 'doc', + id: 'api/row-level-security', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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/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/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-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/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/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/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: 'doc', + id: 'api/update-an-rls-rule', + label: 'Update an RLS rule', + className: 'api-method put', + }, ], - "key": "api-category-row-level-security" + key: 'api-category-row-level-security', }, { - "type": "category", - "label": "SQL Lab", - "link": { - "type": "doc", - "id": "api/sql-lab" + type: 'category', + label: 'SQL Lab', + link: { + type: 'doc', + id: 'api/sql-lab', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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/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/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/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/export-sql-query-results-to-csv-with-streaming", - "label": "Export SQL query results to CSV with streaming", - "className": "api-method post" + type: 'doc', + id: 'api/export-sql-query-results-to-csv-with-streaming', + label: 'Export SQL query results to CSV with streaming', + className: 'api-method post', }, { - "type": "doc", - "id": "api/format-sql-code", - "label": "Format SQL code", - "className": "api-method post" + 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: '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" + key: 'api-category-sql-lab', }, { - "type": "category", - "label": "SQL Lab Permanent Link", - "link": { - "type": "doc", - "id": "api/sql-lab-permanent-link" + type: 'category', + label: 'SQL Lab Permanent Link', + link: { + type: 'doc', + id: 'api/sql-lab-permanent-link', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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/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: '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" + key: 'api-category-sql-lab-permanent-link', }, { - "type": "category", - "label": "Security", - "link": { - "type": "doc", - "id": "api/security" + type: 'category', + label: 'Security', + link: { + type: 'doc', + id: 'api/security', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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-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/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-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: 'doc', + id: 'api/create-security-refresh', + label: 'Create security refresh', + className: 'api-method post', + }, ], - "key": "api-category-security" + key: 'api-category-security', }, { - "type": "category", - "label": "Security Groups", - "link": { - "type": "doc", - "id": "api/security-groups" + type: 'category', + label: 'Security Groups', + link: { + type: 'doc', + id: 'api/security-groups', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/get-security-groups", - "label": "Get security groups", - "className": "api-method get" + type: 'doc', + id: 'api/get-security-groups', + label: 'Get security groups', + className: 'api-method get', }, { - "type": "doc", - "id": "api/create-security-groups", - "label": "Create security groups", - "className": "api-method post" + type: 'doc', + id: 'api/create-security-groups', + label: 'Create security groups', + className: 'api-method post', }, { - "type": "doc", - "id": "api/get-security-groups-info", - "label": "Get security groups info", - "className": "api-method get" + type: 'doc', + id: 'api/get-security-groups-info', + label: 'Get security groups info', + className: 'api-method get', }, { - "type": "doc", - "id": "api/delete-security-groups-by-pk", - "label": "Delete security groups by pk", - "className": "api-method delete" + type: 'doc', + id: 'api/delete-security-groups-by-pk', + label: 'Delete security groups by pk', + className: 'api-method delete', }, { - "type": "doc", - "id": "api/get-security-groups-by-pk", - "label": "Get security groups by pk", - "className": "api-method get" + type: 'doc', + id: 'api/get-security-groups-by-pk', + label: 'Get security groups by pk', + className: 'api-method get', }, { - "type": "doc", - "id": "api/update-security-groups-by-pk", - "label": "Update security groups by pk", - "className": "api-method put" - } + type: 'doc', + id: 'api/update-security-groups-by-pk', + label: 'Update security groups by pk', + className: 'api-method put', + }, ], - "key": "api-category-security-groups" + key: 'api-category-security-groups', }, { - "type": "category", - "label": "Security Permissions", - "link": { - "type": "doc", - "id": "api/security-permissions" + type: 'category', + label: 'Security Permissions', + link: { + type: 'doc', + id: 'api/security-permissions', }, - "collapsible": true, - "collapsed": true, - "items": [ + 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', + 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-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: 'doc', + id: 'api/get-security-permissions-by-pk', + label: 'Get security permissions by pk', + className: 'api-method get', + }, ], - "key": "api-category-security-permissions" + 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" + 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": [ + 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/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/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/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/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/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: '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)" + 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" + type: 'category', + label: 'Security Resources (View Menus)', + link: { + type: 'doc', + id: 'api/security-resources-view-menus', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/get-security-resources", - "label": "Get security resources", - "className": "api-method get" + 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/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/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/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/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: '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)" + key: 'api-category-security-resources-(view-menus)', }, { - "type": "category", - "label": "Security Roles", - "link": { - "type": "doc", - "id": "api/security-roles" + type: 'category', + label: 'Security Roles', + link: { + type: 'doc', + id: 'api/security-roles', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/get-security-roles", - "label": "Get security roles", - "className": "api-method get" + 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/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/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/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/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/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/update-security-roles-by-pk', + label: 'Update security roles by pk', + className: 'api-method put', }, { - "type": "doc", - "id": "api/update-security-roles-by-role-id-groups", - "label": "Update security roles by role_id groups", - "className": "api-method put" + type: 'doc', + id: 'api/update-security-roles-by-role-id-groups', + label: 'Update security roles by role_id groups', + 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/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/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: '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" + key: 'api-category-security-roles', }, { - "type": "category", - "label": "Security Users", - "link": { - "type": "doc", - "id": "api/security-users" + type: 'category', + label: 'Security Users', + link: { + type: 'doc', + id: 'api/security-users', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/get-security-users", - "label": "Get security users", - "className": "api-method get" + 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/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/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/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/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: 'doc', + id: 'api/update-security-users-by-pk', + label: 'Update security users by pk', + className: 'api-method put', + }, ], - "key": "api-category-security-users" + key: 'api-category-security-users', }, { - "type": "category", - "label": "Tags", - "link": { - "type": "doc", - "id": "api/tags" + type: 'category', + label: 'Tags', + link: { + type: 'doc', + id: 'api/tags', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/bulk-delete-tags", - "label": "Bulk delete tags", - "className": "api-method delete" + 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/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/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/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/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-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-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/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/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-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/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/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/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/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: 'doc', + id: 'api/create-tag-by-pk-favorites', + label: 'Create tag by pk favorites', + className: 'api-method post', + }, ], - "key": "api-category-tags" + key: 'api-category-tags', }, { - "type": "category", - "label": "Themes", - "link": { - "type": "doc", - "id": "api/themes" + type: 'category', + label: 'Themes', + link: { + type: 'doc', + id: 'api/themes', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/bulk-delete-themes", - "label": "Bulk delete themes", - "className": "api-method delete" + type: 'doc', + id: 'api/bulk-delete-themes', + label: 'Bulk delete themes', + className: 'api-method delete', }, { - "type": "doc", - "id": "api/get-a-list-of-themes", - "label": "Get a list of themes", - "className": "api-method get" + type: 'doc', + id: 'api/get-a-list-of-themes', + label: 'Get a list of themes', + className: 'api-method get', }, { - "type": "doc", - "id": "api/create-a-theme", - "label": "Create a theme", - "className": "api-method post" + type: 'doc', + id: 'api/create-a-theme', + label: 'Create a theme', + className: 'api-method post', }, { - "type": "doc", - "id": "api/get-metadata-information-about-this-api-resource-theme-info", - "label": "Get metadata information about this API resource (theme--info)", - "className": "api-method get" + type: 'doc', + id: 'api/get-metadata-information-about-this-api-resource-theme-info', + label: + 'Get metadata information about this API resource (theme--info)', + className: 'api-method get', }, { - "type": "doc", - "id": "api/download-multiple-themes-as-yaml-files", - "label": "Download multiple themes as YAML files", - "className": "api-method get" + type: 'doc', + id: 'api/download-multiple-themes-as-yaml-files', + label: 'Download multiple themes as YAML files', + className: 'api-method get', }, { - "type": "doc", - "id": "api/import-themes-from-a-zip-file", - "label": "Import themes from a ZIP file", - "className": "api-method post" + type: 'doc', + id: 'api/import-themes-from-a-zip-file', + label: 'Import themes from a ZIP file', + className: 'api-method post', }, { - "type": "doc", - "id": "api/get-related-fields-data-theme-related-column-name", - "label": "Get related fields data (theme-related-column-name)", - "className": "api-method get" + type: 'doc', + id: 'api/get-related-fields-data-theme-related-column-name', + label: 'Get related fields data (theme-related-column-name)', + className: 'api-method get', }, { - "type": "doc", - "id": "api/clear-the-system-dark-theme", - "label": "Clear the system dark theme", - "className": "api-method delete" + type: 'doc', + id: 'api/clear-the-system-dark-theme', + label: 'Clear the system dark theme', + className: 'api-method delete', }, { - "type": "doc", - "id": "api/clear-the-system-default-theme", - "label": "Clear the system default theme", - "className": "api-method delete" + type: 'doc', + id: 'api/clear-the-system-default-theme', + label: 'Clear the system default theme', + className: 'api-method delete', }, { - "type": "doc", - "id": "api/delete-a-theme", - "label": "Delete a theme", - "className": "api-method delete" + type: 'doc', + id: 'api/delete-a-theme', + label: 'Delete a theme', + className: 'api-method delete', }, { - "type": "doc", - "id": "api/get-a-theme", - "label": "Get a theme", - "className": "api-method get" + type: 'doc', + id: 'api/get-a-theme', + label: 'Get a theme', + className: 'api-method get', }, { - "type": "doc", - "id": "api/update-a-theme", - "label": "Update a theme", - "className": "api-method put" + type: 'doc', + id: 'api/update-a-theme', + label: 'Update a theme', + className: 'api-method put', }, { - "type": "doc", - "id": "api/set-a-theme-as-the-system-dark-theme", - "label": "Set a theme as the system dark theme", - "className": "api-method put" + type: 'doc', + id: 'api/set-a-theme-as-the-system-dark-theme', + label: 'Set a theme as the system dark theme', + className: 'api-method put', }, { - "type": "doc", - "id": "api/set-a-theme-as-the-system-default-theme", - "label": "Set a theme as the system default theme", - "className": "api-method put" - } + type: 'doc', + id: 'api/set-a-theme-as-the-system-default-theme', + label: 'Set a theme as the system default theme', + className: 'api-method put', + }, ], - "key": "api-category-themes" + key: 'api-category-themes', }, { - "type": "category", - "label": "User", - "link": { - "type": "doc", - "id": "api/user" + type: 'category', + label: 'User', + link: { + type: 'doc', + id: 'api/user', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/get-the-user-avatar", - "label": "Get the user avatar", - "className": "api-method get" - } + type: 'doc', + id: 'api/get-the-user-avatar', + label: 'Get the user avatar', + className: 'api-method get', + }, ], - "key": "api-category-user" + key: 'api-category-user', }, { - "type": "category", - "label": "UserRegistrationsRestAPI", - "link": { - "type": "doc", - "id": "api/user-registrations-rest-api" + type: 'category', + label: 'UserRegistrationsRestAPI', + link: { + type: 'doc', + id: 'api/user-registrations-rest-api', }, - "collapsible": true, - "collapsed": true, - "items": [ + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/get-security-user-registrations", - "label": "Get security user registrations", - "className": "api-method get" + type: 'doc', + id: 'api/get-security-user-registrations', + label: 'Get security user registrations', + className: 'api-method get', }, { - "type": "doc", - "id": "api/create-security-user-registrations", - "label": "Create security user registrations", - "className": "api-method post" + type: 'doc', + id: 'api/create-security-user-registrations', + label: 'Create security user registrations', + className: 'api-method post', }, { - "type": "doc", - "id": "api/get-security-user-registrations-info", - "label": "Get security user registrations info", - "className": "api-method get" + type: 'doc', + id: 'api/get-security-user-registrations-info', + label: 'Get security user registrations info', + className: 'api-method get', }, { - "type": "doc", - "id": "api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name", - "label": "Get distinct values from field data (security-user-registrations-distinct-column-name)", - "className": "api-method get" + type: 'doc', + id: 'api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name', + label: + 'Get distinct values from field data (security-user-registrations-distinct-column-name)', + className: 'api-method get', }, { - "type": "doc", - "id": "api/get-related-fields-data-security-user-registrations-related-column-name", - "label": "Get related fields data (security-user-registrations-related-column-name)", - "className": "api-method get" + type: 'doc', + id: 'api/get-related-fields-data-security-user-registrations-related-column-name', + label: + 'Get related fields data (security-user-registrations-related-column-name)', + className: 'api-method get', }, { - "type": "doc", - "id": "api/delete-security-user-registrations-by-pk", - "label": "Delete security user registrations by pk", - "className": "api-method delete" + type: 'doc', + id: 'api/delete-security-user-registrations-by-pk', + label: 'Delete security user registrations by pk', + className: 'api-method delete', }, { - "type": "doc", - "id": "api/get-security-user-registrations-by-pk", - "label": "Get security user registrations by pk", - "className": "api-method get" + type: 'doc', + id: 'api/get-security-user-registrations-by-pk', + label: 'Get security user registrations by pk', + className: 'api-method get', }, { - "type": "doc", - "id": "api/update-security-user-registrations-by-pk", - "label": "Update security user registrations by pk", - "className": "api-method put" - } + type: 'doc', + id: 'api/update-security-user-registrations-by-pk', + label: 'Update security user registrations by pk', + className: 'api-method put', + }, ], - "key": "api-category-userregistrationsrestapi" + key: 'api-category-userregistrationsrestapi', }, { - "type": "category", - "label": "Schemas", - "collapsible": true, - "collapsed": true, - "items": [ + type: 'category', + label: 'Schemas', + collapsible: true, + collapsed: true, + items: [ { - "type": "doc", - "id": "api/schemas/advanceddatatypeschema", - "label": "AdvancedDataTypeSchema", - "className": "schema" + 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/annotationlayer', + label: 'AnnotationLayer', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/annotationlayerrestapi-get", - "label": "AnnotationLayerRestApi.get", - "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', + 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', + 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-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-post', + label: 'AnnotationLayerRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/annotationlayerrestapi-put", - "label": "AnnotationLayerRestApi.put", - "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', + 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-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', + 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', + 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-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-post', + label: 'AnnotationRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/annotationrestapi-put", - "label": "AnnotationRestApi.put", - "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/availabledomainsschema', + label: 'AvailableDomainsSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/cacheinvalidationrequestschema", - "label": "CacheInvalidationRequestSchema", - "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', + 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-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-post', + label: 'CacheRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/cacherestapi-put", - "label": "CacheRestApi.put", - "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/catalogsresponseschema', + label: 'CatalogsResponseSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartcachescreenshotresponseschema", - "label": "ChartCacheScreenshotResponseSchema", - "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/chartcachewarmuprequestschema', + label: 'ChartCacheWarmUpRequestSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartcachewarmupresponseschema", - "label": "ChartCacheWarmUpResponseSchema", - "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/chartcachewarmupresponsesingle', + label: 'ChartCacheWarmUpResponseSingle', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdataadhocmetricschema", - "label": "ChartDataAdhocMetricSchema", - "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/chartdataaggregateoptionsschema', + label: 'ChartDataAggregateOptionsSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdataasyncresponseschema", - "label": "ChartDataAsyncResponseSchema", - "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/chartdataboxplotoptionsschema', + label: 'ChartDataBoxplotOptionsSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdatacolumn", - "label": "ChartDataColumn", - "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/chartdatacontributionoptionsschema', + label: 'ChartDataContributionOptionsSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdatadatasource", - "label": "ChartDataDatasource", - "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/chartdataextras', + label: 'ChartDataExtras', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdatafilter", - "label": "ChartDataFilter", - "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/chartdatageodeticparseoptionsschema', + label: 'ChartDataGeodeticParseOptionsSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdatageohashdecodeoptionsschema", - "label": "ChartDataGeohashDecodeOptionsSchema", - "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/chartdatageohashencodeoptionsschema', + label: 'ChartDataGeohashEncodeOptionsSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdatapivotoptionsschema", - "label": "ChartDataPivotOptionsSchema", - "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/chartdatapostprocessingoperation', + label: 'ChartDataPostProcessingOperation', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdataprophetoptionsschema", - "label": "ChartDataProphetOptionsSchema", - "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/chartdataquerycontextschema', + label: 'ChartDataQueryContextSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdataqueryobject", - "label": "ChartDataQueryObject", - "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/chartdataresponseresult', + label: 'ChartDataResponseResult', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdataresponseschema", - "label": "ChartDataResponseSchema", - "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', + label: 'ChartDataRestApi.get', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdatarestapi-get-list", - "label": "ChartDataRestApi.get_list", - "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-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-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-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', + 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-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-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-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-post', + label: 'ChartDataRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdatarestapi-put", - "label": "ChartDataRestApi.put", - "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/chartdatarollingoptionsschema', + label: 'ChartDataRollingOptionsSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartdataselectoptionsschema", - "label": "ChartDataSelectOptionsSchema", - "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/chartdatasortoptionsschema', + label: 'ChartDataSortOptionsSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartentityresponseschema", - "label": "ChartEntityResponseSchema", - "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/chartfavstarresponseresult', + label: 'ChartFavStarResponseResult', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartgetdatasourceobjectdataresponse", - "label": "ChartGetDatasourceObjectDataResponse", - "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/chartgetdatasourceobjectresponse', + label: 'ChartGetDatasourceObjectResponse', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartgetdatasourceresponseschema", - "label": "ChartGetDatasourceResponseSchema", - "className": "schema" + type: 'doc', + id: 'api/schemas/chartgetdatasourceresponseschema', + label: 'ChartGetDatasourceResponseSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartgetresponseschema", - "label": "ChartGetResponseSchema", - "className": "schema" + type: 'doc', + id: 'api/schemas/chartgetresponseschema', + label: 'ChartGetResponseSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartrestapi-get", - "label": "ChartRestApi.get", - "className": "schema" + type: 'doc', + id: 'api/schemas/chartrestapi-get', + label: 'ChartRestApi.get', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartrestapi-get-list", - "label": "ChartRestApi.get_list", - "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-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-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-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', + 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-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-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-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-post', + label: 'ChartRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/chartrestapi-put", - "label": "ChartRestApi.put", - "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', + 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', + 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-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', + 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', + 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-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-post', + label: 'CssTemplateRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/csstemplaterestapi-put", - "label": "CssTemplateRestApi.put", - "className": "schema" + type: 'doc', + id: 'api/schemas/csstemplaterestapi-put', + label: 'CssTemplateRestApi.put', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/currentuserputschema", - "label": "CurrentUserPutSchema", - "className": "schema" + type: 'doc', + id: 'api/schemas/currentuserputschema', + label: 'CurrentUserPutSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/dashboard", - "label": "Dashboard", - "className": "schema" + type: 'doc', + id: 'api/schemas/dashboard', + label: 'Dashboard', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/dashboardcachescreenshotresponseschema", - "label": "DashboardCacheScreenshotResponseSchema", - "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/dashboardcopyschema', + label: 'DashboardCopySchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/dashboarddatasetschema", - "label": "DashboardDatasetSchema", - "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/dashboardgetresponseschema', + label: 'DashboardGetResponseSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/dashboardpermalinkstateschema", - "label": "DashboardPermalinkStateSchema", - "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', + 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', + 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-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-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', + 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-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-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-post', + label: 'DashboardRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/dashboardrestapi-put", - "label": "DashboardRestApi.put", - "className": "schema" + type: 'doc', + id: 'api/schemas/dashboardrestapi-put', + label: 'DashboardRestApi.put', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/dashboardscreenshotpostschema", - "label": "DashboardScreenshotPostSchema", - "className": "schema" + type: 'doc', + id: 'api/schemas/dashboardscreenshotpostschema', + label: 'DashboardScreenshotPostSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/database", - "label": "Database", - "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/database-1', + label: 'Database1', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/databaseconnectionschema", - "label": "DatabaseConnectionSchema", - "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/databasefunctionnamesresponse', + label: 'DatabaseFunctionNamesResponse', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/databaserelatedchart", - "label": "DatabaseRelatedChart", - "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/databaserelatedcharts', + label: 'DatabaseRelatedCharts', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/databaserelateddashboard", - "label": "DatabaseRelatedDashboard", - "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/databaserelateddashboards', + label: 'DatabaseRelatedDashboards', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/databaserelatedobjectsresponse", - "label": "DatabaseRelatedObjectsResponse", - "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', + 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', + 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', + 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-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-post', + label: 'DatabaseRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/databaserestapi-put", - "label": "DatabaseRestApi.put", - "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/databasesshtunnel', + label: 'DatabaseSSHTunnel', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/databaseschemaaccessforfileuploadresponse", - "label": "DatabaseSchemaAccessForFileUploadResponse", - "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/databasetablesresponse', + label: 'DatabaseTablesResponse', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/databasetestconnectionschema", - "label": "DatabaseTestConnectionSchema", - "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/databasevalidateparametersschema', + label: 'DatabaseValidateParametersSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/dataset", - "label": "Dataset", - "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/datasetcachewarmuprequestschema', + label: 'DatasetCacheWarmUpRequestSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/datasetcachewarmupresponseschema", - "label": "DatasetCacheWarmUpResponseSchema", - "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/datasetcachewarmupresponsesingle', + label: 'DatasetCacheWarmUpResponseSingle', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/datasetcolumnsput", - "label": "DatasetColumnsPut", - "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', + 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-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-post', + label: 'DatasetColumnsRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/datasetcolumnsrestapi-put", - "label": "DatasetColumnsRestApi.put", - "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/datasetduplicateschema', + label: 'DatasetDuplicateSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/datasetmetriccurrencyput", - "label": "DatasetMetricCurrencyPut", - "className": "schema" + type: 'doc', + id: 'api/schemas/datasetmetriccurrencyput', + label: 'DatasetMetricCurrencyPut', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/datasetmetricrestapi-get", - "label": "DatasetMetricRestApi.get", - "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-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-post', + label: 'DatasetMetricRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/datasetmetricrestapi-put", - "label": "DatasetMetricRestApi.put", - "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/datasetmetricsput', + label: 'DatasetMetricsPut', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/datasetrelatedchart", - "label": "DatasetRelatedChart", - "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/datasetrelatedcharts', + label: 'DatasetRelatedCharts', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/datasetrelateddashboard", - "label": "DatasetRelatedDashboard", - "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/datasetrelateddashboards', + label: 'DatasetRelatedDashboards', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/datasetrelatedobjectsresponse", - "label": "DatasetRelatedObjectsResponse", - "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', + 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-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-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-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', + 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-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-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', + 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-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', + 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-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-post', + label: 'DatasetRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/datasetrestapi-put", - "label": "DatasetRestApi.put", - "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/datasource', + label: 'Datasource', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/distincresponseschema", - "label": "DistincResponseSchema", - "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/distinctresultresponse', + label: 'DistinctResultResponse', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/embeddeddashboardconfig", - "label": "EmbeddedDashboardConfig", - "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/embeddeddashboardresponseschema', + label: 'EmbeddedDashboardResponseSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/embeddeddashboardrestapi-get", - "label": "EmbeddedDashboardRestApi.get", - "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-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-post', + label: 'EmbeddedDashboardRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/embeddeddashboardrestapi-put", - "label": "EmbeddedDashboardRestApi.put", - "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/engineinformation', + label: 'EngineInformation', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/estimatequerycostschema", - "label": "EstimateQueryCostSchema", - "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/executepayloadschema', + label: 'ExecutePayloadSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/explorecontextschema", - "label": "ExploreContextSchema", - "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/explorepermalinkstateschema', + label: 'ExplorePermalinkStateSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/folder", - "label": "Folder", - "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/formdatapostschema', + label: 'FormDataPostSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/formdataputschema", - "label": "FormDataPutSchema", - "className": "schema" + type: 'doc', + id: 'api/schemas/formdataputschema', + label: 'FormDataPutSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/formatquerypayloadschema", - "label": "FormatQueryPayloadSchema", - "className": "schema" + type: 'doc', + id: 'api/schemas/formatquerypayloadschema', + label: 'FormatQueryPayloadSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/getfavstaridsschema", - "label": "GetFavStarIdsSchema", - "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/getorcreatedatasetschema', + label: 'GetOrCreateDatasetSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/groupapi-get", - "label": "GroupApi.get", - "className": "schema" + type: 'doc', + id: 'api/schemas/groupapi-get', + label: 'GroupApi.get', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/groupapi-get-role", - "label": "GroupApi.get.Role", - "className": "schema" + type: 'doc', + id: 'api/schemas/groupapi-get-role', + label: 'GroupApi.get.Role', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/groupapi-get-user", - "label": "GroupApi.get.User", - "className": "schema" + type: 'doc', + id: 'api/schemas/groupapi-get-user', + label: 'GroupApi.get.User', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/groupapi-get-list", - "label": "GroupApi.get_list", - "className": "schema" + type: 'doc', + id: 'api/schemas/groupapi-get-list', + label: 'GroupApi.get_list', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/groupapi-get-list-role", - "label": "GroupApi.get_list.Role", - "className": "schema" + type: 'doc', + id: 'api/schemas/groupapi-get-list-role', + label: 'GroupApi.get_list.Role', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/groupapi-get-list-user", - "label": "GroupApi.get_list.User", - "className": "schema" + type: 'doc', + id: 'api/schemas/groupapi-get-list-user', + label: 'GroupApi.get_list.User', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/groupapi-post", - "label": "GroupApi.post", - "className": "schema" + type: 'doc', + id: 'api/schemas/groupapi-post', + label: 'GroupApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/groupapi-put", - "label": "GroupApi.put", - "className": "schema" + type: 'doc', + id: 'api/schemas/groupapi-put', + label: 'GroupApi.put', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/grouppostschema", - "label": "GroupPostSchema", - "className": "schema" + type: 'doc', + id: 'api/schemas/grouppostschema', + label: 'GroupPostSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/groupputschema", - "label": "GroupPutSchema", - "className": "schema" + type: 'doc', + id: 'api/schemas/groupputschema', + label: 'GroupPutSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/guesttokencreate", - "label": "GuestTokenCreate", - "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-database', + label: 'ImportV1Database', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/importv-1-databaseextra", - "label": "ImportV1DatabaseExtra", - "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', + 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-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', + 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-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-post', + label: 'LogRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/logrestapi-put", - "label": "LogRestApi.put", - "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', + 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-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-post', + label: 'PermissionApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/permissionapi-put", - "label": "PermissionApi.put", - "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', + 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-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-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', + 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-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-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-post', + label: 'PermissionViewMenuApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/permissionviewmenuapi-put", - "label": "PermissionViewMenuApi.put", - "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/queryexecutionresponseschema', + label: 'QueryExecutionResponseSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/queryrestapi-get", - "label": "QueryRestApi.get", - "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-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-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-post', + label: 'QueryRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/queryrestapi-put", - "label": "QueryRestApi.put", - "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/queryresult', + label: 'QueryResult', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/rlsrestapi-get", - "label": "RLSRestApi.get", - "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-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-post', + label: 'RLSRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/rlsrestapi-put", - "label": "RLSRestApi.put", - "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/recentactivity', + label: 'RecentActivity', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/recentactivityresponseschema", - "label": "RecentActivityResponseSchema", - "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/recentactivityschema', + label: 'RecentActivitySchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/relatedresponseschema", - "label": "RelatedResponseSchema", - "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/relatedresultresponse', + label: 'RelatedResultResponse', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/reportexecutionlogrestapi-get", - "label": "ReportExecutionLogRestApi.get", - "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-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-post', + label: 'ReportExecutionLogRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/reportexecutionlogrestapi-put", - "label": "ReportExecutionLogRestApi.put", - "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/reportrecipient', + label: 'ReportRecipient', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/reportrecipientconfigjson", - "label": "ReportRecipientConfigJSON", - "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', + 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-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-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-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-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-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', + 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-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', + 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-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-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-post', + label: 'ReportScheduleRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/reportschedulerestapi-put", - "label": "ReportScheduleRestApi.put", - "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/resource', + label: 'Resource', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/rlsrule", - "label": "RlsRule", - "className": "schema" + type: 'doc', + id: 'api/schemas/rlsrule', + label: 'RlsRule', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/rolegroupputschema", - "label": "RoleGroupPutSchema", - "className": "schema" + type: 'doc', + id: 'api/schemas/rolegroupputschema', + label: 'RoleGroupPutSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/rolepermissionlistschema", - "label": "RolePermissionListSchema", - "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/rolepermissionpostschema', + label: 'RolePermissionPostSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/roleresponseschema", - "label": "RoleResponseSchema", - "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/roleuserputschema', + label: 'RoleUserPutSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/roles", - "label": "Roles", - "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/roles-1', + label: 'Roles1', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/rolesresponseschema", - "label": "RolesResponseSchema", - "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/sqllabbootstrapschema', + label: 'SQLLabBootstrapSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/savedqueryrestapi-get", - "label": "SavedQueryRestApi.get", - "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-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', + 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-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', + 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-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-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', + 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-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-post', + label: 'SavedQueryRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/savedqueryrestapi-put", - "label": "SavedQueryRestApi.put", - "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/schemasresponseschema', + label: 'SchemasResponseSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/selectstarresponseschema", - "label": "SelectStarResponseSchema", - "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/slice', + label: 'Slice', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/sqllabpermalinkschema", - "label": "SqlLabPermalinkSchema", - "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/stopqueryschema', + label: 'StopQuerySchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/supersetroleapi-get", - "label": "SupersetRoleApi.get", - "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-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-post', + label: 'SupersetRoleApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/supersetroleapi-put", - "label": "SupersetRoleApi.put", - "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', + label: 'SupersetUserApi.get', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/supersetuserapi-get-group", - "label": "SupersetUserApi.get.Group", - "className": "schema" + type: 'doc', + id: 'api/schemas/supersetuserapi-get-group', + label: 'SupersetUserApi.get.Group', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/supersetuserapi-get-role", - "label": "SupersetUserApi.get.Role", - "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', + 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-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', + label: 'SupersetUserApi.get_list', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/supersetuserapi-get-list-group", - "label": "SupersetUserApi.get_list.Group", - "className": "schema" + type: 'doc', + id: 'api/schemas/supersetuserapi-get-list-group', + label: 'SupersetUserApi.get_list.Group', + 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-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', + 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-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-post', + label: 'SupersetUserApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/supersetuserapi-put", - "label": "SupersetUserApi.put", - "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/tab', + label: 'Tab', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/tabstate", - "label": "TabState", - "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/table', + label: 'Table', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/tableextrametadataresponseschema", - "label": "TableExtraMetadataResponseSchema", - "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/tablemetadatacolumnsresponse', + label: 'TableMetadataColumnsResponse', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/tablemetadataforeignkeysindexesresponse", - "label": "TableMetadataForeignKeysIndexesResponse", - "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/tablemetadataoptionsresponse', + label: 'TableMetadataOptionsResponse', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/tablemetadataprimarykeyresponse", - "label": "TableMetadataPrimaryKeyResponse", - "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/tablemetadataresponseschema', + label: 'TableMetadataResponseSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/tables", - "label": "Tables", - "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/tabspayloadschema', + label: 'TabsPayloadSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/tag", - "label": "Tag", - "className": "schema" + type: 'doc', + id: 'api/schemas/tag', + label: 'Tag', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/tag-1", - "label": "Tag1", - "className": "schema" + type: 'doc', + id: 'api/schemas/tag-1', + label: 'Tag1', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/taggetresponseschema", - "label": "TagGetResponseSchema", - "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/tagobject', + label: 'TagObject', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/tagpostbulkresponseobject", - "label": "TagPostBulkResponseObject", - "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/tagpostbulkresponseschema', + label: 'TagPostBulkResponseSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/tagpostbulkschema", - "label": "TagPostBulkSchema", - "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', + 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', + 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-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', + 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', + 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-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-post', + label: 'TagRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/tagrestapi-put", - "label": "TagRestApi.put", - "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/taggedobjectentityresponseschema', + label: 'TaggedObjectEntityResponseSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/temporarycachepostschema", - "label": "TemporaryCachePostSchema", - "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/temporarycacheputschema', + label: 'TemporaryCachePutSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/theme", - "label": "Theme", - "className": "schema" + type: 'doc', + id: 'api/schemas/theme', + label: 'Theme', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/themerestapi-get", - "label": "ThemeRestApi.get", - "className": "schema" + type: 'doc', + id: 'api/schemas/themerestapi-get', + label: 'ThemeRestApi.get', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/themerestapi-get-user", - "label": "ThemeRestApi.get.User", - "className": "schema" + type: 'doc', + id: 'api/schemas/themerestapi-get-user', + label: 'ThemeRestApi.get.User', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/themerestapi-get-user-1", - "label": "ThemeRestApi.get.User1", - "className": "schema" + type: 'doc', + id: 'api/schemas/themerestapi-get-user-1', + label: 'ThemeRestApi.get.User1', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/themerestapi-get-list", - "label": "ThemeRestApi.get_list", - "className": "schema" + type: 'doc', + id: 'api/schemas/themerestapi-get-list', + label: 'ThemeRestApi.get_list', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/themerestapi-get-list-user", - "label": "ThemeRestApi.get_list.User", - "className": "schema" + type: 'doc', + id: 'api/schemas/themerestapi-get-list-user', + label: 'ThemeRestApi.get_list.User', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/themerestapi-get-list-user-1", - "label": "ThemeRestApi.get_list.User1", - "className": "schema" + type: 'doc', + id: 'api/schemas/themerestapi-get-list-user-1', + label: 'ThemeRestApi.get_list.User1', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/themerestapi-post", - "label": "ThemeRestApi.post", - "className": "schema" + type: 'doc', + id: 'api/schemas/themerestapi-post', + label: 'ThemeRestApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/themerestapi-put", - "label": "ThemeRestApi.put", - "className": "schema" + type: 'doc', + id: 'api/schemas/themerestapi-put', + label: 'ThemeRestApi.put', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/uploadfilemetadata", - "label": "UploadFileMetadata", - "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/uploadfilemetadataitem', + label: 'UploadFileMetadataItem', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/uploadfilemetadatapostschema", - "label": "UploadFileMetadataPostSchema", - "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/uploadpostschema', + label: 'UploadPostSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/user", - "label": "User", - "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-1', + label: 'User1', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/user-2", - "label": "User2", - "className": "schema" + type: 'doc', + id: 'api/schemas/user-2', + label: 'User2', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/user-3", - "label": "User3", - "className": "schema" + type: 'doc', + id: 'api/schemas/user-3', + label: 'User3', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/userregistrationsrestapi-get", - "label": "UserRegistrationsRestAPI.get", - "className": "schema" + type: 'doc', + id: 'api/schemas/userregistrationsrestapi-get', + label: 'UserRegistrationsRestAPI.get', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/userregistrationsrestapi-get-list", - "label": "UserRegistrationsRestAPI.get_list", - "className": "schema" + type: 'doc', + id: 'api/schemas/userregistrationsrestapi-get-list', + label: 'UserRegistrationsRestAPI.get_list', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/userregistrationsrestapi-post", - "label": "UserRegistrationsRestAPI.post", - "className": "schema" + type: 'doc', + id: 'api/schemas/userregistrationsrestapi-post', + label: 'UserRegistrationsRestAPI.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/userregistrationsrestapi-put", - "label": "UserRegistrationsRestAPI.put", - "className": "schema" + type: 'doc', + id: 'api/schemas/userregistrationsrestapi-put', + label: 'UserRegistrationsRestAPI.put', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/userresponseschema", - "label": "UserResponseSchema", - "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/validatesqlrequest', + label: 'ValidateSQLRequest', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/validatesqlresponse", - "label": "ValidateSQLResponse", - "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/validatorconfigjson', + label: 'ValidatorConfigJSON', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/viewmenuapi-get", - "label": "ViewMenuApi.get", - "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-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-post', + label: 'ViewMenuApi.post', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/viewmenuapi-put", - "label": "ViewMenuApi.put", - "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/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-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-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/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/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-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-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-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-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-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-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-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/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/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/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/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/thumbnail-query-schema', + label: 'thumbnail_query_schema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/dashboardnativefiltersconfigupdateschema", - "label": "DashboardNativeFiltersConfigUpdateSchema", - "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/dashboardcolorsconfigupdateschema', + label: 'DashboardColorsConfigUpdateSchema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/get-slack-channels-schema", - "label": "get_slack_channels_schema", - "className": "schema" + type: 'doc', + id: 'api/schemas/get-slack-channels-schema', + label: 'get_slack_channels_schema', + className: 'schema', }, { - "type": "doc", - "id": "api/schemas/dashboardchartcustomizationsconfigupdateschema", - "label": "DashboardChartCustomizationsConfigUpdateSchema", - "className": "schema" - } + type: 'doc', + id: 'api/schemas/dashboardchartcustomizationsconfigupdateschema', + label: 'DashboardChartCustomizationsConfigUpdateSchema', + className: 'schema', + }, ], - "key": "api-category-schemas" - } - ] + 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 index 7982bddc7b0..fcfd96af1d9 100644 --- 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 @@ -1,4302 +1,4332 @@ -import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; +import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; const sidebar: SidebarsConfig = { apisidebar: [ { - type: "category", - label: "Advanced Data Type", + type: 'category', + label: 'Advanced Data Type', link: { - type: "doc", - id: "api/advanced-data-type", + 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-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: '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", + type: 'category', + label: 'Annotation Layers', link: { - type: "doc", - id: "api/annotation-layers", + 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/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/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/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-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/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/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/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/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/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/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/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/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/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: '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", + type: 'category', + label: 'AsyncEventsRestApi', link: { - type: "doc", - id: "api/async-events-rest-api", + 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: '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", + type: 'category', + label: 'Available Domains', link: { - type: "doc", - id: "api/available-domains", + 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: 'doc', + id: 'api/get-all-available-domains', + label: 'Get all available domains', + className: 'api-method get', }, ], }, { - type: "category", - label: "CSS Templates", + type: 'category', + label: 'CSS Templates', link: { - type: "doc", - id: "api/css-templates", + 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/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/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/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-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/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/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/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: 'doc', + id: 'api/update-a-css-template', + label: 'Update a CSS template', + className: 'api-method put', }, ], }, { - type: "category", - label: "CacheRestApi", + type: 'category', + label: 'CacheRestApi', link: { - type: "doc", - id: "api/cache-rest-api", + 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: '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", + type: 'category', + label: 'Charts', link: { - type: "doc", - id: "api/charts", + 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/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/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/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/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', + 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/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/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/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/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/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/warm-up-the-cache-for-the-chart', + label: 'Warm up the cache for the chart', + className: 'api-method put', }, { - type: "doc", - id: "api/get-a-chart-detail-information", - label: "Get a chart detail information", - className: "api-method get", + type: 'doc', + id: 'api/get-a-chart-detail-information', + label: 'Get a chart detail information', + className: 'api-method get', }, { - type: "doc", - id: "api/delete-a-chart", - label: "Delete a chart", - className: "api-method delete", + type: 'doc', + id: 'api/delete-a-chart', + label: 'Delete a chart', + className: 'api-method delete', }, { - type: "doc", - id: "api/update-a-chart", - label: "Update a chart", - className: "api-method put", + 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/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/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/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/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-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: 'doc', + id: 'api/get-chart-thumbnail', + label: 'Get chart thumbnail', + className: 'api-method get', }, ], }, { - type: "category", - label: "Current User", + type: 'category', + label: 'Current User', link: { - type: "doc", - id: "api/current-user", + 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-object', + label: 'Get the user object', + className: 'api-method get', }, { - type: "doc", - id: "api/update-the-current-user", - label: "Update the current user", - className: "api-method put", + type: 'doc', + id: 'api/update-the-current-user', + label: 'Update the current user', + className: 'api-method put', }, { - type: "doc", - id: "api/get-the-user-roles", - label: "Get the user roles", - 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", + type: 'category', + label: 'Dashboard Filter State', link: { - type: "doc", - id: "api/dashboard-filter-state", + type: 'doc', + id: 'api/dashboard-filter-state', }, collapsible: true, collapsed: true, items: [ { - type: "doc", - id: "api/create-a-dashboards-filter-state", + type: 'doc', + id: 'api/create-a-dashboards-filter-state', label: "Create a dashboard's filter state", - className: "api-method post", + className: 'api-method post', }, { - type: "doc", - id: "api/delete-a-dashboards-filter-state-value", + type: 'doc', + id: 'api/delete-a-dashboards-filter-state-value', label: "Delete a dashboard's filter state value", - className: "api-method delete", + className: 'api-method delete', }, { - type: "doc", - id: "api/get-a-dashboards-filter-state-value", + type: 'doc', + id: 'api/get-a-dashboards-filter-state-value', label: "Get a dashboard's filter state value", - className: "api-method get", + className: 'api-method get', }, { - type: "doc", - id: "api/update-a-dashboards-filter-state-value", + type: 'doc', + id: 'api/update-a-dashboards-filter-state-value', label: "Update a dashboard's filter state value", - className: "api-method put", + className: 'api-method put', }, ], }, { - type: "category", - label: "Dashboard Permanent Link", + type: 'category', + label: 'Dashboard Permanent Link', link: { - type: "doc", - id: "api/dashboard-permanent-link", + type: 'doc', + id: 'api/dashboard-permanent-link', }, collapsible: true, collapsed: true, items: [ { - type: "doc", - id: "api/get-dashboards-permanent-link-state", + type: 'doc', + id: 'api/get-dashboards-permanent-link-state', label: "Get dashboard's permanent link state", - className: "api-method get", + className: 'api-method get', }, { - type: "doc", - id: "api/create-a-new-dashboards-permanent-link", + type: 'doc', + id: 'api/create-a-new-dashboards-permanent-link', label: "Create a new dashboard's permanent link", - className: "api-method post", + className: 'api-method post', }, ], }, { - type: "category", - label: "Dashboards", + type: 'category', + label: 'Dashboards', link: { - type: "doc", - id: "api/dashboards", + 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/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/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/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/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/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/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/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-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-dashboard-detail-information', + label: 'Get a dashboard detail information', + className: 'api-method get', }, { - type: "doc", - id: "api/get-a-dashboards-chart-definitions", + type: 'doc', + id: 'api/get-a-dashboards-chart-definitions', label: "Get a dashboard's chart definitions.", - className: "api-method get", + 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/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", + type: 'doc', + id: 'api/get-dashboards-datasets', label: "Get dashboard's datasets", - className: "api-method get", + className: 'api-method get', }, { - type: "doc", - id: "api/delete-a-dashboards-embedded-configuration", + type: 'doc', + id: 'api/delete-a-dashboards-embedded-configuration', label: "Delete a dashboard's embedded configuration", - className: "api-method delete", + className: 'api-method delete', }, { - type: "doc", - id: "api/get-the-dashboards-embedded-configuration", + type: 'doc', + id: 'api/get-the-dashboards-embedded-configuration', label: "Get the dashboard's embedded configuration", - className: "api-method get", + className: 'api-method get', }, { - type: "doc", - id: "api/set-a-dashboards-embedded-configuration", + type: 'doc', + id: 'api/set-a-dashboards-embedded-configuration', label: "Set a dashboard's embedded configuration", - className: "api-method post", + 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/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", + type: 'doc', + id: 'api/get-dashboards-tabs', label: "Get dashboard's tabs", - className: "api-method get", + className: 'api-method get', }, { - type: "doc", - id: "api/delete-a-dashboard", - label: "Delete a dashboard", - className: "api-method delete", + 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/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/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-chart-customizations-configuration-for-a-dashboard", - label: "Update chart customizations configuration for a dashboard.", - className: "api-method put", + type: 'doc', + id: 'api/update-chart-customizations-configuration-for-a-dashboard', + label: 'Update chart customizations configuration for a dashboard.', + className: 'api-method put', }, { - 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/update-colors-configuration-for-a-dashboard', + label: 'Update colors configuration for a dashboard.', + className: 'api-method put', }, { - type: "doc", - id: "api/export-dashboard-as-example-bundle", - label: "Export dashboard as example bundle", - className: "api-method get", + type: 'doc', + id: 'api/export-dashboard-as-example-bundle', + label: 'Export dashboard as example bundle', + className: 'api-method get', }, { - 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/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/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/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-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", + type: 'doc', + id: 'api/get-dashboards-thumbnail', label: "Get dashboard's thumbnail", - className: "api-method get", + className: 'api-method get', }, ], }, { - type: "category", - label: "Database", + type: 'category', + label: 'Database', link: { - type: "doc", - id: "api/database", + 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/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/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-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/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/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/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/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/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/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/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/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/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/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/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-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-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-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-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/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/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', + 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/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/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/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-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-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-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-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/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/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: 'doc', + id: 'api/validate-arbitrary-sql', + label: 'Validate arbitrary SQL', + className: 'api-method post', }, ], }, { - type: "category", - label: "Datasets", + type: 'category', + label: 'Datasets', link: { - type: "doc", - id: "api/datasets", + 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/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/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/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-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/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/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/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/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/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/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/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/get-a-dataset", - label: "Get a dataset", - className: "api-method get", + type: 'doc', + id: 'api/get-a-dataset', + label: 'Get a dataset', + className: 'api-method get', }, { - 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: '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: "doc", - id: "api/delete-a-dataset", - label: "Delete a dataset", - className: "api-method delete", + type: 'doc', + id: 'api/delete-a-dataset', + label: 'Delete a dataset', + className: 'api-method delete', }, { - type: "doc", - id: "api/update-a-dataset", - label: "Update a dataset", - className: "api-method put", + 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-column', + label: 'Delete a dataset column', + className: 'api-method delete', }, { - type: "doc", - id: "api/get-dataset-drill-info", - label: "Get dataset drill info", - className: "api-method get", + type: 'doc', + id: 'api/get-dataset-drill-info', + label: 'Get dataset drill info', + className: 'api-method get', }, { - type: "doc", - id: "api/delete-a-dataset-metric", - label: "Delete a dataset metric", - 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/refresh-and-update-columns-of-a-dataset', + label: 'Refresh and update columns of a dataset', + className: 'api-method put', }, ], }, { - type: "category", - label: "Datasources", + type: 'category', + label: 'Datasources', link: { - type: "doc", - id: "api/datasources", + 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: 'doc', + id: 'api/get-possible-values-for-a-datasource-column', + label: 'Get possible values for a datasource column', + className: 'api-method get', }, { - type: "doc", - id: "api/validate-a-sql-expression-against-a-datasource", - label: "Validate a SQL expression against a datasource", - className: "api-method post", + type: 'doc', + id: 'api/validate-a-sql-expression-against-a-datasource', + label: 'Validate a SQL expression against a datasource', + className: 'api-method post', }, ], }, { - type: "category", - label: "Embedded Dashboard", + type: 'category', + label: 'Embedded Dashboard', link: { - type: "doc", - id: "api/embedded-dashboard", + 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: '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", + type: 'category', + label: 'Explore', link: { - type: "doc", - id: "api/explore", + 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: '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", + type: 'category', + label: 'Explore Form Data', link: { - type: "doc", - id: "api/explore-form-data", + 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/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/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/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: 'doc', + id: 'api/update-an-existing-form-data', + label: 'Update an existing form_data', + className: 'api-method put', }, ], }, { - type: "category", - label: "Explore Permanent Link", + type: 'category', + label: 'Explore Permanent Link', link: { - type: "doc", - id: "api/explore-permanent-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/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", + type: 'doc', + id: 'api/get-charts-permanent-link-state', label: "Get chart's permanent link state", - className: "api-method get", + className: 'api-method get', }, ], }, { - type: "category", - label: "Import/export", + type: 'category', + label: 'Import/export', link: { - type: "doc", - id: "api/import-export", + 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/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: 'doc', + id: 'api/import-multiple-assets', + label: 'Import multiple assets', + className: 'api-method post', }, ], }, { - type: "category", - label: "LogRestApi", + type: 'category', + label: 'LogRestApi', link: { - type: "doc", - id: "api/log-rest-api", + 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/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/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-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: 'doc', + id: 'api/get-a-log-detail-information', + label: 'Get a log detail information', + className: 'api-method get', }, ], }, { - type: "category", - label: "Menu", + type: 'category', + label: 'Menu', link: { - type: "doc", - id: "api/menu", + type: 'doc', + id: 'api/menu', }, collapsible: true, collapsed: true, items: [ { - type: "doc", - id: "api/get-menu", - label: "Get menu", - className: "api-method get", + type: 'doc', + id: 'api/get-menu', + label: 'Get menu', + className: 'api-method get', }, ], }, { - type: "category", - label: "OpenApi", + type: 'category', + label: 'OpenApi', link: { - type: "doc", - id: "api/open-api", + 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: 'doc', + id: 'api/get-api-by-version-openapi', + label: 'Get api by version openapi', + className: 'api-method get', }, ], }, { - type: "category", - label: "Queries", + type: 'category', + label: 'Queries', link: { - type: "doc", - id: "api/queries", + 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-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-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/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/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-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/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/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/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/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-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/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/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/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/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/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/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: 'doc', + id: 'api/update-a-saved-query', + label: 'Update a saved query', + className: 'api-method put', }, ], }, { - type: "category", - label: "Report Schedules", + type: 'category', + label: 'Report Schedules', link: { - type: "doc", - id: "api/report-schedules", + 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/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/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/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-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-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/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/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/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/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-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: '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", + type: 'category', + label: 'Row Level Security', link: { - type: "doc", - id: "api/row-level-security", + 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/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/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/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-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/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/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/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: 'doc', + id: 'api/update-an-rls-rule', + label: 'Update an RLS rule', + className: 'api-method put', }, ], }, { - type: "category", - label: "SQL Lab", + type: 'category', + label: 'SQL Lab', link: { - type: "doc", - id: "api/sql-lab", + 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/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/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/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/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/export-sql-query-results-to-csv-with-streaming", - label: "Export SQL query results to CSV with streaming", - className: "api-method post", + type: 'doc', + id: 'api/export-sql-query-results-to-csv-with-streaming', + label: 'Export SQL query results to CSV with streaming', + className: 'api-method post', }, { - type: "doc", - id: "api/format-sql-code", - label: "Format SQL code", - className: "api-method post", + 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: '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", + type: 'category', + label: 'SQL Lab Permanent Link', link: { - type: "doc", - id: "api/sql-lab-permanent-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/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: '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", + type: 'category', + label: 'Security', link: { - type: "doc", - id: "api/security", + 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-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/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-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: 'doc', + id: 'api/create-security-refresh', + label: 'Create security refresh', + className: 'api-method post', }, ], }, { - type: "category", - label: "Security Groups", + type: 'category', + label: 'Security Groups', link: { - type: "doc", - id: "api/security-groups", + type: 'doc', + id: 'api/security-groups', }, collapsible: true, collapsed: true, items: [ { - type: "doc", - id: "api/get-security-groups", - label: "Get security groups", - className: "api-method get", + type: 'doc', + id: 'api/get-security-groups', + label: 'Get security groups', + className: 'api-method get', }, { - type: "doc", - id: "api/create-security-groups", - label: "Create security groups", - className: "api-method post", + type: 'doc', + id: 'api/create-security-groups', + label: 'Create security groups', + className: 'api-method post', }, { - type: "doc", - id: "api/get-security-groups-info", - label: "Get security groups info", - className: "api-method get", + type: 'doc', + id: 'api/get-security-groups-info', + label: 'Get security groups info', + className: 'api-method get', }, { - type: "doc", - id: "api/delete-security-groups-by-pk", - label: "Delete security groups by pk", - className: "api-method delete", + type: 'doc', + id: 'api/delete-security-groups-by-pk', + label: 'Delete security groups by pk', + className: 'api-method delete', }, { - type: "doc", - id: "api/get-security-groups-by-pk", - label: "Get security groups by pk", - className: "api-method get", + type: 'doc', + id: 'api/get-security-groups-by-pk', + label: 'Get security groups by pk', + className: 'api-method get', }, { - type: "doc", - id: "api/update-security-groups-by-pk", - label: "Update security groups by pk", - className: "api-method put", + type: 'doc', + id: 'api/update-security-groups-by-pk', + label: 'Update security groups by pk', + className: 'api-method put', }, ], }, { - type: "category", - label: "Security Permissions", + type: 'category', + label: 'Security Permissions', link: { - type: "doc", - id: "api/security-permissions", + 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', + 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-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: '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)", + type: 'category', + label: 'Security Permissions on Resources (View Menus)', link: { - type: "doc", - id: "api/security-permissions-on-resources-view-menus", + 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/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/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/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/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/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: '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)", + type: 'category', + label: 'Security Resources (View Menus)', link: { - type: "doc", - id: "api/security-resources-view-menus", + 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/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/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/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/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/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: 'doc', + id: 'api/update-security-resources-by-pk', + label: 'Update security resources by pk', + className: 'api-method put', }, ], }, { - type: "category", - label: "Security Roles", + type: 'category', + label: 'Security Roles', link: { - type: "doc", - id: "api/security-roles", + 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/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/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/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/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/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/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/update-security-roles-by-pk', + label: 'Update security roles by pk', + className: 'api-method put', }, { - type: "doc", - id: "api/update-security-roles-by-role-id-groups", - label: "Update security roles by role_id groups", - className: "api-method put", + type: 'doc', + id: 'api/update-security-roles-by-role-id-groups', + label: 'Update security roles by role_id groups', + 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/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/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: '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", + type: 'category', + label: 'Security Users', link: { - type: "doc", - id: "api/security-users", + 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/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/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/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/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/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: 'doc', + id: 'api/update-security-users-by-pk', + label: 'Update security users by pk', + className: 'api-method put', }, ], }, { - type: "category", - label: "Tags", + type: 'category', + label: 'Tags', link: { - type: "doc", - id: "api/tags", + 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/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/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/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/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/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-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-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/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/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-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/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/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/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/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: 'doc', + id: 'api/create-tag-by-pk-favorites', + label: 'Create tag by pk favorites', + className: 'api-method post', }, ], }, { - type: "category", - label: "Themes", + type: 'category', + label: 'Themes', link: { - type: "doc", - id: "api/themes", + type: 'doc', + id: 'api/themes', }, collapsible: true, collapsed: true, items: [ { - type: "doc", - id: "api/bulk-delete-themes", - label: "Bulk delete themes", - className: "api-method delete", + type: 'doc', + id: 'api/bulk-delete-themes', + label: 'Bulk delete themes', + className: 'api-method delete', }, { - type: "doc", - id: "api/get-a-list-of-themes", - label: "Get a list of themes", - className: "api-method get", + type: 'doc', + id: 'api/get-a-list-of-themes', + label: 'Get a list of themes', + className: 'api-method get', }, { - type: "doc", - id: "api/create-a-theme", - label: "Create a theme", - className: "api-method post", + type: 'doc', + id: 'api/create-a-theme', + label: 'Create a theme', + className: 'api-method post', }, { - type: "doc", - id: "api/get-metadata-information-about-this-api-resource-theme-info", - label: "Get metadata information about this API resource (theme--info)", - className: "api-method get", + type: 'doc', + id: 'api/get-metadata-information-about-this-api-resource-theme-info', + label: + 'Get metadata information about this API resource (theme--info)', + className: 'api-method get', }, { - type: "doc", - id: "api/download-multiple-themes-as-yaml-files", - label: "Download multiple themes as YAML files", - className: "api-method get", + type: 'doc', + id: 'api/download-multiple-themes-as-yaml-files', + label: 'Download multiple themes as YAML files', + className: 'api-method get', }, { - type: "doc", - id: "api/import-themes-from-a-zip-file", - label: "Import themes from a ZIP file", - className: "api-method post", + type: 'doc', + id: 'api/import-themes-from-a-zip-file', + label: 'Import themes from a ZIP file', + className: 'api-method post', }, { - type: "doc", - id: "api/get-related-fields-data-theme-related-column-name", - label: "Get related fields data (theme-related-column-name)", - className: "api-method get", + type: 'doc', + id: 'api/get-related-fields-data-theme-related-column-name', + label: 'Get related fields data (theme-related-column-name)', + className: 'api-method get', }, { - type: "doc", - id: "api/clear-the-system-dark-theme", - label: "Clear the system dark theme", - className: "api-method delete", + type: 'doc', + id: 'api/clear-the-system-dark-theme', + label: 'Clear the system dark theme', + className: 'api-method delete', }, { - type: "doc", - id: "api/clear-the-system-default-theme", - label: "Clear the system default theme", - className: "api-method delete", + type: 'doc', + id: 'api/clear-the-system-default-theme', + label: 'Clear the system default theme', + className: 'api-method delete', }, { - type: "doc", - id: "api/delete-a-theme", - label: "Delete a theme", - className: "api-method delete", + type: 'doc', + id: 'api/delete-a-theme', + label: 'Delete a theme', + className: 'api-method delete', }, { - type: "doc", - id: "api/get-a-theme", - label: "Get a theme", - className: "api-method get", + type: 'doc', + id: 'api/get-a-theme', + label: 'Get a theme', + className: 'api-method get', }, { - type: "doc", - id: "api/update-a-theme", - label: "Update a theme", - className: "api-method put", + type: 'doc', + id: 'api/update-a-theme', + label: 'Update a theme', + className: 'api-method put', }, { - type: "doc", - id: "api/set-a-theme-as-the-system-dark-theme", - label: "Set a theme as the system dark theme", - className: "api-method put", + type: 'doc', + id: 'api/set-a-theme-as-the-system-dark-theme', + label: 'Set a theme as the system dark theme', + className: 'api-method put', }, { - type: "doc", - id: "api/set-a-theme-as-the-system-default-theme", - label: "Set a theme as the system default theme", - className: "api-method put", + type: 'doc', + id: 'api/set-a-theme-as-the-system-default-theme', + label: 'Set a theme as the system default theme', + className: 'api-method put', }, ], }, { - type: "category", - label: "User", + type: 'category', + label: 'User', link: { - type: "doc", - id: "api/user", + 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: 'doc', + id: 'api/get-the-user-avatar', + label: 'Get the user avatar', + className: 'api-method get', }, ], }, { - type: "category", - label: "UserRegistrationsRestAPI", + type: 'category', + label: 'UserRegistrationsRestAPI', link: { - type: "doc", - id: "api/user-registrations-rest-api", + type: 'doc', + id: 'api/user-registrations-rest-api', }, collapsible: true, collapsed: true, items: [ { - type: "doc", - id: "api/get-security-user-registrations", - label: "Get security user registrations", - className: "api-method get", + type: 'doc', + id: 'api/get-security-user-registrations', + label: 'Get security user registrations', + className: 'api-method get', }, { - type: "doc", - id: "api/create-security-user-registrations", - label: "Create security user registrations", - className: "api-method post", + type: 'doc', + id: 'api/create-security-user-registrations', + label: 'Create security user registrations', + className: 'api-method post', }, { - type: "doc", - id: "api/get-security-user-registrations-info", - label: "Get security user registrations info", - className: "api-method get", + type: 'doc', + id: 'api/get-security-user-registrations-info', + label: 'Get security user registrations info', + className: 'api-method get', }, { - type: "doc", - id: "api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name", - label: "Get distinct values from field data (security-user-registrations-distinct-column-name)", - className: "api-method get", + type: 'doc', + id: 'api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name', + label: + 'Get distinct values from field data (security-user-registrations-distinct-column-name)', + className: 'api-method get', }, { - type: "doc", - id: "api/get-related-fields-data-security-user-registrations-related-column-name", - label: "Get related fields data (security-user-registrations-related-column-name)", - className: "api-method get", + type: 'doc', + id: 'api/get-related-fields-data-security-user-registrations-related-column-name', + label: + 'Get related fields data (security-user-registrations-related-column-name)', + className: 'api-method get', }, { - type: "doc", - id: "api/delete-security-user-registrations-by-pk", - label: "Delete security user registrations by pk", - className: "api-method delete", + type: 'doc', + id: 'api/delete-security-user-registrations-by-pk', + label: 'Delete security user registrations by pk', + className: 'api-method delete', }, { - type: "doc", - id: "api/get-security-user-registrations-by-pk", - label: "Get security user registrations by pk", - className: "api-method get", + type: 'doc', + id: 'api/get-security-user-registrations-by-pk', + label: 'Get security user registrations by pk', + className: 'api-method get', }, { - type: "doc", - id: "api/update-security-user-registrations-by-pk", - label: "Update security user registrations by pk", - className: "api-method put", + type: 'doc', + id: 'api/update-security-user-registrations-by-pk', + label: 'Update security user registrations by pk', + className: 'api-method put', }, ], }, { - type: "category", - label: "Schemas", + type: 'category', + label: 'Schemas', collapsible: true, collapsed: true, items: [ { - type: "doc", - id: "api/schemas/advanceddatatypeschema", - label: "AdvancedDataTypeSchema", - className: "schema", + 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/annotationlayer', + label: 'AnnotationLayer', + className: 'schema', }, { - type: "doc", - id: "api/schemas/annotationlayerrestapi-get", - label: "AnnotationLayerRestApi.get", - 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', + 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', + 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-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-post', + label: 'AnnotationLayerRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/annotationlayerrestapi-put", - label: "AnnotationLayerRestApi.put", - 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', + 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-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', + 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', + 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-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-post', + label: 'AnnotationRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/annotationrestapi-put", - label: "AnnotationRestApi.put", - 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/availabledomainsschema', + label: 'AvailableDomainsSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/cacheinvalidationrequestschema", - label: "CacheInvalidationRequestSchema", - 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', + 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-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-post', + label: 'CacheRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/cacherestapi-put", - label: "CacheRestApi.put", - 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/catalogsresponseschema', + label: 'CatalogsResponseSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartcachescreenshotresponseschema", - label: "ChartCacheScreenshotResponseSchema", - 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/chartcachewarmuprequestschema', + label: 'ChartCacheWarmUpRequestSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartcachewarmupresponseschema", - label: "ChartCacheWarmUpResponseSchema", - 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/chartcachewarmupresponsesingle', + label: 'ChartCacheWarmUpResponseSingle', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdataadhocmetricschema", - label: "ChartDataAdhocMetricSchema", - 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/chartdataaggregateoptionsschema', + label: 'ChartDataAggregateOptionsSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdataasyncresponseschema", - label: "ChartDataAsyncResponseSchema", - 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/chartdataboxplotoptionsschema', + label: 'ChartDataBoxplotOptionsSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdatacolumn", - label: "ChartDataColumn", - 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/chartdatacontributionoptionsschema', + label: 'ChartDataContributionOptionsSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdatadatasource", - label: "ChartDataDatasource", - 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/chartdataextras', + label: 'ChartDataExtras', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdatafilter", - label: "ChartDataFilter", - 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/chartdatageodeticparseoptionsschema', + label: 'ChartDataGeodeticParseOptionsSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdatageohashdecodeoptionsschema", - label: "ChartDataGeohashDecodeOptionsSchema", - 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/chartdatageohashencodeoptionsschema', + label: 'ChartDataGeohashEncodeOptionsSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdatapivotoptionsschema", - label: "ChartDataPivotOptionsSchema", - 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/chartdatapostprocessingoperation', + label: 'ChartDataPostProcessingOperation', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdataprophetoptionsschema", - label: "ChartDataProphetOptionsSchema", - 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/chartdataquerycontextschema', + label: 'ChartDataQueryContextSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdataqueryobject", - label: "ChartDataQueryObject", - 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/chartdataresponseresult', + label: 'ChartDataResponseResult', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdataresponseschema", - label: "ChartDataResponseSchema", - 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', + label: 'ChartDataRestApi.get', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdatarestapi-get-list", - label: "ChartDataRestApi.get_list", - 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-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-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-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', + 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-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-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-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-post', + label: 'ChartDataRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdatarestapi-put", - label: "ChartDataRestApi.put", - 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/chartdatarollingoptionsschema', + label: 'ChartDataRollingOptionsSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartdataselectoptionsschema", - label: "ChartDataSelectOptionsSchema", - 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/chartdatasortoptionsschema', + label: 'ChartDataSortOptionsSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartentityresponseschema", - label: "ChartEntityResponseSchema", - 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/chartfavstarresponseresult', + label: 'ChartFavStarResponseResult', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartgetdatasourceobjectdataresponse", - label: "ChartGetDatasourceObjectDataResponse", - 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/chartgetdatasourceobjectresponse', + label: 'ChartGetDatasourceObjectResponse', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartgetdatasourceresponseschema", - label: "ChartGetDatasourceResponseSchema", - className: "schema", + type: 'doc', + id: 'api/schemas/chartgetdatasourceresponseschema', + label: 'ChartGetDatasourceResponseSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartgetresponseschema", - label: "ChartGetResponseSchema", - className: "schema", + type: 'doc', + id: 'api/schemas/chartgetresponseschema', + label: 'ChartGetResponseSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartrestapi-get", - label: "ChartRestApi.get", - className: "schema", + type: 'doc', + id: 'api/schemas/chartrestapi-get', + label: 'ChartRestApi.get', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartrestapi-get-list", - label: "ChartRestApi.get_list", - 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-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-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-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', + 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-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-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-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-post', + label: 'ChartRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/chartrestapi-put", - label: "ChartRestApi.put", - 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', + 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', + 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-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', + 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', + 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-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-post', + label: 'CssTemplateRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/csstemplaterestapi-put", - label: "CssTemplateRestApi.put", - className: "schema", + type: 'doc', + id: 'api/schemas/csstemplaterestapi-put', + label: 'CssTemplateRestApi.put', + className: 'schema', }, { - type: "doc", - id: "api/schemas/currentuserputschema", - label: "CurrentUserPutSchema", - className: "schema", + type: 'doc', + id: 'api/schemas/currentuserputschema', + label: 'CurrentUserPutSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/dashboard", - label: "Dashboard", - className: "schema", + type: 'doc', + id: 'api/schemas/dashboard', + label: 'Dashboard', + className: 'schema', }, { - type: "doc", - id: "api/schemas/dashboardcachescreenshotresponseschema", - label: "DashboardCacheScreenshotResponseSchema", - 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/dashboardcopyschema', + label: 'DashboardCopySchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/dashboarddatasetschema", - label: "DashboardDatasetSchema", - 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/dashboardgetresponseschema', + label: 'DashboardGetResponseSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/dashboardpermalinkstateschema", - label: "DashboardPermalinkStateSchema", - 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', + 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', + 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-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-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', + 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-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-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-post', + label: 'DashboardRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/dashboardrestapi-put", - label: "DashboardRestApi.put", - className: "schema", + type: 'doc', + id: 'api/schemas/dashboardrestapi-put', + label: 'DashboardRestApi.put', + className: 'schema', }, { - type: "doc", - id: "api/schemas/dashboardscreenshotpostschema", - label: "DashboardScreenshotPostSchema", - className: "schema", + type: 'doc', + id: 'api/schemas/dashboardscreenshotpostschema', + label: 'DashboardScreenshotPostSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/database", - label: "Database", - 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/database-1', + label: 'Database1', + className: 'schema', }, { - type: "doc", - id: "api/schemas/databaseconnectionschema", - label: "DatabaseConnectionSchema", - 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/databasefunctionnamesresponse', + label: 'DatabaseFunctionNamesResponse', + className: 'schema', }, { - type: "doc", - id: "api/schemas/databaserelatedchart", - label: "DatabaseRelatedChart", - 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/databaserelatedcharts', + label: 'DatabaseRelatedCharts', + className: 'schema', }, { - type: "doc", - id: "api/schemas/databaserelateddashboard", - label: "DatabaseRelatedDashboard", - 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/databaserelateddashboards', + label: 'DatabaseRelatedDashboards', + className: 'schema', }, { - type: "doc", - id: "api/schemas/databaserelatedobjectsresponse", - label: "DatabaseRelatedObjectsResponse", - 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', + 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', + 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', + 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-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-post', + label: 'DatabaseRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/databaserestapi-put", - label: "DatabaseRestApi.put", - 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/databasesshtunnel', + label: 'DatabaseSSHTunnel', + className: 'schema', }, { - type: "doc", - id: "api/schemas/databaseschemaaccessforfileuploadresponse", - label: "DatabaseSchemaAccessForFileUploadResponse", - 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/databasetablesresponse', + label: 'DatabaseTablesResponse', + className: 'schema', }, { - type: "doc", - id: "api/schemas/databasetestconnectionschema", - label: "DatabaseTestConnectionSchema", - 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/databasevalidateparametersschema', + label: 'DatabaseValidateParametersSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/dataset", - label: "Dataset", - 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/datasetcachewarmuprequestschema', + label: 'DatasetCacheWarmUpRequestSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/datasetcachewarmupresponseschema", - label: "DatasetCacheWarmUpResponseSchema", - 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/datasetcachewarmupresponsesingle', + label: 'DatasetCacheWarmUpResponseSingle', + className: 'schema', }, { - type: "doc", - id: "api/schemas/datasetcolumnsput", - label: "DatasetColumnsPut", - 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', + 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-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-post', + label: 'DatasetColumnsRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/datasetcolumnsrestapi-put", - label: "DatasetColumnsRestApi.put", - 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/datasetduplicateschema', + label: 'DatasetDuplicateSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/datasetmetriccurrencyput", - label: "DatasetMetricCurrencyPut", - className: "schema", + type: 'doc', + id: 'api/schemas/datasetmetriccurrencyput', + label: 'DatasetMetricCurrencyPut', + className: 'schema', }, { - type: "doc", - id: "api/schemas/datasetmetricrestapi-get", - label: "DatasetMetricRestApi.get", - 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-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-post', + label: 'DatasetMetricRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/datasetmetricrestapi-put", - label: "DatasetMetricRestApi.put", - 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/datasetmetricsput', + label: 'DatasetMetricsPut', + className: 'schema', }, { - type: "doc", - id: "api/schemas/datasetrelatedchart", - label: "DatasetRelatedChart", - 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/datasetrelatedcharts', + label: 'DatasetRelatedCharts', + className: 'schema', }, { - type: "doc", - id: "api/schemas/datasetrelateddashboard", - label: "DatasetRelatedDashboard", - 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/datasetrelateddashboards', + label: 'DatasetRelatedDashboards', + className: 'schema', }, { - type: "doc", - id: "api/schemas/datasetrelatedobjectsresponse", - label: "DatasetRelatedObjectsResponse", - 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', + 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-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-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-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', + 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-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-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', + 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-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', + 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-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-post', + label: 'DatasetRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/datasetrestapi-put", - label: "DatasetRestApi.put", - 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/datasource', + label: 'Datasource', + className: 'schema', }, { - type: "doc", - id: "api/schemas/distincresponseschema", - label: "DistincResponseSchema", - 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/distinctresultresponse', + label: 'DistinctResultResponse', + className: 'schema', }, { - type: "doc", - id: "api/schemas/embeddeddashboardconfig", - label: "EmbeddedDashboardConfig", - 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/embeddeddashboardresponseschema', + label: 'EmbeddedDashboardResponseSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/embeddeddashboardrestapi-get", - label: "EmbeddedDashboardRestApi.get", - 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-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-post', + label: 'EmbeddedDashboardRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/embeddeddashboardrestapi-put", - label: "EmbeddedDashboardRestApi.put", - 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/engineinformation', + label: 'EngineInformation', + className: 'schema', }, { - type: "doc", - id: "api/schemas/estimatequerycostschema", - label: "EstimateQueryCostSchema", - 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/executepayloadschema', + label: 'ExecutePayloadSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/explorecontextschema", - label: "ExploreContextSchema", - 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/explorepermalinkstateschema', + label: 'ExplorePermalinkStateSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/folder", - label: "Folder", - 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/formdatapostschema', + label: 'FormDataPostSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/formdataputschema", - label: "FormDataPutSchema", - className: "schema", + type: 'doc', + id: 'api/schemas/formdataputschema', + label: 'FormDataPutSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/formatquerypayloadschema", - label: "FormatQueryPayloadSchema", - className: "schema", + type: 'doc', + id: 'api/schemas/formatquerypayloadschema', + label: 'FormatQueryPayloadSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/getfavstaridsschema", - label: "GetFavStarIdsSchema", - 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/getorcreatedatasetschema', + label: 'GetOrCreateDatasetSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/groupapi-get", - label: "GroupApi.get", - className: "schema", + type: 'doc', + id: 'api/schemas/groupapi-get', + label: 'GroupApi.get', + className: 'schema', }, { - type: "doc", - id: "api/schemas/groupapi-get-role", - label: "GroupApi.get.Role", - className: "schema", + type: 'doc', + id: 'api/schemas/groupapi-get-role', + label: 'GroupApi.get.Role', + className: 'schema', }, { - type: "doc", - id: "api/schemas/groupapi-get-user", - label: "GroupApi.get.User", - className: "schema", + type: 'doc', + id: 'api/schemas/groupapi-get-user', + label: 'GroupApi.get.User', + className: 'schema', }, { - type: "doc", - id: "api/schemas/groupapi-get-list", - label: "GroupApi.get_list", - className: "schema", + type: 'doc', + id: 'api/schemas/groupapi-get-list', + label: 'GroupApi.get_list', + className: 'schema', }, { - type: "doc", - id: "api/schemas/groupapi-get-list-role", - label: "GroupApi.get_list.Role", - className: "schema", + type: 'doc', + id: 'api/schemas/groupapi-get-list-role', + label: 'GroupApi.get_list.Role', + className: 'schema', }, { - type: "doc", - id: "api/schemas/groupapi-get-list-user", - label: "GroupApi.get_list.User", - className: "schema", + type: 'doc', + id: 'api/schemas/groupapi-get-list-user', + label: 'GroupApi.get_list.User', + className: 'schema', }, { - type: "doc", - id: "api/schemas/groupapi-post", - label: "GroupApi.post", - className: "schema", + type: 'doc', + id: 'api/schemas/groupapi-post', + label: 'GroupApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/groupapi-put", - label: "GroupApi.put", - className: "schema", + type: 'doc', + id: 'api/schemas/groupapi-put', + label: 'GroupApi.put', + className: 'schema', }, { - type: "doc", - id: "api/schemas/grouppostschema", - label: "GroupPostSchema", - className: "schema", + type: 'doc', + id: 'api/schemas/grouppostschema', + label: 'GroupPostSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/groupputschema", - label: "GroupPutSchema", - className: "schema", + type: 'doc', + id: 'api/schemas/groupputschema', + label: 'GroupPutSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/guesttokencreate", - label: "GuestTokenCreate", - 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-database', + label: 'ImportV1Database', + className: 'schema', }, { - type: "doc", - id: "api/schemas/importv-1-databaseextra", - label: "ImportV1DatabaseExtra", - 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', + 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-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', + 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-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-post', + label: 'LogRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/logrestapi-put", - label: "LogRestApi.put", - 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', + 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-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-post', + label: 'PermissionApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/permissionapi-put", - label: "PermissionApi.put", - 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', + 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-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-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', + 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-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-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-post', + label: 'PermissionViewMenuApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/permissionviewmenuapi-put", - label: "PermissionViewMenuApi.put", - 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/queryexecutionresponseschema', + label: 'QueryExecutionResponseSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/queryrestapi-get", - label: "QueryRestApi.get", - 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-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-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-post', + label: 'QueryRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/queryrestapi-put", - label: "QueryRestApi.put", - 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/queryresult', + label: 'QueryResult', + className: 'schema', }, { - type: "doc", - id: "api/schemas/rlsrestapi-get", - label: "RLSRestApi.get", - 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-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-post', + label: 'RLSRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/rlsrestapi-put", - label: "RLSRestApi.put", - 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/recentactivity', + label: 'RecentActivity', + className: 'schema', }, { - type: "doc", - id: "api/schemas/recentactivityresponseschema", - label: "RecentActivityResponseSchema", - 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/recentactivityschema', + label: 'RecentActivitySchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/relatedresponseschema", - label: "RelatedResponseSchema", - 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/relatedresultresponse', + label: 'RelatedResultResponse', + className: 'schema', }, { - type: "doc", - id: "api/schemas/reportexecutionlogrestapi-get", - label: "ReportExecutionLogRestApi.get", - 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-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-post', + label: 'ReportExecutionLogRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/reportexecutionlogrestapi-put", - label: "ReportExecutionLogRestApi.put", - 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/reportrecipient', + label: 'ReportRecipient', + className: 'schema', }, { - type: "doc", - id: "api/schemas/reportrecipientconfigjson", - label: "ReportRecipientConfigJSON", - 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', + 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-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-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-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-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-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', + 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-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', + 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-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-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-post', + label: 'ReportScheduleRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/reportschedulerestapi-put", - label: "ReportScheduleRestApi.put", - 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/resource', + label: 'Resource', + className: 'schema', }, { - type: "doc", - id: "api/schemas/rlsrule", - label: "RlsRule", - className: "schema", + type: 'doc', + id: 'api/schemas/rlsrule', + label: 'RlsRule', + className: 'schema', }, { - type: "doc", - id: "api/schemas/rolegroupputschema", - label: "RoleGroupPutSchema", - className: "schema", + type: 'doc', + id: 'api/schemas/rolegroupputschema', + label: 'RoleGroupPutSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/rolepermissionlistschema", - label: "RolePermissionListSchema", - 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/rolepermissionpostschema', + label: 'RolePermissionPostSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/roleresponseschema", - label: "RoleResponseSchema", - 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/roleuserputschema', + label: 'RoleUserPutSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/roles", - label: "Roles", - 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/roles-1', + label: 'Roles1', + className: 'schema', }, { - type: "doc", - id: "api/schemas/rolesresponseschema", - label: "RolesResponseSchema", - 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/sqllabbootstrapschema', + label: 'SQLLabBootstrapSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/savedqueryrestapi-get", - label: "SavedQueryRestApi.get", - 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-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', + 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-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', + 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-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-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', + 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-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-post', + label: 'SavedQueryRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/savedqueryrestapi-put", - label: "SavedQueryRestApi.put", - 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/schemasresponseschema', + label: 'SchemasResponseSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/selectstarresponseschema", - label: "SelectStarResponseSchema", - 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/slice', + label: 'Slice', + className: 'schema', }, { - type: "doc", - id: "api/schemas/sqllabpermalinkschema", - label: "SqlLabPermalinkSchema", - 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/stopqueryschema', + label: 'StopQuerySchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/supersetroleapi-get", - label: "SupersetRoleApi.get", - 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-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-post', + label: 'SupersetRoleApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/supersetroleapi-put", - label: "SupersetRoleApi.put", - 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', + label: 'SupersetUserApi.get', + className: 'schema', }, { - type: "doc", - id: "api/schemas/supersetuserapi-get-group", - label: "SupersetUserApi.get.Group", - className: "schema", + type: 'doc', + id: 'api/schemas/supersetuserapi-get-group', + label: 'SupersetUserApi.get.Group', + className: 'schema', }, { - type: "doc", - id: "api/schemas/supersetuserapi-get-role", - label: "SupersetUserApi.get.Role", - 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', + 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-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', + label: 'SupersetUserApi.get_list', + className: 'schema', }, { - type: "doc", - id: "api/schemas/supersetuserapi-get-list-group", - label: "SupersetUserApi.get_list.Group", - className: "schema", + type: 'doc', + id: 'api/schemas/supersetuserapi-get-list-group', + label: 'SupersetUserApi.get_list.Group', + 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-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', + 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-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-post', + label: 'SupersetUserApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/supersetuserapi-put", - label: "SupersetUserApi.put", - 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/tab', + label: 'Tab', + className: 'schema', }, { - type: "doc", - id: "api/schemas/tabstate", - label: "TabState", - 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/table', + label: 'Table', + className: 'schema', }, { - type: "doc", - id: "api/schemas/tableextrametadataresponseschema", - label: "TableExtraMetadataResponseSchema", - 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/tablemetadatacolumnsresponse', + label: 'TableMetadataColumnsResponse', + className: 'schema', }, { - type: "doc", - id: "api/schemas/tablemetadataforeignkeysindexesresponse", - label: "TableMetadataForeignKeysIndexesResponse", - 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/tablemetadataoptionsresponse', + label: 'TableMetadataOptionsResponse', + className: 'schema', }, { - type: "doc", - id: "api/schemas/tablemetadataprimarykeyresponse", - label: "TableMetadataPrimaryKeyResponse", - 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/tablemetadataresponseschema', + label: 'TableMetadataResponseSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/tables", - label: "Tables", - 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/tabspayloadschema', + label: 'TabsPayloadSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/tag", - label: "Tag", - className: "schema", + type: 'doc', + id: 'api/schemas/tag', + label: 'Tag', + className: 'schema', }, { - type: "doc", - id: "api/schemas/tag-1", - label: "Tag1", - className: "schema", + type: 'doc', + id: 'api/schemas/tag-1', + label: 'Tag1', + className: 'schema', }, { - type: "doc", - id: "api/schemas/taggetresponseschema", - label: "TagGetResponseSchema", - 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/tagobject', + label: 'TagObject', + className: 'schema', }, { - type: "doc", - id: "api/schemas/tagpostbulkresponseobject", - label: "TagPostBulkResponseObject", - 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/tagpostbulkresponseschema', + label: 'TagPostBulkResponseSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/tagpostbulkschema", - label: "TagPostBulkSchema", - 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', + 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', + 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-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', + 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', + 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-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-post', + label: 'TagRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/tagrestapi-put", - label: "TagRestApi.put", - 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/taggedobjectentityresponseschema', + label: 'TaggedObjectEntityResponseSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/temporarycachepostschema", - label: "TemporaryCachePostSchema", - 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/temporarycacheputschema', + label: 'TemporaryCachePutSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/theme", - label: "Theme", - className: "schema", + type: 'doc', + id: 'api/schemas/theme', + label: 'Theme', + className: 'schema', }, { - type: "doc", - id: "api/schemas/themerestapi-get", - label: "ThemeRestApi.get", - className: "schema", + type: 'doc', + id: 'api/schemas/themerestapi-get', + label: 'ThemeRestApi.get', + className: 'schema', }, { - type: "doc", - id: "api/schemas/themerestapi-get-user", - label: "ThemeRestApi.get.User", - className: "schema", + type: 'doc', + id: 'api/schemas/themerestapi-get-user', + label: 'ThemeRestApi.get.User', + className: 'schema', }, { - type: "doc", - id: "api/schemas/themerestapi-get-user-1", - label: "ThemeRestApi.get.User1", - className: "schema", + type: 'doc', + id: 'api/schemas/themerestapi-get-user-1', + label: 'ThemeRestApi.get.User1', + className: 'schema', }, { - type: "doc", - id: "api/schemas/themerestapi-get-list", - label: "ThemeRestApi.get_list", - className: "schema", + type: 'doc', + id: 'api/schemas/themerestapi-get-list', + label: 'ThemeRestApi.get_list', + className: 'schema', }, { - type: "doc", - id: "api/schemas/themerestapi-get-list-user", - label: "ThemeRestApi.get_list.User", - className: "schema", + type: 'doc', + id: 'api/schemas/themerestapi-get-list-user', + label: 'ThemeRestApi.get_list.User', + className: 'schema', }, { - type: "doc", - id: "api/schemas/themerestapi-get-list-user-1", - label: "ThemeRestApi.get_list.User1", - className: "schema", + type: 'doc', + id: 'api/schemas/themerestapi-get-list-user-1', + label: 'ThemeRestApi.get_list.User1', + className: 'schema', }, { - type: "doc", - id: "api/schemas/themerestapi-post", - label: "ThemeRestApi.post", - className: "schema", + type: 'doc', + id: 'api/schemas/themerestapi-post', + label: 'ThemeRestApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/themerestapi-put", - label: "ThemeRestApi.put", - className: "schema", + type: 'doc', + id: 'api/schemas/themerestapi-put', + label: 'ThemeRestApi.put', + className: 'schema', }, { - type: "doc", - id: "api/schemas/uploadfilemetadata", - label: "UploadFileMetadata", - 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/uploadfilemetadataitem', + label: 'UploadFileMetadataItem', + className: 'schema', }, { - type: "doc", - id: "api/schemas/uploadfilemetadatapostschema", - label: "UploadFileMetadataPostSchema", - 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/uploadpostschema', + label: 'UploadPostSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/user", - label: "User", - 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-1', + label: 'User1', + className: 'schema', }, { - type: "doc", - id: "api/schemas/user-2", - label: "User2", - className: "schema", + type: 'doc', + id: 'api/schemas/user-2', + label: 'User2', + className: 'schema', }, { - type: "doc", - id: "api/schemas/user-3", - label: "User3", - className: "schema", + type: 'doc', + id: 'api/schemas/user-3', + label: 'User3', + className: 'schema', }, { - type: "doc", - id: "api/schemas/userregistrationsrestapi-get", - label: "UserRegistrationsRestAPI.get", - className: "schema", + type: 'doc', + id: 'api/schemas/userregistrationsrestapi-get', + label: 'UserRegistrationsRestAPI.get', + className: 'schema', }, { - type: "doc", - id: "api/schemas/userregistrationsrestapi-get-list", - label: "UserRegistrationsRestAPI.get_list", - className: "schema", + type: 'doc', + id: 'api/schemas/userregistrationsrestapi-get-list', + label: 'UserRegistrationsRestAPI.get_list', + className: 'schema', }, { - type: "doc", - id: "api/schemas/userregistrationsrestapi-post", - label: "UserRegistrationsRestAPI.post", - className: "schema", + type: 'doc', + id: 'api/schemas/userregistrationsrestapi-post', + label: 'UserRegistrationsRestAPI.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/userregistrationsrestapi-put", - label: "UserRegistrationsRestAPI.put", - className: "schema", + type: 'doc', + id: 'api/schemas/userregistrationsrestapi-put', + label: 'UserRegistrationsRestAPI.put', + className: 'schema', }, { - type: "doc", - id: "api/schemas/userresponseschema", - label: "UserResponseSchema", - 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/validatesqlrequest', + label: 'ValidateSQLRequest', + className: 'schema', }, { - type: "doc", - id: "api/schemas/validatesqlresponse", - label: "ValidateSQLResponse", - 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/validatorconfigjson', + label: 'ValidatorConfigJSON', + className: 'schema', }, { - type: "doc", - id: "api/schemas/viewmenuapi-get", - label: "ViewMenuApi.get", - 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-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-post', + label: 'ViewMenuApi.post', + className: 'schema', }, { - type: "doc", - id: "api/schemas/viewmenuapi-put", - label: "ViewMenuApi.put", - 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/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-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-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/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/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-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-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-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-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-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-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-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/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/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/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/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/thumbnail-query-schema', + label: 'thumbnail_query_schema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/dashboardnativefiltersconfigupdateschema", - label: "DashboardNativeFiltersConfigUpdateSchema", - 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/dashboardcolorsconfigupdateschema', + label: 'DashboardColorsConfigUpdateSchema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/get-slack-channels-schema", - label: "get_slack_channels_schema", - className: "schema", + type: 'doc', + id: 'api/schemas/get-slack-channels-schema', + label: 'get_slack_channels_schema', + className: 'schema', }, { - type: "doc", - id: "api/schemas/dashboardchartcustomizationsconfigupdateschema", - label: "DashboardChartCustomizationsConfigUpdateSchema", - className: "schema", + type: 'doc', + id: 'api/schemas/dashboardchartcustomizationsconfigupdateschema', + label: 'DashboardChartCustomizationsConfigUpdateSchema', + className: 'schema', }, ], }, 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 index f9ea58f7e61..76a195377f0 100644 --- 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 @@ -1,13 +1,13 @@ --- id: sql-lab-permanent-link -title: "SQL Lab Permanent Link" -description: "SQL Lab Permanent Link" +title: 'SQL Lab Permanent Link' +description: 'SQL Lab Permanent Link' custom_edit_url: null --- 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}` | +| 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 index 5699ee701ce..bf9477c4397 100644 --- 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 @@ -1,18 +1,18 @@ --- id: sql-lab -title: "SQL Lab" -description: "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/` | -| `POST` | [Export SQL query results to CSV with streaming](./export-sql-query-results-to-csv-with-streaming) | `/api/v1/sqllab/export_streaming/` | -| `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/` | +| 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/` | +| `POST` | [Export SQL query results to CSV with streaming](./export-sql-query-results-to-csv-with-streaming) | `/api/v1/sqllab/export_streaming/` | +| `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 index b9ba448ee8f..ec0313e674e 100644 --- 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 @@ -1,26 +1,26 @@ --- id: tags -title: "Tags" -description: "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}` | +| 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 index 844a50cb316..1cc56089d73 100644 --- 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 @@ -1 +1,103 @@ -{"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}} +{ + "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 index c981bad450c..e953eaf2ee8 100644 --- 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 @@ -1 +1,54 @@ -{"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"}}} +{ + "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 index 197646cdce2..580d1d744c7 100644 --- 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 @@ -1,33 +1,32 @@ --- id: test-a-database-connection -title: "Test a database connection" -description: "Test a database connection" -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Test a database connection'} +>     - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 188a349c40f..e9fcb6db7c9 100644 --- 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 @@ -1 +1 @@ -{"title":"Body"} +{ "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 index eaa0ce8a782..e4530774d49 100644 --- 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 @@ -1 +1,63 @@ -{"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"}}} +{ + "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 index c18999b8896..70abe3e43d1 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'The list of the database schemas where to upload information'} +> - - The list of the database schemas where to upload information - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/themes.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/themes.tag.mdx index 42612909c9f..7fb7dc06e5b 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/themes.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/themes.tag.mdx @@ -1,25 +1,25 @@ --- id: themes -title: "Themes" -description: "Themes" +title: 'Themes' +description: 'Themes' custom_edit_url: null --- Manage UI themes for customizing Superset's appearance. -| Method | Endpoint | Path | -|--------|----------|------| -| `DELETE` | [Bulk delete themes](./bulk-delete-themes) | `/api/v1/theme/` | -| `GET` | [Get a list of themes](./get-a-list-of-themes) | `/api/v1/theme/` | -| `POST` | [Create a theme](./create-a-theme) | `/api/v1/theme/` | -| `GET` | [Get metadata information about this API resource (theme--info)](./get-metadata-information-about-this-api-resource-theme-info) | `/api/v1/theme/_info` | -| `DELETE` | [Delete a theme](./delete-a-theme) | `/api/v1/theme/{pk}` | -| `GET` | [Get a theme](./get-a-theme) | `/api/v1/theme/{pk}` | -| `PUT` | [Update a theme](./update-a-theme) | `/api/v1/theme/{pk}` | -| `PUT` | [Set a theme as the system dark theme](./set-a-theme-as-the-system-dark-theme) | `/api/v1/theme/{pk}/set_system_dark` | -| `PUT` | [Set a theme as the system default theme](./set-a-theme-as-the-system-default-theme) | `/api/v1/theme/{pk}/set_system_default` | -| `GET` | [Download multiple themes as YAML files](./download-multiple-themes-as-yaml-files) | `/api/v1/theme/export/` | -| `POST` | [Import themes from a ZIP file](./import-themes-from-a-zip-file) | `/api/v1/theme/import/` | -| `GET` | [Get related fields data (theme-related-column-name)](./get-related-fields-data-theme-related-column-name) | `/api/v1/theme/related/{column_name}` | -| `DELETE` | [Clear the system dark theme](./clear-the-system-dark-theme) | `/api/v1/theme/unset_system_dark` | -| `DELETE` | [Clear the system default theme](./clear-the-system-default-theme) | `/api/v1/theme/unset_system_default` | +| Method | Endpoint | Path | +| -------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | +| `DELETE` | [Bulk delete themes](./bulk-delete-themes) | `/api/v1/theme/` | +| `GET` | [Get a list of themes](./get-a-list-of-themes) | `/api/v1/theme/` | +| `POST` | [Create a theme](./create-a-theme) | `/api/v1/theme/` | +| `GET` | [Get metadata information about this API resource (theme--info)](./get-metadata-information-about-this-api-resource-theme-info) | `/api/v1/theme/_info` | +| `DELETE` | [Delete a theme](./delete-a-theme) | `/api/v1/theme/{pk}` | +| `GET` | [Get a theme](./get-a-theme) | `/api/v1/theme/{pk}` | +| `PUT` | [Update a theme](./update-a-theme) | `/api/v1/theme/{pk}` | +| `PUT` | [Set a theme as the system dark theme](./set-a-theme-as-the-system-dark-theme) | `/api/v1/theme/{pk}/set_system_dark` | +| `PUT` | [Set a theme as the system default theme](./set-a-theme-as-the-system-default-theme) | `/api/v1/theme/{pk}/set_system_default` | +| `GET` | [Download multiple themes as YAML files](./download-multiple-themes-as-yaml-files) | `/api/v1/theme/export/` | +| `POST` | [Import themes from a ZIP file](./import-themes-from-a-zip-file) | `/api/v1/theme/import/` | +| `GET` | [Get related fields data (theme-related-column-name)](./get-related-fields-data-theme-related-column-name) | `/api/v1/theme/related/{column_name}` | +| `DELETE` | [Clear the system dark theme](./clear-the-system-dark-theme) | `/api/v1/theme/unset_system_dark` | +| `DELETE` | [Clear the system default theme](./clear-the-system-default-theme) | `/api/v1/theme/unset_system_default` | 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 14ea01905d3..ae5ec59cf2d 100644 --- 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 @@ -1 +1,128 @@ -{"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",null],"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"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"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],"uuid":"550e8400-e29b-41d4-a716-446655440000","viz_type":["bar","area","table"]}}},"description":"Chart schema","required":true}} +{ + "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", + null + ], + "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" + }, + "uuid": { "format": "uuid", "nullable": true, "type": "string" }, + "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], + "uuid": "550e8400-e29b-41d4-a716-446655440000", + "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 index 04279ec6609..9f14586985d 100644 --- 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 @@ -1 +1,222 @@ -{"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",null],"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"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"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":[],"uuid":"550e8400-e29b-41d4-a716-446655440000","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"}}} +{ + "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", + null + ], + "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" + }, + "uuid": { + "format": "uuid", + "nullable": true, + "type": "string" + }, + "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": [], + "uuid": "550e8400-e29b-41d4-a716-446655440000", + "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 index b82d8184c53..90704be67f6 100644 --- 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 @@ -1,33 +1,32 @@ --- id: update-a-chart -title: "Update a chart" -description: "Update a chart" -sidebar_label: "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: eJztWm1vG7kR/isDokBsVLJkx3Zye8gHx01wyQWJEdttD1GgUMuRlvEuuUdyJSuC/nsx5L7pLac2vaQF/Mle7sxwnuG8UrtgOTc8Q4fGsujDgknFIpZzl7AOUzxDerpjHWbw90IaFCxypsAOs3GCGWfRgrl5TlRSOZygYcvlx0CN1j3XYk4ksVYOlaN/eZ6nMuZOatX7bLWitUZWbnSOxkm0no3HCQ6dzFAXnlmgjY3MiZlF7G+F8XLgQCqwGGsl7CHoMbgEgXilmkDJDWNtwCXSQpxw447grXYYFgSOeZE6C057TsEdt7owMfYcH6VYi5BjKJTAsVQojsg8RZoSQWWSdUN0WExYxiXcoUDHZWq3AAkvatXbXLv3sc5INWltg2I4mm9Kv0JjtQJtYGJ0kYNLuIOEW6jZWobZZzvBbTLS3AgPRTrMtmC6gFRaR5AacrKwVHFaiNL0CmdhW3CaLLppwXKFG8PnYe/qcIZSbO56kyBIURnSE6PrNUzr285kmkJh8QguINZZnqJrOwBIgao5C1CIwsKnFSU+AVdiZY10/rSfg6xxbQdEb4IhN+BU+qEArdYVIxVQFRmLPjDvyazcEOmYfy/QzFmHWT5FMayephJnrEOKf9zHE9q6bnpA67n2bW92CnNt8Ss2avbAe4dG8XRYmJQ2+UMGaYcZV3yCYljxpvOvcI60TpErYtUz5fPgTq9+RwTADZLTGAtSWOBpqmcURBoEegfShnCqCa5knFdjSHHsALPczWGui+B9IwStsLJP0GDFWvsFhk/jWzS+qtO7V3uCCg13KEDMFc9kTMaBWYIK4lTGdz5lJgjkFYRDT9HMjHQIo8I5rUAq/x7v81QbBPKXI7ghmK+v370FPfqMcci2uZ6hKe00SzRkfA4zrijWgacODdgcYwouaGrQXi7hnXXoi8r9lrpAMeNJoCQBg7lBi4qSfPlSog2ZkGKaVDKFB6eNQEPPlaXqTOL/mUpb8FR+8fmg40NfKpiRoLE2GXcNuU10kQo6X4OuMF8vGjvADUsttgbYJs6Gug15lqBLCFRFX0mX1h9Pyym0AaUdWB1sIx0IjdavFbkga3iGTAufdKzj7mtR3Aotm8oYh6Gj2AaE3my4fcbv36CauIRFJ2f9Dsukqp77e5jS8cnXgvmGT3xJGiFwa3UsvQlm0iWNFnvFXlGEWhQ8gEVhYQ8Fp/LLHnk/5MwVz6Nj8O6E95yqFqX4ETesw7hBTkr7fT9+owkbrCGuSbB0RM4uSan3aN1FLo/ywoVUXSqz0bod7+yFqr3Wu5hmvd1ufDj+uNEDHG8po029W7FqLXO1qDTrO2pHME5VHbwSVb5teNey0o4XKxFdttKt0Gi4gvP6vYJ/sbOzPj497fe7ePLTqHt6LE67/Mnxeff09Pz87Oz0tN/v91nbqbb7xHK5XrnDYULZhq/3+ktasLlWNnTlJ/3+N/T0IVLKU1JFNgohZdAWqXsYAR5GgIcR4GEEeBgBHkaAhxHgYQR4GAH+v0aADeLVoaDs1pte78+aEv4XhoTvOCP8GSPCjhkhFDVBB3v6TXNAhtbyCbaGgZ0et+pENSN7zgWUPzRE8EpNeSpFq45QizGVgpTdRNPiDViOfyyWW8ULl2gjv6CI4KJwCXV1cZXIy3lsC5A2Y0Dy+McieanNSAqBKoLfdAFCq0c0a0wRcjSZtJYQUf2PY7Q2tEcGQ2BuA1jLC+hOfyy6t5qqfKFEBJSfSxdCUUNoqiXeS3KuTUS1DI/o5ORHe15uNB2FH3TJ69w8gr9TMAXvQ2O02Ybj0jc3BLWUUHLTVmc/Ojm8UiEzg0UzRRNQRHChoFB4n2NMh+YXQcdxYXaE10vueFqboMMsxoUhjPRb6eeZo+xLP3iWmThkSUtV974ba4HXXrXw02rK1YRFLL59/4Z1WMpHmDaPZQBELC5MCt1/wtXtDQxY4lwe9XqpjnmaaOuip/2nT3s8l73pcc93Bb3jAYPBYKAAur/AgF2U6cBbOoLnyA0a+MvF5eWL6+vhzbtfX7xdZbgMZ9S9mecYwfoxNbQCHi0G7A7nAxbBgE15WuCALR+xZafGdjV3ib+wqNDVCzU+meXauCpy7EANVHW9BM/qZeonDmhb2NsInUCeIBdo7LPFmimC1qU5Bgz+WmagodN3qJYlN0F+tg3mQB0OVG6kcgeVukdEfHB42DbAaz7l195/WkZYWWwOWitLdqix8xmXDsbo4sRD/7eAL4L+GbpEC1L86vZm3SZRRQXrfkJYP1WusgiGufF2+dRpWNqeEqyz6S2BujLnSIt55MfCoxDBcjw/WMAdzlu2heUhUZOJfx6oYBY/PlUmWTN4SaRTPEr15IBID39mFIVrpTGMK7xu44Nx6IuGgh79Vw4RW7XnIr9b0in5rBHiNrR/W89io3l8Q69B4BRTnWeoXJl/vI8EQYvcaKdjnS6jXm9BopbRgmJiuSHtsrBOZ5WIDptyIylN2zJlejFhcvAXmKWarUuf8pH++Ky0Kv+Xm5srqOUsO4y0WZVX491Q7jokVnoXJjcDr678PYQ2a0K2mqrk99RL/9VIlVyvqSwEkD7FLtjIu+bLarh6/Y8bVn6C4mdM/7aZ0zzoZYeYhwbHBm3ynwohKVar9833LC92/sjR/2+NL/3N+aX/3eeX/nccYPrNBPN4zJ+ejc9Pu2dPjp90T8/OT7qjx+O4exL/dP54fH7Ox/x8nwmmw6Qa682p+rrI0YTrz2qObS1RzAe66XFwZesy7nuVUvWNpLJ2AVodDd67Xp5y6dvW8t4yJJwPjOeS9jomfyilRPkdhWeIvw9ssRhxi7cmXS5pOVzN+kGvSgE+MwnpuzbBojFPLW4oU7df7OB9OUMcQuPiq0pWVxrKXwJTamYRYx0qheEjsCVZNZQSv3t40S4KLcaNdo8SYOC4iGP0pXA37cdWsr66pTgdlZ+SZVoQi+Ez+qGKz4KO2kP2GcOvhXpchFYwiKRQplGpdUh1yJf/EKitVlgsAkUoicvaKL51ILssl/8CVkm7Mw== -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update a chart'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 7e73e81b3f2..83731afbd6b 100644 --- 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 @@ -1 +1,24 @@ -{"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}} +{ + "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 index 1b3039cc046..70718d8042b 100644 --- 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 @@ -1 +1,95 @@ -{"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"}}} +{ + "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 index 2314c66f0d9..83ab4a45054 100644 --- 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 @@ -1,33 +1,32 @@ --- id: update-a-css-template -title: "Update a CSS template" -description: "Update a CSS template" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update a CSS template'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 657bd8471fb..928ebfc1ec1 100644 --- 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 @@ -1 +1,110 @@ -{"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"},"theme_id":{"description":"Theme ID for the dashboard","nullable":true,"type":"integer"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"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],"theme_id":1,"uuid":"550e8400-e29b-41d4-a716-446655440000"}}},"description":"Dashboard schema","required":true}} +{ + "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" + }, + "theme_id": { + "description": "Theme ID for the dashboard", + "nullable": true, + "type": "integer" + }, + "uuid": { "format": "uuid", "nullable": true, "type": "string" } + }, + "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], + "theme_id": 1, + "uuid": "550e8400-e29b-41d4-a716-446655440000" + } + } + }, + "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 index fc76f5da612..bdcb44ea9fb 100644 --- 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 @@ -1 +1,206 @@ -{"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"},"theme_id":{"description":"Theme ID for the dashboard","nullable":true,"type":"integer"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"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":[],"theme_id":1,"uuid":"550e8400-e29b-41d4-a716-446655440000"}}}},"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"}}} +{ + "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" + }, + "theme_id": { + "description": "Theme ID for the dashboard", + "nullable": true, + "type": "integer" + }, + "uuid": { + "format": "uuid", + "nullable": true, + "type": "string" + } + }, + "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": [], + "theme_id": 1, + "uuid": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + }, + "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 index 004838517fb..db6b943884c 100644 --- 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 @@ -1,33 +1,32 @@ --- id: update-a-dashboard -title: "Update a dashboard" -description: "Update a dashboard" -sidebar_label: "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: eJztGttu2zj2Vw6IxTbB2omTOmlHgz6kaYtJt2iDxtkL6sJDi8cWG4pUScqOx/C/Lw4pydd00vYhu4u8JBZ57ndSmrOCW56jR+tY8mnOpGYJK7jPWItpniM93bAWs/i1lBYFS7wtscVcmmHOWTJnflYQlNQex2jZYvE5QqPzL42YEUhqtEft6ScvCiVT7qXRh1+c0bS2pFVYU6D1El1Ao5+jCnog0HOpwoZAl1pZ0DJL2Ku4AWYEPkNYwyItSqX4UGEteSWv81bqMVu0ajYoBsPZNvVLtM5oMBbG1pQF+Ix7yLiDBg18Jh0I7rKh4Vbci6XboceHCVorBcL51RWMjA3aNGQP7kO3gR546Qluk8cZhI3d5HN++w712GcsOel0WiyXun7u3IM53nq0mqtBaRVx/lME6QY513yMYlDjqtk3MIfGKOSaUCl0Bjl6Lrjn22r2yCNvrz68BzP8gqkH6WCMGi33KEDMNM9lStxgmqGGVMn0RupxMInjEyR3mwnaqZUeYVh6bzRIvW4ymEicHsBFoI63hXEoIEMbrWtxhBZ1isC1CCuFmaKF0qF1MM0M5HwGU649eANcebQArsCUYheWWXkvv5upDgk8Z9Jjviu2CAC4xYq/FA64UmZK4WtAoEIftE4zrse4EdIHcDEChSMPmBd+BjNTwlQqBUMEo7HOvChF/XSfyG2KRrPCreUzei6MkyHv6yqxw8NfQmZGD8ftIbrAvMYmp1byTKUYo3dbbqw9uBoVy1gJ8cHFl9L5OkBqQk7+EZ1bM3MwnEHpCE5YPoa/grCm2B039/FqUQ6VdBkV3R01D20uNVIooc/QkvO08RueI8Um0smhwloOJZ0nm3CllnDfCrOVtLNG4bfC7CPtE08e2UwzmWYgcBQk5WmKzlG8bTigl6FDCMRDjHI15TMHoVegIMG5EMHEhGyRTJRGixsNVAIcelA4QVUxCRGrTUUzCkCFGjd9QbJOuAx6x0RUEenHotapcrxtlmstv5YIUqD2cjSjACm49U0VnuKQNLRknV3Zs1KYj09Ovrswez7+ltN6fBycMkTgzplUxsCXPluX5IcM4jPMcSB3hHCPduDi1XYvuhejsoxER8bm3LMkLvypNZYixrrBWqxqlexVzf8jOn9WyIOi9LGv8byIzfSOiaSmvjlLrKy7NbCtPr3cWu+iy/U7mmVUcqMdLrHqxvDp6PNWSV1CrRSaSK/K84AVQ3oJHKMpbC2de1Q7hJ2cdPB5t9Np4/Evw3b3SHTb/NnRabvbPT09Oel2O51Ohy3IDxsVrUnJahzcnDmp/KArjHaxBB13Oj8xW8bgqUJBl/kwRpXizg9yI6IPvcxxJ5hFVyr/OLE+TqyPE+vjxPo4sT5OrI8T6+PE+l8ysW4hrM+w1bi2a9I5Wp1s/ndn3R8ade+edH9y0P3GpBtblyAHdX9qms3ROT5enVXvjJ71YGgQ2UsuoLq2TeBCT7iSYqWpQ2HNRAoSdlujFdyoy9HD6nKteekzY+UfKBI4K6mK+oo/NKeKHYqsIkZNnj6sJm+MHUohUCfwb1OCMPoJzfIThIK6qXNVh6kbFbVSi86UNsVdCjb0onbdh9XuvaGOUmqRUEOtQwhFowIIgy4MCXgrKbi2NWpoBI2Ojx868gpryBWhO1PU+VkC/6BkitGH1hq7S49zUyoRVK0oVNjE6uShi8OFjlUYHNoJ2qhFAmcaSo23BabktLAIJk1Le0d6veGeq8YELeYwLS3pSG+evkw9FVt6fVQV3mWldOxzi922UyPwKogXX1Yprqlgp9cf3zHqaENUy8cqCRKWllZB+19wed2DPsu8L5LDQ2VSrjLjfPK88/z5IS/k4eTosOlVh0d9Bv1+XwO0f4M+O6vKQrB4Ai+RW7Twl7Pz89dXV4Peh7+/fr+OcB591e7NCkxg011LWAFP5n12g7M+S6DPJlyV2GeLJ2zRavS7nPksXAzUGjYLjY4yL4z1dQa5vu7r+rIEXjTLNB/sEVv4LkO0IkqGXKB1L+Yb5oiSVybpM/hbVY0G3tygXlTYpPaLXar29X5fF1Zqv1eLfEDAe/v7q0Z4yyf8KsTSiiHWFpcON9qRLRr9+ZRLDyP0aRbU/27l51GHHH1mBAl/ed3btEtSQ8FmvJC+v9chM4/G6QXb/N5aoqxGTLTQdtRE6NqkQyNmSbg0OIgZLUezvTnc4GzFvrDYJ2gy8699HU1Dk1Njlg2jV0BG4YEy4z0C3f+VUVZutMpCcI/A14bgaCB6Z1ySR8J75IRt23Ve3CzIY6GaxFyOI+BOv7BN3u9oGwSdnkyRo/ZVXQrxEgnNC2u8SY1aJIeHcyK1SOaUI4stauel8yavSbTYhFtJ5dtVpTSQiaeBEQ/DcRCT5ldd5lSnqkf6FyrVOv3fer1LaOgsWoykWafX6Lsl3FUsuLRHr+PpzHxxGW8b7AaRnaaq8AP0Irybr4vuFbWLqGQovXM2DCH6pj6evP1nj1Uv+sOhOuyypmUEpelia+oHFkcWXfajRKrrsY/LrwZe/z/cuXd+6CDSufsk0lk7inSao8jTEX9+Mjrttk+eHT1rd09Oj9vDp6O0fZz+cvp0dHrKR/w0XF/qkdk+1l6VBVqHqwfLlSVK0Ag3OapuuXzOw8BRfR+ysxKssWgGD4+3/rBQXIb5s7p1jVXiE+OFJH5Hq75iLZYUN5RTMWk+sfl8yB1eW7VY0PLXEu0sHtLqvA3lRMgwggmWjLhyuCVQM0uxvY/VgWAflnG5Lmh9RaBnoTyokp5Yi3pZ/D5m8ZnSOvSBwD1urFb0FcSt2Y2qVsQ4S1MMvexu2M8rVfbympJrWH1lkxtBKJbTVR39DTKaoHJI87AWG2oZ57pIkvKPzj0rjmrytPpBSu20wnweIWI/WzRGCb2f7LJY/AdeOKzr -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update a dashboard'} +> - - 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 index 1962dcb54f2..a08dc6f19d9 100644 --- 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 @@ -1 +1,17 @@ -{"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"}}]} +{ + "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 index a6881dd9b31..49b042b8aa3 100644 --- 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 @@ -1 +1,22 @@ -{"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}} +{ + "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 index 7a5553e8fe5..b35d8b0b701 100644 --- 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 @@ -1 +1,85 @@ -{"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"}}} +{ + "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 index fec598bf23a..a2fe4daaf75 100644 --- 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 @@ -6,28 +6,27 @@ 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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import 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 index 78674c08973..8464ee1dd25 100644 --- 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 @@ -1 +1,15 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"query","name":"override_columns","schema":{"type":"boolean"}}]} +{ + "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 index 1fe4a016540..29ddf56b202 100644 --- 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 @@ -1 +1,229 @@ -{"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"},"datetime_format":{"maxLength":100,"minLength":1,"nullable":true,"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"},"currency_code_column":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"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":{"allOf":[{"properties":{"symbol":{"maxLength":128,"minLength":1,"type":"string"},"symbolPosition":{"maxLength":128,"minLength":1,"type":"string"}},"type":"object","title":"DatasetMetricCurrencyPut"}],"nullable":true},"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"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"type":"object","title":"DatasetRestApi.put"},"example":{"always_filter_main_dttm":true,"cache_timeout":1,"catalog":"string","columns":[{}],"currency_code_column":"string","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","uuid":"550e8400-e29b-41d4-a716-446655440000"}}},"description":"Dataset schema","required":true}} +{ + "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" + }, + "datetime_format": { + "maxLength": 100, + "minLength": 1, + "nullable": true, + "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" + }, + "currency_code_column": { + "maxLength": 250, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "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": { + "allOf": [ + { + "properties": { + "symbol": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "symbolPosition": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object", + "title": "DatasetMetricCurrencyPut" + } + ], + "nullable": true + }, + "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" }, + "uuid": { "format": "uuid", "nullable": true, "type": "string" } + }, + "type": "object", + "title": "DatasetRestApi.put" + }, + "example": { + "always_filter_main_dttm": true, + "cache_timeout": 1, + "catalog": "string", + "columns": [{}], + "currency_code_column": "string", + "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", + "uuid": "550e8400-e29b-41d4-a716-446655440000" + } + } + }, + "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 index 79fe9f408b3..da3d0c1b317 100644 --- 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 @@ -1 +1,329 @@ -{"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"},"datetime_format":{"maxLength":100,"minLength":1,"nullable":true,"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"},"currency_code_column":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"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":{"allOf":[{"properties":{"symbol":{"maxLength":128,"minLength":1,"type":"string"},"symbolPosition":{"maxLength":128,"minLength":1,"type":"string"}},"type":"object","title":"DatasetMetricCurrencyPut"}],"nullable":true},"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"},"uuid":{"format":"uuid","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":[],"currency_code_column":"string","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","uuid":"550e8400-e29b-41d4-a716-446655440000"}}}},"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"}}} +{ + "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" + }, + "datetime_format": { + "maxLength": 100, + "minLength": 1, + "nullable": true, + "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" + }, + "currency_code_column": { + "maxLength": 250, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "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": { + "allOf": [ + { + "properties": { + "symbol": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "symbolPosition": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object", + "title": "DatasetMetricCurrencyPut" + } + ], + "nullable": true + }, + "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" }, + "uuid": { + "format": "uuid", + "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": [], + "currency_code_column": "string", + "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", + "uuid": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + }, + "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 index 65d66fe6ce6..ef652d82266 100644 --- 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 @@ -1,33 +1,32 @@ --- id: update-a-dataset -title: "Update a dataset" -description: "Update a dataset" -sidebar_label: "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: eJztW21v2zgS/isEcUATnN3YiZNmteiHNNdi2+21QZPs3iEOtLQ0jtlIpEpSTryG/vthSL1ZlmOnaa97B39KRA2HnOG8PpTnNGGKxWBAaepdzSkX1KMJMxPaoYLFgE+3tEMVfEm5gpB6RqXQoTqYQMyoN6dmliAVFwZuQNEs6+RcvqSgZhUbOQWleAh+IKM0Fpq2MBlJGQETNMuu3ZKgzSsZzpAkkMKAMPgvS5KIB8xwKfY+aylwrOKVKJmAMhy0pY3u2Ez7Yx4ZUH7MuPBDY2J8FcKYpZGh3phFGjpLm+jQgAUT8A2PQaZ2ZZFGERtFUKihKTxOMSySN0gcs/v3IG7MhHr7h70OjbkonnudVay0UVzcWE65nrw55QZi3SJbOGUigNAPmWG+Y9BY9nBh2f7Gy/ru1NZxW5odMgOoL38sVcxMg0O/13v0fkLQgeIJHvYDJ1DRw32iQOvNyY1iG1E6E3IkyxbboTdKpslo1v6Sh22+0qFc+ywwfAoPbKHORpfWu544mZmJFGgcK47ja8yjsLK1hGnqZC5WdgMbrDAFNZIaSgtcMyGrB6erBfO9Lonl6DMEhnao4QY50X8wwzSYU+djZ6mpZKNMKTazrpAqBSKY+YEs49Y3cGz01hHT4K8yijww+SDCRHLxUOR5ip8YUIJFfqqib+0pYIKJP2VRCtpPFIQYrJvRpN/rPV51eRjXEEGA+kHicDNvGMsotFluZTgNJjwKFYgaCQ24CtKIqZ03dvruagMuraZxEE8VuTUQL4XRlX4KIo3RL2Iwige0iO+0UEjNSdb77sOuZ4ke8DmnwjZH49qPmWA3EPqFWUazjSOi/oJE/pTD3WZzyioAfXoji3bae9B48ljhao7o49iWU4s0ehaP3IJ1o9g/XnuYbuKZ1LzNqtYyyNbGwX9a+U5zGWw4vG7aJpr2QXtaX97Bd07rTwhOq4KuO+KvrXvy2S012MH+o3Xz30qdHXrHlODixjdwv0mWaTh87UwW9bc+8TqDW5V4BQoe8T+rZmEjv5bjsYYN63R5J5rZYJmoua+qyXjAPDYJ6vrLZnHH4Nt2m3x8JW0gTiIsBm3P95BOn2yK6yPOJ9DmJOHPE2cBcM/ixFXWKzs2t1KjJ+vXWq5i+VrvdDXHQNZeyFXkCxVZv60Aq9HWA1c1vFhOLYxjYKoGVhVHNYr2IseJX5YxTrIVmdPRNnOjG21kv2rdMsk51i1O6BgUbtavvOiqf115R8XRmnn1WLfm2mjTLKtXzvro4WEPjge9Xhf2fxp1B/1w0GUv+kfdweDo6PBwMOj1ej2aZc2sUpgayTfWRDFsNNOJFNql5/1e7wlAw0JeEWk8ciFEgbYYwxaX2OISW1xii0tscYktLrHFJba4xBaX2OISW1xii0tscYm/MC6xRL6IVORoQdXifVvo4v8VuPhusMVjQYu/AmaxErQIJkzcQIgmN3gSMBGD1uwGWtLTGvMuJ9JXLCT55xgeeSumLOIhqb4cIYmSUx7iZpflqc11svR/rCyXgqVmIhX/E0KPnKRmAsLk65Myi7QIUp/oJDn4sZK8kWrEwxCER/4tUxJK8cyQCZsCSUDF3CZAYiRhQQBaEzPhmijQMlUBtAlY8nPSDX6sdB+kIWOZitAjFxMoTAjCUgQSStBESEPgnqNxLUtU8rAS7e//aMtLlMSjwJBC0OrMzCO/oTM56wOlpGqT41SmUWhFzTnks3Gpwx8dHN4KF8CJBjUF5aTwyIkgqYD7BAI8NDtIZGATWqt7vcFUWKqgQzUEqUIZsV/5fGcwXmPxb9gNxu4iTmos6u67mB/P7ebcd2wRE5hVg8tP72mHRmwEUfWYu4CH6TUi3X+Rs8sLMqQTYxJvby+SAYsmUhvvuHd8vMcSvjft74Vuub3+kJLhcCgI6f5ChvQkDwlW2x55BUyBIn87OT19fX7uX3z89fWHxQmn7py6F7MEPNI8qoo2JM/mQ3oLsyH1yJDatDuk2TOK39fl0p1ZIK0mXzlQSsjjRCpTeI8eiqEoMG/yshzGamcHlyWPUEPHTZgAw7z+ct5Qhtt3rpAhJX/P45Bv5C2ILJ+NQr9sE3QodociUVyYnWLDz5F4Z3e3roJ3bMrOrRXV1LAwWB22FBo1UUrP7hg3xJY1VvhHij53EsRgJjLErZ9dXjS14hVUpGkrKO0fhbnMnWourGb+6FRT6tbi9LNsMY66UOhIhjOPvDv/+OG582Q+nu3MyS3Matol2S5So5J/HgqnGBSvVEpD5TmRjOB5JG92kHT3Z9uKN1JkgqAuYSTXlavOJhILIiyoO+7TUo82dTpPbjM8KxtBnAe7crT1RJaK2ff4moQwhUgmMQiTxyJrKY7RPFHSyEBGmbe3N0dWmTdH38iWuJ2m2si4YNGhU6Y4huwCXbFsFi5q7DaxZs5BrfwR/9j4tMj/l4uLM1LyyToUd7PIr5R3aXPnLsjiOyxKiVTk7ZlF1aVqMGlVVT7fUmf2O9si0J5jinBC2nA7pyNrnm+KFuvd7xfFR7u2wbVvK/TNCp11cLKvYKxAT76WCXLRUnyqvgB+vcH9cH5d1uiyeusuiFuvq5qUSx3A0oXSBo1WhRQ91GbVrnNc61Je4OTtUWiFqt3QlG1Tvdlsu2WpNTANKfOu5WDMjg/HR4Pu4Yv+i+7g8Gi/OzoYB9394Kejg/HRERuzI9rEc8qS4bENa+9/pGGtQ/BXiDAsuXTJcalRdHouUe7H6Pk73u8vwMIF/FvrgRu4bh0fPfjWBp9bwgLO2dz0kld+C3ttwox1O16LI/RqOELvewIJm5lKh3Ixli7+L4T7NAHlMnEBdNWGMNk6umnf5RBtYuaAb7fRlozeQMjzk0EV7iUR47Z7zO/uXLa/oizhuFo/DwCOj5fcYm50ye+KzucYFy5VlGU47H49gqYacp37ZR7gb2HW/nsS6+rUo/YEi6zdzqMhRNk90Z1POQSwSyr3XRSuQF/FrL5msa/klmbXmNRtBWhXdy/qtVxt4lK3hjWLm3ESBGBr2NW017UK6+wSU+so/71MLEOcotgdfvjC7twepRXZJnk75grp1HVyjiVmX0Q66h8MFFk6/weFatXCfO4oXCWblUqxNT/qJcv+AxqGHCI= -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update a dataset'} +> - - 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 index 44d069f4ff0..6db4adf1bbd 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The Report Schedule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 3dfe8084835..fc820d82265 100644 --- 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 @@ -1 +1,775 @@ -{"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",null],"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","Webhook"],"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/Coyhaique","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",null],"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}} +{ + "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", null], + "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", "Webhook"], + "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/Coyhaique", + "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", null], + "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 index 9a5b3a31ece..bf1b906721d 100644 --- 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 @@ -1 +1,861 @@ -{"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",null],"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","Webhook"],"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/Coyhaique","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",null],"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"}}} +{ + "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", null], + "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", "Webhook"], + "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/Coyhaique", + "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", null], + "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 index 9bb1ca9195b..6f636752423 100644 --- 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 @@ -1,33 +1,32 @@ --- id: update-a-report-schedule -title: "Update a report schedule" -description: "Update a report schedule" -sidebar_label: "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/yrYqauKXUtZdh67WW28VRIlS7JEmREpex3LNWnOgDMQMcAYD8qUSt/9qoF5ABSdeHfrKld3/CPK9A+P6W40Gg0Mmr5PalBQUUOVTvY+3Cc51ZlitWFSJHvJtKTkktZSGTLJSppbTkm9SAYJw9IaTJkMEgEVRQpxRT9Zpmie7Bll6SDRWUkrSPbuE7OqsRYThhZUJQ8PH31tqs2BzFdYJZPCUGHwEeqaswyQjd0bjbzcB33VStZUGUa1q5sZtqTBO2ZScgoieRgkWQnKdSgs5zDjtGVsnZ2Bf/tnk1agFrm8da+MtTFqSkgID77UtTaKicL1rKiTJK2oKWX+uONhU4H4CoRpYjXNiZGEiblUFTElJXPl9JOT25KakioHKjc6u8CpMuQWNHEvozlhwpXnoMuZBJUPiNPFgEhFXG1NQORNe02uTp8lg4QKWyV7H7zadDJIuuZI+GZp0yQZoOAf1+V38kphYPZYzn0yvHxzQejnWlGtmRTPPgx9XXJslf34pDSm1nu7u00Pzwqr7O5T1AeQkvJ6bjlRVEurMkpMCYZkIFwJWUlLMgVzQ+DRW5JBUsHncyoKUyZ7L54/fz5IKiY6YNOYWW1kld6yHGs8GjBXSlwpkXOnaZ0pSoUupUHd1+wz5ag0+hmqGpXjX/v7dtip/OvMNgcDM9B00xwbxGyvS3GlKQEiWEZDi0arK9iSkmZCIG1Kpsk+Dv+udwehYMkhML4iGjjVvb1hM5xK1KBGv2KW0AoYT7Wd3dDMPGZ22hk70a0raioTzgSNOPrgufxIWu+FPmqPHHbMSeWngyv4Ku4+GxX6MenZfBgkc6kymvajv9kRFQoymtZUsU0O4I3IKAHhJyaau1GsKKii+YCU8pZwKYoBmpWmmRS5HpAZnUtFycTWVGmKchTazQEogIln5Elf+Wlkhd9/31g/q3Cuv9hkU1wWqaLoizfazUnDEQ7xgtLamT+XhSagpBU5mUvlTaYZMGQmh1XMyd9CNp5vYsMvLF9jCFhzfZb/8PuTXN4Kt+7dJ8zQSm8YF6xAQFH0x0oTlmsCnMtb75xzyqmhjTGJgoZCPyOnc8Lp3BBa1WblxuaWcU5mlEhBW6/hWWippmmySRsNAkrBCmlFM1YzKkwsQLw2dpXSTIo5K9J2MY2rzbJsCqqgofEGvvC3Cs2XinqWm7kySAwzbnr6SXnZ8jZ0rL2evLno5dw86k0DgnVwQaPZguiaZs7ilsBZTqRroYPF7AgdSzJIJhyyRfv/t98mg+QdnZVSLpKPj2zjIQxlPvjSj18t0Obhwioprubg1NWyNz58lQyS8cVxMkiGk7fJIJke/XO6gadBoj/xTYvq5Odzog0YWjnd4LKY0zkTVEehgncuupSW56SgpncyaMFCmmcEtfzJUrVCH0Q/1zQz3tIVNVYJQpnr7eLq/NzFEUTYakad6q2bgL0LnhydHw2nvoS8unwzIoZVNNVUMapT45ztV/hdbHQnxQaL2CdtGfHVveSK4rKP06JxSz6KbGdY2yaMdvbnimWwuz9j+Q1gRNcCWaYgIPOc6XR/BrMQ5AVDH9IDuoKola5oSB9ABQsZ0qKwLKJvLA9opjXYgOYgzErRAFFwdwdLxnkI2htbzWz45iEwJUNSw4yDyMIq1JqQlAIWatUDh7AAFZIqpTqdAAeoAviGzaQ1gVCH0gIPOj7i6T4wG+j6laLUYNTdIccwk0qKQKYTUBAK/lqWIATVM6uKALXh+JxBVUevPsNlX9qA3TNWAGchLXQJOmhzDoUMhviczRRd0/e5rELKgsjDDuzMVjPQJQsxDYugzgg4zGRI19ZEtKYqMIQRGmKonpEsIGe6DOtIoeSSBW+5QCOYBWxc5DdQURFWYVDRYNAvpIVFVkpjeuyNhQJyaQsZvG0slZE7F3IZcD0BmU4j3UxZNbMLE7SbKlbLcASmVrBA3++YyEtJ0XfvV7SZixCRIiulgoJGWGEZ90PfQYYVNkIUFBaYiLECIx+Bk4gKqdN9pqjeWGEIBipQ2ebmQ1nJ/JItIYdmDDZUUbmcbS57bW/samPJOaSXTN5sbjaiIpd3m8sumUyPgXPa2POjChPgZnPTCYj0tfXucWPhuWWb+5zazFZfaHilSwtrurGxPrQVmd9od5BhC7mIezSLsNEBlOwRnR6AyKkCHRWoGeSRMg4op1VMs7vQsNADZzsTmPGIqwMJ6VumI/UdyEKuAUxHfW22sCFUM8XygqYHsIrxWqbHCgWJYJFZEQEKMoh7fGypQ1hRIeKOVvFIDUuWQSFjpLRQRrNoyGwOOZqHonchLhXw9ATUTFoV42tWP5TaoFHH/MlVCeyTjThUVJtI70PLIO7LovAhz4cgcCuqS1iKCL7V8jGQDhWNnM0hFUuqIsAoyUyISNzKRNwf5ZUUMatHTFlB61CeI47L5xJyGb7gSGgqIA+7e4XR4wXlMccOfQeraBQRBE4jH3DMcf8ZW9OxzE0JswiR+lEttLZ0atUiAtf5O7aQUy5tJN2xxagU+FrFFXyyLiTvsRVEPvgEOJvD5whZrlWhqpKacR6O9KnIGYju/7is6A3FZ0J+3gCPQFFRbOpv7E5I20BjrXBKOU+HzKw2lL2lS9iIM5Hh5NvE3TsmoILsccljceyShcNy+gm4jQzzNVQQ2+X6svLaCuoDzAY4o8LYbLHaPZeW6S7OWS8dSWFYRmP9o2LT04sQUcCpyNlNyOc5pGMIPcU5q0Iez9EnioLySD8b+TmXt1SlY4X6DCuPIKNMRoCAePFHxMZtFCukiRHDxJoPGqEvlUrGTe/A8Mh3Pl6IR1Sgn6BRZ1SxPK5kOCywswj8zDK5bmQjZCxehUZSZGYdMVQpulrHliyncg1UFPgapKlSEOrkAtodSQvQ2/S9jPzDBatZEbFx0QSBHamkKCFGTJkewkIaXHQth/JLpUOKIn2pFNmZQLyIX1gbsvfmhgkowrePAedcDBSCKWNFEaEKl1E2CxU3LiUVLHQoGAnvgN3xZrlWkMp5OqmBiTVcpvuZWq8s07eUl9HbLEX4kmUxKgyk++iWQ7O8BCZW6SWL169LEAsm0lPBaTiweH4xpxFQxKHxJdWSWxPVYTI9UCAibi6lBhXNvgkgf6caZpSvwyoaKoRYHHMgJFO3xq7hMh2DjTzQJJOK6tlKW5GHcMlqJbPQCCYsDhonJj0AZUqM/1Yx/lqWQsfQGTNmDTq3GVvrcFrKCtaqedcfKn5yy+YmHVqlYnxKC5vh7rQOu52WNvKA09JiXLu2bE/ZjY0XzClOOSNjxMjIz7zFgbSxtbxlqoiM9V3JDC2liiLZd0wIVtNwsryHhTWR63iPy8XtQjRmhmOfGeYPI7yD6qFDWPrFLoAshlSHV6pbBPqyEWSfLCj2CG5jvADLRlblMgbHwCsvdo9dSjzughicSGvKdCzXGZis5O1a1amSnMfQW6mNdFbogN1zKYoVBTVbUcelZri5DZ55Bd7nO6pqwnNHCMhXqqM+Ge+UG0LOaEfpsoCZH4iGXpQwg7wDzEr1jQ+gKPO+8ABK1TgrTy6CmqJYeGk8qQT4sytHUqZs99IDpssF7etiJMxaagg8s8bvlBxdspCQbAZc95IPSymKT/67UgNYUSxCQHJZeSeN5CFkGfREBTrzC7+jy+YcxhGMd1wd2hkEhC5B9Ep9BRUUVvdsHsNd94xbnl5lJ3SmZE/JdFiydMRE2UOiSM9kz/6JXHb6P1ULa3SnuFNtQMx6Lb/GI7mei9ewgro59nM0VVa3iyECZxA0PoMqK8H04p/hxrFkPYmmo3rSlBWI3AZATJcg8lXRdyf5AnrmzhRoIVegenHO8GAwPbdVbfvX2KwMxvLM3gLr7GjU7u1awvZEAXlvJCNYYKCielow3rEysjrrZ8QFy6RmXSEeYS3snaCB3hHTbMYC3t9UwbOCTqvjUsgqHdN+gMcYK4OArvp4hfMeeiF/BtOz+jPuhgV00/7n1d2KS5V3DF6CKGRvUpdsBXn3sgm0oZenFiVwFtC4FQbR2deEyt4gJvgdq+ytfsJEAbVUndlPFM0FXUi+CoSfAqv7yTwFnOmiU+50xjjTfTEtVT9KU8rT/SVbdnSJx4MhVZc9KRcr2RMBB1c3VhTpGE9de51ecQAxg1CzVxxEegBG9oiy1aeOuSttdi5oP33e4ucc1hyzOoBDzpadE0fILXM6IEWg/vd0AYYqJtq9owcVXXod4J4B14H9O9kcAbXIAVWV9UPeQkMQ4I/je6Sm6Vuq/HFQi74CquQasga8BpGOoFl0WnAEOWUqeuUlXS1uoNlltqBfAo+pVAWLak9MekJ5c5rcgyC4X92tNgo4rjjDaUznlAPzUnTggWK6PeIOQLmgIj1hfmXt8CE6Z+WZ70Grmoiggw5B3frZ0EFHNuNxuxM5A3fJoYfOT05jmomcNqtxD0qVpyfyNn7liHI8AFsT5GLyLqZxDxMhY7qO/GzxkgFvZm8Hu/GIkVUu1lQ+BV2BYLGgb1lmpFoD31Edy/4eo8JbJty44ucmxnebvUpDHdJ+Q9dAR+B6aaimz+HR1H3mnP5leOieAI+Rdltb6RHc4nmX2gDYHVWiB0YStzwsQC7o7RzvHzT6adAxZGwedj0BvQCTlfQWgsbv7cLN2mHJOMUvX4YJKoxnwWGeg9NW/UN/Tn3kJDqaNH9/OHJyHRWrGuU9Yk5LRybbPR5N+6c/Pw+eX4TPUUFU8m1AhM/fBc/fB88/BM9/CZ7/Gjz/GDz/rX/eCbjYeRE+RwVRybch8V1IBEzthLXCSmGdgPGdgPGdgPGdgPGdgPGOPbyNc8uysqGvhq3yr6bD9kngtli7EUb6F8txpTmyeDVid7/C0c7dd80WErn0HqYFcIIsSmdGLWRK6raKDX1A+dxPhB4oFDhP1yHKr88trcAwzWEJIWa19hfKWsTiBSYadW1zqNcQzURBg86HJdNMQCDoUNZUlBDVOrSziKVjNlP4ZUgFkKVK+E1bg5xQrplYsB451Zziacco1FAQwDbIa7zCFHR0hvEKE6imAGR0GVJKhuSKBdQ50zMZvPH8xs74jd8Mt5AUeVTFfqYVOumix0aQK5aHtP821pGK0RKqoJcREy4OaEkpwB2LdLTO5G1P91FnA7zRPKg+BsWCAR/LvJDKn+W2EH69DCzpkhVB6aU/cWsoF/dBSGMAoJiQIabghi7XEBNqesKqOVWylsH4TRayvglfJeehVBMjs0UpeTCTpsA5E4Hmpkz5hT6gdfSSK74CIZehfq/uykIqGQzRW8jtXUjinjt4DYZzoRm8ZVwwGyj5reSFjA3vHSgNwaj9AoWis5CupZJ35Spg/xervO85PnB/dpp1wK8Brf9vHW3jt0KfdeLWE9wXLvy28DSjzbrjvwXgt2wQGA8yN14NOiybqwodrZg2/giqhWQW1ZB4lN3TZ1QVFmO4HhpBSUOK52xJdYhYxYzXYwetpDFBq0tqhf+Ke+qj/1OtwB0F9l8oXkPtis5u4QY4dQ7onM1WWDZyy+xo0vz968gts/5YfPcAbgDDJxpDE7elbIBjKqgPKC5+cX92hif72McFLOEGFTC+xJVhPJn+OHadN4HD7n7trLkjbbZohqKFDqTFW5ftqVQLD0swpVtAesSfQ7e0DylCYA4m7OIIT/Zm1gX9LfYKFiDnMkTYDQtJK2Du79+00DFwqBvT6LFqxqK34zc84BkIp6cADWU4kUJyv1S2kDse9V8dWugMxBrA0EYqiNg6k2gFIRAMfYuN4MYqGQEK8wYgFGbE8lsItXQBVoU8XjAbvuhCqrnkiwixFQ0HegwFHi8XMsI4hL2OmcmAqZDdsSyF3w33iICaRoAy6cifUwfwJShppChCJibA/KTogUqGFaZQskinU1BwG9XALg3UId9TFdnhO1jQiOT+Q2MLvIcaKdnavVTGFs5ILt8M3d8zvFgZHBbg92K3pvvI62qyu88x7m6fqcVtdUMpdidFU9QH/lcTNz92mo+fPeK3AVeT3RO4Bcb8c1NrZ2Lw0rnHRiwrWdG+JtgwXE2CbcHVpFOqDw7DwPDdzuQK/+fcj4sQN13M/K07q/FNZVczuHqIdzJRgf5W/aa+3bVWPLH47Su8st7MANaB9l5/JqsabzPfMlMSIKZUVJeSuyuemHKz8pf9qbtSKq2prbkWAbs/JYPkp5fJIPkH/ocPL/HPn15u1krbfXA72F8Y/c3bwW9bgeN7wb0eNmv7ED/RV+2tVyduc8G1ufmKWRI5kfN5cyl1rmTVFLk7r898hoPurmn392OdvkxJNSUdG24o9d612CEX0pALyznZIe/cq93Auxuz/lVM+zpX5+cDcoT3wV0eznNs/MYNkFRt41/1J5761qlv7UeN4dUU2VbudPsrdj5VlhL6rHhGfv3hOfnpJfnrD7/+NFP/mNjap/cgR303pO1Gk58G5KeXA/KPAfnHywF5+XLgsoL+9DIYdCENwXu6ySBp230h92eDDdxKhefyKd67lXZDXsfpPEp80HhzJSeAaTxNW3+3uU+EIFYYxgkz32hfRNyle8yCMJJQpdzhXncT+bu/rCc8/F5Sze/eXG9z4S6pNvs1e1Zb43NEmlf2OWn+BU0W2otNSWatrjaliYW5VEG9KDXJpxUFSUMvwpygF4P1WfI1uTprqTj/ejpNmy2zMT3G6yROiGnSUtYSTzBFpMku7KRvczY+vPgY50B8uPcphdE1++Z2vbs4/5VX0vsb548vhjdm0XrtL7pmdMbOWQYu8MUGHxbOrUczBQ334WE9iStZz8ds0iLXcy9dyoGupdB+ffj2+fP/IMeSbfLh7g2Wm21K5jYlc5uSuU3J3KZkblMytymZ25TMbUrmNiVzm5K5TcncpmRuUzK3KZnblMzGiW5TMrcpmR2yTcncpmRGxduUzJDepmR2wDYlc5uS2QHblMxtSuY2JXObkplsUzK3KZnblMxtSuY2JXObkrlNydymZG5TMrcpmduUzG1K5jYlc5uSuU3J3KZkblMytymZ25TMbUrmNiVzm5K5TcncpmRuUzL/H6ZkPmoVJ2kyny3ZJ7Ftszb/x7M215M2/7iUza/PwPzdFEyfapKjeX3/H6VZVlRrvDL7FakbsSl3DZMDwAxC9+9q7pFT4TMw+n/kk9R4+zhHZh/LFbT1srz4Y2W5EmBNKRW7o/ke2bd4kGOa95MuGWSDIGFDL8l3f6wkr6SasTynYo+8l5bkUnxjSAlLSmpcIV1OpFvxs4xq3SYt+azKTQJ2/Xnpvv9jpcOF1B3z7hEfYDkTonmfGJpLqjGfhdDPDI3rsURdH06ib7/9oy0Pr6YgOeOUoNWZ1R5pwiAcK7+mbZBj6HJ5UNSmh6Y1vuqHP9o5nOIlLQGcaKqWVHkp9si+IFZ0uUUOJDLL8PLLxun1CgzwTgWDRNMMjxtW7l8Qvrk16NcxGd9AgT5+3V9qDE0/72QypxPHpP+nhzl+J9xLsqvL82SQcHctqSObqbCXZFZxsvNPMr6akusEs5P3dncxpYiXUpu9H5//+OMu1Gx3+WK3ScR+cZ2Q6+trQcjOCblO9hvP4JS+Rw4oKKrIf+0Ph0eTSTp9c3Z0ETcY+uHama5qukfWR6yvm5Nv7q+TBV1dJ3vkOnFr1nXy8E3yMOiEG69M6fbgrXgd0AnIKqesZhLpa3Et2kR+8rKDMcB5gq8lX6+Fga9fUsip0i/v13Th2W70cZ2QPzfeKDX4ee+haY0yv9wk57V4ei1qxYR50vL7DCs/efo01MBrWMLE2VKghQjsh1oKjYrohMe9pSFzarLSyf6vSX7vBfBxGnI+vpquK2WvrUXWLQWF/bU1lnuvmalTzK+DvkloK149j+3F1271OZP5ao/gjuqZn85svnpyTxZ0FSiXPDzF2qjjv18LrxcMFzudrGm8qSQ5fcZl8QSrPv17glNybZ2scwzWYX1PjHm7TTib1O7CkPu3vveSNdXe14sHHDHnTfwstgoHdOO4JOuvP8diktMl5bJ2mZK+J2cvvqP7Gg9gMskf9nZ377Grh717fPfDo96aXwBousBQTzF0320OruvG73bm4CJ+x2awrWpI95MHySNlnUynY9L18zBIkJu4v07eR8xNvMPFMoyNMfY+HWMn7pAh6mSjqpr2rvaD+8fTW6eLXrXyQjrXe5/MnJW+auPp1+/woMStKi4D3pX2kbET+mGAjVNF57iH/Xc7wV60FJf9P+t+9Ds/ifP89zZX/+o+6nm4j3r+f3cf9fzRr998ObE8SCUP9LgBM2tIH1f4hO3/3T+w8/zf+oGdQYK/5/L4EKT9GYfgpCGA0N35essXfhbjJx3HWjNkv+Fa134BpOEUJ8FuzfE09GHgvd9943Y/JFDjmeryRdIOQDJI9mqXJu+90Ifk/h6N/krxhweE3fmZ32C3jtBZSc5cTJsne3Pgmj7ipgtOkyeXzQ7rqYvq1ze99aIfr5j3Ns9erPwQWqSSAYYMuJ4skoeP6D3diut48gXh2hk0fBQi4+LgW+xnGa3Nb9b9GKxk4yv0YbjguqhY5thEuQ+J+Nfx2P5WAf5QA2I+brE+fPZdopvD7WX4qyKtO2weUKiNWri/9zV85PDQKcWFWKiXh4f/Bpznq4w= -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update a report schedule'} +>     - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index a1284dc666c..3e84bed1201 100644 --- 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 @@ -1 +1,35 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"db_id":{},"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":{},"description":"string","extra_json":"string","label":"string","schema":"string","sql":"string","template_parameters":"string"}}},"description":"Model schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "catalog": { "maxLength": 256, "nullable": true, "type": "string" }, + "db_id": {}, + "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": {}, + "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 index 67497fdd3dd..a73b4b68e95 100644 --- 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 @@ -1 +1,118 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"catalog":{"maxLength":256,"nullable":true,"type":"string"},"db_id":{},"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":{},"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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "catalog": { + "maxLength": 256, + "nullable": true, + "type": "string" + }, + "db_id": {}, + "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": {}, + "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 index 8be710f138b..a638d088043 100644 --- 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 @@ -1,33 +1,32 @@ --- id: update-a-saved-query -title: "Update a saved query" -description: "Update a saved query" -sidebar_label: "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/isEMaAJpsRN0A6Bin5IgxZN17VZ7GwDosClxYulhiIZknLiCfrvw5F680vQrv2QFdgnS6e74z3PvZB0RTUzrAAHxtL4sqK5pDHVzGU0opIVgG83NKIGbsvcAKexMyVE1KYZFIzGFXVLjVq5dDAHQ+v6KmiDda8UX6JKqqQD6fCRaS3ylLlcydFnqyTKel/aKA3G5WC9GXNMqDk+Fuz+Pci5y2h8+PyXiMpSCDYT0IbTBGGdyeWc1hHls2nOaVzhI9jU5BqXRFdfNIV7Z9i0De6L6oLNQHxTjD3ugenB4dHXmN6KrwrOQaEFczAdpvmLdnUnUbPPkDoaUZc7VKdjtgD+ewlmeQ7WHet8X5cusMYKjSqDvLUOH05HrzFkvZc25PaClrOB5HZFYSviHtlGAL8pDoI0btfrvEaB1UraUJGHT59+Rz0bsKVw/9f5D1znGxarld9n+D/dAxsRnDooSJoxOQeOkJ59V50XYC2bw2BzeJDwVfo6Q/qKcdJsIjE5lQsmck56NEQbtcg5BrsJZmAbsBw8LpYLyUqXKZP/DTwmx6XLQLpmfdLNmy1AhoYBybPHRfJBOXKtSsljMsmgJRmQbqtKkwLhCiyRyhG4z5H+TVCdD4/o8PCxc6ONSvF1JoBgXtwyJn9guYX8gDHKbMNxokrBPdTGQ2ONSz1/7PY5lQ6MZIJYMAswAUVMjiUpJdxrSDFpXkhUmpbmgQJ8g0OsoyCiFtLSIEY8KX6+czS+vMLjnmNzPD1SnJcI4iqi93up4jD2sYWTpWASx2F6cf5+MNSa11A++F4aQfb+ImcXE5LQzDkdj0ZCpUxkyrr46OnR0YjpfLQ4GFkc0dNbnNGjg4SSJEkkIXtvSUKPm77xhMfkFTADhvx0fHLyejyeTj7++vrDqsFJSNXeZKkhJuvZ6nU5eVIl9AaWCY1JQhdMlJDQ+gmtow7h2dJlSg4wdoIOZV5oZVzbQDaRiWzPGeRlJ8YtZweXJf+SiigYZcA4GPuyWiMkxN6QklDyM2EpVvDUqRuQdWONwF9uA5vI3URqk0u30wa9j8o7u7tDGt6xBRv7YhpQsSLsk66kRTY6Btgdyx25BpdmnoBvgF8FFAW4THEM/+xiss5M3GqR9ZpBxJ/asqkCPRPPzqeoNxlWTeBos3KCdkvqTPFlTN6NP37YD02dXy93KnIDywHDpN5FbST6RSIDOZw51hGzRnujpATsCzXfQdXdFxQbc20/0Zw5IIx4vojni0Y0UIQXvRKz4i9/Md3GbaVvasybHyqhq0uDad2aHbq+/nv8TDgsQChdgHTNePJVExxV2iinUiXqeDSq0FUdV9gr9Ya3k9I6VbQuIrpgJscpbpuJ6t3gM4dr5k9lPkw8ZsmywHHVvOKPn1mr/t9OJmek81NHFKNZ9dfh3QhuHOYufsNbNFGGnJ6hE8Sy6mQrVY291679lbqdvWPcNQJIP4ErOvNl+kaZgqG/d39O2jMi9lb4Srudw4OuIzSeGrg2YLNvdYJerJLn/WX/9Q9xCYxoLq9VyMIK6aUGY2HlGtCLsOSD3uIgZNK6goW7U/ij5IH+WruXNRQ6uHcjLVgu0Zmv/qrpvUvKdI4rHiCyvv9oRGN9g5UaSvGSVtWMWbgwoq5RHLTiy6u+G3yT8tyfbziNr5mwsBFSd1ChO+fNeXSX9NleDbURMrn0TSdKfKMR7hPhz6L6CpvFT1i/evgwnJUDw42DEc6CYHGcpuD3iYd1rwbT6+wCS3bW/OVUKI4mht3hpZ7dhRiVhxwu4ygLm1UZDk3BJVY1HrsHqeqqv3lAUFtZqKqgEXaKuiPF76vIS13/A28+siI= -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update a saved query'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 4b10b8fe79a..2079616da07 100644 --- 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 @@ -1 +1,29 @@ -{"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}} +{ + "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 index 1b8c9a5b65b..527cc50288b 100644 --- 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 @@ -1 +1,116 @@ -{"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"}}} +{ + "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 index 109b9abe168..2d835a68a8d 100644 --- 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 @@ -1,33 +1,32 @@ --- id: update-a-tag -title: "Update a tag" -description: "Changes a Tag." -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update a tag'} +> - - Changes a Tag. - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.ParamsDetails.json index fd77b4c69a4..622893f11e4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.RequestSchema.json index ed296b95b42..24dea083999 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.RequestSchema.json @@ -1 +1,21 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"json_data":{"type":"string"},"theme_name":{"type":"string"}},"required":["json_data","theme_name"],"type":"object","title":"ThemeRestApi.put"},"example":{"json_data":"string","theme_name":"string"}}},"description":"Theme schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "json_data": { "type": "string" }, + "theme_name": { "type": "string" } + }, + "required": ["json_data", "theme_name"], + "type": "object", + "title": "ThemeRestApi.put" + }, + "example": { "json_data": "string", "theme_name": "string" } + } + }, + "description": "Theme schema", + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.StatusCodes.json index ae64ea21897..4809b36684a 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.StatusCodes.json @@ -1 +1,108 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"json_data":{"type":"string"},"theme_name":{"type":"string"}},"required":["json_data","theme_name"],"type":"object","title":"ThemeRestApi.put"}},"type":"object"},"example":{"id":1,"result":{"json_data":"string","theme_name":"string"}}}},"description":"Theme 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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "id": { "type": "number" }, + "result": { + "properties": { + "json_data": { "type": "string" }, + "theme_name": { "type": "string" } + }, + "required": ["json_data", "theme_name"], + "type": "object", + "title": "ThemeRestApi.put" + } + }, + "type": "object" + }, + "example": { + "id": 1, + "result": { "json_data": "string", "theme_name": "string" } + } + } + }, + "description": "Theme 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-a-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.api.mdx index 626c422cf8c..701a20db8ec 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.api.mdx @@ -1,33 +1,32 @@ --- id: update-a-theme -title: "Update a theme" -description: "Update a theme" -sidebar_label: "Update a theme" +title: 'Update a theme' +description: 'Update a theme' +sidebar_label: 'Update a theme' hide_title: true hide_table_of_contents: true api: eJzNV21v2zYQ/ivEYUATTImbrgMKFf2QBi3arkiD2NkLoiClxXPERiJZknLiCfrvw5GyLL9kWNsP2Sdb5N3xnudeeGzAcMsr9GgdpJcNSAUpGO4LSEDxCunrFhKw+LWWFgWk3taYgMsLrDikDfiFISmpPN6ghba9itLo/GstFiSSa+VRefrLjSllzr3UavTFaUVrK1vGaoPWS3T0RfvXgvvhMc5bqW6gTcAXWOF19HFrux16fDmwtKZ3lSz19PQL5p52pS9pYUJS5+j8sZGHpvZ0It7zypS44dryzHWPVp60CQh0uZWGQC9Nsw70JrPBcWe0cpGDZ0+f/gCDUgy4UXU1pQCFE+rS/98JbzeF10NA2I6GWL4lJg8EpTaCexR00vMfIr5C5/jNA0T9G6peEV5zwbo6Stl7NeelFGxVrcxYPZeCnN1GM9CNWI4eF8uF4rUvtJV/o0jZce0LVL47n/V5swPIUDEi+eVxkbzVdiqFQJWyv3TNhFZPPCv4HJlBW0nnCJHXjOc5Osd8IR2z6HRtc9wFsLcX0T1/XHSn2rOZrpVI2aTAZQqh6CEwodExpT3De0nJtY2otxEQPXv22JlnrKZQ8GmJjLLOL1L2OxVTzD60VttdOE50XYoAtbPQadNRvz52c3ivPFrFS+bQztFGFCk7VqxWeG8wp6CFRabzvLYPlNdb7nnZU5CAw7y2hJFGgS93HtLLK7rPPb+h8SB2SUdt/P4g1wLHwbU4OZRc3UAK+cX5R0ig5FMsV59dAaSQ17ZkB3+ys4sJy6Dw3qSjUalzXhba+fTF0xcvRtzI0fxoFFr36CgDlmWZYuzgHcvguGsHgemUvUZu0bKfjk9O3ozH15NPv705XVc4iTE6mCwMpmwzTCtZwZ40GdziIoOUZTDnZY0ZtE+gTXpsZwtfaDVA1y/0+GRltPXLynGZytTyPmev+mW64PboWPafSUiieIFcoHWvmg0qotcdHRmwn7sOdO31Laq20ybIr3bBzNR+poyVyu8t3T0k4b39/SEBH/icj0P+DEhYW1wFWitHPPTY+R2Xns3Q50WA/k3Am+h/hb7Qghw/u5hscpIupdhmnhDWz8tUaSIxk8DL52SlMsyUyM52tkTpJZ1TLRYp+zD+dHoYK1jOFnsNu8XFgFvW7pM0UfwyU5EWmlJ6SjYI74R0iYelvtkj0f2XQFW4cTWGWYVxFpiCBCI5NLDXFIkwxKewzmdjbluKUugasW5rS0HcGQvYPPMjbTOBcyy1qVD5rv+EHImGGmO117ku23Q0ashUmzZUE+2WtZPaeV0tTSQw51ZSm3Zdywxm6L/AGQ9DXnATEkBVV9SPuk/6CV1p3f67yeSM9XbaBMibdXs93i3nxrGx0h5Nj0xb9v6MjBCWdSM7qer0g3QbHkXL5jrOYxdNuxbbwDSk5lttK072Pvwxge6FRZUUd6G/GgLoNiHla4szi674XiNkxWl1vnquvfmeN04CUs10JGWNg9qgdTgc8wdLlIFRbn4UiXW+4uHm7Oxvpfia+f729HjvR6bkMgxRIQ2bLv0vgRtJZx0tfYcEUnNLyRKz4RKaZsodXtiybWn5a42WLsCrVUKGOhEyzBAC0hkvHW450w8DsHfeTbT7bEX4upPdIleLkPdlTV+QUGOOL+72ivI1NLZwetwYtqiB4tbwQeUYNY7zHENjflj2atA6zi4oa6bdu73SglQsv6N3Kr+LPuoAOeRvWIu3Qx0Hk2iSEosG90GQ+gTs/hConSw0TZSIDbrtSQkXGfHStv8AXCm+cg== -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update a theme'} +> - - Update a theme - + 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 index 32e33f67aca..fe23a883303 100644 --- 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 @@ -1 +1,18 @@ -{"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"}}]} +{ + "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 index 87799d55922..478531f61e9 100644 --- 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 @@ -1 +1,50 @@ -{"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}} +{ + "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 index 2ff8831be2d..58b8e870cd7 100644 --- 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 @@ -1 +1,111 @@ -{"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"}}} +{ + "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 index aba505dd21e..75e787f86b0 100644 --- 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 @@ -1,33 +1,34 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={ + 'Update an annotation layer (annotation-layer-pk-annotation-annotation-id)' + } +> - - 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 index a21f8dd40a1..72e71f5b2c8 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index f52f3eaf388..63fcb28dcb0 100644 --- 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 @@ -1 +1,28 @@ -{"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}} +{ + "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 index 29ca8c0132e..3f06800a6c8 100644 --- 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 @@ -1 +1,89 @@ -{"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"}}} +{ + "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 index dbdc671f4b3..9d389a1d9be 100644 --- 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 @@ -1,33 +1,32 @@ --- 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)" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update an annotation layer (annotation-layer-pk)'} +> - - 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 index 23e8648381e..6f7ffa71668 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}]} +{ + "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 index 59f73c0882f..47d753cff12 100644 --- 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 @@ -1 +1,37 @@ -{"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}} +{ + "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 index 8d9f5939fe8..990dc2a0aa5 100644 --- 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 @@ -1 +1,85 @@ -{"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"}}} +{ + "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 index db157c85eb5..72c869877d4 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update an existing form_data'} +> - - 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 index ef790456124..190269bf08e 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The Rule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index c13e8be385f..940defeeb5b 100644 --- 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 @@ -1 +1,58 @@ -{"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}} +{ + "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 index 73bcf18bb1d..6cc2e10b273 100644 --- 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 @@ -1 +1,148 @@ -{"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"}}} +{ + "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 index bb4ddabce96..ca62ff7691e 100644 --- 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 @@ -1,33 +1,32 @@ --- id: update-an-rls-rule -title: "Update an RLS rule" -description: "Update an RLS rule" -sidebar_label: "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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update an RLS rule'} +> - - Update an RLS rule - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.ParamsDetails.json index fd77b4c69a4..622893f11e4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "parameters": [ + { + "in": "path", + "name": "pk", + "required": true, + "schema": { "type": "integer" } + } + ] +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.RequestSchema.json index 763b0e4917c..bf881f2322d 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.RequestSchema.json @@ -1 +1,37 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"array","items":{"type":"string"},"description":"List of deleted chart customization IDs."},"modified":{"type":"array","items":{"type":"object"},"description":"List of modified chart customization configurations."},"reordered":{"type":"array","items":{"type":"string"},"description":"List of chart customization IDs in new order."}},"title":"DashboardChartCustomizationsConfigUpdateSchema"},"example":{"deleted":["string"],"modified":[{}],"reordered":["string"]}}},"description":"Chart customizations configuration","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deleted": { + "type": "array", + "items": { "type": "string" }, + "description": "List of deleted chart customization IDs." + }, + "modified": { + "type": "array", + "items": { "type": "object" }, + "description": "List of modified chart customization configurations." + }, + "reordered": { + "type": "array", + "items": { "type": "string" }, + "description": "List of chart customization IDs in new order." + } + }, + "title": "DashboardChartCustomizationsConfigUpdateSchema" + }, + "example": { + "deleted": ["string"], + "modified": [{}], + "reordered": ["string"] + } + } + }, + "description": "Chart customizations configuration", + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.StatusCodes.json index 28bc94c6ad6..318a48d7bb5 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.StatusCodes.json @@ -1 +1,94 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"array"}},"type":"object"},"example":{"result":[]}}},"description":"Dashboard chart customizations 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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { "result": { "type": "array" } }, + "type": "object" + }, + "example": { "result": [] } + } + }, + "description": "Dashboard chart customizations 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-chart-customizations-configuration-for-a-dashboard.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.api.mdx index 3705661a559..b69764c2434 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.api.mdx @@ -1,33 +1,32 @@ --- id: update-chart-customizations-configuration-for-a-dashboard -title: "Update chart customizations configuration for a dashboard." -description: "Update chart customizations configuration for a dashboard." -sidebar_label: "Update chart customizations configuration for a dashboard." +title: 'Update chart customizations configuration for a dashboard.' +description: 'Update chart customizations configuration for a dashboard.' +sidebar_label: 'Update chart customizations configuration for a dashboard.' hide_title: true hide_table_of_contents: true api: eJzFWG1v2zgM/isEccBanNusux0weNiHrtuw7oatWNN7QV10is3UWm3Jk+S0meH/fqBkO06T4l42oJ8SyyTF5yFFkW6wEkaU5MhYjM8blApjrITLMUIlSuKna4zQ0NdaGsowdqamCG2aUykwbtAtK5aSytEVGWzbiyBN1r3U2ZJFUq0cKcd/RVUVMhVOajX5YrXitQ1bevaFUocRVkZXZJwky28zKsixC4OgMEYsMULpqLSjdeuMVFfYRpiRTY2seD+M8b20DvQcOkuQ5sI4SGvrdCm/ea/g+JXdZ81SZ3Iu/9V2nb/3bteb2rpfqtVcXtXGP4WtDWmTkfkhUO+BCFKBohvwG+1j20bopCvY4ith85kWJjti1aOxpj3yzp5VmXB0GsLWRki3oqxYdxSj896zizGV501IjwHfSqxtNzAcbfpu1/nayEzPnq20siFnnjx+/J8ycD3jDNm6cBtR8GzdDf2IhF7tfBuogd5tobFQe24ztvj0u3wvyVpxRVtS5R+8HxTxpcigO8oxHKuFKGQGq4IBldELmbGzmzBHugHLwcNiOVOidrk28htlMRzWLifluv1hyKEtQMaKAckvD4vkjTYzmWWkYvhL15Bp9chBLhYEFZlSWsuInAaRpmQtuFxaMGR1bVLaBnCwF9A9fVh0H7SDua5VFsM0pz6FKBsgQKbJgtIO6FZycm0iGmx4RE+ePHTmVUZzKMSsIOCsc8sYfufDFLKPjNFmG44jXReZh9pZ6LR5q18fujgcK0dGiQIsmQWZgCKGQwW1otuKUg6aXwSdprW553i9EU4UAwURWkprwxi5G/lyE6roRYROXHGHsiqflm+W271UZ3Tq3QsNTCHUFcaYnn16jxEWYkbF6rE7BDGmtSlg7084OZtCgrlzVTyZFDoVRa6ti589fvZsIio5WRxMsn7DycHEV+zL9YqdICRJogD23kKCh12t8O9ieEnCkIGfDo+OXp+eXk4//vb6w7rCUQjg3nRZUQx3Y7iSzeBRk+A1LROMIcGFKGpKsH2EbTSAPlm63N+JPexhYQAuy0ob1x8rm6hE9fclvBiW96va7fC28P3sRMFOTiIjY180dzgKcDqeEoSfu7p16fQ1qbbTZi5ebMOfqN1EVUYqt9Pj2Gfhnd3dMTPvxEKc+qwbsbO2uEoNrSwTNJAiboR0MCeX5p6TH8NIE4CV5HKdMaKTs+ldsuJeCu5mFpPwuU+uJjA29YR9jlYq49wKtG3mV5DueZ7pbBnDu9OPH/ZDQZDz5U4D17QckQ7tLksz988TFfjKhBMDV3ci0QnpgvYLfbXDorvPkQ/1nZvWtz7b26K1rg/m2oCAgel9jDAQyeNK7ScHHmFi3AxKU123W+PCOeArWagjteEU2Rpp3Oi1+TVktKBCVyUp19VEn4HBUFMZ7XSqizaeTBo21cYNH8V2w1rouHsTES6EkXx12K6MezOh154L32d6NzFCUnXJNbJ75B9fJdftv51OT2Cw00bI3qzbG/BuOHcaij2/4/EQtIHjEzbCWNaNbKWq0/fSrZ8V+4Lvx4kA0pf9Bmc+v99oUwq29+6PKXaDJ5/T8BaH68qDbiNWvjQ0N2Tz/2uErVitPq2m2Nc/ZMKJUKq5DkbWSKkrMpaY7X4IGy1xSga5xUFg2rpS+Ou9m9C/6+CsuTK0A45u3aQqhPRdoc/hpjtU5ygqyX4dsHZvCiOM/ZeCrWfros+yc2yambB0Zoq25eWvNRm+7C9Wie7PXyZ9v5RhPBeFpQ0/h8YHdz513fsurAK57n8/vamlP09FzU8Y8XUSPnC0HJxQdf3u4cW4fo4UNxotPuZB4zBNyV8n98tejGrVyRln46z7TFLqjFWMuOGxVtwEH3UVKOS5ktfCnVaHJiyY5ITlIWUUvyGxuz8MaisLTRMkwu3RDqT465d5adu/AYY3T6Q= -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update chart customizations configuration for a dashboard.'} +> - - Update chart customizations configuration for a dashboard. - + 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 index 8a85f27369f..675dd97c350 100644 --- 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 @@ -1 +1,18 @@ -{"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"}}]} +{ + "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 index ad3cb291a0f..bb9b7adc980 100644 --- 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 @@ -1 +1,55 @@ -{"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}} +{ + "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 index 985a5804e87..f41e7fa3abc 100644 --- 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 @@ -1 +1,94 @@ -{"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"}}} +{ + "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 index 2bee894489e..a73100fc4e3 100644 --- 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 @@ -1,33 +1,32 @@ --- 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." +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update colors configuration for a dashboard.'} +> - - 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 index 74d702d0d05..9e47ade133e 100644 --- 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 @@ -1 +1,11 @@ -{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]} +{ + "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 index 261b28be132..fc901aa93d7 100644 --- 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 @@ -1 +1,23 @@ -{"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}} +{ + "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 index 76dd1a5bff8..568db1fe81a 100644 --- 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 @@ -1 +1,73 @@ -{"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":"User2"},"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"}}} +{ + "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": "User2" + }, + "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 index 41783f9b713..1fd8aea62cd 100644 --- 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 @@ -1,33 +1,32 @@ --- id: update-dashboard-by-id-or-slug-embedded -title: "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" +sidebar_label: 'Update dashboard by id_or_slug embedded' hide_title: true hide_table_of_contents: true api: eJytV2Fv2zYQ/SvEYUATTIntrAUKFf2QZinarmiD2MaGRYFLS2dLrUSqJOVEFfTfhyMlWbacoGv7yTJ5PN57fHc8VhChDlWSm0QK8GGKRjPOIq7jpeQqeqIZZkuMIoxYKMUqWReKk+0peJBzxTM0qDT4N9Wep1mMWzcsiZhUTKfFGjxIaD7nJgYPBM8QfEiihVSLZl7h1yJRGIFvVIEe6DDGjINfgSlzstZGJWINdX3rjFGbVzIqySKUwqAw9MnzPE1CG+3os6agqp6rXMkclUlQW9s0lXcYLSKZ8UTYocRgpg9s6rUDXCleQl33A74ZeLrt7OXyM4YGPDCJSWngsmH2z5amC8swbYH3PMvJ6EBoN20otzVtPqT98IkxI5lGM+DXxq9zKbSj4mw8/gkiFeoiNb+UYA/CmIs1RotlOXS8SpQ2CyejA66SqDecCINrVDSe8sdWFRrVA5P1w+c516jO+vE6qlZSZdyADxE3eGKSDMEbbtnlymIn5F5MxcGJR+IZ6Ou6OeepO7zh2l3lbc9yqMHbXZRwNj57ejKenEyezSZj/4+xPx7/C/uo2qBbMFsQQyFPizBErVdFmpakW2Zi3BU0Rft0PPkJsWaoNV9/1ynvMtMthLnghYmlSr5h5LPzwsQoTLM/6xLtAL7+QvL+7KfS7hcgeSsMiT5lGtUGFUOlpPLZuWCFwPscQ4ORG2QyDAv1AK7X3PDU2dnNNYaFSkxpr4jPd4a0Q3Xb8LWtZZ04bakkTBbxW5JHkVPKLLYiWpaL7U2xaOsceHB/EsoIpxaWu41SLtbgQzi/fg+U7ktMt3+1LFRIoMNCpezkH3Y1n7EAYmNyfzRKZcjTWGrjPx8/fz7ieTLaTEZdFKPJqN05ABYEgWDs5A0L4Lw5UAvAZ6+QK1Tst/OLi8vpdDH7+Nflh90FF+6wT2Zljj7bP++tbcSeVAF8wTIAnwWw4WmBAdRPoPY6oFeliaXoQe0GOrBJlktlWHNj6kAEoq387GU3fJoX5oi2ZT/GiOfWxsgjVPpltceLg9BwEwD7nXGb6Asjv6Com9WE/+UhzIE4DkSuEmGO2thPyfjo+LjPxju+4VOryh4jO4NbCUihiZSOCH7HE8NWaMLY8vDjLFQOTIYmlhGhuJrP9gnyWyu2ryAC/qkVUeVYmlmSPnnbJX0NOaqGOnLWLbdLGZU+ezf9+OHUFYlkVR5V7AuWPaJZfUzWxPeLQDiOIm54x88e+42RTPE0lesjMj1+AZToDj11fIWxTaOJwYche9U2s+tRL7VdOXJJXSg6x4PHAfuF6D1Nswg3mMo8Q2GawmZl4hxVuZJGhjKt/dGoIle1X1GO1ANvF4U2MmtdeLDhKuHL1FXf1g19R7ji9ta0YYIHKIqMCl3zl35sqdv1/2Y2u2Kdn9oDimbXX4d3ENzUVWyao66FWu23V+SEsOw6OUhVs95a17arbqu27RQcSFu7K1haQb5ue5p3f8+g6dApmdzstr+xoGuPFi8UrhTq+EedkBctxfW237/8viaZHhwr6WjY7TByVK4jbjum3hBpztltJo5KbTJuL+HmzTK3t1PvkbMs2VbDrCfhnX17d/z/e241bBi8N6M85YltgKyQqyarboDnCcU+6bde4IG/877qIrttZXYDVbXkGucqrWsa/lqgKl2b1yrdvfESTd8R+CueanwE2tF10/wcs0eeggcxte2/KG2ipQX9A48ug92nYk2H6+qojc4Z9Ctiz8GgnaI64FachyHaS+Fh234hu5qTXJfNizOTES1R/I6eVvzOxSotJe5JRGPuZipcq+VckqKpB+w1bZ3ymw8CdZCNqnIW7j6oO3LsJUq81PV/Otp2Tw== -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update dashboard by id_or_slug embedded'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 9d4fda00f4a..15dfefe769e 100644 --- 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 @@ -1 +1,37 @@ -{"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}} +{ + "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 index 3c9543a8105..72d9cbac017 100644 --- 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 @@ -1 +1,94 @@ -{"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"}}} +{ + "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 index 6e1c59fc66e..26c225d73bc 100644 --- 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 @@ -1,33 +1,32 @@ --- 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." +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update native filters configuration for a dashboard.'} +> - - Update native filters configuration for a dashboard. - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.ParamsDetails.json index fd77b4c69a4..622893f11e4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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-groups-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.RequestSchema.json index efc94cd3e8e..cf6b0e0007e 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.RequestSchema.json @@ -1 +1,54 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"type":"object","title":"GroupPutSchema"},"example":{"description":"string","label":"string","name":"string","roles":[1],"users":[1]}}},"description":"Model schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "Group description", + "maxLength": 512, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "label": { + "description": "Group label", + "maxLength": 150, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "name": { + "description": "Group name", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "roles": { + "description": "Group roles", + "items": { "type": "integer" }, + "type": "array" + }, + "users": { + "description": "Group users", + "items": { "type": "integer" }, + "type": "array" + } + }, + "type": "object", + "title": "GroupPutSchema" + }, + "example": { + "description": "string", + "label": "string", + "name": "string", + "roles": [1], + "users": [1] + } + } + }, + "description": "Model schema", + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.StatusCodes.json index a87a64e5667..254f8a52cf3 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.StatusCodes.json @@ -1 +1,125 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"type":"object","title":"GroupPutSchema"}},"type":"object"},"example":{"result":{"description":"string","label":"string","name":"string","roles":[],"users":[]}}}},"description":"Group 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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "description": { + "description": "Group description", + "maxLength": 512, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "label": { + "description": "Group label", + "maxLength": 150, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "name": { + "description": "Group name", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "roles": { + "description": "Group roles", + "items": { "type": "integer" }, + "type": "array" + }, + "users": { + "description": "Group users", + "items": { "type": "integer" }, + "type": "array" + } + }, + "type": "object", + "title": "GroupPutSchema" + } + }, + "type": "object" + }, + "example": { + "result": { + "description": "string", + "label": "string", + "name": "string", + "roles": [], + "users": [] + } + } + } + }, + "description": "Group 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-groups-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.api.mdx index 50d34852030..97d9facc0de 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.api.mdx @@ -1,33 +1,32 @@ --- id: update-security-groups-by-pk -title: "Update security groups by pk" -description: "Update security groups by pk" -sidebar_label: "Update security groups by pk" +title: 'Update security groups by pk' +description: 'Update security groups by pk' +sidebar_label: 'Update security groups by pk' hide_title: true hide_table_of_contents: true api: eJztWG1v2zYQ/ivEYUATTIntYAUKFf2QBu2armuN2tkGRIZLSxdbDUWqJOVEE/TfhyMlWX4JirYD8mH7ZJM8Hvk89/B4VAU51zxDi9pAeF1BKiGEnNsVBCB5htS6hQA0filSjQmEVhcYgIlXmHEIK7BlTlaptLhEDXU989Zo7EuVlGQSK2lRWvrL81ykMbepkoPPRknq2/jKtcpR2xQNtRI0sU5zst1rwq9aFTnr9wWQ8ft3KJd2BeHT0VkAWSrb9jAAWQjBFwJbCM3GjdWpXEIdgOALFA+t5Ae31hg9HX7zGp7Tw0u4se0VhtsrjA541EocoKtx6QcDSC1m5lC0Oodca15SuzBOC4f9+cFv8LfpUIvPGFsIwKaWCPIex4Wd+PDXAeA9z3JxgJ8GbReiTUej0a7dsHE9mnVIrkezmvax7fJ3laBgjfR29U20osmVNJ7as+HwB3Ss0RTC/q/v/7i+90y3Fb9RyY9qvyd9Uv6e9BuoecItJrSLX35I3hkaw5fYY6sN3lcQdxPhJU9Yc2eE7FKuuUgTtrmZWK7VOk1os/toenM9ltHjYrmSvLArpdO/MQnZeWFXKG2zPuvSzAEg/YkeyS+Pi+S9suxGFTIJ2XSFLclIdBtV6BhZotAwqSzD+5To3wfV+XCIzs4eOza5VjE1FwIZxcWWIfuD5Objg1orfQjHhSpE4qA2HprZtNTTxz4+l9Killwwg3qN2qMI2blkhcT7HGMKmutkKo4L/YAAX3PLRUdBAAbjQhNGKgw/31mXT2YBWL6k3AKTZpy5hGJgFgABc7AvEwjBp5h562e+dHbzRTl3NeX9SawSnDhAvvoUXC4hhPjq47tewmuaXnPULrRgJ3+x8dWURbCyNg8HA6FiLlbK2PDZ8NmzAc/TwXo0aJce+KUHowhYFEWSsZM3LILz5sC5LYfsJXKNmv10fnHxajKZTz/89ur99oQLH+OTaZljyHbDvLFN2JMqglssIwhZBGsuCoygfgJ10KEcl3blrvUWZ9fRIU2zXGnbnjwTyUi2dQl70XWf5oU9omXZd9AR+Ikr5Alq86LaIcXvvyEmAvYz4zHJf27VLcq6mU3gXxwCHMnjSOY6lfao3fgpGR8dH/epeMvXfOKU2KNjq3MTfCUNMdKxwO94atkN2njlSPhOCiqPJEO7UglBGF9Nd9kJWyu2qx1C/amVT+UpmjqGPgWbKX31eJ72FeStW2IXKilD9nby4f2pzwrpTXlUsVsseyyz+pisieznkfQEJdzyjpwd6hsjJfBUqOURmR4/BzrZOxeSO76sZYx5xtiiZO74eqrogVhQhNyjMYSHeK7y25ri6DKUP+2FpjAfjBbs7uUdDbME1yhUnqG0Ta5zKvKOqlwrq2Il6nAwqMhVHVZ0fuo9bxeFsSprXQSw5jqlK8E06dm58aXYDXdVmdsmBICyyCj3NU36cYlv2/+b6XTMOj91ALSbbX8d3r3NTXwSpzGq8JjS7HJMTgjLtpODVDXznXXtnuNtLFwl6kG6dF7Bwkn2tdIZJ39v/5xC87ans+ZHobuGHOg6oMlzjTcazep7nZAXo+THzYeCV//e42/Yq4CHszqAVN6ofceTIkdtsF+z97pIpt5uPfLsG5txd5U3637lfOw87xr4Fu/tIBc8le4xop3M/Nm5Bp6ntPIIepdvAN4vBBDmt6Q1L6ZrqKoFN3ilRV1T95cCdenL/1bP7pglqSt3EghvuDC4t7GuboGjj015esw28drecPv6kaU7NqKgFgSU+f2nopr49vnSre4H+pmvN3GvTqLT7GecxzG6zP+w7ayXg8ZXJLpF88EpUwlN0fyOVMHv/B6Vg+yf5NTnr5/C11DeJemSqvBewDr9Nn8I1EEWqspb+Lxfd6S4m5J4qet/AKsSrb4= -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update security groups by pk'} +> - - Update security groups by pk - + 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index fb36caf26d3..1cd5104ccfc 100644 --- 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 @@ -1 +1,17 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"permission_id":{},"view_menu_id":{}},"type":"object","title":"PermissionViewMenuApi.put"},"example":{"permission_id":{},"view_menu_id":{}}}},"description":"Model schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { "permission_id": {}, "view_menu_id": {} }, + "type": "object", + "title": "PermissionViewMenuApi.put" + }, + "example": { "permission_id": {}, "view_menu_id": {} } + } + }, + "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 index e3f754324e7..d49826fe9fc 100644 --- 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 @@ -1 +1,86 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"permission_id":{},"view_menu_id":{}},"type":"object","title":"PermissionViewMenuApi.put"}},"type":"object"},"example":{"result":{"permission_id":{},"view_menu_id":{}}}}},"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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { "permission_id": {}, "view_menu_id": {} }, + "type": "object", + "title": "PermissionViewMenuApi.put" + } + }, + "type": "object" + }, + "example": { "result": { "permission_id": {}, "view_menu_id": {} } } + } + }, + "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 index 31a0466d6b9..cb0937decad 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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: eJzFV21v2zYQ/ivEYUAdTImbogMKFf2QBi2ari9G7HQDosClpbPNRiJZknLiCfrvw5GSLL8Ua9dh+WSTujve8/A5HlmB5oYX6NBYiK8rEBJi0NwtIQLJC6TRLURg8GspDGYQO1NiBDZdYsEhrsCtNVkJ6XCBBur6JlijdS9VtiaTVEmH0tFfrnUuUu6EksMvVkma28TSRmk0TqD1IzSFsFYoORUZxFUdwUrg3bRAWTYzddSur2ZfMHUQgRMup4lR5/1J4N17lOWZFie6dFBHgPe80GT2favQOhna1AhNmUMM71WGOWsy36WnpgmrlbQByJPHj3+CBoO2zN3/SM+e1zZhvXy+i7o97i4cFixdcrnAjGI//Sl6CrSWL7AnReuMkIt/xNE5wkuesUayMbuQK56LjG0Kg2mjViKjZPfB9HwDltOHxXIleemWyoi/MIvZWemWKF2zPutkegBI3zEgefqwSD4ox+aqlFnMJktsSUai26rSpMgyhZZJ5RjeC6J/H1QXwyN68uSh90YbldJwliOjfXHrmH0iuYX9QWOUOYTjXJV55qE2ERpvWuq3hy6fC+nQSJ4zi2aFJqCI2ZlkpcR7jSltmp9kKk1L8w0BvuaO5x0FEVhMS0MYqS99uXMQX99Qc3F8Qb0Kxs13tjnKLFOSXTbysGxARxujs80ewU0EhNuzcpFBDKXOuMNpu8x0c5rZaSsxO52tp74B3h+nKsOxhx9aZc7lAmJIry7fQQQ5n2G+GQZ3GpcmZ8d/stHVhCWwdE7Hw2GuUp4vlXXxs8fPng25FsPV6bDNZNjL5LjLZHiaAEuSRDJ2/IYlcNZUqwcUs5fIDRr2y9n5+avxeDr5+PurD9sO50Egx5O1xpjtamRjm7FHVQK3uE4gZgmseF5iAvUjqKMO9Gjtlkr2YHcTHXBRaGVcW7Y2kYlsmyJ70U1TxxnQsuzn2YlCnCXyDI19Ue1wFOA0PCXAfmU8pVKaOnWLsm68iYsXh/An8iiR2gjpBi2OEzIeHB31mXnLV3zsVd1jZ2tyIw0lLRHUkcLvuHBsji5dek7+G0aqAKxAt1QZIRpdTXbJilsrtqssIuFzK64qMDbxhH2ONi59bQXa9vUVrFueZypbx+zt+OOHk3DgiPl6ULFbXPdIZ/URWRP3zxMZ+Mq44x1XOzvRGKkcT3K1GJDp0XOgQ2On1/nSZy2BrEdg110sm62ZL/3AHN2ES9o/fzuO4Tt3odK3NW26PxrDwVEa0sTBrYXdTN/RZ5bhCnOlC5SuOWS95EKgShvlVKryOh4OKwpVxxXVXr0X7by0ThVtiAhW3AjqRbbpCz4M/c9wzv0lz6cJEaAsCzp0myH9WNjj9c1kMmJdnDoCymY7Xod3L7lx6B70jV4eTBl2MaIghGU7yEGqGn9vXftnSLs1Y+p9AaTvIxXMvKBfK1Nwivf2jwk0bxoqzPAVuv7nQdcROU8Nzg3a5b8NQlGskpebB9KrH3uKRCDkXAU6ttCXGo3F/hW/N0XaC3ar00CpdQX3F4PmlfdjJbG1dndzcHjvhjrnQtIaXp1VUy7XwLWgRE6h19kjOFg0EEGsb0leQT/XUFUzbvHK5HVN019LNHQvuNlI2FdWJvzVKoN4znOLe3l2dyQYXDZX4SO22aLt/JtJLte+UvKSRhBRZwiv4vqGFO4PUL96+NA/CnuOe3cyKuDgcZam6DvDt21veqfQ6Ip0Nmve1oXKyMXwO3qG8ruQo/KQw/OR5kJ7KsN9LYQkKdGNv7d/nWSbPwTqIAtVFSxCI6g7UnwnJV7q+m/V7LKf -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update security permissions resources by pk'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 9428eade0e6..55108bd2484 100644 --- 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 @@ -1 +1,18 @@ -{"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}} +{ + "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 index 5fe712c423d..52ee13918c5 100644 --- 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 @@ -1 +1,89 @@ -{"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"}}} +{ + "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 index 6b334e84d13..d3169c03091 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update security resources by pk'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 1ef16a987eb..93229186a6c 100644 --- 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 @@ -1 +1,18 @@ -{"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}} +{ + "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 index 13ef2612add..85d1c9e4acf 100644 --- 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 @@ -1 +1,87 @@ -{"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"}}} +{ + "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 index 1ed087c7eb0..3ac47807463 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update security roles by pk'} +> - - 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-groups.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.ParamsDetails.json index 5c0c197a9fc..1d541341e82 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"role_id","required":true,"schema":{"type":"integer"}}]} +{ + "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-groups.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.RequestSchema.json index 54259d25f19..e742d945255 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.RequestSchema.json @@ -1 +1,24 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"group_ids":{"description":"List of group ids","items":{"type":"integer"},"type":"array"}},"required":["group_ids"],"type":"object","title":"RoleGroupPutSchema"},"example":{"group_ids":[1]}}},"description":"Update role groups schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "group_ids": { + "description": "List of group ids", + "items": { "type": "integer" }, + "type": "array" + } + }, + "required": ["group_ids"], + "type": "object", + "title": "RoleGroupPutSchema" + }, + "example": { "group_ids": [1] } + } + }, + "description": "Update role groups schema", + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.StatusCodes.json index 37e8c24e9dc..1d93f2d9e52 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.StatusCodes.json @@ -1 +1,93 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"group_ids":{"description":"List of group ids","items":{"type":"integer"},"type":"array"}},"required":["group_ids"],"type":"object","title":"RoleGroupPutSchema"}},"type":"object"},"example":{"result":{"group_ids":[]}}}},"description":"Role groups 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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "group_ids": { + "description": "List of group ids", + "items": { "type": "integer" }, + "type": "array" + } + }, + "required": ["group_ids"], + "type": "object", + "title": "RoleGroupPutSchema" + } + }, + "type": "object" + }, + "example": { "result": { "group_ids": [] } } + } + }, + "description": "Role groups 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-groups.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.api.mdx index 2bf27e844a7..d96f2fdd891 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.api.mdx @@ -1,33 +1,32 @@ --- id: update-security-roles-by-role-id-groups -title: "Update security roles by role_id groups" -description: "Update security roles by role_id groups" -sidebar_label: "Update security roles by role_id groups" +title: 'Update security roles by role_id groups' +description: 'Update security roles by role_id groups' +sidebar_label: 'Update security roles by role_id groups' hide_title: true hide_table_of_contents: true api: eJzVV21v2zYQ/ivEYUATTImTogMKFf2QBu2armiN2N4GRIZLi2ebrUSqJOXEE/TfhyMlWX4pVqwDgn2ySR2P9zz3ygoKbniODo2F+K4CqSCGgrsVRKB4jhCD0RnOpIAIDH4tpUEBsTMlRmDTFeYc4grcpiBRqRwu0UBdT4M0WvdKiw2JpFo5VI7+8qLIZMqd1Grw2WpFe1tdhdEFGifR0mppdFnMpPALgTY1sqCDEMN7aR3TC+ZFGIlEIB3m9phFUbvDjeEbqOs+nLveNdNOUs8/Y+ogAiddRhu3OsNfSXBYulGwt44AH3he0PcdY+8upzVdsmvypBDcISNKg9mWNcD32fX22UIrG3h4enHxAywatGXm/n/s1vviu3xvYfWZJ+IPmL/tUV56LwhS9uyHaM3RWr7EHiPWGamW/2h4dxBeccGaTInZjVrzTAq2TUpWGL2Wgow9xNQ7G7BcPi6WieKlW2kj/0IRs6vSrVC55n7WxcOxtOgdDEiePS6SD9qxhS6ViNl4hS3JSHRbXZoUmdBomdKO4YMk+g9BdTo8oqdPH9s3hdEpLecZMvKL28Tsdwq34B80RptjOK51mQkPtdHQnKarfnns9LlRDo3iGbNo1mgCiphdKVYqfCgwJaf5TabTtDTfCMA33PGsoyACi2lpCCP1xM/3zlcVql18SRUGRs13RmXFVzXC5VHfCIghVJhZq2ZGBd/O5uHPTIpZqEQQwcNZqgWOPLTQgjOulhBDOrl9DxFkfI7Zdhmij9alydjZn2w4GbMEVs4V8WCQ6ZRnK21d/Pzi+fMBL+RgfTlorRh4KwZVY0M9CEYkwJIkUYydvWUJXDWJ6LHE7BVyg4b9dHV9/Xo0mo0//vb6w+6B6+D7s/GmwJjtu38rK9iTKoEvuEkgZgmseVZiAvUTqKMO83DjVlr1UHcbHW6ZF9q4NiNtohLV9kn2sts+L0p3QteyHyYnCmpWyAUa+7LaoyigaWhKgP3MeEpJMnP6C6q6OU1UvDwGP1GniSqMVO6khXFOwienp31i3vE1H/l47ZGzs7kNDK0s8dNxwu+5dGyBLl15Sv4TQqqAK0e30oIADSfjfa7iVortxxVx8KkNrSoQNvZ8fYq2R/qRFVg7jK4g3dI812ITs3ejjx/OQyWRi81Jxb7gpsc5q09Jmqh/kahAl+COd1TtOaIR0hmeZ3p5QqKnL4CqwdHZruXPD3mWzcOfmRSsy/nAGg3aJbnOj9sxfKcDyNe+1oVqURoKhaMehX0L39NnJnCNmS5yVK6pmj7SgqKqMNrpVGd1PBhUpKqOK8q4+kDbdWmdzlsVEay5kdRcbFPovZowVy64H9O8mRABqjKnKtos6cfX0F39b8fjIev01BGQNbv6OrwHxo1CO6Bv9Ixh2rCbISkhLLtKjlLVnPfStX/OtG7xo2kA6RtDBXMfyG+0yTnpe/fHGJq3EeVj+ApdQ/Og64gOzwwuDNrVv1VCWqxWt9uH1uvjb5GLaR2BVAt9OOaPygKNxf4g3tuiMAty68vAnnU59029eR1+f9Tv3Nt1fIcPblBkXCrS74OwajLiDnghyYhL6HXkyD9ISWG8fZk2l0zbILmDqppzixOT1TVtfy3RUDefbuPUp4+QfiASEC94ZvHAym6ygZPbZoA9ZVs/7FrfvoHUxqdDVtIKIqr6vXd0Tc4IJdKbEL72i13v9ME4RakaTlylKfrS/23Zaa/WDCcUUfPmNZ5r4d/2/J4I5ffBUO1xhxcj7YX+U4ZRK6ikoKNhvefCLjibPwTqKBVVFSRCqa87ZnyrJF7q+m+Q7r84 -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update security roles by role_id groups'} +> - - Update security roles by role_id groups - + 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 index 5c0c197a9fc..1d541341e82 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"role_id","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 7dad5c14a29..f9bcb2aaf8b 100644 --- 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 @@ -1 +1,24 @@ -{"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}} +{ + "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 index 9edbb6b220a..20569b9b603 100644 --- 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 @@ -1 +1,93 @@ -{"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"}}} +{ + "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 index 53dccf3353a..47b71f248de 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update security roles by role_id users'} +> - - Update security roles by role_id users - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.ParamsDetails.json index fd77b4c69a4..622893f11e4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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-user-registrations-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.RequestSchema.json index 96f502941f8..2616c1ca120 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.RequestSchema.json @@ -1 +1,17 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.put"},"example":{"id":1}}},"description":"Model schema","required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { "id": { "type": "integer" } }, + "type": "object", + "title": "UserRegistrationsRestAPI.put" + }, + "example": { "id": 1 } + } + }, + "description": "Model schema", + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.StatusCodes.json index 717b98f5d52..dc254353bb6 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.StatusCodes.json @@ -1 +1,86 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.put"}},"type":"object"},"example":{"result":{"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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { "id": { "type": "integer" } }, + "type": "object", + "title": "UserRegistrationsRestAPI.put" + } + }, + "type": "object" + }, + "example": { "result": { "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-user-registrations-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.api.mdx index 8a654ff0e03..156d6576c4d 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.api.mdx @@ -1,33 +1,32 @@ --- id: update-security-user-registrations-by-pk -title: "Update security user registrations by pk" -description: "Update security user registrations by pk" -sidebar_label: "Update security user registrations by pk" +title: 'Update security user registrations by pk' +description: 'Update security user registrations by pk' +sidebar_label: 'Update security user registrations by pk' hide_title: true hide_table_of_contents: true api: eJzFV21v2zYQ/ivEYUATTImTogMKFf2QBi2arkuN2N4GRIFLi2dbjUSyJOXEE/TfhyMlWX4p9tIN+WSTujve8/DhHVmB5oYX6NBYiG8ryCTEoLlbQgSSF0ije4jA4NcyMyggdqbECGy6xIJDXIFba7LKpMMFGqjru2CN1r1RYk0mqZIOpaO/XOs8S7nLlBx8sUrS3CaWNkqjcRlaGmXiYPyonVKzL5g6iMBlLqeJiUVzg4vMOuNXsDdo3cXw6lSXDuoI8JEXmixD7POaggm0qck02UMMvyiBOWsy2oVd04TVStqQ4POzs++AZ9CWufvfYe85bhOxyaKlZI+TK4cFS5dcLlCQ94vvgl2gtXyBPYzWmUwu/jLTzhHecMEaicXsSq54ngm2ETLTRq0yQcnug+n5BiznT4tlInnplspkf6CI2UXplihdsz7r5HcASN8xIHnxtEiulWNzVUoRs/ESW5KR6LaqNCkyodAyqRzDx4zo3wfVxfCInj9/6r3RRqU0nOXIaF/cOma/ktzC/qAxyhzCcanKXHioTYTGm5b66amPz5V0aCTPmUWzQhNQxOxCslLio8aUNs1PMpWmpfmGAN9xx/OOgggspqUhjNRHvjw4iG/vqBk4vqDe8s0yBXcREEI/eSUghlIL7nDaBpyWFs3U9F2ns/XU96XHk1QJHHmUoYPlXC4ghnRy8xEiyPkM880wCJHGpcnZye9sOBmzBJbO6XgwyFXK86WyLn559vLlgOtssDoftGkM9tMYnCfAkiSRjJ28ZwlcNCfSf43ZG+QGDfvh4vLy7Wg0HX/6+e31tsNlEMHJeK0xZrs62NgK9qxK4B7XCcQsgRXPS0ygfgZ11CEert1SyR7mbqJDnRVaGdceTZvIRLYNjb3upqlvHNGy7DupiUKQJXKBxr6udggKWBqSEmA/Mp7SWZk6dY+ybryJiNeHwCfyOJHaZNIdtSBOyfjo+LhPywe+4iMv2x41W5MbUShpiZ2OEf7AM8fm6NKlJ+Q/oKMKqAp0SyUIznAy3mUqbq3YrqaIgc+trKpA19iz9TnauPRVFTjbV1awbkmeKbGO2YfRp+vTUE6y+fqoYve47jHO6mOyJuJfJTKQJbjjHVE729AYqRxPc7U4ItPjV0AlYaeT+ePOWvYYsce22GOzNfPHPdBGl9KSds5fVGP4O/xX+r6mvfYlL1SK0pAUDu4o7Ob4kT4zgSvMlS5QuqZ4eqWFQJU2yqlU5XU8GFQUqo4rOm/1XrTL0jpVtCEiWHGTUY+xTb33Yei/wDn31zOfJkSAsiyomDZD+rGwx+j78XjIujh1BJTNdrwO715yo9AV6Bu9AJgy7GpIQQjLdpCDVDX+3rr2z4F2X0bU0wJI3x8qmHkpv1Om4BTvw29jaN4WdB7DV+j6mgddR+Q8NTg3aJf/NghFsUrebB4qb7cfB2d1BJmcqwB4C1+p0Vjs38B7U6SuYLc6D6RZV3Df0pv31D+Q+9bCXcN3+OgGOueZpAW8+KrmKNwC1xllcQ69hhzB/oGACGJ9T9IJ2riFqppxixOT1zVNfy3RUC+/28jTnxqR+euQgHjOc4t7SXb3Gji6aa6vx2xD/3byzSSXa38K8pJGEFGxDy/P+o7U68uiXz186Be4nuPePYoOZ/C4SFP0xf7btne98jKckIZmzfu1UIJcDH+gJyF/CDkqHYikRxTNhY5ThjtWCEkyo1t6b/M6OTZ/CNRBFqoqWITyXnek+OZIvNT1n9amdAc= -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update security user registrations by pk'} +> - - Update security user registrations by pk - + 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index c9e8c1b6682..937bfaf26d7 100644 --- 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 @@ -1 +1,60 @@ -{"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"},"groups":{"description":"The user's roles","items":{"type":"integer"},"type":"array"},"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"},"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","groups":[1],"last_name":"string","password":"string","roles":[1],"username":"string"}}},"description":"Model schema","required":true}} +{ + "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" + }, + "groups": { + "description": "The user's roles", + "items": { "type": "integer" }, + "type": "array" + }, + "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" }, + "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", + "groups": [1], + "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 index a8819906e48..b3163c3f68f 100644 --- 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 @@ -1 +1,134 @@ -{"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"},"groups":{"description":"The user's roles","items":{"type":"integer"},"type":"array"},"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"},"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","groups":[],"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"}}} +{ + "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" + }, + "groups": { + "description": "The user's roles", + "items": { "type": "integer" }, + "type": "array" + }, + "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" }, + "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", + "groups": [], + "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 index 3978a18e836..f5deea77b1c 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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/isHYkASTImToAUKFcWQBi2armuD2tkGRIFLS2ebiUSqJOVEE/TfhyP14rdkW1ogwNBPNqm7I5/nXnhkxXKueYYWtWHhZcWEZCHLuZ2zgEmeIY1uWMA0fi2ExoSFVhcYMBPPMeMsrJgtc5IS0uIMNavrKy+Nxr5WSUkisZIWpaW/PM9TEXMrlBxcGyVprreVa5WjtgKNk42tWCD9S9DEWuSkxUJ2ZqAwqMF//+XM7hiQygKHmVIJ5CoVcQlWgcZMLRC4Ew/gujAWMn6DICwI2ZgPWgQTpVLkktUBw4yLdHPh0RydqR0DXqLTNVYLOSPVqdDGjj11D+g7MXBiW4zMtCpy86ABrVI0LGDCYma2+aEzy7XmJY1T/m92RlL3biznxtwqnTxooRWCqdLACztHaRufb7PpkXxnrKT5j1A7oYBl/O4Dypmds/D4+WHAMiHb8dHGnvv11OQaY0uohE1pYljkqA3aC4P6JBcHeWFdQN3xLE9xOap9HjWR1ppejZ9+tg2Iy6OrFT/2Er1n+rmGWafUE9LDqIM1bn5TCabQ5ON60pOr0ORKGu+u48PDb0hujaZI7Y+k/5H0/9Ok35BfLQN9/H9bQXhMPbivHGzUgzOLGcRzLmeY0P6ffVPKZ2gMn+GSL+/ldpWrTpG95gk0zUUIZ3LBU5FA38JArtVCJLTZTTBLuh7L0dNiuZCUJkqLvzAJ4WQlZaArvVuALCt6JM+eFslHZWGqCpmEQInWkIxEt1GFjhEShb5c450g+jdBdTYcouPjp/ZNrlVMw0mKQH6xZQi/U7h5/6DWSm/DcaqKNHFQGwuNNi31/KnT50xaSvsUDOoFao8ihBMJhcS7HGNympsEFceFvicA33LL046CgBmMC00Y6QZxfWupxNA1wPIZlRs2bL4DFUjDrgJGuBzqMypQRZ5wi+PWzJiKkxlPyrG7etztxyrBoYPjLykplzMWsvji8wdG5W+CaT/0EUfjQqew/yecX4wgYnNr83AwSFXM07kyNnxx+OLFgOdisDgatCsP3MqDo4hBFEUSYP8dROykyTa34RBeI9eo4aeT09M3w+F49OnXNx9XFU69g/dHZY4hrPu4l01gp4rYDZYRCyFiC54WGLF6h9VBB/K8tHN3hLYwu4kOqMhypW2bdiaSkWwbNXjVTdOptEvLwn9nI/B6c+QJavOqWuPEb7/hJWLwM/CYQn9s1Q3KutEm7K+24Y3kXiRzLaTdbfd9QMK7e3vLTLznCz50UbjExspk73olDRHSkcBvubAwRRvPHQePY6DyQDK0c5UQgvOL0To5YSsF65FDoL+0wVN5hkaOoC9Br7IcO56mzfjx0i2vE5WUIbwffvp44AuCmJa7FdxguUQy1HskTVy/jKTnJ+GWd9ysMd8IqRQPUjXbJdG9l4ySeu0scqkLLWGuuzIwKcGlrmeK3hAK63oSaq3YPSxX+U1NTnSlySd6ocnHW13F1nfygT5DggtMVZ6htE2RcyHkDVW5VlbFKq3DwaAiU3VYUe7UG9ZOC2NV1poI2IJrQWeBaeqyM+P7zCl3jZzbJgsYyiKjotcM6ceVvFX770ajc+js1AGj3aza6/BubG7oqzd9ox4OlIazc9epK71mZCtVjb6Trt2DTeuKIZ09HqSr4xWbuIB9q3TGyd77P0asef1x1yf3tW/wHeg6IOWxxqlGM3+sEbJilPzcPyW9+V6X6MPHNM2H27vmgAk5VZs3jvZOsOWaQOGE2ni5xZF3nLEZd8d/Y//hxFpZq+sHLN7ZQZ5y4e6zLuarJukuGc8FLXzEls5rj4huWWF+Q0Hqo/CSVdWEG7zQaV3T9NcCdekvDm0iuPxMhGuQEhZOeWpwY19dp8N2PzcN7R70jl7db3ubk6XLt7SgEQvovPCvkPUV5Ykrs251/2G5YC4pbnRWVAa8xkkcozsv7pe9Wqpd5xcUrZPmLTNTCalofkuxwW/9HpWD7B82aM4fWoXvurxJCmjq25f81QV+84dAbWWhqryEPy7qjhR3vhIvdf03+cyEjA== -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update security users by pk'} +> - - Update security users by pk - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.RequestSchema.json index 26c4519543d..36e8bdc94a3 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.RequestSchema.json @@ -1 +1,37 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"first_name":{"description":"The current user's first name","maxLength":64,"minLength":1,"type":"string"},"last_name":{"description":"The current user's last name","maxLength":64,"minLength":1,"type":"string"},"password":{"description":"The current user's password for authentication","type":"string"}},"type":"object","title":"CurrentUserPutSchema"},"example":{"first_name":"string","last_name":"string","password":"string"}}},"required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "first_name": { + "description": "The current user's first name", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "last_name": { + "description": "The current user's last name", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "password": { + "description": "The current user's password for authentication", + "type": "string" + } + }, + "type": "object", + "title": "CurrentUserPutSchema" + }, + "example": { + "first_name": "string", + "last_name": "string", + "password": "string" + } + } + }, + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.StatusCodes.json index ce84b5655b4..8cf0ac004ba 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.StatusCodes.json @@ -1 +1,66 @@ -{"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"},"login_count":{"type":"integer"},"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","login_count":1,"username":"string"}}}},"description":"User updated 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"}}} +{ + "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" }, + "login_count": { "type": "integer" }, + "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", + "login_count": 1, + "username": "string" + } + } + } + }, + "description": "User updated 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" + } + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.api.mdx index 0139af64327..e23f7fe241a 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.api.mdx @@ -1,33 +1,32 @@ --- id: update-the-current-user -title: "Update the current user" +title: 'Update the current user' description: "Updates the current user's first name, last name, or password." -sidebar_label: "Update the current user" +sidebar_label: 'Update the current user' hide_title: true hide_table_of_contents: true api: eJzFV1Fv2zYQ/ivEYUATTInroRgKFX1Igg5tV7RGbWMDoiClpbPNRiJVknKiCfrvw5GSLFlukS0D9iTpdHe877vj8VhBgibWIrdCSQhhmSfcomF2iywutEZpWWFQPzNsLbSxTPIMA5by7lVplnNj7pVOziEAjd8KNPZSJSWEFcRKWpSWXnmepyLmtNDkq6HVKjDxFjNOb7lWOWor0NCXW+uWFqCvYYiLH4UGAWT84QPKjd1C+OuLADIh289pALbMEUIwVgu5gToAQvL4hTrc/3idlqNHLdMqs7XSjBd2i9I21MHId91J1OorxpY0hE1JcOXdLg3qWWHnnuw6AHzgWZ7iIdOtywEre+Eewn7t2mdcaEwgtLpAJzC5ksZn8pfnz59QBxpNkdqxHDMuUnoZ8TysnNFvkfTEQlrcoHZyc8tjK3Z9q5VSKXLZ/pZKlpkqzHGNQR2Nq0xthLyNVeEpGK9Pif+O9Q/yS4n93LDdZnekPsz3ntGGw31+j5cCMTYdEERpPqTEy46WzQD7tA+1V0Z1cNiIDGpWuG6UMFPEMRqzLtK0JDwvnlRUGRrDN4+ieshdZwiXPGFNpwvZO7njqUhYzjXP0KI2LNdqJxJM4Aiynq3HMv1/sSwldRilxV+YhOxi0G1Yt7mPpahn6NYzGBda2BLC6wq+3lsIr2/qmwAs3xgIr9t2xCi3cBPAw1msEpy7mIwzSrncQAjx8vMH14VWmO4/jSp0TBHHhU7Z2Z9stlywCLbW5uFkkqqYp1tlbPjy+cuXE56LyW46yXASAYuiSDJ29pZFcNGE7OCF7BK5Rs1+uri6ejOf3y4+/f7m49DgyifmbFHmGLLD3Ox1E/asiuAOywhCFsGOpwVGUD+DOuhwzUq7dS28RdYJOmwiy5W2bYGYSEay7afsdSc+zwt7QsuyRxEQeNUt8gS1eV0d0OAjbqiIgP3MuNtvt1bdoawba4L7+hjESJ5GMtdC2pM21HNSPjk97YN/z3d87sqnR8BAuE+wkoY46HDzey4sW6ONtw72o0FXPvYM7VYlFPRsuTjkI2y12GF9EM4vbYlUnpSF4+RLsDfpV4hnZlwlXrulcqWSMmTv558+nvvtKtblScXusOzxyupT0iZ6X0XSU5Jwyzs6DshulFSK56nanJDq6Sug/efRQwh5Yd05TkMK9Mgi7lHvUPtdWGhKzVGG4bAJfKDfLMEdpirPaHd7Ty7z3lGVa2VVrNI6nEwqclWHFVV5PfJ2VRirstZFADuuBV+lvte1bvwItebuHHNhQgAoi4x6TPNJD0M9Zuj/7WIxY52fOgCKZuivwzsKbu6iYvSPzi+afN/N3Gyn9IGTo1Q19k67rikxbcN0Z7cH6dpmBStXdL8pnXHy9/6PBeXIqdHc4f7uR0EHug7I+FbjWqPZ/lsn5MUo+Xk/xr/5r4bFAIRcq/EAPC9y1Ab7g01PRFXp9XZTT7axGXeHYrOmv7OMriyH/PfO2KdfcxrOLD7YSZ5y4WZAV+5Vs7+ugeeC4p/SXYEuDFSOvt6uoapW3OBSp3VN4m8Fajo2b/Yl7w7PAHyPctvyDkvaIr1u43ZIWlAko6GB9p+3uIhjdP31+7r9JjFbUpmsmgtcphIy0fyeLnf8HkKAAJTj1I/oJPNNvvADhXdJlUTzQX9cbiuueSFQzS8uy16AVeU1fK+lNuGRuPMI6pu6rv8G5r8OqQ== -sidebar_class_name: "put api-method" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Update the current user'} +> - - Updates the current user's first name, last name, or password. - + 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 index 9dceb7ca0b8..1186b828edf 100644 --- 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 @@ -1 +1,34 @@ -{"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}} +{ + "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 index 7e7600ea45a..7cc087f26cc 100644 --- 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 @@ -1 +1,93 @@ -{"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"}}} +{ + "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 index bd0e04a0410..13f486e5a13 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Upload a file and returns file metadata'} +> - - 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index 1889ea6f371..fe8e8f8d7bb 100644 --- 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 @@ -1 +1,111 @@ -{"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}} +{ + "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 index 226e01c4f7c..0b2e98b6a6f 100644 --- 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 @@ -1 +1,80 @@ -{"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"}}} +{ + "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 index 7a7d0ea5f80..221e756fcec 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Upload a file to a database table'} +> - - Upload a file to a database table - + Request diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/user-registrations-rest-api.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/user-registrations-rest-api.tag.mdx index a06d35cf3e0..b3724df32aa 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/user-registrations-rest-api.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/user-registrations-rest-api.tag.mdx @@ -1,19 +1,19 @@ --- id: user-registrations-rest-api -title: "UserRegistrationsRestAPI" -description: "UserRegistrationsRestAPI" +title: 'UserRegistrationsRestAPI' +description: 'UserRegistrationsRestAPI' custom_edit_url: null --- Endpoints related to UserRegistrationsRestAPI. -| Method | Endpoint | Path | -|--------|----------|------| -| `GET` | [Get security user registrations](./get-security-user-registrations) | `/api/v1/security/user_registrations/` | -| `POST` | [Create security user registrations](./create-security-user-registrations) | `/api/v1/security/user_registrations/` | -| `GET` | [Get security user registrations info](./get-security-user-registrations-info) | `/api/v1/security/user_registrations/_info` | -| `DELETE` | [Delete security user registrations by pk](./delete-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` | -| `GET` | [Get security user registrations by pk](./get-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` | -| `PUT` | [Update security user registrations by pk](./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)](./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)](./get-related-fields-data-security-user-registrations-related-column-name) | `/api/v1/security/user_registrations/related/{column_name}` | +| Method | Endpoint | Path | +| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| `GET` | [Get security user registrations](./get-security-user-registrations) | `/api/v1/security/user_registrations/` | +| `POST` | [Create security user registrations](./create-security-user-registrations) | `/api/v1/security/user_registrations/` | +| `GET` | [Get security user registrations info](./get-security-user-registrations-info) | `/api/v1/security/user_registrations/_info` | +| `DELETE` | [Delete security user registrations by pk](./delete-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` | +| `GET` | [Get security user registrations by pk](./get-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` | +| `PUT` | [Update security user registrations by pk](./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)](./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)](./get-related-fields-data-security-user-registrations-related-column-name) | `/api/v1/security/user_registrations/related/{column_name}` | 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 index f3ec7f344da..dbb6880db01 100644 --- 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 @@ -1,12 +1,12 @@ --- id: user -title: "User" -description: "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` | +| 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-a-sql-expression-against-a-datasource.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.ParamsDetails.json index e4cca44326a..7e2164b2657 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.ParamsDetails.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.ParamsDetails.json @@ -1 +1,18 @@ -{"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"}}]} +{ + "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" } + } + ] +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.RequestSchema.json index c5f4f1013aa..2743a477562 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.RequestSchema.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.RequestSchema.json @@ -1 +1,36 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"clause":{"description":"SQL clause type for filter expressions","enum":["WHERE","HAVING"],"type":"string"},"expression":{"description":"The SQL expression to validate","type":"string"},"expression_type":{"default":"where","description":"The type of SQL expression","enum":["column","metric","where","having"],"type":"string"}},"required":["expression"],"type":"object"},"example":{"clause":"WHERE","expression":"string","expression_type":"column"}}},"required":true}} +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "clause": { + "description": "SQL clause type for filter expressions", + "enum": ["WHERE", "HAVING"], + "type": "string" + }, + "expression": { + "description": "The SQL expression to validate", + "type": "string" + }, + "expression_type": { + "default": "where", + "description": "The type of SQL expression", + "enum": ["column", "metric", "where", "having"], + "type": "string" + } + }, + "required": ["expression"], + "type": "object" + }, + "example": { + "clause": "WHERE", + "expression": "string", + "expression_type": "column" + } + } + }, + "required": true + } +} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.StatusCodes.json index 9f8f0258821..63505ce3741 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.StatusCodes.json +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.StatusCodes.json @@ -1 +1,105 @@ -{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"Empty array for success, errors for failure","items":{"properties":{"end_column":{"type":"integer"},"line_number":{"type":"integer"},"message":{"type":"string"},"start_column":{"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"example":{"result":[{"end_column":1,"line_number":1,"message":"string","start_column":1}]}}},"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"},"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"}}} +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "description": "Empty array for success, errors for failure", + "items": { + "properties": { + "end_column": { "type": "integer" }, + "line_number": { "type": "integer" }, + "message": { "type": "string" }, + "start_column": { "type": "integer" } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "example": { + "result": [ + { + "end_column": 1, + "line_number": 1, + "message": "string", + "start_column": 1 + } + ] + } + } + }, + "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" + }, + "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/validate-a-sql-expression-against-a-datasource.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.api.mdx index e0a88f880ec..11a52e8fed6 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.api.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.api.mdx @@ -1,33 +1,32 @@ --- id: validate-a-sql-expression-against-a-datasource -title: "Validate a SQL expression against a datasource" -description: "Validate a SQL expression against a datasource" -sidebar_label: "Validate a SQL expression against a datasource" +title: 'Validate a SQL expression against a datasource' +description: 'Validate a SQL expression against a datasource' +sidebar_label: 'Validate a SQL expression against a datasource' hide_title: true hide_table_of_contents: true api: eJzFWG1v3DYM/isCMaAJ5uSarQMKF/2QZunSrkiz3LXdEAeZzubFam3JleRLbob/+0DJb3fndOsLmk+5yBSp5yEpkqqg4JrnaFEbCC8qSNDEWhRWKAkhzFJkdlUgUwuWcMuNKnWMEICgrwW3KQQgeY4QQv/9irZAABo/lkJjAqHVJQZg4hRzDmEFTiAEY7WQ11DXwZhhkZBZm+LnmBbJ/zEspMVr1FDXl14ajX2mkhWJxEpalJZ+8qLIRMzpTJP3hg5WDXQVWhWorUDjtmW8NEi/1pFM/3jF/DfP5EJpthCZRc3wttBojFDSQAAoyxzCC3h3cnx+DAGcHL59cfobXAabbAXQb9y2R8yRzV6GWcWWPBMJt8TfJ7R5xzmVC15mFkK4SVHTrrvjYt3YAEissjKnhRytFjEEnbKUL8n2NrR66LuLIc5eVs3fY2z9wXleZDhkv2NvSFGrfgRqe8h63TSFjVswhZLGO/inhw+/Ijw0GkfopruO88KuGNear1xomDKO0ZiAodZKGx8uXGSlI05YzM22cpTJVQNkJMYDyITEK1nmc9TjAjkaw69xJDUDMJZr+wn19YhnmgUHa1xi4LuWmot1IAcb5z4YHLP36PrpDupL58l1jt/64KdUaGzVATz6KnfeTdh/gO0hPOMJa66ekL2QLkNZfxuzQqulSDCBEUSDvR7Lwf1ieSN5aVOlxT+YhOywtClK29hnXVqNABlu9Eh+vl8kz5WeiyRBGbK/VMkSJR9YlvIlsgJ1LroLlbs0ZTYVhoLKF6cRgJ0+j+7R/aI7VZYtVCmTkNEV3oQQJh0Elig0TCrL8FZQcG0j6nSQlV/uO4teSIta8owZ1EuqqXRthuxQslLibYExoXOLTMVxqe+Iw+fc8szLOeMG41ILu3K30vsbup0uqVew/Jr6JPi16zgMlabbvVglOHXn831UxuU1lZc3568ggIzPMev/bcIlhLjUGdv7k529ns5YBKm1RTiZZCrmWaqMDR8/fPx4wgsxWR5M+iZnUm30WvXaikjqSVvvr/qKN4mARVEkGds7YREcNnnnPBWyZ8g1avbD4dHR8XR6NXv9+/Hp+oYj7+O92arAkG26uZdN2IMqgg+4iiBkESx5VmIE9QOgLq+h5WxlU9crtMR0Cx01Ii+Utm2ImkhGsi3H7Gm3vF8oY3fILvsO/AXeUIo8QW2eVhssesANkxGwH5tb4sqqDyjrZjex9XSMoUjuRrLQQtqdFuk+Ce/s7g65e8mXfOpCd8Df2mIfXkoaorCjjd9wYdkCbZw60r4TZZVHnqNNVUKQKd436QxbMbYZnUTT322AVp7TmaP076DfMoxPT+x2jHrp1hNzlaxC9nL6+nTf3ztisdqp2AdcDdzC6l2SJu88iaRnlJB3bG74qhFSGe5n6nqHRHefAN0do00JMr7ZrvNrLsgKX597PHs0+yhDXnYjUAjfzFcUOO4O9RdYqSmuRsNjaxx4RZ9ZgkvMVJGjtM1t7MLWK6oKrayKVVaHk0lFquqwogyvt7QdlcaqvFURwJJrwecZto2vU7M+pdAxB5NH8y/9cdfzuv6T2eyMdXrqAOg06/o6vFuHm/oyQ99o+GRKsxdnpISwrCsZparZ76RrN362pWZKRdKDdAWngrkL+edK55z0vXw3g2aWpeT2X/uBzoGuA9p8pXGh0aRfqoS0GCXP+8H4+BuMWn76q2mCX6iRQbksUBskyq2wZGu4RHHp5ZYHnm5jc+66i+YR4LMTas1814FYvLWTIuPCdWwueKsm1y6AF4LOckC7h6rC7cePcPNRYiTnIAAKTx9/F1BVc27wjc7qmpY/lqipAbnsU8A/0QhDvxMIFzwzuAWka8Zg57xpvXfZnS85o7Db+U2u/MFL+g8CqlkjLz3u+eZLD3XHK8/XHUskUF9SZrvS4ljzMsMiMdCx1bQSJL/jMI7RVdW7ZS8HlzNVNghg3jwm5SqhPZrf0LMUv/HnVY4W/y5Aa762l76j9TopB2k0GkRml6vND0I1ykhVeQlfI+uOINeGgBuR/wX1iPLN -sidebar_class_name: "post api-method" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Validate a SQL expression against a datasource'} +> - - Validate a SQL expression against a datasource - + Request 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 index fd77b4c69a4..622893f11e4 100644 --- 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 @@ -1 +1,10 @@ -{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} +{ + "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 index f4fb7786d8e..00ad89ac33f 100644 --- 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 @@ -1 +1,31 @@ -{"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}} +{ + "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 index d02b67542e5..e54d26db111 100644 --- 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 @@ -1 +1,83 @@ -{"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"}}} +{ + "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 index 38ac50af0b8..501807296a5 100644 --- 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 @@ -1,33 +1,32 @@ --- id: validate-arbitrary-sql -title: "Validate arbitrary SQL" -description: "Validates that arbitrary SQL is acceptable for the given database." -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Validate arbitrary SQL'} +> - - 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 index 306059b9fc5..1ace53615c3 100644 --- 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 @@ -1 +1,84 @@ -{"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}} +{ + "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 index c981bad450c..e953eaf2ee8 100644 --- 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 @@ -1 +1,54 @@ -{"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"}}} +{ + "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 index 6fb455262f0..45cf06eae60 100644 --- 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 @@ -1,33 +1,32 @@ --- id: validate-database-connection-parameters -title: "Validate database connection parameters" -description: "Validate database connection parameters" -sidebar_label: "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" +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 MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Validate database connection parameters'} +>     - - 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 index 945e96e2c1e..2cc3178b377 100644 --- 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 @@ -1 +1,40 @@ -{"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}} +{ + "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 index b22256ba3dd..86da629ba66 100644 --- 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 @@ -1 +1,80 @@ -{"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"}}} +{ + "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 index 2de180964d7..9a3ad8a6d34 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Warm up the cache for each chart powered by the given table'} +> - - 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 index 31b80a7de6e..19ff8604a9e 100644 --- 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 @@ -1 +1,35 @@ -{"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}} +{ + "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 index d7318bd7864..14f3557f6a2 100644 --- 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 @@ -1 +1,80 @@ -{"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"}}} +{ + "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 index 7256cda9a0c..17dc5346176 100644 --- 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 @@ -1,33 +1,32 @@ --- 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" +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" +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"; +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; - + as={'h1'} + className={'openapi__heading'} + children={'Warm up the cache for the chart'} +> - - 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 index c3564104795..a43477e873b 100644 --- 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 @@ -68,4 +68,4 @@ Future phases will add support for these sources. --- -*Auto-generated by generate-superset-components.mjs* +_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 index d6e88517ab8..9a0336c9873 100644 --- 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 @@ -33,72 +33,72 @@ DropdownContainer arranges items horizontally and moves overflowing items into a @@ -110,18 +110,30 @@ Edit the code below to experiment with the component: 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, + element: React.createElement( + 'div', + { + style: { + minWidth: 120, + padding: '4px 12px', + background: '#e6f4ff', + border: '1px solid #91caff', + borderRadius: 4, + }, }, - }, 'Filter ' + (i + 1)), + 'Filter ' + (i + 1), + ), })); return ( -
    +
    Drag the right edge to resize and see items overflow into a dropdown @@ -138,21 +150,37 @@ 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'), - }) + element: React.createElement( + 'div', + { + style: { + minWidth: 150, + padding: '4px 12px', + background: '#f5f5f5', + border: '1px solid #d9d9d9', + borderRadius: 4, + }, + }, + label + ': All', + ), + }), ); return ( -
    +
    ); } ``` - - ## Import ```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 index 996f054a61a..6b8e80867cf 100644 --- 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 @@ -33,70 +33,62 @@ The Flex component from Superset's UI library. ## Try It @@ -157,9 +149,17 @@ function JustifyAlign() { }; return (
    - {['flex-start', 'center', 'flex-end', 'space-between', 'space-around'].map(justify => ( + {[ + 'flex-start', + 'center', + 'flex-end', + 'space-between', + 'space-around', + ].map(justify => (
    - {justify} + + {justify} +
    @@ -174,14 +174,14 @@ function JustifyAlign() { ## Props -| Prop | Type | Default | Description | -|------|------|---------|-------------| -| `vertical` | `boolean` | `false` | - | -| `wrap` | `string` | `"nowrap"` | - | -| `justify` | `string` | `"normal"` | - | -| `align` | `string` | `"normal"` | - | -| `flex` | `string` | `"normal"` | - | -| `gap` | `string` | `"small"` | - | +| Prop | Type | Default | Description | +| ---------- | --------- | ---------- | ----------- | +| `vertical` | `boolean` | `false` | - | +| `wrap` | `string` | `"nowrap"` | - | +| `justify` | `string` | `"normal"` | - | +| `align` | `string` | `"normal"` | - | +| `flex` | `string` | `"normal"` | - | +| `gap` | `string` | `"small"` | - | ## Import 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 index 16f13d42ee0..5863a4a763f 100644 --- 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 @@ -34,52 +34,87 @@ The Grid system of Ant Design is based on a 24-grid layout. The `Row` and `Col` component="Grid" renderComponent="Row" props={{ - align: "top", - justify: "start", - wrap: true, - gutter: 16 -}} + align: 'top', + justify: 'start', + wrap: true, + gutter: 16, + }} controls={[ - { - name: "align", - label: "Align", - type: "select", - options: [ - "top", - "middle", - "bottom", - "stretch" - ], - description: "Vertical alignment of columns within the row." - }, - { - name: "justify", - label: "Justify", - type: "select", - options: [ - "start", - "end", - "center", - "space-around", - "space-between", - "space-evenly" - ], - description: "Horizontal distribution of columns within the row." - }, - { - name: "wrap", - label: "Wrap", - type: "boolean", - description: "Whether columns are allowed to wrap to the next line." - }, - { - name: "gutter", - label: "Gutter", - type: "number", - description: "Spacing between columns in pixels." - } -]} - sampleChildren={[{"component":"Col","props":{"span":4,"children":"col-4","style":{"background":"#e6f4ff","padding":"8px","border":"1px solid #91caff","textAlign":"center"}}},{"component":"Col","props":{"span":4,"children":"col-4 (tall)","style":{"background":"#e6f4ff","padding":"24px 8px","border":"1px solid #91caff","textAlign":"center"}}},{"component":"Col","props":{"span":4,"children":"col-4","style":{"background":"#e6f4ff","padding":"8px","border":"1px solid #91caff","textAlign":"center"}}}]} + { + name: 'align', + label: 'Align', + type: 'select', + options: ['top', 'middle', 'bottom', 'stretch'], + description: 'Vertical alignment of columns within the row.', + }, + { + name: 'justify', + label: 'Justify', + type: 'select', + options: [ + 'start', + 'end', + 'center', + 'space-around', + 'space-between', + 'space-evenly', + ], + description: 'Horizontal distribution of columns within the row.', + }, + { + name: 'wrap', + label: 'Wrap', + type: 'boolean', + description: 'Whether columns are allowed to wrap to the next line.', + }, + { + name: 'gutter', + label: 'Gutter', + type: 'number', + description: 'Spacing between columns in pixels.', + }, + ]} + sampleChildren={[ + { + component: 'Col', + props: { + span: 4, + children: 'col-4', + style: { + background: '#e6f4ff', + padding: '8px', + border: '1px solid #91caff', + textAlign: 'center', + }, + }, + }, + { + component: 'Col', + props: { + span: 4, + children: 'col-4 (tall)', + style: { + background: '#e6f4ff', + padding: '24px 8px', + border: '1px solid #91caff', + textAlign: 'center', + }, + }, + }, + { + component: 'Col', + props: { + span: 4, + children: 'col-4', + style: { + background: '#e6f4ff', + padding: '8px', + border: '1px solid #91caff', + textAlign: 'center', + }, + }, + }, + ]} /> ## Try It @@ -91,19 +126,59 @@ function Demo() { 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) @@ -104,6 +116,7 @@ Everything you need to contribute to the Apache Superset project. This section i **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) @@ -114,6 +127,7 @@ Everything you need to contribute to the Apache Superset project. This section i **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) @@ -122,6 +136,7 @@ Everything you need to contribute to the Apache Superset project. This section i **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) 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 index 7926d80cf61..4a6b0f6ee3b 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/sidebars.js +++ b/docs/developer_docs_versioned_docs/version-6.1.0/sidebars.js @@ -45,9 +45,7 @@ module.exports = { type: 'category', label: 'Extension Points', collapsed: true, - items: [ - 'extensions/extension-points/sqllab', - ], + items: ['extensions/extension-points/sqllab'], }, 'extensions/development', 'extensions/deployment', @@ -61,9 +59,7 @@ module.exports = { type: 'category', label: 'Testing', collapsed: true, - items: [ - 'testing/overview', - ], + items: ['testing/overview'], }, { type: 'category', 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 index e8c8d229fcb..97a9a1eb382 100644 --- 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 @@ -159,13 +159,13 @@ Use `--concurrency=1` to limit resource usage on your dev machine. ### Troubleshooting -| Problem | Solution | -|---|---| -| Beat shows no output | Ensure `beat_schedule` is defined in your `CeleryConfig` and `--loglevel=info` is set | +| 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 | +| 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!* +_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 index baefc13cbee..eae05687ea7 100644 --- 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 @@ -59,6 +59,7 @@ pre-commit run --all-files ## GitHub Actions Key workflows: + - `test-frontend.yml` - Frontend tests - `test-backend.yml` - Backend tests - `docker.yml` - Docker image builds @@ -67,4 +68,4 @@ Key workflows: --- -*This documentation is under active development. Check back soon for updates!* +_This documentation is under active development. Check back soon for updates!_ 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 index e33bb1095bc..9ae784aaf16 100644 --- 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 @@ -58,4 +58,4 @@ npm run test -- MyComponent.test.tsx --- -*This documentation is under active development. Check back soon for updates!* +_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 index 0fc04399958..eb01ff64f5e 100644 --- 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 @@ -37,26 +37,32 @@ Superset embraces a testing pyramid approach: ## Testing Documentation ### Frontend Testing + - **[Frontend Testing](./frontend-testing.md)** - Jest, React Testing Library, and component testing strategies -### Backend Testing +### Backend Testing + - **[Backend Testing](./backend-testing.md)** - pytest, database testing, and API testing patterns ### End-to-End Testing + - **[E2E Testing](./e2e-testing.md)** - Playwright testing for complete user workflows ### CI/CD Integration + - **[CI/CD](./ci-cd.md)** - 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 @@ -64,12 +70,14 @@ Superset embraces a testing pyramid approach: ## 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) @@ -78,11 +86,12 @@ Superset embraces a testing pyramid approach: ## Running Tests ### Quick Commands + ```bash # Frontend unit tests npm run test -# Backend unit tests +# Backend unit tests pytest tests/unit_tests/ # End-to-end tests @@ -93,6 +102,7 @@ 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 @@ -101,11 +111,13 @@ npm run test:coverage ## 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 @@ -133,18 +145,21 @@ npm run test:coverage ## 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 @@ -159,4 +174,4 @@ npm run test:coverage --- -*This documentation is under active development. Check back soon for updates!* +_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 index 0e190220f15..6435d0716e2 100644 --- 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 @@ -102,8 +102,9 @@ storybook/stories//index.js ``` Use the `|` separator for nested stories: + ```javascript - storyPath: '@superset-ui/package|Category|Subcategory' + storyPath: '@superset-ui/package|Category|Subcategory'; ``` ## Best Practices 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 index 5fb8424449a..ec8b5d0d43b 100644 --- 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 @@ -61,7 +61,7 @@ One of the most important points of RTL is accessibility and this is also a very 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 }) +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. @@ -108,10 +108,12 @@ Cleaning the state of the application, such as resetting the DB, or in general, - 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) +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 diff --git a/docs/developer_docs_versions.json b/docs/developer_docs_versions.json index fc7d70bb315..99672c9707c 100644 --- a/docs/developer_docs_versions.json +++ b/docs/developer_docs_versions.json @@ -1,3 +1 @@ -[ - "6.1.0" -] +["6.1.0"] diff --git a/docs/docs/faq.mdx b/docs/docs/faq.mdx index 56386e9a599..23adf5ad8a1 100644 --- a/docs/docs/faq.mdx +++ b/docs/docs/faq.mdx @@ -2,68 +2,84 @@ 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] +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 +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 @@ -73,7 +89,7 @@ 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 +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. @@ -157,10 +173,10 @@ Metadata field: ```json { - "filter_immune_slices": [], - "expanded_slices": {}, - "filter_immune_slice_fields": {}, - "timed_refresh_immune_slices": [324] + "filter_immune_slices": [], + "expanded_slices": {}, + "filter_immune_slice_fields": {}, + "timed_refresh_immune_slices": [324] } ``` @@ -173,8 +189,8 @@ value in milliseconds in the JSON Metadata field: ```json { - "stagger_refresh": false, - "stagger_time": 2500 + "stagger_refresh": false, + "stagger_time": 2500 } ``` @@ -234,8 +250,8 @@ information like your list of users and dashboard definitions. While Superset su 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_ +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. @@ -253,11 +269,11 @@ second etc). Example: ```json { - "label_colors": { - "foo": "#FF69B4", - "bar": "lightblue", - "baz": 0 - } + "label_colors": { + "foo": "#FF69B4", + "bar": "lightblue", + "baz": 0 + } } ``` @@ -323,8 +339,8 @@ guarantees and are not recommended but may fit your use case temporarily: ## 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 +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? diff --git a/docs/docs/index.mdx b/docs/docs/index.mdx index 77ba3a1a82c..bb204678b5d 100644 --- a/docs/docs/index.mdx +++ b/docs/docs/index.mdx @@ -88,23 +88,47 @@ Superset provides: [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 @@ -263,4 +287,8 @@ Understanding the Superset Points of View --> - + + diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx index 2eee4d09eca..22a6c2e667a 100644 --- a/docs/docs/quickstart.mdx +++ b/docs/docs/quickstart.mdx @@ -82,7 +82,8 @@ From this point on, you can head on to: 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/docs/using-superset/creating-your-first-dashboard.mdx b/docs/docs/using-superset/creating-your-first-dashboard.mdx index a05a4288362..a9f7779e5a5 100644 --- a/docs/docs/using-superset/creating-your-first-dashboard.mdx +++ b/docs/docs/using-superset/creating-your-first-dashboard.mdx @@ -5,13 +5,13 @@ sidebar_position: 1 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +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 +(data analysts, business analysts, data scientists, etc). :::tip @@ -37,22 +37,44 @@ 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) @@ -76,13 +98,13 @@ 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. @@ -105,15 +127,15 @@ To install Superset as a PWA, look for the install icon in your browser's addres ### 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: +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)) + the datetime format? (using the [ISO-8601 string pattern](https://en.wikipedia.org/wiki/ISO_8601)) - + ### Superset semantic layer @@ -121,59 +143,62 @@ Superset has a thin semantic layer that adds many quality of life improvements f 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. + 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. + 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. + 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. + 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. + 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 @@ -184,26 +209,32 @@ To save your chart, first click the **Save** button. You can either: 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). +(the query, chart type, options selected, name, etc). - + - To resize the chart, start by clicking the Edit Dashboard button in the top right corner. +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. +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 @@ -218,14 +249,14 @@ 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 dashboard editors and admins. Published dashboards are visible @@ -265,6 +296,7 @@ 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` @@ -286,6 +318,7 @@ Column headers display a tooltip with the column's **Description** from the data #### 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. @@ -296,12 +329,12 @@ AG Grid supports server-side column filters that query the full dataset β€” not **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 | +| 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. @@ -365,6 +398,7 @@ Charts can display a "Last queried at" timestamp showing when the chart data was 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/docs/using-superset/embedding.mdx b/docs/docs/using-superset/embedding.mdx index f03c931e331..1b6cc9b2344 100644 --- a/docs/docs/using-superset/embedding.mdx +++ b/docs/docs/using-superset/embedding.mdx @@ -3,34 +3,34 @@ title: Embedding Superset sidebar_position: 6 --- -{/* +{/\* Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file +or more contributor license agreements. See the NOTICE file distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file +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 +with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 +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 +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 @@ -46,7 +46,7 @@ Embed a dashboard: import { embedDashboard } from '@superset-ui/embedded-sdk'; embedDashboard({ - id: 'dashboard-uuid-here', // from Dashboard β†’ Embed + id: 'dashboard-uuid-here', // from Dashboard β†’ Embed supersetDomain: 'https://superset.example.com', mountPoint: document.getElementById('superset-container'), fetchGuestToken: () => fetchTokenFromYourBackend(), @@ -116,11 +116,11 @@ Must be `True` to enable the embedded SDK and the guest token endpoint. Without 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 | +| 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 | --- @@ -128,4 +128,4 @@ The following URL parameters can be passed through the `urlParams` option in `da - **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. +- **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/docs/using-superset/exploring-data.mdx b/docs/docs/using-superset/exploring-data.mdx index 8d83a0c2c63..50c107ca03d 100644 --- a/docs/docs/using-superset/exploring-data.mdx +++ b/docs/docs/using-superset/exploring-data.mdx @@ -5,7 +5,7 @@ sidebar_position: 2 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +import useBaseUrl from '@docusaurus/useBaseUrl'; ## Exploring Data in Superset @@ -32,12 +32,12 @@ 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 @@ -45,16 +45,16 @@ 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. @@ -70,7 +70,7 @@ By default, Apache Superset only shows the last week of data. In our example, we of the data in the dataset. Click the **Time β€£ Time Range** section and change the **Range Type** to **No Filter**. - + Click **Apply** to save. @@ -80,24 +80,24 @@ example, we want to understand different Travel Classes, we select **Travel Clas 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) + (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). + 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**. + Tutorial Dashboard. Finally, select **Save & Go To Dashboard**. - + ### Dashboard Basics @@ -109,7 +109,7 @@ On this dashboard you should see the table you created in the previous section. 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. @@ -124,7 +124,7 @@ tutorial_flights again as a datasource, then click on the visualization type to 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 @@ -134,7 +134,7 @@ January 2011 and 30th June 2011 respectively by either entering directly the dat 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 @@ -146,7 +146,7 @@ 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. @@ -161,7 +161,7 @@ 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. @@ -178,7 +178,7 @@ tab on the left hand pane. Within this pane, try changing the Color Scheme, remo 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. @@ -191,14 +191,14 @@ 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**. @@ -213,7 +213,7 @@ If you would like to make your dashboard available to other users, simply select 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 @@ -230,7 +230,7 @@ Next, add an annotation by navigating to Manage β€£ Annotations and then create 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 @@ -241,11 +241,11 @@ dialogue: - 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 @@ -267,7 +267,7 @@ datasource and the **Line Chart** visualization type. Within the Time section, s 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. @@ -286,7 +286,7 @@ 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. @@ -301,13 +301,15 @@ Next, in the Time Comparison subsection of **Advanced Analytics**, enter the Tim β€œ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. @@ -319,7 +321,7 @@ 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 @@ -351,10 +353,11 @@ The **Custom** time range picker accepts natural language expressions alongside 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/docs/using-superset/exporting-dashboard-data.mdx b/docs/docs/using-superset/exporting-dashboard-data.mdx index 46c0a749d7c..cfc79af297c 100644 --- a/docs/docs/using-superset/exporting-dashboard-data.mdx +++ b/docs/docs/using-superset/exporting-dashboard-data.mdx @@ -67,13 +67,13 @@ will not register. ## Configuration keys -| Key | Default | Description | -| --- | --- | --- | -| `EXCEL_EXPORT_S3_BUCKET` | `None` | Destination bucket. Required; `501` if unset. | -| `EXCEL_EXPORT_S3_KEY_PREFIX` | `"dashboard-exports/"` | Key prefix: `{prefix}{dashboard_id}/{job_id}.xlsx`. | -| `EXCEL_EXPORT_LINK_TTL_SECONDS` | `86400` | Lifetime of the pre-signed download URL (24h). | -| `EXCEL_EXPORT_S3_CLIENT_KWARGS` | `{}` | Extra kwargs for `boto3.client("s3", ...)` β€” e.g. `region_name`, or `endpoint_url` for MinIO/LocalStack. | -| `EXCEL_EXPORT_TABLE_VIZ_TYPES` | `None` | Viz types kept tabular in **Export Images to Excel** mode; every other type is embedded as an image. `None` uses the built-in default (`table`, `pivot_table`, `pivot_table_v2`). | +| Key | Default | Description | +| ------------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `EXCEL_EXPORT_S3_BUCKET` | `None` | Destination bucket. Required; `501` if unset. | +| `EXCEL_EXPORT_S3_KEY_PREFIX` | `"dashboard-exports/"` | Key prefix: `{prefix}{dashboard_id}/{job_id}.xlsx`. | +| `EXCEL_EXPORT_LINK_TTL_SECONDS` | `86400` | Lifetime of the pre-signed download URL (24h). | +| `EXCEL_EXPORT_S3_CLIENT_KWARGS` | `{}` | Extra kwargs for `boto3.client("s3", ...)` β€” e.g. `region_name`, or `endpoint_url` for MinIO/LocalStack. | +| `EXCEL_EXPORT_TABLE_VIZ_TYPES` | `None` | Viz types kept tabular in **Export Images to Excel** mode; every other type is embedded as an image. `None` uses the built-in default (`table`, `pivot_table`, `pivot_table_v2`). | Credentials and region resolve through the standard boto3 chain (environment variables, shared config, or instance role) unless overridden via diff --git a/docs/docs/using-superset/handlebars-chart.mdx b/docs/docs/using-superset/handlebars-chart.mdx index f560f923f51..a0d1e599d41 100644 --- a/docs/docs/using-superset/handlebars-chart.mdx +++ b/docs/docs/using-superset/handlebars-chart.mdx @@ -28,11 +28,11 @@ Superset registers several custom helpers on top of the standard Handlebars buil Formats a date value using [Day.js](https://day.js.org/) format strings. ```handlebars -{{dateFormat my_date format="MMMM YYYY"}} +{{dateFormat my_date format='MMMM YYYY'}} ``` -| Option | Default | Description | -|--------|---------|-------------| +| Option | Default | Description | +| -------- | ------------ | --------------------------------- | | `format` | `YYYY-MM-DD` | A Day.js-compatible format string | --- @@ -52,11 +52,11 @@ Converts an object to a JSON string, or any other value to its string representa Formats a number using locale-aware formatting. ```handlebars -{{formatNumber myNumber "en-US"}} +{{formatNumber myNumber 'en-US'}} ``` -| Option | Default | Description | -|--------|---------|-------------| +| Option | Default | Description | +| -------- | ------- | --------------------- | | `locale` | `en-US` | A BCP 47 language tag | --- @@ -76,7 +76,7 @@ Parses a JSON string into an object that can be used in your template. Groups an array of objects by a key, powered by [handlebars-group-by](https://github.com/nicktindall/handlebars-group-by). ```handlebars -{{#groupBy data "department"}} +{{#groupBy data 'department'}}

    {{value}}

    {{#each items}}

    {{this.name}}

    @@ -92,47 +92,47 @@ Superset also registers all helpers from the [just-handlebars-helpers](https://g #### Comparison -| Helper | Description | Example | -|--------|-------------|---------| -| `eq` | Strict equality | `{{#if (eq status "active")}}` | -| `eqw` | Weak equality | `{{#if (eqw count "5")}}` | -| `neq` | Strict inequality | `{{#if (neq role "admin")}}` | -| `lt` | Less than | `{{#if (lt score 50)}}` | -| `lte` | Less than or equal | `{{#if (lte score 100)}}` | -| `gt` | Greater than | `{{#if (gt price 0)}}` | -| `gte` | Greater than or equal | `{{#if (gte age 18)}}` | +| Helper | Description | Example | +| ------ | --------------------- | ------------------------------ | +| `eq` | Strict equality | `{{#if (eq status "active")}}` | +| `eqw` | Weak equality | `{{#if (eqw count "5")}}` | +| `neq` | Strict inequality | `{{#if (neq role "admin")}}` | +| `lt` | Less than | `{{#if (lt score 50)}}` | +| `lte` | Less than or equal | `{{#if (lte score 100)}}` | +| `gt` | Greater than | `{{#if (gt price 0)}}` | +| `gte` | Greater than or equal | `{{#if (gte age 18)}}` | #### Logical -| Helper | Description | Example | -|--------|-------------|---------| -| `and` | Logical AND | `{{#if (and isActive isVerified)}}` | -| `or` | Logical OR | `{{#if (or isAdmin isMod)}}` | -| `not` | Logical NOT | `{{#if (not isDisabled)}}` | -| `ifx` | Inline conditional | `{{ifx isActive "Yes" "No"}}` | +| Helper | Description | Example | +| ---------- | ----------------------------- | ---------------------------------------- | +| `and` | Logical AND | `{{#if (and isActive isVerified)}}` | +| `or` | Logical OR | `{{#if (or isAdmin isMod)}}` | +| `not` | Logical NOT | `{{#if (not isDisabled)}}` | +| `ifx` | Inline conditional | `{{ifx isActive "Yes" "No"}}` | | `coalesce` | Returns first non-falsy value | `{{coalesce nickname name "Anonymous"}}` | #### String -| Helper | Description | Example | -|--------|-------------|---------| -| `capitalize` | Capitalizes first letter | `{{capitalize name}}` | -| `uppercase` | Converts to uppercase | `{{uppercase status}}` | -| `lowercase` | Converts to lowercase | `{{lowercase email}}` | -| `truncate` | Truncates a string | `{{truncate description 100}}` | -| `contains` | Checks if string contains substring | `{{#if (contains tag "urgent")}}` | +| Helper | Description | Example | +| ------------ | ----------------------------------- | --------------------------------- | +| `capitalize` | Capitalizes first letter | `{{capitalize name}}` | +| `uppercase` | Converts to uppercase | `{{uppercase status}}` | +| `lowercase` | Converts to lowercase | `{{lowercase email}}` | +| `truncate` | Truncates a string | `{{truncate description 100}}` | +| `contains` | Checks if string contains substring | `{{#if (contains tag "urgent")}}` | #### Math -| Helper | Description | Example | -|--------|-------------|---------| -| `add` | Addition | `{{add a b}}` | -| `subtract` | Subtraction | `{{subtract total discount}}` | +| Helper | Description | Example | +| ---------- | -------------- | ----------------------------- | +| `add` | Addition | `{{add a b}}` | +| `subtract` | Subtraction | `{{subtract total discount}}` | | `multiply` | Multiplication | `{{multiply price quantity}}` | -| `divide` | Division | `{{divide total count}}` | -| `ceil` | Ceiling | `{{ceil value}}` | -| `floor` | Floor | `{{floor value}}` | -| `round` | Round | `{{round value}}` | +| `divide` | Division | `{{divide total count}}` | +| `ceil` | Ceiling | `{{ceil value}}` | +| `floor` | Floor | `{{floor value}}` | +| `round` | Round | `{{round value}}` | For the full list of available helpers, see the [just-handlebars-helpers documentation](https://github.com/leapfrogtechnology/just-handlebars-helpers). diff --git a/docs/docs/using-superset/sql-templating.mdx b/docs/docs/using-superset/sql-templating.mdx index 2e924e7c659..788ac9b1227 100644 --- a/docs/docs/using-superset/sql-templating.mdx +++ b/docs/docs/using-superset/sql-templating.mdx @@ -5,24 +5,24 @@ description: Use Jinja templates in SQL Lab and virtual datasets to create dynam 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 +or more contributor license agreements. See the NOTICE file distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file +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 +with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 +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 +KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -*/} +\*/} # SQL Templating @@ -101,12 +101,12 @@ 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 | +| 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** @@ -128,10 +128,10 @@ WHERE role IN {{ current_user_roles()|where_in }} Access dashboard and chart filter values in your queries: -| Macro | Description | -|-------|-------------| +| Macro | Description | +| ------------------------------- | ------------------------------- | | `{{ filter_values('column') }}` | Returns filter values as a list | -| `{{ get_filters('column') }}` | Returns filters with operators | +| `{{ get_filters('column') }}` | Returns filters with operators | **Example: Using filter values** @@ -150,8 +150,8 @@ The `where_in` filter converts the list to SQL format: `('value1', 'value2', 'va It returns a `TimeFilter` object with `from_expr` and `to_expr` β€” fully-formatted SQL expressions that should be used directly in `WHERE` clauses without quoting. -| Macro | Description | -|-------|-------------| +| Macro | Description | +| --------------------------------- | -------------------------------------------------- | | `{{ get_time_filter('column') }}` | Returns time filter with `from_expr` and `to_expr` | **Example: Time-filtered virtual dataset** @@ -208,9 +208,7 @@ Add to the Parameters menu: ```json { - "_filters": [ - {"col": "region", "op": "IN", "val": ["US", "EU"]} - ] + "_filters": [{ "col": "region", "op": "IN", "val": ["US", "EU"] }] } ``` @@ -263,6 +261,7 @@ Using `remove_filter=True` applies the filter in the inner query for better perf - **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/docs/using-superset/using-ai-with-superset.mdx b/docs/docs/using-superset/using-ai-with-superset.mdx index b419ccc9269..d53a8b83c9b 100644 --- a/docs/docs/using-superset/using-ai-with-superset.mdx +++ b/docs/docs/using-superset/using-ai-with-superset.mdx @@ -47,6 +47,7 @@ Ask your AI assistant to browse what's available in your Superset instance: - **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" @@ -62,6 +63,7 @@ Describe the visualization you want and AI creates it for you: - **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" @@ -84,6 +86,7 @@ Build dashboards from a collection of charts: - **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" @@ -95,6 +98,7 @@ Discover what database connections are configured in your Superset instance: - **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" @@ -106,6 +110,7 @@ Build ad-hoc SQL datasets that can be used as the basis for charts: - **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" @@ -118,6 +123,7 @@ Execute SQL directly through your AI assistant: - **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'" @@ -130,6 +136,7 @@ Pull the raw data behind any chart: - **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" @@ -139,6 +146,7 @@ Pull the raw data behind any chart: - **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?" @@ -232,56 +240,56 @@ Ask your admin for the MCP server URL and any authentication tokens you need. ### 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| Tool | Description | +| ------------------- | ------------------------------------------------ | +| `list_databases` | List configured database connections | | `get_database_info` | Get details about a specific database connection | --- diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 3c3237fa2d2..7bc46d2b4a7 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -49,13 +49,23 @@ if (!versionsConfig.user_docs.disabled) { path: 'docs', routeBasePath: 'user-docs', sidebarPath: require.resolve('./sidebars.js'), - editUrl: ({ versionDocsDirPath, docPath }: { versionDocsDirPath: string; docPath: string }) => { + editUrl: ({ + versionDocsDirPath, + docPath, + }: { + versionDocsDirPath: string; + docPath: string; + }) => { if (docPath === 'intro.md') { return 'https://github.com/apache/superset/edit/master/README.md'; } return `https://github.com/apache/superset/edit/master/docs/${versionDocsDirPath}/${docPath}`; }, - remarkPlugins: [remarkImportPartial, remarkLocalizeBadges, remarkTechArticleSchema], + remarkPlugins: [ + remarkImportPartial, + remarkLocalizeBadges, + remarkTechArticleSchema, + ], admonitions: { keywords: ['note', 'tip', 'info', 'warning', 'danger', 'resources'], extendDefaults: true, @@ -81,9 +91,12 @@ if (!versionsConfig.components.disabled) { path: 'components', routeBasePath: 'components', sidebarPath: require.resolve('./sidebarComponents.js'), - editUrl: - 'https://github.com/apache/superset/edit/master/docs/components', - remarkPlugins: [remarkImportPartial, remarkLocalizeBadges, remarkTechArticleSchema], + editUrl: 'https://github.com/apache/superset/edit/master/docs/components', + remarkPlugins: [ + remarkImportPartial, + remarkLocalizeBadges, + remarkTechArticleSchema, + ], admonitions: { keywords: ['note', 'tip', 'info', 'warning', 'danger', 'resources'], extendDefaults: true, @@ -109,9 +122,12 @@ if (!versionsConfig.admin_docs.disabled) { path: 'admin_docs', routeBasePath: 'admin-docs', sidebarPath: require.resolve('./sidebarAdminDocs.js'), - editUrl: - 'https://github.com/apache/superset/edit/master/docs/admin_docs', - remarkPlugins: [remarkImportPartial, remarkLocalizeBadges, remarkTechArticleSchema], + editUrl: 'https://github.com/apache/superset/edit/master/docs/admin_docs', + remarkPlugins: [ + remarkImportPartial, + remarkLocalizeBadges, + remarkTechArticleSchema, + ], admonitions: { keywords: ['note', 'tip', 'info', 'warning', 'danger', 'resources'], extendDefaults: true, @@ -139,13 +155,18 @@ if (!versionsConfig.developer_docs.disabled) { sidebarPath: require.resolve('./sidebarTutorials.js'), editUrl: 'https://github.com/apache/superset/edit/master/docs/developer_docs', - remarkPlugins: [remarkImportPartial, remarkLocalizeBadges, remarkTechArticleSchema], + remarkPlugins: [ + remarkImportPartial, + remarkLocalizeBadges, + remarkTechArticleSchema, + ], admonitions: { keywords: ['note', 'tip', 'info', 'warning', 'danger', 'resources'], extendDefaults: true, }, docItemComponent: '@theme/ApiItem', // Required for OpenAPI docs - includeCurrentVersion: versionsConfig.developer_docs.includeCurrentVersion, + includeCurrentVersion: + versionsConfig.developer_docs.includeCurrentVersion, lastVersion: versionsConfig.developer_docs.lastVersion, onlyIncludeVersions: versionsConfig.developer_docs.onlyIncludeVersions, versions: versionsConfig.developer_docs.versions, @@ -222,7 +243,10 @@ if (!versionsConfig.admin_docs.disabled) { } // Add Developer Docs navbar item if not hidden from nav -if (!versionsConfig.developer_docs.disabled && !versionsConfig.developer_docs.hideFromNav) { +if ( + !versionsConfig.developer_docs.disabled && + !versionsConfig.developer_docs.hideFromNav +) { dynamicNavbarItems.push({ label: 'Developers', to: '/developer-docs/', @@ -263,7 +287,6 @@ if (!versionsConfig.developer_docs.disabled && !versionsConfig.developer_docs.hi }); } - const config: Config = { future: { v4: { @@ -315,7 +338,8 @@ const config: Config = { name: 'Apache Superset', applicationCategory: 'BusinessApplication', operatingSystem: 'Cross-platform', - description: 'Apache Superset is a modern, enterprise-ready business intelligence web application for data exploration and visualization.', + description: + 'Apache Superset is a modern, enterprise-ready business intelligence web application for data exploration and visualization.', url: 'https://superset.apache.org', license: 'https://www.apache.org/licenses/LICENSE-2.0', author: { @@ -354,7 +378,8 @@ const config: Config = { '@type': 'SearchAction', target: { '@type': 'EntryPoint', - urlTemplate: 'https://superset.apache.org/search?q={search_term_string}', + urlTemplate: + 'https://superset.apache.org/search?q={search_term_string}', }, 'query-input': 'required name=search_term_string', }, @@ -716,7 +741,9 @@ const config: Config = { // Redirect all /developer_portal/* paths to /developer-docs/* if (existingPath.startsWith('/developer-docs/')) { - redirects.push(existingPath.replace('/developer-docs/', '/developer_portal/')); + redirects.push( + existingPath.replace('/developer-docs/', '/developer_portal/'), + ); } // Redirect all /docs/* paths to /user-docs/* for user documentation @@ -748,8 +775,7 @@ const config: Config = { blog: { showReadingTime: true, // Please change this to your repo. - editUrl: - 'https://github.com/apache/superset/tree/master/docs', + editUrl: 'https://github.com/apache/superset/tree/master/docs', }, theme: { customCss: require.resolve('./src/styles/custom.css'), @@ -761,10 +787,10 @@ const config: Config = { priority: 0.5, ignorePatterns: ['/tags/**'], filename: 'sitemap.xml', - createSitemapItems: async (params) => { + createSitemapItems: async params => { const { defaultCreateSitemapItems, ...rest } = params; const items = await defaultCreateSitemapItems(rest); - return items.map((item) => { + return items.map(item => { // Boost priority for key pages if (item.url.endsWith('/user-docs/')) { return { ...item, priority: 1.0, changefreq: 'daily' }; @@ -798,14 +824,24 @@ const config: Config = { themeConfig: { // SEO: OpenGraph and Twitter meta tags metadata: [ - { name: 'keywords', content: 'data visualization, business intelligence, BI, dashboards, SQL, analytics, open source, Apache, charts, reporting' }, + { + name: 'keywords', + content: + 'data visualization, business intelligence, BI, dashboards, SQL, analytics, open source, Apache, charts, reporting', + }, { property: 'og:type', content: 'website' }, { property: 'og:site_name', content: 'Apache Superset' }, - { property: 'og:image', content: 'https://superset.apache.org/img/superset-og-image.png' }, + { + property: 'og:image', + content: 'https://superset.apache.org/img/superset-og-image.png', + }, { property: 'og:image:width', content: '1200' }, { property: 'og:image:height', content: '630' }, { name: 'twitter:card', content: 'summary_large_image' }, - { name: 'twitter:image', content: 'https://superset.apache.org/img/superset-og-image.png' }, + { + name: 'twitter:image', + content: 'https://superset.apache.org/img/superset-og-image.png', + }, { name: 'twitter:site', content: '@ApacheSuperset' }, ], colorMode: { diff --git a/docs/eslint.config.js b/docs/eslint.config.js index 2f0d01513ec..95ec46f5fc2 100644 --- a/docs/eslint.config.js +++ b/docs/eslint.config.js @@ -19,8 +19,6 @@ */ const typescriptEslintParser = require('@typescript-eslint/parser'); const typescriptEslintPlugin = require('@typescript-eslint/eslint-plugin'); -const eslintConfigPrettier = require('eslint-config-prettier'); -const prettierEslintPlugin = require('eslint-plugin-prettier'); const js = require('@eslint/js'); const ts = require('typescript-eslint'); const react = require('eslint-plugin-react'); @@ -34,7 +32,6 @@ module.exports = defineConfig([ globalIgnores(['build/**/*', '.docusaurus/**/*', 'node_modules/**/*']), js.configs.recommended, ...ts.configs.recommended, - eslintConfigPrettier, { files: ['eslint.config.js'], rules: { @@ -59,7 +56,6 @@ module.exports = defineConfig([ plugins: { typescript: typescriptEslintPlugin, react, - prettier: prettierEslintPlugin, }, rules: { 'react/react-in-jsx-scope': 'off', diff --git a/docs/netlify.toml b/docs/netlify.toml index 1a0f6ca94ad..5c3e2a49c1b 100644 --- a/docs/netlify.toml +++ b/docs/netlify.toml @@ -19,53 +19,53 @@ # This enables automatic deploy previews for PRs that modify docs [build] - # Base directory is the docs folder - base = "docs" - # Build command for Docusaurus - command = "yarn install && yarn build" - # Output directory (relative to base) - publish = "build" - # Skip builds when no docs changes (exit 0 = skip, non-zero = build). - # Checks for changes in docs/ and README.md (which gets pulled into docs). - # - # $CACHED_COMMIT_REF is the last *deployed* commit; it is set on incremental - # builds (notably the master production deploy) and empty on a context's - # first build (every deploy preview). The production path diffs against it - # and skips correctly. - # - # Deploy previews need different handling: Netlify checks out a *merge* - # commit, so $COMMIT_REF (the PR head SHA) is frequently not resolvable in - # the clone, and on a shallow clone `git merge-base` can fail too -- so the - # previous logic fell through to a build on every PR, even non-docs ones. - # Instead, always diff the checked-out HEAD against its merge-base with - # master, deepening the shallow clone until that merge-base resolves. If it - # genuinely can't be determined, exit non-zero to build (fail safe). - ignore = 'if [ -n "$CACHED_COMMIT_REF" ]; then git diff --quiet "$CACHED_COMMIT_REF" HEAD -- . ../README.md; else git fetch --no-tags origin master >/dev/null 2>&1 || true; i=0; while [ "$i" -lt 10 ] && ! git merge-base origin/master HEAD >/dev/null 2>&1; do git fetch --deepen=200 origin master >/dev/null 2>&1 || break; i=$((i+1)); done; BASE="$(git merge-base origin/master HEAD 2>/dev/null || true)"; if [ -z "$BASE" ]; then exit 1; fi; git diff --quiet "$BASE" HEAD -- . ../README.md; fi' +# Base directory is the docs folder +base = "docs" +# Build command for Docusaurus +command = "yarn install && yarn build" +# Output directory (relative to base) +publish = "build" +# Skip builds when no docs changes (exit 0 = skip, non-zero = build). +# Checks for changes in docs/ and README.md (which gets pulled into docs). +# +# $CACHED_COMMIT_REF is the last *deployed* commit; it is set on incremental +# builds (notably the master production deploy) and empty on a context's +# first build (every deploy preview). The production path diffs against it +# and skips correctly. +# +# Deploy previews need different handling: Netlify checks out a *merge* +# commit, so $COMMIT_REF (the PR head SHA) is frequently not resolvable in +# the clone, and on a shallow clone `git merge-base` can fail too -- so the +# previous logic fell through to a build on every PR, even non-docs ones. +# Instead, always diff the checked-out HEAD against its merge-base with +# master, deepening the shallow clone until that merge-base resolves. If it +# genuinely can't be determined, exit non-zero to build (fail safe). +ignore = 'if [ -n "$CACHED_COMMIT_REF" ]; then git diff --quiet "$CACHED_COMMIT_REF" HEAD -- . ../README.md; else git fetch --no-tags origin master >/dev/null 2>&1 || true; i=0; while [ "$i" -lt 10 ] && ! git merge-base origin/master HEAD >/dev/null 2>&1; do git fetch --deepen=200 origin master >/dev/null 2>&1 || break; i=$((i+1)); done; BASE="$(git merge-base origin/master HEAD 2>/dev/null || true)"; if [ -z "$BASE" ]; then exit 1; fi; git diff --quiet "$BASE" HEAD -- . ../README.md; fi' [build.environment] - # Node version matching docs/.nvmrc - NODE_VERSION = "20" - # Yarn version - YARN_VERSION = "1.22.22" - # Increase heap size for webpack bundling of Superset UI components - NODE_OPTIONS = "--max-old-space-size=8192" +# Node version matching docs/.nvmrc +NODE_VERSION = "20" +# Yarn version +YARN_VERSION = "1.22.22" +# Increase heap size for webpack bundling of Superset UI components +NODE_OPTIONS = "--max-old-space-size=8192" # Deploy preview settings [context.deploy-preview] - command = "yarn install && yarn build" +command = "yarn install && yarn build" # Branch deploy settings (for feature branches) [context.branch-deploy] - command = "yarn install && yarn build" +command = "yarn install && yarn build" # Redirect /docs to the main docs page [[redirects]] - from = "/docs" - to = "/docs/intro" - status = 301 +from = "/docs" +to = "/docs/intro" +status = 301 # Handle SPA routing for Docusaurus [[redirects]] - from = "/*" - to = "/index.html" - status = 200 +from = "/*" +to = "/index.html" +status = 200 diff --git a/docs/package.json b/docs/package.json index f80848e56d8..e56547af0e3 100644 --- a/docs/package.json +++ b/docs/package.json @@ -92,11 +92,9 @@ "@typescript-eslint/eslint-plugin": "^8.64.0", "@typescript-eslint/parser": "^8.64.0", "eslint": "^9.39.2", - "eslint-config-prettier": "^10.1.8", - "eslint-plugin-prettier": "^5.5.6", "eslint-plugin-react": "^7.37.5", "globals": "^17.7.0", - "prettier": "^3.9.5", + "oxfmt": "^0.60.0", "typescript": "~6.0.3", "typescript-eslint": "^8.64.0", "webpack": "^5.108.2" diff --git a/docs/plugins/remark-tech-article-schema.mjs b/docs/plugins/remark-tech-article-schema.mjs index 44c505ac3fb..014cebec5a6 100644 --- a/docs/plugins/remark-tech-article-schema.mjs +++ b/docs/plugins/remark-tech-article-schema.mjs @@ -48,7 +48,9 @@ export default function remarkTechArticleSchema() { const title = frontmatter.title; const description = frontmatter.description; - const keywords = Array.isArray(frontmatter.keywords) ? frontmatter.keywords : []; + const keywords = Array.isArray(frontmatter.keywords) + ? frontmatter.keywords + : []; const proficiencyLevel = frontmatter.seo_proficiency || 'Beginner'; // Create the import statement @@ -110,7 +112,7 @@ export default function remarkTechArticleSchema() { type: 'ExpressionStatement', expression: { type: 'ArrayExpression', - elements: keywords.map((k) => ({ + elements: keywords.map(k => ({ type: 'Literal', value: k, })), diff --git a/docs/plugins/robots-txt-plugin.js b/docs/plugins/robots-txt-plugin.js index 0b9bf348a12..27f95dae8e2 100644 --- a/docs/plugins/robots-txt-plugin.js +++ b/docs/plugins/robots-txt-plugin.js @@ -47,14 +47,18 @@ module.exports = function robotsTxtPlugin(context, options = {}) { lines.push(`User-agent: ${policy.userAgent}`); if (policy.allow) { - const allows = Array.isArray(policy.allow) ? policy.allow : [policy.allow]; + const allows = Array.isArray(policy.allow) + ? policy.allow + : [policy.allow]; for (const allow of allows) { lines.push(`Allow: ${allow}`); } } if (policy.disallow) { - const disallows = Array.isArray(policy.disallow) ? policy.disallow : [policy.disallow]; + const disallows = Array.isArray(policy.disallow) + ? policy.disallow + : [policy.disallow]; for (const disallow of disallows) { lines.push(`Disallow: ${disallow}`); } diff --git a/docs/scripts/convert-api-sidebar.mjs b/docs/scripts/convert-api-sidebar.mjs index f3db2a125fa..28489bf7532 100644 --- a/docs/scripts/convert-api-sidebar.mjs +++ b/docs/scripts/convert-api-sidebar.mjs @@ -28,8 +28,20 @@ import path from 'path'; import { fileURLToPath } from 'url'; const __dirname = path.dirname(fileURLToPath(import.meta.url)); -const sidebarTsPath = path.join(__dirname, '..', 'developer_docs', 'api', 'sidebar.ts'); -const sidebarJsPath = path.join(__dirname, '..', 'developer_docs', 'api', 'sidebar.js'); +const sidebarTsPath = path.join( + __dirname, + '..', + 'developer_docs', + 'api', + 'sidebar.ts', +); +const sidebarJsPath = path.join( + __dirname, + '..', + 'developer_docs', + 'api', + 'sidebar.js', +); if (!fs.existsSync(sidebarTsPath)) { console.log('No sidebar.ts found, skipping conversion'); @@ -47,7 +59,7 @@ content = content.replace(/: SidebarsConfig/g, ''); // Change export default to module.exports content = content.replace( /export default sidebar\.apisidebar;/, - 'module.exports = sidebar.apisidebar;' + 'module.exports = sidebar.apisidebar;', ); // Parse the sidebar to add unique keys for duplicate labels @@ -60,9 +72,9 @@ try { const sidebarObj = new Function(`return ${sidebarMatch[1]}`)(); // First pass: count labels - const countLabels = (items) => { + const countLabels = items => { const counts = {}; - const count = (item) => { + const count = item => { if (item.type === 'doc' && item.label) { counts[item.label] = (counts[item.label] || 0) + 1; } @@ -105,7 +117,7 @@ module.exports = sidebar.apisidebar; // Fall back to simple conversion content = content.replace( /export default sidebar\.apisidebar;/, - 'module.exports = sidebar.apisidebar;' + 'module.exports = sidebar.apisidebar;', ); } diff --git a/docs/scripts/generate-api-index.mjs b/docs/scripts/generate-api-index.mjs index 2fd9fddac63..e64c4511de9 100644 --- a/docs/scripts/generate-api-index.mjs +++ b/docs/scripts/generate-api-index.mjs @@ -34,28 +34,68 @@ import { fileURLToPath } from 'url'; const require = createRequire(import.meta.url); const __dirname = path.dirname(fileURLToPath(import.meta.url)); -const SPEC_PATH = path.join(__dirname, '..', 'static', 'resources', 'openapi.json'); -const SIDEBAR_PATH = path.join(__dirname, '..', 'developer_docs', 'api', 'sidebar.js'); +const SPEC_PATH = path.join( + __dirname, + '..', + 'static', + 'resources', + 'openapi.json', +); +const SIDEBAR_PATH = path.join( + __dirname, + '..', + 'developer_docs', + 'api', + 'sidebar.js', +); const OUTPUT_PATH = path.join(__dirname, '..', 'developer_docs', 'api.mdx'); // Category groupings for better organization const CATEGORY_GROUPS = { - 'Authentication': ['Security'], + Authentication: ['Security'], 'Core Resources': ['Dashboards', 'Charts', 'Datasets', 'Database'], - 'Data Exploration': ['Explore', 'SQL Lab', 'Queries', 'Datasources', 'Advanced Data Type'], - 'Organization & Customization': ['Tags', 'Annotation Layers', 'CSS Templates'], + 'Data Exploration': [ + 'Explore', + 'SQL Lab', + 'Queries', + 'Datasources', + 'Advanced Data Type', + ], + 'Organization & Customization': [ + 'Tags', + 'Annotation Layers', + 'CSS Templates', + ], 'Sharing & Embedding': [ - 'Dashboard Permanent Link', 'Explore Permanent Link', 'SQL Lab Permanent Link', - 'Embedded Dashboard', 'Dashboard Filter State', 'Explore Form Data' + 'Dashboard Permanent Link', + 'Explore Permanent Link', + 'SQL Lab Permanent Link', + 'Embedded Dashboard', + 'Dashboard Filter State', + 'Explore Form Data', ], 'Scheduling & Alerts': ['Report Schedules'], 'Security & Access Control': [ - 'Security Roles', 'Security Users', 'Security Permissions', - 'Security Resources (View Menus)', 'Security Permissions on Resources (View Menus)', - 'Row Level Security' + 'Security Roles', + 'Security Users', + 'Security Permissions', + 'Security Resources (View Menus)', + 'Security Permissions on Resources (View Menus)', + 'Row Level Security', + ], + 'Import/Export & Administration': [ + 'Import/export', + 'CacheRestApi', + 'LogRestApi', + ], + 'User & System': [ + 'Current User', + 'User', + 'Menu', + 'Available Domains', + 'AsyncEventsRestApi', + 'OpenApi', ], - 'Import/Export & Administration': ['Import/export', 'CacheRestApi', 'LogRestApi'], - 'User & System': ['Current User', 'User', 'Menu', 'Available Domains', 'AsyncEventsRestApi', 'OpenApi'], }; /** @@ -68,7 +108,7 @@ function buildSlugMap() { try { const sidebar = require(SIDEBAR_PATH); - const extractDocs = (items) => { + const extractDocs = items => { for (const item of items) { if (item.type === 'doc' && item.label && item.id) { // id is like "api/create-security-login" β†’ slug "create-security-login" @@ -80,7 +120,9 @@ function buildSlugMap() { }; extractDocs(sidebar); - console.log(`Loaded ${Object.keys(labelToSlug).length} slug mappings from sidebar`); + console.log( + `Loaded ${Object.keys(labelToSlug).length} slug mappings from sidebar`, + ); } catch { console.warn('Could not read sidebar, will use computed slugs'); } @@ -214,7 +256,9 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \\ for (const [groupName, groupTags] of Object.entries(CATEGORY_GROUPS)) { if (groupName === 'Authentication') continue; // Already rendered - const tagsInGroup = groupTags.filter(tag => tagEndpoints[tag] && !renderedTags.has(tag)); + const tagsInGroup = groupTags.filter( + tag => tagEndpoints[tag] && !renderedTags.has(tag), + ); if (tagsInGroup.length === 0) continue; mdx += `#### ${groupName}\n\n`; @@ -238,7 +282,9 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \\ } // Render any remaining tags not in a group - const remainingTags = Object.keys(tagEndpoints).filter(tag => !renderedTags.has(tag)); + const remainingTags = Object.keys(tagEndpoints).filter( + tag => !renderedTags.has(tag), + ); if (remainingTags.length > 0) { mdx += `#### Other\n\n`; diff --git a/docs/scripts/generate-api-tag-pages.mjs b/docs/scripts/generate-api-tag-pages.mjs index 23ecda248b8..d155370fb52 100644 --- a/docs/scripts/generate-api-tag-pages.mjs +++ b/docs/scripts/generate-api-tag-pages.mjs @@ -33,7 +33,13 @@ import { fileURLToPath } from 'url'; const require = createRequire(import.meta.url); const __dirname = path.dirname(fileURLToPath(import.meta.url)); -const SPEC_PATH = path.join(__dirname, '..', 'static', 'resources', 'openapi.json'); +const SPEC_PATH = path.join( + __dirname, + '..', + 'static', + 'resources', + 'openapi.json', +); const API_DOCS_DIR = path.join(__dirname, '..', 'developer_docs', 'api'); const SIDEBAR_PATH = path.join(API_DOCS_DIR, 'sidebar.js'); @@ -53,7 +59,7 @@ function buildSlugMap() { try { const sidebar = require(SIDEBAR_PATH); - const extractDocs = (items) => { + const extractDocs = items => { for (const item of items) { if (item.type === 'doc' && item.label && item.id) { const slug = item.id.replace(/^api\//, ''); @@ -109,13 +115,15 @@ function main() { // Sort endpoints within each tag by path then method for (const tag of Object.keys(tagEndpoints)) { - tagEndpoints[tag].sort((a, b) => - a.path.localeCompare(b.path) || a.method.localeCompare(b.method) + tagEndpoints[tag].sort( + (a, b) => + a.path.localeCompare(b.path) || a.method.localeCompare(b.method), ); } // Scan existing .tag.mdx files and match by frontmatter title - const tagFiles = fs.readdirSync(API_DOCS_DIR) + const tagFiles = fs + .readdirSync(API_DOCS_DIR) .filter(f => f.endsWith('.tag.mdx')); let updated = 0; diff --git a/docs/scripts/generate-database-docs.mjs b/docs/scripts/generate-database-docs.mjs index 93cb5d766b8..25c6e078457 100644 --- a/docs/scripts/generate-database-docs.mjs +++ b/docs/scripts/generate-database-docs.mjs @@ -564,7 +564,9 @@ print(json.dumps(databases, default=str)) throw new Error('No metadata found in engine specs'); } - console.log(`Extracted metadata from ${Object.keys(databases).length} engine specs`); + console.log( + `Extracted metadata from ${Object.keys(databases).length} engine specs`, + ); return databases; } catch (err) { console.log('Engine spec metadata extraction failed:', err.message); @@ -615,20 +617,20 @@ function buildStatistics(databases) { for (const cat of categories) { // Map category constant names to display names const categoryDisplayNames = { - 'CLOUD_AWS': 'Cloud - AWS', - 'CLOUD_GCP': 'Cloud - Google', - 'CLOUD_AZURE': 'Cloud - Azure', - 'CLOUD_DATA_WAREHOUSES': 'Cloud Data Warehouses', - 'APACHE_PROJECTS': 'Apache Projects', - 'TRADITIONAL_RDBMS': 'Traditional RDBMS', - 'ANALYTICAL_DATABASES': 'Analytical Databases', - 'SEARCH_NOSQL': 'Search & NoSQL', - 'QUERY_ENGINES': 'Query Engines', - 'TIME_SERIES': 'Time Series Databases', - 'OTHER': 'Other Databases', - 'OPEN_SOURCE': 'Open Source', - 'HOSTED_OPEN_SOURCE': 'Hosted Open Source', - 'PROPRIETARY': 'Proprietary', + CLOUD_AWS: 'Cloud - AWS', + CLOUD_GCP: 'Cloud - Google', + CLOUD_AZURE: 'Cloud - Azure', + CLOUD_DATA_WAREHOUSES: 'Cloud Data Warehouses', + APACHE_PROJECTS: 'Apache Projects', + TRADITIONAL_RDBMS: 'Traditional RDBMS', + ANALYTICAL_DATABASES: 'Analytical Databases', + SEARCH_NOSQL: 'Search & NoSQL', + QUERY_ENGINES: 'Query Engines', + TIME_SERIES: 'Time Series Databases', + OTHER: 'Other Databases', + OPEN_SOURCE: 'Open Source', + HOSTED_OPEN_SOURCE: 'Hosted Open Source', + PROPRIETARY: 'Proprietary', }; const displayName = categoryDisplayNames[cat] || cat; if (!stats.byCategory[displayName]) { @@ -657,7 +659,9 @@ function toSlug(name) { * Generate MDX content for a single database page */ function generateDatabaseMDX(name, db) { - const description = db.documentation?.description || `Documentation for ${name} database connection.`; + const description = + db.documentation?.description || + `Documentation for ${name} database connection.`; const shortDesc = description .slice(0, 160) .replace(/\\/g, '\\\\') @@ -704,7 +708,9 @@ export const databaseInfo = ${inlineData}; * Generate the index MDX for the databases overview */ function generateIndexMDX(statistics, usedFlaskContext = true) { - const fallbackNotice = usedFlaskContext ? '' : ` + const fallbackNotice = usedFlaskContext + ? '' + : ` :::info Developer Note This documentation was built without Flask context, so feature diagnostics (scores, time grain support, etc.) may not reflect actual database capabilities. For full diagnostics, build docs locally with: @@ -832,7 +838,10 @@ function getImageDimensions(imgPath) { const content = fs.readFileSync(imgPath, 'utf-8'); const vbMatch = content.match(/viewBox=["']([^"']+)["']/); if (vbMatch) { - const parts = vbMatch[1].trim().split(/[\s,]+/).map(Number); + const parts = vbMatch[1] + .trim() + .split(/[\s,]+/) + .map(Number); if (parts.length >= 4 && parts[2] > 0 && parts[3] > 0) { return { width: parts[2], height: parts[3] }; } @@ -841,7 +850,9 @@ function getImageDimensions(imgPath) { if (dims.width > 0 && dims.height > 0) { return { width: dims.width, height: dims.height }; } - } catch { /* fall through */ } + } catch { + /* fall through */ + } return null; } @@ -879,7 +890,9 @@ function generateReadmeLogos(databases) { // deduplicated by logo filename (matches docs homepage logic in index.tsx) const seenLogos = new Set(); const dbsWithLogos = Object.entries(databases) - .filter(([, db]) => db.documentation?.logo && db.documentation?.homepage_url) + .filter( + ([, db]) => db.documentation?.logo && db.documentation?.homepage_url, + ) .sort(([a], [b]) => a.localeCompare(b)) .filter(([, db]) => { const logo = db.documentation.logo; @@ -901,16 +914,27 @@ function generateReadmeLogos(databases) { // Generate linked logo tags with aspect-ratio-preserving dimensions const logoTags = dbsWithLogos.map(([name, db]) => { const logo = db.documentation.logo; - const slug = name.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, ''); + const slug = name + .toLowerCase() + .replace(/[^a-z0-9]+/g, '-') + .replace(/^-|-$/g, ''); const imgPath = path.join(IMAGES_DIR, logo); const dims = getImageDimensions(imgPath); let sizeAttrs; if (dims) { - const { width, height } = fitToBoundingBox(dims.width, dims.height, MAX_WIDTH, MAX_HEIGHT, MIN_HEIGHT); + const { width, height } = fitToBoundingBox( + dims.width, + dims.height, + MAX_WIDTH, + MAX_HEIGHT, + MIN_HEIGHT, + ); sizeAttrs = `width="${width}" height="${height}"`; } else { - console.warn(` Could not read dimensions for ${logo}, using height-only fallback`); + console.warn( + ` Could not read dimensions for ${logo}, using height-only fallback`, + ); sizeAttrs = `height="${MAX_HEIGHT}"`; } @@ -936,9 +960,14 @@ function updateReadme(databases) { const content = fs.readFileSync(README_PATH, 'utf-8'); // Check if markers exist - if (!content.includes(README_START_MARKER) || !content.includes(README_END_MARKER)) { + if ( + !content.includes(README_START_MARKER) || + !content.includes(README_END_MARKER) + ) { console.log('README.md missing database markers, skipping update'); - console.log(` Add ${README_START_MARKER} and ${README_END_MARKER} to enable auto-generation`); + console.log( + ` Add ${README_START_MARKER} and ${README_END_MARKER} to enable auto-generation`, + ); return false; } @@ -948,11 +977,11 @@ function updateReadme(databases) { // Replace content between markers const pattern = new RegExp( `${README_START_MARKER}[\\s\\S]*?${README_END_MARKER}`, - 'g' + 'g', ); const newContent = content.replace( pattern, - `${README_START_MARKER}\n${logosHtml}\n${README_END_MARKER}` + `${README_START_MARKER}\n${logosHtml}\n${README_END_MARKER}`, ); if (newContent !== content) { @@ -990,9 +1019,14 @@ function extractCustomErrors() { const customErrors = JSON.parse(result.stdout); const moduleCount = Object.keys(customErrors).length; - const errorCount = Object.values(customErrors).reduce((sum, classes) => - sum + Object.values(classes).reduce((s, errs) => s + errs.length, 0), 0); - console.log(` Found ${errorCount} custom errors across ${moduleCount} modules`); + const errorCount = Object.values(customErrors).reduce( + (sum, classes) => + sum + Object.values(classes).reduce((s, errs) => s + errs.length, 0), + 0, + ); + console.log( + ` Found ${errorCount} custom errors across ${moduleCount} modules`, + ); return customErrors; } catch (err) { console.log(' Could not extract custom_errors:', err.message); @@ -1110,7 +1144,9 @@ function mergeWithExistingDiagnostics(newDatabases, existingData) { const preserved = Object.values(newDatabases).filter(d => d.score > 0).length; if (preserved > 0) { - console.log(`Preserved score/time_grains for ${preserved} databases from existing data`); + console.log( + `Preserved score/time_grains for ${preserved} databases from existing data`, + ); } return newDatabases; @@ -1153,7 +1189,7 @@ async function main() { console.log(`Processed ${Object.keys(databases).length} databases\n`); // Check if new data has scores; if not, preserve existing diagnostics - const hasNewScores = Object.values(databases).some((db) => db.score > 0); + const hasNewScores = Object.values(databases).some(db => db.score > 0); if (!hasNewScores && existingData) { databases = mergeWithExistingDiagnostics(databases, existingData); } @@ -1182,16 +1218,21 @@ async function main() { fs.writeFileSync(DATA_OUTPUT_FILE, JSON.stringify(output, null, 2) + '\n'); console.log(`Generated: ${path.relative(DOCS_DIR, DATA_OUTPUT_FILE)}`); - // Ensure supported directory exists if (!fs.existsSync(MDX_SUPPORTED_DIR)) { fs.mkdirSync(MDX_SUPPORTED_DIR, { recursive: true }); } // Clean up old MDX files that are no longer in the database list - console.log(`\nCleaning up old MDX files in ${path.relative(DOCS_DIR, MDX_SUPPORTED_DIR)}/`); - const existingMdxFiles = fs.readdirSync(MDX_SUPPORTED_DIR).filter(f => f.endsWith('.mdx')); - const validSlugs = new Set(Object.keys(databases).map(name => `${toSlug(name)}.mdx`)); + console.log( + `\nCleaning up old MDX files in ${path.relative(DOCS_DIR, MDX_SUPPORTED_DIR)}/`, + ); + const existingMdxFiles = fs + .readdirSync(MDX_SUPPORTED_DIR) + .filter(f => f.endsWith('.mdx')); + const validSlugs = new Set( + Object.keys(databases).map(name => `${toSlug(name)}.mdx`), + ); let removedCount = 0; for (const file of existingMdxFiles) { if (!validSlugs.has(file)) { @@ -1204,7 +1245,9 @@ async function main() { } // Generate individual MDX files for each database in supported/ subdirectory - console.log(`\nGenerating MDX files in ${path.relative(DOCS_DIR, MDX_SUPPORTED_DIR)}/`); + console.log( + `\nGenerating MDX files in ${path.relative(DOCS_DIR, MDX_SUPPORTED_DIR)}/`, + ); let mdxCount = 0; for (const [name, db] of Object.entries(databases)) { @@ -1233,7 +1276,7 @@ async function main() { }; fs.writeFileSync( path.join(MDX_OUTPUT_DIR, '_category_.json'), - JSON.stringify(categoryJson, null, 2) + '\n' + JSON.stringify(categoryJson, null, 2) + '\n', ); // Generate _category_.json for supported/ subdirectory (collapsible) @@ -1245,12 +1288,15 @@ async function main() { }; fs.writeFileSync( path.join(MDX_SUPPORTED_DIR, '_category_.json'), - JSON.stringify(supportedCategoryJson, null, 2) + '\n' + JSON.stringify(supportedCategoryJson, null, 2) + '\n', ); console.log(` Generated _category_.json files`); // Update README.md database logos (only when explicitly requested) - if (process.env.UPDATE_README === 'true' || process.argv.includes('--update-readme')) { + if ( + process.env.UPDATE_README === 'true' || + process.argv.includes('--update-readme') + ) { console.log(''); updateReadme(databases); } diff --git a/docs/scripts/generate-if-changed.mjs b/docs/scripts/generate-if-changed.mjs index b44d5e77ff5..248dd2b00f5 100644 --- a/docs/scripts/generate-if-changed.mjs +++ b/docs/scripts/generate-if-changed.mjs @@ -58,16 +58,28 @@ const GENERATORS = [ inputs: [ { type: 'glob', - base: path.join(ROOT_DIR, 'superset-frontend/packages/superset-ui-core/src/components'), + base: path.join( + ROOT_DIR, + 'superset-frontend/packages/superset-ui-core/src/components', + ), pattern: '**/*.stories.tsx', }, { type: 'glob', - base: path.join(ROOT_DIR, 'superset-frontend/packages/superset-core/src'), + base: path.join( + ROOT_DIR, + 'superset-frontend/packages/superset-core/src', + ), pattern: '**/*.stories.tsx', }, - { type: 'file', path: path.join(DOCS_DIR, 'scripts/generate-superset-components.mjs') }, - { type: 'file', path: path.join(DOCS_DIR, 'src/components/StorybookWrapper.jsx') }, + { + type: 'file', + path: path.join(DOCS_DIR, 'scripts/generate-superset-components.mjs'), + }, + { + type: 'file', + path: path.join(DOCS_DIR, 'src/components/StorybookWrapper.jsx'), + }, ], outputs: [ path.join(DOCS_DIR, 'developer_docs/components/index.mdx'), @@ -84,7 +96,10 @@ const GENERATORS = [ base: path.join(ROOT_DIR, 'superset/db_engine_specs'), pattern: '**/*.py', }, - { type: 'file', path: path.join(DOCS_DIR, 'scripts/generate-database-docs.mjs') }, + { + type: 'file', + path: path.join(DOCS_DIR, 'scripts/generate-database-docs.mjs'), + }, ], outputs: [ path.join(DOCS_DIR, 'src/data/databases.json'), @@ -96,15 +111,28 @@ const GENERATORS = [ command: 'python3 scripts/fix-openapi-spec.py && docusaurus gen-api-docs superset && node scripts/convert-api-sidebar.mjs && node scripts/generate-api-index.mjs && node scripts/generate-api-tag-pages.mjs', inputs: [ - { type: 'file', path: path.join(DOCS_DIR, 'static/resources/openapi.json') }, - { type: 'file', path: path.join(DOCS_DIR, 'scripts/fix-openapi-spec.py') }, - { type: 'file', path: path.join(DOCS_DIR, 'scripts/convert-api-sidebar.mjs') }, - { type: 'file', path: path.join(DOCS_DIR, 'scripts/generate-api-index.mjs') }, - { type: 'file', path: path.join(DOCS_DIR, 'scripts/generate-api-tag-pages.mjs') }, - ], - outputs: [ - path.join(DOCS_DIR, 'docs/api.mdx'), + { + type: 'file', + path: path.join(DOCS_DIR, 'static/resources/openapi.json'), + }, + { + type: 'file', + path: path.join(DOCS_DIR, 'scripts/fix-openapi-spec.py'), + }, + { + type: 'file', + path: path.join(DOCS_DIR, 'scripts/convert-api-sidebar.mjs'), + }, + { + type: 'file', + path: path.join(DOCS_DIR, 'scripts/generate-api-index.mjs'), + }, + { + type: 'file', + path: path.join(DOCS_DIR, 'scripts/generate-api-tag-pages.mjs'), + }, ], + outputs: [path.join(DOCS_DIR, 'docs/api.mdx')], }, ]; @@ -121,11 +149,15 @@ function walkDir(dir, pattern) { for (const entry of fs.readdirSync(currentDir, { withFileTypes: true })) { const fullPath = path.join(currentDir, entry.name); if (entry.isDirectory()) { - if (entry.name === 'node_modules' || entry.name === '__pycache__') continue; + if (entry.name === 'node_modules' || entry.name === '__pycache__') + continue; walk(fullPath); } else { // Normalize to forward slashes so glob patterns work on all platforms - const relativePath = path.relative(dir, fullPath).split(path.sep).join('/'); + const relativePath = path + .relative(dir, fullPath) + .split(path.sep) + .join('/'); if (regex.test(relativePath)) { results.push(fullPath); } @@ -160,7 +192,9 @@ function computeInputHash(inputs) { hash.update(`file:${input.path}:${hashFile(input.path)}\n`); } else if (input.type === 'glob') { const files = walkDir(input.base, input.pattern); - hash.update(`glob:${input.base}:${input.pattern}:count=${files.length}\n`); + hash.update( + `glob:${input.base}:${input.pattern}:count=${files.length}\n`, + ); for (const file of files) { hash.update(` ${path.relative(input.base, file)}:${hashFile(file)}\n`); } @@ -170,7 +204,7 @@ function computeInputHash(inputs) { } function outputsExist(outputs) { - return outputs.every((p) => fs.existsSync(p)); + return outputs.every(p => fs.existsSync(p)); } // --------------------------------------------------------------------------- @@ -211,11 +245,11 @@ async function main() { // parallel, then api-docs sequentially (it depends on docusaurus CLI // being available, not on other generators). - const independent = GENERATORS.filter((g) => g.name !== 'api-docs'); - const sequential = GENERATORS.filter((g) => g.name === 'api-docs'); + const independent = GENERATORS.filter(g => g.name !== 'api-docs'); + const sequential = GENERATORS.filter(g => g.name === 'api-docs'); // Check and run independent generators in parallel - const parallelPromises = independent.map((gen) => { + const parallelPromises = independent.map(gen => { const currentHash = computeInputHash(gen.inputs); const cachedHash = cache[gen.name]; const hasOutputs = outputsExist(gen.outputs); @@ -240,7 +274,7 @@ async function main() { stdio: 'inherit', env: process.env, }); - child.on('close', (code) => { + child.on('close', code => { if (code === 0) { updatedCache[gen.name] = currentHash; resolve(); @@ -249,7 +283,7 @@ async function main() { reject(new Error(`${gen.name} failed with exit code ${code}`)); } }); - child.on('error', (err) => { + child.on('error', err => { console.error(` βœ— ${gen.name} failed to start`); reject(err); }); @@ -301,7 +335,7 @@ async function main() { } console.log('Checking generators for changes...\n'); -main().catch((err) => { +main().catch(err => { console.error(err); process.exit(1); }); diff --git a/docs/scripts/generate-superset-components.mjs b/docs/scripts/generate-superset-components.mjs index 48e55855b5c..062fd0c2590 100644 --- a/docs/scripts/generate-superset-components.mjs +++ b/docs/scripts/generate-superset-components.mjs @@ -76,14 +76,30 @@ const SOURCES = [ // Components that require complex function props or aren't exported properly skipComponents: new Set([ // Complex function props (require callbacks, async data, or render props) - 'AsyncSelect', 'ConfirmStatusChange', 'CronPicker', 'LabeledErrorBoundInput', - 'AsyncAceEditor', 'AsyncEsmComponent', 'TimezoneSelector', + 'AsyncSelect', + 'ConfirmStatusChange', + 'CronPicker', + 'LabeledErrorBoundInput', + 'AsyncAceEditor', + 'AsyncEsmComponent', + 'TimezoneSelector', // Not exported from @superset/components index or have export mismatches - 'ActionCell', 'BooleanCell', 'ButtonCell', 'NullCell', 'NumericCell', 'TimeCell', - 'CertifiedBadgeWithTooltip', 'CodeSyntaxHighlighter', 'DynamicTooltip', - 'PopoverDropdown', 'PopoverSection', 'WarningIconWithTooltip', 'RefreshLabel', + 'ActionCell', + 'BooleanCell', + 'ButtonCell', + 'NullCell', + 'NumericCell', + 'TimeCell', + 'CertifiedBadgeWithTooltip', + 'CodeSyntaxHighlighter', + 'DynamicTooltip', + 'PopoverDropdown', + 'PopoverSection', + 'WarningIconWithTooltip', + 'RefreshLabel', // Components with complex nested props (JSX children, overlay, items arrays) - 'Dropdown', 'DropdownButton', + 'Dropdown', + 'DropdownButton', ]), }, { @@ -175,16 +191,15 @@ const CATEGORY_MAP = { // Documentation-only stories to skip (not actual components) const SKIP_STORIES = [ - 'Introduction', // Design System intro page - 'Overview', // Category overview pages - 'Examples', // Example collections - 'DesignSystem', // Meta design system page + 'Introduction', // Design System intro page + 'Overview', // Category overview pages + 'Examples', // Example collections + 'DesignSystem', // Meta design system page 'MetadataBarOverview', // Overview page - 'TableOverview', // Overview page - 'Filter Plugins', // Collection story, not a component + 'TableOverview', // Overview page + 'Filter Plugins', // Collection story, not a component ]; - /** * Collect the set of value names exported from a barrel file, following * `export * from './X'` re-exports one level deep. Used to verify that a @@ -198,7 +213,9 @@ function collectBarrelExports(barrelPath, visited = new Set()) { const content = fs.readFileSync(barrelPath, 'utf8'); - for (const m of content.matchAll(/export\s+\{([\s\S]*?)\}(?:\s+from\s+['"][^'"]+['"])?/g)) { + for (const m of content.matchAll( + /export\s+\{([\s\S]*?)\}(?:\s+from\s+['"][^'"]+['"])?/g, + )) { for (const part of m[1].split(',')) { const cleaned = part.trim().replace(/^type\s+/, ''); if (!cleaned) continue; @@ -213,7 +230,7 @@ function collectBarrelExports(barrelPath, visited = new Set()) { } for (const m of content.matchAll( - /export\s+(?:const|let|var|function|class)\s+([A-Za-z_]\w*)/g + /export\s+(?:const|let|var|function|class)\s+([A-Za-z_]\w*)/g, )) { exports.add(m[1]); } @@ -265,7 +282,10 @@ function walkDir(dir, files = []) { const fullPath = path.join(dir, entry.name); if (entry.isDirectory()) { walkDir(fullPath, files); - } else if (entry.name.endsWith('.stories.tsx') || entry.name.endsWith('.stories.ts')) { + } else if ( + entry.name.endsWith('.stories.tsx') || + entry.name.endsWith('.stories.ts') + ) { files.push(fullPath); } } @@ -308,7 +328,9 @@ function parseStoryFile(filePath, sourceConfig) { // Extract title from story meta (in export default block, not from data objects) // Look for title in the export default section, which typically starts with "export default {" - const metaMatch = content.match(/export\s+default\s*\{[\s\S]*?title:\s*['"]([^'"]+)['"]/); + const metaMatch = content.match( + /export\s+default\s*\{[\s\S]*?title:\s*['"]([^'"]+)['"]/, + ); const title = metaMatch ? metaMatch[1] : null; if (!title) return null; @@ -339,7 +361,7 @@ function parseStoryFile(filePath, sourceConfig) { // Extract description from parameters let description = ''; const descBlockMatch = content.match( - /description:\s*{\s*component:\s*([\s\S]*?)\s*},?\s*}/ + /description:\s*{\s*component:\s*([\s\S]*?)\s*},?\s*}/, ); if (descBlockMatch) { const descBlock = descBlockMatch[1]; @@ -353,7 +375,9 @@ function parseStoryFile(filePath, sourceConfig) { // Extract story exports const storyExports = []; - const exportMatches = content.matchAll(/export\s+(?:const|function)\s+(\w+)/g); + const exportMatches = content.matchAll( + /export\s+(?:const|function)\s+(\w+)/g, + ); for (const match of exportMatches) { if (match[1] !== 'default') { storyExports.push(match[1]); @@ -370,7 +394,9 @@ function parseStoryFile(filePath, sourceConfig) { // Handles: import Component from 'path' // and: import Component, { OtherExport } from 'path' const defaultImportMatch = content.match( - new RegExp(`import\\s+${componentName}(?:\\s*,\\s*{[^}]*})?\\s+from\\s+['"]([^'"]+)['"]`) + new RegExp( + `import\\s+${componentName}(?:\\s*,\\s*{[^}]*})?\\s+from\\s+['"]([^'"]+)['"]`, + ), ); if (defaultImportMatch) { componentImportPath = defaultImportMatch[1]; @@ -378,7 +404,9 @@ function parseStoryFile(filePath, sourceConfig) { } else { // Try named import const namedImportMatch = content.match( - new RegExp(`import\\s*{[^}]*\\b${componentName}\\b[^}]*}\\s*from\\s+['"]([^'"]+)['"]`) + new RegExp( + `import\\s*{[^}]*\\b${componentName}\\b[^}]*}\\s*from\\s+['"]([^'"]+)['"]`, + ), ); if (namedImportMatch) { componentImportPath = namedImportMatch[1]; @@ -434,9 +462,12 @@ function parseArgsContent(argsContent, args) { if (!trimmed || trimmed.startsWith('//')) continue; // Match: key: value pattern at start of line - const propMatch = trimmed.match(/^([a-zA-Z_$][a-zA-Z0-9_$]*):\s*(.+?)[\s,]*$/); + const propMatch = trimmed.match( + /^([a-zA-Z_$][a-zA-Z0-9_$]*):\s*(.+?)[\s,]*$/, + ); // Also match key with value on the next line (e.g., prettier wrapping long strings) - const keyOnlyMatch = !propMatch && trimmed.match(/^([a-zA-Z_$][a-zA-Z0-9_$]*):$/); + const keyOnlyMatch = + !propMatch && trimmed.match(/^([a-zA-Z_$][a-zA-Z0-9_$]*):$/); if (!propMatch && !keyOnlyMatch) continue; let key, valueStr; @@ -446,7 +477,8 @@ function parseArgsContent(argsContent, args) { } else { // Value is on the next line key = keyOnlyMatch[1]; - const nextLine = i + 1 < lines.length ? lines[i + 1].trim().replace(/,\s*$/, '') : ''; + const nextLine = + i + 1 < lines.length ? lines[i + 1].trim().replace(/,\s*$/, '') : ''; if (!nextLine) continue; valueStr = nextLine; i++; // Skip the next line since we consumed it @@ -503,7 +535,9 @@ function extractVariableArrays(content) { // Pattern 1: const varName = ['a', 'b', 'c']; // Also handles: export const varName: Type[] = ['a', 'b', 'c']; - const varMatches = content.matchAll(/(?:export\s+)?(?:const|let)\s+([a-zA-Z_$][a-zA-Z0-9_$]*)(?::\s*[^=]+)?\s*=\s*\[([^\]]+)\]/g); + const varMatches = content.matchAll( + /(?:export\s+)?(?:const|let)\s+([a-zA-Z_$][a-zA-Z0-9_$]*)(?::\s*[^=]+)?\s*=\s*\[([^\]]+)\]/g, + ); for (const varMatch of varMatches) { const varName = varMatch[1]; const arrayContent = varMatch[2]; @@ -518,7 +552,9 @@ function extractVariableArrays(content) { } // Pattern 2: const VAR = { options: [...] } - for SIZES.options, COLORS.options patterns - const objWithOptionsMatches = content.matchAll(/(?:const|let)\s+([A-Z][A-Z_0-9]*)\s*=\s*\{[^}]*options:\s*([a-zA-Z_$][a-zA-Z0-9_$]*)/g); + const objWithOptionsMatches = content.matchAll( + /(?:const|let)\s+([A-Z][A-Z_0-9]*)\s*=\s*\{[^}]*options:\s*([a-zA-Z_$][a-zA-Z0-9_$]*)/g, + ); for (const match of objWithOptionsMatches) { const objName = match[1]; const optionsVarName = match[2]; @@ -599,7 +635,10 @@ function parseArgTypes(argTypesContent, argTypes, fullContent) { // Extract description - find the position and extract properly const descIndex = propConfig.indexOf('description:'); if (descIndex !== -1) { - const descValue = extractStringValue(propConfig, descIndex + 'description:'.length); + const descValue = extractStringValue( + propConfig, + descIndex + 'description:'.length, + ); if (descValue) { argTypes[propName].description = descValue; } @@ -620,7 +659,9 @@ function parseArgTypes(argTypesContent, argTypes, fullContent) { } } else { // Check for variable reference: options: variableName or options: VAR.options - const varRefMatch = propConfig.match(/options:\s*([a-zA-Z_$][a-zA-Z0-9_$]*(?:\.[a-zA-Z_$][a-zA-Z0-9_$]*)?)/); + const varRefMatch = propConfig.match( + /options:\s*([a-zA-Z_$][a-zA-Z0-9_$]*(?:\.[a-zA-Z_$][a-zA-Z0-9_$]*)?)/, + ); if (varRefMatch) { const varRef = varRefMatch[1]; // Handle VAR.options pattern @@ -634,7 +675,9 @@ function parseArgTypes(argTypesContent, argTypes, fullContent) { } } else { // Check for ES6 shorthand: options, (same as options: options) - const shorthandMatch = propConfig.match(/(?:^|[,\s])options(?:[,\s]|$)/); + const shorthandMatch = propConfig.match( + /(?:^|[,\s])options(?:[,\s]|$)/, + ); if (shorthandMatch && variableArrays['options']) { argTypes[propName].type = 'select'; argTypes[propName].options = variableArrays['options']; @@ -644,8 +687,12 @@ function parseArgTypes(argTypesContent, argTypes, fullContent) { // Check for control type (radio, select, boolean, etc.) // Supports both: control: 'boolean' (shorthand) and control: { type: 'boolean' } (object) - const controlShorthandMatch = propConfig.match(/control:\s*['"]([^'"]+)['"]/); - const controlObjectMatch = propConfig.match(/control:\s*\{[^}]*type:\s*['"]([^'"]+)['"]/); + const controlShorthandMatch = propConfig.match( + /control:\s*['"]([^'"]+)['"]/, + ); + const controlObjectMatch = propConfig.match( + /control:\s*\{[^}]*type:\s*['"]([^'"]+)['"]/, + ); if (controlShorthandMatch) { argTypes[propName].type = controlShorthandMatch[1]; } else if (controlObjectMatch) { @@ -706,17 +753,19 @@ function extractBalancedBrackets(content, startIndex) { * Handles acronyms properly: imgURL -> "Image URL", coverLeft -> "Cover Left" */ function propNameToLabel(name) { - return name - // Insert space before uppercase letters that follow lowercase (camelCase boundary) - .replace(/([a-z])([A-Z])/g, '$1 $2') - // Handle common acronyms - keep them together - .replace(/([A-Z]+)([A-Z][a-z])/g, '$1 $2') - // Capitalize first letter - .replace(/^./, s => s.toUpperCase()) - // Fix common acronyms display - .replace(/\bUrl\b/g, 'URL') - .replace(/\bImg\b/g, 'Image') - .replace(/\bId\b/g, 'ID'); + return ( + name + // Insert space before uppercase letters that follow lowercase (camelCase boundary) + .replace(/([a-z])([A-Z])/g, '$1 $2') + // Handle common acronyms - keep them together + .replace(/([A-Z]+)([A-Z][a-z])/g, '$1 $2') + // Capitalize first letter + .replace(/^./, s => s.toUpperCase()) + // Fix common acronyms display + .replace(/\bUrl\b/g, 'URL') + .replace(/\bImg\b/g, 'Image') + .replace(/\bId\b/g, 'ID') + ); } /** @@ -764,17 +813,30 @@ function extractDocsConfig(content, storyNames) { for (const storyName of storyNames) { // Look for parameters block - const parametersPattern = new RegExp(`${storyName}\\.parameters\\s*=\\s*\\{`, 's'); + const parametersPattern = new RegExp( + `${storyName}\\.parameters\\s*=\\s*\\{`, + 's', + ); const parametersMatch = content.match(parametersPattern); if (parametersMatch) { - const parametersContent = extractBalancedBraces(content, parametersMatch.index + parametersMatch[0].length - 1); + const parametersContent = extractBalancedBraces( + content, + parametersMatch.index + parametersMatch[0].length - 1, + ); if (parametersContent) { // Extract sampleChildren - inline array using generic JSON parser - const sampleChildrenArrayMatch = parametersContent.match(/sampleChildren:\s*\[/); + const sampleChildrenArrayMatch = + parametersContent.match(/sampleChildren:\s*\[/); if (sampleChildrenArrayMatch) { - const arrayStartIndex = sampleChildrenArrayMatch.index + sampleChildrenArrayMatch[0].length - 1; - const arrayContent = extractBalancedBrackets(parametersContent, arrayStartIndex); + const arrayStartIndex = + sampleChildrenArrayMatch.index + + sampleChildrenArrayMatch[0].length - + 1; + const arrayContent = extractBalancedBrackets( + parametersContent, + arrayStartIndex, + ); if (arrayContent) { const parsed = jsToJson('[' + arrayContent + ']'); if (parsed && parsed.length > 0) { @@ -784,9 +846,16 @@ function extractDocsConfig(content, storyNames) { } // Extract sampleChildrenStyle - inline object using generic JSON parser - const sampleChildrenStyleMatch = parametersContent.match(/sampleChildrenStyle:\s*\{/); + const sampleChildrenStyleMatch = parametersContent.match( + /sampleChildrenStyle:\s*\{/, + ); if (sampleChildrenStyleMatch) { - const styleContent = extractBalancedBraces(parametersContent, sampleChildrenStyleMatch.index + sampleChildrenStyleMatch[0].length - 1); + const styleContent = extractBalancedBraces( + parametersContent, + sampleChildrenStyleMatch.index + + sampleChildrenStyleMatch[0].length - + 1, + ); if (styleContent) { const parsed = jsToJson('{' + styleContent + '}'); if (parsed) { @@ -798,7 +867,10 @@ function extractDocsConfig(content, storyNames) { // Extract staticProps - generic JSON-like object extraction const staticPropsMatch = parametersContent.match(/staticProps:\s*\{/); if (staticPropsMatch) { - const staticPropsContent = extractBalancedBraces(parametersContent, staticPropsMatch.index + staticPropsMatch[0].length - 1); + const staticPropsContent = extractBalancedBraces( + parametersContent, + staticPropsMatch.index + staticPropsMatch[0].length - 1, + ); if (staticPropsContent) { // Try to parse as JSON (handles inline data) const parsed = jsToJson('{' + staticPropsContent + '}'); @@ -811,32 +883,45 @@ function extractDocsConfig(content, storyNames) { // Extract gallery config const galleryMatch = parametersContent.match(/gallery:\s*\{/); if (galleryMatch) { - const galleryContent = extractBalancedBraces(parametersContent, galleryMatch.index + galleryMatch[0].length - 1); + const galleryContent = extractBalancedBraces( + parametersContent, + galleryMatch.index + galleryMatch[0].length - 1, + ); if (galleryContent) { gallery = {}; // Extract component name - const compMatch = galleryContent.match(/component:\s*['"]([^'"]+)['"]/); + const compMatch = galleryContent.match( + /component:\s*['"]([^'"]+)['"]/, + ); if (compMatch) gallery.component = compMatch[1]; // Extract sizes - variable reference - const sizesVarMatch = galleryContent.match(/sizes:\s*([a-zA-Z_$][a-zA-Z0-9_$]*)/); + const sizesVarMatch = galleryContent.match( + /sizes:\s*([a-zA-Z_$][a-zA-Z0-9_$]*)/, + ); if (sizesVarMatch && variableArrays[sizesVarMatch[1]]) { gallery.sizes = variableArrays[sizesVarMatch[1]]; } // Extract styles - variable reference - const stylesVarMatch = galleryContent.match(/styles:\s*([a-zA-Z_$][a-zA-Z0-9_$]*)/); + const stylesVarMatch = galleryContent.match( + /styles:\s*([a-zA-Z_$][a-zA-Z0-9_$]*)/, + ); if (stylesVarMatch && variableArrays[stylesVarMatch[1]]) { gallery.styles = variableArrays[stylesVarMatch[1]]; } // Extract sizeProp - const sizePropMatch = galleryContent.match(/sizeProp:\s*['"]([^'"]+)['"]/); + const sizePropMatch = galleryContent.match( + /sizeProp:\s*['"]([^'"]+)['"]/, + ); if (sizePropMatch) gallery.sizeProp = sizePropMatch[1]; // Extract styleProp - const stylePropMatch = galleryContent.match(/styleProp:\s*['"]([^'"]+)['"]/); + const stylePropMatch = galleryContent.match( + /styleProp:\s*['"]([^'"]+)['"]/, + ); if (stylePropMatch) gallery.styleProp = stylePropMatch[1]; } } @@ -845,11 +930,18 @@ function extractDocsConfig(content, storyNames) { const liveExampleMatch = parametersContent.match(/liveExample:\s*`/); if (liveExampleMatch) { // Find the closing backtick - const startIndex = liveExampleMatch.index + liveExampleMatch[0].length; + const startIndex = + liveExampleMatch.index + liveExampleMatch[0].length; let endIndex = startIndex; - while (endIndex < parametersContent.length && parametersContent[endIndex] !== '`') { + while ( + endIndex < parametersContent.length && + parametersContent[endIndex] !== '`' + ) { // Handle escaped backticks - if (parametersContent[endIndex] === '\\' && parametersContent[endIndex + 1] === '`') { + if ( + parametersContent[endIndex] === '\\' && + parametersContent[endIndex + 1] === '`' + ) { endIndex += 2; } else { endIndex++; @@ -857,23 +949,32 @@ function extractDocsConfig(content, storyNames) { } if (endIndex < parametersContent.length) { // Unescape template literal escapes (source text has \` and \$ for literal backticks/dollars) - liveExample = parametersContent.slice(startIndex, endIndex).replace(/\\`/g, '`').replace(/\\\$/g, '$'); + liveExample = parametersContent + .slice(startIndex, endIndex) + .replace(/\\`/g, '`') + .replace(/\\\$/g, '$'); } } // Extract renderComponent - allows overriding which component to render // Useful when the title-derived component (e.g., 'Icons') is a namespace, not a component - const renderComponentMatch = parametersContent.match(/renderComponent:\s*['"]([^'"]+)['"]/); + const renderComponentMatch = parametersContent.match( + /renderComponent:\s*['"]([^'"]+)['"]/, + ); if (renderComponentMatch) { renderComponent = renderComponentMatch[1]; } // Extract triggerProp/onHideProp - for components like Modal that need a trigger button - const triggerPropMatch = parametersContent.match(/triggerProp:\s*['"]([^'"]+)['"]/); + const triggerPropMatch = parametersContent.match( + /triggerProp:\s*['"]([^'"]+)['"]/, + ); if (triggerPropMatch) { triggerProp = triggerPropMatch[1]; } - const onHidePropMatch = parametersContent.match(/onHideProp:\s*['"]([^'"]+)['"]/); + const onHidePropMatch = parametersContent.match( + /onHideProp:\s*['"]([^'"]+)['"]/, + ); if (onHidePropMatch) { onHideProp = onHidePropMatch[1]; } @@ -882,27 +983,45 @@ function extractDocsConfig(content, storyNames) { // Format: examples: [{ title: 'Title', code: `...` }, ...] const examplesMatch = parametersContent.match(/examples:\s*\[/); if (examplesMatch) { - const examplesStartIndex = examplesMatch.index + examplesMatch[0].length - 1; - const examplesArrayContent = extractBalancedBrackets(parametersContent, examplesStartIndex); + const examplesStartIndex = + examplesMatch.index + examplesMatch[0].length - 1; + const examplesArrayContent = extractBalancedBrackets( + parametersContent, + examplesStartIndex, + ); if (examplesArrayContent) { examples = []; // Find each example object { title: '...', code: `...` } - const exampleObjPattern = /\{\s*title:\s*['"]([^'"]+)['"]\s*,\s*code:\s*`/g; + const exampleObjPattern = + /\{\s*title:\s*['"]([^'"]+)['"]\s*,\s*code:\s*`/g; let exampleMatch; - while ((exampleMatch = exampleObjPattern.exec(examplesArrayContent)) !== null) { + while ( + (exampleMatch = exampleObjPattern.exec(examplesArrayContent)) !== + null + ) { const title = exampleMatch[1]; - const codeStartIndex = exampleMatch.index + exampleMatch[0].length; + const codeStartIndex = + exampleMatch.index + exampleMatch[0].length; // Find closing backtick for code let codeEndIndex = codeStartIndex; - while (codeEndIndex < examplesArrayContent.length && examplesArrayContent[codeEndIndex] !== '`') { - if (examplesArrayContent[codeEndIndex] === '\\' && examplesArrayContent[codeEndIndex + 1] === '`') { + while ( + codeEndIndex < examplesArrayContent.length && + examplesArrayContent[codeEndIndex] !== '`' + ) { + if ( + examplesArrayContent[codeEndIndex] === '\\' && + examplesArrayContent[codeEndIndex + 1] === '`' + ) { codeEndIndex += 2; } else { codeEndIndex++; } } // Unescape template literal escapes (source text has \` and \$ for literal backticks/dollars) - const code = examplesArrayContent.slice(codeStartIndex, codeEndIndex).replace(/\\`/g, '`').replace(/\\\$/g, '$'); + const code = examplesArrayContent + .slice(codeStartIndex, codeEndIndex) + .replace(/\\`/g, '`') + .replace(/\\\$/g, '$'); examples.push({ title, code }); } } @@ -910,10 +1029,29 @@ function extractDocsConfig(content, storyNames) { } } - if (sampleChildren || gallery || staticProps || liveExample || examples || renderComponent || triggerProp) break; + if ( + sampleChildren || + gallery || + staticProps || + liveExample || + examples || + renderComponent || + triggerProp + ) + break; } - return { sampleChildren, sampleChildrenStyle, gallery, staticProps, liveExample, examples, renderComponent, triggerProp, onHideProp }; + return { + sampleChildren, + sampleChildrenStyle, + gallery, + staticProps, + liveExample, + examples, + renderComponent, + triggerProp, + onHideProp, + }; } /** @@ -927,11 +1065,17 @@ function extractArgsAndControls(content, componentName) { // Pattern: export default { argTypes: {...} } const defaultExportMatch = content.match(/export\s+default\s*\{/); if (defaultExportMatch) { - const metaContent = extractBalancedBraces(content, defaultExportMatch.index + defaultExportMatch[0].length - 1); + const metaContent = extractBalancedBraces( + content, + defaultExportMatch.index + defaultExportMatch[0].length - 1, + ); if (metaContent) { const metaArgTypesMatch = metaContent.match(/\bargTypes:\s*\{/); if (metaArgTypesMatch) { - const metaArgTypesContent = extractBalancedBraces(metaContent, metaArgTypesMatch.index + metaArgTypesMatch[0].length - 1); + const metaArgTypesContent = extractBalancedBraces( + metaContent, + metaArgTypesMatch.index + metaArgTypesMatch[0].length - 1, + ); if (metaArgTypesContent) { parseArgTypes(metaArgTypesContent, argTypes, content); } @@ -944,14 +1088,31 @@ function extractArgsAndControls(content, componentName) { // - InteractiveComponentName (CSF 2.0 convention) // - ComponentNameStory (CSF 3.0 convention) // - ComponentName (fallback) - const storyNames = [`Interactive${componentName}`, `${componentName}Story`, componentName]; + const storyNames = [ + `Interactive${componentName}`, + `${componentName}Story`, + componentName, + ]; // Extract docs config (sampleChildren, sampleChildrenStyle, gallery, staticProps, liveExample) from parameters.docs - const { sampleChildren, sampleChildrenStyle, gallery, staticProps, liveExample, examples, renderComponent, triggerProp, onHideProp } = extractDocsConfig(content, storyNames); + const { + sampleChildren, + sampleChildrenStyle, + gallery, + staticProps, + liveExample, + examples, + renderComponent, + triggerProp, + onHideProp, + } = extractDocsConfig(content, storyNames); for (const storyName of storyNames) { // Try CSF 3.0 format: export const StoryName: StoryObj = { args: {...}, argTypes: {...} } - const csf3Pattern = new RegExp(`export\\s+const\\s+${storyName}[^=]*=[^{]*\\{`, 's'); + const csf3Pattern = new RegExp( + `export\\s+const\\s+${storyName}[^=]*=[^{]*\\{`, + 's', + ); const csf3Match = content.match(csf3Pattern); if (csf3Match) { @@ -962,7 +1123,10 @@ function extractArgsAndControls(content, componentName) { // Extract args from story content const argsMatch = storyContent.match(/\bargs:\s*\{/); if (argsMatch) { - const argsContent = extractBalancedBraces(storyContent, argsMatch.index + argsMatch[0].length - 1); + const argsContent = extractBalancedBraces( + storyContent, + argsMatch.index + argsMatch[0].length - 1, + ); if (argsContent) { parseArgsContent(argsContent, args); } @@ -971,7 +1135,10 @@ function extractArgsAndControls(content, componentName) { // Extract argTypes from story content const argTypesMatch = storyContent.match(/\bargTypes:\s*\{/); if (argTypesMatch) { - const argTypesContent = extractBalancedBraces(storyContent, argTypesMatch.index + argTypesMatch[0].length - 1); + const argTypesContent = extractBalancedBraces( + storyContent, + argTypesMatch.index + argTypesMatch[0].length - 1, + ); if (argTypesContent) { parseArgTypes(argTypesContent, argTypes, content); } @@ -987,17 +1154,26 @@ function extractArgsAndControls(content, componentName) { const csf2ArgsPattern = new RegExp(`${storyName}\\.args\\s*=\\s*\\{`, 's'); const csf2ArgsMatch = content.match(csf2ArgsPattern); if (csf2ArgsMatch) { - const argsContent = extractBalancedBraces(content, csf2ArgsMatch.index + csf2ArgsMatch[0].length - 1); + const argsContent = extractBalancedBraces( + content, + csf2ArgsMatch.index + csf2ArgsMatch[0].length - 1, + ); if (argsContent) { parseArgsContent(argsContent, args); } } // Try CSF 2.0 argTypes: StoryName.argTypes = {...} - const csf2ArgTypesPattern = new RegExp(`${storyName}\\.argTypes\\s*=\\s*\\{`, 's'); + const csf2ArgTypesPattern = new RegExp( + `${storyName}\\.argTypes\\s*=\\s*\\{`, + 's', + ); const csf2ArgTypesMatch = content.match(csf2ArgTypesPattern); if (csf2ArgTypesMatch) { - const argTypesContent = extractBalancedBraces(content, csf2ArgTypesMatch.index + csf2ArgTypesMatch[0].length - 1); + const argTypesContent = extractBalancedBraces( + content, + csf2ArgTypesMatch.index + csf2ArgTypesMatch[0].length - 1, + ); if (argTypesContent) { parseArgTypes(argTypesContent, argTypes, content); } @@ -1025,14 +1201,29 @@ function extractArgsAndControls(content, componentName) { label, type: argType.type, options: argType.options, - description: argType.description + description: argType.description, }); } else if (typeof value === 'boolean') { - controls.push({ name: key, label, type: 'boolean', description: argType.description }); + controls.push({ + name: key, + label, + type: 'boolean', + description: argType.description, + }); } else if (typeof value === 'string') { - controls.push({ name: key, label, type: 'text', description: argType.description }); + controls.push({ + name: key, + label, + type: 'text', + description: argType.description, + }); } else if (typeof value === 'number') { - controls.push({ name: key, label, type: 'number', description: argType.description }); + controls.push({ + name: key, + label, + type: 'number', + description: argType.description, + }); } } @@ -1052,31 +1243,69 @@ function extractArgsAndControls(content, componentName) { label, type: argType.type, options: argType.options, - description: argType.description + description: argType.description, }); } - return { args, argTypes, controls, sampleChildren, sampleChildrenStyle, gallery, staticProps, liveExample, examples, renderComponent, triggerProp, onHideProp }; + return { + args, + argTypes, + controls, + sampleChildren, + sampleChildrenStyle, + gallery, + staticProps, + liveExample, + examples, + renderComponent, + triggerProp, + onHideProp, + }; } /** * Generate MDX content for a component */ function generateMDX(component, storyContent) { - const { componentName, description, relativePath, category, sourceConfig, resolvedImportPath, isDefaultExport } = component; + const { + componentName, + description, + relativePath, + category, + sourceConfig, + resolvedImportPath, + isDefaultExport, + } = component; - const { args, argTypes, controls, sampleChildren, sampleChildrenStyle, gallery, staticProps, liveExample, examples, renderComponent, triggerProp, onHideProp } = extractArgsAndControls(storyContent, componentName); + const { + args, + argTypes, + controls, + sampleChildren, + sampleChildrenStyle, + gallery, + staticProps, + liveExample, + examples, + renderComponent, + triggerProp, + onHideProp, + } = extractArgsAndControls(storyContent, componentName); // Merge staticProps into args for complex values (arrays, objects) that can't be parsed from inline args const mergedArgs = { ...args, ...staticProps }; // Format JSON: unquote property names but keep double quotes for string values // This avoids issues with single quotes in strings breaking MDX parsing - const controlsJson = JSON.stringify(controls, null, 2) - .replace(/"(\w+)":/g, '$1:'); + const controlsJson = JSON.stringify(controls, null, 2).replace( + /"(\w+)":/g, + '$1:', + ); - const propsJson = JSON.stringify(mergedArgs, null, 2) - .replace(/"(\w+)":/g, '$1:'); + const propsJson = JSON.stringify(mergedArgs, null, 2).replace( + /"(\w+)":/g, + '$1:', + ); // Format sampleChildren if present (from story's parameters.docs.sampleChildren) const sampleChildrenJson = sampleChildren @@ -1105,11 +1334,20 @@ function generateMDX(component, storyContent) { .join('\n '); // Generate props table with descriptions from argTypes - const propsTable = Object.entries(mergedArgs).map(([key, value]) => { - const type = typeof value === 'boolean' ? 'boolean' : typeof value === 'string' ? 'string' : typeof value === 'number' ? 'number' : 'any'; - const desc = argTypes[key]?.description || '-'; - return `| \`${key}\` | \`${type}\` | \`${JSON.stringify(value)}\` | ${desc} |`; - }).join('\n'); + const propsTable = Object.entries(mergedArgs) + .map(([key, value]) => { + const type = + typeof value === 'boolean' + ? 'boolean' + : typeof value === 'string' + ? 'string' + : typeof value === 'number' + ? 'number' + : 'any'; + const desc = argTypes[key]?.description || '-'; + return `| \`${key}\` | \`${type}\` | \`${JSON.stringify(value)}\` | ${desc} |`; + }) + .join('\n'); // Calculate relative import path based on category depth const importDepth = category.includes('/') ? 4 : 3; @@ -1137,13 +1375,13 @@ function generateMDX(component, storyContent) { const publicExports = sourceConfig.importPrefix.startsWith('@superset/') ? getPublicExports(sourceConfig) : null; - const isPubliclyExported = - !publicExports || publicExports.has(componentName); + const isPubliclyExported = !publicExports || publicExports.has(componentName); // Determine component description based on source - const defaultDesc = sourceConfig.category === 'ui' - ? `The ${componentName} component from Superset's UI library.` - : `The ${componentName} component from Superset.`; + const defaultDesc = + sourceConfig.category === 'ui' + ? `The ${componentName} component from Superset's UI library.` + : `The ${componentName} component from Superset.`; return `--- title: ${componentName} @@ -1174,7 +1412,9 @@ import { StoryWithControls${hasGallery ? ', ComponentGallery' : ''} } from '${wr # ${componentName} ${description || defaultDesc} -${hasGallery ? ` +${ + hasGallery + ? ` ## All Variants -` : ''} +` + : '' +} ## Live Example ## Try It @@ -1203,36 +1465,59 @@ ${hasGallery ? ` Edit the code below to experiment with the component: \`\`\`tsx live -${liveExample || `function Demo() { +${ + liveExample || + `function Demo() { return ( <${componentName} ${liveExampleProps || '// Add props here'} - ${childrenValue ? `> + ${ + childrenValue + ? `> ${childrenValue} - ` : '/>'} + ` + : '/>' + } ); -}`} +}` +} \`\`\` -${examples && examples.length > 0 ? examples.map(ex => ` +${ + examples && examples.length > 0 + ? examples + .map( + ex => ` ## ${ex.title} \`\`\`tsx live ${ex.code} \`\`\` -`).join('') : ''} -${Object.keys(args).length > 0 ? `## Props +`, + ) + .join('') + : '' +} +${ + Object.keys(args).length > 0 + ? `## Props | Prop | Type | Default | Description | |------|------|---------|-------------| -${propsTable}` : ''} +${propsTable}` + : '' +} -${isPubliclyExported ? `## Import +${ + isPubliclyExported + ? `## Import \`\`\`tsx ${useDefaultImport ? `import ${componentName} from '${docImportPath}';` : `import { ${componentName} } from '${docImportPath}';`} \`\`\` ----` : '---'} +---` + : '---' +} :::tip[Improve this page] This documentation is auto-generated from the component's Storybook story. @@ -1245,9 +1530,24 @@ Help improve it by [editing the story file](https://github.com/apache/superset/e * Category display names for sidebar */ const CATEGORY_LABELS = { - ui: { title: 'Core Components', sidebarLabel: 'Core Components', description: 'Buttons, inputs, modals, selects, and other fundamental UI elements.' }, - 'design-system': { title: 'Layout Components', sidebarLabel: 'Layout Components', description: 'Grid, Layout, Table, Flex, Space, and container components for page structure.' }, - extension: { title: 'Extension Components', sidebarLabel: 'Extension Components', description: 'Components available to extension developers via @apache-superset/core/components.' }, + ui: { + title: 'Core Components', + sidebarLabel: 'Core Components', + description: + 'Buttons, inputs, modals, selects, and other fundamental UI elements.', + }, + 'design-system': { + title: 'Layout Components', + sidebarLabel: 'Layout Components', + description: + 'Grid, Layout, Table, Flex, Space, and container components for page structure.', + }, + extension: { + title: 'Extension Components', + sidebarLabel: 'Extension Components', + description: + 'Components available to extension developers via @apache-superset/core/components.', + }, }; /** @@ -1255,8 +1555,10 @@ const CATEGORY_LABELS = { */ function generateCategoryIndex(category, components) { const labels = CATEGORY_LABELS[category] || { - title: category.charAt(0).toUpperCase() + category.slice(1).replace(/-/g, ' '), - sidebarLabel: category.charAt(0).toUpperCase() + category.slice(1).replace(/-/g, ' '), + title: + category.charAt(0).toUpperCase() + category.slice(1).replace(/-/g, ' '), + sidebarLabel: + category.charAt(0).toUpperCase() + category.slice(1).replace(/-/g, ' '), }; const componentList = components .sort((a, b) => a.componentName.localeCompare(b.componentName)) @@ -1398,7 +1700,9 @@ function generateTodoMd(skippedFiles) { const sections = Object.entries(grouped) .map(([source, files]) => { - const fileList = files.map(f => `- [ ] \`${path.relative(ROOT_DIR, f)}\``).join('\n'); + const fileList = files + .map(f => `- [ ] \`${path.relative(ROOT_DIR, f)}\``) + .join('\n'); return `### ${source}\n\n${files.length} components\n\n${fileList}`; }) .join('\n\n'); @@ -1439,10 +1743,21 @@ ${sections} * Build metadata for a component (for JSON output) */ function buildComponentMetadata(component, storyContent) { - const { componentName, description, category, sourceConfig, resolvedImportPath, extensionCompatible } = component; - const { args, controls, gallery, liveExample } = extractArgsAndControls(storyContent, componentName); + const { + componentName, + description, + category, + sourceConfig, + resolvedImportPath, + extensionCompatible, + } = component; + const { args, controls, gallery, liveExample } = extractArgsAndControls( + storyContent, + componentName, + ); const labels = CATEGORY_LABELS[category] || { - title: category.charAt(0).toUpperCase() + category.slice(1).replace(/-/g, ' '), + title: + category.charAt(0).toUpperCase() + category.slice(1).replace(/-/g, ' '), }; return { @@ -1518,10 +1833,18 @@ function generateExtensionTypeDeclarations(extensionComponents) { if (!extracted) continue; for (const type of extracted.types) { - if (type.definition.includes('AntdAlertProps') || type.definition.includes('AlertProps')) { - imports.add("import type { AlertProps as AntdAlertProps } from 'antd/es/alert';"); + if ( + type.definition.includes('AntdAlertProps') || + type.definition.includes('AlertProps') + ) { + imports.add( + "import type { AlertProps as AntdAlertProps } from 'antd/es/alert';", + ); } - if (type.definition.includes('PropsWithChildren') || type.definition.includes('FC')) { + if ( + type.definition.includes('PropsWithChildren') || + type.definition.includes('FC') + ) { imports.add("import type { PropsWithChildren, FC } from 'react';"); } typeDeclarations.push(`export type ${type.name} = ${type.definition};`); @@ -1533,7 +1856,7 @@ function generateExtensionTypeDeclarations(extensionComponents) { componentDeclarations.push( hasPropsType ? `export const ${name}: FC<${propsType}>;` - : `export const ${name}: FC>;` + : `export const ${name}: FC>;`, ); } } @@ -1584,11 +1907,15 @@ async function main() { // Find enabled story files const enabledFiles = findEnabledStoryFiles(); - console.log(`Found ${enabledFiles.length} story files from enabled sources\n`); + console.log( + `Found ${enabledFiles.length} story files from enabled sources\n`, + ); // Find disabled story files (for tracking) const disabledFiles = findDisabledStoryFiles(); - console.log(`Found ${disabledFiles.length} story files from disabled sources (tracking only)\n`); + console.log( + `Found ${disabledFiles.length} story files from disabled sources (tracking only)\n`, + ); // Parse enabled files const components = []; @@ -1627,7 +1954,10 @@ async function main() { for (const component of categoryComponents) { const storyContent = fs.readFileSync(component.filePath, 'utf-8'); const mdxContent = generateMDX(component, storyContent); - const outputPath = path.join(categoryDir, `${component.componentName.toLowerCase()}.mdx`); + const outputPath = path.join( + categoryDir, + `${component.componentName.toLowerCase()}.mdx`, + ); fs.writeFileSync(outputPath, mdxContent); console.log(` βœ“ ${category}/${component.componentName}`); generatedCount++; @@ -1659,7 +1989,8 @@ async function main() { statistics: { totalComponents: componentMetadata.length, byCategory, - extensionCompatible: componentMetadata.filter(c => c.extensionCompatible).length, + extensionCompatible: componentMetadata.filter(c => c.extensionCompatible) + .length, withGallery: componentMetadata.filter(c => c.hasGallery).length, withLiveExample: componentMetadata.filter(c => c.hasLiveExample).length, }, @@ -1682,7 +2013,9 @@ async function main() { } const typesContent = generateExtensionTypeDeclarations(extensionComponents); fs.writeFileSync(TYPES_OUTPUT_PATH, typesContent); - console.log(` βœ“ extension types (${extensionComponents.length} components)`); + console.log( + ` βœ“ extension types (${extensionComponents.length} components)`, + ); } // Generate main overview @@ -1698,7 +2031,9 @@ async function main() { console.log(` βœ“ TODO.md`); console.log(`\nDone! Generated ${generatedCount} component pages.`); - console.log(`Tracked ${disabledFiles.length} components for future implementation.`); + console.log( + `Tracked ${disabledFiles.length} components for future implementation.`, + ); } main().catch(console.error); diff --git a/docs/scripts/lint-docs-links.mjs b/docs/scripts/lint-docs-links.mjs index 7d29ba59e2d..b4418f6ece2 100644 --- a/docs/scripts/lint-docs-links.mjs +++ b/docs/scripts/lint-docs-links.mjs @@ -65,11 +65,25 @@ const docsRoot = path.join(__dirname, '..'); const ROOTS = ['docs', 'admin_docs', 'developer_docs', 'components']; const NON_DOC_EXTENSIONS = new Set([ - '.png', '.jpg', '.jpeg', '.gif', '.webp', '.svg', '.ico', - '.json', '.yaml', '.yml', '.txt', '.csv', - '.zip', '.tar', '.gz', + '.png', + '.jpg', + '.jpeg', + '.gif', + '.webp', + '.svg', + '.ico', + '.json', + '.yaml', + '.yml', + '.txt', + '.csv', + '.zip', + '.tar', + '.gz', '.pdf', - '.mp4', '.webm', '.mov', + '.mp4', + '.webm', + '.mov', ]); const LINK_RE = /\[[^\]\n]+?\]\((?\.{1,2}\/[^)\s]+?)\)/g; @@ -180,19 +194,19 @@ for (const f of findings) { } console.error( - `βœ— lint-docs-links: found ${findings.length} broken internal link(s)` + `βœ— lint-docs-links: found ${findings.length} broken internal link(s)`, ); console.error(''); if (groups.bare.length) { console.error( - ` ${groups.bare.length} bare relative link(s) (no .md/.mdx extension)` + ` ${groups.bare.length} bare relative link(s) (no .md/.mdx extension)`, ); console.error( - " Docusaurus's file resolver skips these; the browser resolves them" + " Docusaurus's file resolver skips these; the browser resolves them", ); console.error( - ' against the current page URL β€” wrong directory for trailing-slash routes.' + ' against the current page URL β€” wrong directory for trailing-slash routes.', ); console.error(' Add the extension so the file resolver picks them up.'); console.error(''); @@ -204,21 +218,19 @@ if (groups.bare.length) { if (groups['wrong-extension'].length) { console.error( - ` ${groups['wrong-extension'].length} wrong-extension link(s) (.md vs .mdx mismatch)` + ` ${groups['wrong-extension'].length} wrong-extension link(s) (.md vs .mdx mismatch)`, ); console.error(' The target file exists with the other extension on disk.'); console.error(''); for (const f of groups['wrong-extension']) { - console.error( - ` ${f.file}:${f.line} ${f.url} β†’ use ${f.actualExt}` - ); + console.error(` ${f.file}:${f.line} ${f.url} β†’ use ${f.actualExt}`); } console.error(''); } if (groups['missing-target'].length) { console.error( - ` ${groups['missing-target'].length} missing-target link(s) (file doesn't exist)` + ` ${groups['missing-target'].length} missing-target link(s) (file doesn't exist)`, ); console.error(''); for (const f of groups['missing-target']) { diff --git a/docs/scripts/manage-versions.mjs b/docs/scripts/manage-versions.mjs index 11f90285460..64a5a249c44 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 rawArgs = process.argv.slice(2); const skipGenerate = rawArgs.includes('--skip-generate'); -const args = rawArgs.filter((a) => a !== '--skip-generate'); +const args = rawArgs.filter(a => a !== '--skip-generate'); const command = args[0]; // 'add' or 'remove' const section = args[1]; // 'user_docs', 'admin_docs', 'developer_docs', or 'components' const version = args[2]; // version string like '1.2.0' @@ -73,7 +73,8 @@ function freezeDataImports(section, version) { // Matches data file imports in two flavors: // `from '../../foo/bar.json'` (relative, must escape one or more dirs) // `from '@site/static/foo.json'` (Docusaurus site-root alias) - const dataImportRe = /(from\s+['"])((?:\.\.\/)+|@site\/)([^'"\s]+\.(?:json|ya?ml))(['"])/g; + const dataImportRe = + /(from\s+['"])((?:\.\.\/)+|@site\/)([^'"\s]+\.(?:json|ya?ml))(['"])/g; function freezeOne(fullPath, depth, prefix, pathSpec, importPath, suffix) { let resolvedSource; @@ -87,7 +88,9 @@ function freezeDataImports(section, version) { const upCount = pathSpec.match(/\.\.\//g).length; if (upCount <= depth) return null; const relativeFromVersioned = path.relative(versionedDocsPath, fullPath); - const originalDir = path.dirname(path.join(sectionRoot, relativeFromVersioned)); + const originalDir = path.dirname( + path.join(sectionRoot, relativeFromVersioned), + ); resolvedSource = path.resolve(originalDir, pathSpec + importPath); } // Skip imports that land inside the section root β€” those get copied @@ -105,7 +108,9 @@ function freezeDataImports(section, version) { .relative(path.dirname(fullPath), destPath) .split(path.sep) .join('/'); - const finalImport = rewritten.startsWith('.') ? rewritten : `./${rewritten}`; + const finalImport = rewritten.startsWith('.') + ? rewritten + : `./${rewritten}`; return `${prefix}${finalImport}${suffix}`; } @@ -119,19 +124,32 @@ function freezeDataImports(section, version) { const original = fs.readFileSync(fullPath, 'utf8'); let inFence = false; let mutated = false; - const updated = original.split('\n').map(line => { - if (/^\s*(```|~~~)/.test(line)) { - inFence = !inFence; - return line; - } - if (inFence) return line; - return line.replace(dataImportRe, (match, prefix, pathSpec, importPath, suffix) => { - const rewritten = freezeOne(fullPath, depth, prefix, pathSpec, importPath, suffix); - if (rewritten === null) return match; - mutated = true; - return rewritten; - }); - }).join('\n'); + const updated = original + .split('\n') + .map(line => { + if (/^\s*(```|~~~)/.test(line)) { + inFence = !inFence; + return line; + } + if (inFence) return line; + return line.replace( + dataImportRe, + (match, prefix, pathSpec, importPath, suffix) => { + const rewritten = freezeOne( + fullPath, + depth, + prefix, + pathSpec, + importPath, + suffix, + ); + if (rewritten === null) return match; + mutated = true; + return rewritten; + }, + ); + }) + .join('\n'); if (mutated) { fs.writeFileSync(fullPath, updated); const rel = path.relative(versionedDocsPath, fullPath); @@ -171,20 +189,23 @@ function fixVersionedImports(section, version) { // Track fenced code blocks so we don't rewrite import samples inside // ```ts / ```js (etc.) blocks that are documentation, not real imports. let inFence = false; - const updated = original.split('\n').map(line => { - if (/^\s*(```|~~~)/.test(line)) { - inFence = !inFence; - return line; - } - if (inFence) return line; - return line.replace( - /(from\s+['"])((?:\.\.\/)+)/g, - (match, prefix, dots) => { - const upCount = dots.match(/\.\.\//g).length; - return upCount > depth ? `${prefix}../${dots}` : match; - }, - ); - }).join('\n'); + const updated = original + .split('\n') + .map(line => { + if (/^\s*(```|~~~)/.test(line)) { + inFence = !inFence; + return line; + } + if (inFence) return line; + return line.replace( + /(from\s+['"])((?:\.\.\/)+)/g, + (match, prefix, dots) => { + const upCount = dots.match(/\.\.\//g).length; + return upCount > depth ? `${prefix}../${dots}` : match; + }, + ); + }) + .join('\n'); if (updated !== original) { fs.writeFileSync(fullPath, updated); const rel = path.relative(versionedDocsPath, fullPath); @@ -254,14 +275,15 @@ function addVersion(section, version) { // Update config // Add to onlyIncludeVersions array (after 'current') - const versionIndex = config[section].onlyIncludeVersions.indexOf('current') + 1; + const versionIndex = + config[section].onlyIncludeVersions.indexOf('current') + 1; config[section].onlyIncludeVersions.splice(versionIndex, 0, version); // Add version metadata config[section].versions[version] = { label: version, path: version, - banner: 'none' + banner: 'none', }; // Note: we deliberately do NOT auto-bump `lastVersion` to the new @@ -334,7 +356,10 @@ function removeVersion(section, version) { fs.unlinkSync(versionsJsonPath); console.log(` Removed empty ${versionsJsonFile}`); } else { - fs.writeFileSync(versionsJsonPath, JSON.stringify(versions, null, 2) + '\n'); + fs.writeFileSync( + versionsJsonPath, + JSON.stringify(versions, null, 2) + '\n', + ); console.log(` Updated ${versionsJsonFile}`); } } @@ -348,8 +373,11 @@ function removeVersion(section, version) { // Update lastVersion if needed if (config[section].lastVersion === version) { // Set to the next available version or 'current' - const remainingVersions = config[section].onlyIncludeVersions.filter(v => v !== 'current'); - config[section].lastVersion = remainingVersions.length > 0 ? remainingVersions[0] : 'current'; + const remainingVersions = config[section].onlyIncludeVersions.filter( + v => v !== 'current', + ); + config[section].lastVersion = + remainingVersions.length > 0 ? remainingVersions[0] : 'current'; console.log(` Updated lastVersion to ${config[section].lastVersion}`); } diff --git a/docs/sip/authenticated-encryption-at-rest.md b/docs/sip/authenticated-encryption-at-rest.md index c95caf25255..26ab00d3490 100644 --- a/docs/sip/authenticated-encryption-at-rest.md +++ b/docs/sip/authenticated-encryption-at-rest.md @@ -49,7 +49,7 @@ decryption to fail loudly rather than yielding attacker-influenced plaintext. Using authenticated encryption for secrets at rest is an ASVS L1 expectation (11.3.2 / cryptography best practice). -`config.py` already documents that operators *can* switch to GCM by writing a +`config.py` already documents that operators _can_ switch to GCM by writing a custom `AbstractEncryptedFieldAdapter`, but: 1. it is opt-in, undocumented as a security recommendation, and easy to miss; diff --git a/docs/src/components/FAQSchema.tsx b/docs/src/components/FAQSchema.tsx index 45a56b424b7..c13c2eff180 100644 --- a/docs/src/components/FAQSchema.tsx +++ b/docs/src/components/FAQSchema.tsx @@ -39,7 +39,9 @@ interface FAQSchemaProps { * { question: "How do I install it?", answer: "You can install via..." } * ]} /> */ -export default function FAQSchema({ faqs }: FAQSchemaProps): JSX.Element | null { +export default function FAQSchema({ + faqs, +}: FAQSchemaProps): JSX.Element | null { // FAQPage schema requires a non-empty mainEntity array per schema.org specs if (!faqs || faqs.length === 0) { return null; @@ -48,7 +50,7 @@ export default function FAQSchema({ faqs }: FAQSchemaProps): JSX.Element | null const schema = { '@context': 'https://schema.org', '@type': 'FAQPage', - mainEntity: faqs.map((faq) => ({ + mainEntity: faqs.map(faq => ({ '@type': 'Question', name: faq.question, acceptedAnswer: { diff --git a/docs/src/components/GetStartedSplitButton.tsx b/docs/src/components/GetStartedSplitButton.tsx index 9f4a541884c..64bdd5b73fe 100644 --- a/docs/src/components/GetStartedSplitButton.tsx +++ b/docs/src/components/GetStartedSplitButton.tsx @@ -64,9 +64,7 @@ const Root = styled.div<{ $variant: 'hero' | 'navbar' }>` text-decoration: none; min-width: 0; ${({ $variant }) => - $variant === 'hero' - ? `padding: 10px 10px;` - : `padding: 7px 8px;`} + $variant === 'hero' ? `padding: 10px 10px;` : `padding: 7px 8px;`} } .split-main:hover { @@ -79,9 +77,7 @@ const Root = styled.div<{ $variant: 'hero' | 'navbar' }>` align-self: stretch; background: rgba(255, 255, 255, 0.38); ${({ $variant }) => - $variant === 'hero' - ? `margin: 8px 0;` - : `margin: 6px 0;`} + $variant === 'hero' ? `margin: 8px 0;` : `margin: 6px 0;`} } .split-dropdown-trigger { diff --git a/docs/src/components/StorybookWrapper.jsx b/docs/src/components/StorybookWrapper.jsx index 1220b56add5..87b5c47b86a 100644 --- a/docs/src/components/StorybookWrapper.jsx +++ b/docs/src/components/StorybookWrapper.jsx @@ -72,7 +72,7 @@ function getProviders() { // Configure Ant Design to render portals (tooltips, dropdowns, etc.) // inside the closest .storybook-example container instead of document.body // This fixes positioning issues in the docs pages - const getPopupContainer = (triggerNode) => { + const getPopupContainer = triggerNode => { // Find the closest .storybook-example container const container = triggerNode?.closest?.('.storybook-example'); return container || document.body; @@ -190,7 +190,11 @@ const CHILDREN_PROP_NAMES = ['label', 'children', 'text', 'content']; // Extract children from props based on common conventions function extractChildren(props) { for (const propName of CHILDREN_PROP_NAMES) { - if (props[propName] !== undefined && props[propName] !== null && props[propName] !== '') { + if ( + props[propName] !== undefined && + props[propName] !== null && + props[propName] !== '' + ) { const { [propName]: childContent, ...restProps } = props; return { children: childContent, restProps }; } @@ -220,7 +224,11 @@ function generateSampleChildren(sampleChildren, sampleChildrenStyle) { return ; } // Fallback if component not found - return
    {item.props?.children || `Unknown: ${item.component}`}
    ; + return ( +
    + {item.props?.children || `Unknown: ${item.component}`} +
    + ); } // Simple string return ( @@ -252,7 +260,16 @@ function generateSampleChildren(sampleChildren, sampleChildrenStyle) { // renderComponent allows overriding which component to actually render (useful when the named // component is a namespace object like Icons, not a React component) // triggerProp: for components like Modal that need a trigger, specify the boolean prop that controls visibility -function StoryWithControlsInner({ component, renderComponent, props, controls, sampleChildren, sampleChildrenStyle, triggerProp, onHideProp }) { +function StoryWithControlsInner({ + component, + renderComponent, + props, + controls, + sampleChildren, + sampleChildrenStyle, + triggerProp, + onHideProp, +}) { // Use renderComponent if provided, otherwise use the main component name const componentToRender = renderComponent || component; const Component = resolveComponent(componentToRender); @@ -274,7 +291,7 @@ function StoryWithControlsInner({ component, renderComponent, props, controls, s : extractChildren(stateProps); // Filter out undefined values so they don't override component defaults const filteredProps = Object.fromEntries( - Object.entries(restProps).filter(([, v]) => v !== undefined) + Object.entries(restProps).filter(([, v]) => v !== undefined), ); // Resolve any prop values that are component descriptors @@ -283,7 +300,12 @@ function StoryWithControlsInner({ component, renderComponent, props, controls, s // e.g., items: [{ id: 'x', element: { component: 'div', props: { children: 'text' } } }] Object.keys(filteredProps).forEach(key => { const value = filteredProps[key]; - if (value && typeof value === 'object' && !Array.isArray(value) && value.component) { + if ( + value && + typeof value === 'object' && + !Array.isArray(value) && + value.component + ) { const PropComponent = resolveComponent(value.component); if (PropComponent) { filteredProps[key] = ; @@ -295,10 +317,18 @@ function StoryWithControlsInner({ component, renderComponent, props, controls, s const resolved = { ...item }; Object.keys(resolved).forEach(field => { const fieldValue = resolved[field]; - if (fieldValue && typeof fieldValue === 'object' && !Array.isArray(fieldValue) && fieldValue.component) { + if ( + fieldValue && + typeof fieldValue === 'object' && + !Array.isArray(fieldValue) && + fieldValue.component + ) { const FieldComponent = resolveComponent(fieldValue.component); if (FieldComponent) { - resolved[field] = React.createElement(FieldComponent, { key: `${key}-${idx}`, ...fieldValue.props }); + resolved[field] = React.createElement(FieldComponent, { + key: `${key}-${idx}`, + ...fieldValue.props, + }); } } }); @@ -312,14 +342,16 @@ function StoryWithControlsInner({ component, renderComponent, props, controls, s // For List-like components with dataSource but no renderItem, provide a default if (filteredProps.dataSource && !filteredProps.renderItem) { const ListItem = resolveComponent('List')?.Item; - filteredProps.renderItem = (item) => + filteredProps.renderItem = item => ListItem ? React.createElement(ListItem, null, String(item)) : React.createElement('div', null, String(item)); } // Use sample children if provided, otherwise use props children - const children = generateSampleChildren(sampleChildren, sampleChildrenStyle) || propsChildren; + const children = + generateSampleChildren(sampleChildren, sampleChildrenStyle) || + propsChildren; // For components with a trigger (like Modal with show/onHide), add handlers. // onHideProp supports comma-separated names for components with multiple close @@ -356,7 +388,9 @@ function StoryWithControlsInner({ component, renderComponent, props, controls, s Open {component} )} - {children} + + {children} + ) : (
    @@ -384,7 +418,9 @@ function StoryWithControlsInner({ component, renderComponent, props, controls, s {control.type === 'select' ? ( - ) : control.type === 'inline-radio' || control.type === 'radio' ? ( -
    + ) : control.type === 'inline-radio' || + control.type === 'radio' ? ( +
    {control.options?.map(option => ( @@ -422,7 +467,9 @@ function StoryWithControlsInner({ component, renderComponent, props, controls, s updateProp(control.name, Number(e.target.value))} + onChange={e => + updateProp(control.name, Number(e.target.value)) + } style={{ width: '100%', padding: '5px' }} /> ) : control.type === 'color' ? ( @@ -457,7 +504,16 @@ function StoryWithControlsInner({ component, renderComponent, props, controls, s // A simple component to display a story with controls // renderComponent: optional override for which component to render (e.g., 'Icons.InfoCircleOutlined' when component='Icons') // triggerProp/onHideProp: for components like Modal that need a button to open (e.g., triggerProp="show", onHideProp="onHide") -export function StoryWithControls({ component: Component, renderComponent, props = {}, controls = [], sampleChildren, sampleChildrenStyle, triggerProp, onHideProp }) { +export function StoryWithControls({ + component: Component, + renderComponent, + props = {}, + controls = [], + sampleChildren, + sampleChildrenStyle, + triggerProp, + onHideProp, +}) { return ( }> {() => ( @@ -477,7 +533,13 @@ export function StoryWithControls({ component: Component, renderComponent, props } // Inner component for ComponentGallery (browser-only) -function ComponentGalleryInner({ component, sizes, styles, sizeProp, styleProp }) { +function ComponentGalleryInner({ + component, + sizes, + styles, + sizeProp, + styleProp, +}) { const Component = resolveComponent(component); const Providers = getProviders(); @@ -495,7 +557,14 @@ function ComponentGalleryInner({ component, sizes, styles, sizeProp, styleProp } {sizes.map(size => (

    {size}

    -
    +
    {styles.map(style => ( }> {() => ( diff --git a/docs/src/components/databases/DatabaseIndex.tsx b/docs/src/components/databases/DatabaseIndex.tsx index 91c58964a31..4236619bf56 100644 --- a/docs/src/components/databases/DatabaseIndex.tsx +++ b/docs/src/components/databases/DatabaseIndex.tsx @@ -18,7 +18,17 @@ */ import React, { useState, useMemo } from 'react'; -import { Card, Row, Col, Statistic, Table, Tag, Input, Select, Tooltip } from 'antd'; +import { + Card, + Row, + Col, + Statistic, + Table, + Tag, + Input, + Select, + Tooltip, +} from 'antd'; import { DatabaseOutlined, CheckCircleOutlined, @@ -37,7 +47,7 @@ interface DatabaseIndexProps { // Type for table entries (includes both regular DBs and compatible DBs) interface TableEntry { name: string; - categories: string[]; // Multiple categories supported + categories: string[]; // Multiple categories supported score: number; max_score: number; timeGrainCount: number; @@ -66,20 +76,20 @@ interface TableEntry { // Map category constant names to display names const CATEGORY_DISPLAY_NAMES: Record = { - 'CLOUD_AWS': 'Cloud - AWS', - 'CLOUD_GCP': 'Cloud - Google', - 'CLOUD_AZURE': 'Cloud - Azure', - 'CLOUD_DATA_WAREHOUSES': 'Cloud Data Warehouses', - 'APACHE_PROJECTS': 'Apache Projects', - 'TRADITIONAL_RDBMS': 'Traditional RDBMS', - 'ANALYTICAL_DATABASES': 'Analytical Databases', - 'SEARCH_NOSQL': 'Search & NoSQL', - 'QUERY_ENGINES': 'Query Engines', - 'TIME_SERIES': 'Time Series Databases', - 'OTHER': 'Other Databases', - 'OPEN_SOURCE': 'Open Source', - 'HOSTED_OPEN_SOURCE': 'Hosted Open Source', - 'PROPRIETARY': 'Proprietary', + CLOUD_AWS: 'Cloud - AWS', + CLOUD_GCP: 'Cloud - Google', + CLOUD_AZURE: 'Cloud - Azure', + CLOUD_DATA_WAREHOUSES: 'Cloud Data Warehouses', + APACHE_PROJECTS: 'Apache Projects', + TRADITIONAL_RDBMS: 'Traditional RDBMS', + ANALYTICAL_DATABASES: 'Analytical Databases', + SEARCH_NOSQL: 'Search & NoSQL', + QUERY_ENGINES: 'Query Engines', + TIME_SERIES: 'Time Series Databases', + OTHER: 'Other Databases', + OPEN_SOURCE: 'Open Source', + HOSTED_OPEN_SOURCE: 'Hosted Open Source', + PROPRIETARY: 'Proprietary', }; // Category colors for visual distinction @@ -98,7 +108,7 @@ const CATEGORY_COLORS: Record = { // Licensing categories 'Open Source': 'geekblue', 'Hosted Open Source': 'cyan', - 'Proprietary': 'default', + Proprietary: 'default', }; // Convert category constant to display name @@ -110,7 +120,7 @@ function getCategoryDisplayName(cat: string): string { // Falls back to name-based inference for compatible databases without categories function getCategories( name: string, - documentationCategories?: string[] + documentationCategories?: string[], ): string[] { // Prefer categories from documentation metadata (computed by Python) if (documentationCategories && documentationCategories.length > 0) { @@ -221,10 +231,11 @@ const DatabaseIndex: React.FC = ({ data }) => { categories: getCategories(name, db.documentation?.categories), timeGrainCount: countTimeGrains(db), hasDrivers: (db.documentation?.drivers?.length ?? 0) > 0, - hasAuthMethods: (db.documentation?.authentication_methods?.length ?? 0) > 0, + hasAuthMethods: + (db.documentation?.authentication_methods?.length ?? 0) > 0, hasConnectionString: Boolean( db.documentation?.connection_string || - (db.documentation?.drivers?.length ?? 0) > 0 + (db.documentation?.drivers?.length ?? 0) > 0, ), hasCustomErrors: (db.documentation?.custom_errors?.length ?? 0) > 0, customErrorCount: db.documentation?.custom_errors?.length ?? 0, @@ -233,10 +244,10 @@ const DatabaseIndex: React.FC = ({ data }) => { // Add compatible databases from this database's documentation const compatibleDbs = db.documentation?.compatible_databases ?? []; - compatibleDbs.forEach((compat) => { + compatibleDbs.forEach(compat => { // Check if this compatible DB already exists as a main entry const existsAsMain = Object.keys(databases).some( - (dbName) => dbName.toLowerCase() === compat.name.toLowerCase() + dbName => dbName.toLowerCase() === compat.name.toLowerCase(), ); if (!existsAsMain) { @@ -277,14 +288,15 @@ const DatabaseIndex: React.FC = ({ data }) => { // Filter and sort databases const filteredDatabases = useMemo(() => { return databaseList - .filter((db) => { + .filter(db => { const matchesSearch = !searchText || db.name.toLowerCase().includes(searchText.toLowerCase()) || db.documentation?.description ?.toLowerCase() .includes(searchText.toLowerCase()); - const matchesCategory = !categoryFilter || db.categories.includes(categoryFilter); + const matchesCategory = + !categoryFilter || db.categories.includes(categoryFilter); return matchesSearch && matchesCategory; }) .sort((a, b) => b.score - a.score); @@ -293,9 +305,9 @@ const DatabaseIndex: React.FC = ({ data }) => { // Get unique categories and counts for filter const { categories, categoryCounts } = useMemo(() => { const counts: Record = {}; - databaseList.forEach((db) => { + databaseList.forEach(db => { // Count each category the database belongs to - db.categories.forEach((cat) => { + db.categories.forEach(cat => { counts[cat] = (counts[cat] || 0) + 1; }); }); @@ -314,12 +326,17 @@ const DatabaseIndex: React.FC = ({ data }) => { sorter: (a: TableEntry, b: TableEntry) => a.name.localeCompare(b.name), render: (name: string, record: TableEntry) => { // Convert name to URL slug - const toSlug = (n: string) => n.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, ''); + const toSlug = (n: string) => + n + .toLowerCase() + .replace(/[^a-z0-9]+/g, '-') + .replace(/^-|-$/g, ''); // Link to parent for compatible DBs, otherwise to own page - const linkTarget = record.isCompatible && record.compatibleWith - ? `/docs/databases/supported/${toSlug(record.compatibleWith)}` - : `/docs/databases/supported/${toSlug(name)}`; + const linkTarget = + record.isCompatible && record.compatibleWith + ? `/docs/databases/supported/${toSlug(record.compatibleWith)}` + : `/docs/databases/supported/${toSlug(name)}`; return (
    @@ -337,7 +354,9 @@ const DatabaseIndex: React.FC = ({ data }) => { )}
    {record.documentation?.description?.slice(0, 80)} - {(record.documentation?.description?.length ?? 0) > 80 ? '...' : ''} + {(record.documentation?.description?.length ?? 0) > 80 + ? '...' + : ''}
    ); @@ -348,13 +367,15 @@ const DatabaseIndex: React.FC = ({ data }) => { dataIndex: 'categories', key: 'categories', width: 220, - filters: categories.map((cat) => ({ text: cat, value: cat })), + filters: categories.map(cat => ({ text: cat, value: cat })), onFilter: (value: React.Key | boolean, record: TableEntry) => record.categories.includes(value as string), render: (cats: string[]) => (
    - {cats.map((cat) => ( - {cat} + {cats.map(cat => ( + + {cat} + ))}
    ), @@ -382,16 +403,26 @@ const DatabaseIndex: React.FC = ({ data }) => { dataIndex: 'timeGrainCount', key: 'timeGrainCount', width: 100, - sorter: (a: TableEntry, b: TableEntry) => a.timeGrainCount - b.timeGrainCount, + sorter: (a: TableEntry, b: TableEntry) => + a.timeGrainCount - b.timeGrainCount, render: (count: number, record: TableEntry) => { if (count === 0) return -; const grains = getSupportedTimeGrains(record.time_grains); return ( - {grains.map((grain) => ( - {grain} +
    + {grains.map(grain => ( + + {grain} + ))}
    } @@ -450,13 +481,17 @@ const DatabaseIndex: React.FC = ({ data }) => {
    {record.joins && JOINs} {record.subqueries && Subqueries} - {record.supports_dynamic_schema && Dynamic Schema} + {record.supports_dynamic_schema && ( + Dynamic Schema + )} {record.supports_catalog && Catalog} {record.ssh_tunneling && SSH} {record.supports_file_upload && File Upload} {record.query_cancelation && Query Cancel} {record.query_cost_estimation && Cost Est.} - {record.user_impersonation && Impersonation} + {record.user_impersonation && ( + Impersonation + )} {record.sql_validation && SQL Validation}
    ), @@ -545,7 +580,7 @@ const DatabaseIndex: React.FC = ({ data }) => { placeholder="Search databases..." prefix={} value={searchText} - onChange={(e) => setSearchText(e.target.value)} + onChange={e => setSearchText(e.target.value)} allowClear /> @@ -556,7 +591,7 @@ const DatabaseIndex: React.FC = ({ data }) => { value={categoryFilter} onChange={setCategoryFilter} allowClear - options={categories.map((cat) => ({ + options={categories.map(cat => ({ label: ( = ({ data }) => { record.isCompatible ? `${record.compatibleWith}-${record.name}` : record.name} + rowKey={record => + record.isCompatible + ? `${record.compatibleWith}-${record.name}` + : record.name + } pagination={{ defaultPageSize: 20, showSizeChanger: true, - showTotal: (total) => `${total} databases`, + showTotal: total => `${total} databases`, }} size="middle" /> diff --git a/docs/src/components/databases/DatabaseLogoWall.tsx b/docs/src/components/databases/DatabaseLogoWall.tsx index a9b5b7be98b..26eb7e5b819 100644 --- a/docs/src/components/databases/DatabaseLogoWall.tsx +++ b/docs/src/components/databases/DatabaseLogoWall.tsx @@ -35,7 +35,10 @@ const databases = Object.entries(typedData.databases) .map(([name, db]) => ({ name, logo: db.documentation.logo!, - docPath: `/user-docs/databases/supported/${name.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '')}`, + docPath: `/user-docs/databases/supported/${name + .toLowerCase() + .replace(/[^a-z0-9]+/g, '-') + .replace(/^-|-$/g, '')}`, })); export default function DatabaseLogoWall(): React.JSX.Element { diff --git a/docs/src/components/databases/types.ts b/docs/src/components/databases/types.ts index 4a0aa26d310..7b3f61a57c5 100644 --- a/docs/src/components/databases/types.ts +++ b/docs/src/components/databases/types.ts @@ -77,7 +77,7 @@ export interface CompatibleDatabase { description?: string; logo?: string; homepage_url?: string; - categories?: string[]; // Category classifications (e.g., ["TRADITIONAL_RDBMS", "OPEN_SOURCE"]) + categories?: string[]; // Category classifications (e.g., ["TRADITIONAL_RDBMS", "OPEN_SOURCE"]) pypi_packages?: string[]; connection_string?: string; parameters?: Record; @@ -87,27 +87,27 @@ export interface CompatibleDatabase { } export interface CustomError { - error_type: string; // e.g., "CONNECTION_INVALID_USERNAME_ERROR" - message_template: string; // e.g., 'The username "%(username)s" does not exist.' - regex_pattern?: string; // The regex pattern that matches this error (optional, for reference) - regex_name?: string; // The name of the regex constant (e.g., "CONNECTION_INVALID_USERNAME_REGEX") - invalid_fields?: string[]; // Fields that are invalid, e.g., ["username", "password"] - issue_codes?: number[]; // Related issue codes from ISSUE_CODES mapping - category?: string; // Error category: "Authentication", "Connection", "Query", etc. - description?: string; // Human-readable short description of the error type + error_type: string; // e.g., "CONNECTION_INVALID_USERNAME_ERROR" + message_template: string; // e.g., 'The username "%(username)s" does not exist.' + regex_pattern?: string; // The regex pattern that matches this error (optional, for reference) + regex_name?: string; // The name of the regex constant (e.g., "CONNECTION_INVALID_USERNAME_REGEX") + invalid_fields?: string[]; // Fields that are invalid, e.g., ["username", "password"] + issue_codes?: number[]; // Related issue codes from ISSUE_CODES mapping + category?: string; // Error category: "Authentication", "Connection", "Query", etc. + description?: string; // Human-readable short description of the error type } export interface DatabaseDocumentation { description?: string; logo?: string; homepage_url?: string; - categories?: string[]; // Category classifications (e.g., ["TRADITIONAL_RDBMS", "OPEN_SOURCE"]) + categories?: string[]; // Category classifications (e.g., ["TRADITIONAL_RDBMS", "OPEN_SOURCE"]) pypi_packages?: string[]; connection_string?: string; default_port?: number; parameters?: Record; notes?: string; - limitations?: string[]; // Known limitations or caveats + limitations?: string[]; // Known limitations or caveats connection_examples?: ConnectionExample[]; host_examples?: HostExample[]; drivers?: Driver[]; @@ -122,7 +122,7 @@ export interface DatabaseDocumentation { sqlalchemy_docs_url?: string; advanced_features?: Record; compatible_databases?: CompatibleDatabase[]; - custom_errors?: CustomError[]; // Database-specific error messages and troubleshooting info + custom_errors?: CustomError[]; // Database-specific error messages and troubleshooting info } export interface TimeGrains { diff --git a/docs/src/components/ui-components/ComponentIndex.tsx b/docs/src/components/ui-components/ComponentIndex.tsx index 180a67ea2db..c0c20434d50 100644 --- a/docs/src/components/ui-components/ComponentIndex.tsx +++ b/docs/src/components/ui-components/ComponentIndex.tsx @@ -52,7 +52,7 @@ const ComponentIndex: React.FC = ({ data }) => { const filteredComponents = useMemo(() => { return components - .filter((comp) => { + .filter(comp => { const matchesSearch = !searchText || comp.name.toLowerCase().includes(searchText.toLowerCase()) || @@ -67,7 +67,7 @@ const ComponentIndex: React.FC = ({ data }) => { const { categories, categoryCounts } = useMemo(() => { const counts: Record = {}; - components.forEach((comp) => { + components.forEach(comp => { counts[comp.category] = (counts[comp.category] || 0) + 1; }); return { @@ -103,7 +103,7 @@ const ComponentIndex: React.FC = ({ data }) => { dataIndex: 'category', key: 'category', width: 120, - filters: categories.map((cat) => ({ + filters: categories.map(cat => ({ text: CATEGORY_LABELS[cat] || cat, value: cat, })), @@ -120,9 +120,7 @@ const ComponentIndex: React.FC = ({ data }) => { dataIndex: 'package', key: 'package', width: 220, - render: (pkg: string) => ( - {pkg} - ), + render: (pkg: string) => {pkg}, }, { title: 'Tags', @@ -215,7 +213,7 @@ const ComponentIndex: React.FC = ({ data }) => { placeholder="Search components..." prefix={} value={searchText} - onChange={(e) => setSearchText(e.target.value)} + onChange={e => setSearchText(e.target.value)} allowClear /> @@ -226,7 +224,7 @@ const ComponentIndex: React.FC = ({ data }) => { value={categoryFilter} onChange={setCategoryFilter} allowClear - options={categories.map((cat) => ({ + options={categories.map(cat => ({ label: ( = ({ data }) => { pagination={{ defaultPageSize: 20, showSizeChanger: true, - showTotal: (total) => `${total} components`, + showTotal: total => `${total} components`, }} size="middle" /> diff --git a/docs/src/data/databases.json b/docs/src/data/databases.json index 33662b38ea1..229758e4703 100644 --- a/docs/src/data/databases.json +++ b/docs/src/data/databases.json @@ -13,11 +13,7 @@ "averageScore": 53, "maxScore": 201, "byCategory": { - "Cloud - AWS": [ - "Amazon Athena", - "Amazon DynamoDB", - "Amazon Redshift" - ], + "Cloud - AWS": ["Amazon Athena", "Amazon DynamoDB", "Amazon Redshift"], "Query Engines": [ "Amazon Athena", "Apache DataFusion", @@ -216,14 +212,8 @@ "YDB", "YugabyteDB" ], - "Cloud - Azure": [ - "Azure Data Explorer" - ], - "Cloud - Google": [ - "Google BigQuery", - "Google Datastore", - "Google Sheets" - ] + "Cloud - Azure": ["Azure Data Explorer"], + "Cloud - Google": ["Google BigQuery", "Google Datastore", "Google Sheets"] } }, "databases": { @@ -290,14 +280,8 @@ "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]" - ], + "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": [ { @@ -335,9 +319,7 @@ "error_type": "SYNTAX_ERROR", "category": "Query", "description": "SQL syntax error", - "issue_codes": [ - 1030 - ] + "issue_codes": [1030] } ] }, @@ -413,14 +395,8 @@ "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" - ], + "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", @@ -503,14 +479,8 @@ "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" - ], + "categories": ["Cloud - AWS", "Analytical Databases", "Proprietary"], + "pypi_packages": ["sqlalchemy-redshift"], "connection_string": "redshift+psycopg2://{username}:{password}@{host}:5439/{database}", "default_port": 5439, "parameters": { @@ -595,14 +565,8 @@ "error_type": "CONNECTION_ACCESS_DENIED_ERROR", "category": "Authentication", "description": "Access denied", - "issue_codes": [ - 1014, - 1015 - ], - "invalid_fields": [ - "username", - "password" - ] + "issue_codes": [1014, 1015], + "invalid_fields": ["username", "password"] }, { "regex_name": "CONNECTION_INVALID_HOSTNAME_REGEX", @@ -610,12 +574,8 @@ "error_type": "CONNECTION_INVALID_HOSTNAME_ERROR", "category": "Connection", "description": "Invalid hostname", - "issue_codes": [ - 1007 - ], - "invalid_fields": [ - "host" - ] + "issue_codes": [1007], + "invalid_fields": ["host"] }, { "regex_name": "CONNECTION_PORT_CLOSED_REGEX", @@ -623,13 +583,8 @@ "error_type": "CONNECTION_PORT_CLOSED_ERROR", "category": "Connection", "description": "Port closed or refused", - "issue_codes": [ - 1008 - ], - "invalid_fields": [ - "host", - "port" - ] + "issue_codes": [1008], + "invalid_fields": ["host", "port"] }, { "regex_name": "CONNECTION_HOST_DOWN_REGEX", @@ -637,13 +592,8 @@ "error_type": "CONNECTION_HOST_DOWN_ERROR", "category": "Connection", "description": "Host unreachable", - "issue_codes": [ - 1009 - ], - "invalid_fields": [ - "host", - "port" - ] + "issue_codes": [1009], + "invalid_fields": ["host", "port"] }, { "regex_name": "CONNECTION_UNKNOWN_DATABASE_REGEX", @@ -651,12 +601,8 @@ "error_type": "CONNECTION_UNKNOWN_DATABASE_ERROR", "category": "Connection", "description": "Unknown database", - "issue_codes": [ - 1015 - ], - "invalid_fields": [ - "database" - ] + "issue_codes": [1015], + "invalid_fields": ["database"] } ] }, @@ -737,9 +683,7 @@ "Analytical Databases", "Open Source" ], - "pypi_packages": [ - "pydoris" - ], + "pypi_packages": ["pydoris"], "connection_string": "doris://{username}:{password}@{host}:{port}/{catalog}.{database}", "default_port": 9030, "parameters": { @@ -758,14 +702,8 @@ "error_type": "CONNECTION_ACCESS_DENIED_ERROR", "category": "Authentication", "description": "Access denied", - "issue_codes": [ - 1014, - 1015 - ], - "invalid_fields": [ - "username", - "password" - ] + "issue_codes": [1014, 1015], + "invalid_fields": ["username", "password"] }, { "regex_name": "CONNECTION_INVALID_HOSTNAME_REGEX", @@ -773,12 +711,8 @@ "error_type": "CONNECTION_INVALID_HOSTNAME_ERROR", "category": "Connection", "description": "Invalid hostname", - "issue_codes": [ - 1007 - ], - "invalid_fields": [ - "host" - ] + "issue_codes": [1007], + "invalid_fields": ["host"] }, { "regex_name": "CONNECTION_HOST_DOWN_REGEX", @@ -786,13 +720,8 @@ "error_type": "CONNECTION_HOST_DOWN_ERROR", "category": "Connection", "description": "Host unreachable", - "issue_codes": [ - 1009 - ], - "invalid_fields": [ - "host", - "port" - ] + "issue_codes": [1009], + "invalid_fields": ["host", "port"] }, { "regex_name": "CONNECTION_UNKNOWN_DATABASE_REGEX", @@ -800,12 +729,8 @@ "error_type": "CONNECTION_UNKNOWN_DATABASE_ERROR", "category": "Connection", "description": "Unknown database", - "issue_codes": [ - 1015 - ], - "invalid_fields": [ - "database" - ] + "issue_codes": [1015], + "invalid_fields": ["database"] }, { "regex_name": "SYNTAX_ERROR_REGEX", @@ -813,17 +738,13 @@ "error_type": "SYNTAX_ERROR", "category": "Query", "description": "SQL syntax error", - "issue_codes": [ - 1030 - ] + "issue_codes": [1030] } ] }, "engine": "pydoris", "engine_name": "Apache Doris", - "engine_aliases": [ - "doris" - ], + "engine_aliases": ["doris"], "default_driver": "pydoris", "supports_file_upload": true, "supports_dynamic_schema": true, @@ -893,14 +814,8 @@ "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" - ], + "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": [ @@ -1011,9 +926,7 @@ "Time Series Databases", "Open Source" ], - "pypi_packages": [ - "pydruid" - ], + "pypi_packages": ["pydruid"], "connection_string": "druid://{username}:{password}@{host}:{port}/druid/v2/sql", "default_port": 9088, "parameters": { @@ -1049,9 +962,7 @@ "Cloud Data Warehouses", "Hosted Open Source" ], - "pypi_packages": [ - "pydruid" - ], + "pypi_packages": ["pydruid"], "connection_string": "druid://{username}:{password}@{host}/druid/v2/sql", "docs_url": "https://docs.imply.io/" } @@ -1130,14 +1041,8 @@ "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" - ], + "categories": ["Apache Projects", "Query Engines", "Open Source"], + "pypi_packages": ["pyhive"], "connection_string": "hive://hive@{hostname}:{port}/{database}", "default_port": 10000, "category": "Apache Projects" @@ -1214,14 +1119,8 @@ "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" - ], + "categories": ["Apache Projects", "Query Engines", "Open Source"], + "pypi_packages": ["impyla"], "connection_string": "impala://{hostname}:{port}/{database}", "default_port": 21050, "category": "Apache Projects" @@ -1303,9 +1202,7 @@ "Time Series Databases", "Open Source" ], - "pypi_packages": [ - "apache-iotdb" - ], + "pypi_packages": ["apache-iotdb"], "connection_string": "iotdb://{username}:{password}@{hostname}:{port}", "default_port": 6667, "parameters": { @@ -1394,9 +1291,7 @@ "Analytical Databases", "Open Source" ], - "pypi_packages": [ - "kylinpy" - ], + "pypi_packages": ["kylinpy"], "connection_string": "kylin://{username}:{password}@{hostname}:{port}/{project}?{param1}={value1}&{param2}={value2}", "default_port": 7070, "category": "Apache Projects" @@ -1478,9 +1373,7 @@ "Analytical Databases", "Open Source" ], - "pypi_packages": [ - "phoenixdb" - ], + "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.", @@ -1563,9 +1456,7 @@ "Time Series Databases", "Open Source" ], - "pypi_packages": [ - "pinotdb" - ], + "pypi_packages": ["pinotdb"], "connection_string": "pinot+http://{broker_host}:{broker_port}/query?controller=http://{controller_host}:{controller_port}/", "default_port": 8099, "connection_examples": [ @@ -1660,14 +1551,8 @@ "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" - ], + "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" @@ -1744,14 +1629,8 @@ "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" - ], + "categories": ["Apache Projects", "Query Engines", "Open Source"], + "pypi_packages": ["pyhive"], "connection_string": "hive://hive@{hostname}:{port}/{database}", "default_port": 10000, "category": "Apache Projects" @@ -1826,13 +1705,8 @@ "max_score": 201, "documentation": { "description": "Arc is a data platform with multiple connection options.", - "categories": [ - "Other Databases", - "Proprietary" - ], - "pypi_packages": [ - "arc-superset-arrow" - ], + "categories": ["Other Databases", "Proprietary"], + "pypi_packages": ["arc-superset-arrow"], "connection_string": "arc+arrow://{api_key}@{hostname}:{port}/{database}", "parameters": { "api_key": "Arc API key", @@ -1935,9 +1809,7 @@ "Analytical Databases", "Hosted Open Source" ], - "pypi_packages": [ - "impyla" - ], + "pypi_packages": ["impyla"], "connection_string": "ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true", "category": "Other Databases" }, @@ -2013,13 +1885,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Open Source"], + "pypi_packages": ["mysqlclient"], "connection_string": "mysql://{username}:{password}@{host}/{database}", "default_port": 3306, "parameters": { @@ -2068,22 +1935,16 @@ "description": "MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.", "logo": "mariadb.png", "homepage_url": "https://mariadb.org/", - "pypi_packages": [ - "mysqlclient" - ], + "pypi_packages": ["mysqlclient"], "connection_string": "mysql://{username}:{password}@{host}:{port}/{database}", - "categories": [ - "Open Source" - ] + "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" - ], + "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", @@ -2094,10 +1955,7 @@ "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" - ] + "categories": ["Cloud - AWS", "Hosted Open Source"] } ], "category": "Traditional RDBMS" @@ -2174,13 +2032,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Open Source"], + "pypi_packages": ["mysqlclient"], "connection_string": "mysql://{username}:{password}@{host}/{database}", "default_port": 3306, "parameters": { @@ -2229,22 +2082,16 @@ "description": "MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.", "logo": "mariadb.png", "homepage_url": "https://mariadb.org/", - "pypi_packages": [ - "mysqlclient" - ], + "pypi_packages": ["mysqlclient"], "connection_string": "mysql://{username}:{password}@{host}:{port}/{database}", - "categories": [ - "Open Source" - ] + "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" - ], + "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", @@ -2255,10 +2102,7 @@ "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" - ] + "categories": ["Cloud - AWS", "Hosted Open Source"] } ], "category": "Traditional RDBMS" @@ -2335,13 +2179,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Open Source"], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "default_port": 5432, "parameters": { @@ -2370,9 +2209,7 @@ "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}", "parameters": { "username": "AccessKey ID of your Alibaba Cloud account", @@ -2381,18 +2218,14 @@ "port": "Port number of the Hologres instance", "database": "Name of the Hologres database" }, - "categories": [ - "Proprietary" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "connection_examples": [ { @@ -2402,33 +2235,25 @@ ], "notes": "psycopg2 comes bundled with Superset Docker images.", "docs_url": "https://docs.timescale.com/", - "categories": [ - "Open Source" - ] + "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" - ], + "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" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "connection_examples": [ { @@ -2447,18 +2272,14 @@ }, "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" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "parameters": { "username": "Database user (default: postgres)", @@ -2469,19 +2290,14 @@ }, "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" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}/{database}?sslmode=require", "parameters": { "username": "Neon role name", @@ -2491,18 +2307,14 @@ }, "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" - ] + "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" - ], + "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", @@ -2513,19 +2325,14 @@ "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" - ] + "categories": ["Cloud - AWS", "Hosted Open Source"] } ], "category": "Traditional RDBMS" }, "engine": "postgresql", "engine_name": "Aurora PostgreSQL", - "engine_aliases": [ - "postgres" - ], + "engine_aliases": ["postgres"], "default_driver": "psycopg2", "supports_file_upload": true, "supports_dynamic_schema": true, @@ -2595,13 +2402,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Open Source"], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "default_port": 5432, "parameters": { @@ -2630,9 +2432,7 @@ "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}", "parameters": { "username": "AccessKey ID of your Alibaba Cloud account", @@ -2641,18 +2441,14 @@ "port": "Port number of the Hologres instance", "database": "Name of the Hologres database" }, - "categories": [ - "Proprietary" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "connection_examples": [ { @@ -2662,33 +2458,25 @@ ], "notes": "psycopg2 comes bundled with Superset Docker images.", "docs_url": "https://docs.timescale.com/", - "categories": [ - "Open Source" - ] + "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" - ], + "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" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "connection_examples": [ { @@ -2707,18 +2495,14 @@ }, "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" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "parameters": { "username": "Database user (default: postgres)", @@ -2729,19 +2513,14 @@ }, "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" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}/{database}?sslmode=require", "parameters": { "username": "Neon role name", @@ -2751,18 +2530,14 @@ }, "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" - ] + "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" - ], + "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", @@ -2773,19 +2548,14 @@ "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" - ] + "categories": ["Cloud - AWS", "Hosted Open Source"] } ], "category": "Traditional RDBMS" }, "engine": "postgresql", "engine_name": "Aurora PostgreSQL (Data API)", - "engine_aliases": [ - "postgres" - ], + "engine_aliases": ["postgres"], "default_driver": "auroradataapi", "supports_file_upload": true, "supports_dynamic_schema": true, @@ -2855,14 +2625,8 @@ "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" - ], + "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", @@ -3039,9 +2803,7 @@ "Analytical Databases", "Proprietary" ], - "pypi_packages": [ - "pymssql" - ], + "pypi_packages": ["pymssql"], "connection_string": "mssql+pymssql://{username}@{server}:{password}@{server}.database.windows.net:1433/{database}", "category": "Cloud - Azure", "custom_errors": [ @@ -3051,10 +2813,7 @@ "error_type": "CONNECTION_ACCESS_DENIED_ERROR", "category": "Authentication", "description": "Access denied", - "issue_codes": [ - 1014, - 1015 - ] + "issue_codes": [1014, 1015] }, { "regex_name": "CONNECTION_INVALID_HOSTNAME_REGEX", @@ -3062,9 +2821,7 @@ "error_type": "CONNECTION_INVALID_HOSTNAME_ERROR", "category": "Connection", "description": "Invalid hostname", - "issue_codes": [ - 1007 - ] + "issue_codes": [1007] }, { "regex_name": "CONNECTION_PORT_CLOSED_REGEX", @@ -3072,9 +2829,7 @@ "error_type": "CONNECTION_PORT_CLOSED_ERROR", "category": "Connection", "description": "Port closed or refused", - "issue_codes": [ - 1008 - ] + "issue_codes": [1008] }, { "regex_name": "CONNECTION_HOST_DOWN_REGEX", @@ -3082,9 +2837,7 @@ "error_type": "CONNECTION_HOST_DOWN_ERROR", "category": "Connection", "description": "Host unreachable", - "issue_codes": [ - 1009 - ] + "issue_codes": [1009] } ] }, @@ -3160,13 +2913,8 @@ "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" - ], + "categories": ["Analytical Databases", "Open Source"], + "pypi_packages": ["clickhouse-connect>=0.13.0"], "connection_string": "clickhousedb://{username}:{password}@{host}:{port}/{database}", "default_port": 8123, "drivers": [ @@ -3207,9 +2955,7 @@ "Cloud Data Warehouses", "Hosted Open Source" ], - "pypi_packages": [ - "clickhouse-connect>=0.13.0" - ], + "pypi_packages": ["clickhouse-connect>=0.13.0"], "connection_string": "clickhousedb://{username}:{password}@{host}:8443/{database}?secure=true", "parameters": { "username": "ClickHouse Cloud username", @@ -3229,9 +2975,7 @@ "Cloud Data Warehouses", "Hosted Open Source" ], - "pypi_packages": [ - "clickhouse-connect>=0.13.0" - ], + "pypi_packages": ["clickhouse-connect>=0.13.0"], "connection_string": "clickhousedb://{username}:{password}@{host}/{database}?secure=true", "docs_url": "https://docs.altinity.com/" } @@ -3388,9 +3132,7 @@ "Traditional RDBMS", "Hosted Open Source" ], - "pypi_packages": [ - "superset-engine-d1" - ], + "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", @@ -3472,13 +3214,8 @@ "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" - ], + "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", @@ -3486,9 +3223,7 @@ }, "engine": "cockroachdb", "engine_name": "CockroachDB", - "engine_aliases": [ - "postgres" - ], + "engine_aliases": ["postgres"], "default_driver": "psycopg2", "supports_file_upload": true, "supports_dynamic_schema": true, @@ -3558,13 +3293,8 @@ "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" - ], + "categories": ["Search & NoSQL", "Open Source"], + "pypi_packages": ["couchbase-sqlalchemy"], "connection_string": "couchbase://{username}:{password}@{host}:{port}?ssl=true", "default_port": 8091, "parameters": { @@ -3586,9 +3316,7 @@ }, "engine": "couchbase", "engine_name": "Couchbase", - "engine_aliases": [ - "couchbasedb" - ], + "engine_aliases": ["couchbasedb"], "default_driver": "couchbase", "supports_file_upload": true, "supports_dynamic_schema": false, @@ -3658,14 +3386,8 @@ "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" - ], + "categories": ["Time Series Databases", "Open Source"], + "pypi_packages": ["crate", "sqlalchemy-cratedb"], "connection_string": "crate://{host}:{port}", "default_port": 4200, "parameters": { @@ -3759,9 +3481,7 @@ "Analytical Databases", "Proprietary" ], - "pypi_packages": [ - "databend-sqlalchemy" - ], + "pypi_packages": ["databend-sqlalchemy"], "connection_string": "databend://{username}:{password}@{host}:{port}/{database}?secure=true", "default_port": 443, "parameters": { @@ -3923,9 +3643,7 @@ "Analytical Databases", "Hosted Open Source" ], - "pypi_packages": [ - "apache-superset[databricks]" - ], + "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": { @@ -4111,14 +3829,8 @@ "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" - ], + "categories": ["Apache Projects", "Query Engines", "Open Source"], + "pypi_packages": ["pyhive"], "connection_string": "hive://hive@{hostname}:{port}/{database}", "default_port": 10000, "category": "Cloud Data Warehouses" @@ -4268,13 +3980,8 @@ "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" - ], + "categories": ["Query Engines", "Proprietary"], + "pypi_packages": ["psycopg2"], "connection_string": "denodo://{username}:{password}@{host}:{port}/{database}", "default_port": 9996, "parameters": { @@ -4300,112 +4007,76 @@ "error_type": "CONNECTION_INVALID_USERNAME_ERROR", "category": "Authentication", "description": "Invalid username", - "issue_codes": [ - 1012 - ], - "invalid_fields": [ - "username", - "password" - ] + "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" - ] + "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" - ] + "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" - ] + "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" - ] + "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" - ] + "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 - ] + "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 - ] + "issue_codes": [1003, 1004] }, { "message_template": "Invalid aggregation expression.", "error_type": "SYNTAX_ERROR", "category": "Query", "description": "SQL syntax error", - "issue_codes": [ - 1030 - ] + "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 - ] + "issue_codes": [1030] } ] }, @@ -4481,13 +4152,8 @@ "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" - ], + "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" @@ -4511,9 +4177,7 @@ }, "engine": "dremio", "engine_name": "Dremio", - "engine_aliases": [ - "dremio+flight" - ], + "engine_aliases": ["dremio+flight"], "default_driver": "flight", "supports_file_upload": true, "supports_dynamic_schema": false, @@ -4583,13 +4247,8 @@ "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" - ], + "categories": ["Analytical Databases", "Open Source"], + "pypi_packages": ["duckdb-engine"], "connection_string": "duckdb:////path/to/duck.db", "drivers": [ { @@ -4606,19 +4265,14 @@ "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" - ], + "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" - ] + "categories": ["Hosted Open Source"] } ], "category": "Other Databases", @@ -4629,10 +4283,7 @@ "error_type": "COLUMN_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Column not found", - "issue_codes": [ - 1003, - 1004 - ] + "issue_codes": [1003, 1004] } ] }, @@ -4708,13 +4359,8 @@ "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" - ], + "categories": ["Search & NoSQL", "Open Source"], + "pypi_packages": ["elasticsearch-dbapi"], "connection_string": "elasticsearch+https://{user}:{password}@{host}:9243/", "default_port": 9243, "parameters": { @@ -4744,13 +4390,8 @@ "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" - ], + "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/" }, @@ -4764,9 +4405,7 @@ "Cloud - AWS", "Hosted Open Source" ], - "pypi_packages": [ - "elasticsearch-dbapi" - ], + "pypi_packages": ["elasticsearch-dbapi"], "connection_string": "odelasticsearch+https://{user}:{password}@{host}:443/", "docs_url": "https://docs.aws.amazon.com/opensearch-service/latest/developerguide/" } @@ -4845,13 +4484,8 @@ "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" - ], + "categories": ["Analytical Databases", "Proprietary"], + "pypi_packages": ["sqlalchemy-exasol"], "connection_string": "exa+pyodbc://{username}:{password}@{dsn}", "default_port": 8563, "parameters": { @@ -4956,13 +4590,8 @@ "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" - ], + "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, @@ -5051,9 +4680,7 @@ "Analytical Databases", "Proprietary" ], - "pypi_packages": [ - "firebolt-sqlalchemy" - ], + "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", @@ -5144,14 +4771,8 @@ "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" - ], + "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": [ @@ -5185,9 +4806,7 @@ "error_type": "CONNECTION_DATABASE_PERMISSIONS_ERROR", "category": "Permissions", "description": "Insufficient permissions", - "issue_codes": [ - 1017 - ] + "issue_codes": [1017] }, { "regex_name": "TABLE_DOES_NOT_EXIST_REGEX", @@ -5195,10 +4814,7 @@ "error_type": "TABLE_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Table not found", - "issue_codes": [ - 1003, - 1005 - ] + "issue_codes": [1003, 1005] }, { "regex_name": "COLUMN_DOES_NOT_EXIST_REGEX", @@ -5206,10 +4822,7 @@ "error_type": "COLUMN_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Column not found", - "issue_codes": [ - 1003, - 1004 - ] + "issue_codes": [1003, 1004] }, { "regex_name": "SCHEMA_DOES_NOT_EXIST_REGEX", @@ -5217,10 +4830,7 @@ "error_type": "SCHEMA_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Schema not found", - "issue_codes": [ - 1003, - 1016 - ] + "issue_codes": [1003, 1016] }, { "regex_name": "SYNTAX_ERROR_REGEX", @@ -5228,9 +4838,7 @@ "error_type": "SYNTAX_ERROR", "category": "Query", "description": "SQL syntax error", - "issue_codes": [ - 1030 - ] + "issue_codes": [1030] } ] }, @@ -5306,14 +4914,8 @@ "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" - ], + "categories": ["Cloud - Google", "Search & NoSQL", "Proprietary"], + "pypi_packages": ["python-datastore-sqlalchemy"], "connection_string": "datastore://{project_id}/?database={database_id}", "authentication_methods": [ { @@ -5343,9 +4945,7 @@ "error_type": "CONNECTION_DATABASE_PERMISSIONS_ERROR", "category": "Permissions", "description": "Insufficient permissions", - "issue_codes": [ - 1017 - ] + "issue_codes": [1017] }, { "regex_name": "TABLE_DOES_NOT_EXIST_REGEX", @@ -5353,10 +4953,7 @@ "error_type": "TABLE_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Table not found", - "issue_codes": [ - 1003, - 1005 - ] + "issue_codes": [1003, 1005] }, { "regex_name": "COLUMN_DOES_NOT_EXIST_REGEX", @@ -5364,10 +4961,7 @@ "error_type": "COLUMN_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Column not found", - "issue_codes": [ - 1003, - 1004 - ] + "issue_codes": [1003, 1004] }, { "regex_name": "SCHEMA_DOES_NOT_EXIST_REGEX", @@ -5375,10 +4969,7 @@ "error_type": "SCHEMA_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Schema not found", - "issue_codes": [ - 1003, - 1016 - ] + "issue_codes": [1003, 1016] }, { "regex_name": "SYNTAX_ERROR_REGEX", @@ -5386,9 +4977,7 @@ "error_type": "SYNTAX_ERROR", "category": "Query", "description": "SQL syntax error", - "issue_codes": [ - 1030 - ] + "issue_codes": [1030] } ] }, @@ -5464,13 +5053,8 @@ "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]" - ], + "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.", @@ -5482,9 +5066,7 @@ "error_type": "SYNTAX_ERROR", "category": "Query", "description": "SQL syntax error", - "issue_codes": [ - 1030 - ] + "issue_codes": [1030] } ] }, @@ -5560,14 +5142,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Open Source"], + "pypi_packages": ["sqlalchemy-greenplum", "psycopg2"], "connection_string": "greenplum://{username}:{password}@{host}:{port}/{database}", "default_port": 5432, "parameters": { @@ -5582,9 +5158,7 @@ }, "engine": "greenplum", "engine_name": "Greenplum", - "engine_aliases": [ - "postgres" - ], + "engine_aliases": ["postgres"], "default_driver": "psycopg2", "supports_file_upload": true, "supports_dynamic_schema": true, @@ -5659,9 +5233,7 @@ "Analytical Databases", "Proprietary" ], - "pypi_packages": [ - "psycopg2" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}", "parameters": { "username": "AccessKey ID of your Alibaba Cloud account", @@ -5746,13 +5318,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Proprietary"], + "pypi_packages": ["ibm_db_sa"], "connection_string": "db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}", "default_port": 50000, "drivers": [ @@ -5774,9 +5341,7 @@ "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" - ], + "pypi_packages": ["sqlalchemy-ibmi"], "connection_string": "ibmi://{username}:{password}@{host}/{database}", "parameters": { "username": "IBM i username", @@ -5785,9 +5350,7 @@ "database": "Library/schema name" }, "docs_url": "https://github.com/IBM/sqlalchemy-ibmi", - "categories": [ - "Proprietary" - ] + "categories": ["Proprietary"] } ], "docs_url": "https://github.com/ibmdb/python-ibmdbsa", @@ -5795,9 +5358,7 @@ }, "engine": "db2", "engine_name": "IBM Db2", - "engine_aliases": [ - "ibm_db_sa" - ], + "engine_aliases": ["ibm_db_sa"], "default_driver": null, "supports_file_upload": true, "supports_dynamic_schema": true, @@ -5867,13 +5428,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Proprietary"], + "pypi_packages": ["ibm_db_sa"], "connection_string": "db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}", "default_port": 50000, "drivers": [ @@ -5895,9 +5451,7 @@ "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" - ], + "pypi_packages": ["sqlalchemy-ibmi"], "connection_string": "ibmi://{username}:{password}@{host}/{database}", "parameters": { "username": "IBM i username", @@ -5906,9 +5460,7 @@ "database": "Library/schema name" }, "docs_url": "https://github.com/IBM/sqlalchemy-ibmi", - "categories": [ - "Proprietary" - ] + "categories": ["Proprietary"] } ], "docs_url": "https://github.com/ibmdb/python-ibmdbsa", @@ -5916,9 +5468,7 @@ }, "engine": "ibmi", "engine_name": "IBM Db2 for i", - "engine_aliases": [ - "ibm_db_sa" - ], + "engine_aliases": ["ibm_db_sa"], "default_driver": null, "supports_file_upload": true, "supports_dynamic_schema": true, @@ -5988,13 +5538,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Proprietary"], + "pypi_packages": ["nzalchemy"], "connection_string": "netezza+nzpy://{username}:{password}@{hostname}:{port}/{database}", "default_port": 5480, "category": "Other Databases" @@ -6071,13 +5616,8 @@ "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" - ], + "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.", @@ -6155,13 +5695,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Proprietary"], + "pypi_packages": ["pymssql"], "connection_string": "mssql+pymssql://{username}:{password}@{host}:{port}/{database}", "default_port": 1433, "drivers": [ @@ -6188,10 +5723,7 @@ "error_type": "CONNECTION_ACCESS_DENIED_ERROR", "category": "Authentication", "description": "Access denied", - "issue_codes": [ - 1014, - 1015 - ] + "issue_codes": [1014, 1015] }, { "regex_name": "CONNECTION_INVALID_HOSTNAME_REGEX", @@ -6199,9 +5731,7 @@ "error_type": "CONNECTION_INVALID_HOSTNAME_ERROR", "category": "Connection", "description": "Invalid hostname", - "issue_codes": [ - 1007 - ] + "issue_codes": [1007] }, { "regex_name": "CONNECTION_PORT_CLOSED_REGEX", @@ -6209,9 +5739,7 @@ "error_type": "CONNECTION_PORT_CLOSED_ERROR", "category": "Connection", "description": "Port closed or refused", - "issue_codes": [ - 1008 - ] + "issue_codes": [1008] }, { "regex_name": "CONNECTION_HOST_DOWN_REGEX", @@ -6219,9 +5747,7 @@ "error_type": "CONNECTION_HOST_DOWN_ERROR", "category": "Connection", "description": "Host unreachable", - "issue_codes": [ - 1009 - ] + "issue_codes": [1009] } ] }, @@ -6297,14 +5823,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Open Source"], + "pypi_packages": ["sqlalchemy-monetdb", "pymonetdb"], "connection_string": "monetdb://{username}:{password}@{host}:{port}/{database}", "default_port": 50000, "parameters": { @@ -6389,13 +5909,8 @@ "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" - ], + "categories": ["Search & NoSQL", "Proprietary"], + "pypi_packages": ["pymongosql"], "connection_string": "mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset", "parameters": { "username": "Username for MongoDB", @@ -6501,10 +6016,7 @@ "Cloud Data Warehouses", "Hosted Open Source" ], - "pypi_packages": [ - "duckdb", - "duckdb-engine" - ], + "pypi_packages": ["duckdb", "duckdb-engine"], "connection_string": "duckdb:///md:{database}?motherduck_token={token}", "parameters": { "database": "MotherDuck database name", @@ -6527,18 +6039,13 @@ "error_type": "COLUMN_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Column not found", - "issue_codes": [ - 1003, - 1004 - ] + "issue_codes": [1003, 1004] } ] }, "engine": "motherduck", "engine_name": "MotherDuck", - "engine_aliases": [ - "duckdb" - ], + "engine_aliases": ["duckdb"], "default_driver": "duckdb_engine", "supports_file_upload": true, "supports_dynamic_schema": false, @@ -6608,13 +6115,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Open Source"], + "pypi_packages": ["mysqlclient"], "connection_string": "mysql://{username}:{password}@{host}/{database}", "default_port": 3306, "parameters": { @@ -6663,22 +6165,16 @@ "description": "MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.", "logo": "mariadb.png", "homepage_url": "https://mariadb.org/", - "pypi_packages": [ - "mysqlclient" - ], + "pypi_packages": ["mysqlclient"], "connection_string": "mysql://{username}:{password}@{host}:{port}/{database}", - "categories": [ - "Open Source" - ] + "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" - ], + "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", @@ -6689,10 +6185,7 @@ "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" - ] + "categories": ["Cloud - AWS", "Hosted Open Source"] } ], "category": "Traditional RDBMS", @@ -6703,14 +6196,8 @@ "error_type": "CONNECTION_ACCESS_DENIED_ERROR", "category": "Authentication", "description": "Access denied", - "issue_codes": [ - 1014, - 1015 - ], - "invalid_fields": [ - "username", - "password" - ] + "issue_codes": [1014, 1015], + "invalid_fields": ["username", "password"] }, { "regex_name": "CONNECTION_INVALID_HOSTNAME_REGEX", @@ -6718,12 +6205,8 @@ "error_type": "CONNECTION_INVALID_HOSTNAME_ERROR", "category": "Connection", "description": "Invalid hostname", - "issue_codes": [ - 1007 - ], - "invalid_fields": [ - "host" - ] + "issue_codes": [1007], + "invalid_fields": ["host"] }, { "regex_name": "CONNECTION_HOST_DOWN_REGEX", @@ -6731,13 +6214,8 @@ "error_type": "CONNECTION_HOST_DOWN_ERROR", "category": "Connection", "description": "Host unreachable", - "issue_codes": [ - 1009 - ], - "invalid_fields": [ - "host", - "port" - ] + "issue_codes": [1009], + "invalid_fields": ["host", "port"] }, { "regex_name": "CONNECTION_UNKNOWN_DATABASE_REGEX", @@ -6745,12 +6223,8 @@ "error_type": "CONNECTION_UNKNOWN_DATABASE_ERROR", "category": "Connection", "description": "Unknown database", - "issue_codes": [ - 1015 - ], - "invalid_fields": [ - "database" - ] + "issue_codes": [1015], + "invalid_fields": ["database"] }, { "regex_name": "SYNTAX_ERROR_REGEX", @@ -6758,9 +6232,7 @@ "error_type": "SYNTAX_ERROR", "category": "Query", "description": "SQL syntax error", - "issue_codes": [ - 1030 - ] + "issue_codes": [1030] } ] }, @@ -6836,13 +6308,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Open Source"], + "pypi_packages": ["oceanbase_py"], "connection_string": "oceanbase://{username}:{password}@{host}:{port}/{database}", "category": "Other Databases", "custom_errors": [ @@ -6852,14 +6319,8 @@ "error_type": "CONNECTION_ACCESS_DENIED_ERROR", "category": "Authentication", "description": "Access denied", - "issue_codes": [ - 1014, - 1015 - ], - "invalid_fields": [ - "username", - "password" - ] + "issue_codes": [1014, 1015], + "invalid_fields": ["username", "password"] }, { "regex_name": "CONNECTION_INVALID_HOSTNAME_REGEX", @@ -6867,12 +6328,8 @@ "error_type": "CONNECTION_INVALID_HOSTNAME_ERROR", "category": "Connection", "description": "Invalid hostname", - "issue_codes": [ - 1007 - ], - "invalid_fields": [ - "host" - ] + "issue_codes": [1007], + "invalid_fields": ["host"] }, { "regex_name": "CONNECTION_HOST_DOWN_REGEX", @@ -6880,13 +6337,8 @@ "error_type": "CONNECTION_HOST_DOWN_ERROR", "category": "Connection", "description": "Host unreachable", - "issue_codes": [ - 1009 - ], - "invalid_fields": [ - "host", - "port" - ] + "issue_codes": [1009], + "invalid_fields": ["host", "port"] }, { "regex_name": "CONNECTION_UNKNOWN_DATABASE_REGEX", @@ -6894,12 +6346,8 @@ "error_type": "CONNECTION_UNKNOWN_DATABASE_ERROR", "category": "Connection", "description": "Unknown database", - "issue_codes": [ - 1015 - ], - "invalid_fields": [ - "database" - ] + "issue_codes": [1015], + "invalid_fields": ["database"] }, { "regex_name": "SYNTAX_ERROR_REGEX", @@ -6907,18 +6355,13 @@ "error_type": "SYNTAX_ERROR", "category": "Query", "description": "SQL syntax error", - "issue_codes": [ - 1030 - ] + "issue_codes": [1030] } ] }, "engine": "oceanbase", "engine_name": "OceanBase", - "engine_aliases": [ - "oceanbase", - "oceanbase_py" - ], + "engine_aliases": ["oceanbase", "oceanbase_py"], "default_driver": "oceanbase", "supports_file_upload": true, "supports_dynamic_schema": true, @@ -6986,13 +6429,8 @@ "max_score": 201, "documentation": { "description": "Ocient is a hyperscale data analytics database.", - "categories": [ - "Analytical Databases", - "Proprietary" - ], - "pypi_packages": [ - "sqlalchemy-ocient" - ], + "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", @@ -7003,9 +6441,7 @@ "error_type": "CONNECTION_INVALID_USERNAME_ERROR", "category": "Authentication", "description": "Invalid username", - "issue_codes": [ - 1012 - ] + "issue_codes": [1012] }, { "regex_name": "CONNECTION_INVALID_PASSWORD_REGEX", @@ -7013,9 +6449,7 @@ "error_type": "CONNECTION_INVALID_PASSWORD_ERROR", "category": "Authentication", "description": "Invalid password", - "issue_codes": [ - 1013 - ] + "issue_codes": [1013] }, { "regex_name": "CONNECTION_UNKNOWN_DATABASE_REGEX", @@ -7023,9 +6457,7 @@ "error_type": "CONNECTION_UNKNOWN_DATABASE_ERROR", "category": "Connection", "description": "Unknown database", - "issue_codes": [ - 1015 - ] + "issue_codes": [1015] }, { "regex_name": "CONNECTION_INVALID_HOSTNAME_REGEX", @@ -7033,9 +6465,7 @@ "error_type": "CONNECTION_INVALID_HOSTNAME_ERROR", "category": "Connection", "description": "Invalid hostname", - "issue_codes": [ - 1007 - ] + "issue_codes": [1007] }, { "regex_name": "CONNECTION_INVALID_PORT_ERROR", @@ -7048,9 +6478,7 @@ "error_type": "GENERIC_DB_ENGINE_ERROR", "category": "General", "description": "Database engine error", - "issue_codes": [ - 1002 - ] + "issue_codes": [1002] }, { "regex_name": "SYNTAX_ERROR_REGEX", @@ -7058,9 +6486,7 @@ "error_type": "SYNTAX_ERROR", "category": "Query", "description": "SQL syntax error", - "issue_codes": [ - 1030 - ] + "issue_codes": [1030] }, { "regex_name": "TABLE_DOES_NOT_EXIST_REGEX", @@ -7068,10 +6494,7 @@ "error_type": "TABLE_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Table not found", - "issue_codes": [ - 1003, - 1005 - ] + "issue_codes": [1003, 1005] }, { "regex_name": "COLUMN_DOES_NOT_EXIST_REGEX", @@ -7079,10 +6502,7 @@ "error_type": "COLUMN_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Column not found", - "issue_codes": [ - 1003, - 1004 - ] + "issue_codes": [1003, 1004] } ] }, @@ -7231,13 +6651,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Proprietary"], + "pypi_packages": ["oracledb"], "connection_string": "oracle+oracledb://{username}:{password}@{hostname}:{port}", "default_port": 1521, "notes": "Previously used cx_Oracle, now uses oracledb.", @@ -7314,13 +6729,8 @@ "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" - ], + "categories": ["Search & NoSQL", "Open Source"], + "pypi_packages": ["sqlalchemy-parseable"], "connection_string": "parseable://{username}:{password}@{hostname}:{port}/{stream_name}", "connection_examples": [ { @@ -7404,13 +6814,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Open Source"], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "default_port": 5432, "parameters": { @@ -7439,9 +6844,7 @@ "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}", "parameters": { "username": "AccessKey ID of your Alibaba Cloud account", @@ -7450,18 +6853,14 @@ "port": "Port number of the Hologres instance", "database": "Name of the Hologres database" }, - "categories": [ - "Proprietary" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "connection_examples": [ { @@ -7471,33 +6870,25 @@ ], "notes": "psycopg2 comes bundled with Superset Docker images.", "docs_url": "https://docs.timescale.com/", - "categories": [ - "Open Source" - ] + "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" - ], + "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" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "connection_examples": [ { @@ -7516,18 +6907,14 @@ }, "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" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "parameters": { "username": "Database user (default: postgres)", @@ -7538,19 +6925,14 @@ }, "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" - ] + "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" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}/{database}?sslmode=require", "parameters": { "username": "Neon role name", @@ -7560,18 +6942,14 @@ }, "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" - ] + "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" - ], + "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", @@ -7582,10 +6960,7 @@ "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" - ] + "categories": ["Cloud - AWS", "Hosted Open Source"] } ], "category": "Traditional RDBMS", @@ -7596,12 +6971,8 @@ "error_type": "CONNECTION_INVALID_USERNAME_ERROR", "category": "Authentication", "description": "Invalid username", - "issue_codes": [ - 1012 - ], - "invalid_fields": [ - "username" - ] + "issue_codes": [1012], + "invalid_fields": ["username"] }, { "regex_name": "CONNECTION_INVALID_PASSWORD_REGEX", @@ -7609,13 +6980,8 @@ "error_type": "CONNECTION_INVALID_PASSWORD_ERROR", "category": "Authentication", "description": "Invalid password", - "issue_codes": [ - 1013 - ], - "invalid_fields": [ - "username", - "password" - ] + "issue_codes": [1013], + "invalid_fields": ["username", "password"] }, { "regex_name": "CONNECTION_INVALID_PASSWORD_NEEDED_REGEX", @@ -7623,13 +6989,8 @@ "error_type": "CONNECTION_ACCESS_DENIED_ERROR", "category": "Authentication", "description": "Access denied", - "issue_codes": [ - 1014, - 1015 - ], - "invalid_fields": [ - "password" - ] + "issue_codes": [1014, 1015], + "invalid_fields": ["password"] }, { "regex_name": "CONNECTION_INVALID_HOSTNAME_REGEX", @@ -7637,12 +6998,8 @@ "error_type": "CONNECTION_INVALID_HOSTNAME_ERROR", "category": "Connection", "description": "Invalid hostname", - "issue_codes": [ - 1007 - ], - "invalid_fields": [ - "host" - ] + "issue_codes": [1007], + "invalid_fields": ["host"] }, { "regex_name": "CONNECTION_PORT_CLOSED_REGEX", @@ -7650,13 +7007,8 @@ "error_type": "CONNECTION_PORT_CLOSED_ERROR", "category": "Connection", "description": "Port closed or refused", - "issue_codes": [ - 1008 - ], - "invalid_fields": [ - "host", - "port" - ] + "issue_codes": [1008], + "invalid_fields": ["host", "port"] }, { "regex_name": "CONNECTION_HOST_DOWN_REGEX", @@ -7664,13 +7016,8 @@ "error_type": "CONNECTION_HOST_DOWN_ERROR", "category": "Connection", "description": "Host unreachable", - "issue_codes": [ - 1009 - ], - "invalid_fields": [ - "host", - "port" - ] + "issue_codes": [1009], + "invalid_fields": ["host", "port"] }, { "regex_name": "CONNECTION_UNKNOWN_DATABASE_REGEX", @@ -7678,12 +7025,8 @@ "error_type": "CONNECTION_UNKNOWN_DATABASE_ERROR", "category": "Connection", "description": "Unknown database", - "issue_codes": [ - 1015 - ], - "invalid_fields": [ - "database" - ] + "issue_codes": [1015], + "invalid_fields": ["database"] }, { "regex_name": "COLUMN_DOES_NOT_EXIST_REGEX", @@ -7691,10 +7034,7 @@ "error_type": "COLUMN_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Column not found", - "issue_codes": [ - 1003, - 1004 - ] + "issue_codes": [1003, 1004] }, { "regex_name": "SYNTAX_ERROR_REGEX", @@ -7702,17 +7042,13 @@ "error_type": "SYNTAX_ERROR", "category": "Query", "description": "SQL syntax error", - "issue_codes": [ - 1030 - ] + "issue_codes": [1030] } ] }, "engine": "postgresql", "engine_name": "PostgreSQL", - "engine_aliases": [ - "postgres" - ], + "engine_aliases": ["postgres"], "default_driver": "psycopg2", "supports_file_upload": true, "supports_dynamic_schema": true, @@ -7782,13 +7118,8 @@ "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" - ], + "categories": ["Query Engines", "Open Source"], + "pypi_packages": ["pyhive"], "install_instructions": "pip install \"apache-superset[presto]\"", "connection_string": "presto://{hostname}:{port}/{database}", "default_port": 8080, @@ -7813,10 +7144,7 @@ "error_type": "COLUMN_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Column not found", - "issue_codes": [ - 1003, - 1004 - ] + "issue_codes": [1003, 1004] }, { "regex_name": "TABLE_DOES_NOT_EXIST_REGEX", @@ -7824,10 +7152,7 @@ "error_type": "TABLE_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Table not found", - "issue_codes": [ - 1003, - 1005 - ] + "issue_codes": [1003, 1005] }, { "regex_name": "SCHEMA_DOES_NOT_EXIST_REGEX", @@ -7835,10 +7160,7 @@ "error_type": "SCHEMA_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Schema not found", - "issue_codes": [ - 1003, - 1016 - ] + "issue_codes": [1003, 1016] }, { "regex_name": "CONNECTION_ACCESS_DENIED_REGEX", @@ -7846,10 +7168,7 @@ "error_type": "CONNECTION_ACCESS_DENIED_ERROR", "category": "Authentication", "description": "Access denied", - "issue_codes": [ - 1014, - 1015 - ] + "issue_codes": [1014, 1015] }, { "regex_name": "CONNECTION_INVALID_HOSTNAME_REGEX", @@ -7857,9 +7176,7 @@ "error_type": "CONNECTION_INVALID_HOSTNAME_ERROR", "category": "Connection", "description": "Invalid hostname", - "issue_codes": [ - 1007 - ] + "issue_codes": [1007] }, { "regex_name": "CONNECTION_HOST_DOWN_REGEX", @@ -7867,9 +7184,7 @@ "error_type": "CONNECTION_HOST_DOWN_ERROR", "category": "Connection", "description": "Host unreachable", - "issue_codes": [ - 1009 - ] + "issue_codes": [1009] }, { "regex_name": "CONNECTION_PORT_CLOSED_REGEX", @@ -7877,9 +7192,7 @@ "error_type": "CONNECTION_PORT_CLOSED_ERROR", "category": "Connection", "description": "Port closed or refused", - "issue_codes": [ - 1008 - ] + "issue_codes": [1008] }, { "regex_name": "CONNECTION_UNKNOWN_DATABASE_ERROR", @@ -7887,9 +7200,7 @@ "error_type": "CONNECTION_UNKNOWN_DATABASE_ERROR", "category": "Connection", "description": "Unknown database", - "issue_codes": [ - 1015 - ] + "issue_codes": [1015] } ] }, @@ -7965,13 +7276,8 @@ "description": "RisingWave is a distributed streaming database.", "logo": "risingwave.svg", "homepage_url": "https://risingwave.com/", - "categories": [ - "Analytical Databases", - "Open Source" - ], - "pypi_packages": [ - "sqlalchemy-risingwave" - ], + "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", @@ -7979,9 +7285,7 @@ }, "engine": "risingwave", "engine_name": "RisingWave", - "engine_aliases": [ - "postgres" - ], + "engine_aliases": ["postgres"], "default_driver": "", "supports_file_upload": true, "supports_dynamic_schema": true, @@ -8051,14 +7355,8 @@ "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" - ], + "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, @@ -8137,14 +7435,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Proprietary"], + "pypi_packages": ["sqlalchemy-sybase", "pyodbc"], "connection_string": "sybase+pyodbc://{username}:{password}@{dsn}", "parameters": { "username": "Database username", @@ -8157,9 +7449,7 @@ }, "engine": "sybase", "engine_name": "SAP Sybase", - "engine_aliases": [ - "sybase_sqlany" - ], + "engine_aliases": ["sybase_sqlany"], "default_driver": "pyodbc", "supports_file_upload": true, "supports_dynamic_schema": false, @@ -8229,10 +7519,7 @@ "description": "SQLite is a self-contained, serverless SQL database engine.", "logo": "sqlite.png", "homepage_url": "https://www.sqlite.org/", - "categories": [ - "Traditional RDBMS", - "Open Source" - ], + "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.", @@ -8244,10 +7531,7 @@ "error_type": "COLUMN_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Column not found", - "issue_codes": [ - 1003, - 1004 - ] + "issue_codes": [1003, 1004] } ] }, @@ -8323,13 +7607,8 @@ "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]" - ], + "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" @@ -8406,13 +7685,8 @@ "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" - ], + "categories": ["Analytical Databases", "Proprietary"], + "pypi_packages": ["singlestoredb"], "connection_string": "singlestoredb://{username}:{password}@{host}:{port}/{database}", "default_port": 3306, "parameters": { @@ -8509,9 +7783,7 @@ "Analytical Databases", "Proprietary" ], - "pypi_packages": [ - "snowflake-sqlalchemy" - ], + "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": [ @@ -8542,9 +7814,7 @@ "error_type": "OBJECT_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Object not found", - "issue_codes": [ - 1029 - ] + "issue_codes": [1029] }, { "regex_name": "SYNTAX_ERROR_REGEX", @@ -8552,9 +7822,7 @@ "error_type": "SYNTAX_ERROR", "category": "Query", "description": "SQL syntax error", - "issue_codes": [ - 1030 - ] + "issue_codes": [1030] } ] }, @@ -8630,13 +7898,8 @@ "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" - ], + "categories": ["Analytical Databases", "Open Source"], + "pypi_packages": ["starrocks"], "connection_string": "starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}", "default_port": 9030, "parameters": { @@ -8680,9 +7943,7 @@ "Cloud Data Warehouses", "Hosted Open Source" ], - "pypi_packages": [ - "starrocks" - ], + "pypi_packages": ["starrocks"], "connection_string": "starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}", "parameters": { "username": "CelerData username", @@ -8703,14 +7964,8 @@ "error_type": "CONNECTION_ACCESS_DENIED_ERROR", "category": "Authentication", "description": "Access denied", - "issue_codes": [ - 1014, - 1015 - ], - "invalid_fields": [ - "username", - "password" - ] + "issue_codes": [1014, 1015], + "invalid_fields": ["username", "password"] }, { "regex_name": "CONNECTION_UNKNOWN_DATABASE_REGEX", @@ -8718,12 +7973,8 @@ "error_type": "CONNECTION_UNKNOWN_DATABASE_ERROR", "category": "Connection", "description": "Unknown database", - "issue_codes": [ - 1015 - ], - "invalid_fields": [ - "database" - ] + "issue_codes": [1015], + "invalid_fields": ["database"] } ] }, @@ -8799,9 +8050,7 @@ "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" - ], + "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.", @@ -8879,14 +8128,8 @@ "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" - ], + "categories": ["Time Series Databases", "Open Source"], + "pypi_packages": ["taospy", "taos-ws-py"], "connection_string": "taosws://{user}:{password}@{host}:{port}", "default_port": 6041, "connection_examples": [ @@ -8970,13 +8213,8 @@ "description": "Teradata is an enterprise data warehouse platform.", "logo": "teradata.png", "homepage_url": "https://www.teradata.com/", - "categories": [ - "Traditional RDBMS", - "Proprietary" - ], - "pypi_packages": [ - "teradatasqlalchemy" - ], + "categories": ["Traditional RDBMS", "Proprietary"], + "pypi_packages": ["teradatasqlalchemy"], "connection_string": "teradatasql://{user}:{password}@{host}", "default_port": 1025, "drivers": [ @@ -9069,13 +8307,8 @@ "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" - ], + "categories": ["Analytical Databases", "Open Source"], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "default_port": 5432, "connection_examples": [ @@ -9160,13 +8393,8 @@ "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" - ], + "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, @@ -9196,9 +8424,7 @@ "Cloud Data Warehouses", "Hosted Open Source" ], - "pypi_packages": [ - "trino" - ], + "pypi_packages": ["trino"], "connection_string": "trino://{username}:{password}@{host}:{port}/{catalog}", "parameters": { "username": "Starburst Galaxy username (email/role)", @@ -9214,13 +8440,8 @@ "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" - ], + "categories": ["Query Engines", "Hosted Open Source"], + "pypi_packages": ["trino"], "connection_string": "trino://{username}:{password}@{hostname}:{port}/{catalog}", "docs_url": "https://docs.starburst.io/" } @@ -9299,13 +8520,8 @@ "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" - ], + "categories": ["Analytical Databases", "Proprietary"], + "pypi_packages": ["sqlalchemy-vertica-python"], "connection_string": "vertica+vertica_python://{username}:{password}@{host}/{database}", "default_port": 5433, "parameters": { @@ -9391,13 +8607,8 @@ "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" - ], + "categories": ["Traditional RDBMS", "Open Source"], + "pypi_packages": ["ydb-sqlalchemy"], "connection_string": "ydb://{host}:{port}/{database_name}", "default_port": 2135, "engine_parameters": [ @@ -9447,10 +8658,7 @@ }, "engine": "yql", "engine_name": "YDB", - "engine_aliases": [ - "yql+ydb", - "ydb" - ], + "engine_aliases": ["yql+ydb", "ydb"], "default_driver": "ydb", "supports_file_upload": false, "supports_dynamic_schema": false, @@ -9525,9 +8733,7 @@ "Traditional RDBMS", "Open Source" ], - "pypi_packages": [ - "psycopg2" - ], + "pypi_packages": ["psycopg2"], "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}", "default_port": 5433, "notes": "Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.", @@ -9613,10 +8819,7 @@ "error_type": "COLUMN_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Column not found", - "issue_codes": [ - 1003, - 1004 - ] + "issue_codes": [1003, 1004] }, { "regex_name": "TABLE_DOES_NOT_EXIST_REGEX", @@ -9624,10 +8827,7 @@ "error_type": "TABLE_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Table not found", - "issue_codes": [ - 1003, - 1005 - ] + "issue_codes": [1003, 1005] }, { "regex_name": "SCHEMA_DOES_NOT_EXIST_REGEX", @@ -9635,10 +8835,7 @@ "error_type": "SCHEMA_DOES_NOT_EXIST_ERROR", "category": "Query", "description": "Schema not found", - "issue_codes": [ - 1003, - 1016 - ] + "issue_codes": [1003, 1016] }, { "regex_name": "CONNECTION_ACCESS_DENIED_REGEX", @@ -9646,10 +8843,7 @@ "error_type": "CONNECTION_ACCESS_DENIED_ERROR", "category": "Authentication", "description": "Access denied", - "issue_codes": [ - 1014, - 1015 - ] + "issue_codes": [1014, 1015] }, { "regex_name": "CONNECTION_INVALID_HOSTNAME_REGEX", @@ -9657,9 +8851,7 @@ "error_type": "CONNECTION_INVALID_HOSTNAME_ERROR", "category": "Connection", "description": "Invalid hostname", - "issue_codes": [ - 1007 - ] + "issue_codes": [1007] }, { "regex_name": "CONNECTION_HOST_DOWN_REGEX", @@ -9667,9 +8859,7 @@ "error_type": "CONNECTION_HOST_DOWN_ERROR", "category": "Connection", "description": "Host unreachable", - "issue_codes": [ - 1009 - ] + "issue_codes": [1009] }, { "regex_name": "CONNECTION_PORT_CLOSED_REGEX", @@ -9677,9 +8867,7 @@ "error_type": "CONNECTION_PORT_CLOSED_ERROR", "category": "Connection", "description": "Port closed or refused", - "issue_codes": [ - 1008 - ] + "issue_codes": [1008] }, { "regex_name": "CONNECTION_UNKNOWN_DATABASE_ERROR", @@ -9687,9 +8875,7 @@ "error_type": "CONNECTION_UNKNOWN_DATABASE_ERROR", "category": "Connection", "description": "Unknown database", - "issue_codes": [ - 1015 - ] + "issue_codes": [1015] } ] }, @@ -9765,14 +8951,8 @@ "description": "DataFusion is a highly performant query engine", "logo": "datafusion.png", "homepage_url": "https://datafusion.apache.org/", - "categories": [ - "Query Engines", - "Open Source", - "Apache Projects" - ], - "pypi_packages": [ - "flightsql-dbapi" - ], + "categories": ["Query Engines", "Open Source", "Apache Projects"], + "pypi_packages": ["flightsql-dbapi"], "connection_string": "datafusion://host:port", "drivers": [ { diff --git a/docs/src/pages/inTheWild.tsx b/docs/src/pages/inTheWild.tsx index 870ced1c53a..f7f2da89054 100644 --- a/docs/src/pages/inTheWild.tsx +++ b/docs/src/pages/inTheWild.tsx @@ -43,7 +43,7 @@ const ContributorAvatars = ({ contributors }: { contributors?: string[] }) => { if (!contributors?.length) return null; return ( - {contributors.map((handle) => { + {contributors.map(handle => { const username = handle.replace('@', ''); return ( { href={`https://github.com/${username}`} target="_blank" rel="noreferrer" - onClick={(e) => e.stopPropagation()} + onClick={e => e.stopPropagation()} > { export default function InTheWild() { return ( - +
    -
    +
    { - const logoItems = items.filter(({ logo }) => logo?.trim()); - const textItems = items.filter(({ logo }) => !logo?.trim()); + items={Object.entries(typedDataSet.categories).map( + ([category, items]) => { + const logoItems = items.filter(({ logo }) => logo?.trim()); + const textItems = items.filter(({ logo }) => !logo?.trim()); - return { - key: category, - label: ( - - {category} ({items.length}) - - ), - children: ( - <> - {logoItems.length > 0 && ( - 0 ? 24 : 0 }}> - {logoItems.map(({ name, url, logo, contributors }) => ( -
    - - - {name} - {contributors?.length && ( -
    - -
    - )} -     -     - - ))} - - )} + return { + key: category, + label: ( + + {category} ({items.length}) + + ), + children: ( + <> + {logoItems.length > 0 && ( + 0 ? 24 : 0, + }} + > + {logoItems.map( + ({ name, url, logo, contributors }) => ( + + + + {name} + {contributors?.length && ( +
    + +
    + )} +     +     + + ), + )} + + )} - {textItems.length > 0 && ( - - {textItems.map(({ name, url, contributors }) => ( - - - - {name} - - - - - ))} - - )} - - ), - }; - })} + {textItems.length > 0 && ( + + {textItems.map(({ name, url, contributors }) => ( + + + + + {name} + + + + + + ))} + + )} + + ), + }; + }, + )} /> diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index 214efdcd2de..f50ef3de1e1 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -42,10 +42,13 @@ const Databases = Object.entries(typedDatabaseData.databases) title: name, href: db.documentation?.homepage_url, imgName: db.documentation?.logo, - docPath: `/docs/databases/supported/${name.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '')}`, + docPath: `/docs/databases/supported/${name + .toLowerCase() + .replace(/[^a-z0-9]+/g, '-') + .replace(/^-|-$/g, '')}`, })) .sort((a, b) => a.title.localeCompare(b.title)) - .filter((db) => { + .filter(db => { if (seenLogos.has(db.imgName!)) return false; seenLogos.add(db.imgName!); return true; @@ -66,7 +69,7 @@ const typedDataSet = load(DataSet) as DataSetType; // Extract all organizations with logos for the carousel const companiesWithLogos = Object.values(typedDataSet.categories) .flat() - .filter((org) => org.logo?.trim()); + .filter(org => org.logo?.trim()); // Fisher-Yates shuffle for fair randomization function shuffleArray(array: T[]): T[] { @@ -350,7 +353,9 @@ const StyledDocSectionCard = styled(Link)` text-decoration: none; color: var(--ifm-font-base-color); background: transparent; - transition: transform 0.2s ease, box-shadow 0.2s ease; + transition: + transform 0.2s ease, + box-shadow 0.2s ease; &:hover { transform: translateY(-4px); box-shadow: 0 8px 24px rgba(0, 0, 0, 0.1); @@ -595,7 +600,8 @@ export default function Home(): JSX.Element { const slider = useRef(null); const [slideIndex, setSlideIndex] = useState(0); - const [shuffledCompanies, setShuffledCompanies] = useState(companiesWithLogos); + const [shuffledCompanies, setShuffledCompanies] = + useState(companiesWithLogos); const onChange = (current, next) => { setSlideIndex(next); @@ -893,7 +899,11 @@ export default function Home(): JSX.Element { - +
    {Databases.map(({ title, imgName, docPath }) => (
    @@ -957,7 +967,11 @@ export default function Home(): JSX.Element { src={`/img/logos/${logo}`} alt={name} title={name} - style={{ maxHeight: 48, maxWidth: '100%', objectFit: 'contain' }} + style={{ + maxHeight: 48, + maxWidth: '100%', + objectFit: 'contain', + }} /> diff --git a/docs/src/pages/markdown-page.md b/docs/src/pages/markdown-page.md index 54e57d4c3ed..e869e37b6cc 100644 --- a/docs/src/pages/markdown-page.md +++ b/docs/src/pages/markdown-page.md @@ -18,6 +18,7 @@ under the License. --> --- + title: Markdown page example --- diff --git a/docs/src/styles/custom.css b/docs/src/styles/custom.css index ef7a191b2a7..db1ecee0b43 100644 --- a/docs/src/styles/custom.css +++ b/docs/src/styles/custom.css @@ -26,16 +26,18 @@ /* You can override the default Infima variables here. */ @font-face { font-family: 'Roboto'; - src: url('../fonts/Roboto-Regular.woff2') format('woff2'), - url('../fonts/Roboto-Regular.woff') format('woff'); + src: + url('../fonts/Roboto-Regular.woff2') format('woff2'), + url('../fonts/Roboto-Regular.woff') format('woff'); font-weight: 400; font-style: normal; } @font-face { font-family: 'Roboto'; - src: url('../fonts/Roboto-Bold.woff2') format('woff2'), - url('../fonts/Roboto-Bold.woff') format('woff'); + src: + url('../fonts/Roboto-Bold.woff2') format('woff2'), + url('../fonts/Roboto-Bold.woff') format('woff'); font-weight: 700; font-style: bold; } @@ -447,9 +449,9 @@ ul.dropdown__menu svg { /* Limit the code editor height and make it scrollable */ /* Target multiple possible class names used by Docusaurus/react-live */ .playgroundEditor, -[class*="playgroundEditor"], +[class*='playgroundEditor'], .live-editor, -[class*="liveEditor"] { +[class*='liveEditor'] { max-height: 350px !important; overflow: auto !important; } @@ -457,15 +459,15 @@ ul.dropdown__menu svg { /* The actual textarea/code area inside the editor */ .playgroundEditor textarea, .playgroundEditor pre, -[class*="playgroundEditor"] textarea, -[class*="playgroundEditor"] pre { +[class*='playgroundEditor'] textarea, +[class*='playgroundEditor'] pre { max-height: 350px !important; overflow: auto !important; } /* Also limit the preview area for consistency */ .playgroundPreview, -[class*="playgroundPreview"] { +[class*='playgroundPreview'] { max-height: 400px; overflow: auto; } diff --git a/docs/src/styles/main.css b/docs/src/styles/main.css index 2a819710c73..63cb5abfcd4 100644 --- a/docs/src/styles/main.css +++ b/docs/src/styles/main.css @@ -280,7 +280,9 @@ a > span > svg { .footer__social-links a { display: inline-flex; align-items: center; - transition: opacity 0.2s, transform 0.2s; + transition: + opacity 0.2s, + transform 0.2s; } .footer__social-links a:hover { diff --git a/docs/src/theme/ApiExplorer/MethodEndpoint/index.tsx b/docs/src/theme/ApiExplorer/MethodEndpoint/index.tsx index 276331db547..d4369b06ad4 100644 --- a/docs/src/theme/ApiExplorer/MethodEndpoint/index.tsx +++ b/docs/src/theme/ApiExplorer/MethodEndpoint/index.tsx @@ -24,10 +24,10 @@ * so SSG can render the page without a store context. */ -import React from "react"; +import React from 'react'; -import BrowserOnly from "@docusaurus/BrowserOnly"; -import { useSelector } from "react-redux"; +import BrowserOnly from '@docusaurus/BrowserOnly'; +import { useSelector } from 'react-redux'; interface ServerVariable { default?: string; @@ -44,20 +44,20 @@ interface StoreState { function colorForMethod(method: string) { switch (method.toLowerCase()) { - case "get": - return "primary"; - case "post": - return "success"; - case "delete": - return "danger"; - case "put": - return "info"; - case "patch": - return "warning"; - case "head": - return "secondary"; - case "event": - return "secondary"; + case 'get': + return 'primary'; + case 'post': + return 'success'; + case 'delete': + return 'danger'; + case 'put': + return 'info'; + case 'patch': + return 'warning'; + case 'head': + return 'secondary'; + case 'event': + return 'secondary'; default: return undefined; } @@ -66,7 +66,7 @@ function colorForMethod(method: string) { export interface Props { method: string; path: string; - context?: "endpoint" | "callback"; + context?: 'endpoint' | 'callback'; } // Inner component rendered only in the browser, where the Redux store exists. @@ -74,11 +74,11 @@ function ServerUrl() { const serverValue = useSelector((state: StoreState) => state.server.value); if (serverValue && serverValue.variables) { - let serverUrlWithVariables = serverValue.url.replace(/\/$/, ""); - Object.keys(serverValue.variables).forEach((variable) => { + let serverUrlWithVariables = serverValue.url.replace(/\/$/, ''); + Object.keys(serverValue.variables).forEach(variable => { serverUrlWithVariables = serverUrlWithVariables.replace( `{${variable}}`, - serverValue.variables?.[variable].default ?? "" + serverValue.variables?.[variable].default ?? '', ); }); return <>{serverUrlWithVariables}; @@ -93,8 +93,8 @@ function ServerUrl() { function MethodEndpoint({ method, path, context }: Props) { const renderServerUrl = () => { - if (context === "callback") { - return ""; + if (context === 'callback') { + return ''; } return {() => }; }; @@ -102,13 +102,13 @@ function MethodEndpoint({ method, path, context }: Props) { return ( <> 
    -        
-          {method === "event" ? "Webhook" : method.toUpperCase()}
-        {" "}
-        {method !== "event" && (
+        
+          {method === 'event' ? 'Webhook' : method.toUpperCase()}
+        {' '}
+        {method !== 'event' && (
           
    
             {renderServerUrl()}
-            {`${path.replace(/{([a-z0-9-_]+)}/gi, ":$1")}`}
+            {`${path.replace(/{([a-z0-9-_]+)}/gi, ':$1')}`}
           
    
         )}
    diff --git a/docs/src/theme/DocVersionBadge/index.js b/docs/src/theme/DocVersionBadge/index.js index 13281efcbb6..1fd86f4a419 100644 --- a/docs/src/theme/DocVersionBadge/index.js +++ b/docs/src/theme/DocVersionBadge/index.js @@ -75,9 +75,13 @@ export default function DocVersionBadge() { if (afterBase.startsWith('/')) { const segments = afterBase.substring(1).split('/'); // Check if first segment is a version (e.g., "1.1.0", "next") - if (segments[0] && (segments[0].match(/^\d+\.\d+\.\d+$/) || segments[0] === 'next')) { + if ( + segments[0] && + (segments[0].match(/^\d+\.\d+\.\d+$/) || segments[0] === 'next') + ) { // Skip the version segment - relativePath = segments.length > 1 ? '/' + segments.slice(1).join('/') : ''; + relativePath = + segments.length > 1 ? '/' + segments.slice(1).join('/') : ''; } else { // No version in path (e.g., /docs/intro for current version with empty path) relativePath = afterBase; diff --git a/docs/src/theme/Playground/Preview/index.tsx b/docs/src/theme/Playground/Preview/index.tsx index f3af23389bf..5a47a4a40bd 100644 --- a/docs/src/theme/Playground/Preview/index.tsx +++ b/docs/src/theme/Playground/Preview/index.tsx @@ -75,7 +75,7 @@ function PlaygroundLivePreview(): ReactNode { {() => ( <> ( + fallback={params => ( )} > diff --git a/docs/src/theme/ReactLiveScope/index.tsx b/docs/src/theme/ReactLiveScope/index.tsx index fade92f93cf..117c3bf4c7e 100644 --- a/docs/src/theme/ReactLiveScope/index.tsx +++ b/docs/src/theme/ReactLiveScope/index.tsx @@ -52,12 +52,21 @@ if (isBrowser) { // eslint-disable-next-line @typescript-eslint/no-require-imports const { Alert } = require('@apache-superset/core/components'); - console.log('[ReactLiveScope] SupersetComponents keys:', Object.keys(SupersetComponents || {}).slice(0, 10)); - console.log('[ReactLiveScope] Has Button?', 'Button' in (SupersetComponents || {})); + console.log( + '[ReactLiveScope] SupersetComponents keys:', + Object.keys(SupersetComponents || {}).slice(0, 10), + ); + console.log( + '[ReactLiveScope] Has Button?', + 'Button' in (SupersetComponents || {}), + ); Object.assign(ReactLiveScope, SupersetComponents, { Alert }); - console.log('[ReactLiveScope] Final scope keys:', Object.keys(ReactLiveScope).slice(0, 20)); + console.log( + '[ReactLiveScope] Final scope keys:', + Object.keys(ReactLiveScope).slice(0, 20), + ); } catch (e) { console.error('[ReactLiveScope] Failed to load Superset components:', e); } diff --git a/docs/src/theme/Root.js b/docs/src/theme/Root.js index 677531ff905..5b6200eb0a4 100644 --- a/docs/src/theme/Root.js +++ b/docs/src/theme/Root.js @@ -21,10 +21,27 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; // File extensions to track as downloads const DOWNLOAD_EXTENSIONS = [ - 'pdf', 'zip', 'tar', 'gz', 'tgz', 'bz2', - 'exe', 'dmg', 'pkg', 'deb', 'rpm', - 'doc', 'docx', 'xls', 'xlsx', 'ppt', 'pptx', - 'csv', 'json', 'yaml', 'yml', + 'pdf', + 'zip', + 'tar', + 'gz', + 'tgz', + 'bz2', + 'exe', + 'dmg', + 'pkg', + 'deb', + 'rpm', + 'doc', + 'docx', + 'xls', + 'xlsx', + 'ppt', + 'pptx', + 'csv', + 'json', + 'yaml', + 'yml', ]; // Scroll depth milestones to track @@ -38,7 +55,9 @@ export default function Root({ children }) { const { matomoUrl, matomoSiteId } = customFields; if (typeof window !== 'undefined') { - const devMode = ['localhost', '127.0.0.1', '::1', '0.0.0.0'].includes(window.location.hostname); + const devMode = ['localhost', '127.0.0.1', '::1', '0.0.0.0'].includes( + window.location.hostname, + ); // Initialize the _paq array window._paq = window._paq || []; @@ -50,7 +69,10 @@ export default function Root({ children }) { window._paq.push(['setSiteId', matomoSiteId]); // Track downloads with custom extensions - window._paq.push(['setDownloadExtensions', DOWNLOAD_EXTENSIONS.join('|')]); + window._paq.push([ + 'setDownloadExtensions', + DOWNLOAD_EXTENSIONS.join('|'), + ]); // Now load the matomo.js script const script = document.createElement('script'); @@ -69,7 +91,11 @@ export default function Root({ children }) { // Helper to track site search const trackSiteSearch = (keyword, category, resultsCount) => { if (devMode) { - console.log('Matomo trackSiteSearch:', { keyword, category, resultsCount }); + console.log('Matomo trackSiteSearch:', { + keyword, + category, + resultsCount, + }); } window._paq.push(['trackSiteSearch', keyword, category, resultsCount]); }; @@ -82,9 +108,8 @@ export default function Root({ children }) { window._paq.push(['trackPageView']); }; - // Track external link clicks using domain as category (vendor-agnostic) - const handleLinkClick = (event) => { + const handleLinkClick = event => { const link = event.target.closest('a'); if (!link) return; @@ -106,20 +131,22 @@ export default function Root({ children }) { // Track Algolia search queries const setupAlgoliaTracking = () => { - const observer = new MutationObserver((mutations) => { - mutations.forEach((mutation) => { - mutation.addedNodes.forEach((node) => { + const observer = new MutationObserver(mutations => { + mutations.forEach(mutation => { + mutation.addedNodes.forEach(node => { if (node.nodeType === Node.ELEMENT_NODE) { - const searchInput = node.querySelector?.('.DocSearch-Input') || - (node.classList?.contains('DocSearch-Input') ? node : null); + const searchInput = + node.querySelector?.('.DocSearch-Input') || + (node.classList?.contains('DocSearch-Input') ? node : null); if (searchInput) { let debounceTimer; - searchInput.addEventListener('input', (e) => { + searchInput.addEventListener('input', e => { clearTimeout(debounceTimer); debounceTimer = setTimeout(() => { const query = e.target.value.trim(); if (query.length >= 3) { - const results = document.querySelectorAll('.DocSearch-Hit'); + const results = + document.querySelectorAll('.DocSearch-Hit'); trackSiteSearch(query, 'Documentation', results.length); } }, 1000); @@ -135,21 +162,26 @@ export default function Root({ children }) { }; // Track video plays - const handleVideoPlay = (event) => { + const handleVideoPlay = event => { if (event.target.tagName === 'VIDEO') { - const videoSrc = event.target.currentSrc || event.target.src || 'unknown'; + const videoSrc = + event.target.currentSrc || event.target.src || 'unknown'; trackEvent('Video', 'Play', videoSrc); } }; // Track CTA button clicks - const handleCTAClick = (event) => { - const button = event.target.closest('.get-started-button, .default-button-theme'); + const handleCTAClick = event => { + const button = event.target.closest( + '.get-started-button, .default-button-theme', + ); if (button) { const buttonText = button.textContent?.trim() || 'Unknown'; const clickedLink = event.target.closest?.('a'); const href = - clickedLink?.getAttribute('href') || button.getAttribute('href') || ''; + clickedLink?.getAttribute('href') || + button.getAttribute('href') || + ''; trackEvent('CTA', 'Click', `${buttonText} - ${href}`); } }; @@ -158,15 +190,23 @@ export default function Root({ children }) { let scrollMilestonesReached = new Set(); const handleScroll = () => { const scrollTop = window.scrollY; - const docHeight = document.documentElement.scrollHeight - window.innerHeight; + const docHeight = + document.documentElement.scrollHeight - window.innerHeight; if (docHeight <= 0) return; const scrollPercent = Math.round((scrollTop / docHeight) * 100); SCROLL_MILESTONES.forEach(milestone => { - if (scrollPercent >= milestone && !scrollMilestonesReached.has(milestone)) { + if ( + scrollPercent >= milestone && + !scrollMilestonesReached.has(milestone) + ) { scrollMilestonesReached.add(milestone); - trackEvent('Scroll Depth', `${milestone}%`, window.location.pathname); + trackEvent( + 'Scroll Depth', + `${milestone}%`, + window.location.pathname, + ); } }); }; @@ -178,9 +218,13 @@ export default function Root({ children }) { // Track 404 pages const track404 = () => { - const is404 = document.querySelector('.theme-doc-404') || - document.title.toLowerCase().includes('not found') || - document.querySelector('h1')?.textContent?.toLowerCase().includes('not found'); + const is404 = + document.querySelector('.theme-doc-404') || + document.title.toLowerCase().includes('not found') || + document + .querySelector('h1') + ?.textContent?.toLowerCase() + .includes('not found'); if (is404) { trackEvent('Error', '404', window.location.pathname); if (devMode) { @@ -190,19 +234,27 @@ export default function Root({ children }) { }; // Track copy-to-clipboard events on code blocks - const handleCopy = (event) => { + const handleCopy = event => { const codeBlock = event.target.closest('pre, code, .prism-code'); if (codeBlock) { const codeText = window.getSelection()?.toString() || ''; - const codeSnippet = codeText.substring(0, 100) + (codeText.length > 100 ? '...' : ''); - trackEvent('Code', 'Copy', `${window.location.pathname}: ${codeSnippet}`); + const codeSnippet = + codeText.substring(0, 100) + (codeText.length > 100 ? '...' : ''); + trackEvent( + 'Code', + 'Copy', + `${window.location.pathname}: ${codeSnippet}`, + ); } }; // Track color mode preference (as event, no admin config needed) const trackColorMode = () => { - const colorMode = document.documentElement.getAttribute('data-theme') || - (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'); + const colorMode = + document.documentElement.getAttribute('data-theme') || + (window.matchMedia('(prefers-color-scheme: dark)').matches + ? 'dark' + : 'light'); trackEvent('User Preference', 'Color Mode', colorMode); }; @@ -289,11 +341,14 @@ export default function Root({ children }) { window.addEventListener('scroll', handleScroll, { passive: true }); // Watch for color mode changes - const colorModeObserver = new MutationObserver((mutations) => { - mutations.forEach((mutation) => { + const colorModeObserver = new MutationObserver(mutations => { + mutations.forEach(mutation => { if (mutation.attributeName === 'data-theme') { - trackEvent('User Preference', 'Color Mode Change', - document.documentElement.getAttribute('data-theme')); + trackEvent( + 'User Preference', + 'Color Mode Change', + document.documentElement.getAttribute('data-theme'), + ); } }); }); diff --git a/docs/static/resources/openapi.json b/docs/static/resources/openapi.json index 75f9d322656..357280686a8 100644 --- a/docs/static/resources/openapi.json +++ b/docs/static/resources/openapi.json @@ -144,11 +144,7 @@ "type": "object" }, "level": { - "enum": [ - "info", - "warning", - "error" - ], + "enum": ["info", "warning", "error"], "type": "string" }, "message": { @@ -236,12 +232,7 @@ "properties": { "annotationType": { "description": "Type of annotation layer", - "enum": [ - "FORMULA", - "INTERVAL", - "EVENT", - "TIME_SERIES" - ], + "enum": ["FORMULA", "INTERVAL", "EVENT", "TIME_SERIES"], "type": "string" }, "color": { @@ -272,13 +263,7 @@ }, "opacity": { "description": "Opacity of layer", - "enum": [ - "", - "opacityLow", - "opacityMedium", - "opacityHigh", - null - ], + "enum": ["", "opacityLow", "opacityMedium", "opacityHigh", null], "nullable": true, "type": "string" }, @@ -305,22 +290,12 @@ }, "sourceType": { "description": "Type of source for annotation data", - "enum": [ - "", - "line", - "NATIVE", - "table" - ], + "enum": ["", "line", "NATIVE", "table"], "type": "string" }, "style": { "description": "Line style. Only applies to time-series annotations", - "enum": [ - "dashed", - "dotted", - "solid", - "longDashed" - ], + "enum": ["dashed", "dotted", "solid", "longDashed"], "type": "string" }, "timeColumn": { @@ -342,12 +317,7 @@ "type": "number" } }, - "required": [ - "name", - "show", - "showMarkers", - "value" - ], + "required": ["name", "show", "showMarkers", "value"], "type": "object" }, "AnnotationLayerRestApi.get": { @@ -414,10 +384,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "AnnotationLayerRestApi.get_list.User1": { @@ -431,10 +398,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "AnnotationLayerRestApi.post": { @@ -451,9 +415,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "AnnotationLayerRestApi.put": { @@ -503,9 +465,7 @@ "type": "string" } }, - "required": [ - "layer" - ], + "required": ["layer"], "type": "object" }, "AnnotationRestApi.get.AnnotationLayer": { @@ -567,9 +527,7 @@ "type": "integer" } }, - "required": [ - "first_name" - ], + "required": ["first_name"], "type": "object" }, "AnnotationRestApi.get_list.User1": { @@ -582,9 +540,7 @@ "type": "integer" } }, - "required": [ - "first_name" - ], + "required": ["first_name"], "type": "object" }, "AnnotationRestApi.post": { @@ -616,11 +572,7 @@ "type": "string" } }, - "required": [ - "end_dttm", - "short_descr", - "start_dttm" - ], + "required": ["end_dttm", "short_descr", "start_dttm"], "type": "object" }, "AnnotationRestApi.put": { @@ -768,9 +720,7 @@ "type": "string" } }, - "required": [ - "chart_id" - ], + "required": ["chart_id"], "type": "object" }, "ChartCacheWarmUpResponseSchema": { @@ -806,14 +756,7 @@ "properties": { "aggregate": { "description": "Aggregation operator.Only required for simple expression types.", - "enum": [ - "AVG", - "COUNT", - "COUNT_DISTINCT", - "MAX", - "MIN", - "SUM" - ], + "enum": ["AVG", "COUNT", "COUNT_DISTINCT", "MAX", "MIN", "SUM"], "type": "string" }, "column": { @@ -821,10 +764,7 @@ }, "expressionType": { "description": "Simple or SQL metric", - "enum": [ - "SIMPLE", - "SQL" - ], + "enum": ["SIMPLE", "SQL"], "example": "SQL", "type": "string" }, @@ -858,9 +798,7 @@ "type": "string" } }, - "required": [ - "expressionType" - ], + "required": ["expressionType"], "type": "object" }, "ChartDataAggregateOptionsSchema": { @@ -925,25 +863,16 @@ }, "percentiles": { "description": "Upper and lower percentiles for percentile whisker type.", - "example": [ - 1, - 99 - ] + "example": [1, 99] }, "whisker_type": { "description": "Whisker type. Any numpy function will work.", - "enum": [ - "tukey", - "min/max", - "percentile" - ], + "enum": ["tukey", "min/max", "percentile"], "example": "tukey", "type": "string" } }, - "required": [ - "whisker_type" - ], + "required": ["whisker_type"], "type": "object" }, "ChartDataColumn": { @@ -965,17 +894,12 @@ "properties": { "orientation": { "description": "Should cell values be calculated across the row or column.", - "enum": [ - "row", - "column" - ], + "enum": ["row", "column"], "example": "row", "type": "string" } }, - "required": [ - "orientation" - ], + "required": ["orientation"], "type": "object" }, "ChartDataDatasource": { @@ -985,19 +909,11 @@ }, "type": { "description": "Datasource type", - "enum": [ - "table", - "dataset", - "query", - "saved_query", - "view" - ], + "enum": ["table", "dataset", "query", "saved_query", "view"], "type": "string" } }, - "required": [ - "id" - ], + "required": ["id"], "type": "object" }, "ChartDataExtras": { @@ -1021,18 +937,12 @@ }, "relative_end": { "description": "End time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`", - "enum": [ - "today", - "now" - ], + "enum": ["today", "now"], "type": "string" }, "relative_start": { "description": "Start time for relative time deltas. Default: `config[\"DEFAULT_RELATIVE_START_TIME\"]`", - "enum": [ - "today", - "now" - ], + "enum": ["today", "now"], "type": "string" }, "time_grain_sqla": { @@ -1116,18 +1026,11 @@ }, "val": { "description": "The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.", - "example": [ - "China", - "France", - "Japan" - ], + "example": ["China", "France", "Japan"], "nullable": true } }, - "required": [ - "col", - "op" - ], + "required": ["col", "op"], "type": "object" }, "ChartDataGeodeticParseOptionsSchema": { @@ -1149,11 +1052,7 @@ "type": "string" } }, - "required": [ - "geodetic", - "latitude", - "longitude" - ], + "required": ["geodetic", "latitude", "longitude"], "type": "object" }, "ChartDataGeohashDecodeOptionsSchema": { @@ -1171,11 +1070,7 @@ "type": "string" } }, - "required": [ - "geohash", - "latitude", - "longitude" - ], + "required": ["geohash", "latitude", "longitude"], "type": "object" }, "ChartDataGeohashEncodeOptionsSchema": { @@ -1193,11 +1088,7 @@ "type": "string" } }, - "required": [ - "geohash", - "latitude", - "longitude" - ], + "required": ["geohash", "latitude", "longitude"], "type": "object" }, "ChartDataPivotOptionsSchema": { @@ -1291,17 +1182,12 @@ } } }, - "groupby": [ - "country", - "gender" - ] + "groupby": ["country", "gender"] }, "type": "object" } }, - "required": [ - "operation" - ], + "required": ["operation"], "type": "object" }, "ChartDataProphetOptionsSchema": { @@ -1357,11 +1243,7 @@ "example": false } }, - "required": [ - "confidence_interval", - "periods", - "time_grain" - ], + "required": ["confidence_interval", "periods", "time_grain"], "type": "object" }, "ChartDataQueryContextSchema": { @@ -1389,11 +1271,7 @@ "type": "array" }, "result_format": { - "enum": [ - "csv", - "json", - "xlsx" - ] + "enum": ["csv", "json", "xlsx"] }, "result_type": { "enum": [ @@ -1516,14 +1394,8 @@ "orderby": { "description": "Expects a list of lists where the first element is the column name which to sort by, and the second element is a boolean.", "example": [ - [ - "my_col_1", - false - ], - [ - "my_col_2", - true - ] + ["my_col_1", false], + ["my_col_2", true] ], "items": {}, "nullable": true, @@ -1925,9 +1797,7 @@ "type": "string" } }, - "required": [ - "table_name" - ], + "required": ["table_name"], "type": "object" }, "ChartDataRestApi.get_list.Tag": { @@ -1941,12 +1811,7 @@ "type": "string" }, "type": { - "enum": [ - 1, - 2, - 3, - 4 - ] + "enum": [1, 2, 3, 4] } }, "type": "object" @@ -1965,10 +1830,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ChartDataRestApi.get_list.User1": { @@ -1985,10 +1847,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ChartDataRestApi.get_list.User2": { @@ -2005,10 +1864,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ChartDataRestApi.get_list.User3": { @@ -2025,10 +1881,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ChartDataRestApi.post": { @@ -2066,13 +1919,7 @@ }, "datasource_type": { "description": "The type of dataset/datasource identified on `datasource_id`.", - "enum": [ - "table", - "dataset", - "query", - "saved_query", - "view" - ], + "enum": ["table", "dataset", "query", "saved_query", "view"], "type": "string" }, "description": { @@ -2123,21 +1970,13 @@ }, "viz_type": { "description": "The type of chart visualization used.", - "example": [ - "bar", - "area", - "table" - ], + "example": ["bar", "area", "table"], "maxLength": 250, "minLength": 0, "type": "string" } }, - "required": [ - "datasource_id", - "datasource_type", - "slice_name" - ], + "required": ["datasource_id", "datasource_type", "slice_name"], "type": "object" }, "ChartDataRestApi.put": { @@ -2171,14 +2010,7 @@ }, "datasource_type": { "description": "The type of dataset/datasource identified on `datasource_id`.", - "enum": [ - "table", - "dataset", - "query", - "saved_query", - "view", - null - ], + "enum": ["table", "dataset", "query", "saved_query", "view", null], "nullable": true, "type": "string" }, @@ -2238,11 +2070,7 @@ }, "viz_type": { "description": "The type of chart visualization used.", - "example": [ - "bar", - "area", - "table" - ], + "example": ["bar", "area", "table"], "maxLength": 250, "minLength": 0, "nullable": true, @@ -2323,21 +2151,14 @@ "type": "integer" } }, - "required": [ - "rolling_type", - "window" - ], + "required": ["rolling_type", "window"], "type": "object" }, "ChartDataSelectOptionsSchema": { "properties": { "columns": { "description": "Columns which to select from the input data, in the desired order. If columns are renamed, the original column name should be referenced here.", - "example": [ - "country", - "gender", - "age" - ], + "example": ["country", "gender", "age"], "items": { "type": "string" }, @@ -2345,9 +2166,7 @@ }, "exclude": { "description": "Columns to exclude from selection.", - "example": [ - "my_temp_column" - ], + "example": ["my_temp_column"], "items": { "type": "string" }, @@ -2392,9 +2211,7 @@ "type": "object" } }, - "required": [ - "columns" - ], + "required": ["columns"], "type": "object" }, "ChartEntityResponseSchema": { @@ -2731,9 +2548,7 @@ "type": "string" } }, - "required": [ - "table_name" - ], + "required": ["table_name"], "type": "object" }, "ChartRestApi.get_list.Tag": { @@ -2747,12 +2562,7 @@ "type": "string" }, "type": { - "enum": [ - 1, - 2, - 3, - 4 - ] + "enum": [1, 2, 3, 4] } }, "type": "object" @@ -2771,10 +2581,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ChartRestApi.get_list.User1": { @@ -2791,10 +2598,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ChartRestApi.get_list.User2": { @@ -2811,10 +2615,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ChartRestApi.get_list.User3": { @@ -2831,10 +2632,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ChartRestApi.post": { @@ -2872,13 +2670,7 @@ }, "datasource_type": { "description": "The type of dataset/datasource identified on `datasource_id`.", - "enum": [ - "table", - "dataset", - "query", - "saved_query", - "view" - ], + "enum": ["table", "dataset", "query", "saved_query", "view"], "type": "string" }, "description": { @@ -2929,21 +2721,13 @@ }, "viz_type": { "description": "The type of chart visualization used.", - "example": [ - "bar", - "area", - "table" - ], + "example": ["bar", "area", "table"], "maxLength": 250, "minLength": 0, "type": "string" } }, - "required": [ - "datasource_id", - "datasource_type", - "slice_name" - ], + "required": ["datasource_id", "datasource_type", "slice_name"], "type": "object" }, "ChartRestApi.put": { @@ -2977,14 +2761,7 @@ }, "datasource_type": { "description": "The type of dataset/datasource identified on `datasource_id`.", - "enum": [ - "table", - "dataset", - "query", - "saved_query", - "view", - null - ], + "enum": ["table", "dataset", "query", "saved_query", "view", null], "nullable": true, "type": "string" }, @@ -3044,11 +2821,7 @@ }, "viz_type": { "description": "The type of chart visualization used.", - "example": [ - "bar", - "area", - "table" - ], + "example": ["bar", "area", "table"], "maxLength": 250, "minLength": 0, "nullable": true, @@ -3097,10 +2870,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "CssTemplateRestApi.get.User1": { @@ -3117,10 +2887,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "CssTemplateRestApi.get_list": { @@ -3168,10 +2935,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "CssTemplateRestApi.get_list.User1": { @@ -3188,10 +2952,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "CssTemplateRestApi.post": { @@ -3304,9 +3065,7 @@ "type": "string" } }, - "required": [ - "json_metadata" - ], + "required": ["json_metadata"], "type": "object" }, "DashboardDatasetSchema": { @@ -3699,9 +3458,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "DashboardRestApi.get_list.Tag": { @@ -3715,12 +3472,7 @@ "type": "string" }, "type": { - "enum": [ - 1, - 2, - 3, - 4 - ] + "enum": [1, 2, 3, 4] } }, "type": "object" @@ -3739,10 +3491,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "DashboardRestApi.get_list.User1": { @@ -3759,10 +3508,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "DashboardRestApi.get_list.User2": { @@ -3779,10 +3525,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "DashboardRestApi.post": { @@ -4294,9 +4037,7 @@ "type": "string" } }, - "required": [ - "database_name" - ], + "required": ["database_name"], "type": "object" }, "DatabaseRestApi.get_list": { @@ -4393,9 +4134,7 @@ "type": "string" } }, - "required": [ - "database_name" - ], + "required": ["database_name"], "type": "object" }, "DatabaseRestApi.get_list.User": { @@ -4409,10 +4148,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "DatabaseRestApi.get_list.User1": { @@ -4426,10 +4162,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "DatabaseRestApi.post": { @@ -4462,10 +4195,7 @@ "configuration_method": { "default": "sqlalchemy_form", "description": "Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.", - "enum": [ - "sqlalchemy_form", - "dynamic_form" - ] + "enum": ["sqlalchemy_form", "dynamic_form"] }, "database_name": { "description": "A database name to identify this connection.", @@ -4543,9 +4273,7 @@ "type": "string" } }, - "required": [ - "database_name" - ], + "required": ["database_name"], "type": "object" }, "DatabaseRestApi.put": { @@ -4578,10 +4306,7 @@ "configuration_method": { "default": "sqlalchemy_form", "description": "Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.", - "enum": [ - "sqlalchemy_form", - "dynamic_form" - ] + "enum": ["sqlalchemy_form", "dynamic_form"] }, "database_name": { "description": "A database name to identify this connection.", @@ -4724,10 +4449,7 @@ "configuration_method": { "default": "sqlalchemy_form", "description": "Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.", - "enum": [ - "sqlalchemy_form", - "dynamic_form" - ] + "enum": ["sqlalchemy_form", "dynamic_form"] }, "database_name": { "description": "A database name to identify this connection.", @@ -4797,10 +4519,7 @@ }, "configuration_method": { "description": "Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.", - "enum": [ - "sqlalchemy_form", - "dynamic_form" - ] + "enum": ["sqlalchemy_form", "dynamic_form"] }, "database_name": { "description": "A database name to identify this connection.", @@ -4849,10 +4568,7 @@ "type": "string" } }, - "required": [ - "configuration_method", - "engine" - ], + "required": ["configuration_method", "engine"], "type": "object" }, "Dataset": { @@ -5038,10 +4754,7 @@ "type": "string" } }, - "required": [ - "db_name", - "table_name" - ], + "required": ["db_name", "table_name"], "type": "object" }, "DatasetCacheWarmUpResponseSchema": { @@ -5141,9 +4854,7 @@ "type": "string" } }, - "required": [ - "column_name" - ], + "required": ["column_name"], "type": "object" }, "DatasetColumnsRestApi.get": { @@ -5189,10 +4900,7 @@ "type": "string" } }, - "required": [ - "base_model_id", - "table_name" - ], + "required": ["base_model_id", "table_name"], "type": "object" }, "DatasetMetricCurrencyPut": { @@ -5297,10 +5005,7 @@ "type": "string" } }, - "required": [ - "expression", - "metric_name" - ], + "required": ["expression", "metric_name"], "type": "object" }, "DatasetRelatedChart": { @@ -5535,12 +5240,7 @@ "readOnly": true } }, - "required": [ - "columns", - "database", - "metrics", - "table_name" - ], + "required": ["columns", "database", "metrics", "table_name"], "type": "object" }, "DatasetRestApi.get.Database": { @@ -5564,9 +5264,7 @@ "type": "string" } }, - "required": [ - "database_name" - ], + "required": ["database_name"], "type": "object" }, "DatasetRestApi.get.SqlMetric": { @@ -5627,10 +5325,7 @@ "type": "string" } }, - "required": [ - "expression", - "metric_name" - ], + "required": ["expression", "metric_name"], "type": "object" }, "DatasetRestApi.get.TableColumn": { @@ -5708,9 +5403,7 @@ "type": "string" } }, - "required": [ - "column_name" - ], + "required": ["column_name"], "type": "object" }, "DatasetRestApi.get.User": { @@ -5727,10 +5420,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "DatasetRestApi.get.User1": { @@ -5744,10 +5434,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "DatasetRestApi.get.User2": { @@ -5761,10 +5448,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "DatasetRestApi.get_list": { @@ -5835,10 +5519,7 @@ "type": "string" } }, - "required": [ - "database", - "table_name" - ], + "required": ["database", "table_name"], "type": "object" }, "DatasetRestApi.get_list.Database": { @@ -5856,9 +5537,7 @@ "type": "string" } }, - "required": [ - "database_name" - ], + "required": ["database_name"], "type": "object" }, "DatasetRestApi.get_list.User": { @@ -5875,10 +5554,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "DatasetRestApi.get_list.User1": { @@ -5895,10 +5571,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "DatasetRestApi.post": { @@ -5959,10 +5632,7 @@ "type": "string" } }, - "required": [ - "database", - "table_name" - ], + "required": ["database", "table_name"], "type": "object" }, "DatasetRestApi.put": { @@ -6105,13 +5775,7 @@ }, "datasource_type": { "description": "The type of dataset/datasource identified on `datasource_id`.", - "enum": [ - "table", - "dataset", - "query", - "saved_query", - "view" - ], + "enum": ["table", "dataset", "query", "saved_query", "view"], "type": "string" }, "schema": { @@ -6119,9 +5783,7 @@ "type": "string" } }, - "required": [ - "datasource_type" - ], + "required": ["datasource_type"], "type": "object" }, "DistincResponseSchema": { @@ -6157,9 +5819,7 @@ "type": "array" } }, - "required": [ - "allowed_domains" - ], + "required": ["allowed_domains"], "type": "object" }, "EmbeddedDashboardResponseSchema": { @@ -6268,10 +5928,7 @@ "type": "object" } }, - "required": [ - "database_id", - "sql" - ], + "required": ["database_id", "sql"], "type": "object" }, "ExecutePayloadSchema": { @@ -6331,10 +5988,7 @@ "type": "string" } }, - "required": [ - "database_id", - "sql" - ], + "required": ["database_id", "sql"], "type": "object" }, "ExploreContextSchema": { @@ -6372,9 +6026,7 @@ "type": "array" } }, - "required": [ - "formData" - ], + "required": ["formData"], "type": "object" }, "Folder": { @@ -6398,11 +6050,7 @@ "type": "string" }, "type": { - "enum": [ - "metric", - "column", - "folder" - ], + "enum": ["metric", "column", "folder"], "type": "string" }, "uuid": { @@ -6410,9 +6058,7 @@ "type": "string" } }, - "required": [ - "uuid" - ], + "required": ["uuid"], "type": "object" }, "FormDataPostSchema": { @@ -6427,13 +6073,7 @@ }, "datasource_type": { "description": "The datasource type", - "enum": [ - "table", - "dataset", - "query", - "saved_query", - "view" - ], + "enum": ["table", "dataset", "query", "saved_query", "view"], "type": "string" }, "form_data": { @@ -6441,11 +6081,7 @@ "type": "string" } }, - "required": [ - "datasource_id", - "datasource_type", - "form_data" - ], + "required": ["datasource_id", "datasource_type", "form_data"], "type": "object" }, "FormDataPutSchema": { @@ -6460,13 +6096,7 @@ }, "datasource_type": { "description": "The datasource type", - "enum": [ - "table", - "dataset", - "query", - "saved_query", - "view" - ], + "enum": ["table", "dataset", "query", "saved_query", "view"], "type": "string" }, "form_data": { @@ -6474,11 +6104,7 @@ "type": "string" } }, - "required": [ - "datasource_id", - "datasource_type", - "form_data" - ], + "required": ["datasource_id", "datasource_type", "form_data"], "type": "object" }, "FormatQueryPayloadSchema": { @@ -6501,9 +6127,7 @@ "type": "string" } }, - "required": [ - "sql" - ], + "required": ["sql"], "type": "object" }, "GetFavStarIdsSchema": { @@ -6555,10 +6179,7 @@ "type": "string" } }, - "required": [ - "database_id", - "table_name" - ], + "required": ["database_id", "table_name"], "type": "object" }, "GroupApi.get": { @@ -6587,9 +6208,7 @@ "$ref": "#/components/schemas/GroupApi.get.User" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "GroupApi.get.Role": { @@ -6602,9 +6221,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "GroupApi.get.User": { @@ -6617,9 +6234,7 @@ "type": "string" } }, - "required": [ - "username" - ], + "required": ["username"], "type": "object" }, "GroupApi.get_list": { @@ -6648,9 +6263,7 @@ "$ref": "#/components/schemas/GroupApi.get_list.User" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "GroupApi.get_list.Role": { @@ -6663,9 +6276,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "GroupApi.get_list.User": { @@ -6678,9 +6289,7 @@ "type": "string" } }, - "required": [ - "username" - ], + "required": ["username"], "type": "object" }, "GroupApi.post": { @@ -6720,9 +6329,7 @@ "type": "array" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "GroupApi.put": { @@ -6801,9 +6408,7 @@ "type": "array" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "GroupPutSchema": { @@ -6863,10 +6468,7 @@ "$ref": "#/components/schemas/User3" } }, - "required": [ - "resources", - "rls" - ], + "required": ["resources", "rls"], "type": "object" }, "ImportV1Database": { @@ -6892,11 +6494,7 @@ }, "configuration_method": { "default": "sqlalchemy_form", - "enum": [ - "sqlalchemy_form", - "dynamic_form", - null - ], + "enum": ["sqlalchemy_form", "dynamic_form", null], "nullable": true }, "database_name": { @@ -6946,12 +6544,7 @@ "type": "string" } }, - "required": [ - "database_name", - "sqlalchemy_uri", - "uuid", - "version" - ], + "required": ["database_name", "sqlalchemy_uri", "uuid", "version"], "type": "object" }, "ImportV1DatabaseExtra": { @@ -7063,11 +6656,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name", - "username" - ], + "required": ["first_name", "last_name", "username"], "type": "object" }, "LogRestApi.get_list": { @@ -7125,11 +6714,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name", - "username" - ], + "required": ["first_name", "last_name", "username"], "type": "object" }, "LogRestApi.post": { @@ -7172,9 +6757,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "PermissionApi.get_list": { @@ -7187,9 +6770,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "PermissionApi.post": { @@ -7199,9 +6780,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "PermissionApi.put": { @@ -7211,9 +6790,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "PermissionViewMenuApi.get": { @@ -7237,9 +6814,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "PermissionViewMenuApi.get.ViewMenu": { @@ -7249,9 +6824,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "PermissionViewMenuApi.get_list": { @@ -7275,9 +6848,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "PermissionViewMenuApi.get_list.ViewMenu": { @@ -7287,9 +6858,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "PermissionViewMenuApi.post": { @@ -7452,10 +7021,7 @@ "readOnly": true } }, - "required": [ - "client_id", - "database" - ], + "required": ["client_id", "database"], "type": "object" }, "QueryRestApi.get.Database": { @@ -7636,10 +7202,7 @@ }, "filter_type": { "description": "filter_type_description", - "enum": [ - "Regular", - "Base" - ], + "enum": ["Regular", "Base"], "type": "string" }, "group_key": { @@ -7687,10 +7250,7 @@ }, "filter_type": { "description": "filter_type_description", - "enum": [ - "Regular", - "Base" - ], + "enum": ["Regular", "Base"], "type": "string" }, "group_key": { @@ -7733,10 +7293,7 @@ }, "filter_type": { "description": "filter_type_description", - "enum": [ - "Regular", - "Base" - ], + "enum": ["Regular", "Base"], "type": "string" }, "group_key": { @@ -7766,13 +7323,7 @@ "type": "array" } }, - "required": [ - "clause", - "filter_type", - "name", - "roles", - "tables" - ], + "required": ["clause", "filter_type", "name", "roles", "tables"], "type": "object" }, "RLSRestApi.put": { @@ -7788,10 +7339,7 @@ }, "filter_type": { "description": "filter_type_description", - "enum": [ - "Regular", - "Base" - ], + "enum": ["Regular", "Base"], "type": "string" }, "group_key": { @@ -7965,10 +7513,7 @@ "type": "string" } }, - "required": [ - "scheduled_dttm", - "state" - ], + "required": ["scheduled_dttm", "state"], "type": "object" }, "ReportExecutionLogRestApi.get_list": { @@ -8012,10 +7557,7 @@ "type": "string" } }, - "required": [ - "scheduled_dttm", - "state" - ], + "required": ["scheduled_dttm", "state"], "type": "object" }, "ReportExecutionLogRestApi.post": { @@ -8041,18 +7583,11 @@ }, "type": { "description": "The recipient type, check spec for valid options", - "enum": [ - "Email", - "Slack", - "SlackV2", - "Webhook" - ], + "enum": ["Email", "Slack", "SlackV2", "Webhook"], "type": "string" } }, - "required": [ - "type" - ], + "required": ["type"], "type": "object" }, "ReportRecipientConfigJSON": { @@ -8187,12 +7722,7 @@ "type": "integer" } }, - "required": [ - "crontab", - "name", - "recipients", - "type" - ], + "required": ["crontab", "name", "recipients", "type"], "type": "object" }, "ReportScheduleRestApi.get.Dashboard": { @@ -8218,9 +7748,7 @@ "type": "integer" } }, - "required": [ - "database_name" - ], + "required": ["database_name"], "type": "object" }, "ReportScheduleRestApi.get.ReportRecipients": { @@ -8237,9 +7765,7 @@ "type": "string" } }, - "required": [ - "type" - ], + "required": ["type"], "type": "object" }, "ReportScheduleRestApi.get.Slice": { @@ -8274,10 +7800,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ReportScheduleRestApi.get_list": { @@ -8358,12 +7881,7 @@ "type": "string" } }, - "required": [ - "crontab", - "name", - "recipients", - "type" - ], + "required": ["crontab", "name", "recipients", "type"], "type": "object" }, "ReportScheduleRestApi.get_list.ReportRecipients": { @@ -8376,9 +7894,7 @@ "type": "string" } }, - "required": [ - "type" - ], + "required": ["type"], "type": "object" }, "ReportScheduleRestApi.get_list.User": { @@ -8392,10 +7908,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ReportScheduleRestApi.get_list.User1": { @@ -8409,10 +7922,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ReportScheduleRestApi.get_list.User2": { @@ -8429,10 +7939,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ReportScheduleRestApi.post": { @@ -8451,11 +7958,7 @@ }, "creation_method": { "description": "Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.", - "enum": [ - "charts", - "dashboards", - "alerts_reports" - ] + "enum": ["charts", "dashboards", "alerts_reports"] }, "crontab": { "description": "A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.", @@ -8528,12 +8031,7 @@ "type": "array" }, "report_format": { - "enum": [ - "PDF", - "PNG", - "CSV", - "TEXT" - ], + "enum": ["PDF", "PNG", "CSV", "TEXT"], "type": "string" }, "selected_tabs": { @@ -9153,10 +8651,7 @@ }, "type": { "description": "The report schedule type", - "enum": [ - "Alert", - "Report" - ], + "enum": ["Alert", "Report"], "type": "string" }, "validator_config_json": { @@ -9164,10 +8659,7 @@ }, "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" - ], + "enum": ["not null", "operator"], "type": "string" }, "working_timeout": { @@ -9177,11 +8669,7 @@ "type": "integer" } }, - "required": [ - "crontab", - "name", - "type" - ], + "required": ["crontab", "name", "type"], "type": "object" }, "ReportScheduleRestApi.put": { @@ -9200,12 +8688,7 @@ }, "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", - null - ], + "enum": ["charts", "dashboards", "alerts_reports", null], "nullable": true }, "crontab": { @@ -9277,12 +8760,7 @@ "type": "array" }, "report_format": { - "enum": [ - "PDF", - "PNG", - "CSV", - "TEXT" - ], + "enum": ["PDF", "PNG", "CSV", "TEXT"], "type": "string" }, "sql": { @@ -9896,10 +9374,7 @@ }, "type": { "description": "The report schedule type", - "enum": [ - "Alert", - "Report" - ], + "enum": ["Alert", "Report"], "type": "string" }, "validator_config_json": { @@ -9907,11 +9382,7 @@ }, "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", - null - ], + "enum": ["not null", "operator", null], "nullable": true, "type": "string" }, @@ -9931,15 +9402,10 @@ "type": "string" }, "type": { - "enum": [ - "dashboard" - ] + "enum": ["dashboard"] } }, - "required": [ - "id", - "type" - ], + "required": ["id", "type"], "type": "object" }, "RlsRule": { @@ -9951,9 +9417,7 @@ "type": "integer" } }, - "required": [ - "clause" - ], + "required": ["clause"], "type": "object" }, "RoleGroupPutSchema": { @@ -9966,9 +9430,7 @@ "type": "array" } }, - "required": [ - "group_ids" - ], + "required": ["group_ids"], "type": "object" }, "RolePermissionListSchema": { @@ -9995,9 +9457,7 @@ "type": "array" } }, - "required": [ - "permission_view_menu_ids" - ], + "required": ["permission_view_menu_ids"], "type": "object" }, "RoleResponseSchema": { @@ -10033,9 +9493,7 @@ "type": "array" } }, - "required": [ - "user_ids" - ], + "required": ["user_ids"], "type": "object" }, "Roles": { @@ -10171,9 +9629,7 @@ "type": "integer" } }, - "required": [ - "database_name" - ], + "required": ["database_name"], "type": "object" }, "SavedQueryRestApi.get.User": { @@ -10190,10 +9646,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "SavedQueryRestApi.get.User1": { @@ -10210,10 +9663,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "SavedQueryRestApi.get_list": { @@ -10296,9 +9746,7 @@ "type": "integer" } }, - "required": [ - "database_name" - ], + "required": ["database_name"], "type": "object" }, "SavedQueryRestApi.get_list.Tag": { @@ -10312,12 +9760,7 @@ "type": "string" }, "type": { - "enum": [ - 1, - 2, - 3, - 4 - ] + "enum": [1, 2, 3, 4] } }, "type": "object" @@ -10336,10 +9779,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "SavedQueryRestApi.get_list.User1": { @@ -10356,10 +9796,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "SavedQueryRestApi.post": { @@ -10567,11 +10004,7 @@ "type": "string" } }, - "required": [ - "dbId", - "name", - "sql" - ], + "required": ["dbId", "name", "sql"], "type": "object" }, "StopQuerySchema": { @@ -10592,9 +10025,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "SupersetRoleApi.get_list": { @@ -10607,9 +10038,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "SupersetRoleApi.post": { @@ -10619,9 +10048,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "SupersetRoleApi.put": { @@ -10631,9 +10058,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "SupersetUserApi.get": { @@ -10697,12 +10122,7 @@ "type": "string" } }, - "required": [ - "email", - "first_name", - "last_name", - "username" - ], + "required": ["email", "first_name", "last_name", "username"], "type": "object" }, "SupersetUserApi.get.Group": { @@ -10725,9 +10145,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "SupersetUserApi.get.Role": { @@ -10740,9 +10158,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "SupersetUserApi.get.User": { @@ -10822,12 +10238,7 @@ "type": "string" } }, - "required": [ - "email", - "first_name", - "last_name", - "username" - ], + "required": ["email", "first_name", "last_name", "username"], "type": "object" }, "SupersetUserApi.get_list.Group": { @@ -10850,9 +10261,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "SupersetUserApi.get_list.Role": { @@ -10865,9 +10274,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "SupersetUserApi.get_list.User": { @@ -11279,12 +10686,7 @@ "type": "string" }, "type": { - "enum": [ - 1, - 2, - 3, - 4 - ] + "enum": [1, 2, 3, 4] } }, "type": "object" @@ -11298,12 +10700,7 @@ "type": "string" }, "type": { - "enum": [ - 1, - 2, - 3, - 4 - ] + "enum": [1, 2, 3, 4] } }, "type": "object" @@ -11401,12 +10798,7 @@ "type": "string" }, "type": { - "enum": [ - 1, - 2, - 3, - 4 - ] + "enum": [1, 2, 3, 4] } }, "type": "object" @@ -11422,10 +10814,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "TagRestApi.get.User1": { @@ -11439,10 +10828,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "TagRestApi.get_list": { @@ -11472,12 +10858,7 @@ "type": "string" }, "type": { - "enum": [ - 1, - 2, - 3, - 4 - ] + "enum": [1, 2, 3, 4] } }, "type": "object" @@ -11493,10 +10874,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "TagRestApi.get_list.User1": { @@ -11510,10 +10888,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "TagRestApi.post": { @@ -11598,9 +10973,7 @@ "type": "string" } }, - "required": [ - "value" - ], + "required": ["value"], "type": "object" }, "TemporaryCachePutSchema": { @@ -11610,9 +10983,7 @@ "type": "string" } }, - "required": [ - "value" - ], + "required": ["value"], "type": "object" }, "Theme": { @@ -11683,10 +11054,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ThemeRestApi.get.User1": { @@ -11703,10 +11071,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ThemeRestApi.get_list": { @@ -11771,10 +11136,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ThemeRestApi.get_list.User1": { @@ -11791,10 +11153,7 @@ "type": "string" } }, - "required": [ - "first_name", - "last_name" - ], + "required": ["first_name", "last_name"], "type": "object" }, "ThemeRestApi.post": { @@ -11806,10 +11165,7 @@ "type": "string" } }, - "required": [ - "json_data", - "theme_name" - ], + "required": ["json_data", "theme_name"], "type": "object" }, "ThemeRestApi.put": { @@ -11821,10 +11177,7 @@ "type": "string" } }, - "required": [ - "json_data", - "theme_name" - ], + "required": ["json_data", "theme_name"], "type": "object" }, "UploadFileMetadata": { @@ -11871,17 +11224,10 @@ }, "type": { "description": "File type to upload", - "enum": [ - "csv", - "excel", - "columnar" - ] + "enum": ["csv", "excel", "columnar"] } }, - "required": [ - "file", - "type" - ], + "required": ["file", "type"], "type": "object" }, "UploadPostSchema": { @@ -11889,11 +11235,7 @@ "already_exists": { "default": "fail", "description": "What to do if the table already exists accepts: fail, replace, append", - "enum": [ - "fail", - "replace", - "append" - ], + "enum": ["fail", "replace", "append"], "type": "string" }, "column_data_types": { @@ -11988,18 +11330,10 @@ }, "type": { "description": "File type to upload", - "enum": [ - "csv", - "excel", - "columnar" - ] + "enum": ["csv", "excel", "columnar"] } }, - "required": [ - "file", - "table_name", - "type" - ], + "required": ["file", "table_name", "type"], "type": "object" }, "User": { @@ -12101,12 +11435,7 @@ "type": "string" } }, - "required": [ - "email", - "first_name", - "last_name", - "username" - ], + "required": ["email", "first_name", "last_name", "username"], "type": "object" }, "UserRegistrationsRestAPI.post": { @@ -12173,9 +11502,7 @@ "type": "object" } }, - "required": [ - "sql" - ], + "required": ["sql"], "type": "object" }, "ValidateSQLResponse": { @@ -12199,14 +11526,7 @@ "properties": { "op": { "description": "The operation to compare with a threshold to apply to the SQL output\n", - "enum": [ - "<", - "<=", - ">", - ">=", - "==", - "!=" - ], + "enum": ["<", "<=", ">", ">=", "==", "!="], "type": "string" }, "threshold": { @@ -12225,9 +11545,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "ViewMenuApi.get_list": { @@ -12240,9 +11558,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "ViewMenuApi.post": { @@ -12252,9 +11568,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "ViewMenuApi.put": { @@ -12264,9 +11578,7 @@ "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "type": "object" }, "advanced_data_type_convert_schema": { @@ -12283,10 +11595,7 @@ "type": "array" } }, - "required": [ - "type", - "values" - ], + "required": ["type", "values"], "type": "object" }, "database_catalogs_query_schema": { @@ -12323,9 +11632,7 @@ "type": "string" } }, - "required": [ - "schema_name" - ], + "required": ["schema_name"], "type": "object" }, "delete_tags_schema": { @@ -12471,11 +11778,7 @@ ] } }, - "required": [ - "col", - "opr", - "value" - ], + "required": ["col", "opr", "value"], "type": "object" }, "type": "array" @@ -12498,10 +11801,7 @@ "type": "string" }, "order_direction": { - "enum": [ - "asc", - "desc" - ], + "enum": ["asc", "desc"], "type": "string" }, "page": { @@ -12565,9 +11865,7 @@ "type": "number" } }, - "required": [ - "last_updated_ms" - ], + "required": ["last_updated_ms"], "type": "object" }, "screenshot_query_schema": { @@ -12596,9 +11894,7 @@ "type": "string" } }, - "required": [ - "key" - ], + "required": ["key"], "type": "object" }, "thumbnail_query_schema": { @@ -12689,10 +11985,7 @@ "type": "array", "items": { "type": "string", - "enum": [ - "public_channel", - "private_channel" - ] + "enum": ["public_channel", "private_channel"] }, "description": "Types of channels to search." }, @@ -12775,12 +12068,8 @@ "example": { "display_value": "string", "error_message": "string", - "valid_filter_operators": [ - "string" - ], - "values": [ - "string" - ] + "valid_filter_operators": ["string"], + "values": ["string"] } } }, @@ -12808,9 +12097,7 @@ } ], "summary": "Return an AdvancedDataTypeResponse", - "tags": [ - "Advanced Data Type" - ], + "tags": ["Advanced Data Type"], "x-codeSamples": [ { "lang": "cURL", @@ -12848,9 +12135,7 @@ "type": "object" }, "example": { - "result": [ - "string" - ] + "result": ["string"] } } }, @@ -12875,9 +12160,7 @@ } ], "summary": "Return a list of available advanced data types", - "tags": [ - "Advanced Data Type" - ], + "tags": ["Advanced Data Type"], "x-codeSamples": [ { "lang": "cURL", @@ -12950,9 +12233,7 @@ } ], "summary": "Delete multiple annotation layers in a bulk operation", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -13057,22 +12338,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -13097,9 +12370,7 @@ } ], "summary": "Get a list of annotation layers (annotation-layer)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -13179,9 +12450,7 @@ } ], "summary": "Create an annotation layer (annotation-layer)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -13264,13 +12533,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -13295,9 +12560,7 @@ } ], "summary": "Get metadata information about this API resource (annotation-layer--info)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -13374,9 +12637,7 @@ } ], "summary": "Get related fields data (annotation-layer-related-column-name)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -13444,9 +12705,7 @@ } ], "summary": "Delete annotation layer (annotation-layer-pk)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -13549,9 +12808,7 @@ "id": 1, "name": "string" }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -13580,9 +12837,7 @@ } ], "summary": "Get an annotation layer (annotation-layer-pk)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -13673,9 +12928,7 @@ } ], "summary": "Update an annotation layer (annotation-layer-pk)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -13757,9 +13010,7 @@ } ], "summary": "Bulk delete annotation layers", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -13831,12 +13082,8 @@ }, "example": { "count": 1.0, - "ids": [ - "string" - ], - "result": [ - {} - ] + "ids": ["string"], + "result": [{}] } } }, @@ -13861,9 +13108,7 @@ } ], "summary": "Get a list of annotation layers (annotation-layer-pk-annotation)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -13960,9 +13205,7 @@ } ], "summary": "Create an annotation layer (annotation-layer-pk-annotation)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -14039,9 +13282,7 @@ } ], "summary": "Delete annotation layer (annotation-layer-pk-annotation-annotation-id)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -14145,9 +13386,7 @@ } ], "summary": "Get an annotation layer (annotation-layer-pk-annotation-annotation-id)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -14253,9 +13492,7 @@ } ], "summary": "Update an annotation layer (annotation-layer-pk-annotation-annotation-id)", - "tags": [ - "Annotation Layers" - ], + "tags": ["Annotation Layers"], "x-codeSamples": [ { "lang": "cURL", @@ -14306,9 +13543,7 @@ } ], "summary": "Export all assets", - "tags": [ - "Import/export" - ], + "tags": ["Import/export"], "x-codeSamples": [ { "lang": "cURL", @@ -14405,9 +13640,7 @@ } ], "summary": "Import multiple assets", - "tags": [ - "Import/export" - ], + "tags": ["Import/export"], "x-codeSamples": [ { "lang": "cURL", @@ -14511,9 +13744,7 @@ } ], "summary": "Read off of the Redis events stream", - "tags": [ - "AsyncEventsRestApi" - ], + "tags": ["AsyncEventsRestApi"], "x-codeSamples": [ { "lang": "cURL", @@ -14569,9 +13800,7 @@ } ], "summary": "Get all available domains", - "tags": [ - "Available Domains" - ], + "tags": ["Available Domains"], "x-codeSamples": [ { "lang": "cURL", @@ -14601,12 +13830,8 @@ "$ref": "#/components/schemas/CacheInvalidationRequestSchema" }, "example": { - "datasource_uids": [ - "string" - ], - "datasources": [ - {} - ] + "datasource_uids": ["string"], + "datasources": [{}] } } }, @@ -14630,9 +13855,7 @@ } ], "summary": "Invalidate cache records and remove the database records", - "tags": [ - "CacheRestApi" - ], + "tags": ["CacheRestApi"], "x-codeSamples": [ { "lang": "cURL", @@ -14708,9 +13931,7 @@ } ], "summary": "Bulk delete charts", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -14815,22 +14036,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -14855,9 +14068,7 @@ } ], "summary": "Get a list of charts", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -14887,28 +14098,20 @@ "cache_timeout": 1, "certification_details": "string", "certified_by": "string", - "dashboards": [ - 1 - ], + "dashboards": [1], "datasource_id": 1, "datasource_name": "string", "datasource_type": "table", "description": "string", "external_url": "string", "is_managed_externally": true, - "owners": [ - 1 - ], + "owners": [1], "params": "string", "query_context": "string", "query_context_generation": true, "slice_name": "string", "uuid": "550e8400-e29b-41d4-a716-446655440000", - "viz_type": [ - "bar", - "area", - "table" - ] + "viz_type": ["bar", "area", "table"] } } }, @@ -14949,11 +14152,7 @@ "query_context_generation": true, "slice_name": "string", "uuid": "550e8400-e29b-41d4-a716-446655440000", - "viz_type": [ - "bar", - "area", - "table" - ] + "viz_type": ["bar", "area", "table"] } } } @@ -14982,9 +14181,7 @@ } ], "summary": "Create a new chart", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -15067,13 +14264,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -15098,9 +14291,7 @@ } ], "summary": "Get metadata information about this API resource (chart--info)", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -15137,9 +14328,7 @@ }, "force": true, "form_data": {}, - "queries": [ - {} - ], + "queries": [{}], "result_format": {}, "result_type": {} } @@ -15195,9 +14384,7 @@ } ], "summary": "Return payload data response for the given query (chart-data)", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -15266,9 +14453,7 @@ } ], "summary": "Return payload data response for the given query (chart-data-cache-key)", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -15334,9 +14519,7 @@ } ], "summary": "Download multiple charts as YAML files", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -15404,9 +14587,7 @@ } ], "summary": "Check favorited charts for current user", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -15503,9 +14684,7 @@ } ], "summary": "Import chart(s) with associated datasets and databases", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -15583,9 +14762,7 @@ } ], "summary": "Get related fields data (chart-related-column-name)", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -15654,9 +14831,7 @@ } ], "summary": "Warm up the cache for the chart", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -15751,9 +14926,7 @@ } ], "summary": "Get a chart detail information", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -15826,9 +14999,7 @@ } ], "summary": "Delete a chart", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -15868,30 +15039,20 @@ "cache_timeout": 1, "certification_details": "string", "certified_by": "string", - "dashboards": [ - 1 - ], + "dashboards": [1], "datasource_id": 1, "datasource_type": "table", "description": "string", "external_url": "string", "is_managed_externally": true, - "owners": [ - 1 - ], + "owners": [1], "params": "string", "query_context": "string", "query_context_generation": true, "slice_name": "string", - "tags": [ - 1 - ], + "tags": [1], "uuid": "550e8400-e29b-41d4-a716-446655440000", - "viz_type": [ - "bar", - "area", - "table" - ] + "viz_type": ["bar", "area", "table"] } } }, @@ -15932,11 +15093,7 @@ "slice_name": "string", "tags": [], "uuid": "550e8400-e29b-41d4-a716-446655440000", - "viz_type": [ - "bar", - "area", - "table" - ] + "viz_type": ["bar", "area", "table"] } } } @@ -15968,9 +15125,7 @@ } ], "summary": "Update a chart", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -16067,9 +15222,7 @@ } ], "summary": "Compute and cache a screenshot (chart-pk-cache-screenshot)", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -16174,9 +15327,7 @@ } ], "summary": "Return payload data response for a chart", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -16243,9 +15394,7 @@ } ], "summary": "Remove the chart from the user favorite list", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -16310,9 +15459,7 @@ } ], "summary": "Mark the chart as favorite for the current user", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -16383,9 +15530,7 @@ } ], "summary": "Get a computed screenshot from cache (chart-pk-screenshot-digest)", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -16461,9 +15606,7 @@ } ], "summary": "Get chart thumbnail", - "tags": [ - "Charts" - ], + "tags": ["Charts"], "x-codeSamples": [ { "lang": "cURL", @@ -16536,9 +15679,7 @@ } ], "summary": "Bulk delete CSS templates", - "tags": [ - "CSS Templates" - ], + "tags": ["CSS Templates"], "x-codeSamples": [ { "lang": "cURL", @@ -16643,22 +15784,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -16683,9 +15816,7 @@ } ], "summary": "Get a list of CSS templates", - "tags": [ - "CSS Templates" - ], + "tags": ["CSS Templates"], "x-codeSamples": [ { "lang": "cURL", @@ -16765,9 +15896,7 @@ } ], "summary": "Create a CSS template", - "tags": [ - "CSS Templates" - ], + "tags": ["CSS Templates"], "x-codeSamples": [ { "lang": "cURL", @@ -16850,13 +15979,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -16881,9 +16006,7 @@ } ], "summary": "Get metadata information about this API resource (css-template--info)", - "tags": [ - "CSS Templates" - ], + "tags": ["CSS Templates"], "x-codeSamples": [ { "lang": "cURL", @@ -16960,9 +16083,7 @@ } ], "summary": "Get related fields data (css-template-related-column-name)", - "tags": [ - "CSS Templates" - ], + "tags": ["CSS Templates"], "x-codeSamples": [ { "lang": "cURL", @@ -17029,9 +16150,7 @@ } ], "summary": "Delete a CSS template", - "tags": [ - "CSS Templates" - ], + "tags": ["CSS Templates"], "x-codeSamples": [ { "lang": "cURL", @@ -17135,9 +16254,7 @@ "id": 1, "template_name": "string" }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -17166,9 +16283,7 @@ } ], "summary": "Get a CSS template", - "tags": [ - "CSS Templates" - ], + "tags": ["CSS Templates"], "x-codeSamples": [ { "lang": "cURL", @@ -17257,9 +16372,7 @@ } ], "summary": "Update a CSS template", - "tags": [ - "CSS Templates" - ], + "tags": ["CSS Templates"], "x-codeSamples": [ { "lang": "cURL", @@ -17335,9 +16448,7 @@ } ], "summary": "Bulk delete dashboards", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -17397,12 +16508,8 @@ }, "example": { "count": 1, - "ids": [ - 1 - ], - "result": [ - {} - ] + "ids": [1], + "result": [{}] } } }, @@ -17427,9 +16534,7 @@ } ], "summary": "Get a list of dashboards", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -17463,14 +16568,10 @@ "external_url": "string", "is_managed_externally": true, "json_metadata": "string", - "owners": [ - 1 - ], + "owners": [1], "position_json": "string", "published": true, - "roles": [ - 1 - ], + "roles": [1], "slug": "string", "theme_id": 1, "uuid": "550e8400-e29b-41d4-a716-446655440000" @@ -17537,9 +16638,7 @@ } ], "summary": "Create a new dashboard", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -17622,13 +16721,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -17653,9 +16748,7 @@ } ], "summary": "Get metadata information about this API resource (dashboard--info)", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -17723,9 +16816,7 @@ } ], "summary": "Download multiple dashboards as YAML files", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -17793,9 +16884,7 @@ } ], "summary": "Check favorited dashboards for current user", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -17892,9 +16981,7 @@ } ], "summary": "Import dashboard(s) with associated charts/datasets/databases", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -17968,9 +17055,7 @@ } ], "summary": "Get dashboard's permanent link state", - "tags": [ - "Dashboard Permanent Link" - ], + "tags": ["Dashboard Permanent Link"], "x-codeSamples": [ { "lang": "cURL", @@ -18048,9 +17133,7 @@ } ], "summary": "Get related fields data (dashboard-related-column-name)", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -18145,9 +17228,7 @@ } ], "summary": "Get a dashboard detail information", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -18195,9 +17276,7 @@ "type": "object" }, "example": { - "result": [ - {} - ] + "result": [{}] } } }, @@ -18222,9 +17301,7 @@ } ], "summary": "Get a dashboard's chart definitions.", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -18318,9 +17395,7 @@ } ], "summary": "Create a copy of an existing dashboard", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -18370,9 +17445,7 @@ "type": "object" }, "example": { - "result": [ - {} - ] + "result": [{}] } } }, @@ -18397,9 +17470,7 @@ } ], "summary": "Get dashboard's datasets", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -18464,9 +17535,7 @@ } ], "summary": "Delete a dashboard's embedded configuration", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -18534,9 +17603,7 @@ } ], "summary": "Get the dashboard's embedded configuration", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -18574,9 +17641,7 @@ "$ref": "#/components/schemas/EmbeddedDashboardConfig" }, "example": { - "allowed_domains": [ - "string" - ] + "allowed_domains": ["string"] } } }, @@ -18620,9 +17685,7 @@ } ], "summary": "Set a dashboard's embedded configuration", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -18661,9 +17724,7 @@ "$ref": "#/components/schemas/EmbeddedDashboardConfig" }, "example": { - "allowed_domains": [ - "string" - ] + "allowed_domains": ["string"] } } }, @@ -18706,9 +17767,7 @@ "jwt": [] } ], - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "operationId": "update_dashboard_by_id_or_slug_embedded", "summary": "Update dashboard by id_or_slug embedded", "x-codeSamples": [ @@ -18785,9 +17844,7 @@ } ], "summary": "Get dashboard's tabs", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -18860,9 +17917,7 @@ } ], "summary": "Delete a dashboard", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -18906,18 +17961,12 @@ "external_url": "string", "is_managed_externally": true, "json_metadata": "string", - "owners": [ - 1 - ], + "owners": [1], "position_json": "string", "published": true, - "roles": [ - 1 - ], + "roles": [1], "slug": "string", - "tags": [ - 1 - ], + "tags": [1], "theme_id": 1, "uuid": "550e8400-e29b-41d4-a716-446655440000" } @@ -18994,9 +18043,7 @@ } ], "summary": "Update a dashboard", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -19035,9 +18082,7 @@ "$ref": "#/components/schemas/DashboardScreenshotPostSchema" }, "example": { - "activeTabs": [ - "string" - ], + "activeTabs": ["string"], "anchor": "string", "dataMask": {}, "urlParams": [] @@ -19082,9 +18127,7 @@ } ], "summary": "Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -19123,15 +18166,9 @@ "$ref": "#/components/schemas/DashboardChartCustomizationsConfigUpdateSchema" }, "example": { - "deleted": [ - "string" - ], - "modified": [ - {} - ], - "reordered": [ - "string" - ] + "deleted": ["string"], + "modified": [{}], + "reordered": ["string"] } } }, @@ -19182,9 +18219,7 @@ } ], "summary": "Update chart customizations configuration for a dashboard.", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -19242,9 +18277,7 @@ "label_colors": { "key": "value" }, - "color_scheme_domain": [ - "string" - ] + "color_scheme_domain": ["string"] } } }, @@ -19295,9 +18328,7 @@ } ], "summary": "Update colors configuration for a dashboard.", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -19379,9 +18410,7 @@ } ], "summary": "Export dashboard as example bundle", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -19448,9 +18477,7 @@ } ], "summary": "Remove the dashboard from the user favorite list", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -19515,9 +18542,7 @@ } ], "summary": "Mark the dashboard as favorite for the current user", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -19569,25 +18594,18 @@ { "col": "tz_offset", "op": ">=", - "val": [ - 1000 - ] + "val": [1000] }, { "col": "tz_offset", "op": "<=", - "val": [ - 2000 - ] + "val": [2000] } ] }, "filterState": { "label": "1000 <= x <= 2000", - "value": [ - 1000, - 2000 - ] + "value": [1000, 2000] }, "id": "NATIVE_FILTER_ID" } @@ -19601,9 +18619,7 @@ }, "filterState": { "label": "Week ending Saturday", - "value": [ - "P1W/1970-01-03T00:00:00Z" - ] + "value": ["P1W/1970-01-03T00:00:00Z"] }, "id": "NATIVE_FILTER_ID" } @@ -19629,9 +18645,7 @@ "granularity_sqla": "order_date" }, "filterState": { - "value": [ - "order_date" - ] + "value": ["order_date"] }, "id": "NATIVE_FILTER_ID" } @@ -19645,16 +18659,12 @@ { "col": "real_name", "op": "IN", - "val": [ - "John Doe" - ] + "val": ["John Doe"] } ] }, "filterState": { - "value": [ - "John Doe" - ] + "value": ["John Doe"] }, "id": "NATIVE_FILTER_ID" } @@ -19709,9 +18719,7 @@ } ], "summary": "Create a dashboard's filter state", - "tags": [ - "Dashboard Filter State" - ], + "tags": ["Dashboard Filter State"], "x-codeSamples": [ { "lang": "cURL", @@ -19794,9 +18802,7 @@ } ], "summary": "Delete a dashboard's filter state value", - "tags": [ - "Dashboard Filter State" - ], + "tags": ["Dashboard Filter State"], "x-codeSamples": [ { "lang": "cURL", @@ -19876,9 +18882,7 @@ } ], "summary": "Get a dashboard's filter state value", - "tags": [ - "Dashboard Filter State" - ], + "tags": ["Dashboard Filter State"], "x-codeSamples": [ { "lang": "cURL", @@ -19978,9 +18982,7 @@ } ], "summary": "Update a dashboard's filter state value", - "tags": [ - "Dashboard Filter State" - ], + "tags": ["Dashboard Filter State"], "x-codeSamples": [ { "lang": "cURL", @@ -20019,15 +19021,9 @@ "$ref": "#/components/schemas/DashboardNativeFiltersConfigUpdateSchema" }, "example": { - "deleted": [ - "string" - ], - "modified": [ - {} - ], - "reordered": [ - "string" - ] + "deleted": ["string"], + "modified": [{}], + "reordered": ["string"] } } }, @@ -20078,9 +19074,7 @@ } ], "summary": "Update native filters configuration for a dashboard.", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -20125,25 +19119,18 @@ { "col": "tz_offset", "op": ">=", - "val": [ - 1000 - ] + "val": [1000] }, { "col": "tz_offset", "op": "<=", - "val": [ - 2000 - ] + "val": [2000] } ] }, "filterState": { "label": "1000 <= x <= 200", - "value": [ - 1000, - 2000 - ] + "value": [1000, 2000] }, "id": "NATIVE_FILTER_ID" } @@ -20158,9 +19145,7 @@ }, "filterState": { "label": "Week ending Saturday", - "value": [ - "P1W/1970-01-03T00:00:00Z" - ] + "value": ["P1W/1970-01-03T00:00:00Z"] }, "id": "NATIVE_FILTER_ID" } @@ -20188,9 +19173,7 @@ "granularity_sqla": "order_date" }, "filterState": { - "value": [ - "order_date" - ] + "value": ["order_date"] }, "id": "NATIVE_FILTER_ID" } @@ -20205,16 +19188,12 @@ { "col": "real_name", "op": "IN", - "val": [ - "John Doe" - ] + "val": ["John Doe"] } ] }, "filterState": { - "value": [ - "John Doe" - ] + "value": ["John Doe"] }, "id": "NATIVE_FILTER_ID" } @@ -20225,15 +19204,11 @@ "$ref": "#/components/schemas/DashboardPermalinkStateSchema" }, "example": { - "activeTabs": [ - "string" - ], + "activeTabs": ["string"], "anchor": "string", "chartStates": {}, "dataMask": {}, - "urlParams": [ - {} - ] + "urlParams": [{}] } } }, @@ -20283,9 +19258,7 @@ } ], "summary": "Create a new dashboard's permanent link", - "tags": [ - "Dashboard Permanent Link" - ], + "tags": ["Dashboard Permanent Link"], "x-codeSamples": [ { "lang": "cURL", @@ -20328,10 +19301,7 @@ "in": "query", "name": "download_format", "schema": { - "enum": [ - "png", - "pdf" - ], + "enum": ["png", "pdf"], "type": "string" } } @@ -20367,9 +19337,7 @@ } ], "summary": "Get a computed screenshot from cache (dashboard-pk-screenshot-digest)", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -20463,9 +19431,7 @@ } ], "summary": "Get dashboard's thumbnail", - "tags": [ - "Dashboards" - ], + "tags": ["Dashboards"], "x-codeSamples": [ { "lang": "cURL", @@ -20572,22 +19538,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -20612,9 +19570,7 @@ } ], "summary": "Get a list of databases", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -20734,9 +19690,7 @@ } ], "summary": "Create a new database", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -20819,13 +19773,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -20850,9 +19800,7 @@ } ], "summary": "Get metadata information about this API resource (database--info)", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -20933,9 +19881,7 @@ }, "example": [ { - "available_drivers": [ - "string" - ], + "available_drivers": ["string"], "default_driver": "string", "engine": "string", "engine_information": { @@ -20965,9 +19911,7 @@ } ], "summary": "Get names of databases currently available", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21030,9 +19974,7 @@ } ], "summary": "Download database(s) and associated dataset(s) as a zip file", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21129,9 +20071,7 @@ } ], "summary": "Import database(s) with associated datasets", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21211,9 +20151,7 @@ } ], "summary": "Receive personal access tokens from OAuth2", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21290,9 +20228,7 @@ } ], "summary": "Get related fields data (database-related-column-name)", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21373,9 +20309,7 @@ } ], "summary": "Test a database connection", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21447,9 +20381,7 @@ } ], "summary": "Upload a file and returns file metadata", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21534,9 +20466,7 @@ } ], "summary": "Validate database connection parameters", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21609,9 +20539,7 @@ } ], "summary": "Delete a database", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21672,9 +20600,7 @@ } ], "summary": "Get a database", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21810,9 +20736,7 @@ } ], "summary": "Change a database", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21864,9 +20788,7 @@ "$ref": "#/components/schemas/CatalogsResponseSchema" }, "example": { - "result": [ - "string" - ] + "result": ["string"] } } }, @@ -21891,9 +20813,7 @@ } ], "summary": "Get all catalogs from a database", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -21982,9 +20902,7 @@ } ], "summary": "Get a database connection info", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22024,9 +20942,7 @@ "$ref": "#/components/schemas/DatabaseFunctionNamesResponse" }, "example": { - "function_names": [ - "string" - ] + "function_names": ["string"] } } }, @@ -22048,9 +20964,7 @@ } ], "summary": "Get function names supported by a database", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22113,9 +21027,7 @@ } ], "summary": "Get charts and dashboards count associated to a database", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22167,9 +21079,7 @@ "$ref": "#/components/schemas/SchemasResponseSchema" }, "example": { - "result": [ - "string" - ] + "result": ["string"] } } }, @@ -22194,9 +21104,7 @@ } ], "summary": "Get all schemas from a database", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22236,9 +21144,7 @@ "$ref": "#/components/schemas/DatabaseSchemaAccessForFileUploadResponse" }, "example": { - "schemas": [ - "string" - ] + "schemas": ["string"] } } }, @@ -22260,9 +21166,7 @@ } ], "summary": "The list of the database schemas where to upload information", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22349,9 +21253,7 @@ } ], "summary": "Get database select star for table (database-pk-select-star-table-name)", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22438,9 +21340,7 @@ } ], "summary": "Get database select star for table (database-pk-select-star-table-name-schema-name)", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22511,9 +21411,7 @@ } ], "summary": "Re-sync all permissions for a database connection", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22605,9 +21503,7 @@ } ], "summary": "Get database table metadata", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22697,9 +21593,7 @@ } ], "summary": "Get table extra metadata (database-pk-table-extra-table-name-schema-name)", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22790,9 +21684,7 @@ } ], "summary": "Get table metadata", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22883,9 +21775,7 @@ } ], "summary": "Get table extra metadata (database-pk-table-metadata-extra)", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -22950,9 +21840,7 @@ }, "example": { "count": 1, - "result": [ - {} - ] + "result": [{}] } } }, @@ -22980,9 +21868,7 @@ } ], "summary": "Get a list of tables for given database", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -23065,9 +21951,7 @@ } ], "summary": "Upload a file to a database table", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -23134,9 +22018,7 @@ "type": "object" }, "example": { - "result": [ - {} - ] + "result": [{}] } } }, @@ -23161,9 +22043,7 @@ } ], "summary": "Validate arbitrary SQL", - "tags": [ - "Database" - ], + "tags": ["Database"], "x-codeSamples": [ { "lang": "cURL", @@ -23242,9 +22122,7 @@ } ], "summary": "Bulk delete datasets", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -23349,22 +22227,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -23389,9 +22259,7 @@ } ], "summary": "Get a list of datasets", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -23424,9 +22292,7 @@ "external_url": "string", "is_managed_externally": true, "normalize_columns": true, - "owners": [ - 1 - ], + "owners": [1], "schema": "string", "sql": "string", "table_name": "string", @@ -23493,9 +22359,7 @@ } ], "summary": "Create a new dataset", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -23578,13 +22442,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -23609,9 +22469,7 @@ } ], "summary": "Get metadata information about this API resource (dataset--info)", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -23688,9 +22546,7 @@ } ], "summary": "Get distinct values from field data (dataset-distinct-column-name)", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -23778,9 +22634,7 @@ } ], "summary": "Duplicate a dataset", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -23845,9 +22699,7 @@ } ], "summary": "Download multiple datasets as YAML files", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -23933,9 +22785,7 @@ } ], "summary": "Retrieve a table by name, or create it if it does not exist", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -24040,9 +22890,7 @@ } ], "summary": "Import dataset(s) with associated databases", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -24119,9 +22967,7 @@ } ], "summary": "Get related fields data (dataset-related-column-name)", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -24191,9 +23037,7 @@ } ], "summary": "Warm up the cache for each chart powered by the given table", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -24327,9 +23171,7 @@ } ], "summary": "Get a dataset", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -24392,9 +23234,7 @@ } ], "summary": "Get charts and dashboards count associated to a dataset", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -24467,9 +23307,7 @@ } ], "summary": "Delete a dataset", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -24516,9 +23354,7 @@ "always_filter_main_dttm": true, "cache_timeout": 1, "catalog": "string", - "columns": [ - {} - ], + "columns": [{}], "currency_code_column": "string", "database_id": 1, "default_endpoint": "string", @@ -24527,20 +23363,14 @@ "extra": "string", "fetch_values_predicate": "string", "filter_select_enabled": true, - "folders": [ - {} - ], + "folders": [{}], "is_managed_externally": true, "is_sqllab_view": true, "main_dttm_col": "string", - "metrics": [ - {} - ], + "metrics": [{}], "normalize_columns": true, "offset": 1, - "owners": [ - 1 - ], + "owners": [1], "schema": "string", "sql": "string", "table_name": "string", @@ -24626,9 +23456,7 @@ } ], "summary": "Update a dataset", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -24711,9 +23539,7 @@ } ], "summary": "Delete a dataset column", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -24787,9 +23613,7 @@ } ], "summary": "Get dataset drill info", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -24872,9 +23696,7 @@ } ], "summary": "Delete a dataset metric", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -24947,9 +23769,7 @@ } ], "summary": "Refresh and update columns of a dataset", - "tags": [ - "Datasets" - ], + "tags": ["Datasets"], "x-codeSamples": [ { "lang": "cURL", @@ -25032,9 +23852,7 @@ "type": "object" }, "example": { - "result": [ - {} - ] + "result": [{}] } } }, @@ -25062,9 +23880,7 @@ } ], "summary": "Get possible values for a datasource column", - "tags": [ - "Datasources" - ], + "tags": ["Datasources"], "x-codeSamples": [ { "lang": "cURL", @@ -25113,10 +23929,7 @@ "properties": { "clause": { "description": "SQL clause type for filter expressions", - "enum": [ - "WHERE", - "HAVING" - ], + "enum": ["WHERE", "HAVING"], "type": "string" }, "expression": { @@ -25126,18 +23939,11 @@ "expression_type": { "default": "where", "description": "The type of SQL expression", - "enum": [ - "column", - "metric", - "where", - "having" - ], + "enum": ["column", "metric", "where", "having"], "type": "string" } }, - "required": [ - "expression" - ], + "required": ["expression"], "type": "object" }, "example": { @@ -25215,9 +24021,7 @@ } ], "summary": "Validate a SQL expression against a datasource", - "tags": [ - "Datasources" - ], + "tags": ["Datasources"], "x-codeSamples": [ { "lang": "cURL", @@ -25335,9 +24139,7 @@ } ], "summary": "Get a report schedule log (embedded-dashboard-uuid)", - "tags": [ - "Embedded Dashboard" - ], + "tags": ["Embedded Dashboard"], "x-codeSamples": [ { "lang": "cURL", @@ -25436,9 +24238,7 @@ } ], "summary": "Assemble Explore related information in a single endpoint", - "tags": [ - "Explore" - ], + "tags": ["Explore"], "x-codeSamples": [ { "lang": "cURL", @@ -25524,9 +24324,7 @@ } ], "summary": "Create a new form_data", - "tags": [ - "Explore Form Data" - ], + "tags": ["Explore Form Data"], "x-codeSamples": [ { "lang": "cURL", @@ -25601,9 +24399,7 @@ } ], "summary": "Delete a form_data", - "tags": [ - "Explore Form Data" - ], + "tags": ["Explore Form Data"], "x-codeSamples": [ { "lang": "cURL", @@ -25675,9 +24471,7 @@ } ], "summary": "Get a form_data", - "tags": [ - "Explore Form Data" - ], + "tags": ["Explore Form Data"], "x-codeSamples": [ { "lang": "cURL", @@ -25772,9 +24566,7 @@ } ], "summary": "Update an existing form_data", - "tags": [ - "Explore Form Data" - ], + "tags": ["Explore Form Data"], "x-codeSamples": [ { "lang": "cURL", @@ -25804,9 +24596,7 @@ }, "example": { "formData": {}, - "urlParams": [ - {} - ] + "urlParams": [{}] } } }, @@ -25856,9 +24646,7 @@ } ], "summary": "Create a new permanent link (explore-permalink)", - "tags": [ - "Explore Permanent Link" - ], + "tags": ["Explore Permanent Link"], "x-codeSamples": [ { "lang": "cURL", @@ -25932,9 +24720,7 @@ } ], "summary": "Get chart's permanent link state", - "tags": [ - "Explore Permanent Link" - ], + "tags": ["Explore Permanent Link"], "x-codeSamples": [ { "lang": "cURL", @@ -26041,22 +24827,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -26081,9 +24859,7 @@ } ], "summary": "Get a list of logs", - "tags": [ - "LogRestApi" - ], + "tags": ["LogRestApi"], "x-codeSamples": [ { "lang": "cURL", @@ -26160,9 +24936,7 @@ "jwt": [] } ], - "tags": [ - "LogRestApi" - ], + "tags": ["LogRestApi"], "operationId": "create_log", "summary": "Create log", "x-codeSamples": [ @@ -26241,9 +25015,7 @@ } ], "summary": "Get recent activity data for a user", - "tags": [ - "LogRestApi" - ], + "tags": ["LogRestApi"], "x-codeSamples": [ { "lang": "cURL", @@ -26353,9 +25125,7 @@ "slice_id": 1, "user_id": {} }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -26384,9 +25154,7 @@ } ], "summary": "Get a log detail information", - "tags": [ - "LogRestApi" - ], + "tags": ["LogRestApi"], "x-codeSamples": [ { "lang": "cURL", @@ -26447,9 +25215,7 @@ } ], "summary": "Get the user object", - "tags": [ - "Current User" - ], + "tags": ["Current User"], "x-codeSamples": [ { "lang": "cURL", @@ -26526,9 +25292,7 @@ } ], "summary": "Update the current user", - "tags": [ - "Current User" - ], + "tags": ["Current User"], "x-codeSamples": [ { "lang": "cURL", @@ -26589,9 +25353,7 @@ } ], "summary": "Get the user roles", - "tags": [ - "Current User" - ], + "tags": ["Current User"], "x-codeSamples": [ { "lang": "cURL", @@ -26678,9 +25440,7 @@ "jwt": [] } ], - "tags": [ - "Menu" - ], + "tags": ["Menu"], "operationId": "get_menu", "summary": "Get menu", "x-codeSamples": [ @@ -26789,22 +25549,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -26829,9 +25581,7 @@ } ], "summary": "Get a list of queries", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -26908,9 +25658,7 @@ } ], "summary": "Get distinct values from field data (query-distinct-column-name)", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -26987,9 +25735,7 @@ } ], "summary": "Get related fields data (query-related-column-name)", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -27063,9 +25809,7 @@ } ], "summary": "Manually stop a query with client_id", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -27117,9 +25861,7 @@ "type": "object" }, "example": { - "result": [ - {} - ] + "result": [{}] } } }, @@ -27144,9 +25886,7 @@ } ], "summary": "Get a list of queries that changed after last_updated_ms", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -27272,9 +26012,7 @@ "tmp_table_name": "string", "tracking_url": {} }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -27303,9 +26041,7 @@ } ], "summary": "Get query detail information", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -27381,9 +26117,7 @@ } ], "summary": "Bulk delete report schedules", - "tags": [ - "Report Schedules" - ], + "tags": ["Report Schedules"], "x-codeSamples": [ { "lang": "cURL", @@ -27488,22 +26222,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -27528,9 +26254,7 @@ } ], "summary": "Get a list of report schedules", - "tags": [ - "Report Schedules" - ], + "tags": ["Report Schedules"], "x-codeSamples": [ { "lang": "cURL", @@ -27572,16 +26296,10 @@ "grace_period": 14400, "log_retention": 90, "name": "Daily dashboard email", - "owners": [ - 1 - ], - "recipients": [ - {} - ], + "owners": [1], + "recipients": [{}], "report_format": "PDF", - "selected_tabs": [ - 1 - ], + "selected_tabs": [1], "sql": "SELECT value FROM time_series_table", "timezone": "Africa/Abidjan", "type": "Alert", @@ -27667,9 +26385,7 @@ } ], "summary": "Create a report schedule", - "tags": [ - "Report Schedules" - ], + "tags": ["Report Schedules"], "x-codeSamples": [ { "lang": "cURL", @@ -27752,13 +26468,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -27783,9 +26495,7 @@ } ], "summary": "Get metadata information about this API resource (report--info)", - "tags": [ - "Report Schedules" - ], + "tags": ["Report Schedules"], "x-codeSamples": [ { "lang": "cURL", @@ -27862,9 +26572,7 @@ } ], "summary": "Get related fields data (report-related-column-name)", - "tags": [ - "Report Schedules" - ], + "tags": ["Report Schedules"], "x-codeSamples": [ { "lang": "cURL", @@ -27957,9 +26665,7 @@ } ], "summary": "Get slack channels", - "tags": [ - "Report Schedules" - ], + "tags": ["Report Schedules"], "x-codeSamples": [ { "lang": "cURL", @@ -28030,9 +26736,7 @@ } ], "summary": "Delete a report schedule", - "tags": [ - "Report Schedules" - ], + "tags": ["Report Schedules"], "x-codeSamples": [ { "lang": "cURL", @@ -28156,9 +26860,7 @@ "validator_type": "string", "working_timeout": 1 }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -28187,9 +26889,7 @@ } ], "summary": "Get a report schedule", - "tags": [ - "Report Schedules" - ], + "tags": ["Report Schedules"], "x-codeSamples": [ { "lang": "cURL", @@ -28242,12 +26942,8 @@ "grace_period": 14400, "log_retention": 90, "name": "string", - "owners": [ - 1 - ], - "recipients": [ - {} - ], + "owners": [1], + "recipients": [{}], "report_format": "PDF", "sql": "SELECT value FROM time_series_table", "timezone": "Africa/Abidjan", @@ -28336,9 +27032,7 @@ } ], "summary": "Update a report schedule", - "tags": [ - "Report Schedules" - ], + "tags": ["Report Schedules"], "x-codeSamples": [ { "lang": "cURL", @@ -28412,12 +27106,8 @@ }, "example": { "count": 1.0, - "ids": [ - "string" - ], - "result": [ - {} - ] + "ids": ["string"], + "result": [{}] } } }, @@ -28442,9 +27132,7 @@ } ], "summary": "Get a list of report schedule logs", - "tags": [ - "Report Schedules" - ], + "tags": ["Report Schedules"], "x-codeSamples": [ { "lang": "cURL", @@ -28553,9 +27241,7 @@ } ], "summary": "Get a report schedule log (report-pk-log-log-id)", - "tags": [ - "Report Schedules" - ], + "tags": ["Report Schedules"], "x-codeSamples": [ { "lang": "cURL", @@ -28631,9 +27317,7 @@ } ], "summary": "Bulk delete RLS rules", - "tags": [ - "Row Level Security" - ], + "tags": ["Row Level Security"], "x-codeSamples": [ { "lang": "cURL", @@ -28738,22 +27422,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -28778,9 +27454,7 @@ } ], "summary": "Get a list of RLS", - "tags": [ - "Row Level Security" - ], + "tags": ["Row Level Security"], "x-codeSamples": [ { "lang": "cURL", @@ -28812,12 +27486,8 @@ "filter_type": "Regular", "group_key": "string", "name": "string", - "roles": [ - 1 - ], - "tables": [ - 1 - ] + "roles": [1], + "tables": [1] } } }, @@ -28877,9 +27547,7 @@ } ], "summary": "Create a new RLS rule", - "tags": [ - "Row Level Security" - ], + "tags": ["Row Level Security"], "x-codeSamples": [ { "lang": "cURL", @@ -28962,13 +27630,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -28993,9 +27657,7 @@ } ], "summary": "Get metadata information about this API resource (rowlevelsecurity--info)", - "tags": [ - "Row Level Security" - ], + "tags": ["Row Level Security"], "x-codeSamples": [ { "lang": "cURL", @@ -29072,9 +27734,7 @@ } ], "summary": "Get related fields data (rowlevelsecurity-related-column-name)", - "tags": [ - "Row Level Security" - ], + "tags": ["Row Level Security"], "x-codeSamples": [ { "lang": "cURL", @@ -29141,9 +27801,7 @@ } ], "summary": "Delete an RLS", - "tags": [ - "Row Level Security" - ], + "tags": ["Row Level Security"], "x-codeSamples": [ { "lang": "cURL", @@ -29251,9 +27909,7 @@ "roles": [], "tables": [] }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -29282,9 +27938,7 @@ } ], "summary": "Get an RLS", - "tags": [ - "Row Level Security" - ], + "tags": ["Row Level Security"], "x-codeSamples": [ { "lang": "cURL", @@ -29327,12 +27981,8 @@ "filter_type": "Regular", "group_key": "string", "name": "string", - "roles": [ - 1 - ], - "tables": [ - 1 - ] + "roles": [1], + "tables": [1] } } }, @@ -29395,9 +28045,7 @@ } ], "summary": "Update an RLS rule", - "tags": [ - "Row Level Security" - ], + "tags": ["Row Level Security"], "x-codeSamples": [ { "lang": "cURL", @@ -29470,9 +28118,7 @@ } ], "summary": "Bulk delete saved queries", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -29577,22 +28223,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -29617,9 +28255,7 @@ } ], "summary": "Get a list of saved queries", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -29711,9 +28347,7 @@ } ], "summary": "Create a saved query", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -29796,13 +28430,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -29827,9 +28457,7 @@ } ], "summary": "Get metadata information about this API resource (saved-query--info)", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -29906,9 +28534,7 @@ } ], "summary": "Get distinct values from field data (saved-query-distinct-column-name)", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -29974,9 +28600,7 @@ } ], "summary": "Download multiple saved queries as YAML files", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -30073,9 +28697,7 @@ } ], "summary": "Import saved queries with associated databases", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -30152,9 +28774,7 @@ } ], "summary": "Get related fields data (saved-query-related-column-name)", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -30221,9 +28841,7 @@ } ], "summary": "Delete a saved query", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -30333,9 +28951,7 @@ "sql_tables": {}, "template_parameters": "string" }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -30364,9 +28980,7 @@ } ], "summary": "Get a saved query", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -30467,9 +29081,7 @@ } ], "summary": "Update a saved query", - "tags": [ - "Queries" - ], + "tags": ["Queries"], "x-codeSamples": [ { "lang": "cURL", @@ -30523,9 +29135,7 @@ } ], "summary": "Get the CSRF token", - "tags": [ - "Security" - ], + "tags": ["Security"], "x-codeSamples": [ { "lang": "cURL", @@ -30632,22 +29242,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -30671,9 +29273,7 @@ "jwt": [] } ], - "tags": [ - "Security Groups" - ], + "tags": ["Security Groups"], "operationId": "get_security_groups", "summary": "Get security groups", "x-codeSamples": [ @@ -30705,12 +29305,8 @@ "description": "string", "label": "string", "name": "string", - "roles": [ - 1 - ], - "users": [ - 1 - ] + "roles": [1], + "users": [1] } } }, @@ -30760,9 +29356,7 @@ "jwt": [] } ], - "tags": [ - "Security Groups" - ], + "tags": ["Security Groups"], "operationId": "create_security_groups", "summary": "Create security groups", "x-codeSamples": [ @@ -30847,13 +29441,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -30877,9 +29467,7 @@ "jwt": [] } ], - "tags": [ - "Security Groups" - ], + "tags": ["Security Groups"], "operationId": "get_security_groups__info", "summary": "Get security groups info", "x-codeSamples": [ @@ -30947,9 +29535,7 @@ "jwt": [] } ], - "tags": [ - "Security Groups" - ], + "tags": ["Security Groups"], "operationId": "delete_security_groups_by_pk", "summary": "Delete security groups by pk", "x-codeSamples": [ @@ -31055,9 +29641,7 @@ "label": "string", "name": "string" }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -31085,9 +29669,7 @@ "jwt": [] } ], - "tags": [ - "Security Groups" - ], + "tags": ["Security Groups"], "operationId": "get_security_groups_by_pk", "summary": "Get security groups by pk", "x-codeSamples": [ @@ -31129,12 +29711,8 @@ "description": "string", "label": "string", "name": "string", - "roles": [ - 1 - ], - "users": [ - 1 - ] + "roles": [1], + "users": [1] } } }, @@ -31187,9 +29765,7 @@ "jwt": [] } ], - "tags": [ - "Security Groups" - ], + "tags": ["Security Groups"], "operationId": "update_security_groups_by_pk", "summary": "Update security groups by pk", "x-codeSamples": [ @@ -31220,12 +29796,8 @@ "$ref": "#/components/schemas/GuestTokenCreate" }, "example": { - "resources": [ - {} - ], - "rls": [ - {} - ], + "resources": [{}], + "rls": [{}], "user": { "first_name": "string", "last_name": "string", @@ -31272,9 +29844,7 @@ } ], "summary": "Get a guest token", - "tags": [ - "Security" - ], + "tags": ["Security"], "x-codeSamples": [ { "lang": "cURL", @@ -31309,10 +29879,7 @@ }, "provider": { "description": "Choose an authentication provider", - "enum": [ - "db", - "ldap" - ], + "enum": ["db", "ldap"], "example": "db", "type": "string" }, @@ -31372,9 +29939,7 @@ "$ref": "#/components/responses/500" } }, - "tags": [ - "Security" - ], + "tags": ["Security"], "operationId": "create_security_login", "summary": "Create security login", "x-codeSamples": [ @@ -31483,22 +30048,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -31522,9 +30079,7 @@ "jwt": [] } ], - "tags": [ - "Security Permissions on Resources (View Menus)" - ], + "tags": ["Security Permissions on Resources (View Menus)"], "operationId": "get_security_permissions_resources", "summary": "Get security permissions resources", "x-codeSamples": [ @@ -31605,9 +30160,7 @@ "jwt": [] } ], - "tags": [ - "Security Permissions on Resources (View Menus)" - ], + "tags": ["Security Permissions on Resources (View Menus)"], "operationId": "create_security_permissions_resources", "summary": "Create security permissions resources", "x-codeSamples": [ @@ -31692,13 +30245,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -31722,9 +30271,7 @@ "jwt": [] } ], - "tags": [ - "Security Permissions on Resources (View Menus)" - ], + "tags": ["Security Permissions on Resources (View Menus)"], "operationId": "get_security_permissions_resources__info", "summary": "Get security permissions resources info", "x-codeSamples": [ @@ -31792,9 +30339,7 @@ "jwt": [] } ], - "tags": [ - "Security Permissions on Resources (View Menus)" - ], + "tags": ["Security Permissions on Resources (View Menus)"], "operationId": "delete_security_permissions_resources_by_pk", "summary": "Delete security permissions resources by pk", "x-codeSamples": [ @@ -31897,9 +30442,7 @@ "result": { "id": 1 }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -31927,9 +30470,7 @@ "jwt": [] } ], - "tags": [ - "Security Permissions on Resources (View Menus)" - ], + "tags": ["Security Permissions on Resources (View Menus)"], "operationId": "get_security_permissions_resources_by_pk", "summary": "Get security permissions resources by pk", "x-codeSamples": [ @@ -32019,9 +30560,7 @@ "jwt": [] } ], - "tags": [ - "Security Permissions on Resources (View Menus)" - ], + "tags": ["Security Permissions on Resources (View Menus)"], "operationId": "update_security_permissions_resources_by_pk", "summary": "Update security permissions resources by pk", "x-codeSamples": [ @@ -32130,22 +30669,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -32169,9 +30700,7 @@ "jwt": [] } ], - "tags": [ - "Security Permissions" - ], + "tags": ["Security Permissions"], "operationId": "get_security_permissions", "summary": "Get security permissions", "x-codeSamples": [ @@ -32256,13 +30785,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -32286,9 +30811,7 @@ "jwt": [] } ], - "tags": [ - "Security Permissions" - ], + "tags": ["Security Permissions"], "operationId": "get_security_permissions__info", "summary": "Get security permissions info", "x-codeSamples": [ @@ -32394,9 +30917,7 @@ "id": 1, "name": "string" }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -32424,9 +30945,7 @@ "jwt": [] } ], - "tags": [ - "Security Permissions" - ], + "tags": ["Security Permissions"], "operationId": "get_security_permissions_by_pk", "summary": "Get security permissions by pk", "x-codeSamples": [ @@ -32483,9 +31002,7 @@ "jwt_refresh": [] } ], - "tags": [ - "Security" - ], + "tags": ["Security"], "operationId": "create_security_refresh", "summary": "Create security refresh", "x-codeSamples": [ @@ -32594,22 +31111,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -32633,9 +31142,7 @@ "jwt": [] } ], - "tags": [ - "Security Resources (View Menus)" - ], + "tags": ["Security Resources (View Menus)"], "operationId": "get_security_resources", "summary": "Get security resources", "x-codeSamples": [ @@ -32714,9 +31221,7 @@ "jwt": [] } ], - "tags": [ - "Security Resources (View Menus)" - ], + "tags": ["Security Resources (View Menus)"], "operationId": "create_security_resources", "summary": "Create security resources", "x-codeSamples": [ @@ -32801,13 +31306,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -32831,9 +31332,7 @@ "jwt": [] } ], - "tags": [ - "Security Resources (View Menus)" - ], + "tags": ["Security Resources (View Menus)"], "operationId": "get_security_resources__info", "summary": "Get security resources info", "x-codeSamples": [ @@ -32901,9 +31400,7 @@ "jwt": [] } ], - "tags": [ - "Security Resources (View Menus)" - ], + "tags": ["Security Resources (View Menus)"], "operationId": "delete_security_resources_by_pk", "summary": "Delete security resources by pk", "x-codeSamples": [ @@ -33007,9 +31504,7 @@ "id": 1, "name": "string" }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -33037,9 +31532,7 @@ "jwt": [] } ], - "tags": [ - "Security Resources (View Menus)" - ], + "tags": ["Security Resources (View Menus)"], "operationId": "get_security_resources_by_pk", "summary": "Get security resources by pk", "x-codeSamples": [ @@ -33127,9 +31620,7 @@ "jwt": [] } ], - "tags": [ - "Security Resources (View Menus)" - ], + "tags": ["Security Resources (View Menus)"], "operationId": "update_security_resources_by_pk", "summary": "Update security resources by pk", "x-codeSamples": [ @@ -33238,22 +31729,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -33277,9 +31760,7 @@ "jwt": [] } ], - "tags": [ - "Security Roles" - ], + "tags": ["Security Roles"], "operationId": "get_security_roles", "summary": "Get security roles", "x-codeSamples": [ @@ -33358,9 +31839,7 @@ "jwt": [] } ], - "tags": [ - "Security Roles" - ], + "tags": ["Security Roles"], "operationId": "create_security_roles", "summary": "Create security roles", "x-codeSamples": [ @@ -33445,13 +31924,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -33475,9 +31950,7 @@ "jwt": [] } ], - "tags": [ - "Security Roles" - ], + "tags": ["Security Roles"], "operationId": "get_security_roles__info", "summary": "Get security roles info", "x-codeSamples": [ @@ -33512,11 +31985,7 @@ "items": { "properties": { "col": { - "enum": [ - "user_ids", - "permission_ids", - "name" - ], + "enum": ["user_ids", "permission_ids", "name"], "type": "string" }, "value": { @@ -33529,18 +31998,12 @@ }, "order_column": { "default": "id", - "enum": [ - "id", - "name" - ], + "enum": ["id", "name"], "type": "string" }, "order_direction": { "default": "asc", - "enum": [ - "asc", - "desc" - ], + "enum": ["asc", "desc"], "type": "string" }, "page": { @@ -33565,9 +32028,7 @@ }, "example": { "count": 1, - "ids": [ - 1 - ], + "ids": [1], "result": [] } } @@ -33617,9 +32078,7 @@ } ], "summary": "List roles", - "tags": [ - "Security Roles" - ], + "tags": ["Security Roles"], "x-codeSamples": [ { "lang": "cURL", @@ -33685,9 +32144,7 @@ "jwt": [] } ], - "tags": [ - "Security Roles" - ], + "tags": ["Security Roles"], "operationId": "delete_security_roles_by_pk", "summary": "Delete security roles by pk", "x-codeSamples": [ @@ -33791,9 +32248,7 @@ "id": 1, "name": "string" }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -33821,9 +32276,7 @@ "jwt": [] } ], - "tags": [ - "Security Roles" - ], + "tags": ["Security Roles"], "operationId": "get_security_roles_by_pk", "summary": "Get security roles by pk", "x-codeSamples": [ @@ -33911,9 +32364,7 @@ "jwt": [] } ], - "tags": [ - "Security Roles" - ], + "tags": ["Security Roles"], "operationId": "update_security_roles_by_pk", "summary": "Update security roles by pk", "x-codeSamples": [ @@ -33954,9 +32405,7 @@ "$ref": "#/components/schemas/RoleGroupPutSchema" }, "example": { - "group_ids": [ - 1 - ] + "group_ids": [1] } } }, @@ -34005,9 +32454,7 @@ "jwt": [] } ], - "tags": [ - "Security Roles" - ], + "tags": ["Security Roles"], "operationId": "update_security_roles_by_role_id_groups", "summary": "Update security roles by role_id groups", "x-codeSamples": [ @@ -34048,9 +32495,7 @@ "$ref": "#/components/schemas/RolePermissionPostSchema" }, "example": { - "permission_view_menu_ids": [ - 1 - ] + "permission_view_menu_ids": [1] } } }, @@ -34099,9 +32544,7 @@ "jwt": [] } ], - "tags": [ - "Security Roles" - ], + "tags": ["Security Roles"], "operationId": "create_security_roles_by_role_id_permissions", "summary": "Create security roles by role_id permissions", "x-codeSamples": [ @@ -34151,9 +32594,7 @@ "type": "object" }, "example": { - "result": [ - {} - ] + "result": [{}] } } }, @@ -34180,9 +32621,7 @@ "jwt": [] } ], - "tags": [ - "Security Roles" - ], + "tags": ["Security Roles"], "operationId": "get_security_roles_by_role_id_permissions", "summary": "Get security roles by role_id permissions", "x-codeSamples": [ @@ -34223,9 +32662,7 @@ "$ref": "#/components/schemas/RoleUserPutSchema" }, "example": { - "user_ids": [ - 1 - ] + "user_ids": [1] } } }, @@ -34274,9 +32711,7 @@ "jwt": [] } ], - "tags": [ - "Security Roles" - ], + "tags": ["Security Roles"], "operationId": "update_security_roles_by_role_id_users", "summary": "Update security roles by role_id users", "x-codeSamples": [ @@ -34385,22 +32820,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -34424,9 +32851,7 @@ "jwt": [] } ], - "tags": [ - "UserRegistrationsRestAPI" - ], + "tags": ["UserRegistrationsRestAPI"], "operationId": "get_security_user_registrations", "summary": "Get security user registrations", "x-codeSamples": [ @@ -34505,9 +32930,7 @@ "jwt": [] } ], - "tags": [ - "UserRegistrationsRestAPI" - ], + "tags": ["UserRegistrationsRestAPI"], "operationId": "create_security_user_registrations", "summary": "Create security user registrations", "x-codeSamples": [ @@ -34592,13 +33015,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -34622,9 +33041,7 @@ "jwt": [] } ], - "tags": [ - "UserRegistrationsRestAPI" - ], + "tags": ["UserRegistrationsRestAPI"], "operationId": "get_security_user_registrations__info", "summary": "Get security user registrations info", "x-codeSamples": [ @@ -34703,9 +33120,7 @@ } ], "summary": "Get distinct values from field data (security-user-registrations-distinct-column-name)", - "tags": [ - "UserRegistrationsRestAPI" - ], + "tags": ["UserRegistrationsRestAPI"], "x-codeSamples": [ { "lang": "cURL", @@ -34782,9 +33197,7 @@ } ], "summary": "Get related fields data (security-user-registrations-related-column-name)", - "tags": [ - "UserRegistrationsRestAPI" - ], + "tags": ["UserRegistrationsRestAPI"], "x-codeSamples": [ { "lang": "cURL", @@ -34850,9 +33263,7 @@ "jwt": [] } ], - "tags": [ - "UserRegistrationsRestAPI" - ], + "tags": ["UserRegistrationsRestAPI"], "operationId": "delete_security_user_registrations_by_pk", "summary": "Delete security user registrations by pk", "x-codeSamples": [ @@ -34955,9 +33366,7 @@ "result": { "id": 1 }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -34985,9 +33394,7 @@ "jwt": [] } ], - "tags": [ - "UserRegistrationsRestAPI" - ], + "tags": ["UserRegistrationsRestAPI"], "operationId": "get_security_user_registrations_by_pk", "summary": "Get security user registrations by pk", "x-codeSamples": [ @@ -35075,9 +33482,7 @@ "jwt": [] } ], - "tags": [ - "UserRegistrationsRestAPI" - ], + "tags": ["UserRegistrationsRestAPI"], "operationId": "update_security_user_registrations_by_pk", "summary": "Update security user registrations by pk", "x-codeSamples": [ @@ -35186,22 +33591,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -35225,9 +33622,7 @@ "jwt": [] } ], - "tags": [ - "Security Users" - ], + "tags": ["Security Users"], "operationId": "get_security_users", "summary": "Get security users", "x-codeSamples": [ @@ -35259,14 +33654,10 @@ "active": true, "email": "string", "first_name": "string", - "groups": [ - 1 - ], + "groups": [1], "last_name": "string", "password": "string", - "roles": [ - 1 - ], + "roles": [1], "username": "string" } } @@ -35323,9 +33714,7 @@ "jwt": [] } ], - "tags": [ - "Security Users" - ], + "tags": ["Security Users"], "operationId": "create_security_users", "summary": "Create security users", "x-codeSamples": [ @@ -35410,13 +33799,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -35440,9 +33825,7 @@ "jwt": [] } ], - "tags": [ - "Security Users" - ], + "tags": ["Security Users"], "operationId": "get_security_users__info", "summary": "Get security users info", "x-codeSamples": [ @@ -35510,9 +33893,7 @@ "jwt": [] } ], - "tags": [ - "Security Users" - ], + "tags": ["Security Users"], "operationId": "delete_security_users_by_pk", "summary": "Delete security users by pk", "x-codeSamples": [ @@ -35625,9 +34006,7 @@ "login_count": 1, "username": "string" }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -35655,9 +34034,7 @@ "jwt": [] } ], - "tags": [ - "Security Users" - ], + "tags": ["Security Users"], "operationId": "get_security_users_by_pk", "summary": "Get security users by pk", "x-codeSamples": [ @@ -35699,14 +34076,10 @@ "active": true, "email": "string", "first_name": "string", - "groups": [ - 1 - ], + "groups": [1], "last_name": "string", "password": "string", - "roles": [ - 1 - ], + "roles": [1], "username": "string" } } @@ -35763,9 +34136,7 @@ "jwt": [] } ], - "tags": [ - "Security Users" - ], + "tags": ["Security Users"], "operationId": "update_security_users_by_pk", "summary": "Update security users by pk", "x-codeSamples": [ @@ -35805,9 +34176,7 @@ "queries": { "key": "value" }, - "tab_state_ids": [ - "string" - ] + "tab_state_ids": ["string"] } } }, @@ -35832,9 +34201,7 @@ } ], "summary": "Get the bootstrap data for SqlLab page", - "tags": [ - "SQL Lab" - ], + "tags": ["SQL Lab"], "x-codeSamples": [ { "lang": "cURL", @@ -35912,9 +34279,7 @@ } ], "summary": "Estimate the SQL query execution cost", - "tags": [ - "SQL Lab" - ], + "tags": ["SQL Lab"], "x-codeSamples": [ { "lang": "cURL", @@ -35971,20 +34336,12 @@ "$ref": "#/components/schemas/QueryExecutionResponseSchema" }, "example": { - "columns": [ - {} - ], - "data": [ - {} - ], - "expanded_columns": [ - {} - ], + "columns": [{}], + "data": [{}], + "expanded_columns": [{}], "query": {}, "query_id": 1, - "selected_columns": [ - {} - ], + "selected_columns": [{}], "status": "string" } } @@ -35998,20 +34355,12 @@ "$ref": "#/components/schemas/QueryExecutionResponseSchema" }, "example": { - "columns": [ - {} - ], - "data": [ - {} - ], - "expanded_columns": [ - {} - ], + "columns": [{}], + "data": [{}], + "expanded_columns": [{}], "query": {}, "query_id": 1, - "selected_columns": [ - {} - ], + "selected_columns": [{}], "status": "string" } } @@ -36040,9 +34389,7 @@ } ], "summary": "Execute a SQL query", - "tags": [ - "SQL Lab" - ], + "tags": ["SQL Lab"], "x-codeSamples": [ { "lang": "cURL", @@ -36108,9 +34455,7 @@ } ], "summary": "Export the SQL query results to a CSV", - "tags": [ - "SQL Lab" - ], + "tags": ["SQL Lab"], "x-codeSamples": [ { "lang": "cURL", @@ -36190,9 +34535,7 @@ } ], "summary": "Export SQL query results to CSV with streaming", - "tags": [ - "SQL Lab" - ], + "tags": ["SQL Lab"], "x-codeSamples": [ { "lang": "cURL", @@ -36269,9 +34612,7 @@ } ], "summary": "Format SQL code", - "tags": [ - "SQL Lab" - ], + "tags": ["SQL Lab"], "x-codeSamples": [ { "lang": "cURL", @@ -36301,9 +34642,7 @@ }, "example": { "formData": {}, - "urlParams": [ - {} - ] + "urlParams": [{}] } } }, @@ -36353,9 +34692,7 @@ } ], "summary": "Create a new permanent link (sqllab-permalink)", - "tags": [ - "SQL Lab Permanent Link" - ], + "tags": ["SQL Lab Permanent Link"], "x-codeSamples": [ { "lang": "cURL", @@ -36429,9 +34766,7 @@ } ], "summary": "Get permanent link state for SQLLab editor.", - "tags": [ - "SQL Lab Permanent Link" - ], + "tags": ["SQL Lab Permanent Link"], "x-codeSamples": [ { "lang": "cURL", @@ -36474,20 +34809,12 @@ "$ref": "#/components/schemas/QueryExecutionResponseSchema" }, "example": { - "columns": [ - {} - ], - "data": [ - {} - ], - "expanded_columns": [ - {} - ], + "columns": [{}], + "data": [{}], + "expanded_columns": [{}], "query": {}, "query_id": 1, - "selected_columns": [ - {} - ], + "selected_columns": [{}], "status": "string" } } @@ -36519,9 +34846,7 @@ } ], "summary": "Get the result of a SQL query execution", - "tags": [ - "SQL Lab" - ], + "tags": ["SQL Lab"], "x-codeSamples": [ { "lang": "cURL", @@ -36598,9 +34923,7 @@ } ], "summary": "Bulk delete tags", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -36705,22 +35028,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -36745,9 +35060,7 @@ } ], "summary": "Get a list of tags", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -36830,9 +35143,7 @@ } ], "summary": "Create a tag", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -36915,13 +35226,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -36946,9 +35253,7 @@ } ], "summary": "Get metadata information about tag API endpoints", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -36977,9 +35282,7 @@ "$ref": "#/components/schemas/TagPostBulkSchema" }, "example": { - "tags": [ - {} - ] + "tags": [{}] } } }, @@ -37022,9 +35325,7 @@ } ], "summary": "Bulk create tags and tagged objects", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -37092,9 +35393,7 @@ "jwt": [] } ], - "tags": [ - "Tags" - ], + "tags": ["Tags"], "operationId": "get_tag_favorite_status", "summary": "Get tag favorite status", "x-codeSamples": [ @@ -37144,9 +35443,7 @@ "type": "object" }, "example": { - "result": [ - {} - ] + "result": [{}] } } }, @@ -37174,9 +35471,7 @@ } ], "summary": "Get all objects associated with a tag", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -37253,9 +35548,7 @@ } ], "summary": "Get related fields data (tag-related-column-name)", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -37312,9 +35605,7 @@ "type": "object" }, "example": { - "tags": [ - "string" - ] + "tags": ["string"] } } }, @@ -37347,9 +35638,7 @@ } ], "summary": "Add tags to an object", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -37438,9 +35727,7 @@ } ], "summary": "Delete a tagged object", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -37507,9 +35794,7 @@ } ], "summary": "Delete a tag", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -37615,9 +35900,7 @@ "name": "string", "type": {} }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -37646,9 +35929,7 @@ } ], "summary": "Get a tag detail information", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -37747,9 +36028,7 @@ } ], "summary": "Update a tag", - "tags": [ - "Tags" - ], + "tags": ["Tags"], "x-codeSamples": [ { "lang": "cURL", @@ -37819,9 +36098,7 @@ "jwt": [] } ], - "tags": [ - "Tags" - ], + "tags": ["Tags"], "operationId": "delete_tag_by_pk_favorites", "summary": "Delete tag by pk favorites", "x-codeSamples": [ @@ -37891,9 +36168,7 @@ "jwt": [] } ], - "tags": [ - "Tags" - ], + "tags": ["Tags"], "operationId": "create_tag_by_pk_favorites", "summary": "Create tag by pk favorites", "x-codeSamples": [ @@ -37968,9 +36243,7 @@ } ], "summary": "Bulk delete themes", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -38075,22 +36348,14 @@ "description_columns": { "column_name": "A Nice description for the column" }, - "ids": [ - "string" - ], + "ids": ["string"], "label_columns": { "column_name": "A Nice label for the column" }, - "list_columns": [ - "string" - ], + "list_columns": ["string"], "list_title": "List Items", - "order_columns": [ - "string" - ], - "result": [ - {} - ] + "order_columns": ["string"], + "result": [{}] } } }, @@ -38115,9 +36380,7 @@ } ], "summary": "Get a list of themes", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -38197,9 +36460,7 @@ } ], "summary": "Create a theme", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -38282,13 +36543,9 @@ "add_columns": {}, "edit_columns": {}, "filters": { - "column_name": [ - {} - ] + "column_name": [{}] }, - "permissions": [ - "string" - ] + "permissions": ["string"] } } }, @@ -38313,9 +36570,7 @@ } ], "summary": "Get metadata information about this API resource (theme--info)", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -38384,9 +36639,7 @@ } ], "summary": "Download multiple themes as YAML files", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -38465,9 +36718,7 @@ } ], "summary": "Import themes from a ZIP file", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -38544,9 +36795,7 @@ } ], "summary": "Get related fields data (theme-related-column-name)", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -38603,9 +36852,7 @@ } ], "summary": "Clear the system dark theme", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -38662,9 +36909,7 @@ } ], "summary": "Clear the system default theme", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -38737,9 +36982,7 @@ } ], "summary": "Delete a theme", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -38847,9 +37090,7 @@ "theme_name": "string", "uuid": "550e8400-e29b-41d4-a716-446655440000" }, - "show_columns": [ - "string" - ], + "show_columns": ["string"], "show_title": "Show Item Details" } } @@ -38878,9 +37119,7 @@ } ], "summary": "Get a theme", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -38976,9 +37215,7 @@ } ], "summary": "Update a theme", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -39059,9 +37296,7 @@ } ], "summary": "Set a theme as the system dark theme", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -39142,9 +37377,7 @@ } ], "summary": "Set a theme as the system default theme", - "tags": [ - "Themes" - ], + "tags": ["Themes"], "x-codeSamples": [ { "lang": "cURL", @@ -39190,9 +37423,7 @@ } }, "summary": "Get the user avatar", - "tags": [ - "User" - ], + "tags": ["User"], "x-codeSamples": [ { "lang": "cURL", @@ -39248,9 +37479,7 @@ "jwt": [] } ], - "tags": [ - "OpenApi" - ], + "tags": ["OpenApi"], "operationId": "get_api_by_version__openapi", "summary": "Get api by version openapi", "x-codeSamples": [ @@ -39284,10 +37513,7 @@ "variables": { "protocol": { "default": "http", - "enum": [ - "http", - "https" - ], + "enum": ["http", "https"], "description": "HTTP protocol" }, "host": { diff --git a/docs/tsconfig.json b/docs/tsconfig.json index 0d40e73e0f5..ec28c208cc1 100644 --- a/docs/tsconfig.json +++ b/docs/tsconfig.json @@ -13,8 +13,12 @@ "esModuleInterop": true, "types": ["@docusaurus/module-type-aliases"], "paths": { - "@superset-ui/core": ["../superset-frontend/packages/superset-ui-core/src"], - "@superset-ui/core/*": ["../superset-frontend/packages/superset-ui-core/src/*"], + "@superset-ui/core": [ + "../superset-frontend/packages/superset-ui-core/src" + ], + "@superset-ui/core/*": [ + "../superset-frontend/packages/superset-ui-core/src/*" + ], // Types for @apache-superset/core/components are auto-generated by scripts/generate-superset-components.mjs // Runtime resolution uses webpack alias pointing to actual source (see src/webpack.extend.ts) // Using /ui path matches the established pattern used throughout the Superset codebase @@ -22,14 +26,6 @@ "*": ["src/*", "node_modules/*"] } }, - "include": [ - "src/**/*.ts", - "src/**/*.tsx", - "src/**/*.d.ts" - ], - "exclude": [ - "node_modules", - "../superset-frontend/**/*", - "src/shims/**" - ] + "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.d.ts"], + "exclude": ["node_modules", "../superset-frontend/**/*", "src/shims/**"] } diff --git a/docs/user_docs_versioned_docs/version-6.0.0/api.mdx b/docs/user_docs_versioned_docs/version-6.0.0/api.mdx index 11e0b86fe87..642ec72f9f9 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/api.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/api.mdx @@ -21,8 +21,8 @@ documented here. The docs below are generated using message={
    NOTE! - You can find an interactive version of this documentation on your local Superset - instance at /swagger/v1 (unless disabled) + You can find an interactive version of this documentation on your local + Superset instance at /swagger/v1 (unless disabled)
    } /> diff --git a/docs/user_docs_versioned_docs/version-6.0.0/configuration/alerts-reports.mdx b/docs/user_docs_versioned_docs/version-6.0.0/configuration/alerts-reports.mdx index f5fc0d2e6db..91bcd665ac1 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/configuration/alerts-reports.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/configuration/alerts-reports.mdx @@ -9,8 +9,8 @@ version: 2 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_ 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 need to do some setup, described here. @@ -26,25 +26,25 @@ Alerts and reports are disabled by default. To turn them on, you need to do some - 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](/user-docs/6.0.0/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. + - 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). +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 must install a headless browser, for taking screenshots of the charts and dashboards. Only Firefox and Chrome are currently supported. > If you choose Chrome, you must also change the value of `WEBDRIVER_TYPE` to `"chrome"` in your `superset_config.py`. -Note: All the components required (Firefox headless browser, Redis, Postgres db, celery worker and celery beat) are present in the *dev* docker image if you are following [Installing Superset Locally](/user-docs/6.0.0/installation/docker-compose/). +Note: All the components required (Firefox headless browser, Redis, Postgres db, celery worker and celery beat) are present in the _dev_ docker image if you are following [Installing Superset Locally](/user-docs/6.0.0/installation/docker-compose/). All you need to do is add the required config variables described in this guide (See `Detailed Config`). -If you are running a non-dev docker image, e.g., a stable release like `apache/superset:3.1.0`, that image does not include a headless browser. Only the `superset_worker` container needs this headless browser to browse to the target chart or dashboard. +If you are running a non-dev docker image, e.g., a stable release like `apache/superset:3.1.0`, that image does not include a headless browser. Only the `superset_worker` container needs this headless browser to browse to the target chart or dashboard. You can either install and configure the headless browser - see "Custom Dockerfile" section below - or when deploying via `docker compose`, modify your `docker-compose.yml` file to use a dev image for the worker container and a stable release image for the `superset_app` container. -*Note*: In this context, a "dev image" is the same application software as its corresponding non-dev image, just bundled with additional tools. So an image like `3.1.0-dev` is identical to `3.1.0` when it comes to stability, functionality, and running in production. The actual "in-development" versions of Superset - cutting-edge and unstable - are not tagged with version numbers on Docker Hub and will display version `0.0.0-dev` within the Superset UI. +_Note_: In this context, a "dev image" is the same application software as its corresponding non-dev image, just bundled with additional tools. So an image like `3.1.0-dev` is identical to `3.1.0` when it comes to stability, functionality, and running in production. The actual "in-development" versions of Superset - cutting-edge and unstable - are not tagged with version numbers on Docker Hub and will display version `0.0.0-dev` within the Superset UI. ### Slack integration @@ -94,7 +94,7 @@ You need to replace default values with your custom Redis, Slack and/or SMTP con 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. +- 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. @@ -201,7 +201,7 @@ Please refer to `ExecutorType` in the codebase for other executor types. It's also possible to specify a minimum interval between each report's execution through the config file: -``` python +```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()) @@ -210,7 +210,7 @@ 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 +```python def alert_dynamic_minimal_interval(**kwargs) -> int: """ Define logic here to retrieve the value dynamically @@ -277,17 +277,17 @@ Don't forget to set `WEBDRIVER_TYPE` and `WEBDRIVER_OPTION_ARGS` in your config ## Troubleshooting -There are many reasons that reports might not be working. Try these steps to check for specific issues. +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. +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`. +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 @@ -301,7 +301,7 @@ If you are handling the installation of that software on your own, or wish to us 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. +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: @@ -327,16 +327,16 @@ 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. +- 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. +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`. +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`. ## Scheduling Queries as Reports diff --git a/docs/user_docs_versioned_docs/version-6.0.0/configuration/configuring-superset.mdx b/docs/user_docs_versioned_docs/version-6.0.0/configuration/configuring-superset.mdx index 0919ed24c1a..29dde6b95fb 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/configuration/configuring-superset.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/configuration/configuring-superset.mdx @@ -225,7 +225,7 @@ RequestHeader set X-Forwarded-Proto "https" ## Configuring the application root -*Please be advised that this feature is in BETA.* +_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 two ways: @@ -311,10 +311,13 @@ 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 ``` diff --git a/docs/user_docs_versioned_docs/version-6.0.0/configuration/country-map-tools.mdx b/docs/user_docs_versioned_docs/version-6.0.0/configuration/country-map-tools.mdx index fb1a04fd880..50fcb26564f 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/configuration/country-map-tools.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/configuration/country-map-tools.mdx @@ -22,10 +22,10 @@ The current list of countries can be found in the src The Country Maps visualization already ships with the maps for the following countries: -
      -{countriesData.countries.map((country, index) => ( -
    • {country}
      • -))} +
        + {countriesData.countries.map((country, index) => ( +
      • {country}
        • + ))}
      ## Adding a New Country diff --git a/docs/user_docs_versioned_docs/version-6.0.0/configuration/databases.mdx b/docs/user_docs_versioned_docs/version-6.0.0/configuration/databases.mdx index 3c4816f5826..6db8e8d7edd 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/configuration/databases.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/configuration/databases.mdx @@ -4,6 +4,7 @@ hide_title: true sidebar_position: 1 version: 1 --- + # Connecting to Databases Superset does not ship bundled with connectivity to databases. The main step in connecting @@ -35,55 +36,55 @@ Some of the recommended packages are shown below. Please refer to [pyproject.toml](https://github.com/apache/superset/blob/master/pyproject.toml) for the versions that are compatible with Superset. -|
      Database
      | PyPI package | Connection String | -| --------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [AWS Athena](/user-docs/6.0.0/configuration/databases#aws-athena) | `pip install pyathena[pandas]` , `pip install PyAthenaJDBC` | `awsathena+rest://{access_key_id}:{access_key}@athena.{region}.amazonaws.com/{schema}?s3_staging_dir={s3_staging_dir}&...` | -| [AWS DynamoDB](/user-docs/6.0.0/configuration/databases#aws-dynamodb) | `pip install pydynamodb` | `dynamodb://{access_key_id}:{secret_access_key}@dynamodb.{region_name}.amazonaws.com?connector=superset` | -| [AWS Redshift](/user-docs/6.0.0/configuration/databases#aws-redshift) | `pip install sqlalchemy-redshift` | `redshift+psycopg2://:@:5439/` | -| [Apache Doris](/user-docs/6.0.0/configuration/databases#apache-doris) | `pip install pydoris` | `doris://:@:/.` | -| [Apache Drill](/user-docs/6.0.0/configuration/databases#apache-drill) | `pip install sqlalchemy-drill` | `drill+sadrill://:@:/`, often useful: `?use_ssl=True/False` | -| [Apache Druid](/user-docs/6.0.0/configuration/databases#apache-druid) | `pip install pydruid` | `druid://:@:/druid/v2/sql` | -| [Apache Hive](/user-docs/6.0.0/configuration/databases#hive) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` | -| [Apache Impala](/user-docs/6.0.0/configuration/databases#apache-impala) | `pip install impyla` | `impala://{hostname}:{port}/{database}` | -| [Apache Kylin](/user-docs/6.0.0/configuration/databases#apache-kylin) | `pip install kylinpy` | `kylin://:@:/?=&=` | -| [Apache Pinot](/user-docs/6.0.0/configuration/databases#apache-pinot) | `pip install pinotdb` | `pinot://BROKER:5436/query?server=http://CONTROLLER:5983/` | -| [Apache Solr](/user-docs/6.0.0/configuration/databases#apache-solr) | `pip install sqlalchemy-solr` | `solr://{username}:{password}@{hostname}:{port}/{server_path}/{collection}` | -| [Apache Spark SQL](/user-docs/6.0.0/configuration/databases#apache-spark-sql) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` | -| [Ascend.io](/user-docs/6.0.0/configuration/databases#ascendio) | `pip install impyla` | `ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true` | -| [Azure MS SQL](/user-docs/6.0.0/configuration/databases#sql-server) | `pip install pymssql` | `mssql+pymssql://UserName@presetSQL:TestPassword@presetSQL.database.windows.net:1433/TestSchema` | -| [ClickHouse](/user-docs/6.0.0/configuration/databases#clickhouse) | `pip install clickhouse-connect` | `clickhousedb://{username}:{password}@{hostname}:{port}/{database}` | -| [CockroachDB](/user-docs/6.0.0/configuration/databases#cockroachdb) | `pip install cockroachdb` | `cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable` | -| [Couchbase](/user-docs/6.0.0/configuration/databases#couchbase) | `pip install couchbase-sqlalchemy` | `couchbase://{username}:{password}@{hostname}:{port}?truststorepath={ssl certificate path}` | -| [CrateDB](/user-docs/6.0.0/configuration/databases#cratedb) | `pip install sqlalchemy-cratedb` | `crate://{username}:{password}@{hostname}:{port}`, often useful: `?ssl=true/false` or `?schema=testdrive`. | -| [Denodo](/user-docs/6.0.0/configuration/databases#denodo) | `pip install denodo-sqlalchemy` | `denodo://{username}:{password}@{hostname}:{port}/{database}` | -| [Dremio](/user-docs/6.0.0/configuration/databases#dremio) | `pip install sqlalchemy_dremio` |`dremio+flight://{username}:{password}@{host}:32010`, often useful: `?UseEncryption=true/false`. For Legacy ODBC: `dremio+pyodbc://{username}:{password}@{host}:31010` | -| [Elasticsearch](/user-docs/6.0.0/configuration/databases#elasticsearch) | `pip install elasticsearch-dbapi` | `elasticsearch+http://{user}:{password}@{host}:9200/` | -| [Exasol](/user-docs/6.0.0/configuration/databases#exasol) | `pip install sqlalchemy-exasol` | `exa+pyodbc://{username}:{password}@{hostname}:{port}/my_schema?CONNECTIONLCALL=en_US.UTF-8&driver=EXAODBC` | -| [Google BigQuery](/user-docs/6.0.0/configuration/databases#google-bigquery) | `pip install sqlalchemy-bigquery` | `bigquery://{project_id}` | -| [Google Sheets](/user-docs/6.0.0/configuration/databases#google-sheets) | `pip install shillelagh[gsheetsapi]` | `gsheets://` | -| [Firebolt](/user-docs/6.0.0/configuration/databases#firebolt) | `pip install firebolt-sqlalchemy` | `firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={name}` | -| [Hologres](/user-docs/6.0.0/configuration/databases#hologres) | `pip install psycopg2` | `postgresql+psycopg2://:@/` | -| [IBM Db2](/user-docs/6.0.0/configuration/databases#ibm-db2) | `pip install ibm_db_sa` | `db2+ibm_db://` | -| [IBM Netezza Performance Server](/user-docs/6.0.0/configuration/databases#ibm-netezza-performance-server) | `pip install nzalchemy` | `netezza+nzpy://:@/` | -| [MySQL](/user-docs/6.0.0/configuration/databases#mysql) | `pip install mysqlclient` | `mysql://:@/` | -| [OceanBase](/user-docs/6.0.0/configuration/databases#oceanbase) | `pip install oceanbase_py` | `oceanbase://:@/` | -| [Oracle](/user-docs/6.0.0/configuration/databases#oracle) | `pip install cx_Oracle` | `oracle://:@:` | -| [Parseable](/user-docs/6.0.0/configuration/databases#parseable) | `pip install sqlalchemy-parseable` | `parseable://:@/` | -| [PostgreSQL](/user-docs/6.0.0/configuration/databases#postgres) | `pip install psycopg2` | `postgresql://:@/` | -| [Presto](/user-docs/6.0.0/configuration/databases#presto) | `pip install pyhive` | `presto://{username}:{password}@{hostname}:{port}/{database}` | -| [SAP Hana](/user-docs/6.0.0/configuration/databases#hana) | `pip install hdbcli sqlalchemy-hana` or `pip install apache_superset[hana]` | `hana://{username}:{password}@{host}:{port}` | -| [SingleStore](/user-docs/6.0.0/configuration/databases#singlestore) | `pip install sqlalchemy-singlestoredb` | `singlestoredb://{username}:{password}@{host}:{port}/{database}` | -| [StarRocks](/user-docs/6.0.0/configuration/databases#starrocks) | `pip install starrocks` | `starrocks://:@:/.` | -| [Snowflake](/user-docs/6.0.0/configuration/databases#snowflake) | `pip install snowflake-sqlalchemy` | `snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}` | -| SQLite | No additional library needed | `sqlite://path/to/file.db?check_same_thread=false` | -| [SQL Server](/user-docs/6.0.0/configuration/databases#sql-server) | `pip install pymssql` | `mssql+pymssql://:@:/` | -| [TDengine](/user-docs/6.0.0/configuration/databases#tdengine) | `pip install taospy` `pip install taos-ws-py` | `taosws://:@:` | -| [Teradata](/user-docs/6.0.0/configuration/databases#teradata) | `pip install teradatasqlalchemy` | `teradatasql://{user}:{password}@{host}` | -| [TimescaleDB](/user-docs/6.0.0/configuration/databases#timescaledb) | `pip install psycopg2` | `postgresql://:@:/` | -| [Trino](/user-docs/6.0.0/configuration/databases#trino) | `pip install trino` | `trino://{username}:{password}@{hostname}:{port}/{catalog}` | -| [Vertica](/user-docs/6.0.0/configuration/databases#vertica) | `pip install sqlalchemy-vertica-python` | `vertica+vertica_python://:@/` | -| [YDB](/user-docs/6.0.0/configuration/databases#ydb) | `pip install ydb-sqlalchemy` | `ydb://{host}:{port}/{database_name}` | -| [YugabyteDB](/user-docs/6.0.0/configuration/databases#yugabytedb) | `pip install psycopg2` | `postgresql://:@/` | +|
      Database
      | PyPI package | Connection String | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [AWS Athena](/user-docs/6.0.0/configuration/databases#aws-athena) | `pip install pyathena[pandas]` , `pip install PyAthenaJDBC` | `awsathena+rest://{access_key_id}:{access_key}@athena.{region}.amazonaws.com/{schema}?s3_staging_dir={s3_staging_dir}&...` | +| [AWS DynamoDB](/user-docs/6.0.0/configuration/databases#aws-dynamodb) | `pip install pydynamodb` | `dynamodb://{access_key_id}:{secret_access_key}@dynamodb.{region_name}.amazonaws.com?connector=superset` | +| [AWS Redshift](/user-docs/6.0.0/configuration/databases#aws-redshift) | `pip install sqlalchemy-redshift` | `redshift+psycopg2://:@:5439/` | +| [Apache Doris](/user-docs/6.0.0/configuration/databases#apache-doris) | `pip install pydoris` | `doris://:@:/.` | +| [Apache Drill](/user-docs/6.0.0/configuration/databases#apache-drill) | `pip install sqlalchemy-drill` | `drill+sadrill://:@:/`, often useful: `?use_ssl=True/False` | +| [Apache Druid](/user-docs/6.0.0/configuration/databases#apache-druid) | `pip install pydruid` | `druid://:@:/druid/v2/sql` | +| [Apache Hive](/user-docs/6.0.0/configuration/databases#hive) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` | +| [Apache Impala](/user-docs/6.0.0/configuration/databases#apache-impala) | `pip install impyla` | `impala://{hostname}:{port}/{database}` | +| [Apache Kylin](/user-docs/6.0.0/configuration/databases#apache-kylin) | `pip install kylinpy` | `kylin://:@:/?=&=` | +| [Apache Pinot](/user-docs/6.0.0/configuration/databases#apache-pinot) | `pip install pinotdb` | `pinot://BROKER:5436/query?server=http://CONTROLLER:5983/` | +| [Apache Solr](/user-docs/6.0.0/configuration/databases#apache-solr) | `pip install sqlalchemy-solr` | `solr://{username}:{password}@{hostname}:{port}/{server_path}/{collection}` | +| [Apache Spark SQL](/user-docs/6.0.0/configuration/databases#apache-spark-sql) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` | +| [Ascend.io](/user-docs/6.0.0/configuration/databases#ascendio) | `pip install impyla` | `ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true` | +| [Azure MS SQL](/user-docs/6.0.0/configuration/databases#sql-server) | `pip install pymssql` | `mssql+pymssql://UserName@presetSQL:TestPassword@presetSQL.database.windows.net:1433/TestSchema` | +| [ClickHouse](/user-docs/6.0.0/configuration/databases#clickhouse) | `pip install clickhouse-connect` | `clickhousedb://{username}:{password}@{hostname}:{port}/{database}` | +| [CockroachDB](/user-docs/6.0.0/configuration/databases#cockroachdb) | `pip install cockroachdb` | `cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable` | +| [Couchbase](/user-docs/6.0.0/configuration/databases#couchbase) | `pip install couchbase-sqlalchemy` | `couchbase://{username}:{password}@{hostname}:{port}?truststorepath={ssl certificate path}` | +| [CrateDB](/user-docs/6.0.0/configuration/databases#cratedb) | `pip install sqlalchemy-cratedb` | `crate://{username}:{password}@{hostname}:{port}`, often useful: `?ssl=true/false` or `?schema=testdrive`. | +| [Denodo](/user-docs/6.0.0/configuration/databases#denodo) | `pip install denodo-sqlalchemy` | `denodo://{username}:{password}@{hostname}:{port}/{database}` | +| [Dremio](/user-docs/6.0.0/configuration/databases#dremio) | `pip install sqlalchemy_dremio` | `dremio+flight://{username}:{password}@{host}:32010`, often useful: `?UseEncryption=true/false`. For Legacy ODBC: `dremio+pyodbc://{username}:{password}@{host}:31010` | +| [Elasticsearch](/user-docs/6.0.0/configuration/databases#elasticsearch) | `pip install elasticsearch-dbapi` | `elasticsearch+http://{user}:{password}@{host}:9200/` | +| [Exasol](/user-docs/6.0.0/configuration/databases#exasol) | `pip install sqlalchemy-exasol` | `exa+pyodbc://{username}:{password}@{hostname}:{port}/my_schema?CONNECTIONLCALL=en_US.UTF-8&driver=EXAODBC` | +| [Google BigQuery](/user-docs/6.0.0/configuration/databases#google-bigquery) | `pip install sqlalchemy-bigquery` | `bigquery://{project_id}` | +| [Google Sheets](/user-docs/6.0.0/configuration/databases#google-sheets) | `pip install shillelagh[gsheetsapi]` | `gsheets://` | +| [Firebolt](/user-docs/6.0.0/configuration/databases#firebolt) | `pip install firebolt-sqlalchemy` | `firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={name}` | +| [Hologres](/user-docs/6.0.0/configuration/databases#hologres) | `pip install psycopg2` | `postgresql+psycopg2://:@/` | +| [IBM Db2](/user-docs/6.0.0/configuration/databases#ibm-db2) | `pip install ibm_db_sa` | `db2+ibm_db://` | +| [IBM Netezza Performance Server](/user-docs/6.0.0/configuration/databases#ibm-netezza-performance-server) | `pip install nzalchemy` | `netezza+nzpy://:@/` | +| [MySQL](/user-docs/6.0.0/configuration/databases#mysql) | `pip install mysqlclient` | `mysql://:@/` | +| [OceanBase](/user-docs/6.0.0/configuration/databases#oceanbase) | `pip install oceanbase_py` | `oceanbase://:@/` | +| [Oracle](/user-docs/6.0.0/configuration/databases#oracle) | `pip install cx_Oracle` | `oracle://:@:` | +| [Parseable](/user-docs/6.0.0/configuration/databases#parseable) | `pip install sqlalchemy-parseable` | `parseable://:@/` | +| [PostgreSQL](/user-docs/6.0.0/configuration/databases#postgres) | `pip install psycopg2` | `postgresql://:@/` | +| [Presto](/user-docs/6.0.0/configuration/databases#presto) | `pip install pyhive` | `presto://{username}:{password}@{hostname}:{port}/{database}` | +| [SAP Hana](/user-docs/6.0.0/configuration/databases#hana) | `pip install hdbcli sqlalchemy-hana` or `pip install apache_superset[hana]` | `hana://{username}:{password}@{host}:{port}` | +| [SingleStore](/user-docs/6.0.0/configuration/databases#singlestore) | `pip install sqlalchemy-singlestoredb` | `singlestoredb://{username}:{password}@{host}:{port}/{database}` | +| [StarRocks](/user-docs/6.0.0/configuration/databases#starrocks) | `pip install starrocks` | `starrocks://:@:/.` | +| [Snowflake](/user-docs/6.0.0/configuration/databases#snowflake) | `pip install snowflake-sqlalchemy` | `snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}` | +| SQLite | No additional library needed | `sqlite://path/to/file.db?check_same_thread=false` | +| [SQL Server](/user-docs/6.0.0/configuration/databases#sql-server) | `pip install pymssql` | `mssql+pymssql://:@:/` | +| [TDengine](/user-docs/6.0.0/configuration/databases#tdengine) | `pip install taospy` `pip install taos-ws-py` | `taosws://:@:` | +| [Teradata](/user-docs/6.0.0/configuration/databases#teradata) | `pip install teradatasqlalchemy` | `teradatasql://{user}:{password}@{host}` | +| [TimescaleDB](/user-docs/6.0.0/configuration/databases#timescaledb) | `pip install psycopg2` | `postgresql://:@:/` | +| [Trino](/user-docs/6.0.0/configuration/databases#trino) | `pip install trino` | `trino://{username}:{password}@{hostname}:{port}/{catalog}` | +| [Vertica](/user-docs/6.0.0/configuration/databases#vertica) | `pip install sqlalchemy-vertica-python` | `vertica+vertica_python://:@/` | +| [YDB](/user-docs/6.0.0/configuration/databases#ydb) | `pip install ydb-sqlalchemy` | `ydb://{host}:{port}/{database_name}` | +| [YugabyteDB](/user-docs/6.0.0/configuration/databases#yugabytedb) | `pip install psycopg2` | `postgresql://:@/` | --- @@ -133,7 +134,7 @@ exists in the directory with your `docker-compose.yml` or `docker-compose-non-de touch ./docker/requirements-local.txt ``` -Add the driver identified in step above. You can use a text editor or do +Add the driver identified in step above. You can use a text editor or do it from the command line like: ```bash @@ -145,7 +146,7 @@ Launch Superset with `docker compose -f docker-compose-non-dev.yml up` and the driver should be present. You can check its presence by entering the running container with -`docker exec -it bash` and running `pip freeze`. The PyPI package should +`docker exec -it bash` and running `pip freeze`. The PyPI package should be present in the printed list. **If you're running a customized docker image**, rebuild your local image with the new @@ -168,7 +169,7 @@ From there, follow the steps on the [Using Database Connection UI page](/user-docs/6.0.0/configuration/databases#connecting-through-the-ui). Consult the page for your specific database type in the Superset documentation to determine -the connection string and any other parameters you need to input. For instance, +the connection string and any other parameters you need to input. For instance, on the [MySQL page](/user-docs/6.0.0/configuration/databases#mysql), we see that the connection string to a local MySQL database differs depending on whether the setup is running on Linux or Mac. @@ -177,7 +178,7 @@ Click the β€œTest Connection” button, which should result in a popup message s #### 4. Troubleshooting -If the test fails, review your docker logs for error messages. Superset uses SQLAlchemy +If the test fails, review your docker logs for error messages. Superset uses SQLAlchemy to connect to databases; to troubleshoot the connection string for your database, you might start Python in the Superset application container or host environment and try to connect directly to the desired database and fetch data. This eliminates Superset for the @@ -248,9 +249,9 @@ The PyAthena library also allows to assume a specific IAM role which you can def ```json { - "connect_args": { - "role_arn": "" - } + "connect_args": { + "role_arn": "" + } } ``` @@ -464,7 +465,7 @@ You also need to add the following configuration to "Other" -> "Engine Parameter ```json { - "connect_args": {"http_path": "sql/protocolv1/o/****"} + "connect_args": { "http_path": "sql/protocolv1/o/****" } } ``` @@ -489,7 +490,7 @@ databricks+pyhive://token:{access_token}@{server_hostname}:{port}/{database_name You also need to add the following configuration to "Other" -> "Engine Parameters", with your HTTP path: ```json -{"connect_args": {"http_path": "sql/protocolv1/o/****"}} +{ "connect_args": { "http_path": "sql/protocolv1/o/****" } } ``` #### ODBC @@ -505,7 +506,12 @@ databricks+pyodbc://token:{access_token}@{server_hostname}:{port}/{database_name And for the connection arguments: ```json -{"connect_args": {"http_path": "sql/protocolv1/o/****", "driver_path": "/path/to/odbc/driver"}} +{ + "connect_args": { + "http_path": "sql/protocolv1/o/****", + "driver_path": "/path/to/odbc/driver" + } +} ``` The driver path should be: @@ -516,7 +522,12 @@ The driver path should be: For a connection to a SQL endpoint you need to use the HTTP path from the endpoint: ```json -{"connect_args": {"http_path": "/sql/1.0/endpoints/****", "driver_path": "/path/to/odbc/driver"}} +{ + "connect_args": { + "http_path": "/sql/1.0/endpoints/****", + "driver_path": "/path/to/odbc/driver" + } +} ``` ##### OAuth2 Authentication @@ -561,6 +572,7 @@ DATABASE_OAUTH2_TIMEOUT = timedelta(seconds=30) ``` Replace the following placeholders: + - `your-databricks-client-id`: Your Databricks OAuth2 application client ID - `your-databricks-client-secret`: Your Databricks OAuth2 application client secret - `your-superset-host:port`: Your Superset instance hostname and port @@ -665,7 +677,7 @@ We recommend reading the the [GitHub README](https://github.com/JohnOmernik/sqlalchemy-drill#usage-with-odbc) to learn how to work with Drill through ODBC. -import useBaseUrl from "@docusaurus/useBaseUrl"; +import useBaseUrl from '@docusaurus/useBaseUrl'; #### Apache Druid @@ -696,7 +708,7 @@ When adding a connection to Druid, you can customize the connection a few differ You can add certificates in the **Root Certificate** field when configuring the new database connection to Druid: -{" "} + When using a custom certificate, pydruid will automatically use https scheme. @@ -781,9 +793,9 @@ please edit your Database and enter the settings of your specified time zone in ```json { - "connect_args": { - "time_zone": "Asia/Shanghai" - } + "connect_args": { + "time_zone": "Asia/Shanghai" + } } ``` @@ -874,17 +886,17 @@ credentials file (as a JSON). ```json { - "type": "service_account", - "project_id": "...", - "private_key_id": "...", - "private_key": "...", - "client_email": "...", - "client_id": "...", - "auth_uri": "...", - "token_uri": "...", - "auth_provider_x509_cert_url": "...", - "client_x509_cert_url": "..." - } + "type": "service_account", + "project_id": "...", + "private_key_id": "...", + "private_key": "...", + "client_email": "...", + "client_id": "...", + "auth_uri": "...", + "token_uri": "...", + "auth_provider_x509_cert_url": "...", + "client_x509_cert_url": "..." +} ``` ![CleanShot 2021-10-22 at 04 18 11](https://user-images.githubusercontent.com/52086618/138352958-a18ef9cb-8880-4ef1-88c1-452a9f1b8105.gif) @@ -910,19 +922,19 @@ credentials file (as a JSON). ```json { - "credentials_info": { - "type": "service_account", - "project_id": "...", - "private_key_id": "...", - "private_key": "...", - "client_email": "...", - "client_id": "...", - "auth_uri": "...", - "token_uri": "...", - "auth_provider_x509_cert_url": "...", - "client_x509_cert_url": "..." - } - } + "credentials_info": { + "type": "service_account", + "project_id": "...", + "private_key_id": "...", + "private_key": "...", + "client_email": "...", + "client_id": "...", + "auth_uri": "...", + "token_uri": "...", + "auth_provider_x509_cert_url": "...", + "client_x509_cert_url": "..." + } + } ``` You should then be able to connect to your BigQuery datasets. @@ -1134,7 +1146,8 @@ parseable://admin:admin@demo.parseable.com:443/ingress-nginx Note: The stream_name in the URI represents the Parseable logstream you want to query. You can use both HTTP (port 80) and HTTPS (port 443) connections. ->>>>>>> +> > > > > > > + #### Apache Pinot The recommended connector library for Apache Pinot is [pinotdb](https://pypi.org/project/pinotdb/). @@ -1155,7 +1168,7 @@ If you want to use explore view or joins, window functions, etc. then enable [mu Add below argument while creating database connection in Advanced -> Other -> ENGINE PARAMETERS ```json -{"connect_args":{"use_multistage_engine":"true"}} +{ "connect_args": { "use_multistage_engine": "true" } } ``` #### Postgres @@ -1221,17 +1234,17 @@ datasource. If you’re using an older version of Presto, you can configure it i ```json { - "version": "0.123" + "version": "0.123" } ``` SSL Secure extra add json config to extra connection information. ```json - { - "connect_args": - {"protocol": "https", - "requests_kwargs":{"verify":false} +{ + "connect_args": { + "protocol": "https", + "requests_kwargs": { "verify": false } } } ``` @@ -1285,27 +1298,27 @@ And if you want connect Snowflake with [Key Pair Authentication](https://docs.sn Please make sure you have the key pair and the public key is registered in Snowflake. To connect Snowflake with Key Pair Authentication, you need to add the following parameters to "SECURE EXTRA" field. -***Please note that you need to merge multi-line private key content to one line and insert `\n` between each line*** +**_Please note that you need to merge multi-line private key content to one line and insert `\n` between each line_** ```json { - "auth_method": "keypair", - "auth_params": { - "privatekey_body": "-----BEGIN ENCRYPTED PRIVATE KEY-----\n...\n...\n-----END ENCRYPTED PRIVATE KEY-----", - "privatekey_pass":"Your Private Key Password" - } - } + "auth_method": "keypair", + "auth_params": { + "privatekey_body": "-----BEGIN ENCRYPTED PRIVATE KEY-----\n...\n...\n-----END ENCRYPTED PRIVATE KEY-----", + "privatekey_pass": "Your Private Key Password" + } +} ``` If your private key is stored on server, you can replace "privatekey_body" with β€œprivatekey_path” in parameter. ```json { - "auth_method": "keypair", - "auth_params": { - "privatekey_path":"Your Private Key Path", - "privatekey_pass":"Your Private Key Password" - } + "auth_method": "keypair", + "auth_params": { + "privatekey_path": "Your Private Key Path", + "privatekey_pass": "Your Private Key Password" + } } ``` @@ -1421,9 +1434,9 @@ teradatasql://{user}:{password}@{host} #### ODBC Driver There's also an older connector named - [sqlalchemy-teradata](https://github.com/Teradata/sqlalchemy-teradata) that - requires the installation of ODBC drivers. The Teradata ODBC Drivers - are available +[sqlalchemy-teradata](https://github.com/Teradata/sqlalchemy-teradata) that +requires the installation of ODBC drivers. The Teradata ODBC Drivers +are available here: https://downloads.teradata.com/download/connectivity/odbc-driver/linux Here are the required environment variables: @@ -1434,8 +1447,8 @@ export ODBCINST=/.../teradata/client/ODBC_64/odbcinst.ini ``` We recommend using the first library because of the - lack of requirement around ODBC drivers and - because it's more regularly updated. +lack of requirement around ODBC drivers and +because it's more regularly updated. #### TimescaleDB @@ -1496,21 +1509,21 @@ You can provide `username`/`password` in the connection string or in the `Secure - In Connection String - ``` - trino://{username}:{password}@{hostname}:{port}/{catalog} - ``` + ``` + trino://{username}:{password}@{hostname}:{port}/{catalog} + ``` - In `Secure Extra` field - ```json - { - "auth_method": "basic", - "auth_params": { - "username": "", - "password": "" - } + ```json + { + "auth_method": "basic", + "auth_params": { + "username": "", + "password": "" } - ``` + } + ``` NOTE: if both are provided, `Secure Extra` always takes higher priority. @@ -1539,11 +1552,11 @@ In `Secure Extra` field, config as following example: ```json { - "auth_method": "certificate", - "auth_params": { - "cert": "/path/to/cert.pem", - "key": "/path/to/key.pem" - } + "auth_method": "certificate", + "auth_params": { + "cert": "/path/to/cert.pem", + "key": "/path/to/key.pem" + } } ``` @@ -1555,10 +1568,10 @@ Config `auth_method` and provide token in `Secure Extra` field ```json { - "auth_method": "jwt", - "auth_params": { - "token": "" - } + "auth_method": "jwt", + "auth_params": { + "token": "" + } } ``` @@ -1883,11 +1896,11 @@ If you enable DML in the meta database users will be able to run DML queries on Second, you might want to change the value of `SUPERSET_META_DB_LIMIT`. The default value is 1000, and defines how many are read from each database before any aggregations and joins are executed. You can also set this value `None` if you only have small tables. :::warning -`SUPERSET_META_DB_LIMIT` is applied to **each** underlying table *before* the in-memory join runs, not to the final result. If any table involved in a join has more rows than the limit, the meta database will read only the first `SUPERSET_META_DB_LIMIT` rows of that table, which means matching rows can be silently dropped and the join can return **incomplete or even empty** results with no error. If you join tables larger than the limit, raise `SUPERSET_META_DB_LIMIT` to comfortably exceed your largest joined table, or set it to `None` when working only with small tables, to get correct results. +`SUPERSET_META_DB_LIMIT` is applied to **each** underlying table _before_ the in-memory join runs, not to the final result. If any table involved in a join has more rows than the limit, the meta database will read only the first `SUPERSET_META_DB_LIMIT` rows of that table, which means matching rows can be silently dropped and the join can return **incomplete or even empty** results with no error. If you join tables larger than the limit, raise `SUPERSET_META_DB_LIMIT` to comfortably exceed your largest joined table, or set it to `None` when working only with small tables, to get correct results. ::: Additionally, you might want to restrict the databases to with the meta database has access to. This can be done in the database configuration, under "Advanced" -> "Other" -> "ENGINE PARAMETERS" and adding: ```json -{"allowed_dbs":["Google Sheets","examples"]} +{ "allowed_dbs": ["Google Sheets", "examples"] } ``` diff --git a/docs/user_docs_versioned_docs/version-6.0.0/configuration/importing-exporting-datasources.mdx b/docs/user_docs_versioned_docs/version-6.0.0/configuration/importing-exporting-datasources.mdx index 400d64590ad..1c6d91cfcbf 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/configuration/importing-exporting-datasources.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/configuration/importing-exporting-datasources.mdx @@ -117,10 +117,10 @@ datasets by saving the following YAML to file and then running the **import_data ```yaml databases: -- database_name: main - tables: - - table_name: random_time_series - columns: - - column_name: ds - verbose_name: datetime + - database_name: main + tables: + - table_name: random_time_series + columns: + - column_name: ds + verbose_name: datetime ``` diff --git a/docs/user_docs_versioned_docs/version-6.0.0/configuration/map-tiles.mdx b/docs/user_docs_versioned_docs/version-6.0.0/configuration/map-tiles.mdx index e83608c38bb..ceac0f45880 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/configuration/map-tiles.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/configuration/map-tiles.mdx @@ -18,7 +18,9 @@ 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'] @@ -26,6 +28,7 @@ DECKGL_BASE_MAP = [ ``` Default values are: + ```python DECKGL_BASE_MAP = [ ['https://tile.openstreetmap.org/{z}/{x}/{y}.png', 'Streets (OSM)'], @@ -46,6 +49,7 @@ 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. diff --git a/docs/user_docs_versioned_docs/version-6.0.0/configuration/networking-settings.mdx b/docs/user_docs_versioned_docs/version-6.0.0/configuration/networking-settings.mdx index abdea435e0d..d08c83df9b8 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/configuration/networking-settings.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/configuration/networking-settings.mdx @@ -8,12 +8,10 @@ version: 1 ## 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 @@ -63,7 +61,7 @@ Now anybody can directly access the dashboard's URL. You can embed it in an ifra width="600" height="400" seamless - frameBorder="0" + frameborder="0" scrolling="no" src="https://superset.my-domain.com/superset/dashboard/10/?standalone=1&height=400" > @@ -93,17 +91,17 @@ running a custom auth postback endpoint), you can add the endpoints to `WTF_CSRF ## 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 + - 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. + - 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. + - Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing. ## Domain Sharding diff --git a/docs/user_docs_versioned_docs/version-6.0.0/configuration/sql-templating.mdx b/docs/user_docs_versioned_docs/version-6.0.0/configuration/sql-templating.mdx index 500bad6fb3d..1fb8162dd44 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/configuration/sql-templating.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/configuration/sql-templating.mdx @@ -84,6 +84,7 @@ WHERE dttm_col > '{{ from_dttm | default("2024-01-01", true) }}' **Option 2: Use SQL Lab Parameters** Set parameters in the SQL Lab UI (Parameters menu): + ```json { "from_dttm": "2024-01-01", @@ -129,7 +130,7 @@ In the UI you can assign a set of parameters as JSON 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. +There is a special `_filters` parameter which can be used to test filters used in the jinja template. ```json { @@ -150,7 +151,7 @@ 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. +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 @@ -284,16 +285,19 @@ cache key by adding the following parameter to your Jinja code: ``` 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') ``` @@ -447,7 +451,7 @@ 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 +- `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. @@ -572,6 +576,7 @@ Dashboard filter without any value applied **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 %} diff --git a/docs/user_docs_versioned_docs/version-6.0.0/configuration/theming.mdx b/docs/user_docs_versioned_docs/version-6.0.0/configuration/theming.mdx index 1a32b59740a..89921c94a4e 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/configuration/theming.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/configuration/theming.mdx @@ -4,6 +4,7 @@ hide_title: true sidebar_position: 12 version: 1 --- + # Theming Superset :::note @@ -34,11 +35,13 @@ You can also extend with Superset-specific tokens (documented in the default the 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 @@ -46,6 +49,7 @@ When `ENABLE_UI_THEME_ADMINISTRATION = True` is configured, administrators can m ### 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 diff --git a/docs/user_docs_versioned_docs/version-6.0.0/contributing/contributing.mdx b/docs/user_docs_versioned_docs/version-6.0.0/contributing/contributing.mdx index 607fed1b24d..344010678ae 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/contributing/contributing.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/contributing/contributing.mdx @@ -129,7 +129,7 @@ Security team members must: - Have an [ICLA](https://www.apache.org/licenses/contributor-agreements.html) signed with Apache Software Foundation. - Not reveal information about pending and unfixed security issues to anyone (including their employers) unless specifically authorised by the security team members, e.g., if the security team agrees that diagnosing and solving an issue requires the involvement of external experts. -A release manager, the contributor overseeing the release of a specific version of Apache Superset, is by default a member of the security team. However, they are not expected to be active in assessing, discussing, and fixing security issues. +A release manager, the contributor overseeing the release of a specific version of Apache Superset, is by default a member of the security team. However, they are not expected to be active in assessing, discussing, and fixing security issues. Security team members should also follow these general expectations: diff --git a/docs/user_docs_versioned_docs/version-6.0.0/contributing/development.mdx b/docs/user_docs_versioned_docs/version-6.0.0/contributing/development.mdx index 3c12088d8ae..3ad159f6830 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/contributing/development.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/contributing/development.mdx @@ -3,6 +3,7 @@ title: Setting up a Development Environment sidebar_position: 3 version: 1 --- + # Setting up a Development Environment The documentation in this section is a bit of a patchwork of knowledge representing the @@ -123,6 +124,7 @@ docker-compose up ## GitHub Codespaces (Cloud Development) GitHub Codespaces provides a complete, pre-configured development environment in the cloud. This is ideal for: + - Quick contributions without local setup - Consistent development environments across team members - Working from devices that can't run Docker locally @@ -269,17 +271,21 @@ You can also run the pre-commit checks manually in various ways: ## Working with LLMs ### Environment Setup + Ensure Docker Compose is running before starting LLM sessions: + ```bash docker compose up ``` Validate your environment: + ```bash curl -f http://localhost:8088/health && echo "βœ… Superset ready" ``` ### LLM Session Best Practices + - Always validate environment setup first using the health checks above - Use focused validation commands: `pre-commit run` (not `--all-files`) - **Read [LLMS.md](https://github.com/apache/superset/blob/master/LLMS.md) first** - Contains comprehensive development guidelines, coding standards, and critical refactor information @@ -291,6 +297,7 @@ curl -f http://localhost:8088/health && echo "βœ… Superset ready" - Follow the TypeScript migration guidelines and avoid deprecated patterns listed in LLMS.md ### Key Development Commands + ```bash # Frontend development cd superset-frontend @@ -591,7 +598,7 @@ If you want to use the same flag in the client code, also add it to the FeatureF ```typescript export enum FeatureFlag { - SCOPED_FILTER = "SCOPED_FILTER", + SCOPED_FILTER = 'SCOPED_FILTER', } ``` @@ -884,9 +891,9 @@ VSCode will not stop on breakpoints right away. We've attached to PID 6 however To debug Flask running in POD inside a kubernetes cluster, you'll need to make sure the pod runs as root and is granted the SYS_TRACE capability.These settings should not be used in production environments. ```yaml - securityContext: - capabilities: - add: ["SYS_PTRACE"] +securityContext: + capabilities: + add: ['SYS_PTRACE'] ``` See [set capabilities for a container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container) for more details. diff --git a/docs/user_docs_versioned_docs/version-6.0.0/contributing/guidelines.mdx b/docs/user_docs_versioned_docs/version-6.0.0/contributing/guidelines.mdx index a6d609744d6..4e3c4e2e248 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/contributing/guidelines.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/contributing/guidelines.mdx @@ -107,8 +107,8 @@ Triaging goals First, add **Category labels (a.k.a. hash labels)**. Every issue/PR must have one hash label (except spam entry). Labels that begin with `#` defines issue/PR type: -| Label | for Issue | for PR | -| --------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| Label | for Issue | for PR | +| --------------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | `#bug` | Bug report | Bug fix | | `#code-quality` | Describe problem with code, architecture or productivity | Refactor, tests, tooling | | `#feature` | New feature request | New feature implementation | diff --git a/docs/user_docs_versioned_docs/version-6.0.0/contributing/howtos.mdx b/docs/user_docs_versioned_docs/version-6.0.0/contributing/howtos.mdx index b592c630e2d..46e0281135b 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/contributing/howtos.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/contributing/howtos.mdx @@ -4,6 +4,7 @@ hide_title: true sidebar_position: 4 version: 1 --- + # Development How-tos ## Contributing to Documentation @@ -230,10 +231,11 @@ For E2E testing, we recommend that you use a `docker compose` backend ```bash CYPRESS_CONFIG=true docker compose up --build ``` + `docker compose` will get to work and expose a Cypress-ready Superset app. This app uses a different database schema (`superset_cypress`) to keep it isolated from your other dev environment(s), a specific set of examples, and a set of configurations that -aligns with the expectations within the end-to-end tests. Also note that it's served on a +aligns with the expectations within the end-to-end tests. Also note that it's served on a different port than the default port for the backend (`8088`). Now in another terminal, let's get ready to execute some Cypress commands. First, tell cypress @@ -374,24 +376,24 @@ You are now ready to attach a debugger to the process. Using VSCode you can conf ```json { - "version": "0.2.0", - "configurations": [ + "version": "0.2.0", + "configurations": [ + { + "name": "Attach to Superset App in Docker Container", + "type": "python", + "request": "attach", + "connect": { + "host": "127.0.0.1", + "port": 5678 + }, + "pathMappings": [ { - "name": "Attach to Superset App in Docker Container", - "type": "python", - "request": "attach", - "connect": { - "host": "127.0.0.1", - "port": 5678 - }, - "pathMappings": [ - { - "localRoot": "${workspaceFolder}", - "remoteRoot": "/app" - } - ] - }, - ] + "localRoot": "${workspaceFolder}", + "remoteRoot": "/app" + } + ] + } + ] } ``` @@ -402,9 +404,9 @@ VSCode will not stop on breakpoints right away. We've attached to PID 6 however To debug Flask running in POD inside a kubernetes cluster, you'll need to make sure the pod runs as root and is granted the `SYS_TRACE` capability. These settings should not be used in production environments. ```yaml - securityContext: - capabilities: - add: ["SYS_PTRACE"] +securityContext: + capabilities: + add: ['SYS_PTRACE'] ``` See [set capabilities for a container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container) for more details. @@ -459,7 +461,7 @@ In TypeScript/JavaScript, the technique is similar: we import `t` (simple translation), `tn` (translation containing a number). ```javascript -import { t, tn } from "@superset-ui/translation"; +import { t, tn } from '@superset-ui/translation'; ``` ### Enabling language selection @@ -612,7 +614,7 @@ If using the eslint extension with vscode, put the following in your workspace ` ## GitHub Ephemeral Environments On any given pull request on GitHub, it's possible to create a temporary environment/deployment -by simply adding the label `testenv-up` to the PR. Once you add the `testenv-up` label, a +by simply adding the label `testenv-up` to the PR. Once you add the `testenv-up` label, a GitHub Action will be triggered that will: - build a docker image diff --git a/docs/user_docs_versioned_docs/version-6.0.0/contributing/resources.mdx b/docs/user_docs_versioned_docs/version-6.0.0/contributing/resources.mdx index 49db61f0bc2..696920e2eea 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/contributing/resources.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/contributing/resources.mdx @@ -9,23 +9,24 @@ import Mermaid from '@theme/Mermaid'; # Resources ## High Level Architecture +
      ```mermaid flowchart TD - %% Top Level - LB["Load Balancer(s)
      (optional)"] - LB -.-> WebServers +%% Top Level +LB["Load Balancer(s)
      (optional)"] +LB -.-> WebServers - %% Web Servers - subgraph WebServers ["Web Server(s)"] - WS1["Frontend
      (React, AntD, ECharts, AGGrid)"] - WS2["Backend
      (Python, Flask, SQLAlchemy, Pandas, ...)"] - end +%% Web Servers +subgraph WebServers ["Web Server(s)"] +WS1["Frontend
      (React, AntD, ECharts, AGGrid)"] +WS2["Backend
      (Python, Flask, SQLAlchemy, Pandas, ...)"] +end - %% Infra - subgraph InfraServices ["Infra"] - DB[("Metadata Database
      (Postgres / MySQL)")] +%% Infra +subgraph InfraServices ["Infra"] +DB[("Metadata Database
      (Postgres / MySQL)")] subgraph Caching ["Caching Subservices
      (Redis, memcache, S3, ...)"] direction LR @@ -34,62 +35,62 @@ flowchart TD CsvCache["CSV Exports Cache"] ThumbnailCache["Thumbnails Cache"] AlertImageCache["Alert/Report Images Cache"] - QueryCache -- " " --> CsvCache - linkStyle 1 stroke:transparent; + QueryCache -- " " --> CsvCache + linkStyle 1 stroke:transparent; ThumbnailCache -- " " --> AlertImageCache - linkStyle 2 stroke:transparent; + linkStyle 2 stroke:transparent; end Broker(("Message Queue
      (Redis / RabbitMQ / SQS)")) - end - AsyncBackend["Async Workers (Celery)
      required for Alerts & Reports, thumbnails, CSV exports, long-running workloads, ..."] +end - %% External DBs - subgraph ExternalDatabases ["Analytics Databases"] - direction LR - BigQuery[(BigQuery)] - Snowflake[(Snowflake)] - Redshift[(Redshift)] - Postgres[(Postgres)] - Postgres[(... any ...)] - end +AsyncBackend["Async Workers (Celery)
      required for Alerts & Reports, thumbnails, CSV exports, long-running workloads, ..."] - %% Connections - LB -.-> WebServers - WebServers --> DB - WebServers -.-> Caching - WebServers -.-> Broker - WebServers -.-> ExternalDatabases +%% External DBs +subgraph ExternalDatabases ["Analytics Databases"] +direction LR +BigQuery[(BigQuery)] +Snowflake[(Snowflake)] +Redshift[(Redshift)] +Postgres[(Postgres)] +Postgres[(... any ...)] +end - Broker -.-> AsyncBackend +%% Connections +LB -.-> WebServers +WebServers --> DB +WebServers -.-> Caching +WebServers -.-> Broker +WebServers -.-> ExternalDatabases - AsyncBackend -.-> ExternalDatabases - AsyncBackend -.-> Caching +Broker -.-> AsyncBackend +AsyncBackend -.-> ExternalDatabases +AsyncBackend -.-> Caching +%% Legend styling +classDef requiredNode stroke-width:2px,stroke:black; +class Required requiredNode; +class Optional optionalNode; - %% Legend styling - classDef requiredNode stroke-width:2px,stroke:black; - class Required requiredNode; - class Optional optionalNode; +%% Hide real arrow +linkStyle 0 stroke:transparent; - %% Hide real arrow - linkStyle 0 stroke:transparent; +%% Styling +classDef optionalNode stroke-dasharray: 5 5, opacity:0.9; +class LB optionalNode; +class Caching optionalNode; +class AsyncBackend optionalNode; +class Broker optionalNode; +class QueryCache optionalNode; +class CsvCache optionalNode; +class ThumbnailCache optionalNode; +class AlertImageCache optionalNode; +class Celery optionalNode; - %% Styling - classDef optionalNode stroke-dasharray: 5 5, opacity:0.9; - class LB optionalNode; - class Caching optionalNode; - class AsyncBackend optionalNode; - class Broker optionalNode; - class QueryCache optionalNode; - class CsvCache optionalNode; - class ThumbnailCache optionalNode; - class AlertImageCache optionalNode; - class Celery optionalNode; +classDef invisible fill:transparent,stroke:transparent; - classDef invisible fill:transparent,stroke:transparent; ```
      @@ -102,3 +103,4 @@ Here is our interactive ERD:
      [Download the .svg](https://github.com/apache/superset/tree/master/docs/static/img/erd.svg) +``` diff --git a/docs/user_docs_versioned_docs/version-6.0.0/faq.mdx b/docs/user_docs_versioned_docs/version-6.0.0/faq.mdx index cbd4da1edca..12a902823e0 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/faq.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/faq.mdx @@ -7,7 +7,7 @@ sidebar_position: 9 ## 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 +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 @@ -17,7 +17,7 @@ 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 +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. @@ -101,10 +101,10 @@ Metadata field: ```json { - "filter_immune_slices": [], - "expanded_slices": {}, - "filter_immune_slice_fields": {}, - "timed_refresh_immune_slices": [324] + "filter_immune_slices": [], + "expanded_slices": {}, + "filter_immune_slice_fields": {}, + "timed_refresh_immune_slices": [324] } ``` @@ -117,8 +117,8 @@ value in milliseconds in the JSON Metadata field: ```json { - "stagger_refresh": false, - "stagger_time": 2500 + "stagger_refresh": false, + "stagger_time": 2500 } ``` @@ -161,8 +161,8 @@ information like your list of users and dashboard definitions. While Superset su 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_ +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. @@ -180,11 +180,11 @@ second etc). Example: ```json { - "label_colors": { - "foo": "#FF69B4", - "bar": "lightblue", - "baz": 0 - } + "label_colors": { + "foo": "#FF69B4", + "bar": "lightblue", + "baz": 0 + } } ``` @@ -250,8 +250,8 @@ guarantees and are not recommended but may fit your use case temporarily: ## 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 +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? diff --git a/docs/user_docs_versioned_docs/version-6.0.0/installation/architecture.mdx b/docs/user_docs_versioned_docs/version-6.0.0/installation/architecture.mdx index 92011884783..d7c1e317294 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/installation/architecture.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/installation/architecture.mdx @@ -5,7 +5,7 @@ sidebar_position: 1 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +import useBaseUrl from '@docusaurus/useBaseUrl'; # Architecture diff --git a/docs/user_docs_versioned_docs/version-6.0.0/installation/docker-builds.mdx b/docs/user_docs_versioned_docs/version-6.0.0/installation/docker-builds.mdx index 73bf4dd26d6..9294afa2a55 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/installation/docker-builds.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/installation/docker-builds.mdx @@ -11,8 +11,7 @@ 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. +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 diff --git a/docs/user_docs_versioned_docs/version-6.0.0/installation/docker-compose.mdx b/docs/user_docs_versioned_docs/version-6.0.0/installation/docker-compose.mdx index 030fc6ff168..3d6d77f8a8e 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/installation/docker-compose.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/installation/docker-compose.mdx @@ -5,12 +5,13 @@ sidebar_position: 5 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +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** @@ -29,23 +30,23 @@ 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 + 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 + 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 + 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. + `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. @@ -92,7 +93,7 @@ like to try out Superset without making any code changes follow the steps docume :::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 +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. @@ -121,6 +122,7 @@ 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 @@ -165,7 +167,7 @@ looking to fire up. :::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 +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. @@ -174,7 +176,7 @@ 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 +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 @@ -258,24 +260,24 @@ Superset (which is running in its docker container). Other databases may have sl 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. + 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. + (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 diff --git a/docs/user_docs_versioned_docs/version-6.0.0/installation/installation-methods.mdx b/docs/user_docs_versioned_docs/version-6.0.0/installation/installation-methods.mdx index 03db4c38bbb..06d768eb95e 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/installation/installation-methods.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/installation/installation-methods.mdx @@ -5,7 +5,7 @@ sidebar_position: 2 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +import useBaseUrl from '@docusaurus/useBaseUrl'; # Installation Methods diff --git a/docs/user_docs_versioned_docs/version-6.0.0/installation/kubernetes.mdx b/docs/user_docs_versioned_docs/version-6.0.0/installation/kubernetes.mdx index 14e833600c3..b963bef02b7 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/installation/kubernetes.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/installation/kubernetes.mdx @@ -1,16 +1,17 @@ --- -title: Kubernetes +title: Kubernetes hide_title: true sidebar_position: 3 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +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). @@ -134,7 +135,7 @@ init: ``` :::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. +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. ::: @@ -195,7 +196,7 @@ Those can be passed as key/values either with `extraEnv` or `extraSecretEnv` if extraEnv: SMTP_HOST: smtp.gmail.com SMTP_USER: user@gmail.com - SMTP_PORT: "587" + SMTP_PORT: '587' SMTP_MAIL_FROM: user@gmail.com extraSecretEnv: @@ -356,7 +357,7 @@ supersetCeleryBeat: extraEnv: SMTP_HOST: smtp.gmail.com SMTP_USER: user@gmail.com - SMTP_PORT: "587" + SMTP_PORT: '587' SMTP_MAIL_FROM: user@gmail.com extraSecretEnv: diff --git a/docs/user_docs_versioned_docs/version-6.0.0/installation/pypi.mdx b/docs/user_docs_versioned_docs/version-6.0.0/installation/pypi.mdx index 14228c20812..c35e4db33be 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/installation/pypi.mdx +++ b/docs/user_docs_versioned_docs/version-6.0.0/installation/pypi.mdx @@ -5,12 +5,13 @@ sidebar_position: 4 version: 1 --- -import useBaseUrl from "@docusaurus/useBaseUrl"; +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/). @@ -23,6 +24,7 @@ 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 @@ -133,6 +135,7 @@ 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/docs/configuration/configuring-superset#specifying-a-secret_key export FLASK_APP=superset diff --git a/docs/user_docs_versioned_docs/version-6.0.0/intro.md b/docs/user_docs_versioned_docs/version-6.0.0/intro.md index c6a159b10fc..90ebf59be35 100644 --- a/docs/user_docs_versioned_docs/version-6.0.0/intro.md +++ b/docs/user_docs_versioned_docs/version-6.0.0/intro.md @@ -2,6 +2,7 @@ hide_title: true sidebar_position: 1 --- + - + + diff --git a/docs/user_docs_versioned_docs/version-6.1.0/intro.md b/docs/user_docs_versioned_docs/version-6.1.0/intro.md index 67459ad42ea..1b45d94d54c 100644 --- a/docs/user_docs_versioned_docs/version-6.1.0/intro.md +++ b/docs/user_docs_versioned_docs/version-6.1.0/intro.md @@ -2,6 +2,7 @@ hide_title: true sidebar_position: 1 --- +