Skip to content

MM-67946 Updating webhook documentation to include encoding changes#8862

Open
avasconcelos114 wants to merge 4 commits intomasterfrom
MM-67945
Open

MM-67946 Updating webhook documentation to include encoding changes#8862
avasconcelos114 wants to merge 4 commits intomasterfrom
MM-67945

Conversation

@avasconcelos114
Copy link
Copy Markdown
Contributor

Summary

This PR was created to include the changes made in mattermost/mattermost#35667, so that the decoding of special characters is made clear.

I opened this PR as a result of the documentation impact analysis, let me know if we'd like this documented differently (or not at all)

Ticket Link

Fixes https://mattermost.atlassian.net/browse/MM-67946

@avasconcelos114 avasconcelos114 requested a review from Combs7th April 8, 2026 10:40
@avasconcelos114 avasconcelos114 self-assigned this Apr 8, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 8, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3aa418f1-6c28-4a85-8969-e31da9b235db

📥 Commits

Reviewing files that changed from the base of the PR and between 4ad4de5 and 8924f09.

📒 Files selected for processing (2)
  • source/conf.py
  • source/integrations-guide/incoming-webhooks.rst
✅ Files skipped from review due to trivial changes (2)
  • source/conf.py
  • source/integrations-guide/incoming-webhooks.rst

📝 Walkthrough

Walkthrough

Documentation and Sphinx config updated: incoming webhooks docs clarify that HTML entities in attachment title and author_name are automatically decoded (with examples and guidance to avoid double-encoding), and conf.py version/release comments bumped from 11.6 to 11.7.

Changes

Cohort / File(s) Summary
Incoming Webhooks Documentation
source/integrations-guide/incoming-webhooks.rst
Clarified attachments parameter: title and author_name HTML entities are automatically decoded; added examples (named and numeric entities) and instruction to avoid double-encoding.
Sphinx Config
source/conf.py
Bumped commented version and release placeholders from '11.6' to '11.7'.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: updating webhook documentation to document encoding/decoding behaviour changes.
Description check ✅ Passed The description explains the purpose of the PR and references related code changes, providing context about the documentation impact.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 MM-67945

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
source/integrations-guide/incoming-webhooks.rst (1)

227-227: Consider splitting this long bullet for better scanability.

The content is strong, but this line is dense. Breaking it into two short sentences (what is decoded + what to avoid) will make it easier to consume quickly.

✏️ Suggested wording tweak
-- `Message Attachments <https://developers.mattermost.com/integrate/reference/message-attachments/>`_: Present rich, structured summaries such as status, priority, fields, links, or images for faster triage and comprehension. (Slack‑compatible schema.) Attachment ``title`` and ``author_name`` fields support HTML entity decoding — both numeric entities (e.g., ``&#40;`` for ``(``) and named entities (e.g., ``&amp;``, ``&lt;``, ``&gt;``, ``&quot;``, ``&apos;``) are automatically converted to their readable characters. Avoid double-encoding these values, as decoding is applied automatically.
+- `Message Attachments <https://developers.mattermost.com/integrate/reference/message-attachments/>`_: Present rich, structured summaries such as status, priority, fields, links, or images for faster triage and comprehension. (Slack‑compatible schema.) Attachment ``title`` and ``author_name`` fields support automatic HTML entity decoding for both numeric entities (for example, ``&#40;`` → ``(``) and named entities (for example, ``&amp;``, ``&lt;``, ``&gt;``, ``&quot;``, ``&apos;``). Avoid double-encoding these values because decoding is already applied automatically.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@source/integrations-guide/incoming-webhooks.rst` at line 227, The long bullet
under "Message Attachments" is dense; split it into two sentences for clarity:
keep the first sentence describing that attachment title and author_name fields
support HTML entity decoding (list numeric and named entity examples like &#40;,
&amp;, &lt;, &gt;, &quot;, &apos;) and note that decoding is applied
automatically, and make the second short sentence a recommendation to avoid
double-encoding these values. Update the sentence that currently mentions both
decoding and the avoidance warning so it becomes two concise sentences
referencing the "Message Attachments" bullet and the "title" and "author_name"
fields.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@source/integrations-guide/incoming-webhooks.rst`:
- Line 227: The long bullet under "Message Attachments" is dense; split it into
two sentences for clarity: keep the first sentence describing that attachment
title and author_name fields support HTML entity decoding (list numeric and
named entity examples like &#40;, &amp;, &lt;, &gt;, &quot;, &apos;) and note
that decoding is applied automatically, and make the second short sentence a
recommendation to avoid double-encoding these values. Update the sentence that
currently mentions both decoding and the avoidance warning so it becomes two
concise sentences referencing the "Message Attachments" bullet and the "title"
and "author_name" fields.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 06398271-74f3-47c7-be39-a91defbfa455

📥 Commits

Reviewing files that changed from the base of the PR and between dbe1e0d and 4ad4de5.

📒 Files selected for processing (1)
  • source/integrations-guide/incoming-webhooks.rst

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

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

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

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

@esethna esethna added the Do Not Merge/Awaiting Next Release To be merged with the next release (e.g. API documentation updates) label Apr 13, 2026
@esethna esethna added this to the v11.7.0 milestone Apr 13, 2026
@esethna
Copy link
Copy Markdown
Contributor

esethna commented Apr 13, 2026

@avasconcelos114 please rebase to v11.7 branch when it's cut in the next few days

@amyblais amyblais added the 2: Editor Review Requires review by an editor label Apr 17, 2026
@avasconcelos114
Copy link
Copy Markdown
Contributor Author

@esethna I've rebased this on the v11.7-documentation branch, but not 100% sure this is what was expected, let me know if I should fix anything with the branch

@avasconcelos114 avasconcelos114 requested a review from esethna April 17, 2026 12:44
@github-actions
Copy link
Copy Markdown
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2: Editor Review Requires review by an editor Do Not Merge/Awaiting Next Release To be merged with the next release (e.g. API documentation updates)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants