Skip to content

Commit b92491b

Browse files
docs-botSiaraMist
docs-bot
and
SiaraMist
authored
Update OpenAPI Description (#53879)
Co-authored-by: Siara <[email protected]>
1 parent cf53fa9 commit b92491b

File tree

11 files changed

+547
-115
lines changed

11 files changed

+547
-115
lines changed

‎src/github-apps/lib/config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "917eb60d24132049c50cea80b1e4e8eb3ea4716e"
63+
"sha": "04d2822d65627912d8772ac6f67d3b8cb9acea31"
6464
}

‎src/rest/lib/config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,5 @@
5050
]
5151
}
5252
},
53-
"sha": "917eb60d24132049c50cea80b1e4e8eb3ea4716e"
53+
"sha": "04d2822d65627912d8772ac6f67d3b8cb9acea31"
5454
}

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

Lines changed: 68 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10700,6 +10700,11 @@
1070010700
}
1070110701
]
1070210702
},
10703+
{
10704+
"type": "string or null",
10705+
"name": "dismissed_comment",
10706+
"description": "<p>The dismissal comment associated with the dismissal of the alert.</p>"
10707+
},
1070310708
{
1070410709
"type": "string or null",
1070510710
"name": "dismissed_reason",
@@ -10712,6 +10717,11 @@
1071210717
null
1071310718
]
1071410719
},
10720+
{
10721+
"type": "null",
10722+
"name": "fixed_at",
10723+
"description": "<p>The time that the alert was fixed in ISO 8601 format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>"
10724+
},
1071510725
{
1071610726
"type": "string",
1071710727
"name": "html_url",
@@ -10853,14 +10863,15 @@
1085310863
]
1085410864
},
1085510865
{
10856-
"type": "string",
10866+
"type": "string or null",
1085710867
"name": "state",
10858-
"description": "<p>State of a code scanning alert.</p>",
10868+
"description": "<p>State of a code scanning alert. Events for alerts found outside the default branch will return a <code>null</code> value until they are dismissed or fixed.</p>",
1085910869
"isRequired": true,
1086010870
"enum": [
1086110871
"open",
1086210872
"dismissed",
10863-
"fixed"
10873+
"fixed",
10874+
null
1086410875
]
1086510876
},
1086610877
{
@@ -11110,6 +11121,11 @@
1111011121
}
1111111122
]
1111211123
},
11124+
{
11125+
"type": "string or null",
11126+
"name": "dismissed_comment",
11127+
"description": "<p>The dismissal comment associated with the dismissal of the alert.</p>"
11128+
},
1111311129
{
1111411130
"type": "string or null",
1111511131
"name": "dismissed_reason",
@@ -11122,6 +11138,11 @@
1112211138
null
1112311139
]
1112411140
},
11141+
{
11142+
"type": "null",
11143+
"name": "fixed_at",
11144+
"description": "<p>The time that the alert was fixed in ISO 8601 format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>"
11145+
},
1112511146
{
1112611147
"type": "string",
1112711148
"name": "html_url",
@@ -11444,7 +11465,7 @@
1144411465
{
1144511466
"type": "null",
1144611467
"name": "fixed_at",
11447-
"description": ""
11468+
"description": "<p>The time that the alert was fixed in ISO 8601 format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>"
1144811469
},
1144911470
{
1145011471
"type": "string",
@@ -11619,7 +11640,7 @@
1161911640
{
1162011641
"type": "string or null",
1162111642
"name": "state",
11622-
"description": "<p>State of a code scanning alert.</p>",
11643+
"description": "<p>State of a code scanning alert. Events for alerts found outside the default branch will return a <code>null</code> value until they are dismissed or fixed.</p>",
1162311644
"isRequired": true,
1162411645
"enum": [
1162511646
"open",
@@ -11884,6 +11905,11 @@
1188411905
}
1188511906
]
1188611907
},
11908+
{
11909+
"type": "string or null",
11910+
"name": "dismissed_comment",
11911+
"description": "<p>The dismissal comment associated with the dismissal of the alert.</p>"
11912+
},
1188711913
{
1188811914
"type": "string or null",
1188911915
"name": "dismissed_reason",
@@ -11896,6 +11922,11 @@
1189611922
null
1189711923
]
1189811924
},
11925+
{
11926+
"type": "null",
11927+
"name": "fixed_at",
11928+
"description": "<p>The time that the alert was fixed in ISO 8601 format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>"
11929+
},
1189911930
{
1190011931
"type": "string",
1190111932
"name": "html_url",
@@ -12067,12 +12098,13 @@
1206712098
]
1206812099
},
1206912100
{
12070-
"type": "string",
12101+
"type": "string or null",
1207112102
"name": "state",
12072-
"description": "<p>State of a code scanning alert.</p>",
12103+
"description": "<p>State of a code scanning alert. Events for alerts found outside the default branch will return a <code>null</code> value until they are dismissed or fixed.</p>",
1207312104
"isRequired": true,
1207412105
"enum": [
12075-
"fixed"
12106+
"fixed",
12107+
null
1207612108
]
1207712109
},
1207812110
{
@@ -12208,12 +12240,22 @@
1220812240
"description": "",
1220912241
"isRequired": true
1221012242
},
12243+
{
12244+
"type": "string or null",
12245+
"name": "dismissed_comment",
12246+
"description": "<p>The dismissal comment associated with the dismissal of the alert.</p>"
12247+
},
1221112248
{
1221212249
"type": "string or null",
1221312250
"name": "dismissed_reason",
1221412251
"description": "<p>The reason for dismissing or closing the alert. Can be one of: <code>false positive</code>, <code>won't fix</code>, and <code>used in tests</code>.</p>",
1221512252
"isRequired": true
1221612253
},
12254+
{
12255+
"type": "null",
12256+
"name": "fixed_at",
12257+
"description": "<p>The time that the alert was fixed in ISO 8601 format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>"
12258+
},
1221712259
{
1221812260
"type": "string",
1221912261
"name": "html_url",
@@ -12380,14 +12422,15 @@
1238012422
]
1238112423
},
1238212424
{
12383-
"type": "string",
12425+
"type": "string or null",
1238412426
"name": "state",
12385-
"description": "<p>State of a code scanning alert.</p>",
12427+
"description": "<p>State of a code scanning alert. Events for alerts found outside the default branch will return a <code>null</code> value until they are dismissed or fixed.</p>",
1238612428
"isRequired": true,
1238712429
"enum": [
1238812430
"open",
1238912431
"dismissed",
12390-
"fixed"
12432+
"fixed",
12433+
null
1239112434
]
1239212435
},
1239312436
{
@@ -12523,12 +12566,22 @@
1252312566
"description": "",
1252412567
"isRequired": true
1252512568
},
12569+
{
12570+
"type": "string or null",
12571+
"name": "dismissed_comment",
12572+
"description": "<p>The dismissal comment associated with the dismissal of the alert.</p>"
12573+
},
1252612574
{
1252712575
"type": "null",
1252812576
"name": "dismissed_reason",
1252912577
"description": "<p>The reason for dismissing or closing the alert. Can be one of: <code>false positive</code>, <code>won't fix</code>, and <code>used in tests</code>.</p>",
1253012578
"isRequired": true
1253112579
},
12580+
{
12581+
"type": "null",
12582+
"name": "fixed_at",
12583+
"description": "<p>The time that the alert was fixed in ISO 8601 format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>"
12584+
},
1253212585
{
1253312586
"type": "string",
1253412587
"name": "html_url",
@@ -12670,13 +12723,14 @@
1267012723
]
1267112724
},
1267212725
{
12673-
"type": "string",
12726+
"type": "string or null",
1267412727
"name": "state",
12675-
"description": "<p>State of a code scanning alert.</p>",
12728+
"description": "<p>State of a code scanning alert. Events for alerts found outside the default branch will return a <code>null</code> value until they are dismissed or fixed.</p>",
1267612729
"isRequired": true,
1267712730
"enum": [
1267812731
"open",
12679-
"fixed"
12732+
"fixed",
12733+
null
1268012734
]
1268112735
},
1268212736
{

0 commit comments

Comments
 (0)