github/directus
1
1
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-04-25 03:00:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Snippet Toggler Improvements (#20077)

Browse Source
This commit is contained in:
Pascal Jufer
2023-10-19 13:35:07 +02:00
committed by GitHub
parent 6935bd2ba2
commit 161d7518c1
29 changed files with 408 additions and 392 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/.vitepress/components/SnippetToggler.vue
View File

@@ -1,11 +1,12 @@
<script setup lang="ts">
import { useLocalStorage, type RemovableRef } from '@vueuse/core';
import { onMounted, ref, watch } from 'vue';
import { onMounted, ref, watch, nextTick } from 'vue';
const props = defineProps<{
choices: string[];
label?: string;
group?: string;
alwaysDark?: boolean;
maintainHeight?: boolean;
}>();
const selected = ref<string>();
@@ -13,26 +14,38 @@ let localStorage: RemovableRef<string | undefined> | undefined;
// Get local storage on client side (preventing SSR <-> client mismatch & flash)
onMounted(() => {
localStorage = useLocalStorage('toggler-value', undefined);
if (props.group) {
localStorage = useLocalStorage(`toggler-${props.group}`, undefined);
const initialValue = localStorage.value;
const initialValue = localStorage.value;
selected.value = initialValue && props.choices.includes(initialValue) ? initialValue : props.choices[0];
selected.value = initialValue && props.choices.includes(initialValue) ? initialValue : props.choices[0];
watch(localStorage, (value) => {
if (value && !props.choices.includes(value)) return;
watch(localStorage, (value) => {
if (value && !props.choices.includes(value)) return;
selected.value = value;
});
selected.value = value;
});
} else {
selected.value = props.choices[0];
}
});
const changeSelected = (choice: string) => {
const changeSelected = async (choice: string, el: HTMLElement) => {
const previousRelativeOffset = el.offsetTop - document.documentElement.scrollTop;
if (localStorage) {
localStorage.value = choice;
} else {
// Not expected but as fallback safety
selected.value = choice;
}
if (props.group) {
await nextTick();
const newRelativeOffset = el.offsetTop - document.documentElement.scrollTop;
document.documentElement.scrollTop += newRelativeOffset - previousRelativeOffset;
}
};
</script>
@@ -45,7 +58,7 @@ const changeSelected = (choice: string) => {
:key="choice"
class="button"
:class="{ active: choice === selected }"
@click="changeSelected(choice)"
@click="changeSelected(choice, $el)"
>
{{ choice }}
</button>
@@ -54,7 +67,10 @@ const changeSelected = (choice: string) => {
<div class="content-area">
<template v-for="choice in choices" :key="choice">
<div class="content" :class="{ active: choice === selected }">
<div
v-if="maintainHeight || choice === selected"
:class="{ content: maintainHeight, active: maintainHeight && choice === selected }"
>
<slot :name="choice.toLowerCase()"></slot>
</div>
</template>

2
docs/index.md
View File

@@ -26,7 +26,7 @@ import Badge from './.vitepress/components/Badge.vue'
</div>
<div :class="$style.heroToggler">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API" :alwaysDark="true">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api" alwaysDark maintainHeight>
<template #rest>
```js

24
docs/reference/authentication.md
View File

@@ -42,7 +42,7 @@ Retrieve a temporary access token and refresh token.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /auth/login`
@@ -124,7 +124,7 @@ The token's expiration time can be configured through
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /auth/login`
@@ -176,7 +176,7 @@ Retrieve a new access token using a refresh token.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /auth/refresh`
@@ -246,7 +246,7 @@ as the mode in the request, the refresh token won't be returned in the JSON.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /auth/refresh`
@@ -299,7 +299,7 @@ Invalidate the refresh token thus destroying the user's session.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /auth/logout`
@@ -347,7 +347,7 @@ to submit it here.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /auth/logout`
@@ -393,7 +393,7 @@ Request a password reset email to be sent to the given user.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /auth/password/request`
@@ -441,7 +441,7 @@ Provide a custom reset url which the link in the email will lead to. The reset t
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /auth/password/request`
@@ -484,7 +484,7 @@ this endpoint to allow the user to reset their password.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /auth/password/reset`
@@ -531,7 +531,7 @@ New password for the user.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /auth/password/reset`
@@ -581,7 +581,7 @@ To learn more about setting up auth providers, see
### Request
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`GET /auth`
@@ -632,7 +632,7 @@ Whether or not the default authentication provider is disabled.
### Example
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`GET /auth`

38
docs/reference/files.md
View File

@@ -137,7 +137,7 @@ Below are four possible qualities (200x200 cover) to visually compare the balanc
### Preset
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -165,7 +165,7 @@ const result = await client.request(readAssetRaw('<file-id>', { key: '<key>' }))
### Custom
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -198,7 +198,7 @@ const result = await client.request(readAssetRaw('1ac73658-8b62-4dea-b6da-529fbc
### Advanced
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -333,7 +333,7 @@ List all files that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /files`
@@ -380,7 +380,7 @@ be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /files`
@@ -429,7 +429,7 @@ Retrieve a single file by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /files/:id`
@@ -469,7 +469,7 @@ Returns a [file object](#the-file-object) if a valid primary key was provided.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d`
@@ -512,7 +512,7 @@ Upload a new file.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /files`
@@ -565,7 +565,7 @@ multiple files were uploaded at once.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /files`
@@ -619,7 +619,7 @@ Import a file from the web
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /files/import`
@@ -674,7 +674,7 @@ Returns the [file object](#the-file-object) for the imported file.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /files/import`
@@ -725,7 +725,7 @@ Update an existing file, and/or replace it's file contents.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /files/:id`
@@ -773,7 +773,7 @@ Returns the [file object](#the-file-object) for the updated file.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d`
@@ -822,7 +822,7 @@ Update multiple files at the same time.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /files`
@@ -877,7 +877,7 @@ Returns the [file objects](#the-file-object) for the updated files.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /files`
@@ -935,7 +935,7 @@ This will also delete the file from disk.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /files/:id`
@@ -975,7 +975,7 @@ Empty response.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d`
@@ -1019,7 +1019,7 @@ This will also delete the files from disk.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /files`
@@ -1069,7 +1069,7 @@ Empty response.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /files`

40
docs/reference/items.md
View File

@@ -39,7 +39,7 @@ List all items that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /items/:collection`
@@ -92,7 +92,7 @@ be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /items/articles`
@@ -140,7 +140,7 @@ Get an item that exists in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /items/:collection/:id`
@@ -180,7 +180,7 @@ Returns an [item object](#the-item-object) if a valid primary key was provided.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /items/articles/15`
@@ -216,7 +216,7 @@ List the singleton item in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /items/:collection`
@@ -267,7 +267,7 @@ Returns an [item object](#the-item-object) if a valid collection name was provid
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /items/about`
@@ -306,7 +306,7 @@ Create a new item in the given collection.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /items/:collection`
@@ -359,7 +359,7 @@ Returns the [item objects](#the-item-object) of the item that were created.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /items/articles`
@@ -410,7 +410,7 @@ Create new items in the given collection.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /items/:collection`
@@ -456,7 +456,7 @@ Returns the [item objects](#the-item-object) of the item that were created.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /items/articles`
@@ -524,7 +524,7 @@ Update an existing item.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /items/:collection/:id`
@@ -570,7 +570,7 @@ Returns the [item object](#the-item-object) of the item that was updated.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /items/articles/15`
@@ -619,7 +619,7 @@ Update a singleton item.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /items/:collection`
@@ -673,7 +673,7 @@ Returns an [item object](#the-item-object) if a valid primary key was provided.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /items/about`
@@ -721,7 +721,7 @@ Update multiple items at the same time.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /items/:collection`
@@ -767,7 +767,7 @@ Returns the [item objects](#the-item-object) for the updated items.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /items/articles`
@@ -819,7 +819,7 @@ Delete an existing item.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /items/:collection/:id`
@@ -855,7 +855,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /items/articles/15`
@@ -891,7 +891,7 @@ const result = await client.request(deleteItem('articles', '5'));
Delete multiple existing items.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /items/:collection`
@@ -941,7 +941,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /items/articles`

28
docs/reference/query.md
View File

@@ -59,7 +59,7 @@ sections.item:videos.source
In GraphQL, this can be achieved using Union Types.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -152,7 +152,7 @@ filter the related items themselves, take a look at [the `deep` parameter](#deep
:::
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -232,7 +232,7 @@ root item's fields, related item fields are not included.
Find all items that mention Directus\
`Directus`
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`?search=Directus`
@@ -283,7 +283,7 @@ Sort by a "sort" field, followed by publish date descending\
Sort by a "sort" field, followed by a nested author's name\
`sort, -author.name`
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -344,7 +344,7 @@ with caution.
:::
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`?limit=200`
@@ -387,7 +387,7 @@ Skip the first `n` items in the response. Can be used for pagination.
Get items 101—200\
`100`
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`?offset=100`
@@ -434,7 +434,7 @@ Get items 1-100\
Get items 101-200\
`2`
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`?page=2`
@@ -486,7 +486,7 @@ The following aggregation functions are available in Directus:
| `max` | Return the highest value in the field |
| `countAll` | Equivalent to `?aggregate[count]=*` (GraphQL only) |
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -531,7 +531,7 @@ value. This allows for things like _"Average rating per month"_ or _"Total sales
The `groupBy` query allows for grouping on multiple fields simultaneously. Combined with the [Functions](#functions),
this allows for aggregate reporting per year-month-date.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -606,7 +606,7 @@ Only get 3 related articles, with only the top rated comment nested
}
```
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -670,7 +670,7 @@ Alias for nested fields, f.e. `field.nested`, will not work.
:::
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -734,7 +734,7 @@ Save the current API response to a file.
Saves the API response to a file. Accepts one of `csv`, `json`, `xml`, `yaml`.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -796,7 +796,7 @@ function name as the nested field (see the example that follows).
:::
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -867,7 +867,7 @@ For more details, see: [Aggregation & Grouping](#aggregation-grouping)
:::
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```

20
docs/reference/system/activity.md
View File

@@ -62,7 +62,7 @@ Returns a list of activity actions.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /activity`
@@ -109,7 +109,7 @@ data will be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /activity`
@@ -151,7 +151,7 @@ Returns a single activity action by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /activity/:id`
@@ -191,7 +191,7 @@ Returns an [activity object](#the-activity-object) if a valid identifier was pro
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /activity/15`
@@ -233,7 +233,7 @@ Creates a new comment on a given item.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /activity/comment`
@@ -294,7 +294,7 @@ Returns the [activity object](#the-activity-object) of the created comment.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /activity/comment`
@@ -346,7 +346,7 @@ Updates an existing comment by activity action primary key.
### Response
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /activity/comment/:id`
@@ -397,7 +397,7 @@ Returns the [activity object](#the-activity-object) of the created comment.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /activity/comment/15`
@@ -446,7 +446,7 @@ Deletes a comment.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /activity/comment/:id`
@@ -478,7 +478,7 @@ const result = await client.request(deleteComment(comment_id));
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /activity/comment/15`

20
docs/reference/system/collections.md
View File

@@ -148,7 +148,7 @@ List the available collections.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /collections`
@@ -194,7 +194,7 @@ An array of [collection objects](#the-collection-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /collections`
@@ -234,7 +234,7 @@ Retrieve a single collection by table name.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /collections/:collection`
@@ -274,7 +274,7 @@ A [collection object](#the-collection-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /collections/articles`
@@ -312,7 +312,7 @@ Create a new Collection. This will create a new table in the database as well.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /collections`
@@ -381,7 +381,7 @@ The [collection object](#the-collection-object) for the collection created in th
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /collections`
@@ -435,7 +435,7 @@ Update the metadata for an existing collection.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /collections/:collection`
@@ -482,7 +482,7 @@ The [collection object](#the-collection-object) for the updated collection in th
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /collections/testimonials`
@@ -540,7 +540,7 @@ Be aware, this will delete the table from the database, including all items in i
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /collections/:collection`
@@ -572,7 +572,7 @@ const result = await client.request(deleteCollection(collection_name));
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /collections/articles`

32
docs/reference/system/dashboards.md
View File

@@ -55,7 +55,7 @@ List all dashboards that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /dashboards`
@@ -102,7 +102,7 @@ data will be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /dashboards`
@@ -147,7 +147,7 @@ List an existing dashboard by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /dashboards/:id`
@@ -187,7 +187,7 @@ Returns the requested [dashboard object](#the-dashboard-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /dashboards/2fc325fb-299b-4d20-a9e7-a34349dee8b2`
@@ -228,7 +228,7 @@ Create a new dashboard.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /dashboards`
@@ -274,7 +274,7 @@ Returns the [dashboard object](#the-dashboard-object) for the created dashboard.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /dashboards`
@@ -325,7 +325,7 @@ Create multiple new dashboards.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /dashboards`
@@ -371,7 +371,7 @@ Returns the [dashboard object](#the-dashboard-object) for the created dashboard.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /dashboards`
@@ -436,7 +436,7 @@ Update an existing dashboard.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /dashboards/:id`
@@ -482,7 +482,7 @@ Returns the [dashboard object](#the-dashboard-object) for the updated dashboard.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /dashboards/2fc325fb-299b-4d20-a9e7-a34349dee8b2`
@@ -531,7 +531,7 @@ Update multiple existing dashboards.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /dashboards`
@@ -586,7 +586,7 @@ Returns the [dashboard objects](#the-dashboard-object) for the updated dashboard
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /dashboards`
@@ -641,7 +641,7 @@ Delete an existing dashboard.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /dashboards/:id`
@@ -677,7 +677,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /dashboards/12204ee2-2c82-4d9a-b044-2f4842a11dba`
@@ -715,7 +715,7 @@ Delete multiple existing dashboards.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /dashboards`
@@ -757,7 +757,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /dashboards`

4
docs/reference/system/extensions.md
View File

@@ -16,7 +16,7 @@ List the available extensions in the project. The types of extensions that you c
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /extensions/:type`
@@ -56,7 +56,7 @@ An array of interface extension keys.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /extensions/interfaces`

24
docs/reference/system/fields.md
View File

@@ -154,7 +154,7 @@ List the available fields.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /fields`
@@ -194,7 +194,7 @@ An array of [field objects](#the-field-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /fields`
@@ -233,7 +233,7 @@ List the available fields in a given collection.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /fields/:collection`
@@ -273,7 +273,7 @@ An array of [field objects](#the-field-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /fields/articles`
@@ -312,7 +312,7 @@ Get a single field in a given collection.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /fields/:collection/:field`
@@ -352,7 +352,7 @@ A [field object](#the-field-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /fields/articles/title`
@@ -391,7 +391,7 @@ Create a new field in the given collection.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /fields/:collection`
@@ -455,7 +455,7 @@ The [field object](#the-field-object) for the created field.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /fields/articles`
@@ -517,7 +517,7 @@ const result = await client.request(
Updates the given field in the given collection.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /fields/articles/title`
@@ -579,7 +579,7 @@ The [field object](#the-field-object) for the updated field.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /fields/articles/title`
@@ -645,7 +645,7 @@ Be aware, this will delete the column from the database, including all data in i
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /fields/:collection/:field`
@@ -677,7 +677,7 @@ const result = await client.request(deleteField(collection_name, field_name));
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /fields/articles/title`

40
docs/reference/system/flows.md
View File

@@ -68,7 +68,7 @@ List all flows that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /flows`
@@ -114,7 +114,7 @@ be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /flows`
@@ -161,7 +161,7 @@ List an existing flow by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /flows/:id`
@@ -201,7 +201,7 @@ Returns the requested [flow object](#the-flow-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2`
@@ -245,7 +245,7 @@ Create a new flow.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /flows`
@@ -291,7 +291,7 @@ Returns the [flow object](#the-flow-object) for the created flow.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /flows`
@@ -344,7 +344,7 @@ Create multiple new flows.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /flows`
@@ -390,7 +390,7 @@ Returns the [flow object](#the-flow-object) for the created flow.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /flows`
@@ -461,7 +461,7 @@ Update an existing flow.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /flows/:id`
@@ -507,7 +507,7 @@ Returns the [flow object](#the-flow-object) for the updated flow.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2`
@@ -556,7 +556,7 @@ Update multiple existing flows.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /flows`
@@ -611,7 +611,7 @@ Returns the [flow objects](#the-flow-object) for the updated flows.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /flows`
@@ -667,7 +667,7 @@ Delete an existing flow.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /flows/:id`
@@ -703,7 +703,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /flows/12204ee2-2c82-4d9a-b044-2f4842a11dba`
@@ -741,7 +741,7 @@ Delete multiple existing flows.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /flows`
@@ -783,7 +783,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /flows`
@@ -833,7 +833,7 @@ Start a flow with GET webhook trigger.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /flows/trigger/:flow_uuid`
@@ -858,7 +858,7 @@ Result of the flow, if any.
### Example
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`GET /flows/trigger/202a940b-a00b-47df-b832-369c53f13122`
@@ -887,7 +887,7 @@ Start a flow with POST webhook trigger.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /flows/trigger/:flow_uuid`
@@ -916,7 +916,7 @@ Result of the flow, if any.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /flows/trigger/202a940b-a00b-47df-b832-369c53f13122`

32
docs/reference/system/folders.md
View File

@@ -36,7 +36,7 @@ List all folders that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /folders`
@@ -83,7 +83,7 @@ will be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /folders`
@@ -127,7 +127,7 @@ List an existing folder by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /folders/:id`
@@ -167,7 +167,7 @@ Returns a [folder object](#the-folder-object) if a valid primary key was provide
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /folders/fc02d733-95b8-4e27-bd4b-08a32cbe4e66`
@@ -209,7 +209,7 @@ Create a new (virtual) folder.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /folders`
@@ -255,7 +255,7 @@ Returns the [folder object](#the-folder-object) of the folder that was created.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /folders`
@@ -304,7 +304,7 @@ Create multiple new (virtual) folders.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /folders`
@@ -350,7 +350,7 @@ Returns the [folder object](#the-folder-object) of the folder that was created.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /folders`
@@ -409,7 +409,7 @@ Update an existing folder.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /folders/:id`
@@ -455,7 +455,7 @@ Returns the [folder object](#the-folder-object) of the folder that was updated.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /folders/fac21847-d5ce-4e4b-a288-9abafbdfbc87`
@@ -507,7 +507,7 @@ Update multiple existing folders.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /folders`
@@ -562,7 +562,7 @@ Returns the [folder objects](#the-folder-object) of the folders that were update
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /folders`
@@ -623,7 +623,7 @@ Any files in this folder will be moved to the root folder.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /folders/:id`
@@ -659,7 +659,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /folders/a5bdb793-dd85-4ac9-882a-b42862092983`
@@ -703,7 +703,7 @@ Any files in these folders will be moved to the root folder.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /folders`
@@ -745,7 +745,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /folders`

32
docs/reference/system/notifications.md
View File

@@ -57,7 +57,7 @@ List all notifications that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /notifications`
@@ -104,7 +104,7 @@ available, data will be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /notifications`
@@ -150,7 +150,7 @@ List an existing notification by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /notifications/:id`
@@ -190,7 +190,7 @@ Returns the requested [notification object](#the-notification-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /notifications/42`
@@ -234,7 +234,7 @@ Create a new notification.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /notifications`
@@ -280,7 +280,7 @@ Returns the [notification object](#the-notification-object) for the created noti
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /notifications`
@@ -332,7 +332,7 @@ Create multiple new notifications.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /notifications`
@@ -378,7 +378,7 @@ Returns the [notification object](#the-notification-object) for the created noti
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /notifications`
@@ -465,7 +465,7 @@ notification email to be sent.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /notifications/:id`
@@ -511,7 +511,7 @@ Returns the [notification object](#the-notification-object) for the updated noti
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /notifications/34`
@@ -560,7 +560,7 @@ Update multiple existing notifications.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /notifications`
@@ -615,7 +615,7 @@ Returns the [notification objects](#the-notification-object) for the updated not
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /notifications`
@@ -667,7 +667,7 @@ Delete an existing notification.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /notifications/:id`
@@ -703,7 +703,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /notifications/34`
@@ -741,7 +741,7 @@ Delete multiple existing notifications.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /notifications`
@@ -783,7 +783,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /notifications`

36
docs/reference/system/operations.md
View File

@@ -71,7 +71,7 @@ List all operations that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /operations`
@@ -118,7 +118,7 @@ data will be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /operations`
@@ -162,7 +162,7 @@ const result = await client.request(
List an existing operation by primary key.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /operations/:id`
@@ -204,7 +204,7 @@ Returns the requested [operation object](#the-operation-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /operations/3c636d1c-4eb2-49cd-8a6d-3ec571ab3390`
@@ -246,7 +246,7 @@ const result = await client.request(
Create a new operation.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /operations`
@@ -294,7 +294,7 @@ Returns the [operation object](#the-operation-object) for the created operation.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /operations`
@@ -350,7 +350,7 @@ Create multiple new operations.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /operations`
@@ -411,7 +411,7 @@ Returns the [operation object](#the-operation-object) for the created operation.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /operations`
@@ -488,7 +488,7 @@ Update an existing operation.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /operation/:id`
@@ -534,7 +534,7 @@ Returns the [operation object](#the-operation-object) for the updated operation.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /operation/7d62f1e9-a83f-407b-84f8-1c184f014501`
@@ -581,7 +581,7 @@ const result = await client.request(
Update multiple existing operations.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /operations`
@@ -636,7 +636,7 @@ Returns the [operation objects](#the-operation-object) for the updated operation
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /operations`
@@ -692,7 +692,7 @@ Delete an existing operation.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /operations/:id`
@@ -728,7 +728,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /operations/07ac467e-1900-4c62-9637-8dac2ab97f71`
@@ -764,7 +764,7 @@ Delete multiple existing operations.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /operations`
@@ -806,7 +806,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /operations`
@@ -856,7 +856,7 @@ Trigger an operation based on primary key.
### Request
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`POST /operations/trigger/:operation_uuid`
@@ -885,7 +885,7 @@ Result of the operation, if any.
### Example
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`POST /flows/trigger/202a940b-a00b-47df-b832-369c53f13122`

32
docs/reference/system/panels.md
View File

@@ -84,7 +84,7 @@ List all panels that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /panels`
@@ -131,7 +131,7 @@ will be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /panels`
@@ -176,7 +176,7 @@ List an existing panel by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /panels/:id`
@@ -216,7 +216,7 @@ Returns the requested [panel object](#the-panel-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /panels/2fc325fb-299b-4d20-a9e7-a34349dee8b2`
@@ -259,7 +259,7 @@ Create a new panel.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /panels`
@@ -305,7 +305,7 @@ Returns the [panel object](#the-panel-object) for the created panel.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /panels`
@@ -361,7 +361,7 @@ Create multiple new panels.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /panels`
@@ -407,7 +407,7 @@ Returns the [panel object](#the-panel-object) for the created panel.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /panels`
@@ -480,7 +480,7 @@ Update an existing panel.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /panels/:id`
@@ -526,7 +526,7 @@ Returns the [panel object](#the-panel-object) for the updated panel.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /panels/2fc325fb-299b-4d20-a9e7-a34349dee8b2`
@@ -576,7 +576,7 @@ Update multiple existing panels.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /panels`
@@ -631,7 +631,7 @@ Returns the [panel objects](#the-panel-object) for the updated panels.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /panels`
@@ -686,7 +686,7 @@ Delete an existing panel.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /panels/:id`
@@ -722,7 +722,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /panels/12204ee2-2c82-4d9a-b044-2f4842a11dba`
@@ -760,7 +760,7 @@ Delete multiple existing panels.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /panels`
@@ -802,7 +802,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /panels`

32
docs/reference/system/permissions.md
View File

@@ -67,7 +67,7 @@ other than the current user's role won't be returned.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /permissions`
@@ -114,7 +114,7 @@ available, data will be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /permissions`
@@ -160,7 +160,7 @@ List an existing permission by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /permissions/:id`
@@ -200,7 +200,7 @@ Returns the requested [permission object](#the-permission-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /permissions/34`
@@ -244,7 +244,7 @@ Create a new permission rule
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /permissions`
@@ -290,7 +290,7 @@ Returns the [permission object](#the-permission-object) for the created permissi
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /permissions`
@@ -348,7 +348,7 @@ Create multiple new permission rules
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /permissions`
@@ -394,7 +394,7 @@ Returns the [permission objects](#the-permission-object) for the created permiss
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /permissions`
@@ -471,7 +471,7 @@ Update an existing permissions rule.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /permissions/:id`
@@ -517,7 +517,7 @@ Returns the [permission object](#the-permission-object) for the updated permissi
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /permissions/34`
@@ -565,7 +565,7 @@ Update multiple existing permissions rules.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /permissions`
@@ -620,7 +620,7 @@ Returns the [permission object](#the-permission-object) for the updated permissi
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /permissions`
@@ -671,7 +671,7 @@ Delete an existing permissions rule
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /permissions/:id`
@@ -707,7 +707,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /permissions/34`
@@ -745,7 +745,7 @@ Delete multiple existing permissions rules
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /permissions`
@@ -787,7 +787,7 @@ Empty body.
##### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /permissions`

32
docs/reference/system/presets.md
View File

@@ -84,7 +84,7 @@ other than the current user's role won't be returned.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /presets`
@@ -131,7 +131,7 @@ will be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /presets`
@@ -176,7 +176,7 @@ List an existing preset by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
GET /presets/:id
@@ -216,7 +216,7 @@ Returns the requested [preset object](#the-preset-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /presets/42`
@@ -259,7 +259,7 @@ Create a new preset.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /presets`
@@ -305,7 +305,7 @@ Returns the [preset object](#the-preset-object) for the created preset.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /presets`
@@ -357,7 +357,7 @@ Create multiple new presets.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /presets`
@@ -403,7 +403,7 @@ Returns the [preset object](#the-preset-object) for the created preset.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /presets`
@@ -479,7 +479,7 @@ Update an existing preset.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /presets/:id`
@@ -525,7 +525,7 @@ Returns the [preset object](#the-preset-object) for the updated preset.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /presets/34`
@@ -574,7 +574,7 @@ Update multiple existing presets.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /presets`
@@ -629,7 +629,7 @@ Returns the [preset objects](#the-preset-object) for the updated presets.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /presets`
@@ -681,7 +681,7 @@ Delete an existing preset.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /presets/:id`
@@ -717,7 +717,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /presets/34`
@@ -755,7 +755,7 @@ Delete multiple existing presets.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /presets`
@@ -797,7 +797,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /presets`

24
docs/reference/system/relations.md
View File

@@ -122,7 +122,7 @@ to a collection that the current user doesn't have access to are stripped out.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /relations`
@@ -162,7 +162,7 @@ Array of [relation objects](#the-relation-object). If no items are available, da
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /relations`
@@ -212,7 +212,7 @@ to a collection that the current user doesn't have access to are stripped out.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /relations/:collection`
@@ -252,7 +252,7 @@ Array of [relation objects](#the-relation-object). If no items are available, da
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /relations/articles`
@@ -295,7 +295,7 @@ List an existing relation by collection/field name.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /relations/:collection/:field`
@@ -335,7 +335,7 @@ Returns the requested [relation object](#the-relation-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /relations/articles/featured_image`
@@ -379,7 +379,7 @@ Create a new relation.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /relations`
@@ -425,7 +425,7 @@ Returns the [relation object](#the-relation-object) for the created relation.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /relations`
@@ -481,7 +481,7 @@ Update an existing relation.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /relations/:collection/:field`
@@ -527,7 +527,7 @@ Returns the [relation object](#the-relation-object) for the created relation.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /relations/articles/author`
@@ -581,7 +581,7 @@ Delete an existing relation.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /relations/:collection/:field`
@@ -617,7 +617,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /relations/articles/author`

8
docs/reference/system/revisions.md
View File

@@ -61,7 +61,7 @@ to a collection that the current user doesn't have access to are stripped out.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /revisions`
@@ -108,7 +108,7 @@ data will be an empty array.
### Examples
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /revisions`
@@ -154,7 +154,7 @@ List an existing revision by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /revisions/:id`
@@ -194,7 +194,7 @@ Returns the requested [revision object](#the-revision-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /revisions/322`

32
docs/reference/system/roles.md
View File

@@ -58,7 +58,7 @@ List all roles that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /roles`
@@ -105,7 +105,7 @@ be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /roles`
@@ -151,7 +151,7 @@ const result = await client.request(
List an existing role by primary key.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /roles/:id`
@@ -191,7 +191,7 @@ Returns the requested [role object](#the-role-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /roles/b4cb3b64-8580-4ad9-a099-eade6da24302`
@@ -237,7 +237,7 @@ Create a new role.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /roles`
@@ -283,7 +283,7 @@ Returns the [role object](#the-role-object) for the created role.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /roles`
@@ -345,7 +345,7 @@ Create multiple new roles.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /roles`
@@ -391,7 +391,7 @@ Returns the [role objects](#the-role-object) for the created roles.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /roles`
@@ -474,7 +474,7 @@ Update an existing role.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /roles/:id`
@@ -520,7 +520,7 @@ Returns the [role object](#the-role-object) for the updated role.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7`
@@ -572,7 +572,7 @@ Update multiple existing roles.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /roles`
@@ -627,7 +627,7 @@ Returns the [role objects](#the-role-object) for the updated roles.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /roles`
@@ -685,7 +685,7 @@ Delete an existing role.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /roles/:id`
@@ -721,7 +721,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7`
@@ -759,7 +759,7 @@ Delete multiple existing roles.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /roles`
@@ -801,7 +801,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /roles`

10
docs/reference/system/schema.md
View File

@@ -14,7 +14,7 @@ Retrieve the current schema. This endpoint is only available to admin users.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -57,7 +57,7 @@ query parameter is used.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
```
@@ -104,7 +104,7 @@ unintentional diffs from being generated. You can opt in to bypass these checks
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
::: details **Toggle Open to See Request**
@@ -408,7 +408,7 @@ Returns the differences between the current instance's schema and the schema pas
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
::: details **Toggle Open to See Example Request**
@@ -707,7 +707,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
::: details **Toggle Open to See Sample Body**

20
docs/reference/system/server.md
View File

@@ -21,7 +21,7 @@ This OAS spec is based on the read permissions of the currently authenticated us
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /server/specs/oas`
@@ -57,7 +57,7 @@ Object conforming to [the OpenAPI Specification](https://swagger.io/specificatio
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /server/specs/oas`
@@ -97,7 +97,7 @@ The SDL is based on the permissions of the currently authenticated user.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /server/specs/graphql/`
@@ -157,7 +157,7 @@ type articles {
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /server/specs/graphql/`
@@ -195,7 +195,7 @@ Ping... pong! 🏓
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /server/ping`
@@ -231,7 +231,7 @@ Pong.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /server/ping`
@@ -273,7 +273,7 @@ The public information is returned for everybody. Admin users get additional inf
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /server/info`
@@ -330,7 +330,7 @@ The maximum query limit accepted on API requests
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /server/info`
@@ -438,7 +438,7 @@ return more in-depth information about the current health status of the system.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /server/health`
@@ -486,7 +486,7 @@ Array with the status of all individually connected services.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /server/health`

8
docs/reference/system/settings.md
View File

@@ -113,7 +113,7 @@ Custom aspect ratios in the [image editor](/user-guide/file-library/files#edit-a
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /settings`
@@ -153,7 +153,7 @@ Returns the [settings object](#the-settings-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /settings`
@@ -189,7 +189,7 @@ const result = await client.request(readSettings());
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /settings`
@@ -235,7 +235,7 @@ Returns the [settings object](#the-setting-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /settings`

44
docs/reference/system/shares.md
View File

@@ -69,7 +69,7 @@ List all shares that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /shares`
@@ -116,7 +116,7 @@ will be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /shares`
@@ -161,7 +161,7 @@ const result = await client.request(
List an existing share by primary key.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /shares/:id`
@@ -201,7 +201,7 @@ Returns the requested [share object](#the-share-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /shares/b4cb3b64-8580-4ad9-a099-eade6da24302`
@@ -246,7 +246,7 @@ Create a new share.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /shares`
@@ -292,7 +292,7 @@ Returns the [share object](#the-share-object) for the created share.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /shares`
@@ -349,7 +349,7 @@ Create multiple new shares.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /shares`
@@ -395,7 +395,7 @@ Returns the [share objects](#the-share-object) for the created shares.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /shares`
@@ -478,7 +478,7 @@ Update an existing share.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /shares/:id`
@@ -524,7 +524,7 @@ Returns the [share object](#the-share-object) for the updated share.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /shares/c86c2761-65d3-43c3-897f-6f74ad6a5bd7`
@@ -575,7 +575,7 @@ Update multiple existing shares.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /shares`
@@ -630,7 +630,7 @@ Returns the [share objects](#the-share-object) for the updated shares.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /shares`
@@ -687,7 +687,7 @@ Delete an existing share.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /shares/:id`
@@ -723,7 +723,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /shares/c86c2761-65d3-43c3-897f-6f74ad6a5bd7`
@@ -761,7 +761,7 @@ Delete multiple existing shares.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /shares`
@@ -803,7 +803,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /shares`
@@ -850,7 +850,7 @@ with the credentials set returned by this endpoint.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /shares/auth`
@@ -903,7 +903,7 @@ as the mode in the request, the refresh token won't be returned in the JSON.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /shares/auth`
@@ -940,7 +940,7 @@ Sends an email to the provided email addresses with a link to the share.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /shares/invite`
@@ -985,7 +985,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /shares/invite`
@@ -1022,7 +1022,7 @@ const result = await client.request(
Allows unauthenticated users to retrieve information about the share.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /shares/info/:id`
@@ -1052,7 +1052,7 @@ The [share objects](#the-share-object) for the given UUID, if it's still valid.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /shares/info/653925a9-970e-487a-bfc0-ab6c96affcdc`

32
docs/reference/system/translations.md
View File

@@ -37,7 +37,7 @@ List all translations that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`GET /translations`
@@ -73,7 +73,7 @@ available, data will be an empty array.
### Example
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`GET /translations`
@@ -104,7 +104,7 @@ List an existing translation by primary key.
### Request
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`GET /translations/:id`
@@ -133,7 +133,7 @@ Returns the requested [translation object](#the-translations-object).
### Example
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`GET /translations/2fc325fb-299b-4d20-a9e7-a34349dee8b2`
@@ -162,7 +162,7 @@ Create a new translation.
### Request
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`POST /translations`
@@ -197,7 +197,7 @@ Returns the [translation object](#the-translations-object) for the created trans
### Example
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`POST /translations`
@@ -236,7 +236,7 @@ Create multiple new translation.
### Request
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`POST /translations`
@@ -271,7 +271,7 @@ Returns the [translation object](#the-translations-object) for the created trans
### Example
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`POST /translations`
@@ -324,7 +324,7 @@ Update an existing translation.
### Request
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`PATCH /translations/:id`
@@ -359,7 +359,7 @@ Returns the [translation object](#the-translations-object) for the updated trans
### Example
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`PATCH /translations/2fc325fb-299b-4d20-a9e7-a34349dee8b2`
@@ -394,7 +394,7 @@ Update multiple existing translations.
### Request
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`PATCH /translations`
@@ -438,7 +438,7 @@ Returns the [translation objects](#the-translations-object) for the updated tran
### Example
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`PATCH /translations`
@@ -476,7 +476,7 @@ Delete an existing translation.
### Request
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`DELETE /translations/:id`
@@ -501,7 +501,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`DELETE /translations/12204ee2-2c82-4d9a-b044-2f4842a11dba`
@@ -526,7 +526,7 @@ Delete multiple existing translations.
### Request
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`DELETE /translations`
@@ -557,7 +557,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'SDK']" group="api">
<template #rest>
`DELETE /translations`

60
docs/reference/system/users.md
View File

@@ -107,7 +107,7 @@ List all users that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /users`
@@ -154,7 +154,7 @@ be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /users`
@@ -198,7 +198,7 @@ List an existing user by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /users/:id`
@@ -238,7 +238,7 @@ Returns the requested [user object](#the-user-object).
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /users/72a1ce24-4748-47de-a05f-ce9af3033727`
@@ -282,7 +282,7 @@ Retrieve the currently authenticated user.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /users/me`
@@ -322,7 +322,7 @@ Returns the [user object](#the-user-object) for the currently authenticated user
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /users/me`
@@ -362,7 +362,7 @@ Update the authenticated user.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /users/me`
@@ -404,7 +404,7 @@ Returns the updated [user object](#the-user-object) for the authenticated user.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /users/me`
@@ -452,7 +452,7 @@ Create a new user
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users`
@@ -500,7 +500,7 @@ Returns the [user object](#the-user-object) for the created user.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users`
@@ -566,7 +566,7 @@ Create multiple new users
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users`
@@ -614,7 +614,7 @@ Returns the [user objects](#the-user-object) for the created users.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users`
@@ -700,7 +700,7 @@ Update an existing user.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /users/:id`
@@ -746,7 +746,7 @@ Returns the [user object](#the-user-object) for the updated user.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /users/72a1ce24-4748-47de-a05f-ce9af3033727`
@@ -795,7 +795,7 @@ Update multiple existing users.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /users`
@@ -850,7 +850,7 @@ Returns the [user objects](#the-user-object) for the updated users.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /users`
@@ -905,7 +905,7 @@ Delete an existing user.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /users/:id`
@@ -941,7 +941,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /users/72a1ce24-4748-47de-a05f-ce9af3033727`
@@ -979,7 +979,7 @@ Delete multiple existing users.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /users`
@@ -1021,7 +1021,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /users`
@@ -1063,7 +1063,7 @@ Invite a new user by email.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users/invite`
@@ -1119,7 +1119,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users/invite`
@@ -1164,7 +1164,7 @@ This link includes a token, which is then used to activate the invited user.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users/invisponse/accept`
@@ -1215,7 +1215,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users/invite/accept`
@@ -1256,7 +1256,7 @@ Generates a secret and returns the URL to be used in an authenticator app.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users/me/tfa/generate`
@@ -1307,7 +1307,7 @@ OTP secret to be saved in the authenticator app.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users/me/tfa/generate`
@@ -1352,7 +1352,7 @@ Adds a TFA secret to the user account.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users/me/tfa/enable`
@@ -1403,7 +1403,7 @@ Empty response.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users/me/tfa/enable`
@@ -1446,7 +1446,7 @@ Disables two-factor authentication by removing the OTP secret from the user.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users/me/tfa/disable`
@@ -1493,7 +1493,7 @@ Empty response.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /users/me/tfa/disable`

20
docs/reference/system/utilities.md
View File

@@ -14,7 +14,7 @@ Generate a hash for a given string.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /utils/hash/generate`
@@ -61,7 +61,7 @@ Hashed string.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /utils/hash/generate`
@@ -101,7 +101,7 @@ Verify a string with a hash.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /utils/hash/verify`
@@ -152,7 +152,7 @@ Boolean.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /utils/hash/verify`
@@ -200,7 +200,7 @@ If a collection has a sort field, this util can be used to move items in that ma
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /utils/sort/articles`
@@ -251,7 +251,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /utils/sort/articles`
@@ -294,7 +294,7 @@ Import multiple records from a JSON or CSV file into a collection.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /utils/import/:collection`
@@ -341,7 +341,7 @@ Export a larger data set to a file in the File Library
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /utils/export/:collection`
@@ -418,7 +418,7 @@ Empty body
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /utils/export/articles`
@@ -478,7 +478,7 @@ const result = await client.request(
Resets both the data and schema cache of Directus. This endpoint is only available to admin users.
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /utils/cache/clear`

32
docs/reference/system/webhooks.md
View File

@@ -56,7 +56,7 @@ List all webhooks that exist in Directus.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /webhooks`
@@ -103,7 +103,7 @@ data will be an empty array.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /webhooks`
@@ -148,7 +148,7 @@ List an existing webhook by primary key.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /webhooks/:id`
@@ -188,7 +188,7 @@ Returns the requested [webhook object](#the-webhook-object).
### Examples
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`GET /webhooks/15`
@@ -232,7 +232,7 @@ Create a new webhook.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /webhooks`
@@ -280,7 +280,7 @@ Returns the [webhook object](#the-webhook-object) for the created webhook.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /webhooks`
@@ -338,7 +338,7 @@ Create multiple new webhooks.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /webhooks`
@@ -386,7 +386,7 @@ Returns the [webhook objects](#the-webhook-object) for the created webhooks.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`POST /webhooks`
@@ -464,7 +464,7 @@ Update an existing webhook.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /webhooks/:id`
@@ -510,7 +510,7 @@ Returns the [webhook object](#the-webhook-object) for the updated webhook.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /webhooks/15`
@@ -558,7 +558,7 @@ Update multiple existing webhooks.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /webhooks`
@@ -615,7 +615,7 @@ Returns the [webhook objects](#the-webhook-object) for the updated webhooks.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`PATCH /webhooks`
@@ -666,7 +666,7 @@ Delete an existing webhook.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /webhooks/:id`
@@ -702,7 +702,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /webhooks/15`
@@ -740,7 +740,7 @@ Delete multiple existing webhooks.
### Request
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /webhooks`
@@ -782,7 +782,7 @@ Empty body.
### Example
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" label="API">
<SnippetToggler :choices="['REST', 'GraphQL', 'SDK']" group="api">
<template #rest>
`DELETE /webhooks`