@directus/app 9.14.0 → 9.14.3

package/dist/assets/relations.a37c187d.js

@@ -0,0 +1,115 @@
+import{a as l,o as i,b as c,w as n,g as a,e as h,B as s}from"./runtime-core.esm-bundler.e3d5f5b7.js";const p={class:"markdown-body"},u={class:"two-up"},d={class:"left"},g=s("What data is linked to what other data. Allows you to assign authors to articles, products to sales, and whatever other structures you can think of. "),j=s("Learn more about Relationships"),_=s("."),f=a("div",{class:"right"},[a("p",null,[a("div",{class:"table-of-contents"},[a("ul",null,[a("li",null,[a("a",{href:"#the-relation-object"},"The Relation Object ")]),a("li",null,[a("a",{href:"#list-relations"},"List relations ")]),a("li",null,[a("a",{href:"#list-relations-in-collection"},"List relations in collection ")]),a("li",null,[a("a",{href:"#retrieve-a-relation"},"Retrieve a relation ")]),a("li",null,[a("a",{href:"#create-a-relation"},"Create a Relation ")]),a("li",null,[a("a",{href:"#update-a-relation"},"Update a Relation ")]),a("li",null,[a("a",{href:"#delete-a-relation"},"Delete a Relation ")])])])])],-1),m=a("hr",null,null,-1),b=a("h2",{id:"the-relation-object",tabindex:"-1"},[s("The Relation Object "),a("a",{class:"header-anchor",href:"#the-relation-object"},"#")],-1),y=a("div",{class:"two-up"},[a("div",{class:"left"},[a("div",{class:"definitions"},[a("p",null,[a("code",null,"collection"),s(),a("strong",null,"string"),a("br"),s(" Name of the collection. This matches the table name in the database.")]),a("p",null,[a("code",null,"field"),s(),a("strong",null,"string"),a("br"),s(" Name of the field that holds the related primary key. This matches the column name in the database.")]),a("p",null,[a("code",null,"related_collection"),s(),a("strong",null,"string"),a("br"),s(" Name of the related collection. This matches the table name in the database.")])]),a("h4",{id:"meta",tabindex:"-1"},[s("Meta "),a("a",{class:"header-anchor",href:"#meta"},"#")]),a("p",null,"Directus metadata. Used to enable non-database relationship types"),a("div",{class:"definitions"},[a("p",null,[a("code",null,"id"),s(),a("strong",null,"integer"),a("br"),s(" Primary key of the metadata row in "),a("code",null,"directus_relations"),s(".")]),a("p",null,[a("code",null,"many_collection"),s(),a("strong",null,"string"),a("br"),s(" Name of the collection. Matches the top level "),a("code",null,"collection"),s(" field.")]),a("p",null,[a("code",null,"many_field"),s(),a("strong",null,"string"),a("br"),s(" Name of the field. Matches the top level "),a("code",null,"field"),s(" field.")]),a("p",null,[a("code",null,"one_collection"),s(),a("strong",null,"string"),a("br"),s(" Name of the related collection. Matches the top level "),a("code",null,"related_collection"),s(" field.")]),a("p",null,[a("code",null,"one_field"),s(),a("strong",null,"string"),a("br"),s(" Name of the one to many field on the other side of the relation.")]),a("p",null,[a("code",null,"one_allowed_collections"),s(),a("strong",null,"string"),a("br"),s(" What collections are allowed to be used in a many-to-any context.")]),a("p",null,[a("code",null,"one_collection_field"),s(),a("strong",null,"string"),a("br"),s(" Field that holds the collection name in a many-to-any context.")]),a("p",null,[a("code",null,"one_deselect_action"),s(),a("strong",null,"nullify | delete"),a("br"),s(" Whether to nullify or delete related one-to-many records.")]),a("p",null,[a("code",null,"sort_field"),s(),a("strong",null,"string"),a("br"),s(" What field is used to hold the sort field.")]),a("p",null,[a("code",null,"junction_field"),s(),a("strong",null,"string"),a("br"),s(" What field connects two relations in a many-to-many (o2m-m2o) context.")])]),a("h4",{id:"schema",tabindex:"-1"},[s("Schema "),a("a",{class:"header-anchor",href:"#schema"},"#")]),a("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers."),a("div",{class:"definitions"},[a("p",null,[a("code",null,"table"),s(),a("strong",null,"string"),a("br"),s(" The table name.")]),a("p",null,[a("code",null,"column"),s(),a("strong",null,"string"),a("br"),s(" The column name.")]),a("p",null,[a("code",null,"foreign_key_table"),s(),a("strong",null,"string"),a("br"),s(" Related table name.")]),a("p",null,[a("code",null,"foreign_key_column"),s(),a("strong",null,"string"),a("br"),s(" Related column name.")]),a("p",null,[a("code",null,"constraint_name"),s(),a("strong",null,"string"),a("br"),s(" Name for the foreign key constraint.")]),a("p",null,[a("code",null,"on_update"),s(),a("strong",null,"string"),a("br"),s(" Update trigger for the foreign key constraint.")]),a("p",null,[a("code",null,"on_delete"),s(),a("strong",null,"string"),a("br"),s(" Delete trigger for the foreign key constraint.")])])]),a("div",{class:"right"},[a("pre",null,[a("code",{class:"language-json"},[a("span",{class:"hljs-punctuation"},"{"),s(`
+	`),a("span",{class:"hljs-attr"},'"collection"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"about_us"'),a("span",{class:"hljs-punctuation"},","),s(`
+	`),a("span",{class:"hljs-attr"},'"field"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"logo"'),a("span",{class:"hljs-punctuation"},","),s(`
+	`),a("span",{class:"hljs-attr"},'"related_collection"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"directus_files"'),a("span",{class:"hljs-punctuation"},","),s(`
+	`),a("span",{class:"hljs-attr"},'"schema"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-punctuation"},"{"),s(`
+		`),a("span",{class:"hljs-attr"},'"table"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"about_us"'),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"column"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"logo"'),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"foreign_key_table"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"directus_files"'),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"foreign_key_column"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"id"'),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"constraint_name"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"about_us_logo_foreign"'),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"on_update"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"NO ACTION"'),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"on_delete"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"SET NULL"'),s(`
+	`),a("span",{class:"hljs-punctuation"},"}"),a("span",{class:"hljs-punctuation"},","),s(`
+	`),a("span",{class:"hljs-attr"},'"meta"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-punctuation"},"{"),s(`
+		`),a("span",{class:"hljs-attr"},'"id"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-number"},"1"),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"junction_field"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-literal"},[a("span",{class:"hljs-keyword"},"null")]),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"many_collection"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"about_us"'),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"many_field"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"logo"'),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"one_allowed_collections"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-literal"},[a("span",{class:"hljs-keyword"},"null")]),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"one_collection"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"directus_files"'),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"one_collection_field"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-literal"},[a("span",{class:"hljs-keyword"},"null")]),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"one_deselect_action"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"nullify"'),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"one_field"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-literal"},[a("span",{class:"hljs-keyword"},"null")]),a("span",{class:"hljs-punctuation"},","),s(`
+		`),a("span",{class:"hljs-attr"},'"sort_field"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-literal"},[a("span",{class:"hljs-keyword"},"null")]),s(`
+	`),a("span",{class:"hljs-punctuation"},"}"),s(`
+`),a("span",{class:"hljs-punctuation"},"}"),s(`
+`)])])])],-1),x=a("hr",null,null,-1),q=a("h2",{id:"list-relations",tabindex:"-1"},[s("List relations "),a("a",{class:"header-anchor",href:"#list-relations"},"#")],-1),v=a("p",null,"List all relations that exist in Directus.",-1),w=a("div",{class:"two-up"},[a("div",{class:"left"},[a("div",{class:"tip hint"},[a("div",{class:"hint-title"},"Permissions"),a("p",null,"The data returned in this endpoint will be filtered based on the user\u2019s permissions. For example, relations that apply to a collection that the current user doesn\u2019t have access to are stripped out.")]),a("h3",{id:"query-parameters",tabindex:"-1"},[s("Query Parameters "),a("a",{class:"header-anchor",href:"#query-parameters"},"#")]),a("p",null,"Doesn\u2019t support any query parameters."),a("h3",{id:"returns",tabindex:"-1"},[s("Returns "),a("a",{class:"header-anchor",href:"#returns"},"#")]),a("p",null,[s("Array of "),a("a",{href:"#the-relation-object"},"relation objects"),s(". If no items are available, data will be an empty array.")])]),a("div",{class:"right"},[a("h3",{id:"rest-api",tabindex:"-1"},[s("REST API "),a("a",{class:"header-anchor",href:"#rest-api"},"#")]),a("pre",null,[a("code",null,`GET /relations
+`)]),a("h3",{id:"graphql",tabindex:"-1"},[s("GraphQL "),a("a",{class:"header-anchor",href:"#graphql"},"#")]),a("pre",null,[a("code",null,`POST /graphql/system
+`)]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"type"),a("span",{class:"hljs-type"}," Query"),s(` {
+	relations: [directus_relations]
+}
+`)])]),a("h5",{id:"example",tabindex:"-1"},[s("Example "),a("a",{class:"header-anchor",href:"#example"},"#")]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"query"),s(` {
+	relations {
+		collection
+		field
+	}
+}
+`)])])])],-1),T=a("hr",null,null,-1),k=a("h2",{id:"list-relations-in-collection",tabindex:"-1"},[s("List relations in collection "),a("a",{class:"header-anchor",href:"#list-relations-in-collection"},"#")],-1),R=a("p",null,"List all relations that exist in a given collection.",-1),E=a("div",{class:"two-up"},[a("div",{class:"left"},[a("div",{class:"tip hint"},[a("div",{class:"hint-title"},"Permissions"),a("p",null,"The data returned in this endpoint will be filtered based on the user\u2019s permissions. For example, relations that apply to a collection that the current user doesn\u2019t have access to are stripped out.")]),a("h3",{id:"query-parameters-1",tabindex:"-1"},[s("Query Parameters "),a("a",{class:"header-anchor",href:"#query-parameters-1"},"#")]),a("p",null,"Doesn\u2019t support any query parameters."),a("h3",{id:"returns-1",tabindex:"-1"},[s("Returns "),a("a",{class:"header-anchor",href:"#returns-1"},"#")]),a("p",null,[s("Array of "),a("a",{href:"#the-relation-object"},"relation objects"),s(". If no items are available, data will be an empty array.")])]),a("div",{class:"right"},[a("h3",{id:"rest-api-1",tabindex:"-1"},[s("REST API "),a("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),a("pre",null,[a("code",null,`GET /relations/:collection
+`)]),a("h5",{id:"example-1",tabindex:"-1"},[s("Example "),a("a",{class:"header-anchor",href:"#example-1"},"#")]),a("pre",null,[a("code",null,`GET /relations/articles
+`)]),a("h3",{id:"graphql-1",tabindex:"-1"},[s("GraphQL "),a("a",{class:"header-anchor",href:"#graphql-1"},"#")]),a("pre",null,[a("code",null,`POST /graphql/system
+`)]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"type"),a("span",{class:"hljs-type"}," Query"),s(` {
+	relations_in_collection(collection:`),a("span",{class:"hljs-type"}," String"),s(`!): [directus_relations]
+}
+`)])]),a("h5",{id:"example-2",tabindex:"-1"},[s("Example "),a("a",{class:"header-anchor",href:"#example-2"},"#")]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"query"),s(` {
+	relations_in_collection(collection: `),a("span",{class:"hljs-string"},'"articles"'),s(`) {
+		collection
+		field
+	}
+}
+`)])])])],-1),P=a("hr",null,null,-1),S=a("h2",{id:"retrieve-a-relation",tabindex:"-1"},[s("Retrieve a relation "),a("a",{class:"header-anchor",href:"#retrieve-a-relation"},"#")],-1),L=a("p",null,"List an existing relation by collection/field name.",-1),A=a("div",{class:"two-up"},[a("div",{class:"left"},[a("h3",{id:"query-parameters-2",tabindex:"-1"},[s("Query Parameters "),a("a",{class:"header-anchor",href:"#query-parameters-2"},"#")]),a("p",null,"Doesn\u2019t support any query parameters."),a("h3",{id:"returns-2",tabindex:"-1"},[s("Returns "),a("a",{class:"header-anchor",href:"#returns-2"},"#")]),a("p",null,[s("Returns the requested "),a("a",{href:"#the-relation-object"},"relation object"),s(".")])]),a("div",{class:"right"},[a("h3",{id:"rest-api-2",tabindex:"-1"},[s("REST API "),a("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),a("pre",null,[a("code",null,`GET /relations/:collection/:field
+`)]),a("h5",{id:"example-3",tabindex:"-1"},[s("Example "),a("a",{class:"header-anchor",href:"#example-3"},"#")]),a("pre",null,[a("code",null,`GET /relations/articles/featured_image
+`)]),a("h3",{id:"graphql-2",tabindex:"-1"},[s("GraphQL "),a("a",{class:"header-anchor",href:"#graphql-2"},"#")]),a("pre",null,[a("code",null,`POST /graphql/system
+`)]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"type"),a("span",{class:"hljs-type"}," Query"),s(` {
+	relations_by_name(collection:`),a("span",{class:"hljs-type"}," String"),s("!, field:"),a("span",{class:"hljs-type"}," String"),s(`!): directus_relations
+}
+`)])]),a("h5",{id:"example-4",tabindex:"-1"},[s("Example "),a("a",{class:"header-anchor",href:"#example-4"},"#")]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"query"),s(` {
+	relations_by_name(collection: `),a("span",{class:"hljs-string"},'"articles"'),s(", field: "),a("span",{class:"hljs-string"},'"featured_image"'),s(`) {
+		collection
+		field
+		related_collection
+	}
+}
+`)])])])],-1),N=a("hr",null,null,-1),Q=a("h2",{id:"create-a-relation",tabindex:"-1"},[s("Create a Relation "),a("a",{class:"header-anchor",href:"#create-a-relation"},"#")],-1),D=a("p",null,"Create a new relation.",-1),O=a("div",{class:"two-up"},[a("div",{class:"left"},[a("h3",{id:"query-parameters-3",tabindex:"-1"},[s("Query Parameters "),a("a",{class:"header-anchor",href:"#query-parameters-3"},"#")]),a("p",null,"Doesn\u2019t support any query parameters."),a("h3",{id:"request-body",tabindex:"-1"},[s("Request Body "),a("a",{class:"header-anchor",href:"#request-body"},"#")]),a("p",null,[s("A partial "),a("a",{href:"#the-relation-object"},"relation object"),s(".")]),a("h3",{id:"returns-3",tabindex:"-1"},[s("Returns "),a("a",{class:"header-anchor",href:"#returns-3"},"#")]),a("p",null,[s("Returns the "),a("a",{href:"#the-relation-object"},"relation object"),s(" for the created relation.")])]),a("div",{class:"right"},[a("h3",{id:"rest-api-3",tabindex:"-1"},[s("REST API "),a("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),a("pre",null,[a("code",null,`POST /relations
+`)]),a("h5",{id:"example-5",tabindex:"-1"},[s("Example "),a("a",{class:"header-anchor",href:"#example-5"},"#")]),a("pre",null,[a("code",{class:"language-json"},[a("span",{class:"hljs-comment"},"// POST /relations"),s(`
+
+`),a("span",{class:"hljs-punctuation"},"{"),s(`
+	`),a("span",{class:"hljs-attr"},'"collection"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"articles"'),a("span",{class:"hljs-punctuation"},","),s(`
+	`),a("span",{class:"hljs-attr"},'"field"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"featured_image"'),a("span",{class:"hljs-punctuation"},","),s(`
+	`),a("span",{class:"hljs-attr"},'"related_collection"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"directus_files"'),s(`
+`),a("span",{class:"hljs-punctuation"},"}"),s(`
+`)])]),a("h3",{id:"graphql-3",tabindex:"-1"},[s("GraphQL "),a("a",{class:"header-anchor",href:"#graphql-3"},"#")]),a("pre",null,[a("code",null,`POST /graphql/system
+`)]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"type"),a("span",{class:"hljs-type"}," Mutation"),s(` {
+	create_relations_item(data: create_directus_relations_input!): directus_relations
+}
+`)])]),a("h5",{id:"example-6",tabindex:"-1"},[s("Example "),a("a",{class:"header-anchor",href:"#example-6"},"#")]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"mutation"),s(` {
+	create_relations_item(
+		data: { collection: `),a("span",{class:"hljs-string"},'"articles"'),s(", field: "),a("span",{class:"hljs-string"},'"featured_image"'),s(", related_collection: "),a("span",{class:"hljs-string"},'"directus_files"'),s(` }
+	) {
+		collection
+		field
+		related_collection
+	}
+}
+`)])])])],-1),G=a("hr",null,null,-1),C=a("h2",{id:"update-a-relation",tabindex:"-1"},[s("Update a Relation "),a("a",{class:"header-anchor",href:"#update-a-relation"},"#")],-1),I=a("p",null,"Update an existing relation.",-1),B=a("div",{class:"two-up"},[a("div",{class:"left"},[a("h3",{id:"query-parameters-4",tabindex:"-1"},[s("Query Parameters "),a("a",{class:"header-anchor",href:"#query-parameters-4"},"#")]),a("p",null,"Doesn\u2019t support any query parameters."),a("h3",{id:"request-body-1",tabindex:"-1"},[s("Request Body "),a("a",{class:"header-anchor",href:"#request-body-1"},"#")]),a("p",null,[s("A partial "),a("a",{href:"#the-relation-object"},"relation object"),s(".")]),a("h3",{id:"returns-4",tabindex:"-1"},[s("Returns "),a("a",{class:"header-anchor",href:"#returns-4"},"#")]),a("p",null,[s("Returns the "),a("a",{href:"#the-relation-object"},"relation object"),s(" for the created relation.")])]),a("div",{class:"right"},[a("h3",{id:"rest-api-4",tabindex:"-1"},[s("REST API "),a("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),a("pre",null,[a("code",null,`PATCH /relations/:collection/:field
+`)]),a("h5",{id:"example-7",tabindex:"-1"},[s("Example "),a("a",{class:"header-anchor",href:"#example-7"},"#")]),a("pre",null,[a("code",{class:"language-json"},[a("span",{class:"hljs-comment"},"// PATCH /relations/articles/author"),s(`
+
+`),a("span",{class:"hljs-punctuation"},"{"),s(`
+	`),a("span",{class:"hljs-attr"},'"meta"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-punctuation"},"{"),s(`
+		`),a("span",{class:"hljs-attr"},'"one_field"'),a("span",{class:"hljs-punctuation"},":"),s(),a("span",{class:"hljs-string"},'"articles"'),s(`
+	`),a("span",{class:"hljs-punctuation"},"}"),s(`
+`),a("span",{class:"hljs-punctuation"},"}"),s(`
+`)])]),a("h3",{id:"graphql-4",tabindex:"-1"},[s("GraphQL "),a("a",{class:"header-anchor",href:"#graphql-4"},"#")]),a("pre",null,[a("code",null,`POST /graphql/system
+`)]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"type"),a("span",{class:"hljs-type"}," Mutation"),s(` {
+	update_relations_item(collection:`),a("span",{class:"hljs-type"}," String"),s("!, field:"),a("span",{class:"hljs-type"}," String"),s(`!, data: update_directus_relations_input!): directus_relations
+}
+`)])]),a("h5",{id:"example-8",tabindex:"-1"},[s("Example "),a("a",{class:"header-anchor",href:"#example-8"},"#")]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"mutation"),s(` {
+	update_relations_item(collection: `),a("span",{class:"hljs-string"},'"articles"'),s(", field: "),a("span",{class:"hljs-string"},'"author"'),s(", data: { meta: { one_field: "),a("span",{class:"hljs-string"},'"articles"'),s(` } }) {
+		collection
+		field
+		related_collection
+	}
+}
+`)])])])],-1),M=a("hr",null,null,-1),U=a("h2",{id:"delete-a-relation",tabindex:"-1"},[s("Delete a Relation "),a("a",{class:"header-anchor",href:"#delete-a-relation"},"#")],-1),W=a("p",null,"Delete an existing relation.",-1),F=a("div",{class:"two-up"},[a("div",{class:"left"},[a("h3",{id:"returns-5",tabindex:"-1"},[s("Returns "),a("a",{class:"header-anchor",href:"#returns-5"},"#")]),a("p",null,"Empty body.")]),a("div",{class:"right"},[a("h3",{id:"rest-api-5",tabindex:"-1"},[s("REST API "),a("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),a("pre",null,[a("code",null,`DELETE /relations/:collection/:field
+`)]),a("h5",{id:"example-9",tabindex:"-1"},[s("Example "),a("a",{class:"header-anchor",href:"#example-9"},"#")]),a("pre",null,[a("code",null,`DELETE /relations/articles/author
+`)]),a("h3",{id:"graphql-5",tabindex:"-1"},[s("GraphQL "),a("a",{class:"header-anchor",href:"#graphql-5"},"#")]),a("pre",null,[a("code",null,`POST /graphql/system
+`)]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"type"),a("span",{class:"hljs-type"}," Mutation"),s(` {
+	delete_relations_item(collection:`),a("span",{class:"hljs-type"}," String"),s("!, field:"),a("span",{class:"hljs-type"}," String"),s(`!): delete_one
+}
+`)])]),a("h5",{id:"example-10",tabindex:"-1"},[s("Example "),a("a",{class:"header-anchor",href:"#example-10"},"#")]),a("pre",null,[a("code",{class:"language-graphql"},[a("span",{class:"hljs-keyword"},"mutation"),s(` {
+	delete_relations_item(collection: `),a("span",{class:"hljs-string"},'"articles"'),s(", field: "),a("span",{class:"hljs-string"},'"author"'),s(`) {
+		collection
+		field
+	}
+}
+`)])])])],-1),K="Relations",X=!1,Y="page-reference",Z={name:"relations",setup(V,{expose:t}){const e={title:"Relations",modularExtension:!1,pageClass:"page-reference"};return t({frontmatter:e}),(H,z)=>{const r=l("router-link"),o=l("docs-wrapper");return i(),c(o,{frontmatter:e},{default:n(()=>[a("div",p,[a("div",u,[a("div",d,[a("blockquote",null,[a("p",null,[g,h(r,{to:"/docs/getting-started/glossary/#relationships"},{default:n(()=>[j]),_:1}),_])])]),f]),m,b,y,x,q,v,w,T,k,R,E,P,S,L,A,N,Q,D,O,G,C,I,B,M,U,W,F])]),_:1})}}};export{Z as default,X as modularExtension,Y as pageClass,K as title};

package/dist/assets/{relationships.cbc9b1c5.js → relationships.5cda18e3.js}

@@ -1,4 +1,4 @@
-import{a as s,o as c,b as d,w as n,g as e,e as l,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,[t("As you might have guessed, relationships are a crucial part of any relational database. Directus supports all standard relationship types, as well as a few more "),e("em",null,"compound"),t(" types that offer greater flexibility.")])],-1),f=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#many-to-one-(m2o)"},"Many-to-One (M2O) ")]),e("li",null,[e("a",{href:"#one-to-many-(o2m)"},"One-to-Many (O2M) ")]),e("li",null,[e("a",{href:"#translations-(o2m)"},"Translations (O2M) ")]),e("li",null,[e("a",{href:"#many-to-many-(m2m)"},"Many-to-Many (M2M) ")]),e("li",null,[e("a",{href:"#many-to-any-(m2a)"},"Many-to-Any (M2A) ")]),e("li",null,[e("a",{href:"#one-to-one-(o2o)"},"One-to-One (O2O) ")])])])],-1),p=e("h3",{id:"introduction",tabindex:"-1"},[t("Introduction "),e("a",{class:"header-anchor",href:"#introduction"},"#")],-1),m=e("p",null,"While it may seem complex at first, relational data is actually quite straightforward once you understand what\u2019s happening behind the sometimes confusing terminology. Before diving into the details of each type, let\u2019s first cover a few basics that will help you better visualize them in your mind\u2019s eye.",-1),_=e("h3",{id:"primary-and-foreign-keys",tabindex:"-1"},[t("Primary and Foreign Keys "),e("a",{class:"header-anchor",href:"#primary-and-foreign-keys"},"#")],-1),y=t("Every "),g=t("Item"),w=t(" in a relational database has a unique "),M=t("Primary Key"),b=t(" (or \u201CPK\u201D) that identifies it within its "),v=t("Collection"),O=t(". Because it\u2019s required, the key is the first "),k=t("field"),x=t(" created within a collection, typically storing an \u201Cauto-increment\u201D number, an automatically generated unique hash, or a manually entered value. They are often abbreviated to \u201CPK\u201D (Primary Key), \u201CID\u201D (Identifier), \u201CUID\u201D (Unique Identifier), or \u201CUUID\u201D (Universally Unique Identifier), depending on the type of value they store. After it\u2019s created, the value of an item\u2019s PK should "),T=e("em",null,"never",-1),C=t(" change."),A=e("p",null,[t("To link items together relationally, you simply save a reference to an item\u2019s PK in a different field. That "),e("em",null,"reference"),t(" is called a Foreign Key (FK). If the primary key is a "),e("em",null,"person"),t(", the foreign key is like their "),e("em",null,"business card"),t(". It references the actual person, providing just enough information to find them.")],-1),j=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Composite & Compound Keys"),e("p",null,[t("In the above explanation we\u2019ve ignored "),e("em",null,"composite"),t(" and "),e("em",null,"compound"),t(" keys, which are essentially unique keys created by combining "),e("em",null,"multiple"),t(" field/column values.")])],-1),I=e("h3",{id:"perspective-matters",tabindex:"-1"},[t("Perspective Matters "),e("a",{class:"header-anchor",href:"#perspective-matters"},"#")],-1),P=e("p",null,"Just like primary and foreign keys, relationships are always described relative to their \u201Cparent\u201D collection. Looking at the same relationship/key from the perspective of the opposite collection would reverse it. This means that a many-to-one relationship can also be seen as a one-to-many relationship, it just depends on which collection is considered the parent.",-1),D=e("h2",{id:"many-to-one-(m2o)",tabindex:"-1"},[t("Many-to-One (M2O) "),e("a",{class:"header-anchor",href:"#many-to-one-(m2o)"},"#")],-1),S=e("p",null,[t("The Many-to-One is the only relationship type with an actual field on the parent Collection. This field saves the foreign key to a single related item. For example, a "),e("em",null,"city"),t(" can only be in one "),e("em",null,"country"),t(", but a "),e("em",null,"country"),t(" can have many "),e("em",null,"cities"),t(".")],-1),R=e("p",null,"Below is an example of a M2O relationship:",-1),F=e("pre",null,[e("code",null,`cities (the "Many" Collection)
+import{a as s,o as c,b as d,w as n,g as e,e as l,B as t}from"./runtime-core.esm-bundler.e3d5f5b7.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,[t("As you might have guessed, relationships are a crucial part of any relational database. Directus supports all standard relationship types, as well as a few more "),e("em",null,"compound"),t(" types that offer greater flexibility.")])],-1),f=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#many-to-one-(m2o)"},"Many-to-One (M2O) ")]),e("li",null,[e("a",{href:"#one-to-many-(o2m)"},"One-to-Many (O2M) ")]),e("li",null,[e("a",{href:"#translations-(o2m)"},"Translations (O2M) ")]),e("li",null,[e("a",{href:"#many-to-many-(m2m)"},"Many-to-Many (M2M) ")]),e("li",null,[e("a",{href:"#many-to-any-(m2a)"},"Many-to-Any (M2A) ")]),e("li",null,[e("a",{href:"#one-to-one-(o2o)"},"One-to-One (O2O) ")])])])],-1),p=e("h3",{id:"introduction",tabindex:"-1"},[t("Introduction "),e("a",{class:"header-anchor",href:"#introduction"},"#")],-1),m=e("p",null,"While it may seem complex at first, relational data is actually quite straightforward once you understand what\u2019s happening behind the sometimes confusing terminology. Before diving into the details of each type, let\u2019s first cover a few basics that will help you better visualize them in your mind\u2019s eye.",-1),_=e("h3",{id:"primary-and-foreign-keys",tabindex:"-1"},[t("Primary and Foreign Keys "),e("a",{class:"header-anchor",href:"#primary-and-foreign-keys"},"#")],-1),y=t("Every "),g=t("Item"),w=t(" in a relational database has a unique "),M=t("Primary Key"),b=t(" (or \u201CPK\u201D) that identifies it within its "),v=t("Collection"),O=t(". Because it\u2019s required, the key is the first "),k=t("field"),x=t(" created within a collection, typically storing an \u201Cauto-increment\u201D number, an automatically generated unique hash, or a manually entered value. They are often abbreviated to \u201CPK\u201D (Primary Key), \u201CID\u201D (Identifier), \u201CUID\u201D (Unique Identifier), or \u201CUUID\u201D (Universally Unique Identifier), depending on the type of value they store. After it\u2019s created, the value of an item\u2019s PK should "),T=e("em",null,"never",-1),C=t(" change."),A=e("p",null,[t("To link items together relationally, you simply save a reference to an item\u2019s PK in a different field. That "),e("em",null,"reference"),t(" is called a Foreign Key (FK). If the primary key is a "),e("em",null,"person"),t(", the foreign key is like their "),e("em",null,"business card"),t(". It references the actual person, providing just enough information to find them.")],-1),j=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Composite & Compound Keys"),e("p",null,[t("In the above explanation we\u2019ve ignored "),e("em",null,"composite"),t(" and "),e("em",null,"compound"),t(" keys, which are essentially unique keys created by combining "),e("em",null,"multiple"),t(" field/column values.")])],-1),I=e("h3",{id:"perspective-matters",tabindex:"-1"},[t("Perspective Matters "),e("a",{class:"header-anchor",href:"#perspective-matters"},"#")],-1),P=e("p",null,"Just like primary and foreign keys, relationships are always described relative to their \u201Cparent\u201D collection. Looking at the same relationship/key from the perspective of the opposite collection would reverse it. This means that a many-to-one relationship can also be seen as a one-to-many relationship, it just depends on which collection is considered the parent.",-1),D=e("h2",{id:"many-to-one-(m2o)",tabindex:"-1"},[t("Many-to-One (M2O) "),e("a",{class:"header-anchor",href:"#many-to-one-(m2o)"},"#")],-1),S=e("p",null,[t("The Many-to-One is the only relationship type with an actual field on the parent Collection. This field saves the foreign key to a single related item. For example, a "),e("em",null,"city"),t(" can only be in one "),e("em",null,"country"),t(", but a "),e("em",null,"country"),t(" can have many "),e("em",null,"cities"),t(".")],-1),R=e("p",null,"Below is an example of a M2O relationship:",-1),F=e("pre",null,[e("code",null,`cities (the "Many" Collection)
 - id (Primary Key)
 - name
 - country (the M2O field that stores the country key)

