jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Description (#57256)

Browse Source 
Co-authored-by: hubwriter <hubwriter@github.com>
This commit is contained in:
docs-bot
2025-08-26 07:08:05 -07:00
committed by GitHub
parent fe1407787d
commit 1b81cfe1df
11 changed files with 241 additions and 241 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -754,7 +754,7 @@
"verb": "get",
"requestPath": "/orgs/{org}/secret-scanning/pattern-configurations",
"additional-permissions": false,
"access": "write"
"access": "read"
},
{
"category": "secret-scanning",

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

@@ -917,7 +917,7 @@
"subcategory": "push-protection",
"verb": "get",
"requestPath": "/orgs/{org}/secret-scanning/pattern-configurations",
"access": "write",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false

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

@@ -1027,7 +1027,7 @@
"verb": "get",
"requestPath": "/orgs/{org}/secret-scanning/pattern-configurations",
"additional-permissions": false,
"access": "write"
"access": "read"
},
{
"category": "secret-scanning",

2
src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
View File

@@ -1414,7 +1414,7 @@
"subcategory": "push-protection",
"verb": "get",
"requestPath": "/orgs/{org}/secret-scanning/pattern-configurations",
"access": "write",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false

2
src/github-apps/lib/config.json
View File

@@ -60,5 +60,5 @@
"2022-11-28"
]
},
"sha": "8d36cf75c50f0c0cfa27b0f1413e0904847f91ba"
"sha": "883ec926b6621250deaa3de639e53a42967d2639"
}

20
src/rest/data/fpt-2022-11-28/schema.json
View File

@@ -243909,7 +243909,7 @@
},
{
"name": "since",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 28 days ago.</p>",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 100 days ago.</p>",
"in": "query",
"required": false,
"schema": {
@@ -243936,11 +243936,11 @@
},
{
"name": "per_page",
"description": "<p>The number of days of metrics to display per page (max 28). 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>",
"description": "<p>The number of days of metrics to display 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>",
"in": "query",
"schema": {
"type": "integer",
"default": 28
"default": 100
}
}
],
@@ -244448,7 +244448,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint will only return results for a given day if the organization contained <strong>five or more members with active Copilot licenses</strong> on that day, as evaluated at the end of that day.</p>\n</div>\n<p>The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code>, <code>read:org</code>, or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"descriptionHTML": "<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint will only return results for a given day if the organization contained <strong>five or more members with active Copilot licenses</strong> on that day, as evaluated at the end of that day.</p>\n</div>\n<p>The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code>, <code>read:org</code>, or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -244500,7 +244500,7 @@
},
{
"name": "since",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 28 days ago.</p>",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 100 days ago.</p>",
"in": "query",
"required": false,
"schema": {
@@ -244527,11 +244527,11 @@
},
{
"name": "per_page",
"description": "<p>The number of days of metrics to display per page (max 28). 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>",
"description": "<p>The number of days of metrics to display 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>",
"in": "query",
"schema": {
"type": "integer",
"default": 28
"default": 100
}
}
],
@@ -245040,7 +245040,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint will only return results for a given day if the team had <strong>five or more members with active Copilot licenses</strong> on that day, as evaluated at the end of that day.</p>\n</div>\n<p>The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code>, <code>read:org</code>, or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"descriptionHTML": "<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint will only return results for a given day if the team had <strong>five or more members with active Copilot licenses</strong> on that day, as evaluated at the end of that day.</p>\n</div>\n<p>The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code>, <code>read:org</code>, or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -591477,7 +591477,7 @@
"fineGrainedPat": true,
"permissions": [
{
"\"Administration\" organization permissions": "write"
"\"Administration\" organization permissions": "read"
}
]
},
@@ -591702,7 +591702,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the secret scanning pattern configurations for an organization.</p>\n<p>Personal access tokens (classic) need the <code>write:org</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists the secret scanning pattern configurations for an organization.</p>\n<p>Personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

36
src/rest/data/ghec-2022-11-28/schema.json
View File

@@ -257237,7 +257237,7 @@
},
{
"name": "since",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 28 days ago.</p>",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 100 days ago.</p>",
"in": "query",
"required": false,
"schema": {
@@ -257264,11 +257264,11 @@
},
{
"name": "per_page",
"description": "<p>The number of days of metrics to display per page (max 28). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
"description": "<p>The number of days of metrics to display per page (max 100). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
"in": "query",
"schema": {
"type": "integer",
"default": 28
"default": 100
}
}
],
@@ -257769,7 +257769,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<p>The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"descriptionHTML": "<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<p>The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -257821,7 +257821,7 @@
},
{
"name": "since",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 28 days ago.</p>",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 100 days ago.</p>",
"in": "query",
"required": false,
"schema": {
@@ -257848,11 +257848,11 @@
},
{
"name": "per_page",
"description": "<p>The number of days of metrics to display per page (max 28). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
"description": "<p>The number of days of metrics to display per page (max 100). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
"in": "query",
"schema": {
"type": "integer",
"default": 28
"default": 100
}
}
],
@@ -258354,7 +258354,7 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business\">About enterprise accounts for Copilot Business</a>.\"</p>\n</div>\n<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<p>The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint will only return results for a given day if the enterprise team had <strong>five or more members with active Copilot licenses</strong> on that day, as evaluated at the end of that day.</p>\n</div>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business\">About enterprise accounts for Copilot Business</a>.\"</p>\n</div>\n<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<p>The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint will only return results for a given day if the enterprise team had <strong>five or more members with active Copilot licenses</strong> on that day, as evaluated at the end of that day.</p>\n</div>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code> or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -258397,7 +258397,7 @@
},
{
"name": "since",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 28 days ago.</p>",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 100 days ago.</p>",
"in": "query",
"required": false,
"schema": {
@@ -258424,11 +258424,11 @@
},
{
"name": "per_page",
"description": "<p>The number of days of metrics to display per page (max 28). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
"description": "<p>The number of days of metrics to display per page (max 100). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
"in": "query",
"schema": {
"type": "integer",
"default": 28
"default": 100
}
}
],
@@ -258936,7 +258936,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint will only return results for a given day if the organization contained <strong>five or more members with active Copilot licenses</strong> on that day, as evaluated at the end of that day.</p>\n</div>\n<p>The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code>, <code>read:org</code>, or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"descriptionHTML": "<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint will only return results for a given day if the organization contained <strong>five or more members with active Copilot licenses</strong> on that day, as evaluated at the end of that day.</p>\n</div>\n<p>The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code>, <code>read:org</code>, or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -258988,7 +258988,7 @@
},
{
"name": "since",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 28 days ago.</p>",
"description": "<p>Show usage metrics since this date. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (<code>YYYY-MM-DDTHH:MM:SSZ</code>). Maximum value is 100 days ago.</p>",
"in": "query",
"required": false,
"schema": {
@@ -259015,11 +259015,11 @@
},
{
"name": "per_page",
"description": "<p>The number of days of metrics to display per page (max 28). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
"description": "<p>The number of days of metrics to display per page (max 100). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
"in": "query",
"schema": {
"type": "integer",
"default": 28
"default": 100
}
}
],
@@ -259528,7 +259528,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint will only return results for a given day if the team had <strong>five or more members with active Copilot licenses</strong> on that day, as evaluated at the end of that day.</p>\n</div>\n<p>The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code>, <code>read:org</code>, or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"descriptionHTML": "<p>Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint will only return results for a given day if the team had <strong>five or more members with active Copilot licenses</strong> on that day, as evaluated at the end of that day.</p>\n</div>\n<p>The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.</p>\n<p>To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.</p>\n<p>OAuth app tokens and personal access tokens (classic) need either the <code>manage_billing:copilot</code>, <code>read:org</code>, or <code>read:enterprise</code> scopes to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -641500,7 +641500,7 @@
"fineGrainedPat": true,
"permissions": [
{
"\"Administration\" organization permissions": "write"
"\"Administration\" organization permissions": "read"
}
]
},
@@ -641725,7 +641725,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the secret scanning pattern configurations for an organization.</p>\n<p>Personal access tokens (classic) need the <code>write:org</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists the secret scanning pattern configurations for an organization.</p>\n<p>Personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

304
src/rest/data/ghes-3.14-2022-11-28/schema.json
View File

File diff suppressed because it is too large Load Diff

108
src/rest/data/ghes-3.15-2022-11-28/schema.json
View File

