@directus/app 9.11.1 → 9.12.2

package/dist/assets/flows.22228af1.js

@@ -0,0 +1,172 @@
+import{a as n,o as h,b as d,w as a,g as s,e as l,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var o={};const i={class:"markdown-body"},p=s("div",{class:"two-up"},[s("div",{class:"left"},[s("blockquote",null,[s("p",null,"Flows enable custom, event-driven data processing and task automation within Directus.")])]),s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-flow-object"},"The Flow Object")]),s("li",null,[s("a",{href:"#list-flows"},"List Flows")]),s("li",null,[s("a",{href:"#retrieve-a-flow"},"Retrieve a flow")]),s("li",null,[s("a",{href:"#create-a-flow"},"Create a Flow")]),s("li",null,[s("a",{href:"#create-multiple-flows"},"Create Multiple Flows")]),s("li",null,[s("a",{href:"#update-a-flow"},"Update a Flow")]),s("li",null,[s("a",{href:"#update-multiple-flows"},"Update Multiple Flows")]),s("li",null,[s("a",{href:"#delete-a-flow"},"Delete a Flow")]),s("li",null,[s("a",{href:"#delete-multiple-flows"},"Delete Multiple Flows")]),s("li",null,[s("a",{href:"#flow-with-get-webhook-trigger"},"Flow with GET webhook trigger")]),s("li",null,[s("a",{href:"#flow-with-post-webhook-trigger"},"Flow with POST webhook trigger")])])])])])],-1),u=s("hr",null,null,-1),f=s("h2",{id:"the-flow-object"},[e("The Flow Object "),s("a",{class:"header-anchor",href:"#the-flow-object"},"#")],-1),_={class:"two-up"},g={class:"left"},w={class:"definitions"},m=s("p",null,[s("code",{class:""},"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the flow.")],-1),j=s("p",null,[s("code",{class:""},"name"),e(),s("strong",null,"string"),s("br"),e(" Name for the flow.")],-1),y=s("p",null,[s("code",{class:""},"icon"),e(),s("strong",null,"string"),s("br"),e(" Icon displayed in the Admin App for the flow.")],-1),b=s("p",null,[s("code",{class:""},"color"),e(),s("strong",null,"string"),s("br"),e(" Color of the icon displayed in the Admin App for the flow.")],-1),q=s("p",null,[s("code",{class:""},"note"),e(),s("strong",null,"text"),s("br"),e(" Short description displayed in the Admin App.")],-1),x=s("p",null,[s("code",{class:""},"status"),e(),s("strong",null,"string"),s("br"),e(" Current status of the flow. One of "),s("code",{class:""},"active"),e(", "),s("code",{class:""},"inactive"),e(". Defaults to "),s("code",{class:""},"active"),e(" when not specified.")],-1),v=s("p",null,[s("code",{class:""},"trigger"),e(),s("strong",null,"string"),s("br"),e(" Type of trigger for the flow. One of "),s("code",{class:""},"hook"),e(", "),s("code",{class:""},"webhook"),e(", "),s("code",{class:""},"operation"),e(", "),s("code",{class:""},"schedule"),e(", "),s("code",{class:""},"manual"),e(".")],-1),E=s("p",null,[s("code",{class:""},"options"),e(),s("strong",null,"json"),s("br"),e(" Options of the selected trigger for the flow.")],-1),T=s("p",null,[s("code",{class:""},"accountability"),e(),s("strong",null,"string"),s("br"),e(" The permission used during the flow. One of "),s("code",{class:""},"$public"),e(", "),s("code",{class:""},"$trigger"),e(", "),s("code",{class:""},"$full"),e(", or UUID of a role.")],-1),k=s("p",null,[s("code",{class:""},"date_created"),e(),s("strong",null,"timestamp"),s("br"),e(" Timestamp in ISO8601 when the flow was created.")],-1),P=s("code",{class:""},"user_created",-1),S=e(),R=s("strong",null,"many-to-one",-1),F=s("br",null,null,-1),A=e(" The user who created the flow. Many-to-one to "),O=e("users"),D=e("."),I=s("p",null,[s("code",{class:""},"operation"),e(),s("strong",null,"string"),s("br"),e(" UUID of the operation connected to the trigger in the flow.")],-1),M=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
+	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-string"},'"2fab3b9d-0543-4b87-8a30-3c5ee66fedf1"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Flow"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"bolt"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"color"'),e(": "),s("span",{class:"hljs-string"},'"#112233"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"note"'),e(": "),s("span",{class:"hljs-string"},'"Note for my flow"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"manual"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"accountability"'),e(": "),s("span",{class:"hljs-string"},'"$trigger"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"date_created"'),e(": "),s("span",{class:"hljs-string"},'"2022-05-11T13:14:52Z"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"user_created"'),e(": "),s("span",{class:"hljs-string"},'"12e62fd0-29c7-4fd3-b3d3-c7a39933e8af"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"operation"'),e(": "),s("span",{class:"hljs-string"},'"92e82998-e421-412f-a513-13701e83e4ce"'),e(`
+}
+`)])])],-1),C=s("hr",null,null,-1),L=s("h2",{id:"list-flows"},[e("List Flows "),s("a",{class:"header-anchor",href:"#list-flows"},"#")],-1),G=s("p",null,"List all flows that exist in Directus.",-1),Q={class:"two-up"},U={class:"left"},B=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),H=e("Supports all "),N=e("global query parameters"),$=e("."),V=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),Z=e("An array of up to "),z=e("limit"),J=e(),K=s("a",{href:"#the-flow-object"},"flow objects",-1),W=e(". If no items are available, data will be an empty array."),X={class:"right"},Y=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),ss=s("pre",null,[s("code",{class:""},`GET /flows
+SEARCH /flows
+`)],-1),es=e("Learn more about SEARCH ->"),as=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),ts=s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)],-1),ls=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	flows: [directus_flows]
+}
+`)])],-1),ns=s("h5",{id:"example"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),os=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	flows {
+		id
+		name
+		status
+	}
+}
+`)])],-1),rs=s("hr",null,null,-1),cs=s("h2",{id:"retrieve-a-flow"},[e("Retrieve a flow "),s("a",{class:"header-anchor",href:"#retrieve-a-flow"},"#")],-1),hs=s("p",null,"List an existing flow by primary key.",-1),ds={class:"two-up"},is={class:"left"},ps=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),us=e("Supports all "),fs=e("global query parameters"),_s=e("."),gs=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ws=s("p",null,[e("Returns the requested "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),ms=s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",{class:""},`GET /flows/:id
+`)]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:""},`GET /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2
+`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	flows_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_flows
+}
+`)])]),s("h5",{id:"example-3"},[e("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	flows_by_id(id: `),s("span",{class:"hljs-string"},'"2fc325fb-299b-4d20-a9e7-a34349dee8b2"'),e(`) {
+		id
+		name
+		status
+	}
+}
+`)])])],-1),js=s("hr",null,null,-1),ys=s("h2",{id:"create-a-flow"},[e("Create a Flow "),s("a",{class:"header-anchor",href:"#create-a-flow"},"#")],-1),bs=s("p",null,"Create a new flow.",-1),qs={class:"two-up"},xs={class:"left"},vs=s("h3",{id:"query-parameters-3"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Es=e("Supports all "),Ts=e("global query parameters"),ks=e("."),Ps=s("h3",{id:"request-body"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ss=s("p",null,[e("A partial "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),Rs=s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Fs=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the created flow.")],-1),As=s("div",{class:"right"},[s("h3",{id:"rest-api-3"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",{class:""},`POST /flows
+`)]),s("h5",{id:"example-4"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Flow"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"manual"'),e(`
+}
+`)])]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	create_flows_item(data: create_directus_flows_input!): directus_flows
+}
+`)])]),s("h5",{id:"example-5"},[e("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	create_flows_item(data: { name: `),s("span",{class:"hljs-string"},'"My Flow"'),e(", status: "),s("span",{class:"hljs-string"},'"active"'),e(", trigger: "),s("span",{class:"hljs-string"},'"manual"'),e(` }) {
+		id
+		name
+		status
+	}
+}
+`)])])],-1),Os=s("hr",null,null,-1),Ds=s("h2",{id:"create-multiple-flows"},[e("Create Multiple Flows "),s("a",{class:"header-anchor",href:"#create-multiple-flows"},"#")],-1),Is=s("p",null,"Create multiple new flows.",-1),Ms={class:"two-up"},Cs={class:"left"},Ls=s("h3",{id:"query-parameters-4"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Gs=e("Supports all "),Qs=e("global query parameters"),Us=e("."),Bs=s("h3",{id:"request-body-2"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Hs=s("p",null,[e("An array of partial "),s("a",{href:"#the-flow-object"},"flow objects"),e(".")],-1),Ns=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),$s=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the created flow.")],-1),Vs=s("div",{class:"right"},[s("h3",{id:"rest-api-4"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",{class:""},`POST /flows
+`)]),s("h5",{id:"example-6"},[e("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows"),e(`
+
+[
+	{
+		`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Flow"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"manual"'),e(`
+	},
+	{
+		`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Another Flow"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"webhook"'),e(`
+	}
+]
+`)])]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	create_flows_items(data: [create_directus_flows_input!]!): [directus_flows]
+}
+`)])]),s("h5",{id:"example-7"},[e("Example "),s("a",{class:"header-anchor",href:"#example-7"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	create_flows_items(
+		data: [
+			{
+				`),s("span",{class:"hljs-string"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Flow"'),e(`,
+				`),s("span",{class:"hljs-string"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+				`),s("span",{class:"hljs-string"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"manual"'),e(`
+			},
+			{
+				`),s("span",{class:"hljs-string"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Another Flow"'),e(`,
+				`),s("span",{class:"hljs-string"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+				`),s("span",{class:"hljs-string"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"webhook"'),e(`
+			}
+		]
+	) {
+		id
+		name
+		status
+	}
+}
+`)])])],-1),Zs=s("hr",null,null,-1),zs=s("h2",{id:"update-a-flow"},[e("Update a Flow "),s("a",{class:"header-anchor",href:"#update-a-flow"},"#")],-1),Js=s("p",null,"Update an existing flow.",-1),Ks={class:"two-up"},Ws={class:"left"},Xs=s("h3",{id:"query-parameters-5"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Ys=e("Supports all "),se=e("global query parameters"),ee=e("."),ae=s("h3",{id:"request-body-3"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),te=s("p",null,[e("A partial "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),le=s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),ne=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the updated flow.")],-1),oe=s("div",{class:"right"},[s("h3",{id:"rest-api-5"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",{class:""},`PATCH /flows/:id
+`)]),s("h5",{id:"example-8"},[e("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Updated Flow"'),e(`
+}
+`)])]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	update_flows_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_flows_input): directus_flows
+}
+`)])]),s("h5",{id:"example-9"},[e("Example "),s("a",{class:"header-anchor",href:"#example-9"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	update_flows_item(id: `),s("span",{class:"hljs-string"},'"2fc325fb-299b-4d20-a9e7-a34349dee8b2"'),e(", data: { name: "),s("span",{class:"hljs-string"},'"My Updated Flow"'),e(` }) {
+		id
+		name
+	}
+}
+`)])])],-1),re=s("hr",null,null,-1),ce=s("h2",{id:"update-multiple-flows"},[e("Update Multiple Flows "),s("a",{class:"header-anchor",href:"#update-multiple-flows"},"#")],-1),he=s("p",null,"Update multiple existing flows.",-1),de={class:"two-up"},ie={class:"left"},pe=s("h3",{id:"query-parameters-6"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),ue=e("Supports all "),fe=e("global query parameters"),_e=e("."),ge=s("h3",{id:"request-body-4"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),we=s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the flows you\u2019d like to update.")]),s("p",null,[s("code",{class:""},"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-flow-object"},"the flow object"),e("\u2019s properties.")])],-1),me=s("h3",{id:"returns-6"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),je=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow objects"),e(" for the updated flows.")],-1),ye=s("div",{class:"right"},[s("h3",{id:"rest-api-6"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",{class:""},`PATCH /flows
+`)]),s("h5",{id:"example-10"},[e("Example "),s("a",{class:"header-anchor",href:"#example-10"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /flows"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"keys"'),e(": ["),s("span",{class:"hljs-string"},'"3f2facab-7f05-4ee8-a7a3-d8b9c634a1fc"'),e(", "),s("span",{class:"hljs-string"},'"7259bfa8-3786-45c6-8c08-cc688e7ba229"'),e(`],
+	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
+		`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"inactive"'),e(`
+	}
+}
+`)])]),s("h3",{id:"graphql-6"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	update_flows_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_flows_input): [directus_flows]
+}
+`)])]),s("h5",{id:"example-11"},[e("Example "),s("a",{class:"header-anchor",href:"#example-11"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	update_flows_items(
+		ids: [`),s("span",{class:"hljs-string"},'"3f2facab-7f05-4ee8-a7a3-d8b9c634a1fc"'),e(", "),s("span",{class:"hljs-string"},'"7259bfa8-3786-45c6-8c08-cc688e7ba229"'),e(`]
+		data: { status: `),s("span",{class:"hljs-string"},'"inactive"'),e(` }
+	) {
+		id
+		name
+		status
+	}
+}
+`)])])],-1),be=s("hr",null,null,-1),qe=s("h2",{id:"delete-a-flow"},[e("Delete a Flow "),s("a",{class:"header-anchor",href:"#delete-a-flow"},"#")],-1),xe=s("p",null,"Delete an existing flow.",-1),ve=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-7"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-7"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-7"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /flows/:id
+`)]),s("h5",{id:"example-12"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /flows/12204ee2-2c82-4d9a-b044-2f4842a11dba
+`)]),s("h3",{id:"graphql-7"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	delete_flows_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
+}
+`)])]),s("h5",{id:"example-13"},[e("Example "),s("a",{class:"header-anchor",href:"#example-13"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	delete_flows_item(id: `),s("span",{class:"hljs-string"},'"12204ee2-2c82-4d9a-b044-2f4842a11dba"'),e(`) {
+		id
+	}
+}
+`)])])])],-1),Ee=s("hr",null,null,-1),Te=s("h2",{id:"delete-multiple-flows"},[e("Delete Multiple Flows "),s("a",{class:"header-anchor",href:"#delete-multiple-flows"},"#")],-1),ke=s("p",null,"Delete multiple existing flows.",-1),Pe=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-5"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"An array of flows primary keys"),s("h3",{id:"returns-8"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-8"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-8"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /flows
+`)]),s("h5",{id:"example-14"},[e("Example "),s("a",{class:"header-anchor",href:"#example-14"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /flows"),e(`
+[`),s("span",{class:"hljs-string"},'"25821236-8c2a-4f89-8fdc-c7d01f35877d"'),e(", "),s("span",{class:"hljs-string"},'"02b9486e-4273-4fd5-b94b-e18fd923d1ed"'),e(", "),s("span",{class:"hljs-string"},'"7d62f1e9-a83f-407b-84f8-1c184f014501"'),e(`]
+`)])]),s("h3",{id:"graphql-8"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-8"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	delete_flows_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
+}
+`)])]),s("h5",{id:"example-15"},[e("Example "),s("a",{class:"header-anchor",href:"#example-15"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	delete_flows_items(
+		ids: [
+			`),s("span",{class:"hljs-string"},'"25821236-8c2a-4f89-8fdc-c7d01f35877d"'),e(`
+			`),s("span",{class:"hljs-string"},'"02b9486e-4273-4fd5-b94b-e18fd923d1ed"'),e(`
+			`),s("span",{class:"hljs-string"},'"7d62f1e9-a83f-407b-84f8-1c184f014501"'),e(`
+		]
+	) {
+		ids
+	}
+}
+`)])])])],-1),Se=s("h2",{id:"flow-with-get-webhook-trigger"},[e("Flow with GET webhook trigger "),s("a",{class:"header-anchor",href:"#flow-with-get-webhook-trigger"},"#")],-1),Re=s("p",null,"Start a flow with GET webhook trigger.",-1),Fe=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-9"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-9"},"#")]),s("p",null,"Result of the flow, if any.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-9"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-9"},"#")]),s("pre",null,[s("code",{class:""},`GET /flows/trigger/:flow_uuid
+`)]),s("h5",{id:"example-16"},[e("Example "),s("a",{class:"header-anchor",href:"#example-16"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// GET /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),e(`
+`),s("span",{class:"hljs-comment"},"// Payload here"),e(`
+`)])])])],-1),Ae=s("h2",{id:"flow-with-post-webhook-trigger"},[e("Flow with POST webhook trigger "),s("a",{class:"header-anchor",href:"#flow-with-post-webhook-trigger"},"#")],-1),Oe=s("p",null,"Start a flow with POST webhook trigger.",-1),De=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-6"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-6"},"#")]),s("p",null,"Payload for the POST request."),s("h3",{id:"returns-10"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-10"},"#")]),s("p",null,"Result of the flow, if any.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-10"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-10"},"#")]),s("pre",null,[s("code",{class:""},`POST /flows/trigger/:flow_uuid
+`)]),s("h5",{id:"example-17"},[e("Example "),s("a",{class:"header-anchor",href:"#example-17"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),e(`
+`),s("span",{class:"hljs-comment"},"// Payload here"),e(`
+`)])])])],-1),Ie={title:"Flows",modularExtension:!1,pageClass:"page-reference"},Me={name:"flows",setup(Ce,{expose:r}){return r({frontmatter:{title:"Flows",modularExtension:!1,pageClass:"page-reference"}}),(Le,Ge)=>{const t=n("router-link"),c=n("docswrapper");return h(),d(c,{frontmatter:Ie},{default:a(()=>[s("div",i,[p,u,f,s("div",_,[s("div",g,[s("div",w,[m,j,y,b,q,x,v,E,T,k,s("p",null,[P,S,R,F,A,l(t,{to:"/docs/reference/system/users/#the-users-object"},{default:a(()=>[O]),_:1}),D]),I])]),M]),C,L,G,s("div",Q,[s("div",U,[B,s("p",null,[H,l(t,{to:"/docs/reference/query"},{default:a(()=>[N]),_:1}),$]),V,s("p",null,[Z,l(t,{to:"/docs/reference/query/#limit"},{default:a(()=>[z]),_:1}),J,K,W])]),s("div",X,[Y,ss,s("p",null,[l(t,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[es]),_:1})]),as,ts,ls,ns,os])]),rs,cs,hs,s("div",ds,[s("div",is,[ps,s("p",null,[us,l(t,{to:"/docs/reference/query"},{default:a(()=>[fs]),_:1}),_s]),gs,ws]),ms]),js,ys,bs,s("div",qs,[s("div",xs,[vs,s("p",null,[Es,l(t,{to:"/docs/reference/query"},{default:a(()=>[Ts]),_:1}),ks]),Ps,Ss,Rs,Fs]),As]),Os,Ds,Is,s("div",Ms,[s("div",Cs,[Ls,s("p",null,[Gs,l(t,{to:"/docs/reference/query"},{default:a(()=>[Qs]),_:1}),Us]),Bs,Hs,Ns,$s]),Vs]),Zs,zs,Js,s("div",Ks,[s("div",Ws,[Xs,s("p",null,[Ys,l(t,{to:"/docs/reference/query"},{default:a(()=>[se]),_:1}),ee]),ae,te,le,ne]),oe]),re,ce,he,s("div",de,[s("div",ie,[pe,s("p",null,[ue,l(t,{to:"/docs/reference/query"},{default:a(()=>[fe]),_:1}),_e]),ge,we,me,je]),ye]),be,qe,xe,ve,Ee,Te,ke,Pe,Se,Re,Fe,Ae,Oe,De])]),_:1})}}};typeof o=="function"&&o(Me);export{Me as default,Ie as frontmatter};

package/dist/assets/flows.3ea1b90f.js

@@ -0,0 +1,15 @@
+import{a,o as c,b as d,w as o,g as e,e as n,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var l={};const h={class:"markdown-body"},_=e("blockquote",null,[e("p",null,"Flows enable custom, event-driven data processing and task automation within Directus. Each Flow is composed of one Trigger, followed by a series of Operations.")],-1),u=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#what's-a-flow%3F"},"What's a Flow?")]),e("li",null,[e("a",{href:"#create-a-flow"},"Create a Flow")]),e("li",null,[e("a",{href:"#the-flow-object"},"The Flow Object")]),e("li",null,[e("a",{href:"#logs"},"Logs")])])])],-1),p=t(" ::: Before You Begin [Learn Directus](/getting-started/learn-directus) ::: "),f=e("h2",{id:"what%E2%80%99s-a-flow%3F"},[t("What\u2019s a Flow? "),e("a",{class:"header-anchor",href:"#what%E2%80%99s-a-flow%3F"},"#")],-1),w=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/whats-a-flow-20220603A.webp",alt:"What's a Flow?"})],-1),g=t("Each Flow begins with one Trigger, which defines the actions that start the Flow. Triggers can be some event or action within the app, an incoming webhook, a cron job, or manual click of a button. Please see the documentation on "),m=t("Triggers"),b=t(" for more details."),O=t("Operations are the actions performed after the Trigger, which include things like creating new Items in a Collection, sending off emails, pushing "),y=e("em",null,"in-app",-1),F=t(" notifications, or sending webhooks, just to name a few options. You can even set up divergent chains of Flow Operations, which execute conditionally, based on whether one Operation passed or failed. To ensure data is passed on as expected, a "),v=t("console log"),j=t(" is also included to help design and troubleshoot your Flows. Please see the documentation on "),k=t("Operations"),T=t(" for more details."),x=e("p",null,[t("Once a Flow is triggered, a "),e("a",{href:"#the-flow-object"},"Flow JSON Object"),t(" is created which stores data from the Trigger event. Then as each Operation in the flow executes, the data generated is added onto this Flow Object. Every Operation in a Flow has access to this Flow Object.")],-1),A=e("h2",{id:"create-a-flow"},[t("Create a Flow "),e("a",{class:"header-anchor",href:"#create-a-flow"},"#")],-1),S=e("video",{title:"",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/create-a-flow-20220603A.mp4",type:"video/mp4"})],-1),P=e("p",null,"To create a Flow, follow these steps:",-1),C=e("li",null,[t("Navigate to "),e("strong",null,"\u201CSettings > Flows\u201D"),t(" and click "),e("span",{mi:"",btn:""},"add"),t(" in the Page Header. A side menu will appear.")],-1),N=e("li",null,[t("Under "),e("strong",null,"Flow Setup"),t(", fill in a name for the Flow."),e("br"),t(" Optional: Set a status, material icon, description or color to help remember the Flow.")],-1),E=t("Select your "),$=e("strong",null,"Activity and Logs Tracking",-1),B=t(" preference as desired."),L=e("br",null,null,-1),V=t(" To learn more, please see "),W=t("Activity"),D=t(" and "),J=t("Logs"),I=t("."),G=t("Click "),H=e("span",{mi:"",btn:""},"arrow_forward",-1),Y=t(" to navigate to "),q=e("strong",null,"Trigger Setup",-1),z=t(", select a "),R=t("Trigger"),U=t(" type and configure as desired."),K=e("li",null,[t("Click "),e("span",{mi:"",btn:""},"done"),t(" in the Menu Header and you will be taken to the Flow Grid Area."),e("br"),t(" A Trigger Panel will be on the Flow Grid.")],-1),M=e("li",null,[t("On the Trigger Panel, click "),e("span",{mi:""},"add"),t(" and the "),e("strong",null,"Create Operation"),t(" side menu will open.")],-1),Q=t("Set a name, select the "),X=t("Operation"),Z=t(" type, and configure as desired."),ee=e("br",null,null,-1),te=t(" The unique name will be converted into an Operation Key, used on the "),oe=e("a",{href:"#the-flow-object"},"Flow Object",-1),se=t("."),ne=e("br",null,null,-1),ae=t(" If no name is set, a name and key will be auto-generated."),le=e("li",null,[t("When done, click "),e("span",{mi:"",btn:""},"done"),t(" in the Page Header to confirm and return to the Flow Grid Area.")],-1),ie=e("li",null,[t("On the newly created Operation Panel: "),e("ul",null,[e("li",null,[t("Click "),e("span",{mi:"",icon:""},"add"),t(" to add Operation after successful execution of the current Operation.")]),e("li",null,[t("Click "),e("span",{mi:"",icon:""},"remove"),t(" to add Operation after a failed execution of the the current Operation.")])])],-1),re=e("li",null,"Repeat steps 8-10 to create your Flow as desired.",-1),ce=e("li",null,[e("strong",null,"Optional:"),t(" To edit a Trigger or Operation Panel, click "),e("span",{mi:"",icon:""},"edit"),t(" and make edits as desired.")],-1),de=e("li",null,[e("strong",null,"Optional:"),t(" To delete an Operation Panel, click "),e("span",{mi:"",icon:""},"more_vert"),t(" and click "),e("span",{mi:"",icon:"",dngr:""},"delete"),t(".")],-1),he=e("h2",{id:"the-flow-object"},[t("The Flow Object "),e("a",{class:"header-anchor",href:"#the-flow-object"},"#")],-1),_e=e("p",null,"When a Flow is triggered, a JSON object is created to store all data generated within the Flow. When you create an Operation, a key is generated. This key is appended to the Flow Object when the Operation executes. It is used to add the associated Operation\u2019s data onto the Flows Object. As each Operation in the Flow executes, it has access to the Flow Object and therefore the data generated from preceding Operations.",-1),ue=e("p",null,[t("The following JSON object is a simple example of a Flow with two Operations. The "),e("code",{class:""},"$trigger"),t(", "),e("code",{class:""},"$last"),t(", and "),e("code",{class:""},"$accountability"),t(" keys are included on every Flow. An Operation key will be generated for each Operation that executes successfully.")],-1),pe=t(" @TODO: Uncomment once Azzy's doc is live: For more details, see the API Reference for [Flows](reference/system/flows) and [Operations](reference/system/operations). "),fe=e("pre",null,[e("code",{class:"language-JSON"},[t(`{
+   `),e("span",{class:"hljs-attr"},'"$trigger"'),t(": {}, "),e("span",{class:"hljs-comment"},"// Data generated by the Flow's Trigger."),t(`
+   `),e("span",{class:"hljs-attr"},'"$last"'),t(": "),e("span",{class:"hljs-literal"},"null"),t(", "),e("span",{class:"hljs-comment"},"// Data from the last Operation in the flow, for easy access!"),t(`
+   `),e("span",{class:"hljs-attr"},'"$accountability"'),t(": {}, "),e("span",{class:"hljs-comment"},"// Provides details on who/what tripped the Trigger and generated this Flow Object."),t(`
+   `),e("span",{class:"hljs-attr"},'"operation_key"'),t(": { "),e("span",{class:"hljs-comment"},"// The data (if any) generated by the first Operation."),t(`
+			`),e("span",{class:"hljs-attr"},'"some_nested_key"'),t(": "),e("span",{class:"hljs-string"},'"Some nested value."'),t(`,
+    },
+	`),e("span",{class:"hljs-attr"},'"operation_key_2"'),t(": "),e("span",{class:"hljs-literal"},"null"),t(", "),e("span",{class:"hljs-comment"},"// Value is null if no data was generated during an Operation."),t(`
+}
+`)])],-1),we=e("h3",{id:"flow-variables"},[t("Flow Variables "),e("a",{class:"header-anchor",href:"#flow-variables"},"#")],-1),ge=e("p",null,"The Flow Object keys serve as variables, allowing data access from every Flow Operation. Variables must be passed using the following double-moustache syntax. You can even use dot-notation to extract sub-nested values.",-1),me=e("pre",null,[e("code",{class:"language-JSON"},[t(`{
+   `),e("span",{class:"hljs-attr"},'"operation_key_3"'),t(`: {
+			`),e("span",{class:"hljs-attr"},'"user"'),t(": "),e("span",{class:"hljs-string"},'"{{ $accountability.user }}"'),t(`,
+	 }
+}
+`)])],-1),be=e("h2",{id:"logs"},[t("Logs "),e("a",{class:"header-anchor",href:"#logs"},"#")],-1),Oe=e("video",{title:"",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/logs-20220603A.mp4",type:"video/mp4"})],-1),ye=e("p",null,"Logs, accessed from the Sidebar, store a log of information for each Flow execution. Each log will display information from Triggers as well as each Operation.",-1),Fe={title:"Flows",modularExtension:!1},ve={name:"flows",setup(je,{expose:i}){return i({frontmatter:{title:"Flows",modularExtension:!1}}),(ke,Te)=>{const s=a("router-link"),r=a("docswrapper");return c(),d(r,{frontmatter:Fe},{default:o(()=>[e("div",h,[_,u,p,f,w,e("p",null,[g,n(s,{to:"/docs/configuration/flows/triggers"},{default:o(()=>[m]),_:1}),b]),e("p",null,[O,y,F,n(s,{to:"/docsconfiguration/flows/operations/#log-to-console"},{default:o(()=>[v]),_:1}),j,n(s,{to:"/docs/configuration/flows/operations"},{default:o(()=>[k]),_:1}),T]),x,A,S,P,e("ol",null,[C,N,e("li",null,[E,$,B,L,V,n(s,{to:"/docs/reference/system/activity/"},{default:o(()=>[W]),_:1}),D,n(s,{to:"/docs/#logs"},{default:o(()=>[J]),_:1}),I]),e("li",null,[G,H,Y,q,z,n(s,{to:"/docsconfiguration/flows/triggers"},{default:o(()=>[R]),_:1}),U]),K,M,e("li",null,[Q,n(s,{to:"/docsconfiguration/flows/operations"},{default:o(()=>[X]),_:1}),Z,ee,te,oe,se,ne,ae]),le,ie,re,ce,de]),he,_e,ue,pe,fe,we,ge,me,be,Oe,ye])]),_:1})}}};typeof l=="function"&&l(ve);export{ve as default,Fe as frontmatter};

package/dist/assets/{folders.2ba716f4.js → folders.0024d3d3.js}

@@ -1,13 +1,13 @@
-import{w as n,y as h,z as c,A as a,E as e,C as t,W as s}from"./vendor.3b903562.js";const i={class:"markdown-body"},p=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Folders can be used to organize files within the platform. Folders are virtual, and aren\u2019t mirrored within the storage adapter.")])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-folder-object"},"The Folder Object")]),e("li",null,[e("a",{href:"#list-folders"},"List Folders")]),e("li",null,[e("a",{href:"#retrieve-a-folder"},"Retrieve a Folder")]),e("li",null,[e("a",{href:"#create-a-folder"},"Create a Folder")]),e("li",null,[e("a",{href:"#create-multiple-folders"},"Create Multiple Folders")]),e("li",null,[e("a",{href:"#update-a-folder"},"Update a Folder")]),e("li",null,[e("a",{href:"#update-multiple-folders"},"Update Multiple Folders")]),e("li",null,[e("a",{href:"#delete-a-folder"},"Delete a Folder")]),e("li",null,[e("a",{href:"#delete-multiple-folders"},"Delete Multiple Folders")])])])])])],-1),u=e("hr",null,null,-1),_=e("h2",{id:"the-folder-object"},[s("The Folder Object "),e("a",{class:"header-anchor",href:"#the-folder-object"},"#")],-1),f=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",null,"id"),s(),e("strong",null,"uuid"),e("br"),s(" Primary key of the folder.")]),e("p",null,[e("code",null,"name"),s(),e("strong",null,"string"),e("br"),s(" Name of the folder.")]),e("p",null,[e("code",null,"parent"),s(),e("strong",null,"many-to-one"),e("br"),s(" Parent folder. Many-to-one to folders (recursive).")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[s(`{
+import{a as r,o as c,b as h,w as a,g as e,e as t,B as s}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const i={class:"markdown-body"},p=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Folders can be used to organize files within the platform. Folders are virtual, and aren\u2019t mirrored within the storage adapter.")])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-folder-object"},"The Folder Object")]),e("li",null,[e("a",{href:"#list-folders"},"List Folders")]),e("li",null,[e("a",{href:"#retrieve-a-folder"},"Retrieve a Folder")]),e("li",null,[e("a",{href:"#create-a-folder"},"Create a Folder")]),e("li",null,[e("a",{href:"#create-multiple-folders"},"Create Multiple Folders")]),e("li",null,[e("a",{href:"#update-a-folder"},"Update a Folder")]),e("li",null,[e("a",{href:"#update-multiple-folders"},"Update Multiple Folders")]),e("li",null,[e("a",{href:"#delete-a-folder"},"Delete a Folder")]),e("li",null,[e("a",{href:"#delete-multiple-folders"},"Delete Multiple Folders")])])])])])],-1),u=e("hr",null,null,-1),_=e("h2",{id:"the-folder-object"},[s("The Folder Object "),e("a",{class:"header-anchor",href:"#the-folder-object"},"#")],-1),f=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",{class:""},"id"),s(),e("strong",null,"uuid"),e("br"),s(" Primary key of the folder.")]),e("p",null,[e("code",{class:""},"name"),s(),e("strong",null,"string"),e("br"),s(" Name of the folder.")]),e("p",null,[e("code",{class:""},"parent"),s(),e("strong",null,"many-to-one"),e("br"),s(" Parent folder. Many-to-one to folders (recursive).")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[s(`{
 	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
 		`),e("span",{class:"hljs-attr"},'"id"'),s(": "),e("span",{class:"hljs-string"},'"fc02d733-95b8-4e27-bd4b-08a32cbe4e66"'),s(`,
 		`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Test"'),s(`,
 		`),e("span",{class:"hljs-attr"},'"parent"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`
 	}
 }
