Skip to content

Commit e530576

Browse files
docs-botjc-clarkCopilot
authored
Update OpenAPI Description (#62273)
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 2fc6284 commit e530576

69 files changed

Lines changed: 11412 additions & 295 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/rest/secret-scanning/custom-patterns.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: REST API endpoints for secret scanning custom patterns
3+
shortTitle: Custom patterns
4+
intro: Use the REST API to manage custom patterns for secret scanning.
5+
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
6+
fpt: '*'
7+
ghec: '*'
8+
autogenerated: rest
9+
allowTitleToDifferFromFilename: true
10+
category:
11+
- Secure code and manage vulnerabilities
12+
---
13+
14+
<!-- Content after this section is automatically generated -->

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ versions:
99
ghes: '*'
1010
children:
1111
- /alert-dismissal-requests
12+
- /custom-patterns
1213
- /delegated-bypass
1314
- /push-protection
1415
- /secret-scanning

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

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -873,6 +873,42 @@
873873
"additional-permissions": false,
874874
"access": "write"
875875
},
876+
{
877+
"category": "secret-scanning",
878+
"slug": "list-organization-custom-patterns",
879+
"subcategory": "custom-patterns",
880+
"verb": "get",
881+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns",
882+
"additional-permissions": false,
883+
"access": "read"
884+
},
885+
{
886+
"category": "secret-scanning",
887+
"slug": "bulk-create-organization-custom-patterns",
888+
"subcategory": "custom-patterns",
889+
"verb": "post",
890+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns",
891+
"additional-permissions": false,
892+
"access": "write"
893+
},
894+
{
895+
"category": "secret-scanning",
896+
"slug": "bulk-delete-organization-custom-patterns",
897+
"subcategory": "custom-patterns",
898+
"verb": "delete",
899+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns",
900+
"additional-permissions": false,
901+
"access": "write"
902+
},
903+
{
904+
"category": "secret-scanning",
905+
"slug": "update-an-organization-custom-pattern",
906+
"subcategory": "custom-patterns",
907+
"verb": "patch",
908+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}",
909+
"additional-permissions": false,
910+
"access": "write"
911+
},
876912
{
877913
"category": "secret-scanning",
878914
"slug": "list-organization-pattern-configurations",
@@ -8481,6 +8517,42 @@
84818517
"additional-permissions": false,
84828518
"access": "read"
84838519
},
8520+
{
8521+
"category": "secret-scanning",
8522+
"slug": "list-repository-custom-patterns",
8523+
"subcategory": "custom-patterns",
8524+
"verb": "get",
8525+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns",
8526+
"additional-permissions": false,
8527+
"access": "read"
8528+
},
8529+
{
8530+
"category": "secret-scanning",
8531+
"slug": "bulk-create-repository-custom-patterns",
8532+
"subcategory": "custom-patterns",
8533+
"verb": "post",
8534+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns",
8535+
"additional-permissions": false,
8536+
"access": "write"
8537+
},
8538+
{
8539+
"category": "secret-scanning",
8540+
"slug": "bulk-delete-repository-custom-patterns",
8541+
"subcategory": "custom-patterns",
8542+
"verb": "delete",
8543+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns",
8544+
"additional-permissions": false,
8545+
"access": "write"
8546+
},
8547+
{
8548+
"category": "secret-scanning",
8549+
"slug": "update-a-repository-custom-pattern",
8550+
"subcategory": "custom-patterns",
8551+
"verb": "patch",
8552+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}",
8553+
"additional-permissions": false,
8554+
"access": "write"
8555+
},
84848556
{
84858557
"category": "secret-scanning",
84868558
"slug": "get-secret-scanning-scan-history-for-a-repository",

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5176,6 +5176,30 @@
51765176
"verb": "get",
51775177
"requestPath": "/orgs/{org}/secret-scanning/alerts"
51785178
},
5179+
{
5180+
"slug": "list-organization-custom-patterns",
5181+
"subcategory": "custom-patterns",
5182+
"verb": "get",
5183+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns"
5184+
},
5185+
{
5186+
"slug": "bulk-create-organization-custom-patterns",
5187+
"subcategory": "custom-patterns",
5188+
"verb": "post",
5189+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns"
5190+
},
5191+
{
5192+
"slug": "bulk-delete-organization-custom-patterns",
5193+
"subcategory": "custom-patterns",
5194+
"verb": "delete",
5195+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns"
5196+
},
5197+
{
5198+
"slug": "update-an-organization-custom-pattern",
5199+
"subcategory": "custom-patterns",
5200+
"verb": "patch",
5201+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}"
5202+
},
51795203
{
51805204
"slug": "list-organization-pattern-configurations",
51815205
"subcategory": "push-protection",
@@ -5212,6 +5236,30 @@
52125236
"verb": "get",
52135237
"requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations"
52145238
},
5239+
{
5240+
"slug": "list-repository-custom-patterns",
5241+
"subcategory": "custom-patterns",
5242+
"verb": "get",
5243+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns"
5244+
},
5245+
{
5246+
"slug": "bulk-create-repository-custom-patterns",
5247+
"subcategory": "custom-patterns",
5248+
"verb": "post",
5249+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns"
5250+
},
5251+
{
5252+
"slug": "bulk-delete-repository-custom-patterns",
5253+
"subcategory": "custom-patterns",
5254+
"verb": "delete",
5255+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns"
5256+
},
5257+
{
5258+
"slug": "update-a-repository-custom-pattern",
5259+
"subcategory": "custom-patterns",
5260+
"verb": "patch",
5261+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}"
5262+
},
52155263
{
52165264
"slug": "create-a-push-protection-bypass",
52175265
"subcategory": "secret-scanning",

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

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1319,6 +1319,50 @@
13191319
"server-to-server": true,
13201320
"additional-permissions": false
13211321
},
1322+
{
1323+
"category": "secret-scanning",
1324+
"slug": "list-organization-custom-patterns",
1325+
"subcategory": "custom-patterns",
1326+
"verb": "get",
1327+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns",
1328+
"access": "read",
1329+
"user-to-server": true,
1330+
"server-to-server": true,
1331+
"additional-permissions": false
1332+
},
1333+
{
1334+
"category": "secret-scanning",
1335+
"slug": "bulk-create-organization-custom-patterns",
1336+
"subcategory": "custom-patterns",
1337+
"verb": "post",
1338+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns",
1339+
"access": "write",
1340+
"user-to-server": true,
1341+
"server-to-server": true,
1342+
"additional-permissions": false
1343+
},
1344+
{
1345+
"category": "secret-scanning",
1346+
"slug": "bulk-delete-organization-custom-patterns",
1347+
"subcategory": "custom-patterns",
1348+
"verb": "delete",
1349+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns",
1350+
"access": "write",
1351+
"user-to-server": true,
1352+
"server-to-server": true,
1353+
"additional-permissions": false
1354+
},
1355+
{
1356+
"category": "secret-scanning",
1357+
"slug": "update-an-organization-custom-pattern",
1358+
"subcategory": "custom-patterns",
1359+
"verb": "patch",
1360+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}",
1361+
"access": "write",
1362+
"user-to-server": true,
1363+
"server-to-server": true,
1364+
"additional-permissions": false
1365+
},
13221366
{
13231367
"category": "secret-scanning",
13241368
"slug": "list-organization-pattern-configurations",
@@ -10829,6 +10873,50 @@
1082910873
"server-to-server": true,
1083010874
"additional-permissions": false
1083110875
},
10876+
{
10877+
"category": "secret-scanning",
10878+
"slug": "list-repository-custom-patterns",
10879+
"subcategory": "custom-patterns",
10880+
"verb": "get",
10881+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns",
10882+
"access": "read",
10883+
"user-to-server": true,
10884+
"server-to-server": true,
10885+
"additional-permissions": false
10886+
},
10887+
{
10888+
"category": "secret-scanning",
10889+
"slug": "bulk-create-repository-custom-patterns",
10890+
"subcategory": "custom-patterns",
10891+
"verb": "post",
10892+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns",
10893+
"access": "write",
10894+
"user-to-server": true,
10895+
"server-to-server": true,
10896+
"additional-permissions": false
10897+
},
10898+
{
10899+
"category": "secret-scanning",
10900+
"slug": "bulk-delete-repository-custom-patterns",
10901+
"subcategory": "custom-patterns",
10902+
"verb": "delete",
10903+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns",
10904+
"access": "write",
10905+
"user-to-server": true,
10906+
"server-to-server": true,
10907+
"additional-permissions": false
10908+
},
10909+
{
10910+
"category": "secret-scanning",
10911+
"slug": "update-a-repository-custom-pattern",
10912+
"subcategory": "custom-patterns",
10913+
"verb": "patch",
10914+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}",
10915+
"access": "write",
10916+
"user-to-server": true,
10917+
"server-to-server": true,
10918+
"additional-permissions": false
10919+
},
1083210920
{
1083310921
"category": "secret-scanning",
1083410922
"slug": "get-secret-scanning-scan-history-for-a-repository",

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5502,6 +5502,30 @@
55025502
"verb": "get",
55035503
"requestPath": "/orgs/{org}/secret-scanning/alerts"
55045504
},
5505+
{
5506+
"slug": "list-organization-custom-patterns",
5507+
"subcategory": "custom-patterns",
5508+
"verb": "get",
5509+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns"
5510+
},
5511+
{
5512+
"slug": "bulk-create-organization-custom-patterns",
5513+
"subcategory": "custom-patterns",
5514+
"verb": "post",
5515+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns"
5516+
},
5517+
{
5518+
"slug": "bulk-delete-organization-custom-patterns",
5519+
"subcategory": "custom-patterns",
5520+
"verb": "delete",
5521+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns"
5522+
},
5523+
{
5524+
"slug": "update-an-organization-custom-pattern",
5525+
"subcategory": "custom-patterns",
5526+
"verb": "patch",
5527+
"requestPath": "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}"
5528+
},
55055529
{
55065530
"slug": "list-organization-pattern-configurations",
55075531
"subcategory": "push-protection",
@@ -5538,6 +5562,30 @@
55385562
"verb": "get",
55395563
"requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations"
55405564
},
5565+
{
5566+
"slug": "list-repository-custom-patterns",
5567+
"subcategory": "custom-patterns",
5568+
"verb": "get",
5569+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns"
5570+
},
5571+
{
5572+
"slug": "bulk-create-repository-custom-patterns",
5573+
"subcategory": "custom-patterns",
5574+
"verb": "post",
5575+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns"
5576+
},
5577+
{
5578+
"slug": "bulk-delete-repository-custom-patterns",
5579+
"subcategory": "custom-patterns",
5580+
"verb": "delete",
5581+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns"
5582+
},
5583+
{
5584+
"slug": "update-a-repository-custom-pattern",
5585+
"subcategory": "custom-patterns",
5586+
"verb": "patch",
5587+
"requestPath": "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}"
5588+
},
55415589
{
55425590
"slug": "get-secret-scanning-scan-history-for-a-repository",
55435591
"subcategory": "secret-scanning",

0 commit comments

Comments
 (0)