@directus/app 9.12.2 → 9.14.1

package/dist/assets/fields.715d4591.js

@@ -0,0 +1,135 @@
+import{a as n,o as d,b as c,w as s,g as e,e as i,B as l}from"./runtime-core.esm-bundler.b1f35d24.js";const h={class:"markdown-body"},p={class:"two-up"},u={class:"left"},f=l("Fields are individual pieces of content within an item. They are mapped to columns in the database. "),g=l("Learn more about Fields"),m=l("."),_=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-field-object"},"The Field Object ")]),e("li",null,[e("a",{href:"#list-all-fields"},"List All Fields ")]),e("li",null,[e("a",{href:"#list-fields-in-collection"},"List Fields in Collection ")]),e("li",null,[e("a",{href:"#retrieve-a-field"},"Retrieve a Field ")]),e("li",null,[e("a",{href:"#create-a-field"},"Create a Field ")]),e("li",null,[e("a",{href:"#update-a-field"},"Update a Field ")]),e("li",null,[e("a",{href:"#delete-a-field"},"Delete a Field ")])])])])],-1),b=e("hr",null,null,-1),j=e("h2",{id:"the-field-object",tabindex:"-1"},[l("The Field Object "),e("a",{class:"header-anchor",href:"#the-field-object"},"#")],-1),y={class:"two-up"},x={class:"left"},v={class:"definitions"},q=e("p",null,[e("code",null,"collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the collection the field resides in.")],-1),T=e("p",null,[e("code",null,"field"),l(),e("strong",null,"string"),e("br"),l(" The identifier of the field. This matches the table column name.")],-1),w=e("code",null,"type",-1),A=l(),k=e("strong",null,"string",-1),E=e("br",null,null,-1),S=l(" The Directus data type of the field. See "),P=l("Types"),F=l(" for possible options."),R=e("h4",{id:"meta",tabindex:"-1"},[l("Meta "),e("a",{class:"header-anchor",href:"#meta"},"#")],-1),L=e("p",null,"Directus metadata, primarily used in the Admin App. Meta is optional.",-1),C=e("div",{class:"definitions"},[e("p",null,[e("code",null,"id"),l(),e("strong",null,"integer"),e("br"),l(" Primary key of the metadata row in "),e("code",null,"directus_fields"),l(".")]),e("p",null,[e("code",null,"collection"),l(),e("strong",null,"string"),e("br"),l(" The name of the collection this field resides in.")]),e("p",null,[e("code",null,"field"),l(),e("strong",null,"string"),e("br"),l(" Identifier of the field. Matches the column name in the database.")]),e("p",null,[e("code",null,"special"),l(),e("strong",null,"string"),e("br"),l(" Any special transform flags that apply to this field.")]),e("p",null,[e("code",null,"interface"),l(),e("strong",null,"string"),e("br"),l(" The interface used for this field.")]),e("p",null,[e("code",null,"options"),l(),e("strong",null,"object"),e("br"),l(" The interface options configured for this field. The structure is based on the interface used.")]),e("p",null,[e("code",null,"display"),l(),e("strong",null,"string"),e("br"),l(" The display used for this field.")]),e("p",null,[e("code",null,"display_options"),l(),e("strong",null,"string"),e("br"),l(" The configured options for the used display.")]),e("p",null,[e("code",null,"readonly"),l(),e("strong",null,"boolean"),e("br"),l(" If the field is considered readonly in the Admin App.")]),e("p",null,[e("code",null,"hidden"),l(),e("strong",null,"boolean"),e("br"),l(" If the field is hidden from the edit page in the Admin App.")]),e("p",null,[e("code",null,"sort"),l(),e("strong",null,"integer"),e("br"),l(" Where this field is shown on the edit page in the Admin App.")]),e("p",null,[e("code",null,"width"),l(),e("strong",null,"string"),e("br"),l(" How wide the interface is rendered on the edit page in the Admin App. One of "),e("code",null,"half"),l(", "),e("code",null,"half-left"),l(", "),e("code",null,"half-right"),l(", "),e("code",null,"half-space"),l(", "),e("code",null,"full"),l(", "),e("code",null,"fill"),l(".")]),e("p",null,[e("code",null,"translations"),l(),e("strong",null,"array"),e("br"),l(" How this field\u2019s name is displayed in the different languages in the Admin App.")]),e("p",null,[e("code",null,"note"),l(),e("strong",null,"string"),e("br"),l(" Short description displayed in the Admin App.")])],-1),Q=e("h4",{id:"schema",tabindex:"-1"},[l("Schema "),e("a",{class:"header-anchor",href:"#schema"},"#")],-1),I=e("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers. Note: schema is optional. If a field exist in directus_fields, but not in the database, it\u2019s an alias commonly used for relational (o2m) or presentation purposes in the Admin App.",-1),G=e("div",{class:"definitions"},[e("p",null,[e("code",null,"name"),l(),e("strong",null,"string"),e("br"),l(" Identifier of the field. Matches the column name in the database.")]),e("p",null,[e("code",null,"table"),l(),e("strong",null,"string"),e("br"),l(" Name of the table the column resides in.")]),e("p",null,[e("code",null,"data_type"),l(),e("strong",null,"string"),e("br"),l(" The datatype as used in the database. Note: this value is database vendor specific.")]),e("p",null,[e("code",null,"default_value"),l(),e("strong",null,"any"),e("br"),l(" The configured default value for the column.")]),e("p",null,[e("code",null,"max_length"),l(),e("strong",null,"integer"),e("br"),l(" Configured length for varchar-type columns.")]),e("p",null,[e("code",null,"numeric_precision"),l(),e("strong",null,"integer"),e("br"),l(" Precision for integer/float/decimal type fields.")]),e("p",null,[e("code",null,"numeric_scale"),l(),e("strong",null,"integer"),e("br"),l(" Scale for integer/float/decimal type fields.")]),e("p",null,[e("code",null,"is_nullable"),l(),e("strong",null,"boolean"),e("br"),l(" Whether or not the column is nullable. This is what is used as the \u201Crequired\u201D state in Directus.")]),e("p",null,[e("code",null,"is_primary_key"),l(),e("strong",null,"boolean"),e("br"),l(" Whether or not the field is the primary key of the table.")]),e("p",null,[e("code",null,"foreign_key_column"),l(),e("strong",null,"string"),e("br"),l(" If the current column has a foreign key constraint, this points to the related column.")]),e("p",null,[e("code",null,"foreign_key_table"),l(),e("strong",null,"string"),e("br"),l(" If the current column has a foreign key constraint, this points to the related table.")]),e("p",null,[e("code",null,"comment"),l(),e("strong",null,"string"),e("br"),l(" Comment as stored in the database.")])],-1),O=e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[l(`{
+	`),e("span",{class:"hljs-attr"},'"collection"'),l(": "),e("span",{class:"hljs-string"},'"articles"'),l(`,
+	`),e("span",{class:"hljs-attr"},'"field"'),l(": "),e("span",{class:"hljs-string"},'"id"'),l(`,
+	`),e("span",{class:"hljs-attr"},'"type"'),l(": "),e("span",{class:"hljs-string"},'"integer"'),l(`,
+	`),e("span",{class:"hljs-attr"},'"meta"'),l(`: {
+		`),e("span",{class:"hljs-attr"},'"id"'),l(": "),e("span",{class:"hljs-number"},"16"),l(`,
+		`),e("span",{class:"hljs-attr"},'"collection"'),l(": "),e("span",{class:"hljs-string"},'"articles"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"field"'),l(": "),e("span",{class:"hljs-string"},'"id"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"special"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"interface"'),l(": "),e("span",{class:"hljs-string"},'"numeric"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"options"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"display"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"display_options"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"readonly"'),l(": "),e("span",{class:"hljs-literal"},"true"),l(`,
+		`),e("span",{class:"hljs-attr"},'"hidden"'),l(": "),e("span",{class:"hljs-literal"},"true"),l(`,
+		`),e("span",{class:"hljs-attr"},'"sort"'),l(": "),e("span",{class:"hljs-number"},"1"),l(`,
+		`),e("span",{class:"hljs-attr"},'"width"'),l(": "),e("span",{class:"hljs-string"},'"full"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"translations"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"note"'),l(": "),e("span",{class:"hljs-string"},'"The unique identifier of the article"'),l(`
+	},
+	`),e("span",{class:"hljs-attr"},'"schema"'),l(`: {
+		`),e("span",{class:"hljs-attr"},'"name"'),l(": "),e("span",{class:"hljs-string"},'"id"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"table"'),l(": "),e("span",{class:"hljs-string"},'"articles"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"data_type"'),l(": "),e("span",{class:"hljs-string"},'"integer"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"default_value"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"max_length"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"numeric_precision"'),l(": "),e("span",{class:"hljs-number"},"32"),l(`,
+		`),e("span",{class:"hljs-attr"},'"numeric_scale"'),l(": "),e("span",{class:"hljs-number"},"0"),l(`,
+		`),e("span",{class:"hljs-attr"},'"is_nullable"'),l(": "),e("span",{class:"hljs-literal"},"false"),l(`,
+		`),e("span",{class:"hljs-attr"},'"is_primary_key"'),l(": "),e("span",{class:"hljs-literal"},"true"),l(`,
+		`),e("span",{class:"hljs-attr"},'"has_auto_increment"'),l(": "),e("span",{class:"hljs-literal"},"true"),l(`,
+		`),e("span",{class:"hljs-attr"},'"foreign_key_column"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"foreign_key_table"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"comment"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`
+	}
+}
+`)])])],-1),D=e("hr",null,null,-1),B=e("h2",{id:"list-all-fields",tabindex:"-1"},[l("List All Fields "),e("a",{class:"header-anchor",href:"#list-all-fields"},"#")],-1),H=e("p",null,"List the available fields.",-1),M=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters",tabindex:"-1"},[l("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")]),e("p",null,"This endpoint doesn\u2019t currently support any query parameters."),e("h3",{id:"returns",tabindex:"-1"},[l("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")]),e("p",null,[l("An array of "),e("a",{href:"#the-field-object"},"field objects"),l(".")])]),e("div",{class:"right"},[e("h3",{id:"rest-api",tabindex:"-1"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")]),e("pre",null,[e("code",null,`GET /fields
+`)]),e("h3",{id:"graphql",tabindex:"-1"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),l(` {
+	fields: [directus_fields]
+}
+`)])]),e("h5",{id:"example",tabindex:"-1"},[l("Example "),e("a",{class:"header-anchor",href:"#example"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
+	fields {
+		collection
+		field
+	}
+}
+`)])])])],-1),N=e("hr",null,null,-1),W=e("h2",{id:"list-fields-in-collection",tabindex:"-1"},[l("List Fields in Collection "),e("a",{class:"header-anchor",href:"#list-fields-in-collection"},"#")],-1),U=e("p",null,"List the available fields in a given collection.",-1),V=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters-1",tabindex:"-1"},[l("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-1"},"#")]),e("p",null,"This endpoint doesn\u2019t currently support any query parameters."),e("h3",{id:"returns-1",tabindex:"-1"},[l("Returns "),e("a",{class:"header-anchor",href:"#returns-1"},"#")]),e("p",null,[l("An array of "),e("a",{href:"#the-field-object"},"field objects"),l(".")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-1",tabindex:"-1"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),e("pre",null,[e("code",null,`GET /fields/:collection
+`)]),e("h5",{id:"example-1",tabindex:"-1"},[l("Example "),e("a",{class:"header-anchor",href:"#example-1"},"#")]),e("pre",null,[e("code",null,`GET /fields/articles
+`)]),e("h3",{id:"graphql-1",tabindex:"-1"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-1"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),l(` {
+	fields_in_collection(collection:`),e("span",{class:"hljs-type"}," String"),l(`!): directus_fields
+}
+`)])]),e("h5",{id:"example-2",tabindex:"-1"},[l("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
+	fields_in_collection(collection: `),e("span",{class:"hljs-string"},'"articles"'),l(`) {
+		collection
+		field
+	}
+}
+`)])])])],-1),z=e("hr",null,null,-1),J=e("h2",{id:"retrieve-a-field",tabindex:"-1"},[l("Retrieve a Field "),e("a",{class:"header-anchor",href:"#retrieve-a-field"},"#")],-1),K=e("p",null,"Get a single field in a given collection.",-1),X=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters-2",tabindex:"-1"},[l("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")]),e("p",null,"This endpoint doesn\u2019t currently support any query parameters."),e("h3",{id:"returns-2",tabindex:"-1"},[l("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")]),e("p",null,[l("A "),e("a",{href:"#the-field-object"},"field object"),l(".")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-2",tabindex:"-1"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`GET /fields/:collection/:field
+`)]),e("h5",{id:"example-3",tabindex:"-1"},[l("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",null,`GET /fields/articles/title
+`)]),e("h3",{id:"graphql-2",tabindex:"-1"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),l(` {
+	fields_by_name(collection:`),e("span",{class:"hljs-type"}," String"),l("!, field:"),e("span",{class:"hljs-type"}," String"),l(`!): directus_fields
+}
+`)])]),e("h5",{id:"example-4",tabindex:"-1"},[l("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
+	fields_by_name(collection: `),e("span",{class:"hljs-string"},'"articles"'),l(", field: "),e("span",{class:"hljs-string"},'"title"'),l(`) {
+		collection
+		field
+	}
+}
+`)])])])],-1),Y=e("hr",null,null,-1),Z=e("h2",{id:"create-a-field",tabindex:"-1"},[l("Create a Field "),e("a",{class:"header-anchor",href:"#create-a-field"},"#")],-1),$=e("p",null,"Create a new field in the given collection.",-1),ee=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters-3",tabindex:"-1"},[l("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")]),e("p",null,"This endpoint doesn\u2019t currently support any query parameters."),e("h3",{id:"request-body",tabindex:"-1"},[l("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"field"),l(),e("strong",null,"Required"),e("br"),l(" Field key, also used as the column name.")]),e("p",null,[e("code",null,"type"),l(),e("strong",null,"Required"),e("br"),l(" One of the Directus types. This in turn controls what datatype is used for the column in the database. Setting the type to "),e("code",null,"alias"),l(" prevents a column from being created in the database.")]),e("p",null,[e("code",null,"meta"),e("br"),l(" Any of the optional meta values in the "),e("a",{href:"#the-field-object"},"field object"),l(".")]),e("p",null,[e("code",null,"schema"),e("br"),l(" Any of the optional schema values in the "),e("a",{href:"#the-field-object"},"field object"),l(".")])]),e("h3",{id:"returns-3",tabindex:"-1"},[l("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")]),e("p",null,[l("The "),e("a",{href:"#the-field-object"},"field object"),l(" for the created field.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-3",tabindex:"-1"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /fields/:collection
+`)]),e("h5",{id:"example-5",tabindex:"-1"},[l("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /fields/articles"),l(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"field"'),l(": "),e("span",{class:"hljs-string"},'"title"'),l(`,
+	`),e("span",{class:"hljs-attr"},'"type"'),l(": "),e("span",{class:"hljs-string"},'"string"'),l(`,
+	`),e("span",{class:"hljs-attr"},'"meta"'),l(`: {
+		`),e("span",{class:"hljs-attr"},'"icon"'),l(": "),e("span",{class:"hljs-string"},'"title"'),l(`
+	},
+	`),e("span",{class:"hljs-attr"},'"schema"'),l(`: {
+		`),e("span",{class:"hljs-attr"},'"default_value"'),l(": "),e("span",{class:"hljs-string"},'"Hello World"'),l(`
+	}
+}
+`)])]),e("h3",{id:"graphql-3",tabindex:"-1"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),l(` {
+	create_fields_item(collection:`),e("span",{class:"hljs-type"}," String"),l(`!, data: create_directus_fields_input!): directus_fields
+}
+`)])]),e("h5",{id:"example-6",tabindex:"-1"},[l("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),l(` {
+	create_fields_item(
+		collection: `),e("span",{class:"hljs-string"},'"articles"'),l(`
+		data: { field: `),e("span",{class:"hljs-string"},'"title"'),l(", "),e("span",{class:"hljs-keyword"},"type"),l(": "),e("span",{class:"hljs-string"},'"string"'),l(", meta: { icon: "),e("span",{class:"hljs-string"},'"title"'),l(" }, "),e("span",{class:"hljs-keyword"},"schema"),l(": { default_value: "),e("span",{class:"hljs-string"},'"Hello World"'),l(` } }
+	) {
+		collection
+		field
+	}
+}
+`)])])])],-1),le=e("hr",null,null,-1),se=e("h2",{id:"update-a-field",tabindex:"-1"},[l("Update a Field "),e("a",{class:"header-anchor",href:"#update-a-field"},"#")],-1),te=e("p",null,"Updates the given field in the given collection.",-1),ae=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters-4",tabindex:"-1"},[l("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")]),e("p",null,"This endpoint doesn\u2019t currently support any query parameters."),e("h3",{id:"request-body-1",tabindex:"-1"},[l("Request Body "),e("a",{class:"header-anchor",href:"#request-body-1"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"type"),e("br"),l(" The new type for the field.")]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Changing Type"),e("p",null,"Types may not be compatible, and/or data might be truncated / corrupted. Please be careful when changing types of an existing field with content.")]),e("p",null,[e("code",null,"meta"),e("br"),l(" Any of the optional meta values in the "),e("a",{href:"#the-field-object"},"field object"),l(".")]),e("p",null,[e("code",null,"schema"),e("br"),l(" Any of the optional schema values in the "),e("a",{href:"#the-field-object"},"field object"),l(".")])]),e("p",null,"Updating the field name is not supported at this time."),e("h3",{id:"returns-4",tabindex:"-1"},[l("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")]),e("p",null,[l("The "),e("a",{href:"#the-field-object"},"field object"),l(" for the updated field.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-4",tabindex:"-1"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`PATCH /fields/:collection/:field
+`)]),e("h5",{id:"example-7",tabindex:"-1"},[l("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /fields/articles/title"),l(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"meta"'),l(`: {
+		`),e("span",{class:"hljs-attr"},'"note"'),l(": "),e("span",{class:"hljs-string"},'"Put the title here"'),l(`
+	},
+	`),e("span",{class:"hljs-attr"},'"schema"'),l(`: {
+		`),e("span",{class:"hljs-attr"},'"default_value"'),l(": "),e("span",{class:"hljs-string"},'"Hello World!"'),l(`
+	}
+}
+`)])]),e("h3",{id:"graphql-4",tabindex:"-1"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),l(` {
+	update_fields_item(collection:`),e("span",{class:"hljs-type"}," String"),l("!, field:"),e("span",{class:"hljs-type"}," String"),l(`!, data: update_directus_fields_input!): directus_fields
+}
+`)])]),e("h5",{id:"example-8",tabindex:"-1"},[l("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),l(` {
+	update_fields_item(
+		collection: `),e("span",{class:"hljs-string"},'"articles"'),l(`
+		field: `),e("span",{class:"hljs-string"},'"title"'),l(`
+		data: { meta: { note: `),e("span",{class:"hljs-string"},'"Put the title here"'),l(" }, "),e("span",{class:"hljs-keyword"},"schema"),l(": { default_value: "),e("span",{class:"hljs-string"},'"Hello World!"'),l(` } }
+	) {
+		collection
+		field
+	}
+}
+`)])])])],-1),ne=e("hr",null,null,-1),ie=e("h2",{id:"delete-a-field",tabindex:"-1"},[l("Delete a Field "),e("a",{class:"header-anchor",href:"#delete-a-field"},"#")],-1),re=e("p",null,"Deletes the given field in the given collection.",-1),oe=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Destructive"),e("p",null,"Be aware, this will delete the column from the database, including all data in it. This action can\u2019t be undone.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-5",tabindex:"-1"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`DELETE /fields/:collection/:field
+`)]),e("h5",{id:"example-9",tabindex:"-1"},[l("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",null,`DELETE /fields/articles/title
+`)]),e("h3",{id:"graphql-5",tabindex:"-1"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),l(` {
+	delete_fields_item(collection:`),e("span",{class:"hljs-type"}," String"),l("!, field:"),e("span",{class:"hljs-type"}," String"),l(`!): delete_field
+}
+`)])]),e("h5",{id:"example-10",tabindex:"-1"},[l("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),l(` {
+	delete_fields_item(collection: `),e("span",{class:"hljs-string"},'"articles"'),l(", field: "),e("span",{class:"hljs-string"},'"title"'),l(`) {
+		collection
+		field
+	}
+}
+`)])])])],-1),ue="Fields",fe=!1,ge="page-reference",me={name:"fields",setup(de,{expose:r}){const t={title:"Fields",modularExtension:!1,pageClass:"page-reference"};return r({frontmatter:t}),(ce,he)=>{const a=n("router-link"),o=n("docs-wrapper");return d(),c(o,{frontmatter:t},{default:s(()=>[e("div",h,[e("div",p,[e("div",u,[e("blockquote",null,[e("p",null,[f,i(a,{to:"/docs/getting-started/glossary/#fields"},{default:s(()=>[g]),_:1}),m])])]),_]),b,j,e("div",y,[e("div",x,[e("div",v,[q,T,e("p",null,[w,A,k,E,S,i(a,{to:"/docs/getting-started/glossary/#app"},{default:s(()=>[P]),_:1}),F])]),R,L,C,Q,I,G]),O]),D,B,H,M,N,W,U,V,z,J,K,X,Y,Z,$,ee,le,se,te,ae,ne,ie,re,oe])]),_:1})}}};export{me as default,fe as modularExtension,ge as pageClass,ue as title};

package/dist/assets/file-library.a4de4015.js

@@ -0,0 +1 @@
+import{a as s,o as d,b as c,w as t,g as e,e as i,B as l}from"./runtime-core.esm-bundler.b1f35d24.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,"The File Library Module aggregates all files within the Directus Project into one consolidated library. It is a full-featured Digital Asset Management (DAM) system for storing, organizing, browsing, and transforming your various files and assets.")],-1),p=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-library-20220307A.webp",alt:"File Library"})],-1),f=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#how-it-works"},"How it Works ")]),e("li",null,[e("a",{href:"#files"},"Files ")]),e("li",null,[e("a",{href:"#edit-an-image"},"Edit an Image ")]),e("li",null,[e("a",{href:"#upload-a-file"},"Upload a File ")]),e("li",null,[e("a",{href:"#replace-a-file"},"Replace a File ")]),e("li",null,[e("a",{href:"#folders"},"Folders ")]),e("li",null,[e("a",{href:"#create-a-folder"},"Create a Folder ")]),e("li",null,[e("a",{href:"#rename-a-folder"},"Rename a Folder ")]),e("li",null,[e("a",{href:"#move-a-folder"},"Move a Folder ")]),e("li",null,[e("a",{href:"#delete-a-folder"},"Delete a Folder ")]),e("li",null,[e("a",{href:"#more-help"},"More Help ")])])])],-1),_={class:"warning hint"},m=e("div",{class:"hint-title"},"More Documents on Folder and File Management",-1),g=l("This is a non-technical, no-code guide to the File Library Module. Please note there is documentation on programmatic "),b=l("Folder"),F=l(" and "),y=l("File"),v=l(" management via the API."),w=e("h2",{id:"how-it-works",tabindex:"-1"},[l("How it Works "),e("a",{class:"header-anchor",href:"#how-it-works"},"#")],-1),k={class:"tip hint"},A=e("div",{class:"hint-title"},"Required Knowledge",-1),C=l("Familiarity with the "),D=l("Collections Page"),T=l(" will be helpful but not necessary."),I=l("The File Library acts as one big "),L=e("a",{href:"#folders"},"Folder",-1),P=l(" to store all uploaded "),x=e("a",{href:"#files"},"Files",-1),M=l(". Sub-folders can be created within the File Library to help Files stay organized. Folders and File information are stored in regular Collections, which means "),S=l("User and Role access permissions"),E=l(" are fully configurable and granular on both Folders and Files. Multiple files can be uploaded at once through the app and also programmatically via the API. Any type of file can be uploaded, "),H=e("em",null,"not just images",-1),U=l(". When a Folder is selected from the Navigation Bar, the "),R=e("a",{href:"#folders"},"File Listing Page",-1),B=l(" is presented. This page has all the same features and functionalities as the "),N=l("Collections Page"),W=l("."),j=e("video",{title:"How the File Library Works",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/how-it-works-20220305A.mp4",type:"video/mp4"}),e("p",null,[l(" Your browser is not displaying the video for some reason. Here's a "),e("a",{href:""},"link to the video"),l(" instead. ")])],-1),z=e("ol",null,[e("li",null,[l("Select a Folder. There are two options: "),e("ul",null,[e("li",null,"Choose desired Folder from the Navigation Bar."),e("li",null,[l("Click "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" in the Page Header, name your folder, and click "),e("strong",null,"\u201CSave\u201D"),l(".")])])]),e("li",null,[l("Click "),e("span",{mi:"",btn:""},"add"),l(" in the Page Header. A popover will appear.")]),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])]),e("li",null,"Optional: Click the File Display to open the File Details Page and fill in information as desired.")],-1),O=e("h2",{id:"files",tabindex:"-1"},[l("Files "),e("a",{class:"header-anchor",href:"#files"},"#")],-1),K=l("When a file is clicked in the File Listing Page, the File Details Page appears. This is a custom form for viewing assets and embeds, with core Fields included out-of-the-box (see below), and the ability for Administrators to add additional custom Fields. This page has the same features and functionality as the "),V=l("Item Details Page"),Y=l("."),q=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/files-20220305A.webp",alt:"Files"})],-1),J=e("h3",{id:"action-buttons",tabindex:"-1"},[l("Action Buttons "),e("a",{class:"header-anchor",href:"#action-buttons"},"#")],-1),X=e("p",null,"Notice the following Buttons in the Header:",-1),G=e("ul",null,[e("li",null,[e("span",{mi:"",btn:""},"check"),l(" \u2013 Saves any edits made to the file. ")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"tune"),l(" \u2013 Please see [Edit an Image](#edit-an-image) to learn more. ")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"save_alt"),l(" \u2013 Downloads the file to your current device. ")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"drive_file_move"),l(" \u2013 Moves selected File(s) to another Folder. ")]),e("li",null,[e("span",{mi:"",btn:"",dngr:""},"delete"),l(" \u2013 Permanently removes the File and its metadata. This action is permanent and cannot be undone. ")])],-1),Q=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Deleting Files Linked to Items"),e("p",null,[l("By default, Directus will not allow you to delete a File until you remove it from any and all related Items. However, this behavior can be reconfigured so that Files automatically update when the image is deleted by setting the relational constraint of your File Field to "),e("code",null,"SET NULL"),l(" or "),e("code",null,"CASCADE"),l(" when the File is deleted.")])],-1),Z=e("h3",{id:"file-details",tabindex:"-1"},[l("File Details "),e("a",{class:"header-anchor",href:"#file-details"},"#")],-1),$=e("p",null,[l("The Files Collection comes pre-configured with the following Fields out of the box. New Fields can be created and customized as needed in "),e("strong",null,"Settings > Data Model"),l(". However the pre-configured Fields cannot be changed or deleted.")],-1),ee=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-details-20220305A.webp",alt:"File Details"})],-1),le=e("ul",null,[e("li",null,[e("strong",null,"Preview"),l(" \u2013 A preview of the image or file.")]),e("li",null,[e("strong",null,"Title"),l(" \u2013 A title for the File.")]),e("li",null,[e("strong",null,"Description"),l(" \u2013 A description of the File.")]),e("li",null,[e("strong",null,"Tags"),l(" \u2013 Keywords used for search-ability.")]),e("li",null,[e("strong",null,"Location"),l(" \u2013 An optional location "),e("em",null,"(e.g. where a photo was taken)"),l(".")]),e("li",null,[e("strong",null,"Storage"),l(" \u2013 Which storage adapter is used to store the file asset.")]),e("li",null,[e("strong",null,"Filename (Disk)"),l(" \u2013 LOCKED. This is the actual name of the file in storage.")]),e("li",null,[e("strong",null,"Filename (Download)"),l(" \u2013 Allows you to set the name of the file when it is downloaded.")])],-1),te=e("h3",{id:"file-sidebar",tabindex:"-1"},[l("File Sidebar "),e("a",{class:"header-anchor",href:"#file-sidebar"},"#")],-1),oe=e("p",null,"The file sidebar also includes the following details, which are not editable and serve as metadata.",-1),ie=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-sidebar-20220305A.webp",alt:"File Sidebar"})],-1),ae=e("ul",null,[e("li",null,[e("strong",null,"Type"),l(" \u2013 The MIME type of the file, displayed in the App as a formatted media type.")]),e("li",null,[e("strong",null,"Dimensions"),l(" \u2013 "),e("em",null,"Images only"),l(". The width and height of the image in pixels.")]),e("li",null,[e("strong",null,"Size"),l(" \u2013 The file-size the asset takes up in the storage adapter.")]),e("li",null,[e("strong",null,"Created"),l(" \u2013 The timestamp of when the file was uploaded to the Project.")]),e("li",null,[e("strong",null,"Owner"),l(" \u2013 The User that uploaded the file to the Project.")]),e("li",null,[e("strong",null,"Modified"),l(" \u2013 The timestamp of when the file was last modified.")]),e("li",null,[e("strong",null,"Edited By"),l(" \u2013 The User that modified the File.")]),e("li",null,[e("strong",null,"Folder"),l(" \u2013 The current parent folder that contains the File.")]),e("li",null,[e("strong",null,"Metadata"),l(" \u2013 Metadata JSON dump of the File\u2019s EXIF, IPTC, and ICC information.")])],-1),se=e("h2",{id:"edit-an-image",tabindex:"-1"},[l("Edit an Image "),e("a",{class:"header-anchor",href:"#edit-an-image"},"#")],-1),ne=e("p",null,"Rotate, crop, flip, or adjust aspect ratios of an image.",-1),re=e("video",{alt:"Edit an Image",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220516A/edit-an-image-20220516A.mp4",type:"video/mp4"})],-1),de=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click a file to open its detail page.")]),e("li",null,[l("Click the "),e("span",{mi:"",btn:"",sec:""},"tune"),l(" button in the top right to open the image editor.")]),e("li",null,[l("Make your changes and click "),e("span",{mi:"",btn:""},"check"),l(" in the top right to save the updates.")])],-1),ce=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"Edits overwrite the original file on disk. This can\u2019t be reversed.")],-1),he=e("h2",{id:"upload-a-file",tabindex:"-1"},[l("Upload a File "),e("a",{class:"header-anchor",href:"#upload-a-file"},"#")],-1),ue=l("We covered the File Library\u2019s three upload methods in "),pe=e("a",{href:"#how-it-works"},"How it Works",-1),fe=l(". Keep in mind that files can also be added through different Interfaces as well. For example, Users can upload an Avatar image when they fill in their User Details. Similarly, Items with an Image Field will have a file upload Interface on the Item Detail page. Files can also be "),_e=l("uploaded programmatically via the API"),me=l("."),ge=e("h2",{id:"replace-a-file",tabindex:"-1"},[l("Replace a File "),e("a",{class:"header-anchor",href:"#replace-a-file"},"#")],-1),be=e("p",null,"When a file is replaced, its existing info and all relationships are kept.",-1),Fe=e("video",{alt:"Replace a File",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220608A/replace-a-file-20220608A.mp4",type:"video/mp4"})],-1),ye=e("ol",null,[e("li",null,"Click the Image Preview on the File Detail page. A popup will appear."),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])])],-1),ve=e("h2",{id:"folders",tabindex:"-1"},[l("Folders "),e("a",{class:"header-anchor",href:"#folders"},"#")],-1),we=e("p",null,"Folders provide the organization system for Files.",-1),ke=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/folders-20220305A.webp",alt:"Folders"})],-1),Ae=l("They can be named, renamed, and nested as sub-folders anywhere in the Folder hierarchy. Once a Folder is selected from the Navigation Bar, File Listing Page opens. The File Listing Page displays all Files within a Folder. It also enables all other features and functionalities from the "),Ce=l("Collections Page"),De=l(" such as batch editing, batch deleting, sorting, filtering, searching, etc. Folders can also be managed "),Te=l("programmatically via the API"),Ie=l("."),Le=e("h2",{id:"create-a-folder",tabindex:"-1"},[l("Create a Folder "),e("a",{class:"header-anchor",href:"#create-a-folder"},"#")],-1),Pe=e("video",{alt:"Create a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/create-a-folder-20220305A.mp4",type:"video/mp4"})],-1),xe=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click on the "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" button located in the Header.")]),e("li",null,"Fill in a Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),Me=e("h2",{id:"rename-a-folder",tabindex:"-1"},[l("Rename a Folder "),e("a",{class:"header-anchor",href:"#rename-a-folder"},"#")],-1),Se=e("video",{alt:"Renaming a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/rename-a-folder-20220215A.mp4",type:"video/mp4"})],-1),Ee=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to rename and select \u201CRename Folder\u201D.")]),e("li",null,"Update the Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),He=e("h2",{id:"move-a-folder",tabindex:"-1"},[l("Move a Folder "),e("a",{class:"header-anchor",href:"#move-a-folder"},"#")],-1),Ue=e("video",{alt:"Moving a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/move-a-folder20220305A.mp4",type:"video/mp4"})],-1),Re=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the folder you wish to move and select "),e("strong",null,"\u201CMove to Folder\u201D"),l(". A popup will appear.")]),e("li",null,"Select a Folder to serve as the new Parent Folder."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),Be=e("h2",{id:"delete-a-folder",tabindex:"-1"},[l("Delete a Folder "),e("a",{class:"header-anchor",href:"#delete-a-folder"},"#")],-1),Ne=e("video",{alt:"Deleting a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/delete-a-folder-20220215A.mp4",type:"video/mp4"})],-1),We=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to delete and select "),e("strong",null,"\u201CDelete Folder\u201D"),l(".")]),e("li",null,[l("Click "),e("strong",null,"\u201CDelete\u201D"),l(".")])],-1),je=e("div",{class:"tip hint"},[e("p",null,"When you delete a Folder, any nested Files and Folders will be moved one level up.")],-1),ze=e("h2",{id:"more-help",tabindex:"-1"},[l("More Help "),e("a",{class:"header-anchor",href:"#more-help"},"#")],-1),Oe=e("p",null,[l("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),Je="File Library",Xe=!1,Ge={name:"file-library",setup(Ke,{expose:n}){const a={title:"File Library",modularExtension:!1};return n({frontmatter:a}),(Ve,Ye)=>{const o=s("router-link"),r=s("docs-wrapper");return d(),c(r,{frontmatter:a},{default:t(()=>[e("div",h,[u,p,f,e("div",_,[m,e("p",null,[g,i(o,{to:"/docs/reference/system/folders/"},{default:t(()=>[b]),_:1}),F,i(o,{to:"/docs/reference/files/"},{default:t(()=>[y]),_:1}),v])]),w,e("div",k,[A,e("p",null,[C,i(o,{to:"/docs/app/content-collections/"},{default:t(()=>[D]),_:1}),T])]),e("p",null,[I,L,P,x,M,i(o,{to:"/docs/configuration/users-roles-permissions.md"},{default:t(()=>[S]),_:1}),E,H,U,R,B,i(o,{to:"/docs/app/content-collections/"},{default:t(()=>[N]),_:1}),W]),j,z,O,e("p",null,[K,i(o,{to:"/docs/getting-started/glossary/#items"},{default:t(()=>[V]),_:1}),Y]),q,J,X,G,Q,Z,$,ee,le,te,oe,ie,ae,se,ne,re,de,ce,he,e("p",null,[ue,pe,fe,i(o,{to:"/docs/reference/files/"},{default:t(()=>[_e]),_:1}),me]),ge,be,Fe,ye,ve,we,ke,e("p",null,[Ae,i(o,{to:"/docs/app/content-collections/"},{default:t(()=>[Ce]),_:1}),De,i(o,{to:"/docs/docs/reference/system/folders.md"},{default:t(()=>[Te]),_:1}),Ie]),Le,Pe,xe,Me,Se,Ee,He,Ue,Re,Be,Ne,We,je,ze,Oe])]),_:1})}}};export{Ge as default,Xe as modularExtension,Je as title};

package/dist/assets/files.7c2ccfe2.js

@@ -0,0 +1,189 @@
+import{a as i,o as d,b as c,w as t,g as e,e as a,B as s}from"./runtime-core.esm-bundler.b1f35d24.js";const h={class:"markdown-body"},u=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,[s("Every file managed by the platform is uploaded to the configured storage adapter, and its associated metadata is tracked within the "),e("code",null,"directus_files"),s(" system collection. Any requested file transformations are handled on the fly, and are only saved to storage.")])])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#accessing-an-file"},"Accessing an File ")]),e("li",null,[e("a",{href:"#downloading-a-file"},"Downloading a File ")]),e("li",null,[e("a",{href:"#requesting-a-thumbnail"},"Requesting a Thumbnail ")]),e("li",null,[e("a",{href:"#the-file-object"},"The File Object ")]),e("li",null,[e("a",{href:"#list-files"},"List Files ")]),e("li",null,[e("a",{href:"#retrieve-a-file"},"Retrieve a File ")]),e("li",null,[e("a",{href:"#upload-a-file"},"Upload a File ")]),e("li",null,[e("a",{href:"#import-a-file"},"Import a File ")]),e("li",null,[e("a",{href:"#update-a-file"},"Update a File ")]),e("li",null,[e("a",{href:"#update-multiple-files"},"Update Multiple Files ")]),e("li",null,[e("a",{href:"#delete-a-file"},"Delete a File ")]),e("li",null,[e("a",{href:"#delete-multiple-files"},"Delete Multiple Files ")])])])])])],-1),p=e("hr",null,null,-1),f=e("h2",{id:"accessing-an-file",tabindex:"-1"},[s("Accessing an File "),e("a",{class:"header-anchor",href:"#accessing-an-file"},"#")],-1),_=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"The location of your actual file originals is based on the project\u2019s configuration, but you can consistently access them via the API using the following URL."),e("pre",null,[e("code",null,`example.com/assets/<file-id>
+example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4
+`)]),e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"SEO"),e("p",null,"You can provide an optional filename after the UUID to optimize for SEO, for example:"),e("pre",null,[e("code",null,`example.com/assets/<file-id>/<filename>
+example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4/directus-logo.png
+`)]),e("p",null,[s("This optional filename is also used in the Content-Disposition header when the "),e("code",null,"?download"),s(" query parameter is used.")])]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Direct File Access"),e("p",null,[s("While you may "),e("em",null,"technically"),s(" be able to expose your storage adapters root filesystem and access your raw files through there, it is recommended that you always use the Directus API. This is the only way that you can take advantage of file permissions and other built-in features.")])])]),e("div",{class:"right"},[e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/original-20220216A.jpg",alt:"Original File"}),s(),e("em",null,"Original File Used \u2014 602KB and 1800x1200")])])],-1),m=e("hr",null,null,-1),g=e("h2",{id:"downloading-a-file",tabindex:"-1"},[s("Downloading a File "),e("a",{class:"header-anchor",href:"#downloading-a-file"},"#")],-1),b=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[s("To download an asset with the correct filename, you need to add the "),e("code",null,"?download"),s(" query parameter to the request and the "),e("code",null,"download"),s(" attribute to your anchor tag. This will ensure the appropriate "),e("a",{href:"https://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html",target:"_blank",rel:"noopener noreferrer"},"Content-Disposition"),s(" headers are added. Without this, the download will work on the "),e("em",null,"same"),s(" domain, however it will have the file\u2019s \u201Cid\u201D as the filename for cross-origin requests.")])]),e("div",{class:"right"},[e("h3",{id:"example",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")]),e("pre",null,[e("code",{class:"language-html"},[e("span",{class:"hljs-tag"},[s("<"),e("span",{class:"hljs-name"},"a"),s(),e("span",{class:"hljs-attr"},"href"),s("="),e("span",{class:"hljs-string"},'"https://your-directus.com/assets/<file-id>?download"'),s(),e("span",{class:"hljs-attr"},"target"),s("="),e("span",{class:"hljs-string"},'"_blank"'),s(),e("span",{class:"hljs-attr"},"download"),s("="),e("span",{class:"hljs-string"},'"Your File.pdf"'),s(">")]),s("Download"),e("span",{class:"hljs-tag"},[s("</"),e("span",{class:"hljs-name"},"a"),s(">")]),s(`
+`)])])])],-1),y=e("hr",null,null,-1),j=e("h2",{id:"requesting-a-thumbnail",tabindex:"-1"},[s("Requesting a Thumbnail "),e("a",{class:"header-anchor",href:"#requesting-a-thumbnail"},"#")],-1),x={class:"two-up"},v={class:"left"},q=e("p",null,[s("Fetching thumbnails is as easy as adding a "),e("code",null,"key"),s(" query parameter to the original file\u2019s URL. In the Admin App, you can configure different asset presets that control the output of any given image. If a requested thumbnail doesn\u2019t yet exist, it is dynamically generated and immediately returned.")],-1),w=e("h3",{id:"preset-transformations",tabindex:"-1"},[s("Preset Transformations "),e("a",{class:"header-anchor",href:"#preset-transformations"},"#")],-1),T=e("strong",null,[e("code",null,"key")],-1),k=s(" \u2014 This "),R=e("strong",null,"key",-1),E=s(" of the "),A=s("Storage Asset Preset"),D=s(", a shortcut for the below parameters"),S=e("h3",{id:"custom-transformations",tabindex:"-1"},[s("Custom Transformations "),e("a",{class:"header-anchor",href:"#custom-transformations"},"#")],-1),F=e("p",null,"Alternatively, if you have \u201CStorage Asset Transform\u201D set to all, you can use the following parameters for more fine grained control:",-1),P=e("ul",null,[e("li",null,[e("strong",null,[e("code",null,"fit")]),s(" \u2014 The "),e("strong",null,"fit"),s(" of the thumbnail while always preserving the aspect ratio, can be any of the following options: "),e("ul",null,[e("li",null,[e("code",null,"cover"),s(" \u2014 Covers both width/height by cropping/clipping to fit")]),e("li",null,[e("code",null,"contain"),s(" \u2014 Contain within both width/height using \u201Cletterboxing\u201D as needed")]),e("li",null,[e("code",null,"inside"),s(" \u2014 Resize to be as large as possible, ensuring dimensions are less than or equal to the requested width and height")]),e("li",null,[e("code",null,"outside"),s(" \u2014 Resize to be as small as possible, ensuring dimensions are greater than or equal to the requested width and height")])])]),e("li",null,[e("strong",null,[e("code",null,"width")]),s(" \u2014 The "),e("strong",null,"width"),s(" of the thumbnail in pixels")]),e("li",null,[e("strong",null,[e("code",null,"height")]),s(" \u2014 The "),e("strong",null,"height"),s(" of the thumbnail in pixels")]),e("li",null,[e("strong",null,[e("code",null,"quality")]),s(" \u2014 The optional "),e("strong",null,"quality"),s(" of the thumbnail ("),e("code",null,"1"),s(" to "),e("code",null,"100"),s(")")]),e("li",null,[e("strong",null,[e("code",null,"withoutEnlargement")]),s(" \u2014 Disable image up-scaling")]),e("li",null,[e("strong",null,[e("code",null,"format")]),s(" \u2014 What file format to return the thumbnail in. One of "),e("code",null,"jpg"),s(", "),e("code",null,"png"),s(", "),e("code",null,"webp"),s(", "),e("code",null,"tiff")])],-1),C=e("h3",{id:"advanced-transformations",tabindex:"-1"},[s("Advanced Transformations "),e("a",{class:"header-anchor",href:"#advanced-transformations"},"#")],-1),I=e("p",null,[s("For even more advanced control over the file generation, Directus exposes "),e("a",{href:"https://sharp.pixelplumbing.com/api-operation",target:"_blank",rel:"noopener noreferrer"},[s("the full "),e("code",null,"sharp"),s(" API")]),s(" through the "),e("code",null,"transforms"),s(" query parameter. This parameter accepts a two-dimensional array with the format "),e("code",null,"[Operation, ...arguments]"),s(".")],-1),O=e("h3",{id:"quality-vs-filesize",tabindex:"-1"},[s("Quality vs Filesize "),e("a",{class:"header-anchor",href:"#quality-vs-filesize"},"#")],-1),Q=e("p",null,[s("The quality parameter can be any integer from "),e("code",null,"0-100"),s(". Qualities closer to "),e("code",null,"0"),s(" have lower filesizes, but also poor image quality due to compression artifacts. Values closer to "),e("code",null,"100"),s(" have larger filesizes, but better image quality. Below are four possible qualities (200x200 cover) to visually compare the balance between compression and filesize.")],-1),U=e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"25%"),e("th",null,"50%"),e("th",null,"75%"),e("th",null,"100%")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-25-20220216A.jpg",alt:"25%"}),e("br"),e("em",null,"4KB")]),e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-50-20220216A.jpg",alt:"50%"}),e("br"),e("em",null,"6KB")]),e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-75-20220216A.jpg",alt:"75%"}),e("br"),e("em",null,"8KB")]),e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-100-20220216A.jpg",alt:"100%"}),e("br"),e("em",null,"38KB")])])])],-1),B=e("div",{class:"right"},[e("h3",{id:"preset",tabindex:"-1"},[s("Preset "),e("a",{class:"header-anchor",href:"#preset"},"#")]),e("pre",null,[e("code",null,`example.com/assets/<file-id>?key=<key>
+`)]),e("h3",{id:"custom",tabindex:"-1"},[s("Custom "),e("a",{class:"header-anchor",href:"#custom"},"#")]),e("pre",null,[e("code",null,`example.com/assets/<file-id>?fit=<fit>&width=<width>&height=<height>&quality=<quality>
+example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4?fit=cover&width=200&height=200&quality=80
+`)]),e("h3",{id:"advanced",tabindex:"-1"},[s("Advanced "),e("a",{class:"header-anchor",href:"#advanced"},"#")]),e("pre",null,[e("code",null,`?transforms=[
+	["blur", 45],
+	["tint", "rgb(255, 0, 0)"],
+	["expand", { "right": 200, "bottom": 150 }]
+]
+`)])],-1),L=e("hr",null,null,-1),X=e("h2",{id:"the-file-object",tabindex:"-1"},[s("The File Object "),e("a",{class:"header-anchor",href:"#the-file-object"},"#")],-1),Y={class:"two-up"},M={class:"left"},z={class:"definitions"},G=e("p",null,[e("code",null,"id"),s(),e("strong",null,"uuid"),e("br"),s(" Primary key of the file")],-1),N=e("p",null,[e("code",null,"storage"),s(),e("strong",null,"string"),e("br"),s(" Storage adapter used for the file.")],-1),Z=e("p",null,[e("code",null,"filename_disk"),s(),e("strong",null,"string"),e("br"),s(" Name of the file as saved on the storage adapter.")],-1),H=e("p",null,[e("code",null,"filename_download"),s(),e("strong",null,"string"),e("br"),s(" Preferred filename when file is downloaded.")],-1),W=e("p",null,[e("code",null,"title"),s(),e("strong",null,"string"),e("br"),s(" Title for the file.")],-1),K=e("p",null,[e("code",null,"type"),s(),e("strong",null,"string"),e("br"),s(" Mimetype of the file.")],-1),J=e("code",null,"folder",-1),V=s(),$=e("strong",null,"many-to-one",-1),ee=e("br",null,null,-1),se=s(" What (virtual) folder the file is in. Many-to-one to "),te=s("folders"),le=s("."),ae=e("code",null,"uploaded_by",-1),ne=s(),ie=e("strong",null,"many-to-one",-1),oe=e("br",null,null,-1),re=s(" Who uploaded the file. Many-to-one to "),de=s("users"),ce=s("."),he=e("p",null,[e("code",null,"uploaded_on"),s(),e("strong",null,"datetime"),e("br"),s(" When the file was uploaded.")],-1),ue=e("code",null,"modified_by",-1),pe=s(),fe=e("strong",null,"many-to-one",-1),_e=e("br",null,null,-1),me=s(" Who updated the file last. Many-to-one to "),ge=s("users"),be=s("."),ye=e("p",null,[e("code",null,"filesize"),s(),e("strong",null,"number"),e("br"),s(" Size of the file in bytes.")],-1),je=e("p",null,[e("code",null,"width"),s(),e("strong",null,"number"),e("br"),s(" If the file is a(n) image/video, it\u2019s the width in px.")],-1),xe=e("p",null,[e("code",null,"height"),s(),e("strong",null,"number"),e("br"),s(" If the file is a(n) image/video, it\u2019s the height in px.")],-1),ve=e("p",null,[e("code",null,"duration"),s(),e("strong",null,"number"),e("br"),s(" If the file contains audio/video, it\u2019s the duration in milliseconds.")],-1),qe=e("p",null,[e("code",null,"description"),s(),e("strong",null,"string"),e("br"),s(" Description of the file.")],-1),we=e("p",null,[e("code",null,"location"),s(),e("strong",null,"string"),e("br"),s(" Location of the file.")],-1),Te=e("p",null,[e("code",null,"tags"),s(),e("strong",null,"array"),e("br"),s(" Tags for the file.")],-1),ke=e("p",null,[e("code",null,"metadata"),s(),e("strong",null,"object"),e("br"),s(" Any additional metadata Directus was able to scrape from the file. For images, this includes EXIF, IPTC, and ICC information.")],-1),Re=e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[s(`{
+	`),e("span",{class:"hljs-attr"},'"id"'),s(": "),e("span",{class:"hljs-string"},'"4f4b14fa-a43a-46d0-b7ad-90af5919bebb"'),s(`,
+	`),e("span",{class:"hljs-attr"},'"storage"'),s(": "),e("span",{class:"hljs-string"},'"local"'),s(`,
+	`),e("span",{class:"hljs-attr"},'"filename_disk"'),s(": "),e("span",{class:"hljs-string"},'"4f4b14fa-a43a-46d0-b7ad-90af5919bebb.jpeg"'),s(`,
+	`),e("span",{class:"hljs-attr"},'"filename_download"'),s(": "),e("span",{class:"hljs-string"},'"paulo-silva-vSRgXtQuns8-unsplash.jpg"'),s(`,
+	`),e("span",{class:"hljs-attr"},'"title"'),s(": "),e("span",{class:"hljs-string"},'"Paulo Silva (via Unsplash)"'),s(`,
+	`),e("span",{class:"hljs-attr"},'"type"'),s(": "),e("span",{class:"hljs-string"},'"image/jpeg"'),s(`,
+	`),e("span",{class:"hljs-attr"},'"folder"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
+	`),e("span",{class:"hljs-attr"},'"uploaded_by"'),s(": "),e("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),s(`,
+	`),e("span",{class:"hljs-attr"},'"uploaded_on"'),s(": "),e("span",{class:"hljs-string"},'"2021-02-04T11:37:41-05:00"'),s(`,
+	`),e("span",{class:"hljs-attr"},'"modified_by"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
+	`),e("span",{class:"hljs-attr"},'"modified_on"'),s(": "),e("span",{class:"hljs-string"},'"2021-02-04T11:37:42-05:00"'),s(`,
+	`),e("span",{class:"hljs-attr"},'"filesize"'),s(": "),e("span",{class:"hljs-number"},"3442252"),s(`,
+	`),e("span",{class:"hljs-attr"},'"width"'),s(": "),e("span",{class:"hljs-number"},"3456"),s(`,
+	`),e("span",{class:"hljs-attr"},'"height"'),s(": "),e("span",{class:"hljs-number"},"5184"),s(`,
+	`),e("span",{class:"hljs-attr"},'"duration"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
+	`),e("span",{class:"hljs-attr"},'"description"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
+	`),e("span",{class:"hljs-attr"},'"location"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
+	`),e("span",{class:"hljs-attr"},'"tags"'),s(": ["),e("span",{class:"hljs-string"},'"photo"'),s(", "),e("span",{class:"hljs-string"},'"pretty"'),s(`],
+	`),e("span",{class:"hljs-attr"},'"metadata"'),s(`: {
+		`),e("span",{class:"hljs-attr"},'"icc"'),s(`: {
+			`),e("span",{class:"hljs-attr"},'"version"'),s(": "),e("span",{class:"hljs-string"},'"2.1"'),s(`,
+			`),e("span",{class:"hljs-attr"},'"intent"'),s(": "),e("span",{class:"hljs-string"},'"Perceptual"'),s(`,
+			`),e("span",{class:"hljs-attr"},'"cmm"'),s(": "),e("span",{class:"hljs-string"},'"lcms"'),s(`,
+			`),e("span",{class:"hljs-attr"},'"deviceClass"'),s(": "),e("span",{class:"hljs-string"},'"Monitor"'),s(`,
+			`),e("span",{class:"hljs-attr"},'"colorSpace"'),s(": "),e("span",{class:"hljs-string"},'"RGB"'),s(`,
+			`),e("span",{class:"hljs-attr"},'"connectionSpace"'),s(": "),e("span",{class:"hljs-string"},'"XYZ"'),s(`,
+			`),e("span",{class:"hljs-attr"},'"platform"'),s(": "),e("span",{class:"hljs-string"},'"Apple"'),s(`,
+			`),e("span",{class:"hljs-attr"},'"creator"'),s(": "),e("span",{class:"hljs-string"},'"lcms"'),s(`,
+			`),e("span",{class:"hljs-attr"},'"description"'),s(": "),e("span",{class:"hljs-string"},'"c2"'),s(`,
+			`),e("span",{class:"hljs-attr"},'"copyright"'),s(": "),e("span",{class:"hljs-string"},'""'),s(`
+		}
+	}
+}
+`)])])],-1),Ee=e("hr",null,null,-1),Ae=e("h2",{id:"list-files",tabindex:"-1"},[s("List Files "),e("a",{class:"header-anchor",href:"#list-files"},"#")],-1),De=e("p",null,"List all files that exist in Directus.",-1),Se={class:"two-up"},Fe={class:"left"},Pe=e("h3",{id:"query-parameters",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),Ce=s("Supports all "),Ie=s("global query parameters"),Oe=s("."),Qe=e("h3",{id:"returns",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),Ue=s("An array of up to "),Be=s("limit"),Le=s(),Xe=e("a",{href:"#the-file-object"},"file objects",-1),Ye=s(". If no items are available, data will be an empty array."),Me={class:"right"},ze=e("h3",{id:"rest-api",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),Ge=e("pre",null,[e("code",null,`GET /files
+SEARCH /files
+`)],-1),Ne=s("Learn more about SEARCH ->"),Ze=e("h3",{id:"graphql",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),He=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),We=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
+	files: [directus_files]
+}
+`)])],-1),Ke=e("h5",{id:"example-1",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-1"},"#")],-1),Je=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
+	files {
+		id
+		filename_disk
+	}
+}
+`)])],-1),Ve=e("hr",null,null,-1),$e=e("h2",{id:"retrieve-a-file",tabindex:"-1"},[s("Retrieve a File "),e("a",{class:"header-anchor",href:"#retrieve-a-file"},"#")],-1),es=e("p",null,"Retrieve a single file by primary key.",-1),ss={class:"two-up"},ts={class:"left"},ls=e("h3",{id:"query-parameters-1",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),as=s("Supports all "),ns=s("global query parameters"),is=s("."),os=e("h3",{id:"returns-1",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-1"},"#")],-1),rs=e("p",null,[s("Returns a "),e("a",{href:"#the-file-object"},"file object"),s(" if a valid primary key was provided.")],-1),ds=e("div",{class:"right"},[e("h3",{id:"rest-api-1",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),e("pre",null,[e("code",null,`GET /files/:id
+`)]),e("h5",{id:"example-2",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",null,`GET /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d
+`)]),e("h3",{id:"graphql-1",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-1"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
+	files_by_id(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): directus_files
+}
+`)])]),e("h5",{id:"example-3",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
+	files_by_id(id: `),e("span",{class:"hljs-string"},'"0fca80c4-d61c-4404-9fd7-6ba86b64154d"'),s(`) {
+		id
+		filename_disk
+	}
+}
+`)])])],-1),cs=e("h2",{id:"upload-a-file",tabindex:"-1"},[s("Upload a File "),e("a",{class:"header-anchor",href:"#upload-a-file"},"#")],-1),hs=e("p",null,"Upload/create a new file.",-1),us={class:"two-up"},ps={class:"left"},fs=e("p",null,[s("To upload a file, use "),e("code",null,"multipart/form-data"),s(" as the encoding type, instead of JSON.")],-1),_s=e("p",null,[s("The file contents has to be provided in a part called "),e("code",null,"file"),s(". All other properties of "),e("a",{href:"#the-file-object"},"the file object"),s(" can be provided as parts as well.")],-1),ms=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Order Matters"),e("p",null,[s("Make sure to define the non-file properties "),e("em",null,"first"),s(". This ensures that the file metadata is associated with the correct file.")])],-1),gs=e("p",null,"You can upload multiple files at a time by repeating the payload with different contents, for example:",-1),bs=e("pre",null,[e("code",null,`--__X_BOUNDARY__
+Content-Disposition: form-data; name="title"
+
+Example
+--__X_BOUNDARY__
+Content-Disposition: form-data; name="file"; filename="paulo-silva-vSRgXtQuns8-unsplash.jpg"
+Content-Type: image/jpeg
+
+// binary data
+
+--__X_BOUNDARY__
+Content-Disposition: form-data; name="title"
+
+Another Title
+--__X_BOUNDARY__
+Content-Disposition: form-data; name="file"; filename="mae-mu-GFhqNX1gE9E-unsplash.jpg"
+Content-Type: image/jpeg
+
+// binary data
+`)],-1),ys=e("p",null,[s("In JavaScript, this can be achieved using the native "),e("code",null,"FormData"),s(" class:")],-1),js=e("pre",null,[e("code",{class:"language-js"},[e("span",{class:"hljs-keyword"},"import"),s(" axios "),e("span",{class:"hljs-keyword"},"from"),s(),e("span",{class:"hljs-string"},"'axios'"),s(`;
+
+`),e("span",{class:"hljs-keyword"},"const"),s(" fileInput = "),e("span",{class:"hljs-built_in"},"document"),s(".querySelector("),e("span",{class:"hljs-string"},`'input[type="file"]'`),s(`);
+`),e("span",{class:"hljs-keyword"},"const"),s(" formData = "),e("span",{class:"hljs-keyword"},"new"),s(` FormData();
+
+formData.append(`),e("span",{class:"hljs-string"},"'title'"),s(", "),e("span",{class:"hljs-string"},"'My First File'"),s(`);
+formData.append(`),e("span",{class:"hljs-string"},"'file'"),s(", fileInput.files["),e("span",{class:"hljs-number"},"0"),s(`]);
+
+`),e("span",{class:"hljs-keyword"},"await"),s(" axios.post("),e("span",{class:"hljs-string"},"'/files'"),s(`, formData);
+`)])],-1),xs=e("h3",{id:"query-parameters-2",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),vs=s("Supports all "),qs=s("global query parameters"),ws=s("."),Ts=e("h3",{id:"returns-2",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ks=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file object"),s(" for the uploaded file, or an array of "),e("a",{href:"#the-file-object"},"file objects"),s(" if multiple files were uploaded at once.")],-1),Rs=e("div",{class:"right"},[e("pre",null,[e("code",null,`POST /files
+`)]),e("pre",null,[e("code",null,`// Request
+
+Content-Type: multipart/form-data; charset=utf-8; boundary=__X_BOUNDARY__
+Content-Length: 3442422
+
+--__X_BOUNDARY__
+Content-Disposition: form-data; name="file"; filename="paulo-silva-vSRgXtQuns8-unsplash.jpg"
+Content-Type: image/jpeg
+
+\xFF\xD8\xFF\xE0JFIF


HH\xFF\xE2ICC_PROFILE

\flcmsmntrRGB XYZ \x07\xDC
)9acspAPPL\xF6\xD6
\xD3-lcms
+desc\xFC^cprt
\\\vwtpt
hbkpt
|rXYZ
\x90gXYZ
\xA4bXYZ
\xB8rTRC
\xCC@gTRC
\xCC@bTRC
\xCC@descc2textIXXYZ \xF6\xD6
\xD3-XYZ 3\xA4XYZ o\xA28\xF5\x90XYZ b\x99\xB7\x85\xDAXYZ $\xA0\x84\xB6\xCFcurv\xCB
\xC9c\x92\bk\v\xF6?Q\x1B4!\xF1)\x902;\x92FQw]\xEDkpz\x89\xB1\x9A|\xACi\xBF}\xD3\xC3\xE90\xFF\xFF\xFF\xDB\x84\b\b\x07\x07
+`)])],-1),Es=e("hr",null,null,-1),As=e("h2",{id:"import-a-file",tabindex:"-1"},[s("Import a File "),e("a",{class:"header-anchor",href:"#import-a-file"},"#")],-1),Ds=e("p",null,"Import a file from the web",-1),Ss={class:"two-up"},Fs={class:"left"},Ps=e("h3",{id:"query-parameters-3",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Cs=s("Supports all "),Is=s("global query parameters"),Os=s("."),Qs=e("h3",{id:"request-body",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Us=e("div",{class:"definitions"},[e("p",null,[e("code",null,"url"),s(),e("strong",null,"Required"),e("br"),s(" The URL to download the file from.")]),e("p",null,[e("code",null,"data"),e("br"),s(" Any of "),e("a",{href:"#the-file-object"},"the file object"),s("\u2019s properties.")])],-1),Bs=e("h3",{id:"returns-3",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Ls=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file object"),s(" for the imported file.")],-1),Xs=e("div",{class:"right"},[e("h3",{id:"rest-api-2",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`POST /files/import
+`)]),e("h5",{id:"example-4",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /files/import"),s(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"url"'),s(": "),e("span",{class:"hljs-string"},'"https://source.unsplash.com/random"'),s(`,
+	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
+		`),e("span",{class:"hljs-attr"},'"title"'),s(": "),e("span",{class:"hljs-string"},'"Example"'),s(`
+	}
+}
+`)])]),e("h3",{id:"graphql-2",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	import_file(url:`),e("span",{class:"hljs-type"}," String"),s(`!, data: create_directus_files_input!): directus_files
+}
+`)])]),e("h5",{id:"example-5",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	import_file(url: `),e("span",{class:"hljs-string"},'"https://source.unsplash.com/random"'),s(", data: { title: "),e("span",{class:"hljs-string"},'"Example"'),s(` }) {
+		id
+	}
+}
+`)])])],-1),Ys=e("hr",null,null,-1),Ms=e("h2",{id:"update-a-file",tabindex:"-1"},[s("Update a File "),e("a",{class:"header-anchor",href:"#update-a-file"},"#")],-1),zs=e("p",null,"Update an existing file, and/or replace it\u2019s file contents.",-1),Gs={class:"two-up"},Ns={class:"left"},Zs=e("h3",{id:"query-parameters-4",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Hs=s("Supports all "),Ws=s("global query parameters"),Ks=s("."),Js=e("h3",{id:"request-body-1",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-1"},"#")],-1),Vs=e("p",null,[s("You can either submit a JSON object consisting of a partial "),e("a",{href:"#the-file-object"},"file object"),s(" to update the file meta, or send a multipart/form-data request to replace the file contents on disk. See "),e("a",{href:"#upload-a-file"},"Upload a File"),s(" for more information on the structure of this "),e("code",null,"multipart/form-data"),s(" request.")],-1),$s=e("h3",{id:"returns-4",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),et=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file object"),s(" for the updated file.")],-1),st=e("div",{class:"right"},[e("h3",{id:"rest-api-3",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`PATCH /files/:id
+`)]),e("h5",{id:"example-6",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d"),s(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"title"'),s(": "),e("span",{class:"hljs-string"},'"Example"'),s(`
+}
+`)])]),e("h3",{id:"graphql-3",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	update_files_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!, data: update_directus_files_input!): directus_files
+}
+`)])]),e("h5",{id:"example-7",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	update_files_item(id: `),e("span",{class:"hljs-string"},'"0fca80c4-d61c-4404-9fd7-6ba86b64154d"'),s(", data: { title: "),e("span",{class:"hljs-string"},'"Example"'),s(` }) {
+		id
+		title
+	}
+}
+`)])])],-1),tt=e("hr",null,null,-1),lt=e("h2",{id:"update-multiple-files",tabindex:"-1"},[s("Update Multiple Files "),e("a",{class:"header-anchor",href:"#update-multiple-files"},"#")],-1),at=e("p",null,"Update multiple files at the same time.",-1),nt={class:"two-up"},it={class:"left"},ot=e("h3",{id:"query-parameters-5",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),rt=s("Supports all "),dt=s("global query parameters"),ct=s("."),ht=e("h3",{id:"request-body-2",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),ut=e("div",{class:"definitions"},[e("p",null,[e("code",null,"keys"),s(),e("strong",null,"Required"),e("br"),s(" Array of primary keys of the files you\u2019d like to update.")]),e("p",null,[e("code",null,"data"),s(),e("strong",null,"Required"),e("br"),s(" Any of "),e("a",{href:"#the-file-object"},"the file object"),s("\u2019s properties.")])],-1),pt=e("h3",{id:"returns-5",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),ft=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file objects"),s(" for the updated files.")],-1),_t=e("div",{class:"right"},[e("h3",{id:"rest-api-4",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`PATCH /files
+`)]),e("h5",{id:"example-8",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /files"),s(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"keys"'),s(": ["),e("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),s(", "),e("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),s(`],
+	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
+		`),e("span",{class:"hljs-attr"},'"tags"'),s(": ["),e("span",{class:"hljs-string"},'"cities"'),s(`]
+	}
+}
+`)])]),e("h3",{id:"graphql-4",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	update_files_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!, data: update_directus_files!): [directus_files]
+}
+`)])]),e("h5",{id:"example-9",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	update_files_items(
+		ids: [`),e("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),s(", "),e("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),s(`]
+		data: { tags: [`),e("span",{class:"hljs-string"},'"cities"'),s(`] }
+	)
+}
+`)])])],-1),mt=e("hr",null,null,-1),gt=e("h2",{id:"delete-a-file",tabindex:"-1"},[s("Delete a File "),e("a",{class:"header-anchor",href:"#delete-a-file"},"#")],-1),bt=e("p",null,"Delete an existing file.",-1),yt={class:"two-up"},jt={class:"left"},xt=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Destructive"),e("p",null,"This will also delete the file from disk.")],-1),vt=e("h3",{id:"query-parameters-6",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),qt=s("Supports all "),wt=s("global query parameters"),Tt=s("."),kt=e("h3",{id:"returns-6",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Rt=e("p",null,"Empty response.",-1),Et=e("div",{class:"right"},[e("h3",{id:"rest-api-5",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`DELETE /files/:id
+`)]),e("h5",{id:"example-10",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),e("pre",null,[e("code",null,`DELETE /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d
+`)]),e("h3",{id:"graphql-5",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	delete_files_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): delete_one
+}
+`)])]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	delete_files_item(id: `),e("span",{class:"hljs-string"},'"0fca80c4-d61c-4404-9fd7-6ba86b64154d"'),s(`) {
+		id
+	}
+}
+`)])])],-1),At=e("hr",null,null,-1),Dt=e("h2",{id:"delete-multiple-files",tabindex:"-1"},[s("Delete Multiple Files "),e("a",{class:"header-anchor",href:"#delete-multiple-files"},"#")],-1),St=e("p",null,"Delete multiple files at once.",-1),Ft=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Destructive"),e("p",null,"This will also delete the files from disk.")]),e("h3",{id:"request-body-3",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")]),e("p",null,"Array of file primary keys"),e("h3",{id:"returns-7",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")]),e("p",null,"Empty response.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-6",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`DELETE /files
+`)]),e("h5",{id:"example-11",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// DELETE /files"),s(`
+
+[`),e("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),s(", "),e("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),s(`]
+`)])]),e("h3",{id:"graphql-6",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	delete_files_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!): delete_many
+}
+`)])]),e("h5",{id:"example-12",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	delete_files_items(ids: [`),e("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),s(", "),e("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),s(`]) {
+		ids
+	}
+}
+`)])])])],-1),Qt="Accessing Files",Ut=!1,Bt="page-reference",Lt={name:"files",setup(Pt,{expose:o}){const n={title:"Accessing Files",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:n}),(Ct,It)=>{const l=i("router-link"),r=i("docs-wrapper");return d(),c(r,{frontmatter:n},{default:t(()=>[e("div",h,[u,p,f,_,m,g,b,y,j,e("div",x,[e("div",v,[q,w,e("ul",null,[e("li",null,[T,k,R,E,a(l,{to:"/docs/configuration/project-settings/#files-thumbnails"},{default:t(()=>[A]),_:1}),D])]),S,F,P,C,I,O,Q,U]),B]),L,X,e("div",Y,[e("div",M,[e("div",z,[G,N,Z,H,W,K,e("p",null,[J,V,$,ee,se,a(l,{to:"/docs/reference/system/folders/"},{default:t(()=>[te]),_:1}),le]),e("p",null,[ae,ne,ie,oe,re,a(l,{to:"/docs/reference/system/users/"},{default:t(()=>[de]),_:1}),ce]),he,e("p",null,[ue,pe,fe,_e,me,a(l,{to:"/docs/reference/system/users/"},{default:t(()=>[ge]),_:1}),be]),ye,je,xe,ve,qe,we,Te,ke])]),Re]),Ee,Ae,De,e("div",Se,[e("div",Fe,[Pe,e("p",null,[Ce,a(l,{to:"/docs/reference/query"},{default:t(()=>[Ie]),_:1}),Oe]),Qe,e("p",null,[Ue,a(l,{to:"/docs/reference/query/#limit"},{default:t(()=>[Be]),_:1}),Le,Xe,Ye])]),e("div",Me,[ze,Ge,e("p",null,[a(l,{to:"/docs/reference/introduction/#search-http-method"},{default:t(()=>[Ne]),_:1})]),Ze,He,We,Ke,Je])]),Ve,$e,es,e("div",ss,[e("div",ts,[ls,e("p",null,[as,a(l,{to:"/docs/reference/query"},{default:t(()=>[ns]),_:1}),is]),os,rs]),ds]),cs,hs,e("div",us,[e("div",ps,[fs,_s,ms,gs,bs,ys,js,xs,e("p",null,[vs,a(l,{to:"/docs/reference/query"},{default:t(()=>[qs]),_:1}),ws]),Ts,ks]),Rs]),Es,As,Ds,e("div",Ss,[e("div",Fs,[Ps,e("p",null,[Cs,a(l,{to:"/docs/reference/query"},{default:t(()=>[Is]),_:1}),Os]),Qs,Us,Bs,Ls]),Xs]),Ys,Ms,zs,e("div",Gs,[e("div",Ns,[Zs,e("p",null,[Hs,a(l,{to:"/docs/reference/query"},{default:t(()=>[Ws]),_:1}),Ks]),Js,Vs,$s,et]),st]),tt,lt,at,e("div",nt,[e("div",it,[ot,e("p",null,[rt,a(l,{to:"/docs/reference/query"},{default:t(()=>[dt]),_:1}),ct]),ht,ut,pt,ft]),_t]),mt,gt,bt,e("div",yt,[e("div",jt,[xt,vt,e("p",null,[qt,a(l,{to:"/docs/reference/query"},{default:t(()=>[wt]),_:1}),Tt]),kt,Rt]),Et]),At,Dt,St,Ft])]),_:1})}}};export{Lt as default,Ut as modularExtension,Bt as pageClass,Qt as title};