Skip to content

Commit 02c09ec

Browse files
docs-botsabrowning1
docs-bot
and
sabrowning1
authored
Update OpenAPI Description (#56387)
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
1 parent b63d9f0 commit 02c09ec

28 files changed

+2007
-490
lines changed

‎content/rest/code-scanning/alert-dismissal-requests.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: REST API endpoints for {% data variables.product.prodname_code_scanning %} alert dismissal requests
3+
shortTitle: Alert dismissal requests
4+
intro: Use the REST API to interact with {% data variables.product.prodname_code_scanning %} alert dismissal requests from a repository.
5+
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
6+
ghec: '*'
7+
topics:
8+
- API
9+
autogenerated: rest
10+
allowTitleToDifferFromFilename: true
11+
---
12+
13+
<!-- Content after this section is automatically generated -->

‎content/rest/code-scanning/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ topics:
1414
- Code scanning
1515
- REST
1616
children:
17+
- /alert-dismissal-requests
1718
- /code-scanning
1819
autogenerated: rest
1920
---

‎src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8288,4 +8288,4 @@
82888288
}
82898289
]
82908290
}
8291-
}
8291+
}

‎src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json

Lines changed: 72 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"enterprise_custom_properties": {
33
"title": "Custom properties",
4-
"displayTitle": "Business permissions for \"Custom properties\"",
4+
"displayTitle": "Enterprise permissions for \"Custom properties\"",
55
"permissions": [
66
{
77
"category": "enterprise-admin",
@@ -61,7 +61,7 @@
6161
},
6262
"enterprise_scim": {
6363
"title": "Enterprise SCIM",
64-
"displayTitle": "Business permissions for \"Enterprise SCIM\"",
64+
"displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
6565
"permissions": [
6666
{
6767
"category": "enterprise-admin",
@@ -2264,6 +2264,48 @@
22642264
}
22652265
]
22662266
},
2267+
"organization_code_scanning_dismissal_requests": {
2268+
"title": "Organization dismissal requests for code scanning",
2269+
"displayTitle": "Organization permissions for \"Organization dismissal requests for code scanning\"",
2270+
"permissions": [
2271+
{
2272+
"category": "code-scanning",
2273+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-an-organization",
2274+
"subcategory": "alert-dismissal-requests",
2275+
"verb": "get",
2276+
"requestPath": "/orgs/{org}/dismissal-requests/code-scanning",
2277+
"additional-permissions": false,
2278+
"access": "read"
2279+
},
2280+
{
2281+
"category": "code-scanning",
2282+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
2283+
"subcategory": "alert-dismissal-requests",
2284+
"verb": "get",
2285+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning",
2286+
"additional-permissions": true,
2287+
"access": "read"
2288+
},
2289+
{
2290+
"category": "code-scanning",
2291+
"slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
2292+
"subcategory": "alert-dismissal-requests",
2293+
"verb": "get",
2294+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
2295+
"additional-permissions": true,
2296+
"access": "read"
2297+
},
2298+
{
2299+
"category": "code-scanning",
2300+
"slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
2301+
"subcategory": "alert-dismissal-requests",
2302+
"verb": "patch",
2303+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
2304+
"additional-permissions": true,
2305+
"access": "write"
2306+
}
2307+
]
2308+
},
22672309
"organization_private_registries": {
22682310
"title": "Organization private registries",
22692311
"displayTitle": "Organization permissions for \"Organization private registries\"",
@@ -4961,6 +5003,33 @@
49615003
"requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}",
49625004
"additional-permissions": false,
49635005
"access": "read"
5006+
},
5007+
{
5008+
"category": "code-scanning",
5009+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
5010+
"subcategory": "alert-dismissal-requests",
5011+
"verb": "get",
5012+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning",
5013+
"additional-permissions": true,
5014+
"access": "read"
5015+
},
5016+
{
5017+
"category": "code-scanning",
5018+
"slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
5019+
"subcategory": "alert-dismissal-requests",
5020+
"verb": "get",
5021+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
5022+
"additional-permissions": true,
5023+
"access": "read"
5024+
},
5025+
{
5026+
"category": "code-scanning",
5027+
"slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
5028+
"subcategory": "alert-dismissal-requests",
5029+
"verb": "patch",
5030+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
5031+
"additional-permissions": true,
5032+
"access": "read"
49645033
}
49655034
]
49665035
},
@@ -9002,4 +9071,4 @@
90029071
}
90039072
]
90049073
}
9005-
}
9074+
}

