@directus/app 9.14.2 → 9.15.0

package/dist/assets/{introduction.eda1c2c4.js → introduction.a173e7ad.js}

@@ -1,4 +1,4 @@
-import{a as o,o as r,b as u,w as n,g as t,e as a,B as s}from"./runtime-core.esm-bundler.e3d5f5b7.js";const h={class:"markdown-body"},d=t("blockquote",null,[t("p",null,"Directus offers both a RESTful and GraphQL API to manage the data in the database. The API has predictable resource-oriented URLs, relies on standard HTTP status codes, and uses JSON for input and output.")],-1),p=t("p",null,[t("div",{class:"table-of-contents"},[t("ul",null,[t("li",null,[t("a",{href:"#dynamic-api"},"Dynamic API ")]),t("li",null,[t("a",{href:"#rest-vs.-graphql"},"REST vs. GraphQL ")]),t("li",null,[t("a",{href:"#authentication"},"Authentication ")]),t("li",null,[t("a",{href:"#relational-data"},"Relational Data ")]),t("li",null,[t("a",{href:"#search-http-method"},"SEARCH HTTP Method ")]),t("li",null,[t("a",{href:"#system-data-in-graphql"},"System data in GraphQL ")]),t("li",null,[t("a",{href:"#error-codes"},"Error Codes ")])])])],-1),_=t("h2",{id:"dynamic-api",tabindex:"-1"},[s("Dynamic API "),t("a",{class:"header-anchor",href:"#dynamic-api"},"#")],-1),f=s("The platform\u2019s API uses "),m=s("Database Mirroring"),y=s(" to dynamically generate REST endpoints and a GraphQL schema based on the connected database\u2019s architecture. Since these endpoints return data based on your specific schema and configured permissions, the input/output of the API differs greatly for individual installations."),j=t("h2",{id:"rest-vs.-graphql",tabindex:"-1"},[s("REST vs. GraphQL "),t("a",{class:"header-anchor",href:"#rest-vs.-graphql"},"#")],-1),g=t("p",null,[t("strong",null,"There is no difference in the functionality available between the REST and GraphQL endpoints."),s(" The functionality available in both is mapped to the same set of core services, meaning that you don\u2019t lose any performance or capabilities by choosing one or the other.")],-1),b=t("p",null,"Which one you choose is ultimately up to you.",-1),w=t("h2",{id:"authentication",tabindex:"-1"},[s("Authentication "),t("a",{class:"header-anchor",href:"#authentication"},"#")],-1),T=s("By default, all data in the system is off-limits for unauthenticated users. To gain access to protected data, you must "),v=s("include an access token with every request"),E=s(", or "),A=s("configure permissions for the public role"),k=s("."),I=t("p",null,"Useful references:",-1),P=s("Authenticating into the API"),x=s("Login endpoint reference"),D=t("h2",{id:"relational-data",tabindex:"-1"},[s("Relational Data "),t("a",{class:"header-anchor",href:"#relational-data"},"#")],-1),S=s("Directus only retrieves the fields in your items that explicitly have been requested. Relational data can be retrieved nested by using "),R=s("the "),q=t("code",null,"fields",-1),L=s(" parameter"),N=s(" in REST, or regular nested queries in GraphQL. This allows you to retrieve the author of your article included in the articles data, or fetch related log entry points for your app\u2019s analytics data for example."),O=t("h3",{id:"creating-%2F-updating-%2F-deleting",tabindex:"-1"},[s("Creating / Updating / Deleting "),t("a",{class:"header-anchor",href:"#creating-%2F-updating-%2F-deleting"},"#")],-1),C=t("p",null,"Similarly to fetching, relational content can be modified deeply as well.",-1),H=t("h4",{id:"many-to-one",tabindex:"-1"},[s("Many-to-One "),t("a",{class:"header-anchor",href:"#many-to-one"},"#")],-1),M=t("p",null,"Many-to-One relationships are fairly straightforward to manage relationally. You can simply submit the changes you want as an object under the relational key in your collection. For example, if you wanted to create a new featured article on your page, you could submit:",-1),U=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),s(`
+import{a as o,o as r,b as u,w as n,g as t,e as a,B as s}from"./runtime-core.esm-bundler.e3d5f5b7.js";const h={class:"markdown-body"},d=t("blockquote",null,[t("p",null,"Directus offers both a RESTful and GraphQL API to manage the data in the database. The API has predictable resource-oriented URLs, relies on standard HTTP status codes, and uses JSON for input and output.")],-1),p=t("p",null,[t("div",{class:"table-of-contents"},[t("ul",null,[t("li",null,[t("a",{href:"#dynamic-api"}," Dynamic API")]),t("li",null,[t("a",{href:"#rest-vs.-graphql"}," REST vs. GraphQL")]),t("li",null,[t("a",{href:"#authentication"}," Authentication")]),t("li",null,[t("a",{href:"#relational-data"}," Relational Data")]),t("li",null,[t("a",{href:"#search-http-method"}," SEARCH HTTP Method")]),t("li",null,[t("a",{href:"#system-data-in-graphql"}," System data in GraphQL")]),t("li",null,[t("a",{href:"#error-codes"}," Error Codes")])])])],-1),_=t("h2",{id:"dynamic-api",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#dynamic-api"},"#"),s(" Dynamic API")],-1),f=s("The platform\u2019s API uses "),m=s("Database Mirroring"),y=s(" to dynamically generate REST endpoints and a GraphQL schema based on the connected database\u2019s architecture. Since these endpoints return data based on your specific schema and configured permissions, the input/output of the API differs greatly for individual installations."),j=t("h2",{id:"rest-vs.-graphql",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#rest-vs.-graphql"},"#"),s(" REST vs. GraphQL")],-1),g=t("p",null,[t("strong",null,"There is no difference in the functionality available between the REST and GraphQL endpoints."),s(" The functionality available in both is mapped to the same set of core services, meaning that you don\u2019t lose any performance or capabilities by choosing one or the other.")],-1),b=t("p",null,"Which one you choose is ultimately up to you.",-1),w=t("h2",{id:"authentication",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#authentication"},"#"),s(" Authentication")],-1),T=s("By default, all data in the system is off-limits for unauthenticated users. To gain access to protected data, you must "),v=s("include an access token with every request"),E=s(", or "),A=s("configure permissions for the public role"),k=s("."),I=t("p",null,"Useful references:",-1),P=s("Authenticating into the API"),x=s("Login endpoint reference"),D=t("h2",{id:"relational-data",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#relational-data"},"#"),s(" Relational Data")],-1),S=s("Directus only retrieves the fields in your items that explicitly have been requested. Relational data can be retrieved nested by using "),R=s("the "),q=t("code",null,"fields",-1),L=s(" parameter"),N=s(" in REST, or regular nested queries in GraphQL. This allows you to retrieve the author of your article included in the articles data, or fetch related log entry points for your app\u2019s analytics data for example."),O=t("h3",{id:"creating-%2F-updating-%2F-deleting",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#creating-%2F-updating-%2F-deleting"},"#"),s(" Creating / Updating / Deleting")],-1),C=t("p",null,"Similarly to fetching, relational content can be modified deeply as well.",-1),H=t("h4",{id:"many-to-one",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#many-to-one"},"#"),s(" Many-to-One")],-1),M=t("p",null,"Many-to-One relationships are fairly straightforward to manage relationally. You can simply submit the changes you want as an object under the relational key in your collection. For example, if you wanted to create a new featured article on your page, you could submit:",-1),U=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),s(`
 	`),t("span",{class:"hljs-attr"},'"featured_article"'),t("span",{class:"hljs-punctuation"},":"),s(),t("span",{class:"hljs-punctuation"},"{"),s(`
 		`),t("span",{class:"hljs-attr"},'"title"'),t("span",{class:"hljs-punctuation"},":"),s(),t("span",{class:"hljs-string"},'"This is my new article!"'),s(`
 	`),t("span",{class:"hljs-punctuation"},"}"),s(`
@@ -12,7 +12,7 @@ import{a as o,o as r,b as u,w as n,g as t,e as a,B as s}from"./runtime-core.esm-
 `)])],-1),B=t("p",null,"Seeing that the Many-to-One relationship stores the foreign key on the field itself, removing the item can be done by nullifying the field:",-1),F=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),s(`
 	`),t("span",{class:"hljs-attr"},'"featured_article"'),t("span",{class:"hljs-punctuation"},":"),s(),t("span",{class:"hljs-literal"},[t("span",{class:"hljs-keyword"},"null")]),s(`
 `),t("span",{class:"hljs-punctuation"},"}"),s(`
-`)])],-1),Q=t("h4",{id:"one-to-many-(%2F-many-to-many)",tabindex:"-1"},[s("One-to-Many (/ Many-to-Many) "),t("a",{class:"header-anchor",href:"#one-to-many-(%2F-many-to-many)"},"#")],-1),Y=t("p",null,"One-to-Many, and therefore Many-to-Many and Many-to-Any, relationships can be updated in one of two ways:",-1),W=t("p",null,[t("strong",null,"Basic")],-1),K=t("p",null,[s("The API will return one-to-many fields as an array of nested keys or items (based on the "),t("code",null,"fields"),s(" parameter). You can use this same structure to select what the related items are:")],-1),X=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),s(`
+`)])],-1),Q=t("h4",{id:"one-to-many-(%2F-many-to-many)",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#one-to-many-(%2F-many-to-many)"},"#"),s(" One-to-Many (/ Many-to-Many)")],-1),Y=t("p",null,"One-to-Many, and therefore Many-to-Many and Many-to-Any, relationships can be updated in one of two ways:",-1),W=t("p",null,[t("strong",null,"Basic")],-1),K=t("p",null,[s("The API will return one-to-many fields as an array of nested keys or items (based on the "),t("code",null,"fields"),s(" parameter). You can use this same structure to select what the related items are:")],-1),X=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),s(`
 	`),t("span",{class:"hljs-attr"},'"children"'),t("span",{class:"hljs-punctuation"},":"),s(),t("span",{class:"hljs-punctuation"},"["),t("span",{class:"hljs-number"},"2"),t("span",{class:"hljs-punctuation"},","),s(),t("span",{class:"hljs-number"},"7"),t("span",{class:"hljs-punctuation"},","),s(),t("span",{class:"hljs-number"},"149"),t("span",{class:"hljs-punctuation"},"]"),s(`
 `),t("span",{class:"hljs-punctuation"},"}"),s(`
 `)])],-1),z=t("p",null,"You can also provide an object instead of a primary key in order to create new items nested on the fly, or an object with a primary key included to update an existing item:",-1),J=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),s(`
@@ -37,7 +37,7 @@ import{a as o,o as r,b as u,w as n,g as t,e as a,B as s}from"./runtime-core.esm-
 		`),t("span",{class:"hljs-attr"},'"delete"'),t("span",{class:"hljs-punctuation"},":"),s(),t("span",{class:"hljs-punctuation"},"["),t("span",{class:"hljs-number"},"7"),t("span",{class:"hljs-punctuation"},"]"),s(`
 	`),t("span",{class:"hljs-punctuation"},"}"),s(`
 `),t("span",{class:"hljs-punctuation"},"}"),s(`
-`)])],-1),at=t("p",null,"This is useful if you need to have more tightly control on staged changes, or when you\u2019re working with a big relational dataset.",-1),lt=t("h4",{id:"many-to-any-(union-types)",tabindex:"-1"},[s("Many-to-Any (Union Types) "),t("a",{class:"header-anchor",href:"#many-to-any-(union-types)"},"#")],-1),ot=t("p",null,"Many-to-Any fields work very similar to a \u201Cregular\u201D many-to-many, with the exception that the related field can pull in the fields from any of the related collections, for example:",-1),it=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),s(`
+`)])],-1),at=t("p",null,"This is useful if you need to have more tightly control on staged changes, or when you\u2019re working with a big relational dataset.",-1),lt=t("h4",{id:"many-to-any-(union-types)",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#many-to-any-(union-types)"},"#"),s(" Many-to-Any (Union Types)")],-1),ot=t("p",null,"Many-to-Any fields work very similar to a \u201Cregular\u201D many-to-many, with the exception that the related field can pull in the fields from any of the related collections, for example:",-1),it=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),s(`
 	`),t("span",{class:"hljs-attr"},'"sections"'),t("span",{class:"hljs-punctuation"},":"),s(),t("span",{class:"hljs-punctuation"},"["),s(`
 		`),t("span",{class:"hljs-punctuation"},"{"),s(`
 			`),t("span",{class:"hljs-attr"},'"collection"'),t("span",{class:"hljs-punctuation"},":"),s(),t("span",{class:"hljs-string"},'"headings"'),t("span",{class:"hljs-punctuation"},","),s(`
@@ -53,12 +53,12 @@ import{a as o,o as r,b as u,w as n,g as t,e as a,B as s}from"./runtime-core.esm-
 		`),t("span",{class:"hljs-punctuation"},"}"),s(`
 	`),t("span",{class:"hljs-punctuation"},"]"),s(`
 `),t("span",{class:"hljs-punctuation"},"}"),s(`
-`)])],-1),ct=t("h5",{id:"rest-api",tabindex:"-1"},[s("REST API "),t("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),rt=t("p",null,[s("To scope the fields that are returned per collection type, you can use the "),t("code",null,"<field>:<scope>"),s(" syntax in the fields parameter as follows:")],-1),ut=t("pre",null,[t("code",null,`GET /items/pages
+`)])],-1),ct=t("h5",{id:"rest-api",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#rest-api"},"#"),s(" REST API")],-1),rt=t("p",null,[s("To scope the fields that are returned per collection type, you can use the "),t("code",null,"<field>:<scope>"),s(" syntax in the fields parameter as follows:")],-1),ut=t("pre",null,[t("code",null,`GET /items/pages
 	?fields[]=sections.item:headings.id
 	&fields[]=sections.item:headings.title
 	&fields[]=sections.item:paragraphs.body
 	&fields[]=sections.item:paragraphs.background_color
-`)],-1),ht=t("h5",{id:"graphql",tabindex:"-1"},[s("GraphQL "),t("a",{class:"header-anchor",href:"#graphql"},"#")],-1),dt=t("p",null,"In GraphQL, you can use nested fragments on the Union Type to select the fields:",-1),pt=t("pre",null,[t("code",{class:"language-graphql"},[t("span",{class:"hljs-keyword"},"query"),s(` {
+`)],-1),ht=t("h5",{id:"graphql",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#graphql"},"#"),s(" GraphQL")],-1),dt=t("p",null,"In GraphQL, you can use nested fragments on the Union Type to select the fields:",-1),pt=t("pre",null,[t("code",{class:"language-graphql"},[t("span",{class:"hljs-keyword"},"query"),s(` {
 	pages {
 		sections {
 			item {
@@ -75,7 +75,7 @@ import{a as o,o as r,b as u,w as n,g as t,e as a,B as s}from"./runtime-core.esm-
 		}
 	}
 }
-`)])],-1),_t=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Updating"),t("p",null,"Updating records in a many-to-any is identical to the other relationship types.")],-1),ft=t("h2",{id:"search-http-method",tabindex:"-1"},[s("SEARCH HTTP Method "),t("a",{class:"header-anchor",href:"#search-http-method"},"#")],-1),mt=t("p",null,"When using the REST API to read multiple items by (very) advanced filters, you might run into the issue where the URL simply can\u2019t hold enough data to include the full query structure. In those cases, you can use the SEARCH http method as a drop-in replacement for GET, where you\u2019re allowed to put the query into the request body as follows:",-1),yt=t("p",null,[t("strong",null,"Before:")],-1),jt=t("pre",null,[t("code",null,`GET /items/articles?filter[title][_eq]=Hello World
+`)])],-1),_t=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Updating"),t("p",null,"Updating records in a many-to-any is identical to the other relationship types.")],-1),ft=t("h2",{id:"search-http-method",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#search-http-method"},"#"),s(" SEARCH HTTP Method")],-1),mt=t("p",null,"When using the REST API to read multiple items by (very) advanced filters, you might run into the issue where the URL simply can\u2019t hold enough data to include the full query structure. In those cases, you can use the SEARCH http method as a drop-in replacement for GET, where you\u2019re allowed to put the query into the request body as follows:",-1),yt=t("p",null,[t("strong",null,"Before:")],-1),jt=t("pre",null,[t("code",null,`GET /items/articles?filter[title][_eq]=Hello World
 `)],-1),gt=t("p",null,[t("strong",null,"After:")],-1),bt=t("pre",null,[t("code",{class:"language-json"},[s(`SEARCH /items/articles
 
 `),t("span",{class:"hljs-punctuation"},"{"),s(`
@@ -87,4 +87,4 @@ import{a as o,o as r,b as u,w as n,g as t,e as a,B as s}from"./runtime-core.esm-
 		`),t("span",{class:"hljs-punctuation"},"}"),s(`
 	`),t("span",{class:"hljs-punctuation"},"}"),s(`
 `),t("span",{class:"hljs-punctuation"},"}"),s(`
-`)])],-1),wt=t("p",null,[s("There\u2019s a lot of discussion around whether or not to put a body in a GET request, to use POSTs to create search queries, or to rely on a different method altogether. As of right now, we\u2019ve chosen "),t("a",{href:"https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/",target:"_blank",rel:"noopener noreferrer"},[s("to align with IETF\u2019s "),t("em",null,"HTTP SEARCH Method"),s(" specification")]),s(". While we recognize this is still a draft spec, the SEARCH method has been used extensively before in the WebDAV world ("),t("a",{href:"https://tools.ietf.org/html/rfc5323",target:"_blank",rel:"noopener noreferrer"},"spec"),s("), and compared to the other available options, it feels like the \u201Ccleanest\u201D and most correct to handle this moving forward. As with everything else, if you have any ideas, opinions, or concerns, "),t("a",{href:"https://github.com/directus/directus/discussions/new",target:"_blank",rel:"noopener noreferrer"},"we\u2019d love to hear your thoughts"),s(".")],-1),Tt=t("p",null,"Useful reading:",-1),vt=t("ul",null,[t("li",null,[t("a",{href:"https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"HTTP SEARCH Method"),s(" (IETF, 2021)")])]),t("li",null,[t("a",{href:"https://httptoolkit.tech/blog/http-search-method/",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"Defining a new HTTP method: HTTP SEARCH"),s(" (Tim Perry, 2021)")])]),t("li",null,[t("a",{href:"https://stackoverflow.com/questions/978061/http-get-with-request-body",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"HTTP GET with request body"),s(" (StackOverflow, 2009 and ongoing)")])]),t("li",null,[t("a",{href:"https://www.elastic.co/guide/en/elasticsearch/guide/current/_empty_search.html",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"Elastic Search GET body usage"),s(" (elastic, n.d.)")])]),t("li",null,[t("a",{href:"https://evertpot.com/dropbox-post-api/",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"Dropbox starts using POST, and why this is poor API design."),s(" (Evert Pot, 2015)")])])],-1),Et=t("h2",{id:"system-data-in-graphql",tabindex:"-1"},[s("System data in GraphQL "),t("a",{class:"header-anchor",href:"#system-data-in-graphql"},"#")],-1),At=t("p",null,[s("Due to restrictions in GraphQL itself, it\u2019s impossible to properly scope/namespace system functionality from regular data access. In order to prevent any naming conflicts between user-created and system data, we\u2019ve scoped the access of the two into separate endpoints for user and system data respectively: "),t("code",null,"/graphql"),s(" and "),t("code",null,"/graphql/system"),s(". Both endpoints share the same underlying schema, so "),t("strong",null,"nested relations will work as expected"),s(" regardless if they \u201Ccross over\u201D between user and system data. The only difference in the two endpoints are the root query and mutation fields available.")],-1),kt=t("h2",{id:"error-codes",tabindex:"-1"},[s("Error Codes "),t("a",{class:"header-anchor",href:"#error-codes"},"#")],-1),It=t("p",null,"Below are the global error codes used within Directus, and what they mean.",-1),Pt=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"Error Code"),t("th",null,"HTTP Status"),t("th",null,"Description")])]),t("tbody",null,[t("tr",null,[t("td",null,[t("code",null,"FAILED_VALIDATION")]),t("td",null,"400"),t("td",null,"Validation for this particular item failed")]),t("tr",null,[t("td",null,[t("code",null,"FORBIDDEN")]),t("td",null,"403"),t("td",null,"You are not allowed to do the current action")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_TOKEN")]),t("td",null,"403"),t("td",null,"Provided token is invalid")]),t("tr",null,[t("td",null,[t("code",null,"TOKEN_EXPIRED")]),t("td",null,"401"),t("td",null,"Provided token is valid but has expired")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_CREDENTIALS")]),t("td",null,"401"),t("td",null,"Username / password or access token is wrong")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_IP")]),t("td",null,"401"),t("td",null,"Your IP address isn\u2019t allow-listed to be used with this user")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_OTP")]),t("td",null,"401"),t("td",null,"Wrong OTP was provided")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_PAYLOAD")]),t("td",null,"400"),t("td",null,"Provided payload is invalid")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_QUERY")]),t("td",null,"400"),t("td",null,"The requested query parameters can not be used")]),t("tr",null,[t("td",null,[t("code",null,"UNSUPPORTED_MEDIA_TYPE")]),t("td",null,"415"),t("td",null,[s("Provided payload format or "),t("code",null,"Content-Type"),s(" header is unsupported")])]),t("tr",null,[t("td",null,[t("code",null,"REQUESTS_EXCEEDED")]),t("td",null,"429"),t("td",null,"Hit the rate limit")]),t("tr",null,[t("td",null,[t("code",null,"ROUTE_NOT_FOUND")]),t("td",null,"404"),t("td",null,"Endpoint does not exist")]),t("tr",null,[t("td",null,[t("code",null,"SERVICE_UNAVAILABLE")]),t("td",null,"503"),t("td",null,"Could not use external service")]),t("tr",null,[t("td",null,[t("code",null,"UNPROCESSABLE_ENTITY")]),t("td",null,"422"),t("td",null,"You tried doing something illegal")])])],-1),xt=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Security"),t("p",null,[s("To prevent leaking which items exist, all actions for non-existing items will return a "),t("code",null,"FORBIDDEN"),s(" error.")])],-1),Lt="API Reference",Nt=!1,Ot={name:"introduction",setup(Dt,{expose:i}){const l={title:"API Reference",modularExtension:!1};return i({frontmatter:l}),(St,Rt)=>{const e=o("router-link"),c=o("docs-wrapper");return r(),u(c,{frontmatter:l},{default:n(()=>[t("div",h,[d,p,_,t("p",null,[f,a(e,{to:"/docs/getting-started/introduction/#database-mirroring"},{default:n(()=>[m]),_:1}),y]),j,g,b,w,t("p",null,[T,a(e,{to:"/docs/reference/authentication/#access-tokens"},{default:n(()=>[v]),_:1}),E,a(e,{to:"/docs/getting-started/quickstart/#_6-set-role-public-permissions"},{default:n(()=>[A]),_:1}),k]),I,t("ul",null,[t("li",null,[a(e,{to:"/docs/reference/authentication/"},{default:n(()=>[P]),_:1})]),t("li",null,[a(e,{to:"/docs/reference/authentication/#login"},{default:n(()=>[x]),_:1})])]),D,t("p",null,[S,a(e,{to:"/docs/reference/query/#fields"},{default:n(()=>[R,q,L]),_:1}),N]),O,C,H,M,U,G,V,B,F,Q,Y,W,K,X,z,J,Z,$,tt,st,nt,et,at,lt,ot,it,ct,rt,ut,ht,dt,pt,_t,ft,mt,yt,jt,gt,bt,wt,Tt,vt,Et,At,kt,It,Pt,xt])]),_:1})}}};export{Ot as default,Nt as modularExtension,Lt as title};
+`)])],-1),wt=t("p",null,[s("There\u2019s a lot of discussion around whether or not to put a body in a GET request, to use POSTs to create search queries, or to rely on a different method altogether. As of right now, we\u2019ve chosen "),t("a",{href:"https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/",target:"_blank",rel:"noopener noreferrer"},[s("to align with IETF\u2019s "),t("em",null,"HTTP SEARCH Method"),s(" specification")]),s(". While we recognize this is still a draft spec, the SEARCH method has been used extensively before in the WebDAV world ("),t("a",{href:"https://tools.ietf.org/html/rfc5323",target:"_blank",rel:"noopener noreferrer"},"spec"),s("), and compared to the other available options, it feels like the \u201Ccleanest\u201D and most correct to handle this moving forward. As with everything else, if you have any ideas, opinions, or concerns, "),t("a",{href:"https://github.com/directus/directus/discussions/new",target:"_blank",rel:"noopener noreferrer"},"we\u2019d love to hear your thoughts"),s(".")],-1),Tt=t("p",null,"Useful reading:",-1),vt=t("ul",null,[t("li",null,[t("a",{href:"https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"HTTP SEARCH Method"),s(" (IETF, 2021)")])]),t("li",null,[t("a",{href:"https://httptoolkit.tech/blog/http-search-method/",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"Defining a new HTTP method: HTTP SEARCH"),s(" (Tim Perry, 2021)")])]),t("li",null,[t("a",{href:"https://stackoverflow.com/questions/978061/http-get-with-request-body",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"HTTP GET with request body"),s(" (StackOverflow, 2009 and ongoing)")])]),t("li",null,[t("a",{href:"https://www.elastic.co/guide/en/elasticsearch/guide/current/_empty_search.html",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"Elastic Search GET body usage"),s(" (elastic, n.d.)")])]),t("li",null,[t("a",{href:"https://evertpot.com/dropbox-post-api/",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"Dropbox starts using POST, and why this is poor API design."),s(" (Evert Pot, 2015)")])])],-1),Et=t("h2",{id:"system-data-in-graphql",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#system-data-in-graphql"},"#"),s(" System data in GraphQL")],-1),At=t("p",null,[s("Due to restrictions in GraphQL itself, it\u2019s impossible to properly scope/namespace system functionality from regular data access. In order to prevent any naming conflicts between user-created and system data, we\u2019ve scoped the access of the two into separate endpoints for user and system data respectively: "),t("code",null,"/graphql"),s(" and "),t("code",null,"/graphql/system"),s(". Both endpoints share the same underlying schema, so "),t("strong",null,"nested relations will work as expected"),s(" regardless if they \u201Ccross over\u201D between user and system data. The only difference in the two endpoints are the root query and mutation fields available.")],-1),kt=t("h2",{id:"error-codes",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#error-codes"},"#"),s(" Error Codes")],-1),It=t("p",null,"Below are the global error codes used within Directus, and what they mean.",-1),Pt=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"Error Code"),t("th",null,"HTTP Status"),t("th",null,"Description")])]),t("tbody",null,[t("tr",null,[t("td",null,[t("code",null,"FAILED_VALIDATION")]),t("td",null,"400"),t("td",null,"Validation for this particular item failed")]),t("tr",null,[t("td",null,[t("code",null,"FORBIDDEN")]),t("td",null,"403"),t("td",null,"You are not allowed to do the current action")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_TOKEN")]),t("td",null,"403"),t("td",null,"Provided token is invalid")]),t("tr",null,[t("td",null,[t("code",null,"TOKEN_EXPIRED")]),t("td",null,"401"),t("td",null,"Provided token is valid but has expired")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_CREDENTIALS")]),t("td",null,"401"),t("td",null,"Username / password or access token is wrong")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_IP")]),t("td",null,"401"),t("td",null,"Your IP address isn\u2019t allow-listed to be used with this user")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_OTP")]),t("td",null,"401"),t("td",null,"Wrong OTP was provided")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_PAYLOAD")]),t("td",null,"400"),t("td",null,"Provided payload is invalid")]),t("tr",null,[t("td",null,[t("code",null,"INVALID_QUERY")]),t("td",null,"400"),t("td",null,"The requested query parameters can not be used")]),t("tr",null,[t("td",null,[t("code",null,"UNSUPPORTED_MEDIA_TYPE")]),t("td",null,"415"),t("td",null,[s("Provided payload format or "),t("code",null,"Content-Type"),s(" header is unsupported")])]),t("tr",null,[t("td",null,[t("code",null,"REQUESTS_EXCEEDED")]),t("td",null,"429"),t("td",null,"Hit the rate limit")]),t("tr",null,[t("td",null,[t("code",null,"ROUTE_NOT_FOUND")]),t("td",null,"404"),t("td",null,"Endpoint does not exist")]),t("tr",null,[t("td",null,[t("code",null,"SERVICE_UNAVAILABLE")]),t("td",null,"503"),t("td",null,"Could not use external service")]),t("tr",null,[t("td",null,[t("code",null,"UNPROCESSABLE_ENTITY")]),t("td",null,"422"),t("td",null,"You tried doing something illegal")])])],-1),xt=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Security"),t("p",null,[s("To prevent leaking which items exist, all actions for non-existing items will return a "),t("code",null,"FORBIDDEN"),s(" error.")])],-1),Lt="API Reference",Nt=!1,Ot={name:"introduction",setup(Dt,{expose:i}){const l={title:"API Reference",modularExtension:!1};return i({frontmatter:l}),(St,Rt)=>{const e=o("router-link"),c=o("docs-wrapper");return r(),u(c,{frontmatter:l},{default:n(()=>[t("div",h,[d,p,_,t("p",null,[f,a(e,{to:"/docs/getting-started/introduction/#database-mirroring"},{default:n(()=>[m]),_:1}),y]),j,g,b,w,t("p",null,[T,a(e,{to:"/docs/reference/authentication/#access-tokens"},{default:n(()=>[v]),_:1}),E,a(e,{to:"/docs/getting-started/quickstart/#_6-set-role-public-permissions"},{default:n(()=>[A]),_:1}),k]),I,t("ul",null,[t("li",null,[a(e,{to:"/docs/reference/authentication/"},{default:n(()=>[P]),_:1})]),t("li",null,[a(e,{to:"/docs/reference/authentication/#login"},{default:n(()=>[x]),_:1})])]),D,t("p",null,[S,a(e,{to:"/docs/reference/query/#fields"},{default:n(()=>[R,q,L]),_:1}),N]),O,C,H,M,U,G,V,B,F,Q,Y,W,K,X,z,J,Z,$,tt,st,nt,et,at,lt,ot,it,ct,rt,ut,ht,dt,pt,_t,ft,mt,yt,jt,gt,bt,wt,Tt,vt,Et,At,kt,It,Pt,xt])]),_:1})}}};export{Ot as default,Nt as modularExtension,Lt as title};

package/dist/assets/{introduction.e73b1c6c.js → introduction.a6b2c1f0.js}

@@ -1 +1 @@
-import{a as i,o as d,b as c,w as o,g as e,e as a,B as t}from"./runtime-core.esm-bundler.e3d5f5b7.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"These Docs will help you get Directus up-and-running quickly, guide you through advanced features, and explain the core concepts that make Directus so unique.")],-1),p=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#what-is-directus%3F"},"What is Directus? ")]),e("li",null,[e("a",{href:"#how-it-works"},"How It Works ")]),e("li",null,[e("a",{href:"#who%E2%80%99s-it-for%3F"},"Who\u2019s It For? ")]),e("li",null,[e("a",{href:"#when-to-use-it"},"When to Use It ")]),e("li",null,[e("a",{href:"#why-use-it%3F"},"Why Use It? ")]),e("li",null,[e("a",{href:"#directus-cloud"},"Directus Cloud ")])])])],-1),m=e("h2",{id:"what-is-directus%3F",tabindex:"-1"},[t("What is Directus? "),e("a",{class:"header-anchor",href:"#what-is-directus%3F"},"#")],-1),_=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Directus"),e("p",null,[t("Directus ("),e("a",{href:"http://audio.pronouncekiwi.com/Salli/Directus",target:"_blank",rel:"noopener noreferrer"},"duh REKT iss"),t(") is Latin for: "),e("em",null,"laid straight, arranged in lines"),t("."),e("br"),t(" The broadest goal of our platform is to present data in a simple, orderly, and intuitive way.")])],-1),g=e("p",null,[e("strong",null,"Directus is an Open Data Platform built to democratize the database."),e("br"),t(" This platform provides everyone on your team, "),e("em",null,"regardless of technical skill"),t(", equal access to data and digital file asset management, for any data model or project. First, link Directus to your desired SQL database and file storage adapter. After that, Directus enables you to perform CRUD operations, create users, assign roles with fully configurable permissions, build complex and granular queries, configure event-driven webhooks and task automation\u2026 "),e("em",null,"the list goes on!")],-1),f=e("p",null,[e("strong",null,"Database Introspection & Abstraction"),e("br"),t(" SQL flavors all come with slightly different data types and idiosyncrasies. Directus uses "),e("a",{href:"#how-it-works"},"Database Introspection"),t(" to read your database structure and create an abstraction layer to handle all the nitty-gritty details behind the scenes. This technique works seamlessly with any major SQL database. It also lets you link Directus to your new or pre-existing database or remove it anytime, with no impact on your existing data model. That means you\u2019ll never encounter vendor lock-in.")],-1),y=e("p",null,[e("strong",null,"The App and APIs"),e("br"),t(" Once your database is introspected and abstracted, Directus dynamically generates REST and GraphQL API endpoints to manage your data with granular control. You also get CLI tools for file management and a complete Javascript SDK.")],-1),b=e("p",null,[t("The API and CLI power the no-code App. In other words, the App is just a GUI that provides no-code access to the API. This architecture is how Directus democratizes the database and provides control to "),e("a",{href:"#who-s-it-for"},"the whole team"),t(".")],-1),w=e("p",null,[e("strong",null,"Open-Source, Modular, Extensible, Scalable"),e("br"),t(" At the highest level, Directus organizes its features and functionality into Modules. Each Module allows you to interact with data in some specific way, such as data and content management, digital file asset management, drag and drop analytics dashboard creation, or whatever. If you find Directus is missing something that your project needs, no problem!")],-1),v=e("p",null,[t("Built entirely in Typescript, primarily on "),e("a",{href:"https://nodejs.dev",target:"_blank",rel:"noopener noreferrer"},"Node.js"),t(" and "),e("a",{href:"https://vuejs.org",target:"_blank",rel:"noopener noreferrer"},"Vue.js"),t(", Directus is 100% open-source, modular and extensible, ensuring your project never hits a hard feature ceiling. The platform scales without issue, "),e("em",null,"and some Projects have hundreds of millions of users.")],-1),D=e("p",null,[t("You can use it with any "),e("em",null,"(or many)"),t(" stacks or frontend frameworks.")],-1),k=e("p",null,[e("strong",null,"Custom Configuration Options"),e("br"),t(" Extensive configuration options are also available as global variables in the codebase. Developers can custom configure SSO authentication method, caching details, default file storage location (local, S3, google, etc.) for digital assets, emails, "),e("em",null,"and much more.")],-1),I={class:"tip hint"},x=e("div",{class:"hint-title"},"Ready to dive in?",-1),T=t("Get a free project running in minutes. Learn Directus hands-on in the "),C=t("Quickstart Guide"),S=t("."),j=e("h2",{id:"how-it-works",tabindex:"-1"},[t("How It Works "),e("a",{class:"header-anchor",href:"#how-it-works"},"#")],-1),A=e("p",null,[e("strong",null,[t("Directus is installed as a "),e("em",null,"layer"),t(" on top of your new or existing SQL database.")])],-1),P=e("p",null,[t("The App and API dynamically "),e("em",null,"\u201Cmirror\u201D"),t(" your actual schema and content in real-time. This is similar to how technical database clients (like "),e("em",null,"phpMyAdmin"),t(") work. However, Database Introspection has many unique advantages:")],-1),E=e("ul",null,[e("li",null,"Absolute control over your pure SQL database schema."),e("li",null,"Complete transparency, portability, and security for your data."),e("li",null,"Allows importing existing databases, unaltered and without migrations."),e("li",null,"Direct database access and the full power of raw, complex SQL queries."),e("li",null,"Significant performance improvements through optimizations and indexing.")],-1),L=e("p",null,[t("In contrast, other platforms typically use a predefined or proprietary "),e("em",null,"one-size-fits-all"),t(" data model to store content . That is not the case with Directus. Directus gives you direct access to your pure and unaltered data. That means you have the option to bypass the Directus middleware (API, SDK, App) and connect to your data with proper SQL queries. This effectively removes all bottlenecks, latency overhead, and proprietary access limitations.")],-1),q=e("h2",{id:"who%E2%80%99s-it-for%3F",tabindex:"-1"},[t("Who\u2019s It For? "),e("a",{class:"header-anchor",href:"#who%E2%80%99s-it-for%3F"},"#")],-1),F=e("p",null,[e("strong",null,"Directus lets the whole team work together and access data in one place.")],-1),Q=e("p",null,[e("strong",null,"Developers"),e("br"),t(" Developers get a complete data connection toolkit with REST and GraphQL APIs, a JavaScript SDK, access to global variables to customize configuration options, and direct command-line access to digital assets.")],-1),W=e("p",null,[e("strong",null,"Power Users"),e("br"),t(" Data analysts and data scientists have in-app tools to query data, build out in-app analytics dashboards, and extract or upload data in file format. Additionally, these users are still free to link other services and run raw SQL queries directly on the database.")],-1),B=e("p",null,[e("strong",null,"Business Users"),e("br"),t(" The no-code app is safe and intuitive enough to make data accessible to everyone, even the most non-technical users. Administrators can create fully granular permissions for roles as well as individual users.")],-1),z={class:"tip hint"},U=e("div",{class:"hint-title"},"Directus Vocabulary",-1),M=t("In order keep things simpler, "),N=e("em",null,"especially for the no-code users",-1),R=t(", Directus uses friendlier names for many database terms and technical concepts, including "),G=t("Project"),O=t(" (database), "),H=t("Collection"),K=t(" (table), "),V=t("Field"),Y=t(" (column), "),J=t("Item"),X=t(" (record), and "),Z=t("Type"),$=t(" (datatype)."),ee=e("h2",{id:"when-to-use-it",tabindex:"-1"},[t("When to Use It "),e("a",{class:"header-anchor",href:"#when-to-use-it"},"#")],-1),te=e("p",null,[e("strong",null,"Directus can power any data-driven project and can be linked or removed at any time.")],-1),oe=e("p",null,[t("Build, monitor or manage any data model or app you desire: IoT fleets, e-commerce, SaaS, business data analytics, multi-channel content, "),e("em",null,"or anything else!"),t(" If it involves SQL and digital files, you can link up Directus. With this in mind, four broad use cases do emerge:")],-1),se=e("p",null,[e("strong",null,"Backend as a Service"),e("br"),t(" An end-to-end data solution. Efficiently connects data, auto-generates exhaustive APIs for projects that scale, and provides webhooks and task automation. Completely detached from the database, you\u2019re free to link and remove Directus anytime or use any other service in tandem.")],-1),ae=e("p",null,[e("strong",null,"Headless CMS"),e("br"),t(" Remember, "),e("em",null,"content"),t(" is just data from a database! Manage any omnichannel digital experience. Deliver file assets and data across websites, apps, kiosks, digital signage\u2026 "),e("em",null,"the sky\u2019s the limit!")],-1),ne=e("p",null,[e("strong",null,"Internal Tool Builder"),e("br"),t(" The whole team can build custom apps! Ditch the spreadsheet and quickly build back-office apps and admin panels for customers, inventory, projects, marketing, "),e("em",null,"or anything else.")],-1),ie=e("p",null,[e("strong",null,"Data Management and Analytics"),e("br"),t(" Establish "),e("em",null,"a single source of truth"),t(" for all data. Build no-code analytics dashboards to gain insights into company KPIs and other metrics. Coalesce previously siloed department data.")],-1),re=e("h2",{id:"why-use-it%3F",tabindex:"-1"},[t("Why Use It? "),e("a",{class:"header-anchor",href:"#why-use-it%3F"},"#")],-1),le=e("p",null,[e("strong",null,"Directus is a simple, data-first solution to complex problems with no downsides.")],-1),de=e("p",null,[t("Directus was created in 2004 and has been slowly, iteratively improved on for a long time. The core team has carefully thought through the app, beginning to end, and strives to make this platform is an all-benefit and no downside experience. It is also plug-and-play, so you\u2019re free to link or remove it anytime, with zero impact on your data. You have no vendor lock-in whatsoever, "),e("em",null,"your data is yours"),t(". There are no artificial data limits "),e("em",null,"(e.g. limits on users or roles)"),t(".")],-1),ce=e("p",null,[t("Consider competing platforms in the four general use cases "),e("a",{href:"#when-to-use-it"},"mentioned above"),t(". Due diligence to select a viable solution from one of these categories can easily take six months to ensure the feature list, pricing, scalability, migration options, etc\u2026 all match the project in question. However, with Directus, that\u2019s not the case! You can test it immediately on an existing database or build a new data model from scratch, "),e("em",null,"with no impact on your data and no long-term commitments.")],-1),ue=e("p",null,"The following core principles guide this platform:",-1),he=e("li",null,[e("strong",null,"Pure"),t(" \u2014 No predefined or proprietary schema, with all system metadata stored separately.")],-1),pe=e("li",null,[e("strong",null,"Open"),t(" \u2014 Directus Core is public and open source, with no obfuscated or cloud-only code.")],-1),me=e("li",null,[e("strong",null,"Portable"),t(" \u2014 The database can be exported or migrated anytime, so there\u2019s no vendor lock-in.")],-1),_e=e("strong",null,"Limitless",-1),ge=t(" \u2014 No artificial limits or paywalls on users, roles, languages, "),fe=t("Collections"),ye=t(", or "),be=t("Items"),we=t("."),ve=e("li",null,[e("strong",null,"Extensible"),t(" \u2014 Every aspect of this platform is modular to avoid any hard feature ceiling.")],-1),De=e("li",null,[e("strong",null,"Unopinionated"),t(" \u2014 Choose the stack, database, and architecture as you wish.")],-1),ke=e("h2",{id:"directus-cloud",tabindex:"-1"},[t("Directus Cloud "),e("a",{class:"header-anchor",href:"#directus-cloud"},"#")],-1),Ie=e("p",null,[e("strong",null,"Directus Cloud is the fastest and easiest way to get your Directus Projects going.")],-1),xe=t("Cloud architecture can be complicated and resource-intensive. Directus Cloud provides scalable, optimized storage and infrastructure, and automatic updates so developers can focus on the app\u2019s core business logic. Directus Cloud also offers "),Te=t("Cloud Exclusive Extensions"),Ce=t(", enhancing Directus Core with even more features."),Se=e("p",null,"With free Dirctus Cloud account, you can set up Teams to organize Projects, Project billing, and other Team Members however you need. You\u2019ll be able to get a Project running in about 90 seconds. Then as Project growth changes over time, scale service up or down as needed at the click of a button. The cloud dashboard also provides simple, straightforward analytics to help understand traffic and inform scaling decisions.",-1),je={class:"tip hint"},Ae=e("div",{class:"hint-title"},"Ready to try Directus Cloud?",-1),Pe=t("Setup your free Cloud account and learn Directus hands-on in the "),Ee=t("Quickstart Guide"),Le=t("."),qe=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Enterprise Cloud"),e("p",null,[t("Need advanced configuration, unlimited scalability, and dedicated support? "),e("a",{href:"https://directus.io/contact/",target:"_blank",rel:"noopener noreferrer"},"Contact us")])],-1),ze="Introduction",Ue=!1,Me={name:"introduction",setup(Fe,{expose:r}){const n={title:"Introduction",modularExtension:!1};return r({frontmatter:n}),(Qe,We)=>{const s=i("router-link"),l=i("docs-wrapper");return d(),c(l,{frontmatter:n},{default:o(()=>[e("div",u,[h,p,m,_,g,f,y,b,w,v,D,k,e("div",I,[x,e("p",null,[T,a(s,{to:"/docs/getting-started/quickstart/"},{default:o(()=>[C]),_:1}),S])]),j,A,P,E,L,q,F,Q,W,B,e("div",z,[U,e("p",null,[M,N,R,a(s,{to:"/docs/getting-started/glossary/#projects"},{default:o(()=>[G]),_:1}),O,a(s,{to:"/docs/getting-started/glossary/#collections"},{default:o(()=>[H]),_:1}),K,a(s,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[V]),_:1}),Y,a(s,{to:"/docs/getting-started/glossary/#items"},{default:o(()=>[J]),_:1}),X,a(s,{to:"/docs/getting-started/glossary/#types"},{default:o(()=>[Z]),_:1}),$])]),ee,te,oe,se,ae,ne,ie,re,le,de,ce,ue,e("ul",null,[he,pe,me,e("li",null,[_e,ge,a(s,{to:"/docs/getting-started/glossary/#collections"},{default:o(()=>[fe]),_:1}),ye,a(s,{to:"/docs/getting-started/glossary/#items"},{default:o(()=>[be]),_:1}),we]),ve,De]),ke,Ie,e("p",null,[xe,a(s,{to:"/docs/cloud/glossary/#cloud-exclusives"},{default:o(()=>[Te]),_:1}),Ce]),Se,e("div",je,[Ae,e("p",null,[Pe,a(s,{to:"/docs/getting-started/quickstart/"},{default:o(()=>[Ee]),_:1}),Le])]),qe])]),_:1})}}};export{Me as default,Ue as modularExtension,ze as title};
+import{a as i,o as d,b as c,w as o,g as e,e as a,B as t}from"./runtime-core.esm-bundler.e3d5f5b7.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"These Docs will help you get Directus up-and-running quickly, guide you through advanced features, and explain the core concepts that make Directus so unique.")],-1),p=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#what-is-directus%3F"}," What is Directus?")]),e("li",null,[e("a",{href:"#how-it-works"}," How It Works")]),e("li",null,[e("a",{href:"#who%E2%80%99s-it-for%3F"}," Who\u2019s It For?")]),e("li",null,[e("a",{href:"#when-to-use-it"}," When to Use It")]),e("li",null,[e("a",{href:"#why-use-it%3F"}," Why Use It?")]),e("li",null,[e("a",{href:"#directus-cloud"}," Directus Cloud")])])])],-1),m=e("h2",{id:"what-is-directus%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#what-is-directus%3F"},"#"),t(" What is Directus?")],-1),_=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Directus"),e("p",null,[t("Directus ("),e("a",{href:"http://audio.pronouncekiwi.com/Salli/Directus",target:"_blank",rel:"noopener noreferrer"},"duh REKT iss"),t(") is Latin for: "),e("em",null,"laid straight, arranged in lines"),t("."),e("br"),t(" The broadest goal of our platform is to present data in a simple, orderly, and intuitive way.")])],-1),g=e("p",null,[e("strong",null,"Directus is an Open Data Platform built to democratize the database."),e("br"),t(" This platform provides everyone on your team, "),e("em",null,"regardless of technical skill"),t(", equal access to data and digital file asset management, for any data model or project. First, link Directus to your desired SQL database and file storage adapter. After that, Directus enables you to perform CRUD operations, create users, assign roles with fully configurable permissions, build complex and granular queries, configure event-driven webhooks and task automation\u2026 "),e("em",null,"the list goes on!")],-1),f=e("p",null,[e("strong",null,"Database Introspection & Abstraction"),e("br"),t(" SQL flavors all come with slightly different data types and idiosyncrasies. Directus uses "),e("a",{href:"#how-it-works"},"Database Introspection"),t(" to read your database structure and create an abstraction layer to handle all the nitty-gritty details behind the scenes. This technique works seamlessly with any major SQL database. It also lets you link Directus to your new or pre-existing database or remove it anytime, with no impact on your existing data model. That means you\u2019ll never encounter vendor lock-in.")],-1),y=e("p",null,[e("strong",null,"The App and APIs"),e("br"),t(" Once your database is introspected and abstracted, Directus dynamically generates REST and GraphQL API endpoints to manage your data with granular control. You also get CLI tools for file management and a complete Javascript SDK.")],-1),b=e("p",null,[t("The API and CLI power the no-code App. In other words, the App is just a GUI that provides no-code access to the API. This architecture is how Directus democratizes the database and provides control to "),e("a",{href:"#who-s-it-for"},"the whole team"),t(".")],-1),w=e("p",null,[e("strong",null,"Open-Source, Modular, Extensible, Scalable"),e("br"),t(" At the highest level, Directus organizes its features and functionality into Modules. Each Module allows you to interact with data in some specific way, such as data and content management, digital file asset management, drag and drop analytics dashboard creation, or whatever. If you find Directus is missing something that your project needs, no problem!")],-1),v=e("p",null,[t("Built entirely in Typescript, primarily on "),e("a",{href:"https://nodejs.dev",target:"_blank",rel:"noopener noreferrer"},"Node.js"),t(" and "),e("a",{href:"https://vuejs.org",target:"_blank",rel:"noopener noreferrer"},"Vue.js"),t(", Directus is 100% open-source, modular and extensible, ensuring your project never hits a hard feature ceiling. The platform scales without issue, "),e("em",null,"and some Projects have hundreds of millions of users.")],-1),D=e("p",null,[t("You can use it with any "),e("em",null,"(or many)"),t(" stacks or frontend frameworks.")],-1),k=e("p",null,[e("strong",null,"Custom Configuration Options"),e("br"),t(" Extensive configuration options are also available as global variables in the codebase. Developers can custom configure SSO authentication method, caching details, default file storage location (local, S3, google, etc.) for digital assets, emails, "),e("em",null,"and much more.")],-1),I={class:"tip hint"},x=e("div",{class:"hint-title"},"Ready to dive in?",-1),T=t("Get a free project running in minutes. Learn Directus hands-on in the "),C=t("Quickstart Guide"),S=t("."),j=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),t(" How It Works")],-1),A=e("p",null,[e("strong",null,[t("Directus is installed as a "),e("em",null,"layer"),t(" on top of your new or existing SQL database.")])],-1),P=e("p",null,[t("The App and API dynamically "),e("em",null,"\u201Cmirror\u201D"),t(" your actual schema and content in real-time. This is similar to how technical database clients (like "),e("em",null,"phpMyAdmin"),t(") work. However, Database Introspection has many unique advantages:")],-1),E=e("ul",null,[e("li",null,"Absolute control over your pure SQL database schema."),e("li",null,"Complete transparency, portability, and security for your data."),e("li",null,"Allows importing existing databases, unaltered and without migrations."),e("li",null,"Direct database access and the full power of raw, complex SQL queries."),e("li",null,"Significant performance improvements through optimizations and indexing.")],-1),L=e("p",null,[t("In contrast, other platforms typically use a predefined or proprietary "),e("em",null,"one-size-fits-all"),t(" data model to store content . That is not the case with Directus. Directus gives you direct access to your pure and unaltered data. That means you have the option to bypass the Directus middleware (API, SDK, App) and connect to your data with proper SQL queries. This effectively removes all bottlenecks, latency overhead, and proprietary access limitations.")],-1),q=e("h2",{id:"who%E2%80%99s-it-for%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#who%E2%80%99s-it-for%3F"},"#"),t(" Who\u2019s It For?")],-1),F=e("p",null,[e("strong",null,"Directus lets the whole team work together and access data in one place.")],-1),Q=e("p",null,[e("strong",null,"Developers"),e("br"),t(" Developers get a complete data connection toolkit with REST and GraphQL APIs, a JavaScript SDK, access to global variables to customize configuration options, and direct command-line access to digital assets.")],-1),W=e("p",null,[e("strong",null,"Power Users"),e("br"),t(" Data analysts and data scientists have in-app tools to query data, build out in-app analytics dashboards, and extract or upload data in file format. Additionally, these users are still free to link other services and run raw SQL queries directly on the database.")],-1),B=e("p",null,[e("strong",null,"Business Users"),e("br"),t(" The no-code app is safe and intuitive enough to make data accessible to everyone, even the most non-technical users. Administrators can create fully granular permissions for roles as well as individual users.")],-1),z={class:"tip hint"},U=e("div",{class:"hint-title"},"Directus Vocabulary",-1),M=t("In order keep things simpler, "),N=e("em",null,"especially for the no-code users",-1),R=t(", Directus uses friendlier names for many database terms and technical concepts, including "),G=t("Project"),O=t(" (database), "),H=t("Collection"),K=t(" (table), "),V=t("Field"),Y=t(" (column), "),J=t("Item"),X=t(" (record), and "),Z=t("Type"),$=t(" (datatype)."),ee=e("h2",{id:"when-to-use-it",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#when-to-use-it"},"#"),t(" When to Use It")],-1),te=e("p",null,[e("strong",null,"Directus can power any data-driven project and can be linked or removed at any time.")],-1),oe=e("p",null,[t("Build, monitor or manage any data model or app you desire: IoT fleets, e-commerce, SaaS, business data analytics, multi-channel content, "),e("em",null,"or anything else!"),t(" If it involves SQL and digital files, you can link up Directus. With this in mind, four broad use cases do emerge:")],-1),se=e("p",null,[e("strong",null,"Backend as a Service"),e("br"),t(" An end-to-end data solution. Efficiently connects data, auto-generates exhaustive APIs for projects that scale, and provides webhooks and task automation. Completely detached from the database, you\u2019re free to link and remove Directus anytime or use any other service in tandem.")],-1),ae=e("p",null,[e("strong",null,"Headless CMS"),e("br"),t(" Remember, "),e("em",null,"content"),t(" is just data from a database! Manage any omnichannel digital experience. Deliver file assets and data across websites, apps, kiosks, digital signage\u2026 "),e("em",null,"the sky\u2019s the limit!")],-1),ne=e("p",null,[e("strong",null,"Internal Tool Builder"),e("br"),t(" The whole team can build custom apps! Ditch the spreadsheet and quickly build back-office apps and admin panels for customers, inventory, projects, marketing, "),e("em",null,"or anything else.")],-1),ie=e("p",null,[e("strong",null,"Data Management and Analytics"),e("br"),t(" Establish "),e("em",null,"a single source of truth"),t(" for all data. Build no-code analytics dashboards to gain insights into company KPIs and other metrics. Coalesce previously siloed department data.")],-1),re=e("h2",{id:"why-use-it%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#why-use-it%3F"},"#"),t(" Why Use It?")],-1),le=e("p",null,[e("strong",null,"Directus is a simple, data-first solution to complex problems with no downsides.")],-1),de=e("p",null,[t("Directus was created in 2004 and has been slowly, iteratively improved on for a long time. The core team has carefully thought through the app, beginning to end, and strives to make this platform is an all-benefit and no downside experience. It is also plug-and-play, so you\u2019re free to link or remove it anytime, with zero impact on your data. You have no vendor lock-in whatsoever, "),e("em",null,"your data is yours"),t(". There are no artificial data limits "),e("em",null,"(e.g. limits on users or roles)"),t(".")],-1),ce=e("p",null,[t("Consider competing platforms in the four general use cases "),e("a",{href:"#when-to-use-it"},"mentioned above"),t(". Due diligence to select a viable solution from one of these categories can easily take six months to ensure the feature list, pricing, scalability, migration options, etc\u2026 all match the project in question. However, with Directus, that\u2019s not the case! You can test it immediately on an existing database or build a new data model from scratch, "),e("em",null,"with no impact on your data and no long-term commitments.")],-1),ue=e("p",null,"The following core principles guide this platform:",-1),he=e("li",null,[e("strong",null,"Pure"),t(" \u2014 No predefined or proprietary schema, with all system metadata stored separately.")],-1),pe=e("li",null,[e("strong",null,"Open"),t(" \u2014 Directus Core is public and open source, with no obfuscated or cloud-only code.")],-1),me=e("li",null,[e("strong",null,"Portable"),t(" \u2014 The database can be exported or migrated anytime, so there\u2019s no vendor lock-in.")],-1),_e=e("strong",null,"Limitless",-1),ge=t(" \u2014 No artificial limits or paywalls on users, roles, languages, "),fe=t("Collections"),ye=t(", or "),be=t("Items"),we=t("."),ve=e("li",null,[e("strong",null,"Extensible"),t(" \u2014 Every aspect of this platform is modular to avoid any hard feature ceiling.")],-1),De=e("li",null,[e("strong",null,"Unopinionated"),t(" \u2014 Choose the stack, database, and architecture as you wish.")],-1),ke=e("h2",{id:"directus-cloud",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#directus-cloud"},"#"),t(" Directus Cloud")],-1),Ie=e("p",null,[e("strong",null,"Directus Cloud is the fastest and easiest way to get your Directus Projects going.")],-1),xe=t("Cloud architecture can be complicated and resource-intensive. Directus Cloud provides scalable, optimized storage and infrastructure, and automatic updates so developers can focus on the app\u2019s core business logic. Directus Cloud also offers "),Te=t("Cloud Exclusive Extensions"),Ce=t(", enhancing Directus Core with even more features."),Se=e("p",null,"With free Dirctus Cloud account, you can set up Teams to organize Projects, Project billing, and other Team Members however you need. You\u2019ll be able to get a Project running in about 90 seconds. Then as Project growth changes over time, scale service up or down as needed at the click of a button. The cloud dashboard also provides simple, straightforward analytics to help understand traffic and inform scaling decisions.",-1),je={class:"tip hint"},Ae=e("div",{class:"hint-title"},"Ready to try Directus Cloud?",-1),Pe=t("Setup your free Cloud account and learn Directus hands-on in the "),Ee=t("Quickstart Guide"),Le=t("."),qe=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Enterprise Cloud"),e("p",null,[t("Need advanced configuration, unlimited scalability, and dedicated support? "),e("a",{href:"https://directus.io/contact/",target:"_blank",rel:"noopener noreferrer"},"Contact us")])],-1),ze="Introduction",Ue=!1,Me={name:"introduction",setup(Fe,{expose:r}){const n={title:"Introduction",modularExtension:!1};return r({frontmatter:n}),(Qe,We)=>{const s=i("router-link"),l=i("docs-wrapper");return d(),c(l,{frontmatter:n},{default:o(()=>[e("div",u,[h,p,m,_,g,f,y,b,w,v,D,k,e("div",I,[x,e("p",null,[T,a(s,{to:"/docs/getting-started/quickstart/"},{default:o(()=>[C]),_:1}),S])]),j,A,P,E,L,q,F,Q,W,B,e("div",z,[U,e("p",null,[M,N,R,a(s,{to:"/docs/getting-started/glossary/#projects"},{default:o(()=>[G]),_:1}),O,a(s,{to:"/docs/getting-started/glossary/#collections"},{default:o(()=>[H]),_:1}),K,a(s,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[V]),_:1}),Y,a(s,{to:"/docs/getting-started/glossary/#items"},{default:o(()=>[J]),_:1}),X,a(s,{to:"/docs/getting-started/glossary/#types"},{default:o(()=>[Z]),_:1}),$])]),ee,te,oe,se,ae,ne,ie,re,le,de,ce,ue,e("ul",null,[he,pe,me,e("li",null,[_e,ge,a(s,{to:"/docs/getting-started/glossary/#collections"},{default:o(()=>[fe]),_:1}),ye,a(s,{to:"/docs/getting-started/glossary/#items"},{default:o(()=>[be]),_:1}),we]),ve,De]),ke,Ie,e("p",null,[xe,a(s,{to:"/docs/cloud/glossary/#cloud-exclusives"},{default:o(()=>[Te]),_:1}),Ce]),Se,e("div",je,[Ae,e("p",null,[Pe,a(s,{to:"/docs/getting-started/quickstart/"},{default:o(()=>[Ee]),_:1}),Le])]),qe])]),_:1})}}};export{Me as default,Ue as modularExtension,ze as title};

package/dist/assets/{introduction.32669a19.js → introduction.e6dc6284.js}

@@ -1,4 +1,4 @@
-import{a as n,o as l,b as c,w as o,g as e,e as i,B as t}from"./runtime-core.esm-bundler.e3d5f5b7.js";const d={class:"markdown-body"},h=e("blockquote",null,[e("p",null,[t("Our team truly appreciates every single contributor, community member, GitHub star, pull-request, bug report, and feature request. Keeping Directus completely free and open-source is our way of saying: "),e("strong",null,"Thank you!")])],-1),p=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"We're here to help!"),e("p",null,[t("If you have "),e("em",null,"any"),t(" questions along your contributor journey, please feel free to come chat with us on our "),e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord Community"),t(".")])],-1),f=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Technical Contributor Docs"),e("p",null,[t("Technical documentation for contributing to the core codebase is located on the main "),e("code",null,"directus/directus"),e("a",{href:"https://github.com/directus/directus/wiki",target:"_blank",rel:"noopener noreferrer"},"GitHub repository\u2019s Wiki"),t(".")])],-1),_=e("h2",{id:"code-of-conduct",tabindex:"-1"},[t("Code of Conduct "),e("a",{class:"header-anchor",href:"#code-of-conduct"},"#")],-1),g=e("p",null,[e("strong",null,[t("The Directus "),e("a",{href:"https://github.com/directus/directus/blob/main/code_of_conduct.md",target:"_blank",rel:"noopener noreferrer"},"Code of Conduct"),t(" is one of the ways we put our values into practice. We expect all of our staff, contractors and contributors to know and follow this code.")])],-1),b=e("p",null,[e("strong",null,"Our contributors and maintainers work extremely hard to build Directus as premium open-source software. Please be respectful of those efforts throughout our ecosystem. Trolling, harassing, insulting, or other unacceptable behavior by participants will not be tolerated.")],-1),m=e("p",null,"In the interest of fostering an open and welcoming environment, we as pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.",-1),y=e("p",null,"Examples of behavior that contributes to creating a positive environment include:",-1),w=e("ul",null,[e("li",null,"Using welcoming and inclusive language"),e("li",null,"Being respectful of differing viewpoints and experiences"),e("li",null,"Gracefully accepting constructive criticism"),e("li",null,"Focusing on what is best for the community"),e("li",null,"Showing empathy towards other community members")],-1),v=e("p",null,[e("strong",null,[t("Before continuing, please take a moment to read our full "),e("a",{href:"https://github.com/directus/directus/blob/main/contributing.md",target:"_blank",rel:"noopener noreferrer"},"Code of Conduct"),t(".")])],-1),k=e("h2",{id:"wait-%E2%80%94-before-you-begin",tabindex:"-1"},[t("Wait \u2014 Before you Begin "),e("a",{class:"header-anchor",href:"#wait-%E2%80%94-before-you-begin"},"#")],-1),x=t("When contributing to this repository, it is important to first discuss the change you wish to make with the owners of this repository. This can be done via "),q=e("a",{href:"https://github.com/directus/directus/issues",target:"_blank",rel:"noopener noreferrer"},"GitHub Issue",-1),C=t(", "),D=e("a",{href:"https://github.com/directus/directus/discussions",target:"_blank",rel:"noopener noreferrer"},"GitHub Discussions",-1),R=t(", "),F=e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord",-1),B=t(", "),T=t("email"),Y=t(", or any other method."),G=e("p",null,"Following this rule will help avoid wasted time caused by multiple people working on the same issue or writing code that will not be merged.",-1),H=e("h2",{id:"feature-requests",tabindex:"-1"},[t("Feature Requests "),e("a",{class:"header-anchor",href:"#feature-requests"},"#")],-1),S=e("p",null,[t("Feature requests are a great way to let our team know what should be prioritized next. You can "),e("a",{href:"https://github.com/directus/directus/discussions/new",target:"_blank",rel:"noopener noreferrer"},"submit a new feature request"),t(" or "),e("a",{href:"https://github.com/directus/directus/discussions",target:"_blank",rel:"noopener noreferrer"},"vote on existing submissions"),t(" via GitHub Discussions.")],-1),W=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"The 80/20 Rule"),e("p",null,"To keep the Directus codebase as clean and simple as possible, we will only consider approving features that we feel at least 80% of our user-base will find valuable. If your feature request falls within the 20% range, it is considered an edge-case and should be implemented as an extension.")],-1),A=e("h2",{id:"rfcs",tabindex:"-1"},[t("RFCs "),e("a",{class:"header-anchor",href:"#rfcs"},"#")],-1),I=e("p",null,[t("Some Directus features/fixes may require additional design, strategy, and/or discussion before beginning work. For these notable pull-requests, you should first submit an RFC (Request For Comments) to our core team via "),e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord"),t(". This process is relatively informal, but ensures proper alignment, and helps avoid squandered development time by contributors.")],-1),E=e("h2",{id:"bug-reporting",tabindex:"-1"},[t("Bug Reporting "),e("a",{class:"header-anchor",href:"#bug-reporting"},"#")],-1),N=e("p",null,[t("Reporting any bugs you come across is an invaluable part of helping keep Directus stable. After confirming a similar issue doesn\u2019t already exist, you can "),e("a",{href:"https://github.com/directus/directus/issues/new",target:"_blank",rel:"noopener noreferrer"},"submit a bug report"),t(" via GitHub Issues. Please ensure the following for all submissions:")],-1),O=e("li",null,"You are experiencing an actual bug, not a configuration issue",-1),P=e("li",null,"You are using the official (pre-built) version of directus and not a fork",-1),V=e("li",null,"You are not asking a question or requesting a new feature",-1),U=e("li",null,"You have checked that no similar issue (or discussion) already exists",-1),j=e("li",null,"You have entered a clear and concise title",-1),z=e("li",null,"You have followed the issue template, with stack details and steps to reproduce",-1),K=t("You have already completed all "),L=t("troubleshooting steps"),M=e("h2",{id:"reporting-security-vulnerabilities",tabindex:"-1"},[t("Reporting Security Vulnerabilities "),e("a",{class:"header-anchor",href:"#reporting-security-vulnerabilities"},"#")],-1),J=t("If you believe you have discovered a security issue within a Directus product or service, please reach out to us directly over email: "),Q=t("security@directus.io"),X=t(". We will then open a "),Z=e("a",{href:"https://github.com/directus/directus/security/advisories",target:"_blank",rel:"noopener noreferrer"},"GitHub Security Advisory",-1),$=t(" for tracking the fix."),ee=e("p",null,"We value the members of the independent security research community who find security vulnerabilities and work with our team so that proper fixes can be issued to users. Our policy is to credit all researchers in the fix\u2019s release notes. In order to receive credit, security researchers must follow responsible disclosure practices, including:",-1),te=e("ul",null,[e("li",null,"They do not publish the vulnerability prior to the Directus team releasing a fix for it"),e("li",null,"They do not divulge exact details of the issue, eg: through exploits or proof-of-concepts")],-1),oe=e("h2",{id:"submitting-a-pull-request",tabindex:"-1"},[t("Submitting a Pull-Request "),e("a",{class:"header-anchor",href:"#submitting-a-pull-request"},"#")],-1),se=e("h3",{id:"1.-submit-an-rfc-(if-needed)",tabindex:"-1"},[t("1. Submit an RFC (if needed) "),e("a",{class:"header-anchor",href:"#1.-submit-an-rfc-(if-needed)"},"#")],-1),ie=e("p",null,[t("Please read our docs on the "),e("a",{href:"#rfcs"},"RFC process"),t(".")],-1),re=e("h3",{id:"2.-update-relevant-docs",tabindex:"-1"},[t("2. Update relevant docs "),e("a",{class:"header-anchor",href:"#2.-update-relevant-docs"},"#")],-1),ne=e("p",null,"Before submitting any pull-requests, ensure that any relevant documentation (included in this same repo) is updated.",-1),ae=e("h3",{id:"3.-push-your-changes",tabindex:"-1"},[t("3. Push your changes "),e("a",{class:"header-anchor",href:"#3.-push-your-changes"},"#")],-1),ue=e("pre",null,[e("code",{class:"language-bash"},`git push -u origin YOUR-BRANCH-NAME
-`)],-1),le=e("h3",{id:"submit-a-pull-request",tabindex:"-1"},[t("Submit a pull-request "),e("a",{class:"header-anchor",href:"#submit-a-pull-request"},"#")],-1),ce=e("p",null,"Once you push the changes to your repo, the \u201CCompare & pull request\u201D button will appear in GitHub. Click it and you\u2019ll be taken to a screen where you can fill in the appropriate details. Finally, open the pull request by clicking the \u201CCreate pull request\u201D button.",-1),de=e("p",null,"Now our core staff will review your contribution and either merge it, or request that you to make changes.",-1),he=e("h2",{id:"syncing-your-fork-with-directus",tabindex:"-1"},[t("Syncing Your Fork with Directus "),e("a",{class:"header-anchor",href:"#syncing-your-fork-with-directus"},"#")],-1),pe=e("p",null,"After you have submitted your pull requests, you would need to sync your fork with Directus to pull all the latest commits before you continue to contribute.",-1),fe=e("h3",{id:"1.-add-directus-as-a-remote",tabindex:"-1"},[t("1. Add Directus as a Remote "),e("a",{class:"header-anchor",href:"#1.-add-directus-as-a-remote"},"#")],-1),_e=e("p",null,"While your fork is your main remote or origin, you will add Directus as the upstream, which generally refers to the original repo that you have forked.",-1),ge=e("pre",null,[e("code",{class:"language-bash"},`git remote add upstream git@github.com:directus/directus.git
-`)],-1),be=e("h3",{id:"2.-fetch-the-latest-changes",tabindex:"-1"},[t("2. Fetch the Latest Changes "),e("a",{class:"header-anchor",href:"#2.-fetch-the-latest-changes"},"#")],-1),me=e("p",null,[t("Depending on your setup, you will need to get the latest commits from the "),e("code",null,"main"),t(" branch of Directus by doing a pull, reset, rebase or fetch.")],-1),ye=e("pre",null,[e("code",{class:"language-bash"},`git pull upstream main
+import{a as n,o as l,b as c,w as o,g as e,e as i,B as t}from"./runtime-core.esm-bundler.e3d5f5b7.js";const d={class:"markdown-body"},h=e("blockquote",null,[e("p",null,[t("Our team truly appreciates every single contributor, community member, GitHub star, pull-request, bug report, and feature request. Keeping Directus completely free and open-source is our way of saying: "),e("strong",null,"Thank you!")])],-1),p=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"We're here to help!"),e("p",null,[t("If you have "),e("em",null,"any"),t(" questions along your contributor journey, please feel free to come chat with us on our "),e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord Community"),t(".")])],-1),f=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Technical Contributor Docs"),e("p",null,[t("Technical documentation for contributing to the core codebase is located on the main "),e("code",null,"directus/directus"),e("a",{href:"https://github.com/directus/directus/wiki",target:"_blank",rel:"noopener noreferrer"},"GitHub repository\u2019s Wiki"),t(".")])],-1),_=e("h2",{id:"code-of-conduct",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#code-of-conduct"},"#"),t(" Code of Conduct")],-1),g=e("p",null,[e("strong",null,[t("The Directus "),e("a",{href:"https://github.com/directus/directus/blob/main/code_of_conduct.md",target:"_blank",rel:"noopener noreferrer"},"Code of Conduct"),t(" is one of the ways we put our values into practice. We expect all of our staff, contractors and contributors to know and follow this code.")])],-1),b=e("p",null,[e("strong",null,"Our contributors and maintainers work extremely hard to build Directus as premium open-source software. Please be respectful of those efforts throughout our ecosystem. Trolling, harassing, insulting, or other unacceptable behavior by participants will not be tolerated.")],-1),m=e("p",null,"In the interest of fostering an open and welcoming environment, we as pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.",-1),y=e("p",null,"Examples of behavior that contributes to creating a positive environment include:",-1),w=e("ul",null,[e("li",null,"Using welcoming and inclusive language"),e("li",null,"Being respectful of differing viewpoints and experiences"),e("li",null,"Gracefully accepting constructive criticism"),e("li",null,"Focusing on what is best for the community"),e("li",null,"Showing empathy towards other community members")],-1),v=e("p",null,[e("strong",null,[t("Before continuing, please take a moment to read our full "),e("a",{href:"https://github.com/directus/directus/blob/main/contributing.md",target:"_blank",rel:"noopener noreferrer"},"Code of Conduct"),t(".")])],-1),k=e("h2",{id:"wait-%E2%80%94-before-you-begin",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#wait-%E2%80%94-before-you-begin"},"#"),t(" Wait \u2014 Before you Begin")],-1),x=t("When contributing to this repository, it is important to first discuss the change you wish to make with the owners of this repository. This can be done via "),q=e("a",{href:"https://github.com/directus/directus/issues",target:"_blank",rel:"noopener noreferrer"},"GitHub Issue",-1),C=t(", "),D=e("a",{href:"https://github.com/directus/directus/discussions",target:"_blank",rel:"noopener noreferrer"},"GitHub Discussions",-1),R=t(", "),F=e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord",-1),B=t(", "),T=t("email"),Y=t(", or any other method."),G=e("p",null,"Following this rule will help avoid wasted time caused by multiple people working on the same issue or writing code that will not be merged.",-1),H=e("h2",{id:"feature-requests",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#feature-requests"},"#"),t(" Feature Requests")],-1),S=e("p",null,[t("Feature requests are a great way to let our team know what should be prioritized next. You can "),e("a",{href:"https://github.com/directus/directus/discussions/new",target:"_blank",rel:"noopener noreferrer"},"submit a new feature request"),t(" or "),e("a",{href:"https://github.com/directus/directus/discussions",target:"_blank",rel:"noopener noreferrer"},"vote on existing submissions"),t(" via GitHub Discussions.")],-1),W=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"The 80/20 Rule"),e("p",null,"To keep the Directus codebase as clean and simple as possible, we will only consider approving features that we feel at least 80% of our user-base will find valuable. If your feature request falls within the 20% range, it is considered an edge-case and should be implemented as an extension.")],-1),A=e("h2",{id:"rfcs",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rfcs"},"#"),t(" RFCs")],-1),I=e("p",null,[t("Some Directus features/fixes may require additional design, strategy, and/or discussion before beginning work. For these notable pull-requests, you should first submit an RFC (Request For Comments) to our core team via "),e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord"),t(". This process is relatively informal, but ensures proper alignment, and helps avoid squandered development time by contributors.")],-1),E=e("h2",{id:"bug-reporting",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#bug-reporting"},"#"),t(" Bug Reporting")],-1),N=e("p",null,[t("Reporting any bugs you come across is an invaluable part of helping keep Directus stable. After confirming a similar issue doesn\u2019t already exist, you can "),e("a",{href:"https://github.com/directus/directus/issues/new",target:"_blank",rel:"noopener noreferrer"},"submit a bug report"),t(" via GitHub Issues. Please ensure the following for all submissions:")],-1),O=e("li",null,"You are experiencing an actual bug, not a configuration issue",-1),P=e("li",null,"You are using the official (pre-built) version of directus and not a fork",-1),V=e("li",null,"You are not asking a question or requesting a new feature",-1),U=e("li",null,"You have checked that no similar issue (or discussion) already exists",-1),j=e("li",null,"You have entered a clear and concise title",-1),z=e("li",null,"You have followed the issue template, with stack details and steps to reproduce",-1),K=t("You have already completed all "),L=t("troubleshooting steps"),M=e("h2",{id:"reporting-security-vulnerabilities",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#reporting-security-vulnerabilities"},"#"),t(" Reporting Security Vulnerabilities")],-1),J=t("If you believe you have discovered a security issue within a Directus product or service, please reach out to us directly over email: "),Q=t("security@directus.io"),X=t(". We will then open a "),Z=e("a",{href:"https://github.com/directus/directus/security/advisories",target:"_blank",rel:"noopener noreferrer"},"GitHub Security Advisory",-1),$=t(" for tracking the fix."),ee=e("p",null,"We value the members of the independent security research community who find security vulnerabilities and work with our team so that proper fixes can be issued to users. Our policy is to credit all researchers in the fix\u2019s release notes. In order to receive credit, security researchers must follow responsible disclosure practices, including:",-1),te=e("ul",null,[e("li",null,"They do not publish the vulnerability prior to the Directus team releasing a fix for it"),e("li",null,"They do not divulge exact details of the issue, eg: through exploits or proof-of-concepts")],-1),oe=e("h2",{id:"submitting-a-pull-request",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#submitting-a-pull-request"},"#"),t(" Submitting a Pull-Request")],-1),se=e("h3",{id:"1.-submit-an-rfc-(if-needed)",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#1.-submit-an-rfc-(if-needed)"},"#"),t(" 1. Submit an RFC (if needed)")],-1),ie=e("p",null,[t("Please read our docs on the "),e("a",{href:"#rfcs"},"RFC process"),t(".")],-1),re=e("h3",{id:"2.-update-relevant-docs",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#2.-update-relevant-docs"},"#"),t(" 2. Update relevant docs")],-1),ne=e("p",null,"Before submitting any pull-requests, ensure that any relevant documentation (included in this same repo) is updated.",-1),ae=e("h3",{id:"3.-push-your-changes",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#3.-push-your-changes"},"#"),t(" 3. Push your changes")],-1),ue=e("pre",null,[e("code",{class:"language-bash"},`git push -u origin YOUR-BRANCH-NAME
+`)],-1),le=e("h3",{id:"submit-a-pull-request",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#submit-a-pull-request"},"#"),t(" Submit a pull-request")],-1),ce=e("p",null,"Once you push the changes to your repo, the \u201CCompare & pull request\u201D button will appear in GitHub. Click it and you\u2019ll be taken to a screen where you can fill in the appropriate details. Finally, open the pull request by clicking the \u201CCreate pull request\u201D button.",-1),de=e("p",null,"Now our core staff will review your contribution and either merge it, or request that you to make changes.",-1),he=e("h2",{id:"syncing-your-fork-with-directus",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#syncing-your-fork-with-directus"},"#"),t(" Syncing Your Fork with Directus")],-1),pe=e("p",null,"After you have submitted your pull requests, you would need to sync your fork with Directus to pull all the latest commits before you continue to contribute.",-1),fe=e("h3",{id:"1.-add-directus-as-a-remote",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#1.-add-directus-as-a-remote"},"#"),t(" 1. Add Directus as a Remote")],-1),_e=e("p",null,"While your fork is your main remote or origin, you will add Directus as the upstream, which generally refers to the original repo that you have forked.",-1),ge=e("pre",null,[e("code",{class:"language-bash"},`git remote add upstream git@github.com:directus/directus.git
+`)],-1),be=e("h3",{id:"2.-fetch-the-latest-changes",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#2.-fetch-the-latest-changes"},"#"),t(" 2. Fetch the Latest Changes")],-1),me=e("p",null,[t("Depending on your setup, you will need to get the latest commits from the "),e("code",null,"main"),t(" branch of Directus by doing a pull, reset, rebase or fetch.")],-1),ye=e("pre",null,[e("code",{class:"language-bash"},`git pull upstream main
 `)],-1),we=e("p",null,"At this point you are ready to continue working on Directus, with the latest commits included!",-1),ve=e("div",{class:"tip hint"},[e("p",null,"Before you begin or resume development, be sure to always sync, if you are going to submit a pull request with your changes!")],-1),De="Contributing",Re=!1,Fe={name:"introduction",setup(ke,{expose:a}){const r={title:"Contributing",modularExtension:!1};return a({frontmatter:r}),(xe,qe)=>{const s=n("router-link"),u=n("docs-wrapper");return l(),c(u,{frontmatter:r},{default:o(()=>[e("div",d,[h,p,f,_,g,b,m,y,w,v,k,e("p",null,[x,q,C,D,R,F,B,i(s,{to:"/docsmailto:info@directus.io"},{default:o(()=>[T]),_:1}),Y]),G,H,S,W,A,I,E,N,e("ul",null,[O,P,V,U,j,z,e("li",null,[K,i(s,{to:"/docs/getting-started/support#troubleshooting-steps"},{default:o(()=>[L]),_:1})])]),M,e("p",null,[J,i(s,{to:"/docsmailto:security@directus.io"},{default:o(()=>[Q]),_:1}),X,Z,$]),ee,te,oe,se,ie,re,ne,ae,ue,le,ce,de,he,pe,fe,_e,ge,be,me,ye,we,ve])]),_:1})}}};export{Fe as default,Re as modularExtension,De as title};