Skip to content

Document inline comment anchor fields on /comments.create #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tommoor merged 1 commit into from
May 14, 2026
Merged

Document inline comment anchor fields on /comments.create #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion spec3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1750,7 +1750,7 @@
"Comments"
],
"summary": "Create a comment",
"description": "Add a comment or reply to a document, either `data` or `text` is required.",
"description": "Add a comment or reply to a document, either `data` or `text` is required. Provide `anchorText` to create an inline comment attached to a specific text range in the document.",
"requestBody": {
"content": {
"application/json": {
Expand All @@ -1777,6 +1777,18 @@
"type": "string",
"description": "The body of the comment in markdown.",
"example": "Sounds great"
},
"anchorText": {
"type": "string",
"description": "Plain text substring to anchor the comment to as an inline comment. The first occurrence in the document's plain text is used unless disambiguated by `anchorPrefix` and/or `anchorSuffix`."
},
"anchorPrefix": {
"type": "string",
"description": "Text immediately preceding `anchorText`, used to disambiguate between multiple occurrences. Requires `anchorText`."
},
"anchorSuffix": {
"type": "string",
"description": "Text immediately following `anchorText`, used to disambiguate between multiple occurrences. Requires `anchorText`."
}
},
"required": [
Expand Down
22 changes: 21 additions & 1 deletion spec3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1366,7 +1366,10 @@ paths:
tags:
- Comments
summary: Create a comment
description: Add a comment or reply to a document, either `data` or `text` is required.
description:
Add a comment or reply to a document, either `data` or `text` is required.
Provide `anchorText` to create an inline comment attached to a specific
text range in the document.
requestBody:
content:
application/json:
Expand All @@ -1389,6 +1392,23 @@ paths:
type: string
description: The body of the comment in markdown.
example: Sounds great
anchorText:
type: string
description:
Plain text substring to anchor the comment to as an inline
comment. The first occurrence in the document's plain text
is used unless disambiguated by `anchorPrefix` and/or
`anchorSuffix`.
anchorPrefix:
type: string
description:
Text immediately preceding `anchorText`, used to disambiguate
between multiple occurrences. Requires `anchorText`.
anchorSuffix:
type: string
description:
Text immediately following `anchorText`, used to disambiguate
between multiple occurrences. Requires `anchorText`.
required:
- documentId
responses:
Expand Down
Loading