Document datetime_config nested property for interactive dialog fields by sbishel · Pull Request #1502 · mattermost/mattermost-developer-documentation

sbishel · 2026-04-20T23:13:09Z

Summary

Interactive dialog date and datetime elements now support a nested datetime_config object for grouping date/datetime configuration. This PR documents that structure and deprecates the equivalent top-level fields.

What's documented:

New datetime_config object (v11.6) with five properties: min_date, max_date, time_interval, location_timezone, allow_manual_time_entry
location_timezone and allow_manual_time_entry are new to the public docs — they let integrations pin the displayed timezone and enable manual text entry for the time
Precedence rule: when both legacy top-level fields and datetime_config.* are set, datetime_config wins
Backward compatibility note: existing integrations using top-level min_date / max_date / time_interval continue to work unchanged

Changes:

Updated the date and datetime spec tables — added datetime_config row, marked legacy fields as deprecated with replacement references
Rewrote all element examples (primary, usage, and the full end-to-end dialog example) to use datetime_config
Added a new location_timezone + allow_manual_time_entry usage example
New #### datetime_config object subsection with a full property table and the backward-compatibility note
Tightened validation/interval prose to reference datetime_config.time_interval

Paired with: server + webapp changes in mattermost/mattermost on branch interactive-dialog-property-update.
mattermost/mattermost#36067

Ticket Link

https://mattermost.atlassian.net/browse/MM-68388

Add documentation for the new datetime_config object on interactive dialog date and datetime elements, introduced in Mattermost v11.8. Adds spec for location_timezone and allow_manual_time_entry. Deprecates the top-level min_date, max_date, and time_interval fields in favor of the nested structure, with precedence when both are set, and retains a backward compatibility note. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

github-actions · 2026-04-20T23:14:28Z

Newest code from mattermost has been published to preview environment for Git SHA b5ca58e

hanzei

Awesome 🎉

github-actions · 2026-04-21T14:15:48Z

Newest code from mattermost has been published to preview environment for Git SHA 8baad30

…g docs Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

github-actions · 2026-04-21T16:55:58Z

Newest code from mattermost has been published to preview environment for Git SHA 094e3f6

coderabbitai · 2026-04-21T16:57:11Z

📝 Walkthrough

Walkthrough

Documentation update to the interactive dialogs schema: min_date, max_date, and time_interval for date/datetime elements are moved into a new nested datetime_config object; legacy top-level fields are marked deprecated; examples, validation guidance, and a new fixed-location timezone example were added and precedence clarified.

Changes

Cohort / File(s)	Summary
Interactive Dialogs Documentation `site/content/integrate/plugins/interactive-dialogs/_index.md`	Moved `min_date`/`max_date`/`time_interval` into a new `datetime_config` object for `date` and `datetime` elements; deprecated legacy top-level fields; added `datetime_config` section documenting `location_timezone`, `manual_time_entry` (and deprecated `allow_manual_time_entry`); updated examples (including fixed-location timezone with manual entry), validation guidance, time-interval references, and full dialog JSON payload to use `datetime_config`.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related issues

