Skip to content

Commit 25ebf10

Browse files
Update OpenAPI 3.1 Descriptions
1 parent cfd2822 commit 25ebf10

8 files changed

Lines changed: 36 additions & 0 deletions

File tree

descriptions-next/api.github.com/api.github.com.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27831,6 +27831,10 @@
2783127831
"tool_name": {
2783227832
"description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.",
2783327833
"type": "string"
27834+
},
27835+
"validate": {
27836+
"description": "Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.",
27837+
"type": "boolean"
2783427838
}
2783527839
},
2783627840
"required": [

descriptions-next/api.github.com/api.github.com.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20125,6 +20125,11 @@ paths:
2012520125
be available for filtering using the `tool_guid` parameter of
2012620126
operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.
2012720127
type: string
20128+
validate:
20129+
description: |-
20130+
Whether the SARIF file will be validated according to the code scanning specifications.
20131+
This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.
20132+
type: boolean
2012820133
required:
2012920134
- commit_sha
2013020135
- ref

descriptions-next/api.github.com/dereferenced/api.github.com.deref.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212707,6 +212707,10 @@
212707212707
"tool_name": {
212708212708
"description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.",
212709212709
"type": "string"
212710+
},
212711+
"validate": {
212712+
"description": "Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.",
212713+
"type": "boolean"
212710212714
}
212711212715
},
212712212716
"required": [

descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43110,6 +43110,11 @@ paths:
4311043110
be available for filtering using the `tool_guid` parameter of
4311143111
operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.
4311243112
type: string
43113+
validate:
43114+
description: |-
43115+
Whether the SARIF file will be validated according to the code scanning specifications.
43116+
This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.
43117+
type: boolean
4311343118
required:
4311443119
- commit_sha
4311543120
- ref

descriptions-next/ghec/dereferenced/ghec.deref.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216192,6 +216192,10 @@
216192216192
"tool_name": {
216193216193
"description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.",
216194216194
"type": "string"
216195+
},
216196+
"validate": {
216197+
"description": "Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.",
216198+
"type": "boolean"
216195216199
}
216196216200
},
216197216201
"required": [

descriptions-next/ghec/dereferenced/ghec.deref.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44646,6 +44646,11 @@ paths:
4464644646
be available for filtering using the `tool_guid` parameter of
4464744647
operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.
4464844648
type: string
44649+
validate:
44650+
description: |-
44651+
Whether the SARIF file will be validated according to the code scanning specifications.
44652+
This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.
44653+
type: boolean
4464944654
required:
4465044655
- commit_sha
4465144656
- ref

descriptions-next/ghec/ghec.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29067,6 +29067,10 @@
2906729067
"tool_name": {
2906829068
"description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.",
2906929069
"type": "string"
29070+
},
29071+
"validate": {
29072+
"description": "Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.",
29073+
"type": "boolean"
2907029074
}
2907129075
},
2907229076
"required": [

descriptions-next/ghec/ghec.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20987,6 +20987,11 @@ paths:
2098720987
be available for filtering using the `tool_guid` parameter of
2098820988
operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.
2098920989
type: string
20990+
validate:
20991+
description: |-
20992+
Whether the SARIF file will be validated according to the code scanning specifications.
20993+
This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.
20994+
type: boolean
2099020995
required:
2099120996
- commit_sha
2099220997
- ref

0 commit comments

Comments
 (0)