‎src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1512,6 +1512,12 @@
15121512
"verb": "get",
15131513
"requestPath": "/orgs/{org}/code-scanning/alerts"
15141514
},
1515+
{
1516+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-an-organization",
1517+
"subcategory": "alert-dismissal-requests",
1518+
"verb": "get",
1519+
"requestPath": "/orgs/{org}/dismissal-requests/code-scanning"
1520+
},
15151521
{
15161522
"slug": "list-code-scanning-alerts-for-a-repository",
15171523
"subcategory": "code-scanning",
@@ -1631,6 +1637,24 @@
16311637
"subcategory": "code-scanning",
16321638
"verb": "get",
16331639
"requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"
1640+
},
1641+
{
1642+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
1643+
"subcategory": "alert-dismissal-requests",
1644+
"verb": "get",
1645+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning"
1646+
},
1647+
{
1648+
"slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
1649+
"subcategory": "alert-dismissal-requests",
1650+
"verb": "get",
1651+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
1652+
},
1653+
{
1654+
"slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
1655+
"subcategory": "alert-dismissal-requests",
1656+
"verb": "patch",
1657+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
16341658
}
16351659
],
16361660
"code-security": [

‎src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"enterprise_custom_properties": {
33
"title": "Custom properties",
4-
"displayTitle": "Business permissions for \"Custom properties\"",
4+
"displayTitle": "Enterprise permissions for \"Custom properties\"",
55
"permissions": [
66
{
77
"category": "enterprise-admin",
@@ -73,7 +73,7 @@
7373
},
7474
"enterprise_scim": {
7575
"title": "Enterprise SCIM",
76-
"displayTitle": "Business permissions for \"Enterprise SCIM\"",
76+
"displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
7777
"permissions": [
7878
{
7979
"category": "enterprise-admin",
@@ -2742,6 +2742,56 @@
27422742
}
27432743
]
27442744
},
2745+
"organization_code_scanning_dismissal_requests": {
2746+
"title": "Organization dismissal requests for code scanning",
2747+
"displayTitle": "Organization permissions for \"Organization dismissal requests for code scanning\"",
2748+
"permissions": [
2749+
{
2750+
"category": "code-scanning",
2751+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-an-organization",
2752+
"subcategory": "alert-dismissal-requests",
2753+
"verb": "get",
2754+
"requestPath": "/orgs/{org}/dismissal-requests/code-scanning",
2755+
"access": "read",
2756+
"user-to-server": true,
2757+
"server-to-server": true,
2758+
"additional-permissions": false
2759+
},
2760+
{
2761+
"category": "code-scanning",
2762+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
2763+
"subcategory": "alert-dismissal-requests",
2764+
"verb": "get",
2765+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning",
2766+
"access": "read",
2767+
"user-to-server": true,
2768+
"server-to-server": true,
2769+
"additional-permissions": true
2770+
},
2771+
{
2772+
"category": "code-scanning",
2773+
"slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
2774+
"subcategory": "alert-dismissal-requests",
2775+
"verb": "get",
2776+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
2777+
"access": "read",
2778+
"user-to-server": true,
2779+
"server-to-server": true,
2780+
"additional-permissions": true
2781+
},
2782+
{
2783+
"category": "code-scanning",
2784+
"slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
2785+
"subcategory": "alert-dismissal-requests",
2786+
"verb": "patch",
2787+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
2788+
"access": "write",
2789+
"user-to-server": true,
2790+
"server-to-server": true,
2791+
"additional-permissions": true
2792+
}
2793+
]
2794+
},
27452795
"organization_private_registries": {
27462796
"title": "Organization private registries",
27472797
"displayTitle": "Organization permissions for \"Organization private registries\"",
@@ -6019,6 +6069,39 @@
60196069
"user-to-server": true,
60206070
"server-to-server": true,
60216071
"additional-permissions": false
6072+
},
6073+
{
6074+
"category": "code-scanning",
6075+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
6076+
"subcategory": "alert-dismissal-requests",
6077+
"verb": "get",
6078+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning",
6079+
"access": "read",
6080+
"user-to-server": true,
6081+
"server-to-server": true,
6082+
"additional-permissions": true
6083+
},
6084+
{
6085+
"category": "code-scanning",
6086+
"slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
6087+
"subcategory": "alert-dismissal-requests",
6088+
"verb": "get",
6089+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
6090+
"access": "read",
6091+
"user-to-server": true,
6092+
"server-to-server": true,
6093+
"additional-permissions": true
6094+
},
6095+
{
6096+
"category": "code-scanning",
6097+
"slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
6098+
"subcategory": "alert-dismissal-requests",
6099+
"verb": "patch",
6100+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
6101+
"access": "read",
6102+
"user-to-server": true,
6103+
"server-to-server": true,
6104+
"additional-permissions": true
60226105
}
60236106
]
60246107
},

‎src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1408,6 +1408,12 @@
14081408
"verb": "get",
14091409
"requestPath": "/orgs/{org}/code-scanning/alerts"
14101410
},
1411+
{
1412+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-an-organization",
1413+
"subcategory": "alert-dismissal-requests",
1414+
"verb": "get",
1415+
"requestPath": "/orgs/{org}/dismissal-requests/code-scanning"
1416+
},
14111417
{
14121418
"slug": "list-code-scanning-alerts-for-a-repository",
14131419
"subcategory": "code-scanning",
@@ -1527,6 +1533,24 @@
15271533
"subcategory": "code-scanning",
15281534
"verb": "get",
15291535
"requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"
1536+
},
1537+
{
1538+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
1539+
"subcategory": "alert-dismissal-requests",
1540+
"verb": "get",
1541+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning"
1542+
},
1543+
{
1544+
"slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
1545+
"subcategory": "alert-dismissal-requests",
1546+
"verb": "get",
1547+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
1548+
},
1549+
{
1550+
"slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
1551+
"subcategory": "alert-dismissal-requests",
1552+
"verb": "patch",
1553+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
15301554
}
15311555
],
15321556
"code-security": [

‎src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1512,6 +1512,12 @@
15121512
"verb": "get",
15131513
"requestPath": "/orgs/{org}/code-scanning/alerts"
15141514
},
1515+
{
1516+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-an-organization",
1517+
"subcategory": "alert-dismissal-requests",
1518+
"verb": "get",
1519+
"requestPath": "/orgs/{org}/dismissal-requests/code-scanning"
1520+
},
15151521
{
15161522
"slug": "list-code-scanning-alerts-for-a-repository",
15171523
"subcategory": "code-scanning",
@@ -1631,6 +1637,24 @@
16311637
"subcategory": "code-scanning",
16321638
"verb": "get",
16331639
"requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"
1640+
},
1641+
{
1642+
"slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
1643+
"subcategory": "alert-dismissal-requests",
1644+
"verb": "get",
1645+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning"
1646+
},
1647+
{
1648+
"slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
1649+
"subcategory": "alert-dismissal-requests",
1650+
"verb": "get",
1651+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
1652+
},
1653+
{
1654+
"slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
1655+
"subcategory": "alert-dismissal-requests",
1656+
"verb": "patch",
1657+
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
16341658
}
16351659
],
16361660
"code-security": [

‎src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat-permissions.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"enterprise_scim": {
33
"title": "Enterprise SCIM",
4-
"displayTitle": "Business permissions for \"Enterprise SCIM\"",
4+
"displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
55
"permissions": [
66
{
77
"category": "enterprise-admin",
@@ -6527,4 +6527,4 @@
65276527
}
65286528
]
65296529
}
6530-
}
6530+
}

‎src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-permissions.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"enterprise_scim": {
33
"title": "Enterprise SCIM",
4-
"displayTitle": "Business permissions for \"Enterprise SCIM\"",
4+
"displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
55
"permissions": [
66
{
77
"category": "enterprise-admin",

0 commit comments

Comments
 (0)