Skip to content

Improve alias docs #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve alias docs #389

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions content/guides/04.connect/3.query-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down