@directus/app 9.12.1 → 9.14.0

package/dist/assets/notifications.33c688c9.js

@@ -1,153 +0,0 @@
-import{a as i,o as r,b as h,w as t,g as e,e as n,B as s}from"./runtime-core.esm-bundler.b1f35d24.js";var l={};const d={class:"markdown-body"},p=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Notifications allow you to send/receive messages to/from other users of the platform.")])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-notification-object"},"The Notification Object")]),e("li",null,[e("a",{href:"#list-notifications"},"List Notifications")]),e("li",null,[e("a",{href:"#retrieve-a-notification"},"Retrieve a notification")]),e("li",null,[e("a",{href:"#create-a-notification"},"Create a Notification")]),e("li",null,[e("a",{href:"#create-multiple-notifications"},"Create Multiple Notifications")]),e("li",null,[e("a",{href:"#update-a-notification"},"Update a Notification")]),e("li",null,[e("a",{href:"#update-multiple-notifications"},"Update Multiple Notifications")]),e("li",null,[e("a",{href:"#delete-a-notification"},"Delete a Notification")]),e("li",null,[e("a",{href:"#delete-multiple-notifications"},"Delete Multiple Notifications")])])])])])],-1),u=e("hr",null,null,-1),f=e("h2",{id:"the-notification-object"},[s("The Notification Object "),e("a",{class:"header-anchor",href:"#the-notification-object"},"#")],-1),_=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",{class:""},"id"),s(),e("strong",null,"integer"),e("br"),s(" Primary key of the revision.")]),e("p",null,[e("code",{class:""},"timestamp"),s(),e("strong",null,"string"),e("br"),s(" Timestamp in ISO8601 when the notification was created.")]),e("p",null,[e("code",{class:""},"status"),s(),e("strong",null,"string"),e("br"),s(" Current status of the notification. One of \u201Cinbox\u201D, \u201Carchived\u201D.")]),e("p",null,[e("code",{class:""},"recipient"),s(),e("strong",null,"many-to-one"),e("br"),s(" User that received the notification.")]),e("p",null,[e("code",{class:""},"sender"),s(),e("strong",null,"many-to-one"),e("br"),s(" User that sent the notification, if any.")]),e("p",null,[e("code",{class:""},"subject"),s(),e("strong",null,"string"),e("br"),s(" Subject line of the message.")]),e("p",null,[e("code",{class:""},"message"),s(),e("strong",null,"string"),e("br"),s(" Notification\u2019s message content. Will be sent in the email.")]),e("p",null,[e("code",{class:""},"collection"),s(),e("strong",null,"string"),e("br"),s(" Collection this notification references.")]),e("p",null,[e("code",{class:""},"item"),s(),e("strong",null,"string"),e("br"),s(" Primary key of the item this notification references.")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[s(`{
-	`),e("span",{class:"hljs-attr"},'"id"'),s(": "),e("span",{class:"hljs-number"},"2"),s(`,
-	`),e("span",{class:"hljs-attr"},'"timestamp"'),s(": "),e("span",{class:"hljs-string"},'"2021-11-24T13:57:35Z"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"status"'),s(": "),e("span",{class:"hljs-string"},'"inbox"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"recipient"'),s(": "),e("span",{class:"hljs-string"},'"3EE34828-B43C-4FB2-A721-5151579B08EA"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"sender"'),s(": "),e("span",{class:"hljs-string"},'"497a495e-5529-4e46-8feb-2f35e9b85601"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"subject"'),s(": "),e("span",{class:"hljs-string"},'"You were mentioned in articles"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"message"'),s(": "),e("span",{class:"hljs-string"},'"\\nHello admin@example.com,\\n\\rijk@directus.io has mentioned you in a comment:\\n\\n> Hello <em>admin@example.com</em>!\\n\\n<a href=\\"http://localhost:8080/admin/content/articles/1\\">Click here to view.</a>\\n"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"collection"'),s(": "),e("span",{class:"hljs-string"},'"articles"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"item"'),s(": "),e("span",{class:"hljs-string"},'"1"'),s(`
-}
-`)])])])],-1),m=e("hr",null,null,-1),g=e("h2",{id:"list-notifications"},[s("List Notifications "),e("a",{class:"header-anchor",href:"#list-notifications"},"#")],-1),j=e("p",null,"List all notifications that exist in Directus.",-1),y={class:"two-up"},b={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 "),k=s("limit"),P=s(),R=e("a",{href:"#the-notification-object"},"notification objects",-1),S=s(". If no items are available, data will be an empty array."),N={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 /notifications
-SEARCH /notifications
-`)],-1),L=s("Learn more about SEARCH ->"),D=e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),O=e("pre",null,[e("code",{class:""},`POST /graphql/system
-`)],-1),Q=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
-	notifications: [directus_notifications]
-}
-`)])],-1),I=e("h5",{id:"example"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")],-1),H=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
-	notifications {
-		id
-		recipient
-		subject
-	}
-}
-`)])],-1),B=e("hr",null,null,-1),M=e("h2",{id:"retrieve-a-notification"},[s("Retrieve a notification "),e("a",{class:"header-anchor",href:"#retrieve-a-notification"},"#")],-1),G=e("p",null,"List an existing notification by primary key.",-1),U={class:"two-up"},Y={class:"left"},V=e("h3",{id:"query-parameters-2"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),F=s("Supports all "),W=s("global query parameters"),Z=s("."),z=e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),J=e("p",null,[s("Returns the requested "),e("a",{href:"#the-notification-object"},"notification object"),s(".")],-1),K=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 /notifications/:id
-`)]),e("h5",{id:"example-2"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",{class:""},`GET /notifications/42
-`)]),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(` {
-	notifications_by_id(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): directus_notifications
-}
-`)])]),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(` {
-	notifications_by_id(id: `),e("span",{class:"hljs-number"},"42"),s(`) {
-		id
-		sender
-		recipient
-		message
-		subject
-	}
-}
-`)])])],-1),X=e("hr",null,null,-1),$=e("h2",{id:"create-a-notification"},[s("Create a Notification "),e("a",{class:"header-anchor",href:"#create-a-notification"},"#")],-1),ee=e("p",null,"Create a new notification.",-1),se={class:"two-up"},te={class:"left"},ae=e("h3",{id:"query-parameters-3"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),ne=s("Supports all "),ie=s("global query parameters"),le=s("."),oe=e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),ce=e("p",null,[s("A partial "),e("a",{href:"#the-notification-object"},"notification object"),s(".")],-1),re=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-notification-object"},"notification object"),s(" for the created notification.")],-1),de=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 /notifications
-`)]),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 /notifications"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"recipient"'),s(": "),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"subject"'),s(": "),e("span",{class:"hljs-string"},'"Hi there!"'),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_notifications_item(data: create_directus_notifications_input!): directus_notifications
-}
-`)])]),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_notifications_item(data: { recipient: `),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),s(", subject: "),e("span",{class:"hljs-string"},'"Hi there!"'),s(` }) {
-		id
-		recipient
-	}
-}
-`)])])],-1),pe=e("hr",null,null,-1),ue=e("h2",{id:"create-multiple-notifications"},[s("Create Multiple Notifications "),e("a",{class:"header-anchor",href:"#create-multiple-notifications"},"#")],-1),fe=e("p",null,"Create multiple new notifications.",-1),_e={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),je=s("Supports all "),ye=s("global query parameters"),be=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-notification-object"},"notification objects"),s(".")],-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-notification-object"},"notification object"),s(" for the created notification.")],-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 /notifications
-`)]),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 /notifications"),s(`
-
-[
-	{
-		`),e("span",{class:"hljs-attr"},'"collection"'),s(": "),e("span",{class:"hljs-string"},'"directus_files"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"recipient"'),s(": "),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"message"'),s(": "),e("span",{class:"hljs-string"},'"Hi there! You should check out these files"'),s(`
-	},
-	{
-		`),e("span",{class:"hljs-attr"},'"collection"'),s(": "),e("span",{class:"hljs-string"},'"articles"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"recipient"'),s(": "),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"message"'),s(": "),e("span",{class:"hljs-string"},'"Hi there! You should check out these articles"'),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_notifications_items(data: [create_directus_notifications_input!]!): [directus_notifications]
-}
-`)])]),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_notifications_items(
-		data: [
-			{
-				collection: `),e("span",{class:"hljs-string"},'"directus_files"'),s(`
-				recipient: `),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),s(`
-				message: `),e("span",{class:"hljs-string"},'"Hi there! You should check out these files"'),s(`
-			}
-			{
-				collection: `),e("span",{class:"hljs-string"},'"articles"'),s(`
-				recipient: `),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),s(`
-				message: `),e("span",{class:"hljs-string"},'"Hi there! You should check out these articles"'),s(`
-			}
-		]
-	) {
-		id
-		recipient
-	}
-}
-`)])])],-1),Te=e("hr",null,null,-1),ke=e("h2",{id:"update-a-notification"},[s("Update a Notification "),e("a",{class:"header-anchor",href:"#update-a-notification"},"#")],-1),Pe=e("p",null,"Update an existing notification.",-1),Re=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Email Notifications"),e("p",null,"Emails are only sent when the notification is created. Updated to an existing notification won\u2019t trigger a new notification email to be sent.")],-1),Se={class:"two-up"},Ne={class:"left"},Ae=e("h3",{id:"query-parameters-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Ce=s("Supports all "),Le=s("global query parameters"),De=s("."),Oe=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-notification-object"},"notification object"),s(".")],-1),Ie=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),He=e("p",null,[s("Returns the "),e("a",{href:"#the-notification-object"},"notification object"),s(" for the updated notification.")],-1),Be=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 /notifications/: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 /notifications/34"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"message"'),s(": "),e("span",{class:"hljs-string"},'"This is my updated notification"'),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_notifications_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!, data: update_directus_notifications_input): directus_notifications
-}
-`)])]),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_notifications_item(id: `),e("span",{class:"hljs-number"},"32"),s(", data: { message: "),e("span",{class:"hljs-string"},'"This is my updated notification"'),s(` }) {
-		id
-		message
-	}
-}
-`)])])],-1),Me=e("hr",null,null,-1),Ge=e("h2",{id:"update-multiple-notifications"},[s("Update Multiple Notifications "),e("a",{class:"header-anchor",href:"#update-multiple-notifications"},"#")],-1),Ue=e("p",null,"Update multiple existing notifications.",-1),Ye={class:"two-up"},Ve={class:"left"},Fe=e("h3",{id:"query-parameters-6"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),We=s("Supports all "),Ze=s("global query parameters"),ze=s("."),Je=e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Ke=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 notifications 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-notification-object"},"the notification object"),s("\u2019s properties.")])],-1),Xe=e("h3",{id:"returns-6"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),$e=e("p",null,[s("Returns the "),e("a",{href:"#the-notification-object"},"notification objects"),s(" for the updated notifications.")],-1),es=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 /notifications
-`)]),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 /notifications"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"keys"'),s(": ["),e("span",{class:"hljs-number"},"15"),s(", "),e("span",{class:"hljs-number"},"64"),s(`],
-	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
-		`),e("span",{class:"hljs-attr"},'"message"'),s(": "),e("span",{class:"hljs-string"},'"Updated message!"'),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_notifications_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!, data: update_directus_notifications_input): [directus_notifications]
-}
-`)])]),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_notifications_items(ids: [`),e("span",{class:"hljs-number"},"15"),s(", "),e("span",{class:"hljs-number"},"64"),s("], data: { message: "),e("span",{class:"hljs-string"},'"Updated message!"'),s(` }) {
-		id
-		recipient
-	}
-}
-`)])])],-1),ss=e("hr",null,null,-1),ts=e("h2",{id:"delete-a-notification"},[s("Delete a Notification "),e("a",{class:"header-anchor",href:"#delete-a-notification"},"#")],-1),as=e("p",null,"Delete an existing notification.",-1),ns=e("div",{class:"two-up"},[e("div",{class:"left"},[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 /notifications/:id
-`)]),e("h5",{id:"example-12"},[s("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),e("pre",null,[e("code",{class:""},`DELETE /notifications/34
-`)]),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_notifications_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_notifications_item(id: `),e("span",{class:"hljs-number"},"32"),s(`) {
-		id
-	}
-}
-`)])])])],-1),is=e("hr",null,null,-1),ls=e("h2",{id:"delete-multiple-notifications"},[s("Delete Multiple Notifications "),e("a",{class:"header-anchor",href:"#delete-multiple-notifications"},"#")],-1),os=e("p",null,"Delete multiple existing notifications.",-1),cs=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-5"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-5"},"#")]),e("p",null,"An array of notification 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 /notifications
-`)]),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 /notifications"),s(`
-[`),e("span",{class:"hljs-number"},"15"),s(", "),e("span",{class:"hljs-number"},"251"),s(", "),e("span",{class:"hljs-number"},"810"),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_notifications_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_notifications_items(ids: [`),e("span",{class:"hljs-number"},"15"),s(", "),e("span",{class:"hljs-number"},"251"),s(", "),e("span",{class:"hljs-number"},"810"),s(`]) {
-		ids
-	}
-}
-`)])])])],-1),rs={title:"Notifications",modularExtension:!1,pageClass:"page-reference"},hs={name:"notifications",setup(ds,{expose:o}){return o({frontmatter:{title:"Notifications",modularExtension:!1,pageClass:"page-reference"}}),(ps,us)=>{const a=i("router-link"),c=i("docswrapper");return r(),h(c,{frontmatter:rs},{default:t(()=>[e("div",d,[p,u,f,_,m,g,j,e("div",y,[e("div",b,[q,e("p",null,[x,n(a,{to:"/docs/reference/query"},{default:t(()=>[v]),_:1}),E]),w,e("p",null,[T,n(a,{to:"/docs/reference/query/#limit"},{default:t(()=>[k]),_:1}),P,R,S])]),e("div",N,[A,C,e("p",null,[n(a,{to:"/docs/reference/introduction/#search-http-method"},{default:t(()=>[L]),_:1})]),D,O,Q,I,H])]),B,M,G,e("div",U,[e("div",Y,[V,e("p",null,[F,n(a,{to:"/docs/reference/query"},{default:t(()=>[W]),_:1}),Z]),z,J]),K]),X,$,ee,e("div",se,[e("div",te,[ae,e("p",null,[ne,n(a,{to:"/docs/reference/query"},{default:t(()=>[ie]),_:1}),le]),oe,ce,re,he]),de]),pe,ue,fe,e("div",_e,[e("div",me,[ge,e("p",null,[je,n(a,{to:"/docs/reference/query"},{default:t(()=>[ye]),_:1}),be]),qe,xe,ve,Ee]),we]),Te,ke,Pe,Re,e("div",Se,[e("div",Ne,[Ae,e("p",null,[Ce,n(a,{to:"/docs/reference/query"},{default:t(()=>[Le]),_:1}),De]),Oe,Qe,Ie,He]),Be]),Me,Ge,Ue,e("div",Ye,[e("div",Ve,[Fe,e("p",null,[We,n(a,{to:"/docs/reference/query"},{default:t(()=>[Ze]),_:1}),ze]),Je,Ke,Xe,$e]),es]),ss,ts,as,ns,is,ls,os,cs])]),_:1})}}};typeof l=="function"&&l(hs);export{hs as default,rs as frontmatter};

package/dist/assets/overview.3436365c.js

@@ -1 +0,0 @@
-import{a as n,o as l,b as r,w as o,g as t,e as a,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var c={};const u={class:"markdown-body"},_=t("blockquote",null,[t("p",null,"Whether you\u2019re a hobbyist, startup or Fortune 500 enterprise, our flexible Cloud service lets you get up and running with Directus quickly. We do all the heavy lifting of managing your infrastructure and software updates - and you also benefit from fair and predictable usage-based pricing.")],-1),h=t("p",null,[t("img",{src:"https://cdn.directus.io/docs/v9/cloud/overview/overview-20220322A/hero-image-20220402A.webp",alt:"Hero Image"})],-1),m=t("p",null,[t("div",{class:"table-of-contents"},[t("ul",null,[t("li",null,[t("a",{href:"#getting-started"},"Getting Started")]),t("li",null,[t("a",{href:"#accounts"},"Accounts")]),t("li",null,[t("a",{href:"#teams"},"Teams")]),t("li",null,[t("a",{href:"#projects"},"Projects")])])])],-1),p=t("a",{href:"https://directus.cloud/",target:"_blank",rel:"noopener noreferrer"},"Directus Cloud",-1),g=e(" is a hosting platform for "),f=e("Directus Projects"),v=e(" which handles data storage, hosting, updates and scalability so you can focus on building your digital apps and experiences. There are three "),y=e("tiers of Cloud Projects"),b=e(": Community, Standard and Enterprise. All three tiers come with all the great features of Directus Core, as well as all "),T=e("Cloud Exclusive"),w=e(" extensions."),j=e("The Cloud Dashboard is constructed to manage three key components: "),P=e("Accounts"),A=e(", "),C=e("Teams"),x=e(" and "),k=e("Projects"),D=e(". First, create an Account. Once logged in, create or join a Team, and your Account will become a Member of that Team. Once that\u2019s complete, you can create Projects within a Team."),M=e("Accounts can be Members on multiple Teams. All Team Members have SuperAdmin privileges to manage the Team\u2019s Projects, Project "),S=e("billing"),V=e(", other Team Members and the Team itself. Teams can have multiple Team Members and multiple Projects. Projects can only be managed by one Team and cannot be transferred to new Teams."),O=t("h2",{id:"getting-started"},[e("Getting Started "),t("a",{class:"header-anchor",href:"#getting-started"},"#")],-1),B=e("To make life easy, you have the option to "),E=e("create and login to your free Cloud Account"),H=e(" automatically with GitHub. If you don\u2019t have a GitHub account or prefer not to use this login method, email-and-password login is available, as well. Once logged in, create a new Team or select an existing Team. Then you can access and manage the Team\u2019s associated Projects, billing details, Team Members, Activity and Settings."),N=t("video",{alt:"Cloud Dashboard Overview",loop:"",muted:"",controls:"",autoplay:""},[t("source",{src:"https://cdn.directus.io/docs/v9/cloud/overview/overview-20220322A/cloud-dashboard-overview-20220329A.mp4",type:"video/mp4"})],-1),G=e("Remember: The Dashboard layout itself is designed to manage "),q=e("Accounts"),F=e(", "),I=e("Teams"),R=e(" and "),W=e("Projects"),z=e(". Here\u2019s how the Dashboard layout relates to each of these components:"),J=t("h2",{id:"accounts"},[e("Accounts "),t("a",{class:"header-anchor",href:"#accounts"},"#")],-1),K=t("h3",{id:"cloud-dashboard-header"},[e("Cloud Dashboard Header "),t("a",{class:"header-anchor",href:"#cloud-dashboard-header"},"#")],-1),L=t("span",{mi:"",icon:""},"check",-1),Q=e(" \u2014 View Directus Cloud "),U=e("system status"),X=e("."),Y=t("li",null,[t("span",{mi:"",icon:""},"notifications"),e(" \u2014 Notifications such as version upgrades, platform upgrades, etc.")],-1),Z=t("li",null,[t("span",{mi:"",icon:""},"help_outline"),e(" \u2014 Documentation, Community Support and Request for Premium Support.")],-1),$=t("span",{mi:"",icon:""},"expand_more",-1),ee=e(" \u2014 "),te=e("Create new Teams"),oe=e(" and navigate between Teams you are on."),se=t("span",{mi:"",icon:""},"account_circle",-1),ae=e(" \u2014 "),ne=e("Access, edit or destroy Account"),ce=e("."),ie=t("h2",{id:"teams"},[e("Teams "),t("a",{class:"header-anchor",href:"#teams"},"#")],-1),de=e("Team Members"),le=e(" \u2014 View, invite and remove other Team Members or leave a Team."),re=e("Team Activity"),ue=e(" \u2014 View Team activity such as Project creation and deletion, billing information changes, Member invitations and removals, etc."),_e=e("Team Settings"),he=e(" \u2014 Edit the Team Name and Team Slug, as well as "),me=e("destroy a Team"),pe=e("."),ge=t("h2",{id:"projects"},[e("Projects "),t("a",{class:"header-anchor",href:"#projects"},"#")],-1),fe=e("Team Projects"),ve=e(" \u2014 View and access all Projects managed within a Team. Click a Project to enter the Product Details Page and access, monitor, edit or delete a Project."),ye=e("Team Billing"),be=e(" \u2014 View and manage billing details such as credit card information, usage, subscriptions and receipts."),Te={title:"Overview",modularExtension:!1},we={name:"overview",setup(je,{expose:i}){return i({frontmatter:{title:"Overview",modularExtension:!1}}),(Pe,Ae)=>{const s=n("router-link"),d=n("docswrapper");return l(),r(d,{frontmatter:Te},{default:o(()=>[t("div",u,[_,h,m,t("p",null,[p,g,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[f]),_:1}),v,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[y]),_:1}),b,a(s,{to:"/docs/cloud/glossary/#cloud-exclusives"},{default:o(()=>[T]),_:1}),w]),t("p",null,[j,a(s,{to:"/docs/cloud/glossary/#accounts"},{default:o(()=>[P]),_:1}),A,a(s,{to:"/docs/cloud/glossary/#teams"},{default:o(()=>[C]),_:1}),x,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[k]),_:1}),D]),t("p",null,[M,a(s,{to:"/docs/cloud/teams/#manage-billing"},{default:o(()=>[S]),_:1}),V]),O,t("p",null,[B,a(s,{to:"/docs/cloud/accounts/#create-account-and-login"},{default:o(()=>[E]),_:1}),H]),N,t("p",null,[G,a(s,{to:"/docs/cloud/glossary/#accounts"},{default:o(()=>[q]),_:1}),F,a(s,{to:"/docs/cloud/glossary/#teams"},{default:o(()=>[I]),_:1}),R,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[W]),_:1}),z]),J,K,t("ul",null,[t("li",null,[L,Q,a(s,{to:"/docs/cloud/glossary/#system-status"},{default:o(()=>[U]),_:1}),X]),Y,Z,t("li",null,[$,ee,a(s,{to:"/docs/cloud/teams/#create-a-team"},{default:o(()=>[te]),_:1}),oe]),t("li",null,[se,ae,a(s,{to:"/docs/cloud/accounts"},{default:o(()=>[ne]),_:1}),ce])]),ie,t("ul",null,[t("li",null,[a(s,{to:"/docs/cloud/teams"},{default:o(()=>[de]),_:1}),le]),t("li",null,[a(s,{to:"/docs/cloud/teams/#view-team-activity"},{default:o(()=>[re]),_:1}),ue]),t("li",null,[a(s,{to:"/docs/cloud/teams/#update-team-settings"},{default:o(()=>[_e]),_:1}),he,a(s,{to:"/docs/cloud/teams/#destroy-a-team"},{default:o(()=>[me]),_:1}),pe])]),ge,t("ul",null,[t("li",null,[a(s,{to:"/docs/cloud/projects"},{default:o(()=>[fe]),_:1}),ve]),t("li",null,[a(s,{to:"/docs/cloud/teams/#manage-billing"},{default:o(()=>[ye]),_:1}),be])])])]),_:1})}}};typeof c=="function"&&c(we);export{we as default,Te as frontmatter};