-`)])])])],-1),m=e("hr",null,null,-1),g=e("h2",{id:"list-folders"},[s("List Folders "),e("a",{class:"header-anchor",href:"#list-folders"},"#")],-1),y=e("p",null,"List all folders that exist in Directus.",-1),b={class:"two-up"},j={class:"left"},q=e("h3",{id:"query-parameters"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),x=s("Supports all "),v=s("global query parameters"),E=s("."),w=e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),T=s("An array of up to "),P=s("limit"),R=s(),k=e("a",{href:"#the-folder-object"},"folder objects",-1),S=s(". If no items are available, data will be an empty array."),A={class:"right"},F=e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),D=e("pre",null,[e("code",null,`GET /folders
+`)])])])],-1),m=e("hr",null,null,-1),g=e("h2",{id:"list-folders"},[s("List Folders "),e("a",{class:"header-anchor",href:"#list-folders"},"#")],-1),y=e("p",null,"List all folders that exist in Directus.",-1),b={class:"two-up"},j={class:"left"},q=e("h3",{id:"query-parameters"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),x=s("Supports all "),v=s("global query parameters"),E=s("."),w=e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),T=s("An array of up to "),P=s("limit"),R=s(),k=e("a",{href:"#the-folder-object"},"folder objects",-1),S=s(". If no items are available, data will be an empty array."),F={class:"right"},A=e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),C=e("pre",null,[e("code",{class:""},`GET /folders
 SEARCH /folders
