GitHub Enterprise Server 3.5 release candidate (#26792)
This commit is contained in:
Matt Pollard
@@ -144618,6 +144618,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -144724,6 +144731,16 @@
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>IP for location auto-detection when proxying a request</p>",
|
||||
"type": "string",
|
||||
"name": "client_ip",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "IP for location auto-detection when proxying a request",
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>Machine type to use for this codespace</p>",
|
||||
"type": "string",
|
||||
@@ -144744,6 +144761,16 @@
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>Whether to authorize requested permissions from devcontainer.json</p>",
|
||||
"type": "boolean",
|
||||
"name": "multi_repo_permissions_opt_out",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether to authorize requested permissions from devcontainer.json",
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>Working directory for this codespace</p>",
|
||||
"type": "string",
|
||||
@@ -147669,6 +147696,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -150590,6 +150624,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -150831,6 +150872,16 @@
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>IP for location auto-detection when proxying a request</p>",
|
||||
"type": "string",
|
||||
"name": "client_ip",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "IP for location auto-detection when proxying a request",
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>Machine type to use for this codespace</p>",
|
||||
"type": "string",
|
||||
@@ -150851,6 +150902,16 @@
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>Whether to authorize requested permissions from devcontainer.json</p>",
|
||||
"type": "boolean",
|
||||
"name": "multi_repo_permissions_opt_out",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether to authorize requested permissions from devcontainer.json",
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>Working directory for this codespace</p>",
|
||||
"type": "string",
|
||||
@@ -153777,6 +153838,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -156699,6 +156767,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -159977,6 +160052,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -160078,6 +160160,16 @@
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>IP for location auto-detection when proxying a request</p>",
|
||||
"type": "string",
|
||||
"name": "client_ip",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "IP for location auto-detection when proxying a request",
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>Machine type to use for this codespace</p>",
|
||||
"type": "string",
|
||||
@@ -160098,6 +160190,16 @@
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>Whether to authorize requested permissions from devcontainer.json</p>",
|
||||
"type": "boolean",
|
||||
"name": "multi_repo_permissions_opt_out",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether to authorize requested permissions from devcontainer.json",
|
||||
"isRequired": false,
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"description": "<p>Working directory for this codespace</p>",
|
||||
"type": "string",
|
||||
@@ -163084,6 +163186,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -166002,6 +166111,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -168964,6 +169080,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -171968,6 +172091,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -175277,6 +175407,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -178255,6 +178392,13 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"idle_timeout_notice": {
|
||||
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -178349,6 +178493,14 @@
|
||||
"WestUs2"
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "client_ip",
|
||||
"description": "<p>IP for location auto-detection when proxying a request</p>",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
@@ -220871,6 +221023,346 @@
|
||||
]
|
||||
},
|
||||
"enterprise-admin": {
|
||||
"admin-stats": [
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "get",
|
||||
"requestPath": "/enterprise-installation/{enterprise_or_org}/server-statistics",
|
||||
"title": "Get GitHub Enterprise Server statistics",
|
||||
"category": "enterprise-admin",
|
||||
"subcategory": "admin-stats",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "enterprise_or_org",
|
||||
"description": "<p>The slug version of the enterprise name or the login of an organization.</p>",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "date_start",
|
||||
"description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header\">Link header</a>. If specified, the query only searches for events after this cursor.</p>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "date_end",
|
||||
"description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header\">Link header</a>. If specified, the query only searches for events before this cursor.</p>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"enabledForGitHubApps": false,
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"parameters": {
|
||||
"enterprise_or_org": "ENTERPRISE_OR_ORG"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "<p>Response</p>",
|
||||
"example": {
|
||||
"server_id": "ea6088f3-f095-4bf2-8d7f-c573819e8768",
|
||||
"collection_date": "2021-12-14T23:59:59Z",
|
||||
"schema_version": "20220111",
|
||||
"ghes_version": "3.5.0",
|
||||
"host_name": "github.example.com",
|
||||
"github_connect": {
|
||||
"features_enabled": [
|
||||
"license_usage_sync",
|
||||
"content_analysis",
|
||||
"content_analysis_notifications"
|
||||
]
|
||||
},
|
||||
"ghe_stats": {
|
||||
"comments": {
|
||||
"total_commit_comments": 1000,
|
||||
"total_gist_comments": 1000,
|
||||
"total_issue_comments": 0,
|
||||
"total_pull_request_comments": 0
|
||||
},
|
||||
"gists": {
|
||||
"total_gists": 100,
|
||||
"private_gists": 59,
|
||||
"public_gists": 41
|
||||
},
|
||||
"hooks": {
|
||||
"total_hooks": 2,
|
||||
"active_hooks": 1,
|
||||
"inactive_hooks": 1
|
||||
},
|
||||
"issues": {
|
||||
"total_issues": 3421,
|
||||
"open_issues": 1234,
|
||||
"closed_issues": 1222
|
||||
},
|
||||
"milestones": {
|
||||
"total_milestones": 50,
|
||||
"open_milestones": 20,
|
||||
"closed_milestones": 30
|
||||
},
|
||||
"orgs": {
|
||||
"total_orgs": 100,
|
||||
"disabled_orgs": 22,
|
||||
"total_teams": 299,
|
||||
"total_team_members": 400
|
||||
},
|
||||
"pages": {
|
||||
"total_pages": 10
|
||||
},
|
||||
"pulls": {
|
||||
"total_pulls": 1232,
|
||||
"merged_pulls": 223,
|
||||
"mergeable_pulls": 435,
|
||||
"unmergeable_pulls": 0
|
||||
},
|
||||
"repos": {
|
||||
"total_repos": 12,
|
||||
"root_repos": 1,
|
||||
"fork_repos": 2,
|
||||
"org_repos": 1,
|
||||
"total_pushes": 42,
|
||||
"total_wikis": 1
|
||||
},
|
||||
"users": {
|
||||
"total_users": 2000,
|
||||
"admin_users": 299,
|
||||
"suspended_users": 423
|
||||
}
|
||||
},
|
||||
"dormant_users": {
|
||||
"total_dormant_users": 5,
|
||||
"dormancy_threshold": "90 days"
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"title": "Server Statistics Proxy Endpoint",
|
||||
"description": "Response of S4 Proxy endpoint that provides GHES statistics",
|
||||
"properties": {
|
||||
"server_id": {
|
||||
"type": "string"
|
||||
},
|
||||
"collection_date": {
|
||||
"type": "string"
|
||||
},
|
||||
"schema_version": {
|
||||
"type": "string"
|
||||
},
|
||||
"ghes_version": {
|
||||
"type": "string"
|
||||
},
|
||||
"host_name": {
|
||||
"type": "string"
|
||||
},
|
||||
"github_connect": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"features_enabled": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"ghe_stats": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"comments": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_commit_comments": {
|
||||
"type": "integer"
|
||||
},
|
||||
"total_gist_comments": {
|
||||
"type": "integer"
|
||||
},
|
||||
"total_issue_comments": {
|
||||
"type": "integer"
|
||||
},
|
||||
"total_pull_request_comments": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"gists": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_gists": {
|
||||
"type": "integer"
|
||||
},
|
||||
"private_gists": {
|
||||
"type": "integer"
|
||||
},
|
||||
"public_gists": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"hooks": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_hooks": {
|
||||
"type": "integer"
|
||||
},
|
||||
"active_hooks": {
|
||||
"type": "integer"
|
||||
},
|
||||
"inactive_hooks": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"issues": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_issues": {
|
||||
"type": "integer"
|
||||
},
|
||||
"open_issues": {
|
||||
"type": "integer"
|
||||
},
|
||||
"closed_issues": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"milestones": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_milestones": {
|
||||
"type": "integer"
|
||||
},
|
||||
"open_milestones": {
|
||||
"type": "integer"
|
||||
},
|
||||
"closed_milestones": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"orgs": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_orgs": {
|
||||
"type": "integer"
|
||||
},
|
||||
"disabled_orgs": {
|
||||
"type": "integer"
|
||||
},
|
||||
"total_teams": {
|
||||
"type": "integer"
|
||||
},
|
||||
"total_team_members": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"pages": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_pages": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"pulls": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_pulls": {
|
||||
"type": "integer"
|
||||
},
|
||||
"merged_pulls": {
|
||||
"type": "integer"
|
||||
},
|
||||
"mergeable_pulls": {
|
||||
"type": "integer"
|
||||
},
|
||||
"unmergeable_pulls": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"repos": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_repos": {
|
||||
"type": "integer"
|
||||
},
|
||||
"root_repos": {
|
||||
"type": "integer"
|
||||
},
|
||||
"fork_repos": {
|
||||
"type": "integer"
|
||||
},
|
||||
"org_repos": {
|
||||
"type": "integer"
|
||||
},
|
||||
"total_pushes": {
|
||||
"type": "integer"
|
||||
},
|
||||
"total_wikis": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"users": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_users": {
|
||||
"type": "integer"
|
||||
},
|
||||
"admin_users": {
|
||||
"type": "integer"
|
||||
},
|
||||
"suspended_users": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"dormant_users": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_dormant_users": {
|
||||
"type": "integer"
|
||||
},
|
||||
"dormancy_threshold": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.</p>\n<p>To use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see \"<a href=\"/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise\">Enabling Server Statistics for your enterprise</a>\" in the GitHub Enterprise Server documentation.</p>\n<p>You'll need to use a personal access token:</p>\n<ul>\n<li>If you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics, you'll need a personal access token with the <code>read:enterprise</code> permission.</li>\n<li>If you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics, you'll need a personal access token with the <code>read:org</code> permission.</li>\n</ul>\n<p>For more information on creating a personal access token, see \"<a href=\"/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token\">Creating a personal access token</a>.\"</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"audit-log": [
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
@@ -354726,6 +355218,21 @@
|
||||
"https://example.com"
|
||||
]
|
||||
},
|
||||
"build_type": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "The process in which the Page will be built.",
|
||||
"enum": [
|
||||
"legacy",
|
||||
"workflow",
|
||||
null
|
||||
],
|
||||
"examples": [
|
||||
"legacy"
|
||||
]
|
||||
},
|
||||
"source": {
|
||||
"title": "Pages Source Hash",
|
||||
"type": "object",
|
||||
@@ -354898,7 +355405,7 @@
|
||||
"in": "body",
|
||||
"rawType": "object",
|
||||
"rawDescription": "The source branch and directory used to publish your Pages site.",
|
||||
"isRequired": true,
|
||||
"isRequired": false,
|
||||
"childParamsGroups": [
|
||||
{
|
||||
"parentName": "source",
|
||||
@@ -355058,6 +355565,21 @@
|
||||
"https://example.com"
|
||||
]
|
||||
},
|
||||
"build_type": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "The process in which the Page will be built.",
|
||||
"enum": [
|
||||
"legacy",
|
||||
"workflow",
|
||||
null
|
||||
],
|
||||
"examples": [
|
||||
"legacy"
|
||||
]
|
||||
},
|
||||
"source": {
|
||||
"title": "Pages Source Hash",
|
||||
"type": "object",
|
||||
|
||||
Reference in New Issue
Block a user