Skip to content

Commit 239211f

Browse files
docs-botrachaelrenk
docs-bot
and
rachaelrenk
authored
Update OpenAPI Description (#54572)
Co-authored-by: Rachael Rose Renk <[email protected]>
1 parent f9569c0 commit 239211f

File tree

17 files changed

+2594
-250
lines changed

17 files changed

+2594
-250
lines changed

‎content/rest/secret-scanning/delegated-bypass.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: REST API endpoints for push protection bypass requests
3+
shortTitle: Push protection bypass
4+
intro: Use the REST API to manage push protection bypass requests for secret scanning.
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/secret-scanning/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ versions:
1010
topics:
1111
- API
1212
children:
13+
- /delegated-bypass
1314
- /secret-scanning
1415
autogenerated: rest
1516
---

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

+54
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,15 @@
2121
"additional-permissions": false,
2222
"access": "write"
2323
},
24+
{
25+
"category": "enterprise-admin",
26+
"slug": "promote-a-custom-property-to-an-enterprise",
27+
"subcategory": "custom-properties",
28+
"verb": "put",
29+
"requestPath": "/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote",
30+
"additional-permissions": false,
31+
"access": "write"
32+
},
2433
{
2534
"category": "enterprise-admin",
2635
"slug": "get-a-custom-property-for-an-enterprise",
@@ -7791,6 +7800,15 @@
77917800
"title": "Secret scanning alerts",
77927801
"displayTitle": "Repository permissions for \"Secret scanning alerts\"",
77937802
"permissions": [
7803+
{
7804+
"category": "secret-scanning",
7805+
"slug": "list-bypass-requests-for-secret-scanning-for-an-org",
7806+
"subcategory": "delegated-bypass",
7807+
"verb": "get",
7808+
"requestPath": "/orgs/{org}/bypass-requests/secret-scanning",
7809+
"additional-permissions": false,
7810+
"access": "read"
7811+
},
77947812
{
77957813
"category": "secret-scanning",
77967814
"slug": "list-secret-scanning-alerts-for-an-organization",
@@ -7800,6 +7818,42 @@
78007818
"additional-permissions": false,
78017819
"access": "read"
78027820
},
7821+
{
7822+
"category": "secret-scanning",
7823+
"slug": "list-bypass-requests-for-secret-scanning-for-a-repository",
7824+
"subcategory": "delegated-bypass",
7825+
"verb": "get",
7826+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning",
7827+
"additional-permissions": false,
7828+
"access": "read"
7829+
},
7830+
{
7831+
"category": "secret-scanning",
7832+
"slug": "get-a-bypass-request-for-secret-scanning",
7833+
"subcategory": "delegated-bypass",
7834+
"verb": "get",
7835+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}",
7836+
"additional-permissions": false,
7837+
"access": "read"
7838+
},
7839+
{
7840+
"category": "secret-scanning",
7841+
"slug": "review-a-bypass-request-for-secret-scanning",
7842+
"subcategory": "delegated-bypass",
7843+
"verb": "patch",
7844+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}",
7845+
"additional-permissions": false,
7846+
"access": "read"
7847+
},
7848+
{
7849+
"category": "secret-scanning",
7850+
"slug": "dismiss-a-response-on-a-bypass-request-for-secret-scanning",
7851+
"subcategory": "delegated-bypass",
7852+
"verb": "delete",
7853+
"requestPath": "/repos/{owner}/{repo}/bypass-responses/secret-scanning/{bypass_response_id}",
7854+
"additional-permissions": false,
7855+
"access": "read"
7856+
},
78037857
{
78047858
"category": "secret-scanning",
78057859
"slug": "list-secret-scanning-alerts-for-a-repository",

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

+36
Original file line numberDiff line numberDiff line change
@@ -2524,6 +2524,12 @@
25242524
"verb": "patch",
25252525
"requestPath": "/enterprises/{enterprise}/properties/schema"
25262526
},
2527+
{
2528+
"slug": "promote-a-custom-property-to-an-enterprise",
2529+
"subcategory": "custom-properties",
2530+
"verb": "put",
2531+
"requestPath": "/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote"
2532+
},
25272533
{
25282534
"slug": "get-a-custom-property-for-an-enterprise",
25292535
"subcategory": "custom-properties",
@@ -5306,12 +5312,42 @@
53065312
}
53075313
],
53085314
"secret-scanning": [
5315+
{
5316+
"slug": "list-bypass-requests-for-secret-scanning-for-an-org",
5317+
"subcategory": "delegated-bypass",
5318+
"verb": "get",
5319+
"requestPath": "/orgs/{org}/bypass-requests/secret-scanning"
5320+
},
53095321
{
53105322
"slug": "list-secret-scanning-alerts-for-an-organization",
53115323
"subcategory": "secret-scanning",
53125324
"verb": "get",
53135325
"requestPath": "/orgs/{org}/secret-scanning/alerts"
53145326
},
5327+
{
5328+
"slug": "list-bypass-requests-for-secret-scanning-for-a-repository",
5329+
"subcategory": "delegated-bypass",
5330+
"verb": "get",
5331+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning"
5332+
},
5333+
{
5334+
"slug": "get-a-bypass-request-for-secret-scanning",
5335+
"subcategory": "delegated-bypass",
5336+
"verb": "get",
5337+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}"
5338+
},
5339+
{
5340+
"slug": "review-a-bypass-request-for-secret-scanning",
5341+
"subcategory": "delegated-bypass",
5342+
"verb": "patch",
5343+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}"
5344+
},
5345+
{
5346+
"slug": "dismiss-a-response-on-a-bypass-request-for-secret-scanning",
5347+
"subcategory": "delegated-bypass",
5348+
"verb": "delete",
5349+
"requestPath": "/repos/{owner}/{repo}/bypass-responses/secret-scanning/{bypass_response_id}"
5350+
},
53155351
{
53165352
"slug": "list-secret-scanning-alerts-for-a-repository",
53175353
"subcategory": "secret-scanning",

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

+66
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@
2525
"server-to-server": true,
2626
"additional-permissions": false
2727
},
28+
{
29+
"category": "enterprise-admin",
30+
"slug": "promote-a-custom-property-to-an-enterprise",
31+
"subcategory": "custom-properties",
32+
"verb": "put",
33+
"requestPath": "/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote",
34+
"access": "write",
35+
"user-to-server": true,
36+
"server-to-server": true,
37+
"additional-permissions": false
38+
},
2839
{
2940
"category": "enterprise-admin",
3041
"slug": "get-a-custom-property-for-an-enterprise",
@@ -9470,6 +9481,17 @@
94709481
"title": "Secret scanning alerts",
94719482
"displayTitle": "Repository permissions for \"Secret scanning alerts\"",
94729483
"permissions": [
9484+
{
9485+
"category": "secret-scanning",
9486+
"slug": "list-bypass-requests-for-secret-scanning-for-an-org",
9487+
"subcategory": "delegated-bypass",
9488+
"verb": "get",
9489+
"requestPath": "/orgs/{org}/bypass-requests/secret-scanning",
9490+
"access": "read",
9491+
"user-to-server": true,
9492+
"server-to-server": false,
9493+
"additional-permissions": false
9494+
},
94739495
{
94749496
"category": "secret-scanning",
94759497
"slug": "list-secret-scanning-alerts-for-an-organization",
@@ -9481,6 +9503,50 @@
94819503
"server-to-server": true,
94829504
"additional-permissions": false
94839505
},
9506+
{
9507+
"category": "secret-scanning",
9508+
"slug": "list-bypass-requests-for-secret-scanning-for-a-repository",
9509+
"subcategory": "delegated-bypass",
9510+
"verb": "get",
9511+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning",
9512+
"access": "read",
9513+
"user-to-server": true,
9514+
"server-to-server": false,
9515+
"additional-permissions": false
9516+
},
9517+
{
9518+
"category": "secret-scanning",
9519+
"slug": "get-a-bypass-request-for-secret-scanning",
9520+
"subcategory": "delegated-bypass",
9521+
"verb": "get",
9522+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}",
9523+
"access": "read",
9524+
"user-to-server": true,
9525+
"server-to-server": false,
9526+
"additional-permissions": false
9527+
},
9528+
{
9529+
"category": "secret-scanning",
9530+
"slug": "review-a-bypass-request-for-secret-scanning",
9531+
"subcategory": "delegated-bypass",
9532+
"verb": "patch",
9533+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}",
9534+
"access": "read",
9535+
"user-to-server": true,
9536+
"server-to-server": false,
9537+
"additional-permissions": false
9538+
},
9539+
{
9540+
"category": "secret-scanning",
9541+
"slug": "dismiss-a-response-on-a-bypass-request-for-secret-scanning",
9542+
"subcategory": "delegated-bypass",
9543+
"verb": "delete",
9544+
"requestPath": "/repos/{owner}/{repo}/bypass-responses/secret-scanning/{bypass_response_id}",
9545+
"access": "read",
9546+
"user-to-server": true,
9547+
"server-to-server": false,
9548+
"additional-permissions": false
9549+
},
94849550
{
94859551
"category": "secret-scanning",
94869552
"slug": "list-secret-scanning-alerts-for-a-repository",

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

+6
Original file line numberDiff line numberDiff line change
@@ -2252,6 +2252,12 @@
22522252
"verb": "patch",
22532253
"requestPath": "/enterprises/{enterprise}/properties/schema"
22542254
},
2255+
{
2256+
"slug": "promote-a-custom-property-to-an-enterprise",
2257+
"subcategory": "custom-properties",
2258+
"verb": "put",
2259+
"requestPath": "/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote"
2260+
},
22552261
{
22562262
"slug": "get-a-custom-property-for-an-enterprise",
22572263
"subcategory": "custom-properties",

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

+36
Original file line numberDiff line numberDiff line change
@@ -2524,6 +2524,12 @@
25242524
"verb": "patch",
25252525
"requestPath": "/enterprises/{enterprise}/properties/schema"
25262526
},
2527+
{
2528+
"slug": "promote-a-custom-property-to-an-enterprise",
2529+
"subcategory": "custom-properties",
2530+
"verb": "put",
2531+
"requestPath": "/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote"
2532+
},
25272533
{
25282534
"slug": "get-a-custom-property-for-an-enterprise",
25292535
"subcategory": "custom-properties",
@@ -5306,12 +5312,42 @@
53065312
}
53075313
],
53085314
"secret-scanning": [
5315+
{
5316+
"slug": "list-bypass-requests-for-secret-scanning-for-an-org",
5317+
"subcategory": "delegated-bypass",
5318+
"verb": "get",
5319+
"requestPath": "/orgs/{org}/bypass-requests/secret-scanning"
5320+
},
53095321
{
53105322
"slug": "list-secret-scanning-alerts-for-an-organization",
53115323
"subcategory": "secret-scanning",
53125324
"verb": "get",
53135325
"requestPath": "/orgs/{org}/secret-scanning/alerts"
53145326
},
5327+
{
5328+
"slug": "list-bypass-requests-for-secret-scanning-for-a-repository",
5329+
"subcategory": "delegated-bypass",
5330+
"verb": "get",
5331+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning"
5332+
},
5333+
{
5334+
"slug": "get-a-bypass-request-for-secret-scanning",
5335+
"subcategory": "delegated-bypass",
5336+
"verb": "get",
5337+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}"
5338+
},
5339+
{
5340+
"slug": "review-a-bypass-request-for-secret-scanning",
5341+
"subcategory": "delegated-bypass",
5342+
"verb": "patch",
5343+
"requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}"
5344+
},
5345+
{
5346+
"slug": "dismiss-a-response-on-a-bypass-request-for-secret-scanning",
5347+
"subcategory": "delegated-bypass",
5348+
"verb": "delete",
5349+
"requestPath": "/repos/{owner}/{repo}/bypass-responses/secret-scanning/{bypass_response_id}"
5350+
},
53155351
{
53165352
"slug": "list-secret-scanning-alerts-for-a-repository",
53175353
"subcategory": "secret-scanning",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "2d90b0feb3246497649850821757a0eeec84e915"
63+
"sha": "04c2dd07097565bce579c288d92a4be14dc99bf6"
6464
}

0 commit comments

Comments
 (0)