@directus/app 9.14.1 → 9.14.2

package/dist/assets/items.d9c6a0b4.js

@@ -1,136 +0,0 @@
-import{a as r,o as c,b as d,w as s,g as e,e as l,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";const h={class:"markdown-body"},u={class:"two-up"},p={class:"left"},_=t("Items are individual pieces of data in your database. They can be anything, from articles, to IoT status checks. "),m=t("Learn more about Items"),f=t("."),g=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-item-object"},"The Item Object ")]),e("li",null,[e("a",{href:"#get-items"},"Get Items ")]),e("li",null,[e("a",{href:"#get-item-by-id"},"Get Item by ID ")]),e("li",null,[e("a",{href:"#create-an-item"},"Create an Item ")]),e("li",null,[e("a",{href:"#create-multiple-items"},"Create Multiple Items ")]),e("li",null,[e("a",{href:"#update-an-item"},"Update an Item ")]),e("li",null,[e("a",{href:"#update-multiple-items"},"Update Multiple Items ")]),e("li",null,[e("a",{href:"#delete-an-item"},"Delete an Item ")]),e("li",null,[e("a",{href:"#delete-multiple-items"},"Delete Multiple Items ")])])])])],-1),b=e("hr",null,null,-1),x=e("h2",{id:"the-item-object",tabindex:"-1"},[t("The Item Object "),e("a",{class:"header-anchor",href:"#the-item-object"},"#")],-1),y={class:"two-up"},j={class:"left"},q=e("p",null,[t("Items don\u2019t have a pre-defined schema. The format depends completely on how you configured your collections and fields in Directus. For the sake of documentation, we\u2019ll use a fictional articles collection with the following fields: "),e("code",null,"id"),t(", "),e("code",null,"status"),t(", "),e("code",null,"title"),t(", "),e("code",null,"body"),t(", "),e("code",null,"featured_image"),t(", and "),e("code",null,"author"),t(".")],-1),v={class:"tip hint"},w=e("div",{class:"hint-title"},"Relational Data",-1),E=t("Please see "),T=t("Relational Data"),I=t(" and "),P=t("Field Parameters"),R=t(" to learn more."),S=e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[t(`{
-	`),e("span",{class:"hljs-attr"},'"id"'),t(": "),e("span",{class:"hljs-number"},"1"),t(`,
-	`),e("span",{class:"hljs-attr"},'"status"'),t(": "),e("span",{class:"hljs-string"},'"published"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"title"'),t(": "),e("span",{class:"hljs-string"},'"Hello, world!"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"body"'),t(": "),e("span",{class:"hljs-string"},'"This is my first article"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"featured_image"'),t(": "),e("span",{class:"hljs-string"},'"768eabec-3c54-4110-a6bb-64b548116661"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"author"'),t(": "),e("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),t(`
-}
-`)])])],-1),D=e("hr",null,null,-1),A=e("h2",{id:"get-items",tabindex:"-1"},[t("Get Items "),e("a",{class:"header-anchor",href:"#get-items"},"#")],-1),k=e("p",null,"List all items that exist in Directus.",-1),C={class:"two-up"},G={class:"left"},Q=e("h3",{id:"query-parameters",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),L=t("Supports all "),O=t("global query parameters"),H=t("."),M={class:"tip hint"},B=e("div",{class:"hint-title"},"Relational Data",-1),U=t("The "),F=t("Field Parameter"),N=t(" is required to return nested relational data."),V=e("h3",{id:"returns",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),z=t("An array of up to "),J=t("limit"),K=t(),W=e("a",{href:"#the-item-object"},"item objects",-1),X=t(". If no items are available, data will be an empty array."),Y=e("h4",{id:"singleton",tabindex:"-1"},[t("Singleton "),e("a",{class:"header-anchor",href:"#singleton"},"#")],-1),Z=e("p",null,"If your collection is a singleton, this endpoint will return the item. If the item doesn\u2019t exist in the database, the default values will be returned.",-1),$={class:"right"},ee=e("h3",{id:"rest-api",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),te=e("pre",null,[e("code",null,`GET /items/:collection
-SEARCH /items/:collection
-`)],-1),se=t("Learn more about SEARCH ->"),ae=e("h5",{id:"example",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example"},"#")],-1),le=e("pre",null,[e("code",null,`GET /items/articles
-`)],-1),ne=e("h3",{id:"graphql",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),re=e("pre",null,[e("code",null,`POST /graphql
-`)],-1),ie=e("pre",null,[e("code",{class:"language-graphql"},`type Query {
-	<collection>: [<collection>]
-}
-`)],-1),oe=e("h5",{id:"example-1",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-1"},"#")],-1),ce=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),t(` {
-	articles {
-		id
-		title
-		author {
-			first_name
-		}
-	}
-}
-`)])],-1),de=e("hr",null,null,-1),he=e("h2",{id:"get-item-by-id",tabindex:"-1"},[t("Get Item by ID "),e("a",{class:"header-anchor",href:"#get-item-by-id"},"#")],-1),ue=e("p",null,"Get an item that exists in Directus.",-1),pe={class:"two-up"},_e={class:"left"},me=e("h3",{id:"query-parameters-1",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),fe=t("Supports all "),ge=t("global query parameters"),be=t("."),xe=e("h3",{id:"returns-1",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-1"},"#")],-1),ye=e("p",null,[t("Returns an "),e("a",{href:"#the-item-object"},"item object"),t(" if a valid primary key was provided.")],-1),je=e("div",{class:"right"},[e("h3",{id:"rest-api-1",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),e("pre",null,[e("code",null,`GET /items/:collection/:id
-`)]),e("h5",{id:"example-2",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",null,`GET /items/articles/15
-`)]),e("h3",{id:"graphql-1",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-1"},"#")]),e("pre",null,[e("code",null,`POST /graphql
-`)]),e("pre",null,[e("code",{class:"language-graphql"},`type Query {
-	<collection>_by_id(id: ID!): <collection>
-}
-`)]),e("h5",{id:"example-3",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),t(` {
-	articles_by_id(id: `),e("span",{class:"hljs-number"},"15"),t(`) {
-		id
-		title
-	}
-}
-`)])])],-1),qe=e("hr",null,null,-1),ve=e("h2",{id:"create-an-item",tabindex:"-1"},[t("Create an Item "),e("a",{class:"header-anchor",href:"#create-an-item"},"#")],-1),we=e("p",null,"Create a new item in the given collection.",-1),Ee={class:"two-up"},Te={class:"left"},Ie=e("h3",{id:"query-parameters-2",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Pe=t("Supports all "),Re=t("global query parameters"),Se=t("."),De=e("h3",{id:"request-body",tabindex:"-1"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ae=e("p",null,[t("An array of partial "),e("a",{href:"#the-item-object"},"item objects"),t(".")],-1),ke={class:"tip hint"},Ce=e("div",{class:"hint-title"},"Relational Data",-1),Ge=t("Relational data needs to be correctly nested to add new items successfully. Check out the "),Qe=t("relational data section"),Le=t(" for more information."),Oe=e("h3",{id:"returns-2",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),He=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item objects"),t(" of the item that were created.")],-1),Me=e("div",{class:"right"},[e("h3",{id:"rest-api-2",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`POST /items/:collection
-`)]),e("h5",{id:"example-4",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",null,`POST /items/articles
-`)]),e("pre",null,[e("code",{class:"language-json"},[t(`{
-	`),e("span",{class:"hljs-attr"},'"title"'),t(": "),e("span",{class:"hljs-string"},'"Hello world!"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"body"'),t(": "),e("span",{class:"hljs-string"},'"This is our first article"'),t(`
-}
-`)])]),e("h3",{id:"graphql-2",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql
-`)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
-	create_<collection>_item(data: create_<collection>_input): <collection>
-}
-`)]),e("h5",{id:"example-5",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	create_articles_item(data: { title: `),e("span",{class:"hljs-string"},'"Hello world!"'),t(", body: "),e("span",{class:"hljs-string"},'"This is our first article"'),t(` }) {
-		id
-		title
-	}
-}
-`)])])],-1),Be=e("hr",null,null,-1),Ue=e("h2",{id:"create-multiple-items",tabindex:"-1"},[t("Create Multiple Items "),e("a",{class:"header-anchor",href:"#create-multiple-items"},"#")],-1),Fe=e("p",null,"Create new items in the given collection.",-1),Ne={class:"two-up"},Ve={class:"left"},ze=e("h3",{id:"query-parameters-3",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Je=t("Supports all "),Ke=t("global query parameters"),We=t("."),Xe=e("h3",{id:"request-body-1",tabindex:"-1"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-1"},"#")],-1),Ye=e("p",null,[t("An array of partial "),e("a",{href:"#the-item-object"},"item objects"),t(".")],-1),Ze=e("h3",{id:"returns-3",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),$e=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item objects"),t(" of the item that were created.")],-1),et=e("div",{class:"right"},[e("h3",{id:"rest-api-3",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /items/:collection
-`)]),e("h5",{id:"example-6",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",null,`POST /items/articles
-`)]),e("pre",null,[e("code",{class:"language-json"},[t(`[
-	{
-		`),e("span",{class:"hljs-attr"},'"title"'),t(": "),e("span",{class:"hljs-string"},'"Hello world!"'),t(`,
-		`),e("span",{class:"hljs-attr"},'"body"'),t(": "),e("span",{class:"hljs-string"},'"This is our first article"'),t(`
-	},
-	{
-		`),e("span",{class:"hljs-attr"},'"title"'),t(": "),e("span",{class:"hljs-string"},'"Hello again, world!"'),t(`,
-		`),e("span",{class:"hljs-attr"},'"body"'),t(": "),e("span",{class:"hljs-string"},'"This is our second article"'),t(`
-	}
-]
-`)])]),e("h3",{id:"graphql-3",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql
-`)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
-	create_<collection>_items(data: [create_<collection>_input]): [<collection>]
-}
-`)]),e("h5",{id:"example-7",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	create_articles_items(
-		data: [
-			{ title: `),e("span",{class:"hljs-string"},'"Hello world!"'),t(", body: "),e("span",{class:"hljs-string"},'"This is our first article"'),t(` }
-			{ title: `),e("span",{class:"hljs-string"},'"Hello again, world!"'),t(", body: "),e("span",{class:"hljs-string"},'"This is our second article"'),t(` }
-		]
-	) {
-		id
-		title
-	}
-}
-`)])])],-1),tt=e("hr",null,null,-1),st=e("h2",{id:"update-an-item",tabindex:"-1"},[t("Update an Item "),e("a",{class:"header-anchor",href:"#update-an-item"},"#")],-1),at=e("p",null,"Update an existing item.",-1),lt={class:"two-up"},nt={class:"left"},rt=e("h3",{id:"query-parameters-4",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),it=t("Supports all "),ot=t("global query parameters"),ct=t("."),dt=e("h3",{id:"request-body-2",tabindex:"-1"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),ht=e("p",null,[t("A partial "),e("a",{href:"#the-item-object"},"item object"),t(".")],-1),ut=e("h3",{id:"returns-4",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),pt=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item object"),t(" of the item that was updated.")],-1),_t=e("div",{class:"right"},[e("h3",{id:"rest-api-4",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`PATCH /items/:collection/:id
-`)]),e("h5",{id:"example-8",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",null,`PATCH /items/articles/15
-`)]),e("pre",null,[e("code",{class:"language-json"},[t(`{
-	`),e("span",{class:"hljs-attr"},'"title"'),t(": "),e("span",{class:"hljs-string"},'"An updated title"'),t(`
-}
-`)])]),e("h3",{id:"graphql-4",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",null,`POST /graphql
-`)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
-	update_<collection>_item(id: ID!, data: update_<collection>_input!): <collection>
-}
-`)]),e("h5",{id:"example-9",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	update_articles_item(id: `),e("span",{class:"hljs-number"},"15"),t(", data: { title: "),e("span",{class:"hljs-string"},'"An updated title"'),t(` }) {
-		id
-		title
-	}
-}
-`)])])],-1),mt=e("hr",null,null,-1),ft=e("h2",{id:"update-multiple-items",tabindex:"-1"},[t("Update Multiple Items "),e("a",{class:"header-anchor",href:"#update-multiple-items"},"#")],-1),gt=e("p",null,"Update multiple items at the same time.",-1),bt={class:"two-up"},xt={class:"left"},yt=e("h3",{id:"query-parameters-5",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),jt=t("Supports all "),qt=t("global query parameters"),vt=t("."),wt=e("h3",{id:"request-body-3",tabindex:"-1"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Et=e("p",null,[t("Object containing "),e("code",null,"data"),t(" for the values to set, and either "),e("code",null,"keys"),t(" or "),e("code",null,"query"),t(" to select what items to update.")],-1),Tt=e("h3",{id:"returns-5",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),It=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item objects"),t(" for the updated items.")],-1),Pt=e("h4",{id:"singleton-1",tabindex:"-1"},[t("Singleton "),e("a",{class:"header-anchor",href:"#singleton-1"},"#")],-1),Rt=e("p",null,[t("If your collection is a singleton, this endpoint will act the same as the "),e("a",{href:"#update-an-item"},"Update an Item"),t(" endpoint.")],-1),St=e("div",{class:"right"},[e("h3",{id:"rest-api-5",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /items/:collection
-`)]),e("h5",{id:"example-10",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),e("pre",null,[e("code",null,`PATCH /items/articles
-`)]),e("pre",null,[e("code",{class:"language-json"},[t(`{
-	`),e("span",{class:"hljs-attr"},'"keys"'),t(": ["),e("span",{class:"hljs-number"},"1"),t(", "),e("span",{class:"hljs-number"},"2"),t(`],
-	`),e("span",{class:"hljs-attr"},'"data"'),t(`: {
-		`),e("span",{class:"hljs-attr"},'"status"'),t(": "),e("span",{class:"hljs-string"},'"published"'),t(`
-	}
-}
-`)])]),e("h3",{id:"graphql-5",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",null,`POST /graphql
-`)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
-	update_<collection>_items(ids: [ID!]!, data: [update_<collection>_input]): [<collection>]
-}
-`)]),e("h5",{id:"example-11",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	update_articles_items(ids: [`),e("span",{class:"hljs-number"},"1"),t(", "),e("span",{class:"hljs-number"},"2"),t("], data: { status: "),e("span",{class:"hljs-string"},'"published"'),t(` }) {
-		id
-		status
-	}
-}
-`)])])],-1),Dt=e("hr",null,null,-1),At=e("h2",{id:"delete-an-item",tabindex:"-1"},[t("Delete an Item "),e("a",{class:"header-anchor",href:"#delete-an-item"},"#")],-1),kt=e("p",null,"Delete an existing item.",-1),Ct=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"returns-6",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-6",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`DELETE /items/:collection/:id
-`)]),e("h5",{id:"example-12",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),e("pre",null,[e("code",null,`DELETE /items/articles/15
-`)]),e("h3",{id:"graphql-6",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",null,`POST /graphql
-`)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
-	delete_<collection>_item(id: ID!): delete_one
-}
-`)]),e("h5",{id:"example-13",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-13"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	delete_articles_item(id: `),e("span",{class:"hljs-number"},"15"),t(`) {
-		id
-	}
-}
-`)])])])],-1),Gt=e("hr",null,null,-1),Qt=e("h2",{id:"delete-multiple-items",tabindex:"-1"},[t("Delete Multiple Items "),e("a",{class:"header-anchor",href:"#delete-multiple-items"},"#")],-1),Lt=e("p",null,"Delete multiple existing items.",-1),Ot=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-4",tabindex:"-1"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")]),e("p",null,"An array of item primary keys."),e("h3",{id:"returns-7",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",null,`DELETE /items/:collection
-`)]),e("h5",{id:"example-14",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-14"},"#")]),e("pre",null,[e("code",null,`DELETE /items/articles
-`)]),e("pre",null,[e("code",{class:"language-json"},[t("["),e("span",{class:"hljs-number"},"15"),t(", "),e("span",{class:"hljs-number"},"16"),t(", "),e("span",{class:"hljs-number"},"21"),t(`]
-`)])]),e("h3",{id:"graphql-7",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-7"},"#")]),e("pre",null,[e("code",null,`POST /graphql
-`)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
-	delete_<collection>_items(ids: [ID!]!): delete_many
-}
-`)]),e("h5",{id:"example-15",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-15"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	delete_articles_items(ids: [`),e("span",{class:"hljs-number"},"15"),t(", "),e("span",{class:"hljs-number"},"16"),t(", "),e("span",{class:"hljs-number"},"21"),t(`]) {
-		ids
-	}
-}
-`)])])])],-1),Ft="Accessing Items",Nt=!1,Vt="page-reference",zt={name:"items",setup(Ht,{expose:i}){const n={title:"Accessing Items",modularExtension:!1,pageClass:"page-reference"};return i({frontmatter:n}),(Mt,Bt)=>{const a=r("router-link"),o=r("docs-wrapper");return c(),d(o,{frontmatter:n},{default:s(()=>[e("div",h,[e("div",u,[e("div",p,[e("blockquote",null,[e("p",null,[_,l(a,{to:"/docs/getting-started/glossary/#items"},{default:s(()=>[m]),_:1}),f])])]),g]),b,x,e("div",y,[e("div",j,[q,e("div",v,[w,e("p",null,[E,l(a,{to:"/docs/reference/introduction/#relational-data"},{default:s(()=>[T]),_:1}),I,l(a,{to:"/docs/reference/query/#fields"},{default:s(()=>[P]),_:1}),R])])]),S]),D,A,k,e("div",C,[e("div",G,[Q,e("p",null,[L,l(a,{to:"/docs/reference/query"},{default:s(()=>[O]),_:1}),H]),e("div",M,[B,e("p",null,[U,l(a,{to:"/docs/reference/query/#fields"},{default:s(()=>[F]),_:1}),N])]),V,e("p",null,[z,l(a,{to:"/docs/reference/query/#limit"},{default:s(()=>[J]),_:1}),K,W,X]),Y,Z]),e("div",$,[ee,te,e("p",null,[l(a,{to:"/docs/reference/introduction/#search-http-method"},{default:s(()=>[se]),_:1})]),ae,le,ne,re,ie,oe,ce])]),de,he,ue,e("div",pe,[e("div",_e,[me,e("p",null,[fe,l(a,{to:"/docs/reference/query"},{default:s(()=>[ge]),_:1}),be]),xe,ye]),je]),qe,ve,we,e("div",Ee,[e("div",Te,[Ie,e("p",null,[Pe,l(a,{to:"/docs/reference/query"},{default:s(()=>[Re]),_:1}),Se]),De,Ae,e("div",ke,[Ce,e("p",null,[Ge,l(a,{to:"/docs/reference/introduction/#relational-data"},{default:s(()=>[Qe]),_:1}),Le])]),Oe,He]),Me]),Be,Ue,Fe,e("div",Ne,[e("div",Ve,[ze,e("p",null,[Je,l(a,{to:"/docs/reference/query"},{default:s(()=>[Ke]),_:1}),We]),Xe,Ye,Ze,$e]),et]),tt,st,at,e("div",lt,[e("div",nt,[rt,e("p",null,[it,l(a,{to:"/docs/reference/query"},{default:s(()=>[ot]),_:1}),ct]),dt,ht,ut,pt]),_t]),mt,ft,gt,e("div",bt,[e("div",xt,[yt,e("p",null,[jt,l(a,{to:"/docs/reference/query"},{default:s(()=>[qt]),_:1}),vt]),wt,Et,Tt,It,Pt,Rt]),St]),Dt,At,kt,Ct,Gt,Qt,Lt,Ot])]),_:1})}}};export{zt as default,Nt as modularExtension,Vt as pageClass,Ft as title};

package/dist/assets/manual.20d730b3.js

@@ -1,12 +0,0 @@
-import{a as l,o as c,b as d,w as o,g as t,e as n,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";const _={class:"markdown-body"},h={class:"tip hint"},u=t("div",{class:"hint-title"},"Automation",-1),p=e("We\u2019ve created a little CLI tool you can run that does this process automatically. For more info, check the doc on "),f=e("installing through the CLI"),g=e("."),m=t("h2",{id:"1.-setup-a-project-folder",tabindex:"-1"},[e("1. Setup a Project Folder "),t("a",{class:"header-anchor",href:"#1.-setup-a-project-folder"},"#")],-1),b=t("p",null,[e("Create a new directory, and add a "),t("code",null,"package.json"),e(" by running the following command.")],-1),v=t("pre",null,[t("code",{class:"language-bash"},`npm init -y
-`)],-1),x=e("We recommend aliasing the "),y=t("code",null,"start",-1),k=e(" script to Directus\u2019 start for easier deployments to services like "),w=e("AWS"),C=e(", "),I=e("Google Cloud Platform"),S=e(" or "),j=e("DigitalOcean App Platform"),B=e("."),D=t("pre",null,[t("code",{class:"language-json"},`{
-	...
-	"scripts": {
-		"start": "directus start"
-	}
-	...
-}
-`)],-1),F=t("h2",{id:"2.-install-directus",tabindex:"-1"},[e("2. Install Directus "),t("a",{class:"header-anchor",href:"#2.-install-directus"},"#")],-1),V=t("pre",null,[t("code",{class:"language-bash"},`npm install directus
-`)],-1),A=t("h2",{id:"3.-setup-a-configuration-file",tabindex:"-1"},[e("3. Setup a Configuration File "),t("a",{class:"header-anchor",href:"#3.-setup-a-configuration-file"},"#")],-1),E=t("p",null,[e("Finally, you\u2019ll need to setup your "),t("code",null,".env"),e(" file, or configure the environment variables through other means, such as Docker, etc.")],-1),N=t("p",null,[t("strong",null,"Don\u2019t forget to fill your database information before continuing to next step")],-1),P=e("See "),W=e("Environment Variables"),L=e(" for all available variables."),M=t("h2",{id:"4.-bootstrap-it",tabindex:"-1"},[e("4. Bootstrap It "),t("a",{class:"header-anchor",href:"#4.-bootstrap-it"},"#")],-1),G=t("pre",null,[t("code",{class:"language-bash"},`npx directus bootstrap
-`)],-1),O=t("h2",{id:"5.-start-server",tabindex:"-1"},[e("5. Start Server "),t("a",{class:"header-anchor",href:"#5.-start-server"},"#")],-1),T=t("pre",null,[t("code",{class:"language-bash"},`npm run start
-`)],-1),K="Installing Manually",Q=!1,R={name:"manual",setup(q,{expose:i}){const a={title:"Installing Manually",modularExtension:!1};return i({frontmatter:a}),(z,H)=>{const s=l("router-link"),r=l("docs-wrapper");return c(),d(r,{frontmatter:a},{default:o(()=>[t("div",_,[t("div",h,[u,t("p",null,[p,n(s,{to:"/docs/self-hosted/installation/cli/"},{default:o(()=>[f]),_:1}),g])]),m,b,v,t("p",null,[x,y,k,n(s,{to:"/docs/self-hosted/installation/aws/"},{default:o(()=>[w]),_:1}),C,n(s,{to:"/docs/self-hosted/installation/gcp"},{default:o(()=>[I]),_:1}),S,n(s,{to:"/docs/self-hosted/installation/digitalocean-app-platform/"},{default:o(()=>[j]),_:1}),B]),D,F,V,A,E,N,t("p",null,[P,n(s,{to:"/docs/self-hosted/config-options/#general"},{default:o(()=>[W]),_:1}),L]),M,G,O,T])]),_:1})}}};export{R as default,Q as modularExtension,K as title};

package/dist/assets/migrations.f13ec64d.js

@@ -1,19 +0,0 @@
-import{a as l,o,b as r,w as i,g as a,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";const c=a("div",{class:"markdown-body"},[a("blockquote",null,[a("p",null,[e("Directus allows adding custom migration files that run whenever the "),a("code",null,"directus database migrate:*"),e(" commands are executed. All migrations must reside in the "),a("code",null,"extensions/migrations"),e(" folder.")])]),a("h2",{id:"file-name",tabindex:"-1"},[e("File Name "),a("a",{class:"header-anchor",href:"#file-name"},"#")]),a("p",null,"The file name follows the following structure:"),a("pre",null,[a("code",null,`[identifier]-[name].js
-`)]),a("p",null,"for example:"),a("pre",null,[a("code",null,`20201202A-my-custom-migration.js
-`)]),a("h2",{id:"structure",tabindex:"-1"},[e("Structure "),a("a",{class:"header-anchor",href:"#structure"},"#")]),a("p",null,[e("Migrations have to export an "),a("code",null,"up"),e(" and a "),a("code",null,"down"),e(" function. These functions get a "),a("a",{href:"http://knexjs.org",target:"_blank",rel:"noopener noreferrer"},"Knex"),e(" instance that can be used to do virtually whatever.")]),a("pre",null,[a("code",{class:"language-js"},[a("span",{class:"hljs-built_in"},"module"),e(`.exports = {
-	`),a("span",{class:"hljs-keyword"},"async"),e(),a("span",{class:"hljs-function"},[a("span",{class:"hljs-title"},"up"),e("("),a("span",{class:"hljs-params"},"knex"),e(")")]),e(` {
-		`),a("span",{class:"hljs-keyword"},"await"),e(" knex.schema.createTable("),a("span",{class:"hljs-string"},"'test'"),e(", "),a("span",{class:"hljs-function"},[e("("),a("span",{class:"hljs-params"},"table"),e(") =>")]),e(` {
-			table.increments();
-			table.string(`),a("span",{class:"hljs-string"},"'rijk'"),e(`);
-		});
-	},
-
-	`),a("span",{class:"hljs-keyword"},"async"),e(),a("span",{class:"hljs-function"},[a("span",{class:"hljs-title"},"down"),e("("),a("span",{class:"hljs-params"},"knex"),e(")")]),e(` {
-		`),a("span",{class:"hljs-keyword"},"await"),e(" knex.schema.dropTable("),a("span",{class:"hljs-string"},"'test'"),e(`);
-	},
-};
-`)])]),a("div",{class:"danger hint"},[a("div",{class:"hint-title"},"Danger"),a("p",null,"Seeing that these migrations are a bit of a free-for-all, you can really harm your database. Please make sure you know what you\u2019re doing and backup your database before adding these migrations.")]),a("h2",{id:"migrations-and-directus-schema",tabindex:"-1"},[e("Migrations and Directus schema "),a("a",{class:"header-anchor",href:"#migrations-and-directus-schema"},"#")]),a("p",null,[e("Migrations can be used for managing contents of Directus collections (e.g. initial hydration). In order to do it, you must ensure that schema is up to date before running migrations. One way of achieving it is opting out of default "),a("code",null,"directus bootstrap"),e(" process and running:")]),a("pre",null,[a("code",{class:"language-bash"},[e(`npx directus database install
-`),a("span",{class:"hljs-comment"},"# notice that schema is applied before running migrations"),e(`
-npx directus schema apply ./path/to/snapshot.yaml
-npx directus database migrate:latest
-`)])]),a("p",null,[e("You may want to add additional steps to reflect other responsibilities of "),a("code",null,"directus bootstrap"),e(".")])],-1),m="Custom Migrations",g=!1,f={name:"migrations",setup(u,{expose:t}){const s={title:"Custom Migrations",modularExtension:!1};return t({frontmatter:s}),(d,p)=>{const n=l("docs-wrapper");return o(),r(n,{frontmatter:s},{default:i(()=>[c]),_:1})}}};export{f as default,g as modularExtension,m as title};

package/dist/assets/notifications.674ee6f9.js

@@ -1,153 +0,0 @@
-import{a as l,o as c,b as h,w as s,g as e,e as n,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";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",tabindex:"-1"},[t("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",null,"id"),t(),e("strong",null,"integer"),e("br"),t(" Primary key of the revision.")]),e("p",null,[e("code",null,"timestamp"),t(),e("strong",null,"string"),e("br"),t(" Timestamp in ISO8601 when the notification was created.")]),e("p",null,[e("code",null,"status"),t(),e("strong",null,"string"),e("br"),t(" Current status of the notification. One of \u201Cinbox\u201D, \u201Carchived\u201D.")]),e("p",null,[e("code",null,"recipient"),t(),e("strong",null,"many-to-one"),e("br"),t(" User that received the notification.")]),e("p",null,[e("code",null,"sender"),t(),e("strong",null,"many-to-one"),e("br"),t(" User that sent the notification, if any.")]),e("p",null,[e("code",null,"subject"),t(),e("strong",null,"string"),e("br"),t(" Subject line of the message.")]),e("p",null,[e("code",null,"message"),t(),e("strong",null,"string"),e("br"),t(" Notification\u2019s message content. Will be sent in the email.")]),e("p",null,[e("code",null,"collection"),t(),e("strong",null,"string"),e("br"),t(" Collection this notification references.")]),e("p",null,[e("code",null,"item"),t(),e("strong",null,"string"),e("br"),t(" Primary key of the item this notification references.")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[t(`{
-	`),e("span",{class:"hljs-attr"},'"id"'),t(": "),e("span",{class:"hljs-number"},"2"),t(`,
-	`),e("span",{class:"hljs-attr"},'"timestamp"'),t(": "),e("span",{class:"hljs-string"},'"2021-11-24T13:57:35Z"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"status"'),t(": "),e("span",{class:"hljs-string"},'"inbox"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"recipient"'),t(": "),e("span",{class:"hljs-string"},'"3EE34828-B43C-4FB2-A721-5151579B08EA"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"sender"'),t(": "),e("span",{class:"hljs-string"},'"497a495e-5529-4e46-8feb-2f35e9b85601"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"subject"'),t(": "),e("span",{class:"hljs-string"},'"You were mentioned in articles"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"message"'),t(": "),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"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"collection"'),t(": "),e("span",{class:"hljs-string"},'"articles"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"item"'),t(": "),e("span",{class:"hljs-string"},'"1"'),t(`
-}
-`)])])])],-1),m=e("hr",null,null,-1),g=e("h2",{id:"list-notifications",tabindex:"-1"},[t("List Notifications "),e("a",{class:"header-anchor",href:"#list-notifications"},"#")],-1),b=e("p",null,"List all notifications that exist in Directus.",-1),j={class:"two-up"},y={class:"left"},x=e("h3",{id:"query-parameters",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),q=t("Supports all "),E=t("global query parameters"),v=t("."),w=e("h3",{id:"returns",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),T=t("An array of up to "),k=t("limit"),P=t(),R=e("a",{href:"#the-notification-object"},"notification objects",-1),S=t(". If no items are available, data will be an empty array."),N={class:"right"},A=e("h3",{id:"rest-api",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),C=e("pre",null,[e("code",null,`GET /notifications
-SEARCH /notifications
-`)],-1),L=t("Learn more about SEARCH ->"),D=e("h3",{id:"graphql",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),O=e("pre",null,[e("code",null,`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"),t(` {
-	notifications: [directus_notifications]
-}
-`)])],-1),I=e("h5",{id:"example",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example"},"#")],-1),H=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),t(` {
-	notifications {
-		id
-		recipient
-		subject
-	}
-}
-`)])],-1),B=e("hr",null,null,-1),M=e("h2",{id:"retrieve-a-notification",tabindex:"-1"},[t("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-1",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),F=t("Supports all "),W=t("global query parameters"),Z=t("."),z=e("h3",{id:"returns-1",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-1"},"#")],-1),J=e("p",null,[t("Returns the requested "),e("a",{href:"#the-notification-object"},"notification object"),t(".")],-1),K=e("div",{class:"right"},[e("h3",{id:"rest-api-1",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),e("pre",null,[e("code",null,`GET /notifications/:id
-`)]),e("h5",{id:"example-1",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-1"},"#")]),e("pre",null,[e("code",null,`GET /notifications/42
-`)]),e("h3",{id:"graphql-1",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-1"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),t(` {
-	notifications_by_id(id:`),e("span",{class:"hljs-literal"}," ID"),t(`!): directus_notifications
-}
-`)])]),e("h5",{id:"example-2",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),t(` {
-	notifications_by_id(id: `),e("span",{class:"hljs-number"},"42"),t(`) {
-		id
-		sender
-		recipient
-		message
-		subject
-	}
-}
-`)])])],-1),X=e("hr",null,null,-1),$=e("h2",{id:"create-a-notification",tabindex:"-1"},[t("Create a Notification "),e("a",{class:"header-anchor",href:"#create-a-notification"},"#")],-1),ee=e("p",null,"Create a new notification.",-1),te={class:"two-up"},se={class:"left"},ae=e("h3",{id:"query-parameters-2",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),ne=t("Supports all "),ie=t("global query parameters"),le=t("."),oe=e("h3",{id:"request-body",tabindex:"-1"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),re=e("p",null,[t("A partial "),e("a",{href:"#the-notification-object"},"notification object"),t(".")],-1),ce=e("h3",{id:"returns-2",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),he=e("p",null,[t("Returns the "),e("a",{href:"#the-notification-object"},"notification object"),t(" for the created notification.")],-1),de=e("div",{class:"right"},[e("h3",{id:"rest-api-2",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`POST /notifications
-`)]),e("h5",{id:"example-3",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /notifications"),t(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"recipient"'),t(": "),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),t(`,
-	`),e("span",{class:"hljs-attr"},'"subject"'),t(": "),e("span",{class:"hljs-string"},'"Hi there!"'),t(`
-}
-`)])]),e("h3",{id:"graphql-2",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),t(` {
-	create_notifications_item(data: create_directus_notifications_input!): directus_notifications
-}
-`)])]),e("h5",{id:"example-4",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	create_notifications_item(data: { recipient: `),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),t(", subject: "),e("span",{class:"hljs-string"},'"Hi there!"'),t(` }) {
-		id
-		recipient
-	}
-}
-`)])])],-1),pe=e("hr",null,null,-1),ue=e("h2",{id:"create-multiple-notifications",tabindex:"-1"},[t("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-3",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),be=t("Supports all "),je=t("global query parameters"),ye=t("."),xe=e("h3",{id:"request-body-1",tabindex:"-1"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-1"},"#")],-1),qe=e("p",null,[t("An array of partial "),e("a",{href:"#the-notification-object"},"notification objects"),t(".")],-1),Ee=e("h3",{id:"returns-3",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),ve=e("p",null,[t("Returns the "),e("a",{href:"#the-notification-object"},"notification object"),t(" for the created notification.")],-1),we=e("div",{class:"right"},[e("h3",{id:"rest-api-3",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /notifications
-`)]),e("h5",{id:"example-5",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /notifications"),t(`
-
-[
-	{
-		`),e("span",{class:"hljs-attr"},'"collection"'),t(": "),e("span",{class:"hljs-string"},'"directus_files"'),t(`,
-		`),e("span",{class:"hljs-attr"},'"recipient"'),t(": "),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),t(`,
-		`),e("span",{class:"hljs-attr"},'"message"'),t(": "),e("span",{class:"hljs-string"},'"Hi there! You should check out these files"'),t(`
-	},
-	{
-		`),e("span",{class:"hljs-attr"},'"collection"'),t(": "),e("span",{class:"hljs-string"},'"articles"'),t(`,
-		`),e("span",{class:"hljs-attr"},'"recipient"'),t(": "),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),t(`,
-		`),e("span",{class:"hljs-attr"},'"message"'),t(": "),e("span",{class:"hljs-string"},'"Hi there! You should check out these articles"'),t(`
-	}
-]
-`)])]),e("h3",{id:"graphql-3",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),t(` {
-	create_notifications_items(data: [create_directus_notifications_input!]!): [directus_notifications]
-}
-`)])]),e("h5",{id:"example-6",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	create_notifications_items(
-		data: [
-			{
-				collection: `),e("span",{class:"hljs-string"},'"directus_files"'),t(`
-				recipient: `),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),t(`
-				message: `),e("span",{class:"hljs-string"},'"Hi there! You should check out these files"'),t(`
-			}
-			{
-				collection: `),e("span",{class:"hljs-string"},'"articles"'),t(`
-				recipient: `),e("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),t(`
-				message: `),e("span",{class:"hljs-string"},'"Hi there! You should check out these articles"'),t(`
-			}
-		]
-	) {
-		id
-		recipient
-	}
-}
-`)])])],-1),Te=e("hr",null,null,-1),ke=e("h2",{id:"update-a-notification",tabindex:"-1"},[t("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-4",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Ce=t("Supports all "),Le=t("global query parameters"),De=t("."),Oe=e("h3",{id:"request-body-2",tabindex:"-1"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Qe=e("p",null,[t("A partial "),e("a",{href:"#the-notification-object"},"notification object"),t(".")],-1),Ie=e("h3",{id:"returns-4",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),He=e("p",null,[t("Returns the "),e("a",{href:"#the-notification-object"},"notification object"),t(" for the updated notification.")],-1),Be=e("div",{class:"right"},[e("h3",{id:"rest-api-4",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`PATCH /notifications/:id
-`)]),e("h5",{id:"example-7",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /notifications/34"),t(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"message"'),t(": "),e("span",{class:"hljs-string"},'"This is my updated notification"'),t(`
-}
-`)])]),e("h3",{id:"graphql-4",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),t(` {
-	update_notifications_item(id:`),e("span",{class:"hljs-literal"}," ID"),t(`!, data: update_directus_notifications_input): directus_notifications
-}
-`)])]),e("h5",{id:"example-8",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	update_notifications_item(id: `),e("span",{class:"hljs-number"},"32"),t(", data: { message: "),e("span",{class:"hljs-string"},'"This is my updated notification"'),t(` }) {
-		id
-		message
-	}
-}
-`)])])],-1),Me=e("hr",null,null,-1),Ge=e("h2",{id:"update-multiple-notifications",tabindex:"-1"},[t("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-5",tabindex:"-1"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),We=t("Supports all "),Ze=t("global query parameters"),ze=t("."),Je=e("h3",{id:"request-body-3",tabindex:"-1"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Ke=e("div",{class:"definitions"},[e("p",null,[e("code",null,"keys"),t(),e("strong",null,"Required"),e("br"),t(" Array of primary keys of the notifications you\u2019d like to update.")]),e("p",null,[e("code",null,"data"),t(),e("strong",null,"Required"),e("br"),t(" Any of "),e("a",{href:"#the-notification-object"},"the notification object"),t("\u2019s properties.")])],-1),Xe=e("h3",{id:"returns-5",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),$e=e("p",null,[t("Returns the "),e("a",{href:"#the-notification-object"},"notification objects"),t(" for the updated notifications.")],-1),et=e("div",{class:"right"},[e("h3",{id:"rest-api-5",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /notifications
-`)]),e("h5",{id:"example-9",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /notifications"),t(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"keys"'),t(": ["),e("span",{class:"hljs-number"},"15"),t(", "),e("span",{class:"hljs-number"},"64"),t(`],
-	`),e("span",{class:"hljs-attr"},'"data"'),t(`: {
-		`),e("span",{class:"hljs-attr"},'"message"'),t(": "),e("span",{class:"hljs-string"},'"Updated message!"'),t(`
-	}
-}
-`)])]),e("h3",{id:"graphql-5",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),t(` {
-	update_notifications_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),t(`!]!, data: update_directus_notifications_input): [directus_notifications]
-}
-`)])]),e("h5",{id:"example-10",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	update_notifications_items(ids: [`),e("span",{class:"hljs-number"},"15"),t(", "),e("span",{class:"hljs-number"},"64"),t("], data: { message: "),e("span",{class:"hljs-string"},'"Updated message!"'),t(` }) {
-		id
-		recipient
-	}
-}
-`)])])],-1),tt=e("hr",null,null,-1),st=e("h2",{id:"delete-a-notification",tabindex:"-1"},[t("Delete a Notification "),e("a",{class:"header-anchor",href:"#delete-a-notification"},"#")],-1),at=e("p",null,"Delete an existing notification.",-1),nt=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"returns-6",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-6",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`DELETE /notifications/:id
-`)]),e("h5",{id:"example-11",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),e("pre",null,[e("code",null,`DELETE /notifications/34
-`)]),e("h3",{id:"graphql-6",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),t(` {
-	delete_notifications_item(id:`),e("span",{class:"hljs-literal"}," ID"),t(`!): delete_one
-}
-`)])]),e("h5",{id:"example-12",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	delete_notifications_item(id: `),e("span",{class:"hljs-number"},"32"),t(`) {
-		id
-	}
-}
-`)])])])],-1),it=e("hr",null,null,-1),lt=e("h2",{id:"delete-multiple-notifications",tabindex:"-1"},[t("Delete Multiple Notifications "),e("a",{class:"header-anchor",href:"#delete-multiple-notifications"},"#")],-1),ot=e("p",null,"Delete multiple existing notifications.",-1),rt=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-4",tabindex:"-1"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")]),e("p",null,"An array of notification primary keys"),e("h3",{id:"returns-7",tabindex:"-1"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7",tabindex:"-1"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",null,`DELETE /notifications
-`)]),e("h5",{id:"example-13",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-13"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// DELETE /notifications"),t(`
-[`),e("span",{class:"hljs-number"},"15"),t(", "),e("span",{class:"hljs-number"},"251"),t(", "),e("span",{class:"hljs-number"},"810"),t(`]
-`)])]),e("h3",{id:"graphql-7",tabindex:"-1"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-7"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),t(` {
-	delete_notifications_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),t(`!]!): delete_many
-}
-`)])]),e("h5",{id:"example-14",tabindex:"-1"},[t("Example "),e("a",{class:"header-anchor",href:"#example-14"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),t(` {
-	delete_notifications_items(ids: [`),e("span",{class:"hljs-number"},"15"),t(", "),e("span",{class:"hljs-number"},"251"),t(", "),e("span",{class:"hljs-number"},"810"),t(`]) {
-		ids
-	}
-}
-`)])])])],-1),ut="Notifications",ft=!1,_t="page-reference",mt={name:"notifications",setup(ct,{expose:o}){const i={title:"Notifications",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:i}),(ht,dt)=>{const a=l("router-link"),r=l("docs-wrapper");return c(),h(r,{frontmatter:i},{default:s(()=>[e("div",d,[p,u,f,_,m,g,b,e("div",j,[e("div",y,[x,e("p",null,[q,n(a,{to:"/docs/reference/query"},{default:s(()=>[E]),_:1}),v]),w,e("p",null,[T,n(a,{to:"/docs/reference/query/#limit"},{default:s(()=>[k]),_:1}),P,R,S])]),e("div",N,[A,C,e("p",null,[n(a,{to:"/docs/reference/introduction/#search-http-method"},{default:s(()=>[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:s(()=>[W]),_:1}),Z]),z,J]),K]),X,$,ee,e("div",te,[e("div",se,[ae,e("p",null,[ne,n(a,{to:"/docs/reference/query"},{default:s(()=>[ie]),_:1}),le]),oe,re,ce,he]),de]),pe,ue,fe,e("div",_e,[e("div",me,[ge,e("p",null,[be,n(a,{to:"/docs/reference/query"},{default:s(()=>[je]),_:1}),ye]),xe,qe,Ee,ve]),we]),Te,ke,Pe,Re,e("div",Se,[e("div",Ne,[Ae,e("p",null,[Ce,n(a,{to:"/docs/reference/query"},{default:s(()=>[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:s(()=>[Ze]),_:1}),ze]),Je,Ke,Xe,$e]),et]),tt,st,at,nt,it,lt,ot,rt])]),_:1})}}};export{mt as default,ft as modularExtension,_t as pageClass,ut as title};