-`)],-1),C=s("Learn more about SEARCH ->"),L=e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),Q=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),D=s("Learn more about SEARCH ->"),L=e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),Q=e("pre",null,[e("code",{class:""},`POST /graphql/system
 `)],-1),I=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
 	folders: directus_folders
 }
@@ -16,9 +16,9 @@ SEARCH /folders
 		name
 	}
 }
-`)])],-1),G=e("hr",null,null,-1),B=e("h2",{id:"retrieve-a-folder"},[s("Retrieve a Folder "),e("a",{class:"header-anchor",href:"#retrieve-a-folder"},"#")],-1),N=e("p",null,"List all folders that exist in Directus.",-1),H={class:"two-up"},U={class:"left"},V=e("h3",{id:"query-parameters-2"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),W=s("Supports all "),z=s("global query parameters"),J=s("."),K=e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),X=e("p",null,[s("Returns a "),e("a",{href:"#the-folder-object"},"folder object"),s(" if a valid primary key was provided.")],-1),Y=e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`GET /folders/:id
-`)]),e("h5",{id:"example-2"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",null,`GET /folders/fc02d733-95b8-4e27-bd4b-08a32cbe4e66
-`)]),e("h3",{id:"graphql-2"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)])],-1),G=e("hr",null,null,-1),B=e("h2",{id:"retrieve-a-folder"},[s("Retrieve a Folder "),e("a",{class:"header-anchor",href:"#retrieve-a-folder"},"#")],-1),N=e("p",null,"List all folders that exist in Directus.",-1),H={class:"two-up"},U={class:"left"},V=e("h3",{id:"query-parameters-2"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),z=s("Supports all "),J=s("global query parameters"),K=s("."),W=e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),X=e("p",null,[s("Returns a "),e("a",{href:"#the-folder-object"},"folder object"),s(" if a valid primary key was provided.")],-1),Y=e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",{class:""},`GET /folders/:id
+`)]),e("h5",{id:"example-2"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",{class:""},`GET /folders/fc02d733-95b8-4e27-bd4b-08a32cbe4e66
+`)]),e("h3",{id:"graphql-2"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
 `)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
 	folders_by_id(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): directus_folders
 }
