Skip to content

Commit 00d43be

Browse files
timrogerstimrogers
authored
Merge pull request #1499 from github/openapi-update-181abc7c427e2fa8bc11f03290f77edc53f37be2ee0e6646c3eec0605f51a266
Update OpenAPI 3.0 Descriptions
2 parents 3d94b69 + 2fbca81 commit 00d43be

28 files changed

Lines changed: 279 additions & 28 deletions

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61877,6 +61877,11 @@
6187761877
"nullable": true,
6187861878
"type": "string",
6187961879
"description": "Detailed documentation for the rule as GitHub Flavored Markdown."
61880+
},
61881+
"help_uri": {
61882+
"nullable": true,
61883+
"type": "string",
61884+
"description": "A link to the documentation for the rule used to detect the alert."
6188061885
}
6188161886
}
6188261887
},
@@ -98653,7 +98658,8 @@
9865398658
"security",
9865498659
"external/cwe/cwe-022"
9865598660
],
98656-
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
98661+
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
98662+
"help_uri": "https://codeql.github.com/"
9865798663
},
9865898664
"tool": {
9865998665
"name": "CodeQL",
@@ -98725,7 +98731,8 @@
9872598731
"security",
9872698732
"external/cwe/cwe-022"
9872798733
],
98728-
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
98734+
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
98735+
"help_uri": "https://codeql.github.com/"
9872998736
},
9873098737
"tool": {
9873198738
"name": "CodeQL",

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44726,6 +44726,11 @@ components:
4472644726
nullable: true
4472744727
type: string
4472844728
description: Detailed documentation for the rule as GitHub Flavored Markdown.
44729+
help_uri:
44730+
nullable: true
44731+
type: string
44732+
description: A link to the documentation for the rule used to detect the
44733+
alert.
4472944734
code-scanning-analysis-tool-version:
4473044735
nullable: true
4473144736
type: string
@@ -74543,6 +74548,7 @@ components:
7454374548
files from a malicious zip archive without validating that the destination
7454474549
file path is within the destination directory can cause files outside
7454574550
the destination directory to be overwritten ...'
74551+
help_uri: https://codeql.github.com/
7454674552
tool:
7454774553
name: CodeQL
7454874554
guid:
@@ -74611,6 +74617,7 @@ components:
7461174617
files from a malicious zip archive without validating that the destination
7461274618
file path is within the destination directory can cause files outside
7461374619
the destination directory to be overwritten ...'
74620+
help_uri: https://codeql.github.com/
7461474621
tool:
7461574622
name: CodeQL
7461674623
guid:

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

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19179,6 +19179,11 @@
1917919179
"nullable": true,
1918019180
"type": "string",
1918119181
"description": "Detailed documentation for the rule as GitHub Flavored Markdown."
19182+
},
19183+
"help_uri": {
19184+
"nullable": true,
19185+
"type": "string",
19186+
"description": "A link to the documentation for the rule used to detect the alert."
1918219187
}
1918319188
}
1918419189
},
@@ -65834,6 +65839,11 @@
6583465839
"nullable": true,
6583565840
"type": "string",
6583665841
"description": "Detailed documentation for the rule as GitHub Flavored Markdown."
65842+
},
65843+
"help_uri": {
65844+
"nullable": true,
65845+
"type": "string",
65846+
"description": "A link to the documentation for the rule used to detect the alert."
6583765847
}
6583865848
}
6583965849
},
@@ -204663,6 +204673,11 @@
204663204673
"nullable": true,
204664204674
"type": "string",
204665204675
"description": "Detailed documentation for the rule as GitHub Flavored Markdown."
204676+
},
204677+
"help_uri": {
204678+
"nullable": true,
204679+
"type": "string",
204680+
"description": "A link to the documentation for the rule used to detect the alert."
204666204681
}
204667204682
}
204668204683
},
@@ -204825,7 +204840,8 @@
204825204840
"security",
204826204841
"external/cwe/cwe-022"
204827204842
],
204828-
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
204843+
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
204844+
"help_uri": "https://codeql.github.com/"
204829204845
},
204830204846
"tool": {
204831204847
"name": "CodeQL",
@@ -205292,6 +205308,11 @@
205292205308
"nullable": true,
205293205309
"type": "string",
205294205310
"description": "Detailed documentation for the rule as GitHub Flavored Markdown."
205311+
},
205312+
"help_uri": {
205313+
"nullable": true,
205314+
"type": "string",
205315+
"description": "A link to the documentation for the rule used to detect the alert."
205295205316
}
205296205317
}
205297205318
},
@@ -205454,7 +205475,8 @@
205454205475
"security",
205455205476
"external/cwe/cwe-022"
205456205477
],
205457-
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
205478+
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
205479+
"help_uri": "https://codeql.github.com/"
205458205480
},
205459205481
"tool": {
205460205482
"name": "CodeQL",

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8015,6 +8015,11 @@ paths:
80158015
type: string
80168016
description: Detailed documentation for the rule as GitHub
80178017
Flavored Markdown.
8018+
help_uri:
8019+
nullable: true
8020+
type: string
8021+
description: A link to the documentation for the rule used
8022+
to detect the alert.
80188023
tool: &293
80198024
type: object
80208025
properties:
@@ -41191,6 +41196,7 @@ paths:
4119141196
the destination file path is within the destination directory
4119241197
can cause files outside the destination directory to be overwritten
4119341198
...'
41199+
help_uri: https://codeql.github.com/
4119441200
tool:
4119541201
name: CodeQL
4119641202
guid:
@@ -41320,6 +41326,7 @@ paths:
4132041326
the destination file path is within the destination directory
4132141327
can cause files outside the destination directory to be overwritten
4132241328
...'
41329+
help_uri: https://codeql.github.com/
4132341330
tool:
4132441331
name: CodeQL
4132541332
guid:

‎descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.json‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167179,6 +167179,11 @@
167179167179
"nullable": true,
167180167180
"type": "string",
167181167181
"description": "Detailed documentation for the rule as GitHub Flavored Markdown."
167182+
},
167183+
"help_uri": {
167184+
"nullable": true,
167185+
"type": "string",
167186+
"description": "A link to the documentation for the rule used to detect the alert."
167182167187
}
167183167188
}
167184167189
},
@@ -167341,7 +167346,8 @@
167341167346
"security",
167342167347
"external/cwe/cwe-022"
167343167348
],
167344-
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
167349+
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
167350+
"help_uri": "https://codeql.github.com/"
167345167351
},
167346167352
"tool": {
167347167353
"name": "CodeQL",
@@ -167780,6 +167786,11 @@
167780167786
"nullable": true,
167781167787
"type": "string",
167782167788
"description": "Detailed documentation for the rule as GitHub Flavored Markdown."
167789+
},
167790+
"help_uri": {
167791+
"nullable": true,
167792+
"type": "string",
167793+
"description": "A link to the documentation for the rule used to detect the alert."
167783167794
}
167784167795
}
167785167796
},
@@ -167942,7 +167953,8 @@
167942167953
"security",
167943167954
"external/cwe/cwe-022"
167944167955
],
167945-
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
167956+
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
167957+
"help_uri": "https://codeql.github.com/"
167946167958
},
167947167959
"tool": {
167948167960
"name": "CodeQL",

‎descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35427,6 +35427,11 @@ paths:
3542735427
type: string
3542835428
description: Detailed documentation for the rule as GitHub
3542935429
Flavored Markdown.
35430+
help_uri:
35431+
nullable: true
35432+
type: string
35433+
description: A link to the documentation for the rule used
35434+
to detect the alert.
3543035435
tool: *243
3543135436
most_recent_instance: *244
3543235437
instances:
@@ -35491,6 +35496,7 @@ paths:
3549135496
the destination file path is within the destination directory
3549235497
can cause files outside the destination directory to be overwritten
3549335498
...'
35499+
help_uri: https://codeql.github.com/
3549435500
tool:
3549535501
name: CodeQL
3549635502
guid:
@@ -35612,6 +35618,7 @@ paths:
3561235618
the destination file path is within the destination directory
3561335619
can cause files outside the destination directory to be overwritten
3561435620
...'
35621+
help_uri: https://codeql.github.com/
3561535622
tool:
3561635623
name: CodeQL
3561735624
guid:

0 commit comments

Comments
 (0)