Skip to content

Commit fed6ecf

Browse files
docs-botam-steadkoesie10
authored
Update OpenAPI Description (#55184)
Co-authored-by: Anne-Marie <[email protected]> Co-authored-by: Koen Vlaswinkel <[email protected]>
1 parent 7119f2c commit fed6ecf

File tree

30 files changed

+6111
-771
lines changed

30 files changed

+6111
-771
lines changed

‎content/rest/campaigns/campaigns.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: REST API endpoints for security campaigns
3+
shortTitle: Security campaigns
4+
intro: Use the REST API to create and manage security campaigns for your organization.
5+
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
6+
fpt: '*'
7+
ghec: '*'
8+
topics:
9+
- API
10+
autogenerated: rest
11+
allowTitleToDifferFromFilename: true
12+
---
13+
14+
> [!NOTE]
15+
> These endpoints only interact with published campaigns. Draft campaigns cannot currently be viewed or managed through the API.
16+
17+
<!-- Content after this section is automatically generated -->

‎content/rest/campaigns/index.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: REST API endpoints for security campaigns
3+
shortTitle: Security campaigns
4+
intro: Use the REST API to create and manage security campaigns for your organization.
5+
topics:
6+
- API
7+
autogenerated: rest
8+
allowTitleToDifferFromFilename: true
9+
children:
10+
- /campaigns
11+
versions:
12+
fpt: '*'
13+
ghec: '*'
14+
---
15+

‎content/rest/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ children:
4646
- /apps
4747
- /billing
4848
- /branches
49+
- /campaigns
4950
- /checks
5051
- /classroom
5152
- /code-scanning

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

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -728,6 +728,57 @@
728728
}
729729
]
730730
},
731+
"organization_campaigns": {
732+
"title": "Campaigns",
733+
"displayTitle": "Organization permissions for \"Campaigns\"",
734+
"permissions": [
735+
{
736+
"category": "campaigns",
737+
"slug": "list-campaigns-for-an-organization",
738+
"subcategory": "campaigns",
739+
"verb": "get",
740+
"requestPath": "/orgs/{org}/campaigns",
741+
"additional-permissions": false,
742+
"access": "read"
743+
},
744+
{
745+
"category": "campaigns",
746+
"slug": "create-a-campaign-for-an-organization",
747+
"subcategory": "campaigns",
748+
"verb": "post",
749+
"requestPath": "/orgs/{org}/campaigns",
750+
"additional-permissions": false,
751+
"access": "write"
752+
},
753+
{
754+
"category": "campaigns",
755+
"slug": "get-a-campaign-for-an-organization",
756+
"subcategory": "campaigns",
757+
"verb": "get",
758+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}",
759+
"additional-permissions": false,
760+
"access": "read"
761+
},
762+
{
763+
"category": "campaigns",
764+
"slug": "update-a-campaign",
765+
"subcategory": "campaigns",
766+
"verb": "patch",
767+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}",
768+
"additional-permissions": false,
769+
"access": "write"
770+
},
771+
{
772+
"category": "campaigns",
773+
"slug": "delete-a-campaign-for-an-organization",
774+
"subcategory": "campaigns",
775+
"verb": "delete",
776+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}",
777+
"additional-permissions": false,
778+
"access": "write"
779+
}
780+
]
781+
},
731782
"organization_custom_org_roles": {
732783
"title": "Custom organization roles",
733784
"displayTitle": "Organization permissions for \"Custom organization roles\"",

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1317,6 +1317,38 @@
13171317
"requestPath": "/repos/{owner}/{repo}/merges"
13181318
}
13191319
],
1320+
"campaigns": [
1321+
{
1322+
"slug": "list-campaigns-for-an-organization",
1323+
"subcategory": "campaigns",
1324+
"verb": "get",
1325+
"requestPath": "/orgs/{org}/campaigns"
1326+
},
1327+
{
1328+
"slug": "create-a-campaign-for-an-organization",
1329+
"subcategory": "campaigns",
1330+
"verb": "post",
1331+
"requestPath": "/orgs/{org}/campaigns"
1332+
},
1333+
{
1334+
"slug": "get-a-campaign-for-an-organization",
1335+
"subcategory": "campaigns",
1336+
"verb": "get",
1337+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1338+
},
1339+
{
1340+
"slug": "update-a-campaign",
1341+
"subcategory": "campaigns",
1342+
"verb": "patch",
1343+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1344+
},
1345+
{
1346+
"slug": "delete-a-campaign-for-an-organization",
1347+
"subcategory": "campaigns",
1348+
"verb": "delete",
1349+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1350+
}
1351+
],
13201352
"checks": [
13211353
{
13221354
"slug": "create-a-check-run",

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

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -886,6 +886,67 @@
886886
}
887887
]
888888
},
889+
"organization_campaigns": {
890+
"title": "Campaigns",
891+
"displayTitle": "Organization permissions for \"Campaigns\"",
892+
"permissions": [
893+
{
894+
"category": "campaigns",
895+
"slug": "list-campaigns-for-an-organization",
896+
"subcategory": "campaigns",
897+
"verb": "get",
898+
"requestPath": "/orgs/{org}/campaigns",
899+
"access": "read",
900+
"user-to-server": true,
901+
"server-to-server": true,
902+
"additional-permissions": false
903+
},
904+
{
905+
"category": "campaigns",
906+
"slug": "create-a-campaign-for-an-organization",
907+
"subcategory": "campaigns",
908+
"verb": "post",
909+
"requestPath": "/orgs/{org}/campaigns",
910+
"access": "write",
911+
"user-to-server": true,
912+
"server-to-server": true,
913+
"additional-permissions": false
914+
},
915+
{
916+
"category": "campaigns",
917+
"slug": "get-a-campaign-for-an-organization",
918+
"subcategory": "campaigns",
919+
"verb": "get",
920+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}",
921+
"access": "read",
922+
"user-to-server": true,
923+
"server-to-server": true,
924+
"additional-permissions": false
925+
},
926+
{
927+
"category": "campaigns",
928+
"slug": "update-a-campaign",
929+
"subcategory": "campaigns",
930+
"verb": "patch",
931+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}",
932+
"access": "write",
933+
"user-to-server": true,
934+
"server-to-server": true,
935+
"additional-permissions": false
936+
},
937+
{
938+
"category": "campaigns",
939+
"slug": "delete-a-campaign-for-an-organization",
940+
"subcategory": "campaigns",
941+
"verb": "delete",
942+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}",
943+
"access": "write",
944+
"user-to-server": true,
945+
"server-to-server": true,
946+
"additional-permissions": false
947+
}
948+
]
949+
},
889950
"organization_custom_org_roles": {
890951
"title": "Custom organization roles",
891952
"displayTitle": "Organization permissions for \"Custom organization roles\"",

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1257,6 +1257,38 @@
12571257
"requestPath": "/repos/{owner}/{repo}/merges"
12581258
}
12591259
],
1260+
"campaigns": [
1261+
{
1262+
"slug": "list-campaigns-for-an-organization",
1263+
"subcategory": "campaigns",
1264+
"verb": "get",
1265+
"requestPath": "/orgs/{org}/campaigns"
1266+
},
1267+
{
1268+
"slug": "create-a-campaign-for-an-organization",
1269+
"subcategory": "campaigns",
1270+
"verb": "post",
1271+
"requestPath": "/orgs/{org}/campaigns"
1272+
},
1273+
{
1274+
"slug": "get-a-campaign-for-an-organization",
1275+
"subcategory": "campaigns",
1276+
"verb": "get",
1277+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1278+
},
1279+
{
1280+
"slug": "update-a-campaign",
1281+
"subcategory": "campaigns",
1282+
"verb": "patch",
1283+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1284+
},
1285+
{
1286+
"slug": "delete-a-campaign-for-an-organization",
1287+
"subcategory": "campaigns",
1288+
"verb": "delete",
1289+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1290+
}
1291+
],
12601292
"checks": [
12611293
{
12621294
"slug": "create-a-check-run",

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1317,6 +1317,38 @@
13171317
"requestPath": "/repos/{owner}/{repo}/merges"
13181318
}
13191319
],
1320+
"campaigns": [
1321+
{
1322+
"slug": "list-campaigns-for-an-organization",
1323+
"subcategory": "campaigns",
1324+
"verb": "get",
1325+
"requestPath": "/orgs/{org}/campaigns"
1326+
},
1327+
{
1328+
"slug": "create-a-campaign-for-an-organization",
1329+
"subcategory": "campaigns",
1330+
"verb": "post",
1331+
"requestPath": "/orgs/{org}/campaigns"
1332+
},
1333+
{
1334+
"slug": "get-a-campaign-for-an-organization",
1335+
"subcategory": "campaigns",
1336+
"verb": "get",
1337+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1338+
},
1339+
{
1340+
"slug": "update-a-campaign",
1341+
"subcategory": "campaigns",
1342+
"verb": "patch",
1343+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1344+
},
1345+
{
1346+
"slug": "delete-a-campaign-for-an-organization",
1347+
"subcategory": "campaigns",
1348+
"verb": "delete",
1349+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1350+
}
1351+
],
13201352
"checks": [
13211353
{
13221354
"slug": "create-a-check-run",

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

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -896,6 +896,57 @@
896896
}
897897
]
898898
},
899+
"organization_campaigns": {
900+
"title": "Campaigns",
901+
"displayTitle": "Organization permissions for \"Campaigns\"",
902+
"permissions": [
903+
{
904+
"category": "campaigns",
905+
"slug": "list-campaigns-for-an-organization",
906+
"subcategory": "campaigns",
907+
"verb": "get",
908+
"requestPath": "/orgs/{org}/campaigns",
909+
"additional-permissions": false,
910+
"access": "read"
911+
},
912+
{
913+
"category": "campaigns",
914+
"slug": "create-a-campaign-for-an-organization",
915+
"subcategory": "campaigns",
916+
"verb": "post",
917+
"requestPath": "/orgs/{org}/campaigns",
918+
"additional-permissions": false,
919+
"access": "write"
920+
},
921+
{
922+
"category": "campaigns",
923+
"slug": "get-a-campaign-for-an-organization",
924+
"subcategory": "campaigns",
925+
"verb": "get",
926+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}",
927+
"additional-permissions": false,
928+
"access": "read"
929+
},
930+
{
931+
"category": "campaigns",
932+
"slug": "update-a-campaign",
933+
"subcategory": "campaigns",
934+
"verb": "patch",
935+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}",
936+
"additional-permissions": false,
937+
"access": "write"
938+
},
939+
{
940+
"category": "campaigns",
941+
"slug": "delete-a-campaign-for-an-organization",
942+
"subcategory": "campaigns",
943+
"verb": "delete",
944+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}",
945+
"additional-permissions": false,
946+
"access": "write"
947+
}
948+
]
949+
},
899950
"organization_custom_org_roles": {
900951
"title": "Custom organization roles",
901952
"displayTitle": "Organization permissions for \"Custom organization roles\"",

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1355,6 +1355,38 @@
13551355
"requestPath": "/repos/{owner}/{repo}/merges"
13561356
}
13571357
],
1358+
"campaigns": [
1359+
{
1360+
"slug": "list-campaigns-for-an-organization",
1361+
"subcategory": "campaigns",
1362+
"verb": "get",
1363+
"requestPath": "/orgs/{org}/campaigns"
1364+
},
1365+
{
1366+
"slug": "create-a-campaign-for-an-organization",
1367+
"subcategory": "campaigns",
1368+
"verb": "post",
1369+
"requestPath": "/orgs/{org}/campaigns"
1370+
},
1371+
{
1372+
"slug": "get-a-campaign-for-an-organization",
1373+
"subcategory": "campaigns",
1374+
"verb": "get",
1375+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1376+
},
1377+
{
1378+
"slug": "update-a-campaign",
1379+
"subcategory": "campaigns",
1380+
"verb": "patch",
1381+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1382+
},
1383+
{
1384+
"slug": "delete-a-campaign-for-an-organization",
1385+
"subcategory": "campaigns",
1386+
"verb": "delete",
1387+
"requestPath": "/orgs/{org}/campaigns/{campaign_number}"
1388+
}
1389+
],
13581390
"checks": [
13591391
{
13601392
"slug": "create-a-check-run",

0 commit comments

Comments
 (0)