@@ -27,13 +27,13 @@ SEARCH /folders
 		name
 	}
 }
-`)])])],-1),Z=e("hr",null,null,-1),$=e("h2",{id:"create-a-folder"},[s("Create a Folder "),e("a",{class:"header-anchor",href:"#create-a-folder"},"#")],-1),ee=e("p",null,"Create a new (virtual) folder.",-1),se={class:"two-up"},ae={class:"left"},le=e("h3",{id:"query-parameters-3"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),te=s("Supports all "),re=s("global query parameters"),ne=s("."),de=e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),oe=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(". "),e("code",null,"name"),s(" is required.")],-1),he=e("h3",{id:"returns-3"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),ce=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was created.")],-1),ie=e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /folders
+`)])])],-1),Z=e("hr",null,null,-1),$=e("h2",{id:"create-a-folder"},[s("Create a Folder "),e("a",{class:"header-anchor",href:"#create-a-folder"},"#")],-1),ee=e("p",null,"Create a new (virtual) folder.",-1),se={class:"two-up"},ae={class:"left"},le=e("h3",{id:"query-parameters-3"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),te=s("Supports all "),re=s("global query parameters"),ne=s("."),de=e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),oe=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(". "),e("code",{class:""},"name"),s(" is required.")],-1),ce=e("h3",{id:"returns-3"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),he=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was created.")],-1),ie=e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",{class:""},`POST /folders
 `)]),e("h5",{id:"example-4"},[s("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /folders"),s(`
 
 {
 	`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Nature"'),s(`
 }
-`)])]),e("h3",{id:"graphql-3"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)])]),e("h3",{id:"graphql-3"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
 `)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
 	create_folders_item(data: create_directus_folders_input): directus_folders
 }
