From 8f1de75459f0204c0523b98c44abe5918ebd5a8a Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Thu, 13 Nov 2025 08:40:06 -0800 Subject: [PATCH] GraphQL schema update (#58485) Co-authored-by: heiskr <1221423+heiskr@users.noreply.github.com> --- src/graphql/data/fpt/changelog.json | 16 +++++ src/graphql/data/fpt/schema.docs.graphql | 58 ++++++++++++++++ src/graphql/data/fpt/schema.json | 82 +++++++++++++++++++++++ src/graphql/data/ghec/schema.docs.graphql | 58 ++++++++++++++++ src/graphql/data/ghec/schema.json | 82 +++++++++++++++++++++++ 5 files changed, 296 insertions(+) diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json index 64e1aa8979..1225f5b978 100644 --- a/src/graphql/data/fpt/changelog.json +++ b/src/graphql/data/fpt/changelog.json @@ -1,4 +1,20 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

Type RequiredReviewerConfiguration was added

", + "

Type RequiredReviewerConfigurationInput was added

", + "

Field requiredReviewers was added to object type PullRequestParameters

", + "

Input field requiredReviewers of type '[RequiredReviewerConfigurationInput!]was added to input object typePullRequestParametersInput'

" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2025-11-13" + }, { "schemaChanges": [ { diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index 2f9785a866..e7d8ecc029 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -41909,6 +41909,13 @@ type PullRequestParameters { All conversations on code must be resolved before a pull request can be merged. """ requiredReviewThreadResolution: Boolean! + + """ + This field is in beta and subject to change. A collection of reviewers and + associated file patterns. Each reviewer has a list of file patterns which + determine the files that reviewer is required to review. + """ + requiredReviewers: [RequiredReviewerConfiguration!] } """ @@ -41950,6 +41957,13 @@ input PullRequestParametersInput { All conversations on code must be resolved before a pull request can be merged. """ requiredReviewThreadResolution: Boolean! + + """ + This argument is in beta and subject to change. A collection of reviewers and + associated file patterns. Each reviewer has a list of file patterns which + determine the files that reviewer is required to review. + """ + requiredReviewers: [RequiredReviewerConfigurationInput!] } """ @@ -54516,6 +54530,50 @@ input RequiredDeploymentsParametersInput { requiredDeploymentEnvironments: [String!]! } +""" +A reviewing team, and file patterns describing which files they must approve changes to. +""" +type RequiredReviewerConfiguration { + """ + Array of file patterns. Pull requests which change matching files must be + approved by the specified team. File patterns use fnmatch syntax. + """ + filePatterns: [String!]! + + """ + Minimum number of approvals required from the specified team. If set to zero, + the team will be added to the pull request but approval is optional. + """ + minimumApprovals: Int! + + """ + Node ID of the team which must review changes to matching files. + """ + reviewerId: ID! +} + +""" +A reviewing team, and file patterns describing which files they must approve changes to. +""" +input RequiredReviewerConfigurationInput { + """ + Array of file patterns. Pull requests which change matching files must be + approved by the specified team. File patterns use fnmatch syntax. + """ + filePatterns: [String!]! + + """ + Minimum number of approvals required from the specified team. If set to zero, + the team will be added to the pull request but approval is optional. + """ + minimumApprovals: Int! + + """ + Node ID of the team which must review changes to matching files. + """ + reviewerId: ID! +} + """ Represents a required status check for a protected branch, but not any specific run of that check. """ diff --git a/src/graphql/data/fpt/schema.json b/src/graphql/data/fpt/schema.json index a00e3c2d82..f3cbc94697 100644 --- a/src/graphql/data/fpt/schema.json +++ b/src/graphql/data/fpt/schema.json @@ -56179,6 +56179,14 @@ "id": "boolean", "kind": "scalars", "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "requiredReviewers", + "description": "

This field is in beta and subject to change. A collection of reviewers and\nassociated file patterns. Each reviewer has a list of file patterns which\ndetermine the files that reviewer is required to review.

", + "type": "[RequiredReviewerConfiguration!]", + "id": "requiredreviewerconfiguration", + "kind": "objects", + "href": "/graphql/reference/objects#requiredreviewerconfiguration" } ] }, @@ -70829,6 +70837,39 @@ } ] }, + { + "name": "RequiredReviewerConfiguration", + "kind": "objects", + "id": "requiredreviewerconfiguration", + "href": "/graphql/reference/objects#requiredreviewerconfiguration", + "description": "

A reviewing team, and file patterns describing which files they must approve changes to.

", + "fields": [ + { + "name": "filePatterns", + "description": "

Array of file patterns. Pull requests which change matching files must be\napproved by the specified team. File patterns use fnmatch syntax.

", + "type": "[String!]!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "minimumApprovals", + "description": "

Minimum number of approvals required from the specified team. If set to zero,\nthe team will be added to the pull request but approval is optional.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "reviewerId", + "description": "

Node ID of the team which must review changes to matching files.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + ] + }, { "name": "RequiredStatusCheckDescription", "kind": "objects", @@ -106132,6 +106173,14 @@ "id": "boolean", "kind": "scalars", "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "requiredReviewers", + "description": "

This argument is in beta and subject to change. A collection of reviewers and\nassociated file patterns. Each reviewer has a list of file patterns which\ndetermine the files that reviewer is required to review.

", + "type": "[RequiredReviewerConfigurationInput!]", + "id": "requiredreviewerconfigurationinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#requiredreviewerconfigurationinput" } ] }, @@ -107388,6 +107437,39 @@ } ] }, + { + "name": "RequiredReviewerConfigurationInput", + "kind": "inputObjects", + "id": "requiredreviewerconfigurationinput", + "href": "/graphql/reference/input-objects#requiredreviewerconfigurationinput", + "description": "

A reviewing team, and file patterns describing which files they must approve changes to.

", + "inputFields": [ + { + "name": "filePatterns", + "description": "

Array of file patterns. Pull requests which change matching files must be\napproved by the specified team. File patterns use fnmatch syntax.

", + "type": "[String!]!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "minimumApprovals", + "description": "

Minimum number of approvals required from the specified team. If set to zero,\nthe team will be added to the pull request but approval is optional.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "reviewerId", + "description": "

Node ID of the team which must review changes to matching files.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + ] + }, { "name": "RequiredStatusCheckInput", "kind": "inputObjects", diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index 2f9785a866..e7d8ecc029 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -41909,6 +41909,13 @@ type PullRequestParameters { All conversations on code must be resolved before a pull request can be merged. """ requiredReviewThreadResolution: Boolean! + + """ + This field is in beta and subject to change. A collection of reviewers and + associated file patterns. Each reviewer has a list of file patterns which + determine the files that reviewer is required to review. + """ + requiredReviewers: [RequiredReviewerConfiguration!] } """ @@ -41950,6 +41957,13 @@ input PullRequestParametersInput { All conversations on code must be resolved before a pull request can be merged. """ requiredReviewThreadResolution: Boolean! + + """ + This argument is in beta and subject to change. A collection of reviewers and + associated file patterns. Each reviewer has a list of file patterns which + determine the files that reviewer is required to review. + """ + requiredReviewers: [RequiredReviewerConfigurationInput!] } """ @@ -54516,6 +54530,50 @@ input RequiredDeploymentsParametersInput { requiredDeploymentEnvironments: [String!]! } +""" +A reviewing team, and file patterns describing which files they must approve changes to. +""" +type RequiredReviewerConfiguration { + """ + Array of file patterns. Pull requests which change matching files must be + approved by the specified team. File patterns use fnmatch syntax. + """ + filePatterns: [String!]! + + """ + Minimum number of approvals required from the specified team. If set to zero, + the team will be added to the pull request but approval is optional. + """ + minimumApprovals: Int! + + """ + Node ID of the team which must review changes to matching files. + """ + reviewerId: ID! +} + +""" +A reviewing team, and file patterns describing which files they must approve changes to. +""" +input RequiredReviewerConfigurationInput { + """ + Array of file patterns. Pull requests which change matching files must be + approved by the specified team. File patterns use fnmatch syntax. + """ + filePatterns: [String!]! + + """ + Minimum number of approvals required from the specified team. If set to zero, + the team will be added to the pull request but approval is optional. + """ + minimumApprovals: Int! + + """ + Node ID of the team which must review changes to matching files. + """ + reviewerId: ID! +} + """ Represents a required status check for a protected branch, but not any specific run of that check. """ diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index a00e3c2d82..f3cbc94697 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -56179,6 +56179,14 @@ "id": "boolean", "kind": "scalars", "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "requiredReviewers", + "description": "

This field is in beta and subject to change. A collection of reviewers and\nassociated file patterns. Each reviewer has a list of file patterns which\ndetermine the files that reviewer is required to review.

", + "type": "[RequiredReviewerConfiguration!]", + "id": "requiredreviewerconfiguration", + "kind": "objects", + "href": "/graphql/reference/objects#requiredreviewerconfiguration" } ] }, @@ -70829,6 +70837,39 @@ } ] }, + { + "name": "RequiredReviewerConfiguration", + "kind": "objects", + "id": "requiredreviewerconfiguration", + "href": "/graphql/reference/objects#requiredreviewerconfiguration", + "description": "

A reviewing team, and file patterns describing which files they must approve changes to.

", + "fields": [ + { + "name": "filePatterns", + "description": "

Array of file patterns. Pull requests which change matching files must be\napproved by the specified team. File patterns use fnmatch syntax.

", + "type": "[String!]!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "minimumApprovals", + "description": "

Minimum number of approvals required from the specified team. If set to zero,\nthe team will be added to the pull request but approval is optional.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "reviewerId", + "description": "

Node ID of the team which must review changes to matching files.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + ] + }, { "name": "RequiredStatusCheckDescription", "kind": "objects", @@ -106132,6 +106173,14 @@ "id": "boolean", "kind": "scalars", "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "requiredReviewers", + "description": "

This argument is in beta and subject to change. A collection of reviewers and\nassociated file patterns. Each reviewer has a list of file patterns which\ndetermine the files that reviewer is required to review.

", + "type": "[RequiredReviewerConfigurationInput!]", + "id": "requiredreviewerconfigurationinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#requiredreviewerconfigurationinput" } ] }, @@ -107388,6 +107437,39 @@ } ] }, + { + "name": "RequiredReviewerConfigurationInput", + "kind": "inputObjects", + "id": "requiredreviewerconfigurationinput", + "href": "/graphql/reference/input-objects#requiredreviewerconfigurationinput", + "description": "

A reviewing team, and file patterns describing which files they must approve changes to.

", + "inputFields": [ + { + "name": "filePatterns", + "description": "

Array of file patterns. Pull requests which change matching files must be\napproved by the specified team. File patterns use fnmatch syntax.

", + "type": "[String!]!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "minimumApprovals", + "description": "

Minimum number of approvals required from the specified team. If set to zero,\nthe team will be added to the pull request but approval is optional.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "reviewerId", + "description": "

Node ID of the team which must review changes to matching files.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + ] + }, { "name": "RequiredStatusCheckInput", "kind": "inputObjects",