Skip to content

Commit cbd22dd

Browse files
committed
Update includeReplies description to specify GitHub API maximum replies limit
1 parent 192ca0b commit cbd22dd

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -752,7 +752,7 @@ The following sets of tools are available:
752752
- **Required OAuth Scopes**: `repo`
753753
- `after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
754754
- `discussionNumber`: Discussion Number (number, required)
755-
- `includeReplies`: When true, each top-level comment will include its replies nested within it. Defaults to false. (boolean, optional)
755+
- `includeReplies`: When true, each top-level comment will include its replies nested within it (up to 100 replies per comment, which is the GitHub API maximum). Defaults to false. (boolean, optional)
756756
- `owner`: Repository owner (string, required)
757757
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
758758
- `repo`: Repository name (string, required)

pkg/github/__toolsnaps__/get_discussion_comments.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"type": "number"
1616
},
1717
"includeReplies": {
18-
"description": "When true, each top-level comment will include its replies nested within it. Defaults to false.",
18+
"description": "When true, each top-level comment will include its replies nested within it (up to 100 replies per comment, which is the GitHub API maximum). Defaults to false.",
1919
"type": "boolean"
2020
},
2121
"owner": {

pkg/github/discussions.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ func GetDiscussionComments(t translations.TranslationHelperFunc) inventory.Serve
408408
},
409409
"includeReplies": {
410410
Type: "boolean",
411-
Description: "When true, each top-level comment will include its replies nested within it. Defaults to false.",
411+
Description: "When true, each top-level comment will include its replies nested within it (up to 100 replies per comment, which is the GitHub API maximum). Defaults to false.",
412412
},
413413
},
414414
Required: []string{"owner", "repo", "discussionNumber"},

0 commit comments

Comments
 (0)