Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions openapi/index.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
openapi: '3.0.1'
openapi: "3.0.1"
info:
title: Directus API Reference
description: This is a dynamically generated API specification for all endpoints existing on the current project!
version: '11.1.0'
version: "11.14.0"
license:
name: Business Source License 1.1 (BUSL-1.1)
url: https://github.com/directus/directus/blob/main/license
Expand All @@ -17,6 +17,10 @@ paths:
$ref: paths/activity/_id/index.yaml
"/assets/{id}":
$ref: paths/assets/_id/index.yaml
"/assets/folder/{id}":
$ref: paths/assets/_folder/index.yaml
"/assets/files/":
$ref: paths/assets/_files/index.yaml
"/auth/login":
$ref: paths/auth/login/index.yaml
"/auth/logout":
Expand Down
2 changes: 2 additions & 0 deletions openapi/paths/assets/_folder/index.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
get:
$ref: zipFolder.yaml
34 changes: 34 additions & 0 deletions openapi/paths/assets/_folder/zipFolder.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
summary: ZIP folder
security: []
tags:
- Assets
operationId: zipFolder
description: ZIP folder
parameters:
- name: id
in: path
description: The id of the folder.
required: true
schema:
type: string
responses:
"200":
description: Successful request
content:
text/plain:
schema:
type: string
"404":
$ref: ../../../components/responses.yaml#/NotFoundError
x-codeSamples:
- label: Directus SDK
lang: JavaScript
source: |
import { createDirectus, rest, downloadFolderZip } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(downloadFolderZip('<folder-id>'));
- label: GraphQL
lang: GraphQL
source: Not available in Directus SDK/GraphQL
2 changes: 2 additions & 0 deletions openapi/paths/assets/files/index.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
get:
$ref: zipFiles.yaml
34 changes: 34 additions & 0 deletions openapi/paths/assets/files/zipFiles.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
summary: ZIP files
security: []
tags:
- Assets
operationId: zipFiles
description: ZIP files
requestBody:
content:
application/json:
ids:
type: array
items:
type: string
responses:
"200":
description: Successful request
content:
text/plain:
schema:
type: string
"404":
$ref: ../../../components/responses.yaml#/NotFoundError
x-codeSamples:
- label: Directus SDK
lang: JavaScript
source: |
import { createDirectus, rest, downloadFilesZip } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(downloadFilesZip(['<file-id>','<file-id']));
- label: GraphQL
lang: GraphQL
source: Not available in Directus SDK/GraphQL