@directus/app 9.12.1 → 9.14.0

package/dist/assets/filter-rules.e442e006.js

@@ -1,76 +0,0 @@
-import{a,o as r,b as o,w as u,g as l,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const c=l("div",{class:"markdown-body"},[l("blockquote",null,[l("p",null,[t("Permissions, validation, and the API\u2019s "),l("code",{class:""},"filter"),t(" parameter all rely on a specific JSON structure to define their rules. This page describes the syntax for creating flat, relational, or complex filter rules.")])]),l("p",null,[l("div",{class:"table-of-contents"},[l("ul",null,[l("li",null,[l("a",{href:"#syntax"},"Syntax")]),l("li",null,[l("a",{href:"#filter-operators"},"Filter Operators")]),l("li",null,[l("a",{href:"#relational"},"Relational")]),l("li",null,[l("a",{href:"#logical-operators"},"Logical Operators")]),l("li",null,[l("a",{href:"#dynamic-variables"},"Dynamic Variables")])])])]),l("h2",{id:"syntax"},[t("Syntax "),l("a",{class:"header-anchor",href:"#syntax"},"#")]),l("ul",null,[l("li",null,[l("strong",null,"Field"),t(" \u2014 Any valid root field, "),l("a",{href:"#relational"},"relational field"),t(", or "),l("a",{href:"#logical-operators"},"logical operator")]),l("li",null,[l("strong",null,"Operator"),t(" \u2014 Any valid "),l("a",{href:"#filter-operators"},"filter operator")]),l("li",null,[l("strong",null,"Value"),t(" \u2014 Any valid static value, or "),l("a",{href:"#dynamic-variables"},"dynamic variable")])]),l("pre",null,[l("code",{class:""},`{
-	<field>: {
-		<operator>: <value>
-	}
-}
-`)]),l("h3",{id:"examples"},[t("Examples "),l("a",{class:"header-anchor",href:"#examples"},"#")]),l("pre",null,[l("code",{class:"language-json"},[t(`{
-	`),l("span",{class:"hljs-attr"},'"title"'),t(`: {
-		`),l("span",{class:"hljs-attr"},'"_contains"'),t(": "),l("span",{class:"hljs-string"},'"Directus"'),t(`
-	}
-}
-`)])]),l("pre",null,[l("code",{class:"language-json"},[t(`{
-	`),l("span",{class:"hljs-attr"},'"owner"'),t(`: {
-		`),l("span",{class:"hljs-attr"},'"_eq"'),t(": "),l("span",{class:"hljs-string"},'"$CURRENT_USER"'),t(`
-	}
-}
-`)])]),l("pre",null,[l("code",{class:"language-json"},[t(`{
-	`),l("span",{class:"hljs-attr"},'"datetime"'),t(`: {
-		`),l("span",{class:"hljs-attr"},'"_lte"'),t(": "),l("span",{class:"hljs-string"},'"$NOW"'),t(`
-	}
-}
-`)])]),l("h2",{id:"filter-operators"},[t("Filter Operators "),l("a",{class:"header-anchor",href:"#filter-operators"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,[t("Operator Title "),l("em",null,"(in app)")]),l("th",null,"Operator"),l("th",null,"Description")])]),l("tbody",null,[l("tr",null,[l("td",null,"Equals"),l("td",null,[l("code",{class:""},"_eq")]),l("td",null,"Equal to")]),l("tr",null,[l("td",null,"Doesn\u2019t equal"),l("td",null,[l("code",{class:""},"_neq")]),l("td",null,"Not equal to")]),l("tr",null,[l("td",null,"Less than"),l("td",null,[l("code",{class:""},"_lt")]),l("td",null,"Less than")]),l("tr",null,[l("td",null,"Less than or equal to"),l("td",null,[l("code",{class:""},"_lte")]),l("td",null,"Less than or equal to")]),l("tr",null,[l("td",null,"Greater than"),l("td",null,[l("code",{class:""},"_gt")]),l("td",null,"Greater than")]),l("tr",null,[l("td",null,"Greater than or equal to"),l("td",null,[l("code",{class:""},"_gte")]),l("td",null,"Greater than or equal to")]),l("tr",null,[l("td",null,"Is one of"),l("td",null,[l("code",{class:""},"_in")]),l("td",null,"Matches any of the values")]),l("tr",null,[l("td",null,"Is not one of"),l("td",null,[l("code",{class:""},"_nin")]),l("td",null,"Doesn\u2019t match any of the values")]),l("tr",null,[l("td",null,"Is null"),l("td",null,[l("code",{class:""},"_null")]),l("td",null,[t("Is "),l("code",{class:""},"null")])]),l("tr",null,[l("td",null,"Isn\u2019t null"),l("td",null,[l("code",{class:""},"_nnull")]),l("td",null,[t("Is not "),l("code",{class:""},"null")])]),l("tr",null,[l("td",null,"Contains"),l("td",null,[l("code",{class:""},"_contains")]),l("td",null,"Contains the substring")]),l("tr",null,[l("td",null,"Doesn\u2019t contain"),l("td",null,[l("code",{class:""},"_ncontains")]),l("td",null,"Doesn\u2019t contain the substring")]),l("tr",null,[l("td",null,"Starts with"),l("td",null,[l("code",{class:""},"_starts_with")]),l("td",null,"Starts with")]),l("tr",null,[l("td",null,"Doesn\u2019t start with"),l("td",null,[l("code",{class:""},"_nstarts_with")]),l("td",null,"Doesn\u2019t start with")]),l("tr",null,[l("td",null,"Ends with"),l("td",null,[l("code",{class:""},"_ends_with")]),l("td",null,"Ends with")]),l("tr",null,[l("td",null,"Doesn\u2019t end with"),l("td",null,[l("code",{class:""},"_nends_with")]),l("td",null,"Doesn\u2019t end with")]),l("tr",null,[l("td",null,"Is between"),l("td",null,[l("code",{class:""},"_between")]),l("td",null,"Is between two values (inclusive)")]),l("tr",null,[l("td",null,"Isn\u2019t between"),l("td",null,[l("code",{class:""},"_nbetween")]),l("td",null,"Is not between two values (inclusive)")]),l("tr",null,[l("td",null,"Is empty"),l("td",null,[l("code",{class:""},"_empty")]),l("td",null,[t("Is empty ("),l("code",{class:""},"null"),t(" or falsy)")])]),l("tr",null,[l("td",null,"Isn\u2019t empty"),l("td",null,[l("code",{class:""},"_nempty")]),l("td",null,[t("Is not empty ("),l("code",{class:""},"null"),t(" or falsy)")])]),l("tr",null,[l("td",null,"Intersects"),l("td",null,[l("code",{class:""},"_intersects"),t(),l("sup",null,"[1]")]),l("td",null,"Value intersects a given point")]),l("tr",null,[l("td",null,"Doesn\u2019t intersect"),l("td",null,[l("code",{class:""},"_nintersects"),t(),l("sup",null,"[1]")]),l("td",null,"Value does not intersect a given point")]),l("tr",null,[l("td",null,"Intersects Bounding box"),l("td",null,[l("code",{class:""},"_intersects_bbox"),t(),l("sup",null,"[1]")]),l("td",null,"Value is in a bounding box")]),l("tr",null,[l("td",null,"Doesn\u2019t intersect bounding box"),l("td",null,[l("code",{class:""},"_nintersects_bbox"),t(),l("sup",null,"[1]")]),l("td",null,"Value is not in a bounding box")])])]),l("p",null,[t("The following operator has no Title on the Filter Interface as it is "),l("strong",null,"only available in validation permissions"),t(":")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Operator"),l("th",null,"Description")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",{class:""},"_regex"),t(),l("sup",null,"[2]")]),l("td",null,"Field has to match regex")])])]),l("p",null,[l("sup",null,"[1]"),t(" Only available on Geometry types."),l("br"),l("sup",null,"[2]"),t(" JavaScript \u201Cflavor\u201D regex. Make sure to escape backslashes.")]),l("h2",{id:"relational"},[t("Relational "),l("a",{class:"header-anchor",href:"#relational"},"#")]),l("p",null,[t("You can target related values by nesting field names. For example, if you have a relational Many-to-One "),l("code",{class:""},"author"),t(" field, you can set a rule for the "),l("code",{class:""},"author.name"),t(" field using the following syntax.")]),l("pre",null,[l("code",{class:"language-json"},[t(`{
-	`),l("span",{class:"hljs-attr"},'"author"'),t(`: {
-		`),l("span",{class:"hljs-attr"},'"name"'),t(`: {
-			`),l("span",{class:"hljs-attr"},'"_eq"'),t(": "),l("span",{class:"hljs-string"},'"Rijk van Zanten"'),t(`
-		}
-	}
-}
-`)])]),l("h2",{id:"logical-operators"},[t("Logical Operators "),l("a",{class:"header-anchor",href:"#logical-operators"},"#")]),l("p",null,[t("You can nest or group multiple rules using the "),l("code",{class:""},"_and"),t(" or "),l("code",{class:""},"_or"),t(" logical operators. Each logical operator holds an array of Filter Rules, allowing for more complex filtering. Also note in the example that Logical Operators can be sub-nested into Logical Operators. However, they cannot be sub-nested into Filter Rules.")]),l("pre",null,[l("code",{class:"language-json"},[t(`{
-	`),l("span",{class:"hljs-attr"},'"_or"'),t(`: [
-		{
-			`),l("span",{class:"hljs-attr"},'"_and"'),t(`: [
-				{
-					`),l("span",{class:"hljs-attr"},'"user_created"'),t(`: {
-						`),l("span",{class:"hljs-attr"},'"_eq"'),t(": "),l("span",{class:"hljs-string"},'"$CURRENT_USER"'),t(`
-					}
-				},
-				{
-					`),l("span",{class:"hljs-attr"},'"status"'),t(`: {
-						`),l("span",{class:"hljs-attr"},'"_in"'),t(": ["),l("span",{class:"hljs-string"},'"published"'),t(", "),l("span",{class:"hljs-string"},'"draft"'),t(`]
-					}
-				}
-			]
-		},
-		{
-			`),l("span",{class:"hljs-attr"},'"_and"'),t(`: [
-				{
-					`),l("span",{class:"hljs-attr"},'"user_created"'),t(`: {
-						`),l("span",{class:"hljs-attr"},'"_neq"'),t(": "),l("span",{class:"hljs-string"},'"$CURRENT_USER"'),t(`
-					}
-				},
-				{
-					`),l("span",{class:"hljs-attr"},'"status"'),t(`: {
-						`),l("span",{class:"hljs-attr"},'"_in"'),t(": ["),l("span",{class:"hljs-string"},'"published"'),t(`]
-					}
-				}
-			]
-		}
-	]
-}
-`)])]),l("h3",{id:"some-vs-none-in-one-to-many"},[t("Some vs None in One-to-Many "),l("a",{class:"header-anchor",href:"#some-vs-none-in-one-to-many"},"#")]),l("p",null,"When applying filters to a one-to-many field, Directus will default to a \u201Csome\u201D search, for example in:"),l("pre",null,[l("code",{class:"language-json"},[t(`{
-	`),l("span",{class:"hljs-attr"},'"categories"'),t(`: {
-		`),l("span",{class:"hljs-attr"},'"name"'),t(`: {
-			`),l("span",{class:"hljs-attr"},'"_eq"'),t(": "),l("span",{class:"hljs-string"},'"Recipe"'),t(`
-		}
-	}
-}
-`)])]),l("p",null,[t("the top level parent will be returned if "),l("em",null,"one of"),t(" the categories has the name "),l("code",{class:""},"Recipe"),t(". This behavior can be overridden by using the explicit "),l("code",{class:""},"_some"),t(" and "),l("code",{class:""},"_none"),t(" operators, for example:")]),l("pre",null,[l("code",{class:"language-json"},[t(`{
-	`),l("span",{class:"hljs-attr"},'"categories"'),t(`: {
-		`),l("span",{class:"hljs-attr"},'"_none"'),t(`: {
-			`),l("span",{class:"hljs-attr"},'"name"'),t(`: {
-				`),l("span",{class:"hljs-attr"},'"_eq"'),t(": "),l("span",{class:"hljs-string"},'"Recipe"'),t(`
-			}
-		}
-	}
-}
-`)])]),l("p",null,"will fetch all parent items that don\u2019t have the category \u201CRecipe\u201D"),l("h2",{id:"dynamic-variables"},[t("Dynamic Variables "),l("a",{class:"header-anchor",href:"#dynamic-variables"},"#")]),l("p",null,[t("In addition to static values, you can also filter against "),l("em",null,"dynamic"),t(" values using the following variables.")]),l("ul",null,[l("li",null,[l("code",{class:""},"$CURRENT_USER"),t(" \u2014 The primary key of the currently authenticated user")]),l("li",null,[l("code",{class:""},"$CURRENT_ROLE"),t(" \u2014 The primary key of the role for the currently authenticated user")]),l("li",null,[l("code",{class:""},"$NOW"),t(" \u2014 The current timestamp")]),l("li",null,[l("code",{class:""},"$NOW(<adjustment>)"),t(" - The current timestamp plus/minus a given distance, for example "),l("code",{class:""},"$NOW(-1 year)"),t(", "),l("code",{class:""},"$NOW(+2 hours)")])]),l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Nested User / Role variables in Permissions"),l("p",null,[t("When configuring permissions, "),l("code",{class:""},"$CURRENT_USER"),t(" and "),l("code",{class:""},"$CURRENT_ROLE"),t(" allow you to specify any (nested) field under the current user/role as well as the root ID. For example: "),l("code",{class:""},"$CURRENT_ROLE.name"),t(" or "),l("code",{class:""},"$CURRENT_USER.avatar.filesize"),t(". This includes custom fields that were added to the directus_users/directus_roles tables.")]),l("p",null,"Note: This feature is only available for permissions, validation, and presets. Regular filters and conditional fields currently only support the root ID.")])],-1),i={title:"Filter Rules",modularExtension:!1},d={name:"filter-rules",setup(h,{expose:s}){return s({frontmatter:{title:"Filter Rules",modularExtension:!1}}),(p,f)=>{const e=a("docswrapper");return r(),o(e,{frontmatter:i},{default:u(()=>[c]),_:1})}}};typeof n=="function"&&n(d);export{d as default,i as frontmatter};

