Skip to content

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

Open

Description

@jscode-es

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

Activity

  1. linear commented on Oct 3, 2025

    @linear
  2. linear commented on Oct 3, 2025

    @linear
  3. joselcvarela commented on Oct 24, 2025

    @joselcvarela
    Member

    For the case of POST /utils/export/{collection} (Export Data to a File) it looks like the body requires query and format

  4. added a commit that references this issue on Apr 23, 2026
    41c3f7e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions