Skip to content

Commit 6477731

Browse files
docs-bottimrogersam-steadCopilot
authored
Update OpenAPI Description (#61061)
Co-authored-by: Tim Rogers <timrogers@github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 848387d commit 6477731

66 files changed

Lines changed: 11838 additions & 111 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.
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 Actions concurrency groups
3+
shortTitle: Actions concurrency groups
4+
intro: Use the REST API to view and manage concurrency groups for GitHub Actions workflows.
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+
- Automate CI/CD workflows
12+
---
13+
14+
<!-- Content after this section is automatically generated -->

content/rest/actions/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ versions:
1515
children:
1616
- /artifacts
1717
- /cache
18+
- /concurrency-groups
1819
- /hosted-runners
1920
- /oidc
2021
- /permissions
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 agent tasks
3+
shortTitle: Agent tasks
4+
intro: Use the REST API to start and manage {% data variables.copilot.copilot_cloud_agent %} tasks
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+
- Use Copilot and AI services
12+
---
13+
14+
<!-- Content after this section is automatically generated -->

content/rest/agent-tasks/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: REST API endpoints for agent tasks
3+
shortTitle: Agent tasks
4+
autogenerated: rest
5+
allowTitleToDifferFromFilename: true
6+
children:
7+
- /agent-tasks
8+
versions:
9+
fpt: '*'
10+
ghec: '*'
11+
---
12+

content/rest/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ children:
4949
- /guides
5050
- /actions
5151
- /activity
52+
- /agent-tasks
5253
- /announcement-banners
5354
- /apps
5455
- /billing

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3306,6 +3306,24 @@
33063306
"additional-permissions": false,
33073307
"access": "write"
33083308
},
3309+
{
3310+
"category": "actions",
3311+
"slug": "list-concurrency-groups-for-a-repository",
3312+
"subcategory": "concurrency-groups",
3313+
"verb": "get",
3314+
"requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups",
3315+
"additional-permissions": false,
3316+
"access": "read"
3317+
},
3318+
{
3319+
"category": "actions",
3320+
"slug": "get-a-concurrency-group-for-a-repository",
3321+
"subcategory": "concurrency-groups",
3322+
"verb": "get",
3323+
"requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}",
3324+
"additional-permissions": false,
3325+
"access": "read"
3326+
},
33093327
{
33103328
"category": "actions",
33113329
"slug": "get-a-job-for-a-workflow-run",
@@ -3441,6 +3459,15 @@
34413459
"additional-permissions": false,
34423460
"access": "write"
34433461
},
3462+
{
3463+
"category": "actions",
3464+
"slug": "list-concurrency-groups-for-a-workflow-run",
3465+
"subcategory": "concurrency-groups",
3466+
"verb": "get",
3467+
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups",
3468+
"additional-permissions": false,
3469+
"access": "read"
3470+
},
34443471
{
34453472
"category": "actions",
34463473
"slug": "force-cancel-a-workflow-run",

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -630,6 +630,18 @@
630630
"verb": "delete",
631631
"requestPath": "/repos/{owner}/{repo}/actions/caches/{cache_id}"
632632
},
633+
{
634+
"slug": "list-concurrency-groups-for-a-repository",
635+
"subcategory": "concurrency-groups",
636+
"verb": "get",
637+
"requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups"
638+
},
639+
{
640+
"slug": "get-a-concurrency-group-for-a-repository",
641+
"subcategory": "concurrency-groups",
642+
"verb": "get",
643+
"requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}"
644+
},
633645
{
634646
"slug": "get-a-job-for-a-workflow-run",
635647
"subcategory": "workflow-jobs",
@@ -888,6 +900,12 @@
888900
"verb": "post",
889901
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel"
890902
},
903+
{
904+
"slug": "list-concurrency-groups-for-a-workflow-run",
905+
"subcategory": "concurrency-groups",
906+
"verb": "get",
907+
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups"
908+
},
891909
{
892910
"slug": "force-cancel-a-workflow-run",
893911
"subcategory": "workflow-runs",

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

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4347,6 +4347,28 @@
43474347
"server-to-server": true,
43484348
"additional-permissions": false
43494349
},
4350+
{
4351+
"category": "actions",
4352+
"slug": "list-concurrency-groups-for-a-repository",
4353+
"subcategory": "concurrency-groups",
4354+
"verb": "get",
4355+
"requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups",
4356+
"access": "read",
4357+
"user-to-server": true,
4358+
"server-to-server": true,
4359+
"additional-permissions": false
4360+
},
4361+
{
4362+
"category": "actions",
4363+
"slug": "get-a-concurrency-group-for-a-repository",
4364+
"subcategory": "concurrency-groups",
4365+
"verb": "get",
4366+
"requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}",
4367+
"access": "read",
4368+
"user-to-server": true,
4369+
"server-to-server": true,
4370+
"additional-permissions": false
4371+
},
43504372
{
43514373
"category": "actions",
43524374
"slug": "get-a-job-for-a-workflow-run",
@@ -4512,6 +4534,17 @@
45124534
"server-to-server": true,
45134535
"additional-permissions": false
45144536
},
4537+
{
4538+
"category": "actions",
4539+
"slug": "list-concurrency-groups-for-a-workflow-run",
4540+
"subcategory": "concurrency-groups",
4541+
"verb": "get",
4542+
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups",
4543+
"access": "read",
4544+
"user-to-server": true,
4545+
"server-to-server": true,
4546+
"additional-permissions": false
4547+
},
45154548
{
45164549
"category": "actions",
45174550
"slug": "force-cancel-a-workflow-run",

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -672,6 +672,18 @@
672672
"verb": "delete",
673673
"requestPath": "/repos/{owner}/{repo}/actions/caches/{cache_id}"
674674
},
675+
{
676+
"slug": "list-concurrency-groups-for-a-repository",
677+
"subcategory": "concurrency-groups",
678+
"verb": "get",
679+
"requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups"
680+
},
681+
{
682+
"slug": "get-a-concurrency-group-for-a-repository",
683+
"subcategory": "concurrency-groups",
684+
"verb": "get",
685+
"requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}"
686+
},
675687
{
676688
"slug": "get-a-job-for-a-workflow-run",
677689
"subcategory": "workflow-jobs",
@@ -930,6 +942,12 @@
930942
"verb": "post",
931943
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel"
932944
},
945+
{
946+
"slug": "list-concurrency-groups-for-a-workflow-run",
947+
"subcategory": "concurrency-groups",
948+
"verb": "get",
949+
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups"
950+
},
933951
{
934952
"slug": "review-custom-deployment-protection-rules-for-a-workflow-run",
935953
"subcategory": "workflow-runs",

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -672,6 +672,18 @@
672672
"verb": "delete",
673673
"requestPath": "/repos/{owner}/{repo}/actions/caches/{cache_id}"
674674
},
675+
{
676+
"slug": "list-concurrency-groups-for-a-repository",
677+
"subcategory": "concurrency-groups",
678+
"verb": "get",
679+
"requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups"
680+
},
681+
{
682+
"slug": "get-a-concurrency-group-for-a-repository",
683+
"subcategory": "concurrency-groups",
684+
"verb": "get",
685+
"requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}"
686+
},
675687
{
676688
"slug": "get-a-job-for-a-workflow-run",
677689
"subcategory": "workflow-jobs",
@@ -930,6 +942,12 @@
930942
"verb": "post",
931943
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel"
932944
},
945+
{
946+
"slug": "list-concurrency-groups-for-a-workflow-run",
947+
"subcategory": "concurrency-groups",
948+
"verb": "get",
949+
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups"
950+
},
933951
{
934952
"slug": "force-cancel-a-workflow-run",
935953
"subcategory": "workflow-runs",

0 commit comments

Comments
 (0)