directus / directus/docs

Documentation error: Request Body shows [undefined] in multiple endpoints

Open
#474 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
22
Forks
82
Avg merge
18h 49m
Merged PRs (30d)
4

Description

### Describe the Bug

In the official Directus documentation (example: https://directus.io/docs/api/utilities#export-data-to-a-file), the Request Body section incorrectly displays [undefined].

This issue is not limited to the export endpoint — it also occurs in other endpoints across the documentation, making it unclear what parameters are required.

When testing the endpoints, if required fields (such as "query") are not provided, the API responds with errors like:
Invalid payload. "query" is required

This indicates that the documentation is not showing the actual required body structure.

Expected behavior
- Documentation should display the correct request body schema for each endpoint.
- Required fields (e.g., "query") should be clearly indicated with their format.

Current behavior
- Request Body sections show [undefined].
- The API rejects requests when mandatory fields are missing.

### To Reproduce

Steps to Reproduce
1. Open Postman.
2. Make a request to the affected endpoint (e.g., export) using valid credentials.
3. Check the official documentation for the endpoint.
4. Observe that the Request Body is displayed as [undefined].
5. Send the request without "query" and see the error response.

### Directus Version

v11.8.0

### Hosting Strategy

Self-Hosted (Custom)

### Database

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.