@directus/app 9.0.0-rc.93 → 9.0.0-rc.97

package/dist/assets/fields.a53c26fb.js

@@ -0,0 +1 @@
+import{r as s,p as r,q as c,w as o,B as e,t as l,P as t}from"./vendor.9bb37c18.js";var h="assets/m2o.ac02ed03.png",u="assets/o2m.339378e0.png",p="assets/m2m.07bed843.png",_="assets/m2a.347ed339.png",f="assets/translations.2f0017a9.png",g="assets/translations-2.29d07342.png";const m={class:"markdown-body"},y=t("Fields are a specific type of value within a Collection, storing the data of your item\u2019s content. Each field represents a "),b=e("strong",null,"column",-1),w=t(" in your database. "),v=t("Learn more about Fields"),T=t("."),C={class:"tip hint"},F=e("div",{class:"hint-title"},"System Fields",-1),k=t("While all out-of-the-box system fields are locked from editing or deleting, you are able to create new fields within the system collections. You can enable editing System Collections within the Collection sidebar component of "),D=t("Settings > Data Model"),A=t("."),S=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Database Fields"),e("p",null,[t("Keep in mind that a Directus Field is just a database column. Therefore you can import or create a column directly in the database, and it will automatically appear within Directus. The first time you manage that column, a "),e("code",null,"directus_fields"),t(" record will be created with default values.")])],-1),M=e("h2",{id:"creating-a-field"},[t("Creating a Field "),e("a",{class:"header-anchor",href:"#creating-a-field"},"#")],-1),O=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]")]),e("li",null,[t("Under Fields & Layout, click the "),e("strong",null,"Create Field"),t(" button")]),e("li",null,[e("strong",null,"Choose the field type"),t(", and follow its specific setup guide. (See below) "),e("ul",null,[e("li",null,[e("a",{href:"#schema-setup"},"Schema Setup")]),e("li",null,[e("a",{href:"#relationship-setup"},"Relationship Setup")]),e("li",null,[e("a",{href:"#field-setup"},"Field Setup")]),e("li",null,[e("a",{href:"#interface-options"},"Interface Options")]),e("li",null,[e("a",{href:"#display-options"},"Display Options")]),e("li",null,[e("a",{href:"#conditions"},"Conditions")])])])],-1),N=e("h3",{id:"schema-setup"},[t("Schema Setup "),e("a",{class:"header-anchor",href:"#schema-setup"},"#")],-1),R=e("p",null,"This pane controls the technical details of the field\u2019s database column.",-1),I=e("strong",null,"Key",-1),x=t(" \u2014 (Required) The database column name and field\u2019s API key. The key must be unique within its parent Collection. As of now, all keys are sanitized: lowercased, alphanumeric, and with spaces removed. Keys can not be changed once created, however you can use "),L=t("Translations"),q=t(" to override the field\u2019s display name in the App."),P=e("strong",null,"Type",-1),U=t(" \u2014 (Required) How the data is saved to the database; See "),j=t("Directus Data Type Superset"),W=t(". This dropdown maybe be limited or even disabled based on your chosen Field category."),E=e("li",null,[e("strong",null,"Length"),t(" \u2014 (Only for certain types) For String types this determines the number of characters that can be stored in the database. For Float and Decimal types, this control becomes "),e("strong",null,"Precision & Scale"),t(".")],-1),H=e("li",null,[e("strong",null,"On Create"),t(" \u2014 (Only for certain types) For some data types, this option allows you to control what value is saved when an item is created. These values are fallbacks and can be overridden by the App/API. For example, the Timestamp type allows you to \u201CSave Current Date/Time\u201D.")],-1),K=e("li",null,[e("strong",null,"On Update"),t(" \u2014 (Only for certain types) For some data types, this option allows you to control what value is saved when an item is updated. These values are fallbacks and can be overridden by the App/API. For example, the UUID type allows you to \u201CSave Current User ID\u201D.")],-1),V=e("li",null,[e("strong",null,"Default Value"),t(" \u2014 This is the initial value shown for a field when creating an item in the App. If creating an item via the API, this is the fallback value saved to the database if a field value is not submitted.")],-1),z=e("li",null,[e("strong",null,"Allow NULL"),t(" \u2014 Toggles if the database column is nullable. When disabled, a "),e("code",null,"NULL"),t(" value can not be saved to the field\u2019s column.")],-1),B=e("li",null,[e("strong",null,"Unique"),t(" \u2014 Toggles if the database column\u2019s values must all be unique.")],-1),J=e("h3",{id:"relationship-setup"},[t("Relationship Setup "),e("a",{class:"header-anchor",href:"#relationship-setup"},"#")],-1),G=e("p",null,"This pane is only shown when configuring relational fields (including images and translations).",-1),Y={class:"tip hint"},Q=e("div",{class:"hint-title"},"Matching Existing Schema",-1),X=t("To select existing Collections or Fields, use the list icon button on the right-side of the input \u2014\xA0exact schema matches are shown in blue. Collections or Fields without a match will be created on save. For more control over the primary key field type, first follow the normal "),Z=t("Create a Collection"),$=t(" flow before configuring the relationship."),ee={class:"tip hint"},te=e("div",{class:"hint-title"},"Corresponding Field",-1),oe=t("Relationships go both ways"),ne=t(", so when creating a new relation Field, Directus offers to automatically create the corresponding Field on the related Collection."),le=e("h4",{id:"many-to-one"},[t("Many-to-One "),e("a",{class:"header-anchor",href:"#many-to-one"},"#")],-1),ie=t("The "),se=t("Many-to-One"),ae=t(" is the only Relationship type that creates/uses an actual field on the parent Collection. If the chosen Related Collection already exists, the primary key field is automatically selected. If the Related Collection does not already exist, you will be prompted to enter the name of its new primary key field."),de=e("p",null,[e("img",{src:h,alt:"M2O"})],-1),re=e("h4",{id:"one-to-many"},[t("One-to-Many "),e("a",{class:"header-anchor",href:"#one-to-many"},"#")],-1),ce=t("The "),he=t("One-to-Many"),ue=t(" creates an "),pe=t("Alias"),_e=t(" field on the parent Collection. To configure, enter or select a Related Collection and a field therein for storing the foreign key. The related field must have a data type that matches the type of \u201CThis\u201D Collection\u2019s primary key field."),fe=e("p",null,[e("img",{src:u,alt:"O2M"})],-1),ge=e("p",null,[t("The optional "),e("strong",null,"Sort Field"),t(" can be used enable the reordering of items within the O2M field. Configured by entering the name/key of a Field (numeric type only) from the Related Collection.")],-1),me=e("h4",{id:"many-to-many"},[t("Many-to-Many "),e("a",{class:"header-anchor",href:"#many-to-many"},"#")],-1),ye=t("The "),be=t("Many-to-Many"),we=t(" creates an "),ve=t("Alias"),Te=t(" field on the parent Collection. To configure, enter or select a Related Collection and a field therein for storing the foreign key."),Ce=e("p",null,"To configure the Junction Collection, you can leave \u201CAuto Fill\u201D enabled to let Directus generate intelligent defaults, or disable it to select existing options or enter custom naming.",-1),Fe=e("p",null,[e("img",{src:p,alt:"M2M"})],-1),ke=e("h4",{id:"many-to-any"},[t("Many-to-Any "),e("a",{class:"header-anchor",href:"#many-to-any"},"#")],-1),De=t("The "),Ae=t("Many-to-Any"),Se=t(" creates an "),Me=t("Alias"),Oe=t(" field on the parent Collection. To configure, select one or more Related Collections. The primary key field of each will automatically be referenced."),Ne=e("p",null,"To configure the Junction Collection, you can leave \u201CAuto Fill\u201D enabled to let Directus generate intelligent defaults, or disable it to select existing options or enter custom naming.",-1),Re=e("p",null,[e("img",{src:_,alt:"M2A"})],-1),Ie=e("h4",{id:"translations"},[t("Translations "),e("a",{class:"header-anchor",href:"#translations"},"#")],-1),xe=t("Translations"),Le=t(" creates an "),qe=t("Alias"),Pe=t(" field on the parent Collection. The easiest way to create this is to use the modal wizard, which only asks for the Translation field name:"),Ue=e("p",null,[e("img",{src:f,alt:"Translations"})],-1),je=e("p",null,[t("If you choose to switch to the "),e("strong",null,"manual editor"),t(", enter or select a Related Collection and a field therein for storing the foreign key.")],-1),We=e("p",null,"To configure the Translations Collection, you can leave \u201CAuto Fill\u201D enabled to let Directus generate intelligent defaults, or disable it to select existing options or enter custom naming.",-1),Ee=e("p",null,[e("img",{src:g,alt:"Translations"})],-1),He=e("h3",{id:"field-setup"},[t("Field Setup "),e("a",{class:"header-anchor",href:"#field-setup"},"#")],-1),Ke=e("ul",null,[e("li",null,[e("strong",null,"Required"),t(" \u2014 Toggles if a value for the Field is required. "),e("ul",null,[e("li",null,[t("Empty strings ("),e("code",null,"''"),t(") and "),e("code",null,"NULL"),t(" are "),e("strong",null,"not"),t(" accepted as a valid value")]),e("li",null,[e("code",null,"0"),t(" and "),e("code",null,"false"),t(" are accepted as a valid value")]),e("li",null,"Default values are accepted as a valid value"),e("li",null,"Permission Presets are accepted as a valid value")])]),e("li",null,[e("strong",null,"Readonly"),t(" \u2014 (App Only) Sets the field to be disabled.")]),e("li",null,[e("strong",null,"Hidden"),t(" \u2014 (App Only) Hides the field in the App form. "),e("ul",null,[e("li",null,"The field is still available in filters and Layout options.")])]),e("li",null,[e("strong",null,"Note"),t(" \u2014 (App Only) Displayed below the field in the App form, providing a helpful comment for App users. This note supports markdown.")]),e("li",null,[e("strong",null,"Field Name Translations"),t(" \u2014 (App Only) A repeater for translating the Field Name into different locales. It can also be used to \u201Crename\u201D the field in the primary language without updating the field Key.")])],-1),Ve=e("h3",{id:"interface-options"},[t("Interface Options "),e("a",{class:"header-anchor",href:"#interface-options"},"#")],-1),ze=e("p",null,"This pane includes any customization options that may be defined by the Interface.",-1),Be=e("h3",{id:"display-options"},[t("Display Options "),e("a",{class:"header-anchor",href:"#display-options"},"#")],-1),Je=e("p",null,"This pane includes any customization options that may be defined by the Display.",-1),Ge=e("h3",{id:"conditions"},[t("Conditions "),e("a",{class:"header-anchor",href:"#conditions"},"#")],-1),Ye=e("p",null,"Conditions allow you to alter the current field\u2019s setup based on the values of other fields in the form. This allows you to show/hide the field, make it readonly, or change the interface options.",-1),Qe=e("p",null,[t("Each field can have one or more "),e("em",null,"rules"),t(". Each rule has the following configuration options:")],-1),Xe=e("li",null,[e("strong",null,"Name"),t(": The name of the rule. This is only used internally for convenience purposes")],-1),Ze=e("strong",null,"Rule",-1),$e=t(": The rule that controls whether or not these conditions are applied. Rule follows the "),et=t("Filter Rules"),tt=t(" spec"),ot=e("li",null,[e("strong",null,"Readonly"),t(": Whether or not the field is readonly when the condition is matched")],-1),nt=e("li",null,[e("strong",null,"Hidden"),t(": Whether or not the field is hidden when the condition is matched")],-1),lt=e("li",null,[e("strong",null,"Interface Options"),t(": Any additional configuration for the selected interface")],-1),it=e("p",null,"These changes to the field are merged onto the base configuration of the field. This means you can have the field hidden by default, and then only toggle the hidden state of the field in the condition.",-1),st=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Order matters"),e("p",null,[t("The conditions are matched in order. The "),e("strong",null,"last"),t(" condition that matches is the one that\u2019s used to apply the changes.")])],-1),at=e("h2",{id:"updating-a-field"},[t("Updating a Field "),e("a",{class:"header-anchor",href:"#updating-a-field"},"#")],-1),dt=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]")]),e("li",null,"Click the field you want to update"),e("li",null,"Follow the specific setup guide for the field type\u2026")],-1),rt=e("div",{class:"tip hint"},[e("p",null,[t("Learn more about the field options for "),e("a",{href:"#adjusting-field-arrangement"},"Adjusting the Field Layout"),t(".")])],-1),ct=e("h2",{id:"renaming-a-field"},[t("Renaming a Field "),e("a",{class:"header-anchor",href:"#renaming-a-field"},"#")],-1),ht=e("p",null,[t("While you can not change the "),e("strong",null,"Key"),t(" of a field via Directus (as of now), you can change its "),e("strong",null,"Name"),t(" and translations.")],-1),ut=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]")]),e("li",null,[e("strong",null,"Click the Field"),t(" you want to update")]),e("li",null,[t("Navigate to the "),e("strong",null,"Field Tab")]),e("li",null,[t("Click the Add New button under "),e("strong",null,"Field Name Translations")]),e("li",null,[t("Choose the desired "),e("strong",null,"Language"),t(" (your primary language for \u201Crenaming\u201D)")]),e("li",null,[t("Enter a "),e("strong",null,"Translation")]),e("li",null,[t("Click the "),e("strong",null,"Save"),t(" button")])],-1),pt=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Special Casing"),e("p",null,[t("If you are trying to update the specific casing (uppercase/lowercase) for a word (eg: "),e("code",null,"Dna"),t(" to "),e("code",null,"DNA"),t(") you will want to add the edge-case to the "),e("a",{href:"https://github.com/directus/directus/tree/main/packages/format-title/src",target:"_blank",rel:"noopener noreferrer"},"Format Title package"),t(". If you feel the case passes our "),e("a",{href:"https://docs.directus.io/contributing/introduction/#feature-requests",target:"_blank",rel:"noopener noreferrer"},"80/20 rule"),t(" you should submit a Pull Request to the codebase, otherwise you can update this in your instance.")])],-1),_t=e("h2",{id:"duplicating-a-field"},[t("Duplicating a Field "),e("a",{class:"header-anchor",href:"#duplicating-a-field"},"#")],-1),ft=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]")]),e("li",null,[t("Click the "),e("strong",null,"More Options"),t(" icon for the field you want to delete")]),e("li",null,[t("Click the "),e("strong",null,"Duplicate Field"),t(" option")])],-1),gt=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Relational and Primary Key Fields"),e("p",null,"It is not currently possible to duplicate relational fields or a collection\u2019s primary key.")],-1),mt=e("h2",{id:"adjusting-field-arrangement"},[t("Adjusting Field Arrangement "),e("a",{class:"header-anchor",href:"#adjusting-field-arrangement"},"#")],-1),yt=e("p",null,"The form design of the collection\u2019s fields is determined by the following options.",-1),bt=e("ul",null,[e("li",null,[e("strong",null,"Field Visibility"),t(" \u2014 If the field is \u201CVisible\u201D or \u201CHidden\u201D")]),e("li",null,[e("strong",null,"Field Width"),t(" \u2014 How wide the field is shown relative to the form/page "),e("ul",null,[e("li",null,"Half \u2014 The field is shown at half the form width"),e("li",null,"Full \u2014 (Default) The field is shown at the full form width"),e("li",null,"Fill \u2014 The field is shown filling the page width")])]),e("li",null,[e("strong",null,"Field Sort"),t(" \u2014 The order of fields within the form")]),e("li",null,[e("strong",null,"Field Group"),t(" \u2014 If the field is a \u201Cgroup\u201D type")])],-1),wt=e("ol",{start:"2"},[e("li",null,[t("Click the "),e("strong",null,"More Options"),t(" icon for any fields to adjust visibility")]),e("li",null,[t("Click the "),e("strong",null,"More Options"),t(" icon for any fields to adjust width")]),e("li",null,[e("strong",null,"Rearrange fields and groups"),t(" with their drag-and-drop handles")])],-1),vt=e("h2",{id:"deleting-a-field"},[t("Deleting a Field "),e("a",{class:"header-anchor",href:"#deleting-a-field"},"#")],-1),Tt=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]")]),e("li",null,[t("Click the "),e("strong",null,"More Options"),t(" icon for the field you want to delete")]),e("li",null,[t("Click the "),e("strong",null,"Delete Field"),t(" option")]),e("li",null,[t("Confirm this decision by clicking "),e("strong",null,"Delete"),t(" in the dialog")])],-1),Ct=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"This action is permanent and can not be undone. Please proceed with caution.")],-1),St={setup(Ft,{expose:a}){const i={title:"Fields",modularExtension:!1};return a({frontmatter:i}),(kt,Dt)=>{const n=s("router-link"),d=s("DocsWrapper");return r(),c(d,{frontmatter:i},{default:o(()=>[e("div",m,[e("blockquote",null,[e("p",null,[y,b,w,l(n,{to:"/docs/concepts/fields/"},{default:o(()=>[v]),_:1}),T])]),e("div",C,[F,e("p",null,[k,l(n,{to:"/docs/concepts/databases/"},{default:o(()=>[D]),_:1}),A])]),S,M,O,N,R,e("ul",null,[e("li",null,[I,x,l(n,{to:"/docs/concepts/translations/#schema-translations"},{default:o(()=>[L]),_:1}),q]),e("li",null,[P,U,l(n,{to:"/docs/concepts/types"},{default:o(()=>[j]),_:1}),W]),E,H,K,V,z,B]),J,G,e("div",Y,[Q,e("p",null,[X,l(n,{to:"/docs/guides/collections/#creating-a-collection"},{default:o(()=>[Z]),_:1}),$])]),e("div",ee,[te,e("p",null,[l(n,{to:"/docs/concepts/relationships/#perspective-matters"},{default:o(()=>[oe]),_:1}),ne])]),le,e("p",null,[ie,l(n,{to:"/docs/concepts/relationships/#many-to-one-m2o"},{default:o(()=>[se]),_:1}),ae]),de,re,e("p",null,[ce,l(n,{to:"/docs/concepts/relationships/#one-to-many-o2m"},{default:o(()=>[he]),_:1}),ue,l(n,{to:"/docs/concepts/fields/#fields"},{default:o(()=>[pe]),_:1}),_e]),fe,ge,me,e("p",null,[ye,l(n,{to:"/docs/concepts/relationships/#many-to-many-m2m"},{default:o(()=>[be]),_:1}),we,l(n,{to:"/docs/concepts/fields/#fields"},{default:o(()=>[ve]),_:1}),Te]),Ce,Fe,ke,e("p",null,[De,l(n,{to:"/docs/concepts/relationships/#many-to-any-m2a"},{default:o(()=>[Ae]),_:1}),Se,l(n,{to:"/docs/concepts/fields/#fields"},{default:o(()=>[Me]),_:1}),Oe]),Ne,Re,Ie,e("p",null,[l(n,{to:"/docs/concepts/translations/#content-translations"},{default:o(()=>[xe]),_:1}),Le,l(n,{to:"/docs/concepts/fields/#fields"},{default:o(()=>[qe]),_:1}),Pe]),Ue,je,We,Ee,He,Ke,Ve,ze,Be,Je,Ge,Ye,Qe,e("ul",null,[Xe,e("li",null,[Ze,$e,l(n,{to:"/docs/reference/filter-rules"},{default:o(()=>[et]),_:1}),tt]),ot,nt,lt]),it,st,at,dt,rt,ct,ht,ut,pt,_t,ft,gt,mt,yt,bt,wt,vt,Tt,Ct])]),_:1})}}};export{St as default};

