@directus/app 9.13.0 → 9.14.0

package/dist/assets/permissions.7a7896f5.js

@@ -1,178 +0,0 @@
-import{a as r,o as c,b as h,w as t,g as s,e as a,B as e}from"./runtime-core.esm-bundler.e6808e6c.js";const d={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=e("Permissions are assigned to Roles, and control data access throughout the platform. "),m=e("Learn more about Permissions"),g=e("."),f=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-permission-object"},"The Permission Object")]),s("li",null,[s("a",{href:"#list-permissions"},"List Permissions")]),s("li",null,[s("a",{href:"#retrieve-a-permission"},"Retrieve a Permission")]),s("li",null,[s("a",{href:"#create-a-permission-rule"},"Create a Permission Rule")]),s("li",null,[s("a",{href:"#create-multiple-permission-rules"},"Create Multiple Permission Rules")]),s("li",null,[s("a",{href:"#update-permissions"},"Update Permissions")]),s("li",null,[s("a",{href:"#update-multiple-permissions"},"Update Multiple Permissions")]),s("li",null,[s("a",{href:"#delete-permissions"},"Delete Permissions")]),s("li",null,[s("a",{href:"#delete-multiple-permissions"},"Delete Multiple Permissions")])])])])],-1),j=s("hr",null,null,-1),y=s("h2",{id:"the-permission-object"},[e("The Permission Object "),s("a",{class:"header-anchor",href:"#the-permission-object"},"#")],-1),b={class:"two-up"},q={class:"left"},x={class:"definitions"},P=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the permission rule.")],-1),v=s("code",null,"role",-1),E=e(),R=s("strong",null,"many-to-one",-1),w=s("br",null,null,-1),T=e(" Role this permission applies to. Many-to-one to "),k=e("roles"),S=e(". "),A=s("code",null,"null",-1),D=e(" is used for public permissions."),C=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" Collection this permission rule applies to.")],-1),L=s("p",null,[s("code",null,"action"),e(),s("strong",null,"string"),s("br"),e(" What CRUD operation this permission rule applies to. One of "),s("code",null,"create"),e(", "),s("code",null,"read"),e(", "),s("code",null,"update"),e(", "),s("code",null,"delete"),e(".")],-1),Q=s("code",null,"permissions",-1),I=e(),M=s("strong",null,"object",-1),O=s("br",null,null,-1),G=e(" What rules the item must pass before the role is allowed to alter it. Follows "),B=e("the Filter Rules spec"),U=e("."),H=s("code",null,"validation",-1),F=e(),W=s("strong",null,"object",-1),N=s("br",null,null,-1),V=e(" What rules the provided values must pass before the role is allowed to submit them for insertion/update. Follows "),z=e("the Filter Rules spec"),J=e("."),K=s("p",null,[s("code",null,"preset"),e(),s("strong",null,"object"),s("br"),e(" Additional default values for the role.")],-1),X=s("p",null,[s("code",null,"fields"),e(),s("strong",null,"array"),s("br"),e(" What fields the user is allowed to alter.")],-1),Y=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
-	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-number"},"34"),e(`,
-	`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"pages"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"action"'),e(": "),s("span",{class:"hljs-string"},'"create"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"permissions"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"validation"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"title"'),e(`: {
-			`),s("span",{class:"hljs-attr"},'"_contains"'),e(": "),s("span",{class:"hljs-string"},'"Directus"'),e(`
-		}
-	},
-	`),s("span",{class:"hljs-attr"},'"presets"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"published"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`
-	},
-	`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"translations"'),e(`]
-}
-`)])])],-1),Z=s("hr",null,null,-1),$=s("h2",{id:"list-permissions"},[e("List Permissions "),s("a",{class:"header-anchor",href:"#list-permissions"},"#")],-1),ss=s("p",null,"List all permissions that exist in Directus.",-1),es={class:"two-up"},ts={class:"left"},ls=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"The data returned in this endpoint will be filtered based on the user\u2019s permissions. For example, permissions for a role other than the current user\u2019s role won\u2019t be returned.")],-1),as=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),ns=e("Supports all "),rs=e("global query parameters"),os=e("."),is=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),cs=e("An array of up to "),hs=e("limit"),ds=e(),ps=s("a",{href:"#the-permission-object"},"permission objects",-1),us=e(". If no items are available, data will be an empty array."),_s={class:"right"},ms=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),gs=s("pre",null,[s("code",null,`GET /permissions
-SEARCH /permissions
-`)],-1),fs=e("Learn more about SEARCH ->"),js=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),ys=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),bs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	permissions: directus_permissions
-}
-`)])],-1),qs=s("h5",{id:"example"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),xs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	permissions {
-		action
-		role
-		collection
-	}
-}
-`)])],-1),Ps=s("hr",null,null,-1),vs=s("h2",{id:"retrieve-a-permission"},[e("Retrieve a Permission "),s("a",{class:"header-anchor",href:"#retrieve-a-permission"},"#")],-1),Es=s("p",null,"List an existing permission by primary key.",-1),Rs={class:"two-up"},ws={class:"left"},Ts=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),ks=e("Supports all "),Ss=e("global query parameters"),As=e("."),Ds=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),Cs=s("p",null,[e("Returns the requested "),s("a",{href:"#the-permission-object"},"permission object"),e(".")],-1),Ls=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",null,`GET /permissions/:id
-`)]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// GET /permissions/34"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-number"},"34"),e(`,
-		`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"pages"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"action"'),e(": "),s("span",{class:"hljs-string"},'"create"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"permissions"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-		`),s("span",{class:"hljs-attr"},'"validation"'),e(`: {
-			`),s("span",{class:"hljs-attr"},'"title"'),e(`: {
-				`),s("span",{class:"hljs-attr"},'"_contains"'),e(": "),s("span",{class:"hljs-string"},'"Directus"'),e(`
-			}
-		},
-		`),s("span",{class:"hljs-attr"},'"presets"'),e(`: {
-			`),s("span",{class:"hljs-attr"},'"published"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`
-		},
-		`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"translations"'),e(`]
-	}
-}
-`)])]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	permissions_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_permissions
-}
-`)])]),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(` {
-	permissions_by_id(id: `),s("span",{class:"hljs-number"},"34"),e(`) {
-		role
-		collection
-		action
-	}
-}
-`)])])],-1),Qs=s("hr",null,null,-1),Is=s("h2",{id:"create-a-permission-rule"},[e("Create a Permission Rule "),s("a",{class:"header-anchor",href:"#create-a-permission-rule"},"#")],-1),Ms=s("p",null,"Create a new permission rule",-1),Os={class:"two-up"},Gs={class:"left"},Bs=s("h3",{id:"query-parameters-3"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Us=e("Supports all "),Hs=e("global query parameters"),Fs=e("."),Ws=s("h3",{id:"request-body"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ns=s("p",null,[e("A partial "),s("a",{href:"#the-permission-object"},"permissions object"),e(". "),s("code",null,"action"),e(" and "),s("code",null,"collection"),e(" are required.")],-1),Vs=s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),zs=s("p",null,[e("Returns the "),s("a",{href:"#the-permission-object"},"permission object"),e(" for the created permission.")],-1),Js=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",null,`POST /permissions
-`)]),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"},"// Request"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"pages"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"action"'),e(": "),s("span",{class:"hljs-string"},'"read"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(`]
-}
-`)])]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",null,`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_permissions_item(data: create_directus_permissions_input!): directus_permissions
-}
-`)])]),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_permissions_item(
-		data: { collection: `),s("span",{class:"hljs-string"},'"pages"'),e(", action: "),s("span",{class:"hljs-string"},'"read"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", fields: ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(`] }
-	) {
-		id
-		collection
-		action
-	}
-}
-`)])])],-1),Ks=s("hr",null,null,-1),Xs=s("h2",{id:"create-multiple-permission-rules"},[e("Create Multiple Permission Rules "),s("a",{class:"header-anchor",href:"#create-multiple-permission-rules"},"#")],-1),Ys=s("p",null,"Create multiple new permission rules",-1),Zs={class:"two-up"},$s={class:"left"},se=s("h3",{id:"query-parameters-4"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),ee=e("Supports all "),te=e("global query parameters"),le=e("."),ae=s("h3",{id:"request-body-2"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),ne=s("p",null,[e("An array of partial "),s("a",{href:"#the-permission-object"},"permissions objects"),e(". "),s("code",null,"action"),e(" and "),s("code",null,"collection"),e(" are required.")],-1),re=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),oe=s("p",null,[e("Returns the "),s("a",{href:"#the-permission-object"},"permission objects"),e(" for the created permissions.")],-1),ie=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",null,`POST /permissions
-`)]),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"},"// Request"),e(`
-
-[
-	{
-		`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"pages"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"action"'),e(": "),s("span",{class:"hljs-string"},'"read"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(`]
-	},
-	{
-		`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"pages"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"action"'),e(": "),s("span",{class:"hljs-string"},'"create"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(`]
-	}
-]
-`)])]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",null,`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_permissions_items(data: [create_directus_permissions_input!]!): [directus_permissions]
-}
-`)])]),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_permissions_items(
-		data: [
-			{ collection: `),s("span",{class:"hljs-string"},'"pages"'),e(", action: "),s("span",{class:"hljs-string"},'"read"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", fields: ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(`] }
-			{ collection: `),s("span",{class:"hljs-string"},'"pages"'),e(", action: "),s("span",{class:"hljs-string"},'"create"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", fields: ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(`] }
-		]
-	) {
-		id
-		collection
-		action
-	}
-}
-`)])])],-1),ce=s("hr",null,null,-1),he=s("h2",{id:"update-permissions"},[e("Update Permissions "),s("a",{class:"header-anchor",href:"#update-permissions"},"#")],-1),de=s("p",null,"Update an existing permissions rule.",-1),pe={class:"two-up"},ue={class:"left"},_e=s("h3",{id:"query-parameters-5"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),me=e("Supports all "),ge=e("global query parameters"),fe=e("."),je=s("h3",{id:"request-body-3"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),ye=s("p",null,[e("A partial "),s("a",{href:"#the-permission-object"},"permissions object"),e(".")],-1),be=s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),qe=s("p",null,[e("Returns the "),s("a",{href:"#the-permission-object"},"permission object"),e(" for the updated permission.")],-1),xe=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",null,`PATCH /permissions/: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 /permissions/34"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"body"'),e(`]
-}
-`)])]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",null,`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_permissions_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_permissions_input!): directus_permissions
-}
-`)])]),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_permissions_item(id: `),s("span",{class:"hljs-number"},"34"),e(", data: { fields: ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"body"'),e(`] }) {
-		id
-		action
-		collection
-	}
-}
-`)])])],-1),Pe=s("hr",null,null,-1),ve=s("h2",{id:"update-multiple-permissions"},[e("Update Multiple Permissions "),s("a",{class:"header-anchor",href:"#update-multiple-permissions"},"#")],-1),Ee=s("p",null,"Update multiple existing permissions rules.",-1),Re={class:"two-up"},we={class:"left"},Te=s("h3",{id:"query-parameters-6"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),ke=e("Supports all "),Se=e("global query parameters"),Ae=e("."),De=s("h3",{id:"request-body-4"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Ce=s("h3",{id:"request-body-5"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")],-1),Le=s("div",{class:"definitions"},[s("p",null,[s("code",null,"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the permissions you\u2019d like to update.")]),s("p",null,[s("code",null,"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-permission-object"},"the permission object"),e("\u2019s properties.")])],-1),Qe=s("h3",{id:"returns-6"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Ie=s("p",null,[e("Returns the "),s("a",{href:"#the-permission-object"},"permission object"),e(" for the updated permissions.")],-1),Me=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",null,`PATCH /permissions
-`)]),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 /permissions"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"keys"'),e(": ["),s("span",{class:"hljs-number"},"34"),e(", "),s("span",{class:"hljs-number"},"65"),e(`],
-	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"body"'),e(`]
-	}
-}
-`)])]),s("h3",{id:"graphql-6"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",null,`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_permissions_items(id: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_permissions_input!): [directus_permissions]
-}
-`)])]),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_permissions_items(ids: [`),s("span",{class:"hljs-number"},"34"),e(", "),s("span",{class:"hljs-number"},"64"),e("], data: { fields: ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"body"'),e(`] }) {
-		id
-		action
-		collection
-	}
-}
-`)])])],-1),Oe=s("hr",null,null,-1),Ge=s("h2",{id:"delete-permissions"},[e("Delete Permissions "),s("a",{class:"header-anchor",href:"#delete-permissions"},"#")],-1),Be=s("p",null,"Delete an existing permissions rule",-1),Ue=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",null,`DELETE /permissions/:id
-`)]),s("h5",{id:"example-12"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",null,`DELETE /permissions/34
-`)]),s("h3",{id:"graphql-7"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",null,`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_permissions_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_permissions_item(id: `),s("span",{class:"hljs-number"},"34"),e(`) {
-		id
-	}
-}
-`)])])])],-1),He=s("hr",null,null,-1),Fe=s("h2",{id:"delete-multiple-permissions"},[e("Delete Multiple Permissions "),s("a",{class:"header-anchor",href:"#delete-multiple-permissions"},"#")],-1),We=s("p",null,"Delete multiple existing permissions rules",-1),Ne=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,"An array of permission 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",null,`DELETE /permissions
-`)]),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 /permissions"),e(`
-
-[`),s("span",{class:"hljs-number"},"34"),e(", "),s("span",{class:"hljs-number"},"64"),e(`]
-`)])]),s("h3",{id:"graphql-8"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-8"},"#")]),s("pre",null,[s("code",null,`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_permissions_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_permissions_items(ids: [`),s("span",{class:"hljs-number"},"34"),e(", "),s("span",{class:"hljs-number"},"64"),e(`]) {
-		ids
-	}
-}
-`)])])])],-1),Ve=s("hr",null,null,-1),Ye="Permissions",Ze=!1,$e="page-reference",st={name:"permissions",setup(ze,{expose:o}){const n={title:"Permissions",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:n}),(Je,Ke)=>{const l=r("router-link"),i=r("docs-wrapper");return c(),h(i,{frontmatter:n},{default:t(()=>[s("div",d,[s("div",p,[s("div",u,[s("blockquote",null,[s("p",null,[_,a(l,{to:"/docs/getting-started/glossary/#permissions"},{default:t(()=>[m]),_:1}),g])])]),f]),j,y,s("div",b,[s("div",q,[s("div",x,[P,s("p",null,[v,E,R,w,T,a(l,{to:"/docs/reference/system/roles/"},{default:t(()=>[k]),_:1}),S,A,D]),C,L,s("p",null,[Q,I,M,O,G,a(l,{to:"/docs/reference/filter-rules"},{default:t(()=>[B]),_:1}),U]),s("p",null,[H,F,W,N,V,a(l,{to:"/docs/reference/filter-rules"},{default:t(()=>[z]),_:1}),J]),K,X])]),Y]),Z,$,ss,s("div",es,[s("div",ts,[ls,as,s("p",null,[ns,a(l,{to:"/docs/reference/query"},{default:t(()=>[rs]),_:1}),os]),is,s("p",null,[cs,a(l,{to:"/docs/reference/query/#limit"},{default:t(()=>[hs]),_:1}),ds,ps,us])]),s("div",_s,[ms,gs,s("p",null,[a(l,{to:"/docs/reference/introduction/#search-http-method"},{default:t(()=>[fs]),_:1})]),js,ys,bs,qs,xs])]),Ps,vs,Es,s("div",Rs,[s("div",ws,[Ts,s("p",null,[ks,a(l,{to:"/docs/reference/query"},{default:t(()=>[Ss]),_:1}),As]),Ds,Cs]),Ls]),Qs,Is,Ms,s("div",Os,[s("div",Gs,[Bs,s("p",null,[Us,a(l,{to:"/docs/reference/query"},{default:t(()=>[Hs]),_:1}),Fs]),Ws,Ns,Vs,zs]),Js]),Ks,Xs,Ys,s("div",Zs,[s("div",$s,[se,s("p",null,[ee,a(l,{to:"/docs/reference/query"},{default:t(()=>[te]),_:1}),le]),ae,ne,re,oe]),ie]),ce,he,de,s("div",pe,[s("div",ue,[_e,s("p",null,[me,a(l,{to:"/docs/reference/query"},{default:t(()=>[ge]),_:1}),fe]),je,ye,be,qe]),xe]),Pe,ve,Ee,s("div",Re,[s("div",we,[Te,s("p",null,[ke,a(l,{to:"/docs/reference/query"},{default:t(()=>[Se]),_:1}),Ae]),De,Ce,Le,Qe,Ie]),Me]),Oe,Ge,Be,Ue,He,Fe,We,Ne,Ve])]),_:1})}}};export{st as default,Ze as modularExtension,$e as pageClass,Ye as title};

package/dist/assets/plesk.e70d310e.js

@@ -1,27 +0,0 @@
-import{a,o as c,b as d,w as s,g as e,e as i,B as t}from"./runtime-core.esm-bundler.e6808e6c.js";var h="assets/plesk-screenshot.00f26a33.png";const u={class:"markdown-body"},p=e("p",null,[t("On many shared hosts you are not allowed to directly invoke node commands but you have to use the Plesk configuration panel instead. Unfortunately, Plesk does not allow the interactive execution of node scripts. Therefore we can\u2019t use Directus\u2019 "),e("code",null,"init"),t(" script and have to set up the project by our own.")],-1),_=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Successful tests"),e("p",null,"This approach has successfully been tested with a webhosting offer from netcup.")],-1),f=e("h2",{id:"installation"},[t("Installation "),e("a",{class:"header-anchor",href:"#installation"},"#")],-1),g=e("h3",{id:"1.-setup-database"},[t("1. Setup database "),e("a",{class:"header-anchor",href:"#1.-setup-database"},"#")],-1),m=e("p",null,"First, make sure that you\u2019ve already created a database and a user for it. We will use MySQL in this guide. If you plan to use SQLite you can ignore this step.",-1),y=e("h3",{id:"2.-setup-a-project-folder"},[t("2. Setup a project folder "),e("a",{class:"header-anchor",href:"#2.-setup-a-project-folder"},"#")],-1),b=e("p",null,"Next you will need to create a project folder, we will be adding 4 files to this folder.",-1),w=e("h3",{id:"3.-add-.env-file"},[t("3. Add .env file "),e("a",{class:"header-anchor",href:"#3.-add-.env-file"},"#")],-1),v=t("This file is used to configure Directus. Normally, the "),k=e("code",null,"init",-1),j=t(" script would create it for us. So now we have to do it manually. You can just copy it from another Directus installation or add the relevant variables using this help page: "),x=t("Environment Variables"),A=t(")."),P=e("p",null,"If you have not already a user in the database make sure to add a first user by adding the following two lines so that you can later login to Directus.",-1),D=e("pre",null,[e("code",null,`ADMIN_EMAIL="admin@example.com"
-ADMIN_PASSWORD="password"
-`)],-1),S=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Choosing a Port"),e("p",null,[t("Since Plesk uses the "),e("a",{href:"https://www.phusionpassenger.com/",target:"_blank",rel:"noopener noreferrer"},"Phusion Passenger"),t(" application server to serve Node.js apps you do not need to worry about choosing a specific port. Just use an arbitrary number. To quote the Passenger docs:")]),e("blockquote",null,[e("p",null,"When run in Passenger, the port number that you pass to listen() is irrelevant and has no effect. Passenger always makes the app listen on a random Unix domain socket.")])],-1),I=e("h3",{id:"4.-add-package.json"},[t("4. Add package.json "),e("a",{class:"header-anchor",href:"#4.-add-package.json"},"#")],-1),T=e("p",null,[t("Add Directus and your database connector as a dependency. To execute Directus\u2019 "),e("code",null,"bootstrap"),t(" command you also have to add a script entry for it.")],-1),N=e("pre",null,[e("code",{class:"language-json"},[t(`{
-	`),e("span",{class:"hljs-attr"},'"scripts"'),t(`: {
-		`),e("span",{class:"hljs-attr"},'"bootstrap"'),t(": "),e("span",{class:"hljs-string"},'"directus bootstrap"'),t(`
-	},
-	`),e("span",{class:"hljs-attr"},'"dependencies"'),t(`: {
-		`),e("span",{class:"hljs-attr"},'"directus"'),t(": "),e("span",{class:"hljs-string"},'"*"'),t(`,
-		`),e("span",{class:"hljs-attr"},'"mysql"'),t(": "),e("span",{class:"hljs-string"},'"^2.18.1"'),t(`
-	}
-}
-`)])],-1),C=e("h3",{id:"5.-add-application-startup-file-index.js"},[t("5. Add application startup file index.js "),e("a",{class:"header-anchor",href:"#5.-add-application-startup-file-index.js"},"#")],-1),q=e("p",null,[t("Instead of a start command, Plesk wants a startup file. So create a "),e("code",null,"index.js"),t(" with the following content:")],-1),B=e("pre",null,[e("code",{class:"language-js"},[e("span",{class:"hljs-keyword"},"var"),t(" { startServer } = "),e("span",{class:"hljs-built_in"},"require"),t("("),e("span",{class:"hljs-string"},"'directus/server'"),t(`);
-
-startServer();
-`)])],-1),E=e("h3",{id:"6.-add-.npmrc"},[t("6. Add .npmrc "),e("a",{class:"header-anchor",href:"#6.-add-.npmrc"},"#")],-1),L=e("p",null,[t("We need to make a small configuration for npm by creating a "),e("code",null,".npmrc"),t(" file with the following content:")],-1),M=e("pre",null,[e("code",null,`scripts-prepend-node-path=true
-`)],-1),Y=e("h3",{id:"7.-add-document_root-folder"},[t("7. Add document_root folder "),e("a",{class:"header-anchor",href:"#7.-add-document_root-folder"},"#")],-1),V=e("p",null,[t("Lastly, we need to add a "),e("code",null,"document_root"),t(" folder inside our project-directory.")],-1),W=e("p",null,"It\u2019s required by plesk that the document root must be a subdirectory of the application root directory. The folder can stay empty.",-1),O=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Store `document_root` in a version control"),e("p",null,[t("If you want to keep the folder in in a version control like git, create a empty "),e("code",null,".gitignore"),t(" file inside the folder.")])],-1),U=e("h3",{id:"8.-activate-and-configure-node.js"},[t("8. Activate and configure node.js "),e("a",{class:"header-anchor",href:"#8.-activate-and-configure-node.js"},"#")],-1),F=e("p",null,"In Plesk, choose your website and click \u201CNode.js\u201D. You should then see a button \u201CEnable Node.js\u201D and click on it.",-1),H=e("p",null,[t("Now, change the \u201CDocument root\u201D and \u201CApplication root\u201D to the location of your project folder. \u201CApplication startup file\u201D must point to the "),e("code",null,"index.js"),t(" file from the former step. The screen should now look like this:")],-1),Q=e("p",null,[e("img",{src:h,alt:"Plesk Screenshot"})],-1),R=e("p",null,"You can now install the dependencies by clicking on the button \u201CNPM install\u201D.",-1),J=e("h3",{id:"9.-bootstrap-directus"},[t("9. Bootstrap Directus "),e("a",{class:"header-anchor",href:"#9.-bootstrap-directus"},"#")],-1),$=e("p",null,[t("To set up the database tables (and the first user) for Directus, click on the button \u201CRun script\u201D and input "),e("code",null,"bootstrap"),t(". You get the console output after the script has run through.")],-1),z=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Current Issue of Argon2"),e("p",null,"You may run into an error of argon2 telling you that glibc is missing. If that\u2019s the case try adding and running this script entry to your package.json:"),e("pre",null,[e("code",{class:"language-json"},`    "scripts" {
-        "argon2-rebuild": "npm rebuild argon2 --build-from-source",
-        <...>
-    }
-
-`)]),e("p",null,[t("Afterwards try "),e("code",null,"bootstrap"),t(" again.")])],-1),G=e("h3",{id:"10.-clean-up-.env-file"},[t("10. Clean up .env file "),e("a",{class:"header-anchor",href:"#10.-clean-up-.env-file"},"#")],-1),K=e("p",null,"It is good security practice not to leave emails and passwords stored in plain text, so if you had to create login details through the .env file you should now remove those details from the file.",-1),X=e("h3",{id:"11.-test-directus-access"},[t("11. Test Directus Access "),e("a",{class:"header-anchor",href:"#11.-test-directus-access"},"#")],-1),Z=e("p",null,"The Directus app should now work under your configured url. If not, try changing the application mode and wait a couple of seconds.",-1),ee=e("h2",{id:"using-snapshots"},[t("Using snapshots "),e("a",{class:"header-anchor",href:"#using-snapshots"},"#")],-1),te=t("On Plesk you can\u2019t directly run an npx command. To use the Directus snapshot feature, you\u2019d need to add a script to your "),se=e("code",null,"package.json",-1),oe=t(". For snapshot creation you can find an example in the "),ne=t("CLI docs: Date-based snapshots"),ae=e("p",null,"To apply a snapshot you need a custom wrapper using the non-interactive version:",-1),ie=e("pre",null,[e("code",{class:"language-json"},`    "scripts" {
-    	"apply-snapshot--noninteractive": "npx directus schema apply --yes ./snapshots/\\"$npm_config_filename\\"",
-        <...>
-    }
-
-`)],-1),re=e("p",null,"After that you can apply a snapshot by entering the following command to plesk:",-1),le=e("pre",null,[e("code",{class:"language-sh"},`apply-snapshot--noninteractive --filename=[file.yaml]
-`)],-1),pe="Shared Hosting with Plesk",_e=!1,fe={name:"plesk",setup(ce,{expose:r}){const o={title:"Shared Hosting with Plesk",modularExtension:!1};return r({frontmatter:o}),(de,he)=>{const n=a("router-link"),l=a("docs-wrapper");return c(),d(l,{frontmatter:o},{default:s(()=>[e("div",u,[p,_,f,g,m,y,b,w,e("p",null,[v,k,j,i(n,{to:"/docs/self-hosted/config-options/"},{default:s(()=>[x]),_:1}),A]),P,D,S,I,T,N,C,q,B,E,L,M,Y,V,W,O,U,F,H,Q,R,J,$,z,G,K,X,Z,ee,e("p",null,[te,se,oe,i(n,{to:"/docs/self-hosted/installation/plesk#snapshot-the-data-model"},{default:s(()=>[ne]),_:1})]),ae,ie,re,le])]),_:1})}}};export{fe as default,_e as modularExtension,pe as title};

package/dist/assets/presets-bookmarks.03f2cacf.js

@@ -1 +0,0 @@
-import{a as n,o as c,b as u,w as o,g as e,e as i,B as t}from"./runtime-core.esm-bundler.e6808e6c.js";const d={class:"markdown-body"},h=t("Presets store the state of a Collection Detail page. They can be used to set layout defaults or define bookmarks to specific datasets. "),p=t("Learn more about Presets"),_=t("."),f=e("h2",{id:"creating-a-preset"},[t("Creating a Preset "),e("a",{class:"header-anchor",href:"#creating-a-preset"},"#")],-1),g=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,[t("Settings "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),t(" Presets & Bookmarks")])]),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"add"),t(" in the header")]),e("li",null,[t("Complete the "),e("strong",null,"other preset form fields"),t(" outlined below")])],-1),m=e("ul",null,[e("li",null,[e("strong",null,"Collection"),t(" \u2014 The collection of this preset; supports any project collection, Directus Files, or Directus Users")]),e("li",null,[e("strong",null,"Scope"),t(" \u2014 The users that will have access to this preset, either Global, a specific Role, or an individual User")]),e("li",null,[e("strong",null,"Layout"),t(" \u2014 The collection detail\u2019s layout this preset applies to")]),e("li",null,[e("strong",null,"Name"),t(" \u2014 If left blank, this preset will act as a Default for the collection/layout; if given a name, it will be shown as a bookmark")])],-1),k=e("p",null,[t("After you have completed the form, the layout preview will be populated with live data. "),e("strong",null,"You can now tailor the layout as desired by updating the preview or the filter component in the page sidebar.")],-1),v=e("p",null,"Each preset saves all of the information needed to recreate a view of the collection/layout, including:",-1),b=e("ul",null,[e("li",null,[e("strong",null,"Collection"),t(" \u2014 The collection of the preset")]),e("li",null,[e("strong",null,"Layout"),t(" \u2014 The Layout the preset applies to")]),e("li",null,[e("strong",null,"Layout Query"),t(" \u2014 Order direction, order field, pagination, etc")]),e("li",null,[e("strong",null,"Layout Options"),t(" \u2014 The configuration of all layout options")]),e("li",null,[e("strong",null,"Search"),t(" \u2014 Any full-text search query applied")]),e("li",null,[e("strong",null,"Filters"),t(" \u2014 Any advanced filters applied")]),e("li",null,[e("strong",null,"User"),t(" \u2014 Optional; scopes to a specific user")]),e("li",null,[e("strong",null,"Role"),t(" \u2014 Optional; scopes to a specific role")]),e("li",null,[e("strong",null,"Bookmark Name"),t(" \u2014 Optional; determines if the preset is a bookmark")])],-1),y={class:"tip hint"},w=e("div",{class:"hint-title"},"Defaults vs Bookmarks",-1),C=t("It\u2019s important to be aware of the difference between a collection\u2019s "),D=e("em",null,"defaults",-1),P=t(" and its "),T=e("em",null,"bookmarks",-1),B=t(", both of which are configured by presets. A "),x=e("em",null,"default",-1),N=t(" is how a user will initially view the collection detail without any further customization, while a "),L=e("em",null,"bookmark",-1),O=t(" is a named dataset that can be recalled at any point via the "),A=t("navigation bar"),S=t("."),U=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"System Defaults"),e("p",null,"You can also adjust the defaults and bookmarks for the Directus Activity, Directus Files, and Directus Users collections.")],-1),I=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Order of Defaults"),e("p",null,"Multiple defaults can be configured for a user, either for different layouts of even the same layout. In this case, the preset priority is: User, then Role, then Global.")],-1),E=e("h2",{id:"deleting-a-preset"},[t("Deleting a Preset "),e("a",{class:"header-anchor",href:"#deleting-a-preset"},"#")],-1),F=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,[t("Settings "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),t(" Presets & Bookmarks "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),t(" [Preset]")])]),e("li",null,[t("Click "),e("span",{mi:"",btn:"",dngr:""},"delete"),t(" in the header")]),e("li",null,[t("Confirm this decision by clicking "),e("strong",null,"Delete"),t(" in the dialog")])],-1),R=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"This action is permanent and can not be undone. Please proceed with caution.")],-1),Y="Collection Presets",z=!1,M={name:"presets-bookmarks",setup(V,{expose:a}){const l={title:"Collection Presets",modularExtension:!1};return a({frontmatter:l}),(j,q)=>{const s=n("router-link"),r=n("docs-wrapper");return c(),u(r,{frontmatter:l},{default:o(()=>[e("div",d,[e("blockquote",null,[e("p",null,[h,i(s,{to:"/docs/getting-started/glossary/#presets"},{default:o(()=>[p]),_:1}),_])]),f,g,m,k,v,b,e("div",y,[w,e("p",null,[C,D,P,T,B,x,N,L,O,i(s,{to:"/docs/app/overview/#_2-navigation-bar"},{default:o(()=>[A]),_:1}),S])]),U,I,E,F,R])]),_:1})}}};export{M as default,z as modularExtension,Y as title};

package/dist/assets/presets.78562380.js

@@ -1,164 +0,0 @@
-import{a as n,o as c,b as p,w as t,g as s,e as l,B as e}from"./runtime-core.esm-bundler.e6808e6c.js";const d={class:"markdown-body"},i={class:"two-up"},u={class:"left"},_=e("Presets hold the preferences of individual users of the platform. This allows Directus to show and maintain custom item listings and bookmarks for users of the app. "),m=e("Learn more about Presets"),g=e("."),f=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-preset-object"},"The Preset Object")]),s("li",null,[s("a",{href:"#list-presets"},"List Presets")]),s("li",null,[s("a",{href:"#retrieve-a-preset"},"Retrieve a preset")]),s("li",null,[s("a",{href:"#create-a-preset"},"Create a Preset")]),s("li",null,[s("a",{href:"#create-multiple-presets"},"Create Multiple Presets")]),s("li",null,[s("a",{href:"#update-a-preset"},"Update a Preset")]),s("li",null,[s("a",{href:"#update-multiple-presets"},"Update Multiple Presets")]),s("li",null,[s("a",{href:"#delete-a-preset"},"Delete a Preset")]),s("li",null,[s("a",{href:"#delete-multiple-presets"},"Delete Multiple Presets")])])])])],-1),j=s("hr",null,null,-1),y=s("h2",{id:"the-preset-object"},[e("The Preset Object "),s("a",{class:"header-anchor",href:"#the-preset-object"},"#")],-1),b={class:"two-up"},q={class:"left"},x={class:"definitions"},P=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the preset.")],-1),v=s("p",null,[s("code",null,"bookmark"),e(),s("strong",null,"string"),s("br"),e(" The title of the bookmark. If this value is "),s("code",null,"null"),e(", it\u2019s considered a preset instead of a bookmark.")],-1),E=s("code",null,"user",-1),T=e(),k=s("strong",null,"many-to-one",-1),w=s("br",null,null,-1),R=e(" User this preset applies to. Many-to-one to "),S=e("users"),A=e("."),D=s("code",null,"role",-1),L=e(),C=s("strong",null,"many-to-one",-1),Q=s("br",null,null,-1),I=e(" Role this preset applies to. Many-to-one to "),M=e("users"),O=e("."),G=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" Collection this preset applies to.")],-1),B=s("p",null,[s("code",null,"search"),e(),s("strong",null,"string"),s("br"),e(" The search query used in the preset.")],-1),U=s("p",null,[s("code",null,"filters"),e(),s("strong",null,"array"),s("br"),e(" The filters used in the preset.")],-1),H=s("p",null,[s("code",null,"layout"),e(),s("strong",null,"string"),s("br"),e(" The layout used in this preset.")],-1),N=s("p",null,[s("code",null,"layout_query"),e(),s("strong",null,"object"),s("br"),e(" The item query used by the layout. This structure is based on the used layout.")],-1),V=s("p",null,[s("code",null,"layout_options"),e(),s("strong",null,"object"),s("br"),e(" The options used by the layout. This structure is based on the used layout.")],-1),F=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
-	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-number"},"39"),e(`,
-	`),s("span",{class:"hljs-attr"},'"bookmark"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"user"'),e(": "),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"directus_activity"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"search"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"filters"'),e(`: [],
-	`),s("span",{class:"hljs-attr"},'"layout"'),e(": "),s("span",{class:"hljs-string"},'"tabular"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"layout_query"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"tabular"'),e(`: {
-			`),s("span",{class:"hljs-attr"},'"sort"'),e(": "),s("span",{class:"hljs-string"},'"-timestamp"'),e(`,
-			`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"action"'),e(", "),s("span",{class:"hljs-string"},'"collection"'),e(", "),s("span",{class:"hljs-string"},'"timestamp"'),e(", "),s("span",{class:"hljs-string"},'"user"'),e(`],
-			`),s("span",{class:"hljs-attr"},'"page"'),e(": "),s("span",{class:"hljs-number"},"1"),e(`
-		}
-	},
-	`),s("span",{class:"hljs-attr"},'"layout_options"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"tabular"'),e(`: {
-			`),s("span",{class:"hljs-attr"},'"widths"'),e(`: {
-				`),s("span",{class:"hljs-attr"},'"action"'),e(": "),s("span",{class:"hljs-number"},"100"),e(`,
-				`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-number"},"210"),e(`,
-				`),s("span",{class:"hljs-attr"},'"timestamp"'),e(": "),s("span",{class:"hljs-number"},"240"),e(`,
-				`),s("span",{class:"hljs-attr"},'"user"'),e(": "),s("span",{class:"hljs-number"},"240"),e(`
-			}
-		}
-	}
-}
-`)])])],-1),z=s("hr",null,null,-1),J=s("h2",{id:"list-presets"},[e("List Presets "),s("a",{class:"header-anchor",href:"#list-presets"},"#")],-1),K=s("p",null,"List all presets that exist in Directus.",-1),W={class:"two-up"},X={class:"left"},Y=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"The data returned in this endpoint will be filtered based on the user\u2019s permissions. For example, presets for a role other than the current user\u2019s role won\u2019t be returned.")],-1),Z=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),$=e("Supports all "),ss=e("global query parameters"),es=e("."),ts=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),as=e("An array of up to "),ls=e("limit"),rs=e(),ns=s("a",{href:"#the-preset-object"},"preset objects",-1),os=e(". If no items are available, data will be an empty array."),hs={class:"right"},cs=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),ps=s("pre",null,[s("code",null,`GET /presets
-SEARCH /presets
-`)],-1),ds=e("Learn more about SEARCH ->"),is=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),us=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),_s=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	presets: [directus_presets]
-}
-`)])],-1),ms=s("h5",{id:"example"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),gs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	presets {
-		id
-		user
-	}
-}
-`)])],-1),fs=s("hr",null,null,-1),js=s("h2",{id:"retrieve-a-preset"},[e("Retrieve a preset "),s("a",{class:"header-anchor",href:"#retrieve-a-preset"},"#")],-1),ys=s("p",null,"List an existing preset by primary key.",-1),bs={class:"two-up"},qs={class:"left"},xs=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Ps=e("Supports all "),vs=e("global query parameters"),Es=e("."),Ts=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ks=s("p",null,[e("Returns the requested "),s("a",{href:"#the-preset-object"},"preset object"),e(".")],-1),ws=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",null,`GET /presets/:id
-`)]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",null,`GET /presets/42
-`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	presets_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_presets
-}
-`)])]),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(` {
-	presets_by_id(id: `),s("span",{class:"hljs-number"},"42"),e(`) {
-		id
-		user
-	}
-}
-`)])])],-1),Rs=s("hr",null,null,-1),Ss=s("h2",{id:"create-a-preset"},[e("Create a Preset "),s("a",{class:"header-anchor",href:"#create-a-preset"},"#")],-1),As=s("p",null,"Create a new preset.",-1),Ds={class:"two-up"},Ls={class:"left"},Cs=s("h3",{id:"query-parameters-3"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Qs=e("Supports all "),Is=e("global query parameters"),Ms=e("."),Os=s("h3",{id:"request-body"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Gs=s("p",null,[e("A partial "),s("a",{href:"#the-preset-object"},"preset object"),e(".")],-1),Bs=s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Us=s("p",null,[e("Returns the "),s("a",{href:"#the-preset-object"},"preset object"),e(" for the created preset.")],-1),Hs=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",null,`POST /presets
-`)]),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 /presets"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"user"'),e(": "),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"layout"'),e(": "),s("span",{class:"hljs-string"},'"cards"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"search"'),e(": "),s("span",{class:"hljs-string"},'"Directus"'),e(`
-}
-`)])]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",null,`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_presets_item(data: create_directus_presets_input!): directus_presets
-}
-`)])]),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_presets_item(data: { user: `),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),e(", layout: "),s("span",{class:"hljs-string"},'"cards"'),e(", search: "),s("span",{class:"hljs-string"},'"Directus"'),e(` }) {
-		id
-		user
-	}
-}
-`)])])],-1),Ns=s("hr",null,null,-1),Vs=s("h2",{id:"create-multiple-presets"},[e("Create Multiple Presets "),s("a",{class:"header-anchor",href:"#create-multiple-presets"},"#")],-1),Fs=s("p",null,"Create multiple new presets.",-1),zs={class:"two-up"},Js={class:"left"},Ks=s("h3",{id:"query-parameters-4"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Ws=e("Supports all "),Xs=e("global query parameters"),Ys=e("."),Zs=s("h3",{id:"request-body-2"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),$s=s("p",null,[e("An array of partial "),s("a",{href:"#the-preset-object"},"preset objects"),e(".")],-1),se=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),ee=s("p",null,[e("Returns the "),s("a",{href:"#the-preset-object"},"preset object"),e(" for the created preset.")],-1),te=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",null,`POST /presets
-`)]),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 /presets"),e(`
-
-[
-	{
-		`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"directus_files"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"user"'),e(": "),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"layout"'),e(": "),s("span",{class:"hljs-string"},'"cards"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"search"'),e(": "),s("span",{class:"hljs-string"},'"Directus"'),e(`
-	},
-	{
-		`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"articles"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"user"'),e(": "),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"layout"'),e(": "),s("span",{class:"hljs-string"},'"tabular"'),e(`
-	}
-]
-`)])]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",null,`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_presets_items(data: [create_directus_presets_input!]!): [directus_presets]
-}
-`)])]),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_presets_items(
-		data: [
-			{
-				collection: `),s("span",{class:"hljs-string"},'"directus_files"'),e(`
-				user: `),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),e(`
-				layout: `),s("span",{class:"hljs-string"},'"cards"'),e(`
-				search: `),s("span",{class:"hljs-string"},'"Directus"'),e(`
-			}
-			{ collection: `),s("span",{class:"hljs-string"},'"articles"'),e(", user: "),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),e(", layout: "),s("span",{class:"hljs-string"},'"tabular"'),e(` }
-		]
-	) {
-		id
-		user
-	}
-}
-`)])])],-1),ae=s("hr",null,null,-1),le=s("h2",{id:"update-a-preset"},[e("Update a Preset "),s("a",{class:"header-anchor",href:"#update-a-preset"},"#")],-1),re=s("p",null,"Update an existing preset.",-1),ne={class:"two-up"},oe={class:"left"},he=s("h3",{id:"query-parameters-5"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),ce=e("Supports all "),pe=e("global query parameters"),de=e("."),ie=s("h3",{id:"request-body-3"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),ue=s("p",null,[e("A partial "),s("a",{href:"#the-preset-object"},"preset object"),e(".")],-1),_e=s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),me=s("p",null,[e("Returns the "),s("a",{href:"#the-preset-object"},"preset object"),e(" for the updated preset.")],-1),ge=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",null,`PATCH /presets/: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 /presets/34"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"layout"'),e(": "),s("span",{class:"hljs-string"},'"tabular"'),e(`
-}
-`)])]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",null,`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_presets_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_presets_input): directus_presets
-}
-`)])]),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_presets_item(id: `),s("span",{class:"hljs-number"},"32"),e(", data: { layout: "),s("span",{class:"hljs-string"},'"tabular"'),e(` }) {
-		id
-		user
-	}
-}
-`)])])],-1),fe=s("hr",null,null,-1),je=s("h2",{id:"update-multiple-presets"},[e("Update Multiple Presets "),s("a",{class:"header-anchor",href:"#update-multiple-presets"},"#")],-1),ye=s("p",null,"Update multiple existing presets.",-1),be={class:"two-up"},qe={class:"left"},xe=s("h3",{id:"query-parameters-6"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),Pe=e("Supports all "),ve=e("global query parameters"),Ee=e("."),Te=s("h3",{id:"request-body-4"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),ke=s("div",{class:"definitions"},[s("p",null,[s("code",null,"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the presets you\u2019d like to update.")]),s("p",null,[s("code",null,"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-preset-object"},"the preset object"),e("\u2019s properties.")])],-1),we=s("h3",{id:"returns-6"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Re=s("p",null,[e("Returns the "),s("a",{href:"#the-preset-object"},"preset objects"),e(" for the updated presets.")],-1),Se=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",null,`PATCH /presets
-`)]),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 /presets"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"keys"'),e(": ["),s("span",{class:"hljs-number"},"15"),e(", "),s("span",{class:"hljs-number"},"64"),e(`],
-	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"layout"'),e(": "),s("span",{class:"hljs-string"},'"tabular"'),e(`
-	}
-}
-`)])]),s("h3",{id:"graphql-6"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",null,`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_presets_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_presets_input): [directus_presets]
-}
-`)])]),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_presets_items(ids: [`),s("span",{class:"hljs-number"},"15"),e(", "),s("span",{class:"hljs-number"},"64"),e("], data: { layout: "),s("span",{class:"hljs-string"},'"tabular"'),e(` }) {
-		id
-		user
-	}
-}
-`)])])],-1),Ae=s("hr",null,null,-1),De=s("h2",{id:"delete-a-preset"},[e("Delete a Preset "),s("a",{class:"header-anchor",href:"#delete-a-preset"},"#")],-1),Le=s("p",null,"Delete an existing preset.",-1),Ce=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",null,`DELETE /presets/:id
-`)]),s("h5",{id:"example-12"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",null,`DELETE /presets/34
-`)]),s("h3",{id:"graphql-7"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",null,`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_presets_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_presets_item(id: `),s("span",{class:"hljs-number"},"32"),e(`) {
-		id
-	}
-}
-`)])])])],-1),Qe=s("hr",null,null,-1),Ie=s("h2",{id:"delete-multiple-presets"},[e("Delete Multiple Presets "),s("a",{class:"header-anchor",href:"#delete-multiple-presets"},"#")],-1),Me=s("p",null,"Delete multiple existing presets.",-1),Oe=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 preset 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",null,`DELETE /presets
-`)]),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 /presets"),e(`
-[`),s("span",{class:"hljs-number"},"15"),e(", "),s("span",{class:"hljs-number"},"251"),e(", "),s("span",{class:"hljs-number"},"810"),e(`]
-`)])]),s("h3",{id:"graphql-8"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-8"},"#")]),s("pre",null,[s("code",null,`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_presets_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_presets_items(ids: [`),s("span",{class:"hljs-number"},"15"),e(", "),s("span",{class:"hljs-number"},"251"),e(", "),s("span",{class:"hljs-number"},"810"),e(`]) {
-		ids
-	}
-}
-`)])])])],-1),Ne="Preset",Ve=!1,Fe="page-reference",ze={name:"presets",setup(Ge,{expose:o}){const r={title:"Preset",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:r}),(Be,Ue)=>{const a=n("router-link"),h=n("docs-wrapper");return c(),p(h,{frontmatter:r},{default:t(()=>[s("div",d,[s("div",i,[s("div",u,[s("blockquote",null,[s("p",null,[_,l(a,{to:"/docs/getting-started/glossary/#presets"},{default:t(()=>[m]),_:1}),g])])]),f]),j,y,s("div",b,[s("div",q,[s("div",x,[P,v,s("p",null,[E,T,k,w,R,l(a,{to:"/docs/reference/system/users/"},{default:t(()=>[S]),_:1}),A]),s("p",null,[D,L,C,Q,I,l(a,{to:"/docs/reference/system/users/"},{default:t(()=>[M]),_:1}),O]),G,B,U,H,N,V])]),F]),z,J,K,s("div",W,[s("div",X,[Y,Z,s("p",null,[$,l(a,{to:"/docs/reference/query"},{default:t(()=>[ss]),_:1}),es]),ts,s("p",null,[as,l(a,{to:"/docs/reference/query/#limit"},{default:t(()=>[ls]),_:1}),rs,ns,os])]),s("div",hs,[cs,ps,s("p",null,[l(a,{to:"/docs/reference/introduction/#search-http-method"},{default:t(()=>[ds]),_:1})]),is,us,_s,ms,gs])]),fs,js,ys,s("div",bs,[s("div",qs,[xs,s("p",null,[Ps,l(a,{to:"/docs/reference/query"},{default:t(()=>[vs]),_:1}),Es]),Ts,ks]),ws]),Rs,Ss,As,s("div",Ds,[s("div",Ls,[Cs,s("p",null,[Qs,l(a,{to:"/docs/reference/query"},{default:t(()=>[Is]),_:1}),Ms]),Os,Gs,Bs,Us]),Hs]),Ns,Vs,Fs,s("div",zs,[s("div",Js,[Ks,s("p",null,[Ws,l(a,{to:"/docs/reference/query"},{default:t(()=>[Xs]),_:1}),Ys]),Zs,$s,se,ee]),te]),ae,le,re,s("div",ne,[s("div",oe,[he,s("p",null,[ce,l(a,{to:"/docs/reference/query"},{default:t(()=>[pe]),_:1}),de]),ie,ue,_e,me]),ge]),fe,je,ye,s("div",be,[s("div",qe,[xe,s("p",null,[Pe,l(a,{to:"/docs/reference/query"},{default:t(()=>[ve]),_:1}),Ee]),Te,ke,we,Re]),Se]),Ae,De,Le,Ce,Qe,Ie,Me,Oe])]),_:1})}}};export{ze as default,Ve as modularExtension,Fe as pageClass,Ne as title};

package/dist/assets/project-settings.1ca9f129.js

@@ -1 +0,0 @@
-import{a as i,o as d,b as h,w as t,g as e,e as n,B as o}from"./runtime-core.esm-bundler.e6808e6c.js";const u={class:"markdown-body"},c=e("blockquote",null,[e("p",null,[o("This is where you can adjust all of the "),e("strong",null,"global"),o(" settings for your project. Changes saved here are instantly reflected throughout the platform.")])],-1),g=e("h2",{id:"general"},[o("General "),e("a",{class:"header-anchor",href:"#general"},"#")],-1),p=e("strong",null,"Project Name",-1),_=o(" \u2014 The name used at the top of the "),m=o("Navigation Bar"),f=o(" and on the login/public pages"),w=e("strong",null,"Project Descriptor",-1),b=o(" - The descriptor shown below the Project Name at the top of the "),y=o("Navigation Bar"),v=o(" and on the login/public pages"),k=e("strong",null,"Project URL",-1),T=o(" \u2014 The URL when clicking the logo at the top of the "),x=o("Module Bar"),A=e("li",null,[e("strong",null,"Default Language"),o(" - The default language used within the app.")],-1),P=e("h2",{id:"branding-%26-style"},[o("Branding & Style "),e("a",{class:"header-anchor",href:"#branding-%26-style"},"#")],-1),B=e("strong",null,"Project Color",-1),j=o(" \u2014 The color used behind the logo at the top of the "),S=o("Module Bar"),C=o(", on the login/public pages, and for the browser\u2019s FavIcon"),N=e("strong",null,"Project Logo",-1),F=o(" \u2014 A 40x40 pixel logo at the top of the "),M=o("Module Bar"),q=o(" and on the login/public pages. The image is "),L=e("em",null,"inset",-1),D=o(" within the 64x64 pixel square filled with the Project Color, so we recommend using a SVG or PNG logo with transparency to avoid a \u201Cboxy\u201D look."),G=e("li",null,[e("strong",null,"Public Foreground"),o(" \u2014 An image centered in the public page\u2019s right-pane. Limited to a maximum width of 400px.")],-1),I=e("li",null,[e("strong",null,"Public Background"),o(" \u2014 An image displayed behind the above foreground image, shown full-bleed within the public page\u2019s right-pane. When a Public Background image is not set, the Project Color is used instead.")],-1),U=e("li",null,[e("strong",null,"Public Note"),o(" \u2014 A helpful note displayed at the bottom of the public page\u2019s right-pane; supports markdown for rich-text formatting")],-1),W=e("li",null,[e("strong",null,"Custom CSS"),o(" \u2014 Allows for adding CSS rules to override the App\u2019s default styling. Be aware that the App\u2019s core code, and therefore its DOM selectors, can change at any time. These updates are not considered a breaking change.")],-1),V=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Browser FavIcon & Title"),e("p",null,"The Project Color is also used to set a dynamic favicon and the Project Name is used in the browser\u2019s page title, making it easier to identify different Directus projects.")],-1),z=e("h2",{id:"modules"},[o("Modules "),e("a",{class:"header-anchor",href:"#modules"},"#")],-1),O=e("strong",null,"Module Bar",-1),R=o(" - Allows the following customization of links displayed in the module bar. Show or hide modules by toggling the checkbox, reorder links by dragging on the sort handle, or create new custom links with these fields: "),E=e("li",null,[e("strong",null,"Name"),o(" \u2014 The title of the module link, also shown in a tooltip on hover")],-1),H=e("li",null,[e("strong",null,"Icon"),o(" \u2014 Choose an icon for the module button")],-1),J=e("strong",null,"URL",-1),K=o(" \u2014 Should start with a "),Q=e("code",null,"/",-1),X=o(" for links within the "),Y=o("Directus App"),Z=e("h2",{id:"security"},[o("Security "),e("a",{class:"header-anchor",href:"#security"},"#")],-1),$=e("ul",null,[e("li",null,[e("strong",null,"Auth Password Policy"),o(" \u2014 Allows setting a policy requirement for all user\u2019s passwords, with the following options: "),e("ul",null,[e("li",null,"None \u2014 Not recommended"),e("li",null,"Weak \u2014 Minimum of 8 characters"),e("li",null,"Strong \u2014 Uppercase, lowercase, numbers, and special characters")])]),e("li",null,[e("strong",null,"Auth Login Attempts"),o(" \u2014 Sets the number of failed login attempts allowed before a user\u2019s account is locked. Once locked, an Admin user is required to unlock the account.")])],-1),ee=e("h2",{id:"files-%26-storage"},[o("Files & Storage "),e("a",{class:"header-anchor",href:"#files-%26-storage"},"#")],-1),oe=e("p",null,"The platform\u2019s file middleware allows for cropping and transforming image assets on the fly. This means you can simply request an original image, include any desired transformation parameters, and you\u2019ll be served the new asset as a response.",-1),te=e("p",null,"To impede malicious users from consuming your storage by requesting a large number of random sizes, you can use the following options to limit what transformations are possible.",-1),se=e("ul",null,[e("li",null,[e("strong",null,"Allowed Transformations"),o(" \u2014 For enabling, disabling, or limiting image transformations")]),e("li",null,[e("strong",null,"Default Folder"),o(" \u2014 Sets the default folder where new assets are added. This does not affect existing files. Be aware that fields may override this value.")]),e("li",null,[e("strong",null,"Transformation Presets"),o(" \u2014 Allows setting specific image transformations to simplify requests or limit usage. "),e("ul",null,[e("li",null,"Key \u2014 A unique identifier allowing faster and easier image transformation requests"),e("li",null,"Fit \u2014 Contain (preserve aspect ratio), Cover (force exact size), Fit Inside, or Fit Outside"),e("li",null,"Width \u2014 The width of the image"),e("li",null,"Height \u2014 The height of the image"),e("li",null,"Quality \u2014 The compression or quality of the image"),e("li",null,"Upscaling \u2014 When enabled, images won\u2019t be upscaled"),e("li",null,"Format \u2014 Allows changing the output format to: JPG, PNG, WebP, or TIFF"),e("li",null,[o("Additional Transformations \u2014 Allows adding additional transformations using "),e("a",{href:"https://sharp.pixelplumbing.com/api-constructor",target:"_blank",rel:"noopener noreferrer"},"Sharp")])])])],-1),ne=e("h2",{id:"mapping"},[o("Mapping "),e("a",{class:"header-anchor",href:"#mapping"},"#")],-1),le=e("ul",null,[e("li",null,[e("strong",null,"Mapbox Access Token"),o(" \u2014 Create a "),e("a",{href:"https://docs.mapbox.com/help/glossary/access-token/",target:"_blank",rel:"noopener noreferrer"},"Mapbox Access Token"),o(" and enter it here to improve the platform\u2019s mapping experience.")]),e("li",null,[e("strong",null,"Basemaps"),o(" \u2014 Allows overriding the Mapbox defaults with custom tiles")])],-1),he="Project Settings",ue=!1,ce={name:"project-settings",setup(ie,{expose:a}){const l={title:"Project Settings",modularExtension:!1};return a({frontmatter:l}),(ae,re)=>{const s=i("router-link"),r=i("docs-wrapper");return d(),h(r,{frontmatter:l},{default:t(()=>[e("div",u,[c,g,e("ul",null,[e("li",null,[p,_,n(s,{to:"/docs/app/overview/#_2-navigation-bar"},{default:t(()=>[m]),_:1}),f]),e("li",null,[w,b,n(s,{to:"/docs/app/overview/#_2-navigation-bar"},{default:t(()=>[y]),_:1}),v]),e("li",null,[k,T,n(s,{to:"/docs/app/overview/#_1-module-bar"},{default:t(()=>[x]),_:1})]),A]),P,e("ul",null,[e("li",null,[B,j,n(s,{to:"/docs/app/overview/#_1-module-bar"},{default:t(()=>[S]),_:1}),C]),e("li",null,[N,F,n(s,{to:"/docs/app/overview/#_1-module-bar"},{default:t(()=>[M]),_:1}),q,L,D]),G,I,U,W]),V,z,e("ul",null,[e("li",null,[O,R,e("ul",null,[E,H,e("li",null,[J,K,Q,X,n(s,{to:"/docs/app/overview/"},{default:t(()=>[Y]),_:1})])])])]),Z,$,ee,oe,te,se,ne,le])]),_:1})}}};export{ce as default,ue as modularExtension,he as title};