Skip to content

Expose mentions in the OpenAPI spec (currently hidden with @ApiHideProperty) #2268

Description

@Jeparre

mentions works on sendText, sendImage, sendFile, sendVideo and editMessage, but it is hidden from the OpenAPI spec with @ApiHideProperty() in src/structures/chatting.dto.ts.

It was hidden in Nov 2023 (aff3b01 "Hide mentions", 2d64b26 "Hide mentions from send message"), but it is clearly maintained today:

  • 1c41b8b (Nov 2025): mentions: ["all"] for /api/sendText in groups on WEBJS, GOWS and NOWEB
  • 869a343 (Nov 2025): mentions for send image, file and video

I tested it on WAHA 2026.8.2 with GOWS: POST /api/sendText with "mentions": ["<number>@c.us"] delivers the message with contextInfo.mentionedJID, and WhatsApp renders a clickable mention.

Because the field is not in the spec, clients generated from it can't offer it. For example, the n8n node (@devlikeapro/n8n-nodes-waha) is built from the OpenAPI file, so n8n users can't mention anyone without falling back to a raw HTTP Request.

Could mentions be documented in the spec (removing @ApiHideProperty())? If it was hidden on purpose (for example, engine limitations), a short note in the docs would also help.

Related n8n node PR: devlikeapro/n8n-nodes-waha#30

Activity

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