mirror of
https://github.com/apache/superset.git
synced 2026-05-11 02:45:46 +00:00
fix(docs): regenerate 6.1.0 snapshots with depth-aware import rewriter
The previous import-path fixer only matched two-level relative paths (`../../src/` and `../../data/`), missing files at deeper nesting in the section tree. After the 6.1.0 cut for developer_docs, ~50 component MDX files at depth 3 still referenced `../../../src/components/StorybookWrapper` (should have been `../../../../src/...`), and the components Button page referenced `../../../superset-frontend/...` (should have been `../../../../superset-frontend/...`). The Docusaurus production build failed with module-not-found errors as a result. Replace the pattern-specific regex with a depth-aware walker that - counts the file's nesting depth within the snapshot, - bumps any relative import whose `../` count exceeds that depth (i.e. the import escapes the section root and so must compensate for the extra `version-X.X.X/` directory the snapshot lives under), - skips fenced code blocks so documented sample imports (e.g. Playwright page-object examples in developer_docs/testing/e2e-testing.md) are not rewritten. Re-cut all four sections under the new fixer. yarn build now passes locally.
This commit is contained in:
@@ -5,7 +5,7 @@ description: "Advanced Data Type"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
Endpoints for advanced data type operations and conversions.
|
||||
Advanced data type operations and conversions.
|
||||
|
||||
| Method | Endpoint | Path |
|
||||
|--------|----------|------|
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Themes bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: bulk-delete-themes
|
||||
title: "Bulk delete themes"
|
||||
description: "Bulk delete themes"
|
||||
sidebar_label: "Bulk delete themes"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFVttu3DYQ/RVi0IcYlb22kQKGgjw4roMkNRKju24LWMaGK41XsilSIUcbbwX+ezGkVnvxFkj74idJFOfMOXMjO2iklTUSWgfpbQe50YSaIO1ANo2qckmV0aMHZzSvubzEWvJbRVg7fqFlg5BCpQnnaMEnqxVprVxCAlSR4u850rRAhYTTqnDTHsp7n0ClIYVvLVrer2XN27+Bv0vAomuMdhhcnR4f8+OHOTbWNGipitY1OifnuMHZka30HPyas5k9YE4sAp9k3SjcMlwb+AQKdLmtGnYNKUxKrNGJWaseRRTJIK+PT16W8I2WLZXGVn9jkYrzlkrU1PsXFr+1lcVin55Nw6jk9csq+WxI3JtWF6mYlBi4oyMshEVnWpujKAw6oQ0JfKoc7RM1YARFp6cvnZvGmpw/ZwoF54WWqfhDqqqI+UFrjd2n48K0qghSe4Teml398tI98lETWi2VcGgXaKOKVJxr0Wp8ajDnpIVFYfK8tf9SgO8lSTWEIAGHeWtZI0+ph+8E6e0dDwiSc55cfQPCXQJPh7kpcByoxaGmpJ5DCvnN71eQgJIzVOvPWD383VolDv8Sv15eXU4uRQYlUZOORsrkUpXGUXp2fHY2kk01WpyMiP2NMhBZlmkhDj+IDM77lgmxTsU7lBat+On84uJyPJ5Ovvx2+TkD8MnA6HpJpdEbnIaFgVVVN8bSqt5dpjO9moni7bB8FGfOK6YifpR6EneXKAu07m23IyCDVGTQi8hA/CxkzsU2JfOI2mf6INONrTS9WhE6ciSpdVOO/8Gmzk9yIcchuRtatxbXWTDasdxBovwuKxL3SHkZ5P0XcV1UWCOVpmA1Mbe70tPVRrGbRI7B11Ueu6h/EuR/jRaeHxyLN5lm6kbhkTLz3ZAcvAmn2XaJv1sfFoJi+SYQuUIK/SmSQCOphBS2BXLIQn/FCm8tR3RvYGDX7RX/FgUuUJmmRk19p4aERaCusYZMbpRPR6OOoXzacR36Z2gXrSNTryASWEhb8UBz/XAJMPxe4L1sFfU0IQHUbc2d23/yI/TvNv6HyeRaDDg+AWazjTfofUZuHEcQ/+NbhTBWfLxmENayDbI3VL192O09Z3A1hsZ5TFjaD6MOZqFK3htbS8b79OeEcxS2Qdr/hWGIBtE+YeOpxXuLrvy/IOH+dG+inC32bYPWIW3cwTaWuHbivsVJDImjWobTob+B7a3PLRfDKUH4RKNGyUozVCiiri/cW5BNxf5OmEdQkgDnOSbyFrpuJh3eWOU9L8drIBf1jqvhSIN1BLb9PuIyXBy5ClXL/0PXrUoyHBkJxKYPHqLBeZ5jGEIrq2cnJqMMjRlnCCTAN6SNGAzZ6V/YweoqrJcb8F0Xd8RBwi0VeYS5Cv7Oe/8P7HX75w==
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Bulk delete themes"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/theme/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Bulk delete themes
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./bulk-delete-themes.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./bulk-delete-themes.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./bulk-delete-themes.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -13,8 +13,8 @@ Create, read, update, and delete charts (slices).
|
||||
| `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}` |
|
||||
| `GET` | [Get a chart detail information](./get-a-chart-detail-information) | `/api/v1/chart/{pk}` |
|
||||
| `PUT` | [Update a chart](./update-a-chart) | `/api/v1/chart/{pk}` |
|
||||
| `GET` | [Compute and cache a screenshot (chart-pk-cache-screenshot)](./compute-and-cache-a-screenshot-chart-pk-cache-screenshot) | `/api/v1/chart/{pk}/cache_screenshot/` |
|
||||
| `GET` | [Return payload data response for a chart](./return-payload-data-response-for-a-chart) | `/api/v1/chart/{pk}/data/` |
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"},"example":{"result":"string"}}},"description":"System dark theme cleared"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
id: clear-the-system-dark-theme
|
||||
title: "Clear the system dark theme"
|
||||
description: "Clear the system dark theme"
|
||||
sidebar_label: "Clear the system dark theme"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFVm1v2zYQ/ivEYcAaTImTvQABi37wMgdtF2zB7GAbIsOlqUukRCJV8uTGE/TfhyNlxXYyFGsG7JNo8u74PPfy0C049LU1Hj3IFr49PuaPtobQEC9VXZeFVlRYM7rz1vCe1zlWile1szU6KqK3Q9+UwYvWNYIET64wt9B1yWbHLu9QE3QJ4IOq6hK3/R7tuwQy9NoVNV8MEqZrT1iJTLl7QTlWKHSJymHGob4/PnkB6gq9V7f472EPjnBlVEO5dcVfmEkxbihHQ/39wuHHpghIn9LadoxMvvt/mZxbtyyyDI0Uf9pGZNZ8TSJXKxQ1uqrwnhmRFUpr9F5QXnjh0NvGaXyO4BCPb/zhRd31H7B7ZwidUaXw6FboBDpnnRRjIxqDDzVqwixuCqt14/6haueKVBntwuUedeMKWoO8buHuE4G8nnfzBEjdepDXMOOG9TBP4OFQ2wynAZoP5qUytyBBX/12AQmUaonl488+rxJ040px+If4aXIxmU1ECjlRLUej0mpV5taTPD0+PR2puhitTkZhQEaN8UgLHwZnwYOTgkjT1Ahx+FakMO4bLyRfih95mpz4anx2NplOF7Nff578kgJ0yQDxck25NVsgh40BZlHV1lHoePTkU5OajbyIN8P2UYYlEr5iKOKLuSTRPUeVofNv2j1GKUiRQs8qBfFN37ILsvdoutQcpKZ2haFXG4RHnhQ1fsEVOtgm/l6t1DSUf4v8zuZjnazxzH/grD6pgsQNks4D3xexbSPlCim3GdOL7bCfC7kxFPtl5qR82FS6jQmZhXx8iB4dfzg5r1PDXGyJR6W93c/RwWvg/t6dijMWZBZn4ffFGhKIoEFCLD4kUCvKQcJnqHN2w7DGcWkcJ//ZHMI+oAs+FhmusLR1hYb6sQ+1jYHa2lmy2padHI1aDtXJlnu4exLtrPFkq02IBFbKFWpZRm3ahOF1hjcqPmcMExJA01QsA/1P/gQx2I3/dja7FEOcLgFGsxtv4PsE3DTqGZ8ZVaGwTry75CDMZTfIs6nq/YN113FtN5o21VG8ZK9sLSxD/5xbVymO9/73GdcomIHsT2FQ5EC6S9h54fDGoc+/NEiXQGFubKSzg76p0XnktFBBLPrbW9w70W51ElPiqVLhqeFcfbZzd+4a3h7CBxrVpSrCyxa6qe1b+hpUXfDFJwyoj/K0seebEl9D2y6VxytXdh1vf2zQ8WMyf+yy8KQkECc8TMI9rkHCWGsMErRSZcO4nryoXMxh+KJgQAL8t2OLzZDwfsEX9EfKrLfCt220iKrBUxJxBFWFbt513d/O2JHE
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Clear the system dark theme"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/theme/unset_system_dark"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Clear the system dark theme
|
||||
|
||||
<ParamsDetails>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./clear-the-system-dark-theme.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./clear-the-system-dark-theme.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"},"example":{"result":"string"}}},"description":"System default theme cleared"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
id: clear-the-system-default-theme
|
||||
title: "Clear the system default theme"
|
||||
description: "Clear the system default theme"
|
||||
sidebar_label: "Clear the system default theme"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFVmtv2zYU/SvExYA1mBInewABi37IsgRtF3TB7GAbIsOlpZtILUWq5JUbT+B/Hy4pK3aSYY8M2CfRfByecx+H7sGhb63x6EH28PXhIX8KawgN8VC1ra4LRbU1kw/eGp7zRYWN4lHrbIuO6nTaoe90PEXrFkGCJ1ebWwgh28zY5QcsCEIGeKeaVuP2ufv9IYMSfeHqli8GCdO1J2xEiTeq0ySowgZFoVE5LBnt28OjZxBv0Ht1i/+c+XgQrozqqLKu/h1LKU46qtDQcL9w+KmrI9PHyrYPJiXf/L9Kzq1b1mWJRorfbCdKa74kUakVihZdU3vPisgKVRTovaCq9sKht50r8CmBIx7f+N2zCuw/UPfGEDqjtPDoVugEOmedFCdGdAbvWiwIyzQpbFF07k+ydq5I6bQvXu6x6FxNa5DXPXz4TCCv52GeAalbD/IaZlywHuYZ3O0XtsRppObjdq3MLUgorn6+gAy0WqK+/znEVULROS32fxU/nF2czc5EDhVRKycTbQulK+tJHh8eH09UW09WR5PYIJPOeKSFj72zGHonB5HnuRFi/7XI4WSovRh/Kb7nhnLii5PT07PpdDH76cezdzlAyEaWl2uqrNniOU6MTOumtY5i0aMnn5vcbExGvBqnD0rUSPiCqYjnyMkSQoWqROdf9Q9E5SBFDoOwHMRXQ+EuyH5EE3Kzl5vW1YZebEgeeFLU+QXnaW9b+1u1UtNYBFv6dybvs2WN5xCMstVnVZO4QSqqKPm5gvukukGqbMkKU108DIfcbBQPk81xeb/Jd59iMosheZ9OBP5wfF7mhuVYjQfa3j4M095L4ELfbY9TdmZ2aeGfMG7IIPEGCakKIINWUQUS/joAHObYu6l7OsdZeDKY8JDWBS+LEleobdugocEFYpITUN86S7awOsjJpGeoIHuu5/AI7bTzZJsNRAYr5Wq11MmqNjA83hBPNCEDNF3DrjD85E/0hl3817PZpRhxQgbMZhdv1PuI3DTZG68Z1aCwTry5ZBDWsgvyZKiG83F3CJzhjcVNi+RlcjC6Hpaxis6taxTjvf1lxjmK20AOqzAadBQdMj68cHjj0Ff/FiRkUJsbm+TssO9adB45LFQTvwHbU1w7ad/qKIXEU6Piy8Ox+jv1u3Pd+BoR3tGk1aqOb10sqH4o7GtQbc13HzGnAeXJ8p5vEn0Nfb9UHq+cDoGnP3Xo+IWZ39dafGcySN0e++EjrkHCSVFgdKSV0h1Te/TMckrHLkzmARnwf5EtQWPYhwFfMCwps96C7/u0IzkI90riEU0WwjyE8AdoS5vc
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Clear the system default theme"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/theme/unset_system_default"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Clear the system default theme
|
||||
|
||||
<ParamsDetails>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./clear-the-system-default-theme.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./clear-the-system-default-theme.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"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}}
|
||||
@@ -0,0 +1 @@
|
||||
{"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"}}}
|
||||
@@ -0,0 +1,66 @@
|
||||
---
|
||||
id: 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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create a theme"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/theme/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create a theme
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./create-a-theme.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./create-a-theme.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"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}}
|
||||
@@ -0,0 +1 @@
|
||||
{"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"}}}
|
||||
@@ -0,0 +1,66 @@
|
||||
---
|
||||
id: 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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create security groups"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/security/groups/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create security groups
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./create-security-groups.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./create-security-groups.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.post"},"example":{"id":1}}},"description":"Model schema","required":true}}
|
||||
@@ -0,0 +1 @@
|
||||
{"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"}}}
|
||||
@@ -0,0 +1,66 @@
|
||||
---
|
||||
id: 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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create security user registrations"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/security/user_registrations/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create security user registrations
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./create-security-user-registrations.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./create-security-user-registrations.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -5,9 +5,10 @@ description: "Current User"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
Get information about the currently authenticated user.
|
||||
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/` |
|
||||
|
||||
@@ -5,7 +5,7 @@ description: "Dashboard Permanent Link"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
Create and retrieve permanent links to dashboard states.
|
||||
Permanent links to dashboard states.
|
||||
|
||||
| Method | Endpoint | Path |
|
||||
|--------|----------|------|
|
||||
|
||||
@@ -25,7 +25,9 @@ Create, read, update, and delete dashboards.
|
||||
| `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` |
|
||||
|
||||
@@ -23,7 +23,6 @@ Manage database connections and metadata.
|
||||
| `GET` | [Get all schemas from a database](./get-all-schemas-from-a-database) | `/api/v1/database/{pk}/schemas/` |
|
||||
| `GET` | [Get database select star for table (database-pk-select-star-table-name)](./get-database-select-star-for-table-database-pk-select-star-table-name) | `/api/v1/database/{pk}/select_star/{table_name}/` |
|
||||
| `GET` | [Get database select star for table (database-pk-select-star-table-name-schema-name)](./get-database-select-star-for-table-database-pk-select-star-table-name-schema-name) | `/api/v1/database/{pk}/select_star/{table_name}/{schema_name}/` |
|
||||
| `DELETE` | [Delete a SSH tunnel](./delete-a-ssh-tunnel) | `/api/v1/database/{pk}/ssh_tunnel/` |
|
||||
| `POST` | [Re-sync all permissions for a database connection](./re-sync-all-permissions-for-a-database-connection) | `/api/v1/database/{pk}/sync_permissions/` |
|
||||
| `GET` | [Get table extra metadata (database-pk-table-extra-table-name-schema-name)](./get-table-extra-metadata-database-pk-table-extra-table-name-schema-name) | `/api/v1/database/{pk}/table_extra/{table_name}/{schema_name}/` |
|
||||
| `GET` | [Get table metadata](./get-table-metadata) | `/api/v1/database/{pk}/table_metadata/` |
|
||||
|
||||
@@ -13,13 +13,14 @@ Manage datasets (tables) used for building charts.
|
||||
| `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}` |
|
||||
| `GET` | [Get a dataset](./get-a-dataset) | `/api/v1/dataset/{pk}` |
|
||||
| `PUT` | [Update a dataset](./update-a-dataset) | `/api/v1/dataset/{pk}` |
|
||||
| `DELETE` | [Delete a dataset column](./delete-a-dataset-column) | `/api/v1/dataset/{pk}/column/{column_id}` |
|
||||
| `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 charts and dashboards count associated to a dataset](./get-charts-and-dashboards-count-associated-to-a-dataset) | `/api/v1/dataset/{pk}/related_objects` |
|
||||
| `GET` | [Get distinct values from field data (dataset-distinct-column-name)](./get-distinct-values-from-field-data-dataset-distinct-column-name) | `/api/v1/dataset/distinct/{column_name}` |
|
||||
| `POST` | [Duplicate a dataset](./duplicate-a-dataset) | `/api/v1/dataset/duplicate` |
|
||||
| `GET` | [Download multiple datasets as YAML files](./download-multiple-datasets-as-yaml-files) | `/api/v1/dataset/export/` |
|
||||
|
||||
@@ -10,3 +10,4 @@ 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/` |
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"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"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: 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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Delete a theme"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/theme/{pk}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Delete a theme
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./delete-a-theme.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./delete-a-theme.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./delete-a-theme.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
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"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Delete security groups by pk"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/security/groups/{pk}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Delete security groups by pk
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./delete-security-groups-by-pk.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./delete-security-groups-by-pk.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./delete-security-groups-by-pk.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
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"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Delete security user registrations by pk"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/security/user_registrations/{pk}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Delete security user registrations by pk
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./delete-security-user-registrations-by-pk.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./delete-security-user-registrations-by-pk.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./delete-security-user-registrations-by-pk.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"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"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
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"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Download multiple themes as YAML files"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/theme/export/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Download multiple themes as YAML files
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./download-multiple-themes-as-yaml-files.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./download-multiple-themes-as-yaml-files.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./download-multiple-themes-as-yaml-files.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -5,7 +5,7 @@ description: "Explore Permanent Link"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
Create and retrieve permanent links to chart explore states.
|
||||
Permanent links to chart explore states.
|
||||
|
||||
| Method | Endpoint | Path |
|
||||
|--------|----------|------|
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
{"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"}}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"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"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
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"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Export dashboard as example bundle"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/dashboard/{pk}/export_as_example/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./export-dashboard-as-example-bundle.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./export-dashboard-as-example-bundle.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./export-dashboard-as-example-bundle.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"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}}
|
||||
@@ -0,0 +1 @@
|
||||
{"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"}}}
|
||||
@@ -0,0 +1,66 @@
|
||||
---
|
||||
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"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Export SQL query results to CSV with streaming"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/sqllab/export_streaming/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Export SQL query results to CSV with streaming
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./export-sql-query-results-to-csv-with-streaming.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./export-sql-query-results-to-csv-with-streaming.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"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"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"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"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
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"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get a list of themes"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/theme/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Gets a list of themes, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-a-list-of-themes.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-a-list-of-themes.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-a-list-of-themes.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"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"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: 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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get a theme"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/theme/{pk}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get an item model
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-a-theme.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-a-theme.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-a-theme.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"description":"The dataset ID","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"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"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: 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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get dataset drill info"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/dataset/{pk}/drill_info/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get dataset drill info
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-dataset-drill-info.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-dataset-drill-info.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-dataset-drill-info.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of distinct values","type":"integer"},"result":{"items":{"properties":{"text":{"description":"The distinct item","type":"string"}},"type":"object","title":"DistinctResultResponse"},"type":"array"}},"type":"object","title":"DistincResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Distinct field data"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
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)"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get distinct values from field data (security-user-registrations-distinct-column-name)"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/security/user_registrations/distinct/{column_name}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get distinct values from field data (security-user-registrations-distinct-column-name)
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
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)"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get metadata information about this API resource (theme--info)"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/theme/_info"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get metadata information about this API resource
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-metadata-information-about-this-api-resource-theme-info.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-metadata-information-about-this-api-resource-theme-info.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-metadata-information-about-this-api-resource-theme-info.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
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)"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get related fields data (security-user-registrations-related-column-name)"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/security/user_registrations/related/{column_name}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get related fields data (security-user-registrations-related-column-name)
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-related-fields-data-security-user-registrations-related-column-name.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-related-fields-data-security-user-registrations-related-column-name.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-related-fields-data-security-user-registrations-related-column-name.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
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)"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get related fields data (theme-related-column-name)"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/theme/related/{column_name}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get related fields data (theme-related-column-name)
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-related-fields-data-theme-related-column-name.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-related-fields-data-theme-related-column-name.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-related-fields-data-theme-related-column-name.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"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"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: 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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get security groups by pk"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/security/groups/{pk}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get an item model
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-security-groups-by-pk.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-security-groups-by-pk.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-security-groups-by-pk.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: 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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get security groups info"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/security/groups/_info"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get metadata information about this API resource
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-security-groups-info.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-security-groups-info.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-security-groups-info.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"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"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"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"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: 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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get security groups"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/security/groups/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get a list of models
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-security-groups.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-security-groups.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-security-groups.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"id":{"type":"integer"}},"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"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
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"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get security user registrations by pk"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/security/user_registrations/{pk}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get an item model
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-security-user-registrations-by-pk.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-security-user-registrations-by-pk.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-security-user-registrations-by-pk.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
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"
|
||||
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"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get security user registrations info"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/security/user_registrations/_info"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get metadata information about this API resource
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./get-security-user-registrations-info.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./get-security-user-registrations-info.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./get-security-user-registrations-info.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"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"}]}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user