Document inline comment anchor fields on /comments.create#26
Merged
Conversation
Adds anchorText, anchorPrefix, and anchorSuffix request parameters to the comments.create endpoint, enabling creation of inline comments attached to a specific text range in a document.
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
2 participants
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
Documents the new inline comment input parameters added to
/comments.createin outline/outline#12322 ("feat: Inline comment support").The endpoint now accepts three optional fields for anchoring a comment to a specific text range in the document:
anchorText— Plain text substring to anchor to. First occurrence in the document's plain text is used unless disambiguated.anchorPrefix— Text immediately precedinganchorText, used to disambiguate multiple occurrences. RequiresanchorText.anchorSuffix— Text immediately followinganchorText, used to disambiguate multiple occurrences. RequiresanchorText.The endpoint description has been updated to mention
anchorText. TheCommentresponse schema already exposes theanchorTextfield, so no response-shape changes are needed.Other reviewed PRs from the last day
The following merged outline/outline PRs were reviewed and determined to have no impact on the public API contract, so no doc changes were needed:
Test plan
yarn lint --fail-severity=errorpassesspec3.jsonfromspec3.ymlGenerated by Claude Code