Skip to content

Document 1000-char limit for report-transaction notes - #1671

Merged
marselester merged 2 commits into
mainfrom
faktas/document-notes-limit-on-report-transaction-api
Jul 23, 2026
Merged

Document 1000-char limit for report-transaction notes#1671
marselester merged 2 commits into
mainfrom
faktas/document-notes-limit-on-report-transaction-api

Conversation

@faktas2

@faktas2 faktas2 commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add "Must be 1000 Unicode characters or fewer." to the notes field description in the Request Body table
  • Add NOTES_INVALID error code to the Response error table

Related to internal issue UHU-2728.

Summary by CodeRabbit

  • Documentation
    • Clarified that transaction report notes must contain no more than 1,000 Unicode characters.
    • Documented the NOTES_INVALID 400 Bad Request error returned when notes exceed the limit.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 8, 2026

Copy link
Copy Markdown

Deploying dev-site with  Cloudflare Pages  Cloudflare Pages

Latest commit: 69f2212
Status: ✅  Deploy successful!
Preview URL: https://8594782b.dev-site-4ua.pages.dev
Branch Preview URL: https://faktas-document-notes-limit.dev-site-4ua.pages.dev

View logs

@gemini-code-assist gemini-code-assist Bot left a comment

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.

Code Review

This pull request updates the transaction reporting documentation to specify a limit of 1000 Unicode characters for the notes field and adds the corresponding NOTES_INVALID error code. The reviewer pointed out a style guide violation where a comma should be added before the conjunction "so" in the notes field description.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

| **maxmind_id** | string (8) | _Conditionally required.[^1]_ A unique eight character string identifying a minFraud Standard or Premium request. These IDs are returned in the `maxmindID` field of a response for a successful minFraud request. |
| **minfraud_id** | string (36) | _Conditionally required.[^1]_ A UUID that identifies a minFraud Score, minFraud Insights, or minFraud Factors request. This ID is returned at `/id` in the response. |
| **notes** | string | _Optional._ Your notes on the fraud tag associated with the transaction. We manually review many reported transactions to improve our scoring for you so any additional details to help us understand context are helpful. |
| **notes** | string | _Optional._ Your notes on the fraud tag associated with the transaction. We manually review many reported transactions to improve our scoring for you so any additional details to help us understand context are helpful. Must be 1000 Unicode characters or fewer. |

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.

medium

According to the repository style guide, a comma should be used between independent clauses joined by conjunctions (such as "so"). Please add a comma before "so".

Suggested change
| **notes** | string | _Optional._ Your notes on the fraud tag associated with the transaction. We manually review many reported transactions to improve our scoring for you so any additional details to help us understand context are helpful. Must be 1000 Unicode characters or fewer. |
| **notes** | string | _Optional._ Your notes on the fraud tag associated with the transaction. We manually review many reported transactions to improve our scoring for you, so any additional details to help us understand context are helpful. Must be 1000 Unicode characters or fewer. |
References
  1. Use commas between independent clauses joined by conjunctions. (link)

Add the character limit to the notes field description and add the
NOTES_INVALID error code to the response error table.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@faktas2
faktas2 force-pushed the faktas/document-notes-limit-on-report-transaction-api branch from 68ed608 to ba0e63d Compare June 8, 2026 20:11
@oschwald

Copy link
Copy Markdown
Member

@faktas2 is someone reviewing this PR?

@horgh

horgh commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

@faktas2 see above

@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 98b241f7-70ca-4b8d-89f0-2a22bf84fe15

📥 Commits

Reviewing files that changed from the base of the PR and between 9f10a89 and 69f2212.

📒 Files selected for processing (1)
  • content/minfraud/report-a-transaction.md

📝 Walkthrough

Walkthrough

The transaction report documentation now limits notes to 1000 Unicode characters and documents the NOTES_INVALID 400 error for longer values.

Changes

Transaction notes documentation

Layer / File(s) Summary
Notes validation contract
content/minfraud/report-a-transaction.md
The notes request field now specifies the 1000-character Unicode limit, and the response table documents NOTES_INVALID for values exceeding it.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

I’m a bunny with notes in my nest,
Kept to a thousand Unicode at best.
If the notes grow too wide,
NOTES_INVALID will guide—
Clear docs make the burrow well-pressed!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: documenting the 1000-character limit for report-transaction notes.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch faktas/document-notes-limit-on-report-transaction-api

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.

@faktas2
faktas2 requested a review from marselester July 23, 2026 14:23
@marselester
marselester merged commit 0cb4e87 into main Jul 23, 2026
10 of 11 checks passed
@marselester
marselester deleted the faktas/document-notes-limit-on-report-transaction-api branch July 23, 2026 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants