Skip to content

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

Open
faktas2 wants to merge 1 commit into
mainfrom
faktas/document-notes-limit-on-report-transaction-api
Open

Document 1000-char limit for report-transaction notes#1671
faktas2 wants to merge 1 commit 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.

@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: ba0e63d
Status: ✅  Deploy successful!
Preview URL: https://2209322d.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
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.

1 participant