From 632de3eebd148a27a7c89ccd6925c0897691bece Mon Sep 17 00:00:00 2001 From: Nitwel Date: Wed, 25 Jun 2025 18:48:18 +0200 Subject: [PATCH] improve alias docs --- content/guides/04.connect/3.query-parameters.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/content/guides/04.connect/3.query-parameters.md b/content/guides/04.connect/3.query-parameters.md index cda6f767..e4880a78 100644 --- a/content/guides/04.connect/3.query-parameters.md +++ b/content/guides/04.connect/3.query-parameters.md @@ -515,6 +515,16 @@ const result = await directus.request( ``` :: +::callout{icon="material-symbols:info-outline"} +**Aliases in combination with other features** +Aliases support being used in combination with: + +1. functions, e.g. `alias[release_year]=year(released)`{lang="http"} +2. in the deep query parameter, e.g. `deep[author][_alias][birthyear]=year(birthday)`{lang="http"} + +Note that it is not possible to use aliases on relational fields e.g. `alias[author_name]=author.name`{lang="http"} and not possible to have `.` in the alias name itself e.g. `alias[not.possible]=field`{lang="http"}. +:: + ## Export Saves the API response to a file. Valid values are `csv`, `json`, `xml`, `yaml`.