Document file upload element for interactive dialogs#1509
Conversation
|
Newest code from mattermost has been published to preview environment for Git SHA 9c5dfe4 |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds documentation for a new ChangesFile element support documentation
🎯 2 (Simple) | ⏱️ ~8 minutes Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
site/content/integrate/plugins/interactive-dialogs/_index.md (1)
625-627: ⚡ Quick winAdd a minimum server version note for
fileelements.Most newer element capabilities in this doc are version-gated; adding the server-version floor here would prevent rollout confusion for self-hosted deployments.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@site/content/integrate/plugins/interactive-dialogs/_index.md` around lines 625 - 627, Add a minimum server-version note for the "File elements" section: update the "### File elements" block (and the accompanying `file` element example) to include a short server-version floor notice indicating the minimum self-hosted server release that supports `file` elements, placed directly under the heading (or immediately above the example) so readers see the version requirement before the example usage.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@site/content/integrate/plugins/interactive-dialogs/_index.md`:
- Around line 671-672: The docs now state a top-level file_ids in dialog
submissions but the OpenAPI schema for POST /api/v4/actions/dialogs/submit in
site/static/mattermost-openapi-v4.yaml doesn't include it; update the OpenAPI
operation schema to add a top-level file_ids array (type: array, items: string
or file ID schema) to match the published payload contract, ensuring the
request/response examples and any related components reflect this field, or
alternatively mark the docs as "integration webhook-only" in the markdown and
add a clear x-note in the OpenAPI entry to prevent codegen/SDK consumers from
assuming file_ids is part of the official API contract.
---
Nitpick comments:
In `@site/content/integrate/plugins/interactive-dialogs/_index.md`:
- Around line 625-627: Add a minimum server-version note for the "File elements"
section: update the "### File elements" block (and the accompanying `file`
element example) to include a short server-version floor notice indicating the
minimum self-hosted server release that supports `file` elements, placed
directly under the heading (or immediately above the example) so readers see the
version requirement before the example usage.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: a7f2b2fe-2732-4c9d-b9a6-c609503cea7f
📒 Files selected for processing (1)
site/content/integrate/plugins/interactive-dialogs/_index.md
|
Newest code from mattermost has been published to preview environment for Git SHA 835f1de |
|
Newest code from mattermost has been published to preview environment for Git SHA afd2222 |
Summary
Documents the new
fileelement type for interactive dialogsAdds to
integrate/plugins/interactive-dialogs:fileadded to the supported element-type list.allow_multiple)examples and the full field table (
display_name,name,type,optional,help_text,default,placeholder,allow_multiple).validation, automatic deduplication).
file_idsarray, withguidance to treat
file_idsas the authoritative source.file_idsadded to the dialog submission payload example.Related
Product PR:
Ticket Link
Fixes https://mattermost.atlassian.net/browse/MM-66109