package/dist/assets/files.60739444.js

@@ -0,0 +1,176 @@
+import{r as o,p as c,q as h,w as t,B as e,t as a,P as s}from"./vendor.9bb37c18.js";const d={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=s("Files are the objects that contain information about the file managed through Directus. If you\u2019re looking for the actual file data, including thumbnails, see the "),f=s("/assets"),m=s(" endpoint. "),g=s("Learn more about Files"),j=s("."),y=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[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),b=e("hr",null,null,-1),q=e("h2",{id:"the-file-object"},[s("The File Object "),e("a",{class:"header-anchor",href:"#the-file-object"},"#")],-1),v={class:"two-up"},w={class:"left"},x={class:"definitions"},T=e("p",null,[e("code",null,"id"),s(),e("strong",null,"uuid"),e("br"),s(" Primary key of the file")],-1),R=e("p",null,[e("code",null,"storage"),s(),e("strong",null,"string"),e("br"),s(" Storage adapter used for the file.")],-1),E=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),k=e("p",null,[e("code",null,"filename_download"),s(),e("strong",null,"string"),e("br"),s(" Preferred filename when file is downloaded.")],-1),D=e("p",null,[e("code",null,"title"),s(),e("strong",null,"string"),e("br"),s(" Title for the file.")],-1),S=e("p",null,[e("code",null,"type"),s(),e("strong",null,"string"),e("br"),s(" Mimetype of the file.")],-1),P=e("code",null,"folder",-1),F=s(),I=e("strong",null,"many-to-one",-1),A=e("br",null,null,-1),C=s(" What (virtual) folder the file is in. Many-to-one to "),O=s("folders"),X=s("."),L=e("code",null,"uploaded_by",-1),Q=s(),U=e("strong",null,"many-to-one",-1),Y=e("br",null,null,-1),M=s(" Who uploaded the file. Many-to-one to "),B=s("users"),G=s("."),N=e("p",null,[e("code",null,"uploaded_on"),s(),e("strong",null,"datetime"),e("br"),s(" When the file was uploaded.")],-1),Z=e("code",null,"modified_by",-1),H=s(),W=e("strong",null,"many-to-one",-1),z=e("br",null,null,-1),J=s(" Who updated the file last. Many-to-one to "),V=s("users"),$=s("."),K=e("p",null,[e("code",null,"filesize"),s(),e("strong",null,"number"),e("br"),s(" Size of the file in bytes.")],-1),ee=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),se=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),te=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),le=e("p",null,[e("code",null,"description"),s(),e("strong",null,"string"),e("br"),s(" Description of the file.")],-1),ae=e("p",null,[e("code",null,"location"),s(),e("strong",null,"string"),e("br"),s(" Location of the file.")],-1),ne=e("p",null,[e("code",null,"tags"),s(),e("strong",null,"array"),e("br"),s(" Tags for the file.")],-1),oe=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),ie=e("hr",null,null,-1),ce=e("h2",{id:"list-files"},[s("List Files "),e("a",{class:"header-anchor",href:"#list-files"},"#")],-1),he=e("p",null,"List all files that exist in Directus.",-1),de={class:"two-up"},pe={class:"left"},ue=e("h3",{id:"query-parameters"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),_e=s("Supports all "),fe=s("global query parameters"),me=s("."),ge=e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),je=s("An array of up to "),ye=s("limit"),be=s(),qe=e("a",{href:"#the-file-object"},"file objects",-1),ve=s(". If no items are available, data will be an empty array."),we={class:"right"},xe=e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),Te=e("pre",null,[e("code",null,`GET /files
+SEARCH /files
+`)],-1),Re=s("Learn more about SEARCH ->"),Ee=e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),ke=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),De=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),Se=e("h5",{id:"example"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")],-1),Pe=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
+	files {
+		id
+		filename_disk
+	}
+}
+`)])],-1),Fe=e("hr",null,null,-1),Ie=e("h2",{id:"retrieve-a-file"},[s("Retrieve a File "),e("a",{class:"header-anchor",href:"#retrieve-a-file"},"#")],-1),Ae=e("p",null,"Retrieve a single file by primary key.",-1),Ce={class:"two-up"},Oe={class:"left"},Xe=e("h3",{id:"query-parameters-2"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Le=s("Supports all "),Qe=s("global query parameters"),Ue=s("."),Ye=e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),Me=e("p",null,[s("Returns a "),e("a",{href:"#the-file-object"},"file object"),s(" if a valid primary key was provided.")],-1),Be=e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`GET /files/:id
+`)]),e("h5",{id:"example-2"},[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-2"},[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"}," Query"),s(` {
+	files_by_id(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): directus_files
+}
+`)])]),e("h5",{id:"example-3"},[s("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
+	files_by_id(id: `),e("span",{class:"hljs-string"},'"0fca80c4-d61c-4404-9fd7-6ba86b64154d"'),s(`) {
+		id
+		filename_disk
+	}
+}
+`)])])],-1),Ge=e("h2",{id:"upload-a-file"},[s("Upload a File "),e("a",{class:"header-anchor",href:"#upload-a-file"},"#")],-1),Ne=e("p",null,"Upload/create a new file.",-1),Ze={class:"two-up"},He={class:"left"},We=e("p",null,[s("To upload a file, use "),e("code",null,"multipart/form-data"),s(" as the encoding type, instead of JSON.")],-1),ze=e("p",null,[s("The file contents has to 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),Je=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),Ve=e("p",null,"You can upload multiple files at a time by repeating the payload with different contents, for example:",-1),$e=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),Ke=e("p",null,[s("In JavaScript, this can be achieved using the native "),e("code",null,"FormData"),s(" class:")],-1),es=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),ss=e("h3",{id:"query-parameters-3"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),ts=s("Supports all "),ls=s("global query parameters"),as=s("."),ns=e("h3",{id:"returns-3"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),os=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?Q4!\xF1)\x902;\x92FQw]\xEDkpz\x89\xB1\x9A|\xACi\xBF}\xD3\xC3\xE90\xFF\xFF\xFF\xDB\x84\b\b\x07\x07
+`)])],-1),is=e("hr",null,null,-1),cs=e("h2",{id:"import-a-file"},[s("Import a File "),e("a",{class:"header-anchor",href:"#import-a-file"},"#")],-1),hs=e("p",null,"Import a file from the web",-1),ds={class:"two-up"},ps={class:"left"},us=e("h3",{id:"query-parameters-4"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),_s=s("Supports all "),fs=s("global query parameters"),ms=s("."),gs=e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),js=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),ys=e("h3",{id:"returns-4"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),bs=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file object"),s(" for the imported file.")],-1),qs=e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /files/import
+`)]),e("h5",{id:"example-4"},[s("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /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-3"},[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(` {
+	import_file(url:`),e("span",{class:"hljs-type"}," String"),s(`!, data: create_directus_files_input!): directus_files
+}
+`)])]),e("h5",{id:"example-5"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	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),vs=e("hr",null,null,-1),ws=e("h2",{id:"update-a-file"},[s("Update a File "),e("a",{class:"header-anchor",href:"#update-a-file"},"#")],-1),xs=e("p",null,"Update an existing file, and/or replace it\u2019s file contents.",-1),Ts={class:"two-up"},Rs={class:"left"},Es=e("h3",{id:"query-parameters-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),ks=s("Supports all "),Ds=s("global query parameters"),Ss=s("."),Ps=e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Fs=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),Is=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),As=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file object"),s(" for the updated file.")],-1),Cs=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`PATCH /files/:id
+`)]),e("h5",{id:"example-6"},[s("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// 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-4"},[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_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!, data: update_directus_files_input!): directus_files
+}
+`)])]),e("h5",{id:"example-7"},[s("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	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),Os=e("hr",null,null,-1),Xs=e("h2",{id:"update-multiple-files"},[s("Update Multiple Files "),e("a",{class:"header-anchor",href:"#update-multiple-files"},"#")],-1),Ls=e("p",null,"Update multiple files at the same time.",-1),Qs={class:"two-up"},Us={class:"left"},Ys=e("h3",{id:"query-parameters-6"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),Ms=s("Supports all "),Bs=s("global query parameters"),Gs=s("."),Ns=e("h3",{id:"request-body-3"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Zs=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),Hs=e("h3",{id:"returns-6"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Ws=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file objects"),s(" for the updated files.")],-1),zs=e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /files
+`)]),e("h5",{id:"example-8"},[s("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /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-5"},[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(` {
+	update_files_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!, data: update_directus_files!): [directus_files]
+}
+`)])]),e("h5",{id:"example-9"},[s("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	update_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),Js=e("hr",null,null,-1),Vs=e("h2",{id:"delete-a-file"},[s("Delete a File "),e("a",{class:"header-anchor",href:"#delete-a-file"},"#")],-1),$s=e("p",null,"Delete an existing file.",-1),Ks={class:"two-up"},et={class:"left"},st=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Destructive"),e("p",null,"This will also delete the file from disk.")],-1),tt=e("h3",{id:"query-parameters-7"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-7"},"#")],-1),lt=s("Supports all "),at=s("global query parameters"),nt=s("."),ot=e("h3",{id:"returns-7"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")],-1),rt=e("p",null,"Empty response.",-1),it=e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`DELETE /files/:id
+`)]),e("h5",{id:"example-10"},[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-6"},[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_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),ct=e("hr",null,null,-1),ht=e("h2",{id:"delete-multiple-files"},[s("Delete Multiple Files "),e("a",{class:"header-anchor",href:"#delete-multiple-files"},"#")],-1),dt=e("p",null,"Delete multiple files at once.",-1),pt=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-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")]),e("p",null,"Array of file primary keys"),e("h3",{id:"returns-8"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-8"},"#")]),e("p",null,"Empty response.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",null,`DELETE /files
+`)]),e("h5",{id:"example-11"},[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-7"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-7"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	delete_files_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!): delete_many
+}
+`)])]),e("h5",{id:"example-12"},[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),gt={setup(ut,{expose:r}){const n={title:"Files",modularExtension:!1,pageClass:"page-reference"};return r({frontmatter:n}),(_t,ft)=>{const l=o("router-link"),i=o("DocsWrapper");return c(),h(i,{frontmatter:n},{default:t(()=>[e("div",d,[e("div",p,[e("div",u,[e("blockquote",null,[e("p",null,[_,a(l,{to:"/docs/reference/api/assets/"},{default:t(()=>[f]),_:1}),m,a(l,{to:"/docs/concepts/files/"},{default:t(()=>[g]),_:1}),j])])]),y]),b,q,e("div",v,[e("div",w,[e("div",x,[T,R,E,k,D,S,e("p",null,[P,F,I,A,C,a(l,{to:"/docs/reference/api/system/folders/"},{default:t(()=>[O]),_:1}),X]),e("p",null,[L,Q,U,Y,M,a(l,{to:"/docs/reference/api/system/users/"},{default:t(()=>[B]),_:1}),G]),N,e("p",null,[Z,H,W,z,J,a(l,{to:"/docs/reference/api/system/users/"},{default:t(()=>[V]),_:1}),$]),K,ee,se,te,le,ae,ne,oe])]),re]),ie,ce,he,e("div",de,[e("div",pe,[ue,e("p",null,[_e,a(l,{to:"/docs/reference/api/query"},{default:t(()=>[fe]),_:1}),me]),ge,e("p",null,[je,a(l,{to:"/docs/reference/api/query/#limit"},{default:t(()=>[ye]),_:1}),be,qe,ve])]),e("div",we,[xe,Te,e("p",null,[a(l,{to:"/docs/reference/api/introduction/#search-http-method"},{default:t(()=>[Re]),_:1})]),Ee,ke,De,Se,Pe])]),Fe,Ie,Ae,e("div",Ce,[e("div",Oe,[Xe,e("p",null,[Le,a(l,{to:"/docs/reference/api/query"},{default:t(()=>[Qe]),_:1}),Ue]),Ye,Me]),Be]),Ge,Ne,e("div",Ze,[e("div",He,[We,ze,Je,Ve,$e,Ke,es,ss,e("p",null,[ts,a(l,{to:"/docs/reference/api/query"},{default:t(()=>[ls]),_:1}),as]),ns,os]),rs]),is,cs,hs,e("div",ds,[e("div",ps,[us,e("p",null,[_s,a(l,{to:"/docs/reference/api/query"},{default:t(()=>[fs]),_:1}),ms]),gs,js,ys,bs]),qs]),vs,ws,xs,e("div",Ts,[e("div",Rs,[Es,e("p",null,[ks,a(l,{to:"/docs/reference/api/query"},{default:t(()=>[Ds]),_:1}),Ss]),Ps,Fs,Is,As]),Cs]),Os,Xs,Ls,e("div",Qs,[e("div",Us,[Ys,e("p",null,[Ms,a(l,{to:"/docs/reference/api/query"},{default:t(()=>[Bs]),_:1}),Gs]),Ns,Zs,Hs,Ws]),zs]),Js,Vs,$s,e("div",Ks,[e("div",et,[st,tt,e("p",null,[lt,a(l,{to:"/docs/reference/api/query"},{default:t(()=>[at]),_:1}),nt]),ot,rt]),it]),ct,ht,dt,pt])]),_:1})}}};export{gt as default};

package/dist/assets/files.c4e0315a.js

@@ -0,0 +1 @@
+import{r as n,p as s,q as d,w as i,B as e,t as c,P as t}from"./vendor.9bb37c18.js";const u={class:"markdown-body"},h=t("Directus includes a full-featured Digital Asset Management (DAM) system, complete with different Storage Adapters. "),g=t("Learn more about Files"),p=t("."),f=e("h2",{id:"uploading-a-file"},[t("Uploading a File "),e("a",{class:"header-anchor",href:"#uploading-a-file"},"#")],-1),_=e("p",null,"There are many ways that a file can be uploaded into Directus via the App. We\u2019ll cover the primary method below, but keep in mind that files can also be added directly through different interfaces.",-1),m=e("ol",null,[e("li",null,[t("Navigate to the "),e("strong",null,"File Library")]),e("li",null,[t("Click on the "),e("strong",null,"\u201CCreate Item\u201D"),t(" (+ icon) button located in the header")]),e("li",null,[e("strong",null,"Upload"),t(" the file by: "),e("ul",null,[e("li",null,"Dragging a file from your desktop to the modal"),e("li",null,"Click the modal area to manually select a file from your device"),e("li",null,"Clicking the \u201C\u2026\u201D icon and choosing \u201CImport from URL\u201D")])])],-1),b=e("h2",{id:"creating-a-thumbnail-preset"},[t("Creating a Thumbnail Preset "),e("a",{class:"header-anchor",href:"#creating-a-thumbnail-preset"},"#")],-1),k=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings > Project Settings")]),e("li",null,[t("Scroll to the "),e("strong",null,"Storage Asset Presets"),t(" field")]),e("li",null,[t("Click "),e("strong",null,"Add a New Item")]),e("li",null,[t("Enter a unique "),e("strong",null,"Key"),t(" for the preset")]),e("li",null,[t("Enter the "),e("strong",null,"Fit"),t(", "),e("strong",null,"Width"),t(", "),e("strong",null,"Height"),t(", and "),e("strong",null,"Quality"),t(" for the preset")]),e("li",null,[t("Click the "),e("strong",null,"Save"),t(" action button in the header")])],-1),y=e("h2",{id:"downloading-an-original-file"},[t("Downloading an Original File "),e("a",{class:"header-anchor",href:"#downloading-an-original-file"},"#")],-1),v=e("p",null,"The File Library and the Image and File interfaces all include buttons to download the original copy of a file.",-1),C=e("ol",null,[e("li",null,[t("Navigate to the "),e("strong",null,"File Library")]),e("li",null,"Click a file to open it\u2019s detail page"),e("li",null,"Click the download button in the top right.")],-1),w=e("h2",{id:"editing-images"},[t("Editing Images "),e("a",{class:"header-anchor",href:"#editing-images"},"#")],-1),F=e("p",null,"The detail page for a file contains an image editor you can use for some basic editing like rotating, cropping, or mirroring the file.",-1),D=e("ol",null,[e("li",null,[t("Navigate to the "),e("strong",null,"File Library")]),e("li",null,"Click a file to open it\u2019s detail page"),e("li",null,"Click the edit button in the top right to open the image editor"),e("li",null,"Make your changes and hit save in the top right to save the updates to the file")],-1),x={setup(N,{expose:o}){const l={title:"Files",modularExtension:!1};return o({frontmatter:l}),(A,L)=>{const a=n("router-link"),r=n("DocsWrapper");return s(),d(r,{frontmatter:l},{default:i(()=>[e("div",u,[e("blockquote",null,[e("p",null,[h,c(a,{to:"/docs/concepts/files/"},{default:i(()=>[g]),_:1}),p])]),f,_,m,b,k,y,v,C,w,F,D])]),_:1})}}};export{x as default};

package/dist/assets/files.e25d0ccc.js

@@ -0,0 +1 @@
+import{r as n,p as d,q as u,w as t,B as e,t as s,P as l}from"./vendor.9bb37c18.js";const c={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"Directus offers a full Digital Asset Management (DAM) system. This includes multiple storage adapters, nested folder organization, private file access, image editing, and on-demand thumbnail generation.")],-1),f=l("Directus allows you to manage all your files in one place, including documents, images, videos, and more. Files can be uploaded to the "),g=l("File Library"),m=l(" in general, or directly to an item via a Single File or Multiple Files field."),p=e("h4",{id:"relevant-guides"},[l("Relevant Guides "),e("a",{class:"header-anchor",href:"#relevant-guides"},"#")],-1),_=l("Uploading a File"),b=l("Accessing an Original File"),y=l("Creating a Thumbnail Preset"),w=l("Requesting a Thumbnail"),T=e("h2",{id:"file-fields"},[l("File Fields "),e("a",{class:"header-anchor",href:"#file-fields"},"#")],-1),v=e("p",null,"Directus ships with a full-featured system for digital asset management, with the following fields:",-1),D=e("ul",null,[e("li",null,[e("strong",null,"Title"),l(" \u2014 Pulled from the file metadata if available, falls back to a formatted version of the filename")]),e("li",null,[e("strong",null,"Description"),l(" \u2014 Pulled from the file metadata if available")]),e("li",null,[e("strong",null,"Tags"),l(" \u2014 Pulled from the file metadata if available")]),e("li",null,[e("strong",null,"Location"),l(" \u2014 Pulled from the file metadata if available")]),e("li",null,[e("strong",null,"Storage"),l(" \u2014 The storage adapter where the asset is saved (readonly)")]),e("li",null,[e("strong",null,"Filename Disk"),l(" \u2014 The actual name of the file within the storage adapter")]),e("li",null,[e("strong",null,"Filename Download"),l(" \u2014 The name used when downloading the file via "),e("em",null,"Content-Disposition")])],-1),S=e("p",null,"The sidebar\u2019s info component also includes the following readonly details:",-1),F=e("ul",null,[e("li",null,[e("strong",null,"Type"),l(" \u2014 The MIME type of the file, displayed in the App as a formatted media type")]),e("li",null,[e("strong",null,"Dimensions"),l(" \u2014 (Images Only) The width and height of the image in pixels")]),e("li",null,[e("strong",null,"Size"),l(" \u2014 The file-size the asset takes up within the storage adapter")]),e("li",null,[e("strong",null,"Created"),l(" \u2014 The timestamp of when the file was uploaded to the project")]),e("li",null,[e("strong",null,"Owner"),l(" \u2014 The Directus user that uploaded the file to the project")]),e("li",null,[e("strong",null,"Folder"),l(" \u2014 The current parent folder that contains the file")]),e("li",null,[e("strong",null,"Metadata"),l(" \u2014 Metadata JSON dump of the file\u2019s EXIF, IPTC, and ICC information")])],-1),A=e("h2",{id:"storage-adapters"},[l("Storage Adapters "),e("a",{class:"header-anchor",href:"#storage-adapters"},"#")],-1),k=e("p",null,"Storage adapters allow project files to be stored in different locations or services. By default, Directus includes the following adapters:",-1),C=e("ul",null,[e("li",null,[e("strong",null,"Local Filesystem"),l(" \u2014 The default, any filesystem location or network-attached storage")]),e("li",null,[e("strong",null,"S3 or Equivalent"),l(" \u2014 Including AWS S3, DigitalOcean Spaces, Alibaba OSS, and others")]),e("li",null,[e("strong",null,"Google Cloud Storage"),l(" \u2014 A RESTful web service on the Google Cloud Platform")]),e("li",null,[e("strong",null,"Azure Blob Storage"),l(" \u2014 Azure storage account containers")])],-1),q=e("h2",{id:"thumbnail-transformations"},[l("Thumbnail Transformations "),e("a",{class:"header-anchor",href:"#thumbnail-transformations"},"#")],-1),P=e("p",null,"Our file middleware also allows for cropping and transforming image assets on the fly. This means you can simply request an image, include any desired transformation parameters, and you\u2019ll be served the new asset as a response. This is very useful for automatically generating many different thumbnails/versions of an original file.",-1),M=l("To impede malicious users from consuming your storage by requesting a multitude of random sizes, Directus includes a "),O=l("Asset Allow-List"),x=l(" to limit what transformations are possible."),z=e("h4",{id:"relevant-guides-2"},[l("Relevant Guides "),e("a",{class:"header-anchor",href:"#relevant-guides-2"},"#")],-1),B=l("Requesting a Thumbnail"),G={setup(I,{expose:o}){const i={title:"Files",modularExtension:!1};return o({frontmatter:i}),(E,R)=>{const a=n("router-link"),r=n("DocsWrapper");return d(),u(r,{frontmatter:i},{default:t(()=>[e("div",c,[h,e("p",null,[f,s(a,{to:"/docs/concepts/application/#file-library"},{default:t(()=>[g]),_:1}),m]),p,e("ul",null,[e("li",null,[s(a,{to:"/docs/guides/files/#uploading-a-file"},{default:t(()=>[_]),_:1})]),e("li",null,[s(a,{to:"/docs/guides/files/#accessing-an-original-file"},{default:t(()=>[b]),_:1})]),e("li",null,[s(a,{to:"/docs/guides/files/#creating-a-thumbnail-preset"},{default:t(()=>[y]),_:1})]),e("li",null,[s(a,{to:"/docs/guides/files/#requesting-a-thumbnail"},{default:t(()=>[w]),_:1})])]),T,v,D,S,F,A,k,C,q,P,e("p",null,[M,s(a,{to:"/docs/guides/files/#creating-thumbnail-presets"},{default:t(()=>[O]),_:1}),x]),z,e("ul",null,[e("li",null,[s(a,{to:"/docs/guides/files/#requesting-a-thumbnail"},{default:t(()=>[B]),_:1})])])])]),_:1})}}};export{G as default};