package/dist/assets/{resources.25cb1e34.js → resources.540de098.js}

@@ -1 +1 @@
-import{a as t,o as i,b as u,w as n,g as e,e as c,B as r}from"./runtime-core.esm-bundler.b1f35d24.js";const d={class:"markdown-body"},h=e("h2",{id:"cloud",tabindex:"-1"},[r("Cloud "),e("a",{class:"header-anchor",href:"#cloud"},"#")],-1),p=e("li",null,[e("strong",null,[e("a",{href:"https://directus.cloud",target:"_blank",rel:"noopener noreferrer"},"Directus Cloud")]),r(" \u2014 The best way to get your Project up and running.")],-1),f=e("li",null,[e("strong",null,[e("a",{href:"https://directus.io/contact",target:"_blank",rel:"noopener noreferrer"},"Enterprise Cloud")]),r(" \u2014 Custom-tailored solutions for industrial scale projects.")],-1),_=r("Cloud Documentation"),m=r(" \u2014 Docs for Directus cloud."),g=e("li",null,[e("strong",null,[e("a",{href:"https://status.directus.cloud",target:"_blank",rel:"noopener noreferrer"},"System Status")]),r(" \u2014 Up-to-date information on our various cloud systems.")],-1),k=e("h2",{id:"developer-resources",tabindex:"-1"},[r("Developer Resources "),e("a",{class:"header-anchor",href:"#developer-resources"},"#")],-1),b=e("ul",null,[e("li",null,[e("strong",null,[e("a",{href:"https://github.com/directus/directus",target:"_blank",rel:"noopener noreferrer"},"GitHub")]),r(" \u2014 The open-source repository and version control.")]),e("li",null,[e("strong",null,[e("a",{href:"https://www.npmjs.com/package/directus",target:"_blank",rel:"noopener noreferrer"},"NPM Package")]),r(" \u2014 The official Directus node package.")]),e("li",null,[e("strong",null,[e("a",{href:"https://hub.docker.com/r/directus/directus",target:"_blank",rel:"noopener noreferrer"},"Docker Image")]),r(" \u2014 The official Directus docker image.")]),e("li",null,[e("strong",null,[e("a",{href:"https://docs.directus.io",target:"_blank",rel:"noopener noreferrer"},"Documentation")]),r(" \u2014 Docs for the most recent version of Directus.")]),e("li",null,[e("strong",null,[e("a",{href:"https://locales.directus.io/",target:"_blank",rel:"noopener noreferrer"},"Crowdin")]),r(" \u2014 Service for managing the App\u2019s many language translations.")])],-1),w=e("h2",{id:"community",tabindex:"-1"},[r("Community "),e("a",{class:"header-anchor",href:"#community"},"#")],-1),v=e("ul",null,[e("li",null,[e("strong",null,[e("a",{href:"https://www.youtube.com/c/DirectusVideos",target:"_blank",rel:"noopener noreferrer"},"YouTube")]),r(" \u2014 Checkout our channel with video tutorials and feature overviews.")]),e("li",null,[e("strong",null,[e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord")]),r(" \u2014 A growing community of 4K+ developers.")]),e("li",null,[e("strong",null,[e("a",{href:"https://twitter.com/directus",target:"_blank",rel:"noopener noreferrer"},"Twitter")]),r(" \u2014 The latest product info and sneak-peeks.")]),e("li",null,[e("strong",null,[e("a",{href:"https://directus.io",target:"_blank",rel:"noopener noreferrer"},"Website")]),r(" \u2014 General information, resources, and team info.")]),e("li",null,[e("strong",null,[e("a",{href:"https://github.com/directus-community/awesome-directus",target:"_blank",rel:"noopener noreferrer"},"Awesome List")]),r(" \u2014 A list of awesome things related Directus.")])],-1),T="Resources",A=!1,B={name:"resources",setup(D,{expose:s}){const o={title:"Resources",modularExtension:!1};return s({frontmatter:o}),(y,C)=>{const l=t("router-link"),a=t("docs-wrapper");return i(),u(a,{frontmatter:o},{default:n(()=>[e("div",d,[h,e("ul",null,[p,f,e("li",null,[e("strong",null,[c(l,{to:"/docs/cloud/overview/"},{default:n(()=>[_]),_:1})]),m]),g]),k,b,w,v])]),_:1})}}};export{B as default,A as modularExtension,T as title};
+import{a as t,o as i,b as u,w as n,g as e,e as c,B as r}from"./runtime-core.esm-bundler.e3d5f5b7.js";const d={class:"markdown-body"},h=e("h2",{id:"cloud",tabindex:"-1"},[r("Cloud "),e("a",{class:"header-anchor",href:"#cloud"},"#")],-1),p=e("li",null,[e("strong",null,[e("a",{href:"https://directus.cloud",target:"_blank",rel:"noopener noreferrer"},"Directus Cloud")]),r(" \u2014 The best way to get your Project up and running.")],-1),f=e("li",null,[e("strong",null,[e("a",{href:"https://directus.io/contact",target:"_blank",rel:"noopener noreferrer"},"Enterprise Cloud")]),r(" \u2014 Custom-tailored solutions for industrial scale projects.")],-1),_=r("Cloud Documentation"),m=r(" \u2014 Docs for Directus cloud."),g=e("li",null,[e("strong",null,[e("a",{href:"https://status.directus.cloud",target:"_blank",rel:"noopener noreferrer"},"System Status")]),r(" \u2014 Up-to-date information on our various cloud systems.")],-1),k=e("h2",{id:"developer-resources",tabindex:"-1"},[r("Developer Resources "),e("a",{class:"header-anchor",href:"#developer-resources"},"#")],-1),b=e("ul",null,[e("li",null,[e("strong",null,[e("a",{href:"https://github.com/directus/directus",target:"_blank",rel:"noopener noreferrer"},"GitHub")]),r(" \u2014 The open-source repository and version control.")]),e("li",null,[e("strong",null,[e("a",{href:"https://www.npmjs.com/package/directus",target:"_blank",rel:"noopener noreferrer"},"NPM Package")]),r(" \u2014 The official Directus node package.")]),e("li",null,[e("strong",null,[e("a",{href:"https://hub.docker.com/r/directus/directus",target:"_blank",rel:"noopener noreferrer"},"Docker Image")]),r(" \u2014 The official Directus docker image.")]),e("li",null,[e("strong",null,[e("a",{href:"https://docs.directus.io",target:"_blank",rel:"noopener noreferrer"},"Documentation")]),r(" \u2014 Docs for the most recent version of Directus.")]),e("li",null,[e("strong",null,[e("a",{href:"https://locales.directus.io/",target:"_blank",rel:"noopener noreferrer"},"Crowdin")]),r(" \u2014 Service for managing the App\u2019s many language translations.")])],-1),w=e("h2",{id:"community",tabindex:"-1"},[r("Community "),e("a",{class:"header-anchor",href:"#community"},"#")],-1),v=e("ul",null,[e("li",null,[e("strong",null,[e("a",{href:"https://www.youtube.com/c/DirectusVideos",target:"_blank",rel:"noopener noreferrer"},"YouTube")]),r(" \u2014 Checkout our channel with video tutorials and feature overviews.")]),e("li",null,[e("strong",null,[e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord")]),r(" \u2014 A growing community of 4K+ developers.")]),e("li",null,[e("strong",null,[e("a",{href:"https://twitter.com/directus",target:"_blank",rel:"noopener noreferrer"},"Twitter")]),r(" \u2014 The latest product info and sneak-peeks.")]),e("li",null,[e("strong",null,[e("a",{href:"https://directus.io",target:"_blank",rel:"noopener noreferrer"},"Website")]),r(" \u2014 General information, resources, and team info.")]),e("li",null,[e("strong",null,[e("a",{href:"https://github.com/directus-community/awesome-directus",target:"_blank",rel:"noopener noreferrer"},"Awesome List")]),r(" \u2014 A list of awesome things related Directus.")])],-1),T="Resources",A=!1,B={name:"resources",setup(D,{expose:s}){const o={title:"Resources",modularExtension:!1};return s({frontmatter:o}),(y,C)=>{const l=t("router-link"),a=t("docs-wrapper");return i(),u(a,{frontmatter:o},{default:n(()=>[e("div",d,[h,e("ul",null,[p,f,e("li",null,[e("strong",null,[c(l,{to:"/docs/cloud/overview/"},{default:n(()=>[_]),_:1})]),m]),g]),k,b,w,v])]),_:1})}}};export{B as default,A as modularExtension,T as title};

package/dist/assets/revisions.e044726e.js

@@ -0,0 +1,40 @@
+import{a as l,o as c,b as h,w as t,g as s,e as a,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.js";const d={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=e("Revisions are individual changes to items made. Directus keeps track of changes made, so you\u2019re able to revert to a previous state at will. "),v=e("Learn more about Revisions"),m=e("."),j=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-revision-object"},"The Revision Object ")]),s("li",null,[s("a",{href:"#list-revisions"},"List revisions ")]),s("li",null,[s("a",{href:"#retrieve-a-revision"},"Retrieve a revision ")])])])])],-1),f=s("hr",null,null,-1),g=s("h2",{id:"the-revision-object",tabindex:"-1"},[e("The Revision Object "),s("a",{class:"header-anchor",href:"#the-revision-object"},"#")],-1),y={class:"two-up"},b={class:"left"},x={class:"definitions"},q=s("p",null,[s("code",null,"id"),e(),s("strong",null,"integer"),s("br"),e(" Primary key of the revision.")],-1),w=s("code",null,"activity",-1),k=e(),R=s("strong",null,"many-to-one",-1),E=s("br",null,null,-1),T=e(" Related activity record. Many-to-one to "),P=e("activity"),S=e("."),L=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" Collection in which this revision happened.")],-1),C=s("p",null,[s("code",null,"item"),e(),s("strong",null,"string"),s("br"),e(" Primary key of the item that was changed.")],-1),Q=s("p",null,[s("code",null,"data"),e(),s("strong",null,"object"),s("br"),e(" Snapshot of the top-level item data.")],-1),A=s("p",null,[s("code",null,"delta"),e(),s("strong",null,"object"),s("br"),e(" Snapshot of the changes made in this revision.")],-1),G=s("p",null,[s("code",null,"parent"),e(),s("strong",null,"many-to-one"),s("br"),e(" Parent revision that triggered this revision. Many-to-one to revisions (recursive).")],-1),B=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-number"},"368"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"activity"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-number"},"438"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"item"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"1"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"title"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Hello World"'),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"delta"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"title"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Hello from the Docs!"'),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"parent"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])])],-1),D=s("hr",null,null,-1),H=s("h2",{id:"list-revisions",tabindex:"-1"},[e("List revisions "),s("a",{class:"header-anchor",href:"#list-revisions"},"#")],-1),I=s("p",null,"List all revisions that exist in Directus.",-1),O={class:"two-up"},N={class:"left"},V=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, revisions that apply to a collection that the current user doesn\u2019t have access to are stripped out.")],-1),M=s("h3",{id:"query-parameters",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),F=e("Supports all "),W=e("global query parameters"),z=e("."),J=s("h3",{id:"returns",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),K=e("An array of up to "),U=e("limit"),X=e(),Y=s("a",{href:"#the-revision-object"},"revision objects",-1),Z=e(". If no items are available, data will be an empty array."),$={class:"right"},ss=s("h3",{id:"rest-api",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),es=s("pre",null,[s("code",null,`GET /revisions
+SEARCH /revisions
+`)],-1),ts=e("Learn more about SEARCH ->"),ns=s("h3",{id:"graphql",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),as=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),os=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	revisions: [directus_revisions]
+}
+`)])],-1),ls=s("h5",{id:"examples",tabindex:"-1"},[e("Examples "),s("a",{class:"header-anchor",href:"#examples"},"#")],-1),is=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	revisions {
+		id
+		data
+		delta
+	}
+}
+`)])],-1),rs=s("hr",null,null,-1),cs=s("h2",{id:"retrieve-a-revision",tabindex:"-1"},[e("Retrieve a revision "),s("a",{class:"header-anchor",href:"#retrieve-a-revision"},"#")],-1),hs=s("p",null,"List an existing revision by primary key.",-1),ds={class:"two-up"},ps={class:"left"},us=s("h3",{id:"query-parameters-1",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),_s=e("Supports all "),vs=e("global query parameters"),ms=e("."),js=s("h3",{id:"returns-1",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-1"},"#")],-1),fs=s("p",null,[e("Returns the requested "),s("a",{href:"#the-revision-object"},"revision object"),e(".")],-1),gs=s("div",{class:"right"},[s("h3",{id:"rest-api-1",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),s("pre",null,[s("code",null,`GET /revisions/:id
+`)]),s("h5",{id:"example",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")]),s("pre",null,[s("code",null,`GET /revisions/322
+`)]),s("h3",{id:"graphql-1",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-1"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	revisions_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_revisions
+}
+`)])]),s("h5",{id:"example-1",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-1"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	revisions_by_id(id: `),s("span",{class:"hljs-number"},"322"),e(`) {
+		id
+		data
+		delta
+	}
+}
+`)])])],-1),ws="Revisions",ks=!1,Rs="page-reference",Es={name:"revisions",setup(ys,{expose:i}){const o={title:"Revisions",modularExtension:!1,pageClass:"page-reference"};return i({frontmatter:o}),(bs,xs)=>{const n=l("router-link"),r=l("docs-wrapper");return c(),h(r,{frontmatter:o},{default:t(()=>[s("div",d,[s("div",p,[s("div",u,[s("blockquote",null,[s("p",null,[_,a(n,{to:"/docs/getting-started/glossary/#revisions"},{default:t(()=>[v]),_:1}),m])])]),j]),f,g,s("div",y,[s("div",b,[s("div",x,[q,s("p",null,[w,k,R,E,T,a(n,{to:"/docs/reference/system/activity/"},{default:t(()=>[P]),_:1}),S]),L,C,Q,A,G])]),B]),D,H,I,s("div",O,[s("div",N,[V,M,s("p",null,[F,a(n,{to:"/docs/reference/query"},{default:t(()=>[W]),_:1}),z]),J,s("p",null,[K,a(n,{to:"/docs/reference/query/#limit"},{default:t(()=>[U]),_:1}),X,Y,Z])]),s("div",$,[ss,es,s("p",null,[a(n,{to:"/docs/reference/introduction/#search-http-method"},{default:t(()=>[ts]),_:1})]),ns,as,os,ls,is])]),rs,cs,hs,s("div",ds,[s("div",ps,[us,s("p",null,[_s,a(n,{to:"/docs/reference/query"},{default:t(()=>[vs]),_:1}),ms]),js,fs]),gs])])]),_:1})}}};export{Es as default,ks as modularExtension,Rs as pageClass,ws as title};

package/dist/assets/roles.83da9d9c.js

@@ -0,0 +1,171 @@
+import{a as r,o as h,b as i,w as a,g as s,e as t,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.js";const d={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. "),j=e("Learn more about Roles"),f=e("."),m=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),g=s("hr",null,null,-1),b=s("h2",{id:"the-role-object",tabindex:"-1"},[e("The Role Object "),s("a",{class:"header-anchor",href:"#the-role-object"},"#")],-1),y={class:"two-up"},x={class:"left"},q={class:"definitions"},R=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the role.")],-1),w=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Name of the role.")],-1),v=s("p",null,[s("code",null,"icon"),e(),s("strong",null,"string"),s("br"),e(" Icon for the role. Displayed in the Admin App.")],-1),E=s("p",null,[s("code",null,"description"),e(),s("strong",null,"string"),s("br"),e(" Description for the role. Displayed in the Admin App.")],-1),k=s("p",null,[s("code",null,"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),T=s("p",null,[s("code",null,"enforce_tfa"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not Two-Factor Authentication is required for users in this role.")],-1),P=s("p",null,[s("code",null,"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",null,"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",null,"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"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Admin"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"supervised_user_circle"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"ip_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"enforce_tfa"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"users"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),s("span",{class:"hljs-punctuation"},"]"),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])])],-1),G=s("hr",null,null,-1),B=s("h2",{id:"list-roles",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),as=s("pre",null,[s("code",null,`GET /roles
+SEARCH /roles
+`)],-1),ls=e("Learn more about SEARCH ->"),ts=s("h3",{id:"graphql",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),ns=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),rs=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",tabindex:"-1"},[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),is=s("h2",{id:"retrieve-a-role",tabindex:"-1"},[e("Retrieve a Role "),s("a",{class:"header-anchor",href:"#retrieve-a-role"},"#")],-1),ds=s("p",null,"List an existing role by primary key.",-1),ps={class:"two-up"},us={class:"left"},_s=s("h3",{id:"query-parameters-1",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),js=e("Supports all "),fs=e("global query parameters"),ms=e("."),gs=s("h3",{id:"returns-1",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-1"},"#")],-1),bs=s("p",null,[e("Returns the requested "),s("a",{href:"#the-role-object"},"role object"),e(".")],-1),ys=s("div",{class:"right"},[s("h3",{id:"rest-api-1",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),s("pre",null,[s("code",null,`GET /roles/:id
+`)]),s("h5",{id:"example-1",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-1"},"#")]),s("pre",null,[s("code",null,`GET /roles/b4cb3b64-8580-4ad9-a099-eade6da24302
+`)]),s("h3",{id:"graphql-1",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-1"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	roles_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_roles
+}
+`)])]),s("h5",{id:"example-2",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),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),xs=s("hr",null,null,-1),qs=s("h2",{id:"create-a-role",tabindex:"-1"},[e("Create a Role "),s("a",{class:"header-anchor",href:"#create-a-role"},"#")],-1),Rs=s("p",null,"Create a new role.",-1),ws={class:"two-up"},vs={class:"left"},Es=s("h3",{id:"query-parameters-2",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),ks=e("Supports all "),Ts=e("global query parameters"),Ps=e("."),As=s("h3",{id:"request-body",tabindex:"-1"},[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-2",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-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-2",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`POST /roles
+`)]),s("h5",{id:"example-3",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /roles"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Interns"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"verified_user"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-2",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	create_roles_item(data: create_directus_roles_input!): directus_roles
+}
+`)])]),s("h5",{id:"example-4",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),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",tabindex:"-1"},[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-3",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Us=e("Supports all "),Hs=e("global query parameters"),Ns=e("."),Vs=s("h3",{id:"request-body-1",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-1"},"#")],-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-3",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-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-3",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`POST /roles
+`)]),s("h5",{id:"example-5",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /roles"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"["),e(`
+	`),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Interns"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"verified_user"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Customers"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"person"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`),s("span",{class:"hljs-punctuation"},"]"),e(`
+`)])]),s("h3",{id:"graphql-3",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	create_roles_items(data: [create_directus_roles_input!]!): [directus_roles]
+}
+`)])]),s("h5",{id:"example-6",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),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",tabindex:"-1"},[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-4",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),ee=e("Supports all "),ae=e("global query parameters"),le=e("."),te=s("h3",{id:"request-body-2",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),ne=s("p",null,[e("A partial "),s("a",{href:"#the-role-object"},"role object"),e(".")],-1),re=s("h3",{id:"returns-4",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-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-4",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`PATCH /roles/:id
+`)]),s("h5",{id:"example-7",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-7"},"#")]),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-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"attractions"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-4",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	update_roles_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_roles_input): directus_roles
+}
+`)])]),s("h5",{id:"example-8",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),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),ie=s("h2",{id:"update-multiple-roles",tabindex:"-1"},[e("Update Multiple Roles "),s("a",{class:"header-anchor",href:"#update-multiple-roles"},"#")],-1),de=s("p",null,"Update multiple existing roles.",-1),pe={class:"two-up"},ue={class:"left"},_e=s("h3",{id:"query-parameters-5",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),je=e("Supports all "),fe=e("global query parameters"),me=e("."),ge=s("h3",{id:"request-body-3",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),be=s("div",{class:"definitions"},[s("p",null,[s("code",null,"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the roles you\u2019d like to update.")]),s("p",null,[s("code",null,"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-role-object"},"the role object"),e("\u2019s properties.")])],-1),ye=s("h3",{id:"returns-5",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),xe=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role objects"),e(" for the updated roles.")],-1),qe=s("div",{class:"right"},[s("h3",{id:"rest-api-5",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`PATCH /roles
+`)]),s("h5",{id:"example-9",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-9"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /roles"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"keys"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"6fc3d5d3-a37b-4da8-a2f4-ed62ad5abe03"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"attractions"'),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-5",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	update_roles_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_roles_input): [directus_roles]
+}
+`)])]),s("h5",{id:"example-10",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-10"},"#")]),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),Re=s("hr",null,null,-1),we=s("h2",{id:"delete-a-role",tabindex:"-1"},[e("Delete a Role "),s("a",{class:"header-anchor",href:"#delete-a-role"},"#")],-1),ve=s("p",null,"Delete an existing role.",-1),Ee=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-6",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-6",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",null,`DELETE /roles/:id
+`)]),s("h5",{id:"example-11",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-11"},"#")]),s("pre",null,[s("code",null,`DELETE /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7
+`)]),s("h3",{id:"graphql-6",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	delete_roles_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
+}
+`)])]),s("h5",{id:"example-12",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),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),ke=s("hr",null,null,-1),Te=s("h2",{id:"delete-multiple-roles",tabindex:"-1"},[e("Delete Multiple Roles "),s("a",{class:"header-anchor",href:"#delete-multiple-roles"},"#")],-1),Pe=s("p",null,"Delete multiple existing roles.",-1),Ae=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-4",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")]),s("p",null,"An array of role primary keys"),s("h3",{id:"returns-7",tabindex:"-1"},[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",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",null,`DELETE /roles
+`)]),s("h5",{id:"example-13",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-13"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /roles"),e(`
+`),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},"]"),e(`
+`)])]),s("h3",{id:"graphql-7",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	delete_roles_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
+}
+`)])]),s("h5",{id:"example-14",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-14"},"#")]),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),Qe="Roles",Oe=!1,Me="page-reference",Ge={name:"roles",setup(Ie,{expose:o}){const n={title:"Roles",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:n}),(Ce,De)=>{const l=r("router-link"),c=r("docs-wrapper");return h(),i(c,{frontmatter:n},{default:a(()=>[s("div",d,[s("div",p,[s("div",u,[s("blockquote",null,[s("p",null,[_,t(l,{to:"/docs/getting-started/glossary/#roles"},{default:a(()=>[j]),_:1}),f])])]),m]),g,b,s("div",y,[s("div",x,[s("div",q,[R,w,v,E,k,T,P,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,ns,rs,os,cs])]),hs,is,ds,s("div",ps,[s("div",us,[_s,s("p",null,[js,t(l,{to:"/docs/reference/query"},{default:a(()=>[fs]),_:1}),ms]),gs,bs]),ys]),xs,qs,Rs,s("div",ws,[s("div",vs,[Es,s("p",null,[ks,t(l,{to:"/docs/reference/query"},{default:a(()=>[Ts]),_:1}),Ps]),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,ne,re,oe]),ce]),he,ie,de,s("div",pe,[s("div",ue,[_e,s("p",null,[je,t(l,{to:"/docs/reference/query"},{default:a(()=>[fe]),_:1}),me]),ge,be,ye,xe]),qe]),Re,we,ve,Ee,ke,Te,Pe,Ae,Se])]),_:1})}}};export{Ge as default,Oe as modularExtension,Me as pageClass,Qe as title};

package/dist/assets/{rpm.8909ead0.js → rpm.701e8769.js}

@@ -1 +1 @@
-import{A as d}from"./index.c2e31551.entry.js";function m(i,f){return f.forEach(function(e){e&&typeof e!="string"&&!Array.isArray(e)&&Object.keys(e).forEach(function(n){if(n!=="default"&&!(n in i)){var c=Object.getOwnPropertyDescriptor(e,n);Object.defineProperty(i,n,c.get?c:{enumerable:!0,get:function(){return e[n]}})}})}),Object.freeze(Object.defineProperty(i,Symbol.toStringTag,{value:"Module"}))}var p={exports:{}};(function(i,f){(function(e){e(d.exports)})(function(e){e.defineMode("rpm-changes",function(){var n=/^-+$/,c=/^(Mon|Tue|Wed|Thu|Fri|Sat|Sun) (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)  ?\d{1,2} \d{2}:\d{2}(:\d{2})? [A-Z]{3,4} \d{4} - /,a=/^[\w+.-]+@[\w.-]+/;return{token:function(o){return o.sol()&&(o.match(n)||o.match(c))?"tag":o.match(a)?"string":(o.next(),null)}}}),e.defineMIME("text/x-rpm-changes","rpm-changes"),e.defineMode("rpm-spec",function(){var n=/^(i386|i586|i686|x86_64|ppc64le|ppc64|ppc|ia64|s390x|s390|sparc64|sparcv9|sparc|noarch|alphaev6|alpha|hppa|mipsel)/,c=/^[a-zA-Z0-9()]+:/,a=/^%(debug_package|package|description|prep|build|install|files|clean|changelog|preinstall|preun|postinstall|postun|pretrans|posttrans|pre|post|triggerin|triggerun|verifyscript|check|triggerpostun|triggerprein|trigger)/,o=/^%(ifnarch|ifarch|if)/,u=/^%(else|endif)/,l=/^(\!|\?|\<\=|\<|\>\=|\>|\=\=|\&\&|\|\|)/;return{startState:function(){return{controlFlow:!1,macroParameters:!1,section:!1}},token:function(r,t){var h=r.peek();if(h=="#")return r.skipToEnd(),"comment";if(r.sol()){if(r.match(c))return"header";if(r.match(a))return"atom"}if(r.match(/^\$\w+/)||r.match(/^\$\{\w+\}/))return"def";if(r.match(u))return"keyword";if(r.match(o))return t.controlFlow=!0,"keyword";if(t.controlFlow){if(r.match(l))return"operator";if(r.match(/^(\d+)/))return"number";r.eol()&&(t.controlFlow=!1)}if(r.match(n))return r.eol()&&(t.controlFlow=!1),"number";if(r.match(/^%[\w]+/))return r.match("(")&&(t.macroParameters=!0),"keyword";if(t.macroParameters){if(r.match(/^\d+/))return"number";if(r.match(")"))return t.macroParameters=!1,"keyword"}return r.match(/^%\{\??[\w \-\:\!]+\}/)?(r.eol()&&(t.controlFlow=!1),"def"):(r.next(),null)}}}),e.defineMIME("text/x-rpm-spec","rpm-spec")})})();var g=p.exports,v=m({__proto__:null,default:g},[p.exports]);export{v as r};
+import{z as d}from"./index.ed3b88b9.entry.js";function m(i,f){return f.forEach(function(e){e&&typeof e!="string"&&!Array.isArray(e)&&Object.keys(e).forEach(function(n){if(n!=="default"&&!(n in i)){var c=Object.getOwnPropertyDescriptor(e,n);Object.defineProperty(i,n,c.get?c:{enumerable:!0,get:function(){return e[n]}})}})}),Object.freeze(Object.defineProperty(i,Symbol.toStringTag,{value:"Module"}))}var p={exports:{}};(function(i,f){(function(e){e(d.exports)})(function(e){e.defineMode("rpm-changes",function(){var n=/^-+$/,c=/^(Mon|Tue|Wed|Thu|Fri|Sat|Sun) (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)  ?\d{1,2} \d{2}:\d{2}(:\d{2})? [A-Z]{3,4} \d{4} - /,a=/^[\w+.-]+@[\w.-]+/;return{token:function(o){return o.sol()&&(o.match(n)||o.match(c))?"tag":o.match(a)?"string":(o.next(),null)}}}),e.defineMIME("text/x-rpm-changes","rpm-changes"),e.defineMode("rpm-spec",function(){var n=/^(i386|i586|i686|x86_64|ppc64le|ppc64|ppc|ia64|s390x|s390|sparc64|sparcv9|sparc|noarch|alphaev6|alpha|hppa|mipsel)/,c=/^[a-zA-Z0-9()]+:/,a=/^%(debug_package|package|description|prep|build|install|files|clean|changelog|preinstall|preun|postinstall|postun|pretrans|posttrans|pre|post|triggerin|triggerun|verifyscript|check|triggerpostun|triggerprein|trigger)/,o=/^%(ifnarch|ifarch|if)/,u=/^%(else|endif)/,l=/^(\!|\?|\<\=|\<|\>\=|\>|\=\=|\&\&|\|\|)/;return{startState:function(){return{controlFlow:!1,macroParameters:!1,section:!1}},token:function(r,t){var h=r.peek();if(h=="#")return r.skipToEnd(),"comment";if(r.sol()){if(r.match(c))return"header";if(r.match(a))return"atom"}if(r.match(/^\$\w+/)||r.match(/^\$\{\w+\}/))return"def";if(r.match(u))return"keyword";if(r.match(o))return t.controlFlow=!0,"keyword";if(t.controlFlow){if(r.match(l))return"operator";if(r.match(/^(\d+)/))return"number";r.eol()&&(t.controlFlow=!1)}if(r.match(n))return r.eol()&&(t.controlFlow=!1),"number";if(r.match(/^%[\w]+/))return r.match("(")&&(t.macroParameters=!0),"keyword";if(t.macroParameters){if(r.match(/^\d+/))return"number";if(r.match(")"))return t.macroParameters=!1,"keyword"}return r.match(/^%\{\??[\w \-\:\!]+\}/)?(r.eol()&&(t.controlFlow=!1),"def"):(r.next(),null)}}}),e.defineMIME("text/x-rpm-spec","rpm-spec")})})();var g=p.exports,v=m({__proto__:null,default:g},[p.exports]);export{v as r};

package/dist/assets/{rst.4d43ef54.js → rst.78cdf25e.js}

@@ -1 +1 @@
-import{A as oe}from"./index.c2e31551.entry.js";import{a as ae}from"./python.987c2ae7.js";import{a as ie}from"./stex.2b7cb363.js";import{o as le}from"./overlay.b1fd0f5a.js";function fe(s,I){return I.forEach(function(l){l&&typeof l!="string"&&!Array.isArray(l)&&Object.keys(l).forEach(function(p){if(p!=="default"&&!(p in s)){var i=Object.getOwnPropertyDescriptor(l,p);Object.defineProperty(s,p,i.get?i:{enumerable:!0,get:function(){return l[p]}})}})}),Object.freeze(Object.defineProperty(s,Symbol.toStringTag,{value:"Module"}))}var M={exports:{}};(function(s,I){(function(l){l(oe.exports,ae.exports,ie.exports,le.exports)})(function(l){l.defineMode("rst",function(p,i){var v=/^\*\*[^\*\s](?:[^\*]*[^\*\s])?\*\*/,b=/^\*[^\*\s](?:[^\*]*[^\*\s])?\*/,w=/^``[^`\s](?:[^`]*[^`\s])``/,u=/^(?:[\d]+(?:[\.,]\d+)*)/,E=/^(?:\s\+[\d]+(?:[\.,]\d+)*)/,_=/^(?:\s\-[\d]+(?:[\.,]\d+)*)/,T="[Hh][Tt][Tt][Pp][Ss]?://",P="(?:[\\d\\w.-]+)\\.(?:\\w{2,6})",x="(?:/[\\d\\w\\#\\%\\&\\-\\.\\,\\/\\:\\=\\?\\~]+)*",y=new RegExp("^"+T+P+x),R={token:function(f){if(f.match(v)&&f.match(/\W+|$/,!1))return"strong";if(f.match(b)&&f.match(/\W+|$/,!1))return"em";if(f.match(w)&&f.match(/\W+|$/,!1))return"string-2";if(f.match(u))return"number";if(f.match(E))return"positive";if(f.match(_))return"negative";if(f.match(y))return"link";for(;f.next()!=null&&!(f.match(v,!1)||f.match(b,!1)||f.match(w,!1)||f.match(u,!1)||f.match(E,!1)||f.match(_,!1)||f.match(y,!1)););return null}},W=l.getMode(p,i.backdrop||"rst-base");return l.overlayMode(W,R,!0)},"python","stex"),l.defineMode("rst-base",function(p){function i(n){var e=Array.prototype.slice.call(arguments,1);return n.replace(/{(\d+)}/g,function(r,N){return typeof e[N]!="undefined"?e[N]:r})}var v=l.getMode(p,"python"),b=l.getMode(p,"stex"),w="\\s+",u="(?:\\s*|\\W|$)",E=new RegExp(i("^{0}",u)),_=`(?:[^\\W\\d_](?:[\\w!"#$%&'()\\*\\+,\\-\\./:;<=>\\?]*[^\\W_])?)`,T=new RegExp(i("^{0}",_)),P=`(?:[^\\W\\d_](?:[\\w\\s!"#$%&'()\\*\\+,\\-\\./:;<=>\\?]*[^\\W_])?)`,x=i("(?:{0}|`{1}`)",_,P),y="(?:[^\\s\\|](?:[^\\|]*[^\\s\\|])?)",R="(?:[^\\`]+)",W=new RegExp(i("^{0}",R)),f=new RegExp("^([!'#$%&\"()*+,-./:;<=>?@\\[\\\\\\]^_`{|}~])\\1{3,}\\s*$"),z=new RegExp(i("^\\.\\.{0}",w)),O=new RegExp(i("^_{0}:{1}|^__:{1}",x,u)),A=new RegExp(i("^{0}::{1}",x,u)),S=new RegExp(i("^\\|{0}\\|{1}{2}::{3}",y,w,x,u)),D=new RegExp(i("^\\[(?:\\d+|#{0}?|\\*)]{1}",x,u)),F=new RegExp(i("^\\[{0}\\]{1}",x,u)),j=new RegExp(i("^\\|{0}\\|",y)),H=new RegExp(i("^\\[(?:\\d+|#{0}?|\\*)]_",x)),B=new RegExp(i("^\\[{0}\\]_",x)),G=new RegExp(i("^{0}__?",x)),g=new RegExp(i("^`{0}`_",R)),h=new RegExp(i("^:{0}:`{1}`{2}",_,R,u)),m=new RegExp(i("^`{1}`:{0}:{2}",_,R,u)),$=new RegExp(i("^:{0}:{1}",_,u)),J=new RegExp(i("^{0}",x)),K=new RegExp(i("^::{0}",u)),X=new RegExp(i("^\\|{0}\\|",y)),Q=new RegExp(i("^{0}",w)),U=new RegExp(i("^{0}",x)),V=new RegExp(i("^::{0}",u)),Y=new RegExp("^_"),Z=new RegExp(i("^{0}|_",x)),C=new RegExp(i("^:{0}",u)),ee=new RegExp("^::\\s*$"),ne=new RegExp("^\\s+(?:>>>|In \\[\\d+\\]:)\\s");function o(n,e){var r=null;if(n.sol()&&n.match(ne,!1))c(e,q,{mode:v,local:l.startState(v)});else if(n.sol()&&n.match(z))c(e,t),r="meta";else if(n.sol()&&n.match(f))c(e,o),r="header";else if(k(e)==h||n.match(h,!1))switch(d(e)){case 0:c(e,o,a(h,1)),n.match(/^:/),r="meta";break;case 1:c(e,o,a(h,2)),n.match(T),r="keyword",n.current().match(/^(?:math|latex)/)&&(e.tmp_stex=!0);break;case 2:c(e,o,a(h,3)),n.match(/^:`/),r="meta";break;case 3:if(e.tmp_stex&&(e.tmp_stex=void 0,e.tmp={mode:b,local:l.startState(b)}),e.tmp){if(n.peek()=="`"){c(e,o,a(h,4)),e.tmp=void 0;break}r=e.tmp.mode.token(n,e.tmp.local);break}c(e,o,a(h,4)),n.match(W),r="string";break;case 4:c(e,o,a(h,5)),n.match(/^`/),r="meta";break;case 5:c(e,o,a(h,6)),n.match(E);break;default:c(e,o)}else if(k(e)==m||n.match(m,!1))switch(d(e)){case 0:c(e,o,a(m,1)),n.match(/^`/),r="meta";break;case 1:c(e,o,a(m,2)),n.match(W),r="string";break;case 2:c(e,o,a(m,3)),n.match(/^`:/),r="meta";break;case 3:c(e,o,a(m,4)),n.match(T),r="keyword";break;case 4:c(e,o,a(m,5)),n.match(/^:/),r="meta";break;case 5:c(e,o,a(m,6)),n.match(E);break;default:c(e,o)}else if(k(e)==$||n.match($,!1))switch(d(e)){case 0:c(e,o,a($,1)),n.match(/^:/),r="meta";break;case 1:c(e,o,a($,2)),n.match(T),r="keyword";break;case 2:c(e,o,a($,3)),n.match(/^:/),r="meta";break;case 3:c(e,o,a($,4)),n.match(E);break;default:c(e,o)}else if(k(e)==j||n.match(j,!1))switch(d(e)){case 0:c(e,o,a(j,1)),n.match(X),r="variable-2";break;case 1:c(e,o,a(j,2)),n.match(/^_?_?/)&&(r="link");break;default:c(e,o)}else if(n.match(H))c(e,o),r="quote";else if(n.match(B))c(e,o),r="quote";else if(n.match(G))c(e,o),(!n.peek()||n.peek().match(/^\W$/))&&(r="link");else if(k(e)==g||n.match(g,!1))switch(d(e)){case 0:!n.peek()||n.peek().match(/^\W$/)?c(e,o,a(g,1)):n.match(g);break;case 1:c(e,o,a(g,2)),n.match(/^`/),r="link";break;case 2:c(e,o,a(g,3)),n.match(W);break;case 3:c(e,o,a(g,4)),n.match(/^`_/),r="link";break;default:c(e,o)}else n.match(ee)?c(e,re):n.next()&&c(e,o);return r}function t(n,e){var r=null;if(k(e)==S||n.match(S,!1))switch(d(e)){case 0:c(e,t,a(S,1)),n.match(X),r="variable-2";break;case 1:c(e,t,a(S,2)),n.match(Q);break;case 2:c(e,t,a(S,3)),n.match(U),r="keyword";break;case 3:c(e,t,a(S,4)),n.match(V),r="meta";break;default:c(e,o)}else if(k(e)==A||n.match(A,!1))switch(d(e)){case 0:c(e,t,a(A,1)),n.match(J),r="keyword",n.current().match(/^(?:math|latex)/)?e.tmp_stex=!0:n.current().match(/^python/)&&(e.tmp_py=!0);break;case 1:c(e,t,a(A,2)),n.match(K),r="meta",(n.match(/^latex\s*$/)||e.tmp_stex)&&(e.tmp_stex=void 0,c(e,q,{mode:b,local:l.startState(b)}));break;case 2:c(e,t,a(A,3)),(n.match(/^python\s*$/)||e.tmp_py)&&(e.tmp_py=void 0,c(e,q,{mode:v,local:l.startState(v)}));break;default:c(e,o)}else if(k(e)==O||n.match(O,!1))switch(d(e)){case 0:c(e,t,a(O,1)),n.match(Y),n.match(Z),r="link";break;case 1:c(e,t,a(O,2)),n.match(C),r="meta";break;default:c(e,o)}else n.match(D)||n.match(F)?(c(e,o),r="quote"):(n.eatSpace(),n.eol()?c(e,o):(n.skipToEnd(),c(e,ce),r="comment"));return r}function ce(n,e){return L(n,e,"comment")}function re(n,e){return L(n,e,"meta")}function L(n,e,r){return n.eol()||n.eatSpace()?(n.skipToEnd(),r):(c(e,o),null)}function q(n,e){return e.ctx.mode&&e.ctx.local?n.sol()?(n.eatSpace()||c(e,o),null):e.ctx.mode.token(n,e.ctx.local):(c(e,o),null)}function a(n,e,r,N){return{phase:n,stage:e,mode:r,local:N}}function c(n,e,r){n.tok=e,n.ctx=r||{}}function d(n){return n.ctx.stage||0}function k(n){return n.ctx.phase}return{startState:function(){return{tok:o,ctx:a(void 0,0)}},copyState:function(n){var e=n.ctx,r=n.tmp;return e.local&&(e={mode:e.mode,local:l.copyState(e.mode,e.local)}),r&&(r={mode:r.mode,local:l.copyState(r.mode,r.local)}),{tok:n.tok,ctx:e,tmp:r}},innerMode:function(n){return n.tmp?{state:n.tmp.local,mode:n.tmp.mode}:n.ctx.mode?{state:n.ctx.local,mode:n.ctx.mode}:null},token:function(n,e){return e.tok(n,e)}}},"python","stex"),l.defineMIME("text/x-rst","rst")})})();var ue=M.exports,_e=fe({__proto__:null,default:ue},[M.exports]);export{_e as r};
+import{z as oe}from"./index.ed3b88b9.entry.js";import{a as ae}from"./python.a4264fb2.js";import{a as ie}from"./stex.02a09785.js";import{o as le}from"./overlay.7ab0da68.js";function fe(s,I){return I.forEach(function(l){l&&typeof l!="string"&&!Array.isArray(l)&&Object.keys(l).forEach(function(p){if(p!=="default"&&!(p in s)){var i=Object.getOwnPropertyDescriptor(l,p);Object.defineProperty(s,p,i.get?i:{enumerable:!0,get:function(){return l[p]}})}})}),Object.freeze(Object.defineProperty(s,Symbol.toStringTag,{value:"Module"}))}var L={exports:{}};(function(s,I){(function(l){l(oe.exports,ae.exports,ie.exports,le.exports)})(function(l){l.defineMode("rst",function(p,i){var v=/^\*\*[^\*\s](?:[^\*]*[^\*\s])?\*\*/,b=/^\*[^\*\s](?:[^\*]*[^\*\s])?\*/,w=/^``[^`\s](?:[^`]*[^`\s])``/,u=/^(?:[\d]+(?:[\.,]\d+)*)/,E=/^(?:\s\+[\d]+(?:[\.,]\d+)*)/,_=/^(?:\s\-[\d]+(?:[\.,]\d+)*)/,T="[Hh][Tt][Tt][Pp][Ss]?://",P="(?:[\\d\\w.-]+)\\.(?:\\w{2,6})",x="(?:/[\\d\\w\\#\\%\\&\\-\\.\\,\\/\\:\\=\\?\\~]+)*",y=new RegExp("^"+T+P+x),R={token:function(f){if(f.match(v)&&f.match(/\W+|$/,!1))return"strong";if(f.match(b)&&f.match(/\W+|$/,!1))return"em";if(f.match(w)&&f.match(/\W+|$/,!1))return"string-2";if(f.match(u))return"number";if(f.match(E))return"positive";if(f.match(_))return"negative";if(f.match(y))return"link";for(;f.next()!=null&&!(f.match(v,!1)||f.match(b,!1)||f.match(w,!1)||f.match(u,!1)||f.match(E,!1)||f.match(_,!1)||f.match(y,!1)););return null}},W=l.getMode(p,i.backdrop||"rst-base");return l.overlayMode(W,R,!0)},"python","stex"),l.defineMode("rst-base",function(p){function i(n){var e=Array.prototype.slice.call(arguments,1);return n.replace(/{(\d+)}/g,function(r,N){return typeof e[N]!="undefined"?e[N]:r})}var v=l.getMode(p,"python"),b=l.getMode(p,"stex"),w="\\s+",u="(?:\\s*|\\W|$)",E=new RegExp(i("^{0}",u)),_=`(?:[^\\W\\d_](?:[\\w!"#$%&'()\\*\\+,\\-\\./:;<=>\\?]*[^\\W_])?)`,T=new RegExp(i("^{0}",_)),P=`(?:[^\\W\\d_](?:[\\w\\s!"#$%&'()\\*\\+,\\-\\./:;<=>\\?]*[^\\W_])?)`,x=i("(?:{0}|`{1}`)",_,P),y="(?:[^\\s\\|](?:[^\\|]*[^\\s\\|])?)",R="(?:[^\\`]+)",W=new RegExp(i("^{0}",R)),f=new RegExp("^([!'#$%&\"()*+,-./:;<=>?@\\[\\\\\\]^_`{|}~])\\1{3,}\\s*$"),M=new RegExp(i("^\\.\\.{0}",w)),O=new RegExp(i("^_{0}:{1}|^__:{1}",x,u)),A=new RegExp(i("^{0}::{1}",x,u)),S=new RegExp(i("^\\|{0}\\|{1}{2}::{3}",y,w,x,u)),D=new RegExp(i("^\\[(?:\\d+|#{0}?|\\*)]{1}",x,u)),F=new RegExp(i("^\\[{0}\\]{1}",x,u)),j=new RegExp(i("^\\|{0}\\|",y)),H=new RegExp(i("^\\[(?:\\d+|#{0}?|\\*)]_",x)),B=new RegExp(i("^\\[{0}\\]_",x)),G=new RegExp(i("^{0}__?",x)),g=new RegExp(i("^`{0}`_",R)),h=new RegExp(i("^:{0}:`{1}`{2}",_,R,u)),m=new RegExp(i("^`{1}`:{0}:{2}",_,R,u)),$=new RegExp(i("^:{0}:{1}",_,u)),J=new RegExp(i("^{0}",x)),K=new RegExp(i("^::{0}",u)),X=new RegExp(i("^\\|{0}\\|",y)),Q=new RegExp(i("^{0}",w)),U=new RegExp(i("^{0}",x)),V=new RegExp(i("^::{0}",u)),Y=new RegExp("^_"),Z=new RegExp(i("^{0}|_",x)),C=new RegExp(i("^:{0}",u)),ee=new RegExp("^::\\s*$"),ne=new RegExp("^\\s+(?:>>>|In \\[\\d+\\]:)\\s");function o(n,e){var r=null;if(n.sol()&&n.match(ne,!1))c(e,q,{mode:v,local:l.startState(v)});else if(n.sol()&&n.match(M))c(e,t),r="meta";else if(n.sol()&&n.match(f))c(e,o),r="header";else if(k(e)==h||n.match(h,!1))switch(d(e)){case 0:c(e,o,a(h,1)),n.match(/^:/),r="meta";break;case 1:c(e,o,a(h,2)),n.match(T),r="keyword",n.current().match(/^(?:math|latex)/)&&(e.tmp_stex=!0);break;case 2:c(e,o,a(h,3)),n.match(/^:`/),r="meta";break;case 3:if(e.tmp_stex&&(e.tmp_stex=void 0,e.tmp={mode:b,local:l.startState(b)}),e.tmp){if(n.peek()=="`"){c(e,o,a(h,4)),e.tmp=void 0;break}r=e.tmp.mode.token(n,e.tmp.local);break}c(e,o,a(h,4)),n.match(W),r="string";break;case 4:c(e,o,a(h,5)),n.match(/^`/),r="meta";break;case 5:c(e,o,a(h,6)),n.match(E);break;default:c(e,o)}else if(k(e)==m||n.match(m,!1))switch(d(e)){case 0:c(e,o,a(m,1)),n.match(/^`/),r="meta";break;case 1:c(e,o,a(m,2)),n.match(W),r="string";break;case 2:c(e,o,a(m,3)),n.match(/^`:/),r="meta";break;case 3:c(e,o,a(m,4)),n.match(T),r="keyword";break;case 4:c(e,o,a(m,5)),n.match(/^:/),r="meta";break;case 5:c(e,o,a(m,6)),n.match(E);break;default:c(e,o)}else if(k(e)==$||n.match($,!1))switch(d(e)){case 0:c(e,o,a($,1)),n.match(/^:/),r="meta";break;case 1:c(e,o,a($,2)),n.match(T),r="keyword";break;case 2:c(e,o,a($,3)),n.match(/^:/),r="meta";break;case 3:c(e,o,a($,4)),n.match(E);break;default:c(e,o)}else if(k(e)==j||n.match(j,!1))switch(d(e)){case 0:c(e,o,a(j,1)),n.match(X),r="variable-2";break;case 1:c(e,o,a(j,2)),n.match(/^_?_?/)&&(r="link");break;default:c(e,o)}else if(n.match(H))c(e,o),r="quote";else if(n.match(B))c(e,o),r="quote";else if(n.match(G))c(e,o),(!n.peek()||n.peek().match(/^\W$/))&&(r="link");else if(k(e)==g||n.match(g,!1))switch(d(e)){case 0:!n.peek()||n.peek().match(/^\W$/)?c(e,o,a(g,1)):n.match(g);break;case 1:c(e,o,a(g,2)),n.match(/^`/),r="link";break;case 2:c(e,o,a(g,3)),n.match(W);break;case 3:c(e,o,a(g,4)),n.match(/^`_/),r="link";break;default:c(e,o)}else n.match(ee)?c(e,re):n.next()&&c(e,o);return r}function t(n,e){var r=null;if(k(e)==S||n.match(S,!1))switch(d(e)){case 0:c(e,t,a(S,1)),n.match(X),r="variable-2";break;case 1:c(e,t,a(S,2)),n.match(Q);break;case 2:c(e,t,a(S,3)),n.match(U),r="keyword";break;case 3:c(e,t,a(S,4)),n.match(V),r="meta";break;default:c(e,o)}else if(k(e)==A||n.match(A,!1))switch(d(e)){case 0:c(e,t,a(A,1)),n.match(J),r="keyword",n.current().match(/^(?:math|latex)/)?e.tmp_stex=!0:n.current().match(/^python/)&&(e.tmp_py=!0);break;case 1:c(e,t,a(A,2)),n.match(K),r="meta",(n.match(/^latex\s*$/)||e.tmp_stex)&&(e.tmp_stex=void 0,c(e,q,{mode:b,local:l.startState(b)}));break;case 2:c(e,t,a(A,3)),(n.match(/^python\s*$/)||e.tmp_py)&&(e.tmp_py=void 0,c(e,q,{mode:v,local:l.startState(v)}));break;default:c(e,o)}else if(k(e)==O||n.match(O,!1))switch(d(e)){case 0:c(e,t,a(O,1)),n.match(Y),n.match(Z),r="link";break;case 1:c(e,t,a(O,2)),n.match(C),r="meta";break;default:c(e,o)}else n.match(D)||n.match(F)?(c(e,o),r="quote"):(n.eatSpace(),n.eol()?c(e,o):(n.skipToEnd(),c(e,ce),r="comment"));return r}function ce(n,e){return z(n,e,"comment")}function re(n,e){return z(n,e,"meta")}function z(n,e,r){return n.eol()||n.eatSpace()?(n.skipToEnd(),r):(c(e,o),null)}function q(n,e){return e.ctx.mode&&e.ctx.local?n.sol()?(n.eatSpace()||c(e,o),null):e.ctx.mode.token(n,e.ctx.local):(c(e,o),null)}function a(n,e,r,N){return{phase:n,stage:e,mode:r,local:N}}function c(n,e,r){n.tok=e,n.ctx=r||{}}function d(n){return n.ctx.stage||0}function k(n){return n.ctx.phase}return{startState:function(){return{tok:o,ctx:a(void 0,0)}},copyState:function(n){var e=n.ctx,r=n.tmp;return e.local&&(e={mode:e.mode,local:l.copyState(e.mode,e.local)}),r&&(r={mode:r.mode,local:l.copyState(r.mode,r.local)}),{tok:n.tok,ctx:e,tmp:r}},innerMode:function(n){return n.tmp?{state:n.tmp.local,mode:n.tmp.mode}:n.ctx.mode?{state:n.ctx.local,mode:n.ctx.mode}:null},token:function(n,e){return e.tok(n,e)}}},"python","stex"),l.defineMIME("text/x-rst","rst")})})();var ue=L.exports,_e=fe({__proto__:null,default:ue},[L.exports]);export{_e as r};