package/dist/assets/overview.623fafba.js

@@ -1 +0,0 @@
-import{a as i,o as c,b as d,w as o,g as t,e as s,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var u="assets/app-overview.6445a201.svg";var a={};const h={class:"markdown-body"},p=t("blockquote",null,[t("p",null,"The App is a no-code presentation layer for your data, content, and assets. It uses an intuitive left-to-right visual hierarchy for general organization and navigation.")],-1),_=t("img",{src:u,alt:"Directus Application Overview",class:"no-shadow"},null,-1),g=t("h2",{id:"1.-module-bar"},[e("1. Module Bar "),t("a",{class:"header-anchor",href:"#1.-module-bar"},"#")],-1),f=t("p",null,"The leftmost section of the App is the module bar, which includes the:",-1),m=t("li",null,[t("strong",null,"Project Logo"),e(" \u2014 Displays your configured project logo and project color (defaults to the Directus logo and color). If configured, clicking this component will navigate to the Project URL. During platform activity, an indeterminate progress indicator will also be shown here.")],-1),v=t("strong",null,"Module Navigation",-1),y=e(" \u2014 Allows navigating between the different modules your user has access to. Customizing the Module Navigation is done within the "),b=e("Project Settings"),w=e(", but the default module list includes: "),k=e("Content"),A=e(" \u2014 The primary way to view and interact with database content"),T=e("User Directory"),x=e(" \u2014 A dedicated section for the platform\u2019s system Users"),P=e("File Library"),N=e(" \u2014 An aggregate of all files uploaded and managed within the platform"),C=e("Insights"),j=e(" \u2014 Access to infinitely customizable data dashboards"),B=e("App Guide"),I=e(" \u2014 A tailored, in-app portal for the platform\u2019s concepts, guides, and reference"),S=e("Settings"),D=e(" \u2014 An admin-only section for configuring the project and system settings"),M=t("strong",null,"Notifications",-1),L=e(" - Opens a drawer of notifications, such as from "),U=e("mentions"),z=e("."),O=t("li",null,[t("strong",null,"Current User Menu"),e(" \u2014 This component displays the authenticated user\u2019s name and avatar. "),t("ul",null,[t("li",null,"Sign Out \u2014 Hovering over the User Menu exposes the button to log out of the platform.")])],-1),V=t("h2",{id:"2.-navigation-bar"},[e("2. Navigation Bar "),t("a",{class:"header-anchor",href:"#2.-navigation-bar"},"#")],-1),E=t("p",null,"The navigation bar is based on the current module, and includes:",-1),F=t("strong",null,"Project Name",-1),H=e(" \u2014 Shows an icon and tooltip indicating the API\u2019s connection strength, and the name of your current project, which can be configured under "),R=e("Project Settings"),q=e("."),G=t("strong",null,"Navigation",-1),X=e(" \u2014 This is a dynamic navigation based on your current module. Some modules also support "),J=e("Bookmark Presets"),K=e(", which are a customizable links to specific data-sets."),Q=t("h2",{id:"3.-page"},[e("3. Page "),t("a",{class:"header-anchor",href:"#3.-page"},"#")],-1),W=t("p",null,"This is where the current page\u2019s content is shown, including:",-1),Y=t("ul",null,[t("li",null,[t("strong",null,"Header"),e(" \u2014 A fixed section at the top of each page, the header includes: "),t("ul",null,[t("li",null,"Page Icon \u2014 Clicking this navigates back to the previous page."),t("li",null,"Module Name \u2014 Clicking this navigates to the parent module/section."),t("li",null,"Page Title \u2014 Displays dynamic title of the current page."),t("li",null,"Action Buttons \u2014 Right-aligned contextual buttons for specific page actions.")])]),t("li",null,[t("strong",null,"Page Content"),e(" \u2014 This displays the content of the page you navigated to.")])],-1),Z=t("h2",{id:"4.-sidebar"},[e("4. Sidebar "),t("a",{class:"header-anchor",href:"#4.-sidebar"},"#")],-1),$=t("p",null,"The sidebar provides additional context and options for the current page, including:",-1),tt=t("ul",null,[t("li",null,[t("strong",null,"Page Components"),e(" \u2014 Lists any contextual page components available. The \u201CInfo\u201D component is available on every page, explaining the page\u2019s general purpose and relevant details. Clicking any sidebar component will accordion it open. If the App window is large enough, the sidebar will automatically open, and can be closed by clicking the \u201CX\u201D in the top-right.")]),t("li",null,[t("strong",null,"Notifications Tray"),e(" \u2014 Fixed to the bottom of the page sidebar, this button opens a tray of recent user notifications, and provides a link to your Activity Log page.")])],-1),et={title:"The Application",modularExtension:!1},ot={name:"overview",setup(nt,{expose:l}){return l({frontmatter:{title:"The Application",modularExtension:!1}}),(st,it)=>{const n=i("router-link"),r=i("docswrapper");return c(),d(r,{frontmatter:et},{default:o(()=>[t("div",h,[p,_,g,f,t("ul",null,[m,t("li",null,[v,y,s(n,{to:"/docs/app/settings"},{default:o(()=>[b]),_:1}),w,t("ul",null,[t("li",null,[s(n,{to:"/docs/app/content-collections/"},{default:o(()=>[k]),_:1}),A]),t("li",null,[s(n,{to:"/docs/app/user-directory"},{default:o(()=>[T]),_:1}),x]),t("li",null,[s(n,{to:"/docs/app/file-library"},{default:o(()=>[P]),_:1}),N]),t("li",null,[s(n,{to:"/docs/app/insights"},{default:o(()=>[C]),_:1}),j]),t("li",null,[s(n,{to:"/docs/app/overview/"},{default:o(()=>[B]),_:1}),I]),t("li",null,[s(n,{to:"/docs/app/settings"},{default:o(()=>[S]),_:1}),D])])]),t("li",null,[M,L,s(n,{to:"/docs/app/content-items/#mentions"},{default:o(()=>[U]),_:1}),z]),O]),V,E,t("ul",null,[t("li",null,[F,H,s(n,{to:"/docs/app/settings"},{default:o(()=>[R]),_:1}),q]),t("li",null,[G,X,s(n,{to:"/docs/getting-started/glossary/#presets"},{default:o(()=>[J]),_:1}),K])]),Q,W,Y,Z,$,tt])]),_:1})}}};typeof a=="function"&&a(ot);export{ot as default,et as frontmatter};

package/dist/assets/overview.dbebe94a.js

@@ -1 +0,0 @@
-import{a,o as r,b as s,w as i,g as o,B as c}from"./runtime-core.esm-bundler.b1f35d24.js";var t={};const l=o("div",{class:"markdown-body"},[o("blockquote",null,[o("p",null,"The vast flexibility of Directus is due to its thoughtful configuration options. This section guides administrators through the process of tailoring a newly installed project to your exact needs.")]),o("h2",{id:"config-options"},[c("Config Options "),o("a",{class:"header-anchor",href:"#config-options"},"#")])],-1),f={title:"Configuring the Platform",modularExtension:!1},u={name:"overview",setup(d,{expose:e}){return e({frontmatter:{title:"Configuring the Platform",modularExtension:!1}}),(p,_)=>{const n=a("docswrapper");return r(),s(n,{frontmatter:f},{default:i(()=>[l]),_:1})}}};typeof t=="function"&&t(u);export{u as default,f as frontmatter};

package/dist/assets/panels.385b173a.js

@@ -1,65 +0,0 @@
-import{a as o,o as r,b as h,w as e,g as s,e as a,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var l={};const d={class:"markdown-body"},p=t("Panels are modular units of data visualization that exist within the "),u=t("Insights module"),_=t(". Each panel exists within a Dashboard and can be positioned and resized as needed. "),m=t("Learn more about Panels"),f=t("."),g=s("h2",{id:"extension-entrypoint"},[t("Extension Entrypoint "),s("a",{class:"header-anchor",href:"#extension-entrypoint"},"#")],-1),y=s("p",null,[t("The entrypoint of your panel is the "),s("code",{class:""},"index"),t(" file inside the "),s("code",{class:""},"src/"),t(" folder of your extension package. It exports a configuration object with options to configure the behavior of your panel. When loading your panel, this object is imported by the Directus host.")],-1),j=s("p",null,"Example of an entrypoint:",-1),b=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),t(" PanelComponent "),s("span",{class:"hljs-keyword"},"from"),t(),s("span",{class:"hljs-string"},"'./panel.vue'"),t(`;
-
-`),s("span",{class:"hljs-keyword"},"export"),t(),s("span",{class:"hljs-keyword"},"default"),t(` {
-	`),s("span",{class:"hljs-attr"},"id"),t(": "),s("span",{class:"hljs-string"},"'custom'"),t(`,
-	`),s("span",{class:"hljs-attr"},"name"),t(": "),s("span",{class:"hljs-string"},"'Custom'"),t(`,
-	`),s("span",{class:"hljs-attr"},"icon"),t(": "),s("span",{class:"hljs-string"},"'box'"),t(`,
-	`),s("span",{class:"hljs-attr"},"description"),t(": "),s("span",{class:"hljs-string"},"'This is my custom panel!'"),t(`,
-	`),s("span",{class:"hljs-attr"},"component"),t(`: PanelComponent,
-	`),s("span",{class:"hljs-attr"},"options"),t(`: [
-		{
-			`),s("span",{class:"hljs-attr"},"field"),t(": "),s("span",{class:"hljs-string"},"'text'"),t(`,
-			`),s("span",{class:"hljs-attr"},"name"),t(": "),s("span",{class:"hljs-string"},"'Text'"),t(`,
-			`),s("span",{class:"hljs-attr"},"type"),t(": "),s("span",{class:"hljs-string"},"'string'"),t(`,
-			`),s("span",{class:"hljs-attr"},"meta"),t(`: {
-				`),s("span",{class:"hljs-attr"},"interface"),t(": "),s("span",{class:"hljs-string"},"'input'"),t(`,
-				`),s("span",{class:"hljs-attr"},"width"),t(": "),s("span",{class:"hljs-string"},"'full'"),t(`,
-			},
-		},
-	],
-	`),s("span",{class:"hljs-attr"},"minWidth"),t(": "),s("span",{class:"hljs-number"},"12"),t(`,
-	`),s("span",{class:"hljs-attr"},"minHeight"),t(": "),s("span",{class:"hljs-number"},"8"),t(`,
-};
-`)])],-1),w=s("h4",{id:"available-options"},[t("Available Options "),s("a",{class:"header-anchor",href:"#available-options"},"#")],-1),x=s("li",null,[s("code",{class:""},"id"),t(" \u2014 The unique key for this panel. It is good practice to scope proprietary panels with an author prefix.")],-1),k=s("li",null,[s("code",{class:""},"name"),t(" \u2014 The human-readable name for this panel.")],-1),v=s("code",{class:""},"icon",-1),T=t(" \u2014 An icon name from the "),A=t("material icon set"),V=t(", or the extended list of Directus custom icons."),C=s("li",null,[s("code",{class:""},"description"),t(" \u2014 A short description (<80 characters) of this panel shown in the App.")],-1),P=s("li",null,[s("code",{class:""},"component"),t(" \u2014 A reference to your panel component.")],-1),I=s("li",null,[s("code",{class:""},"options"),t(" \u2014 The options of your panel. Can be either an options object or a dedicated Vue component.")],-1),S=s("li",null,[s("code",{class:""},"minWidth"),t(" - The minimum width in grid units of your panel on a dashboard.")],-1),D=s("li",null,[s("code",{class:""},"minHeight"),t(" - The minimum height in grid units of your panel on a dashboard.")],-1),E=s("h2",{id:"panel-component"},[t("Panel Component "),s("a",{class:"header-anchor",href:"#panel-component"},"#")],-1),B=s("p",null,"The panel component is the part of your extension that will be rendered by the Directus App whenever your panel should be used for data visualization in a dashboard within the Insights module. This panel component has to be Vue component. The most straightforward way to write a Vue component is to use the Vue Single File Component syntax.",-1),H=s("p",null,"Example of a panel component using the Vue SFC syntax:",-1),W=s("pre",null,[s("code",{class:"language-vue"},`<template>
-	<div class="text" :class="{ 'has-header': showHeader }">
-		{{ text }}
-	</div>
-</template>
-
-<script>
-export default {
-	props: {
-		showHeader: {
-			type: Boolean,
-			default: false,
-		},
-		text: {
-			type: String,
-			default: '',
-		},
-	},
-};
-<\/script>
-
-<style scoped>
-.text {
-	padding: 12px;
-}
-
-.text.has-header {
-	padding: 0 12px;
-}
-</style>
-`)],-1),z=s("h4",{id:"available-props"},[t("Available Props "),s("a",{class:"header-anchor",href:"#available-props"},"#")],-1),N=s("ul",null,[s("li",null,[s("code",{class:""},"showHeader"),t(),s("strong",null,"boolean"),t(" \u2014 Whether the header is shown. Useful for alternative styling based on the extra/reduced space.")]),s("li",null,[s("code",{class:""},"dashboard"),t(),s("strong",null,"uuid"),t(" - The UUID string of the dashboard containing the panel.")]),s("li",null,[s("code",{class:""},"height"),t(),s("strong",null,"number"),t(" - The current configured height of the panel.")]),s("li",null,[s("code",{class:""},"width"),t(),s("strong",null,"number"),t(" - The current configured width of the panel.")]),s("li",null,[s("code",{class:""},"now"),t(),s("strong",null,"Date"),t(" - The Date object as of the moment of viewing the dashboard containing the panel.")])],-1),O=s("div",{class:"warning hint"},[s("div",{class:"hint-title"},"Vue Version"),s("p",null,"The Directus App uses Vue 3. There might be 3rd party libraries that aren\u2019t yet compatible with Vue 3.")],-1),U=s("h2",{id:"accessing-internal-systems"},[t("Accessing Internal Systems "),s("a",{class:"header-anchor",href:"#accessing-internal-systems"},"#")],-1),q=s("p",null,[t("To access internal systems like the API or the stores, you can use the "),s("code",{class:""},"useApi()"),t(" and "),s("code",{class:""},"useStores()"),t(" composables exported by the "),s("code",{class:""},"@directus/extensions-sdk"),t(" package. They can be used inside a "),s("code",{class:""},"setup()"),t(" function like this:")],-1),F=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),t(" { useApi, useStores } "),s("span",{class:"hljs-keyword"},"from"),t(),s("span",{class:"hljs-string"},"'@directus/extensions-sdk'"),t(`;
-
-`),s("span",{class:"hljs-keyword"},"export"),t(),s("span",{class:"hljs-keyword"},"default"),t(` {
-	`),s("span",{class:"hljs-function"},[s("span",{class:"hljs-title"},"setup"),t("("),s("span",{class:"hljs-params"}),t(")")]),t(` {
-		`),s("span",{class:"hljs-keyword"},"const"),t(` api = useApi();
-
-		`),s("span",{class:"hljs-keyword"},"const"),t(` { useCollectionsStore } = useStores();
-		`),s("span",{class:"hljs-keyword"},"const"),t(` collectionsStore = useCollectionsStore();
-
-		`),s("span",{class:"hljs-comment"},"// ..."),t(`
-	},
-};
-`)])],-1),L=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Vue Options API"),s("p",null,[t("If you prefer to use the Vue Options API, you can inject the "),s("code",{class:""},"api"),t(" and "),s("code",{class:""},"stores"),t(" properties directly.")])],-1),G={title:"Custom Panels",modularExtension:!0},J={name:"panels",setup(K,{expose:i}){return i({frontmatter:{title:"Custom Panels",modularExtension:!0}}),(M,Q)=>{const n=o("router-link"),c=o("docswrapper");return r(),h(c,{frontmatter:G},{default:e(()=>[s("div",d,[s("blockquote",null,[s("p",null,[p,a(n,{to:"/docs/app/insights"},{default:e(()=>[u]),_:1}),_,a(n,{to:"/docs/getting-started/glossary/#panels"},{default:e(()=>[m]),_:1}),f])]),g,y,j,b,w,s("ul",null,[x,k,s("li",null,[v,T,a(n,{to:"/docs/getting-started/glossary/#material-icons"},{default:e(()=>[A]),_:1}),V]),C,P,I,S,D]),E,B,H,W,z,N,O,U,q,F,L])]),_:1})}}};typeof l=="function"&&l(J);export{J as default,G as frontmatter};

package/dist/assets/permissions.f84f8d42.js

@@ -1,178 +0,0 @@
-import{a as n,o as c,b as h,w as t,g as s,e as l,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};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"},v=s("p",null,[s("code",{class:""},"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the permission rule.")],-1),P=s("code",{class:""},"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",{class:""},"null",-1),D=e(" is used for public permissions."),C=s("p",null,[s("code",{class:""},"collection"),e(),s("strong",null,"string"),s("br"),e(" Collection this permission rule applies to.")],-1),L=s("p",null,[s("code",{class:""},"action"),e(),s("strong",null,"string"),s("br"),e(" What CRUD operation this permission rule applies to. One of "),s("code",{class:""},"create"),e(", "),s("code",{class:""},"read"),e(", "),s("code",{class:""},"update"),e(", "),s("code",{class:""},"delete"),e(".")],-1),Q=s("code",{class:""},"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",{class:""},"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",{class:""},"preset"),e(),s("strong",null,"object"),s("br"),e(" Additional default values for the role.")],-1),X=s("p",null,[s("code",{class:""},"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"},as=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),ls=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"),is=e("."),os=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",{class:""},`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",{class:""},`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),vs=s("hr",null,null,-1),Ps=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",{class:""},`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",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	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",{class:""},"action"),e(" and "),s("code",{class:""},"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",{class:""},`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",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	create_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"),ae=e("."),le=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",{class:""},"action"),e(" and "),s("code",{class:""},"collection"),e(" are required.")],-1),re=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),ie=s("p",null,[e("Returns the "),s("a",{href:"#the-permission-object"},"permission objects"),e(" for the created permissions.")],-1),oe=s("div",{class:"right"},[s("h3",{id:"rest-api-4"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",{class:""},`POST /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",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	create_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",{class:""},`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",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	update_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),ve=s("hr",null,null,-1),Pe=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",{class:""},"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",{class:""},"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",{class:""},`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",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	update_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",{class:""},`DELETE /permissions/:id
-`)]),s("h5",{id:"example-12"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /permissions/34
-`)]),s("h3",{id:"graphql-7"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	delete_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",{class:""},`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",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	delete_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),ze={title:"Permissions",modularExtension:!1,pageClass:"page-reference"},Je={name:"permissions",setup(Ke,{expose:i}){return i({frontmatter:{title:"Permissions",modularExtension:!1,pageClass:"page-reference"}}),(Xe,Ye)=>{const a=n("router-link"),o=n("docswrapper");return c(),h(o,{frontmatter:ze},{default:t(()=>[s("div",d,[s("div",p,[s("div",u,[s("blockquote",null,[s("p",null,[_,l(a,{to:"/docs/getting-started/glossary/#permissions"},{default:t(()=>[m]),_:1}),g])])]),f]),j,y,s("div",b,[s("div",q,[s("div",x,[v,s("p",null,[P,E,R,w,T,l(a,{to:"/docs/reference/system/roles/"},{default:t(()=>[k]),_:1}),S,A,D]),C,L,s("p",null,[Q,I,M,O,G,l(a,{to:"/docs/configuration/filter-rules"},{default:t(()=>[B]),_:1}),U]),s("p",null,[H,F,W,N,V,l(a,{to:"/docs/configuration/filter-rules"},{default:t(()=>[z]),_:1}),J]),K,X])]),Y]),Z,$,ss,s("div",es,[s("div",ts,[as,ls,s("p",null,[ns,l(a,{to:"/docs/reference/query"},{default:t(()=>[rs]),_:1}),is]),os,s("p",null,[cs,l(a,{to:"/docs/reference/query/#limit"},{default:t(()=>[hs]),_:1}),ds,ps,us])]),s("div",_s,[ms,gs,s("p",null,[l(a,{to:"/docs/reference/introduction/#search-http-method"},{default:t(()=>[fs]),_:1})]),js,ys,bs,qs,xs])]),vs,Ps,Es,s("div",Rs,[s("div",ws,[Ts,s("p",null,[ks,l(a,{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,l(a,{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,l(a,{to:"/docs/reference/query"},{default:t(()=>[te]),_:1}),ae]),le,ne,re,ie]),oe]),ce,he,de,s("div",pe,[s("div",ue,[_e,s("p",null,[me,l(a,{to:"/docs/reference/query"},{default:t(()=>[ge]),_:1}),fe]),je,ye,be,qe]),xe]),ve,Pe,Ee,s("div",Re,[s("div",we,[Te,s("p",null,[ke,l(a,{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})}}};typeof r=="function"&&r(Je);export{Je as default,ze as frontmatter};