mirror of
https://github.com/apache/superset.git
synced 2026-05-08 09:25:56 +00:00
docs: cut 6.1.0 versions for docs, admin_docs, developer_docs, components
- Snapshot all four versioned docs sections at v6.1.0; master continues to serve as "Next" (lastVersion: current, banner: unreleased) so editing master keeps updating the canonical URLs - Enable the previously-disabled components plugin and version it - Rename stale "developer_portal" references to "developer_docs" across package.json scripts, manage-versions.mjs, theme files (DocVersionBadge, DocVersionBanner), DOCS_CLAUDE.md, and README.md (URL backward-compat redirect /developer_portal/* preserved) - Add admin_docs version scripts; drop dead "tutorials" plugin id from the version badge - Generalize fixVersionedImports in manage-versions.mjs to walk every section's snapshot and rewrite ../../src/ and ../../data/ imports, catching admin_docs and components files that previous version cuts would have broken - Remove orphan files: developer_portal_versions.json, tutorials_versions.json, and stray empty versions.json files inside components/ and developer_docs/ content directories
This commit is contained in:
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"object_type","required":true,"schema":{"type":"integer"}},{"in":"path","name":"object_id","required":true,"schema":{"type":"integer"}}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"tags":{"description":"list of tag names to add to object","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"tags":["string"]}}},"description":"Tag schema","required":true}}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"201":{"description":"Tag added"},"302":{"description":"Redirects to the current digest"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: add-tags-to-an-object
|
||||
title: "Add tags to an object"
|
||||
description: "Adds tags to an object. Creates new tags if they do not already exist."
|
||||
sidebar_label: "Add tags to an object"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFV21v1DgQ/iuj0Um0urTbcpyEgvhQKhBwCKruojupqYobz24MWTvYzrZ7Uf77aexkN/sC9wI6PiVxZsbzPJ43NyjJ5VZVXhmNKZ5J6cCLmQNvQGgwtx8p98dwbkl4cqDpLv5WU/AFLUEa0MaDKC0JuQS6V84fY4KVsGJOnqzD9KpBxcYr4QtMUIs5YYrR9I1fVoQJWvpcK0sSU29rStDlBc0Fpg0GgRSV9jQji22bfM2ckv/O2HWUJuefGblkkdxoT9rzq6iqUuWCuRl9dExQM7BVWVOR9YpcsCxm4bnJZ6mcBzNlzoAdjbxKyY/oMSaoPM3dwDvnrdIzbJN+QVgrloy8X+hU2wTpXsyrktYeXPXq1y0rbLozETPoAGyz1PKCq4x2Ec/Dk9NdOKwvpCTJW/9y8nBX4pKkspT7ANQXBHltLWkPUs3IBZcfnZx8A89zck7MaA9df0PPShGfCQndoafwSi9EqSSsAxYqaxYqgNxlcKAbsZz+WCzvtah9Yaz6k2QKZ7UvSPtuf1id8B4gQ8WI5NGPRfLWeJiaWssUJgX1JBPT7UxtcwJpuAIZH6vMPlArG7zLrz86zl5pT1aLEhzZBVkga41N4UxDrem+opzRhUUweciTvSf1QnhRRrmwuaO8tsovQ2H9eOcxvbrmOtbn/4Sf1wneH+VG0jg4FqtwKfQMU8zfX77BBEtxS+X6M5LM37Ut4egPuHg3nkCGhfdVOhqVJhdlYZxPH588fjwSlRotTkdezEbNoJK3qy8l21GGkGWZBjh6CRmedfEW+E/hGQlLFn46Oz9/Ph7fTN799vztpsJ5PLmjybKiFLYPby0r4UGT4SdaZphChgtR1pRh+wC5VXSYL5a+MHqAerWwwq3mlbG+DzyX6Uz3FRGerpaPK+P8Ae8L30pOEq0UJCRZ97TZoiii6WjKEH4Gkefk3I03n0i3nTZT8XQf/EwfZrqySvuDHsYxCx8cHg6JeS0WYhyibUDOxuI6MIx2zM+KE3EnlIcp+bwIjHwPPpoIa06+MJLxcBhuc5X2YrAdV8zBhz60mkjYJPD1IVmrDCMrsrYbXVG6p/nWyGUKr8fv3h7HOqCmy4MGPtFywDm0hyzN1D/JdKRLCi9WVG0dRCdkSjouzeyARQ+fIOdyhM9DjnE+jFO+wBT/GZN8ZqHixKyvLR/p3pPB7Vrzhn+DpAWVpppz346WQsREQ01ljTe5Kdt0NGrYVJs2nDntjrXz2nkz700kuBBWidsyFtjeTJwhpqIufecmJki6nnMt6z75EWrapv2Xk8kFrOy0CbI3m/ZWeHecG8eizP94MgNj4dUFG2Esm0b2UtXpB+k2DJJ9YR5zS4kgQ3lu8DYE5Atj54Ltvf59gt1UynkV/+KqrQTQbcLKN5amllzxX42wFWf05XrEff6VgTFBpadmd6gb1xVZR8yhV56Vh0scaFFucRr5c34uQnPtZvMzHni3LxXbhA469fe7hnRkeLr3o6oUSrODIY6bLqeuUFSKUZxiaKGYYLp5NUmHVwsOwhhlV9g0t8LRe1u2LS9/rslyU75eB3rIP6kcv0tMp6J09BXYB5fdwHYIX/K9vxHoZcinsuYvTLj8b92pOGP//62VxJYDKRbqgD/+H5bcgf7OSMZuR42zPKfQgL4sO6yU3CcwwdvuGjc3knWsuOOrjriLvpoAPaRmWIttsI7zWrTJOcOj8WDyW+VW98Ko9rLRNFEidpx2RU7o2ExM2/4FfUdL7A==
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Add tags to an object"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/tag/{object_type}/{object_id}/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Adds tags to an object. Creates new tags if they do not already exist.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./add-tags-to-an-object.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./add-tags-to-an-object.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./add-tags-to-an-object.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
id: advanced-data-type
|
||||
title: "Advanced Data Type"
|
||||
description: "Advanced Data Type"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
Endpoints for advanced data type operations and conversions.
|
||||
|
||||
| Method | Endpoint | Path |
|
||||
|--------|----------|------|
|
||||
| `GET` | [Return an AdvancedDataTypeResponse](./return-an-advanced-data-type-response) | `/api/v1/advanced_data_type/convert` |
|
||||
| `GET` | [Return a list of available advanced data types](./return-a-list-of-available-advanced-data-types) | `/api/v1/advanced_data_type/types` |
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
id: annotation-layers
|
||||
title: "Annotation Layers"
|
||||
description: "Annotation Layers"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
Manage annotation layers and annotations for charts.
|
||||
|
||||
| Method | Endpoint | Path |
|
||||
|--------|----------|------|
|
||||
| `DELETE` | [Delete multiple annotation layers in a bulk operation](./delete-multiple-annotation-layers-in-a-bulk-operation) | `/api/v1/annotation_layer/` |
|
||||
| `GET` | [Get a list of annotation layers (annotation-layer)](./get-a-list-of-annotation-layers-annotation-layer) | `/api/v1/annotation_layer/` |
|
||||
| `POST` | [Create an annotation layer (annotation-layer)](./create-an-annotation-layer-annotation-layer) | `/api/v1/annotation_layer/` |
|
||||
| `GET` | [Get metadata information about this API resource (annotation-layer--info)](./get-metadata-information-about-this-api-resource-annotation-layer-info) | `/api/v1/annotation_layer/_info` |
|
||||
| `DELETE` | [Delete annotation layer (annotation-layer-pk)](./delete-annotation-layer-annotation-layer-pk) | `/api/v1/annotation_layer/{pk}` |
|
||||
| `GET` | [Get an annotation layer (annotation-layer-pk)](./get-an-annotation-layer-annotation-layer-pk) | `/api/v1/annotation_layer/{pk}` |
|
||||
| `PUT` | [Update an annotation layer (annotation-layer-pk)](./update-an-annotation-layer-annotation-layer-pk) | `/api/v1/annotation_layer/{pk}` |
|
||||
| `DELETE` | [Bulk delete annotation layers](./bulk-delete-annotation-layers) | `/api/v1/annotation_layer/{pk}/annotation/` |
|
||||
| `GET` | [Get a list of annotation layers (annotation-layer-pk-annotation)](./get-a-list-of-annotation-layers-annotation-layer-pk-annotation) | `/api/v1/annotation_layer/{pk}/annotation/` |
|
||||
| `POST` | [Create an annotation layer (annotation-layer-pk-annotation)](./create-an-annotation-layer-annotation-layer-pk-annotation) | `/api/v1/annotation_layer/{pk}/annotation/` |
|
||||
| `DELETE` | [Delete annotation layer (annotation-layer-pk-annotation-annotation-id)](./delete-annotation-layer-annotation-layer-pk-annotation-annotation-id) | `/api/v1/annotation_layer/{pk}/annotation/{annotation_id}` |
|
||||
| `GET` | [Get an annotation layer (annotation-layer-pk-annotation-annotation-id)](./get-an-annotation-layer-annotation-layer-pk-annotation-annotation-id) | `/api/v1/annotation_layer/{pk}/annotation/{annotation_id}` |
|
||||
| `PUT` | [Update an annotation layer (annotation-layer-pk-annotation-annotation-id)](./update-an-annotation-layer-annotation-layer-pk-annotation-annotation-id) | `/api/v1/annotation_layer/{pk}/annotation/{annotation_id}` |
|
||||
| `GET` | [Get related fields data (annotation-layer-related-column-name)](./get-related-fields-data-annotation-layer-related-column-name) | `/api/v1/annotation_layer/related/{column_name}` |
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"query","name":"form_data_key","schema":{"type":"string"}},{"in":"query","name":"permalink_key","schema":{"type":"string"}},{"in":"query","name":"slice_id","schema":{"type":"integer"}},{"in":"query","name":"datasource_id","schema":{"type":"integer"}},{"in":"query","name":"datasource_type","schema":{"type":"string"}}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: assemble-explore-related-information-in-a-single-endpoint
|
||||
title: "Assemble Explore related information in a single endpoint"
|
||||
description: "Assembles Explore related information (form_data, slice, dataset) in a single endpoint.<br/><br/> The information can be assembled from:<br/> - The cache using a form_data_key<br/> - The metadata database using a permalink_key<br/> - Build from scratch using dataset or slice identifiers."
|
||||
sidebar_label: "Assemble Explore related information in a single endpoint"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztGWtvG7nxrxBEgcaoYifBFQj2egUcn3Nx6kvSWGkLRMGG2h1pmXDJDcmVrQr678UMudJK4tpO7tp86RdbS84M5/0gV7wEV1jZeGk0z/ipc1BPFTh2ftMoY4FZUMJDyaSeGVsLhGMP8GdeCi9GzClZwIjhhwN/xKRmgjmp5woY6LIxUvvjv0ztyV/pDxtXsEOrEJpNgYl4cMlm1tRZgH1I0IUoKmAt0mSCbY7OP8OyD1aDF7hOrEyF26I0YGuhpP7cR3nWShUOY66wwhdVhI+SMGODbEyWoL2cSbDumI94I6yowYN1PHu/4hLV9qUFu+QjrkUNPOM7PPIRd0UFteDZivtlgwDOW6nnfL0epQnscPwtBIjzXJYpXKk9zMEOI5MGTGt/FwqEcpsEH0bcgmuMduBw/8mjR/ivMNqD9vhTNI2SBbnLySeHfrrq0WusacB6GbCj9Q43yItyL2swLW3vOv7PrY2+LTVzUBhduiNmZsxHD0TXiNjog8xX0nW+gm6xr5oRL4xqa50HV3eHR57RPov7PRpm+gkKvyUxiOs2To/Y0kPtehrekokLwlqxxO8uQhJq6GJHOGcKSZF/LX1FajiUdntEz+LBB1KUMaxwt0ehc4MRL2EmWuXzLmkkSASITVqJdkgx1ifbIzHEVG81SQRK6fPWqkMKmHnevb0kVhCK3OQOluDGW3FI6uXV61csQDH0fiE1/iRoXJjJeeekoKAGPeA0M/BFlS+EasHljYUSYydhkTfdFmsdmrkCzQgXTw3oIT/eJc9MKg82d6CQg4Nzrs4vz8/GLEAxCmYomTcDdKfGKBD6gHAOWmCBODzgIkTp7jnSsYiQpj23QrdKWOmXufuiEvZ4JWqgDAB1Y6xQLERj0Ba5nqwhHocqw6Wrv1+ybSi4YzbGNDGToErkqITGAqq8HCEZ9rHHxUcmtfMgyp1Yvn9Q739XIJSv8qKC4nNeg3NinnCCFwTFCIpFqKSRZULxXfhc/JzOgNKhapWY5gsJ14OG6yqudEyQBi/FlCFG2nK1kDovva/zwgxEJILs2y0pVQ3eyiKRYDvRIsDX5ddvzIBmNoulK40Y9tOqNrYEm0+XeVEZWUBCokvpkAQjSDZdRrW4W91ty9xd7mauNbVEg8fSfr+ZSqi0J9A+fWq7EvTPKT2G3VsKwtZY2FslkiHYWjpHyfWmsUA/k1badh5pK4X9NGpIZM4Lm0iTtMmEUqxQonVpH3FfEi5/SlHjvPBUFpivBNa0mdTg7szeHpPkQNHGWNJdGqyAEew9e4PeCVA3OETkQzYcE9kOLBozaTxMufncYgZIJ+3O3TbBv82wEhxzbdMYi5xPl/t8/w5BEL6HPAN3kwpqb0uurZZf2v4UkiSxADs1DvJaNIekfhVNQxUKq7kV18Gm3rCItZ+SOn2v91fQAF7Bljuq0t20c3jwc2NrUvG2kejmSuxwrFEulFNvqA8O3XYlrP9jaK4ZDRZJVxgsaad62VWyzfQau43GmgIcHmjhSwsu7a80PP2PJggSdmB+wKNncfDJS/BCqlSlChubk/pYSfEiBJT5dJlMhM5onH7n1rRNyCWVcGyD1o0+rpoaYcv0GZXQcyjzVNM9ljU4L+qmY1kJ51ltyh22w1gUZkl4iHq7/Zy8amuh5b9TDeLdJ+K1BRFgFkRJ6QgZSE8Um/5uIGhp766AvXUuuaKLh7umkt5+Xgv7GcrSXKeoCS09aoa9GP96iUFPda5zGPTA/8IERFGUnhfukzBSRWaf5DYZSJfXQgt0BbjxYLVQKuHcF32RpWMRh5nWO1kC2+IOtJ7kMikXu/wtHjXUO70+6JlSfegtTRNlz5yuUm4SKYtu18JmUt/DyXdzv5SkGe7NhqaCgDvccATswS45oA+6YsB+9/YygXxLPaOIuxUiFq6zoK+r0AXSNC/qRsHu5dOel/fLVcfNts6s1+v9hMDfgm+tDt2bxPClOYaOPsZTf/hNt2S92nmXinYl3ErxTGyKaMYu9EIoWbLt3SiW2oUsoeQJ4Xq4QZbH31eWd1q0vjIWc2TGTltfYcDFOEZGpU0L0kcMkvzwfSV5ZbC3aHWZ0Z14VDL1O7EslQYc08YzuJGo/kOhNjRIoidPvrdtYtNGKRTt4pcZ+we6W7wLs9bYlBxnplUliRopRGw86s/fO3wudKg0zIFdgA1SZOxUs1bDTQMFGo0WmSmK1g444HPhhdqoACfMosXLJHqa+HTtefb+A96wezHH54ouifEPI37zsDAlXBFv4SlDCT3nGS/evb3kI67EFNT2s+t4eNFaxR7+i/1yPmYTXnnfZCcnyhRCVcb57Omjp09PRCNPFo9PIJx2MuFsMploxh6+YBN+GkOGdJ2xZyAsWPaH07Oz86urfPz6b+evJpzj00Jk6M3SV0b3WNosbJiSOO35zt/dRE9096jAftosH8/BP0A+2P05HwX4CkQJ1v202uN/wjM24VGGCWd/YqJAX8u9+Qx6PdFHE91Yqf2Djp9j9K4HR0d9CV+Khbgis/ak3Fncqt9oh4JuhBPXQvpwcUuyfZ1kqx3xsu6b7dsJ5fzYmWoVZByTiB8Dxhr/obw/TnTgkdq4jr896SOQUXCszPwBgh79yNFTa/CVKXnG5+Dptc1XPOP73KNGKHCC51I3kJab74fMJW6zEhagTEPXJYES2SMQWjXWeFMYtc5OTlZIap2t0MHWB9TOWufxCTGQGPGFsBIzlYtZg8iEToUeLyKbfMRBtzWGZPzEfw7jcu9+djx+wzZ08FrXOL9LbyPvAXNXIbfgXrjFseziDd2BGbtHJKmqiE/Qa3qp6/ILtT9BSMoyKz4l33jeTW0v/znuXv2oh6bdbUdGQq9HiJxbmFlw1bcSwe5fz0xi7GkbsA52urztUpyCeMYXj4NKnK8Fpf34iNm9hd/6FJ567t7XY6/O/P+B/e4H9mhdbHVPGiUkTV6x3w/p4D0XjUQbPsY4iiVtxDF6Qni856sVcvjOqvUal8P7NKaKUrr4jDQTysGI4wv74ZM9vX/xLNShAZz9V/r74PQe5u8Dvv8U/5U48fF9i/Vhm6GoNaBnohIsqSagnxYFUMnpsA46o500/cs5xii2wb12aBOp8QdS72ZT3VfVahUgQinB9BqYoOrJ1x/W6/V/AFE8FoM=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Assemble Explore related information in a single endpoint"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/explore/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Assembles Explore related information (form_data, slice, dataset) in a single endpoint.<br/><br/> The information can be assembled from:<br/> - The cache using a form_data_key<br/> - The metadata database using a permalink_key<br/> - Build from scratch using dataset or slice identifiers.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./assemble-explore-related-information-in-a-single-endpoint.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./assemble-explore-related-information-in-a-single-endpoint.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./assemble-explore-related-information-in-a-single-endpoint.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
id: async-events-rest-api
|
||||
title: "AsyncEventsRestApi"
|
||||
description: "AsyncEventsRestApi"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
Real-time event streaming via Server-Sent Events (SSE).
|
||||
|
||||
| Method | Endpoint | Path |
|
||||
|--------|----------|------|
|
||||
| `GET` | [Read off of the Redis events stream](./read-off-of-the-redis-events-stream) | `/api/v1/async_event/` |
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
id: available-domains
|
||||
title: "Available Domains"
|
||||
description: "Available Domains"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
Get available domains for the Superset instance.
|
||||
|
||||
| Method | Endpoint | Path |
|
||||
|--------|----------|------|
|
||||
| `GET` | [Get all available domains](./get-all-available-domains) | `/api/v1/available_domains/` |
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"tags":{"items":{"properties":{"description":{"nullable":true,"type":"string"},"name":{"minLength":1,"type":"string"},"objects_to_tag":{"description":"Objects to tag","items":{},"type":"array"}},"type":"object","title":"TagObject"},"type":"array"}},"type":"object","title":"TagPostBulkSchema"},"example":{"tags":[{}]}}},"description":"Tag schema","required":true}}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"objects_skipped":{"description":"Objects to tag","items":{},"type":"array"},"objects_tagged":{"description":"Objects to tag","items":{},"type":"array"}},"type":"object","title":"TagPostBulkResponseObject"}},"type":"object","title":"TagPostBulkResponseSchema"},"example":{"result":{}}}},"description":"Bulk created tags and tagged objects"},"302":{"description":"Redirects to the current digest"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: bulk-create-tags-and-tagged-objects
|
||||
title: "Bulk create tags and tagged objects"
|
||||
description: "Bulk create tags and tagged objects"
|
||||
sidebar_label: "Bulk create tags and tagged objects"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFV21P3DgQ/ivW6KSCLrDQ60lVqn4ARNX2KkDsVncSWVFvMiTuJnZqOwvbKP/9NHaSzb4gtfCBT4ntmfE8z4zH4xo0/qjQ2FOVLCGsIVbSorT0y8syFzG3QsnRd6MkzZk4w4LTX6lVidoKNDSyPHVfYbEw28sJmliLkkzRUFZ5zmc5Qmh1hQHYZYkQgrFayBSaACQvkAQLIb+gTG0G4fEOMTX7jrE1t1bdWp5ubQSXfp1ZxWg96N1remNca76EZjXhbUIAVljyECY89XbgN7WulLGnVT4fe86aAPCBF2WOK8Ju6mbakJl1vyc8ZS3TgQuQ0Jh4shqaMKWSxjP7+ujoGWHTaKrcbs93xJq5KEva+unMDqLE0/R5tn6N7+uWny5qv6e1M1o9T82OaJE2izVyiwkhMIxL95NiwlrwZO+vo9fb4K8xEbqHnyGLK61RWpaIFI3LuTfPCnGBxvDU59z6+dniZR1zrwinPGFtmQjZJ7nguUhYyTUv0KI2rNRqIRJMYBc5K12P5fhlsXyVvLKZ0uInJiE7qWyG0rb7s/6o7QAyVPRI3rwskgtl2Z2qZBKySYYdyUh0G1XpGFmi0DCpLMMHQfRvg+pt0C5/v3SefZIWteQ5M6gXqBlqrXTITiSrJD6UGBM6N8lU7M7Jzkh94JbnXs5tbjCutLBLKrfw/d5CeDNtpkFXgqkIGJgG8HAQqwTHzjFXmyHnMoUQ4q/XXyCAnM8wXw09yTSudM4O/mNXl+MJiyCztgxHo1zFPM+UseHbo7dvR7wUo8XxyPJ0NKvy+a2vFxGwKIokYwcfWQQnbYI5wkN2ilyjZn+cnJ2dj8e3k8t/zi/WFc58qA4myxJDthmtlWzCXtURzHEZQcgiWPC8wgiaV9AEPcirpc2UHMDsJ3qgoiiVtl2mmUhGsruL2Pt++rBUxu7Rvuy32Qi8WoY8QW3e1xucePdbXiJgfzIex2ioAZijbFptwv5+F95I7key1ELavc7vQxLe298fMvGZL/jY5dOAjbXJVeiVNERITwK/58KyO7Rx5ih4EgG1x1GgzVRCACizNskJOzG2mTkE+luXPLVnaOII+hasVIa542nazh8v3fE6U8kyZJ/HlxeH/miLu+Vezea4HJDMmn2SJq7fRdLzk3DLe242mG+FVI6HuUr3SHT/HdDxfPSSffSODcBTBiFQDkIAJafWER6hmyLpKo0/7ZWmQO+MF2y684WWWYILzFVZ0H3tLbk88obqUiurYpU34WhUk6kmrOkANVvWzipjVdGZCGDBtaD+uOuknRnfO9xx14g4NyEAlFVBNawd0sfVsnX7HyeTK9bbaQIgb9bt9Xi3nBv7Ykxr1JYzpdmnKzJCWNaN7KSq1XfSTUOR7Qqya7U8SFeWa5i5rP2gdMHJ3ud/JxQjJwZhuwr9deJANwEp32q802iypxohK0bJ69Vj6Hy7V98A1t5v3WtlNd58ltzQe2faTJsAhLxT203guCpRGxx2poMpSlAvtzj2vBtbcP+Q8jv/2uHYeIS1+C0+2FGZcyHJtkvduj03N8BLQQ4cg7stIYDh6Zl2eXQDdT3jBr/qvGlo+keFmq7b6SqV3aUbgC9ejsw5Lin1B2XIZX5euYZ/s/Ogc+U1TuIYXRV+XHY6qARUO8nx9n1bqIR0NL+npxW/hxAoYo4V/ySiOX8XVL4t8TYpRagDHFDXp1L7Q6i6B4tcDjysay/hqzCdfw/FXVvgnoD/A3qlW3c=
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Bulk create tags and tagged objects"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/tag/bulk_create"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Bulk create tags and tagged objects
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./bulk-create-tags-and-tagged-objects.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./bulk-create-tags-and-tagged-objects.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Annotations bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: bulk-delete-annotation-layers
|
||||
title: "Bulk delete annotation layers"
|
||||
description: "Bulk delete annotation layers"
|
||||
sidebar_label: "Bulk delete annotation layers"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFV9tu2zgQ/RVisA8JVq2ToAsEKvqQZlO03aAtGnd3gShwGWlsKaZIhRy58Qr698WQkiw7LvYK5EnmbXjOXA7HDVTSyhIJrYP4uoEMXWqLigqjIYZpjkJqbUjyhFByjVZUSzE3VlBeuNEiRFDwkUpSDhFoWSKPlhCBxfu6sJhBTLbGCFyaYykhboDWFe8qNOECLbRt1EBqNKEmXpZVpYrUm5/cOUbUjA4XhKXbZyXqZ6S1cg0RUEGKxwukWYYKCWdF5madqbZtO+z3Ndr1Bvw9tDeM3lVGO/RXnRwd8edvY6ysqdBSEU6X6Jxc4AizI1voBRPvZ8ztHabEJPBBlpXCrYObA220E6uzIRRO3NZqKQJTtvTi6PhpUX/Rsqbc2OIPzGJxVlOOmrr7xZAee0iNDwYmL56WyQdDYm5qncWCi4OxoyPMhEVnapuiyAw6oQ0JfCgc7SM12PCMTk6eOjaVNSkPbxUKjgutY/GrVEUW4oPWGruPx7mpVeapdha603zVT09dKO80odVSCYd2hTawiMWZFrXGhwpTDpqfFCZNa/udBHwjSarBBRE4TGvLHFks774RxNc3rBIkFyygoyoUl6yWDm4ieHiWmgyvPMogs0rqBcSQfvl8CREoeYtqMwyJxOPaKvHsd/HzxeXF9EIkkBNV8WSiTCpVbhzFp0enpxNZFZPV8WSjxTMv1JPx1CQBkSSJFuLZW5HAWVdVfi0Wr1FatOKHs/Pzi6ur2fTjLxcfEgCW4w7ppzXlXuR7rMPEgLYoK2OpLwmX6ET32ileDdPPgywdMBTxXylFwUqOMkPrXjU7xBKIRQIduQTEj0KmnKczMkvUbaIPE13ZQtNBD/S5I0m1m3G8Dsf838uVvPJ5MfLB1uQmakY7dsNAXX6TBYk5Upp72v8H6SYwL5FykzHLkCO7Lon7jWI36Oybr33cm+CXqXfL13Ci5Q/76GWimZJR+FyZxa6rDl/6V3K7al5v3p9H/YODCAJsiKF7o6LQNsTwXR801bIdu4Ed7gs71FNtOR573Qq74C55WWS4QmWqEjV1EuHDHQw1lTVkUqPaeDJp2FQbN5zd7SNr57UjU/YmIlhJW7CSuk7VvBn+neFc1oo6mBAB6rpkyeiG/PFqsW3/7XT6SQx22ggYzba9ge8jcFdB+3iNexphrHj3iY0wl20je13Vnfe725bj3OvfFSt3IOlVsIFbn0tvjC0l23v/2xS6Vo+LIqzCoN6edBvx4ZnFuUWX/1sjvnubm0BnC31doXVIow5wNMW5E/atjoNLHJXSP0td//dXWbx12/BSET7QpFKy0GzV51PTpfc1yKrgq48hgt0Uhwhi3y5v9dScECHi19A0t9LhF6valqdDt/qoaR89urBx1TaqJa59f8vpqmpe90Xc524wWviOIIN4LpXDR3Q3txx87jq4Q/HP/jDsxdb37no9htdjrpbQ3nAVeH3zQMPCWZqi1+H+yKN+gxkOwhPkkr1dUz6K3pBi3Q++YC+ipgk7gma2A0D/tDDGtv0TlHWf6A==
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Bulk delete annotation layers"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/annotation_layer/{pk}/annotation/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Bulk delete annotation layers
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./bulk-delete-annotation-layers.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./bulk-delete-annotation-layers.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./bulk-delete-annotation-layers.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -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":"Charts bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: bulk-delete-charts
|
||||
title: "Bulk delete charts"
|
||||
description: "Bulk delete charts"
|
||||
sidebar_label: "Bulk delete charts"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFVm1v2zYQ/ivEYcAaTImTrgMCFf2QZgnaLuiC2dkLosClpYvFhCIV8uTGE/TfhyNlxXY8oNuXfJJE8Z67514esoVaOlkhofOQXreQW0NoCNIWZF1rlUtS1ozuvDW85vMSK8lvirDy/ELLGiEFZQjn6KBLVivSObmEBEiR5u850rRAjYRTVfhpD9V1XQLKQAoPDTreb2TF2x+gu0nAoa+t8RhcvT485Mc3x1g7W6MjFa0r9F7OcS1mT06ZOXRPMdvZHebEJPBRVrXGDcMngy6BAn3uVM2uIYXTUjryYtboexFJMsibw6OXDfjKyIZK69TfWKTipKESDfX+hcOHRjksdvFZN4xMfnxZJufWzVRRoEnFX7YRhTXfkyjlAkWNrlLeMyOyQuY5ei+oVF449LZxOe4iOOBFdm9elt1nS+LWNqZIxaTEUBn0hMVAQRQWvTCWBD4qT7sYDRiB0evXL915tbNcCjnTKLjraJmK36VWRew+dM66naNkG10Eqj1Cb82ufnppBfhoCJ2RWnh0C3SRRSpOjGgMPtaYc9HCorB53rh/Ga9zSVIPKUjAY9445sgafPeVIL2+YfkjOWdd7uUFbhJ43M9tgeMQWpRsLc0cUsivfruABLScoX767AcghbxxWuz/KX4+uzibnIkMSqI6HY20zaUuraf0+PD4eCRrNVocjXL2N8pAZFlmhNj/IDI46QUh5DoV71E6dOK7k9PTs/F4Ovn1l7PPGUCXDBFdLqm0Zi2mYWGISlW1dbTqd5+ZzKwUX7wblg+ior7iUMS3hp7E3SXKAp1/124RyCAVGfQkMhA/9MoxJXuPpsvMXmZqpwy9WgV04ElS46ec/711np/kQo5Dcde4biw+VcEaz3QHivKrVCRukfIy0Psv5NrIsEIqbcFsYm23qaerjWK7iJyDL6s6tpH/JND/Ei06fnAu3maGQ7caD7Sdb6dk7204qzdb/P3TUSjy2L4JxFghhf6MTKCWVEIKmwQ5ZWG+Yoc3jjO6MzGw7faCf4sCF6htXaGhflJDwSJQWztLNre6S0ejlqG6tOU+7J6hnTaebLWCSGAhnWJB8724BBh+L/BWNpr6MCEBNE3Fk9t/8iPM7yb+h8nkUgw4XQIczSbewPdZcOMoQfyP70zCOvHxkkGYyybIzlT19mF313EFVzI0ZgGNJIMYtTALXXJuXSUZ79MfE65R2AZp/xcGEQ2ku4SNpw5vHfry/4KE2+GtjXQ2om9qdB5p7Ya5tsS9E/ctjmJKPFUynA79/XJnf264GE4Jwkca1VqqcFkITdT2jXsNslbs7wgSCDCQANc5FvIa2nYmPV453XW8HC+53NRbroYjDZ4ysOn3HpfhWsxdqBv+H6Zu1ZLhyEggDn3wEA1O8hyDCK2snp2YjDIMZtQQSIDvf2s5GKrTv7CD1UXfLNfg2zbuiELCIxXjCLoK3U3Xdf8ARu5KZw==
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Bulk delete charts"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/chart/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Bulk delete charts
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./bulk-delete-charts.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./bulk-delete-charts.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./bulk-delete-charts.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -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":"CSS templates bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: bulk-delete-css-templates
|
||||
title: "Bulk delete CSS templates"
|
||||
description: "Bulk delete CSS templates"
|
||||
sidebar_label: "Bulk delete CSS templates"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFVttu3DYQ/RVi0IcYlb22kQKGgjw4roMkNVKju24LWMaGK413ZVOkQo423gr892JISXvxtmjz4ieJlzkzZ65soZZWVkhoHaS3LeRGE2qCtAVZ16rMJZVGjx6c0bzn8gVWkv9KwsrxD61qhBRKTThHCz7pd6S1cgUJUEmK13OkaYEKCadl4aYdlPc+gVJDCl8btHxfy4qvfwV/l4BFVxvtMKg6PT7mz3+2sbamRktllK7QOTnHDZsd2VLPwa9tNrMHzIlJ4JOsaoVbgmsBn0CBLrdlzaohhYvxWBBWtZKETswa9SgiV8Z6fXzysnbfaNnQwtjyLyxScd7QAjV1+oXFr01psdhHa1MwMnn9skw+GxL3ptFFKiYLDLajIyyERWcam6MoDDqhDQl8Kh3tIzVgBEanpy8dm9qanJczhYLjQqtU/C5VWcT4oLXG7s0506giUO0QOmlW9dNLl8pHTWi1VMKhXaKNLFJxrkWj8anGnIMWNoXJ88b+QwK+lyTV4IIEHOaNZY7crB6+EaS3d9wnSM65gYU6nPR1CHcJPB3mpsBxsDC2OCX1HFLIb367ggSUnKFaL2MS8bqxShz+KX6+vLqcXIoMFkR1Ohopk0u1MI7Ss+Ozs5Gsy9HyZJQ7N+3Lf5SByLJMC3H4QWRw3hVQ8Hwq3qG0aMUP5xcXl+PxdPLrL5efMwCfDIZdr2hh9IZpw8ZgXFnVxlKf/S7Tme4bpXg7bB/FDvSKTRH/k0EShRYoC7TubbvDI4NUZNBxyUD8KGTOGTgl84jaZ/og07UtNb3q7TpyJKlxU47GwSbdT3IpxyHiG5S3NtcxMdox64Gp/CZLEvdI+SKw/A6ObSRaIS1MwaRiwHc9kPYXxW5I2RVf+qi20Q2T4IUvUcLzh13yJtPMwCg8Uma+65mDN2Hgbaf/u/UgEVsjBhKIJkMK3aBJoJa0gBT20mU/hkqMRdBYdvNeb8GuEVd8LApcojJ1hZq6mg5RjEBtbQ2Z3CifjkYtQ/m05Rz1z9AuGkem6iESWEpbcutzXRsKMPxf4L1sFHVmQgKom4prvFvyJ5T4Nv6HyeRaDDg+AbZmG2/g+8y4cWxWfMbPEGGs+HjNIMxlG2Svqzr5cNt7jmffsMbcaiPJ0LZamIWceW9sJRnv0x8TjlG4Bml3CkO7DaR9wsJTi/cW3eJ7QcKD695EOlvWNzVah7TxaNvY4tyJ95Yn0SWOKhnmSPdk+7ds3dI0jBXCJxrVSpaaEUMutV0a34KsS1Z7AglspjIkwFGPYb2Ftp1JhzdWec/b8RXJKb6jcRiFsPbHtvpHXIV3J+ekavg8VGSfoGHUJBAbQtAQBc7zHEOf6qWeTVpGGao19hdIgF9WG64YYtX9sIL+Ja1XG/BtG2/EJsMFFu0IrRf8nff+b2/1FBM=
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Bulk delete CSS templates"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/css_template/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Bulk delete CSS templates
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./bulk-delete-css-templates.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./bulk-delete-css-templates.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./bulk-delete-css-templates.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -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":"Dashboard bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: bulk-delete-dashboards
|
||||
title: "Bulk delete dashboards"
|
||||
description: "Bulk delete dashboards"
|
||||
sidebar_label: "Bulk delete dashboards"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFV21v2zYQ/ivEYcAaTImTrAMCFf2QpgnaLuiC2dkLosClpYulhCIV8uTGE/TfhyMl+SUusO5LPkmmeM/dcy8P6QYqaWWJhNZBfNNAajShJogbkFWlilRSYfTo3hnNay7NsZT8VhCWjl9oWSHEUGjCOVpoo35FWiuXEAEVpPj3HGmaoULCaZG5aQfVtm0EhYYYHmu0vF/Lkrc/QnsbgUVXGe3Quzo+POTHf46xsqZCS0WwLtE5Oce1mB3ZQs+hXcVsZveYEpPAJ1lWCjcMVwZtBBm61BYVu4YY3kuXz4y0mZjV6kEEnozz+vDoZWO+1rKm3NjiH8xicVpTjpo6/8LiY11YzHZRWjcMTH5+WSYXxs6KLEMdi79NLTKjfySRywWKCm1ZOMeMyAiZpuicoLxwwqIztU1xF8EBL7B7/bLsPhsSd6bWWSwmOfrKoCPMBgoiM+iENiTwqXC0i9GA4RkdH79051XWcCnkTKHgrqNlLP6QqshC96G1xu7icWZqlXmqHUJnza5+eWkR+KgJrZZKOLQLtIFFLE61qDU+VZhy0fyiMGla22+M14UkqYYUROAwrS1zZBm+/0oQ39yyApKcszSvFMbBbQRP+6nJcOzDC8qtpJ5DDOn175cQgZIzVKuf3RDEkNZWif2/xPvzy/PJuUggJ6ri0UiZVKrcOIpPDk9ORrIqRoujUdb7HCUgkiTRQux/EAmcdsLgcx6LdygtWvHD6dnZ+Xg8nfz26/nnBKCNhqiulpQbvRbXsDBEVpSVsdT3vUt0onvxF2+H5YOgrK84FPE94UfBIkeZoXVvmy0SCcQigY5IAuKnTkWmZB5Qt4neS3RlC02v+qAOHEmq3ZTrsLfO9ZNcyLEv9BrfjcVVNYx2THmgKb/KgsQdUpp7it9LsAksS6TcZMwo1HmbftxvFNvF5Dx86evZhBxMfAq+BIuWH5yPN4nm8I3CA2Xm22nZe+OP782Wf7c6GkW2aucIQrwQQ3duRlBJyiGG50Q5fX7uQtfXlrO7M0mw7f6SP4sMF6hMVaKmboJ98QJQU1lDJjWqjUejhqHauOG+bJ+hndWOTNlDRLCQtmChc53oeBh+z/BO1oq6MCEC1HXJE9395Ief6U38D5PJlRhw2gg4mk28ge+z4MZBmvgbX6eEseLjFYMwl02Qnanq7P3utuVK9vI0ZmENJL1INTDz3XJhbCkZ79OfE66R3wZx9xUGcfWk24iNpxbvLLr8/4L4i+OdCXQ2oq8rtA5p7fK5tsS9E/YtjkJKHJXSnxrd1fObfbrhZjhBCJ9oVClZ+IuEb6Sma+AbkFXBPo/YuoeCCLjeoaA30DQz6fDaqrbl5XAP5ubecjccebDKxKbvB1z6mzN3o6r5u5/CvjX9kRJBEAHvIRicpil6Yeqtnp2ojDIMadAUiIDvh2t5GKrUvbCD/r+AXq7BN03YEYSFRyvE4bUW2tu2bf8FpG9YOg==
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Bulk delete dashboards"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/dashboard/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Bulk delete dashboards
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./bulk-delete-dashboards.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./bulk-delete-dashboards.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./bulk-delete-dashboards.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -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":"Dataset bulk delete"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: bulk-delete-datasets
|
||||
title: "Bulk delete datasets"
|
||||
description: "Bulk delete datasets"
|
||||
sidebar_label: "Bulk delete datasets"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFV21v2zYQ/ivEYcAaTImTrAMCFf2QpgnaLuiC2dkLosClpYvFRCIV8uQmE/TfhyMl+SUu0O2LP0mmeM/dc+9uoJJWlkhoHcQ3DaRGE2qCuAFZVYVKJSmjR/fOaD5zaY6l5DdFWDp+oecKIQalCedooY36E2mtfIYISFHBv+dI0wwLJJyqzE07qLZtI1AaYnis0fJ9LUu+/gjtbQQWXWW0Q6/q+PCQH99tY2VNhZZUkC7ROTnHFZsdWaXn0C5tNrN7TIlJ4JMsqwLXBJcCbQQZutSqilVDDO8lSYckZnXxIAJLRnm9a4vfyUxYfKzRUSw+6oUsVCaWMReVNQuVYbaN04ps4HK0Wy7XWtaUG6v+wSwWpzXlqKnT7w1VdjuRVcHA5OfdMrkwdqayDHUs/ja1yIz+kUQuFygqtKVyjhmRETJN0TlBuXLCojO1TXEbwQEvsHu9W3afDYk7U+ssFpMc+xTCbKAgMoNOaEMCnxQn10tGA4ZndHy868yrrOFQyFmBgrOOnmPxBxdTyD601thtPM5MXWSeaofQSbOqX3bdHD5qQqtlIRzaBdrAIhanWtQanypMOWj+UJg0re03yutCkiwGF0TgMK0tc+SBcv+VIL655V5Ocs5Dpu+VDm4jeNpPTYZjb1yYQIXUc4ghvf79EiIo5AyL5c+uBGJIa1uI/b/E+/PL88m5SCAnquLRqDCpLHLjKD45PDkZyUqNFkejLGgcJSCSJNFC7H8QCZx2TcH7OxbvUFq04ofTs7Pz8Xg6+e3X888JQBsNNl09U270ilXDwWCXKitjqc95l+hE9yNMvB2OD8KEeMWmiO83Pgr3c5QZWve22aCQQCwS6GgkIH7q+seUzAPqNtF7ia6s0vSqN+nAkaTaTTkGe6tMP8mFHPsQr7BdO1xGwmjHhAeS8qtUJO6Q0twT/G/0msCxRMpNxnxChDfJx/1FsRlI9sKXPpZN8MDEO+BLkGj5wd54k2g23hR4UJj5plP23vgFZGMkLse7yPo0jiBYCzF0kz+CSlIOMWySZMf5Wgu5Xlv261b3wKbqS/4sMlxgYaoSNXVV68MWgJrKGjKpKdp4NGoYqo0bzsf2BdpZ7ciUPUQEC2kVNzfXNRoPw+8Z3sm6oM5MiAB1XXIVdz/54St5Hf/DZHIlBpw2ArZmHW/g+8K4cWhH/I2XQWGs+HjFIMxlHWSrqzp5f7ttOYp9SxpzMw0kfWNqYOYz5cLYUjLepz8nHCN/DeLuKwwN1ZNuIxaeWryz6PL/C+LX3jsT6KxZX1doHdLK6rxyxLkT7i2OgkscldJPim5x/kaOrikZZgbhE42qQiq/Ovg0arrkvQFZKdZ4xNIBCCLgWIdg3kDTzKTDa1u0LR+HDZ4Te0PZMOJg6YV1zQ/47Hd+zsSi5u+++vq09CMkglD8XkMQOE1T9O2ol3oxQRllKM/QSyAC3gdXvDBEqHthBf2/GP28At804UZoKFxWwQ7fYaG9bdv2X7NvmWI=
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Bulk delete datasets"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/dataset/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Bulk delete datasets
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./bulk-delete-datasets.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./bulk-delete-datasets.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./bulk-delete-datasets.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -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":"Report Schedule bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: bulk-delete-report-schedules
|
||||
title: "Bulk delete report schedules"
|
||||
description: "Bulk delete report schedules"
|
||||
sidebar_label: "Bulk delete report schedules"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFV21P5DYQ/ivWqFIPNbBArxLK6T5wFHR3RVd0LH0RQXveZNgYHDvYkz22Uf57NXY2+wJVr/3Cp2Qdz8zzzIyf8bZQSycrJHQe0usWcmsIDUHagqxrrXJJyprRnbeG13xeYiX5TRFWnl9oUSOkoAzhDB10yXJFOicXkAAp0vx7hjQpUCPhRBV+0rvqui4BZSCFhwYd7zey4u0P0N0k4NDX1ngMoQ739/nxzRhrZ2t0pKJ1hd7LGa5h9uSUmUG3wmynd5gTk8BHWdUaNwxXBl0CBfrcqZpDQwqfsbaOxGVeYtFoFNNG34vIlr293j94WeRXRjZUWqf+wiIVxw2VaKiPLxw+NMph8RyxdcPI5MeXZXJm3VQVBZpU/GkbUVjzPYlSzlHU6CrlPTMiK2Seo/eCSuWFQ28bl+NzBAd/kd3rl2X3yZK4tY0pUjEuMVQGPWExUBCFRS+MJYGPytNzjAYfgdHh4Ut3Xu0sl0JONQruOlqk4jepVRG7D52z7jkeJ7bRRaDae+itOdRPLy0FHwyhM1ILj26OLrJIxbERjcHHGnMuWlgUNs8b9w/H60yS1EMKEvCYN445shjffSVIr29YB0nOWKC3dcbDTQKPu7kt8DKAjCqupZlBCvnV53NIQMsp6tXP/iikkDdOi90/xM+n56fjU5FBSVSno5G2udSl9ZQe7R8djWStRvODkQuRRxmILMuMELvvRQbHvTaEtKfiHUqHTnx3fHJyenk5Gf/6y+mnDKBLBkgXCyqtWQM1LAywVBUo9q3vM5OZ5RQQb4flvSiurxiK+GbsSdxeoizQ+bftFoMMUpFBzyID8UOvIhOy92i6zOxkpnbK0Ksloj1Pkho/4QrsrBP9KOfyMhR6jezG4qoO1njmO3CUX6UicYuUl4Hff2LXRooVUmkLphPLu809XW4U22XkJHxZVrKNCRgH/l+iRccPTsabzDB2q3FP29l2TnbehAm+2e/vVnNRRNzCD72cQEQNKfSjM4FaUgkpbHHl9IVzF/u9cZzdZ5ME2wjO+bMocI7a1hUa6k9wKF501NbOks2t7tLRqGVXXdpy3O6Jt5PGk62WLhKYS6dY6HwvOsENvxd4KxtNPUxIAE1T8Ynuf/IjnOZN/+/H4wsx+OkSYDSb/ga+T8BdRmnib3ypEtaJDxfshLlsOnk2Vb192N11XMylPLH+VJFkEKkWpqFhzqyrJPv7+PuYaxS2Qdp/hUFcA+kuYeOJw1uHvvy/TsL18dZGOhvomxqdR1q7gq4tce/EffODmBJPlQxTo7+A/kurbgQb5gjhI41qLVW4ToR2avsevgZZK458AHyvDVlNgEsea3oNbTuVHq+c7jpejhdi7u+tWMPUg1UyNgPf4yJcobkhdcPfw1lcdmeYKglEKQgRosFxnmPQpqXVk6HKXoZDGpUFEuAr4loShkL1Lxxg+afALNbct23cEeWFT1fEEeQWupuu6/4G0RZcQg==
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Bulk delete report schedules"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/report/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Bulk delete report schedules
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./bulk-delete-report-schedules.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./bulk-delete-report-schedules.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./bulk-delete-report-schedules.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -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":"RLS Rule bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: bulk-delete-rls-rules
|
||||
title: "Bulk delete RLS rules"
|
||||
description: "Bulk delete RLS rules"
|
||||
sidebar_label: "Bulk delete RLS rules"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFV21P4zgQ/ivW6KRbdIECtyehrPYDy4F299AuouVeRFDXTYYm4NjBnhR6Uf77aewktAWkE1/4lNTxPJ5nXp5xG6iklSUSWgfxZQOp0YSaIG5AVpUqUkmF0aMbZzSvuTTHUvJbQVg6fqFlhRBDoQnnaKGN+hVprVxCBFSQ4t9zpGmGCgmnReamHVTbthEUGmK4q9Hyfi1L3n4H7VUEFl1ltEN/1P7uLj/+t4+VNRVaKoJ1ic7JOa747MgWeg7to89mdoMpMQl8kGWlcM3w0aCNIEOX2qLioyGG89OxOK8VilmtbkWgyTDvd/fe1uULLWvKjS3+xSwWhzXlqKk7X1i8qwuL2XOMVg0Dk1/flsmJsbMiy1DH4h9Ti8zon0nkcoGiQlsWzjEjMkKmKTonKC+csOhMbVN8juCAF9i9f1t23wyJa1PrLBaTHH1m0BFmAwWRGXRCGxL4UDh6jtGA4Rnt77915VXWcCrkTKHgqqNlLP6UqshC9aG1xj7H48jUKvNUO4TOmo/67a014IsmtFoq4dAu0AYWsTjUotb4UGHKSfOLwqRpbV9orxNJUg0hiMBhWlvmyCp8c08QX16xAJKcszLDubkXp7hAJcb9zqsIHrZTk+HYuxkEXEk9hxjSi/NTiEDJGarHn10zxJDWVontv8Xvx6fHk2ORQE5UxaORMqlUuXEUH+weHIxkVYwWeyNr7hUf3fs4SkAkSaKF2P4sEjjsdMKnIBafUFq04qfDo6Pj8Xg6+f7H8bcEoI0G586WlBu94t6wMDhYlJWx1LeBS3Si+1EgPg7LO0Fo37Er4hUsomCYo8zQuo/NBpcEYpFAxycB8UunLVMyt6jbRG8lurKFpne9bzuOJNVuylnZWqX8VS7k2Kd/hfba4mNujHbMfGAr72VB4hopzT3TV/JsAtkSKTcZEwvJ34xC3G8Um6nlcPzos9uEUEx8JH4Ei5YfHJYPiWYWRuGOMvPN6Gx98KN9vR8+Pc5NwcPU1lzREQR3IYZupkZQScohhhfpcix9a4aGqC2H+tmIwaYTp/xZZAxnqhI1dU3uMxmAmsoaMqlRbTwaNQzVxg3XavsE7ah2ZMoeIoKFtAVroet0ycPwe4bXslbUuQkRoK5LbvruJz8cPAnZ58nkTAw4bQTszTrewPeJc+OgXvyNL1zCWPHljEGYyzrIs6Hq7P3utuV89gkYs/YGkl7HGpj5mjkxtpSM9/WvCefIb4O4+wqD/nrSbcTGU4vXFl3+WhB/tbw2gc6a93WF1iGtXE9Xlrh2wr7FXgiJo1L6wdJdTl+q1rVThhlD+ECjSsnCXzV8HTVdGV+CrAo+cg8i2CxliICzHtJ6CU0zkw4vrGpbXg73ZS7xjVOH2QiP8Vh34RaX/obNNalq/u47si9QP3siCILgTwgGh2mKXqt6qyejl1GGjg36AhHwRXIlHEOuuhc+oP/PoJcr8E0TdgSR4QYLfnj5hfaqbdv/ANuMaKo=
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Bulk delete RLS rules"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/rowlevelsecurity/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Bulk delete RLS rules
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./bulk-delete-rls-rules.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./bulk-delete-rls-rules.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./bulk-delete-rls-rules.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -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":"Saved queries bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: bulk-delete-saved-queries
|
||||
title: "Bulk delete saved queries"
|
||||
description: "Bulk delete saved queries"
|
||||
sidebar_label: "Bulk delete saved queries"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFVt9v2zYQ/leIwx4aTImToAMCFX1IsxRtF7TZ7GwDosClpYulhCIV8uTGE/i/D0fKsp14w7qXPEmieN/ddz8+soNGWlkjoXWQXneQG02oCdIOZNOoKpdUGT26c0bzmstLrCW/VYS14xdaNggpVJpwjhZ8slqR1solJEAVKf6eI00LVEg4rQo37aG89wlUGlJ4aNHyfi1r3v4A/iYBi64x2mFwdXx4yI//HGNjTYOWqmhdo3NyjhsxO7KVnoNfx2xmd5gTk8BHWTcKtwzXBj6BAl1uq4ZdQwpjucBCMIUKnZi16l5Eroz1+vDoZeO+0rKl0tjqLyxScdpSiZp6/8LiQ1tZLHbR2jSMTF6/LJPPhsStaXWRikmJIXZ0hIWw6ExrcxSFQSe0IYGPlaNdpAaMwOj4+KVr01iT8+dMoeC60DIVv0tVFbE+aK2xu3icmVYVgWqP0Fuzq59eelQ+akKrpRIO7QJtZJGKUy1ajY8N5ly0sChMnrf2HxrwvSSphhQk4DBvLXNksbr7RpBe37BOkJyzgMGvcQLhJoHH/dwUOA6xRXFTUs8hhfzqtwtIQMkZqvVnbB/+bq0S+3+Kn88vzifnIoOSqElHI2VyqUrjKD05PDkZyaYaLY5Gjgd/GrRrlIHIskwLsf9BZHDaT05IeSreobRoxQ+nZ2fn4/F08uWX888ZgE+GuC6XVBq9EdmwMMRW1Y2xtGp7l+lMrxRSvB2WD6L0vOJQxPcRSKJNibJA6952T2hkkIoMeioZiB+FzLnzpmTuUftM72W6sZWmV6uwDhxJat2Ua7G3yfaTXMhxqPQG463FdUWMdkx6ICq/yYrELVJeBpLfT7GLPGuk0hTMKVb7aQLS1UbxtKCcia+rmnYxC5OQhK/RwvODM/Im00zAKDxQZv40MXtvwjm33fXv1ueHcJsnCyQQQ4YU+vMlgUZSCSnsYstZDPMXB6C1nOSduYKnMVzwb1HgApVpatTUT3KoYQTqGmvI5Eb5dDTqGMqnHTeof4Z21joy9QoigYW0FQue68UnwPB7gbeyVdSHCQmgbmue7P6TH2G8t/E/TCaXYsDxCXA023gD32fBjaNE8T++fAhjxcdLBmEu2yA7U9Xbh93eczlXMjVmgY0kg1h1MAst897YWjLepz8mXKOwDdL+LwwiG0j7hI2nFm8tuvL/goRr1q2JdLaibxu0DmnjqraxxL0T9y2OYkoc1TKcHv1F7d+adcvTcJgQPtKoUbLSjBh6qeu7+BpkU7HbI2a07mRIgIseq3oNXTeTDq+s8p6X4xbu8CcOh/MP1unY9n6Py3DZ5JZULf8P87jqz3C+JBDlIHiIBqd5jkGkVlbPjldGGWY1qgskwNepjUwMpepf2MHq+qyXG/BdF3dEieH5inEE3QV/473/G72iEVg=
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Bulk delete saved queries"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/saved_query/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Bulk delete saved queries
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./bulk-delete-saved-queries.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./bulk-delete-saved-queries.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./bulk-delete-saved-queries.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"delete_tags_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":"Deletes multiple Tags"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: bulk-delete-tags
|
||||
title: "Bulk delete tags"
|
||||
description: "Bulk deletes tags. This will remove all tagged objects with this tag."
|
||||
sidebar_label: "Bulk delete tags"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFV21P5DYQ/ivWqFIPNbBwvUoop/vAcaC7K7qi7tIXEcSZZNgYHDvYk4VtlP9ejZ0Nu8sioaoSn5L4Zfw88/J40kKBPneqJmUNpPCx0beiQI2EXpCc+h0xKZUX90pr4bCyMxRSa56aYiHs1Q3mxNNUCuKFJKc7kEAtnayQ0HlIz1vIrSE0BGkLsq61yiWfN7rxfGgLPi+xkvymCCvPLzSvEVLw5JSZQpcsBqRzcg4JkCLN3xHrJUO97M10XZeAYjZ3DTpebGTFa++gu0jAoa+t8RiOebu7y48X46udrdGRirsr9F5OcQPeR8DRRcwAH2RVa1zZ+LihS9ZC8amPQtVoUrVGMZFTz3be7e69LuYzIxsqrVP/YJGKg4ZKNNSfLxzeNcphsYnS8sbI5OfXZXJs3ZUqCjSp+Ns2orDmRxKlnKGo0VXKe2ZEVsg8R+9jhjv0tnE5biI42Ivs3r0uu2+WxLVtTJGKSYkhMugJi4GCKCx6YSwJfFCeNjEabARGb9++dubVznIo5JVGwVlH81T8IbUqYvahc9Zt4nFoG10Eqr2Ffjcf9ctri8AXQ+iM1MKjm6GLLFJxYERj8KHGnIMWBoXN88Y9U17HkqQeXJCAx7xxzJEl+OaeID2/YAVksYT0HIKgXCTwsJ3bAscBWNRrLc0UUsjPfj+BBLS8Qv342ad/CnnjtNj+S3w6OjmaHIkMSqI6HY20zaUurad0f3d/fyRrNZrtjUhORxmILMuMENufRQYHvRgEP6fiI0qHTvxwcHh4NB5fTn779ehbBtAlA57TOZXWLCEaBgZMqqqto0Wu+8xkZiH44sMwvBOvjTcMRbwMeBLXligLdP5DuwY/g1Rk0FPIQPzUa8Yl2Vs0XWa2MlM7ZejNAs6OJ0mNv2Tfby2z/CpnchzCusR0ZfAxAtZ4JjsQlPdSkbhGystA7uXU2sivQiptwVxiVNeJp4uFYj2A7IHvixi2kf0kkP8ed3T8YE+8zwwDtxp3tJ2uO2TrfbimI5Dhhg89BZWQwjJ29kUomZi2jWNXbWQM68VywtOiwBlqW1doqC++EIloqK2dJZtb3aWjUcumurTl9OqeWDtsPNlqYSKBmXSKNcr3ehHM8HuB17LR1MOEBNA0FRdj/8mPUJSr9j9PJqdisNMlwGhW7Q18n4AbR1XhOe6EhHXiyykbYS6rRja6qt8fVncdB2ehLGPWxEgy6EsLVyEBjq2rJNv7+ueEYxSWQdrPwqCLgXSX8OZLh9cOfflfjYSe79pGOivomxqdR1pqGpeGOHfiutledImnSgbB77vGpZY4dMTr7lm6OP639rlnRvhAo1pLFfqJkJRtXwbnIGvF+PcgCDokwFkT0+Ic2vZKejxzuut4ODbCXCLPQn/u1Fuch9aZc1o3PB/Kc5Hg4U5JIKpDOCFuOMhzDFq12PXkSl0p8ig2kAA3iEtX6RDr/oUPWPwJmPmS+baNK6LicIFGHEF+obvouu5fNK1zXA==
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Bulk delete tags"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/api/v1/tag/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Bulk deletes tags. This will remove all tagged objects with this tag.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./bulk-delete-tags.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./bulk-delete-tags.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./bulk-delete-tags.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
id: cache-rest-api
|
||||
title: "CacheRestApi"
|
||||
description: "CacheRestApi"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
Cache management and invalidation operations.
|
||||
|
||||
| Method | Endpoint | Path |
|
||||
|--------|----------|------|
|
||||
| `POST` | [Invalidate cache records and remove the database records](./invalidate-cache-records-and-remove-the-database-records) | `/api/v1/cachekey/invalidate` |
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: change-a-database
|
||||
title: "Change a database"
|
||||
description: "Change a database"
|
||||
sidebar_label: "Change a database"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztXOtvG7kR/1cGbIGz0Y1k5x4N9hwDju1DfHUTJ7LvWkSBSu2OJMZcckNyJauC/vdiyH1JWudx9yEfqk+x+BjODGd+nIeUFcu54Rk6NJbF71ZMKBaznLsZi5jiGdKnexYxgx8LYTBlsTMFRswmM8w4i1fMLXNaJZTDKRq2Xr8Pq9G6Fzpd0pJEK4fK0Z88z6VIuBNa9T9YrWisoZUbnaNxAq1fK6VejBLH/acUbWJETjtZzM5oDs7fXp7dXsLt2YvrSzgbgPbTIBQM3lzDNR+zqOJvrLVErtg6qujOP0v3t6vL37+WbJrJx6gWFo0Fp8EUCpRWTwaX15fnt2Add5ihchYO7m4uzm4vI7i4vL6kfwMnEfR6vcMvY2AiJI6KXGqePsaI0xAWwPngN6ANkHLHQSinwc2E9R/H3OLVBCxKTBymEeQSuUWw6MDNEMK1WfDHYgoTbSCx84q0UHD54AzvfYJXU6gRt0uV7HL6OkfDHfqTKm6Ipl8+M1rpwkKmU4wgQ66EmoKb8cDZxwKNQAvcIOADJoXDFLQCg5l2CAtt7ukmuAWd59piShrRyu9d4BgsmjkaEM6inPTgljTCrS0ytOGQpS5gxucIHM5RolmWNEk3RU6EFygl/cvBoC2kszDmyT2qtAdvcYIGvKZJIuu4lN4hINWJ9WrMtKGpiTaZn+nWYcKTGY6cyFAXbleDF4UJZA+EAouJVqk9BD3x59Jer7OwO1zejBtnw4qWDfTgrF6mJ3AEQqXkwpUyKnIICklt+JALg7YHr7S/PyKFE+6VUEo9lXrMZU1VTKBQKU6EwpREVYWUfCyxApttiIkIUSZiWgo4ytDNdGnt/iAWM/tRckkWuhyRGlm0pZ3zDgogLDlpWtnCxHjg8uYRbsMPlzcJixm6WbhKfMilThEaNAXtJ3Kj5yJF0EougUOLq8IIkhVVkbH4XRe/S8UzkYSP79cRqy5kFIB5x7cbP6EFnukUlROTZbiFRCuFSWVPGX+4RjV1MxY//fEoYplQ1efjR6/AOiPUlG4gNWKOZpeLwZvrsyAHhCUebSw+fq0NTVRToToka9EMS76G5gN5+Eiokf1IS3epX/oVmzZPBwzeXD+GtPjg0CguR4XxaP8FXDjDd48+yU9/Hbx+BWEhXZDjwmOZ3wAbZg4owyvROxmb02PCJYSTRKd4GrQy8tZnT/p+DPT4AyYOpugsFCono00riEc44TAzOHk+ZDPnchv3+4Q+vcYMe9pM+6j6kjzd9RNtsB/Osb2Zy+RfWksTg9zhKEwPGRiUz4dMaZ2jQgNKG8I8g2bITh/bdtLnp5BwKSNYzOhJcrV4GTpON7Ml4J+VzKAcHY+OgmjVGTuyhWeu9090/II7/uXSVTtqwfy9PW3fWy3YBpRX8tGrUyJrhZQWnSPzaBA9vBclHZigS2YdCD7IMSEcEI4epRPrjFbT0yHrZmDIYlgNy7hsd+qno6MIhsyRxXfOrk/65Qk9uCJst+iiUpKFkBKUdjBGQEUkQuTg8bZQHp64FG75R58dUvL3bSWXccqojFMIT9tB0qa2dZZxsEiGRkGDFNafXsU6/uTzwW8htqginyaecvpxXX+GD9LduyHLi7EUyZCRhhM7ryffb+q0BqqJ5HNtINVovVptkefauJJjeoW4WlafhG3zPEbgSYLWUnD3obAOJFJQQ5r1gmOWuyXp84e2PudorNCq0ttEoEyD9koYs0EBISSrgHX8nYVyZxlR2ZkuZEpc+Dd3IdwMbgxap+HihQWrm3u2S+X4A/g3zBhMHDH1Y5spL5YdzYVxBZejYJv+VTbYwWmJ5W1Wq9dcG69HOvYy7Idx4dxG/F8HdUGMhfJW91OboVRYz0PALYNzgYs/xIj365JAHdl6LxqjzyQWM1TB8b3G6dQGEBqee3/vZM8IKUdOj1J0XMg/wqEnQfYUSNCuknrj2TUSPdu5tFFWSCdGCXdc6mntjbWzi8lmDhBumoJVejaCiZVhH5REgkpMofxTWmcDKgX/4tAgkbNIb2k/P2UdL/ZEmwR98jlq8tPN1/t3OsWzQxQ/m4tGwRPKcU/fBgfxVxYcMjyJPnvyq8uzPxmuHX1BGCSyHI3Vit5bykN3pbmalN4XkUwbeVTL8An2ptrr3fNbp1c8yJIUxqBycglST6chlKbzYDHTkBHG+LwpR5MJS2BQ5cNuhhl5Uf/0agIvBeVWKoWZmGMvpGNPe+G56KX6zDte+XpEwRlKGs1tW5/GicSDnC6Ui8iPoaWITzM8F3zz+Nzoh2XPz5V1imV3XibsKOOKTzEdVYGiXH4iTGxtzbi9p20qMcvcBQJfFzjyNBXhDW3F+5uBpAcrD8FVvtNKVFqbWgmod2S7tA4zC1Lco7+iqLEYlcILMX1ToFn6+C2ZQao9ftHRPnMK0Rnpj9KTOOfWLrRJK3BXdJaUy8DReAlN1F856WetvF3MWrFGFTftutJ6OxW8ePEkgJtI2gmcT4nbemsuO4TWdGIwjlGCpiMDP8lPX+flZZyfjV7cvbq4voSyGuaT4TmXIiVTfHl7ezOAsm5me/Da54tzLrzAZJR0BBeqAcIqGP9S5Wzmnp3cbpQmvjKOftqRIlS8PimMtJ+JnAcfZZ046sT6qLmrFkK6mIUilnWmSFxhkAoyBu7eXlXKaKHl8dHTH7bhclc3djZyhVIoy8Lj64kvh24WJEVHRW0weAm3fidcXcABcVzkdKX28IsqGZUbtEqpLXs2Yk6IfY/Lz82PPkmoNFOepgat/dQSCh67yroRqzy3Y/d62zMi5oQjsdlFaQKDwcugJkYF4k29EPFCdHH+BYTfonVnuejlhQuZNs9yidv146D+duW3PeKLtu2BjSJqe6JVsQzDW0W440drU7sFnErKppjSjFSlkNbITiEjMLBZi2iv9y9HM9AR0TSTu/FBoP7IWxYmH3utGrIbgLwNl82ybWhqzbQds7aTxj52wbyCxzpy2mxdrGnA5lrZ4NNPj47+RItiw2hVkY2Dq4T0YN/R2Hc09h2NfUdj39HYdzT2HY19R2Pf0dh3NPYdjX1HY9/R2Hc09h2NfUdj39HYdzT2HY19R2Pf0dh3NB7taOys3+xx0BnH7YLzvunxf9D0eLzr4YNITMlKfvhTnY0MreXTL3KNTYusN7IXPK3wP4Yr5V+G9nNUPtBpVxuntTfIcvxtZblTvHAzbcR/MY3hrHAzqkOG86HuMHUI0t4YJPn+20ryizZjkaaoYvi3LiDV6rvOEDYk0iFmN2h1YRLsErCmF6T74dtK90pT5b9QaeyzstKEMK1FaOoK+CDIuHYlqml4iZ4+/daWlxtNV+HDJrI6t4zhtxBm+SKqMdp0yXHuqxEkakmh3E1H/fitweFKBWCtWlNeihjOFBQKH3LfoAuDoBOf0nS61y+UH9cqIKxNCkMyUqzzYeFY/O49Pc+OT+kHbjVQsvcRe3hCmfnAMxd+/Sa5mrKYJXdvr1nEJB8TAlcfSxeIWVIYCU/+BTd3txBCybjflzrhcqati58dPXvW57noz4/71ePXPx4yGA6HCuDJSxiysxITvLpjeIHcoIG/np2fXw4Go9vX/7h8tbnhPFzUk9tljjFs31WzNoXvVkN2j0sqvg3ZnMsCh2z9HVtHtXg3SzfzsX8lYD1QiygyX3KrovehGqqqaw7Pm6A+L9wBHQtfo4co7JghT9HY56stbQTGS40MGfytRKKR0/eo1uVukvp5l6RDdThUuRHKHVQc92jxweFhWwe/8jkfeDtq6WFjsLlurSypohafL7hwoT7lpf9a2VdBhBAkEe83d7fbaomrVbBtLSTufyqDWQXd3HrV/CdqtrTtJSho12bC6kqjY50uY6AcvBecWUyWByu4x2VLvbA+pNWk5Z+HKmjGV+UqrWzpvFykJfaknh7Q0sOffby8BVU+bAFe54KU8ZRBJKM4OAo/So3ZjlZX+f2aVUFWcOMQFHZeyk7X9JqmIcU5Sp1TM6oEJG8sgdAqN9rpRMt13O+viNQ6XpF/rHd7sIV1OqtIRGzOjSDctiWGejKbbV1is9U1LT/6BJXt6ImSaqjprCNG3GzSq+XdYW4QkJbmfDtVG7i68UmXNltEOlVV7ver1/53vhXaDuidCEJ6zF2xsTfQX3yKS571+y0rfzTs60N+tqk+eKHXEW0eGZwYtLM/SoSoWK3eNr9Avvy23wg72qdAfzYF8lnuUbuy0DqpXVDoHB51bdsuH+zMBJ84ahcJWqWFrYwsYlTO6SilFKRdbCf5raGyecRiNj8Obmhdxn3gVR7YBYsbJ9Txl8MH188lFz4ML5v4ATLfMZ4LOu6YNabIIhbn9wQwAUHesdWKxu+MXK9pmKrOFEW9b0DMY2vVCGHxhEuLO/zUESU7eFumRYfQOOkmn+UgV0uPlbKgTyxi4TLze7amb4mEJ9GfHibaj1tr404ESxAedpwlCfpX/fG171svzs0dIc24/O8L6DtZLGaGL+jbhHwReAxdD495fiyEFkWIbgNJAiPK/lr3VINW+QcJ1amF1SqsCE/7ulaKj4JIL+v1/wCyz0Mx
|
||||
sidebar_class_name: "put api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Change a database"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"put"}
|
||||
path={"/api/v1/database/{pk}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Change a database
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./change-a-database.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./change-a-database.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./change-a-database.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
id: charts
|
||||
title: "Charts"
|
||||
description: "Charts"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
Create, read, update, and delete charts (slices).
|
||||
|
||||
| Method | Endpoint | Path |
|
||||
|--------|----------|------|
|
||||
| `DELETE` | [Bulk delete charts](./bulk-delete-charts) | `/api/v1/chart/` |
|
||||
| `GET` | [Get a list of charts](./get-a-list-of-charts) | `/api/v1/chart/` |
|
||||
| `POST` | [Create a new chart](./create-a-new-chart) | `/api/v1/chart/` |
|
||||
| `GET` | [Get metadata information about this API resource (chart--info)](./get-metadata-information-about-this-api-resource-chart-info) | `/api/v1/chart/_info` |
|
||||
| `DELETE` | [Delete a chart](./delete-a-chart) | `/api/v1/chart/{pk}` |
|
||||
| `GET` | [Get a chart detail information](./get-a-chart-detail-information) | `/api/v1/chart/{pk}` |
|
||||
| `PUT` | [Update a chart](./update-a-chart) | `/api/v1/chart/{pk}` |
|
||||
| `GET` | [Compute and cache a screenshot (chart-pk-cache-screenshot)](./compute-and-cache-a-screenshot-chart-pk-cache-screenshot) | `/api/v1/chart/{pk}/cache_screenshot/` |
|
||||
| `GET` | [Return payload data response for a chart](./return-payload-data-response-for-a-chart) | `/api/v1/chart/{pk}/data/` |
|
||||
| `DELETE` | [Remove the chart from the user favorite list](./remove-the-chart-from-the-user-favorite-list) | `/api/v1/chart/{pk}/favorites/` |
|
||||
| `POST` | [Mark the chart as favorite for the current user](./mark-the-chart-as-favorite-for-the-current-user) | `/api/v1/chart/{pk}/favorites/` |
|
||||
| `GET` | [Get a computed screenshot from cache (chart-pk-screenshot-digest)](./get-a-computed-screenshot-from-cache-chart-pk-screenshot-digest) | `/api/v1/chart/{pk}/screenshot/{digest}/` |
|
||||
| `GET` | [Get chart thumbnail](./get-chart-thumbnail) | `/api/v1/chart/{pk}/thumbnail/{digest}/` |
|
||||
| `POST` | [Return payload data response for the given query (chart-data)](./return-payload-data-response-for-the-given-query-chart-data) | `/api/v1/chart/data` |
|
||||
| `GET` | [Return payload data response for the given query (chart-data-cache-key)](./return-payload-data-response-for-the-given-query-chart-data-cache-key) | `/api/v1/chart/data/{cache_key}` |
|
||||
| `GET` | [Download multiple charts as YAML files](./download-multiple-charts-as-yaml-files) | `/api/v1/chart/export/` |
|
||||
| `GET` | [Check favorited charts for current user](./check-favorited-charts-for-current-user) | `/api/v1/chart/favorite_status/` |
|
||||
| `POST` | [Import chart(s) with associated datasets and databases](./import-chart-s-with-associated-datasets-and-databases) | `/api/v1/chart/import/` |
|
||||
| `GET` | [Get related fields data (chart-related-column-name)](./get-related-fields-data-chart-related-column-name) | `/api/v1/chart/related/{column_name}` |
|
||||
| `PUT` | [Warm up the cache for the chart](./warm-up-the-cache-for-the-chart) | `/api/v1/chart/warm_up_cache` |
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_fav_star_ids_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A list of results for each corresponding chart in the request","items":{"properties":{"id":{"description":"The Chart id","type":"integer"},"value":{"description":"The FaveStar value","type":"boolean"}},"type":"object","title":"ChartFavStarResponseResult"},"type":"array"}},"type":"object","title":"GetFavStarIdsSchema"},"example":{"result":[]}}},"description":"None"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: check-favorited-charts-for-current-user
|
||||
title: "Check favorited charts for current user"
|
||||
description: "Check favorited charts for current user"
|
||||
sidebar_label: "Check favorited charts for current user"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFVl1P3DgU/SvW1T6ANjCw6kooVR8oAkq3ahEzaFciaGqSOxNDYgf7Zgob5b+vrp1kPpitqvaBpySO7/E598u3gUpaWSKhdRDfNJAaTagJ4gZkVRUqlaSMHt07o3nNpTmWkt8UYen4hZ4rhBiUJpyjhTbqV6S18hkiIEUFf8+RpjO5mDqSdqoyN+3A2raNQGmI4bFGyxZalmzwCO1tBBZdZbRDf9gfBwf8+GGWlTUVWlLB2qKrC2+VoUutqtgKYjgWhXIkzEyEHU7MjBUo01ykxgYCmdJzkebSklBaUI7C4mONjiBa+mL9OJW9PGqSozgJKBlEW5y3kEWN2+3O5ALHJK0IewbrO2MKlBrape/N3T2mtOJ8f+aZXLD9VefRq+COzYh9D+Yce5CLzI27+EWAT7KsClz18c2tj+u6is9GI+9/80thLNE5OceV5HNklZ5vYb7ObTCE9zLr4xeLC72QhcrEshREZc1CZZjBFhErtkHL4etqudayptxY9S9msTiuKUdN3fmeqLLbhawaBiVvXlfJZ0NiZmqdxWKyLDBkdztT2xRFZtAJbUjgk2L3b0uxDoNP+fO18+xCE1otC+HQLtAKtNbYWBxrUWt8qjBldX5RmDSt7f9E6kySLMI+f7jDtLaKnn3Lvv8Wyu02ApJzbuOh2h3cRvC0l5oMx55a6PCF1HOIIb2++gQRFPIOi+VncDN/17YQe/+I89OJSCAnquLRqDCpLHLjKD46ODoayUqNFocj3xRHM7kwVhFye6fajRIQSZJoIfY+iASOu0Tzjo/Fe5QWrfjt+OTkdDyeTr78dfo5AWijgd7lM+VGrxAcFgaKqqyMpT5LXKIT3d8V4t2wvD9H2mEe4md1RME6R5mhde+aDTUJxCKBTlEC4nch0xSdm5J5QN0mejfRlVWadnp2+5x4O7u7q3o/yoUc+4ivaF5bXIbGaMeyB6nym1QkZkhp7pX+is5mTWzcf4vNGLLqr30Ym6B44gV/DRYtP1j920QHxpkkObDd8EW3yRS4X5j5Dm/dfeuv//VCOMkxfRA99yxcyOG69tWjSdQOLURQIuUmC2MHRFBJyiGG7/uAvezrNFRKbTkIW30Jm8Q+8W+R4QILU5XMIyD5GAegprKGTGqKNh6NGoZq44ZTuH2BdlI7MmUPwUOBVfKuwH7I8DBhSJhJf916mhAB6rrkDtB98sP3gXX8D5PJpRhw2giYzTreoPcFuXFoZfyPBzVhrLi4ZBDWsg6y1VWdvd/dthzjvp35gSKI9E2tgTufYWfGlpLxPv494Rj5bTz4+L/LQciLbiM2nlqcWXT5z4L4kXRmXg5i47pC63B1KFpZ4twJ+xaHwSWOSulvmW6o/fEMXjt3uIIIn2hUFVJpxveZ1XTZfQOyUkziECLwuBDBRo5DBJwOId430DR30uG1LdqWl8MAzrm/cfhwg8LSUetMHvDZj+zDBAu+fPvM9TdUBKGv+BOCwXGaom9vvdWLC5pRhmI+P+XY8diy4pIhgt0Lo/cTrX5ewW6asCM0Ki67QMJ3amh5Yv0PqbeFZg==
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Check favorited charts for current user"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/chart/favorite_status/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Check favorited charts for current user
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./check-favorited-charts-for-current-user.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./check-favorited-charts-for-current-user.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./check-favorited-charts-for-current-user.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_fav_star_ids_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A list of results for each corresponding chart in the request","items":{"properties":{"id":{"description":"The Chart id","type":"integer"},"value":{"description":"The FaveStar value","type":"boolean"}},"type":"object","title":"ChartFavStarResponseResult"},"type":"array"}},"type":"object","title":"GetFavStarIdsSchema"},"example":{"result":[]}}},"description":"None"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: check-favorited-dashboards-for-current-user
|
||||
title: "Check favorited dashboards for current user"
|
||||
description: "Check favorited dashboards for current user"
|
||||
sidebar_label: "Check favorited dashboards for current user"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFVttu2zgQ/RVisA8JVq2bRRcIVPTBzSZtukVaxA52gShwx9LYYiqRKkm58Qr698WQknyJ95qHPkmiOGfOmRkOp4EKDZbkyFiIbxtItXKkHMQNYFUVMkUntRrdW614zaY5lchv0lFp+cWtK4IYpHK0JANt1K+gMbiGCJx0BX8vyc0WuJpZh2YmMzvrwNq2jUAqiOFrTYYtFJZs8BXauwgM2UorS97ZTy9e8ONfs6yMrsg4GawN2brwVhnZ1MiKrSCGsSikdUIvRNhhxUIbQZjmItUmEMikWoo0R+OEVMLlJAx9rck6iDax2HUns8eupjmJs4CSQXQgeCssajpsd4Ermjg0IuwZrOdaF4QK2k3s9fyeUrcVfO/zAldsf91F9DqEYz9jfwfzlnqQy8xOuvxFQA9YVgVtx/j2zud1V8WVVsT7Xz4pjSVZi0vaKj7rjFTLA8x3uQ2G8AazPn+xuFQrLGQmNkdBVEavZEYZHBCxZRu0nHxfLTcKa5drI/+gLBbj2uWkXOffE5XmsJBtw6Dk5fdVcqWdWOhaZbGYbg4Ycbitrk1KItNkhdJO0IPk8B8qsQ6Dvfz8vevsUjkyCgthyazICDJGm1iMlagVPVSUsjq/KHSa1uYvMnWBDouwzzu3lNZGurVv2fffwnG7i8Dhkts4/II2n2s0mYW7CB6epTqjiacXunyBagkxpDfXHyCCAudUbD5DqPm7NoV49rt4ez4VCeTOVfFoVOgUi1xbF5++OD0dYSVHq5NR1jscLXCljXTEbd7VdpSASJJECfHsnUhg3BWcT0As3hAaMuKH8dnZ+WQym3789fwqAWijgeKntcu12iI5LAw0ZVlp4/pqsYlKVH9niNfD8vMluSPmIZ6iJQoIOWFGxr5u9hQlEIsEOlUJiB8FpilZO3P6C6k2UceJqoxU7qhn+JyL8Oj4eFvze1zhxGd/S/fO4iZFWlmWPsjFbyidWJBLc6/2qVqbHcFx/y32c8nKP/fpbILqqRf9OVi0/OAIvEpUYJ2hw4HxXjy6Tbqg54VeHvHW41d+HNg9GGc5pV9Ezz0Tg55whfsTpZyoLRmIoCSX6yyMIhBBhS6HGP45Fhxxf37D6akNJ+RgXGGf4Af+LTJaUaGrkrkEJJ/vANRURjud6qKNR6OGodq44ZJuH6Gd1dbpsofgYcFInBfUDx8eJgwPC/TXsKcJEZCqS+4M3Sc/fG/YxX83nX4SA04bAbPZxRv0PiI3CS2O//EAJ7QRl58YhLXsghwMVWfvd7ct57pvc37QCCJ9s2tg7ivtQpsSGe/9b1POkd/GA5H/uxmQvOg2YuOZoYUhm/9fED+qLvTjAW1SV2QsbQ9LW0tcO2Hf6iSExLoS/e3TDbv/rZJ3fA/Xk6MHN6oKlIp9+Opquiq/BawkEzlh6x4bItirdYiAyyLk/RaaZo6WbkzRtrwcBnQ+A3sEhhsWNgHbZfOF1n6kHyZc8Me5r2B/g0UQ+oz3EAzGaUq+5fVWjy5wRhkO9ttzziGPNVthGTLZvTB6P/Gq9RZ204QdoXHx8QskfPeGlifaPwEkK5IW
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Check favorited dashboards for current user"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/dashboard/favorite_status/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Check favorited dashboards for current user
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./check-favorited-dashboards-for-current-user.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./check-favorited-dashboards-for-current-user.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./check-favorited-dashboards-for-current-user.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"force":{"type":"boolean"},"thumb_size":{"items":{"type":"integer"},"type":"array"},"window_size":{"items":{"type":"integer"},"type":"array"}},"type":"object","title":"screenshot_query_schema"}}},"in":"query","name":"q"}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body"}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"cache_key":{"description":"The cache key","type":"string"},"chart_url":{"description":"The url to render the chart","type":"string"},"image_url":{"description":"The url to fetch the screenshot","type":"string"},"task_status":{"description":"The status of the async screenshot","type":"string"},"task_updated_at":{"description":"The timestamp of the last change in status","type":"string"}},"type":"object","title":"ChartCacheScreenshotResponseSchema"},"example":{"cache_key":"string","chart_url":"string","image_url":"string","task_status":"string","task_updated_at":"string"}}},"description":"Chart async result"},"202":{"content":{"application/json":{"schema":{"properties":{"cache_key":{"description":"The cache key","type":"string"},"chart_url":{"description":"The url to render the chart","type":"string"},"image_url":{"description":"The url to fetch the screenshot","type":"string"},"task_status":{"description":"The status of the async screenshot","type":"string"},"task_updated_at":{"description":"The timestamp of the last change in status","type":"string"}},"type":"object","title":"ChartCacheScreenshotResponseSchema"},"example":{"cache_key":"string","chart_url":"string","image_url":"string","task_status":"string","task_updated_at":"string"}}},"description":"Chart screenshot task created"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: compute-and-cache-a-screenshot-chart-pk-cache-screenshot
|
||||
title: "Compute and cache a screenshot (chart-pk-cache-screenshot)"
|
||||
description: "Compute and cache a screenshot (chart-pk-cache-screenshot)"
|
||||
sidebar_label: "Compute and cache a screenshot (chart-pk-cache-screenshot)"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztWNtu2zgQ/RVisA8JVqmTogsUKvqQBulti92idrELRIHLSGNLtUQq5MiJK+jfF0Pq5kv30jx0H/pk8zKH5wyHw6FqKKWRBRIaC+FVDZmCEEpJKQSgZIHcWkEABm+rzGACIZkKA7BxioWEsAbalDwrU4RLNNA0QQ2xVoSKeFiWZZ7FkjKtJp+tVtw3GJdGl2goQ8uthTYxjjBvtM5RKmgCoLQqbuY2++LGM8LCHlo86HqkMXLD7btMJfruv1sOHfrmM8YEAVBGOXfY2CAqm2qa31ZoNvNWT8NGzoGue/DgLTTX7EJbamW91Menp/zzjY6KZZzifIUbbiRoY5OVbAghzFIUbljwcC/CksnUkmXGqTQ0r0x+2LYyuSAtDKoEjSBGY4NDSFkhl/iPSAukOHVAg98OoZG0q7klSZU9jOfHhF44MGk3Kv43kFWZSMJkLukwLGUFWpJF2SHn0hKLVksUmWqX3Yf/mwC5YI9d8CZMe34f2t2ftrESAN7LosxxZz87/K2NGjpHPh86t1y30z2WP3Bvgh1POMqtUw3aKiem+Pj08Y8o/RGl/7MoHdwp2FjEBtmY2T55UFot0Fq5HN9AX3Xjtmd6Q3ghE8F3JVoKxRu1lnmWiOGOFaXR6yxhsvvqRrZey9n31fJRyYpSbbIvmITivKIUFbXri74gOCBkbOiVPPm+Sn7TJBa6Ukko+DC1TkZ2t9WViVEkGq1QmgTeZ+z+fVE9Bq/yy/eOszeK0CiZC4tmjUagMdqE4lyJSuF9iTGrc51Cx3FlvrJTLyXJ3M9zi1uMK5PRxtWCn+8Iwqtrrl1ILrk+9AfQwnUA9yexTnDqqPnSMZdqCSHEHz+8gwByeYP50PRu5jYn3JM/xavLmYggJSrDySTXscxTbSl8evr06USW2WR9NnGpZXI28XlnOPWTCEQURUqIk9cigvM21pzvQ/ECpUEjfjq/uLicTuez33+9/C0C4LK0Zfh+Q6lWI459R88yK0ptqAsUG6lIdeWbeN53P1oiHTEP8QApgQdIUSZo7PN6R1AEoYigFRWB+FnIOEZr56RXqJpIHUeqNJmio47gIw6/o+PjseS3ci2nbt9Hsrc6hw3SyrLyXq28kxn5C9KJfaDUektv2LXF7k6y8E/dZtZe9Mxp/uQtGv5hBzyLlCedSJI94R13tJN0jo9yvTziqcfPXF2+c8XooqwIhVRJW6HI8YVz5OSdlKsTN3gyDB1DAAVSqhMIYYnsU/eOCmHbM3W5avadwzvgTrI/S/7qPOhn2GX8jodFgmvMdVmgojYnuP33QHVpNOlY5004mdQM1YQ1R3izh3ZRWdJFBxHAWppM3uQ+cXUwvkZZSC4TPU0IAFVVcI5om/zjMsU2/uvZ7L3ocZoAmM02Xq93j9zUJzse46eV0Ea8ec8grGUb5KCrWns3u2l487uE5woeL9KlvRpuXOi91KZwRcnbP2bQPnvd09SNDvWWE90EbDw3uDBo028FcY/Ihd6vA6dVicbiuIYbdXHs+HnrM+8SS4V091D7DH1QaG9R6e8twnualLnM3CO9LbJ92F+BLDPmddZViRBA6D4m7EY/BMCB4iPhCur6Rlr8aPKm4W7/mOZTscOhv31hcOE2IV+r3rowzisedye+i2kPmln+n0C4kLnFPaXDKkcf2prnWHxtwe4bgtqM1+yIlCtorjnkXe5zq/uB8zhGl4U7k71qgmn32eXVJYcR11jjjyVdMLV/GP0gnbr2M3wybXp27kJhgk3zF/V+R3Q=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Compute and cache a screenshot (chart-pk-cache-screenshot)"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/v1/chart/{pk}/cache_screenshot/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Compute and cache a screenshot (chart-pk-cache-screenshot)
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./compute-and-cache-a-screenshot-chart-pk-cache-screenshot.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./compute-and-cache-a-screenshot-chart-pk-cache-screenshot.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./compute-and-cache-a-screenshot-chart-pk-cache-screenshot.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"dataMask":{"type":"object","description":"An object representing the data mask.","additionalProperties":true},"activeTabs":{"type":"array","items":{"type":"string"},"description":"A list representing active tabs."},"anchor":{"type":"string","description":"A string representing the anchor."},"urlParams":{"type":"array","items":{"type":"array","items":{"type":"string"},"minItems":2,"maxItems":2},"description":"A list of tuples, each containing two strings."}},"title":"DashboardScreenshotPostSchema"},"example":{"dataMask":{"key":"value"},"activeTabs":["string"],"anchor":"string","urlParams":[["string"]]}}}}}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"cache_key":{"description":"The cache key","type":"string"},"dashboard_url":{"description":"The url to render the dashboard","type":"string"},"image_url":{"description":"The url to fetch the screenshot","type":"string"},"task_status":{"description":"The status of the async screenshot","type":"string"},"task_updated_at":{"description":"The timestamp of the last change in status","type":"string"}},"type":"object","title":"DashboardCacheScreenshotResponseSchema"},"example":{"cache_key":"string","dashboard_url":"string","image_url":"string","task_status":"string","task_updated_at":"string"}}},"description":"Dashboard async result"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot
|
||||
title: "Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)"
|
||||
description: "Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)"
|
||||
sidebar_label: "Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFWG1v2zYQ/ivEYcASTImbogMKDf2QZi3abmuD2sUGxEF6li4Wa4lUScqJJ+i/D0fKkmy5a9cV6KdE5PF499zDe3ENJRosyJGxEF/VIBXEUKLLIAKFBfHXCiIw9LGShlKInakoAptkVCDENbhNyVJSOVqSgaa5DtJk3VOdblgk0cqRcvwvlmUuE3RSq8kHqxWvjXTpxQdKHERQGl2ScZIs76bo8A+0q0OSKdnEyJL1QgznSoQdYag0ZEk5qZbCZSRYiSjQrk4hAkxTyUcwvxzcxB42EWDi5JpmuLCDC9EY3EAE0lExXLfOSLWEZmSJyKXdMyMoFg4X9pRPoEoybcbKxrrCxtipoMErq0x+ySH9EqM/70wh1cuw+TCCAu+3H5/yU98KV5U52UgQJpngyKNU3s473drPXjcROOlyvu1XtNlCo0mniSFSNtPuUls3DaxoIqB7LEoW3aXAijYQwxrzimAvXFdbF657dHtUBxBd9ZLXTcNWGbKlVjYw7uGDh/+Jv7t8TTDJ6MabWe/BNctI+G3B29EBFm1BualMfvh8ZXLhtDCkUjItt9tDhzTKApf0WW235JLMK7NdNA5pc2hXN9ahq+xhfWHPE4IJajcq+RKVVZmio/QG3WG1ThZkHRblVnOO1okkQ7UkIVV77Vh9E41Sxoh/FxyQnoRvWyYcJOIgtoPnuhu0fmOAfb+4A+He8hCG3ofRq+tMbwE2ZKvcsamPHjz4H8wtyFpc0oGUMMJxF5buIDzFVLRlIBYv1RpzmYq+2IjS6LVMKT3k1uBs8OXs+/ryTmHlMm3k35TG4rxyGefecL/oKuMBR4YHgyePvq8nr7UTt7pSaSz4NbUgE8NtdWUSEqkmK5R2gu4lwz92qtPBt/z8vXn2UjkyCnNhyazJCDJGm1icK1Epui8pYe/8otBJUplPROo5OsyDnL/cUlIZ6Ta+Kfpw5yC+uubOxuHS15fu5VmuMfcniU5p6s0LfVSOagkxJO/e/g4R5LigvP8MUPM3Z92Tv8Tlm+lMzCFzrownk1wnmGfauvjxg8ePJ1jKyfps0iWXydkkZJ8+3fSJdTIHMZ/PlRAnL8Qczlv6+XDE4imhISN+OL+4eDad3sze/Pbs9e6BixDIk9mmpFjsx7KXTcWP9ZxL8BxiMQ9VeA7Nj9BEnfOXG5dpNXC/W+gAkEWpjdvy0M7VXG0LsHjSLZ+W2rojvld8M5SioC4jTMnYJ/UeVsGtFq85iJ8EJglZe+P0ilTTnmZMnhzCYa6O56o0UrmjrT+nLHx0fDxE6BWucepZOEBpZ7Gnila+j+zAwTuULtRrD803BaYO/hXkMp2yY8zQfdDirZjYZxqD8X5LtjogN/PAvY/6I0OuBfjGfAvSW7wXOt3E4tX0zevTkCjk7eao5h5qAL5ojlmaY/DLXAXcfNe/xWwvIq2Qzuk018sjFj3+Bfix76aIC12UleNmO217Nxx0NOKow/OkXJ14gZN+qRc8hggCrjxbaevnHB64YhjHqi5Xzb+Fixni817IOqHDOMiD0TTxO2+LlNaU67Ig5doM6vkZFNWl0U4nOm/iyaRmVU1c84NtRtouKut0sVURwRqNxEUe0vxWTWjpbpF7lGAmRECqKjijtp/8x+fUXf0vZrNL0elpImBrdvV1/o6Mm4bSwHs80wptxMtLVsK+7Co5CFV73ks3fsDdlgffGwYnfZGoYeFZ/1ybwvdur/6cQTst8ysOu3176p1uIj58Y+jWkM2+VglrsVq97UfvZwfnpq8elTpBHibUrR436NOqJGNp2FwPlpilQW59FsC3rkDfH7S/NHzDF7ZjWNddOLp3kzJHqdpR2bPTP74rwFKylWfDRh4iiP3vH59+gxABYxf4eAV1vUBL70zeNLz8sSLDTcR1/yT8S02l5f9TiG8xtzQyuGuo4Oht22Aeiz7ku45sx3m18S+PB+IYIGon5HIFDccsZG1/e9gY5t/BwVEDxwkhnDhPEvJl6dOy14PsxkUDIli0PwMVOuUzBu/4ByW8C0Zq77N/Qn4tFMcqdHdBJ3ObG+lBJLs30P7DXh2Eoa6DRCg/TYeKr+MMTNP8A0Tdl40=
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/dashboard/{pk}/cache_dashboard_screenshot/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"duplicate_slices":{"description":"Whether or not to also copy all charts on the dashboard","type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"}},"required":["json_metadata"],"type":"object","title":"DashboardCopySchema"},"example":{"css":"string","dashboard_title":"string","duplicate_slices":true,"json_metadata":"string"}}},"required":true}}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"last_modified_time":{"type":"number"}},"type":"object"},"example":{"id":1,"last_modified_time":1}}},"description":"Id of new dashboard and last modified time"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: create-a-copy-of-an-existing-dashboard
|
||||
title: "Create a copy of an existing dashboard"
|
||||
description: "Create a copy of an existing dashboard"
|
||||
sidebar_label: "Create a copy of an existing dashboard"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFWG1v2zYQ/isHYkATTImTrQUKFf2QZi2armiC2kU3xIFLi2eLDUWqJGXHE/TfhyNlWX5pMbTA+skWdTze8/Dh8U41K7nlBXq0jqW3NRPoMitLL41mKRvlCIK7fGq4FSAFGAtOVXOWMEnvS+5zljDNC2Qpk2Ji7KR9b/FLJS0KlnpbYcJclmPBWVozvyrJ2nkr9Zw1zV00RudfGLEii8xoj9rTX16WSmac4hl8dhRU3XNVWlOi9RJdmObCzzaE6wVaKwXC5XAIM2PB9zGdsmQ3noR1bydeeoX7Pi8gvDjsruAPb1HPfc7SJ2dnCSukXj+fJUxXSvEpOY207C9eRcA4cUpmeADRxxx9jpb2QhsP3gBXzkBmyhVwpSDLufUOjN6ObYN0aoxCrmk1onRSoOeCe76/1CiXDt4Mr9+BmX7GzIN0MEeNlnsUIFaaFzLjSq1gmaOGTMnsXup5WNjxBVKMZoF2aaVHmFbeGw1yJzBYSFyewlXwjg+lcSggRxv5tThDizpD4FqEkdIs0ULl0DpY5gYKvoIl1y0THi2AKzGTM5nBRt0Hdrrpq/R2h4u7zjxCp+lRDeyPdeSXplwNoxibhOEDL8ool6DE9ToHBNV7tbfdURc7G7OJudk9WmHAlUa7KJbfzs5+4AxJ0TuiuiqmaAmb4s5PCiPkTCKhKPCAWbNL2TYp5Pr8sKvzgGtbe1cCzAw0LntKIQnQfFjPhzC/SdjjH0JdoHN8joey07cxdRPZCy6gTWMpXOkFV1L05AelNQspULADUHtzI5bzn4vlg+aVz42V/6BI4aLyOWrfrg+d+g4A6U+MSH7/uUheGTuVQqBO4W9TgTD6kYecMlOJtpDOESLKG1mGzoGnfGfRmcpmeAhg5y+ie/xz0b0zHmam0iIFuqlbCaHoIIAw6MItgQ+SxLWPqPNBqzz52afoSnu0mitwaBdoAa01NoULDZXGhxIzQhcGwWRZZb+iw1fccxXtwuIOs8pKvwolzuelZ+ntHdUdns+p7NlkdEd5/+EkMwKHIbxYFSmu5yxl2Yf3bxllsCmqzWOrlpRllVVw8hfcXA9HMGa592U6GCiTcZUb59OnZ0+fDngpB4vzQZfTBucDurkHYwbj8VgDnLyGMbtoj1EgPoUXyC1a+OXi8vLlcDgZXf/58t32hMu4ZSejVYkp7O7axlbAo3rM7nE1ZimM2YKrCsesecSapIN5s/K50T2g3UAHVRalsX6tODfWY72+hOB5N3xaGuePaF34Dj6SODFHLtC65/UOKxFAy8yYwa/tIZ54c4+6aWcT+ueHEI/18ViXVmp/tI78lIyPjo/7XLzhCz4MyurxsTW42X6jHVHS0cCXXHqYoc/yQMJ3UlBHJAX63AiCQPrapSddm8Guegj2p7WA6sjRKFD0KdlM6esnErWvoWi9ZnZqxCoNxeFpPOZytjqq4R5XPZqhOSZrYvvZWEeGqKLp2NnhvjUyCk+VmR+R6fEzRkd1+4BfWuQegceq18yA65jiqPrsl7yRNWpVjKPdCh1LyvY5rzfdSxPpp70NWSjmgMrS1h/cQbYb3lt6DQIXqExZoPZtPgvKio7q0hpvMqOadDCoyVWT1nSomj1vl5Xzpli7SNiCW0k9hGtTcHATi/cZr5Rvw2QJQ10VlN/aR/oJGW7b/+vR6AY6P03CKJptfx3eveCGMVHTO2oDqeK/uiEnhGXbyUGq2vnBugnN4DpZh8o6ggwpu2bToOJXxhac/L35OGJtYxnamvB2U+YH0NTjLP3E4syiy7/XSdspvd+0qS//j2KfuuyZ2W/LhlWJ1mG/J+kNkWKj3eI8boTzBQ83d9uo/+fTs7Vsd6t7fPCDUnEZqqAg57o9WLeMl5JiOO8zwRKWbn0coHVZwkiKUWu3rK6n3OEHq5qGhr9UaOm6vtvIPX6fkI7+C5bOuHK4F2JXurCj922hegzf+IxxEFI7yPUqnDZV0RNL6BLZ/szR3NFpCRk4RBcN+rm052CvlKJkEGdcZBmGy+Trtne9XEYXAEvYtP1cUhhBcyxf0ncXvozBmsBJOD5hLF5pVayzok/SNRXsvb3t9N/+IVQH6ajraBGvkqZjJ9y+REzT/AslI1mQ
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create a copy of an existing dashboard"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/dashboard/{id_or_slug}/copy/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create a copy of an existing dashboard
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./create-a-copy-of-an-existing-dashboard.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./create-a-copy-of-an-existing-dashboard.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./create-a-copy-of-an-existing-dashboard.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"css":{"nullable":true,"type":"string"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"CssTemplateRestApi.post"},"example":{"css":"string","template_name":"string"}}},"description":"Model schema","required":true}}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"properties":{"css":{"nullable":true,"type":"string"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object","title":"CssTemplateRestApi.post"}},"type":"object"},"example":{"id":"string","result":{"css":"string","template_name":"string"}}}},"description":"Item inserted"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: create-a-css-template
|
||||
title: "Create a CSS template"
|
||||
description: "Create a CSS template"
|
||||
sidebar_label: "Create a CSS template"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzVV21v2zYQ/ivEYUATjImTYAUCFf2QGCmarmuC2N0GREFKS5dYDUWyJOXEFfTfhyNlWX4purYDin2xZerueM9zzx3pGix+qtD5U53PIakh08qj8vQojJFFJnyh1eCj04rWXDbFUtCTsdqg9QW64ObCl6qkFBOJkHhbIQc/NwgJOG8LdQ8NB4+lkcLjrRIlkkcpnt6iuvdTSI6eH/CvRWi6FT35iJkHDr7wZA5D58Zt9Ct0/sQU+0Y7T7vikyiNxC7RRbiNfJb7NBxydJktDOGHBP7QOUrW4ueBtsJiHvNsaMEZrVyk4+jg8AfILHL63ODOoquk/39xv+GzWg1CuizGEuC/rtJGmc49lqxQDq3HnHb77eDgB0pRonPiHrfU4yvIOkc4FTlrmyxh52omZJEzI6wo0aN1zFg9K3JKdhNNzzdi+RFZ/QdY3itR+am2xWfME3ZS+Skq3+7PupbYAqTvGJAcHf1sJMbqjH5OJDJC4ecJ+5OKE9GgtdpugzLUlcyZ0p61EVpv2ur5zxbbufJolZDMoZ2hjSgSdqJYpfDJYOYxj4tMZ1llv1CuV8IL2VHAwWFWWcKYXNfw8dFDcn3T3HDw4t5Bcg3D0YgtBoCDGw5Pe5nOcRQydMFLCnUPCWTvr94CBykmKJc/na5sRvlnlZVs7292eTEasxSm3ptkMJA6E3KqnU+OD46PB8IUg9nhIHPudjEZBimwNE0VY3uvWQonrdgC7wk7RWHRsl9OhsOz0eh2fPH72btVh2Gs2N54bjBh60Vb2ubsWZ3CA85TSFgKMyErTKF5Bg3vIF7O/VSrHshuoYNZlEZbv2htl6pULc4P9rJbDjN0h/Zl38gFj05TFDla97JeYyQm37KSAvuViYyUfOv1A6qm9SbkL7ehTdVuqowtlN9ZZL1Pxju7u30e3oiZGAVR9bhYWVyWXStHdHQUiEdReHaHPpsGAr4Dfh1RlOinOqf0SVPr1CQLM7auGoL8YSGcOvIzDvR84EuXvm4iSZvaidYLVic6nyfszeji3X7s7uJuvlOzB5z3KGbNLlkT0y9SFdnJhRcdM2u8t0Za4r7U9ztkuvsCqEPXZpdF4ZEJRg27IAw4RJIggXBqczCCLgWwlV6qWxgusa8rS2XdWh1Y3/4tvWY5zlBqU6Ly7ZgKqomBamO115mWTTIY1BSqSWpqlmYj2rByXpeLEBxmwhY0zV07WUMYes7xToSLRUgTOKCqShpb7U/6ClNrNf7r8fiSdXEaDpTNarwO70Zyozh/6R1dWpi27PySghCW1SBbqWr9g3XTUCUXM3hEp0cEGSZxDZOg0lfaloLivflrTDUKZpC0b6E7QQLohpPzrcU7i276vUEoitPqavkX4uybb9ocCnWnIyMrBFQGrcP+LbO3RPKLdrPDyKrzpQinaxv/S1Jf2aU7aD0++YGRolAULUixbrvgGoQpaMtD4NDvBOBAoomquIa6ngiH761sGlr+VKGl8/JmKcxwanKIoyc0zwPOw41iOUSCjmVFOW1cHahLosdJlmGYoF+2vel1NU0+4DBp/+OVOicfKx7p0i0eIQHgoAMnQVdhLc7xKt4rYkwqON3jesR1wmgfCFX7Sqh5L8O6jhZxhlI3RyjhyIHmpmmafwBu2wEd
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create a CSS template"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/css_template/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create a CSS template
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./create-a-css-template.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./create-a-css-template.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body","body":{"content":{"application/json":{"examples":{"numerical_range_filter":{"description":"**This body should be stringified and put into the value field.**","summary":"Numerical Range Filter","value":{"extraFormData":{"filters":[{"col":"tz_offset","op":">=","val":[1000]},{"col":"tz_offset","op":"<=","val":[2000]}]},"filterState":{"label":"1000 <= x <= 2000","value":[1000,2000]},"id":"NATIVE_FILTER_ID"}},"time_grain_filter":{"description":"**This body should be stringified and put into the value field.**","summary":"Time Grain Filter","value":{"extraFormData":{"time_grain_sqla":"P1W/1970-01-03T00:00:00Z"},"filterState":{"label":"Week ending Saturday","value":["P1W/1970-01-03T00:00:00Z"]},"id":"NATIVE_FILTER_ID"}},"time_range_filter":{"description":"**This body should be stringified and put into the value field.**","summary":"Time Range Filter","value":{"extraFormData":{"time_range":"DATEADD(DATETIME('2025-01-16T00:00:00'), -7, day) : 2025-01-16T00:00:00"},"filterState":{"value":"DATEADD(DATETIME('2025-01-16T00:00:00'), -7, day) : 2025-01-16T00:00:00"},"id":"NATIVE_FILTER_ID"}},"timecolumn_filter":{"description":"**This body should be stringified and put into the value field.**","summary":"Time Column Filter","value":{"extraFormData":{"granularity_sqla":"order_date"},"filterState":{"value":["order_date"]},"id":"NATIVE_FILTER_ID"}},"value_filter":{"description":"**This body should be stringified and put into the value field.**","summary":"Value Filter","value":{"extraFormData":{"filters":[{"col":"real_name","op":"IN","val":["John Doe"]}]},"filterState":{"value":["John Doe"]},"id":"NATIVE_FILTER_ID"}}},"schema":{"properties":{"value":{"description":"Any type of JSON supported text.","type":"string"}},"required":["value"],"type":"object","title":"TemporaryCachePostSchema"},"example":{"value":"string"}}},"required":true}}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the value.","type":"string"}},"type":"object"},"example":{"key":"string"}}},"description":"The value was stored successfully."},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: create-a-dashboards-filter-state
|
||||
title: "Create a dashboard's filter state"
|
||||
description: "Create a dashboard's filter state"
|
||||
sidebar_label: "Create a dashboard's filter state"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFWAtv20YS/iuDRQHbOdqS3PaaY+sCiu20zuUSw1KSw1mGuiJHImNyl9ldymYJ/vfD7JIU9QqMpEgBw6KW8/q+nZ0ZbckyrniKBpVm/m3JYsF8lnETMY8JniJ9u2ceU/gpjxWGzDcqR4/pIMKUM79kpshIKhYGF6hYVXm1lU85qmJlxvDZNA7ZZ1XvnCPU5oUMCxIJpDAoDD3yLEvigJtYit5HLQWt4SNPswQ1PYs8RRUHPJkqLhY4nceJQUVvQtSBijPSZD579mwcxRpmMixARzJPQpghaKNisYjnMYbARQhZbiAWRoKJEJY8yRHmMSbhybNnhCFPU64K5rM3jVe4Ia/w0nn1mNVxMRrFX0qVXnBjYbvAHN+BTIibP6dyPtdomMdkxnz265mzwPzbQb/fvyNS94j+shI9taJ3lVe7GBlubAgJnyEpky345Qwe6R9Jr+K0fjxnwWNxSNCG46v3l9OXV6/HlzfTqwvaW2biFKcLxWPxjQgexynCb+TwKdx2wtOfEs58dj340Bv866f+cX9w3P9+3O/79u9/bD9NHxDvAUUYiwWMuMlVyIsOU/tNPoG6b5mblronp+UqPOazi+H4cnhxcUif46v/XB4enPZPfyTAg3+2gA+OPDj+yYOQF0fgww6JHSTXAfyVHj5PeSCTPP2m2XpuPT6F84XiIk+4ik3R5KtUIappSGztJe+2K/X5pLMa3wj8e/vqiyqgQp5Mbaeoy9rVm7assVcyEnAhCeqO4tZy0hHbz0jVbUCZkhkqE7sG0sa7ztFQFECdCuQcXo3evgGdZ5lUBkMw+GhOmNc0MsebpX3VL29ru3etmJx9xIDqt4lNQgtjTDOpuCrOeRDhtdRm5EKsvKbDdU9O66ba7Mt2QWdSaIfotD94QhPdx8c9FttsjCOEeyzASFBoVIxLXKXFbi7WYa9jsj7WEG27cxn3wDVoIxWGoPMgQK3neZIUJ2Twh37/K3CmqDVfYGcieWLwrSJ7wUOoJxcfrsSSJ3EIq9EKMiWXcYjhLogdXYfla/bsL8DyTvDcRFLFf2LowzA3EQpT+4c233YA6SpaJKenfzeSTEnKFD5LEAiFKXx4T5vj0KBSUu2Ccm5LoZAGagu1Nrn68e9OtithUAmegEa1ROVQ+DAUkAt8zDCg0mQXQQZBrvZs10tueNJS4DGNQU6NyFbljw+G+bd3NJEbvqBKzS64jmaSq7Cu8OAq8J3HHo8DGeKoGcVvaZISC+az4N3Na+a1c1X9VctcBQQkyFUCx/+F67ejMUxYZEzm93qJDHgSSW385/3nz3s8i3vLQS9svPcGPdcAppr8TxhMJhMBcPw7TNiwTkC7Fz68QK5QwXfD8/PL0Wg6fvvvyzfrCuduF4/HRYY+bG7kSjaEg3JC1WrCfJi4Ujxh1QGjybxGe12YSIoO3nahRRxToTfNcdcTMRFNwYazdvkkk9ockl/4clo8px8hD1Hps3KDHIejJmjC4B/AbVGdGnmPoqq1iYSzXcAn4mgiMhULc9gAOCHhw6OjLiWv+JKPbM51aFlbXCWDFJqYadngDzw2MEcTRJaLr2OidIBSNJEMCQkl3SZLfiMGm7lE6P9o0ql0VI0tU394K5VuNjm+tjPKSTcE0+Tl27HipJm6isOSOmyHbaiOSJpI/3kiHFEhN7wlaWMLaiGZ4EkiF4ckevQzo7O8UeUUcoPAoeXuQIPjDix3zGOOMLoGkJr2y94N+Gyb9TK7r9aIp821BcqVhFzR3u/cQrYZ2Gt6DSEuMZFZisLUpc6mljNUZkoaGcik8nu9kkxVfkmHq9qydp5rI9PGBE2VKqaOoOvqbM24SWfO88TUYTKPochTKn31V/rQbIvG38fja2jtVB6jaNbttXi3ghu5Gk7vaPwFqeDqmowQlnUjO6mq9a10ZW9QmjpuZ0gH0lbzks1s/tIgzsneqw/j5jqGDqB7u5rgLOjKI+WpwrlCHX2pEbKipbhZ3e1c7h9rPRaLudyePEd5hspdfDSDc2eJ8szJLQeOPm1SbltxfQH1lGxf89h2aBrze1nCY0GWbf6V9UG4ZTyLyf2AtBvDzGO+vTZbOw93TWbcsrKccY3vVFJVtOyuyuiUhLEdVkLmz3mi0asH5PbyrCHLnuYmkXdrbmBp5xV2eFMPcUew2qh1jPUiF0XXZxNNds/sDzFXNa1396Jb/zqKW/MRHWOnMQwCtH1gv+xdpwhR0WYem9W3g6kMSUfxB7qi5A8uSGkx28S3a64b5W54cjYpI2lY7Wxym7n1A6HaSUNZOglX/quWFds4iZiq+j+r0jQT
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create a dashboard's filter state"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/dashboard/{pk}/filter_state"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create a dashboard's filter state
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./create-a-dashboards-filter-state.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./create-a-dashboards-filter-state.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./create-a-dashboards-filter-state.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_id` and `datasource_type`.","type":"integer"},"datasource_name":{"description":"The datasource name.","nullable":true,"type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":1,"type":"string"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"type":"string"}},"required":["datasource_id","datasource_type","slice_name"],"type":"object","title":"ChartRestApi.post"},"example":{"cache_timeout":1,"certification_details":"string","certified_by":"string","dashboards":[1],"datasource_id":1,"datasource_name":"string","datasource_type":"table","description":"string","external_url":"string","is_managed_externally":true,"owners":[1],"params":"string","query_context":"string","query_context_generation":true,"slice_name":"string","viz_type":["bar","area","table"]}}},"description":"Chart schema","required":true}}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_id` and `datasource_type`.","type":"integer"},"datasource_name":{"description":"The datasource name.","nullable":true,"type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["table","dataset","query","saved_query","view"],"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":1,"type":"string"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"type":"string"}},"required":["datasource_id","datasource_type","slice_name"],"type":"object","title":"ChartRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"cache_timeout":1,"certification_details":"string","certified_by":"string","dashboards":[],"datasource_id":1,"datasource_name":"string","datasource_type":"table","description":"string","external_url":"string","is_managed_externally":true,"owners":[],"params":"string","query_context":"string","query_context_generation":true,"slice_name":"string","viz_type":["bar","area","table"]}}}},"description":"Chart added"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: create-a-new-chart
|
||||
title: "Create a new chart"
|
||||
description: "Create a new chart"
|
||||
sidebar_label: "Create a new chart"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztWm1v2zgS/isD4oAmODV2erdAoUU/pLkW272iDZr0XhAXDi2OLbYUqSUpO6qh/34YUrLkl+Ry1120H/KpFjUznBnOPPNQzZpZ/K1C518aUbN0zTKjPWpPP3lZKplxL40efXZG05rLciw4/SqtKdF6iS6o8SzHqZcFmiooC3SZlSUps5T9rbLBDhxJDQ4zo4U7BjMHnyOQrtQLaLVhbiz4XDrIcm79CbwzHuOCwDmvlHfgTdAU3HNnKpvhyPOZwo0JOYdKC5xLjeKEJUxXSpEAS72tMGG+LpGlTGqPC7SsSVhGsczbcKcCPZfKHQgkvti4PtS6ex/nrdSLwTYoprN63/oFWmc0GAsLa6oSfM495NzBRm2QmIdsJ7jLZ4ZbEUKRHosDMZ2Bks5TSL04ZVjqTFWiTb3GVdwWvKGM7mewXeHW8jru3R3OVIr9Xa9yBCm6RAZh9KNeaXfblVQKKocncAaZKUqFflgAIAXq/ixAIwoHN1tO3ADXYmuNfL45HM5ASvMCDwcw2J+E7im14ZlsbX/YML2JJ7KXly5QFGD0boTkAeqqYOk1Cy3B2g2R6uW3Cm3NEub4EsW0e1pKXLFPhzwdurVfNYPnTT+EoyJoMO5h2cBbj1ZzNa2sok3+q4J004JrvkAx7XRVfY/mzBiFXJOqWWm093XCexIAbpEKzTqQwgFXyqyo8QwIDEVnLMWpF7iFUm/moHDuAYvS11CbKlbsDMFo7PITPdjK1sOaqeSWH/L4gtbRk1Fye4EaLfcoQNSaFzKj5MAqRw2ZktmXALM5AhUAxWGWaFdWeoRZ5b3RIHV4j7elMhaBSuMErijMXy/fvwMz+4xZROjSrNC2eVrlBgpew4prwgfgyqMFV2JGDQnlxskHlUSoy2kYRLcHZgm1RxCBVgQslhYdahoM7UuJLqIn4QC5ZKsQnLECLT13mdqgT/ixlK7iSn4NGJIEuJAaVmRobmzBfS/uclMpQedr0Vf2/kFzR3DT1ouDDbYfZy89DHmVo88pqE6+sy5dOJ5BURgL2nhwJuZGehAGXVirSkHZCAqFEQFfnOf+vi4etJZT8l6gpDd7ZV/w27eoFz5n6bOfxgkrpO6eTw+kbim/PgAxIwRtHSRFFU4HbzkNDgLHGbcsYdwip/4LwX2616PxnkdNEsiTtCjI4va828f5rST1cBtbipyQnlxj5xTAB3T+rJQnpXE+wmTr+R7VOr2Tu3SO7rKOfn1ID65PP+3N7NMDY3CovTPI+omzdTobhW2s79fvgPRYax1oB/86GOx1d8DijhdbjRbtDiu21+pr7HCJNM3uXIznBS0xHpYE7RNqxJVGu8iTn41Pv4FlRx7VJltXxSwOC4uuUv6RlD+S8kdS/kjKH0n5Iyl/JOWPpPyRlP+xpLzZld6m6S1/7rnZH8Xbf3Da/oOw9jtoOxcCBZ3cX8fjbyDmBTrHFzhg54N6vK9KNorsJRfQfotP4Y1eciXFAKRpfi9lcHY/loFujOVbLhm/QywfNa98bqz8iiKFs8rnxI6yDiXb9jwQyFAxRvKX7xvJa2NnUgjUKfzbVCCMfkLkf4lQoi2kcxQRDdcsQ+ci97AY2+tQgBt7Ibpnz773OZXWkOPhnkZn5OsU/kGlF88KrTX2UBznYc7SjGottNq01U/fu5Xe6IhG4NAu0cYoUjjTUGm8LTGjsRsWwWRZZe8oxtfcc7VJQcIcZpWlGNPrNfu88gRuDc0MviCgi4jiaIrcPs2MwMvgmgviiusFS1n28cNbljDFZ6j6x7ZcUpZVVsHTf8HF+8srmLDc+zIdjZTJuMqN8+nz8fPnI17K0fJ0FEbqaMJgMplogKe/wISdtc0TMp3CS+QWLfzp7Pz81eXl9Or931+921Y4j2f09KouMYXdY+plBTxZT9gXrCcshQlbclXhhDVPWJNsYruofR7u2110m4VNfLIojfUdVLmJnuju6wi82CyH+XpE+8JDk5BE6Ry5QOterHdSEb1u0zFh8Oe2X6fefEHdtNoU8otDYU708USXVmp/1Ll7QsJHx8fDBPzKl/wy1M8gCVuL/UEb7SgPm9j5iksPc/RZHiL/X+JeR/cL9LkR5DeVz25O0k4MduuEYr3pSmUdE3MV8nKT9CrDSonZ2a+WKN2lc2ZEnYYbyknsYDmvj9bwBetBbqE5JmlK8c8THdMSmHyXkp2Et0JG4YkyiyMSPf6ZURfu4JNFYs68/1ZB1DZkiKUsEDjiJcQh2XZS6ZgCbMTGjZzn4GHsMaa39BoELlGZskDtWwAKRRINrUtrvMmMatLRaE2mmnRNTdHsWTuvnDdFZyJhS24l4bRrMTOYibQ7fIBr3Rx8a2gf6Z8AS9v2f7m6uoCNnSZh5M22vU28e85dRmSld/EWYeHNRbgTG7tj5GCqWv0g3TR0fh26XtJciEEGjF2zWajN1+GqRx31zys6oyBG953wtr+vh6CbhJSnFucWXf7/GiErzugP/V9IvLrzM/z496Lz430+P/6R+Pz4hyD0CZN6bvYvnZdViTZ+V+uuboMl6uootzyNxep8wQMdaT04iBs7n9y6LOOtH5WKy8Dl2i9lEVKuGS8l7XdKp95aoQ6MLXbN1usZd/jRqqah5fjRL9yVui4P5CJhEb0DEn3BOhCvHocDKKgqfJPaZVgEOVHjLMswTJ+7ZT8NsJGGB0vYrP17oMII0rF8Rf+3wVcsZSxhJiQjNGlYizOwivQr2qTuITI/yNimy9ofFFX3TU3XAw/X6ygRxxBBYwwljGvW0H3uP6w77KY=
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create a new chart"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/chart/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create a new chart
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./create-a-new-chart.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./create-a-new-chart.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","nullable":true,"type":"string"},"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this dashboard. If left empty you will be one of the owners of the dashboard.","type":"integer"},"type":"array"},"position_json":{"description":"This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view","type":"string"},"published":{"description":"Determines whether or not this dashboard is visible in the list of all dashboards.","type":"boolean"},"roles":{"items":{"description":"Roles is a list which defines access to the dashboard. These roles are always applied in addition to restrictions on dataset level access. If no roles defined then the dashboard is available to all roles.","type":"integer"},"type":"array"},"slug":{"description":"Unique identifying part for the web address of the dashboard.","maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"type":"object","title":"DashboardRestApi.post"},"example":{"certification_details":"string","certified_by":"string","css":"string","dashboard_title":"string","external_url":"string","is_managed_externally":true,"json_metadata":"string","owners":[1],"position_json":"string","published":true,"roles":[1],"slug":"string"}}},"description":"Dashboard schema","required":true}}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","nullable":true,"type":"string"},"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this dashboard. If left empty you will be one of the owners of the dashboard.","type":"integer"},"type":"array"},"position_json":{"description":"This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view","type":"string"},"published":{"description":"Determines whether or not this dashboard is visible in the list of all dashboards.","type":"boolean"},"roles":{"items":{"description":"Roles is a list which defines access to the dashboard. These roles are always applied in addition to restrictions on dataset level access. If no roles defined then the dashboard is available to all roles.","type":"integer"},"type":"array"},"slug":{"description":"Unique identifying part for the web address of the dashboard.","maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"type":"object","title":"DashboardRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"certification_details":"string","certified_by":"string","css":"string","dashboard_title":"string","external_url":"string","is_managed_externally":true,"json_metadata":"string","owners":[],"position_json":"string","published":true,"roles":[],"slug":"string"}}}},"description":"Dashboard added"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: create-a-new-dashboard
|
||||
title: "Create a new dashboard"
|
||||
description: "Create a new dashboard"
|
||||
sidebar_label: "Create a new dashboard"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztWW1vGzcS/isD4nC1cYolFw0QbJEPjpuizgWJESm4ApGhUsuRljaX3JBcyVth//thyN3V6sVumhQo7uAvtpY7L5xnXvhQ2jCLn0t0/pURFUs2LDXao/b0kReFkin30ujhrTOa1lyaYc7pU2FNgdZLdEGNPi4a6ZlAz6UKLwS61MqCllnCfoovwCzAZwg7WmzAdKkUnytkibclDpivCmQJc95KvWT1oHWDYjavDq1fo3VGg7GwtKYswGfcQ8YddGrgM+lAcJfNDbfii1y6I3G8X6G1UiBcjsewMDZE05k9Y0fsdG9nXnryt2/zAsKL4+Zyfv8W9dJnLHk+Gg1YLnX7PPqCIPDeo9VczUqryPMfKkg3y7nmSxSzVldVj2jOjVHINalSqcxy9Fxwzw/DnFAG3ozfvwMzv8XUg3SwRI2WexQgKs1zmZI3WGeoIVUyvZN6GSBxfIWUXrNCu7bSI8xL740GqXchg5XE9RlcBet4XxiHAjK0EV2LC7SoUwSuRVgpzBotlA6tg3VmIOcVrLn24A1w5dECuAJTqlUouOU5erTuaJ7NWqMNJSM95sdqhwSAW2z8SeGAK2XWVJ4GBCr0Ico043qJeyV7BlcLULjwgHnhK6hMCWupFMwRjMa2s+Iu2qdjlSm1xyVa2nKzwq3lFT0XxsnQx23XH8ngbei0mMH4eo4uOGu1KWmN/7UUS/TuIE1thvpZ39ZCyD8Xt6XzbQG0hpz8PSavdeZgXkHpSE5YvoR/grCmOF4Xx7JWlHMlXYbi6MxCm0uNVBroM7SUHG38XmYokJV0cq6w9auk84QBV2or1y+bXttYo/CxsvlA78kHj2bXmUwzELgIO+Npis5R/ewBPMnQIQTjoea4WvPKQZjtKGijXIgAISlbJEjSiKjRQC3s0IPCFarGSahAbRqbcQM0WHEfa9rrisswLmIjqaj0ZVXoVLk8hOGjlp9LBClQe7moKOEFt76bmmucU0SW0DhW/b1B+v3z5zuD9PwPB+l2l7HyKY44zNlPrZMP6PxFIc8K43wcvTwv4rx/4JBsze8fb711tyN2cJRsX+0O+u36A/M8Rrk3sbda7Sz7dH5zMBW2Ur3eifaaUg5aMYtbBOkk3G2vrl4abjEIlETa1h71BrrCaBf74/vR+TcQFRk6vMmiLvN5LD6LrlT+idc88ZonXvPEa554zROveeI1j/GaA41dpkOn7Hn/VP3fpT5fxXyOEZ9HmA8XAgVB+MNo9A3cJkfn+BJ7BOfBBO+mq1Nkr7iA5huhBK70iispeicDFNasZNjsYTw93RjLt/C0vyCWj5qXPjNW/o4igYuSWtk3/qHjmEcC6SvGSH74eyN5Z2gQlFokNPdakJHgdqa0KYIw6MLsxnsZ+vMgqM4GeXn+d9fZlY6dCA7tCi2gtcYmcKGh1HhfYErRhUUwaVraBzL1M/dcRbng3GFaWukrlnzasNu1p1asbwbM8yW15bblHLsZsPtnqRE4DttzQUVxTU2bfvzwlg2Y4nNU28cINT2XVsGzX+H6/XgCU5Z5XyTDoTIpV5lxPnkxevFiyAs5XJ0Pu4E1nDKYTqca4NkvMGUXTYUFxBN4hdyihX9cXF6+Ho9nk/f/fv1uV+Ey5urZpCowgf10bWUFfLeZsjuspiyBKVtxVeKU1d+xetDFd135LFxM2gi7hS5GmRfG+rbU3FRPdXsLg5fdcjgNTsgv/BkgBlEjQy7QupebPTjizhtIpgz+1ZzQM2/uUNeNNoX98lioU3061YWV2p+0Wz4j4ZPT0z4Ib/iKj0Mt9YDYWdwm3GhHWHTx8zWXHhbo0yxE/2dj38QQcvSZEbR3KqV9XJJWDPbrheL9rS2ZTQRnErD5bbBV6VdMROiwaqJ0C+nciCoJl5iz2NFyUZ1s4A6rHr5Qn5I0wfzjVEdo6PTsYNkDvREyCs+UWZ6Q6OmPjLpyt5cvLXKPwEHjeucqG1FiCQvUY8AKTqyGHYJLKQvjJDZz5AFHE8P2nb+l1yCIDpoiR+2bwRQKJhraFNZ4kxpVJ8PhhkzVyYaapD6wdlk6b/LWxICtuJVEv1wzS4OZyAEXPDCksE0iMbrMaVA1j/QvjKpd+79MJtfQ2akHjHaza6+L92Bz4zhx6Z3mebiRXV3H65HdM3IUqkY/SNc15bGdumM6L2KQYfZu2DzU6M/G5pzsvfnPhHIUxOiWEN5uSXMImm7aaz+zuLDosq810tzXP2x/3Hr9//A93Oir2OjokI4OmNQLc3gNGZcFWof9G0BviVoryq3Omwu1z3ngClRKjzXxjpuON3i898NCcRmuis2XOLG/PzFeSPJ53keaDRi1Q6z3T2yzmXOHH62qa1r+XKKtIv1uWy4wgAGLIzWMhTuknPaHY+hQVYZb2j4Nov6PGhdpiuFYeFj2pjesaKKzAZs3v6vmRpCO5XRNp78Jo8QGQELHhLV4OJWRI0WbVMpER3uodSXffKCo2lumrno73GyiRDwbaE7FUMI5yuqbuq7/CzGng9w=
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create a new dashboard"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/dashboard/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create a new dashboard
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./create-a-new-dashboard.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./create-a-new-dashboard.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"string"}}]}
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body","body":{"content":{"application/json":{"examples":{"numerical_range_filter":{"summary":"Numerical Range Filter","value":{"dataMask":{"extraFormData":{"filters":[{"col":"tz_offset","op":">=","val":[1000]},{"col":"tz_offset","op":"<=","val":[2000]}]},"filterState":{"label":"1000 <= x <= 200","value":[1000,2000]},"id":"NATIVE_FILTER_ID"}}},"time_grain_filter":{"summary":"Time Grain Filter","value":{"dataMask":{"extraFormData":{"time_grain_sqla":"P1W/1970-01-03T00:00:00Z"},"filterState":{"label":"Week ending Saturday","value":["P1W/1970-01-03T00:00:00Z"]},"id":"NATIVE_FILTER_ID"}}},"time_range_filter":{"summary":"Time Range Filter","value":{"dataMask":{"extraFormData":{"time_range":"DATEADD(DATETIME(\"2025-01-16T00:00:00\"), -7, day) : 2025-01-16T00:00:00"},"filterState":{"value":"DATEADD(DATETIME(\"2025-01-16T00:00:00\"), -7, day) : 2025-01-16T00:00:00"},"id":"NATIVE_FILTER_ID"}}},"timecolumn_filter":{"summary":"Time Column Filter","value":{"dataMask":{"extraFormData":{"granularity_sqla":"order_date"},"filterState":{"value":["order_date"]},"id":"NATIVE_FILTER_ID"}}},"value_filter":{"summary":"Value Filter","value":{"dataMask":{"extraFormData":{"filters":[{"col":"real_name","op":"IN","val":["John Doe"]}]},"filterState":{"value":["John Doe"]},"id":"NATIVE_FILTER_ID"}}}},"schema":{"properties":{"activeTabs":{"description":"Current active dashboard tabs","items":{"type":"string"},"nullable":true,"type":"array"},"anchor":{"description":"Optional anchor link added to url hash","nullable":true,"type":"string"},"dataMask":{"description":"Data mask used for native filter state","nullable":true,"type":"object"},"urlParams":{"description":"URL Parameters","items":{"description":"URL Parameter key-value pair","nullable":true},"nullable":true,"type":"array"}},"type":"object","title":"DashboardPermalinkStateSchema"},"example":{"activeTabs":["string"],"anchor":"string","dataMask":{},"urlParams":[{}]}}},"required":true}}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the permanent link data.","type":"string"},"url":{"description":"permanent link.","type":"string"}},"type":"object"},"example":{"key":"string","url":"string"}}},"description":"The permanent link was stored successfully."},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: create-a-new-dashboards-permanent-link
|
||||
title: "Create a new dashboard's permanent link"
|
||||
description: "Create a new dashboard's permanent link"
|
||||
sidebar_label: "Create a new dashboard's permanent link"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFWA1v2zgS/SvE4IAmOCW2c7e3Pe3mgDRJb9PLtkbstoezDS8tjWPVEqmSlBOvoP9+GFJftpW22xZYIIhtcmY473E4M2QOKVc8QYNKgz/JIRLgQ8rNCjwQPEH6tQYPFH7MIoUh+EZl6IEOVphw8HMw25SktFGRuIeimDlh1OaFDLckEUhhUBj6ytM0jgJuIil6H7QUNIaPPElj1PRdZAmqKODxXHFxj/NlFBtUNKOzJOFqCz68rmTYHcmwl07Ggw2PMyTZkBv+K9drZ90o/lKq5Iob668z6dAGMgYfzO9zuVxqNOCBTMGHf507a+BPBv1+f1Z4T4r+3IieWdFZ4ZVLjAw31p2YL5CUyRb7+Zw90r+zfr9x2S7jOQMeRCGhvBjfvLuev7y5HV/fzW+uoCgKD0yU4Pxe8Uh0UjOOEmT/puk/ykrLsP4Yc/BhOHjfG/zzx/5Jf3DS/9u43/ft3//gaYDvEdcMRRiJezbiJlMh37ZAPm3yS1A/HRAW9VfFQmMYfLi6GF9fXF0d0ef45tfroymc9c9+IGcH/6idncKxx05+9FjIt8fMZx0iHQyV7nzfNT7DWCDjLPlEnFza+T9K2b3iIou5isy2ihSpQlTzkKA+iXzSlvrMdluVTr/f0cy3H3iFPJ7b7Fae4pvX9SmGV3Il2JUkLzvOcg2nJfYJMEU7U6ZKpqhM5FIdD0y0wTFf2F8h6kBFKSVG8OEyUwqFYU6GhVyvFpKrkBkS9yAymOiO5OuByOKYL2Ks8nQpwJXiW5rnIlhJdbjiG/uFx8wJsDgSa8bDEENmJMtUzFZc26LQvUDjQXsvdtegDWEJ12uWaQzZUiomuAXoSGbasvzkGnLxAQNDa2QqHlLd6qDu7d0tGzY1rcXVJ+TYGrcndmtZyiN14MJniS32naQjaGJ75KvNG6JKOPFqg2nkwqLwqvq3HxOTitNZs2vV0A7Lu3xM8mJm4263YtsBnUqhXfSd9QdfUJqfit01bg8ZHa+QeKR4UWhUhBtkZoUsJdyCwtkGFXl+Ch2Bk6n40OiucofeAfO7jFpPG9rsGo0uhesBhj1/H7hm2kiFIdNZEKDWyyyOt6e00N/7/W9gMUGt+T12NVGfBlUrwgsesrLb8tmN2PA4ClnT0rFUyU0UYtiFtaXrsHxLRHwHLG8Fz8xKquh3DH12kZkVClOuz+po7gDSVrRIzs7+bCSpkhQplDAYoTBbn72jzXFoUCmpuqBcyiwOmZCGlRZKbVrqhz872G6EQUU1QqPaoHIofHYhWCbwMcXAYOgGmQwCKmGd2/WSGx7XFHigMcionbAF+sODAX8yo1uE4fc2DdYJlA3rk3kbiTUlxseTQIY4qi4QE+pFxT34ELy9uwWv7kzLn1pmKiAoAVW0k/+y4ZvRmE1hZUzq93qxDHi8ktr4z/vPn/d4GvU2g15dfXuDXlrl8Cmw6XQqGDv5hU3hoow/uxU+e4FcoWJ/ubi8vB6N5uM3/7l+vatw6TbxZLxN0Wf7+9jIhuxZPqUkNgWfTV33MYXiGdCVpIQ63JqVFC2w9UANN0pSqUx12vVUTEVVDdh5PXyaSm2OaF32lZx4TnmFPESlz/M9ZhyIkp0psL8ybhPq3Mg1iqLUJgbOu1BPxfFUpCoS5qjy/pSEj46P23y84hs+svHW4mRnsAkDKTTRUlPBH3hk2BJNsLJEfAMNuUOToFnJkGBQrO1T5FdibD+KCPpvVSDljqexpek3r1Fpx5Ej6zCWnHTF7kKGW5+9Gr15feoSQLTcHuVUuFtUs+KYpInxn6bCsUR1u2Zoj/9SSMZ4Gsv7IxI9/gnoEO+lN4XcIONM4EPT1T7TezUXPHC0UQMgNW2ZfZLw4ZD4PF0XDfe0uTY5uWTgyn3nFsK+b7c0zULcYCzThFxxlmxoOUN5qqSRgYwLv9fLyVTh53SyigNrl5k2MqlM0OVCRVQNdJmZrRnX7ix5FpvSTfAARZZQ2it/0oeGAyZ/GY+HrLZTeEDe7Nqr8R44N3L5m+boFsSkYjdDMkJYdo10UlXqW+nCvvhUOdx2tQ6kzeQ5LGwI032Mk71X78dQ3onoALrZpquzoAuPlOcKlwr16muNkBUtxV3zFnX9fRttuhHYy59YysPGdZSlqNxDUXUTaA1RhDq5zcARr03CbQEvX92+/KjsrFtXd4OPppfGPBKt3tqdognwNCInBhZfaRo88O1TX3OYZlVYTSDPF1zjWxUXBQ1/zJAu5JNZE9n2wIWR7XlC8Jc81njgXN28wNFd2dEds2bndp2urlii9YgE4JU9fboGe0F3mdSu7ibaObGleNAs0bl2GhdBgLYwPC07a6UkSuTgwaJ83kxkSDqKP9A7KX9wTkqL2Z4EO+bKU+Y6KWeTQpQ619au1aFcfiFUnTTkuZNwJaGoWbGVFOwV8P/8zmbG
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create a new dashboard's permanent link"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/dashboard/{pk}/permalink"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create a new dashboard's permanent link
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
{...require("./create-a-new-dashboards-permanent-link.ParamsDetails.json")}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./create-a-new-dashboards-permanent-link.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./create-a-new-dashboards-permanent-link.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: create-a-new-database
|
||||
title: "Create a new database"
|
||||
description: "Create a new database"
|
||||
sidebar_label: "Create a new database"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztW+tvG7kR/1cGbIFzUEWy09w10DkG/NAhvrp5ybkrEBl71O5Iy5hLbkiuZFXQ/14MuS89HDtJgftQfUq0JIczP857kiUz+LlA6850smD9JYu1cqgc/ZXnuRQxd0Kr3ierFX2zcYoZp7/lRudonEDr90qp51HsuP+VoI2NyOkk67NTWoPz94PT6wFcn55dDeB0CNovg1AwfHcFV3zMOswtcmR9NtZaIlds1anozh6k+9vl4PevJZtk8j6qhUVjwWkwhQKl1dPh4Gpwfg3WcYcZKmfh4MPbi9PrQQcuBlcD+jNw0oFut/vkcQxMhMSoyKXmyX2MOA1hA5wPfwM6AAl3HIRyGlwqrP855hYvJ2BRYuww6UAukVsEiw5cihCezYK/FhOYaAOxnVWkhYLBnTO8+wVeTaEibhcq3ub0TY6GO/Q3VdwQTb89NVrpwkKmE+xAhlwJNQWX8sDZ5wKNQAvcIOAdxoXDBLQCg5l2CHNtbukluAWd59piQoho5c/OcQwWzQwNCGdRTrpwTYhwa4sMbbhkoQtI+QyBwzlKNIuSJmFT5ER4jlLSnxwM2kI6C2Me36JKuvAeJ2jAI00SWcel9AYBiY6thzHThpYm2mR+ZTeGMY9TjJzIUBduG8GLwgSyB0KBxVirxD4BPfH30lmPWTgdHi/lxtmwo6UDXTitt+kJHIJQCZlwBUZFDkEhwYZ3uTBou/Ba+/cjUjjhHoRS6qnUYy5rqmIChUpwIhQmJKoqpORjiazvTIG16EI5nKLxoms1EdNSwChDl+pS2/1FrM/sZ8klaegiIhhZZwOd8x0UQFgy0qTShYnxjsurR3gN/7l8SZin6NLwlHiXS50g5NzwDB1pl/YLudEzkSBoJRfAocVVYQTJiqrIWP/jLn4XimciDj9vVh1WPUikeIY7bLuxE9rgmU5QOTFZhFeItVIYV/qU8bsrVFOXsv6zHw87LBOq+n1UQ26dEWpKiCdGzNBs3zp8d3Ua+IawxXsXi/c/Y0MT1VSoHZK0aIYtX0Pzjiw6Eiqyn2nrNvWB37Gu43TB8N3VfZ4V7xwaxWVUGO/dH8GFM3z76uP85Nfhm9cQNtKDOC687/IHYE2tAWWICt3jsTk5Ij+EcBzrBE8CKpHXNnvc899Ajz9h7GCKzkKhclLSpHLpCMccUoOTlyOWOpfbfq9H3qbbqF1Xm2kPVU+SZbterA32wj22m7pM/qW1NTbIHUZhecTAoHw5YkrrHBUaUNqQjzNoRuzkvmPHPX4CMZeyA/OUQpCrxcvQcXqZDQG/VzKDMjqKDoNo1R1bsoWw1v0XOn7BHX+8dNWJWjD/bs/a71YLtua6K/koypSetPKMFp0j9Wg8eIgPJR2YoIvTHR57mGNMdi8cBaFj64xW05MR283AiPVhOSrzsO2lnw4POzBijjR+5+rquFfe0IVL8uUWXaeUZC6kBKUdjBFQEYmQKXj/WijvjrgUbvGtYYZA/nsb5DIvicq8hPxnOylaR1tnGQeLpGiUJEhh/e1VbuNvPh/+FnKJKtNp8ien78f6AT4Iu48jlhdjKeIRI4RjO6sXb9YxrR3VRPKZNpBotB5WW+S5Nq7kmKIOV4vql7BtnscIPI7RWkrmPhXWgURKYghZLzhmuVsQns/beM7QWKFVhdtEoEwCeqUbswGAkIJVjnX8g4XyZJlB2VQXMiEufIydC5fCW4PWabg4s2B18852oRy/Ax+zjMHYEVM/tpnyYtloJowruIyCbvoobHAHp6Uvb7NaRW9tPI507SCch3Hh3Fq+XydxQYy58lr3U5uhRFjPQ/BbBmcC59/EiLfrkkCdyXorGqOvHOYpqmD4HnG6tXEIDc/df+xkzwgpI6ejBB0X8ls49CRInwIJOlVSbyy79kQvth4tygrpRBRzx6We1tZYG7uYrOf84aUpOaWwEVSsTPOgJBIgMYXyobTO/lUCPuLQRyJnkWJpLz9hOyL2RJsYfbEZNfXoevT+nW7x7BDFB2vPTrCE8runb4OB+CcLBhlCoq+W/O7y7i+mZ4ePSINElqOxWlG8pbpzW5rLSWl9HZJprW5qKT65van2uHt+63KKB1niwhhUTi5A6uk0pM50H8xTDRn5GF8n5WgyYckZVPWvSzEjK+qdXE7glaBaSiWQihl2Q/n1rBvCRTfRp97wyujRCcZQ0mhe2/qyTcTeyelCuQ7ZMbSA+DLDM8HXr8+Nvlt0/VrZl1jsrsOEjTKu+BSTqEoU5eILaWLraMbtLR1TsVnkLhD4usSRJ4kIMbSV368nkt5ZeRdc1TetwqR1qFVwekO2C+swsyDFLfon6jQaoxI4E9N3BZqFz9/iFBLt/Rdd7SulkJ0RflSO9HNu7VybpHLuiu6SchE4Gi+gyforI31Qy5tyy/eLaijetvtIq83S7+LsaXBuIm4XbL4EbuPWPHZIrenGoBxRjGZHxX2cn7zJy8c4P43OPry+uBpA2f3yxe+MS5GQKr66vn47hLJPZrvwxteHMy68wKSUdAUXqnGEVTL+WHDWa82d3K61Ir4yj362o0SoeH1aGGkfyJyHn2VdOOrY+qx5V++DsEhD08o6U8SuMEgNGAMf3l9WYLS85dHhs+cPVrPWppErlEJZNhrfTFj/42YDUuzooA2Hr+Dan4TLCzggjoucntQ+eVTnojIDorytz0bMyGPf4uKh9eiLhEo15Uli0NovbaHksbXe4rSy3B2nV5uW0WFOOBKbXZQqMBy+CjCx1c0mLkS8ELs4X3V871gYTKgpst7xuHn41vdo3Wkuurm2LtThPMslbnaTw+O0+8DtL76F2/6w1lJtL7T6l+HzRkvu6N5O1XY7p8KgabU0X6pGSevLVpsjMLDeqWjv93Gl+bAj32kWt7OHQP2eSBcW74tlDdk1d73pTJttm46rtdI221qLGu3ZdvWV86zzqka9Sk00aHOtbLD4Z4dH3zGwWFNpVWTjYEiheNjPN/bzjf18Yz/f2M839vON/XxjP9/Yzzf28439fGM/39jPN/bzjf18Yz/f2M839vON/XxjP9/Yzzf2841Hzje22FyfeBAHR+32834E8n8wArl/BsKTBBPSkeeHh98x5cjQWj59lNms62N9kJ3xpIoNfbhUPmq0Q1UZvJNdI53W2SDL90xs/geyfFC8cKk24j+Y9OG0cCn1JMP9UBv7DkHaB4Mkz/9cSV5r6pMXKun7mqYEGQluqwsTY1OV453wDmhLqJoG3fLjn61nlypYaDXxQGO06cOpgkLhXe7nPuEj6Nhnzjtf6hcqw8I+f7nFuDDCLXxI/TR3rP/xhqKA41NLbr2yOPLod0+pABx65qw/ILmasj6LP7y/Yh0m+ZhMufoZgKbfhZHw9N/w9s3wGkLK0u/1pI65TLV1/ReHL170eC56s6Ne5UZ7Iwaj0UgBPH0FI3ZaqpeHuw9nyA0a+Ovp+flgOIyu3/xz8Hr9wHl4qKfXixz7sPlWzd4EfliO2C0uqMczYjMuCxyx1Q9s1anFe7twqU8xKwHrD7WIIvOdnSpJHKmRqoax8LLJHSnWHdC98BU4dMKBFHmCxr5cbqARGC8RGTH4W9k5ipy+RbUqT5PUL3dJOlJPRio3QrmDiuMubT548qSNwa98xodej1o4rH1snlsrS1DU4vM5Fy60QbzwXyn6MkgQgi2xTnq0CUu/2gab2kLi/lEpzDJgc+2h+aPTHGnrSwBoW2fC7grRsU4WfaBSrxuMWUwWB0u4xUULXlg9od2E8s8jFZDxzZ8KlQ3My01aYlfq6QFtffKzT8s2RmK+FwEcFM7rsoOS6zIjYT6rohhNaTXbgpZV4TrYcUgvdr7K1jTuipYhwRlKndPQo/RIXlsCoWVutNOxlqt+r7ckUqv+kgxktT3bK6zTWUWiw2bcCMo+belEPZn1cSGx2ZrGlT99IcS2gKLiDWo6qw4jbtbp1fJuMTcMrpbW/JhOG7h865N7bTaI7ISqPO93r1b0ipW7HVKgCEJ6p7tkY6+hv/hSikzr92t6I7+N+hB+talyvdCrDh2ODE4M2vRbiRAVq9X75v+5Dv7cf2l0uE+mvzeZ9vXSYbuCbd3ULlx3fo52HdssU7dWgk0ctovRVgm7kdt3GLUNdpTsBaGL7Xqx9akcUrA+mx0FM7Qu4z7zKi+8zy+u3VInYQ7vXC+XXPgGXzkwDi7zI+O5oCuPWKOOrMPIwwQX8pEtl/Txg5GrFX2m9iblUTeNF/PZVIeFGOU9bUC9HW2805MF8bOVUpJLDSdO4xh9mL1/703L/VOIZB02Lv/XOv3jG9Znhs/pn43xOesz1mGh3e2dkP8Wgn0R8s1Ak7wDpfYt0GovUv6FpCqXuFq0OFwuw44QbMn1B1F8XsJWN6vV6r9CEHBu
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create a new database"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/database/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create a new database
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./create-a-new-database.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./create-a-new-database.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
@@ -0,0 +1 @@
|
||||
{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"always_filter_main_dttm":{"default":false,"type":"boolean"},"catalog":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"database":{"type":"integer"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"normalize_columns":{"default":false,"type":"boolean"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["database","table_name"],"type":"object","title":"DatasetRestApi.post"},"example":{"always_filter_main_dttm":true,"catalog":"string","database":1,"external_url":"string","is_managed_externally":true,"normalize_columns":true,"owners":[1],"schema":"string","sql":"string","table_name":"string"}}},"description":"Dataset schema","required":true}}
|
||||
@@ -0,0 +1 @@
|
||||
{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"always_filter_main_dttm":{"default":false,"type":"boolean"},"catalog":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"database":{"type":"integer"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"normalize_columns":{"default":false,"type":"boolean"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["database","table_name"],"type":"object","title":"DatasetRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"always_filter_main_dttm":true,"catalog":"string","database":1,"external_url":"string","is_managed_externally":true,"normalize_columns":true,"owners":[],"schema":"string","sql":"string","table_name":"string"}}}},"description":"Dataset added"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}}
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
id: create-a-new-dataset
|
||||
title: "Create a new dataset"
|
||||
description: "Create a new dataset"
|
||||
sidebar_label: "Create a new dataset"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztWG1v2zYQ/isEMaAJpsR2sAKFin5IshRtVzRB7W4DosClpbPNhiJVkrKjCvrvw5F6s+OkWVOg/dBPsci7I5/n7h6dUlINn3Mw9kQlBQ1LGitpQVr8ybJM8JhZruTgk1ES10y8hJThr0yrDLTlYJytWLPCTOdcWNDTlHE5TaxNcSuBOcuFpeGcCQMBtUUGNKQzpQQwSauAxswyoRZonLKbtyAXdknDo6fDgKZcNs/DgMpcCDYTQEOr8y6UsZrLBUZKmGUzZgBD1ZtcWliAxl24saAlE9NcC7T4ajhupimTbAHJtPEVxT2ePUxS6ZQJ/gWmsRJ5Ks3DqFBrCdrZcgup2Y2jXmFaswKfu6Q8kj7z+WG8WNydSpbCVw4d3XKuAldxXENCw8suYRtBr1o3NfsEscVdbvFC9E9mmQH7How9zvhhpoz1qWVpJuDeUvRg2mJrrtSvmtF2kXRGd9SCD7oj236jyefl6KrLUxfUEd499nntGMO6BhNrnmErdhyQOl6fUTzVUWwyJY3vzaPh6BGdzZNeEco8nfka1GBcJf8Sgl9C8PMIQbVtvykNWMujfu3+nFrxCKm4UytYkkCCdPwxHD5CDVIwhi36bdXL533Ut470hCWkHjpC8lqumOAJyZhmKVjQhmRarbi77G00PV+P5THK9h2wfJAst0ul+RdIQnKc2yVIW59P2vLeAaTv6JAcHf1oJJlWMT7OBBBEYYuQ/I3J8WhAa6V3QTlVuUiIVJbUEWpvPOrpjy6219K3HzGgV6A9ipAcS5JLuMkgtpD4RaLiONd3pOslCkFLQUANxLlGjOFlST+tLTZthWLFFtjATdcZFLCbg1glMHaXM85BMImaEn94/5YGVLAZiO7RqFzHePU414Ic/EsuzscTEtGltVk4GAgVM7FUxobPhs+eDVjGB6vRIPHnDSJKoiiShBy8IhE9rkvMsR2SE2AaNPnt+PT0bDyeTs7/Onu36XDq83QwKTIIyXaqOtuEPCkjeg1FREMS0RUTOUS0ekKroEV3Udilkj187UKLkKeZ0rZpaBPJSDaDC3nRLjtp38NzycNpCLz9ElgC2rwot8jw964JiSj5nbAYS3dq1TXIqvZG0C92AY3kfiQzzaXday58iMZ7+/t9Ct6wFRu7KurRsLHYJVtJg0y06NmacUvmYOOlw/7/kJceQAp2qRK8ORbRNithY0a2awXRfmzKpfTUTBwzH4POpV8tnp/bFeOtG0JnKilC8mZ8/u7QdzKfF3sluYaixy6p9tEaSX4eSU8MwmtJ2aK8NlICDoVa7KHp/nOK3bilUxqYBcKIhDWp+aIB9RzRkLoJIqAZw3mFbhOLyXIS4lvYv/B3poRuH/wWt0kCKxAqS0HaWoxcqfhAZaaVVbESVTgYlBiqCktsjupWtNPcWJU2IQK6YpqjZptaP12YjRnTXZMGFGSeojjVj/jHCdRm/FeTyQVp41QBxdtsxmvx3rrc2Kss7uFoQpQmry8wCGLZDLKTqtrfWVcV5rBR2jG+IzxIp7clnbn6fInTFMZ788+E1nOTG6XdLm3fEw50FaDzVMNcg1l+axCMYpR83/3j5OwBX5/1pH/vSDn8fiNlfVw7Uw6/eagMKJdz5ZO3kas8A+17qJnJe0vYKd5uNfIFYGzK3Ou+jn9HP24c0r74LdzYQSYYdx9H9Webb9VLyjKOJ45qLn0crGxfupe0LJHfD1pUFS5/zkEXfs5uuse9wAPqldF1+DUUbrjpNM41m8jdF9f2FIOt7D2O4xictt9te9VTHRRmGtBZ/e+3VCXoo9kaP+vZmoaUBlQ5OlzxuzX/hsn9iONjYlXiSNnjrK3e+geiar4YZdG7YVl6Cy/xKDkeinsZ0uqqqqr/AONx9uQ=
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: developer-docs/api/superset
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
show_extensions: true
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
import Translate from "@docusaurus/Translate";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create a new dataset"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/v1/dataset/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create a new dataset
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
>
|
||||
<Translate id="theme.openapi.request.title">Request</Translate>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
{...require("./create-a-new-dataset.RequestSchema.json")}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
{...require("./create-a-new-dataset.StatusCodes.json")}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user