@@ -43,7 +43,7 @@ SEARCH /folders
 		name
 	}
 }
-`)])])],-1),pe=e("hr",null,null,-1),ue=e("h2",{id:"create-multiple-folders"},[s("Create Multiple Folders "),e("a",{class:"header-anchor",href:"#create-multiple-folders"},"#")],-1),_e=e("p",null,"Create multiple new (virtual) folders.",-1),fe={class:"two-up"},me={class:"left"},ge=e("h3",{id:"query-parameters-4"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),ye=s("Supports all "),be=s("global query parameters"),je=s("."),qe=e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),xe=e("p",null,[s("An array of partial "),e("a",{href:"#the-folder-object"},"folder objects"),s(". "),e("code",null,"name"),s(" is required.")],-1),ve=e("h3",{id:"returns-4"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),Ee=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was created.")],-1),we=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`POST /folders
+`)])])],-1),pe=e("hr",null,null,-1),ue=e("h2",{id:"create-multiple-folders"},[s("Create Multiple Folders "),e("a",{class:"header-anchor",href:"#create-multiple-folders"},"#")],-1),_e=e("p",null,"Create multiple new (virtual) folders.",-1),fe={class:"two-up"},me={class:"left"},ge=e("h3",{id:"query-parameters-4"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),ye=s("Supports all "),be=s("global query parameters"),je=s("."),qe=e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),xe=e("p",null,[s("An array of partial "),e("a",{href:"#the-folder-object"},"folder objects"),s(". "),e("code",{class:""},"name"),s(" is required.")],-1),ve=e("h3",{id:"returns-4"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),Ee=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was created.")],-1),we=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",{class:""},`POST /folders
 `)]),e("h5",{id:"example-6"},[s("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /folders"),s(`
 
 [
@@ -54,7 +54,7 @@ SEARCH /folders
 		`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Cities"'),s(`
 	}
 ]