Interactive Dialog - DateTime manual entry and timezone support docs#8890: Matches this PR’s additions of datetime_config and the documentation of timezone/manual time-entry behavior for interactive dialog date/datetime elements.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: documenting the new datetime_config nested property for interactive dialog fields.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description check	✅ Passed	The pull request description clearly documents the new datetime_config nested object for interactive dialog date/datetime elements, deprecation of legacy fields, and backward compatibility.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch update-datetime-config

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@site/content/integrate/plugins/interactive-dialogs/_index.md`:
- Line 440: Update the three field description sentences that join two
independent clauses to include a comma before "but" for correct
compound-sentence punctuation; specifically edit the table cell containing the
`default` description ("Default value in ISO date format... Full ISO datetime
strings are accepted but only the date part is parsed; timezone information is
ignored.") and the two other similar field descriptions referenced around lines
445–446 so each "but" connecting independent clauses becomes ", but". Ensure
only punctuation is changed and wording remains otherwise identical.
- Around line 569-584: Update the "datetime_config object" section header to
read "Minimum Server Version: 11.8" instead of "11.6" so the heading matches the
documented introduction of the nested datetime_config object; locate the heading
text near the "datetime_config object" title and change the version number to
11.8.

🪄 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: 8a24dbb3-2ae4-4a30-8022-7b1c8ba940b5

📥 Commits

Reviewing files that changed from the base of the PR and between 7d6867e and 094e3f6.

📒 Files selected for processing (1)

site/content/integrate/plugins/interactive-dialogs/_index.md

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

github-actions · 2026-04-21T17:21:53Z

Newest code from mattermost has been published to preview environment for Git SHA 3ad3f28

github-actions · 2026-04-21T19:17:59Z

Newest code from mattermost has been published to preview environment for Git SHA e0d1acf

coderabbitai

🧹 Nitpick comments (1)

site/content/integrate/plugins/interactive-dialogs/_index.md (1)
569-584: Consider minor wording clarifications for improved readability.

The datetime_config object section is technically accurate and comprehensive. Two optional refinements for clarity:

Line 581 - The phrase "either enabling turns the feature on" could be slightly clearer: "When both are set, the feature is enabled if either is true."

Line 583 - The note "(new in 11.8)" refers to when the deprecation occurred, which might be clearer as "As of v11.8" or "Since v11.8".

These are minor stylistic suggestions; the current wording is functional and understandable.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@site/content/integrate/plugins/interactive-dialogs/_index.md` around lines
569 - 584, Update the wording in the datetime_config docs: change the sentence
about the deprecated field `allow_manual_time_entry` to read "When both are set,
the feature is enabled if either is `true`." (referencing `manual_time_entry`
and `allow_manual_time_entry`), and replace the parenthetical "(new in 11.8)"
with a clearer phrase such as "Since v11.8" or "As of v11.8" in the backward
compatibility note for `datetime_config`.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@site/content/integrate/plugins/interactive-dialogs/_index.md`:
- Around line 569-584: Update the wording in the datetime_config docs: change
the sentence about the deprecated field `allow_manual_time_entry` to read "When
both are set, the feature is enabled if either is `true`." (referencing
`manual_time_entry` and `allow_manual_time_entry`), and replace the
parenthetical "(new in 11.8)" with a clearer phrase such as "Since v11.8" or "As
of v11.8" in the backward compatibility note for `datetime_config`.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 55f4e51c-83f4-4153-aeb4-052608dc876e

📥 Commits

Reviewing files that changed from the base of the PR and between 094e3f6 and e0d1acf.

📒 Files selected for processing (1)

site/content/integrate/plugins/interactive-dialogs/_index.md

github-actions · 2026-04-23T15:24:52Z

Newest code from mattermost has been published to preview environment for Git SHA 0ad4749

github-actions · 2026-04-30T21:23:32Z

Newest code from mattermost has been published to preview environment for Git SHA 64449cf

github-actions · 2026-05-01T14:17:35Z

Newest code from mattermost has been published to preview environment for Git SHA 0167eab

github-actions · 2026-05-01T16:00:59Z

Newest code from mattermost has been published to preview environment for Git SHA d958fea

sbishel mentioned this pull request Apr 20, 2026

Move interactive dialog date/datetime properties into datetime_config mattermost/mattermost#36067

Merged

sbishel requested a review from hanzei April 20, 2026 23:17

hanzei approved these changes Apr 21, 2026

View reviewed changes

Merge branch 'master' into update-datetime-config

8baad30

Rename allow_manual_time_entry to manual_time_entry in datetime_confi…

094e3f6

…g docs Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

coderabbitai Bot requested changes Apr 21, 2026

View reviewed changes

Comment thread site/content/integrate/plugins/interactive-dialogs/_index.md Outdated

Comment thread site/content/integrate/plugins/interactive-dialogs/_index.md

sbishel and others added 2 commits April 21, 2026 11:15

Merge branch 'master' into update-datetime-config

9de18dd

Add missing commas in compound sentences for date field descriptions

3ad3f28

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

sbishel requested a review from ogi-m April 21, 2026 17:41

coderabbitai Bot approved these changes Apr 21, 2026

View reviewed changes

Merge branch 'master' into update-datetime-config

e0d1acf

coderabbitai Bot reviewed Apr 21, 2026

View reviewed changes

sbishel added the 3: QA Review Requires review by a QA tester. May occur at the same time as Dev Review label Apr 21, 2026

Merge branch 'master' into update-datetime-config

0ad4749

Merge branch 'master' into update-datetime-config

64449cf

ogi-m added 4: Reviews Complete All reviewers have approved the pull request and removed 3: QA Review Requires review by a QA tester. May occur at the same time as Dev Review labels May 1, 2026

ogi-m approved these changes May 1, 2026

View reviewed changes

Merge branch 'master' into update-datetime-config

0167eab

Merge branch 'master' into update-datetime-config

d958fea

sbishel merged commit 5af3328 into master May 1, 2026
5 checks passed

sbishel deleted the update-datetime-config branch May 1, 2026 16:01

Conversation

sbishel commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Ticket Link

Uh oh!

github-actions Bot commented Apr 20, 2026

Uh oh!

hanzei left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 21, 2026

Uh oh!

github-actions Bot commented Apr 21, 2026

Uh oh!

coderabbitai Bot commented Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related issues

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Apr 21, 2026

Uh oh!

github-actions Bot commented Apr 21, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 23, 2026

Uh oh!

github-actions Bot commented Apr 30, 2026

Uh oh!

github-actions Bot commented May 1, 2026

Uh oh!

github-actions Bot commented May 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sbishel commented Apr 20, 2026 •

edited

Loading

coderabbitai Bot commented Apr 21, 2026 •

edited

Loading