Skip to content

Commit 701dddd

Browse files
docs-botsubatoitmelliottjrsunbryeisaacmbrown
authored
Update OpenAPI Description (#57475)
Co-authored-by: Ben Ahmady <[email protected]> Co-authored-by: Tom Elliott <[email protected]> Co-authored-by: Sunbrye Ly <[email protected]> Co-authored-by: isaacmbrown <[email protected]> Co-authored-by: Isaac Brown <[email protected]>
1 parent fc9e832 commit 701dddd

File tree

33 files changed

+23964
-2262
lines changed

33 files changed

+23964
-2262
lines changed

‎content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ on:
405405
> * {% data reusables.actions.branch-requirement %}
406406
> * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository.
407407

408-
Runs your workflow when a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to cards or columns in a {% data variables.projects.projects_v1_board %}, use the [`project_card`](#project_card) or [`project_column`](#project_column) events instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the {% data variables.projects.projects_v1_board %} APIs, see [AUTOTITLE](/graphql/reference/objects#project) in the GraphQL API documentation or [AUTOTITLE](/rest/projects).
408+
Runs your workflow when a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to cards or columns in a {% data variables.projects.projects_v1_board %}, use the [`project_card`](#project_card) or [`project_column`](#project_column) events instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the {% data variables.projects.projects_v1_board %} APIs, see [AUTOTITLE](/graphql/reference/objects#project) in the GraphQL API documentation or [AUTOTITLE](/rest/projects-classic).
409409

410410
For example, you can run a workflow when a project has been `created` or `deleted`.
411411

@@ -426,7 +426,7 @@ on:
426426
> * {% data reusables.actions.branch-requirement %}
427427
> * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository.
428428

429-
Runs your workflow when a card on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or columns in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_column`](#project_column) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project card APIs, see [AUTOTITLE](/graphql/reference/objects#projectcard) in the GraphQL API documentation or [AUTOTITLE](/rest/projects/cards).
429+
Runs your workflow when a card on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or columns in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_column`](#project_column) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project card APIs, see [AUTOTITLE](/graphql/reference/objects#projectcard) in the GraphQL API documentation or [AUTOTITLE](/rest/projects-classic/cards).
430430

431431
For example, you can run a workflow when a project card has been `created` or `deleted`.
432432

@@ -447,7 +447,7 @@ on:
447447
> * {% data reusables.actions.branch-requirement %}
448448
> * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository.
449449

450-
Runs your workflow when a column on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or cards in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_card`](#project_card) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project column APIs, see [AUTOTITLE](/graphql/reference/objects#projectcolumn) in the GraphQL API documentation or [AUTOTITLE](/rest/projects#columns).
450+
Runs your workflow when a column on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or cards in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_card`](#project_card) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project column APIs, see [AUTOTITLE](/graphql/reference/objects#projectcolumn) in the GraphQL API documentation or [AUTOTITLE](/rest/projects-classic#columns).
451451

452452
For example, you can run a workflow when a project column has been `created` or `deleted`.
453453

@@ -1002,7 +1002,7 @@ Notifications for scheduled workflows are sent to the user who last modified the
10021002
> [!NOTE]
10031003
> For an enterprise with {% data variables.product.prodname_emus %}, triggering a scheduled workflow requires that the status of the `actor` user account associated with the workflow is currently active (i.e. not suspended or deleted).
10041004
> * Scheduled workflows will not run if the last `actor` associated with the scheduled workflow has been deprovisioned by the {% data variables.product.prodname_emu %} identity provider (IdP). However, if the last `actor` {% data variables.product.prodname_emu %} has not been deprovisioned by the IdP, and has only been removed as a member from a given organization in the enterprise, scheduled workflows will still run with that user set as the `actor`.
1005-
> * Similarly, for an enterprise without {% data variables.product.prodname_emus %}, removing a user from an organization will not prevent scheduled workflows which had that user as their `actor` from running.
1005+
> * Similarly, for an enterprise without {% data variables.product.prodname_emus %}, removing a user from an organization will not prevent scheduled workflows which had that user as their `actor` from running.
10061006
> * Thus, the _user account's_ status, in both {% data variables.product.prodname_emu %} and non-{% data variables.product.prodname_emu %} scenarios, is what's important, _not_ the user's _membership status_ in the organization where the scheduled workflow is located.
10071007

10081008
## `status`

‎content/rest/index.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ featuredLinks:
2323
- /rest/guides/using-the-rest-api-to-interact-with-checks
2424
- /rest/using-the-rest-api/using-pagination-in-the-rest-api
2525
changelog:
26-
label: 'api, apis'
26+
label: api, apis
2727
layout: product-landing
2828
redirect_from:
2929
- /v3
@@ -79,6 +79,7 @@ children:
7979
- /packages
8080
- /pages
8181
- /private-registries
82+
- /projects
8283
- /projects-classic
8384
- /pulls
8485
- /rate-limit

‎content/rest/projects-classic/index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ intro: 'Use the REST API to create, list, update, delete and customize {% data v
55
redirect_from:
66
- /v3/projects
77
- /rest/reference/projects
8-
- /rest/projects
98
topics:
109
- API
1110
autogenerated: rest

‎content/rest/projects-classic/projects.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ topics:
1313
- API
1414
autogenerated: rest
1515
redirect_from:
16-
- /rest/projects/projects
1716
- /v3/projects/projects
1817
- /rest/reference/projects/projects
1918
---

‎content/rest/projects/fields.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 Project fields
3+
shortTitle: Project fields
4+
intro: Use the REST API to manage Project fields
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+
<!-- Content after this section is automatically generated -->

‎content/rest/projects/index.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Projects
3+
topics:
4+
- API
5+
autogenerated: rest
6+
allowTitleToDifferFromFilename: true
7+
children:
8+
- /fields
9+
- /items
10+
- /projects
11+
versions:
12+
fpt: '*'
13+
ghec: '*'
14+
---
15+

‎content/rest/projects/items.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 Project items
3+
shortTitle: Project items
4+
intro: Use the REST API to manage Project items
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+
<!-- Content after this section is automatically generated -->

‎content/rest/projects/projects.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 Projects
3+
shortTitle: Projects
4+
intro: Use the REST API to manage Projects
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+
<!-- Content after this section is automatically generated -->

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

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2133,6 +2133,87 @@
21332133
"additional-permissions": false,
21342134
"access": "write"
21352135
},
2136+
{
2137+
"category": "projects",
2138+
"slug": "list-projects-for-organization",
2139+
"subcategory": "projects",
2140+
"verb": "get",
2141+
"requestPath": "/orgs/{org}/projectsV2",
2142+
"additional-permissions": false,
2143+
"access": "read"
2144+
},
2145+
{
2146+
"category": "projects",
2147+
"slug": "get-project-for-organization",
2148+
"subcategory": "projects",
2149+
"verb": "get",
2150+
"requestPath": "/orgs/{org}/projectsV2/{project_number}",
2151+
"additional-permissions": false,
2152+
"access": "read"
2153+
},
2154+
{
2155+
"category": "projects",
2156+
"slug": "list-project-fields-for-organization",
2157+
"subcategory": "fields",
2158+
"verb": "get",
2159+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields",
2160+
"additional-permissions": false,
2161+
"access": "read"
2162+
},
2163+
{
2164+
"category": "projects",
2165+
"slug": "get-project-field-for-organization",
2166+
"subcategory": "fields",
2167+
"verb": "get",
2168+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}",
2169+
"additional-permissions": false,
2170+
"access": "read"
2171+
},
2172+
{
2173+
"category": "projects",
2174+
"slug": "list-items-for-an-organization-owned-project",
2175+
"subcategory": "items",
2176+
"verb": "get",
2177+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items",
2178+
"additional-permissions": false,
2179+
"access": "read"
2180+
},
2181+
{
2182+
"category": "projects",
2183+
"slug": "add-item-to-organization-owned-project",
2184+
"subcategory": "items",
2185+
"verb": "post",
2186+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items",
2187+
"additional-permissions": false,
2188+
"access": "write"
2189+
},
2190+
{
2191+
"category": "projects",
2192+
"slug": "get-an-item-for-an-organization-owned-project",
2193+
"subcategory": "items",
2194+
"verb": "get",
2195+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
2196+
"additional-permissions": false,
2197+
"access": "read"
2198+
},
2199+
{
2200+
"category": "projects",
2201+
"slug": "update-project-item-for-organization",
2202+
"subcategory": "items",
2203+
"verb": "patch",
2204+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
2205+
"additional-permissions": false,
2206+
"access": "write"
2207+
},
2208+
{
2209+
"category": "projects",
2210+
"slug": "delete-project-item-for-organization",
2211+
"subcategory": "items",
2212+
"verb": "delete",
2213+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
2214+
"additional-permissions": false,
2215+
"access": "write"
2216+
},
21362217
{
21372218
"category": "teams",
21382219
"slug": "add-or-update-team-project-permissions",

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3653,6 +3653,62 @@
36533653
"requestPath": "/orgs/{org}/private-registries/{secret_name}"
36543654
}
36553655
],
3656+
"projects": [
3657+
{
3658+
"slug": "list-projects-for-organization",
3659+
"subcategory": "projects",
3660+
"verb": "get",
3661+
"requestPath": "/orgs/{org}/projectsV2"
3662+
},
3663+
{
3664+
"slug": "get-project-for-organization",
3665+
"subcategory": "projects",
3666+
"verb": "get",
3667+
"requestPath": "/orgs/{org}/projectsV2/{project_number}"
3668+
},
3669+
{
3670+
"slug": "list-project-fields-for-organization",
3671+
"subcategory": "fields",
3672+
"verb": "get",
3673+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields"
3674+
},
3675+
{
3676+
"slug": "get-project-field-for-organization",
3677+
"subcategory": "fields",
3678+
"verb": "get",
3679+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}"
3680+
},
3681+
{
3682+
"slug": "list-items-for-an-organization-owned-project",
3683+
"subcategory": "items",
3684+
"verb": "get",
3685+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
3686+
},
3687+
{
3688+
"slug": "add-item-to-organization-owned-project",
3689+
"subcategory": "items",
3690+
"verb": "post",
3691+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
3692+
},
3693+
{
3694+
"slug": "get-an-item-for-an-organization-owned-project",
3695+
"subcategory": "items",
3696+
"verb": "get",
3697+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
3698+
},
3699+
{
3700+
"slug": "update-project-item-for-organization",
3701+
"subcategory": "items",
3702+
"verb": "patch",
3703+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
3704+
},
3705+
{
3706+
"slug": "delete-project-item-for-organization",
3707+
"subcategory": "items",
3708+
"verb": "delete",
3709+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
3710+
}
3711+
],
36563712
"projects-classic": [
36573713
{
36583714
"slug": "list-organization-projects",

0 commit comments

Comments
 (0)