Skip to content

Commit ee436bb

Browse files
committed
Clarify pull request file field selection description
1 parent 5300483 commit ee436bb

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
@@ -1267,7 +1267,7 @@ The following sets of tools are available:
12671267
- **pull_request_read** - Get details for a single pull request
12681268
- **OAuth Challenge Scopes**: `repo`
12691269
- `after`: Cursor for pagination, used only by the get_review_comments method. Pass the endCursor from the previous page's PageInfo to fetch the next page. (string, optional)
1270-
- `fields`: Fields to include in each file returned by get_files. Use ["filename"] for paths only, or omit patch to reduce response size. Returns all fields when omitted or empty. Ignored by other methods. (string[], optional)
1270+
- `fields`: Fields to return for each changed file. Only applies when method is 'get_files'. When a nonempty list is provided, only the listed fields are returned. If 'fields' is omitted or empty, all available fields are returned, including patches. (string[], optional)
12711271
- `method`: Action to specify what pull request data needs to be retrieved from GitHub.
12721272
Possible options:
12731273
1. get - Get details of a specific pull request.

pkg/github/__toolsnaps__/pull_request_read.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"type": "string"
1313
},
1414
"fields": {
15-
"description": "Fields to include in each file returned by get_files. Use [\"filename\"] for paths only, or omit patch to reduce response size. Returns all fields when omitted or empty. Ignored by other methods.",
15+
"description": "Fields to return for each changed file. Only applies when method is 'get_files'. When a nonempty list is provided, only the listed fields are returned. If 'fields' is omitted or empty, all available fields are returned, including patches.",
1616
"items": {
1717
"enum": [
1818
"filename",

pkg/github/pullrequests.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Possible options:
6060
}
6161
WithPagination(schema)
6262
schema.Properties["fields"] = fieldsSchemaProperty(
63-
"Fields to include in each file returned by get_files. Use [\"filename\"] for paths only, or omit patch to reduce response size. Returns all fields when omitted or empty. Ignored by other methods.",
63+
"Fields to return for each changed file. Only applies when method is 'get_files'. When a nonempty list is provided, only the listed fields are returned. If 'fields' is omitted or empty, all available fields are returned, including patches.",
6464
pullRequestFilesItemFieldEnum,
6565
)
6666
// get_review_comments uses GraphQL cursor-based pagination and accepts the

0 commit comments

Comments
 (0)