@@ -2836,13 +2836,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -7496,13 +7496,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10677,13 +10677,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13116,13 +13116,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists self-hosted runners that are in a specific organization group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists self-hosted runners that are in a specific organization group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13706,13 +13706,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -59799,13 +59799,13 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -82188,13 +82188,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: <a href=\"https://github.com/notifications\">https://github.com/notifications</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No content</p>"
}
]
],
"descriptionHTML": "<p>Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: <a href=\"https://github.com/notifications\">https://github.com/notifications</a>.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -83711,7 +83711,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -83721,7 +83720,8 @@
"httpStatusCode": "205",
"description": "<p>Reset Content</p>"
}
]
],
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>"
}
],
"starring": [
@@ -92229,13 +92229,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes the announcement banner currently set for the organization.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Removes the announcement banner currently set for the organization.</p>"
}
]
},
@@ -110549,13 +110549,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the GitHub Advanced Security active committers for an organization per repository.</p>\n<p>Each distinct user login across all repositories is counted as a single Advanced Security seat, so the <code>total_advanced_security_committers</code> is not the sum of advanced_security_committers for each repository.</p>\n<p>If this organization defers to an enterprise for billing, the <code>total_advanced_security_committers</code> returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.</p>\n<p>The total number of repositories with committer information is tracked by the <code>total_count</code> field.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>Success</p>"
}
]
],
"descriptionHTML": "<p>Gets the GitHub Advanced Security active committers for an organization per repository.</p>\n<p>Each distinct user login across all repositories is counted as a single Advanced Security seat, so the <code>total_advanced_security_committers</code> is not the sum of advanced_security_committers for each repository.</p>\n<p>If this organization defers to an enterprise for billing, the <code>total_advanced_security_committers</code> returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.</p>\n<p>The total number of repositories with committer information is tracked by the <code>total_count</code> field.</p>"
}
]
},
@@ -168702,13 +168702,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -192322,13 +192322,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -192475,7 +192475,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for\nrepository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-an-organization-secret\">Create or\nupdate an organization secret</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -192485,7 +192484,8 @@
"httpStatusCode": "409",
"description": "<p>Conflict when visibility type is not set to selected</p>"
}
]
],
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for\nrepository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-an-organization-secret\">Create or\nupdate an organization secret</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -193099,13 +193099,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes a secret in a repository using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Deletes a secret in a repository using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}
]
},
@@ -206647,13 +206647,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -206981,13 +206981,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the current message and expiration date of the global announcement banner in your enterprise.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets the current message and expiration date of the global announcement banner in your enterprise.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -209589,13 +209589,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": ""
}
],
"manage-ghes": [
@@ -211623,7 +211623,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates the settings on your instance. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-settings\">Get settings endpoint</a>.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values.</li>\n<li>You cannot set the Management Console root site administrator password with this API endpoint. Use the <code>ghe-set-password</code> utility to change the management console password. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password\">Command-line utilities</a>.\"</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -211641,7 +211640,8 @@
"httpStatusCode": "500",
"description": "<p>Internal error</p>"
}
]
],
"descriptionHTML": "<p>Updates the settings on your instance. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-settings\">Get settings endpoint</a>.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values.</li>\n<li>You cannot set the Management Console root site administrator password with this API endpoint. Use the <code>ghe-set-password</code> utility to change the management console password. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password\">Command-line utilities</a>.\"</li>\n</ul>"
},
{
"serverUrl": "http(s)://HOSTNAME",
@@ -319453,13 +319453,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -342661,7 +342661,6 @@
}
],
"previews": [],
"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> The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use <a href=\"https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations\">code security configurations</a> instead. For more information, see the <a href=\"https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/\">changelog</a>.</p>\n</div>\n<p>Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code>, <code>write:org</code>, or <code>repo</code> scopes to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -342671,7 +342670,8 @@
"httpStatusCode": "422",
"description": "<p>The action could not be taken due to an in progress enablement, or a policy is preventing enablement</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> The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use <a href=\"https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations\">code security configurations</a> instead. For more information, see the <a href=\"https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/\">changelog</a>.</p>\n</div>\n<p>Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code>, <code>write:org</code>, or <code>repo</code> scopes to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -343712,7 +343712,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a custom property that is defined for an organization.\nOrganization members can read these properties.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -343726,7 +343725,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
]
],
"descriptionHTML": "<p>Gets a custom property that is defined for an organization.\nOrganization members can read these properties.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -345703,7 +345703,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -345713,7 +345712,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
]
],
"descriptionHTML": "<p>Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -352082,7 +352082,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the teams that are assigned to an organization role. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>To use this endpoint, you must be an administrator for the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -352096,7 +352095,8 @@
"httpStatusCode": "422",
"description": "<p>Response if the organization roles feature is not enabled or validation failed.</p>"
}
]
],
"descriptionHTML": "<p>Lists the teams that are assigned to an organization role. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>To use this endpoint, you must be an administrator for the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -429740,7 +429740,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<p>A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -429750,7 +429749,8 @@
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
]
],
"descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<p>A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -430914,13 +430914,13 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion\">team discussion</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion\">team discussion</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -516471,13 +516471,13 @@
}
],
"previews": [],
"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>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</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>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -518049,13 +518049,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists a team's repositories visible to the authenticated user.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/repos</code>.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists a team's repositories visible to the authenticated user.</p>\n<div class=\"ghd-alert ghd-alert-accent\" 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=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/repos</code>.</p>\n</div>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",

2
src/rest/lib/config.json
View File

@@ -44,5 +44,5 @@
]
}
},
"sha": "8d36cf75c50f0c0cfa27b0f1413e0904847f91ba"
"sha": "883ec926b6621250deaa3de639e53a42967d2639"
}

2
src/webhooks/lib/config.json
View File

@@ -1,3 +1,3 @@
{
"sha": "8d36cf75c50f0c0cfa27b0f1413e0904847f91ba"
"sha": "883ec926b6621250deaa3de639e53a42967d2639"
}