Skip to content

Commit a475ac7

Browse files
docs-botjc-clark
andauthored
Update OpenAPI Description (#62916)
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
1 parent f763d18 commit a475ac7

21 files changed

Lines changed: 10699 additions & 199 deletions

File tree

src/github-apps/lib/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "d77b7dde24f7b3a52b3532b1337d4be8a60fb34d"
63+
"sha": "fee3373e1517aa7a3510c5db165154f47baf8d97"
6464
}

src/rest/data/fpt-2022-11-28/issues.json

Lines changed: 890 additions & 0 deletions
Large diffs are not rendered by default.

src/rest/data/fpt-2022-11-28/secret-scanning.json

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7049,24 +7049,6 @@
70497049
]
70507050
}
70517051
},
7052-
{
7053-
"name": "page",
7054-
"description": "<p>The page number of the results to fetch. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
7055-
"in": "query",
7056-
"schema": {
7057-
"type": "integer",
7058-
"default": 1
7059-
}
7060-
},
7061-
{
7062-
"name": "per_page",
7063-
"description": "<p>The number of results per page (max 100). For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
7064-
"in": "query",
7065-
"schema": {
7066-
"type": "integer",
7067-
"default": 30
7068-
}
7069-
},
70707052
{
70717053
"name": "before",
70727054
"description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers\">Link header</a>. If specified, the query only searches for results before this cursor. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
@@ -7965,24 +7947,6 @@
79657947
]
79667948
}
79677949
},
7968-
{
7969-
"name": "page",
7970-
"description": "<p>The page number of the results to fetch. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
7971-
"in": "query",
7972-
"schema": {
7973-
"type": "integer",
7974-
"default": 1
7975-
}
7976-
},
7977-
{
7978-
"name": "per_page",
7979-
"description": "<p>The number of results per page (max 100). For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
7980-
"in": "query",
7981-
"schema": {
7982-
"type": "integer",
7983-
"default": 30
7984-
}
7985-
},
79867950
{
79877951
"name": "before",
79887952
"description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers\">Link header</a>. If specified, the query only searches for results before this cursor. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",

src/rest/data/fpt-2026-03-10/issues.json

Lines changed: 890 additions & 0 deletions
Large diffs are not rendered by default.

src/rest/data/fpt-2026-03-10/secret-scanning.json

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7049,24 +7049,6 @@
70497049
]
70507050
}
70517051
},
7052-
{
7053-
"name": "page",
7054-
"description": "<p>The page number of the results to fetch. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
7055-
"in": "query",
7056-
"schema": {
7057-
"type": "integer",
7058-
"default": 1
7059-
}
7060-
},
7061-
{
7062-
"name": "per_page",
7063-
"description": "<p>The number of results per page (max 100). For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
7064-
"in": "query",
7065-
"schema": {
7066-
"type": "integer",
7067-
"default": 30
7068-
}
7069-
},
70707052
{
70717053
"name": "before",
70727054
"description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers\">Link header</a>. If specified, the query only searches for results before this cursor. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
@@ -7965,24 +7947,6 @@
79657947
]
79667948
}
79677949
},
7968-
{
7969-
"name": "page",
7970-
"description": "<p>The page number of the results to fetch. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
7971-
"in": "query",
7972-
"schema": {
7973-
"type": "integer",
7974-
"default": 1
7975-
}
7976-
},
7977-
{
7978-
"name": "per_page",
7979-
"description": "<p>The number of results per page (max 100). For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
7980-
"in": "query",
7981-
"schema": {
7982-
"type": "integer",
7983-
"default": 30
7984-
}
7985-
},
79867950
{
79877951
"name": "before",
79887952
"description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers\">Link header</a>. If specified, the query only searches for results before this cursor. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",

src/rest/data/ghec-2022-11-28/billing.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@
247247
}
248248
],
249249
"bodyParameters": [],
250-
"descriptionHTML": "<p>Gets budgets for an enterprise. Enterprise owners and billing managers can view all budgets, and organization administrators can view budgets scoped to organizations and repositories they administer. A custom role holder with fine-grained read access to enterprise billing can also view budgets. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can list all budgets in the enterprise.\nEach page returns up to 100 budgets.</p>",
250+
"descriptionHTML": "<p>Gets budgets for an enterprise. Enterprise owners and billing managers can view all budgets, and organization administrators can view budgets scoped to organizations and repositories they administer. A custom role holder with fine-grained read access to enterprise billing can view non-repository budgets; repository-scoped budgets require the organization administrator permissions described above. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can list all budgets in the enterprise.\nEach page returns up to 100 budgets.</p>",
251251
"codeExamples": [
252252
{
253253
"request": {
@@ -970,7 +970,7 @@
970970
}
971971
],
972972
"bodyParameters": [],
973-
"descriptionHTML": "<p>Gets a budget by ID. Enterprise owners and billing managers can view any budget in the enterprise, and organization administrators can view budgets scoped to organizations and repositories they administer. A custom role holder with fine-grained read access to enterprise billing can also view the budget. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can get any budget in the enterprise.</p>",
973+
"descriptionHTML": "<p>Gets a budget by ID. Enterprise owners and billing managers can view any budget in the enterprise, and organization administrators can view budgets scoped to organizations and repositories they administer. A custom role holder with fine-grained read access to enterprise billing can view the budget unless it is scoped to a repository; repository-scoped budgets require the organization administrator permissions described above. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can get any budget in the enterprise.</p>",
974974
"codeExamples": [
975975
{
976976
"request": {
@@ -2770,7 +2770,7 @@
27702770
"description": "<p>The enterprise teams to add to the cost center.</p>"
27712771
}
27722772
],
2773-
"descriptionHTML": "<p>Adds resources to a cost center.</p>\n<p>The usage for the resources will be charged to the cost center's budget. Enterprise owners and billing managers can add any resource, and organization owners can add non-team resources to cost centers associated with resources they administer. A custom role holder with fine-grained write access to enterprise billing can also add resources. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can add resources to any cost center in the enterprise.</p>",
2773+
"descriptionHTML": "<p>Adds resources to a cost center.</p>\n<p>The usage for the resources will be charged to the cost center's budget. Enterprise owners and billing managers can add any resource, and organization owners can add non-team resources to cost centers associated with resources they administer. A custom role holder with fine-grained write access to enterprise billing can add users in the enterprise who are visible to them and organizations or repositories they administer, but cannot add enterprise teams. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can add resources to any cost center in the enterprise.</p>",
27742774
"codeExamples": [
27752775
{
27762776
"request": {
@@ -2937,7 +2937,7 @@
29372937
"description": "<p>The enterprise teams to remove from the cost center.</p>"
29382938
}
29392939
],
2940-
"descriptionHTML": "<p>Remove resources from a cost center.</p>\n<p>The usage for the resources will no longer be charged to the cost center's budget. Enterprise owners and billing managers can remove any resource, and organization owners can remove non-team resources from cost centers associated with resources they administer. A custom role holder with fine-grained write access to enterprise billing can also remove resources. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can remove resources from any cost center in the enterprise.</p>",
2940+
"descriptionHTML": "<p>Remove resources from a cost center.</p>\n<p>The usage for the resources will no longer be charged to the cost center's budget. Enterprise owners and billing managers can remove any resource, and organization owners can remove non-team resources from cost centers associated with resources they administer. A custom role holder with fine-grained write access to enterprise billing can remove users and any organizations or repositories they administer; only enterprise owners and billing managers can remove enterprise teams. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can remove users from any cost center in the enterprise.</p>",
29412941
"codeExamples": [
29422942
{
29432943
"request": {
@@ -3099,7 +3099,7 @@
30993099
}
31003100
],
31013101
"bodyParameters": [],
3102-
"descriptionHTML": "<p>Gets a report of AI credit usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise, or a custom role holder with fine-grained read access to enterprise billing. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can get this usage report.</p>\n<p><strong>Note:</strong> Only data from the past 24 months is accessible via this endpoint.</p>",
3102+
"descriptionHTML": "<p>Gets a report of AI credit usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise, an organization owner in the enterprise, or a custom role holder with fine-grained read access to enterprise billing. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can get this usage report.</p>\n<p><strong>Note:</strong> Only data from the past 24 months is accessible via this endpoint.</p>",
31033103
"codeExamples": [
31043104
{
31053105
"request": {
@@ -3398,7 +3398,7 @@
33983398
}
33993399
],
34003400
"bodyParameters": [],
3401-
"descriptionHTML": "<p>Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise, or a custom role holder with fine-grained read access to enterprise billing. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can get this usage report.</p>\n<p><strong>Note:</strong> Only data from the past 24 months is accessible via this endpoint.</p>",
3401+
"descriptionHTML": "<p>Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise, an organization owner in the enterprise, or a custom role holder with fine-grained read access to enterprise billing. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can get this usage report.</p>\n<p><strong>Note:</strong> Only data from the past 24 months is accessible via this endpoint.</p>",
34023402
"codeExamples": [
34033403
{
34043404
"request": {
@@ -3661,7 +3661,7 @@
36613661
}
36623662
],
36633663
"bodyParameters": [],
3664-
"descriptionHTML": "<p>Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise, or a custom role holder with fine-grained read access to enterprise billing. By default this endpoint will return usage that does not have a cost center. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can get this usage report.</p>\n<p><strong>Note:</strong> This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest/billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform\">About the enhanced billing platform for enterprises</a>.\"</p>",
3664+
"descriptionHTML": "<p>Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise, an organization owner in the enterprise, or a custom role holder with fine-grained read access to enterprise billing. By default this endpoint will return usage that does not have a cost center. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can get this usage report.</p>\n<p><strong>Note:</strong> This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest/billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform\">About the enhanced billing platform for enterprises</a>.\"</p>",
36653665
"codeExamples": [
36663666
{
36673667
"request": {
@@ -3889,7 +3889,7 @@
38893889
}
38903890
],
38913891
"bodyParameters": [],
3892-
"descriptionHTML": "<p>Gets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise, or a custom role holder with fine-grained read access to enterprise billing. By default, this endpoint will return usage across all cost centers in the enterprise. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can get this usage summary report.</p>\n<p><strong>Note:</strong> Only data from the past 24 months is accessible via this endpoint.</p>",
3892+
"descriptionHTML": "<p>Gets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise, an organization owner in the enterprise, or a custom role holder with fine-grained read access to enterprise billing. By default, this endpoint will return usage across all cost centers in the enterprise. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can get this usage summary report.</p>\n<p><strong>Note:</strong> Only data from the past 24 months is accessible via this endpoint.</p>",
38933893
"codeExamples": [
38943894
{
38953895
"request": {

0 commit comments

Comments
 (0)