Skip to content

Commit a5535eb

Browse files
docs-botrachmari
docs-bot
and
rachmari
authored
GraphQL schema update (#50435)
Co-authored-by: rachmari <[email protected]>
1 parent ec6c9fe commit a5535eb

File tree

5 files changed

+419
-0
lines changed

5 files changed

+419
-0
lines changed

‎src/graphql/data/fpt/changelog.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,23 @@
11
[
2+
{
3+
"schemaChanges": [
4+
{
5+
"title": "The GraphQL schema includes these changes:",
6+
"changes": [
7+
"<p>Type <code>CodeScanningParameters</code> was added</p>",
8+
"<p>Type <code>CodeScanningParametersInput</code> was added</p>",
9+
"<p>Type <code>CodeScanningTool</code> was added</p>",
10+
"<p>Type <code>CodeScanningToolInput</code> was added</p>",
11+
"<p>Enum value 'CODE_SCANNING<code>was added to enum</code>RepositoryRuleType'</p>",
12+
"<p>Member <code>CodeScanningParameters</code> was added to Union type <code>RuleParameters</code></p>",
13+
"<p>Input field <code>codeScanning</code> of type <code>CodeScanningParametersInput</code> was added to input object type <code>RuleParametersInput</code></p>"
14+
]
15+
}
16+
],
17+
"previewChanges": [],
18+
"upcomingChanges": [],
19+
"date": "2024-05-02"
20+
},
221
{
322
"schemaChanges": [
423
{

‎src/graphql/data/fpt/schema.docs.graphql‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4326,6 +4326,76 @@ type CodeOfConduct implements Node {
43264326
url: URI
43274327
}
43284328

4329+
"""
4330+
Choose which tools must provide code scanning results before the reference is
4331+
updated. When configured, code scanning must be enabled and have results for
4332+
both the commit and the reference being updated.
4333+
"""
4334+
type CodeScanningParameters {
4335+
"""
4336+
Tools that must provide code scanning results for this rule to pass.
4337+
"""
4338+
codeScanningTools: [CodeScanningTool!]!
4339+
}
4340+
4341+
"""
4342+
Choose which tools must provide code scanning results before the reference is
4343+
updated. When configured, code scanning must be enabled and have results for
4344+
both the commit and the reference being updated.
4345+
"""
4346+
input CodeScanningParametersInput {
4347+
"""
4348+
Tools that must provide code scanning results for this rule to pass.
4349+
"""
4350+
codeScanningTools: [CodeScanningToolInput!]!
4351+
}
4352+
4353+
"""
4354+
A tool that must provide code scanning results for this rule to pass.
4355+
"""
4356+
type CodeScanningTool {
4357+
"""
4358+
The severity level at which code scanning results that raise alerts block a
4359+
reference update. For more information on alert severity levels, see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
4360+
"""
4361+
alertsThreshold: String!
4362+
4363+
"""
4364+
The severity level at which code scanning results that raise security alerts
4365+
block a reference update. For more information on security severity levels,
4366+
see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
4367+
"""
4368+
securityAlertsThreshold: String!
4369+
4370+
"""
4371+
The name of a code scanning tool
4372+
"""
4373+
tool: String!
4374+
}
4375+
4376+
"""
4377+
A tool that must provide code scanning results for this rule to pass.
4378+
"""
4379+
input CodeScanningToolInput {
4380+
"""
4381+
The severity level at which code scanning results that raise alerts block a
4382+
reference update. For more information on alert severity levels, see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
4383+
"""
4384+
alertsThreshold: String!
4385+
4386+
"""
4387+
The severity level at which code scanning results that raise security alerts
4388+
block a reference update. For more information on security severity levels,
4389+
see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
4390+
"""
4391+
securityAlertsThreshold: String!
4392+
4393+
"""
4394+
The name of a code scanning tool
4395+
"""
4396+
tool: String!
4397+
}
4398+
43294399
"""
43304400
Collaborators affiliation level with a subject.
43314401
"""
@@ -46404,6 +46474,13 @@ enum RepositoryRuleType {
4640446474
"""
4640546475
BRANCH_NAME_PATTERN
4640646476

46477+
"""
46478+
Choose which tools must provide code scanning results before the reference is
46479+
updated. When configured, code scanning must be enabled and have results for
46480+
both the commit and the reference being updated.
46481+
"""
46482+
CODE_SCANNING
46483+
4640746484
"""
4640846485
Committer email pattern
4640946486
"""
@@ -48162,6 +48239,7 @@ Types which can be parameters for `RepositoryRule` objects.
4816248239
"""
4816348240
union RuleParameters =
4816448241
BranchNamePatternParameters
48242+
| CodeScanningParameters
4816548243
| CommitAuthorEmailPatternParameters
4816648244
| CommitMessagePatternParameters
4816748245
| CommitterEmailPatternParameters
@@ -48185,6 +48263,11 @@ input RuleParametersInput {
4818548263
"""
4818648264
branchNamePattern: BranchNamePatternParametersInput
4818748265

48266+
"""
48267+
Parameters used for the `code_scanning` rule type
48268+
"""
48269+
codeScanning: CodeScanningParametersInput
48270+
4818848271
"""
4818948272
Parameters used for the `commit_author_email_pattern` rule type
4819048273
"""

‎src/graphql/data/fpt/schema.json‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12898,6 +12898,56 @@
1289812898
}
1289912899
]
1290012900
},
12901+
{
12902+
"name": "CodeScanningParameters",
12903+
"kind": "objects",
12904+
"id": "codescanningparameters",
12905+
"href": "/graphql/reference/objects#codescanningparameters",
12906+
"description": "<p>Choose which tools must provide code scanning results before the reference is\nupdated. When configured, code scanning must be enabled and have results for\nboth the commit and the reference being updated.</p>",
12907+
"fields": [
12908+
{
12909+
"name": "codeScanningTools",
12910+
"description": "<p>Tools that must provide code scanning results for this rule to pass.</p>",
12911+
"type": "[CodeScanningTool!]!",
12912+
"id": "codescanningtool",
12913+
"kind": "objects",
12914+
"href": "/graphql/reference/objects#codescanningtool"
12915+
}
12916+
]
12917+
},
12918+
{
12919+
"name": "CodeScanningTool",
12920+
"kind": "objects",
12921+
"id": "codescanningtool",
12922+
"href": "/graphql/reference/objects#codescanningtool",
12923+
"description": "<p>A tool that must provide code scanning results for this rule to pass.</p>",
12924+
"fields": [
12925+
{
12926+
"name": "alertsThreshold",
12927+
"description": "<p>The severity level at which code scanning results that raise alerts block a\nreference update. For more information on alert severity levels, see \"<a href=\"$%7BexternalDocsUrl%7D/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels\">About code scanning alerts</a>.\".</p>",
12928+
"type": "String!",
12929+
"id": "string",
12930+
"kind": "scalars",
12931+
"href": "/graphql/reference/scalars#string"
12932+
},
12933+
{
12934+
"name": "securityAlertsThreshold",
12935+
"description": "<p>The severity level at which code scanning results that raise security alerts\nblock a reference update. For more information on security severity levels,\nsee \"<a href=\"$%7BexternalDocsUrl%7D/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels\">About code scanning alerts</a>.\".</p>",
12936+
"type": "String!",
12937+
"id": "string",
12938+
"kind": "scalars",
12939+
"href": "/graphql/reference/scalars#string"
12940+
},
12941+
{
12942+
"name": "tool",
12943+
"description": "<p>The name of a code scanning tool.</p>",
12944+
"type": "String!",
12945+
"id": "string",
12946+
"kind": "scalars",
12947+
"href": "/graphql/reference/scalars#string"
12948+
}
12949+
]
12950+
},
1290112951
{
1290212952
"name": "CommentDeletedEvent",
1290312953
"kind": "objects",
@@ -85686,6 +85736,10 @@
8568685736
"name": "BRANCH_NAME_PATTERN",
8568785737
"description": "<p>Branch name pattern.</p>"
8568885738
},
85739+
{
85740+
"name": "CODE_SCANNING",
85741+
"description": "<p>Choose which tools must provide code scanning results before the reference is\nupdated. When configured, code scanning must be enabled and have results for\nboth the commit and the reference being updated.</p>"
85742+
},
8568985743
{
8569085744
"name": "COMMITTER_EMAIL_PATTERN",
8569185745
"description": "<p>Committer email pattern.</p>"
@@ -89726,6 +89780,11 @@
8972689780
"id": "branchnamepatternparameters",
8972789781
"href": "/graphql/reference/objects#branchnamepatternparameters"
8972889782
},
89783+
{
89784+
"name": "CodeScanningParameters",
89785+
"id": "codescanningparameters",
89786+
"href": "/graphql/reference/objects#codescanningparameters"
89787+
},
8972989788
{
8973089789
"name": "CommitAuthorEmailPatternParameters",
8973189790
"id": "commitauthoremailpatternparameters",
@@ -91883,6 +91942,56 @@
9188391942
}
9188491943
]
9188591944
},
91945+
{
91946+
"name": "CodeScanningParametersInput",
91947+
"kind": "inputObjects",
91948+
"id": "codescanningparametersinput",
91949+
"href": "/graphql/reference/input-objects#codescanningparametersinput",
91950+
"description": "<p>Choose which tools must provide code scanning results before the reference is\nupdated. When configured, code scanning must be enabled and have results for\nboth the commit and the reference being updated.</p>",
91951+
"inputFields": [
91952+
{
91953+
"name": "codeScanningTools",
91954+
"description": "<p>Tools that must provide code scanning results for this rule to pass.</p>",
91955+
"type": "[CodeScanningToolInput!]!",
91956+
"id": "codescanningtoolinput",
91957+
"kind": "input-objects",
91958+
"href": "/graphql/reference/input-objects#codescanningtoolinput"
91959+
}
91960+
]
91961+
},
91962+
{
91963+
"name": "CodeScanningToolInput",
91964+
"kind": "inputObjects",
91965+
"id": "codescanningtoolinput",
91966+
"href": "/graphql/reference/input-objects#codescanningtoolinput",
91967+
"description": "<p>A tool that must provide code scanning results for this rule to pass.</p>",
91968+
"inputFields": [
91969+
{
91970+
"name": "alertsThreshold",
91971+
"description": "<p>The severity level at which code scanning results that raise alerts block a\nreference update. For more information on alert severity levels, see \"<a href=\"$%7BexternalDocsUrl%7D/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels\">About code scanning alerts</a>.\".</p>",
91972+
"type": "String!",
91973+
"id": "string",
91974+
"kind": "scalars",
91975+
"href": "/graphql/reference/scalars#string"
91976+
},
91977+
{
91978+
"name": "securityAlertsThreshold",
91979+
"description": "<p>The severity level at which code scanning results that raise security alerts\nblock a reference update. For more information on security severity levels,\nsee \"<a href=\"$%7BexternalDocsUrl%7D/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels\">About code scanning alerts</a>.\".</p>",
91980+
"type": "String!",
91981+
"id": "string",
91982+
"kind": "scalars",
91983+
"href": "/graphql/reference/scalars#string"
91984+
},
91985+
{
91986+
"name": "tool",
91987+
"description": "<p>The name of a code scanning tool.</p>",
91988+
"type": "String!",
91989+
"id": "string",
91990+
"kind": "scalars",
91991+
"href": "/graphql/reference/scalars#string"
91992+
}
91993+
]
91994+
},
9188691995
{
9188791996
"name": "CommitAuthor",
9188891997
"kind": "inputObjects",
@@ -98676,6 +98785,14 @@
9867698785
"kind": "input-objects",
9867798786
"href": "/graphql/reference/input-objects#branchnamepatternparametersinput"
9867898787
},
98788+
{
98789+
"name": "codeScanning",
98790+
"description": "<p>Parameters used for the <code>code_scanning</code> rule type.</p>",
98791+
"type": "CodeScanningParametersInput",
98792+
"id": "codescanningparametersinput",
98793+
"kind": "input-objects",
98794+
"href": "/graphql/reference/input-objects#codescanningparametersinput"
98795+
},
9867998796
{
9868098797
"name": "commitAuthorEmailPattern",
9868198798
"description": "<p>Parameters used for the <code>commit_author_email_pattern</code> rule type.</p>",

‎src/graphql/data/ghec/schema.docs.graphql‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4326,6 +4326,76 @@ type CodeOfConduct implements Node {
43264326
url: URI
43274327
}
43284328

4329+
"""
4330+
Choose which tools must provide code scanning results before the reference is
4331+
updated. When configured, code scanning must be enabled and have results for
4332+
both the commit and the reference being updated.
4333+
"""
4334+
type CodeScanningParameters {
4335+
"""
4336+
Tools that must provide code scanning results for this rule to pass.
4337+
"""
4338+
codeScanningTools: [CodeScanningTool!]!
4339+
}
4340+
4341+
"""
4342+
Choose which tools must provide code scanning results before the reference is
4343+
updated. When configured, code scanning must be enabled and have results for
4344+
both the commit and the reference being updated.
4345+
"""
4346+
input CodeScanningParametersInput {
4347+
"""
4348+
Tools that must provide code scanning results for this rule to pass.
4349+
"""
4350+
codeScanningTools: [CodeScanningToolInput!]!
4351+
}
4352+
4353+
"""
4354+
A tool that must provide code scanning results for this rule to pass.
4355+
"""
4356+
type CodeScanningTool {
4357+
"""
4358+
The severity level at which code scanning results that raise alerts block a
4359+
reference update. For more information on alert severity levels, see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
4360+
"""
4361+
alertsThreshold: String!
4362+
4363+
"""
4364+
The severity level at which code scanning results that raise security alerts
4365+
block a reference update. For more information on security severity levels,
4366+
see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
4367+
"""
4368+
securityAlertsThreshold: String!
4369+
4370+
"""
4371+
The name of a code scanning tool
4372+
"""
4373+
tool: String!
4374+
}
4375+
4376+
"""
4377+
A tool that must provide code scanning results for this rule to pass.
4378+
"""
4379+
input CodeScanningToolInput {
4380+
"""
4381+
The severity level at which code scanning results that raise alerts block a
4382+
reference update. For more information on alert severity levels, see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
4383+
"""
4384+
alertsThreshold: String!
4385+
4386+
"""
4387+
The severity level at which code scanning results that raise security alerts
4388+
block a reference update. For more information on security severity levels,
4389+
see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
4390+
"""
4391+
securityAlertsThreshold: String!
4392+
4393+
"""
4394+
The name of a code scanning tool
4395+
"""
4396+
tool: String!
4397+
}
4398+
43294399
"""
43304400
Collaborators affiliation level with a subject.
43314401
"""
@@ -46404,6 +46474,13 @@ enum RepositoryRuleType {
4640446474
"""
4640546475
BRANCH_NAME_PATTERN
4640646476

46477+
"""
46478+
Choose which tools must provide code scanning results before the reference is
46479+
updated. When configured, code scanning must be enabled and have results for
46480+
both the commit and the reference being updated.
46481+
"""
46482+
CODE_SCANNING
46483+
4640746484
"""
4640846485
Committer email pattern
4640946486
"""
@@ -48162,6 +48239,7 @@ Types which can be parameters for `RepositoryRule` objects.
4816248239
"""
4816348240
union RuleParameters =
4816448241
BranchNamePatternParameters
48242+
| CodeScanningParameters
4816548243
| CommitAuthorEmailPatternParameters
4816648244
| CommitMessagePatternParameters
4816748245
| CommitterEmailPatternParameters
@@ -48185,6 +48263,11 @@ input RuleParametersInput {
4818548263
"""
4818648264
branchNamePattern: BranchNamePatternParametersInput
4818748265

48266+
"""
48267+
Parameters used for the `code_scanning` rule type
48268+
"""
48269+
codeScanning: CodeScanningParametersInput
48270+
4818848271
"""
4818948272
Parameters used for the `commit_author_email_pattern` rule type
4819048273
"""

0 commit comments

Comments
 (0)