Update OpenAPI Descriptions
This commit is contained in:
github-openapi-bot
@@ -21962,6 +21962,348 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/enterprises/{enterprise}/consumed-licenses": {
|
||||
"get": {
|
||||
"summary": "List enterprise consumed licenses",
|
||||
"description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
],
|
||||
"operationId": "enterprise-admin/get-consumed-licenses",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-enterprise-consumed-licenses"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "enterprise",
|
||||
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "The number of results per page (max 100).",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Consumed Licenses Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"title": "Enterprise Consumed Licenses",
|
||||
"description": "A breakdown of the licenses consumed by an enterprise.",
|
||||
"properties": {
|
||||
"total_seats_consumed": {
|
||||
"type": "integer"
|
||||
},
|
||||
"total_seats_purchased": {
|
||||
"type": "integer"
|
||||
},
|
||||
"users": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"github_com_login": {
|
||||
"type": "string"
|
||||
},
|
||||
"github_com_name": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"github_com_profile": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"license_type": {
|
||||
"type": "string"
|
||||
},
|
||||
"github_com_member_roles": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"github_com_enterprise_role": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"visual_studio_subscription_user": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"github_com_verified_domain_emails": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"github_com_saml_name_id": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"enterprise_server_user": {
|
||||
"type": [
|
||||
"boolean",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"enterprise_server_emails": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"github_com_user": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"total_user_accounts": {
|
||||
"type": "integer"
|
||||
},
|
||||
"enterprise_server_user_ids": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"github_com_orgs_with_pending_invites": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"visual_studio_subscription_email": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"default": {
|
||||
"value": {
|
||||
"total_seats_consumed": 5000,
|
||||
"total_seats_purchased": 4500,
|
||||
"users": [
|
||||
{
|
||||
"enterprise_server_emails": [
|
||||
"monalisa@github.com"
|
||||
],
|
||||
"github_com_login": "monalisa",
|
||||
"github_com_name": "Mona Lisa",
|
||||
"github_com_profile": "https://github.com/monalisa",
|
||||
"license_type": "enterprise",
|
||||
"github_com_member_roles": [
|
||||
"org1:Owner",
|
||||
"org2:Owner"
|
||||
],
|
||||
"github_com_enterprise_role": "owner",
|
||||
"visual_studio_subscription_user": false,
|
||||
"github_com_verified_domain_emails": [
|
||||
"monalisa@github.com"
|
||||
],
|
||||
"github_com_saml_name_id": "monalisa",
|
||||
"enterprise_server_user": true,
|
||||
"github_com_user": true,
|
||||
"total_user_accounts": 3,
|
||||
"enterprise_server_user_ids": [
|
||||
"example_host_name.com:123",
|
||||
"example_host_name_2:222"
|
||||
],
|
||||
"github_com_orgs_with_pending_invites": [
|
||||
"org1",
|
||||
"org2"
|
||||
],
|
||||
"visual_studio_subscription_email": ""
|
||||
},
|
||||
{
|
||||
"enterprise_server_emails": [
|
||||
"deleonjavier@example.com"
|
||||
],
|
||||
"github_com_login": "",
|
||||
"github_com_name": "",
|
||||
"github_com_profile": "",
|
||||
"license_type": "enterprise",
|
||||
"github_com_member_roles": [
|
||||
|
||||
],
|
||||
"github_com_enterprise_role": "",
|
||||
"visual_studio_subscription_user": false,
|
||||
"github_com_verified_domain_emails": [
|
||||
|
||||
],
|
||||
"github_com_saml_name_id": "",
|
||||
"enterprise_server_user": true,
|
||||
"github_com_user": false,
|
||||
"total_user_accounts": 1,
|
||||
"enterprise_server_user_ids": [
|
||||
"example_host_name:123"
|
||||
],
|
||||
"github_com_orgs_with_pending_invites": [
|
||||
|
||||
],
|
||||
"visual_studio_subscription_email": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"headers": {
|
||||
"Link": {
|
||||
"example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": true,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [
|
||||
|
||||
],
|
||||
"category": "enterprise-admin",
|
||||
"subcategory": "license"
|
||||
}
|
||||
}
|
||||
},
|
||||
"/enterprises/{enterprise}/license-sync-status": {
|
||||
"get": {
|
||||
"summary": "Get a license sync status",
|
||||
"description": "Gets information about the status of a license sync job for an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
],
|
||||
"operationId": "enterprise-admin/get-license-sync-status",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-license-sync-status"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "enterprise",
|
||||
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "License Sync Status Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"title": "License Sync Status",
|
||||
"description": "Information about the status of a license sync job for an enterprise.",
|
||||
"properties": {
|
||||
"server_instances": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"server_id": {
|
||||
"type": "string"
|
||||
},
|
||||
"hostname": {
|
||||
"type": "string"
|
||||
},
|
||||
"last_sync": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"date": {
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
},
|
||||
"error": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"default": {
|
||||
"value": {
|
||||
"server_instances": [
|
||||
{
|
||||
"server_id": "deadbeef1",
|
||||
"hostname": "github.example.com",
|
||||
"last_sync": {
|
||||
"date": "2020-01-01T00:00:00Z",
|
||||
"status": "success",
|
||||
"error": ""
|
||||
}
|
||||
},
|
||||
{
|
||||
"server_id": "filetoffish1",
|
||||
"hostname": "github2.example.com",
|
||||
"last_sync": {
|
||||
"date": "2020-01-01T00:00:00Z",
|
||||
"status": "success",
|
||||
"error": ""
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": true,
|
||||
"enabledForGitHubApps": false,
|
||||
"previews": [
|
||||
|
||||
],
|
||||
"category": "enterprise-admin",
|
||||
"subcategory": "license"
|
||||
}
|
||||
}
|
||||
},
|
||||
"/enterprises/{enterprise}/secret-scanning/alerts": {
|
||||
"get": {
|
||||
"summary": "List secret scanning alerts for an enterprise",
|
||||
|
||||
Reference in New Issue
Block a user