-`)])]),e("h3",{id:"graphql-4"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)])]),e("h3",{id:"graphql-4"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
 `)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
 	create_folders_items(data: [create_directus_folders_input]): [directus_folders]
 }
@@ -64,13 +64,13 @@ SEARCH /folders
 		name
 	}
 }
-`)])])],-1),Te=e("hr",null,null,-1),Pe=e("h2",{id:"update-a-folder"},[s("Update a Folder "),e("a",{class:"header-anchor",href:"#update-a-folder"},"#")],-1),Re=e("p",null,"Update an existing folder.",-1),ke={class:"two-up"},Se={class:"left"},Ae=e("h3",{id:"query-parameters-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Fe=s("Supports all "),De=s("global query parameters"),Ce=s("."),Le=e("h3",{id:"request-body-3"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Qe=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(".")],-1),Ie=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),Oe=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was updated.")],-1),Me=e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /folders/:id
+`)])])],-1),Te=e("hr",null,null,-1),Pe=e("h2",{id:"update-a-folder"},[s("Update a Folder "),e("a",{class:"header-anchor",href:"#update-a-folder"},"#")],-1),Re=e("p",null,"Update an existing folder.",-1),ke={class:"two-up"},Se={class:"left"},Fe=e("h3",{id:"query-parameters-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Ae=s("Supports all "),Ce=s("global query parameters"),De=s("."),Le=e("h3",{id:"request-body-3"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Qe=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(".")],-1),Ie=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),Oe=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was updated.")],-1),Me=e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",{class:""},`PATCH /folders/:id
 `)]),e("h5",{id:"example-8"},[s("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /folders/fac21847-d5ce-4e4b-a288-9abafbdfbc87"),s(`
 
 {
 	`),e("span",{class:"hljs-attr"},'"parent"'),s(": "),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(`
 }
-`)])]),e("h3",{id:"graphql-5"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)])]),e("h3",{id:"graphql-5"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
 `)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
 	update_folders_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!, data: update_directus_folders_input): directus_folders
 }
@@ -83,7 +83,7 @@ SEARCH /folders
 		name
 	}
 }
-`)])])],-1),Ge=e("hr",null,null,-1),Be=e("h2",{id:"update-multiple-folders"},[s("Update Multiple Folders "),e("a",{class:"header-anchor",href:"#update-multiple-folders"},"#")],-1),Ne=e("p",null,"Update multiple existing folders.",-1),He={class:"two-up"},Ue={class:"left"},Ve=e("h3",{id:"query-parameters-6"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),We=s("Supports all "),ze=s("global query parameters"),Je=s("."),Ke=e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Xe=e("div",{class:"definitions"},[e("p",null,[e("code",null,"keys"),s(),e("strong",null,"Required"),e("br"),s(" Array of primary keys of the folders you\u2019d like to update.")]),e("p",null,[e("code",null,"data"),s(),e("strong",null,"Required"),e("br"),s(" Any of "),e("a",{href:"#the-folder-object"},"the folder object"),s("\u2019s properties.")])],-1),Ye=e("h3",{id:"returns-6"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Ze=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder objects"),s(" of the folders that were updated.")],-1),$e=e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`PATCH /folders
+`)])])],-1),Ge=e("hr",null,null,-1),Be=e("h2",{id:"update-multiple-folders"},[s("Update Multiple Folders "),e("a",{class:"header-anchor",href:"#update-multiple-folders"},"#")],-1),Ne=e("p",null,"Update multiple existing folders.",-1),He={class:"two-up"},Ue={class:"left"},Ve=e("h3",{id:"query-parameters-6"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),ze=s("Supports all "),Je=s("global query parameters"),Ke=s("."),We=e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Xe=e("div",{class:"definitions"},[e("p",null,[e("code",{class:""},"keys"),s(),e("strong",null,"Required"),e("br"),s(" Array of primary keys of the folders you\u2019d like to update.")]),e("p",null,[e("code",{class:""},"data"),s(),e("strong",null,"Required"),e("br"),s(" Any of "),e("a",{href:"#the-folder-object"},"the folder object"),s("\u2019s properties.")])],-1),Ye=e("h3",{id:"returns-6"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Ze=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder objects"),s(" of the folders that were updated.")],-1),$e=e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",{class:""},`PATCH /folders
 `)]),e("h5",{id:"example-10"},[s("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /folders"),s(`
 
 {
@@ -92,7 +92,7 @@ SEARCH /folders
 		`),e("span",{class:"hljs-attr"},'"parent"'),s(": "),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(`
 	}
 }
-`)])]),e("h3",{id:"graphql-6"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)])]),e("h3",{id:"graphql-6"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
 `)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
 	update_folders_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!, data: update_directus_folders_input): [directus_folders]
 }
@@ -105,9 +105,9 @@ SEARCH /folders
 		name
 	}
 }
-`)])])],-1),es=e("hr",null,null,-1),ss=e("h2",{id:"delete-a-folder"},[s("Delete a Folder "),e("a",{class:"header-anchor",href:"#delete-a-folder"},"#")],-1),as=e("p",null,"Delete an existing folder.",-1),ls=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Files"),e("p",null,"Any files in this folder will be moved to the root folder.")]),e("h3",{id:"returns-7"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",null,`DELETE /folders/:id
-`)]),e("h5",{id:"example-12"},[s("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),e("pre",null,[e("code",null,`// DELETE /folders/a5bdb793-dd85-4ac9-882a-b42862092983
-`)]),e("h3",{id:"graphql-7"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-7"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)])])],-1),es=e("hr",null,null,-1),ss=e("h2",{id:"delete-a-folder"},[s("Delete a Folder "),e("a",{class:"header-anchor",href:"#delete-a-folder"},"#")],-1),as=e("p",null,"Delete an existing folder.",-1),ls=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Files"),e("p",null,"Any files in this folder will be moved to the root folder.")]),e("h3",{id:"returns-7"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",{class:""},`DELETE /folders/:id
+`)]),e("h5",{id:"example-12"},[s("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),e("pre",null,[e("code",{class:""},`// DELETE /folders/a5bdb793-dd85-4ac9-882a-b42862092983
+`)]),e("h3",{id:"graphql-7"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-7"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
 `)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
 	delete_folders_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): delete_one
 }
@@ -116,11 +116,11 @@ SEARCH /folders
 		id
 	}
 }
-`)])])])],-1),ts=e("hr",null,null,-1),rs=e("h2",{id:"delete-multiple-folders"},[s("Delete Multiple Folders "),e("a",{class:"header-anchor",href:"#delete-multiple-folders"},"#")],-1),ns=e("p",null,"Delete multiple existing folders.",-1),ds=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Files"),e("p",null,"Any files in these folders will be moved to the root folder.")]),e("h3",{id:"request-body-5"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-5"},"#")]),e("p",null,"An array of folder primary keys."),e("h3",{id:"returns-8"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-8"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-8"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),e("pre",null,[e("code",null,`DELETE /folders
+`)])])])],-1),ts=e("hr",null,null,-1),rs=e("h2",{id:"delete-multiple-folders"},[s("Delete Multiple Folders "),e("a",{class:"header-anchor",href:"#delete-multiple-folders"},"#")],-1),ns=e("p",null,"Delete multiple existing folders.",-1),ds=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Files"),e("p",null,"Any files in these folders will be moved to the root folder.")]),e("h3",{id:"request-body-5"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-5"},"#")]),e("p",null,"An array of folder primary keys."),e("h3",{id:"returns-8"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-8"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-8"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),e("pre",null,[e("code",{class:""},`DELETE /folders
 `)]),e("h5",{id:"example-14"},[s("Example "),e("a",{class:"header-anchor",href:"#example-14"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// DELETE /folders"),s(`
 
 [`),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(", "),e("span",{class:"hljs-string"},'"fc02d733-95b8-4e27-bd4b-08a32cbe4e66"'),s(`]