package/dist/assets/filter-rules.b8a614b1.js

@@ -0,0 +1,60 @@
+import{r as o,p as i,q as c,w as n,B as t,t as s,P as l}from"./vendor.9bb37c18.js";const d={class:"markdown-body"},h=t("blockquote",null,[t("p",null,[l("Permissions, validation, and the API\u2019s "),t("code",null,"filter"),l(" parameter all rely on a specific JSON structure to define their rules. This page describes the syntax for creating flat, relational, or complex filter rules.")])],-1),_=t("p",null,[t("div",{class:"table-of-contents"},[t("ul",null,[t("li",null,[t("a",{href:"#syntax"},"Syntax")]),t("li",null,[t("a",{href:"#filter-operators"},"Filter Operators")]),t("li",null,[t("a",{href:"#relational"},"Relational")]),t("li",null,[t("a",{href:"#logical-operators"},"Logical Operators")]),t("li",null,[t("a",{href:"#dynamic-variables"},"Dynamic Variables")])])])],-1),p=t("h2",{id:"syntax"},[l("Syntax "),t("a",{class:"header-anchor",href:"#syntax"},"#")],-1),f=t("strong",null,"Field",-1),g=l(" \u2014 Any valid root field, "),m=l("relational field"),y=l(", or "),b=l("logical operator"),j=t("strong",null,"Operator",-1),v=l(" \u2014 Any valid "),x=l("API operator"),w=l(" prefaced with an underscore"),R=t("strong",null,"Value",-1),O=l(" \u2014 Any valid static value, or "),E=l("dynamic variable"),N=t("pre",null,[t("code",null,`{
+	<field>: {
+		<operator>: <value>
+	}
+}
+`)],-1),q=t("h3",{id:"examples"},[l("Examples "),t("a",{class:"header-anchor",href:"#examples"},"#")],-1),T=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"title"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"_contains"'),l(": "),t("span",{class:"hljs-string"},'"Directus"'),l(`
+	}
+}
+`)])],-1),k=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"owner"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),l(`
+	}
+}
+`)])],-1),D=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"datetime"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"_lte"'),l(": "),t("span",{class:"hljs-string"},'"$NOW"'),l(`
+	}
+}
+`)])],-1),V=t("h2",{id:"filter-operators"},[l("Filter Operators "),t("a",{class:"header-anchor",href:"#filter-operators"},"#")],-1),$=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"Operator"),t("th",null,"Description")])]),t("tbody",null,[t("tr",null,[t("td",null,[t("code",null,"_eq")]),t("td",null,"Equal to")]),t("tr",null,[t("td",null,[t("code",null,"_neq")]),t("td",null,"Not equal to")]),t("tr",null,[t("td",null,[t("code",null,"_lt")]),t("td",null,"Less than")]),t("tr",null,[t("td",null,[t("code",null,"_lte")]),t("td",null,"Less than or equal to")]),t("tr",null,[t("td",null,[t("code",null,"_gt")]),t("td",null,"Greater than")]),t("tr",null,[t("td",null,[t("code",null,"_gte")]),t("td",null,"Greater than or equal to")]),t("tr",null,[t("td",null,[t("code",null,"_in")]),t("td",null,"Matches any of the values")]),t("tr",null,[t("td",null,[t("code",null,"_nin")]),t("td",null,"Doesn\u2019t match any of the values")]),t("tr",null,[t("td",null,[t("code",null,"_null")]),t("td",null,[l("Is "),t("code",null,"null")])]),t("tr",null,[t("td",null,[t("code",null,"_nnull")]),t("td",null,[l("Is not "),t("code",null,"null")])]),t("tr",null,[t("td",null,[t("code",null,"_contains")]),t("td",null,"Contains the substring")]),t("tr",null,[t("td",null,[t("code",null,"_ncontains")]),t("td",null,"Doesn\u2019t contain the substring")]),t("tr",null,[t("td",null,[t("code",null,"_starts_with")]),t("td",null,"Starts with")]),t("tr",null,[t("td",null,[t("code",null,"_nstarts_with")]),t("td",null,"Doesn\u2019t start with")]),t("tr",null,[t("td",null,[t("code",null,"_ends_with")]),t("td",null,"Ends with")]),t("tr",null,[t("td",null,[t("code",null,"_nends_with")]),t("td",null,"Doesn\u2019t end with")]),t("tr",null,[t("td",null,[t("code",null,"_between")]),t("td",null,"Is between two values (inclusive)")]),t("tr",null,[t("td",null,[t("code",null,"_nbetween")]),t("td",null,"Is not between two values (inclusive)")]),t("tr",null,[t("td",null,[t("code",null,"_empty")]),t("td",null,[l("Is empty ("),t("code",null,"null"),l(" or falsy)")])]),t("tr",null,[t("td",null,[t("code",null,"_nempty")]),t("td",null,[l("Is not empty ("),t("code",null,"null"),l(" or falsy)")])]),t("tr",null,[t("td",null,[t("code",null,"_intersects"),l(),t("sup",null,"[1]")]),t("td",null,"Value intersects a given point")]),t("tr",null,[t("td",null,[t("code",null,"_nintersects"),l(),t("sup",null,"[1]")]),t("td",null,"Value does not intersect a given point")]),t("tr",null,[t("td",null,[t("code",null,"_intersects_bbox"),l(),t("sup",null,"[1]")]),t("td",null,"Value is in a bounding box")]),t("tr",null,[t("td",null,[t("code",null,"_nintersects_bbox"),l(),t("sup",null,"[1]")]),t("td",null,"Value is not in a bounding box")])])],-1),I=t("p",null,[l("The following operators are "),t("strong",null,"only available in validation permissions"),l(":")],-1),S=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"Operator"),t("th",null,"Description")])]),t("tbody",null,[t("tr",null,[t("td",null,[t("code",null,"_submitted")]),t("td",null,"Field has to be submitted")]),t("tr",null,[t("td",null,[t("code",null,"_regex"),l(),t("sup",null,"[2]")]),t("td",null,"Field has to match regex")])])],-1),U=t("p",null,[t("sup",null,"[1]"),l(" Only available on Geometry types"),t("br"),t("sup",null,"[2]"),l(" JavaScript \u201Cflavor\u201D regex. Make sure to escape backslashes.")],-1),C=t("h2",{id:"relational"},[l("Relational "),t("a",{class:"header-anchor",href:"#relational"},"#")],-1),F=t("p",null,[l("You can target related values by nesting field names. For example, if you have a relational Many-to-One "),t("code",null,"author"),l(" field, you can set a rule for the "),t("code",null,"author.name"),l(" field using the following syntax.")],-1),W=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"author"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"name"'),l(`: {
+			`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"Rijk van Zanten"'),l(`
+		}
+	}
+}
+`)])],-1),A=t("h2",{id:"logical-operators"},[l("Logical Operators "),t("a",{class:"header-anchor",href:"#logical-operators"},"#")],-1),L=t("p",null,[l("You can nest or group multiple rules using the "),t("code",null,"_and"),l(" or "),t("code",null,"_or"),l(" logical operators. Each operator holds an array of rules, allowing for more complex filtering.")],-1),B=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"_or"'),l(`: [
+		{
+			`),t("span",{class:"hljs-attr"},'"_and"'),l(`: [
+				{
+					`),t("span",{class:"hljs-attr"},'"owner"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),l(`
+					}
+				},
+				{
+					`),t("span",{class:"hljs-attr"},'"status"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_in"'),l(": ["),t("span",{class:"hljs-string"},'"published"'),l(", "),t("span",{class:"hljs-string"},'"draft"'),l(`]
+					}
+				}
+			]
+		},
+		{
+			`),t("span",{class:"hljs-attr"},'"_and"'),l(`: [
+				{
+					`),t("span",{class:"hljs-attr"},'"owner"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_neq"'),l(": "),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),l(`
+					}
+				},
+				{
+					`),t("span",{class:"hljs-attr"},'"status"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_in"'),l(": ["),t("span",{class:"hljs-string"},'"published"'),l(`]
+					}
+				}
+			]
+		}
+	]
+}
+`)])],-1),P=t("h2",{id:"dynamic-variables"},[l("Dynamic Variables "),t("a",{class:"header-anchor",href:"#dynamic-variables"},"#")],-1),G=t("p",null,[l("In addition to static values, you can also filter against "),t("em",null,"dynamic"),l(" values using the following variables.")],-1),M=t("ul",null,[t("li",null,[t("code",null,"$CURRENT_USER"),l(" \u2014 The primary key of the currently authenticated user")]),t("li",null,[t("code",null,"$CURRENT_ROLE"),l(" \u2014 The primary key of the role for the currently authenticated user")]),t("li",null,[t("code",null,"$NOW"),l(" \u2014 The current timestamp")]),t("li",null,[t("code",null,"$NOW(<adjustment>)"),l(" - The current timestamp plus/minus a given distance, for example "),t("code",null,"$NOW(-1 year)"),l(", "),t("code",null,"$NOW(+2 hours)")])],-1),H={setup(J,{expose:r}){const a={title:"Filter Rules",modularExtension:!1};return r({frontmatter:a}),(Y,Z)=>{const e=o("router-link"),u=o("DocsWrapper");return i(),c(u,{frontmatter:a},{default:n(()=>[t("div",d,[h,_,p,t("ul",null,[t("li",null,[f,g,s(e,{to:"/docs/reference/filter-rules#relational"},{default:n(()=>[m]),_:1}),y,s(e,{to:"/docs/reference/filter-rules#logical-operators"},{default:n(()=>[b]),_:1})]),t("li",null,[j,v,s(e,{to:"/docs/reference/filter-rules#supported-operators"},{default:n(()=>[x]),_:1}),w]),t("li",null,[R,O,s(e,{to:"/docs/reference/filter-rules#dynamic-variables"},{default:n(()=>[E]),_:1})])]),N,q,T,k,D,V,$,I,S,U,C,F,W,A,L,B,P,G,M])]),_:1})}}};export{H as default};

package/dist/assets/folders.0dc34ccf.js

@@ -0,0 +1,132 @@
+import{r as n,p as h,q as c,w as a,B as e,t,P as s}from"./vendor.9bb37c18.js";const i={class:"markdown-body"},p=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Folders can be used to organize files within the platform. Folders are virtual, and aren\u2019t mirrored within the storage adapter.")])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-folder-object"},"The Folder Object")]),e("li",null,[e("a",{href:"#list-folders"},"List Folders")]),e("li",null,[e("a",{href:"#retrieve-a-folder"},"Retrieve a Folder")]),e("li",null,[e("a",{href:"#create-a-folder"},"Create a Folder")]),e("li",null,[e("a",{href:"#create-multiple-folders"},"Create Multiple Folders")]),e("li",null,[e("a",{href:"#update-a-folder"},"Update a Folder")]),e("li",null,[e("a",{href:"#update-multiple-folders"},"Update Multiple Folders")]),e("li",null,[e("a",{href:"#delete-a-folder"},"Delete a Folder")]),e("li",null,[e("a",{href:"#delete-multiple-folders"},"Delete Multiple Folders")])])])])])],-1),u=e("hr",null,null,-1),_=e("h2",{id:"the-folder-object"},[s("The Folder Object "),e("a",{class:"header-anchor",href:"#the-folder-object"},"#")],-1),f=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",null,"id"),s(),e("strong",null,"uuid"),e("br"),s(" Primary key of the folder.")]),e("p",null,[e("code",null,"name"),s(),e("strong",null,"string"),e("br"),s(" Name of the folder.")]),e("p",null,[e("code",null,"parent"),s(),e("strong",null,"many-to-one"),e("br"),s(" Parent folder. Many-to-one to folders (recursive).")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[s(`{
+	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
+		`),e("span",{class:"hljs-attr"},'"id"'),s(": "),e("span",{class:"hljs-string"},'"fc02d733-95b8-4e27-bd4b-08a32cbe4e66"'),s(`,
+		`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Test"'),s(`,
+		`),e("span",{class:"hljs-attr"},'"parent"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`
+	}
+}
+`)])])])],-1),m=e("hr",null,null,-1),g=e("h2",{id:"list-folders"},[s("List Folders "),e("a",{class:"header-anchor",href:"#list-folders"},"#")],-1),y=e("p",null,"List all folders that exist in Directus.",-1),b={class:"two-up"},j={class:"left"},q=e("h3",{id:"query-parameters"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),x=s("Supports all "),v=s("global query parameters"),E=s("."),w=e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),T=s("An array of up to "),P=s("limit"),R=s(),k=e("a",{href:"#the-folder-object"},"folder objects",-1),S=s(". If no items are available, data will be an empty array."),A={class:"right"},F=e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),D=e("pre",null,[e("code",null,`GET /folders
+SEARCH /folders
+`)],-1),C=s("Learn more about SEARCH ->"),L=e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),Q=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),I=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
+	folders: directus_folders
+}
+`)])],-1),O=e("h5",{id:"example"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")],-1),M=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
+	folders {
+		name
+	}
+}
+`)])],-1),G=e("hr",null,null,-1),B=e("h2",{id:"retrieve-a-folder"},[s("Retrieve a Folder "),e("a",{class:"header-anchor",href:"#retrieve-a-folder"},"#")],-1),N=e("p",null,"List all folders that exist in Directus.",-1),H={class:"two-up"},U={class:"left"},V=e("h3",{id:"query-parameters-2"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),W=s("Supports all "),z=s("global query parameters"),J=s("."),K=e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),X=e("p",null,[s("Returns a "),e("a",{href:"#the-folder-object"},"folder object"),s(" if a valid primary key was provided.")],-1),Y=e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`GET /folders/:id
+`)]),e("h5",{id:"example-2"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",null,`GET /folders/fc02d733-95b8-4e27-bd4b-08a32cbe4e66
+`)]),e("h3",{id:"graphql-2"},[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"}," Query"),s(` {
+	folders_by_id(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): directus_folders
+}
+`)])]),e("h5",{id:"example-3"},[s("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
+	folders_by_id(id: `),e("span",{class:"hljs-string"},'"fc02d733-95b8-4e27-bd4b-08a32cbe4e66"'),s(`) {
+		name
+	}
+}
+`)])])],-1),Z=e("hr",null,null,-1),$=e("h2",{id:"create-a-folder"},[s("Create a Folder "),e("a",{class:"header-anchor",href:"#create-a-folder"},"#")],-1),ee=e("p",null,"Create a new (virtual) folder.",-1),se={class:"two-up"},ae={class:"left"},le=e("h3",{id:"query-parameters-3"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),te=s("Supports all "),re=s("global query parameters"),ne=s("."),de=e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),oe=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(". "),e("code",null,"name"),s(" is required.")],-1),he=e("h3",{id:"returns-3"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),ce=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was created.")],-1),ie=e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /folders
+`)]),e("h5",{id:"example-4"},[s("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /folders"),s(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Nature"'),s(`
+}
+`)])]),e("h3",{id:"graphql-3"},[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(` {
+	create_folders_item(data: create_directus_folders_input): directus_folders
+}
+`)])]),e("h5",{id:"example-5"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	create_folders_item(data: { name: `),e("span",{class:"hljs-string"},'"Nature"'),s(` }) {
+		id
+		name
+	}
+}
+`)])])],-1),pe=e("hr",null,null,-1),ue=e("h2",{id:"create-multiple-folders"},[s("Create Multiple Folders "),e("a",{class:"header-anchor",href:"#create-multiple-folders"},"#")],-1),_e=e("p",null,"Create multiple new (virtual) folders.",-1),fe={class:"two-up"},me={class:"left"},ge=e("h3",{id:"query-parameters-4"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),ye=s("Supports all "),be=s("global query parameters"),je=s("."),qe=e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),xe=e("p",null,[s("An array of partial "),e("a",{href:"#the-folder-object"},"folder objects"),s(". "),e("code",null,"name"),s(" is required.")],-1),ve=e("h3",{id:"returns-4"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),Ee=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was created.")],-1),we=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`POST /folders
+`)]),e("h5",{id:"example-6"},[s("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /folders"),s(`
+
+[
+	{
+		`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Nature"'),s(`
+	},
+	{
+		`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Cities"'),s(`
+	}
+]
+`)])]),e("h3",{id:"graphql-4"},[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(` {
+	create_folders_items(data: [create_directus_folders_input]): [directus_folders]
+}
+`)])]),e("h5",{id:"example-7"},[s("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	create_folders_items(data: [{ name: `),e("span",{class:"hljs-string"},'"Nature"'),s(" }, { name: "),e("span",{class:"hljs-string"},'"Cities"'),s(` }]) {
+		id
+		name
+	}
+}
+`)])])],-1),Te=e("hr",null,null,-1),Pe=e("h2",{id:"update-a-folder"},[s("Update a Folder "),e("a",{class:"header-anchor",href:"#update-a-folder"},"#")],-1),Re=e("p",null,"Update an existing folder.",-1),ke={class:"two-up"},Se={class:"left"},Ae=e("h3",{id:"query-parameters-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Fe=s("Supports all "),De=s("global query parameters"),Ce=s("."),Le=e("h3",{id:"request-body-3"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Qe=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(".")],-1),Ie=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),Oe=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was updated.")],-1),Me=e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /folders/:id
+`)]),e("h5",{id:"example-8"},[s("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /folders/fac21847-d5ce-4e4b-a288-9abafbdfbc87"),s(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"parent"'),s(": "),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(`
+}
+`)])]),e("h3",{id:"graphql-5"},[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(` {
+	update_folders_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!, data: update_directus_folders_input): directus_folders
+}
+`)])]),e("h5",{id:"example-9"},[s("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	update_folders_item(
+		id: `),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(`
+		data: { parent: `),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(` }
+	) {
+		id
+		name
+	}
+}
+`)])])],-1),Ge=e("hr",null,null,-1),Be=e("h2",{id:"update-multiple-folders"},[s("Update Multiple Folders "),e("a",{class:"header-anchor",href:"#update-multiple-folders"},"#")],-1),Ne=e("p",null,"Update multiple existing folders.",-1),He={class:"two-up"},Ue={class:"left"},Ve=e("h3",{id:"query-parameters-6"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),We=s("Supports all "),ze=s("global query parameters"),Je=s("."),Ke=e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Xe=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 folders 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-folder-object"},"the folder object"),s("\u2019s properties.")])],-1),Ye=e("h3",{id:"returns-6"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Ze=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder objects"),s(" of the folders that were updated.")],-1),$e=e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`PATCH /folders
+`)]),e("h5",{id:"example-10"},[s("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /folders"),s(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"keys"'),s(": ["),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(", "),e("span",{class:"hljs-string"},'"a5bdb793-dd85-4ac9-882a-b42862092983"'),s(`],
+	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
+		`),e("span",{class:"hljs-attr"},'"parent"'),s(": "),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(`
+	}
+}
+`)])]),e("h3",{id:"graphql-6"},[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(` {
+	update_folders_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!, data: update_directus_folders_input): [directus_folders]
+}
+`)])]),e("h5",{id:"example-11"},[s("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	update_folders_items(
+		ids: [`),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(", "),e("span",{class:"hljs-string"},'"a5bdb793-dd85-4ac9-882a-b42862092983"'),s(`]
+		data: { parent: `),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(` }
+	) {
+		id
+		name
+	}
+}
+`)])])],-1),es=e("hr",null,null,-1),ss=e("h2",{id:"delete-a-folder"},[s("Delete a Folder "),e("a",{class:"header-anchor",href:"#delete-a-folder"},"#")],-1),as=e("p",null,"Delete an existing folder.",-1),ls=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Files"),e("p",null,"Any files in this folder will be moved to the root folder.")]),e("h3",{id:"returns-7"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",null,`DELETE /folders/:id
+`)]),e("h5",{id:"example-12"},[s("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),e("pre",null,[e("code",null,`// DELETE /folders/a5bdb793-dd85-4ac9-882a-b42862092983
+`)]),e("h3",{id:"graphql-7"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-7"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	delete_folders_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): delete_one
+}
+`)])]),e("h5",{id:"example-13"},[s("Example "),e("a",{class:"header-anchor",href:"#example-13"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	delete_folders_item(id: `),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(`) {
+		id
+	}
+}
+`)])])])],-1),ts=e("hr",null,null,-1),rs=e("h2",{id:"delete-multiple-folders"},[s("Delete Multiple Folders "),e("a",{class:"header-anchor",href:"#delete-multiple-folders"},"#")],-1),ns=e("p",null,"Delete multiple existing folders.",-1),ds=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Files"),e("p",null,"Any files in these folders will be moved to the root folder.")]),e("h3",{id:"request-body-5"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-5"},"#")]),e("p",null,"An array of folder primary keys."),e("h3",{id:"returns-8"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-8"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-8"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),e("pre",null,[e("code",null,`DELETE /folders
+`)]),e("h5",{id:"example-14"},[s("Example "),e("a",{class:"header-anchor",href:"#example-14"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// DELETE /folders"),s(`
+
+[`),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(", "),e("span",{class:"hljs-string"},'"fc02d733-95b8-4e27-bd4b-08a32cbe4e66"'),s(`]
+`)])]),e("h3",{id:"graphql-8"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-8"},"#")]),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_folders_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!): delete_many
+}
+`)])]),e("h5",{id:"example-15"},[s("Example "),e("a",{class:"header-anchor",href:"#example-15"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	delete_folders_items(ids: [`),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(", "),e("span",{class:"hljs-string"},'"a5bdb793-dd85-4ac9-882a-b42862092983"'),s(`]) {
+		ids
+	}
+}
+`)])])])],-1),ps={setup(os,{expose:d}){const r={title:"Folders",modularExtension:!1,pageClass:"page-reference"};return d({frontmatter:r}),(hs,cs)=>{const l=n("router-link"),o=n("DocsWrapper");return h(),c(o,{frontmatter:r},{default:a(()=>[e("div",i,[p,u,_,f,m,g,y,e("div",b,[e("div",j,[q,e("p",null,[x,t(l,{to:"/docs/reference/api/query"},{default:a(()=>[v]),_:1}),E]),w,e("p",null,[T,t(l,{to:"/docs/reference/api/query/#limit"},{default:a(()=>[P]),_:1}),R,k,S])]),e("div",A,[F,D,e("p",null,[t(l,{to:"/docs/reference/api/introduction/#search-http-method"},{default:a(()=>[C]),_:1})]),L,Q,I,O,M])]),G,B,N,e("div",H,[e("div",U,[V,e("p",null,[W,t(l,{to:"/docs/reference/api/query"},{default:a(()=>[z]),_:1}),J]),K,X]),Y]),Z,$,ee,e("div",se,[e("div",ae,[le,e("p",null,[te,t(l,{to:"/docs/reference/api/query"},{default:a(()=>[re]),_:1}),ne]),de,oe,he,ce]),ie]),pe,ue,_e,e("div",fe,[e("div",me,[ge,e("p",null,[ye,t(l,{to:"/docs/reference/api/query"},{default:a(()=>[be]),_:1}),je]),qe,xe,ve,Ee]),we]),Te,Pe,Re,e("div",ke,[e("div",Se,[Ae,e("p",null,[Fe,t(l,{to:"/docs/reference/api/query"},{default:a(()=>[De]),_:1}),Ce]),Le,Qe,Ie,Oe]),Me]),Ge,Be,Ne,e("div",He,[e("div",Ue,[Ve,e("p",null,[We,t(l,{to:"/docs/reference/api/query"},{default:a(()=>[ze]),_:1}),Je]),Ke,Xe,Ye,Ze]),$e]),es,ss,as,ls,ts,rs,ns,ds])]),_:1})}}};export{ps as default};

package/dist/assets/forth.ef05c141.js

@@ -0,0 +1 @@
+import{bz as S}from"./vendor.9bb37c18.js";function T(f,O){return O.forEach(function(E){Object.keys(E).forEach(function(n){if(n!=="default"&&!(n in f)){var R=Object.getOwnPropertyDescriptor(E,n);Object.defineProperty(f,n,R.get?R:{enumerable:!0,get:function(){return E[n]}})}})}),Object.freeze(f)}var u={exports:{}};(function(f,O){(function(E){E(S.exports)})(function(E){function n(i){var r=[];return i.split(" ").forEach(function(e){r.push({name:e})}),r}var R=n("INVERT AND OR XOR 2* 2/ LSHIFT RSHIFT 0= = 0< < > U< MIN MAX 2DROP 2DUP 2OVER 2SWAP ?DUP DEPTH DROP DUP OVER ROT SWAP >R R> R@ + - 1+ 1- ABS NEGATE S>D * M* UM* FM/MOD SM/REM UM/MOD */ */MOD / /MOD MOD HERE , @ ! CELL+ CELLS C, C@ C! CHARS 2@ 2! ALIGN ALIGNED +! ALLOT CHAR [CHAR] [ ] BL FIND EXECUTE IMMEDIATE COUNT LITERAL STATE ; DOES> >BODY EVALUATE SOURCE >IN <# # #S #> HOLD SIGN BASE >NUMBER HEX DECIMAL FILL MOVE . CR EMIT SPACE SPACES TYPE U. .R U.R ACCEPT TRUE FALSE <> U> 0<> 0> NIP TUCK ROLL PICK 2>R 2R@ 2R> WITHIN UNUSED MARKER I J TO COMPILE, [COMPILE] SAVE-INPUT RESTORE-INPUT PAD ERASE 2LITERAL DNEGATE D- D+ D0< D0= D2* D2/ D< D= DMAX DMIN D>S DABS M+ M*/ D. D.R 2ROT DU< CATCH THROW FREE RESIZE ALLOCATE CS-PICK CS-ROLL GET-CURRENT SET-CURRENT FORTH-WORDLIST GET-ORDER SET-ORDER PREVIOUS SEARCH-WORDLIST WORDLIST FIND ALSO ONLY FORTH DEFINITIONS ORDER -TRAILING /STRING SEARCH COMPARE CMOVE CMOVE> BLANK SLITERAL"),a=n("IF ELSE THEN BEGIN WHILE REPEAT UNTIL RECURSE [IF] [ELSE] [THEN] ?DO DO LOOP +LOOP UNLOOP LEAVE EXIT AGAIN CASE OF ENDOF ENDCASE");E.defineMode("forth",function(){function i(r,e){var t;for(t=r.length-1;t>=0;t--)if(r[t].name===e.toUpperCase())return r[t]}return{startState:function(){return{state:"",base:10,coreWordList:R,immediateWordList:a,wordList:[]}},token:function(r,e){var t;if(r.eatSpace())return null;if(e.state===""){if(r.match(/^(\]|:NONAME)(\s|$)/i))return e.state=" compilation","builtin compilation";if(t=r.match(/^(\:)\s+(\S+)(\s|$)+/),t)return e.wordList.push({name:t[2].toUpperCase()}),e.state=" compilation","def"+e.state;if(t=r.match(/^(VARIABLE|2VARIABLE|CONSTANT|2CONSTANT|CREATE|POSTPONE|VALUE|WORD)\s+(\S+)(\s|$)+/i),t)return e.wordList.push({name:t[2].toUpperCase()}),"def"+e.state;if(t=r.match(/^(\'|\[\'\])\s+(\S+)(\s|$)+/),t)return"builtin"+e.state}else{if(r.match(/^(\;|\[)(\s)/))return e.state="",r.backUp(1),"builtin compilation";if(r.match(/^(\;|\[)($)/))return e.state="","builtin compilation";if(r.match(/^(POSTPONE)\s+\S+(\s|$)+/))return"builtin"}if(t=r.match(/^(\S+)(\s+|$)/),t)return i(e.wordList,t[1])!==void 0?"variable"+e.state:t[1]==="\\"?(r.skipToEnd(),"comment"+e.state):i(e.coreWordList,t[1])!==void 0?"builtin"+e.state:i(e.immediateWordList,t[1])!==void 0?"keyword"+e.state:t[1]==="("?(r.eatWhile(function(o){return o!==")"}),r.eat(")"),"comment"+e.state):t[1]===".("?(r.eatWhile(function(o){return o!==")"}),r.eat(")"),"string"+e.state):t[1]==='S"'||t[1]==='."'||t[1]==='C"'?(r.eatWhile(function(o){return o!=='"'}),r.eat('"'),"string"+e.state):t[1]-68719476735?"number"+e.state:"atom"+e.state}}}),E.defineMIME("text/x-forth","forth")})})();var L=u.exports,D=Object.freeze(T({__proto__:null,[Symbol.toStringTag]:"Module",default:L},[u.exports]));export{D as f};