Update from code changes: document suggestion payload on V2 comment annotations#299
Open
mintlify[bot] wants to merge 2 commits into
Open
Update from code changes: document suggestion payload on V2 comment annotations#299mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The V2 comment annotations REST API now accepts a full caller-supplied
suggestionpayload (target, old/new values, summary, drift flag, plus arbitrary custom fields) on both the add and update endpoints, withstatusremaining server-owned. This PR documents that new field on both endpoints and adds an example. The AI Credits Billing System that also shipped in this release is an internal Superflow-portal/admin surface and does not appear in the SDK or REST API docs, so it isn't documented here. Triggering release: https://github.com/snippyly/internal-release-notes/pull/14Changes
suggestionobject field to the V2 add-comment-annotations reference, with per-property descriptions (targetId,targetType,oldValue,newValue,summary,driftDetected) and a note thatstatusis server-owned and custom fields are persisted verbatim.suggestionobject field to the V2 update-comment-annotations reference, noting the update path replaces the persisted object and cannot changestatus.