docs: optional catalog_id on POST /api/emails leads the email with the value delta - #281
docs: optional catalog_id on POST /api/emails leads the email with the value delta#281sweetmantech wants to merge 1 commit into
Conversation
…e value delta Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
|
Warning Review limit reached
Next review available in: 10 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
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. Comment |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 1 file
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="api-reference/openapi/accounts.json">
<violation number="1" location="api-reference/openapi/accounts.json:3590">
P2: The description links to `/api-reference/songs/catalog-valuations` as a related endpoint, but that page doesn't exist yet in the repository. After this PR merges, users who click this link will see a 404 until the referenced endpoint documentation is added. Since the merge order places this PR first, consider either deferring the link until the endpoint page exists, adding a brief placeholder page, or noting the forward-reference risk so the follow-up PR is not missed.</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
| "type": "string", | ||
| "description": "Chat ID to include a chat link in the email footer. Use [Create Chat](/api-reference/chat/create) to create one." | ||
| }, | ||
| "catalog_id": { |
There was a problem hiding this comment.
P2: The description links to /api-reference/songs/catalog-valuations as a related endpoint, but that page doesn't exist yet in the repository. After this PR merges, users who click this link will see a 404 until the referenced endpoint documentation is added. Since the merge order places this PR first, consider either deferring the link until the endpoint page exists, adding a brief placeholder page, or noting the forward-reference risk so the follow-up PR is not missed.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At api-reference/openapi/accounts.json, line 3590:
<comment>The description links to `/api-reference/songs/catalog-valuations` as a related endpoint, but that page doesn't exist yet in the repository. After this PR merges, users who click this link will see a 404 until the referenced endpoint documentation is added. Since the merge order places this PR first, consider either deferring the link until the endpoint page exists, adding a brief placeholder page, or noting the forward-reference risk so the follow-up PR is not missed.</comment>
<file context>
@@ -3587,6 +3587,11 @@
"type": "string",
"description": "Chat ID to include a chat link in the email footer. Use [Create Chat](/api-reference/chat/create) to create one."
},
+ "catalog_id": {
+ "type": "string",
+ "format": "uuid",
</file context>
1 participant
Summary
Row 5 of chat#1911: the contract for leading a report email with the catalog's value delta. Adds an optional
catalog_id(uuid) toSendEmailRequest: when present, the subject is prefixed with the catalog's current estimated value and signed change since the previous measurement, and a valuation hero block is prepended to the body. Single measurement shows a baseline note; an unowned catalog or one with no measurements leaves the email unchanged (best-effort by design - a delta failure must never block a send).Purely additive anchored edit to
SendEmailRequestinaccounts.json; JSON re-validated. Links the series contract at Get Catalog Valuations.Merge order: this PR → the api implementation (stacked on api#795, ref follows). Depends on docs#279 conceptually (the valuations series) but not textually.
🤖 Generated with Claude Code
Summary by cubic
Adds an optional
catalog_id(uuid) toSendEmailRequestforPOST /api/emailsto lead report emails with the catalog’s current value and signed delta, aligning with chat#1911. Additive docs update; existing clients are unaffected.catalog_idis set, the subject is prefixed with the current estimated value and change, and a valuation hero block is added to the body.Written for commit 63768f1. Summary will update on new commits.