-`)])]),e("h3",{id:"graphql-8"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-8"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)])]),e("h3",{id:"graphql-8"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-8"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
 `)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
 	delete_folders_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!): delete_many
 }
@@ -129,4 +129,4 @@ SEARCH /folders
 		ids
 	}
 }
-`)])])])],-1),ps={setup(os,{expose:d}){const r={title:"Folders",modularExtension:!1,pageClass:"page-reference"};return d({frontmatter:r}),(hs,cs)=>{const l=n("router-link"),o=n("DocsWrapper");return h(),c(o,{frontmatter:r},{default:a(()=>[e("div",i,[p,u,_,f,m,g,y,e("div",b,[e("div",j,[q,e("p",null,[x,t(l,{to:"/docs/reference/query"},{default:a(()=>[v]),_:1}),E]),w,e("p",null,[T,t(l,{to:"/docs/reference/query/#limit"},{default:a(()=>[P]),_:1}),R,k,S])]),e("div",A,[F,D,e("p",null,[t(l,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[C]),_:1})]),L,Q,I,O,M])]),G,B,N,e("div",H,[e("div",U,[V,e("p",null,[W,t(l,{to:"/docs/reference/query"},{default:a(()=>[z]),_:1}),J]),K,X]),Y]),Z,$,ee,e("div",se,[e("div",ae,[le,e("p",null,[te,t(l,{to:"/docs/reference/query"},{default:a(()=>[re]),_:1}),ne]),de,oe,he,ce]),ie]),pe,ue,_e,e("div",fe,[e("div",me,[ge,e("p",null,[ye,t(l,{to:"/docs/reference/query"},{default:a(()=>[be]),_:1}),je]),qe,xe,ve,Ee]),we]),Te,Pe,Re,e("div",ke,[e("div",Se,[Ae,e("p",null,[Fe,t(l,{to:"/docs/reference/query"},{default:a(()=>[De]),_:1}),Ce]),Le,Qe,Ie,Oe]),Me]),Ge,Be,Ne,e("div",He,[e("div",Ue,[Ve,e("p",null,[We,t(l,{to:"/docs/reference/query"},{default:a(()=>[ze]),_:1}),Je]),Ke,Xe,Ye,Ze]),$e]),es,ss,as,ls,ts,rs,ns,ds])]),_:1})}}};export{ps as default};
+`)])])])],-1),os={title:"Folders",modularExtension:!1,pageClass:"page-reference"},cs={name:"folders",setup(hs,{expose:d}){return d({frontmatter:{title:"Folders",modularExtension:!1,pageClass:"page-reference"}}),(is,ps)=>{const l=r("router-link"),o=r("docswrapper");return c(),h(o,{frontmatter:os},{default:a(()=>[e("div",i,[p,u,_,f,m,g,y,e("div",b,[e("div",j,[q,e("p",null,[x,t(l,{to:"/docs/reference/query"},{default:a(()=>[v]),_:1}),E]),w,e("p",null,[T,t(l,{to:"/docs/reference/query/#limit"},{default:a(()=>[P]),_:1}),R,k,S])]),e("div",F,[A,C,e("p",null,[t(l,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[D]),_:1})]),L,Q,I,O,M])]),G,B,N,e("div",H,[e("div",U,[V,e("p",null,[z,t(l,{to:"/docs/reference/query"},{default:a(()=>[J]),_:1}),K]),W,X]),Y]),Z,$,ee,e("div",se,[e("div",ae,[le,e("p",null,[te,t(l,{to:"/docs/reference/query"},{default:a(()=>[re]),_:1}),ne]),de,oe,ce,he]),ie]),pe,ue,_e,e("div",fe,[e("div",me,[ge,e("p",null,[ye,t(l,{to:"/docs/reference/query"},{default:a(()=>[be]),_:1}),je]),qe,xe,ve,Ee]),we]),Te,Pe,Re,e("div",ke,[e("div",Se,[Fe,e("p",null,[Ae,t(l,{to:"/docs/reference/query"},{default:a(()=>[Ce]),_:1}),De]),Le,Qe,Ie,Oe]),Me]),Ge,Be,Ne,e("div",He,[e("div",Ue,[Ve,e("p",null,[ze,t(l,{to:"/docs/reference/query"},{default:a(()=>[Je]),_:1}),Ke]),We,Xe,Ye,Ze]),$e]),es,ss,as,ls,ts,rs,ns,ds])]),_:1})}}};typeof n=="function"&&n(cs);export{cs as default,os as frontmatter};

package/dist/assets/forth.725698ea.js