package/dist/assets/filters.3db1b044.js

@@ -1 +0,0 @@
-import{a as l,o as c,b as d,w as o,g as e,e as i,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results, restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.")],-1),_=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filters-20220303A.webp",alt:"Filters"})],-1),p=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#how-it-works"},"How it Works")]),e("li",null,[e("a",{href:"#and%2For-groups"},"AND/OR Groups")]),e("li",null,[e("a",{href:"#dynamic-variables"},"Dynamic Variables")]),e("li",null,[e("a",{href:"#filtering-by-related-collections"},"Filtering by Related Collections")]),e("li",null,[e("a",{href:"#unfilterable-fields"},"Unfilterable Fields")]),e("li",null,[e("a",{href:"#extensibility-options"},"Extensibility Options")]),e("li",null,[e("a",{href:"#more-help"},"More Help")])])])],-1),f={class:"warning hint"},m=e("div",{class:"hint-title"},"There Are Two Filters Documents",-1),g=t("This page is a non-technical guide to using Filters. For more technical info, see "),y=t("Filter-Rules"),b=t("."),w=e("h2",{id:"how-it-works"},[t("How it Works "),e("a",{class:"header-anchor",href:"#how-it-works"},"#")],-1),v={class:"tip hint"},F=e("div",{class:"hint-title"},"Assumed Knowledge",-1),k=t("Filters are intuitive to use, but get quite nuanced as complexity increases. In order to use Filters effectively, you will need to understand the Field "),A=t("(aka "),C=t("data model"),x=t(")"),O=t(" being filtered as well as any relevant "),R=t("Users, Roles and Permissions"),D=t("."),N=t("A basic filter is composed of 3 parts: A "),G=e("strong",null,"Field",-1),I=t(" from the Collection being Filtered, a logical "),V=t("Operator"),E=t(", and some specified "),H=e("strong",null,"Value",-1),T=t(" to filter for within each Item\u2019s Field."),U=e("video",{title:"How Filters Work",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/how-filters-work-20220303A.mp4",type:"video/mp4"})],-1),W=e("ol",{start:"2"},[e("li",null,[t("Click "),e("span",{mi:"",icon:""},"filter_list"),t(" or "),e("strong",null,"\u201CAdd Filter\u201D"),t(".")]),e("li",null,"Select the Field to filter by."),e("li",null,"Select the Operator as desired."),e("li",null,"Define the Value to filter for.")],-1),S=e("p",null,[t("From here, you can set multiple Filters at once, filter by "),e("a",{href:"#filtering-by-related-collections"},"Fields in related Collections"),t(", set Values with "),e("a",{href:"#dynamic-variables"},"Dynamic Variables"),t(", as well as apply "),e("a",{href:"#and-or-groups"},"AND/OR Groups"),t(".")],-1),B={class:"tip hint"},$=e("div",{class:"hint-title"},"Operators",-1),j=t("The Field type will determine the kinds of Operators that can be used on it. In fact, some Fields cannot be filtered at all (read more in "),P=e("a",{href:"#unfilterable-fields"},"Unfilterable Fields",-1),q=t("). Once a Field is selected, the permitted operators will automatically display. An exhaustive list of Operators and what they do can be found in the more technical "),L=t("Filter Rules"),M=t(" document."),Y=e("h2",{id:"and%2For-groups"},[t("AND/OR Groups "),e("a",{class:"header-anchor",href:"#and%2For-groups"},"#")],-1),z=e("p",null,[e("code",{class:""},"AND"),t(" Groups give the option to filter for Items that meet "),e("em",null,"all of several criteria"),t(". On the other hand, "),e("code",{class:""},"OR"),t(" Groups filter for Items that meet "),e("em",null,"any one of several criteria"),t(".")],-1),K=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/and-or-groups-20220303A.webp",alt:"AND/OR Groups"})],-1),J=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click \u201CAnd/OR Group\u201D at the very top of the dropdown menu."),e("li",null,[t("Click the AND/OR text to toggle: "),e("ul",null,[e("li",null,[e("code",{class:""},"AND"),t(" \u2013 Selects Items that meet every single criteria.")]),e("li",null,[e("code",{class:""},"OR"),t(" \u2013 Selects Items that meet one of several criteria.")])])]),e("li",null,"Click \u201CAdd Filter\u201D again."),e("li",null,"Configure the Field, Operator, and Value as desired."),e("li",null,[t("Click and hold "),e("span",{mi:"",icon:""},"drag_indicator"),t(" to drag a Filter and nest it under an AND/OR Group.")])],-1),Q=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Why do we need AND Groups?"),e("p",null,[t("Filters actually default to "),e("code",{class:""},"AND"),t(" Group behavior automatically. However, when Filters are nested inside of an OR Group, they of course switch to "),e("code",{class:""},"OR"),t(" Group behavior. So an AND Group is necessary in cases where you want to meet multiple conditions inside of OR Groups.")])],-1),X=e("h2",{id:"dynamic-variables"},[t("Dynamic Variables "),e("a",{class:"header-anchor",href:"#dynamic-variables"},"#")],-1),Z=e("p",null,"The following video shows how to filter for Blog posts written within the past 60 days.",-1),ee=e("video",{title:"How Filters Work",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/dynamic-variables-20220307A.mp4",type:"video/mp4"})],-1),te=t("The following Dynamic Variables are built into Directus to make Filtering easier: "),oe=e("code",{class:""},"$CURRENT_USER",-1),se=t(", "),ie=e("code",{class:""},"$CURRENT_ROLE",-1),le=t(", "),ne=e("code",{class:""},"$NOW",-1),re=t(" and "),ae=e("code",{class:""},"$NOW(<adjustment>)",-1),ce=t(". For more information, please see the Dynamic Variables section in "),de=t("Filter Rules"),ue=t("."),he=e("h2",{id:"filtering-by-related-collections"},[t("Filtering by Related Collections "),e("a",{class:"header-anchor",href:"#filtering-by-related-collections"},"#")],-1),_e=e("p",null,[t("You may need to run filters on one Collection "),e("em",null,"based on information in another related Collection"),t(". Here are a few examples of when that might happen:")],-1),pe=e("ul",null,[e("li",null,[t("Book authors that also wrote screenplays (filters "),e("code",{class:""},"authors"),t(", uses "),e("code",{class:""},"screenplays"),t(").")]),e("li",null,[t("Products with a 5 star customer review (filters "),e("code",{class:""},"products"),t(", uses "),e("code",{class:""},"reviews"),t(").")]),e("li",null,[t("Accounts with active user login within the last 12 months (filters "),e("code",{class:""},"accounts"),t(", uses "),e("code",{class:""},"logins"),t(").")])],-1),fe=e("p",null,[t("This can span across any number of relationally linked Collections. For example, you could filter for customers that bought rock songs, where the "),e("code",{class:""},"customers"),t(" and "),e("code",{class:""},"genres"),t(" Collections are linked by "),e("code",{class:""},"customers"),t(" -> "),e("code",{class:""},"invoices"),t(" -> "),e("code",{class:""},"invoice-items"),t(" -> "),e("code",{class:""},"tracks"),t(" -> "),e("code",{class:""},"genres"),t(".")],-1),me=t("You will notice a "),ge=e("span",{mi:"",icon:""},"chevron_right",-1),ye=t(" icon beside relational Fields. When you click on any "),be=t("Alias"),we=t(" Field, all the Fields for that associated Collection pop down. If you select one of these Fields, you can run Filters on the current Collection by Field values in a related Collection."),ve=e("p",null,"Here are step-by-step instructions on how to filter by Fields in other Collections:",-1),Fe=e("video",{title:"How Filters Work",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filtering-by-related-collections-20220303A.mp4",type:"video/mp4"})],-1),ke=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click the desired relational Field. This will pop down and display the related Collection Fields."),e("li",null,"Select a Field from this related Collection."),e("li",null,"Set the Operator and Value as desired.")],-1),Ae=e("h2",{id:"unfilterable-fields"},[t("Unfilterable Fields "),e("a",{class:"header-anchor",href:"#unfilterable-fields"},"#")],-1),Ce=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/unfilterable-fields-20220303A.webp",alt:"Unfilterable Fields"})],-1),xe=e("p",null,[t("Not all Fields can be filtered. As seen above in "),e("a",{href:"#filtering-by-related-collections"},"Filtering by Related Collections"),t(", Alias Fields cannot be filtered; they instead provide a dropdown menu to access Fields from a related Collection. Additionally, the \u201CPresentation\u201D and \u201CGroup\u201D Fields cannot be filtered at all and will not appear as an option in Filters.")],-1),Oe=e("h2",{id:"extensibility-options"},[t("Extensibility Options "),e("a",{class:"header-anchor",href:"#extensibility-options"},"#")],-1),Re=e("p",null,"Directus Core is completely open-source, modular and extensible. Extensions allow you to expand or modify any part of Directus to fit your needs. Here are some great resources to get started down that track.",-1),De=t("Extensions > Introduction"),Ne=t("Extensions > Creating Extensions"),Ge=t("Contributing > Introduction"),Ie=t("Contributing > Codebase Overview"),Ve=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Accelerated Development"),e("p",null,[t("Working on an enterprise project and looking to outsource or financially sponsor the development of a Shares extension? Contact "),e("a",{href:"https://directus.io/contact/",target:"_blank",rel:"noopener noreferrer"},"our team")])],-1),Ee=e("h2",{id:"more-help"},[t("More Help "),e("a",{class:"header-anchor",href:"#more-help"},"#")],-1),He=e("p",null,[t("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),Te={title:"Filters",modularExtension:!1},Ue={name:"filters",setup(We,{expose:r}){return r({frontmatter:{title:"Filters",modularExtension:!1}}),(Se,Be)=>{const s=l("router-link"),a=l("docswrapper");return c(),d(a,{frontmatter:Te},{default:o(()=>[e("div",u,[h,_,p,e("div",f,[m,e("p",null,[g,i(s,{to:"/docs/configuration/filter-rules/"},{default:o(()=>[y]),_:1}),b])]),w,e("div",v,[F,e("p",null,[k,e("em",null,[A,i(s,{to:"/docs/configuration/data-model/"},{default:o(()=>[C]),_:1}),x]),O,i(s,{to:"/docs/configuration/users-roles-permissions.md"},{default:o(()=>[R]),_:1}),D])]),e("p",null,[N,G,I,i(s,{to:"/docs/configuration/filter-rules/#filter-operators"},{default:o(()=>[V]),_:1}),E,H,T]),U,W,S,e("div",B,[$,e("p",null,[j,P,q,i(s,{to:"/docs/configuration/filter-rules/#filter-operators"},{default:o(()=>[L]),_:1}),M])]),Y,z,K,J,Q,X,Z,ee,e("p",null,[te,oe,se,ie,le,ne,re,ae,ce,i(s,{to:"/docs/configuration/filter-rules/"},{default:o(()=>[de]),_:1}),ue]),he,_e,pe,fe,e("p",null,[me,ge,ye,i(s,{to:"/docs/getting-started/glossary/#alias"},{default:o(()=>[be]),_:1}),we]),ve,Fe,ke,Ae,Ce,xe,Oe,Re,e("ul",null,[e("li",null,[i(s,{to:"/docs/extensions/introduction/"},{default:o(()=>[De]),_:1})]),e("li",null,[i(s,{to:"/docs/extensions/creating-extensions/"},{default:o(()=>[Ne]),_:1})]),e("li",null,[i(s,{to:"/docs/contributing/introduction/"},{default:o(()=>[Ge]),_:1})]),e("li",null,[i(s,{to:"/docs/contributing/codebase-overview/"},{default:o(()=>[Ie]),_:1})])]),Ve,Ee,He])]),_:1})}}};typeof n=="function"&&n(Ue);export{Ue as default,Te as frontmatter};

package/dist/assets/folders.0024d3d3.js

@@ -1,132 +0,0 @@
-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."),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),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
-}
-`)])],-1),O=e("h5",{id:"example"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")],-1),M=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
-	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),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
-}
-`)])]),e("h5",{id:"example-3"},[s("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
-	folders_by_id(id: `),e("span",{class:"hljs-string"},'"fc02d733-95b8-4e27-bd4b-08a32cbe4e66"'),s(`) {
-		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",{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",{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
-}
-`)])]),e("h5",{id:"example-5"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	create_folders_item(data: { name: `),e("span",{class:"hljs-string"},'"Nature"'),s(` }) {
-		id
-		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",{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(`
-
-[
-	{
-		`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Nature"'),s(`
-	},
-	{
-		`),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",{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]
-}
-`)])]),e("h5",{id:"example-7"},[s("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	create_folders_items(data: [{ name: `),e("span",{class:"hljs-string"},'"Nature"'),s(" }, { name: "),e("span",{class:"hljs-string"},'"Cities"'),s(` }]) {
-		id
-		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"},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",{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
-}
-`)])]),e("h5",{id:"example-9"},[s("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	update_folders_item(
-		id: `),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(`
-		data: { parent: `),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(` }
-	) {
-		id
-		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),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(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"keys"'),s(": ["),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(", "),e("span",{class:"hljs-string"},'"a5bdb793-dd85-4ac9-882a-b42862092983"'),s(`],
-	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
-		`),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",{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]
-}
-`)])]),e("h5",{id:"example-11"},[s("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	update_folders_items(
-		ids: [`),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(", "),e("span",{class:"hljs-string"},'"a5bdb793-dd85-4ac9-882a-b42862092983"'),s(`]
-		data: { parent: `),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(` }
-	) {
-		id
-		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",{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
-}
-`)])]),e("h5",{id:"example-13"},[s("Example "),e("a",{class:"header-anchor",href:"#example-13"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	delete_folders_item(id: `),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(`) {
-		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",{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",{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
-}
-`)])]),e("h5",{id:"example-15"},[s("Example "),e("a",{class:"header-anchor",href:"#example-15"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	delete_folders_items(ids: [`),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(", "),e("span",{class:"hljs-string"},'"a5bdb793-dd85-4ac9-882a-b42862092983"'),s(`]) {
-		ids
-	}
-}
-`)])])])],-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};