Skip to content

Commit 72be1ed

Browse files
Update OpenAPI 3.0 Descriptions
1 parent cfd2822 commit 72be1ed

8 files changed

Lines changed: 36 additions & 0 deletions

File tree

descriptions/api.github.com/api.github.com.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27693,6 +27693,10 @@
2769327693
"tool_name": {
2769427694
"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`.",
2769527695
"type": "string"
27696+
},
27697+
"validate": {
27698+
"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.",
27699+
"type": "boolean"
2769627700
}
2769727701
},
2769827702
"required": [

descriptions/api.github.com/api.github.com.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20059,6 +20059,11 @@ paths:
2005920059
be available for filtering using the `tool_guid` parameter of
2006020060
operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.
2006120061
type: string
20062+
validate:
20063+
description: |-
20064+
Whether the SARIF file will be validated according to the code scanning specifications.
20065+
This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.
20066+
type: boolean
2006220067
required:
2006320068
- commit_sha
2006420069
- ref

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181745,6 +181745,10 @@
181745181745
"tool_name": {
181746181746
"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`.",
181747181747
"type": "string"
181748+
},
181749+
"validate": {
181750+
"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.",
181751+
"type": "boolean"
181748181752
}
181749181753
},
181750181754
"required": [

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41938,6 +41938,11 @@ paths:
4193841938
be available for filtering using the `tool_guid` parameter of
4193941939
operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.
4194041940
type: string
41941+
validate:
41942+
description: |-
41943+
Whether the SARIF file will be validated according to the code scanning specifications.
41944+
This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.
41945+
type: boolean
4194141946
required:
4194241947
- commit_sha
4194341948
- ref

descriptions/ghec/dereferenced/ghec.deref.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185084,6 +185084,10 @@
185084185084
"tool_name": {
185085185085
"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`.",
185086185086
"type": "string"
185087+
},
185088+
"validate": {
185089+
"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.",
185090+
"type": "boolean"
185087185091
}
185088185092
},
185089185093
"required": [

descriptions/ghec/dereferenced/ghec.deref.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43433,6 +43433,11 @@ paths:
4343343433
be available for filtering using the `tool_guid` parameter of
4343443434
operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.
4343543435
type: string
43436+
validate:
43437+
description: |-
43438+
Whether the SARIF file will be validated according to the code scanning specifications.
43439+
This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.
43440+
type: boolean
4343643441
required:
4343743442
- commit_sha
4343843443
- ref

descriptions/ghec/ghec.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28927,6 +28927,10 @@
2892728927
"tool_name": {
2892828928
"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`.",
2892928929
"type": "string"
28930+
},
28931+
"validate": {
28932+
"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.",
28933+
"type": "boolean"
2893028934
}
2893128935
},
2893228936
"required": [

descriptions/ghec/ghec.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20920,6 +20920,11 @@ paths:
2092020920
be available for filtering using the `tool_guid` parameter of
2092120921
operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.
2092220922
type: string
20923+
validate:
20924+
description: |-
20925+
Whether the SARIF file will be validated according to the code scanning specifications.
20926+
This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.
20927+
type: boolean
2092320928
required:
2092420929
- commit_sha
2092520930
- ref

0 commit comments

Comments
 (0)