1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Update OpenAPI Description (#58338)

Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
This commit is contained in:
docs-bot
2025-11-04 05:31:41 -08:00
committed by GitHub
parent 85dadf0652
commit 570e20a0df
19 changed files with 2892 additions and 13649 deletions

View File

@@ -1,14 +1,12 @@
---
title: 'REST API endpoints for {% data variables.product.prodname_projects_v1_caps %}'
title: REST API endpoints for {% data variables.product.prodname_projects_v1_caps %}
shortTitle: Boards
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to create and manage {% data
variables.projects.projects_v1_boards %} in a repository.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
ghes: '*'
ghes: <=3.16
topics:
- API
autogenerated: rest

View File

@@ -117,6 +117,42 @@
"additional-permissions": false,
"access": "write"
},
{
"category": "billing",
"slug": "get-all-budgets-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets",
"additional-permissions": false,
"access": "read"
},
{
"category": "billing",
"slug": "get-a-budget-by-id-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "billing",
"slug": "update-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "patch",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"additional-permissions": false,
"access": "write"
},
{
"category": "billing",
"slug": "delete-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "delete",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"additional-permissions": false,
"access": "write"
},
{
"category": "billing",
"slug": "get-billing-premium-request-usage-report-for-an-organization",
@@ -137,7 +173,7 @@
},
{
"category": "billing",
"slug": "get-billing-usage-summary-report-for-an-organization",
"slug": "get-billing-usage-summary-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/usage/summary",
@@ -8708,7 +8744,7 @@
},
{
"category": "billing",
"slug": "get-billing-usage-summary-report-for-a-user",
"slug": "get-billing-usage-summary-for-a-user",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/users/{username}/settings/billing/usage/summary",

View File

@@ -1108,6 +1108,30 @@
}
],
"billing": [
{
"slug": "get-all-budgets-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets"
},
{
"slug": "get-a-budget-by-id-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "update-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "patch",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "delete-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "delete",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "get-billing-premium-request-usage-report-for-an-organization",
"subcategory": "enhanced-billing",
@@ -1121,7 +1145,7 @@
"requestPath": "/organizations/{org}/settings/billing/usage"
},
{
"slug": "get-billing-usage-summary-report-for-an-organization",
"slug": "get-billing-usage-summary-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/usage/summary"
@@ -1175,7 +1199,7 @@
"requestPath": "/users/{username}/settings/billing/usage"
},
{
"slug": "get-billing-usage-summary-report-for-a-user",
"slug": "get-billing-usage-summary-for-a-user",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/users/{username}/settings/billing/usage/summary"

View File

@@ -141,6 +141,50 @@
"server-to-server": true,
"additional-permissions": false
},
{
"category": "billing",
"slug": "get-all-budgets-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "billing",
"slug": "get-a-budget-by-id-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "billing",
"slug": "update-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "patch",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "billing",
"slug": "delete-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "delete",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "billing",
"slug": "get-billing-premium-request-usage-report-for-an-organization",
@@ -165,7 +209,7 @@
},
{
"category": "billing",
"slug": "get-billing-usage-summary-report-for-an-organization",
"slug": "get-billing-usage-summary-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/usage/summary",
@@ -10942,7 +10986,7 @@
},
{
"category": "billing",
"slug": "get-billing-usage-summary-report-for-a-user",
"slug": "get-billing-usage-summary-for-a-user",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/users/{username}/settings/billing/usage/summary",

View File

@@ -1146,6 +1146,30 @@
}
],
"billing": [
{
"slug": "get-all-budgets-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets"
},
{
"slug": "get-a-budget-by-id-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "update-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "patch",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "delete-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "delete",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "get-billing-premium-request-usage-report-for-an-organization",
"subcategory": "enhanced-billing",
@@ -1159,7 +1183,7 @@
"requestPath": "/organizations/{org}/settings/billing/usage"
},
{
"slug": "get-billing-usage-summary-report-for-an-organization",
"slug": "get-billing-usage-summary-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/usage/summary"

View File

@@ -1188,6 +1188,30 @@
}
],
"billing": [
{
"slug": "get-all-budgets-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets"
},
{
"slug": "get-a-budget-by-id-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "update-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "patch",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "delete-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "delete",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "get-billing-premium-request-usage-report-for-an-organization",
"subcategory": "enhanced-billing",
@@ -1201,7 +1225,7 @@
"requestPath": "/organizations/{org}/settings/billing/usage"
},
{
"slug": "get-billing-usage-summary-report-for-an-organization",
"slug": "get-billing-usage-summary-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/usage/summary"
@@ -1255,7 +1279,7 @@
"requestPath": "/users/{username}/settings/billing/usage"
},
{
"slug": "get-billing-usage-summary-report-for-a-user",
"slug": "get-billing-usage-summary-for-a-user",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/users/{username}/settings/billing/usage/summary"

View File

@@ -195,6 +195,42 @@
"additional-permissions": false,
"access": "write"
},
{
"category": "billing",
"slug": "get-all-budgets-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets",
"additional-permissions": false,
"access": "read"
},
{
"category": "billing",
"slug": "get-a-budget-by-id-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "billing",
"slug": "update-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "patch",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"additional-permissions": false,
"access": "write"
},
{
"category": "billing",
"slug": "delete-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "delete",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"additional-permissions": false,
"access": "write"
},
{
"category": "billing",
"slug": "get-billing-premium-request-usage-report-for-an-organization",
@@ -215,7 +251,7 @@
},
{
"category": "billing",
"slug": "get-billing-usage-summary-report-for-an-organization",
"slug": "get-billing-usage-summary-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/usage/summary",
@@ -9575,7 +9611,7 @@
},
{
"category": "billing",
"slug": "get-billing-usage-summary-report-for-a-user",
"slug": "get-billing-usage-summary-for-a-user",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/users/{username}/settings/billing/usage/summary",

View File

@@ -1128,6 +1128,30 @@
}
],
"billing": [
{
"slug": "get-all-budgets-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets"
},
{
"slug": "get-a-budget-by-id-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "update-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "patch",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "delete-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "delete",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "get-billing-premium-request-usage-report-for-an-organization",
"subcategory": "enhanced-billing",
@@ -1141,7 +1165,7 @@
"requestPath": "/organizations/{org}/settings/billing/usage"
},
{
"slug": "get-billing-usage-summary-report-for-an-organization",
"slug": "get-billing-usage-summary-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/usage/summary"
@@ -1201,7 +1225,7 @@
"requestPath": "/users/{username}/settings/billing/usage"
},
{
"slug": "get-billing-usage-summary-report-for-a-user",
"slug": "get-billing-usage-summary-for-a-user",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/users/{username}/settings/billing/usage/summary"

View File

@@ -738,6 +738,50 @@
"server-to-server": true,
"additional-permissions": false
},
{
"category": "billing",
"slug": "get-all-budgets-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "billing",
"slug": "get-a-budget-by-id-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "billing",
"slug": "update-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "patch",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "billing",
"slug": "delete-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "delete",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "billing",
"slug": "get-billing-premium-request-usage-report-for-an-organization",
@@ -762,7 +806,7 @@
},
{
"category": "billing",
"slug": "get-billing-usage-summary-report-for-an-organization",
"slug": "get-billing-usage-summary-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/usage/summary",
@@ -12494,7 +12538,7 @@
},
{
"category": "billing",
"slug": "get-billing-usage-summary-report-for-a-user",
"slug": "get-billing-usage-summary-for-a-user",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/users/{username}/settings/billing/usage/summary",

View File

@@ -1178,6 +1178,30 @@
}
],
"billing": [
{
"slug": "get-all-budgets-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets"
},
{
"slug": "get-a-budget-by-id-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "update-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "patch",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "delete-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "delete",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "get-billing-premium-request-usage-report-for-an-organization",
"subcategory": "enhanced-billing",
@@ -1191,7 +1215,7 @@
"requestPath": "/organizations/{org}/settings/billing/usage"
},
{
"slug": "get-billing-usage-summary-report-for-an-organization",
"slug": "get-billing-usage-summary-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/usage/summary"

View File

@@ -1220,6 +1220,30 @@
}
],
"billing": [
{
"slug": "get-all-budgets-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets"
},
{
"slug": "get-a-budget-by-id-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "update-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "patch",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "delete-a-budget-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "delete",
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
},
{
"slug": "get-billing-premium-request-usage-report-for-an-organization",
"subcategory": "enhanced-billing",
@@ -1233,7 +1257,7 @@
"requestPath": "/organizations/{org}/settings/billing/usage"
},
{
"slug": "get-billing-usage-summary-report-for-an-organization",
"slug": "get-billing-usage-summary-for-an-organization",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/organizations/{org}/settings/billing/usage/summary"
@@ -1293,7 +1317,7 @@
"requestPath": "/users/{username}/settings/billing/usage"
},
{
"slug": "get-billing-usage-summary-report-for-a-user",
"slug": "get-billing-usage-summary-for-a-user",
"subcategory": "enhanced-billing",
"verb": "get",
"requestPath": "/users/{username}/settings/billing/usage/summary"

View File

@@ -60,5 +60,5 @@
"2022-11-28"
]
},
"sha": "ebc1fecbcfb4449cc61d45e2608ac765b5b144a0"
"sha": "b972b823e3572c9e6b64c3341401184e4eb0a474"
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -385771,7 +385771,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the projects in an organization. Returns a <code>404 Not Found</code> status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a <code>401 Unauthorized</code> or <code>410 Gone</code> status is returned.</p>",
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the <a href=\"https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/\">changelog</a> for more information.</p>\n</div>",
"codeExamples": [
{
"key": "default",
@@ -387502,7 +387502,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the projects in a repository. Returns a <code>404 Not Found</code> status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a <code>401 Unauthorized</code> or <code>410 Gone</code> status is returned.</p>",
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the <a href=\"https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/\">changelog</a> for more information.</p>\n</div>",
"codeExamples": [
{
"key": "default",
@@ -388754,7 +388754,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Lists projects for a user.</p>",
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the <a href=\"https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/\">changelog</a> for more information.</p>\n</div>",
"codeExamples": [
{
"key": "default",

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -47,5 +47,5 @@
]
}
},
"sha": "ebc1fecbcfb4449cc61d45e2608ac765b5b144a0"
"sha": "b972b823e3572c9e6b64c3341401184e4eb0a474"
}

View File

@@ -1,3 +1,3 @@
{
"sha": "ebc1fecbcfb4449cc61d45e2608ac765b5b144a0"
"sha": "b972b823e3572c9e6b64c3341401184e4eb0a474"
}