Update OpenAPI Descriptions (github#27040)

github-openapi-bot · vgrl · web-flow · commit 68e1c0f3191b · 2022-04-20T09:01:59.000+10:00
* Update OpenAPI  Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot &lt;github-openapi-bot@users.noreply.github.com&gt;
Co-authored-by: Vanessa &lt;vgrl@github.com&gt;
diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json
@@ -33324,6 +33324,19 @@
             ],
             "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
             "childParamsGroups": []
+          },
+          {
+            "type": "string or null",
+            "description": "<p>The dismissal note associated with the dismissal of the alert.</p>",
+            "maxLength": 280,
+            "name": "dismissed_note",
+            "in": "body",
+            "rawType": [
+              "string",
+              "null"
+            ],
+            "rawDescription": "The dismissal note associated with the dismissal of the alert.",
+            "childParamsGroups": []
           }
         ],
         "enabledForGitHubApps": true,
@@ -33336,7 +33349,8 @@
               "acceptHeader": "application/vnd.github.v3+json",
               "bodyParameters": {
                 "state": "dismissed",
-                "dismissed_reason": "false positive"
+                "dismissed_reason": "false positive",
+                "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library."
               },
               "parameters": {
                 "owner": "OWNER",
diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json
@@ -26956,7 +26956,8 @@
               "acceptHeader": "application/vnd.github.v3+json",
               "bodyParameters": {
                 "state": "dismissed",
-                "dismissed_reason": "false positive"
+                "dismissed_reason": "false positive",
+                "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library."
               },
               "parameters": {
                 "owner": "OWNER",
diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json
@@ -28024,7 +28024,8 @@
               "acceptHeader": "application/vnd.github.v3+json",
               "bodyParameters": {
                 "state": "dismissed",
-                "dismissed_reason": "false positive"
+                "dismissed_reason": "false positive",
+                "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library."
               },
               "parameters": {
                 "owner": "OWNER",
diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json
@@ -28178,7 +28178,8 @@
               "acceptHeader": "application/vnd.github.v3+json",
               "bodyParameters": {
                 "state": "dismissed",
-                "dismissed_reason": "false positive"
+                "dismissed_reason": "false positive",
+                "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library."
               },
               "parameters": {
                 "owner": "OWNER",
diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json
@@ -29611,7 +29611,8 @@
               "acceptHeader": "application/vnd.github.v3+json",
               "bodyParameters": {
                 "state": "dismissed",
-                "dismissed_reason": "false positive"
+                "dismissed_reason": "false positive",
+                "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library."
               },
               "parameters": {
                 "owner": "OWNER",
diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json
@@ -25475,7 +25475,8 @@
               "acceptHeader": "application/vnd.github.v3+json",
               "bodyParameters": {
                 "state": "dismissed",
-                "dismissed_reason": "false positive"
+                "dismissed_reason": "false positive",
+                "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library."
               },
               "parameters": {
                 "owner": "OWNER",
diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json
@@ -230590,6 +230590,14 @@
                       "won't fix",
                       "used in tests"
                     ]
+                  },
+                  "dismissed_note": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "description": "The dismissal note associated with the dismissal of the alert.",
+                    "maxLength": 280
                   }
                 },
                 "required": [
@@ -230600,7 +230608,8 @@
                 "default": {
                   "value": {
                     "state": "dismissed",
-                    "dismissed_reason": "false positive"
+                    "dismissed_reason": "false positive",
+                    "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library."
                   }
                 }
               }
diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json
@@ -186897,7 +186897,8 @@
                 "default": {
                   "value": {
                     "state": "dismissed",
-                    "dismissed_reason": "false positive"
+                    "dismissed_reason": "false positive",
+                    "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library."
                   }
                 }
               }
diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json
diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json
diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json
diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json

Original file line number	Diff line number	Diff line change
`@@ -230590,6 +230590,14 @@`
`230590`	`230590`	`"won't fix",`
`230591`	`230591`	`"used in tests"`
`230592`	`230592`	`]`
	`230593`	`+ },`
	`230594`	`+ "dismissed_note": {`
	`230595`	`+ "type": [`
	`230596`	`+ "string",`
	`230597`	`+ "null"`
	`230598`	`+ ],`
	`230599`	`+ "description": "The dismissal note associated with the dismissal of the alert.",`
	`230600`	`+ "maxLength": 280`
`230593`	`230601`	`}`
`230594`	`230602`	`},`
`230595`	`230603`	`"required": [`
`@@ -230600,7 +230608,8 @@`
`230600`	`230608`	`"default": {`
`230601`	`230609`	`"value": {`
`230602`	`230610`	`"state": "dismissed",`
`230603`		`- "dismissed_reason": "false positive"`
	`230611`	`+ "dismissed_reason": "false positive",`
	`230612`	`+ "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library."`
`230604`	`230613`	`}`
`230605`	`230614`	`}`
`230606`	`230615`	`}`
Original file line number	Diff line number	Diff line change
`@@ -186897,7 +186897,8 @@`
`186897`	`186897`	`"default": {`
`186898`	`186898`	`"value": {`
`186899`	`186899`	`"state": "dismissed",`
`186900`		`- "dismissed_reason": "false positive"`
	`186900`	`+ "dismissed_reason": "false positive",`
	`186901`	`+ "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library."`
`186901`	`186902`	`}`
`186902`	`186903`	`}`
`186903`	`186904`	`}`