@directus/app 9.12.2 → 9.14.1

package/dist/assets/roles.9fec37da.js

@@ -1,171 +0,0 @@
-import{a as r,o as h,b as d,w as a,g as s,e as t,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const i={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=e("Roles define a specific set of access permissions, and are the primary organizational structure for Users within the platform. "),f=e("Learn more about Roles"),m=e("."),g=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-role-object"},"The Role Object")]),s("li",null,[s("a",{href:"#list-roles"},"List Roles")]),s("li",null,[s("a",{href:"#retrieve-a-role"},"Retrieve a Role")]),s("li",null,[s("a",{href:"#create-a-role"},"Create a Role")]),s("li",null,[s("a",{href:"#create-multiple-roles"},"Create Multiple Roles")]),s("li",null,[s("a",{href:"#update-a-role"},"Update a Role")]),s("li",null,[s("a",{href:"#update-multiple-roles"},"Update Multiple Roles")]),s("li",null,[s("a",{href:"#delete-a-role"},"Delete a Role")]),s("li",null,[s("a",{href:"#delete-multiple-roles"},"Delete Multiple Roles")])])])])],-1),j=s("hr",null,null,-1),y=s("h2",{id:"the-role-object"},[e("The Role Object "),s("a",{class:"header-anchor",href:"#the-role-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 role.")],-1),R=s("p",null,[s("code",{class:""},"name"),e(),s("strong",null,"string"),s("br"),e(" Name of the role.")],-1),E=s("p",null,[s("code",{class:""},"icon"),e(),s("strong",null,"string"),s("br"),e(" Icon for the role. Displayed in the Admin App.")],-1),w=s("p",null,[s("code",{class:""},"description"),e(),s("strong",null,"string"),s("br"),e(" Description for the role. Displayed in the Admin App.")],-1),T=s("p",null,[s("code",{class:""},"ip_access"),e(),s("strong",null,"csv"),s("br"),e(" CSV of IP addresses that have access to this role. Allows you to configure an allowlist of IP addresses.")],-1),P=s("p",null,[s("code",{class:""},"enforce_tfa"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not Two-Factor Authentication is required for users in this role.")],-1),k=s("p",null,[s("code",{class:""},"admin_access"),e(),s("strong",null,"boolean"),s("br"),e(" If this role is considered an admin role. This means that users in this role have full permissions to everything.")],-1),A=s("p",null,[s("code",{class:""},"app_access"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not users in this role have access to use the Admin App.")],-1),S=s("code",{class:""},"users",-1),I=e(),C=s("strong",null,"one-to-many",-1),D=s("br",null,null,-1),L=e(" The users in this role. One-to-many to "),Q=e("users"),O=e("."),M=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
-	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Admin"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"supervised_user_circle"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"description"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"ip_access"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"enforce_tfa"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`,
-	`),s("span",{class:"hljs-attr"},'"admin_access"'),e(": "),s("span",{class:"hljs-literal"},"true"),e(`,
-	`),s("span",{class:"hljs-attr"},'"app_access"'),e(": "),s("span",{class:"hljs-literal"},"true"),e(`,
-	`),s("span",{class:"hljs-attr"},'"users"'),e(": ["),s("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),e(`]
-}
-`)])])],-1),G=s("hr",null,null,-1),B=s("h2",{id:"list-roles"},[e("List Roles "),s("a",{class:"header-anchor",href:"#list-roles"},"#")],-1),U=s("p",null,"List all roles that exist in Directus.",-1),H={class:"two-up"},N={class:"left"},V=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),W=e("Supports all "),z=e("global query parameters"),F=e("."),J=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),K=e("An array of up to "),X=e("limit"),Y=e(),Z=s("a",{href:"#the-role-object"},"role objects",-1),$=e(". If no items are available, data will be an empty array."),ss={class:"right"},es=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),as=s("pre",null,[s("code",{class:""},`GET /roles
-SEARCH /roles
-`)],-1),ls=e("Learn more about SEARCH ->"),ts=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),rs=s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)],-1),ns=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	roles: [directus_roles]
-}
-`)])],-1),os=s("h5",{id:"example"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),cs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	roles {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])],-1),hs=s("hr",null,null,-1),ds=s("h2",{id:"retrieve-a-role"},[e("Retrieve a Role "),s("a",{class:"header-anchor",href:"#retrieve-a-role"},"#")],-1),is=s("p",null,"List an existing role by primary key.",-1),ps={class:"two-up"},us={class:"left"},_s=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),fs=e("Supports all "),ms=e("global query parameters"),gs=e("."),js=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ys=s("p",null,[e("Returns the requested "),s("a",{href:"#the-role-object"},"role object"),e(".")],-1),bs=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 /roles/:id
-`)]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:""},`GET /roles/b4cb3b64-8580-4ad9-a099-eade6da24302
-`)]),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(` {
-	roles_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_roles
-}
-`)])]),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(` {
-	roles_by_id(id: `),s("span",{class:"hljs-number"},"2"),e(`) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),qs=s("hr",null,null,-1),xs=s("h2",{id:"create-a-role"},[e("Create a Role "),s("a",{class:"header-anchor",href:"#create-a-role"},"#")],-1),vs=s("p",null,"Create a new role.",-1),Rs={class:"two-up"},Es={class:"left"},ws=s("h3",{id:"query-parameters-3"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Ts=e("Supports all "),Ps=e("global query parameters"),ks=e("."),As=s("h3",{id:"request-body"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ss=s("p",null,[e("A partial "),s("a",{href:"#the-role-object"},"role object"),e(".")],-1),Is=s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Cs=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role object"),e(" for the created role.")],-1),Ds=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 /roles
-`)]),s("h5",{id:"example-4"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /roles"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Interns"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"verified_user"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"description"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"admin_access"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`,
-	`),s("span",{class:"hljs-attr"},'"app_access"'),e(": "),s("span",{class:"hljs-literal"},"true"),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_roles_item(data: create_directus_roles_input!): directus_roles
-}
-`)])]),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_roles_item(
-		data: { name: `),s("span",{class:"hljs-string"},'"Interns"'),e(", icon: "),s("span",{class:"hljs-string"},'"verified_user"'),e(", description: "),s("span",{class:"hljs-literal"},"null"),e(", admin_access: "),s("span",{class:"hljs-literal"},"false"),e(", app_access: "),s("span",{class:"hljs-literal"},"true"),e(` }
-	) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),Ls=s("hr",null,null,-1),Qs=s("h2",{id:"create-multiple-roles"},[e("Create Multiple Roles "),s("a",{class:"header-anchor",href:"#create-multiple-roles"},"#")],-1),Os=s("p",null,"Create multiple new roles.",-1),Ms={class:"two-up"},Gs={class:"left"},Bs=s("h3",{id:"query-parameters-4"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Us=e("Supports all "),Hs=e("global query parameters"),Ns=e("."),Vs=s("h3",{id:"request-body-2"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Ws=s("p",null,[e("An array of partial "),s("a",{href:"#the-role-object"},"role objects"),e(".")],-1),zs=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),Fs=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role objects"),e(" for the created roles.")],-1),Js=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 /roles
-`)]),s("h5",{id:"example-6"},[e("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /roles"),e(`
-
-[
-	{
-		`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Interns"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"verified_user"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"description"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-		`),s("span",{class:"hljs-attr"},'"admin_access"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`,
-		`),s("span",{class:"hljs-attr"},'"app_access"'),e(": "),s("span",{class:"hljs-literal"},"true"),e(`
-	},
-	{
-		`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Customers"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"person"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"description"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-		`),s("span",{class:"hljs-attr"},'"admin_access"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`,
-		`),s("span",{class:"hljs-attr"},'"app_access"'),e(": "),s("span",{class:"hljs-literal"},"false"),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_roles_items(data: [create_directus_roles_input!]!): [directus_roles]
-}
-`)])]),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_roles_items(
-		data: [
-			{ name: `),s("span",{class:"hljs-string"},'"Interns"'),e(", icon: "),s("span",{class:"hljs-string"},'"verified_user"'),e(", description: "),s("span",{class:"hljs-literal"},"null"),e(", admin_access: "),s("span",{class:"hljs-literal"},"false"),e(", app_access: "),s("span",{class:"hljs-literal"},"true"),e(` }
-			{ name: `),s("span",{class:"hljs-string"},'"Customers"'),e(", icon: "),s("span",{class:"hljs-string"},'"person"'),e(", description: "),s("span",{class:"hljs-literal"},"null"),e(", admin_access: "),s("span",{class:"hljs-literal"},"false"),e(", app_access: "),s("span",{class:"hljs-literal"},"false"),e(` }
-		]
-	) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),Ks=s("hr",null,null,-1),Xs=s("h2",{id:"update-a-role"},[e("Update a Role "),s("a",{class:"header-anchor",href:"#update-a-role"},"#")],-1),Ys=s("p",null,"Update an existing role.",-1),Zs={class:"two-up"},$s={class:"left"},se=s("h3",{id:"query-parameters-5"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),ee=e("Supports all "),ae=e("global query parameters"),le=e("."),te=s("h3",{id:"request-body-3"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),re=s("p",null,[e("A partial "),s("a",{href:"#the-role-object"},"role object"),e(".")],-1),ne=s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),oe=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role object"),e(" for the updated role.")],-1),ce=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 /roles/: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 /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"attractions"'),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_roles_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_roles_input): directus_roles
-}
-`)])]),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_roles_item(id: `),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", data: { icon: "),s("span",{class:"hljs-string"},'"attractions"'),e(` }) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),he=s("hr",null,null,-1),de=s("h2",{id:"update-multiple-roles"},[e("Update Multiple Roles "),s("a",{class:"header-anchor",href:"#update-multiple-roles"},"#")],-1),ie=s("p",null,"Update multiple existing roles.",-1),pe={class:"two-up"},ue={class:"left"},_e=s("h3",{id:"query-parameters-6"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),fe=e("Supports all "),me=e("global query parameters"),ge=e("."),je=s("h3",{id:"request-body-4"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),ye=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 roles 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-role-object"},"the role object"),e("\u2019s properties.")])],-1),be=s("h3",{id:"returns-6"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),qe=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role objects"),e(" for the updated roles.")],-1),xe=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 /roles
-`)]),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 /roles"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"keys"'),e(": ["),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", "),s("span",{class:"hljs-string"},'"6fc3d5d3-a37b-4da8-a2f4-ed62ad5abe03"'),e(`],
-	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"attractions"'),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_roles_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_roles_input): [directus_roles]
-}
-`)])]),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_roles_items(
-		ids: [`),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", "),s("span",{class:"hljs-string"},'"6fc3d5d3-a37b-4da8-a2f4-ed62ad5abe03"'),e(`]
-		data: { icon: `),s("span",{class:"hljs-string"},'"attractions"'),e(` }
-	) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),ve=s("hr",null,null,-1),Re=s("h2",{id:"delete-a-role"},[e("Delete a Role "),s("a",{class:"header-anchor",href:"#delete-a-role"},"#")],-1),Ee=s("p",null,"Delete an existing role.",-1),we=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 /roles/:id
-`)]),s("h5",{id:"example-12"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7
-`)]),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_roles_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_roles_item(id: `),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`) {
-		id
-	}
-}
-`)])])])],-1),Te=s("hr",null,null,-1),Pe=s("h2",{id:"delete-multiple-roles"},[e("Delete Multiple Roles "),s("a",{class:"header-anchor",href:"#delete-multiple-roles"},"#")],-1),ke=s("p",null,"Delete multiple existing roles.",-1),Ae=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-5"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"An array of role 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 /roles
-`)]),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 /roles"),e(`
-[`),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(", "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),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_roles_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_roles_items(ids: [`),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(", "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`]) {
-		ids
-	}
-}
-`)])])])],-1),Se=s("hr",null,null,-1),Ie={title:"Roles",modularExtension:!1,pageClass:"page-reference"},Ce={name:"roles",setup(De,{expose:o}){return o({frontmatter:{title:"Roles",modularExtension:!1,pageClass:"page-reference"}}),(Le,Qe)=>{const l=r("router-link"),c=r("docswrapper");return h(),d(c,{frontmatter:Ie},{default:a(()=>[s("div",i,[s("div",p,[s("div",u,[s("blockquote",null,[s("p",null,[_,t(l,{to:"/docs/getting-started/glossary/#roles"},{default:a(()=>[f]),_:1}),m])])]),g]),j,y,s("div",b,[s("div",q,[s("div",x,[v,R,E,w,T,P,k,A,s("p",null,[S,I,C,D,L,t(l,{to:"/docs/reference/system/users/"},{default:a(()=>[Q]),_:1}),O])])]),M]),G,B,U,s("div",H,[s("div",N,[V,s("p",null,[W,t(l,{to:"/docs/reference/query"},{default:a(()=>[z]),_:1}),F]),J,s("p",null,[K,t(l,{to:"/docs/reference/query/#limit"},{default:a(()=>[X]),_:1}),Y,Z,$])]),s("div",ss,[es,as,s("p",null,[t(l,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[ls]),_:1})]),ts,rs,ns,os,cs])]),hs,ds,is,s("div",ps,[s("div",us,[_s,s("p",null,[fs,t(l,{to:"/docs/reference/query"},{default:a(()=>[ms]),_:1}),gs]),js,ys]),bs]),qs,xs,vs,s("div",Rs,[s("div",Es,[ws,s("p",null,[Ts,t(l,{to:"/docs/reference/query"},{default:a(()=>[Ps]),_:1}),ks]),As,Ss,Is,Cs]),Ds]),Ls,Qs,Os,s("div",Ms,[s("div",Gs,[Bs,s("p",null,[Us,t(l,{to:"/docs/reference/query"},{default:a(()=>[Hs]),_:1}),Ns]),Vs,Ws,zs,Fs]),Js]),Ks,Xs,Ys,s("div",Zs,[s("div",$s,[se,s("p",null,[ee,t(l,{to:"/docs/reference/query"},{default:a(()=>[ae]),_:1}),le]),te,re,ne,oe]),ce]),he,de,ie,s("div",pe,[s("div",ue,[_e,s("p",null,[fe,t(l,{to:"/docs/reference/query"},{default:a(()=>[me]),_:1}),ge]),je,ye,be,qe]),xe]),ve,Re,Ee,we,Te,Pe,ke,Ae,Se])]),_:1})}}};typeof n=="function"&&n(Ce);export{Ce as default,Ie as frontmatter};

package/dist/assets/running-locally.811d0dcc.js

@@ -1,26 +0,0 @@
-import{a as s,o as c,b as h,w as n,g as e,e as a,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const u={class:"markdown-body"},d=t("This guide explains how to install the "),p=e("em",null,"Development",-1),_=t(" version of Directus locally so that you can work on the platform\u2019s source code. To install the "),m=e("em",null,"Production",-1),g=t(" version locally, please follow to our "),f=t("standard installation guides"),y=t("."),b=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Minimum Requirements"),e("p",null,[t("You will need to have "),e("a",{href:"https://nodejs.org/en/download/current/",target:"_blank",rel:"noopener noreferrer"},"the latest version of Node"),t(" to "),e("em",null,"build"),t(" a Development version of Directus.")]),e("p",null,[t("You can use the JavaScript tool manager "),e("a",{href:"https://volta.sh/",target:"_blank",rel:"noopener noreferrer"},"volta"),t(" to automatically install the current node and npm versions.")])],-1),v=e("h2",{id:"1.-fork-the-directus-repository"},[t("1. Fork the Directus repository "),e("a",{class:"header-anchor",href:"#1.-fork-the-directus-repository"},"#")],-1),k=e("p",null,[t("Go to the "),e("a",{href:"https://github.com/directus/directus",target:"_blank",rel:"noopener noreferrer"},"repository"),t(" and fork it to your GitHub account. A fork is your copy of the Directus repository. Forking the repository allows you to freely experiment with changes without affecting the original project.")],-1),w=e("h2",{id:"2.-clone-from-your-repository"},[t("2. Clone from your repository "),e("a",{class:"header-anchor",href:"#2.-clone-from-your-repository"},"#")],-1),j=e("pre",null,[e("code",{class:"language-bash"},[t("git "),e("span",{class:"hljs-built_in"},"clone"),t(` git@github.com:YOUR-USERNAME/directus.git
-`)])],-1),x=e("h2",{id:"3.-make-a-new-branch"},[t("3. Make a new branch "),e("a",{class:"header-anchor",href:"#3.-make-a-new-branch"},"#")],-1),T=e("pre",null,[e("code",{class:"language-bash"},`git checkout -b YOUR-BRANCH-NAME
-`)],-1),A=e("h2",{id:"4.-install-the-dependencies-and-build-the-project"},[t("4. Install the dependencies and build the project "),e("a",{class:"header-anchor",href:"#4.-install-the-dependencies-and-build-the-project"},"#")],-1),D=e("pre",null,[e("code",{class:"language-bash"},`npm install
-npm run build
-`)],-1),C=e("h2",{id:"5.-create-a-.env-file"},[t("5. Create a "),e("code",{class:""},".env"),t(" file "),e("a",{class:"header-anchor",href:"#5.-create-a-.env-file"},"#")],-1),R=e("p",null,[t("Create an "),e("code",{class:""},".env"),t(" file under the "),e("code",{class:""},"api"),t(" folder using vars from the online "),e("a",{href:"https://docs.directus.io/configuration/config-options/",target:"_blank",rel:"noopener noreferrer"},"config help")],-1),E=e("h2",{id:"6.-initialize-the-database"},[t("6. Initialize the database "),e("a",{class:"header-anchor",href:"#6.-initialize-the-database"},"#")],-1),F=e("p",null,"For this step, you\u2019ll need to already have a SQL database up-and-running, except if you\u2019re using the SQLite driver, which will create the database (file) for you.",-1),N=e("p",null,"To start the initialization run the following command:",-1),S=e("pre",null,[e("code",{class:"language-bash"},[e("span",{class:"hljs-comment"},"# From within the root of the project"),t(`
-npm run cli bootstrap
-
-`),e("span",{class:"hljs-comment"},"# For SQLite you need to run the command in the 'api' context (to ensure the database file is created in the right directory)"),t(`
-npm run cli bootstrap --workspace=api
-`)])],-1),B=e("p",null,"This will set-up the required tables for Directus and make sure all the migrations have run.",-1),L=e("h2",{id:"7.-start-the-development-server"},[t("7. Start the development server "),e("a",{class:"header-anchor",href:"#7.-start-the-development-server"},"#")],-1),I=e("p",null,[t("First you need to choose what packages you want to work on. Then, you should run the "),e("code",{class:""},"dev"),t(" script on that package. You can see their names and list of scripts in their related "),e("code",{class:""},"package.json"),t(". Example of running APP:")],-1),M=e("pre",null,[e("code",{class:"language-bash"},`npm run dev -w @directus/app
-`)],-1),Y=e("p",null,"If you want to work on multiple packages at once, you should create a new instance of your terminal for each package: Example of running Api, App:",-1),q=e("table",null,[e("tr",null,[e("th",null," Terminal 1 [Api] "),e("th",null," Terminal 2 [App] ")]),e("tr",null,[e("td",null,[e("pre",null,[e("code",{class:"language-bash"},`npm run dev -w directus
-`)])]),e("td",null,[e("pre",null,[e("code",{class:"language-bash"},`npm run dev -w @directus/app
-`)])])])],-1),z=e("hr",null,null,-1),H=e("p",null,[t("To work on the Documentation (public website version), you should navigate to the "),e("code",{class:""},"docs"),t(" directory and run the following command:")],-1),G=e("pre",null,[e("code",{class:"language-bash"},`npm install
-`)],-1),P=e("p",null,[e("sup",null,"\u2139 This is necessary because the way vue-server-renderer imports vue")],-1),Q=e("p",null,"Then you should run",-1),U=e("pre",null,[e("code",{class:"language-bash"},`npm run dev:site
-`)],-1),V=e("div",{class:"tip hint"},[e("p",null,"If you encounter errors during this installation process, make sure your node version meets the minimum requirements")],-1),O=e("h2",{id:"8.-make-your-fixes%2Fchanges"},[t("8. Make your fixes/changes "),e("a",{class:"header-anchor",href:"#8.-make-your-fixes%2Fchanges"},"#")],-1),J=t("At this point you are ready to start working on Directus! Before diving in however, it\u2019s worth reading through the introduction to "),W=t("Contributing"),K=t("."),X=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Debugging"),e("p",null,[t("Check our Wiki for a "),e("a",{href:"https://github.com/directus/directus/wiki/debugging",target:"_blank",rel:"noopener noreferrer"},"guide"),t(" on debugging the app and api.")])],-1),Z=e("h2",{id:"9.-running-tests"},[t("9. Running tests "),e("a",{class:"header-anchor",href:"#9.-running-tests"},"#")],-1),$=e("p",null,"Tests run automatically through GitHub Actions. However you may wish to run the tests locally especially when you write tests.",-1),ee=e("p",null,[t("Install "),e("a",{href:"https://docs.docker.com/get-docker/",target:"_blank",rel:"noopener noreferrer"},"Docker"),t(" and ensure that the service is running.")],-1),te=e("pre",null,[e("code",{class:"language-bash"},[e("span",{class:"hljs-comment"},"# Ensure that you are testing on the lastest codebase"),t(`
-npm run build
-
-`),e("span",{class:"hljs-comment"},"# Clean up in case you ran the tests before"),t(`
-docker compose -f tests/docker-compose.yml down -v
-
-`),e("span",{class:"hljs-comment"},"# Start the necessary containers"),t(`
-docker compose -f tests/docker-compose.yml up -d --`),e("span",{class:"hljs-built_in"},"wait"),t(`
-
-`),e("span",{class:"hljs-comment"},"# Run the tests"),t(`
-npm run `),e("span",{class:"hljs-built_in"},"test"),t(`:e2e
-`)])],-1),ne={title:"Running Locally",modularExtension:!1},oe={name:"running-locally",setup(se,{expose:i}){return i({frontmatter:{title:"Running Locally",modularExtension:!1}}),(ae,re)=>{const o=s("router-link"),l=s("docswrapper");return c(),h(l,{frontmatter:ne},{default:n(()=>[e("div",u,[e("blockquote",null,[e("p",null,[d,p,_,m,g,a(o,{to:"/docs/self-hosted/installation/"},{default:n(()=>[f]),_:1}),y])]),b,v,k,w,j,x,T,A,D,C,R,E,F,N,S,B,L,I,M,Y,q,z,H,G,P,Q,U,V,O,e("p",null,[J,a(o,{to:"/docs/contributing/introduction"},{default:n(()=>[W]),_:1}),K]),X,Z,$,ee,te])]),_:1})}}};typeof r=="function"&&r(oe);export{oe as default,ne as frontmatter};