@@ -0,0 +1 @@
+import{A}from"./index.133de9ba.entry.js";function S(f,O){return O.forEach(function(E){E&&typeof E!="string"&&!Array.isArray(E)&&Object.keys(E).forEach(function(i){if(i!=="default"&&!(i in f)){var R=Object.getOwnPropertyDescriptor(E,i);Object.defineProperty(f,i,R.get?R:{enumerable:!0,get:function(){return E[i]}})}})}),Object.freeze(Object.defineProperty(f,Symbol.toStringTag,{value:"Module"}))}var u={exports:{}};(function(f,O){(function(E){E(A.exports)})(function(E){function i(n){var r=[];return n.split(" ").forEach(function(e){r.push({name:e})}),r}var R=i("INVERT AND OR XOR 2* 2/ LSHIFT RSHIFT 0= = 0< < > U< MIN MAX 2DROP 2DUP 2OVER 2SWAP ?DUP DEPTH DROP DUP OVER ROT SWAP >R R> R@ + - 1+ 1- ABS NEGATE S>D * M* UM* FM/MOD SM/REM UM/MOD */ */MOD / /MOD MOD HERE , @ ! CELL+ CELLS C, C@ C! CHARS 2@ 2! ALIGN ALIGNED +! ALLOT CHAR [CHAR] [ ] BL FIND EXECUTE IMMEDIATE COUNT LITERAL STATE ; DOES> >BODY EVALUATE SOURCE >IN <# # #S #> HOLD SIGN BASE >NUMBER HEX DECIMAL FILL MOVE . CR EMIT SPACE SPACES TYPE U. .R U.R ACCEPT TRUE FALSE <> U> 0<> 0> NIP TUCK ROLL PICK 2>R 2R@ 2R> WITHIN UNUSED MARKER I J TO COMPILE, [COMPILE] SAVE-INPUT RESTORE-INPUT PAD ERASE 2LITERAL DNEGATE D- D+ D0< D0= D2* D2/ D< D= DMAX DMIN D>S DABS M+ M*/ D. D.R 2ROT DU< CATCH THROW FREE RESIZE ALLOCATE CS-PICK CS-ROLL GET-CURRENT SET-CURRENT FORTH-WORDLIST GET-ORDER SET-ORDER PREVIOUS SEARCH-WORDLIST WORDLIST FIND ALSO ONLY FORTH DEFINITIONS ORDER -TRAILING /STRING SEARCH COMPARE CMOVE CMOVE> BLANK SLITERAL"),a=i("IF ELSE THEN BEGIN WHILE REPEAT UNTIL RECURSE [IF] [ELSE] [THEN] ?DO DO LOOP +LOOP UNLOOP LEAVE EXIT AGAIN CASE OF ENDOF ENDCASE");E.defineMode("forth",function(){function n(r,e){var t;for(t=r.length-1;t>=0;t--)if(r[t].name===e.toUpperCase())return r[t]}return{startState:function(){return{state:"",base:10,coreWordList:R,immediateWordList:a,wordList:[]}},token:function(r,e){var t;if(r.eatSpace())return null;if(e.state===""){if(r.match(/^(\]|:NONAME)(\s|$)/i))return e.state=" compilation","builtin compilation";if(t=r.match(/^(\:)\s+(\S+)(\s|$)+/),t)return e.wordList.push({name:t[2].toUpperCase()}),e.state=" compilation","def"+e.state;if(t=r.match(/^(VARIABLE|2VARIABLE|CONSTANT|2CONSTANT|CREATE|POSTPONE|VALUE|WORD)\s+(\S+)(\s|$)+/i),t)return e.wordList.push({name:t[2].toUpperCase()}),"def"+e.state;if(t=r.match(/^(\'|\[\'\])\s+(\S+)(\s|$)+/),t)return"builtin"+e.state}else{if(r.match(/^(\;|\[)(\s)/))return e.state="",r.backUp(1),"builtin compilation";if(r.match(/^(\;|\[)($)/))return e.state="","builtin compilation";if(r.match(/^(POSTPONE)\s+\S+(\s|$)+/))return"builtin"}if(t=r.match(/^(\S+)(\s+|$)/),t)return n(e.wordList,t[1])!==void 0?"variable"+e.state:t[1]==="\\"?(r.skipToEnd(),"comment"+e.state):n(e.coreWordList,t[1])!==void 0?"builtin"+e.state:n(e.immediateWordList,t[1])!==void 0?"keyword"+e.state:t[1]==="("?(r.eatWhile(function(o){return o!==")"}),r.eat(")"),"comment"+e.state):t[1]===".("?(r.eatWhile(function(o){return o!==")"}),r.eat(")"),"string"+e.state):t[1]==='S"'||t[1]==='."'||t[1]==='C"'?(r.eatWhile(function(o){return o!=='"'}),r.eat('"'),"string"+e.state):t[1]-68719476735?"number"+e.state:"atom"+e.state}}}),E.defineMIME("text/x-forth","forth")})})();var T=u.exports,D=S({__proto__:null,default:T},[u.exports]);export{D as f};

package/dist/assets/fortran.e9ba7b47.js

@@ -0,0 +1 @@
+import{A as h}from"./index.133de9ba.entry.js";function x(o,s){return s.forEach(function(n){n&&typeof n!="string"&&!Array.isArray(n)&&Object.keys(n).forEach(function(i){if(i!=="default"&&!(i in o)){var c=Object.getOwnPropertyDescriptor(n,i);Object.defineProperty(o,i,c.get?c:{enumerable:!0,get:function(){return n[i]}})}})}),Object.freeze(Object.defineProperty(o,Symbol.toStringTag,{value:"Module"}))}var u={exports:{}};(function(o,s){(function(n){n(h.exports)})(function(n){n.defineMode("fortran",function(){function i(t){for(var r={},e=0;e<t.length;++e)r[t[e]]=!0;return r}var c=i(["abstract","accept","allocatable","allocate","array","assign","asynchronous","backspace","bind","block","byte","call","case","class","close","common","contains","continue","cycle","data","deallocate","decode","deferred","dimension","do","elemental","else","encode","end","endif","entry","enumerator","equivalence","exit","external","extrinsic","final","forall","format","function","generic","go","goto","if","implicit","import","include","inquire","intent","interface","intrinsic","module","namelist","non_intrinsic","non_overridable","none","nopass","nullify","open","optional","options","parameter","pass","pause","pointer","print","private","program","protected","public","pure","read","recursive","result","return","rewind","save","select","sequence","stop","subroutine","target","then","to","type","use","value","volatile","where","while","write"]),f=i(["abort","abs","access","achar","acos","adjustl","adjustr","aimag","aint","alarm","all","allocated","alog","amax","amin","amod","and","anint","any","asin","associated","atan","besj","besjn","besy","besyn","bit_size","btest","cabs","ccos","ceiling","cexp","char","chdir","chmod","clog","cmplx","command_argument_count","complex","conjg","cos","cosh","count","cpu_time","cshift","csin","csqrt","ctime","c_funloc","c_loc","c_associated","c_null_ptr","c_null_funptr","c_f_pointer","c_null_char","c_alert","c_backspace","c_form_feed","c_new_line","c_carriage_return","c_horizontal_tab","c_vertical_tab","dabs","dacos","dasin","datan","date_and_time","dbesj","dbesj","dbesjn","dbesy","dbesy","dbesyn","dble","dcos","dcosh","ddim","derf","derfc","dexp","digits","dim","dint","dlog","dlog","dmax","dmin","dmod","dnint","dot_product","dprod","dsign","dsinh","dsin","dsqrt","dtanh","dtan","dtime","eoshift","epsilon","erf","erfc","etime","exit","exp","exponent","extends_type_of","fdate","fget","fgetc","float","floor","flush","fnum","fputc","fput","fraction","fseek","fstat","ftell","gerror","getarg","get_command","get_command_argument","get_environment_variable","getcwd","getenv","getgid","getlog","getpid","getuid","gmtime","hostnm","huge","iabs","iachar","iand","iargc","ibclr","ibits","ibset","ichar","idate","idim","idint","idnint","ieor","ierrno","ifix","imag","imagpart","index","int","ior","irand","isatty","ishft","ishftc","isign","iso_c_binding","is_iostat_end","is_iostat_eor","itime","kill","kind","lbound","len","len_trim","lge","lgt","link","lle","llt","lnblnk","loc","log","logical","long","lshift","lstat","ltime","matmul","max","maxexponent","maxloc","maxval","mclock","merge","move_alloc","min","minexponent","minloc","minval","mod","modulo","mvbits","nearest","new_line","nint","not","or","pack","perror","precision","present","product","radix","rand","random_number","random_seed","range","real","realpart","rename","repeat","reshape","rrspacing","rshift","same_type_as","scale","scan","second","selected_int_kind","selected_real_kind","set_exponent","shape","short","sign","signal","sinh","sin","sleep","sngl","spacing","spread","sqrt","srand","stat","sum","symlnk","system","system_clock","tan","tanh","time","tiny","transfer","transpose","trim","ttynam","ubound","umask","unlink","unpack","verify","xor","zabs","zcos","zexp","zlog","zsin","zsqrt"]),p=i(["c_bool","c_char","c_double","c_double_complex","c_float","c_float_complex","c_funptr","c_int","c_int16_t","c_int32_t","c_int64_t","c_int8_t","c_int_fast16_t","c_int_fast32_t","c_int_fast64_t","c_int_fast8_t","c_int_least16_t","c_int_least32_t","c_int_least64_t","c_int_least8_t","c_intmax_t","c_intptr_t","c_long","c_long_double","c_long_double_complex","c_long_long","c_ptr","c_short","c_signed_char","c_size_t","character","complex","double","integer","logical","real"]),d=/[+\-*&=<>\/\:]/,m=new RegExp("(.and.|.or.|.eq.|.lt.|.le.|.gt.|.ge.|.ne.|.not.|.eqv.|.neqv.)","i");function g(t,r){if(t.match(m))return"operator";var e=t.next();if(e=="!")return t.skipToEnd(),"comment";if(e=='"'||e=="'")return r.tokenize=b(e),r.tokenize(t,r);if(/[\[\]\(\),]/.test(e))return null;if(/\d/.test(e))return t.eatWhile(/[\w\.]/),"number";if(d.test(e))return t.eatWhile(d),"operator";t.eatWhile(/[\w\$_]/);var a=t.current().toLowerCase();return c.hasOwnProperty(a)?"keyword":f.hasOwnProperty(a)||p.hasOwnProperty(a)?"builtin":"variable"}function b(t){return function(r,e){for(var a=!1,l,_=!1;(l=r.next())!=null;){if(l==t&&!a){_=!0;break}a=!a&&l=="\\"}return(_||!a)&&(e.tokenize=null),"string"}}return{startState:function(){return{tokenize:null}},token:function(t,r){if(t.eatSpace())return null;var e=(r.tokenize||g)(t,r);return e=="comment"||e=="meta",e}}}),n.defineMIME("text/x-fortran","fortran")})})();var y=u.exports,k=x({__proto__:null,default:y},[u.exports]);export{k as f};