jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-23 11:54:18 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Description (#52949)

Browse Source 
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
This commit is contained in:
docs-bot
2024-11-04 08:25:39 -05:00
committed by GitHub
parent 5291cadfe9
commit cc74682f59
29 changed files with 3843 additions and 367 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,4 +1,91 @@
{
"organization_api_insights": {
"title": "API Insights",
"displayTitle": "Organization permissions for \"API Insights\"",
"permissions": [
{
"category": "orgs",
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}",
"additional-permissions": false,
"access": "read"
}
]
},
"organization_administration": {
"title": "Administration",
"displayTitle": "Organization permissions for \"Administration\"",

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

@@ -3178,6 +3178,60 @@
"verb": "post",
"requestPath": "/orgs/{org}/hooks/{hook_id}/pings"
},
{
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats"
},
{
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats"
},
{
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}"
},
{
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats"
},
{
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}"
},
{
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}"
},
{
"slug": "list-app-installations-for-an-organization",
"subcategory": "orgs",

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

@@ -60,6 +60,111 @@
}
]
},
"organization_api_insights": {
"title": "API Insights",
"displayTitle": "Organization permissions for \"API Insights\"",
"permissions": [
{
"category": "orgs",
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
}
]
},
"organization_administration": {
"title": "Administration",
"displayTitle": "Organization permissions for \"Administration\"",

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

@@ -2698,6 +2698,60 @@
"verb": "post",
"requestPath": "/orgs/{org}/hooks/{hook_id}/pings"
},
{
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats"
},
{
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats"
},
{
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}"
},
{
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats"
},
{
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}"
},
{
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}"
},
{
"slug": "list-app-installations-for-an-organization",
"subcategory": "orgs",

54
src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
View File

@@ -3178,6 +3178,60 @@
"verb": "post",
"requestPath": "/orgs/{org}/hooks/{hook_id}/pings"
},
{
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats"
},
{
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats"
},
{
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}"
},
{
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats"
},
{
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}"
},
{
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}"
},
{
"slug": "list-app-installations-for-an-organization",
"subcategory": "orgs",

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

@@ -203,6 +203,93 @@
}
]
},
"organization_api_insights": {
"title": "API Insights",
"displayTitle": "Organization permissions for \"API Insights\"",
"permissions": [
{
"category": "orgs",
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}",
"additional-permissions": false,
"access": "read"
}
]
},
"organization_administration": {
"title": "Administration",
"displayTitle": "Organization permissions for \"Administration\"",

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

@@ -3422,6 +3422,60 @@
"verb": "post",
"requestPath": "/orgs/{org}/hooks/{hook_id}/pings"
},
{
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats"
},
{
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats"
},
{
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}"
},
{
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats"
},
{
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}"
},
{
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}"
},
{
"slug": "list-app-installations-for-an-organization",
"subcategory": "orgs",

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

@@ -346,6 +346,111 @@
}
]
},
"organization_api_insights": {
"title": "API Insights",
"displayTitle": "Organization permissions for \"API Insights\"",
"permissions": [
{
"category": "orgs",
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
}
]
},
"organization_administration": {
"title": "Administration",
"displayTitle": "Organization permissions for \"Administration\"",

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

@@ -2942,6 +2942,60 @@
"verb": "post",
"requestPath": "/orgs/{org}/hooks/{hook_id}/pings"
},
{
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats"
},
{
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats"
},
{
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}"
},
{
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats"
},
{
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}"
},
{
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}"
},
{
"slug": "list-app-installations-for-an-organization",
"subcategory": "orgs",

54
src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
View File

@@ -3422,6 +3422,60 @@
"verb": "post",
"requestPath": "/orgs/{org}/hooks/{hook_id}/pings"
},
{
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats"
},
{
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats"
},
{
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}"
},
{
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats"
},
{
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}"
},
{
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}"
},
{
"slug": "list-app-installations-for-an-organization",
"subcategory": "orgs",

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

@@ -60,5 +60,5 @@
"2022-11-28"
]
},
"sha": "e3b1d8b69b58d9e3b89732e2dc093a635bd86ff5"
"sha": "1e71ef0197db634c5e55a7f66a9b01dbbc224ee1"
}