Skip to content

docs: clarify update messaging endpoints only work for draft messages#11656

Open
sanzofr wants to merge 1 commit intoappwrite:1.9.xfrom
sanzofr:docs/update-messaging-draft-note
Open

docs: clarify update messaging endpoints only work for draft messages#11656
sanzofr wants to merge 1 commit intoappwrite:1.9.xfrom
sanzofr:docs/update-messaging-draft-note

Conversation

@sanzofr
Copy link
Copy Markdown

@sanzofr sanzofr commented Mar 26, 2026

What does this PR do?

This PR updates the documentation for the updateEmail(), updatePush(), and updateSms() endpoints to clarify that they only work when the message is in draft status.

Currently, this behavior is not clearly mentioned in the docs, which may lead to confusion when the endpoints do not work as expected on non-draft messages.

Test Plan

  • Reviewed the existing documentation for the mentioned endpoints
  • Updated the markdown files to include a note about draft-only behavior
  • Verified consistency across related documentation files

Related PRs and Issues

Checklist

  • Have you read the Contributing Guidelines on issues?
  • If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 26, 2026

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (3)
  • docs/references/messaging/update-email.md is excluded by !docs/references/**
  • docs/references/messaging/update-push.md is excluded by !docs/references/**
  • docs/references/messaging/update-sms.md is excluded by !docs/references/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 54accfd8-3e4e-4094-8abc-d61937fa396c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 26, 2026

Greptile Summary

This PR adds a blockquote note to the updateEmail(), updatePush(), and updateSms() documentation files to highlight that these endpoints only operate on messages in draft status.\n\nHowever, each of the three files already contained this information in its opening sentence before this PR (e.g. "This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated."). The newly added > Note: blockquote therefore duplicates existing content rather than adding new clarification.\n\n- The draft-only constraint was already documented in the first line of all three files prior to this change.\n- The added blockquotes repeat the same constraint verbatim, leaving the files with identical information stated twice.\n- Consider either removing the blockquotes, or consolidating into a single clear statement (possibly the blockquote form for visual emphasis) to keep the docs concise.

Confidence Score: 4/5

Safe to merge; the change is purely additive documentation and introduces no functional risk, though the note is redundant with existing text.

Only documentation files are touched, so there is zero risk of a runtime regression. The sole concern is that the added note duplicates information already present in each file's first line. This is a minor quality issue worth addressing before merging to avoid reader confusion, but it does not block the PR.

All three files (update-email.md, update-push.md, update-sms.md) have the same redundancy; no file poses a technical risk.

Important Files Changed

Filename Overview
docs/references/messaging/update-email.md Adds a blockquote note about draft-only behavior, but the first line already contains this same information, making the added note redundant.
docs/references/messaging/update-push.md Adds a blockquote note about draft-only behavior, but the first line already contains this same information, making the added note redundant.
docs/references/messaging/update-sms.md Adds a blockquote note about draft-only behavior, but the first line already contains this same information, making the added note redundant.

Reviews (1): Last reviewed commit: "docs: clarify update messaging endpoints..." | Re-trigger Greptile

@@ -1 +1,3 @@
Update an email message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.

> Note: This endpoint only works for messages in draft status.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Redundant note — same information already in line 1

The first line of this file already states: "This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated."

The added blockquote repeats the exact same constraint. Rather than duplicating it, consider either removing the blockquote or rewriting line 1 to be a shorter description and keeping only the blockquote for emphasis. The same redundancy applies to docs/references/messaging/update-push.md:3 and docs/references/messaging/update-sms.md:3.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📚 Documentation: Clarify update email/push/sms

1 participant