Skip to content

Commit 1b81cfe

Browse files
docs-bothubwriter
andauthored
Update OpenAPI Description (#57256)
Co-authored-by: hubwriter <[email protected]>
1 parent fe14077 commit 1b81cfe

File tree

11 files changed

+241
-241
lines changed

11 files changed

+241
-241
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,7 @@
754754
"verb": "get",
755755
"requestPath": "/orgs/{org}/secret-scanning/pattern-configurations",
756756
"additional-permissions": false,
757-
"access": "write"
757+
"access": "read"
758758
},
759759
{
760760
"category": "secret-scanning",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -917,7 +917,7 @@
917917
"subcategory": "push-protection",
918918
"verb": "get",
919919
"requestPath": "/orgs/{org}/secret-scanning/pattern-configurations",
920-
"access": "write",
920+
"access": "read",
921921
"user-to-server": true,
922922
"server-to-server": true,
923923
"additional-permissions": false

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1027,7 +1027,7 @@
10271027
"verb": "get",
10281028
"requestPath": "/orgs/{org}/secret-scanning/pattern-configurations",
10291029
"additional-permissions": false,
1030-
"access": "write"
1030+
"access": "read"
10311031
},
10321032
{
10331033
"category": "secret-scanning",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1414,7 +1414,7 @@
14141414
"subcategory": "push-protection",
14151415
"verb": "get",
14161416
"requestPath": "/orgs/{org}/secret-scanning/pattern-configurations",
1417-
"access": "write",
1417+
"access": "read",
14181418
"user-to-server": true,
14191419
"server-to-server": true,
14201420
"additional-permissions": false

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": "8d36cf75c50f0c0cfa27b0f1413e0904847f91ba"
63+
"sha": "883ec926b6621250deaa3de639e53a42967d2639"
6464
}

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -243909,7 +243909,7 @@
243909243909
},
243910243910
{
243911243911
"name": "since",
243912-
"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>",
243912+
"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>",
243913243913
"in": "query",
243914243914
"required": false,
243915243915
"schema": {
@@ -243936,11 +243936,11 @@
243936243936
},
243937243937
{
243938243938
"name": "per_page",
243939-
"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>",
243939+
"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>",
243940243940
"in": "query",
243941243941
"schema": {
243942243942
"type": "integer",
243943-
"default": 28
243943+
"default": 100
243944243944
}
243945243945
}
243946243946
],
@@ -244448,7 +244448,7 @@
244448244448
}
244449244449
],
244450244450
"previews": [],
244451-
"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>",
244451+
"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>",
244452244452
"statusCodes": [
244453244453
{
244454244454
"httpStatusCode": "200",
@@ -244500,7 +244500,7 @@
244500244500
},
244501244501
{
244502244502
"name": "since",
244503-
"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>",
244503+
"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>",
244504244504
"in": "query",
244505244505
"required": false,
244506244506
"schema": {
@@ -244527,11 +244527,11 @@
244527244527
},
244528244528
{
244529244529
"name": "per_page",
244530-
"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>",
244530+
"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>",
244531244531
"in": "query",
244532244532
"schema": {
244533244533
"type": "integer",
244534-
"default": 28
244534+
"default": 100
244535244535
}
244536244536
}
244537244537
],
@@ -245040,7 +245040,7 @@
245040245040
}
245041245041
],
245042245042
"previews": [],
245043-
"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>",
245043+
"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>",
245044245044
"statusCodes": [
245045245045
{
245046245046
"httpStatusCode": "200",
@@ -591477,7 +591477,7 @@
591477591477
"fineGrainedPat": true,
591478591478
"permissions": [
591479591479
{
591480-
"\"Administration\" organization permissions": "write"
591480+
"\"Administration\" organization permissions": "read"
591481591481
}
591482591482
]
591483591483
},
@@ -591702,7 +591702,7 @@
591702591702
}
591703591703
],
591704591704
"previews": [],
591705-
"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>",
591705+
"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>",
591706591706
"statusCodes": [
591707591707
{
591708591708
"httpStatusCode": "200",

0 commit comments

Comments
 (0)